forked from wp-api-libraries/wp-campaignmonitor-api
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathwp-campaignmonitor-api.php
More file actions
690 lines (580 loc) · 13.6 KB
/
Copy pathwp-campaignmonitor-api.php
File metadata and controls
690 lines (580 loc) · 13.6 KB
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
<?php
/**
* WP Campaign Monitor API (https://www.campaignmonitor.com/api/)
*
* @package WP-CampaignMonitor-API
*/
/*
* Plugin Name: WP Campaign Monitor API
* Plugin URI: https://github.com/wp-api-libraries/wp-campaignmonitor-api
* Description: Perform API requests to Campaign Monitor in WordPress.
* Author: WP API Libraries
* Version: 1.0.0
* Author URI: https://wp-api-libraries.com
* GitHub Plugin URI:https://github.com/wp-api-libraries/wp-campaignmonitor-api
* GitHub Branch: master
*/
/* Exit if accessed directly. */
if ( ! defined( 'ABSPATH' ) ) { exit; }
/* Check if class exists. */
if ( ! class_exists( 'BasecampAPI' ) ) {
/**
* CampaignMonitorAPI class.
*/
class CampaignMonitorAPI {
/**
* Api_key
*
* @var mixed
* @access private
* @static
*/
static private $api_key;
/**
* BaseAPI Endpoint
*
* @var string
* param mixed $api_key
* @access protected
*/
protected $base_uri = 'https://api.createsend.com/api/v3.1';
/**
* __construct function.
*
* @access public
* @param mixed $api_key
* @return void
*/
public function __construct( $api_key ) {
static::$api_key = $api_key;
}
/**
* Fetch the request from the API.
*
* @access private
* @param mixed $request Request URL.
* @return $body Body.
*/
private function fetch( $request ) {
$response = wp_remote_request( $request, $this->args );
var_dump( $response );
$code = wp_remote_retrieve_response_code( $response );
if ( 200 !== $code ) {
return new WP_Error( 'response-error', sprintf( __( 'Server response code: %d', 'text-domain' ), $code ) );
}
$body = wp_remote_retrieve_body( $response );
return json_decode( $body );
}
/** OAUTH. */
/** ACCOUNT. */
/**
* Get_clients function.
*
* @access public
* return void
*/
public function get_clients() {
$request = $this->base_uri . '/clients' . $ouput;
return $this->fetch( $request );
}
/**
* Get_billing_details function.
*
* @access public
* return void
*/
public function get_billing_details() {
}
/**
* Get_valid_countries function.
*
* @access public
* return void
*/
public function get_valid_countries() {
}
/**
* Get_valid_timezones function.
*
* @access public
* return void
*/
public function get_valid_timezones() {
}
/**
* Get_systemdate function.
*
* @access public
* return void
*/
public function get_systemdate() {
}
/**
* Add_administrator function.
*
* @access public
* return void
*/
public function add_administrator() {
}
/**
* Set_administrator
* @param email $email
*/
public function set_administrator( $email ) {
}
/**
* Get_administrators function.
*
* @access public
* return void
*/
public function get_administrators() {
}
/**
* Get_admin_details function.
*
* @access public
* @param email $email
* return void
*/
public function get_admin_details( $email ) {
}
/**
* Delete_admin function.
*
* @access public
* @param email $email
* return void
*/
public function delete_admin( $email ) {
}
/**
* Set_primary_account.
*
* @access public
* @param email $email
* return void
*/
public function set_primary_account( $email ) {
}
/**
* Get_primary_account function.
*
* @access public
* return void
*/
public function get_primary_account() {
}
/**
* Single_sign_on function.
*
* @access public
* return void
*/
public function single_sign_on() {
}
/** CAMPAIGNS. */
/**
* Add_draft_campaign function.
*
* @access public
* @param clientid $client_id
* return void
*/
public function add_draft_campaign( $client_id ) {
}
/**
* Add_campaign_from_template function.
*
* @access public
* @param clientid $client_id
* return void
*/
public function add_campaign_from_template( $client_id ) {
}
/**
* Send_draft_campaign function.
*
* @access public
* @param campaignid $campaign_id
* return void
*/
public function send_draft_campaign( $campaign_id ) {
}
/**
* Send_campaign_draft function.
*
* @access public
* @param campaignid $campaign_id
* return void
*/
public function send_campaign_draft( $campaign_id ) {
}
/**
* Send_campaign_preview function.
*
* @access public
* @param campaignid $campaign_id
* return void
*/
public function send_campaign_preview( $campaign_id ) {
}
/**
* Get_campaign_summary function.
*
* @access public
* @param campaignid $campaign_id
* return void
*/
public function get_campaign_summary( $campaign_id ) {
}
/**
* Get_list_campaign_clients_emails function.
*
* @access public
* @param campaignid $campaign_id
* return void
*/
public function get_list_campaign_client_emails( $campaign_id ) {
}
/**
* Get_list_and_segments_campaign function.
*
* @access public
* @param campaignid $campaign_id
* return void
*/
public function get_lists_and_segments_campaign( $campaign_id ) {
}
/**
* Get_campaign_recipients function.
*
* @access public
* @param campaignid $campaign_id
* @param int $page_number
* @param int $page_size
* @param string $order_field
* @param string $order_direction
* return void
*/
public function get_campaign_recipients( $campaign_id, $page_number = 1, $page_size = 1000, $order_field = 'email', $order_direction = 'asc' ) {
}
/**
* Get_campaign_bounces function.
*
* @access public
* @param
* return void
*/
public function get_campaign_bounces( $campaign_id, $date = '', $page = 1, $page_size = 1000, $order_field = 'email', $order_direction = 'asc' ) {
}
/**
* Get_campaign_opens function.
*
* @access public
* @param
* return void
*/
public function get_campaign_opens( $campaign_id, $date = '', $page_number = 1, $page_size = 1000, $order_field = 'email', $order_direction = 'asc' ) {
}
/**
* Get_campaign_clicks function.
*
* @access public
* @param
* return void
*/
public function get_campaign_clicks( $campaign_id, $date = '', $page_number = 1, $page_size = 1000, $order_field = 'email', $order_direction = 'asc' ) {
}
/**
* Get_campaign_unsubscribes function.
*
* @access public
* @param
* return void
*/
public function get_campaign_unsubscribes( $campaign_id, $date = '', $page_number = 1, $page_size = 1000, $order_field = 'email', $order_direction = 'asc' ) {
}
/**
* Get_campaign_spam_complaints function.
*
* @access public
* @param
* return void
*/
public function get_campaign_spam_complaints( $campaign_id, $date = '', $page_number = 1, $page_size = 1000, $order_field = 'email', $order_direction = 'asc' ) {
}
/**
* Delete_campaign function.
*
* @access public
* @param
* return void
*/
public function delete_campaign( $campaign_id ) {
}
/**
* Unschedule_campaign function.
*
* @access public
* @param
* return void
*/
public function unschedule_campaign( $campaign_id ) {
}
/** CLIENTS. */
/**
* Add_client function.
*
* @access public
* return void
*/
public function add_client() {
}
/**
* Get_client_details function.
*
* @access public
* @param
* return void
*/
public function get_client_details( $client_id ) {
}
/**
* Get_sent_campaign function.
*
* @access public
* @param
* return void
*/
public function get_sent_campaign( $client_id ) {
}
/**
* Get_schedule_campaign function.
*
* @access public
* @param
* return void
*/
public function get_schedule_campaign( $client_id ) {
}
/**
* Get_draft_campaign function.
*
* @access public
* @param
* return void
*/
public function get_draft_campaign( $client_id ) {
}
/**
* Get_subscriber_lists function.
*
* @access public
* @param
* return void
*/
public function get_subscriber_lists( $client_id ) {
}
/**
* Get_lists_email_address function.
*
* @access public
* @param
* return void
*/
public function get_lists_email_address( $client_id, $email ) {
}
/**
* Get_segments function.
*
* @access public
* @param
* return void
*/
public function get_segments( $client_id ) {
}
/**
* Get_suppression_list function.
*
* @access public
* @param
* return void
*/
public function get_suppression_list( $client_id, $page = 1, $page_size = 1000, $order_field = 'email', $order_direction = 'asc' ) {
}
/**
* Add_suppress_email_address function.
*
* @access public
* @param
* return void
*/
public function add_suppress_email_address( $client_id ) {
}
/**
* Delete_supress_email_address function.
*
* @access public
* @param
* return void
*/
public function delete_supress_email_address( $client_id, $email ) {
}
/**
* Get_templates function.
*
* @access public
* @param
* return void
*/
public function get_templates( $client_id ) {
}
/**
* Set_setting_basic_details function.
*
* @access public
* @param
* return void
*/
public function set_setting_basic_details( $client_id ) {
}
/**
* Set_payg_billing function.
*
* @access public
* @param
* return void
*/
public function set_payg_billing( $client_id ) {
}
/**
* Set_monthly_billing function
* @access public
* @param
*/
public function set_monthly_billing( $client_id ) {
}
public function transfer_credits( $client_id ) {
}
public function delete_client( $client_id ) {
}
public function add_person( $client_id ) {
}
public function set_person( $client_id, $email ) {
}
public function get_people( $client_id ) {
}
public function get_person_details( $client_id, $email ) {
}
public function delete_person( $client_id, $email ) {
}
public function set_primary_contact( $client_id, $email ) {
}
public function get_primary_contact( $client_id ) {
}
/** LISTS. */
public function add_list( $client_id ) {
}
public function get_list_details( $list_id ) {
}
public function get_list_stats( $list_id ) {
}
public function get_list_custom_fields( $list_id ) {
}
public function get_list_segments( $list_id ) {
}
public function get_active_list_subscribers( $list_id, $date = '', $page = 1, $page_size = 1000, $order_field = 'date', $order_direction = 'asc' ) {
}
public function get_unconfirmed_subscribers( $list_id, $date = '', $page = 1, $page_size = 1000, $order_field = 'date', $order_direction = 'asc' ) {
}
public function get_bounced_subscriber( $list_id, $date = '', $page = 1, $page_size = 1000, $order_field = 'email', $order_direction = 'asc' ) {
}
public function get_deleted_subscribers( $list_id, $date = '', $page = 1, $page_size = 1000, $order_field = 'email', $order_direction = 'asc' ) {
}
public function set_list( $list_id ) {
}
public function add_custom_field( $list_id ) {
}
public function set_custom_field( $list_id, $custom_field_key ) {
}
public function set_custom_field_options( $list_id, $custom_field_key ) {
}
public function delete_custom_field( $list_id, $custom_field_key ) {
}
public function delete_list( $list_id ) {
}
public function get_list_webhooks( $list_id ) {
}
public function add_webhook( $list_id ) {
}
public function get_test_webhook( $list_id, $webhook_id ) {
}
public function delete_webhook( $list_id, $webhook_id ) {
}
public function add_active_webhook( $list_id, $webhook_id ) {
}
public function delete_active_webhook( $list_id, $webhook_id ) {
}
/** SEGMENTS. */
public function add_segment( $list_id ) {
}
public function set_segment( $segment_id ) {
}
public function add_segment_rulegroup( $segment_id ) {
}
public function get_segment_details( $segment_id ) {
}
public function get_active_segment_subscribers( $segment_id, $date = '', $page = 1, $page_size = 1000, $order_field = 'date', $order_direction = 'asc' ) {
}
public function delete_segment( $segment_id ) {
}
public function delete_segment_rule( $segment_id ) {
}
/** SUBSCRIBERS. */
public function add_subscriber( $list_id ) {
}
public function set_subscriber( $list_id, $email ) {
}
public function add_subscribers( $list_id ) {
}
public function get_subscriber_details( $list_id, $email ) {
}
public function get_subscriber_history( $list_id, $email ) {
}
public function delete_active_subscriber( $list_id ) {
}
public function delete_subscriber( $list_id, $email ) {
}
/** TEMPLATES. */
public function get_template( $template_id ) {
}
public function add_template( $template_id ) {
}
public function set_template( $template_id ) {
}
public function delete_template( $template_id ) {
}
/** TRANSACTIONAL. */
public function get_smart_transactional_email_list( $status = 'all', $client_id ) {
}
public function get_smart_transactional_email_details( $smart_email_id ) {
}
public function send_smart_email( $smart_email_id ) {
}
public function send_classic_email( $client_id ) {
}
public function get_classic_email_list( $client_id ) {
}
public function get_email_statistics( $group = '', $from = '2017-06-13', $to = '2017-07-12', $time_zone = 'PCT', $client_id ) {
}
public function get_list_message_timeline( $group = '', $sent_before_id = null, $sent_after_id = null, $count = 50, $status = 'all', $client_id ) {
}
public function get_message_details( $message_id, $statistics = false ) {
}
public function resend_message( $message_id ) {
}
/** WEBHOOKS. */
}
}