/
ClientInterface.php
258 lines (229 loc) · 8.44 KB
/
ClientInterface.php
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
<?php
namespace Ddeboer\Salesforce\ClientBundle;
use Ddeboer\Salesforce\ClientBundle\Request;
use Ddeboer\Salesforce\ClientBundle\Response;
/**
* Salesforce API client interface
*
* @author David de Boer <david@ddeboer.nl>
*/
interface ClientInterface
{
/**
* Converts a Lead into an Account, Contact, or (optionally) an Opportunity
*
* @param array $leadConverts Array of LeadConvert
*/
function convertLead(array $leadConverts);
/**
* Create one or more Salesforce objects
*
* @param array $objects Array of Salesforce objects
* @param string $objectType Object type, e.g., account or contact
* @return Response\SaveResult[]
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_create.htm
*/
function create(array $objects, $objectType);
/**
* Deletes one or more records from your organization’s data
*
* @param array $ids Salesforce object IDs
* @return Response\DeleteResult[]
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_delete.htm
*/
function delete(array $ids);
/**
* Retrieves a list of available objects for your organization’s data
*
* @return Response\DescribeGlobalResult
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_describeglobal.htm
*/
function describeGlobal();
/**
* Describes metadata (field list and object properties) for the specified object or array of objects
*
* @param array $objectNames
* @return Response\DescribeSObjectResult[]
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_describesobjects.htm
*/
function describeSObjects(array $objectNames);
/**
* Returns information about the standard and custom apps available to the
* logged-in
*
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_invalidatesessions.htm
*/
function describeTabs();
/**
* Delete records from the recycle bin immediately
*
* @param array $ids Object IDS
*/
function emptyRecycleBin(array $ids);
/**
* Retrieves the list of individual records that have been deleted within
* the given timespan for the specified object
*
* @param string $objectType
* @param \DateTime $startDate
* @param \DateTime $endDate
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_getdeleted.htm
*/
function getDeleted($objectType, \DateTime $startDate, \DateTime $endDate);
/**
* Retrieves the list of individual objects that have been updated (added or
* changed) within the given timespan for the specified object
*
* @param string $objectType
* @param \DateTime $startDate
* @param \DateTime $endDate
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_getupdated.htm
*/
function getUpdated($objectType, \DateTime $startDate, \DateTime $endDate);
/**
* Ends one or more sessions specified by a sessionId
*
* @param array $sessionIds
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_invalidatesessions.htm
*/
function invalidateSessions(array $sessionIds);
/**
* Logs in to the login server and starts a client session
*
* @param string $username Salesforce username
* @param string $password Salesforce password
* @param string $token Salesforce security token
* @return Response\LoginResult
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_login.htm
*/
function login($username, $password, $token);
/**
* Ends the session of the logged-in user
*
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_logout.htm
*/
function logout();
/**
* Merge a Salesforce lead, contact or account with one or two other
* Salesforce leads, contacts or accounts
*
* @param array $mergeRequests Array of merge request objects
* @param string $objectType Object type, e.g., account or contact
* @return Response\MergeResult[]
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_merge.htm
*/
function merge(array $mergeRequests, $objectType);
/**
* Submits an array of approval process instances for approval, or processes
* an array of approval process instances to be approved, rejected, or
* removed
*
* @param array $processRequests
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_process.htm
*/
function process(array $processRequests);
/**
* Query salesforce API and return results as record iterator
*
* @param string $query
* @return RecordIterator
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_query.htm
*/
function query($query);
/**
* Retrieves data from specified objects, whether or not they have been
* deleted
*
* @param string $query
* @return Response\QueryResult[]
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_queryall.htm
*/
function queryAll($query);
/**
* Retrieves the next batch of objects from a query
*
* @param string $queryLocator
* @return Response\QueryResult
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_querymore.htm
*/
function queryMore($queryLocator);
/**
* Retrieves one or more records based on the specified IDs
*
* @param array $fields Fields to retrieve on the object
* @param array $ids IDs of objects to retrieve
* @param string $objectType Object type, e.g., account or contact
* @param array $ids
*
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_retrieve.htm
*/
function retrieve(array $fields, array $ids, $objectType);
/**
* Executes a text search in your organization’s data
*
* @param string $searchString
* @return Response\SearchResult
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_search.htm
*/
function search($searchString);
/**
* Undeletes records from the Recycle Bin
*
* @param array $ids
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_undelete.htm
*/
function undelete(array $ids);
/**
* Updates one or more existing records in your organization’s data
*
* @param array $objects
* @param string $objectType Object type, e.g., account or contact
* @return Response\SaveResult[]
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_update.htm
*/
function update(array $objects, $objectType);
/**
* Creates new records and updates existing records; uses a custom field to
* determine the presence of existing records
*
* @param string $externalIdFieldName
* @param array $objects Array of objects
* @param string $objectType Object type, e.g., account or contact
* @return Response\SaveResult[]
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_upsert.htm
*/
function upsert($externalFieldName, array $objects, $objectType);
/**
* Retrieves the current system timestamp (Coordinated Universal Time (UTC)
* time zone) from the API
*
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_getservertimestamp.htm
*/
function getServerTimestamp();
/**
* Get user info
*
* @return Response\GetUserInfoResult
* @link http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_calls_getuserinfo.htm
*/
function getUserInfo();
/**
* Changes a user’s password to a temporary, system-generated value
*
* @param string $userId
*/
function resetPassword($userId);
/**
* Immediately sends an email message
*
* @param array $emails
*/
function sendEmail(array $emails);
/**
* Sets the specified user’s password to the specified value
*
* @param string $userId
* @param string $password
*/
function setPassword($userId, $password);
}