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: <?php
/**
* ManyChat API PHP library
*
* @copyright 2019 ManyChat, Inc.
* @license https://opensource.org/licenses/MIT The MIT License
*/
namespace ManyChat\Structure\Fb;
use ManyChat\Exception\CallMethodNotSucceedException;
use ManyChat\API\NamedAPIStructure;
use ManyChat\Exception\InvalidActionException;
use ManyChat\Exception\JSONDecodeErrorException;
use ManyChat\Exception\NamespaceDepthExceedException;
use ManyChat\Exception\RequestCURLException;
use ManyChat\Utils\Request;
/**
* ManyChat's API /fb/subscriber/ namespace structure wrapper
* @package ManyChat\Structure\Fb
*/
class Subscriber extends NamedAPIStructure
{
/**
* Gets information about the subscriber by its ID
*
* @param integer $subscriber_id Subscriber ID
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
* @see https://api.manychat.com/swagger#/Subscriber/get_fb_subscriber_getInfo Documentation
* of /fb/subscriber/getInfo method at manychat.com.
*
*/
public function getInfo(int $subscriber_id): array
{
$arguments = [
'subscriber_id' => $subscriber_id,
];
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::GET);
}
/**
* Finds subscribers by name
*
* @param string $name Name
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
* @see https://api.manychat.com/swagger#/Subscriber/get_fb_subscriber_findByName Documentation
* of /fb/subscriber/findByName method at manychat.com.
*
*/
public function findByName(string $name): array
{
$arguments = [
'name' => $name,
];
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::GET);
}
/**
* Gets information about the subscriber by user_ref
*
* @param integer $user_ref User ref
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
* @see https://api.manychat.com/swagger#/Subscriber/get_fb_subscriber_getInfoByUserRef Documentation
* of /fb/subscriber/getInfoByUserRef method at manychat.com.
*
*/
public function getInfoByUserRef(int $user_ref): array
{
$arguments = [
'user_ref' => $user_ref,
];
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::GET);
}
/**
* Finds subscribers by custom field value
*
* @param integer $field_id Custom field ID
* @param string|int|null $field_value Custom field value
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
* @see https://api.manychat.com/swagger#/Subscriber/get_fb_subscriber_findByCustomField Documentation
* of /fb/subscriber/findByCustomField method at manychat.com.
*
*/
public function findByCustomField(int $field_id, $field_value): array
{
$arguments = [
'field_id' => $field_id,
'field_value' => $field_value,
];
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::GET);
}
/**
* Adds tag by its ID to the subscriber
*
* @param integer $subscriber_id Subscriber ID
* @param integer $tag_id Tag ID
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
* @see https://api.manychat.com/swagger#/Subscriber/post_fb_subscriber_addTag Documentation
* of /fb/subscriber/addTag method at manychat.com.
*
*/
public function addTag(int $subscriber_id, int $tag_id): array
{
$arguments = [
'subscriber_id' => $subscriber_id,
'tag_id' => $tag_id,
];
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::POST);
}
/**
* Adds tag by its name to the subscriber
*
* @param integer $subscriber_id Subscriber ID
* @param string $tag_name Tag name
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
* @see https://api.manychat.com/swagger#/Subscriber/post_fb_subscriber_addTagByName Documentation
* of /fb/subscriber/addTagByName method at manychat.com.
*
*/
public function addTagByName(int $subscriber_id, string $tag_name): array
{
$arguments = [
'subscriber_id' => $subscriber_id,
'tag_name' => $tag_name,
];
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::POST);
}
/**
* Removes tag by its ID from the subscriber
*
* @param integer $subscriber_id Subscriber ID
* @param integer $tag_id Tag ID
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
* @see https://api.manychat.com/swagger#/Subscriber/post_fb_subscriber_removeTag Documentation
* of /fb/subscriber/removeTag method at manychat.com.
*
*/
public function removeTag(int $subscriber_id, int $tag_id): array
{
$arguments = [
'subscriber_id' => $subscriber_id,
'tag_id' => $tag_id,
];
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::POST);
}
/**
* Removes tag by its name from the subscriber
*
* @param integer $subscriber_id Subscriber ID
* @param string $tag_name Tag name
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
* @see https://api.manychat.com/swagger#/Subscriber/post_fb_subscriber_removeTagByName Documentation
* of /fb/subscriber/removeTagByName method at manychat.com.
*
*/
public function removeTagByName(int $subscriber_id, string $tag_name): array
{
$arguments = [
'subscriber_id' => $subscriber_id,
'tag_name' => $tag_name,
];
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::POST);
}
/**
* Sets custom field value by its ID to the subscriber
*
* @param integer $subscriber_id Subscriber ID
* @param integer $field_id Custom field ID
* @param string|int|null $field_value Custom field value
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
* @see https://api.manychat.com/swagger#/Subscriber/post_fb_subscriber_setCustomField Documentation
* of /fb/subscriber/setCustomField method at manychat.com.
*
*/
public function setCustomField(int $subscriber_id, int $field_id, $field_value): array
{
$arguments = [
'subscriber_id' => $subscriber_id,
'field_id' => $field_id,
'field_value' => $field_value,
];
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::POST);
}
/**
* Sets custom field value by its name to the subscriber
*
* @param integer $subscriber_id Subscriber ID
* @param string $field_name Custom field ID
* @param string|int|null $field_value Custom field value
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
* @see https://api.manychat.com/swagger#/Subscriber/post_fb_subscriber_setCustomFieldByName Documentation
* of /fb/subscriber/setCustomFieldByName method at manychat.com.
*
*/
public function setCustomFieldByName(int $subscriber_id, string $field_name, $field_value): array
{
$arguments = [
'subscriber_id' => $subscriber_id,
'field_name' => $field_name,
'field_value' => $field_value,
];
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::POST);
}
/**
* Verifies subscriber by signed request
*
* @param integer $subscriber_id Subscriber ID
* @param string $signed_request Signed request
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
* @see https://api.manychat.com/swagger#/Subscriber/post_fb_subscriber_verifyBySignedRequest Documentation
* of /fb/subscriber/verifyBySignedRequest method at manychat.com.
*
*/
public function verifyBySignedRequest(int $subscriber_id, string $signed_request): array
{
$arguments = [
'subscriber_id' => $subscriber_id,
'signed_request' => $signed_request,
];
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::POST);
}
/**
* Create new subscriber
*
* `phone` or `email` fields is required
* field `consent_phrase` is required only if has_opt_in is true
*
* @see https://api.manychat.com/swagger#/operations/Subscriber/post_fb_subscriber_createSubscriber
*
* @param bool|null $has_opt_in_sms
* @param bool|null $has_opt_in_email
* @param string|null $consent_phrase
* @param string|null $phone
* @param string|null $email
* @param string|null $first_name
* @param string|null $last_name
* @param string|null $gender
*
* @return array The resulting array that was received from ManyChat API
*
* @throws CallMethodNotSucceedException
* @throws InvalidActionException
* @throws JSONDecodeErrorException
* @throws NamespaceDepthExceedException
* @throws RequestCURLException
*/
public function createSubscriber(?bool $has_opt_in_sms, ?bool $has_opt_in_email, ?string $consent_phrase, ?string $phone, ?string $email, string $first_name = null, string $last_name = null, string $gender = null): array
{
$arguments = [
'first_name' => $first_name,
'last_name' => $last_name,
'phone' => $phone,
'email' => $email,
'gender' => $gender,
'has_opt_in_sms' => $has_opt_in_sms,
'has_opt_in_email' => $has_opt_in_email,
'consent_phrase' => $consent_phrase,
];
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::POST);
}
}