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
    • 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
  20. action
    • list
    • create
    • get
    • update
    • delete
    • types
    • list_all
  21. action_status
    • list

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.

Updating Version

$ semversioner add-change --type patch --description "description for the change"
$ ./release

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-3.3.9.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sky_api_client-3.3.9-py3-none-any.whl (27.5 kB view details)

Uploaded Python 3

File details

Details for the file sky_api_client-3.3.9.tar.gz.

File metadata

  • Download URL: sky_api_client-3.3.9.tar.gz
  • Upload date:
  • Size: 10.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.9

File hashes

Hashes for sky_api_client-3.3.9.tar.gz
Algorithm Hash digest
SHA256 dfa8dd04ed52da3cfd3134a3a0dcdbcf7029c75968fe816ec6a1f8ff63d1971c
MD5 761b2ef92cc5a76018ab56de256f14d9
BLAKE2b-256 25d6be13304a3df88d8af23758095cbcb1e5689b32ea6478148f071f2a89ef45

See more details on using hashes here.

File details

Details for the file sky_api_client-3.3.9-py3-none-any.whl.

File metadata

  • Download URL: sky_api_client-3.3.9-py3-none-any.whl
  • Upload date:
  • Size: 27.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.6.0 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.7.9

File hashes

Hashes for sky_api_client-3.3.9-py3-none-any.whl
Algorithm Hash digest
SHA256 8e7b67391e1e0bebc39df5220efe84533a65c36accb8966c516b33aac024343f
MD5 39baebee64b324168483363cd2c24f9d
BLAKE2b-256 0482aa8fb37d344a277a154c8069012b48f91cdb21775945487cb0346dbff91a

See more details on using hashes here.

Supported by

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