From 723d311aa4d5de883e8b236a6e75f8320e73ddc8 Mon Sep 17 00:00:00 2001 From: lykmapipo Date: Tue, 13 Jan 2026 12:39:37 +0300 Subject: [PATCH] chore(release): bump to v1.4.0 --- CHANGELOG.md | 16 ++ CITATION.cff | 6 +- INSTALLATION.md | 2 +- .../gfwapiclient/gfwapiclient.__version__.rst | 2 +- .../gfwapiclient.client.client.rst | 13 ++ ...ces.bulk_downloads.base.models.request.rst | 172 ++++++++++++++ ...es.bulk_downloads.base.models.response.rst | 215 ++++++++++++++++++ ...t.resources.bulk_downloads.base.models.rst | 17 ++ ...piclient.resources.bulk_downloads.base.rst | 16 ++ ...ources.bulk_downloads.create.endpoints.rst | 52 +++++ ...s.bulk_downloads.create.models.request.rst | 104 +++++++++ ....bulk_downloads.create.models.response.rst | 80 +++++++ ...resources.bulk_downloads.create.models.rst | 17 ++ ...client.resources.bulk_downloads.create.rst | 25 ++ ...ources.bulk_downloads.detail.endpoints.rst | 52 +++++ ....bulk_downloads.detail.models.response.rst | 80 +++++++ ...resources.bulk_downloads.detail.models.rst | 16 ++ ...client.resources.bulk_downloads.detail.rst | 25 ++ ...esources.bulk_downloads.file.endpoints.rst | 52 +++++ ...ces.bulk_downloads.file.models.request.rst | 69 ++++++ ...es.bulk_downloads.file.models.response.rst | 87 +++++++ ...t.resources.bulk_downloads.file.models.rst | 17 ++ ...piclient.resources.bulk_downloads.file.rst | 25 ++ ...esources.bulk_downloads.list.endpoints.rst | 57 +++++ ...ces.bulk_downloads.list.models.request.rst | 90 ++++++++ ...es.bulk_downloads.list.models.response.rst | 80 +++++++ ...t.resources.bulk_downloads.list.models.rst | 17 ++ ...piclient.resources.bulk_downloads.list.rst | 25 ++ ...sources.bulk_downloads.query.endpoints.rst | 71 ++++++ ...lk_downloads.query.models.base.request.rst | 97 ++++++++ ...k_downloads.query.models.base.response.rst | 98 ++++++++ ...urces.bulk_downloads.query.models.base.rst | 17 ++ ...els.fixed_infrastructure_data.response.rst | 149 ++++++++++++ ...query.models.fixed_infrastructure_data.rst | 16 ++ ....resources.bulk_downloads.query.models.rst | 17 ++ ...iclient.resources.bulk_downloads.query.rst | 25 ++ ...ent.resources.bulk_downloads.resources.rst | 102 +++++++++ .../gfwapiclient.resources.bulk_downloads.rst | 53 +++++ .../gfwapiclient/gfwapiclient.resources.rst | 3 +- docs/source/conf.py | 2 +- pyproject.toml | 7 +- src/gfwapiclient/__version__.py | 2 +- 42 files changed, 2077 insertions(+), 11 deletions(-) create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.base.models.request.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.base.models.response.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.base.models.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.base.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.endpoints.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.models.request.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.models.response.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.models.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.detail.endpoints.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.detail.models.response.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.detail.models.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.detail.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.endpoints.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.models.request.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.models.response.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.models.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.endpoints.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.models.request.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.models.response.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.models.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.endpoints.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.base.request.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.base.response.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.base.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.resources.rst create mode 100644 docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.rst diff --git a/CHANGELOG.md b/CHANGELOG.md index 588f9d1..b8222fe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,19 @@ +## v1.4.0 (2026-01-13) + +### Feat + +- **bulk-downloads**: implement bulk report query API endpoints and models +- **bulk-downloads**: implement bulk report API endpoints +- **bulk-downloads**: implement bulk report file API endpoints and models +- **bulk-downloads**: implement bulk report list API endpoints and models +- **bulk-downloads**: implement bulk report detail API endpoints and models +- **bulk-downloads**: implement bulk report create API endpoints and models +- **bulk-downloads**: add base request and response models for Bulk Download API + +### Fix + +- **bulk-downloads**: correct typehints in docstrings + ## v1.3.0 (2025-09-17) ### Feat diff --git a/CITATION.cff b/CITATION.cff index a7d16d5..294d9af 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,4 +1,4 @@ -cff-version: 1.3.0 +cff-version: 1.2.0 title: "GlobalFishingWatch/gfw-api-python-client: Global Fishing Watch APIs Python Client" message: "If you use this software, please cite it using the metadata below." authors: @@ -6,13 +6,13 @@ authors: website: "https://globalfishingwatch.org/" email: "apis@globalfishingwatch.org" abstract: "Python package for accessing data from Global Fishing Watch APIs." -version: "1.3.0" +version: "1.4.0" doi: 10.5281/zenodo.15617432 license: "Apache-2.0" license-url: "https://github.com/GlobalFishingWatch/gfw-api-python-client/blob/develop/LICENSE" repository-code: "https://github.com/GlobalFishingWatch/gfw-api-python-client" url: "https://github.com/GlobalFishingWatch/gfw-api-python-client" -date-released: "2025-09-17" +date-released: "2026-01-13" keywords: - "global fishing watch" - "gfw" diff --git a/INSTALLATION.md b/INSTALLATION.md index 5217519..c02060e 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -127,7 +127,7 @@ print(gfw.__version__) If the installation was successful, you should see the installed version number, for example: ``` -3.0.0 +1.4.0 ``` You can also try a basic import to ensure the package is accessible: diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.__version__.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.__version__.rst index 7c24a73..6a2aa72 100644 --- a/docs/source/apidocs/gfwapiclient/gfwapiclient.__version__.rst +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.__version__.rst @@ -25,6 +25,6 @@ API .. py:data:: __version__ :canonical: gfwapiclient.__version__.__version__ - :value: '1.3.0' + :value: '1.4.0' .. autodoc2-docstring:: gfwapiclient.__version__.__version__ diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.client.client.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.client.client.rst index 03d326a..a24a01a 100644 --- a/docs/source/apidocs/gfwapiclient/gfwapiclient.client.client.rst +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.client.client.rst @@ -94,6 +94,13 @@ API .. autodoc2-docstring:: gfwapiclient.client.client.Client._datasets + .. py:attribute:: _bulk_downloads + :canonical: gfwapiclient.client.client.Client._bulk_downloads + :type: gfwapiclient.resources.BulkDownloadResource + :value: None + + .. autodoc2-docstring:: gfwapiclient.client.client.Client._bulk_downloads + .. py:attribute:: _references :canonical: gfwapiclient.client.client.Client._references :type: gfwapiclient.resources.ReferenceResource @@ -131,6 +138,12 @@ API .. autodoc2-docstring:: gfwapiclient.client.client.Client.datasets + .. py:property:: bulk_downloads + :canonical: gfwapiclient.client.client.Client.bulk_downloads + :type: gfwapiclient.resources.BulkDownloadResource + + .. autodoc2-docstring:: gfwapiclient.client.client.Client.bulk_downloads + .. py:property:: references :canonical: gfwapiclient.client.client.Client.references :type: gfwapiclient.resources.ReferenceResource diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.base.models.request.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.base.models.request.rst new file mode 100644 index 0000000..5e1e560 --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.base.models.request.rst @@ -0,0 +1,172 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.base.models.request` +=================================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.base.models.request + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkReportDataset ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportDataset + :summary: + * - :py:obj:`BulkReportFormat ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFormat + :summary: + * - :py:obj:`BulkReportGeometry ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportGeometry + :summary: + * - :py:obj:`BulkReportRegion ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportRegion + :summary: + * - :py:obj:`BulkReportFileType ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.__all__ + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.base.models.request.__all__ + :value: ['BulkReportDataset', 'BulkReportFileType', 'BulkReportFormat', 'BulkReportGeometry', 'BulkReportReg... + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.__all__ + +.. py:class:: BulkReportDataset() + :canonical: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportDataset + + Bases: :py:obj:`str`, :py:obj:`enum.Enum` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportDataset + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportDataset.__init__ + + .. py:attribute:: FIXED_INFRASTRUCTURE_DATA_LATEST + :canonical: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportDataset.FIXED_INFRASTRUCTURE_DATA_LATEST + :value: 'public-fixed-infrastructure-data:latest' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportDataset.FIXED_INFRASTRUCTURE_DATA_LATEST + +.. py:class:: BulkReportFormat() + :canonical: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFormat + + Bases: :py:obj:`str`, :py:obj:`enum.Enum` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFormat + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFormat.__init__ + + .. py:attribute:: CSV + :canonical: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFormat.CSV + :value: 'CSV' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFormat.CSV + + .. py:attribute:: JSON + :canonical: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFormat.JSON + :value: 'JSON' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFormat.JSON + +.. py:class:: BulkReportGeometry(/, **data: typing.Any) + :canonical: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportGeometry + + Bases: :py:obj:`gfwapiclient.base.models.BaseModel` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportGeometry + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportGeometry.__init__ + + .. py:attribute:: type + :canonical: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportGeometry.type + :type: str + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportGeometry.type + + .. py:attribute:: coordinates + :canonical: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportGeometry.coordinates + :type: typing.Any + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportGeometry.coordinates + +.. py:class:: BulkReportRegion(/, **data: typing.Any) + :canonical: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportRegion + + Bases: :py:obj:`gfwapiclient.base.models.BaseModel` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportRegion + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportRegion.__init__ + + .. py:attribute:: dataset + :canonical: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportRegion.dataset + :type: typing.Optional[str] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportRegion.dataset + + .. py:attribute:: id + :canonical: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportRegion.id + :type: typing.Optional[typing.Union[str, int]] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportRegion.id + +.. py:class:: BulkReportFileType() + :canonical: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType + + Bases: :py:obj:`str`, :py:obj:`enum.Enum` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType.__init__ + + .. py:attribute:: DATA + :canonical: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType.DATA + :value: 'DATA' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType.DATA + + .. py:attribute:: README + :canonical: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType.README + :value: 'README' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType.README + + .. py:attribute:: GEOM + :canonical: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType.GEOM + :value: 'GEOM' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType.GEOM diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.base.models.response.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.base.models.response.rst new file mode 100644 index 0000000..effcd0c --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.base.models.response.rst @@ -0,0 +1,215 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.base.models.response` +==================================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.base.models.response + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkReportStatus ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus + :summary: + * - :py:obj:`BulkReportGeography ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportGeography + :summary: + * - :py:obj:`BulkReportItem ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.__all__ + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.__all__ + :value: ['BulkReportItem'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.__all__ + +.. py:class:: BulkReportStatus() + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus + + Bases: :py:obj:`str`, :py:obj:`enum.Enum` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus.__init__ + + .. py:attribute:: PENDING + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus.PENDING + :value: 'pending' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus.PENDING + + .. py:attribute:: PROCESSING + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus.PROCESSING + :value: 'processing' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus.PROCESSING + + .. py:attribute:: DONE + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus.DONE + :value: 'done' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus.DONE + + .. py:attribute:: FAILED + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus.FAILED + :value: 'failed' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus.FAILED + +.. py:class:: BulkReportGeography(/, **data: typing.Any) + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportGeography + + Bases: :py:obj:`gfwapiclient.base.models.BaseModel` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportGeography + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportGeography.__init__ + + .. py:attribute:: type + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportGeography.type + :type: typing.Optional[str] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportGeography.type + + .. py:attribute:: dataset + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportGeography.dataset + :type: typing.Optional[str] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportGeography.dataset + + .. py:attribute:: id + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportGeography.id + :type: typing.Optional[typing.Union[str, int]] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportGeography.id + +.. py:class:: BulkReportItem(/, **data: typing.Any) + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem + + Bases: :py:obj:`gfwapiclient.http.models.ResultItem` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.__init__ + + .. py:attribute:: id + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.id + :type: typing.Optional[str] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.id + + .. py:attribute:: name + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.name + :type: typing.Optional[str] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.name + + .. py:attribute:: file_path + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.file_path + :type: typing.Optional[str] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.file_path + + .. py:attribute:: format + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.format + :type: typing.Optional[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFormat] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.format + + .. py:attribute:: filters + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.filters + :type: typing.Optional[typing.List[str]] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.filters + + .. py:attribute:: geom + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.geom + :type: typing.Optional[gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportGeography] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.geom + + .. py:attribute:: status + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.status + :type: typing.Optional[gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.status + + .. py:attribute:: owner_id + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.owner_id + :type: typing.Optional[typing.Union[str, int]] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.owner_id + + .. py:attribute:: owner_type + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.owner_type + :type: typing.Optional[str] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.owner_type + + .. py:attribute:: created_at + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.created_at + :type: typing.Optional[datetime.datetime] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.created_at + + .. py:attribute:: updated_at + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.updated_at + :type: typing.Optional[datetime.datetime] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.updated_at + + .. py:attribute:: file_size + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.file_size + :type: typing.Optional[float] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.file_size + + .. py:method:: empty_datetime_str_to_none(value: typing.Any) -> typing.Optional[typing.Any] + :canonical: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.empty_datetime_str_to_none + :classmethod: + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem.empty_datetime_str_to_none diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.base.models.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.base.models.rst new file mode 100644 index 0000000..afcd13a --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.base.models.rst @@ -0,0 +1,17 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.base.models` +=========================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.base.models + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models + :allowtitles: + +Submodules +---------- + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + gfwapiclient.resources.bulk_downloads.base.models.request + gfwapiclient.resources.bulk_downloads.base.models.response diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.base.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.base.rst new file mode 100644 index 0000000..db404ab --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.base.rst @@ -0,0 +1,16 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.base` +==================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.base + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base + :allowtitles: + +Subpackages +----------- + +.. toctree:: + :titlesonly: + :maxdepth: 3 + + gfwapiclient.resources.bulk_downloads.base.models diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.endpoints.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.endpoints.rst new file mode 100644 index 0000000..706ac88 --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.endpoints.rst @@ -0,0 +1,52 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.create.endpoints` +================================================================ + +.. py:module:: gfwapiclient.resources.bulk_downloads.create.endpoints + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.endpoints + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkReportCreateEndPoint ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.endpoints.BulkReportCreateEndPoint + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.endpoints.__all__ + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.create.endpoints.__all__ + :value: ['BulkReportCreateEndPoint'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.endpoints.__all__ + +.. py:class:: BulkReportCreateEndPoint(*, request_body: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody, http_client: gfwapiclient.http.client.HTTPClient) + :canonical: gfwapiclient.resources.bulk_downloads.create.endpoints.BulkReportCreateEndPoint + + Bases: :py:obj:`gfwapiclient.http.endpoints.PostEndPoint`\ [\ :py:obj:`gfwapiclient.http.models.RequestParams`\ , :py:obj:`gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody`\ , :py:obj:`gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateItem`\ , :py:obj:`gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateResult`\ ] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.endpoints.BulkReportCreateEndPoint + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.endpoints.BulkReportCreateEndPoint.__init__ diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.models.request.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.models.request.rst new file mode 100644 index 0000000..d1be76b --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.models.request.rst @@ -0,0 +1,104 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.create.models.request` +===================================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.create.models.request + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.request + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkReportCreateBody ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.request.__all__ + :summary: + * - :py:obj:`BULK_REPORT_CREATE_BODY_VALIDATION_ERROR_MESSAGE ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.request.BULK_REPORT_CREATE_BODY_VALIDATION_ERROR_MESSAGE + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.create.models.request.__all__ + :value: ['BulkReportCreateBody'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.request.__all__ + +.. py:data:: BULK_REPORT_CREATE_BODY_VALIDATION_ERROR_MESSAGE + :canonical: gfwapiclient.resources.bulk_downloads.create.models.request.BULK_REPORT_CREATE_BODY_VALIDATION_ERROR_MESSAGE + :type: typing.Final[str] + :value: 'Create bulk report request body validation failed.' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.request.BULK_REPORT_CREATE_BODY_VALIDATION_ERROR_MESSAGE + +.. py:class:: BulkReportCreateBody(/, **data: typing.Any) + :canonical: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody + + Bases: :py:obj:`gfwapiclient.http.models.RequestBody` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody.__init__ + + .. py:attribute:: name + :canonical: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody.name + :type: typing.Optional[str] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody.name + + .. py:attribute:: dataset + :canonical: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody.dataset + :type: typing.Optional[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportDataset] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody.dataset + + .. py:attribute:: geojson + :canonical: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody.geojson + :type: typing.Optional[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportGeometry] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody.geojson + + .. py:attribute:: format + :canonical: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody.format + :type: typing.Optional[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFormat] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody.format + + .. py:attribute:: region + :canonical: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody.region + :type: typing.Optional[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportRegion] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody.region + + .. py:attribute:: filters + :canonical: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody.filters + :type: typing.Optional[typing.List[str]] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody.filters diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.models.response.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.models.response.rst new file mode 100644 index 0000000..87543a9 --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.models.response.rst @@ -0,0 +1,80 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.create.models.response` +====================================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.create.models.response + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.response + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkReportCreateItem ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateItem + :summary: + * - :py:obj:`BulkReportCreateResult ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateResult + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.response.__all__ + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.create.models.response.__all__ + :value: ['BulkReportCreateItem', 'BulkReportCreateResult'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.response.__all__ + +.. py:class:: BulkReportCreateItem(/, **data: typing.Any) + :canonical: gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateItem + + Bases: :py:obj:`gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateItem + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateItem.__init__ + +.. py:class:: BulkReportCreateResult(data: gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateItem) + :canonical: gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateResult + + Bases: :py:obj:`gfwapiclient.http.models.Result`\ [\ :py:obj:`gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateItem`\ ] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateResult + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateResult.__init__ + + .. py:attribute:: _result_item_class + :canonical: gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateResult._result_item_class + :type: typing.Type[gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateItem] + :value: None + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateResult._result_item_class + + .. py:attribute:: _data + :canonical: gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateResult._data + :type: gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateItem + :value: None + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateResult._data diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.models.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.models.rst new file mode 100644 index 0000000..e5611bc --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.models.rst @@ -0,0 +1,17 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.create.models` +============================================================= + +.. py:module:: gfwapiclient.resources.bulk_downloads.create.models + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create.models + :allowtitles: + +Submodules +---------- + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + gfwapiclient.resources.bulk_downloads.create.models.request + gfwapiclient.resources.bulk_downloads.create.models.response diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.rst new file mode 100644 index 0000000..2208e32 --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.create.rst @@ -0,0 +1,25 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.create` +====================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.create + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.create + :allowtitles: + +Subpackages +----------- + +.. toctree:: + :titlesonly: + :maxdepth: 3 + + gfwapiclient.resources.bulk_downloads.create.models + +Submodules +---------- + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + gfwapiclient.resources.bulk_downloads.create.endpoints diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.detail.endpoints.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.detail.endpoints.rst new file mode 100644 index 0000000..1c640b7 --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.detail.endpoints.rst @@ -0,0 +1,52 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.detail.endpoints` +================================================================ + +.. py:module:: gfwapiclient.resources.bulk_downloads.detail.endpoints + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.endpoints + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkReportDetailEndPoint ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.endpoints.BulkReportDetailEndPoint + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.endpoints.__all__ + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.detail.endpoints.__all__ + :value: ['BulkReportDetailEndPoint'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.endpoints.__all__ + +.. py:class:: BulkReportDetailEndPoint(*, bulk_report_id: str, http_client: gfwapiclient.http.client.HTTPClient) + :canonical: gfwapiclient.resources.bulk_downloads.detail.endpoints.BulkReportDetailEndPoint + + Bases: :py:obj:`gfwapiclient.http.endpoints.GetEndPoint`\ [\ :py:obj:`gfwapiclient.http.models.RequestParams`\ , :py:obj:`gfwapiclient.http.models.RequestBody`\ , :py:obj:`gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailItem`\ , :py:obj:`gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailResult`\ ] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.endpoints.BulkReportDetailEndPoint + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.endpoints.BulkReportDetailEndPoint.__init__ diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.detail.models.response.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.detail.models.response.rst new file mode 100644 index 0000000..c997a5a --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.detail.models.response.rst @@ -0,0 +1,80 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.detail.models.response` +====================================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.detail.models.response + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.models.response + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkReportDetailItem ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailItem + :summary: + * - :py:obj:`BulkReportDetailResult ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailResult + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.models.response.__all__ + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.detail.models.response.__all__ + :value: ['BulkReportDetailItem', 'BulkReportDetailResult'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.models.response.__all__ + +.. py:class:: BulkReportDetailItem(/, **data: typing.Any) + :canonical: gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailItem + + Bases: :py:obj:`gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailItem + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailItem.__init__ + +.. py:class:: BulkReportDetailResult(data: gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailItem) + :canonical: gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailResult + + Bases: :py:obj:`gfwapiclient.http.models.Result`\ [\ :py:obj:`gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailItem`\ ] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailResult + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailResult.__init__ + + .. py:attribute:: _result_item_class + :canonical: gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailResult._result_item_class + :type: typing.Type[gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailItem] + :value: None + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailResult._result_item_class + + .. py:attribute:: _data + :canonical: gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailResult._data + :type: gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailItem + :value: None + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailResult._data diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.detail.models.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.detail.models.rst new file mode 100644 index 0000000..33a4c1d --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.detail.models.rst @@ -0,0 +1,16 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.detail.models` +============================================================= + +.. py:module:: gfwapiclient.resources.bulk_downloads.detail.models + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail.models + :allowtitles: + +Submodules +---------- + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + gfwapiclient.resources.bulk_downloads.detail.models.response diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.detail.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.detail.rst new file mode 100644 index 0000000..bd82483 --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.detail.rst @@ -0,0 +1,25 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.detail` +====================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.detail + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.detail + :allowtitles: + +Subpackages +----------- + +.. toctree:: + :titlesonly: + :maxdepth: 3 + + gfwapiclient.resources.bulk_downloads.detail.models + +Submodules +---------- + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + gfwapiclient.resources.bulk_downloads.detail.endpoints diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.endpoints.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.endpoints.rst new file mode 100644 index 0000000..ddd8b1d --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.endpoints.rst @@ -0,0 +1,52 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.file.endpoints` +============================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.file.endpoints + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.endpoints + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkReportFileEndPoint ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.endpoints.BulkReportFileEndPoint + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.endpoints.__all__ + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.file.endpoints.__all__ + :value: ['BulkReportFileEndPoint'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.endpoints.__all__ + +.. py:class:: BulkReportFileEndPoint(*, bulk_report_id: str, request_params: gfwapiclient.resources.bulk_downloads.file.models.request.BulkReportFileParams, http_client: gfwapiclient.http.client.HTTPClient) + :canonical: gfwapiclient.resources.bulk_downloads.file.endpoints.BulkReportFileEndPoint + + Bases: :py:obj:`gfwapiclient.http.endpoints.GetEndPoint`\ [\ :py:obj:`gfwapiclient.resources.bulk_downloads.file.models.request.BulkReportFileParams`\ , :py:obj:`gfwapiclient.http.models.RequestBody`\ , :py:obj:`gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileItem`\ , :py:obj:`gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileResult`\ ] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.endpoints.BulkReportFileEndPoint + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.endpoints.BulkReportFileEndPoint.__init__ diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.models.request.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.models.request.rst new file mode 100644 index 0000000..648642b --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.models.request.rst @@ -0,0 +1,69 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.file.models.request` +=================================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.file.models.request + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.request + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkReportFileParams ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.request.BulkReportFileParams + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.request.__all__ + :summary: + * - :py:obj:`BULK_REPORT_FILE_PARAMS_VALIDATION_ERROR_MESSAGE ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.request.BULK_REPORT_FILE_PARAMS_VALIDATION_ERROR_MESSAGE + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.file.models.request.__all__ + :value: ['BulkReportFileParams'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.request.__all__ + +.. py:data:: BULK_REPORT_FILE_PARAMS_VALIDATION_ERROR_MESSAGE + :canonical: gfwapiclient.resources.bulk_downloads.file.models.request.BULK_REPORT_FILE_PARAMS_VALIDATION_ERROR_MESSAGE + :type: typing.Final[str] + :value: 'Get bulk report file download URL request parameters validation failed.' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.request.BULK_REPORT_FILE_PARAMS_VALIDATION_ERROR_MESSAGE + +.. py:class:: BulkReportFileParams(/, **data: typing.Any) + :canonical: gfwapiclient.resources.bulk_downloads.file.models.request.BulkReportFileParams + + Bases: :py:obj:`gfwapiclient.http.models.RequestParams` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.request.BulkReportFileParams + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.request.BulkReportFileParams.__init__ + + .. py:attribute:: file + :canonical: gfwapiclient.resources.bulk_downloads.file.models.request.BulkReportFileParams.file + :type: typing.Optional[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.request.BulkReportFileParams.file diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.models.response.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.models.response.rst new file mode 100644 index 0000000..cd6e1fd --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.models.response.rst @@ -0,0 +1,87 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.file.models.response` +==================================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.file.models.response + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.response + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkReportFileItem ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileItem + :summary: + * - :py:obj:`BulkReportFileResult ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileResult + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.response.__all__ + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.file.models.response.__all__ + :value: ['BulkReportFileItem', 'BulkReportFileResult'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.response.__all__ + +.. py:class:: BulkReportFileItem(/, **data: typing.Any) + :canonical: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileItem + + Bases: :py:obj:`gfwapiclient.http.models.ResultItem` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileItem + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileItem.__init__ + + .. py:attribute:: url + :canonical: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileItem.url + :type: typing.Optional[str] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileItem.url + +.. py:class:: BulkReportFileResult(data: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileItem) + :canonical: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileResult + + Bases: :py:obj:`gfwapiclient.http.models.Result`\ [\ :py:obj:`gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileItem`\ ] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileResult + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileResult.__init__ + + .. py:attribute:: _result_item_class + :canonical: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileResult._result_item_class + :type: typing.Type[gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileItem] + :value: None + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileResult._result_item_class + + .. py:attribute:: _data + :canonical: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileResult._data + :type: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileItem + :value: None + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileResult._data diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.models.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.models.rst new file mode 100644 index 0000000..04de6be --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.models.rst @@ -0,0 +1,17 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.file.models` +=========================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.file.models + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file.models + :allowtitles: + +Submodules +---------- + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + gfwapiclient.resources.bulk_downloads.file.models.request + gfwapiclient.resources.bulk_downloads.file.models.response diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.rst new file mode 100644 index 0000000..1d99c4c --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.file.rst @@ -0,0 +1,25 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.file` +==================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.file + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.file + :allowtitles: + +Subpackages +----------- + +.. toctree:: + :titlesonly: + :maxdepth: 3 + + gfwapiclient.resources.bulk_downloads.file.models + +Submodules +---------- + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + gfwapiclient.resources.bulk_downloads.file.endpoints diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.endpoints.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.endpoints.rst new file mode 100644 index 0000000..725ab77 --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.endpoints.rst @@ -0,0 +1,57 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.list.endpoints` +============================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.list.endpoints + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.endpoints + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkReportListEndPoint ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.endpoints.BulkReportListEndPoint + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.endpoints.__all__ + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.list.endpoints.__all__ + :value: ['BulkReportListEndPoint'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.endpoints.__all__ + +.. py:class:: BulkReportListEndPoint(*, request_params: gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams, http_client: gfwapiclient.http.client.HTTPClient) + :canonical: gfwapiclient.resources.bulk_downloads.list.endpoints.BulkReportListEndPoint + + Bases: :py:obj:`gfwapiclient.http.endpoints.GetEndPoint`\ [\ :py:obj:`gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams`\ , :py:obj:`gfwapiclient.http.models.RequestBody`\ , :py:obj:`gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListItem`\ , :py:obj:`gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListResult`\ ] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.endpoints.BulkReportListEndPoint + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.endpoints.BulkReportListEndPoint.__init__ + + .. py:method:: _transform_response_data(*, body: typing.Union[typing.List[typing.Dict[str, typing.Any]], typing.Dict[str, typing.Any]]) -> typing.Union[typing.List[typing.Dict[str, typing.Any]], typing.Dict[str, typing.Any]] + :canonical: gfwapiclient.resources.bulk_downloads.list.endpoints.BulkReportListEndPoint._transform_response_data + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.endpoints.BulkReportListEndPoint._transform_response_data diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.models.request.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.models.request.rst new file mode 100644 index 0000000..d40233d --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.models.request.rst @@ -0,0 +1,90 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.list.models.request` +=================================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.list.models.request + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.request + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkReportListParams ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.request.__all__ + :summary: + * - :py:obj:`BULK_REPORT_LIST_PARAMS_VALIDATION_ERROR_MESSAGE ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.request.BULK_REPORT_LIST_PARAMS_VALIDATION_ERROR_MESSAGE + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.list.models.request.__all__ + :value: ['BulkReportListParams'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.request.__all__ + +.. py:data:: BULK_REPORT_LIST_PARAMS_VALIDATION_ERROR_MESSAGE + :canonical: gfwapiclient.resources.bulk_downloads.list.models.request.BULK_REPORT_LIST_PARAMS_VALIDATION_ERROR_MESSAGE + :type: typing.Final[str] + :value: 'Get bulk reports request parameters validation failed.' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.request.BULK_REPORT_LIST_PARAMS_VALIDATION_ERROR_MESSAGE + +.. py:class:: BulkReportListParams(/, **data: typing.Any) + :canonical: gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams + + Bases: :py:obj:`gfwapiclient.http.models.RequestParams` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams.__init__ + + .. py:attribute:: limit + :canonical: gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams.limit + :type: typing.Optional[int] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams.limit + + .. py:attribute:: offset + :canonical: gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams.offset + :type: typing.Optional[int] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams.offset + + .. py:attribute:: sort + :canonical: gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams.sort + :type: typing.Optional[str] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams.sort + + .. py:attribute:: status + :canonical: gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams.status + :type: typing.Optional[gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams.status diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.models.response.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.models.response.rst new file mode 100644 index 0000000..861f7f9 --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.models.response.rst @@ -0,0 +1,80 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.list.models.response` +==================================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.list.models.response + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.response + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkReportListItem ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListItem + :summary: + * - :py:obj:`BulkReportListResult ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListResult + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.response.__all__ + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.list.models.response.__all__ + :value: ['BulkReportListItem', 'BulkReportListResult'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.response.__all__ + +.. py:class:: BulkReportListItem(/, **data: typing.Any) + :canonical: gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListItem + + Bases: :py:obj:`gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportItem` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListItem + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListItem.__init__ + +.. py:class:: BulkReportListResult(data: typing.List[gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListItem]) + :canonical: gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListResult + + Bases: :py:obj:`gfwapiclient.http.models.Result`\ [\ :py:obj:`gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListItem`\ ] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListResult + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListResult.__init__ + + .. py:attribute:: _result_item_class + :canonical: gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListResult._result_item_class + :type: typing.Type[gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListItem] + :value: None + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListResult._result_item_class + + .. py:attribute:: _data + :canonical: gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListResult._data + :type: typing.List[gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListItem] + :value: None + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListResult._data diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.models.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.models.rst new file mode 100644 index 0000000..0a0edb1 --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.models.rst @@ -0,0 +1,17 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.list.models` +=========================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.list.models + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list.models + :allowtitles: + +Submodules +---------- + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + gfwapiclient.resources.bulk_downloads.list.models.request + gfwapiclient.resources.bulk_downloads.list.models.response diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.rst new file mode 100644 index 0000000..0060d40 --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.list.rst @@ -0,0 +1,25 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.list` +==================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.list + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.list + :allowtitles: + +Subpackages +----------- + +.. toctree:: + :titlesonly: + :maxdepth: 3 + + gfwapiclient.resources.bulk_downloads.list.models + +Submodules +---------- + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + gfwapiclient.resources.bulk_downloads.list.endpoints diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.endpoints.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.endpoints.rst new file mode 100644 index 0000000..1cb5e00 --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.endpoints.rst @@ -0,0 +1,71 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.query.endpoints` +=============================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.query.endpoints + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.endpoints + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkReportQueryEndPoint ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.endpoints.BulkReportQueryEndPoint + :summary: + * - :py:obj:`BulkFixedInfrastructureDataQueryEndPoint ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.endpoints.BulkFixedInfrastructureDataQueryEndPoint + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.endpoints.__all__ + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.query.endpoints.__all__ + :value: ['BulkFixedInfrastructureDataQueryEndPoint', 'BulkReportQueryEndPoint'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.endpoints.__all__ + +.. py:class:: BulkReportQueryEndPoint(*, bulk_report_id: str, request_params: gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams, result_item_class: typing.Type[gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryItemT], result_class: typing.Type[gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryResultT], http_client: gfwapiclient.http.client.HTTPClient) + :canonical: gfwapiclient.resources.bulk_downloads.query.endpoints.BulkReportQueryEndPoint + + Bases: :py:obj:`gfwapiclient.http.endpoints.GetEndPoint`\ [\ :py:obj:`gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams`\ , :py:obj:`gfwapiclient.http.models.RequestBody`\ , :py:obj:`gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryItemT`\ , :py:obj:`gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryResultT`\ ] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.endpoints.BulkReportQueryEndPoint + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.endpoints.BulkReportQueryEndPoint.__init__ + + .. py:method:: _transform_response_data(*, body: typing.Union[typing.List[typing.Dict[str, typing.Any]], typing.Dict[str, typing.Any]]) -> typing.Union[typing.List[typing.Dict[str, typing.Any]], typing.Dict[str, typing.Any]] + :canonical: gfwapiclient.resources.bulk_downloads.query.endpoints.BulkReportQueryEndPoint._transform_response_data + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.endpoints.BulkReportQueryEndPoint._transform_response_data + +.. py:class:: BulkFixedInfrastructureDataQueryEndPoint(*, bulk_report_id: str, request_params: gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams, http_client: gfwapiclient.http.client.HTTPClient) + :canonical: gfwapiclient.resources.bulk_downloads.query.endpoints.BulkFixedInfrastructureDataQueryEndPoint + + Bases: :py:obj:`gfwapiclient.resources.bulk_downloads.query.endpoints.BulkReportQueryEndPoint`\ [\ :py:obj:`gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem`\ , :py:obj:`gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryResult`\ ] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.endpoints.BulkFixedInfrastructureDataQueryEndPoint + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.endpoints.BulkFixedInfrastructureDataQueryEndPoint.__init__ diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.base.request.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.base.request.rst new file mode 100644 index 0000000..760bc3d --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.base.request.rst @@ -0,0 +1,97 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.query.models.base.request` +========================================================================= + +.. py:module:: gfwapiclient.resources.bulk_downloads.query.models.base.request + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.request + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkReportQueryParams ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.request.__all__ + :summary: + * - :py:obj:`BULK_REPORT_QUERY_PARAMS_VALIDATION_ERROR_MESSAGE ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.request.BULK_REPORT_QUERY_PARAMS_VALIDATION_ERROR_MESSAGE + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.query.models.base.request.__all__ + :value: ['BulkReportQueryParams'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.request.__all__ + +.. py:data:: BULK_REPORT_QUERY_PARAMS_VALIDATION_ERROR_MESSAGE + :canonical: gfwapiclient.resources.bulk_downloads.query.models.base.request.BULK_REPORT_QUERY_PARAMS_VALIDATION_ERROR_MESSAGE + :type: typing.Final[str] + :value: 'Query bulk report request parameters validation failed.' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.request.BULK_REPORT_QUERY_PARAMS_VALIDATION_ERROR_MESSAGE + +.. py:class:: BulkReportQueryParams(/, **data: typing.Any) + :canonical: gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams + + Bases: :py:obj:`gfwapiclient.http.models.RequestParams` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams.__init__ + + .. py:attribute:: indexed_fields + :canonical: gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams.indexed_fields + :type: typing.ClassVar[typing.Optional[typing.List[str]]] + :value: ['includes'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams.indexed_fields + + .. py:attribute:: limit + :canonical: gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams.limit + :type: typing.Optional[int] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams.limit + + .. py:attribute:: offset + :canonical: gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams.offset + :type: typing.Optional[int] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams.offset + + .. py:attribute:: sort + :canonical: gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams.sort + :type: typing.Optional[str] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams.sort + + .. py:attribute:: includes + :canonical: gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams.includes + :type: typing.Optional[typing.List[str]] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams.includes diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.base.response.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.base.response.rst new file mode 100644 index 0000000..d1651a0 --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.base.response.rst @@ -0,0 +1,98 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.query.models.base.response` +========================================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.query.models.base.response + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.response + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkReportQueryItem ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryItem + :summary: + * - :py:obj:`BulkReportQueryResult ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryResult + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.response.__all__ + :summary: + * - :py:obj:`_BulkReportQueryItemT ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryItemT + :summary: + * - :py:obj:`_BulkReportQueryResultT ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryResultT + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.query.models.base.response.__all__ + :value: ['BulkReportQueryItem', 'BulkReportQueryResult', '_BulkReportQueryItemT', '_BulkReportQueryResultT'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.response.__all__ + +.. py:class:: BulkReportQueryItem(/, **data: typing.Any) + :canonical: gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryItem + + Bases: :py:obj:`gfwapiclient.http.models.ResultItem` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryItem + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryItem.__init__ + +.. py:data:: _BulkReportQueryItemT + :canonical: gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryItemT + :value: 'TypeVar(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryItemT + +.. py:class:: BulkReportQueryResult(data: typing.List[gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryItemT]) + :canonical: gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryResult + + Bases: :py:obj:`gfwapiclient.http.models.Result`\ [\ :py:obj:`gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryItemT`\ ] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryResult + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryResult.__init__ + + .. py:attribute:: _result_item_class + :canonical: gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryResult._result_item_class + :type: typing.Type[gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryItemT] + :value: None + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryResult._result_item_class + + .. py:attribute:: _data + :canonical: gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryResult._data + :type: typing.List[gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryItemT] + :value: None + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryResult._data + +.. py:data:: _BulkReportQueryResultT + :canonical: gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryResultT + :value: 'TypeVar(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base.response._BulkReportQueryResultT diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.base.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.base.rst new file mode 100644 index 0000000..75b82ce --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.base.rst @@ -0,0 +1,17 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.query.models.base` +================================================================= + +.. py:module:: gfwapiclient.resources.bulk_downloads.query.models.base + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.base + :allowtitles: + +Submodules +---------- + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + gfwapiclient.resources.bulk_downloads.query.models.base.request + gfwapiclient.resources.bulk_downloads.query.models.base.response diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.rst new file mode 100644 index 0000000..760e679 --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.rst @@ -0,0 +1,149 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response` +=============================================================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkFixedInfrastructureDataQueryItem ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem + :summary: + * - :py:obj:`BulkFixedInfrastructureDataQueryResult ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryResult + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.__all__ + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.__all__ + :value: ['BulkFixedInfrastructureDataQueryItem', 'BulkFixedInfrastructureDataQueryResult'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.__all__ + +.. py:class:: BulkFixedInfrastructureDataQueryItem(/, **data: typing.Any) + :canonical: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem + + Bases: :py:obj:`gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryItem` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.__init__ + + .. py:attribute:: detection_id + :canonical: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.detection_id + :type: typing.Optional[str] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.detection_id + + .. py:attribute:: detection_date + :canonical: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.detection_date + :type: typing.Optional[datetime.datetime] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.detection_date + + .. py:attribute:: structure_id + :canonical: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.structure_id + :type: typing.Optional[typing.Union[str, int]] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.structure_id + + .. py:attribute:: lat + :canonical: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.lat + :type: typing.Optional[float] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.lat + + .. py:attribute:: lon + :canonical: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.lon + :type: typing.Optional[float] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.lon + + .. py:attribute:: structure_start_date + :canonical: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.structure_start_date + :type: typing.Optional[datetime.datetime] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.structure_start_date + + .. py:attribute:: structure_end_date + :canonical: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.structure_end_date + :type: typing.Optional[datetime.datetime] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.structure_end_date + + .. py:attribute:: label + :canonical: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.label + :type: typing.Optional[str] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.label + + .. py:attribute:: label_confidence + :canonical: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.label_confidence + :type: typing.Optional[str] + :value: 'Field(...)' + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.label_confidence + + .. py:method:: empty_datetime_str_to_none(value: typing.Any) -> typing.Optional[typing.Any] + :canonical: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.empty_datetime_str_to_none + :classmethod: + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem.empty_datetime_str_to_none + +.. py:class:: BulkFixedInfrastructureDataQueryResult(data: typing.List[gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem]) + :canonical: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryResult + + Bases: :py:obj:`gfwapiclient.resources.bulk_downloads.query.models.base.response.BulkReportQueryResult`\ [\ :py:obj:`gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem`\ ] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryResult + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryResult.__init__ + + .. py:attribute:: _result_item_class + :canonical: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryResult._result_item_class + :type: typing.Type[gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem] + :value: None + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryResult._result_item_class + + .. py:attribute:: _data + :canonical: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryResult._data + :type: typing.List[gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryItem] + :value: None + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryResult._data diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.rst new file mode 100644 index 0000000..ea1ce2c --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.rst @@ -0,0 +1,16 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data` +====================================================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data + :allowtitles: + +Submodules +---------- + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.rst new file mode 100644 index 0000000..a5e7a8d --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.models.rst @@ -0,0 +1,17 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.query.models` +============================================================ + +.. py:module:: gfwapiclient.resources.bulk_downloads.query.models + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query.models + :allowtitles: + +Subpackages +----------- + +.. toctree:: + :titlesonly: + :maxdepth: 3 + + gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data + gfwapiclient.resources.bulk_downloads.query.models.base diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.rst new file mode 100644 index 0000000..6c7b7ac --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.query.rst @@ -0,0 +1,25 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.query` +===================================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads.query + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.query + :allowtitles: + +Subpackages +----------- + +.. toctree:: + :titlesonly: + :maxdepth: 3 + + gfwapiclient.resources.bulk_downloads.query.models + +Submodules +---------- + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + gfwapiclient.resources.bulk_downloads.query.endpoints diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.resources.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.resources.rst new file mode 100644 index 0000000..ed98f47 --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.resources.rst @@ -0,0 +1,102 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads.resources` +========================================================= + +.. py:module:: gfwapiclient.resources.bulk_downloads.resources + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.resources + :allowtitles: + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`BulkDownloadResource ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource + :summary: + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.resources.__all__ + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.resources.__all__ + :value: ['BulkDownloadResource'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.resources.__all__ + +.. py:class:: BulkDownloadResource(*, http_client: gfwapiclient.http.client.HTTPClient) + :canonical: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource + + Bases: :py:obj:`gfwapiclient.http.resources.BaseResource` + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource + + .. rubric:: Initialization + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource.__init__ + + .. py:method:: create_bulk_report(*, name: str, dataset: typing.Optional[typing.Union[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportDataset, str]] = None, geojson: typing.Optional[typing.Union[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportGeometry, typing.Dict[str, typing.Any]]] = None, format: typing.Optional[typing.Union[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFormat, str]] = None, region: typing.Optional[typing.Union[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportRegion, typing.Dict[str, typing.Any]]] = None, filters: typing.Optional[typing.List[str]] = None, **kwargs: typing.Dict[str, typing.Any]) -> gfwapiclient.resources.bulk_downloads.create.models.response.BulkReportCreateResult + :canonical: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource.create_bulk_report + :async: + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource.create_bulk_report + + .. py:method:: get_bulk_report_by_id(*, id: str, **kwargs: typing.Dict[str, typing.Any]) -> gfwapiclient.resources.bulk_downloads.detail.models.response.BulkReportDetailResult + :canonical: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource.get_bulk_report_by_id + :async: + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource.get_bulk_report_by_id + + .. py:method:: get_all_bulk_reports(*, limit: typing.Optional[int] = None, offset: typing.Optional[int] = None, sort: typing.Optional[str] = None, status: typing.Optional[typing.Union[gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus, str]] = None, **kwargs: typing.Dict[str, typing.Any]) -> gfwapiclient.resources.bulk_downloads.list.models.response.BulkReportListResult + :canonical: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource.get_all_bulk_reports + :async: + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource.get_all_bulk_reports + + .. py:method:: get_bulk_report_file_download_url(*, id: str, file: typing.Optional[typing.Union[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType, str]] = None, **kwargs: typing.Dict[str, typing.Any]) -> gfwapiclient.resources.bulk_downloads.file.models.response.BulkReportFileResult + :canonical: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource.get_bulk_report_file_download_url + :async: + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource.get_bulk_report_file_download_url + + .. py:method:: query_bulk_fixed_infrastructure_data_report(*, id: str, limit: typing.Optional[int] = None, offset: typing.Optional[int] = None, sort: typing.Optional[str] = None, includes: typing.Optional[typing.List[str]] = None, **kwargs: typing.Dict[str, typing.Any]) -> gfwapiclient.resources.bulk_downloads.query.models.fixed_infrastructure_data.response.BulkFixedInfrastructureDataQueryResult + :canonical: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource.query_bulk_fixed_infrastructure_data_report + :async: + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource.query_bulk_fixed_infrastructure_data_report + + .. py:method:: _prepare_create_bulk_report_request_body(*, name: str, dataset: typing.Optional[typing.Union[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportDataset, str]] = None, geojson: typing.Optional[typing.Union[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportGeometry, typing.Dict[str, typing.Any]]] = None, format: typing.Optional[typing.Union[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFormat, str]] = None, region: typing.Optional[typing.Union[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportRegion, typing.Dict[str, typing.Any]]] = None, filters: typing.Optional[typing.List[str]] = None) -> gfwapiclient.resources.bulk_downloads.create.models.request.BulkReportCreateBody + :canonical: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource._prepare_create_bulk_report_request_body + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource._prepare_create_bulk_report_request_body + + .. py:method:: _prepare_get_all_bulk_report_params(*, limit: typing.Optional[int] = None, offset: typing.Optional[int] = None, sort: typing.Optional[str] = None, status: typing.Optional[typing.Union[gfwapiclient.resources.bulk_downloads.base.models.response.BulkReportStatus, str]] = None) -> gfwapiclient.resources.bulk_downloads.list.models.request.BulkReportListParams + :canonical: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource._prepare_get_all_bulk_report_params + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource._prepare_get_all_bulk_report_params + + .. py:method:: _prepare_get_bulk_report_file_download_url_params(*, file: typing.Optional[typing.Union[gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType, str]] = None) -> gfwapiclient.resources.bulk_downloads.file.models.request.BulkReportFileParams + :canonical: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource._prepare_get_bulk_report_file_download_url_params + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource._prepare_get_bulk_report_file_download_url_params + + .. py:method:: _prepare_query_bulk_report_params(*, limit: typing.Optional[int] = None, offset: typing.Optional[int] = None, sort: typing.Optional[str] = None, includes: typing.Optional[typing.List[str]] = None) -> gfwapiclient.resources.bulk_downloads.query.models.base.request.BulkReportQueryParams + :canonical: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource._prepare_query_bulk_report_params + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.resources.BulkDownloadResource._prepare_query_bulk_report_params diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.rst new file mode 100644 index 0000000..6362ca5 --- /dev/null +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.bulk_downloads.rst @@ -0,0 +1,53 @@ +:py:mod:`gfwapiclient.resources.bulk_downloads` +=============================================== + +.. py:module:: gfwapiclient.resources.bulk_downloads + +.. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads + :allowtitles: + +Subpackages +----------- + +.. toctree:: + :titlesonly: + :maxdepth: 3 + + gfwapiclient.resources.bulk_downloads.file + gfwapiclient.resources.bulk_downloads.detail + gfwapiclient.resources.bulk_downloads.list + gfwapiclient.resources.bulk_downloads.query + gfwapiclient.resources.bulk_downloads.create + gfwapiclient.resources.bulk_downloads.base + +Submodules +---------- + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + gfwapiclient.resources.bulk_downloads.resources + +Package Contents +---------------- + +Data +~~~~ + +.. list-table:: + :class: autosummary longtable + :align: left + + * - :py:obj:`__all__ ` + - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.__all__ + :summary: + +API +~~~ + +.. py:data:: __all__ + :canonical: gfwapiclient.resources.bulk_downloads.__all__ + :value: ['BulkDownloadResource'] + + .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.__all__ diff --git a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.rst b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.rst index f5a4f27..0d4b71e 100644 --- a/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.rst +++ b/docs/source/apidocs/gfwapiclient/gfwapiclient.resources.rst @@ -16,6 +16,7 @@ Subpackages gfwapiclient.resources.insights gfwapiclient.resources.vessels gfwapiclient.resources.references + gfwapiclient.resources.bulk_downloads gfwapiclient.resources.datasets gfwapiclient.resources.events gfwapiclient.resources.fourwings @@ -39,6 +40,6 @@ API .. py:data:: __all__ :canonical: gfwapiclient.resources.__all__ - :value: ['DatasetResource', 'EventResource', 'FourWingsResource', 'InsightResource', 'ReferenceResource', 'V... + :value: ['BulkDownloadResource', 'DatasetResource', 'EventResource', 'FourWingsResource', 'InsightResource',... .. autodoc2-docstring:: gfwapiclient.resources.__all__ diff --git a/docs/source/conf.py b/docs/source/conf.py index 452f9e5..bff4053 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -19,7 +19,7 @@ project = "Global Fishing Watch API Client" copyright = "2025, Global Fishing Watch" author = "Global Fishing Watch" -release = "1.0.1" +release = "1.4.0" # -- General configuration --------------------------------------------------- diff --git a/pyproject.toml b/pyproject.toml index ffaaa5b..ffb229a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta" # Project metadata. [project] name = "gfw-api-python-client" -version = "1.3.0" +version = "1.4.0" description = "Python package for accessing data from Global Fishing Watch APIs." readme = "README.md" requires-python = ">=3.11" @@ -237,10 +237,11 @@ exclude_lines = [ [tool.commitizen] name = "cz_conventional_commits" -version = "1.3.0" +version = "1.4.0" version_files = [ "pyproject.toml:version", - "src/gfwapiclient/__version__.py", + "src/gfwapiclient/__version__.py:__version__", + "docs/source/conf.py:release", "CITATION.cff:version", ] version_provider = "commitizen" diff --git a/src/gfwapiclient/__version__.py b/src/gfwapiclient/__version__.py index 1848333..65a6f0b 100644 --- a/src/gfwapiclient/__version__.py +++ b/src/gfwapiclient/__version__.py @@ -1,3 +1,3 @@ """Global Fishing Watch (GFW) API Python Client - Version and Metadata.""" -__version__ = "1.3.0" +__version__ = "1.4.0"