Skip to main content

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

  1. Initialize the client
from sky_api_client import SkyApi

sky_api = SkyApi('subscription_key', 'access_token')
  1. Get list of all constituent
list = sky_api.constituent.list()

Available methods

  1. List all constituents
list = sky_api.constituent.list()
  1. Get a specific constituent
constituent = sky_api.constituent.get('constituent_id')
  1. Create a new constituent
new_constituent = sky_api.constituent.create({'first': '', 'last': ''})
  1. Update an existing constituent
updated_constituent = sky_api.constituent.update('constituent_id' ,{'first': '', 'last': ''})
  1. Delete a constituent
sky_api.constituent.delete('constituent_id')
  1. List all entity constituents
sky_api.address.list('constituent_id')

Available Entities and Methods

  1. address
    • list [If constituent id passed in parameter then method will return list of address constituents]
    • 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
    • get
    • create
    • update
    • delete
  6. education
    • list
    • get
    • create
    • update
    • delete
  7. email_addresses
    • list [If constituent id passed in parameter then method will return list of email constituents]
    • create
    • update
    • delete
    • types
  8. phone
    • list [If constituent id passed in parameter then method will return list of phone constituents]
    • 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 [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


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)

Uploaded Source

Built Distribution

sky_api_client-1.0.2-py3-none-any.whl (2.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page