Merge branch 'ml/BP-21748/v102' into 'main'

Release 1.0.2

Closes BP-21748

See merge request grab-transport/mex/store-ops/openapi-sdk/grabfood-api-sdk-python!11

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-python/releases/tag/v1.0.2
+
 ## [1.0.1] - 2025-02-24
 
 ### Added

README.md

@@ -4,7 +4,7 @@ No description provided (generated by Openapi Generator https://github.com/opena
 This Python 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.PythonClientCodegen
 For more information, please visit [https://developer.grab.com](https://developer.grab.com)

docs/ListOrdersApi.md

@@ -8,7 +8,7 @@ Method | HTTP request | Description
 
 
 # **list_orders**
-> ListOrdersResponse list_orders(authorization, merchant_id, var_date, page)
+> ListOrdersResponse list_orders(authorization, merchant_id, var_date=var_date, page=page, order_ids=order_ids)
 
 List orders
 
@@ -34,12 +34,13 @@ with grabfood.ApiClient(configuration) as api_client:
     api_instance = grabfood.ListOrdersApi(api_client)
     authorization = 'Bearer <ACCESS_TOKEN_HERE>' # str | Specify the generated authorization token of the bearer type.
     merchant_id = '1-CYNGRUNGSBCCC' # str | The merchant's ID that is in GrabFood's database.
-    var_date = 'var_date_example' # str | 
-    page = 1 # int | Specify the page number for the report.
+    var_date = 'var_date_example' # str |  (optional)
+    page = 1 # int | Specify the page number for the report. Required if orderIDs is not provided. (optional)
+    order_ids = ['[\"123-CYNKLPCVRN5\",\"456-PCVRN5CYNKL\"]'] # List[str] | List of order IDs. If provided, date and page are not required. (optional)
 
     try:
         # List orders
-        api_response = api_instance.list_orders(authorization, merchant_id, var_date, page)
+        api_response = api_instance.list_orders(authorization, merchant_id, var_date=var_date, page=page, order_ids=order_ids)
         print("The response of ListOrdersApi->list_orders:\n")
         pprint(api_response)
     except Exception as e:
@@ -55,8 +56,9 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **authorization** | **str**| Specify the generated authorization token of the bearer type. | 
  **merchant_id** | **str**| The merchant&#39;s ID that is in GrabFood&#39;s database. | 
- **var_date** | **str**|  | 
- **page** | **int**| Specify the page number for the report. | 
+ **var_date** | **str**|  | [optional] 
+ **page** | **int**| Specify the page number for the report. Required if orderIDs is not provided. | [optional] 
+ **order_ids** | [**List[str]**](str.md)| List of order IDs. If provided, date and page are not required. | [optional] 
 
 ### Return type
 

grabfood/__init__.py

@@ -16,7 +16,7 @@
 """
 
 
-__version__ = "1.0.1"
+__version__ = "1.0.2"
 
 # import apis into sdk package
 from grabfood.api.accept_reject_order_api import AcceptRejectOrderApi

grabfood/api/list_orders_api.py

@@ -19,6 +19,7 @@
 from typing_extensions import Annotated
 
 from pydantic import Field, StrictInt, StrictStr
+from typing import List, Optional
 from typing_extensions import Annotated
 from grabfood.models.list_orders_response import ListOrdersResponse
 
@@ -45,8 +46,9 @@ def list_orders(
         self,
         authorization: Annotated[StrictStr, Field(description="Specify the generated authorization token of the bearer type.")],
         merchant_id: Annotated[StrictStr, Field(description="The merchant's ID that is in GrabFood's database.")],
-        var_date: StrictStr,
-        page: Annotated[StrictInt, Field(description="Specify the page number for the report.")],
+        var_date: Optional[StrictStr] = None,
+        page: Annotated[Optional[StrictInt], Field(description="Specify the page number for the report. Required if orderIDs is not provided.")] = None,
+        order_ids: Annotated[Optional[Annotated[List[StrictStr], Field(max_length=10)]], Field(description="List of order IDs. If provided, date and page are not required.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -67,10 +69,12 @@ def list_orders(
         :type authorization: str
         :param merchant_id: The merchant's ID that is in GrabFood's database. (required)
         :type merchant_id: str
-        :param var_date: (required)
+        :param var_date:
         :type var_date: str
-        :param page: Specify the page number for the report. (required)
+        :param page: Specify the page number for the report. Required if orderIDs is not provided.
         :type page: int
+        :param order_ids: List of order IDs. If provided, date and page are not required.
+        :type order_ids: List[str]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -98,6 +102,7 @@ def list_orders(
             merchant_id=merchant_id,
             var_date=var_date,
             page=page,
+            order_ids=order_ids,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -123,8 +128,9 @@ def list_orders_with_http_info(
         self,
         authorization: Annotated[StrictStr, Field(description="Specify the generated authorization token of the bearer type.")],
         merchant_id: Annotated[StrictStr, Field(description="The merchant's ID that is in GrabFood's database.")],
-        var_date: StrictStr,
-        page: Annotated[StrictInt, Field(description="Specify the page number for the report.")],
+        var_date: Optional[StrictStr] = None,
+        page: Annotated[Optional[StrictInt], Field(description="Specify the page number for the report. Required if orderIDs is not provided.")] = None,
+        order_ids: Annotated[Optional[Annotated[List[StrictStr], Field(max_length=10)]], Field(description="List of order IDs. If provided, date and page are not required.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -145,10 +151,12 @@ def list_orders_with_http_info(
         :type authorization: str
         :param merchant_id: The merchant's ID that is in GrabFood's database. (required)
         :type merchant_id: str
-        :param var_date: (required)
+        :param var_date:
         :type var_date: str
-        :param page: Specify the page number for the report. (required)
+        :param page: Specify the page number for the report. Required if orderIDs is not provided.
         :type page: int
+        :param order_ids: List of order IDs. If provided, date and page are not required.
+        :type order_ids: List[str]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -176,6 +184,7 @@ def list_orders_with_http_info(
             merchant_id=merchant_id,
             var_date=var_date,
             page=page,
+            order_ids=order_ids,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -201,8 +210,9 @@ def list_orders_without_preload_content(
         self,
         authorization: Annotated[StrictStr, Field(description="Specify the generated authorization token of the bearer type.")],
         merchant_id: Annotated[StrictStr, Field(description="The merchant's ID that is in GrabFood's database.")],
-        var_date: StrictStr,
-        page: Annotated[StrictInt, Field(description="Specify the page number for the report.")],
+        var_date: Optional[StrictStr] = None,
+        page: Annotated[Optional[StrictInt], Field(description="Specify the page number for the report. Required if orderIDs is not provided.")] = None,
+        order_ids: Annotated[Optional[Annotated[List[StrictStr], Field(max_length=10)]], Field(description="List of order IDs. If provided, date and page are not required.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -223,10 +233,12 @@ def list_orders_without_preload_content(
         :type authorization: str
         :param merchant_id: The merchant's ID that is in GrabFood's database. (required)
         :type merchant_id: str
-        :param var_date: (required)
+        :param var_date:
         :type var_date: str
-        :param page: Specify the page number for the report. (required)
+        :param page: Specify the page number for the report. Required if orderIDs is not provided.
         :type page: int
+        :param order_ids: List of order IDs. If provided, date and page are not required.
+        :type order_ids: List[str]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -254,6 +266,7 @@ def list_orders_without_preload_content(
             merchant_id=merchant_id,
             var_date=var_date,
             page=page,
+            order_ids=order_ids,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -276,6 +289,7 @@ def _list_orders_serialize(
         merchant_id,
         var_date,
         page,
+        order_ids,
         _request_auth,
         _content_type,
         _headers,
@@ -285,6 +299,7 @@ def _list_orders_serialize(
         _host = None
 
         _collection_formats: Dict[str, str] = {
+            'orderIDs': 'multi',
         }
 
         _path_params: Dict[str, str] = {}
@@ -308,6 +323,10 @@ def _list_orders_serialize(
 
             _query_params.append(('page', page))
 
+        if order_ids is not None:
+            
+            _query_params.append(('orderIDs', order_ids))
+            
         # process the header parameters
         if authorization is not None:
             _header_params['Authorization'] = authorization

grabfood/api_client.py

@@ -92,7 +92,7 @@ def __init__(
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'GrabFood-API-SDK/1.0.1/python'
+        self.user_agent = 'GrabFood-API-SDK/1.0.2/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

grabfood/configs/config.py

@@ -1,4 +1,4 @@
-STG_ENV = "https://partner-api.stg-myteksi.com/grabfood"  # Staging environment for self serve onboarding partner
+STG_ENV = "https://partner-api.grab.com/grabfood-sandbox"  # Staging environment for self serve onboarding partner
 PRD_ENV = "https://partner-api.grab.com/grabfood"  # Production environment
-STG_AUTH_ENV = "https://api.stg-myteksi.com"  # Staging environment authentication
+STG_AUTH_ENV = "https://api.grab.com"  # Staging environment authentication
 PRD_AUTH_ENV = "https://api.grab.com"  # Production environment authentication

grabfood/configuration.py

@@ -386,7 +386,7 @@ def to_debug_report(self):
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 1.1.3\n"\
-               "SDK Package Version: 1.0.1".\
+               "SDK Package Version: 1.0.2".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self):

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "grabfood"
-version = "1.0.1"
+version = "1.0.2"
 description = "GrabFood"
 authors = ["Grab Developer"]
 license = "MIT License"

setup.py

@@ -23,7 +23,7 @@
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "grabfood"
-VERSION = "1.0.1"
+VERSION = "1.0.2"
 PYTHON_REQUIRES = ">=3.7"
 REQUIRES = [
     "urllib3 >= 1.25.3, < 2.1.0",