Metadata-Version: 2.4
Name: ampup
Version: 0.1.5
Summary: Python SDK and CLI for the AmpUp Sales Meeting Analysis Platform
Home-page: 
Author: OpenAPI Generator community
Author-email: team@openapitools.org
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: urllib3>=1.25.3
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1
Provides-Extra: cli
Requires-Dist: typer>=0.9.0; extra == "cli"
Requires-Dist: rich>=13.0; extra == "cli"
Dynamic: author
Dynamic: author-email

# ampup
REST API for the AmpUp Sales Meeting Analysis Platform

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

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

## Requirements.

Python 3.7+

## 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/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import ampup
```

### 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 ampup
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import ampup
from ampup.rest import ApiException
from pprint import pprint

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



# Enter a context with an instance of the API client
with ampup.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ampup.AccountsApi(api_client)
    add_note_to_account_request = ampup.AddNoteToAccountRequest() # AddNoteToAccountRequest | 

    try:
        # add_note_to_account
        api_response = api_instance.add_note_to_account(add_note_to_account_request)
        print("The response of AccountsApi->add_note_to_account:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountsApi->add_note_to_account: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://app.ampup.ai/mcp/api*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AccountsApi* | [**add_note_to_account**](docs/AccountsApi.md#add_note_to_account) | **POST** /v1/add_note_to_account | add_note_to_account
*AccountsApi* | [**add_task_to_account**](docs/AccountsApi.md#add_task_to_account) | **POST** /v1/add_task_to_account | add_task_to_account
*AccountsApi* | [**create_account**](docs/AccountsApi.md#create_account) | **POST** /v1/create_account | create_account
*AccountsApi* | [**get_account**](docs/AccountsApi.md#get_account) | **POST** /v1/get_account | get_account
*AccountsApi* | [**list_accounts**](docs/AccountsApi.md#list_accounts) | **POST** /v1/list_accounts | list_accounts
*AccountsApi* | [**sync_account_to_crm**](docs/AccountsApi.md#sync_account_to_crm) | **POST** /v1/sync_account_to_crm | sync_account_to_crm
*AccountsApi* | [**update_account**](docs/AccountsApi.md#update_account) | **POST** /v1/update_account | update_account
*ConfigurationApi* | [**get_analysis_config**](docs/ConfigurationApi.md#get_analysis_config) | **POST** /v1/get_analysis_config | get_analysis_config
*ConfigurationApi* | [**update_analysis_config**](docs/ConfigurationApi.md#update_analysis_config) | **POST** /v1/update_analysis_config | update_analysis_config
*FilesApi* | [**check_status**](docs/FilesApi.md#check_status) | **POST** /v1/check_status | check_status
*FilesApi* | [**delete_deal_file**](docs/FilesApi.md#delete_deal_file) | **POST** /v1/delete_deal_file | delete_deal_file
*FilesApi* | [**list_deal_files**](docs/FilesApi.md#list_deal_files) | **POST** /v1/list_deal_files | list_deal_files
*FilesApi* | [**upload_deal_file**](docs/FilesApi.md#upload_deal_file) | **POST** /v1/upload_deal_file | upload_deal_file
*FilesApi* | [**upload_file**](docs/FilesApi.md#upload_file) | **POST** /v1/upload_file | upload_file
*FilesApi* | [**upload_folder**](docs/FilesApi.md#upload_folder) | **POST** /v1/upload_folder | upload_folder
*MeetingsApi* | [**delete**](docs/MeetingsApi.md#delete) | **POST** /v1/delete | delete
*MeetingsApi* | [**generate_post_meeting_brief**](docs/MeetingsApi.md#generate_post_meeting_brief) | **POST** /v1/generate_post_meeting_brief | generate_post_meeting_brief
*MeetingsApi* | [**generate_pre_meeting_brief**](docs/MeetingsApi.md#generate_pre_meeting_brief) | **POST** /v1/generate_pre_meeting_brief | generate_pre_meeting_brief
*MeetingsApi* | [**get_meeting**](docs/MeetingsApi.md#get_meeting) | **POST** /v1/get_meeting | get_meeting
*MeetingsApi* | [**get_meeting_transcript**](docs/MeetingsApi.md#get_meeting_transcript) | **POST** /v1/get_meeting_transcript | get_meeting_transcript
*MeetingsApi* | [**get_post_meeting_brief**](docs/MeetingsApi.md#get_post_meeting_brief) | **POST** /v1/get_post_meeting_brief | get_post_meeting_brief
*MeetingsApi* | [**get_pre_meeting_brief**](docs/MeetingsApi.md#get_pre_meeting_brief) | **POST** /v1/get_pre_meeting_brief | get_pre_meeting_brief
*MeetingsApi* | [**get_transcript_excerpt**](docs/MeetingsApi.md#get_transcript_excerpt) | **POST** /v1/get_transcript_excerpt | get_transcript_excerpt
*MeetingsApi* | [**list_meeting_analyses**](docs/MeetingsApi.md#list_meeting_analyses) | **POST** /v1/list_meeting_analyses | list_meeting_analyses
*MeetingsApi* | [**list_meetings**](docs/MeetingsApi.md#list_meetings) | **POST** /v1/list_meetings | list_meetings
*MeetingsApi* | [**run_analysis**](docs/MeetingsApi.md#run_analysis) | **POST** /v1/run_analysis | run_analysis
*MeetingsApi* | [**update_meeting**](docs/MeetingsApi.md#update_meeting) | **POST** /v1/update_meeting | update_meeting
*MetricsApi* | [**bulk_create_metrics**](docs/MetricsApi.md#bulk_create_metrics) | **POST** /v1/bulk_create_metrics | bulk_create_metrics
*MetricsApi* | [**create_metric**](docs/MetricsApi.md#create_metric) | **POST** /v1/create_metric | create_metric
*MetricsApi* | [**create_metric_group**](docs/MetricsApi.md#create_metric_group) | **POST** /v1/create_metric_group | create_metric_group
*MetricsApi* | [**delete_metric_group**](docs/MetricsApi.md#delete_metric_group) | **POST** /v1/delete_metric_group | delete_metric_group
*MetricsApi* | [**list_metric_groups**](docs/MetricsApi.md#list_metric_groups) | **POST** /v1/list_metric_groups | list_metric_groups
*MetricsApi* | [**list_metrics**](docs/MetricsApi.md#list_metrics) | **POST** /v1/list_metrics | list_metrics
*MetricsApi* | [**update_metric_group**](docs/MetricsApi.md#update_metric_group) | **POST** /v1/update_metric_group | update_metric_group
*OpportunitiesApi* | [**add_note_to_opportunity**](docs/OpportunitiesApi.md#add_note_to_opportunity) | **POST** /v1/add_note_to_opportunity | add_note_to_opportunity
*OpportunitiesApi* | [**add_task_to_opportunity**](docs/OpportunitiesApi.md#add_task_to_opportunity) | **POST** /v1/add_task_to_opportunity | add_task_to_opportunity
*OpportunitiesApi* | [**change_opportunity_stage**](docs/OpportunitiesApi.md#change_opportunity_stage) | **POST** /v1/change_opportunity_stage | change_opportunity_stage
*OpportunitiesApi* | [**create_opportunity**](docs/OpportunitiesApi.md#create_opportunity) | **POST** /v1/create_opportunity | create_opportunity
*OpportunitiesApi* | [**get_opportunity**](docs/OpportunitiesApi.md#get_opportunity) | **POST** /v1/get_opportunity | get_opportunity
*OpportunitiesApi* | [**get_opportunity_analysis**](docs/OpportunitiesApi.md#get_opportunity_analysis) | **POST** /v1/get_opportunity_analysis | get_opportunity_analysis
*OpportunitiesApi* | [**list_opportunities**](docs/OpportunitiesApi.md#list_opportunities) | **POST** /v1/list_opportunities | list_opportunities
*OpportunitiesApi* | [**sync_opportunity_to_crm**](docs/OpportunitiesApi.md#sync_opportunity_to_crm) | **POST** /v1/sync_opportunity_to_crm | sync_opportunity_to_crm
*OpportunitiesApi* | [**update_opportunity**](docs/OpportunitiesApi.md#update_opportunity) | **POST** /v1/update_opportunity | update_opportunity
*OrganizationApi* | [**get_org**](docs/OrganizationApi.md#get_org) | **POST** /v1/get_org | get_org
*OrganizationApi* | [**list_orgs**](docs/OrganizationApi.md#list_orgs) | **POST** /v1/list_orgs | list_orgs
*OrganizationApi* | [**switch_org**](docs/OrganizationApi.md#switch_org) | **POST** /v1/switch_org | switch_org
*PracticeScriptsApi* | [**create_practice_script**](docs/PracticeScriptsApi.md#create_practice_script) | **POST** /v1/create_practice_script | create_practice_script
*PracticeScriptsApi* | [**delete_practice_script**](docs/PracticeScriptsApi.md#delete_practice_script) | **POST** /v1/delete_practice_script | delete_practice_script
*PracticeScriptsApi* | [**generate_practice_script**](docs/PracticeScriptsApi.md#generate_practice_script) | **POST** /v1/generate_practice_script | generate_practice_script
*PracticeScriptsApi* | [**get_practice_script**](docs/PracticeScriptsApi.md#get_practice_script) | **POST** /v1/get_practice_script | get_practice_script
*PracticeScriptsApi* | [**list_practice_scripts**](docs/PracticeScriptsApi.md#list_practice_scripts) | **POST** /v1/list_practice_scripts | list_practice_scripts
*PracticeScriptsApi* | [**share_practice_script**](docs/PracticeScriptsApi.md#share_practice_script) | **POST** /v1/share_practice_script | share_practice_script
*PracticeScriptsApi* | [**update_practice_script**](docs/PracticeScriptsApi.md#update_practice_script) | **POST** /v1/update_practice_script | update_practice_script


## Documentation For Models

 - [AddNoteToAccountRequest](docs/AddNoteToAccountRequest.md)
 - [AddNoteToOpportunityRequest](docs/AddNoteToOpportunityRequest.md)
 - [AddTaskToAccountRequest](docs/AddTaskToAccountRequest.md)
 - [AddTaskToOpportunityRequest](docs/AddTaskToOpportunityRequest.md)
 - [BulkCreateMetricsRequest](docs/BulkCreateMetricsRequest.md)
 - [ChangeOpportunityStageRequest](docs/ChangeOpportunityStageRequest.md)
 - [CheckStatusRequest](docs/CheckStatusRequest.md)
 - [CreateAccountRequest](docs/CreateAccountRequest.md)
 - [CreateMetricGroupRequest](docs/CreateMetricGroupRequest.md)
 - [CreateMetricRequest](docs/CreateMetricRequest.md)
 - [CreateOpportunityRequest](docs/CreateOpportunityRequest.md)
 - [CreatePracticeScriptRequest](docs/CreatePracticeScriptRequest.md)
 - [DeleteDealFileRequest](docs/DeleteDealFileRequest.md)
 - [DeleteMetricGroupRequest](docs/DeleteMetricGroupRequest.md)
 - [DeletePracticeScriptRequest](docs/DeletePracticeScriptRequest.md)
 - [DeleteRequest](docs/DeleteRequest.md)
 - [GeneratePostMeetingBriefRequest](docs/GeneratePostMeetingBriefRequest.md)
 - [GeneratePracticeScriptRequest](docs/GeneratePracticeScriptRequest.md)
 - [GeneratePreMeetingBriefRequest](docs/GeneratePreMeetingBriefRequest.md)
 - [GetAccountRequest](docs/GetAccountRequest.md)
 - [GetMeetingRequest](docs/GetMeetingRequest.md)
 - [GetMeetingTranscriptRequest](docs/GetMeetingTranscriptRequest.md)
 - [GetOpportunityAnalysisRequest](docs/GetOpportunityAnalysisRequest.md)
 - [GetOpportunityRequest](docs/GetOpportunityRequest.md)
 - [GetPostMeetingBriefRequest](docs/GetPostMeetingBriefRequest.md)
 - [GetPracticeScriptRequest](docs/GetPracticeScriptRequest.md)
 - [GetPreMeetingBriefRequest](docs/GetPreMeetingBriefRequest.md)
 - [GetTranscriptExcerptRequest](docs/GetTranscriptExcerptRequest.md)
 - [HTTPValidationError](docs/HTTPValidationError.md)
 - [ListAccountsRequest](docs/ListAccountsRequest.md)
 - [ListDealFilesRequest](docs/ListDealFilesRequest.md)
 - [ListMeetingAnalysesRequest](docs/ListMeetingAnalysesRequest.md)
 - [ListMeetingsRequest](docs/ListMeetingsRequest.md)
 - [ListOpportunitiesRequest](docs/ListOpportunitiesRequest.md)
 - [ListPracticeScriptsRequest](docs/ListPracticeScriptsRequest.md)
 - [RunAnalysisRequest](docs/RunAnalysisRequest.md)
 - [SharePracticeScriptRequest](docs/SharePracticeScriptRequest.md)
 - [SwitchOrgRequest](docs/SwitchOrgRequest.md)
 - [SyncAccountToCrmRequest](docs/SyncAccountToCrmRequest.md)
 - [SyncOpportunityToCrmRequest](docs/SyncOpportunityToCrmRequest.md)
 - [UpdateAccountRequest](docs/UpdateAccountRequest.md)
 - [UpdateAnalysisConfigRequest](docs/UpdateAnalysisConfigRequest.md)
 - [UpdateMeetingRequest](docs/UpdateMeetingRequest.md)
 - [UpdateMetricGroupRequest](docs/UpdateMetricGroupRequest.md)
 - [UpdateOpportunityRequest](docs/UpdateOpportunityRequest.md)
 - [UpdatePracticeScriptRequest](docs/UpdatePracticeScriptRequest.md)
 - [UploadDealFileRequest](docs/UploadDealFileRequest.md)
 - [UploadFileRequest](docs/UploadFileRequest.md)
 - [UploadFolderRequest](docs/UploadFolderRequest.md)
 - [ValidationError](docs/ValidationError.md)
 - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)


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

Endpoints do not require authorization.


## Author




