Skip to content

Commit a0fc30c

Browse files
authored
Merge pull request #4 from getdyspatch/update-to-3.0.1
Update to 3.0.1
2 parents a94c78d + 3628247 commit a0fc30c

8 files changed

Lines changed: 18 additions & 17 deletions

File tree

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ details on how to implement Dyspatch.
1111
This Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
1212

1313
- API version: 2019.10
14-
- Package version: 3.0.0
14+
- Package version: 3.0.1
1515
- Build package: io.swagger.codegen.languages.PythonClientCodegen
1616
For more information, please visit [https://docs.dyspatch.io](https://docs.dyspatch.io)
1717

@@ -22,12 +22,9 @@ Python 2.7 and 3.4+
2222
## Installation & Usage
2323
### pip install
2424

25-
If the python package is hosted on Github, you can install directly from Github
26-
2725
```sh
28-
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
26+
pip install dyspatch-python
2927
```
30-
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
3128

3229
Then import the package:
3330
```python

docs/DraftsApi.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ void (empty response body)
403403
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
404404

405405
# **drafts_get**
406-
> DraftsRead drafts_get(status=status)
406+
> DraftsRead drafts_get(cursor=cursor, status=status)
407407
408408
List Drafts
409409

@@ -425,11 +425,12 @@ configuration.api_key['Authorization'] = 'YOUR_API_KEY'
425425

426426
# create an instance of the API class
427427
api_instance = dyspatch_client.DraftsApi(dyspatch_client.ApiClient(configuration))
428+
cursor = 'cursor_example' # str | A cursor value used to retrieve a specific page from a paginated result set. (optional)
428429
status = 'status_example' # str | Filter the list of drafts by a particular status (optional)
429430

430431
try:
431432
# List Drafts
432-
api_response = api_instance.drafts_get(status=status)
433+
api_response = api_instance.drafts_get(cursor=cursor, status=status)
433434
pprint(api_response)
434435
except ApiException as e:
435436
print("Exception when calling DraftsApi->drafts_get: %s\n" % e)
@@ -439,6 +440,7 @@ except ApiException as e:
439440

440441
Name | Type | Description | Notes
441442
------------- | ------------- | ------------- | -------------
443+
**cursor** | **str**| A cursor value used to retrieve a specific page from a paginated result set. | [optional]
442444
**status** | **str**| Filter the list of drafts by a particular status | [optional]
443445

444446
### Return type

docs/DraftsRead.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**cursor** | **object** | Information about paginated results | [optional]
6+
**cursor** | [**Cursor**](Cursor.md) | | [optional]
77
**data** | [**list[DraftMetaRead]**](DraftMetaRead.md) | A list of draft metadata objects | [optional]
88

99
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

dyspatch_client/api/drafts_api.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -760,6 +760,7 @@ def drafts_get(self, **kwargs): # noqa: E501
760760
>>> result = thread.get()
761761
762762
:param async_req bool
763+
:param str cursor: A cursor value used to retrieve a specific page from a paginated result set.
763764
:param str status: Filter the list of drafts by a particular status
764765
:return: DraftsRead
765766
If the method is called asynchronously,
@@ -782,13 +783,14 @@ def drafts_get_with_http_info(self, **kwargs): # noqa: E501
782783
>>> result = thread.get()
783784
784785
:param async_req bool
786+
:param str cursor: A cursor value used to retrieve a specific page from a paginated result set.
785787
:param str status: Filter the list of drafts by a particular status
786788
:return: DraftsRead
787789
If the method is called asynchronously,
788790
returns the request thread.
789791
"""
790792

791-
all_params = ['status'] # noqa: E501
793+
all_params = ['cursor', 'status'] # noqa: E501
792794
all_params.append('async_req')
793795
all_params.append('_return_http_data_only')
794796
all_params.append('_preload_content')
@@ -809,6 +811,8 @@ def drafts_get_with_http_info(self, **kwargs): # noqa: E501
809811
path_params = {}
810812

811813
query_params = []
814+
if 'cursor' in params:
815+
query_params.append(('cursor', params['cursor'])) # noqa: E501
812816
if 'status' in params:
813817
query_params.append(('status', params['status'])) # noqa: E501
814818

dyspatch_client/api_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ def __init__(self, configuration=None, header_name=None, header_value=None,
7474
self.default_headers[header_name] = header_value
7575
self.cookie = cookie
7676
# Set default User-Agent.
77-
self.user_agent = 'Swagger-Codegen/3.0.0/python'
77+
self.user_agent = 'Swagger-Codegen/3.0.1/python'
7878

7979
def __del__(self):
8080
if self._pool is not None:

dyspatch_client/configuration.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -240,5 +240,5 @@ def to_debug_report(self):
240240
"OS: {env}\n"\
241241
"Python Version: {pyversion}\n"\
242242
"Version of the API: 2019.10\n"\
243-
"SDK Package Version: 3.0.0".\
243+
"SDK Package Version: 3.0.1".\
244244
format(env=sys.platform, pyversion=sys.version)

dyspatch_client/models/drafts_read.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class DraftsRead(object):
3131
and the value is json key in definition.
3232
"""
3333
swagger_types = {
34-
'cursor': 'object',
34+
'cursor': 'Cursor',
3535
'data': 'list[DraftMetaRead]'
3636
}
3737

@@ -56,21 +56,19 @@ def __init__(self, cursor=None, data=None): # noqa: E501
5656
def cursor(self):
5757
"""Gets the cursor of this DraftsRead. # noqa: E501
5858
59-
Information about paginated results # noqa: E501
6059
6160
:return: The cursor of this DraftsRead. # noqa: E501
62-
:rtype: object
61+
:rtype: Cursor
6362
"""
6463
return self._cursor
6564

6665
@cursor.setter
6766
def cursor(self, cursor):
6867
"""Sets the cursor of this DraftsRead.
6968
70-
Information about paginated results # noqa: E501
7169
7270
:param cursor: The cursor of this DraftsRead. # noqa: E501
73-
:type: object
71+
:type: Cursor
7472
"""
7573

7674
self._cursor = cursor

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
from setuptools import setup, find_packages # noqa: H301
2121

2222
NAME = "dyspatch-python"
23-
VERSION = "3.0.0"
23+
VERSION = "3.0.1"
2424
# To install the library, run the following
2525
#
2626
# python setup.py install

0 commit comments

Comments
 (0)