release v1.4.0

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

CITATION.cff

@@ -1,18 +1,18 @@
-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:
   - name: "The Global Fishing Watch Team"
     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"

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:

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__

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

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 <gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportDataset>`
+     - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportDataset
+          :summary:
+   * - :py:obj:`BulkReportFormat <gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFormat>`
+     - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFormat
+          :summary:
+   * - :py:obj:`BulkReportGeometry <gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportGeometry>`
+     - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportGeometry
+          :summary:
+   * - :py:obj:`BulkReportRegion <gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportRegion>`
+     - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportRegion
+          :summary:
+   * - :py:obj:`BulkReportFileType <gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType>`
+     - .. autodoc2-docstring:: gfwapiclient.resources.bulk_downloads.base.models.request.BulkReportFileType
+          :summary:
+
+Data
+~~~~
+
+.. list-table::
+   :class: autosummary longtable
+   :align: left
+
+   * - :py:obj:`__all__ <gfwapiclient.resources.bulk_downloads.base.models.request.__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