rcs 1.0.20

No project description provided

Pinnacle Python Library

The Pinnacle Python library provides convenient access to the Pinnacle API from Python.

Installation

pip install rcs

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

from rcs import (
    CompanyContact,
    CompanyDetails,
    Messaging,
    Pinnacle,
    PointOfContact,
)

client = Pinnacle(
    api_key="YOUR_API_KEY",
)
client.company.register(
    company=CompanyDetails(
        name="name",
        category="Entertainment",
        address="address",
        ein="ein",
        description="description",
        brand_color="brandColor",
        logo_url="logoUrl",
        hero_url="heroUrl",
    ),
    company_contact=CompanyContact(
        primary_website_url="primaryWebsiteUrl",
        primary_website_label="primaryWebsiteLabel",
        primary_phone="primaryPhone",
        primary_phone_label="primaryPhoneLabel",
        primary_email="primaryEmail",
        primary_email_label="primaryEmailLabel",
        privacy_policy_url="privacyPolicyUrl",
        tos_url="tosUrl",
    ),
    messaging=Messaging(
        opt_in="By opting in, you agree to receive messages from Pinnacle, including updates and promotions. Reply “STOP” to unsubscribe. Standard message and data rates may apply.",
        opt_out="Reply with keywords like STOP or UNSUBSCRIBE to opt-out. A confirmation message will be sent, and no further messages will be received unless you re-subscribe.",
        opt_out_keywords=["STOP", "UNSUBSCRIBE"],
        agent_use_case="Pinnacle’s agent assists with product updates, promotions, order tracking, and support. It answers FAQs, provides order updates, and helps with opt-in/out processes. Escalates to live support when needed.",
        expected_agent_responses="General Inquiry: “How can I assist you today?”\nOrder Status: “Provide your order number.”\nOpt-In: “You’re now subscribed!”\nOpt-Out: “You have unsubscribed.”\nEscalation: “Connecting to a live agent.”    \n",
    ),
    point_of_contact=PointOfContact(
        poc_name="pocName",
        poc_title="pocTitle",
        poc_email="pocEmail",
    ),
)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API.

import asyncio

from rcs import (
    AsyncPinnacle,
    CompanyContact,
    CompanyDetails,
    Messaging,
    PointOfContact,
)

client = AsyncPinnacle(
    api_key="YOUR_API_KEY",
)


async def main() -> None:
    await client.company.register(
        company=CompanyDetails(
            name="name",
            category="Entertainment",
            address="address",
            ein="ein",
            description="description",
            brand_color="brandColor",
            logo_url="logoUrl",
            hero_url="heroUrl",
        ),
        company_contact=CompanyContact(
            primary_website_url="primaryWebsiteUrl",
            primary_website_label="primaryWebsiteLabel",
            primary_phone="primaryPhone",
            primary_phone_label="primaryPhoneLabel",
            primary_email="primaryEmail",
            primary_email_label="primaryEmailLabel",
            privacy_policy_url="privacyPolicyUrl",
            tos_url="tosUrl",
        ),
        messaging=Messaging(
            opt_in="By opting in, you agree to receive messages from Pinnacle, including updates and promotions. Reply “STOP” to unsubscribe. Standard message and data rates may apply.",
            opt_out="Reply with keywords like STOP or UNSUBSCRIBE to opt-out. A confirmation message will be sent, and no further messages will be received unless you re-subscribe.",
            opt_out_keywords=["STOP", "UNSUBSCRIBE"],
            agent_use_case="Pinnacle’s agent assists with product updates, promotions, order tracking, and support. It answers FAQs, provides order updates, and helps with opt-in/out processes. Escalates to live support when needed.",
            expected_agent_responses="General Inquiry: “How can I assist you today?”\nOrder Status: “Provide your order number.”\nOpt-In: “You’re now subscribed!”\nOpt-Out: “You have unsubscribed.”\nEscalation: “Connecting to a live agent.”    \n",
        ),
        point_of_contact=PointOfContact(
            poc_name="pocName",
            poc_title="pocTitle",
            poc_email="pocEmail",
        ),
    )


asyncio.run(main())

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

from rcs.core.api_error import ApiError

try:
    client.company.register(...)
except ApiError as e:
    print(e.status_code)
    print(e.body)

Advanced

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retriable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retriable when any of the following HTTP status codes is returned:

• 408 (Timeout)
• 429 (Too Many Requests)
• 5XX (Internal Server Errors)

Use the max_retries request option to configure this behavior.

client.company.register(..., request_options={
        "max_retries": 1
    })
    ```

### Timeouts

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

```python

    from rcs import Pinnacle

client = Pinnacle(
    ...,
    timeout=20.0,
)


    # Override timeout for a specific method
    client.company.register(..., request_options={
        "timeout_in_seconds": 1
    })
    ```

### Custom Client

You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
and transports.
```python
import httpx
from rcs import Pinnacle

client = Pinnacle(
    ...,
    httpx_client=httpx.Client(
        proxies="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!