feat: add list parameters and deals structure

Author: Alan Shaw

.openapi-generator/FILES

@@ -15,7 +15,6 @@ docs/Links.md
 docs/LinksFile.md
 docs/ListResponse.md
 docs/NFT.md
-docs/NFTDeals.md
 docs/NFTStorageAPI.md
 docs/Pin.md
 docs/PinStatus.md
@@ -43,7 +42,6 @@ nft_storage/model/links.py
 nft_storage/model/links_file.py
 nft_storage/model/list_response.py
 nft_storage/model/nft.py
-nft_storage/model/nft_deals.py
 nft_storage/model/pin.py
 nft_storage/model/pin_status.py
 nft_storage/model/unauthorized_error_response.py
@@ -69,7 +67,6 @@ test/test_links.py
 test/test_links_file.py
 test/test_list_response.py
 test/test_nft.py
-test/test_nft_deals.py
 test/test_nft_storage_api.py
 test/test_pin.py
 test/test_pin_status.py

README.md

@@ -1,13 +1,11 @@
 # nft.storage
-# API Reference
-
+No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
 - Package version: 1.0.0
 - Build package: org.openapitools.codegen.languages.PythonClientCodegen
-For more information, please visit [https://nft.storage](https://nft.storage)
 
 ## Requirements.
 
@@ -59,10 +57,10 @@ from nft_storage.model.get_response import GetResponse
 from nft_storage.model.list_response import ListResponse
 from nft_storage.model.unauthorized_error_response import UnauthorizedErrorResponse
 from nft_storage.model.upload_response import UploadResponse
-# Defining the host is optional and defaults to https://nft.storage/api
+# Defining the host is optional and defaults to https://api.nft.storage
 # See configuration.py for a list of all supported configuration parameters.
 configuration = nft_storage.Configuration(
-    host = "https://nft.storage/api"
+    host = "https://api.nft.storage"
 )
 
 # The client must configure the authentication and authorization parameters
@@ -92,7 +90,7 @@ with nft_storage.ApiClient(configuration) as api_client:
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *https://nft.storage/api*
+All URIs are relative to *https://api.nft.storage*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
@@ -116,7 +114,6 @@ Class | Method | HTTP request | Description
  - [LinksFile](docs/LinksFile.md)
  - [ListResponse](docs/ListResponse.md)
  - [NFT](docs/NFT.md)
- - [NFTDeals](docs/NFTDeals.md)
  - [Pin](docs/Pin.md)
  - [PinStatus](docs/PinStatus.md)
  - [UnauthorizedErrorResponse](docs/UnauthorizedErrorResponse.md)

docs/Deal.md

@@ -5,12 +5,13 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **last_change** | **str** | This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: YYYY-MM-DDTHH:MM:SSZ. | 
-**status** | **str** | Deal Status | 
+**status** | **str** | Deal status | 
 **batch_root_cid** | **str** |  | [optional] 
 **miner** | **str** | Miner ID | [optional] 
 **network** | **str** | Filecoin network for this Deal | [optional] 
 **piece_cid** | **str** | Piece CID string | [optional] 
-**status_text** | **str** | Deal Status Description | [optional] 
+**status_text** | **str** | Deal status description. | [optional] 
+**chain_deal_id** | **float** | Identifier for the deal stored on chain. | [optional] 
 **deal_activation** | **str** | This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: YYYY-MM-DDTHH:MM:SSZ. | [optional] 
 **deal_expiration** | **str** | This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: YYYY-MM-DDTHH:MM:SSZ. | [optional] 
 

docs/NFT.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **scope** | **str** | Name of the JWT token used to create this NFT. | [optional]  if omitted the server will use the default value of "default"
 **pin** | [**Pin**](Pin.md) |  | [optional] 
 **files** | [**Files**](Files.md) |  | [optional] 
-**deals** | [**NFTDeals**](NFTDeals.md) |  | [optional] 
+**deals** | [**[Deal]**](Deal.md) |  | [optional] 
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
 

docs/NFTDeals.md

@@ -1,6 +1,6 @@
 # nft_storage.NFTStorageAPI
 
-All URIs are relative to *https://nft.storage/api*
+All URIs are relative to *https://api.nft.storage*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
@@ -29,10 +29,10 @@ from nft_storage.model.delete_response import DeleteResponse
 from nft_storage.model.unauthorized_error_response import UnauthorizedErrorResponse
 from nft_storage.model.forbidden_error_response import ForbiddenErrorResponse
 from pprint import pprint
-# Defining the host is optional and defaults to https://nft.storage/api
+# Defining the host is optional and defaults to https://api.nft.storage
 # See configuration.py for a list of all supported configuration parameters.
 configuration = nft_storage.Configuration(
-    host = "https://nft.storage/api"
+    host = "https://api.nft.storage"
 )
 
 # The client must configure the authentication and authorization parameters
@@ -108,10 +108,10 @@ from nft_storage.model.list_response import ListResponse
 from nft_storage.model.unauthorized_error_response import UnauthorizedErrorResponse
 from nft_storage.model.forbidden_error_response import ForbiddenErrorResponse
 from pprint import pprint
-# Defining the host is optional and defaults to https://nft.storage/api
+# Defining the host is optional and defaults to https://api.nft.storage
 # See configuration.py for a list of all supported configuration parameters.
 configuration = nft_storage.Configuration(
-    host = "https://nft.storage/api"
+    host = "https://api.nft.storage"
 )
 
 # The client must configure the authentication and authorization parameters
@@ -128,19 +128,26 @@ configuration = nft_storage.Configuration(
 with nft_storage.ApiClient(configuration) as api_client:
     # Create an instance of the API class
     api_instance = nft_storage_api.NFTStorageAPI(api_client)
+    before = dateutil_parser('2020-07-27T17:32:28Z') # datetime | Return results created before provided timestamp (optional)
+    limit = 10 # int | Max records to return (optional) if omitted the server will use the default value of 10
 
-    # example, this endpoint has no required or optional parameters
+    # example passing only required values which don't have defaults set
+    # and optional values
     try:
         # List all stored files
-        api_response = api_instance.list()
+        api_response = api_instance.list(before=before, limit=limit)
         pprint(api_response)
     except nft_storage.ApiException as e:
         print("Exception when calling NFTStorageAPI->list: %s\n" % e)
 ```
 
 
 ### Parameters
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **before** | **datetime**| Return results created before provided timestamp | [optional]
+ **limit** | **int**| Max records to return | [optional] if omitted the server will use the default value of 10
 
 ### Return type
 
@@ -185,10 +192,10 @@ from nft_storage.model.unauthorized_error_response import UnauthorizedErrorRespo
 from nft_storage.model.get_response import GetResponse
 from nft_storage.model.forbidden_error_response import ForbiddenErrorResponse
 from pprint import pprint
-# Defining the host is optional and defaults to https://nft.storage/api
+# Defining the host is optional and defaults to https://api.nft.storage
 # See configuration.py for a list of all supported configuration parameters.
 configuration = nft_storage.Configuration(
-    host = "https://nft.storage/api"
+    host = "https://api.nft.storage"
 )
 
 # The client must configure the authentication and authorization parameters
@@ -266,10 +273,10 @@ from nft_storage.model.upload_response import UploadResponse
 from nft_storage.model.unauthorized_error_response import UnauthorizedErrorResponse
 from nft_storage.model.forbidden_error_response import ForbiddenErrorResponse
 from pprint import pprint
-# Defining the host is optional and defaults to https://nft.storage/api
+# Defining the host is optional and defaults to https://api.nft.storage
 # See configuration.py for a list of all supported configuration parameters.
 configuration = nft_storage.Configuration(
-    host = "https://nft.storage/api"
+    host = "https://api.nft.storage"
 )
 
 # The client must configure the authentication and authorization parameters

docs/NFTStorageAPI.md

@@ -3,7 +3,7 @@
 """
     NFT Storage API
 
-    # API Reference   # noqa: E501
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
 
     The version of the OpenAPI document: 1.0
     Generated by: https://openapi-generator.tech

nft_storage/__init__.py

@@ -1,7 +1,7 @@
 """
     NFT Storage API
 
-    # API Reference   # noqa: E501
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
 
     The version of the OpenAPI document: 1.0
     Generated by: https://openapi-generator.tech
@@ -175,6 +175,8 @@ def __list(
 
 
             Keyword Args:
+                before (datetime): Return results created before provided timestamp. [optional]
+                limit (int): Max records to return. [optional] if omitted the server will use the default value of 10
                 _return_http_data_only (bool): response data without head status
                     code and headers. Default is True.
                 _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -234,25 +236,41 @@ def __list(
             },
             params_map={
                 'all': [
+                    'before',
+                    'limit',
                 ],
                 'required': [],
                 'nullable': [
                 ],
                 'enum': [
                 ],
                 'validation': [
+                    'limit',
                 ]
             },
             root_map={
                 'validations': {
+                    ('limit',): {
+
+                        'inclusive_maximum': 100,
+                        'inclusive_minimum': 1,
+                    },
                 },
                 'allowed_values': {
                 },
                 'openapi_types': {
+                    'before':
+                        (datetime,),
+                    'limit':
+                        (int,),
                 },
                 'attribute_map': {
+                    'before': 'before',
+                    'limit': 'limit',
                 },
                 'location_map': {
+                    'before': 'query',
+                    'limit': 'query',
                 },
                 'collection_format_map': {
                 }

nft_storage/api/nft_storage_api.py

@@ -1,7 +1,7 @@
 """
     NFT Storage API
 
-    # API Reference   # noqa: E501
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
 
     The version of the OpenAPI document: 1.0
     Generated by: https://openapi-generator.tech

nft_storage/api_client.py

@@ -1,7 +1,7 @@
 """
     NFT Storage API
 
-    # API Reference   # noqa: E501
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
 
     The version of the OpenAPI document: 1.0
     Generated by: https://openapi-generator.tech
@@ -93,7 +93,7 @@ def __init__(self, host=None,
                  ):
         """Constructor
         """
-        self._base_path = "https://nft.storage/api" if host is None else host
+        self._base_path = "https://api.nft.storage" if host is None else host
         """Default Base url
         """
         self.server_index = 0 if server_index is None and host is None else server_index
@@ -396,7 +396,7 @@ def get_host_settings(self):
         """
         return [
             {
-                'url': "https://nft.storage/api",
+                'url': "https://api.nft.storage",
                 'description': "No description provided",
             }
         ]