Metadata-Version: 2.4
Name: postzen-sdk
Version: 1.0.0
Summary: Official Python SDK for the PostZen Public API — manage profiles, connected social accounts, media uploads, and post publishing
Home-page: https://github.com/postzen-dev/postzen-python
Author: PostZen
Author-email: team@openapitools.org
Project-URL: Homepage, https://postzen.dev
Project-URL: Repository, https://github.com/postzen-dev/postzen-python
Keywords: postzen,social media,api,sdk,publishing
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author-email
Dynamic: home-page

# postzen-python
The PostZen Public API lets server-side integrations manage profiles, connected social accounts, OAuth connection flows, media uploads, and post creation.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 1.0.0
- Generator version: 7.23.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.10+

## Installation & Usage
### pip install

```sh
pip install postzen-sdk
```

Then import the package:
```python
import postzen
```

### From source

```sh
pip install git+https://github.com/postzen-dev/postzen-python.git
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import postzen
from postzen.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.postzen.dev
# See configuration.py for a list of all supported configuration parameters.
configuration = postzen.Configuration(
    host = "https://api.postzen.dev"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: bearerAuth
configuration = postzen.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with postzen.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = postzen.AccountsApi(api_client)
    account_id = 'account_id_example' # str | PostZen account id.

    try:
        # Disconnect an account
        api_response = api_instance.disconnect_account(account_id)
        print("The response of AccountsApi->disconnect_account:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountsApi->disconnect_account: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.postzen.dev*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountsApi* | [**disconnect_account**](docs/AccountsApi.md#disconnect_account) | **DELETE** /v1/accounts/{accountId} | Disconnect an account
*AccountsApi* | [**list_accounts**](docs/AccountsApi.md#list_accounts) | **GET** /v1/accounts | List accounts
*ConnectApi* | [**complete_connect**](docs/ConnectApi.md#complete_connect) | **POST** /v1/connect/{platform} | Complete an OAuth connection
*ConnectApi* | [**create_connect_url**](docs/ConnectApi.md#create_connect_url) | **GET** /v1/connect/{platform} | Create an OAuth connect URL
*MediaApi* | [**create_media_presign**](docs/MediaApi.md#create_media_presign) | **POST** /v1/media/presign | Create a presigned media upload URL
*PostsApi* | [**create_post**](docs/PostsApi.md#create_post) | **POST** /v1/posts | Create a post
*ProfilesApi* | [**create_profile**](docs/ProfilesApi.md#create_profile) | **POST** /v1/profiles | Create a profile
*ProfilesApi* | [**delete_profile**](docs/ProfilesApi.md#delete_profile) | **DELETE** /v1/profiles/{profileId} | Delete a profile
*ProfilesApi* | [**get_profile**](docs/ProfilesApi.md#get_profile) | **GET** /v1/profiles/{profileId} | Get a profile
*ProfilesApi* | [**list_profiles**](docs/ProfilesApi.md#list_profiles) | **GET** /v1/profiles | List profiles
*ProfilesApi* | [**update_profile**](docs/ProfilesApi.md#update_profile) | **PUT** /v1/profiles/{profileId} | Update a profile


## Documentation For Models

 - [Account](docs/Account.md)
 - [AccountProfileSummary](docs/AccountProfileSummary.md)
 - [AccountsListResponse](docs/AccountsListResponse.md)
 - [ApiPost](docs/ApiPost.md)
 - [ApiPostAccount](docs/ApiPostAccount.md)
 - [ApiPostPlatformResult](docs/ApiPostPlatformResult.md)
 - [ConnectCompleteErrorResponse](docs/ConnectCompleteErrorResponse.md)
 - [ConnectCompleteRequest](docs/ConnectCompleteRequest.md)
 - [ConnectCompleteResponse](docs/ConnectCompleteResponse.md)
 - [ConnectStartResponse](docs/ConnectStartResponse.md)
 - [CreatePostReplayResponse](docs/CreatePostReplayResponse.md)
 - [CreatePostRequest](docs/CreatePostRequest.md)
 - [CreatePostResponse](docs/CreatePostResponse.md)
 - [CreatePostTarget](docs/CreatePostTarget.md)
 - [ErrorResponse](docs/ErrorResponse.md)
 - [FacebookSettings](docs/FacebookSettings.md)
 - [InstagramSettings](docs/InstagramSettings.md)
 - [InstagramSettingsUserTagsInner](docs/InstagramSettingsUserTagsInner.md)
 - [LinkedInSettings](docs/LinkedInSettings.md)
 - [MediaPresignRequest](docs/MediaPresignRequest.md)
 - [MediaPresignResponse](docs/MediaPresignResponse.md)
 - [MessageResponse](docs/MessageResponse.md)
 - [Pagination](docs/Pagination.md)
 - [PaymentRequiredError](docs/PaymentRequiredError.md)
 - [PaymentRequiredErrorDetails](docs/PaymentRequiredErrorDetails.md)
 - [PinterestSettings](docs/PinterestSettings.md)
 - [PostMediaItem](docs/PostMediaItem.md)
 - [PostPlatformSettings](docs/PostPlatformSettings.md)
 - [Profile](docs/Profile.md)
 - [ProfileCreateRequest](docs/ProfileCreateRequest.md)
 - [ProfileResponse](docs/ProfileResponse.md)
 - [ProfileUpdateRequest](docs/ProfileUpdateRequest.md)
 - [ProfileWriteResponse](docs/ProfileWriteResponse.md)
 - [ProfilesListResponse](docs/ProfilesListResponse.md)
 - [PublicPlatformInput](docs/PublicPlatformInput.md)
 - [PublicPlatformOutput](docs/PublicPlatformOutput.md)
 - [ThreadsSettings](docs/ThreadsSettings.md)
 - [TikTokSettings](docs/TikTokSettings.md)
 - [XSettings](docs/XSettings.md)
 - [YouTubeSettings](docs/YouTubeSettings.md)
 - [YouTubeSettingsTags](docs/YouTubeSettingsTags.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth

- **Type**: Bearer authentication


## Author




