Merge pull request #270 from moririnson/feature/add-narrow-cast

Support Narrowcast api endpoint

Author: moririnson

src/LINEBot.php

@@ -22,6 +22,8 @@
 use LINE\LINEBot\HTTPClient;
 use LINE\LINEBot\MessageBuilder;
 use LINE\LINEBot\MessageBuilder\TextMessageBuilder;
+use LINE\LINEBot\Narrowcast\DemographicFilter\DemographicFilterBuilder;
+use LINE\LINEBot\Narrowcast\Recipient\RecipientBuilder;
 use LINE\LINEBot\Response;
 use LINE\LINEBot\SignatureValidator;
 use LINE\LINEBot\RichMenuBuilder;
@@ -728,4 +730,50 @@ public function revokeChannelAccessToken($channelAccessToken)
             ['Content-Type: application/x-www-form-urlencoded']
         );
     }
+
+    /**
+     * Send Narrowcast message.
+     *
+     * @param MessageBuilder $messageBuilder
+     * @param RecipientBuilder|null $recipientBuilder
+     * @param DemographicFilterBuilder|null $demographicFilterBuilder
+     * @param int|null $limit
+     * @return Response
+     */
+    public function sendNarrowcast(
+        MessageBuilder $messageBuilder,
+        RecipientBuilder $recipientBuilder = null,
+        DemographicFilterBuilder $demographicFilterBuilder = null,
+        $limit = null
+    ) {
+        $params = [
+            'messages' => $messageBuilder->buildMessage()
+        ];
+        if (isset($recipientBuilder)) {
+            $params['recipient'] = $recipientBuilder->build();
+        }
+        if (isset($demographicFilterBuilder)) {
+            $params['filter'] = [
+                'demographic' => $demographicFilterBuilder->build(),
+            ];
+        }
+        if (isset($limit)) {
+            $params['limit'] =  [
+                'max' => $limit
+            ];
+        }
+        return $this->httpClient->post($this->endpointBase . '/v2/bot/message/narrowcast', $params);
+    }
+
+    /**
+     * Get Narrowcast message sending progress.
+     *
+     * @param string $requestId
+     * @return Response
+     */
+    public function getNarrowcastProgress($requestId)
+    {
+        $url = $this->endpointBase . '/v2/bot/message/progress/narrowcast';
+        return $this->httpClient->get($url, ['requestId' => $requestId]);
+    }
 }

src/LINEBot/Narrowcast/DemographicFilter/AgeDemographicFilterBuilder.php

@@ -0,0 +1,36 @@
+<?php
+/**
+ * Copyright 2020 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+namespace LINE\LINEBot\Narrowcast\DemographicFilter;
+
+/**
+ * A builder class for age demographic filter
+ *
+ * @package LINE\LINEBot\Narrowcast\DemographicFilter
+ */
+class AgeDemographicFilterBuilder extends RangeDemographicFilterBuilder
+{
+    const TYPE = 'age';
+
+    /**
+     * @return string
+     */
+    protected function getType()
+    {
+        return self::TYPE;
+    }
+}

src/LINEBot/Narrowcast/DemographicFilter/AppTypeDemographicFilterBuilder.php

@@ -0,0 +1,38 @@
+<?php
+/**
+ * Copyright 2020 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+namespace LINE\LINEBot\Narrowcast\DemographicFilter;
+
+/**
+ * A builder class for app type demographic filter
+ *
+ * @package LINE\LINEBot\Narrowcast\DemographicFilter
+ */
+class AppTypeDemographicFilterBuilder extends OneOfDemographicFilter
+{
+    const TYPE = 'appType';
+
+    /**
+     * Get type
+     *
+     * @return string
+     */
+    protected function getType()
+    {
+        return self::TYPE;
+    }
+}

src/LINEBot/Narrowcast/DemographicFilter/AreaDemographicFilterBuilder.php

@@ -0,0 +1,38 @@
+<?php
+/**
+ * Copyright 2020 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+namespace LINE\LINEBot\Narrowcast\DemographicFilter;
+
+/**
+ * A builder class for area demographic filter
+ *
+ * @package LINE\LINEBot\Narrowcast\DemographicFilter
+ */
+class AreaDemographicFilterBuilder extends OneOfDemographicFilter
+{
+    const TYPE = 'area';
+
+    /**
+     * Get type
+     *
+     * @return string
+     */
+    protected function getType()
+    {
+        return self::TYPE;
+    }
+}

src/LINEBot/Narrowcast/DemographicFilter/DemographicFilterBuilder.php

@@ -0,0 +1,44 @@
+<?php
+/**
+ * Copyright 2020 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+namespace LINE\LINEBot\Narrowcast\DemographicFilter;
+
+/**
+ * A builder class for demographic filter
+ *
+ * @package LINE\LINEBot\Narrowcast\DemographicFilter
+ */
+abstract class DemographicFilterBuilder
+{
+    /**
+     * Builds demographic filter
+     *
+     * @return array
+     */
+    abstract public function build();
+
+    /**
+     * Create builder
+     *
+     * @return DemographicFilterBuilder
+     */
+    public static function builder()
+    {
+        $class = \get_called_class();
+        return new $class();
+    }
+}

src/LINEBot/Narrowcast/DemographicFilter/GenderDemographicFilterBuilder.php

@@ -0,0 +1,38 @@
+<?php
+/**
+ * Copyright 2020 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+namespace LINE\LINEBot\Narrowcast\DemographicFilter;
+
+/**
+ * A builder class for gender demographic filter
+ *
+ * @package LINE\LINEBot\Narrowcast\DemographicFilter
+ */
+class GenderDemographicFilterBuilder extends OneOfDemographicFilter
+{
+    const TYPE = 'gender';
+
+    /**
+     * Get type
+     *
+     * @return string
+     */
+    protected function getType()
+    {
+        return self::TYPE;
+    }
+}

src/LINEBot/Narrowcast/DemographicFilter/OneOfDemographicFilter.php

@@ -0,0 +1,61 @@
+<?php
+/**
+ * Copyright 2020 LINE Corporation
+ *
+ * LINE Corporation licenses this file to you under the Apache License,
+ * version 2.0 (the "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at:
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+namespace LINE\LINEBot\Narrowcast\DemographicFilter;
+
+/**
+ * A builder class for demographic filter has a oneOf parameter
+ *
+ * @package LINE\LINEBot\Narrowcast\DemographicFilter
+ */
+abstract class OneOfDemographicFilter extends DemographicFilterBuilder
+{
+    /** @var string[] $oneOf */
+    private $oneOf = [];
+
+    /**
+     * Get type
+     *
+     * @return string
+     */
+    abstract protected function getType();
+
+    /**
+     * Set oneOf
+     *
+     * @param string[] $oneOf
+     * @return $this
+     */
+    public function setOneOf($oneOf)
+    {
+        $this->oneOf = $oneOf;
+        return $this;
+    }
+
+    /**
+     * Builds demographic filter
+     *
+     * @return array
+     */
+    public function build()
+    {
+        return [
+            'type' => $this->getType(),
+            'oneOf' => $this->oneOf,
+        ];
+    }
+}