Skip to content

Commit 84f2fab

Browse files
Prashant-SuryaPrashant-Surya
authored
feat!: upgrade sdk to use pydantic v2 (#3)
BREAKING CHANGE: requires upgrading pydantic and python version
1 parent 783681b commit 84f2fab

File tree

227 files changed

+33550
-16079
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

227 files changed

+33550
-16079
lines changed

‎.gitlab-ci.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,6 @@ stages:
1414
- pip install -r test-requirements.txt
1515
- pytest --cov=plane
1616

17-
pytest-3.7:
18-
extends: .pytest
19-
image: python:3.7-alpine
20-
pytest-3.8:
21-
extends: .pytest
22-
image: python:3.8-alpine
2317
pytest-3.9:
2418
extends: .pytest
2519
image: python:3.9-alpine
@@ -29,3 +23,9 @@ pytest-3.10:
2923
pytest-3.11:
3024
extends: .pytest
3125
image: python:3.11-alpine
26+
pytest-3.12:
27+
extends: .pytest
28+
image: python:3.12-alpine
29+
pytest-3.13:
30+
extends: .pytest
31+
image: python:3.13-alpine

‎.travis.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# ref: https://docs.travis-ci.com/user/languages/python
22
language: python
33
python:
4-
- "3.7"
5-
- "3.8"
64
- "3.9"
75
- "3.10"
86
- "3.11"
7+
- "3.12"
8+
- "3.13"
99
# uncomment the following if needed
10-
#- "3.11-dev" # 3.11 development branch
10+
#- "3.13-dev" # 3.13 development branch
1111
#- "nightly" # nightly build
1212
# command to install dependencies
1313
install:

‎README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ The Plane REST API
44
Visit our quick start guide and full API documentation at [developers.plane.so](https://developers.plane.so/api-reference/introduction).
55

66
- API version: 0.0.1
7-
- Package version: 0.1.6
7+
- Package version: 0.1.7
88
- Generator version: 7.13.0
9-
- Build package: org.openapitools.codegen.languages.PythonPydanticV1ClientCodegen
9+
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
1010
For more information, please visit [https://plane.so](https://plane.so)
1111

1212
## Requirements.
1313

14-
Python 3.7+
14+
Python 3.9+
1515

1616
## Installation & Usage
1717
### pip install

‎docs/AssetsApi.md

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,8 @@ Generate presigned URL for generic asset upload
2424
* Api Key Authentication (ApiKeyAuthentication):
2525
* OAuth Authentication (OAuth2Authentication):
2626
* OAuth Authentication (OAuth2Authentication):
27+
2728
```python
28-
import time
29-
import os
3029
import plane
3130
from plane.models.generic_asset_upload_request import GenericAssetUploadRequest
3231
from plane.rest import ApiException
@@ -71,6 +70,7 @@ with plane.ApiClient(configuration) as api_client:
7170

7271
### Parameters
7372

73+
7474
Name | Type | Description | Notes
7575
------------- | ------------- | ------------- | -------------
7676
**slug** | **str**| Workspace slug |
@@ -90,6 +90,7 @@ void (empty response body)
9090
- **Accept**: Not defined
9191

9292
### HTTP response details
93+
9394
| Status code | Description | Response headers |
9495
|-------------|-------------|------------------|
9596
**401** | Authentication credentials were not provided or are invalid. | - |
@@ -113,9 +114,8 @@ Generate presigned URL for user asset upload
113114
* Api Key Authentication (ApiKeyAuthentication):
114115
* OAuth Authentication (OAuth2Authentication):
115116
* OAuth Authentication (OAuth2Authentication):
117+
116118
```python
117-
import time
118-
import os
119119
import plane
120120
from plane.models.user_asset_upload_request import UserAssetUploadRequest
121121
from plane.rest import ApiException
@@ -159,6 +159,7 @@ with plane.ApiClient(configuration) as api_client:
159159

160160
### Parameters
161161

162+
162163
Name | Type | Description | Notes
163164
------------- | ------------- | ------------- | -------------
164165
**user_asset_upload_request** | [**UserAssetUploadRequest**](UserAssetUploadRequest.md)| |
@@ -177,6 +178,7 @@ void (empty response body)
177178
- **Accept**: Not defined
178179

179180
### HTTP response details
181+
180182
| Status code | Description | Response headers |
181183
|-------------|-------------|------------------|
182184
**401** | Authentication credentials were not provided or are invalid. | - |
@@ -201,9 +203,8 @@ This performs a soft delete by marking the asset as deleted and updating the use
201203
* Api Key Authentication (ApiKeyAuthentication):
202204
* OAuth Authentication (OAuth2Authentication):
203205
* OAuth Authentication (OAuth2Authentication):
206+
204207
```python
205-
import time
206-
import os
207208
import plane
208209
from plane.rest import ApiException
209210
from pprint import pprint
@@ -246,6 +247,7 @@ with plane.ApiClient(configuration) as api_client:
246247

247248
### Parameters
248249

250+
249251
Name | Type | Description | Notes
250252
------------- | ------------- | ------------- | -------------
251253
**asset_id** | **str**| Asset ID |
@@ -264,6 +266,7 @@ void (empty response body)
264266
- **Accept**: Not defined
265267

266268
### HTTP response details
269+
267270
| Status code | Description | Response headers |
268271
|-------------|-------------|------------------|
269272
**401** | Authentication credentials were not provided or are invalid. | - |
@@ -285,9 +288,8 @@ Get presigned URL for asset download
285288
* Api Key Authentication (ApiKeyAuthentication):
286289
* OAuth Authentication (OAuth2Authentication):
287290
* OAuth Authentication (OAuth2Authentication):
291+
288292
```python
289-
import time
290-
import os
291293
import plane
292294
from plane.rest import ApiException
293295
from pprint import pprint
@@ -331,6 +333,7 @@ with plane.ApiClient(configuration) as api_client:
331333

332334
### Parameters
333335

336+
334337
Name | Type | Description | Notes
335338
------------- | ------------- | ------------- | -------------
336339
**asset_id** | **str**| |
@@ -350,6 +353,7 @@ void (empty response body)
350353
- **Accept**: Not defined
351354

352355
### HTTP response details
356+
353357
| Status code | Description | Response headers |
354358
|-------------|-------------|------------------|
355359
**401** | Authentication credentials were not provided or are invalid. | - |
@@ -372,9 +376,8 @@ Update generic asset after upload completion
372376
* Api Key Authentication (ApiKeyAuthentication):
373377
* OAuth Authentication (OAuth2Authentication):
374378
* OAuth Authentication (OAuth2Authentication):
379+
375380
```python
376-
import time
377-
import os
378381
import plane
379382
from plane.models.patched_generic_asset_update_request import PatchedGenericAssetUpdateRequest
380383
from plane.rest import ApiException
@@ -420,6 +423,7 @@ with plane.ApiClient(configuration) as api_client:
420423

421424
### Parameters
422425

426+
423427
Name | Type | Description | Notes
424428
------------- | ------------- | ------------- | -------------
425429
**asset_id** | **str**| Asset ID |
@@ -440,6 +444,7 @@ void (empty response body)
440444
- **Accept**: Not defined
441445

442446
### HTTP response details
447+
443448
| Status code | Description | Response headers |
444449
|-------------|-------------|------------------|
445450
**401** | Authentication credentials were not provided or are invalid. | - |
@@ -461,9 +466,8 @@ Mark user asset as uploaded
461466
* Api Key Authentication (ApiKeyAuthentication):
462467
* OAuth Authentication (OAuth2Authentication):
463468
* OAuth Authentication (OAuth2Authentication):
469+
464470
```python
465-
import time
466-
import os
467471
import plane
468472
from plane.models.patched_asset_update_request import PatchedAssetUpdateRequest
469473
from plane.rest import ApiException
@@ -508,6 +512,7 @@ with plane.ApiClient(configuration) as api_client:
508512

509513
### Parameters
510514

515+
511516
Name | Type | Description | Notes
512517
------------- | ------------- | ------------- | -------------
513518
**asset_id** | **str**| Asset ID |
@@ -527,6 +532,7 @@ void (empty response body)
527532
- **Accept**: Not defined
528533

529534
### HTTP response details
535+
530536
| Status code | Description | Response headers |
531537
|-------------|-------------|------------------|
532538
**401** | Authentication credentials were not provided or are invalid. | - |

‎docs/Cycle.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
Cycle serializer with comprehensive project metrics and time tracking. Provides cycle details including work item counts by status, progress estimates, and time-bound iteration data for project management and sprint planning.
44

55
## Properties
6+
67
Name | Type | Description | Notes
78
------------ | ------------- | ------------- | -------------
89
**id** | **str** | | [optional] [readonly]
@@ -47,7 +48,7 @@ json = "{}"
4748
# create an instance of Cycle from a JSON string
4849
cycle_instance = Cycle.from_json(json)
4950
# print the JSON string representation of the object
50-
print Cycle.to_json()
51+
print(Cycle.to_json())
5152

5253
# convert the object into a dict
5354
cycle_dict = cycle_instance.to_dict()

‎docs/CycleCreateRequest.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
Serializer for creating cycles with timezone handling and date validation. Manages cycle creation including project timezone conversion, date range validation, and UTC normalization for time-bound iteration planning and sprint management.
44

55
## Properties
6+
67
Name | Type | Description | Notes
78
------------ | ------------- | ------------- | -------------
89
**name** | **str** | |
@@ -24,7 +25,7 @@ json = "{}"
2425
# create an instance of CycleCreateRequest from a JSON string
2526
cycle_create_request_instance = CycleCreateRequest.from_json(json)
2627
# print the JSON string representation of the object
27-
print CycleCreateRequest.to_json()
28+
print(CycleCreateRequest.to_json())
2829

2930
# convert the object into a dict
3031
cycle_create_request_dict = cycle_create_request_instance.to_dict()

‎docs/CycleIssue.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
Serializer for cycle-issue relationships with sub-issue counting. Manages the association between cycles and work items, including hierarchical issue tracking for nested work item structures.
44

55
## Properties
6+
67
Name | Type | Description | Notes
78
------------ | ------------- | ------------- | -------------
89
**id** | **str** | | [optional] [readonly]
@@ -27,7 +28,7 @@ json = "{}"
2728
# create an instance of CycleIssue from a JSON string
2829
cycle_issue_instance = CycleIssue.from_json(json)
2930
# print the JSON string representation of the object
30-
print CycleIssue.to_json()
31+
print(CycleIssue.to_json())
3132

3233
# convert the object into a dict
3334
cycle_issue_dict = cycle_issue_instance.to_dict()

‎docs/CycleIssueRequestRequest.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
Serializer for bulk work item assignment to cycles. Validates work item ID lists for batch operations including cycle assignment and sprint planning workflows.
44

55
## Properties
6+
67
Name | Type | Description | Notes
78
------------ | ------------- | ------------- | -------------
89
**issues** | **List[str]** | List of issue IDs to add to the cycle |
@@ -17,7 +18,7 @@ json = "{}"
1718
# create an instance of CycleIssueRequestRequest from a JSON string
1819
cycle_issue_request_request_instance = CycleIssueRequestRequest.from_json(json)
1920
# print the JSON string representation of the object
20-
print CycleIssueRequestRequest.to_json()
21+
print(CycleIssueRequestRequest.to_json())
2122

2223
# convert the object into a dict
2324
cycle_issue_request_request_dict = cycle_issue_request_request_instance.to_dict()

‎docs/CycleLite.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
Lightweight cycle serializer for minimal data transfer. Provides essential cycle information without computed metrics, optimized for list views and reference lookups.
44

55
## Properties
6+
67
Name | Type | Description | Notes
78
------------ | ------------- | ------------- | -------------
89
**id** | **str** | | [optional] [readonly]
@@ -38,7 +39,7 @@ json = "{}"
3839
# create an instance of CycleLite from a JSON string
3940
cycle_lite_instance = CycleLite.from_json(json)
4041
# print the JSON string representation of the object
41-
print CycleLite.to_json()
42+
print(CycleLite.to_json())
4243

4344
# convert the object into a dict
4445
cycle_lite_dict = cycle_lite_instance.to_dict()

0 commit comments

Comments
 (0)