From 5a33cffd9cbd462da6e6539e790788958f85ff3c Mon Sep 17 00:00:00 2001 From: Yury Gavrilov Date: Fri, 11 Dec 2020 13:06:32 +0300 Subject: [PATCH 1/2] add value parameter to createBotField method --- src/Structure/Fb/Page.php | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/src/Structure/Fb/Page.php b/src/Structure/Fb/Page.php index 3ae233e..e2dfa74 100644 --- a/src/Structure/Fb/Page.php +++ b/src/Structure/Fb/Page.php @@ -244,7 +244,8 @@ public function getBotFields(): array * * @param string $name Bot field name * @param string $type Bot field type - * @param string $description Description of the bot field + * @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 @@ -252,13 +253,18 @@ public function getBotFields(): array * of /fb/page/createBotField method at manychat.com. * */ - public function createBotField(string $name, string $type, string $description): array + public function createBotField(string $name, string $type, ?string $description = null, $value = null): array { $arguments = [ 'name' => $name, 'type' => $type, - 'description' => $description, ]; + if (null !== $description) { + $arguments['description'] = $description; + } + if (null !== $value) { + $arguments['value'] = $value; + } $methodName = $this->getMethodAddress(__FUNCTION__); return $this->getApi()->callMethod($methodName, $arguments, Request::POST); From 9ab52ccf7a24b82623d16eab5f86f5f1addd115e Mon Sep 17 00:00:00 2001 From: Yury Gavrilov Date: Fri, 11 Dec 2020 13:08:03 +0300 Subject: [PATCH 2/2] update docs --- docs/class-ManyChat.Structure.Fb.Page.html | 6 +- ...urce-class-ManyChat.Structure.Fb.Page.html | 142 +++++++++--------- 2 files changed, 77 insertions(+), 71 deletions(-) diff --git a/docs/class-ManyChat.Structure.Fb.Page.html b/docs/class-ManyChat.Structure.Fb.Page.html index e2bbfe4..6b5394f 100644 --- a/docs/class-ManyChat.Structure.Fb.Page.html +++ b/docs/class-ManyChat.Structure.Fb.Page.html @@ -578,7 +578,7 @@

see

# - createBotField( string $name , string $type , string $description ) + createBotField( string $name , string $type , string $description = NULL, string|int|null $value = NULL )
Creates bot field @@ -615,7 +615,7 @@

see

# - setBotField( int $field_id , string|int|null $field_value ) + setBotField( int $field_id , string|int|null $field_value )
Sets bot field value by its ID @@ -652,7 +652,7 @@

see

# - setBotFieldByName( string $field_name , string|int|null $field_value ) + setBotFieldByName( string $field_name , string|int|null $field_value )
Sets bot field value by its name diff --git a/docs/source-class-ManyChat.Structure.Fb.Page.html b/docs/source-class-ManyChat.Structure.Fb.Page.html index d1d4059..b05273f 100644 --- a/docs/source-class-ManyChat.Structure.Fb.Page.html +++ b/docs/source-class-ManyChat.Structure.Fb.Page.html @@ -56,7 +56,7 @@
- 
  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:
+ 
  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
 
 /**
@@ -303,74 +303,80 @@
      *
      * @param string $name Bot field name
      * @param string $type Bot field type
-     * @param string $description Description of the bot field
-     *
-     * @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): array
-    {
-        $arguments = [
-            'name' => $name,
-            'type' => $type,
-            'description' => $description,
+     * @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,
         ];
-        $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);
-    }
-
-}
-
+ 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); + } + +} +