Skip to content

Commit 14ca8e2

Browse files
committed
pangea-sdk: remove beta tags from Share (PAN-8664)
1 parent cc70f6b commit 14ca8e2

File tree

2 files changed

+91
-121
lines changed

2 files changed

+91
-121
lines changed

Diff for: packages/pangea-sdk/pangea/asyncio/services/share.py

+44-60
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,11 @@ class ShareAsync(ServiceBaseAsync):
1919

2020
async def buckets(self) -> PangeaResponse[m.BucketsResult]:
2121
"""
22-
Buckets (Beta)
22+
Buckets
2323
2424
Get information on the accessible buckets.
25-
How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
2625
27-
OperationId: share_post_v1beta_buckets
26+
OperationId: share_post_v1_buckets
2827
2928
Returns:
3029
A PangeaResponse. Available response fields can be found in our [API documentation](https://pangea.cloud/docs/api/share).
@@ -33,7 +32,7 @@ async def buckets(self) -> PangeaResponse[m.BucketsResult]:
3332
response = share.buckets()
3433
"""
3534

36-
return await self.request.post("v1beta/buckets", m.BucketsResult)
35+
return await self.request.post("v1/buckets", m.BucketsResult)
3736

3837
async def delete(
3938
self,
@@ -43,13 +42,12 @@ async def delete(
4342
bucket_id: Optional[str] = None,
4443
) -> PangeaResponse[m.DeleteResult]:
4544
"""
46-
Delete (Beta)
45+
Delete
4746
4847
Delete object by ID or path. If both are supplied, the path must match
4948
that of the object represented by the ID.
50-
How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
5149
52-
OperationId: share_post_v1beta_delete
50+
OperationId: share_post_v1_delete
5351
5452
Args:
5553
id (str, optional): The ID of the object to delete.
@@ -65,7 +63,7 @@ async def delete(
6563
"""
6664

6765
input = m.DeleteRequest(id=id, path=path, force=force, bucket_id=bucket_id)
68-
return await self.request.post("v1beta/delete", m.DeleteResult, data=input.model_dump(exclude_none=True))
66+
return await self.request.post("v1/delete", m.DeleteResult, data=input.model_dump(exclude_none=True))
6967

7068
async def folder_create(
7169
self,
@@ -77,12 +75,11 @@ async def folder_create(
7775
bucket_id: Optional[str] = None,
7876
) -> PangeaResponse[m.FolderCreateResult]:
7977
"""
80-
Create a folder (Beta)
78+
Create a folder
8179
8280
Create a folder, either by name or path and parent_id.
83-
How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
8481
85-
OperationId: share_post_v1beta_folder_create
82+
OperationId: share_post_v1_folder_create
8683
8784
Args:
8885
name (str, optional): The name of an object.
@@ -111,7 +108,7 @@ async def folder_create(
111108
name=name, metadata=metadata, parent_id=parent_id, path=path, tags=tags, bucket_id=bucket_id
112109
)
113110
return await self.request.post(
114-
"v1beta/folder/create", m.FolderCreateResult, data=input.model_dump(exclude_none=True)
111+
"v1/folder/create", m.FolderCreateResult, data=input.model_dump(exclude_none=True)
115112
)
116113

117114
async def get(
@@ -123,13 +120,12 @@ async def get(
123120
password: Optional[str] = None,
124121
) -> PangeaResponse[m.GetResult]:
125122
"""
126-
Get an object (Beta)
123+
Get an object
127124
128125
Get object. If both ID and Path are supplied, the call will fail if the
129126
target object doesn't match both properties.
130-
How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
131127
132-
OperationId: share_post_v1beta_get
128+
OperationId: share_post_v1_get
133129
134130
Args:
135131
id (str, optional): The ID of the object to retrieve.
@@ -155,7 +151,7 @@ async def get(
155151
bucket_id=bucket_id,
156152
password=password,
157153
)
158-
return await self.request.post("v1beta/get", m.GetResult, data=input.dict(exclude_none=True))
154+
return await self.request.post("v1/get", m.GetResult, data=input.model_dump(exclude_none=True))
159155

160156
async def get_archive(
161157
self,
@@ -165,12 +161,11 @@ async def get_archive(
165161
bucket_id: Optional[str] = None,
166162
) -> PangeaResponse[m.GetArchiveResult]:
167163
"""
168-
Get archive (Beta)
164+
Get archive
169165
170166
Get an archive file of multiple objects.
171-
How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
172167
173-
OperationId: share_post_v1beta_get_archive
168+
OperationId: share_post_v1_get_archive
174169
175170
Args:
176171
ids (List[str]): The IDs of the objects to include in the archive. Folders include all children.
@@ -195,9 +190,7 @@ async def get_archive(
195190
raise ValueError(f"Only {TransferMethod.DEST_URL} and {TransferMethod.MULTIPART} are supported")
196191

197192
input = m.GetArchiveRequest(ids=ids, format=format, transfer_method=transfer_method, bucket_id=bucket_id)
198-
return await self.request.post(
199-
"v1beta/get_archive", m.GetArchiveResult, data=input.model_dump(exclude_none=True)
200-
)
193+
return await self.request.post("v1/get_archive", m.GetArchiveResult, data=input.model_dump(exclude_none=True))
201194

202195
async def list(
203196
self,
@@ -209,12 +202,11 @@ async def list(
209202
bucket_id: Optional[str] = None,
210203
) -> PangeaResponse[m.ListResult]:
211204
"""
212-
List (Beta)
205+
List
213206
214207
List or filter/search records.
215-
How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
216208
217-
OperationId: share_post_v1beta_list
209+
OperationId: share_post_v1_list
218210
219211
Args:
220212
filter (Union[Dict[str, str], FilterList], optional):
@@ -232,7 +224,7 @@ async def list(
232224
"""
233225

234226
input = m.ListRequest(filter=filter, last=last, order=order, order_by=order_by, size=size, bucket_id=bucket_id)
235-
return await self.request.post("v1beta/list", m.ListResult, data=input.model_dump(exclude_none=True))
227+
return await self.request.post("v1/list", m.ListResult, data=input.model_dump(exclude_none=True))
236228

237229
async def put(
238230
self,
@@ -256,12 +248,11 @@ async def put(
256248
password_algorithm: Optional[str] = None,
257249
) -> PangeaResponse[m.PutResult]:
258250
"""
259-
Upload a file (Beta)
251+
Upload a file
260252
261253
Upload a file.
262-
How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
263254
264-
OperationId: share_post_v1beta_put
255+
OperationId: share_post_v1_put
265256
266257
Args:
267258
file (io.BufferedReader):
@@ -326,8 +317,8 @@ async def put(
326317
password=password,
327318
password_algorithm=password_algorithm,
328319
)
329-
data = input.dict(exclude_none=True)
330-
return await self.request.post("v1beta/put", m.PutResult, data=data, files=files)
320+
data = input.model_dump(exclude_none=True)
321+
return await self.request.post("v1/put", m.PutResult, data=data, files=files)
331322

332323
async def request_upload_url(
333324
self,
@@ -348,12 +339,11 @@ async def request_upload_url(
348339
bucket_id: Optional[str] = None,
349340
) -> PangeaResponse[m.PutResult]:
350341
"""
351-
Request upload URL (Beta)
342+
Request upload URL
352343
353344
Request an upload URL.
354-
How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
355345
356-
OperationId: share_post_v1beta_put 2
346+
OperationId: share_post_v1_put 2
357347
358348
Args:
359349
name (str, optional): The name of the object to store.
@@ -409,8 +399,8 @@ async def request_upload_url(
409399
bucket_id=bucket_id,
410400
)
411401

412-
data = input.dict(exclude_none=True)
413-
return await self.request.request_presigned_url("v1beta/put", m.PutResult, data=data)
402+
data = input.model_dump(exclude_none=True)
403+
return await self.request.request_presigned_url("v1/put", m.PutResult, data=data)
414404

415405
async def update(
416406
self,
@@ -427,12 +417,11 @@ async def update(
427417
bucket_id: Optional[str] = None,
428418
) -> PangeaResponse[m.UpdateResult]:
429419
"""
430-
Update a file (Beta)
420+
Update a file
431421
432422
Update a file.
433-
How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
434423
435-
OperationId: share_post_v1beta_update
424+
OperationId: share_post_v1_update
436425
437426
Args:
438427
id (str, optional): An identifier for the file to update.
@@ -474,18 +463,17 @@ async def update(
474463
updated_at=updated_at,
475464
bucket_id=bucket_id,
476465
)
477-
return await self.request.post("v1beta/update", m.UpdateResult, data=input.dict(exclude_none=True))
466+
return await self.request.post("v1/update", m.UpdateResult, data=input.model_dump(exclude_none=True))
478467

479468
async def share_link_create(
480469
self, links: List[m.ShareLinkCreateItem], bucket_id: Optional[str] = None
481470
) -> PangeaResponse[m.ShareLinkCreateResult]:
482471
"""
483-
Create share links (Beta)
472+
Create share links
484473
485474
Create a share link.
486-
How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
487475
488-
OperationId: share_post_v1beta_share_link_create
476+
OperationId: share_post_v1_share_link_create
489477
490478
Args:
491479
links (List[ShareLinkCreateItem]):
@@ -513,17 +501,16 @@ async def share_link_create(
513501

514502
input = m.ShareLinkCreateRequest(links=links, bucket_id=bucket_id)
515503
return await self.request.post(
516-
"v1beta/share/link/create", m.ShareLinkCreateResult, data=input.dict(exclude_none=True)
504+
"v1/share/link/create", m.ShareLinkCreateResult, data=input.model_dump(exclude_none=True)
517505
)
518506

519507
async def share_link_get(self, id: str) -> PangeaResponse[m.ShareLinkGetResult]:
520508
"""
521-
Get share link (Beta)
509+
Get share link
522510
523511
Get a share link.
524-
How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
525512
526-
OperationId: share_post_v1beta_share_link_get
513+
OperationId: share_post_v1_share_link_get
527514
528515
Args:
529516
id (str, optional): The ID of a share link.
@@ -539,7 +526,7 @@ async def share_link_get(self, id: str) -> PangeaResponse[m.ShareLinkGetResult]:
539526

540527
input = m.ShareLinkGetRequest(id=id)
541528
return await self.request.post(
542-
"v1beta/share/link/get", m.ShareLinkGetResult, data=input.dict(exclude_none=True)
529+
"v1/share/link/get", m.ShareLinkGetResult, data=input.model_dump(exclude_none=True)
543530
)
544531

545532
async def share_link_list(
@@ -552,12 +539,11 @@ async def share_link_list(
552539
bucket_id: Optional[str] = None,
553540
) -> PangeaResponse[m.ShareLinkListResult]:
554541
"""
555-
List share links (Beta)
542+
List share links
556543
557544
Look up share links by filter options.
558-
How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
559545
560-
OperationId: share_post_v1beta_share_link_list
546+
OperationId: share_post_v1_share_link_list
561547
562548
Args:
563549
filter (Union[Dict[str, str], ShareLinkListFilter], optional):
@@ -578,19 +564,18 @@ async def share_link_list(
578564
filter=filter, last=last, order=order, order_by=order_by, size=size, bucket_id=bucket_id
579565
)
580566
return await self.request.post(
581-
"v1beta/share/link/list", m.ShareLinkListResult, data=input.dict(exclude_none=True)
567+
"v1/share/link/list", m.ShareLinkListResult, data=input.model_dump(exclude_none=True)
582568
)
583569

584570
async def share_link_delete(
585571
self, ids: List[str], bucket_id: Optional[str] = None
586572
) -> PangeaResponse[m.ShareLinkDeleteResult]:
587573
"""
588-
Delete share links (Beta)
574+
Delete share links
589575
590576
Delete share links.
591-
How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
592577
593-
OperationId: share_post_v1beta_share_link_delete
578+
OperationId: share_post_v1_share_link_delete
594579
595580
Args:
596581
ids (List[str]): list of the share link's id to delete
@@ -607,22 +592,21 @@ async def share_link_delete(
607592

608593
input = m.ShareLinkDeleteRequest(ids=ids, bucket_id=bucket_id)
609594
return await self.request.post(
610-
"v1beta/share/link/delete", m.ShareLinkDeleteResult, data=input.dict(exclude_none=True)
595+
"v1/share/link/delete", m.ShareLinkDeleteResult, data=input.model_dump(exclude_none=True)
611596
)
612597

613598
async def share_link_send(
614599
self, links: List[m.ShareLinkSendItem], sender_email: str, sender_name: Optional[str] = None
615600
) -> PangeaResponse[m.ShareLinkSendResult]:
616601
"""
617-
Send share links (Beta)
602+
Send share links
618603
619604
Send a secure share-link notification to a set of email addresses. The
620605
notification email will contain an Open button that the recipient can
621606
use to follow the secured share-link to authenticate and then access the
622607
shared content.
623-
How to install a [Beta release](https://pangea.cloud/docs/sdk/python/#beta-releases).
624608
625-
OperationId: share_post_v1beta_share_link_send
609+
OperationId: share_post_v1_share_link_send
626610
627611
Args:
628612
sender_email: An email address.
@@ -639,5 +623,5 @@ async def share_link_send(
639623

640624
input = m.ShareLinkSendRequest(links=links, sender_email=sender_email, sender_name=sender_name)
641625
return await self.request.post(
642-
"v1beta/share/link/send", m.ShareLinkSendResult, data=input.dict(exclude_none=True)
626+
"v1/share/link/send", m.ShareLinkSendResult, data=input.model_dump(exclude_none=True)
643627
)

0 commit comments

Comments
 (0)