Skip to content

Commit

Permalink
Feat: Added events and track identify api calls
Browse files Browse the repository at this point in the history
  • Loading branch information
homewardgamer committed Nov 20, 2024
1 parent caa4cf8 commit 7f0047a
Show file tree
Hide file tree
Showing 72 changed files with 3,317 additions and 165 deletions.
27 changes: 27 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -11,31 +11,42 @@ docs/Contact.md
docs/ContactApi.md
docs/ContactRequest.md
docs/CreateResponse.md
docs/CustomEventRequest.md
docs/DashboardStats.md
docs/DeleteCampaign200Response.md
docs/DeleteRequest.md
docs/DeleteResponse.md
docs/EventApi.md
docs/EventResponse.md
docs/GettingStartedApi.md
docs/IdentifyRequest.md
docs/IdentifyResponse.md
docs/LastSentCampaignStat.md
docs/ListApi.md
docs/ListModel.md
docs/ListRequest.md
docs/ReportData.md
docs/ReportsApi.md
docs/Response.md
docs/RevenueEventRequest.md
docs/Sender.md
docs/SenderApi.md
docs/SenderRequest.md
docs/SenderResponse.md
docs/Tag.md
docs/TagRequest.md
docs/TagsApi.md
docs/TrackRequest.md
docs/TrackResponse.md
git_push.sh
pyproject.toml
requirements.txt
sendx_python_sdk/__init__.py
sendx_python_sdk/api/__init__.py
sendx_python_sdk/api/campaign_api.py
sendx_python_sdk/api/contact_api.py
sendx_python_sdk/api/event_api.py
sendx_python_sdk/api/getting_started_api.py
sendx_python_sdk/api/list_api.py
sendx_python_sdk/api/reports_api.py
sendx_python_sdk/api/sender_api.py
Expand All @@ -51,24 +62,40 @@ sendx_python_sdk/models/campaign_request.py
sendx_python_sdk/models/contact.py
sendx_python_sdk/models/contact_request.py
sendx_python_sdk/models/create_response.py
sendx_python_sdk/models/custom_event_request.py
sendx_python_sdk/models/dashboard_stats.py
sendx_python_sdk/models/delete_campaign200_response.py
sendx_python_sdk/models/delete_request.py
sendx_python_sdk/models/delete_response.py
sendx_python_sdk/models/event_response.py
sendx_python_sdk/models/identify_request.py
sendx_python_sdk/models/identify_response.py
sendx_python_sdk/models/last_sent_campaign_stat.py
sendx_python_sdk/models/list_model.py
sendx_python_sdk/models/list_request.py
sendx_python_sdk/models/report_data.py
sendx_python_sdk/models/response.py
sendx_python_sdk/models/revenue_event_request.py
sendx_python_sdk/models/sender.py
sendx_python_sdk/models/sender_request.py
sendx_python_sdk/models/sender_response.py
sendx_python_sdk/models/tag.py
sendx_python_sdk/models/tag_request.py
sendx_python_sdk/models/track_request.py
sendx_python_sdk/models/track_response.py
sendx_python_sdk/py.typed
sendx_python_sdk/rest.py
setup.cfg
setup.py
test-requirements.txt
test/__init__.py
test/test_custom_event_request.py
test/test_event_api.py
test/test_event_response.py
test/test_getting_started_api.py
test/test_identify_request.py
test/test_identify_response.py
test/test_revenue_event_request.py
test/test_track_request.py
test/test_track_response.py
tox.ini
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,11 +96,15 @@ Class | Method | HTTP request | Description
*CampaignApi* | [**get_all_campaigns**](docs/CampaignApi.md#get_all_campaigns) | **GET** /campaign | Get All Campaigns
*CampaignApi* | [**get_campaign_by_id**](docs/CampaignApi.md#get_campaign_by_id) | **GET** /campaign/{campaignId} | Get Campaign By Id
*ContactApi* | [**create_contact**](docs/ContactApi.md#create_contact) | **POST** /contact | Create a contact
*ContactApi* | [**delete_contact**](docs/ContactApi.md#delete_contact) | **DELETE** /contact/{contactId} | Delete Contact
*ContactApi* | [**delete_contact**](docs/ContactApi.md#delete_contact) | **DELETE** /contact/{identifier} | Delete Contact
*ContactApi* | [**get_all_contacts**](docs/ContactApi.md#get_all_contacts) | **GET** /contact | Get All Contacts
*ContactApi* | [**get_contact_by_id**](docs/ContactApi.md#get_contact_by_id) | **GET** /contact/{contactId} | Get Contact by ID
*ContactApi* | [**unsubscribe_contact**](docs/ContactApi.md#unsubscribe_contact) | **PUT** /contact/unsubscribe/{contactId} | Unsubscribe Contact
*ContactApi* | [**update_contact**](docs/ContactApi.md#update_contact) | **PUT** /contact/{contactId} | Update Contact
*ContactApi* | [**get_contact_by_id**](docs/ContactApi.md#get_contact_by_id) | **GET** /contact/{identifier} | Get Contact by Identifier
*ContactApi* | [**unsubscribe_contact**](docs/ContactApi.md#unsubscribe_contact) | **POST** /contact/unsubscribe/{identifier} | Unsubscribe Contact
*ContactApi* | [**update_contact**](docs/ContactApi.md#update_contact) | **PUT** /contact/{identifier} | Update Contact
*EventApi* | [**create_revenue_event**](docs/EventApi.md#create_revenue_event) | **POST** /events/revenue | Record a revenue event for a specific contact
*EventApi* | [**push_custom_event**](docs/EventApi.md#push_custom_event) | **POST** /events/custom | Push a custom event associated with a contact
*GettingStartedApi* | [**identify_contact**](docs/GettingStartedApi.md#identify_contact) | **POST** /contact/identify | Identify contact
*GettingStartedApi* | [**tracking_contact**](docs/GettingStartedApi.md#tracking_contact) | **POST** /contact/track | Add Tracking info
*ListApi* | [**create_list**](docs/ListApi.md#create_list) | **POST** /list | Create List
*ListApi* | [**delete_list**](docs/ListApi.md#delete_list) | **DELETE** /list/{listId} | Delete List
*ListApi* | [**get_all_lists**](docs/ListApi.md#get_all_lists) | **GET** /list | Get All Lists
Expand All @@ -124,20 +128,27 @@ Class | Method | HTTP request | Description
- [Contact](docs/Contact.md)
- [ContactRequest](docs/ContactRequest.md)
- [CreateResponse](docs/CreateResponse.md)
- [CustomEventRequest](docs/CustomEventRequest.md)
- [DashboardStats](docs/DashboardStats.md)
- [DeleteCampaign200Response](docs/DeleteCampaign200Response.md)
- [DeleteRequest](docs/DeleteRequest.md)
- [DeleteResponse](docs/DeleteResponse.md)
- [EventResponse](docs/EventResponse.md)
- [IdentifyRequest](docs/IdentifyRequest.md)
- [IdentifyResponse](docs/IdentifyResponse.md)
- [LastSentCampaignStat](docs/LastSentCampaignStat.md)
- [ListModel](docs/ListModel.md)
- [ListRequest](docs/ListRequest.md)
- [ReportData](docs/ReportData.md)
- [Response](docs/Response.md)
- [RevenueEventRequest](docs/RevenueEventRequest.md)
- [Sender](docs/Sender.md)
- [SenderRequest](docs/SenderRequest.md)
- [SenderResponse](docs/SenderResponse.md)
- [Tag](docs/Tag.md)
- [TagRequest](docs/TagRequest.md)
- [TrackRequest](docs/TrackRequest.md)
- [TrackResponse](docs/TrackResponse.md)


<a id="documentation-for-authorization"></a>
Expand Down
75 changes: 55 additions & 20 deletions docs/CampaignApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,22 @@ from sendx_python_sdk.models.create_response import CreateResponse
from sendx_python_sdk.rest import ApiException
from pprint import pprint

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

configuration = sendx_python_sdk.Configuration()


# 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 sendx_python_sdk.ApiClient(configuration) as api_client:
Expand Down Expand Up @@ -106,15 +113,22 @@ from sendx_python_sdk.models.delete_campaign200_response import DeleteCampaign20
from sendx_python_sdk.rest import ApiException
from pprint import pprint

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

configuration = sendx_python_sdk.Configuration()


# 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 sendx_python_sdk.ApiClient(configuration) as api_client:
Expand Down Expand Up @@ -183,15 +197,22 @@ from sendx_python_sdk.models.campaign_request import CampaignRequest
from sendx_python_sdk.rest import ApiException
from pprint import pprint

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

configuration = sendx_python_sdk.Configuration()


# 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 sendx_python_sdk.ApiClient(configuration) as api_client:
Expand Down Expand Up @@ -262,15 +283,22 @@ from sendx_python_sdk.models.campaign import Campaign
from sendx_python_sdk.rest import ApiException
from pprint import pprint

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

configuration = sendx_python_sdk.Configuration()


# 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 sendx_python_sdk.ApiClient(configuration) as api_client:
Expand Down Expand Up @@ -340,15 +368,22 @@ from sendx_python_sdk.models.campaign import Campaign
from sendx_python_sdk.rest import ApiException
from pprint import pprint

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

configuration = sendx_python_sdk.Configuration()


# 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 sendx_python_sdk.ApiClient(configuration) as api_client:
Expand Down
2 changes: 2 additions & 0 deletions docs/Contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ Name | Type | Description | Notes
**ltv** | **int** | Lifetime value (LTV) of the contact in currency units. | [optional]
**contact_source** | **int** | The source from which the contact was added. Possible values: | [optional]
**last_tracked_ip** | **str** | The last known IP address tracked for the contact. | [optional]
**lists** | **List[str]** | A list of &#x60;lists&#x60; ids the contact is subscribed to. | [optional]
**tags** | **List[str]** | &#x60;Tag&#x60; ids associated with the contact for segmentation or categorization. | [optional]

## Example

Expand Down
Loading

0 comments on commit 7f0047a

Please sign in to comment.