dripdrop 0.1.0

Drip Drop API

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 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:

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:

import dripdrop

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import dripdrop

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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	POST /v1/contacts/	Create a contact
ContactsApi	destroy	DELETE /v1/contacts/{uuid}/	Delete a contact
ContactsApi	list	GET /v1/contacts/	List contacts
ContactsApi	partial_update	PATCH /v1/contacts/{uuid}/	Patch a contact
ContactsApi	retrieve	GET /v1/contacts/{uuid}/	Get a contact
ContactsApi	update	PUT /v1/contacts/{uuid}/	Update a contact
CustomFieldsApi	create	POST /v1/custom-fields/	Create a custom field definition
CustomFieldsApi	destroy	DELETE /v1/custom-fields/{uuid}/	Delete a custom field definition
CustomFieldsApi	list	GET /v1/custom-fields/	List custom field definitions
CustomFieldsApi	partial_update	PATCH /v1/custom-fields/{uuid}/	Patch a custom field definition
CustomFieldsApi	retrieve	GET /v1/custom-fields/{uuid}/	Get a custom field definition
CustomFieldsApi	update	PUT /v1/custom-fields/{uuid}/	Update a custom field definition
EnrollmentsApi	create	POST /v1/enrollments/	Enroll a contact
EnrollmentsApi	destroy	DELETE /v1/enrollments/{uuid}/	Unenroll a contact
EnrollmentsApi	list	GET /v1/enrollments/	List enrollments
FlowsApi	create_contact_and_enroll_create	POST /v1/flows/{uuid}/create-contact-and-enroll/	Create contact and enroll in flow
FlowsApi	list	GET /v1/flows/	List flows
FlowsApi	retrieve	GET /v1/flows/{uuid}/	Get a flow
SchemaApi	retrieve	GET /schema/

Documentation For Models

• Contact
• ContactAlreadyExists
• CreateContactAndEnroll
• CreateContactAndEnrollSuccess
• CurrentPassword
• CustomFieldDefinition
• EmailAddress
• FieldTypeEnum
• FlowEnrollmentStatusesEnum
• FlowStatusEnum
• PaginatedContactList
• PaginatedCustomFieldDefinitionList
• PaginatedPublicFlowEnrollmentList
• PaginatedPublicFlowList
• PatchedContact
• PatchedCustomFieldDefinition
• PhoneNumber
• PublicFlow
• PublicFlowEnrollment

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

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

Author