Skip to content

Commit f3617d0

Browse files
habara-khabara-k
committed
Add generated v3 doc
1 parent 104819d commit f3617d0

File tree

345 files changed

+9264
-42
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

345 files changed

+9264
-42
lines changed

‎linebot/v3/async_line_bot_client.py‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# coding: utf-8
22

3-
"""Unified Async LINE Bot Client.
3+
"""Async LINE Bot Client.
44
55
Auto-generated by tools/generate_unified_client.py.
66
Do not edit manually.
@@ -119,9 +119,13 @@
119119

120120

121121
class AsyncLineBotClient:
122-
"""Unified async LINE Bot client that delegates to individual async API clients.
122+
"""Async version of :class:`LineBotClient`.
123123
124-
Auto-generated by tools/generate_unified_client.py.
124+
Wraps all LINE API subpackages into a single async client so that
125+
every API method can be called through one instance.
126+
See :class:`LineBotClient` for details.
127+
128+
Auto-generated by ``tools/generate_unified_client.py``.
125129
Do not edit manually.
126130
127131
Usage::

‎linebot/v3/audience/api/async_manage_audience.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ class AsyncManageAudience(object):
5353
5454
Do not edit the class manually.
5555
56-
Tip: Use :class:`linebot.v3.AsyncLineBotClient` for a unified client
57-
that combines all LINE API operations into a single instance.
56+
Tip: Use :class:`linebot.v3.AsyncLineBotClient` to call every
57+
LINE API method through a single instance.
5858
"""
5959

6060
def __init__(self, api_client=None):

‎linebot/v3/audience/api/async_manage_audience_blob.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ class AsyncManageAudienceBlob(object):
4040
4141
Do not edit the class manually.
4242
43-
Tip: Use :class:`linebot.v3.AsyncLineBotClient` for a unified client
44-
that combines all LINE API operations into a single instance.
43+
Tip: Use :class:`linebot.v3.AsyncLineBotClient` to call every
44+
LINE API method through a single instance.
4545
"""
4646

4747
def __init__(self, api_client=None):

‎linebot/v3/audience/api/manage_audience.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,8 @@ class ManageAudience(object):
5151
5252
Do not edit the class manually.
5353
54-
Tip: Use :class:`linebot.v3.LineBotClient` for a unified client
55-
that combines all LINE API operations into a single instance.
54+
Tip: Use :class:`linebot.v3.LineBotClient` to call every
55+
LINE API method through a single instance.
5656
"""
5757

5858
def __init__(self, api_client=None):

‎linebot/v3/audience/api/manage_audience_blob.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ class ManageAudienceBlob(object):
3838
3939
Do not edit the class manually.
4040
41-
Tip: Use :class:`linebot.v3.LineBotClient` for a unified client
42-
that combines all LINE API operations into a single instance.
41+
Tip: Use :class:`linebot.v3.LineBotClient` to call every
42+
LINE API method through a single instance.
4343
"""
4444

4545
def __init__(self, api_client=None):

‎linebot/v3/audience/docs/Adaccount.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Adaccount
2+
3+
Adaccount
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**name** | **str** | Ad account name. | [optional]
9+
10+
## Example
11+
12+
```python
13+
from linebot.v3.audience.models.adaccount import Adaccount
14+
15+
# TODO update the JSON string below
16+
json = "{}"
17+
# create an instance of Adaccount from a JSON string
18+
adaccount_instance = Adaccount.from_json(json)
19+
# print the JSON string representation of the object
20+
print Adaccount.to_json()
21+
22+
# convert the object into a dict
23+
adaccount_dict = adaccount_instance.to_dict()
24+
# create an instance of Adaccount from a dict
25+
adaccount_form_dict = adaccount.from_dict(adaccount_dict)
26+
```
27+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28+
29+

