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\Utils\Request;
/**
* ManyChat's API /fb/page/ namespace structure wrapper
* @package ManyChat\Structure\Fb
*/
class Page extends NamedAPIStructure
{
/**
* Gets information about the page that corresponds to the current token
*
* @see https://api.manychat.com/swagger#/Page/get_fb_page_getInfo Documentation
* of /fb/page/getInfo method at manychat.com.
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
*/
public function getInfo(): array
{
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName);
}
/**
* Creates tag
*
* @param string $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#/Page/post_fb_page_createTag Documentation
* of /fb/page/createTag method at manychat.com.
*
*/
public function createTag(string $name): array
{
$arguments = [
'name' => $name,
];
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::POST);
}
/**
* Gets current page tags list
*
* @see https://api.manychat.com/swagger#/Page/get_fb_page_getTags Documentation
* of /fb/page/getTags method at manychat.com.
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
*/
public function getTags(): array
{
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName);
}
/**
* Removes tag by its 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#/Page/post_fb_page_removeTag Documentation
* of /fb/page/removeTag method at manychat.com.
*
*/
public function removeTag(int $tag_id): array
{
$arguments = [
'tag_id' => $tag_id,
];
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::POST);
}
/**
* Removes tag by its name
*
* @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#/Page/post_fb_page_removeTagByName Documentation
* of /fb/page/removeTagByName method at manychat.com.
*
*/
public function removeTagByName(string $tag_name): array
{
$arguments = [
'tag_name' => $tag_name,
];
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::POST);
}
/**
* @deprecated use getGrowthTools method instead
*
* Gets current page widgets
*
* @see https://api.manychat.com/swagger#/Page/get_fb_page_getWidgets Documentation
* of /fb/page/getWidgets method at manychat.com.
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
*/
public function getWidgets(): array
{
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName);
}
/**
* Creates custom field
*
* @param string $caption Custom field name
* @param string $type Custom field type: text, number, date, datetime, boolean
* @param string|null $description Custom field description
*
* @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#/Page/post_fb_page_createCustomField Documentation
* of /fb/page/createCustomField method at manychat.com.
*
*/
public function createCustomField(string $caption, string $type, ?string $description = null): array
{
$arguments = [
'caption' => $caption,
'type' => $type,
];
if (null !== $description) {
$arguments['description'] = $description;
}
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::POST);
}
/**
* Gets current page growth tools
*
* @see https://api.manychat.com/swagger#/Page/get_fb_page_getGrowthTools Documentation
* of /fb/page/getGrowthTools method at manychat.com.
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
*/
public function getGrowthTools(): array
{
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName);
}
/**
* Gets current page flows
*
* @see https://api.manychat.com/swagger#/Page/get_fb_page_getFlows Documentation
* of /fb/page/getFlows method at manychat.com.
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
*/
public function getFlows(): array
{
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName);
}
/**
* Gets current page custom fields
*
* @see https://api.manychat.com/swagger#/Page/get_fb_page_getCustomFields Documentation
* of /fb/page/getCustomFields method at manychat.com.
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
*/
public function getCustomFields(): array
{
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName);
}
/**
* Gets current page One-Time Notification topics
*
* @see https://api.manychat.com/swagger#/Page/get_fb_page_getOtnTopics Documentation
* of /fb/page/getOtnTopics method at manychat.com.
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
*/
public function getOtnTopics(): array
{
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName);
}
/**
* Gets current page bot fields
*
* @see https://api.manychat.com/swagger#/Page/get_fb_page_getBotFields Documentation
* of /fb/page/getBotFields method at manychat.com.
*
* @return array The resulting array that was received from ManyChat API
* @throws CallMethodNotSucceedException If the result of calling method didn't succeed
*/
public function getBotFields(): array
{
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName);
}
/**
* Creates bot field
*
* @param string $name Bot field name
* @param string $type Bot field type
* @param string|null $description Description of the bot field
* @param string|int|null $value Bot 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#/Page/post_fb_page_createBotField Documentation
* of /fb/page/createBotField method at manychat.com.
*
*/
public function createBotField(string $name, string $type, ?string $description = null, $value = null): array
{
$arguments = [
'name' => $name,
'type' => $type,
];
if (null !== $description) {
$arguments['description'] = $description;
}
if (null !== $value) {
$arguments['value'] = $value;
}
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::POST);
}
/**
* Sets bot field value by its ID
*
* @param integer $field_id Bot field ID
* @param string|int|null $field_value Bot 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#/Page/post_fb_page_setBotField Documentation
* of /fb/page/setBotField method at manychat.com.
*
*/
public function setBotField(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::POST);
}
/**
* Sets bot field value by its name
*
* @param string $field_name Bot field name
* @param string|int|null $field_value Bot 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#/Page/post_fb_page_setBotFieldByName Documentation
* of /fb/page/setBotFieldByName method at manychat.com.
*
*/
public function setBotFieldByName(string $field_name, $field_value): array
{
$arguments = [
'field_name' => $field_name,
'field_value' => $field_value,
];
$methodName = $this->getMethodAddress(__FUNCTION__);
return $this->getApi()->callMethod($methodName, $arguments, Request::POST);
}
}