sky-api-client


Namesky-api-client JSON
Version 3.3.6 PyPI version JSON
download
home_pagehttps://bitbucket.org/kalyanvarma/skyapi
SummaryPython client for RENXT APIs
upload_time2024-11-12 04:20:03
maintainerNone
docs_urlNone
authorRajeev K L
requires_python>=3.5
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 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
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`.

```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/07/b8/dddeca2783b4483ce5fa83b700af49b74d9810502588025178df319fd202/sky_api_client-3.3.6.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## 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\n```python\nsky_api.address.list('constituent_id')\n```\n\n## Available Entities and Methods\n\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\n20. action\n    - list\n    - create\n    - get\n    - update\n    - delete\n    - types\n    - list_all\n21. action_status\n    - list\n\nThese entities can be used same as above example for `constituent`.\n\n```python\nemail_address_list = sky_api.email_addresses.list()\n```\n\n> Note:- Current version doesn't have refresh token functionality.\n\n# Updating Version\n\n```\n$ semversioner add-change --type patch --description \"description for the change\"\n$ ./release\n```\n\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Python client for RENXT APIs",
    "version": "3.3.6",
    "project_urls": {
        "Homepage": "https://bitbucket.org/kalyanvarma/skyapi"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "96bfe73e4f7b8942d7cf0cc7a16f1ce4fdf8cfa1aa4444ed1677b7427cf32cdc",
                "md5": "55498dbd04b998d068ed22b7199c28ca",
                "sha256": "84e096b5856617e91431446d1950ecf54eeeb27d2ce5dc776aa57eee274c2d71"
            },
            "downloads": -1,
            "filename": "sky_api_client-3.3.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "55498dbd04b998d068ed22b7199c28ca",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.5",
            "size": 26392,
            "upload_time": "2024-11-12T04:20:01",
            "upload_time_iso_8601": "2024-11-12T04:20:01.865101Z",
            "url": "https://files.pythonhosted.org/packages/96/bf/e73e4f7b8942d7cf0cc7a16f1ce4fdf8cfa1aa4444ed1677b7427cf32cdc/sky_api_client-3.3.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "07b8dddeca2783b4483ce5fa83b700af49b74d9810502588025178df319fd202",
                "md5": "989a93077af804dc1f9f8b6d19f8e633",
                "sha256": "2724d28ccd86118bfb1e4599286776f049929e8d7f1bfe788098499334722b6d"
            },
            "downloads": -1,
            "filename": "sky_api_client-3.3.6.tar.gz",
            "has_sig": false,
            "md5_digest": "989a93077af804dc1f9f8b6d19f8e633",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5",
            "size": 9986,
            "upload_time": "2024-11-12T04:20:03",
            "upload_time_iso_8601": "2024-11-12T04:20:03.583220Z",
            "url": "https://files.pythonhosted.org/packages/07/b8/dddeca2783b4483ce5fa83b700af49b74d9810502588025178df319fd202/sky_api_client-3.3.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-12 04:20:03",
    "github": false,
    "gitlab": false,
    "bitbucket": true,
    "codeberg": false,
    "bitbucket_user": "kalyanvarma",
    "bitbucket_project": "skyapi",
    "lcname": "sky-api-client"
}
        
Elapsed time: 0.32456s