‎linebot/v3/audience/docs/AddAudienceToAudienceGroupRequest.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# AddAudienceToAudienceGroupRequest
2+
3+
Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**audience_group_id** | **int** | The audience ID. | [optional]
9+
**upload_description** | **str** | The audience's name. | [optional]
10+
**audiences** | [**List[Audience]**](Audience.md) | An array of up to 10,000 user IDs or IFAs. | [optional]
11+
12+
## Example
13+
14+
```python
15+
from linebot.v3.audience.models.add_audience_to_audience_group_request import AddAudienceToAudienceGroupRequest
16+
17+
# TODO update the JSON string below
18+
json = "{}"
19+
# create an instance of AddAudienceToAudienceGroupRequest from a JSON string
20+
add_audience_to_audience_group_request_instance = AddAudienceToAudienceGroupRequest.from_json(json)
21+
# print the JSON string representation of the object
22+
print AddAudienceToAudienceGroupRequest.to_json()
23+
24+
# convert the object into a dict
25+
add_audience_to_audience_group_request_dict = add_audience_to_audience_group_request_instance.to_dict()
26+
# create an instance of AddAudienceToAudienceGroupRequest from a dict
27+
add_audience_to_audience_group_request_form_dict = add_audience_to_audience_group_request.from_dict(add_audience_to_audience_group_request_dict)
28+
```
29+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
30+
31+

‎linebot/v3/audience/docs/Audience.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Audience
2+
3+
Audience
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**id** | **str** | A user ID or IFA. You can specify an empty array. | [optional]
9+
10+
## Example
11+
12+
```python
13+
from linebot.v3.audience.models.audience import Audience
14+
15+
# TODO update the JSON string below
16+
json = "{}"
17+
# create an instance of Audience from a JSON string
18+
audience_instance = Audience.from_json(json)
19+
# print the JSON string representation of the object
20+
print Audience.to_json()
21+
22+
# convert the object into a dict
23+
audience_dict = audience_instance.to_dict()
24+
# create an instance of Audience from a dict
25+
audience_form_dict = audience.from_dict(audience_dict)
26+
```
27+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
28+
29+

‎linebot/v3/audience/docs/AudienceGroup.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# AudienceGroup
2+
3+
Audience group
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
**audience_group_id** | **int** | The audience ID. | [optional]
9+
**type** | [**AudienceGroupType**](AudienceGroupType.md) | | [optional]
10+
**description** | **str** | The audience's name. | [optional]
11+
**status** | [**AudienceGroupStatus**](AudienceGroupStatus.md) | | [optional]
12+
**failed_type** | [**AudienceGroupFailedType**](AudienceGroupFailedType.md) | | [optional]
13+
**audience_count** | **int** | The number of users included in the audience. | [optional]
14+
**created** | **int** | When the audience was created (in UNIX time). | [optional]
15+
**request_id** | **str** | The request ID that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK or IMP. | [optional]
16+
**click_url** | **str** | The URL that was specified when the audience was created. This is only included when `audienceGroup.type` is CLICK and link URL is specified. | [optional]
17+
**is_ifa_audience** | **bool** | The value indicating the type of account to be sent, as specified when creating the audience for uploading user IDs. | [optional]
18+
**permission** | [**AudienceGroupPermission**](AudienceGroupPermission.md) | | [optional]
19+
**create_route** | [**AudienceGroupCreateRoute**](AudienceGroupCreateRoute.md) | | [optional]
20+
21+
## Example
22+
23+
```python
24+
from linebot.v3.audience.models.audience_group import AudienceGroup
25+
26+
# TODO update the JSON string below
27+
json = "{}"
28+
# create an instance of AudienceGroup from a JSON string
29+
audience_group_instance = AudienceGroup.from_json(json)
30+
# print the JSON string representation of the object
31+
print AudienceGroup.to_json()
32+
33+
# convert the object into a dict
34+
audience_group_dict = audience_group_instance.to_dict()
35+
# create an instance of AudienceGroup from a dict
36+
audience_group_form_dict = audience_group.from_dict(audience_group_dict)
37+
```
38+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
39+
40+

‎linebot/v3/audience/docs/AudienceGroupCreateRoute.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# AudienceGroupCreateRoute
2+
3+
How the audience was created. One of: - `OA_MANAGER`: Audience created with [LINE Official Account Manager](https://manager.line.biz/). - `MESSAGING_API`: Audience created with Messaging API. - `POINT_AD`: Audience created with [LINE Points Ads](https://www.linebiz.com/jp/service/line-point-ad/) (Japanese only). - `AD_MANAGER`: Audience created with [LINE Ads](https://admanager.line.biz/).
4+
5+
## Properties
6+
Name | Type | Description | Notes
7+
------------ | ------------- | ------------- | -------------
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
10+
11+

0 commit comments

Comments
 (0)