# Sky Api Client
Python client for RENXT APIs.
Developed by Uddesh at [Almabase](https://almabase.com)
## Installation
```
pip install sky_api_client
```
## Examples
1. Initialize the client
```python
from sky_api_client import SkyApi
sky_api = SkyApi('subscription_key', 'access_token')
```
2. Get list of all constituent
```python
list = sky_api.constituent.list()
```
## Available methods
1. List all constituents
```python
list = sky_api.constituent.list()
```
2. Get a specific constituent
```python
constituent = sky_api.constituent.get('constituent_id')
```
3. Create a new constituent
```python
new_constituent = sky_api.constituent.create({'first': '', 'last': ''})
```
4. Update an existing constituent
```python
updated_constituent = sky_api.constituent.update('constituent_id' ,{'first': '', 'last': ''})
```
5. Delete a constituent
```python
sky_api.constituent.delete('constituent_id')
```
6. List all entity constituents
```python
sky_api.address.list('constituent_id')
```
## Available Entities and Methods
1. address
- list
- get
- create
- update
- delete
- types
2. code_table
- list
- get
- create
- update
- delete
3. constituent
- list
- get
- create
- update
- delete
- search
4. custom_field_category
- list
5. custom_fields
- list
- create
- update
- delete
6. education
- list
- get
- create
- update
- delete
7. email_addresses
- list
- create
- update
- delete
- types
8. phone
- list
- get
- create
- update
- delete
- types
9. relationship
- list
- get
- create
- update
- delete
10. table_entry
- list
- get
- create
- update
- delete
11. subscription_webhook
- list
- get
- create
- delete
12. online_presence
- list
- create
- get
- update
- delete
- types
13. constituent_address
- list
14. constituent_custom_field
- list
15. constituent_education
- list
16. constituent_email_address
- list
17. constituent_online_presence
- list
18. constituent_phone
- list
19. constituent_relationship
- list
These entities can be used same as above example for `constituent`.
```python
email_address_list = sky_api.email_addresses.list()
```
> Note:- Current version doesn't have refresh token functionality.
# Updating Version
```
$ semversioner add-change --type patch --description "description for the change"
$ ./release
```
Raw data
{
"_id": null,
"home_page": "https://bitbucket.org/kalyanvarma/skyapi",
"name": "sky-api-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.5",
"maintainer_email": null,
"keywords": null,
"author": "Rajeev K L",
"author_email": "rajeev@almabase.com",
"download_url": "https://files.pythonhosted.org/packages/1a/e3/217a2d1122881501efe54efd67da3d52aa07d129d0f4962e5805cec8cb4d/sky_api_client-3.3.4.tar.gz",
"platform": null,
"description": "# Sky Api Client\n\nPython client for RENXT APIs.\n\nDeveloped by Uddesh at [Almabase](https://almabase.com)\n\n\n## Installation\n\n```\npip install sky_api_client\n```\n\n## Examples\n\n1. Initialize the client\n\n```python\nfrom sky_api_client import SkyApi\n\nsky_api = SkyApi('subscription_key', 'access_token')\n```\n\n2. Get list of all constituent\n\n```python\nlist = sky_api.constituent.list()\n```\n\n## Available methods\n\n1. List all constituents\n\n```python\nlist = sky_api.constituent.list()\n```\n\n2. Get a specific constituent\n\n```python\nconstituent = sky_api.constituent.get('constituent_id')\n```\n\n3. Create a new constituent\n\n```python\nnew_constituent = sky_api.constituent.create({'first': '', 'last': ''})\n```\n\n4. Update an existing constituent\n\n```python\nupdated_constituent = sky_api.constituent.update('constituent_id' ,{'first': '', 'last': ''})\n```\n\n5. Delete a constituent\n\n```python\nsky_api.constituent.delete('constituent_id')\n```\n\n6. List all entity constituents\n```python\nsky_api.address.list('constituent_id')\n```\n\n## Available Entities and Methods\n1. address\n - list\n - get\n - create\n - update\n - delete\n - types\n2. code_table\n - list\n - get\n - create\n - update\n - delete\n3. constituent\n - list\n - get\n - create\n - update\n - delete\n - search\n4. custom_field_category\n - list\n5. custom_fields\n - list\n - create\n - update\n - delete\n6. education\n - list\n - get\n - create\n - update\n - delete\n7. email_addresses\n - list\n - create\n - update\n - delete\n - types\n8. phone\n - list\n - get\n - create\n - update\n - delete\n - types\n9. relationship\n - list\n - get\n - create\n - update\n - delete\n10. table_entry\n - list\n - get\n - create\n - update\n - delete\n11. subscription_webhook\n - list\n - get\n - create\n - delete\n12. online_presence\n - list\n - create\n - get\n - update\n - delete\n - types\n13. constituent_address\n - list\n14. constituent_custom_field\n - list\n15. constituent_education\n - list\n16. constituent_email_address\n - list\n17. constituent_online_presence\n - list\n18. constituent_phone\n - list\n19. constituent_relationship\n - list\n\nThese entities can be used same as above example for `constituent`.\n```python\nemail_address_list = sky_api.email_addresses.list()\n```\n\n> Note:- Current version doesn't have refresh token functionality.\n\n\n# Updating Version\n ```\n $ semversioner add-change --type patch --description \"description for the change\"\n $ ./release\n ```\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Python client for RENXT APIs",
"version": "3.3.4",
"project_urls": {
"Homepage": "https://bitbucket.org/kalyanvarma/skyapi"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "18612d1334b31336a6550df0ff61e73d6ddc3f4357c5500bed660a49a4551955",
"md5": "00e6f98c5e2f910c1d6f4c956ca9d1bd",
"sha256": "8f6542bfd29786b5e0dc798323e50b449a24248124a79869bc06f79b49d60dca"
},
"downloads": -1,
"filename": "sky_api_client-3.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "00e6f98c5e2f910c1d6f4c956ca9d1bd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 25177,
"upload_time": "2024-08-14T16:39:24",
"upload_time_iso_8601": "2024-08-14T16:39:24.367015Z",
"url": "https://files.pythonhosted.org/packages/18/61/2d1334b31336a6550df0ff61e73d6ddc3f4357c5500bed660a49a4551955/sky_api_client-3.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1ae3217a2d1122881501efe54efd67da3d52aa07d129d0f4962e5805cec8cb4d",
"md5": "d3a61db6399fac77c5abd4b0d3815a77",
"sha256": "0d9fd240caba838e55ca4cbb7b0064b0b63b9156305ab86fba1bfa0021b735c7"
},
"downloads": -1,
"filename": "sky_api_client-3.3.4.tar.gz",
"has_sig": false,
"md5_digest": "d3a61db6399fac77c5abd4b0d3815a77",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 9683,
"upload_time": "2024-08-14T16:39:25",
"upload_time_iso_8601": "2024-08-14T16:39:25.707679Z",
"url": "https://files.pythonhosted.org/packages/1a/e3/217a2d1122881501efe54efd67da3d52aa07d129d0f4962e5805cec8cb4d/sky_api_client-3.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-14 16:39:25",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "kalyanvarma",
"bitbucket_project": "skyapi",
"lcname": "sky-api-client"
}
JSON