Release 1.0.2

Author: muhamad-lukman-grab

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [1.0.2] - 2025-03-04
+
+### Added
+- Get orders by orderIDs
+
+### Changed
+
+### Deprecated
+
+[1.0.2]: https://github.com/grab/grabfood-api-sdk-php/releases/tag/v1.0.2
+
 ## [1.0.1] - 2025-02-24
 
 ### Added

README.md

@@ -257,6 +257,6 @@ vendor/bin/phpunit
 This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.1.3`
-    - Package version: `1.0.1`
+    - Package version: `1.0.2`
     - Generator version: `7.8.0`
 - Build package: `org.openapitools.codegen.languages.PhpClientCodegen`

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "grab/grabfood-api-sdk-php",
-    "version": "1.0.1",
+    "version": "1.0.2",
     "description": "No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)",
     "keywords": [
         "openapitools",

docs/Api/ListOrdersApi.md

@@ -10,7 +10,7 @@ All URIs are relative to https://partner-api.grab.com/grabfood-sandbox, except i
 ## `listOrders()`
 
 ```php
-listOrders($authorization, $merchant_id, $date, $page): \Grab\GrabfoodApiSdk\Model\ListOrdersResponse
+listOrders($authorization, $merchant_id, $date, $page, $order_ids): \Grab\GrabfoodApiSdk\Model\ListOrdersResponse
 ```
 
 List orders
@@ -31,10 +31,11 @@ $apiInstance = new Grab\GrabfoodApiSdk\Api\ListOrdersApi(
 $authorization = Bearer <ACCESS_TOKEN_HERE>; // string | Specify the generated authorization token of the bearer type.
 $merchant_id = 1-CYNGRUNGSBCCC; // string | The merchant's ID that is in GrabFood's database.
 $date = 'date_example'; // string
-$page = 1; // int | Specify the page number for the report.
+$page = 1; // int | Specify the page number for the report. Required if orderIDs is not provided.
+$order_ids = ["123-CYNKLPCVRN5","456-PCVRN5CYNKL"]; // string[] | List of order IDs. If provided, date and page are not required.
 
 try {
-    $result = $apiInstance->listOrders($authorization, $merchant_id, $date, $page);
+    $result = $apiInstance->listOrders($authorization, $merchant_id, $date, $page, $order_ids);
     print_r($result);
 } catch (Exception $e) {
     echo 'Exception when calling ListOrdersApi->listOrders: ', $e->getMessage(), PHP_EOL;
@@ -47,8 +48,9 @@ try {
 | ------------- | ------------- | ------------- | ------------- |
 | **authorization** | **string**| Specify the generated authorization token of the bearer type. | |
 | **merchant_id** | **string**| The merchant&#39;s ID that is in GrabFood&#39;s database. | |
-| **date** | **string**|  | |
-| **page** | **int**| Specify the page number for the report. | |
+| **date** | **string**|  | [optional] |
+| **page** | **int**| Specify the page number for the report. Required if orderIDs is not provided. | [optional] |
+| **order_ids** | [**string[]**](../Model/string.md)| List of order IDs. If provided, date and page are not required. | [optional] |
 
 ### Return type
 

lib/Api/ListOrdersApi.php

@@ -132,17 +132,18 @@ public function getConfig()
      *
      * @param  string $authorization Specify the generated authorization token of the bearer type. (required)
      * @param  string $merchant_id The merchant's ID that is in GrabFood's database. (required)
-     * @param  string $date date (required)
-     * @param  int $page Specify the page number for the report. (required)
+     * @param  string $date date (optional)
+     * @param  int $page Specify the page number for the report. Required if orderIDs is not provided. (optional)
+     * @param  string[] $order_ids List of order IDs. If provided, date and page are not required. (optional)
      * @param  string $contentType The value for the Content-Type header. Check self::contentTypes['listOrders'] to see the possible values for this operation
      *
      * @throws \Grab\GrabfoodApiSdk\ApiException on non-2xx response or if the response body is not in the expected format
      * @throws \InvalidArgumentException
      * @return \Grab\GrabfoodApiSdk\Model\ListOrdersResponse
      */
-    public function listOrders($authorization, $merchant_id, $date, $page, string $contentType = self::contentTypes['listOrders'][0])
+    public function listOrders($authorization, $merchant_id, $date = null, $page = null, $order_ids = null, string $contentType = self::contentTypes['listOrders'][0])
     {
-        list($response) = $this->listOrdersWithHttpInfo($authorization, $merchant_id, $date, $page, $contentType);
+        list($response) = $this->listOrdersWithHttpInfo($authorization, $merchant_id, $date, $page, $order_ids, $contentType);
         return $response;
     }
 
@@ -153,17 +154,18 @@ public function listOrders($authorization, $merchant_id, $date, $page, string $c
      *
      * @param  string $authorization Specify the generated authorization token of the bearer type. (required)
      * @param  string $merchant_id The merchant's ID that is in GrabFood's database. (required)
-     * @param  string $date (required)
-     * @param  int $page Specify the page number for the report. (required)
+     * @param  string $date (optional)
+     * @param  int $page Specify the page number for the report. Required if orderIDs is not provided. (optional)
+     * @param  string[] $order_ids List of order IDs. If provided, date and page are not required. (optional)
      * @param  string $contentType The value for the Content-Type header. Check self::contentTypes['listOrders'] to see the possible values for this operation
      *
      * @throws \Grab\GrabfoodApiSdk\ApiException on non-2xx response or if the response body is not in the expected format
      * @throws \InvalidArgumentException
      * @return array of \Grab\GrabfoodApiSdk\Model\ListOrdersResponse, HTTP status code, HTTP response headers (array of strings)
      */
-    public function listOrdersWithHttpInfo($authorization, $merchant_id, $date, $page, string $contentType = self::contentTypes['listOrders'][0])
+    public function listOrdersWithHttpInfo($authorization, $merchant_id, $date = null, $page = null, $order_ids = null, string $contentType = self::contentTypes['listOrders'][0])
     {
-        $request = $this->listOrdersRequest($authorization, $merchant_id, $date, $page, $contentType);
+        $request = $this->listOrdersRequest($authorization, $merchant_id, $date, $page, $order_ids, $contentType);
 
         try {
             $options = $this->createHttpClientOption();
@@ -280,16 +282,17 @@ public function listOrdersWithHttpInfo($authorization, $merchant_id, $date, $pag
      *
      * @param  string $authorization Specify the generated authorization token of the bearer type. (required)
      * @param  string $merchant_id The merchant's ID that is in GrabFood's database. (required)
-     * @param  string $date (required)
-     * @param  int $page Specify the page number for the report. (required)
+     * @param  string $date (optional)
+     * @param  int $page Specify the page number for the report. Required if orderIDs is not provided. (optional)
+     * @param  string[] $order_ids List of order IDs. If provided, date and page are not required. (optional)
      * @param  string $contentType The value for the Content-Type header. Check self::contentTypes['listOrders'] to see the possible values for this operation
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Promise\PromiseInterface
      */
-    public function listOrdersAsync($authorization, $merchant_id, $date, $page, string $contentType = self::contentTypes['listOrders'][0])
+    public function listOrdersAsync($authorization, $merchant_id, $date = null, $page = null, $order_ids = null, string $contentType = self::contentTypes['listOrders'][0])
     {
-        return $this->listOrdersAsyncWithHttpInfo($authorization, $merchant_id, $date, $page, $contentType)
+        return $this->listOrdersAsyncWithHttpInfo($authorization, $merchant_id, $date, $page, $order_ids, $contentType)
             ->then(
                 function ($response) {
                     return $response[0];
@@ -304,17 +307,18 @@ function ($response) {
      *
      * @param  string $authorization Specify the generated authorization token of the bearer type. (required)
      * @param  string $merchant_id The merchant's ID that is in GrabFood's database. (required)
-     * @param  string $date (required)
-     * @param  int $page Specify the page number for the report. (required)
+     * @param  string $date (optional)
+     * @param  int $page Specify the page number for the report. Required if orderIDs is not provided. (optional)
+     * @param  string[] $order_ids List of order IDs. If provided, date and page are not required. (optional)
      * @param  string $contentType The value for the Content-Type header. Check self::contentTypes['listOrders'] to see the possible values for this operation
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Promise\PromiseInterface
      */
-    public function listOrdersAsyncWithHttpInfo($authorization, $merchant_id, $date, $page, string $contentType = self::contentTypes['listOrders'][0])
+    public function listOrdersAsyncWithHttpInfo($authorization, $merchant_id, $date = null, $page = null, $order_ids = null, string $contentType = self::contentTypes['listOrders'][0])
     {
         $returnType = '\Grab\GrabfoodApiSdk\Model\ListOrdersResponse';
-        $request = $this->listOrdersRequest($authorization, $merchant_id, $date, $page, $contentType);
+        $request = $this->listOrdersRequest($authorization, $merchant_id, $date, $page, $order_ids, $contentType);
 
         return $this->client
             ->sendAsync($request, $this->createHttpClientOption())
@@ -357,14 +361,15 @@ function ($exception) {
      *
      * @param  string $authorization Specify the generated authorization token of the bearer type. (required)
      * @param  string $merchant_id The merchant's ID that is in GrabFood's database. (required)
-     * @param  string $date (required)
-     * @param  int $page Specify the page number for the report. (required)
+     * @param  string $date (optional)
+     * @param  int $page Specify the page number for the report. Required if orderIDs is not provided. (optional)
+     * @param  string[] $order_ids List of order IDs. If provided, date and page are not required. (optional)
      * @param  string $contentType The value for the Content-Type header. Check self::contentTypes['listOrders'] to see the possible values for this operation
      *
      * @throws \InvalidArgumentException
      * @return \GuzzleHttp\Psr7\Request
      */
-    public function listOrdersRequest($authorization, $merchant_id, $date, $page, string $contentType = self::contentTypes['listOrders'][0])
+    public function listOrdersRequest($authorization, $merchant_id, $date = null, $page = null, $order_ids = null, string $contentType = self::contentTypes['listOrders'][0])
     {
 
         // verify the required parameter 'authorization' is set
@@ -381,20 +386,12 @@ public function listOrdersRequest($authorization, $merchant_id, $date, $page, st
             );
         }
 
-        // verify the required parameter 'date' is set
-        if ($date === null || (is_array($date) && count($date) === 0)) {
-            throw new \InvalidArgumentException(
-                'Missing the required parameter $date when calling listOrders'
-            );
-        }
 
-        // verify the required parameter 'page' is set
-        if ($page === null || (is_array($page) && count($page) === 0)) {
-            throw new \InvalidArgumentException(
-                'Missing the required parameter $page when calling listOrders'
-            );
-        }
 
+        if ($order_ids !== null && count($order_ids) > 10) {
+            throw new \InvalidArgumentException('invalid value for "$order_ids" when calling ListOrdersApi.listOrders, number of items must be less than or equal to 10.');
+        }
+        
 
         $resourcePath = '/partner/v1/orders';
         $formParams = [];
@@ -419,7 +416,7 @@ public function listOrdersRequest($authorization, $merchant_id, $date, $page, st
             'string', // openApiType
             'form', // style
             true, // explode
-            true // required
+            false // required
         ) ?? []);
         // query params
         $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue(
@@ -428,7 +425,16 @@ public function listOrdersRequest($authorization, $merchant_id, $date, $page, st
             'integer', // openApiType
             'form', // style
             true, // explode
-            true // required
+            false // required
+        ) ?? []);
+        // query params
+        $queryParams = array_merge($queryParams, ObjectSerializer::toQueryValue(
+            $order_ids,
+            'orderIDs', // param base name
+            'array', // openApiType
+            'form', // style
+            true, // explode
+            false // required
         ) ?? []);
 
         // header params

lib/Configuration.php

@@ -107,7 +107,7 @@ class Configuration
      *
      * @var string
      */
-    protected $userAgent = 'GrabFood-API-SDK/1.0.1/php';
+    protected $userAgent = 'GrabFood-API-SDK/1.0.2/php';
 
     /**
      * Debug switch (default set to false)
@@ -440,7 +440,7 @@ public static function toDebugReport()
         $report .= '    OS: ' . php_uname() . PHP_EOL;
         $report .= '    PHP Version: ' . PHP_VERSION . PHP_EOL;
         $report .= '    The version of the OpenAPI document: 1.1.3' . PHP_EOL;
-        $report .= '    SDK Package Version: 1.0.1' . PHP_EOL;
+        $report .= '    SDK Package Version: 1.0.2' . PHP_EOL;
         $report .= '    Temp Folder Path: ' . self::getDefaultConfiguration()->getTempFolderPath() . PHP_EOL;
 
         return $report;