(files)
- list - List Files
- create - Create File
- uploaded - Complete File Upload
- update - Update File
- delete - Delete File
List files.
Scopes: files:read
files:write
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:
res = polar.files.list(organization_id="1dbfc517-0bbf-4301-9ba8-555ca42b9737")
while res is not None:
# Handle items
res = res.next()
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
organization_id |
OptionalNullable[str] | ➖ | N/A | 1dbfc517-0bbf-4301-9ba8-555ca42b9737 |
ids |
List[str] | ➖ | List of file IDs to get. | |
page |
Optional[int] | ➖ | Page number, defaults to 1. | |
limit |
Optional[int] | ➖ | Size of a page, defaults to 10. Maximum is 100. | |
retries |
Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
Error Type | Status Code | Content Type |
---|---|---|
models.HTTPValidationError | 422 | application/json |
models.SDKError | 4XX, 5XX | */* |
Create a file.
Scopes: files:write
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:
res = polar.files.create(request={
"name": "<value>",
"mime_type": "<value>",
"size": 638424,
"upload": {
"parts": [
{
"number": 417458,
"chunk_start": 134365,
"chunk_end": 69025,
},
],
},
"organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
"service": "organization_avatar",
})
# Handle response
print(res)
Parameter | Type | Required | Description |
---|---|---|---|
request |
models.FileCreate | ✔️ | The request object to use for the request. |
retries |
Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
Error Type | Status Code | Content Type |
---|---|---|
models.HTTPValidationError | 422 | application/json |
models.SDKError | 4XX, 5XX | */* |
Complete a file upload.
Scopes: files:write
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:
res = polar.files.uploaded(id="<value>", file_upload_completed={
"id": "<id>",
"path": "/sys",
"parts": [
{
"number": 173116,
"checksum_etag": "<value>",
"checksum_sha256_base64": "<value>",
},
{
"number": 894030,
"checksum_etag": "<value>",
"checksum_sha256_base64": "<value>",
},
{
"number": 673715,
"checksum_etag": "<value>",
"checksum_sha256_base64": "<value>",
},
],
})
# Handle response
print(res)
Parameter | Type | Required | Description |
---|---|---|---|
id |
str | ✔️ | The file ID. |
file_upload_completed |
models.FileUploadCompleted | ✔️ | N/A |
retries |
Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
models.FilesUploadedResponseFilesUploaded
Error Type | Status Code | Content Type |
---|---|---|
models.NotPermitted | 403 | application/json |
models.ResourceNotFound | 404 | application/json |
models.HTTPValidationError | 422 | application/json |
models.SDKError | 4XX, 5XX | */* |
Update a file.
Scopes: files:write
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:
res = polar.files.update(id="<value>", file_patch={})
# Handle response
print(res)
Parameter | Type | Required | Description |
---|---|---|---|
id |
str | ✔️ | The file ID. |
file_patch |
models.FilePatch | ✔️ | N/A |
retries |
Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
models.FilesUpdateResponseFilesUpdate
Error Type | Status Code | Content Type |
---|---|---|
models.NotPermitted | 403 | application/json |
models.ResourceNotFound | 404 | application/json |
models.HTTPValidationError | 422 | application/json |
models.SDKError | 4XX, 5XX | */* |
Delete a file.
Scopes: files:write
from polar_sdk import Polar
with Polar(
access_token="<YOUR_BEARER_TOKEN_HERE>",
) as polar:
polar.files.delete(id="<value>")
# Use the SDK ...
Parameter | Type | Required | Description |
---|---|---|---|
id |
str | ✔️ | N/A |
retries |
Optional[utils.RetryConfig] | ➖ | Configuration to override the default retry behavior of the client. |
Error Type | Status Code | Content Type |
---|---|---|
models.NotPermitted | 403 | application/json |
models.ResourceNotFound | 404 | application/json |
models.HTTPValidationError | 422 | application/json |
models.SDKError | 4XX, 5XX | */* |