forked from campaignmonitor/createsend-php
-
Notifications
You must be signed in to change notification settings - Fork 0
/
csrest_general.php
214 lines (196 loc) · 9.35 KB
/
csrest_general.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
<?php
require_once dirname(__FILE__).'/class/base_classes.php';
/**
* Class to access general resources from the create send API.
* @author tobyb
*
*/
if (!class_exists('CS_REST_General')) {
class CS_REST_General extends CS_REST_Wrapper_Base {
/**
* Get the authorization URL for your application, given the application's
* Client ID, Client Secret, Redirect URI, Scope, and optional state data.
*
* @param $client_id int The Client ID of your registered OAuth application.
* @param $redirect_uri string The Redirect URI of your registered OAuth application.
* @param $scope string The comma-separated permission scope your application requires.
* See http://www.campaignmonitor.com/api/getting-started/#authenticating_with_oauth for details.
* @param $state string Optional state data to be included in the URL.
* @return string The authorization URL to which users of your application should be redirected.
* @access public
**/
public static function authorize_url(
$client_id, $redirect_uri, $scope, $state = NULL) {
$qs = "client_id=".urlencode($client_id);
$qs .= "&redirect_uri=".urlencode($redirect_uri);
$qs .= "&scope=".urlencode($scope);
if ($state) {
$qs .= "&state=".urlencode($state);
}
return CS_OAUTH_BASE_URI.'?'.$qs;
}
/**
* Exchange a provided OAuth code for an OAuth access token, 'expires in'
* value and refresh token.
*
* @param $client_id int The Client ID of your registered OAuth application.
* @param $client_secret string The Client Secret of your registered OAuth application.
* @param $redirect_uri string The Redirect URI of your registered OAuth application.
* @param $code string The unique OAuth code to be exchanged for an access token.
* @return CS_REST_Wrapper_Result A successful response will be an object of the form
* {
* 'access_token' => The access token to use for API calls
* 'expires_in' => The number of seconds until this access token expires
* 'refresh_token' => The refresh token to refresh the access token once it expires
* }
* @access public
**/
public static function exchange_token(
$client_id, $client_secret, $redirect_uri, $code) {
$body = "grant_type=authorization_code";
$body .= "&client_id=".urlencode($client_id);
$body .= "&client_secret=".urlencode($client_secret);
$body .= "&redirect_uri=".urlencode($redirect_uri);
$body .= "&code=".urlencode($code);
$options = array('contentType' => 'application/x-www-form-urlencoded');
$wrap = new CS_REST_Wrapper_Base(
NULL, 'https', CS_REST_LOG_NONE, CS_HOST, NULL,
new CS_REST_DoNothingSerialiser(), NULL);
return $wrap->post_request(CS_OAUTH_TOKEN_URI, $body, $options);
}
/**
* Constructor.
* @param $auth_details array Authentication details to use for API calls.
* This array must take one of the following forms:
* If using OAuth to authenticate:
* array(
* 'access_token' => 'your access token',
* 'refresh_token' => 'your refresh token')
*
* Or if using an API key:
* array('api_key' => 'your api key')
* @param $protocol string The protocol to use for requests (http|https)
* @param $debug_level int The level of debugging required CS_REST_LOG_NONE | CS_REST_LOG_ERROR | CS_REST_LOG_WARNING | CS_REST_LOG_VERBOSE
* @param $host string The host to send API requests to. There is no need to change this
* @param $log CS_REST_Log The logger to use. Used for dependency injection
* @param $serialiser The serialiser to use. Used for dependency injection
* @param $transport The transport to use. Used for dependency injection
* @access public
*/
function CS_REST_Wrapper_Base(
$auth_details,
$protocol = 'https',
$debug_level = CS_REST_LOG_NONE,
$host = 'api.createsend.com',
$log = NULL,
$serialiser = NULL,
$transport = NULL) {
$this->CS_REST_Wrapper_Base($auth_details, $protocol, $debug_level, $host, $log, $serialiser, $transport);
}
/**
* Gets an array of valid timezones
* @access public
* @return CS_REST_Wrapper_Result A successful response will be an object of the form
* array<string>(timezones)
*/
function get_timezones() {
return $this->get_request($this->_base_route.'timezones.json');
}
/**
* Gets the current date in your accounts timezone
* @access public
* @return CS_REST_Wrapper_Result A successful response will be an object of the form
* {
* 'SystemDate' => string The current system date in your accounts timezone
* }
*/
function get_systemdate() {
return $this->get_request($this->_base_route.'systemdate.json');
}
/**
* Gets an array of valid countries
* @access public
* @return CS_REST_Wrapper_Result A successful response will be an object of the form
* array<string>(countries)
*/
function get_countries() {
return $this->get_request($this->_base_route.'countries.json');
}
/**
* Gets an array of clients
* @access public
* @return CS_REST_Wrapper_Result A successful response will be an object of the form
* array(
* {
* 'ClientID' => The clients API ID,
* 'Name' => The clients name
* }
* )
*/
function get_clients() {
return $this->get_request($this->_base_route.'clients.json');
}
/**
* Gets your billing details.
* @access public
* @return CS_REST_Wrapper_Result A successful response will be an object of the form
* {
* 'Credits' => The number of credits belonging to the account
* }
*/
function get_billing_details() {
return $this->get_request($this->_base_route.'billingdetails.json');
}
/**
* Gets an array of administrators
* @access public
* @return CS_REST_Wrapper_Result A successful response will be an object of the form
* array(
* {
* 'EmailAddress' => The administrators email address
* 'Name' => The administrators name
* 'Status' => The administrators status
* }
* )
*/
function get_administrators() {
return $this->get_request($this->_base_route.'admins.json');
}
/**
* Retrieves the email address of the primary contact for this account
* @return CS_REST_Wrapper_Result a successful response will be an array in the form:
* array('EmailAddress'=> email address of primary contact)
*/
function get_primary_contact() {
return $this->get_request($this->_base_route.'primarycontact.json');
}
/**
* Assigns the primary contact for this account to the administrator with the specified email address
* @param $emailAddress string The email address of the administrator designated to be the primary contact
* @return CS_REST_Wrapper_Result a successful response will be an array in the form:
* array('EmailAddress'=> email address of primary contact)
*/
function set_primary_contact($emailAddress) {
return $this->put_request($this->_base_route.'primarycontact.json?email=' . urlencode($emailAddress), '');
}
/**
* Get a URL which initiates a new external session for the user with the given email.
* Full details: http://www.campaignmonitor.com/api/account/#single_sign_on
*
* @param $session_options array Options for initiating the external login session.
* This should be an array of the form:
* array(
* 'Email' => 'The email address of the Campaign Monitor user for whom the login session should be created',
* 'Chrome' => 'Which 'chrome' to display - Must be either "all", "tabs", or "none"',
* 'Url' => 'The URL to display once logged in. e.g. "/subscribers/"',
* 'IntegratorID' => 'The Integrator ID. You need to contact Campaign Monitor support to get an Integrator ID.',
* 'ClientID' => 'The Client ID of the client which should be active once logged in to the Campaign Monitor account.' )
*
* @return CS_REST_Wrapper_Result A successful response will be an array of the form:
* array('SessionUrl'=> 'https://external1.createsend.com/cd/create/ABCDEF12/DEADBEEF?url=FEEDDAD1')
*/
function external_session_url($session_options) {
return $this->put_request($this->_base_route.'externalsession.json', $session_options);
}
}
}