Metadata-Version: 2.4
Name: ddx-interactions-api
Version: 0.2.0
Summary: Interactions API
Home-page: https://github.com/Movement-Infrastructure/interactions-api-sdks
Author: DDx API Team
Author-email: api@demexchange.com
License: MIT
Project-URL: Changelog, https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/python/v1/CHANGELOG.md
Keywords: OpenAPI,OpenAPI-Generator,Interactions API
Requires-Python: >= 3.8
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=1.25.3
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Requires-Dist: certifi>=2024.2.2
Dynamic: author
Dynamic: author-email
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# ddx-interactions-api
Interactions API documentation

Python client for the DDx Interactions API, generated from its OpenAPI
specification.

- API version: v1
- Package version: 0.2.0
- Generator version: 7.10.0

For more information, please visit [https://demexchange.com/](https://demexchange.com/).

## Requirements

Python 3.8+

## Installation

```sh
pip install ddx-interactions-api
```

Then import the package:

```python
import ddx_interactions_api
```

## Changelog

API changes are recorded in the
[changelog](https://github.com/Movement-Infrastructure/interactions-api-sdks/blob/main/sdks/python/v1/CHANGELOG.md),
regenerated from a diff of the OpenAPI specification on each sync. Entries
marked **breaking** require a change on the consumer side.

## Reporting issues

This package is generated; edits to it are overwritten on the next spec sync.
Report problems against the API specification rather than the generated code.

## Getting Started

```python

import ddx_interactions_api
from ddx_interactions_api.rest import ApiException
from pprint import pprint

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

# 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 HTTP basic authorization: Basic
configuration = ddx_interactions_api.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)


# Enter a context with an instance of the API client
with ddx_interactions_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ddx_interactions_api.AuthenticationDetailsApi(api_client)
    version = '1' # str |  (default to '1')

    try:
        # Get authentication context
        api_response = api_instance.vversion_auth_me_get(version)
        print("The response of AuthenticationDetailsApi->vversion_auth_me_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthenticationDetailsApi->vversion_auth_me_get: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.movementinfrastructure.org*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AuthenticationDetailsApi* | [**vversion_auth_me_get**](docs/AuthenticationDetailsApi.md#vversion_auth_me_get) | **GET** /v{version}/auth/me | Get authentication context
*InteractionsApi* | [**vversion_interactions_exchange_status_get**](docs/InteractionsApi.md#vversion_interactions_exchange_status_get) | **GET** /v{version}/interactions/exchange-status | Get Exchange pipeline statuses by correlation or interaction ID
*InteractionsApi* | [**vversion_interactions_exchange_status_range_get**](docs/InteractionsApi.md#vversion_interactions_exchange_status_range_get) | **GET** /v{version}/interactions/exchange-status/range | Get Exchange pipeline statuses by date range
*InteractionsApi* | [**vversion_interactions_interaction_id_transactions_get**](docs/InteractionsApi.md#vversion_interactions_interaction_id_transactions_get) | **GET** /v{version}/interactions/{interactionId}/transactions | Get external API transactions by interactionId
*InteractionsApi* | [**vversion_interactions_post**](docs/InteractionsApi.md#vversion_interactions_post) | **POST** /v{version}/interactions | Post interactions data
*InteractionsApi* | [**vversion_interactions_transactions_get**](docs/InteractionsApi.md#vversion_interactions_transactions_get) | **GET** /v{version}/interactions/transactions | Get external API transaction logs by date range


## Documentation For Models

 - [AcceptedInteractionDto](docs/AcceptedInteractionDto.md)
 - [AcceptedInteractionsDto](docs/AcceptedInteractionsDto.md)
 - [ActivistCode](docs/ActivistCode.md)
 - [ActivistCodeOutcomeDetails](docs/ActivistCodeOutcomeDetails.md)
 - [Address](docs/Address.md)
 - [AddressChannelDetails](docs/AddressChannelDetails.md)
 - [CanvasserDetails](docs/CanvasserDetails.md)
 - [CommitteeDetails](docs/CommitteeDetails.md)
 - [CommunicationConsent](docs/CommunicationConsent.md)
 - [CommunicationConsentOutcomeDetails](docs/CommunicationConsentOutcomeDetails.md)
 - [CommunicationConsentStatus](docs/CommunicationConsentStatus.md)
 - [ContactInfo](docs/ContactInfo.md)
 - [ContactMethod](docs/ContactMethod.md)
 - [DynamicChannelDetails](docs/DynamicChannelDetails.md)
 - [DynamicOutcomeDetails](docs/DynamicOutcomeDetails.md)
 - [EventDetails](docs/EventDetails.md)
 - [EventRole](docs/EventRole.md)
 - [EventSignup](docs/EventSignup.md)
 - [EventSignupOutcomeDetails](docs/EventSignupOutcomeDetails.md)
 - [EventSignupStatus](docs/EventSignupStatus.md)
 - [EventSignupStatusValue](docs/EventSignupStatusValue.md)
 - [ExchangeInteractionStatus](docs/ExchangeInteractionStatus.md)
 - [ExchangeInteractionStatusDto](docs/ExchangeInteractionStatusDto.md)
 - [ExchangeInteractionStatusDtoCursorPaginatedResponseDto](docs/ExchangeInteractionStatusDtoCursorPaginatedResponseDto.md)
 - [ExternalApiKeyStatus](docs/ExternalApiKeyStatus.md)
 - [ExternalApiKeyType](docs/ExternalApiKeyType.md)
 - [ExternalTransactionStatus](docs/ExternalTransactionStatus.md)
 - [InitiativeDto](docs/InitiativeDto.md)
 - [InteractionDto](docs/InteractionDto.md)
 - [InteractionDtoChannel](docs/InteractionDtoChannel.md)
 - [InteractionDtoOutcomesDetailedInner](docs/InteractionDtoOutcomesDetailedInner.md)
 - [InteractionErrorDto](docs/InteractionErrorDto.md)
 - [InteractionVanFieldsDto](docs/InteractionVanFieldsDto.md)
 - [InteractionsBatchResultDto](docs/InteractionsBatchResultDto.md)
 - [InteractionsDto](docs/InteractionsDto.md)
 - [InteractionsExternalApiTransactionDto](docs/InteractionsExternalApiTransactionDto.md)
 - [InteractionsExternalApiTransactionDtoGetResponseDto](docs/InteractionsExternalApiTransactionDtoGetResponseDto.md)
 - [InteractionsExternalApiTransactionLogDto](docs/InteractionsExternalApiTransactionLogDto.md)
 - [MercuryDestinationVanApiKeyDto](docs/MercuryDestinationVanApiKeyDto.md)
 - [MinervaMetadataDto](docs/MinervaMetadataDto.md)
 - [Outcome](docs/Outcome.md)
 - [OutcomeDetailOperation](docs/OutcomeDetailOperation.md)
 - [PersonIdentifier](docs/PersonIdentifier.md)
 - [RejectedInteractionDto](docs/RejectedInteractionDto.md)
 - [RejectedInteractionsDto](docs/RejectedInteractionsDto.md)
 - [SimpleDestinationDto](docs/SimpleDestinationDto.md)
 - [SimpleMovementAppDto](docs/SimpleMovementAppDto.md)
 - [SimpleWorkspaceDto](docs/SimpleWorkspaceDto.md)
 - [SurveyResponse](docs/SurveyResponse.md)
 - [SurveyResponseOutcomeDetails](docs/SurveyResponseOutcomeDetails.md)
 - [VanApiKeyDto](docs/VanApiKeyDto.md)
 - [VanDatabaseMode](docs/VanDatabaseMode.md)
 - [WhoAmIApiKeyDto](docs/WhoAmIApiKeyDto.md)
 - [WorkspaceTypeDto](docs/WorkspaceTypeDto.md)


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


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

- **Type**: HTTP basic authentication


## Author

api@demexchange.com


