Metadata-Version: 2.4
Name: dripdrop
Version: 0.1.0
Summary: Drip Drop API
Home-page: 
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
Project-URL: Repository, https://github.com/layline-dev/dripdrop-python
Keywords: OpenAPI,OpenAPI-Generator,Drip Drop API
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author

# dripdrop-python
API for integrations with Drip Drop.Authenticate by passing your API key in the `X-API-Key` header.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 0.1.0
- Generator version: 7.20.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/layline-dev/dripdrop-python.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/layline-dev/dripdrop-python.git`)

Then import the package:
```python
import dripdrop
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import dripdrop
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import dripdrop
from dripdrop.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dripdrop.dev
# See configuration.py for a list of all supported configuration parameters.
configuration = dripdrop.Configuration(
    host = "https://api.dripdrop.dev"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with dripdrop.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dripdrop.ContactsApi(api_client)
    contact = dripdrop.Contact() # Contact | 

    try:
        # Create a contact
        api_response = api_instance.create(contact)
        print("The response of ContactsApi->create:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ContactsApi->create: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.dripdrop.dev*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ContactsApi* | [**create**](docs/ContactsApi.md#create) | **POST** /v1/contacts/ | Create a contact
*ContactsApi* | [**destroy**](docs/ContactsApi.md#destroy) | **DELETE** /v1/contacts/{uuid}/ | Delete a contact
*ContactsApi* | [**list**](docs/ContactsApi.md#list) | **GET** /v1/contacts/ | List contacts
*ContactsApi* | [**partial_update**](docs/ContactsApi.md#partial_update) | **PATCH** /v1/contacts/{uuid}/ | Patch a contact
*ContactsApi* | [**retrieve**](docs/ContactsApi.md#retrieve) | **GET** /v1/contacts/{uuid}/ | Get a contact
*ContactsApi* | [**update**](docs/ContactsApi.md#update) | **PUT** /v1/contacts/{uuid}/ | Update a contact
*CustomFieldsApi* | [**create**](docs/CustomFieldsApi.md#create) | **POST** /v1/custom-fields/ | Create a custom field definition
*CustomFieldsApi* | [**destroy**](docs/CustomFieldsApi.md#destroy) | **DELETE** /v1/custom-fields/{uuid}/ | Delete a custom field definition
*CustomFieldsApi* | [**list**](docs/CustomFieldsApi.md#list) | **GET** /v1/custom-fields/ | List custom field definitions
*CustomFieldsApi* | [**partial_update**](docs/CustomFieldsApi.md#partial_update) | **PATCH** /v1/custom-fields/{uuid}/ | Patch a custom field definition
*CustomFieldsApi* | [**retrieve**](docs/CustomFieldsApi.md#retrieve) | **GET** /v1/custom-fields/{uuid}/ | Get a custom field definition
*CustomFieldsApi* | [**update**](docs/CustomFieldsApi.md#update) | **PUT** /v1/custom-fields/{uuid}/ | Update a custom field definition
*EnrollmentsApi* | [**create**](docs/EnrollmentsApi.md#create) | **POST** /v1/enrollments/ | Enroll a contact
*EnrollmentsApi* | [**destroy**](docs/EnrollmentsApi.md#destroy) | **DELETE** /v1/enrollments/{uuid}/ | Unenroll a contact
*EnrollmentsApi* | [**list**](docs/EnrollmentsApi.md#list) | **GET** /v1/enrollments/ | List enrollments
*FlowsApi* | [**create_contact_and_enroll_create**](docs/FlowsApi.md#create_contact_and_enroll_create) | **POST** /v1/flows/{uuid}/create-contact-and-enroll/ | Create contact and enroll in flow
*FlowsApi* | [**list**](docs/FlowsApi.md#list) | **GET** /v1/flows/ | List flows
*FlowsApi* | [**retrieve**](docs/FlowsApi.md#retrieve) | **GET** /v1/flows/{uuid}/ | Get a flow
*SchemaApi* | [**retrieve**](docs/SchemaApi.md#retrieve) | **GET** /schema/ | 


## Documentation For Models

 - [Contact](docs/Contact.md)
 - [ContactAlreadyExists](docs/ContactAlreadyExists.md)
 - [CreateContactAndEnroll](docs/CreateContactAndEnroll.md)
 - [CreateContactAndEnrollSuccess](docs/CreateContactAndEnrollSuccess.md)
 - [CurrentPassword](docs/CurrentPassword.md)
 - [CustomFieldDefinition](docs/CustomFieldDefinition.md)
 - [EmailAddress](docs/EmailAddress.md)
 - [FieldTypeEnum](docs/FieldTypeEnum.md)
 - [FlowEnrollmentStatusesEnum](docs/FlowEnrollmentStatusesEnum.md)
 - [FlowStatusEnum](docs/FlowStatusEnum.md)
 - [PaginatedContactList](docs/PaginatedContactList.md)
 - [PaginatedCustomFieldDefinitionList](docs/PaginatedCustomFieldDefinitionList.md)
 - [PaginatedPublicFlowEnrollmentList](docs/PaginatedPublicFlowEnrollmentList.md)
 - [PaginatedPublicFlowList](docs/PaginatedPublicFlowList.md)
 - [PatchedContact](docs/PatchedContact.md)
 - [PatchedCustomFieldDefinition](docs/PatchedCustomFieldDefinition.md)
 - [PhoneNumber](docs/PhoneNumber.md)
 - [PublicFlow](docs/PublicFlow.md)
 - [PublicFlowEnrollment](docs/PublicFlowEnrollment.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="ApiKeyAuth"></a>
### ApiKeyAuth

- **Type**: API key
- **API key parameter name**: X-API-Key
- **Location**: HTTP header


## Author




