Skip to content

Add v3 doc #989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
habara-k wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add v3 doc #989

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef0d503
Add v3 doc
habara-k Apr 14, 2026
28c9f16
Add deprecated warning to docs
habara-k Apr 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Contents:
.. toctree::
:maxdepth: 4

linebot.v3
linebot


Expand Down
8 changes: 6 additions & 2 deletions docs/source/linebot.models.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
linebot.models package
======================
linebot.models package (deprecated)
====================================

.. warning::

**Deprecated.** Use :doc:`linebot.v3 <linebot.v3>` instead.

linebot.models.actions module
------------------------------
Expand Down
8 changes: 6 additions & 2 deletions docs/source/linebot.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
linebot package
===============
linebot package (deprecated)
============================

.. warning::

**Deprecated.** Use :doc:`linebot.v3 <linebot.v3>` instead.

linebot.api module
------------------
Expand Down
22 changes: 22 additions & 0 deletions docs/source/linebot.v3.audience.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
linebot.v3.audience package
===========================

API
---

.. autoclass:: linebot.v3.audience.api.manage_audience.ManageAudience
:members:

.. autoclass:: linebot.v3.audience.api.async_manage_audience.AsyncManageAudience
:members:

.. autoclass:: linebot.v3.audience.api.manage_audience_blob.ManageAudienceBlob
:members:

.. autoclass:: linebot.v3.audience.api.async_manage_audience_blob.AsyncManageAudienceBlob
:members:

Models
------

.. automodule:: linebot.v3.audience.models
16 changes: 16 additions & 0 deletions docs/source/linebot.v3.insight.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
linebot.v3.insight package
==========================

API
---

.. autoclass:: linebot.v3.insight.api.insight.Insight
:members:

.. autoclass:: linebot.v3.insight.api.async_insight.AsyncInsight
:members:

Models
------

.. automodule:: linebot.v3.insight.models
16 changes: 16 additions & 0 deletions docs/source/linebot.v3.liff.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
linebot.v3.liff package
=======================

API
---

.. autoclass:: linebot.v3.liff.api.liff.Liff
:members:

.. autoclass:: linebot.v3.liff.api.async_liff.AsyncLiff
:members:

Models
------

.. automodule:: linebot.v3.liff.models
22 changes: 22 additions & 0 deletions docs/source/linebot.v3.messaging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
linebot.v3.messaging package
============================

API
---

.. autoclass:: linebot.v3.messaging.api.messaging_api.MessagingApi
:members:

.. autoclass:: linebot.v3.messaging.api.async_messaging_api.AsyncMessagingApi
:members:

.. autoclass:: linebot.v3.messaging.api.messaging_api_blob.MessagingApiBlob
:members:

.. autoclass:: linebot.v3.messaging.api.async_messaging_api_blob.AsyncMessagingApiBlob
:members:

Models
------

.. automodule:: linebot.v3.messaging.models
16 changes: 16 additions & 0 deletions docs/source/linebot.v3.module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
linebot.v3.module package
=========================

API
---

.. autoclass:: linebot.v3.module.api.line_module.LineModule
:members:

.. autoclass:: linebot.v3.module.api.async_line_module.AsyncLineModule
:members:

Models
------

.. automodule:: linebot.v3.module.models
16 changes: 16 additions & 0 deletions docs/source/linebot.v3.moduleattach.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
linebot.v3.moduleattach package
================================

API
---

.. autoclass:: linebot.v3.moduleattach.api.line_module_attach.LineModuleAttach
:members:

.. autoclass:: linebot.v3.moduleattach.api.async_line_module_attach.AsyncLineModuleAttach
:members:

Models
------

.. automodule:: linebot.v3.moduleattach.models
16 changes: 16 additions & 0 deletions docs/source/linebot.v3.oauth.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
linebot.v3.oauth package
========================

API
---

.. autoclass:: linebot.v3.oauth.api.channel_access_token.ChannelAccessToken
:members:

.. autoclass:: linebot.v3.oauth.api.async_channel_access_token.AsyncChannelAccessToken
:members:

Models
------

.. automodule:: linebot.v3.oauth.models
30 changes: 30 additions & 0 deletions docs/source/linebot.v3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
linebot.v3 package
==================

.. automodule:: linebot.v3

linebot.v3.webhook module
--------------------------

.. automodule:: linebot.v3.webhook
:exclude-members: compare_digest

linebot.v3.exceptions module
-----------------------------

.. automodule:: linebot.v3.exceptions

Subpackages
-----------

.. toctree::

linebot.v3.messaging
linebot.v3.webhooks
linebot.v3.oauth
linebot.v3.audience
linebot.v3.insight
linebot.v3.liff
linebot.v3.module
linebot.v3.moduleattach
linebot.v3.shop
16 changes: 16 additions & 0 deletions docs/source/linebot.v3.shop.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
linebot.v3.shop package
=======================

API
---

.. autoclass:: linebot.v3.shop.api.shop.Shop
:members:

.. autoclass:: linebot.v3.shop.api.async_shop.AsyncShop
:members:

Models
------

.. automodule:: linebot.v3.shop.models
7 changes: 7 additions & 0 deletions docs/source/linebot.v3.webhooks.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
linebot.v3.webhooks package
===========================

