Skip to content

Commit 2e97b09

Browse files
github-actions[bot]github-actions
github-actions[bot]
and
github-actions
authored
Retire GET /v2/bot/message/delivery/ad_phone (#750)
line/line-openapi#82 `GET /v2/bot/message/delivery/ad_phone` was sunset. This change removes it as it's no longer necessary to include it in line-openapi. Co-authored-by: github-actions <[email protected]>
1 parent a3b295c commit 2e97b09

File tree

4 files changed

+1
-369
lines changed

4 files changed

+1
-369
lines changed

‎line-openapi

‎linebot/v3/messaging/api/async_messaging_api.py

-151
Original file line numberDiff line numberDiff line change
@@ -1007,157 +1007,6 @@ def delete_rich_menu_alias_with_http_info(self, rich_menu_alias_id : Annotated[S
10071007
collection_formats=_collection_formats,
10081008
_request_auth=_params.get('_request_auth'))
10091009

1010-
@overload
1011-
async def get_ad_phone_message_statistics(self, var_date : Annotated[StrictStr, Field(..., description="Date the message was sent Format: `yyyyMMdd` (e.g. `20190831`) Time Zone: UTC+9 ")], **kwargs) -> NumberOfMessagesResponse: # noqa: E501
1012-
...
1013-
1014-
@overload
1015-
def get_ad_phone_message_statistics(self, var_date : Annotated[StrictStr, Field(..., description="Date the message was sent Format: `yyyyMMdd` (e.g. `20190831`) Time Zone: UTC+9 ")], async_req: Optional[bool]=True, **kwargs) -> NumberOfMessagesResponse: # noqa: E501
1016-
...
1017-
1018-
@validate_arguments
1019-
def get_ad_phone_message_statistics(self, var_date : Annotated[StrictStr, Field(..., description="Date the message was sent Format: `yyyyMMdd` (e.g. `20190831`) Time Zone: UTC+9 ")], async_req: Optional[bool]=None, **kwargs) -> Union[NumberOfMessagesResponse, Awaitable[NumberOfMessagesResponse]]: # noqa: E501
1020-
"""get_ad_phone_message_statistics # noqa: E501
1021-
1022-
Get result of message delivery using phone number # noqa: E501
1023-
This method makes a synchronous HTTP request by default. To make an
1024-
asynchronous HTTP request, please pass async_req=True
1025-
1026-
>>> thread = api.get_ad_phone_message_statistics(var_date, async_req=True)
1027-
>>> result = thread.get()
1028-
1029-
:param var_date: Date the message was sent Format: `yyyyMMdd` (e.g. `20190831`) Time Zone: UTC+9 (required)
1030-
:type var_date: str
1031-
:param async_req: Whether to execute the request asynchronously.
1032-
:type async_req: bool, optional
1033-
:param _request_timeout: timeout setting for this request. If one
1034-
number provided, it will be total request
1035-
timeout. It can also be a pair (tuple) of
1036-
(connection, read) timeouts.
1037-
:return: Returns the result object.
1038-
If the method is called asynchronously,
1039-
returns the request thread.
1040-
:rtype: NumberOfMessagesResponse
1041-
"""
1042-
kwargs['_return_http_data_only'] = True
1043-
if '_preload_content' in kwargs:
1044-
raise ValueError("Error! Please call the get_ad_phone_message_statistics_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
1045-
if async_req is not None:
1046-
kwargs['async_req'] = async_req
1047-
return self.get_ad_phone_message_statistics_with_http_info(var_date, **kwargs) # noqa: E501
1048-
1049-
@validate_arguments
1050-
def get_ad_phone_message_statistics_with_http_info(self, var_date : Annotated[StrictStr, Field(..., description="Date the message was sent Format: `yyyyMMdd` (e.g. `20190831`) Time Zone: UTC+9 ")], **kwargs) -> ApiResponse: # noqa: E501
1051-
"""get_ad_phone_message_statistics # noqa: E501
1052-
1053-
Get result of message delivery using phone number # noqa: E501
1054-
This method makes a synchronous HTTP request by default. To make an
1055-
asynchronous HTTP request, please pass async_req=True
1056-
1057-
>>> thread = api.get_ad_phone_message_statistics_with_http_info(var_date, async_req=True)
1058-
>>> result = thread.get()
1059-
1060-
:param var_date: Date the message was sent Format: `yyyyMMdd` (e.g. `20190831`) Time Zone: UTC+9 (required)
1061-
:type var_date: str
1062-
:param async_req: Whether to execute the request asynchronously.
1063-
:type async_req: bool, optional
1064-
:param _preload_content: if False, the ApiResponse.data will
1065-
be set to none and raw_data will store the
1066-
HTTP response body without reading/decoding.
1067-
Default is True.
1068-
:type _preload_content: bool, optional
1069-
:param _return_http_data_only: response data instead of ApiResponse
1070-
object with status code, headers, etc
1071-
:type _return_http_data_only: bool, optional
1072-
:param _request_timeout: timeout setting for this request. If one
1073-
number provided, it will be total request
1074-
timeout. It can also be a pair (tuple) of
1075-
(connection, read) timeouts.
1076-
:param _request_auth: set to override the auth_settings for an a single
1077-
request; this effectively ignores the authentication
1078-
in the spec for a single request.
1079-
:type _request_auth: dict, optional
1080-
:type _content_type: string, optional: force content-type for the request
1081-
:return: Returns the result object.
1082-
If the method is called asynchronously,
1083-
returns the request thread.
1084-
:rtype: tuple(NumberOfMessagesResponse, status_code(int), headers(HTTPHeaderDict))
1085-
"""
1086-
1087-
_host = self.line_base_path
1088-
_params = locals()
1089-
1090-
_all_params = [
1091-
'var_date'
1092-
]
1093-
_all_params.extend(
1094-
[
1095-
'async_req',
1096-
'_return_http_data_only',
1097-
'_preload_content',
1098-
'_request_timeout',
1099-
'_request_auth',
1100-
'_content_type',
1101-
'_headers'
1102-
]
1103-
)
1104-
1105-
# validate the arguments
1106-
for _key, _val in _params['kwargs'].items():
1107-
if _key not in _all_params:
1108-
raise ApiTypeError(
1109-
"Got an unexpected keyword argument '%s'"
1110-
" to method get_ad_phone_message_statistics" % _key
1111-
)
1112-
_params[_key] = _val
1113-
del _params['kwargs']
1114-
1115-
_collection_formats = {}
1116-
1117-
# process the path parameters
1118-
_path_params = {}
1119-
1120-
# process the query parameters
1121-
_query_params = []
1122-
if _params.get('var_date') is not None: # noqa: E501
1123-
_query_params.append(('date', _params['var_date']))
1124-
1125-
# process the header parameters
1126-
_header_params = dict(_params.get('_headers', {}))
1127-
# process the form parameters
1128-
_form_params = []
1129-
_files = {}
1130-
# process the body parameter
1131-
_body_params = None
1132-
# set the HTTP header `Accept`
1133-
_header_params['Accept'] = self.api_client.select_header_accept(
1134-
['application/json']) # noqa: E501
1135-
1136-
# authentication setting
1137-
_auth_settings = ['Bearer'] # noqa: E501
1138-
1139-
_response_types_map = {
1140-
'200': "NumberOfMessagesResponse",
1141-
}
1142-
1143-
return self.api_client.call_api(
1144-
'/v2/bot/message/delivery/ad_phone', 'GET',
1145-
_path_params,
1146-
_query_params,
1147-
_header_params,
1148-
body=_body_params,
1149-
post_params=_form_params,
1150-
files=_files,
1151-
response_types_map=_response_types_map,
1152-
auth_settings=_auth_settings,
1153-
async_req=_params.get('async_req'),
1154-
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
1155-
_preload_content=_params.get('_preload_content', True),
1156-
_request_timeout=_params.get('_request_timeout'),
1157-
_host=_host,
1158-
collection_formats=_collection_formats,
1159-
_request_auth=_params.get('_request_auth'))
1160-
11611010
@overload
11621011
async def get_aggregation_unit_name_list(self, limit : Annotated[Optional[StrictStr], Field(description="The maximum number of aggregation units you can get per request. ")] = None, start : Annotated[Optional[StrictStr], Field(description="Value of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array. ")] = None, **kwargs) -> GetAggregationUnitNameListResponse: # noqa: E501
11631012
...

‎linebot/v3/messaging/api/messaging_api.py

-141
Original file line numberDiff line numberDiff line change
@@ -945,147 +945,6 @@ def delete_rich_menu_alias_with_http_info(self, rich_menu_alias_id : Annotated[S
945945
collection_formats=_collection_formats,
946946
_request_auth=_params.get('_request_auth'))
947947

948-
@validate_arguments
949-
def get_ad_phone_message_statistics(self, var_date : Annotated[StrictStr, Field(..., description="Date the message was sent Format: `yyyyMMdd` (e.g. `20190831`) Time Zone: UTC+9 ")], **kwargs) -> NumberOfMessagesResponse: # noqa: E501
950-
"""get_ad_phone_message_statistics # noqa: E501
951-
952-
Get result of message delivery using phone number # noqa: E501
953-
This method makes a synchronous HTTP request by default. To make an
954-
asynchronous HTTP request, please pass async_req=True
955-
956-
>>> thread = api.get_ad_phone_message_statistics(var_date, async_req=True)
957-
>>> result = thread.get()
958-
959-
:param var_date: Date the message was sent Format: `yyyyMMdd` (e.g. `20190831`) Time Zone: UTC+9 (required)
960-
:type var_date: str
961-
:param async_req: Whether to execute the request asynchronously.
962-
:type async_req: bool, optional
963-
:param _request_timeout: timeout setting for this request. If one
964-
number provided, it will be total request
965-
timeout. It can also be a pair (tuple) of
966-
(connection, read) timeouts.
967-
:return: Returns the result object.
968-
If the method is called asynchronously,
969-
returns the request thread.
970-
:rtype: NumberOfMessagesResponse
971-
"""
972-
kwargs['_return_http_data_only'] = True
973-
if '_preload_content' in kwargs:
974-
raise ValueError("Error! Please call the get_ad_phone_message_statistics_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data")
975-
return self.get_ad_phone_message_statistics_with_http_info(var_date, **kwargs) # noqa: E501
976-
977-
@validate_arguments
978-
def get_ad_phone_message_statistics_with_http_info(self, var_date : Annotated[StrictStr, Field(..., description="Date the message was sent Format: `yyyyMMdd` (e.g. `20190831`) Time Zone: UTC+9 ")], **kwargs) -> ApiResponse: # noqa: E501
979-
"""get_ad_phone_message_statistics # noqa: E501
980-
981-
Get result of message delivery using phone number # noqa: E501
982-
This method makes a synchronous HTTP request by default. To make an
983-
asynchronous HTTP request, please pass async_req=True
984-
985-
>>> thread = api.get_ad_phone_message_statistics_with_http_info(var_date, async_req=True)
986-
>>> result = thread.get()
987-
988-
:param var_date: Date the message was sent Format: `yyyyMMdd` (e.g. `20190831`) Time Zone: UTC+9 (required)
989-
:type var_date: str
990-
:param async_req: Whether to execute the request asynchronously.
991-
:type async_req: bool, optional
992-
:param _preload_content: if False, the ApiResponse.data will
993-
be set to none and raw_data will store the
994-
HTTP response body without reading/decoding.
995-
Default is True.
996-
:type _preload_content: bool, optional
997-
:param _return_http_data_only: response data instead of ApiResponse
998-
object with status code, headers, etc
999-
:type _return_http_data_only: bool, optional
1000-
:param _request_timeout: timeout setting for this request. If one
1001-
number provided, it will be total request
1002-
timeout. It can also be a pair (tuple) of
1003-
(connection, read) timeouts.
1004-
:param _request_auth: set to override the auth_settings for an a single
1005-
request; this effectively ignores the authentication
1006-
in the spec for a single request.
1007-
:type _request_auth: dict, optional
1008-
:type _content_type: string, optional: force content-type for the request
1009-
:return: Returns the result object.
1010-
If the method is called asynchronously,
1011-
returns the request thread.
1012-
:rtype: tuple(NumberOfMessagesResponse, status_code(int), headers(HTTPHeaderDict))
1013-
"""
1014-
1015-
_host = self.line_base_path
1016-
_params = locals()
1017-
1018-
_all_params = [
1019-
'var_date'
1020-
]
1021-
_all_params.extend(
1022-
[
1023-
'async_req',
1024-
'_return_http_data_only',
1025-
'_preload_content',
1026-
'_request_timeout',
1027-
'_request_auth',
1028-
'_content_type',
1029-
'_headers'
1030-
]
1031-
)
1032-
1033-
# validate the arguments
1034-
for _key, _val in _params['kwargs'].items():
1035-
if _key not in _all_params:
1036-
raise ApiTypeError(
1037-
"Got an unexpected keyword argument '%s'"
1038-
" to method get_ad_phone_message_statistics" % _key
1039-
)
1040-
_params[_key] = _val
1041-
del _params['kwargs']
1042-
1043-
_collection_formats = {}
1044-
1045-
# process the path parameters
1046-
_path_params = {}
1047-
1048-
# process the query parameters
1049-
_query_params = []
1050-
if _params.get('var_date') is not None: # noqa: E501
1051-
_query_params.append(('date', _params['var_date']))
1052-
1053-
# process the header parameters
1054-
_header_params = dict(_params.get('_headers', {}))
1055-
# process the form parameters
1056-
_form_params = []
1057-
_files = {}
1058-
# process the body parameter
1059-
_body_params = None
1060-
# set the HTTP header `Accept`
1061-
_header_params['Accept'] = self.api_client.select_header_accept(
1062-
['application/json']) # noqa: E501
1063-
1064-
# authentication setting
1065-
_auth_settings = ['Bearer'] # noqa: E501
1066-
1067-
_response_types_map = {
1068-
'200': "NumberOfMessagesResponse",
1069-
}
1070-
1071-
return self.api_client.call_api(
1072-
'/v2/bot/message/delivery/ad_phone', 'GET',
1073-
_path_params,
1074-
_query_params,
1075-
_header_params,
1076-
body=_body_params,
1077-
post_params=_form_params,
1078-
files=_files,
1079-
response_types_map=_response_types_map,
1080-
auth_settings=_auth_settings,
1081-
async_req=_params.get('async_req'),
1082-
_return_http_data_only=_params.get('_return_http_data_only'), # noqa: E501
1083-
_preload_content=_params.get('_preload_content', True),
1084-
_request_timeout=_params.get('_request_timeout'),
1085-
_host=_host,
1086-
collection_formats=_collection_formats,
1087-
_request_auth=_params.get('_request_auth'))
1088-
1089948
@validate_arguments
1090949
def get_aggregation_unit_name_list(self, limit : Annotated[Optional[StrictStr], Field(description="The maximum number of aggregation units you can get per request. ")] = None, start : Annotated[Optional[StrictStr], Field(description="Value of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array. ")] = None, **kwargs) -> GetAggregationUnitNameListResponse: # noqa: E501
1091950
"""get_aggregation_unit_name_list # noqa: E501

‎linebot/v3/messaging/docs/MessagingApi.md

-76
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ Method | HTTP request | Description
1010
[**create_rich_menu_alias**](MessagingApi.md#create_rich_menu_alias) | **POST** /v2/bot/richmenu/alias |
1111
[**delete_rich_menu**](MessagingApi.md#delete_rich_menu) | **DELETE** /v2/bot/richmenu/{richMenuId} |
1212
[**delete_rich_menu_alias**](MessagingApi.md#delete_rich_menu_alias) | **DELETE** /v2/bot/richmenu/alias/{richMenuAliasId} |
13-
[**get_ad_phone_message_statistics**](MessagingApi.md#get_ad_phone_message_statistics) | **GET** /v2/bot/message/delivery/ad_phone |
1413
[**get_aggregation_unit_name_list**](MessagingApi.md#get_aggregation_unit_name_list) | **GET** /v2/bot/message/aggregation/list |
1514
[**get_aggregation_unit_usage**](MessagingApi.md#get_aggregation_unit_usage) | **GET** /v2/bot/message/aggregation/info |
1615
[**get_bot_info**](MessagingApi.md#get_bot_info) | **GET** /v2/bot/info |
@@ -513,81 +512,6 @@ void (empty response body)
513512

514513
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
515514

516-
# **get_ad_phone_message_statistics**
517-
> NumberOfMessagesResponse get_ad_phone_message_statistics(var_date)
518-
519-
520-
521-
Get result of message delivery using phone number
522-
523-
### Example
524-
525-
* Bearer Authentication (Bearer):
526-
```python
527-
import time
528-
import os
529-
import linebot.v3.messaging
530-
from linebot.v3.messaging.models.number_of_messages_response import NumberOfMessagesResponse
531-
from linebot.v3.messaging.rest import ApiException
532-
from pprint import pprint
533-
534-
# Defining the host is optional and defaults to https://api.line.me
535-
# See configuration.py for a list of all supported configuration parameters.
536-
configuration = linebot.v3.messaging.Configuration(
537-
host = "https://api.line.me"
538-
)
539-
540-
# The client must configure the authentication and authorization parameters
541-
# in accordance with the API server security policy.
542-
# Examples for each auth method are provided below, use the example that
543-
# satisfies your auth use case.
544-
545-
# Configure Bearer authorization: Bearer
546-
configuration = linebot.v3.messaging.Configuration(
547-
access_token = os.environ["BEARER_TOKEN"]
548-
)
549-
550-
# Enter a context with an instance of the API client
551-
with linebot.v3.messaging.ApiClient(configuration) as api_client:
552-
# Create an instance of the API class
553-
api_instance = linebot.v3.messaging.MessagingApi(api_client)
554-
var_date = 'var_date_example' # str | Date the message was sent Format: `yyyyMMdd` (e.g. `20190831`) Time Zone: UTC+9
555-
556-
try:
557-
api_response = api_instance.get_ad_phone_message_statistics(var_date)
558-
print("The response of MessagingApi->get_ad_phone_message_statistics:\n")
559-
pprint(api_response)
560-
except Exception as e:
561-
print("Exception when calling MessagingApi->get_ad_phone_message_statistics: %s\n" % e)
562-
```
563-
564-
565-
### Parameters
566-
567-
Name | Type | Description | Notes
568-
------------- | ------------- | ------------- | -------------
569-
**var_date** | **str**| Date the message was sent Format: &#x60;yyyyMMdd&#x60; (e.g. &#x60;20190831&#x60;) Time Zone: UTC+9 |
570-
571-
### Return type
572-
573-
[**NumberOfMessagesResponse**](NumberOfMessagesResponse.md)
574-
575-
### Authorization
576-
577-
[Bearer](../README.md#Bearer)
578-
579-
### HTTP request headers
580-
581-
- **Content-Type**: Not defined
582-
- **Accept**: application/json
583-
584-
### HTTP response details
585-
| Status code | Description | Response headers |
586-
|-------------|-------------|------------------|
587-
**200** | OK | - |
588-
589-
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
590-
591515
# **get_aggregation_unit_name_list**
592516
> GetAggregationUnitNameListResponse get_aggregation_unit_name_list(limit=limit, start=start)
593517

0 commit comments

Comments
 (0)