beehiiv

Name	beehiiv JSON
Version	0.2 JSON
	download
home_page	https://github.com/abrihter/beehiiv
Summary	Python wrapper for the BeeHiiv API
upload_time	2023-07-27 10:22:16
maintainer
docs_url	None
author	abrihter
requires_python
license	MIT
keywords	beehiiv api wrapper
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # beehiiv
Python wrapper for BeeHiiv API

#### Install
```
pip3 install beehiiv
```

### Example
```Python
import os
import beehiiv

PUBLICATION_ID = os.environ['BEEHIIV_PUBLICATION_ID']
API_KEY = os.environ['BEEHIIV_API_KEY']

bh = beehiiv.BeeHiiv(api_key=API_KEY, publicationId=PUBLICATION_ID)
subscriptions = bh.subscriptions.index(
  expand=["stats", "custom_fields"],
  limit=5
)
print(subscriptions)
```

## Classes and methods
```
BeeHiiv.email_blast.index - Retrieve all Email Blasts
BeeHiiv.email_blast.show - Retrieve an Email Blast

BeeHiiv.posts.index - Retrieve all posts belonging to a specific publication
BeeHiiv.posts.show - Retreive a single Post belonging to a specific publication
BeeHiiv.posts.destory - Delete or Archive a post.

BeeHiiv.publications.index - Retrieve all publications associated with your API key.
BeeHiiv.publications.show - Retrieve a single publication

BeeHiiv.referral_program.show - Retrieve details about the publication's referral program

BeeHiiv.segments.index - Retrieve information about all segments belonging to a specific publication
BeeHiiv.segments.show - Retrieve a single segment belonging to a specific publication
BeeHiiv.segments.delete - Delete a segment.
BeeHiiv.segments.expand_results - List the Subscriber Ids from the most recent calculation of a specific publication.

BeeHiiv.subscriptions.create - Create new subscriptions for a publication.  
BeeHiiv.subscriptions.index - Retrieve all subscriptions belonging to a specific publication
BeeHiiv.subscriptions.show - Retrieve a single subscription belonging to a specific publication
BeeHiiv.subscriptions.update - Update a subscriber 
BeeHiiv.subscriptions.delete - Delete a subscription.
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/abrihter/beehiiv",
    "name": "beehiiv",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "BEEHIIV,API,WRAPPER",
    "author": "abrihter",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/d3/cd/6073fc3fbde040e30d87c7da962175d4946a6a27014ec63bd98f232eb04a/beehiiv-0.2.tar.gz",
    "platform": null,
    "description": "# beehiiv\nPython wrapper for BeeHiiv API\n\n#### Install\n```\npip3 install beehiiv\n```\n\n### Example\n```Python\nimport os\nimport beehiiv\n\nPUBLICATION_ID = os.environ['BEEHIIV_PUBLICATION_ID']\nAPI_KEY = os.environ['BEEHIIV_API_KEY']\n\nbh = beehiiv.BeeHiiv(api_key=API_KEY, publicationId=PUBLICATION_ID)\nsubscriptions = bh.subscriptions.index(\n  expand=[\"stats\", \"custom_fields\"],\n  limit=5\n)\nprint(subscriptions)\n```\n\n## Classes and methods\n```\nBeeHiiv.email_blast.index - Retrieve all Email Blasts\nBeeHiiv.email_blast.show - Retrieve an Email Blast\n\nBeeHiiv.posts.index - Retrieve all posts belonging to a specific publication\nBeeHiiv.posts.show - Retreive a single Post belonging to a specific publication\nBeeHiiv.posts.destory - Delete or Archive a post.\n\nBeeHiiv.publications.index - Retrieve all publications associated with your API key.\nBeeHiiv.publications.show - Retrieve a single publication\n\nBeeHiiv.referral_program.show - Retrieve details about the publication's referral program\n\nBeeHiiv.segments.index - Retrieve information about all segments belonging to a specific publication\nBeeHiiv.segments.show - Retrieve a single segment belonging to a specific publication\nBeeHiiv.segments.delete - Delete a segment.\nBeeHiiv.segments.expand_results - List the Subscriber Ids from the most recent calculation of a specific publication.\n\nBeeHiiv.subscriptions.create - Create new subscriptions for a publication.  \nBeeHiiv.subscriptions.index - Retrieve all subscriptions belonging to a specific publication\nBeeHiiv.subscriptions.show - Retrieve a single subscription belonging to a specific publication\nBeeHiiv.subscriptions.update - Update a subscriber \nBeeHiiv.subscriptions.delete - Delete a subscription.\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python wrapper for the BeeHiiv API",
    "version": "0.2",
    "project_urls": {
        "Download": "https://github.com/abrihter/beehiiv/archive/refs/tags/v0.2.tar.gz",
        "Homepage": "https://github.com/abrihter/beehiiv"
    },
    "split_keywords": [
        "beehiiv",
        "api",
        "wrapper"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d3cd6073fc3fbde040e30d87c7da962175d4946a6a27014ec63bd98f232eb04a",
                "md5": "4f1f01ac641628b763262b4a8f2ecf51",
                "sha256": "f69574d0746587bc735e03451cc59127daca35d2b6fa4931333964f1fccf9b8c"
            },
            "downloads": -1,
            "filename": "beehiiv-0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "4f1f01ac641628b763262b4a8f2ecf51",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 7211,
            "upload_time": "2023-07-27T10:22:16",
            "upload_time_iso_8601": "2023-07-27T10:22:16.808747Z",
            "url": "https://files.pythonhosted.org/packages/d3/cd/6073fc3fbde040e30d87c7da962175d4946a6a27014ec63bd98f232eb04a/beehiiv-0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-27 10:22:16",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "abrihter",
    "github_project": "beehiiv",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "beehiiv"
}