Models
------

.. automodule:: linebot.v3.webhooks.models
8 changes: 4 additions & 4 deletions generator/src/main/resources/python-nextgen-custom-client/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,10 @@ class {{classname}}(object):
{{/asyncio}}
@validate_arguments
def {{operationId}}(self, {{#allParams}}{{paramName}} : {{{vendorExtensions.x-py-typing}}}{{^required}} = None{{/required}}, {{/allParams}}{{#asyncio}}async_req: Optional[bool]=None, {{/asyncio}}**kwargs) -> {{#asyncio}}Union[{{{returnType}}}{{^returnType}}None{{/returnType}}, Awaitable[{{{returnType}}}{{^returnType}}None{{/returnType}}]]{{/asyncio}}{{^asyncio}}{{{returnType}}}{{^returnType}}None{{/returnType}}{{/asyncio}}: # noqa: E501
"""{{#isDeprecated}}(Deprecated) {{/isDeprecated}}{{{summary}}}{{^summary}}{{operationId}}{{/summary}} # noqa: E501
"""{{#isDeprecated}}(Deprecated) {{/isDeprecated}}{{{summary}}}

{{#notes}}
{{{.}}} # noqa: E501
{{{.}}}
{{/notes}}
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
Expand Down Expand Up @@ -86,10 +86,10 @@ class {{classname}}(object):

@validate_arguments
def {{operationId}}_with_http_info(self, {{#allParams}}{{paramName}} : {{{vendorExtensions.x-py-typing}}}{{^required}} = None{{/required}}, {{/allParams}}**kwargs) -> ApiResponse: # noqa: E501
"""{{#isDeprecated}}(Deprecated) {{/isDeprecated}}{{{summary}}}{{^summary}}{{operationId}}{{/summary}} # noqa: E501
"""{{#isDeprecated}}(Deprecated) {{/isDeprecated}}{{{summary}}}

{{#notes}}
{{{.}}} # noqa: E501
{{{.}}}
{{/notes}}
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True
Expand Down
22 changes: 4 additions & 18 deletions generator/src/main/resources/python-nextgen-custom-client/asyncio/async_api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,16 +48,11 @@ class Async{{classname}}(object):

@validate_arguments
def {{operationId}}(self, {{#allParams}}{{paramName}} : {{{vendorExtensions.x-py-typing}}}{{^required}} = None{{/required}}, {{/allParams}}async_req: Optional[bool]=None, **kwargs) -> Union[{{{returnType}}}{{^returnType}}None{{/returnType}}, Awaitable[{{{returnType}}}{{^returnType}}None{{/returnType}}]]: # noqa: E501
"""{{#isDeprecated}}(Deprecated) {{/isDeprecated}}{{{summary}}}{{^summary}}{{operationId}}{{/summary}} # noqa: E501
"""{{#isDeprecated}}(Deprecated) {{/isDeprecated}}{{{summary}}}

{{#notes}}
{{{.}}} # noqa: E501
{{{.}}}
{{/notes}}
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.{{operationId}}({{#allParams}}{{paramName}}, {{/allParams}}async_req=True)
>>> result = thread.get()

{{#allParams}}
:param {{paramName}}:{{#description}} {{{.}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional){{/optional}}
Expand All @@ -70,8 +65,6 @@ class Async{{classname}}(object):
timeout. It can also be a pair (tuple) of
(connection, read) timeouts.
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: {{returnType}}{{^returnType}}None{{/returnType}}
"""
kwargs['_return_http_data_only'] = True
Expand All @@ -83,16 +76,11 @@ class Async{{classname}}(object):

@validate_arguments
def {{operationId}}_with_http_info(self, {{#allParams}}{{paramName}} : {{{vendorExtensions.x-py-typing}}}{{^required}} = None{{/required}}, {{/allParams}}**kwargs) -> ApiResponse: # noqa: E501
"""{{#isDeprecated}}(Deprecated) {{/isDeprecated}}{{{summary}}}{{^summary}}{{operationId}}{{/summary}} # noqa: E501
"""{{#isDeprecated}}(Deprecated) {{/isDeprecated}}{{{summary}}}

{{#notes}}
{{{.}}} # noqa: E501
{{{.}}}
{{/notes}}
This method makes a synchronous HTTP request by default. To make an
asynchronous HTTP request, please pass async_req=True

>>> thread = api.{{operationId}}_with_http_info({{#allParams}}{{paramName}}, {{/allParams}}async_req=True)
>>> result = thread.get()

{{#allParams}}
:param {{paramName}}:{{#description}} {{{.}}}{{/description}}{{#required}} (required){{/required}}{{#optional}}(optional){{/optional}}
Expand All @@ -118,8 +106,6 @@ class Async{{classname}}(object):
:type _request_auth: dict, optional
:type _content_type: string, optional: force content-type for the request
:return: Returns the result object.
If the method is called asynchronously,
returns the request thread.
:rtype: {{#returnType}}tuple({{.}}, status_code(int), headers(HTTPHeaderDict)){{/returnType}}{{^returnType}}None{{/returnType}}
"""

Expand Down
Loading