Python client for RENXT APIs
Project description
Sky Api Client
Python client for RENXT APIs.
Developed by Uddesh at Almabase
Installation
pip install sky_api_client
Examples
- Initialize the client
from sky_api_client import SkyApi
sky_api = SkyApi('subscription_key', 'access_token')
- Get list of all constituent
list = sky_api.constituent.list()
Available methods
- List all constituents
list = sky_api.constituent.list()
- Get a specific constituent
constituent = sky_api.constituent.get('constituent_id')
- Create a new constituent
new_constituent = sky_api.constituent.create({'first': '', 'last': ''})
- Update an existing constituent
updated_constituent = sky_api.constituent.update('constituent_id' ,{'first': '', 'last': ''})
- Delete a constituent
sky_api.constituent.delete('constituent_id')
- List all entity constituents
sky_api.address.list('constituent_id')
Available Entities and Methods
- address
- list [If constituent id passed in parameter then method will return list of address constituents]
- get
- create
- update
- delete
- types
- code_table
- list
- get
- create
- update
- delete
- constituent
- list
- get
- create
- update
- delete
- search
- custom_field_category
- list
- custom_fields
- list
- get
- create
- update
- delete
- education
- list
- get
- create
- update
- delete
- email_addresses
- list [If constituent id passed in parameter then method will return list of email constituents]
- create
- update
- delete
- types
- phone
- list [If constituent id passed in parameter then method will return list of phone constituents]
- get
- create
- update
- delete
- types
- relationship
- list
- get
- create
- update
- delete
- table_entry
- list
- get
- create
- update
- delete
- subscription_webhook
- list
- get
- create
- delete
- online_presence
- list [If constituent id passed in parameter then method will return list of online presence constituents]
- create
- get
- update
- delete
- types
These entities can be used same as above example for constituent
.
email_address_list = sky_api.email_addresses.list()
Note:- Current version doesn't have refresh token functionality.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sky_api_client-1.0.2.tar.gz
(2.3 kB
view hashes)
Built Distribution
Close
Hashes for sky_api_client-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4d14f63ab4a945b819fc9a5b989f3c8c68cd19afff08395b1c835ae1337339c6 |
|
MD5 | 6b23f58aa908d8b0e387c86beb3fa732 |
|
BLAKE2b-256 | f27399ea0744e9dd801cf50194c2d459d7a3069bc84fe0c4042dcd679892e9ae |