keap-core-v2-sdk 0.0.9__tar.gz

keap_core_v2_sdk-0.0.9/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.2
+Name: keap-core-v2-sdk
+Version: 0.0.9
+Summary: Keap REST API
+Home-page: https://github.com/infusionsoft/keap-sdk.git
+Author: Keap
+Author-email: api@keap.com
+License: Apache 2.0
+Keywords: OpenAPI,OpenAPI-Generator,Keap REST API
+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
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+    Keap REST Core Service
+    

keap_core_v2_sdk-0.0.9/README.md

@@ -0,0 +1,531 @@
+# keap-core-v2-sdk
+Keap REST Core Service
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 2.70.0.784405-hf-202502271519
+- Package version: 0.0.9
+- Generator version: 7.10.0
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+For more information, please visit [https://developer.keap.com/get-support/](https://developer.keap.com/get-support/)
+
+## Requirements.
+
+Python 3.8+
+
+## 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/infusionsoft/keap-sdk.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/infusionsoft/keap-sdk.git`)
+
+Then import the package:
+```python
+import keap_core_v2_client
+```
+
+### 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 keap_core_v2_client
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import keap_core_v2_client
+from keap_core_v2_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://api.keap.com/crm/rest
+# See configuration.py for a list of all supported configuration parameters.
+configuration = keap_core_v2_client.Configuration(
+    host = "https://api.keap.com/crm/rest"
+)
+
+
+# Enter a context with an instance of the API client
+with keap_core_v2_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = keap_core_v2_client.AffiliateApi(api_client)
+    create_affiliate_request = keap_core_v2_client.CreateAffiliateRequest() # CreateAffiliateRequest | Affiliate request to insert (optional)
+
+    try:
+        # Create an Affiliate
+        api_response = api_instance.add_affiliate_using_post(create_affiliate_request=create_affiliate_request)
+        print("The response of AffiliateApi->add_affiliate_using_post:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling AffiliateApi->add_affiliate_using_post: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.keap.com/crm/rest*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*AffiliateApi* | [**add_affiliate_using_post**](docs/AffiliateApi.md#add_affiliate_using_post) | **POST** /v2/affiliates | Create an Affiliate
+*AffiliateApi* | [**get_affiliate_using_get1**](docs/AffiliateApi.md#get_affiliate_using_get1) | **GET** /v2/affiliates/{id} | Retrieve an Affiliate
+*AffiliateApi* | [**update_affiliate_using_patch**](docs/AffiliateApi.md#update_affiliate_using_patch) | **PATCH** /v2/affiliates/{id} | Update an Affiliate
+*AffiliateApi* | [**update_commission_program_using_patch**](docs/AffiliateApi.md#update_commission_program_using_patch) | **PATCH** /v2/affiliates/commissionPrograms/{commission_program_id} | Update a Affiliate Commission Program
+*AutomationApi* | [**add_contacts_to_automation_sequence_using_post**](docs/AutomationApi.md#add_contacts_to_automation_sequence_using_post) | **POST** /v2/automations/{automation_id}/sequences/{sequence_id}:addContacts | Add Contacts to an Automation Sequence
+*AutomationApi* | [**delete_automation_using_delete**](docs/AutomationApi.md#delete_automation_using_delete) | **DELETE** /v2/automations | Delete an Automation
+*AutomationApi* | [**get_automation_using_get**](docs/AutomationApi.md#get_automation_using_get) | **GET** /v2/automations/{automation_id} | Retrieve an Automation
+*AutomationApi* | [**list_all_automation_ids_using_get**](docs/AutomationApi.md#list_all_automation_ids_using_get) | **GET** /v2/automations/ids | List Automations Ids
+*AutomationApi* | [**list_automations_using_get**](docs/AutomationApi.md#list_automations_using_get) | **GET** /v2/automations | List Automations
+*AutomationApi* | [**update_automation_category_using_put**](docs/AutomationApi.md#update_automation_category_using_put) | **PUT** /v2/automations/category | Update an Automation's Category
+*AutomationCategoryApi* | [**create_category_using_post**](docs/AutomationCategoryApi.md#create_category_using_post) | **POST** /v2/automationCategory | Create automation category
+*AutomationCategoryApi* | [**delete_categories_using_delete**](docs/AutomationCategoryApi.md#delete_categories_using_delete) | **DELETE** /v2/automationCategory | Delete automation category
+*AutomationCategoryApi* | [**list_categories_using_get**](docs/AutomationCategoryApi.md#list_categories_using_get) | **GET** /v2/automationCategory | List automation categories
+*AutomationCategoryApi* | [**save_category_using_put**](docs/AutomationCategoryApi.md#save_category_using_put) | **PUT** /v2/automationCategory | Save automation category
+*BusinessProfileApi* | [**get_business_profile_using_get**](docs/BusinessProfileApi.md#get_business_profile_using_get) | **GET** /v2/businessProfile | Retrieve Business Profile
+*BusinessProfileApi* | [**update_business_profile_using_patch**](docs/BusinessProfileApi.md#update_business_profile_using_patch) | **PATCH** /v2/businessProfile | Update Business Profile
+*CampaignApi* | [**add_contacts_to_campaign_sequence_using_post1**](docs/CampaignApi.md#add_contacts_to_campaign_sequence_using_post1) | **POST** /v2/campaigns/{campaign_id}/sequences/{sequence_id}:addContacts | Add Contacts to Campaign Sequence
+*CampaignApi* | [**get_campaign_using_get1**](docs/CampaignApi.md#get_campaign_using_get1) | **GET** /v2/campaigns/{campaign_id} | Retrieve a Campaign
+*CampaignApi* | [**list_campaigns_using_get1**](docs/CampaignApi.md#list_campaigns_using_get1) | **GET** /v2/campaigns | List Campaigns
+*CampaignApi* | [**remove_contacts_from_campaign_sequence_using_post**](docs/CampaignApi.md#remove_contacts_from_campaign_sequence_using_post) | **POST** /v2/campaigns/{campaign_id}/sequences/{sequence_id}:removeContacts | Remove Contacts from Campaign Sequence
+*CompanyApi* | [**create_company_using_post1**](docs/CompanyApi.md#create_company_using_post1) | **POST** /v2/companies | Create a Company
+*CompanyApi* | [**delete_company_using_delete**](docs/CompanyApi.md#delete_company_using_delete) | **DELETE** /v2/companies/{company_id} | Delete a Company
+*CompanyApi* | [**get_company_using_get1**](docs/CompanyApi.md#get_company_using_get1) | **GET** /v2/companies/{company_id} | Retrieve a Company
+*CompanyApi* | [**list_companies_using_get1**](docs/CompanyApi.md#list_companies_using_get1) | **GET** /v2/companies | List Companies
+*CompanyApi* | [**update_company_using_patch1**](docs/CompanyApi.md#update_company_using_patch1) | **PATCH** /v2/companies/{company_id} | Update a Company
+*ContactApi* | [**create_contact_link_type_using_post**](docs/ContactApi.md#create_contact_link_type_using_post) | **POST** /v2/contacts/links/types | Create a Contact Link type
+*ContactApi* | [**create_contact_using_post1**](docs/ContactApi.md#create_contact_using_post1) | **POST** /v2/contacts | Create a Contact
+*ContactApi* | [**delete_contact_using_delete1**](docs/ContactApi.md#delete_contact_using_delete1) | **DELETE** /v2/contacts/{contact_id} | Delete a Contact
+*ContactApi* | [**get_contact_using_get1**](docs/ContactApi.md#get_contact_using_get1) | **GET** /v2/contacts/{contact_id} | Retrieve a Contact
+*ContactApi* | [**link_contacts_using_post**](docs/ContactApi.md#link_contacts_using_post) | **POST** /v2/contacts:link | Link Contacts
+*ContactApi* | [**list_contact_link_types_using_get**](docs/ContactApi.md#list_contact_link_types_using_get) | **GET** /v2/contacts/links/types | List Contact Link types
+*ContactApi* | [**list_contact_links_using_get**](docs/ContactApi.md#list_contact_links_using_get) | **GET** /v2/contacts/{contact_id}/links | List Linked Contacts
+*ContactApi* | [**list_contacts_using_get1**](docs/ContactApi.md#list_contacts_using_get1) | **GET** /v2/contacts | List Contacts
+*ContactApi* | [**list_payment_methods_using_get**](docs/ContactApi.md#list_payment_methods_using_get) | **GET** /v2/contacts/{contact_id}/paymentMethods | Retrieve Payment Methods
+*ContactApi* | [**retrieve_contact_model_using_get1**](docs/ContactApi.md#retrieve_contact_model_using_get1) | **GET** /v2/contacts/model | Retrieve Contact Model
+*ContactApi* | [**unlink_contacts_using_post**](docs/ContactApi.md#unlink_contacts_using_post) | **POST** /v2/contacts:unlink | Delete Link between two Contacts
+*ContactApi* | [**update_contact_using_patch**](docs/ContactApi.md#update_contact_using_patch) | **PATCH** /v2/contacts/{contact_id} | Update a Contact
+*DealsApi* | [**create_note**](docs/DealsApi.md#create_note) | **POST** /v2/deals/{id}/notes | Creates a new note for a specific deal.
+*DealsApi* | [**delete**](docs/DealsApi.md#delete) | **DELETE** /v2/deals/-/notes/{note_id} | Deletes a specific deal note by its ID.
+*DealsApi* | [**get_note**](docs/DealsApi.md#get_note) | **GET** /v2/deals/-/notes/{note_id} | Retrieves a specific deal note by its ID.
+*DealsApi* | [**list_notes**](docs/DealsApi.md#list_notes) | **GET** /v2/deals/{id}/notes | Lists all notes associated with a specific deal.
+*DealsApi* | [**update**](docs/DealsApi.md#update) | **PATCH** /v2/deals/-/notes/{note_id} | Updates a specific deal note by its ID.
+*EmailApi* | [**create_email_using_post1**](docs/EmailApi.md#create_email_using_post1) | **POST** /v2/emails | Create an Email Record
+*EmailApi* | [**create_emails_using_post1**](docs/EmailApi.md#create_emails_using_post1) | **POST** /v2/emails:batchAdd | Create a set of Email Records
+*EmailApi* | [**delete_email_using_delete1**](docs/EmailApi.md#delete_email_using_delete1) | **DELETE** /v2/emails/{id} | Delete an Email Record
+*EmailApi* | [**delete_emails_using_post1**](docs/EmailApi.md#delete_emails_using_post1) | **POST** /v2/emails:batchRemove | Remove a set of Email Records
+*EmailApi* | [**get_email_template_using_get**](docs/EmailApi.md#get_email_template_using_get) | **GET** /v2/emails/templates/{email_template_id} | Retrieve an email template
+*EmailApi* | [**get_email_using_get1**](docs/EmailApi.md#get_email_using_get1) | **GET** /v2/emails/{id} | Retrieve an Email
+*EmailApi* | [**send_email_using_post1**](docs/EmailApi.md#send_email_using_post1) | **POST** /v2/emails:send | Send an Email
+*EmailAddressApi* | [**get_email_address_status_using_get**](docs/EmailAddressApi.md#get_email_address_status_using_get) | **GET** /v2/emailAddresses/{email} | Retrieve an Email Address status
+*EmailAddressApi* | [**update_email_address_opt_status_using_put**](docs/EmailAddressApi.md#update_email_address_opt_status_using_put) | **PUT** /v2/emailAddresses/{email} | Update an Email Address opt-in status
+*NoteApi* | [**create_note_using_post1**](docs/NoteApi.md#create_note_using_post1) | **POST** /v2/contacts/{contact_id}/notes | Create a Note
+*NoteApi* | [**delete_note_using_delete1**](docs/NoteApi.md#delete_note_using_delete1) | **DELETE** /v2/contacts/{contact_id}/notes/{note_id} | Delete a Note
+*NoteApi* | [**get_note_using_get1**](docs/NoteApi.md#get_note_using_get1) | **GET** /v2/contacts/{contact_id}/notes/{note_id} | Retrieve a Note
+*NoteApi* | [**list_notes_using_get1**](docs/NoteApi.md#list_notes_using_get1) | **GET** /v2/contacts/{contact_id}/notes | List Notes
+*NoteApi* | [**update_note_using_patch**](docs/NoteApi.md#update_note_using_patch) | **PATCH** /v2/contacts/{contact_id}/notes/{note_id} | Update a Note
+*PaymentMethodConfigApi* | [**create_payment_method_config_using_post**](docs/PaymentMethodConfigApi.md#create_payment_method_config_using_post) | **POST** /v2/paymentMethodConfigs | Create Payment Method Configuration
+*PipelinesApi* | [**create**](docs/PipelinesApi.md#create) | **POST** /v2/pipelines | Creates a new entity.
+*PipelinesApi* | [**delete1**](docs/PipelinesApi.md#delete1) | **DELETE** /v2/pipelines/{id} | Deletes a pipeline.
+*PipelinesApi* | [**get**](docs/PipelinesApi.md#get) | **GET** /v2/pipelines/{id} | Retrieves an entity by its identifier.
+*PipelinesApi* | [**get_outcome_labels**](docs/PipelinesApi.md#get_outcome_labels) | **GET** /v2/pipelines/{id}/outcomes | Gets the outcome labels for a pipeline.
+*PipelinesApi* | [**list**](docs/PipelinesApi.md#list) | **GET** /v2/pipelines | Lists entities based on the provided ListCommand.
+*PipelinesApi* | [**list_stages**](docs/PipelinesApi.md#list_stages) | **GET** /v2/pipelines/{id}/stages | Retrieves a list of stages for a specific pipeline.
+*PipelinesApi* | [**list_summaries**](docs/PipelinesApi.md#list_summaries) | **GET** /v2/pipelines/summaries | Retrieves a list of pipeline summaries.
+*PipelinesApi* | [**set_outcome_labels**](docs/PipelinesApi.md#set_outcome_labels) | **PATCH** /v2/pipelines/{id}/outcomes | Sets the outcome labels for a pipeline.
+*PipelinesApi* | [**update1**](docs/PipelinesApi.md#update1) | **PATCH** /v2/pipelines/{id} | Updates an existing entity.
+*ReportingApi* | [**run_report_using_post**](docs/ReportingApi.md#run_report_using_post) | **POST** /v2/reporting/reports/{report_id}:run | Run a Report
+*SalesApi* | [**set_merchant_gateway_as_default_using_post**](docs/SalesApi.md#set_merchant_gateway_as_default_using_post) | **POST** /v2/sales/merchants/{id}:setDefault | Set default Merchant Account
+*SettingsApi* | [**get_application_configurations_using_get**](docs/SettingsApi.md#get_application_configurations_using_get) | **GET** /v2/settings/applications:getConfiguration | Get Application Configuration
+*SettingsApi* | [**get_contact_option_types_using_get1**](docs/SettingsApi.md#get_contact_option_types_using_get1) | **GET** /v2/settings/contactOptionTypes | Get Contact Option types
+*SettingsApi* | [**is_application_enabled_using_get**](docs/SettingsApi.md#is_application_enabled_using_get) | **GET** /v2/settings/applications:isEnabled | Get Application Status
+*StagesApi* | [**create1**](docs/StagesApi.md#create1) | **POST** /v2/stages | Creates a new entity.
+*StagesApi* | [**delete2**](docs/StagesApi.md#delete2) | **DELETE** /v2/stages/{id} | Deletes a stage by its identifier for a given tenant.
+*StagesApi* | [**get1**](docs/StagesApi.md#get1) | **GET** /v2/stages/{id} | Retrieves an entity by its identifier.
+*StagesApi* | [**list1**](docs/StagesApi.md#list1) | **GET** /v2/stages | Lists entities based on the provided ListCommand.
+*StagesApi* | [**list_stages1**](docs/StagesApi.md#list_stages1) | **GET** /v2/stages/{id}/deals | Retrieves a list of deals for a specific stage.
+*StagesApi* | [**update2**](docs/StagesApi.md#update2) | **PATCH** /v2/stages/{id} | Updates an existing entity.
+*SubscriptionsApi* | [**create_subscription_v2_using_post**](docs/SubscriptionsApi.md#create_subscription_v2_using_post) | **POST** /v2/subscriptions | Create Subscription
+*TagsApi* | [**apply_tags_using_post**](docs/TagsApi.md#apply_tags_using_post) | **POST** /v2/tags/{tag_id}/contacts:applyTags | Apply Tag
+*TagsApi* | [**create_tag_category_using_post1**](docs/TagsApi.md#create_tag_category_using_post1) | **POST** /v2/tags/categories | Create Tag Category
+*TagsApi* | [**create_tag_using_post1**](docs/TagsApi.md#create_tag_using_post1) | **POST** /v2/tags | Create Tag
+*TagsApi* | [**delete_tag_category_using_delete**](docs/TagsApi.md#delete_tag_category_using_delete) | **DELETE** /v2/tags/categories/{tag_category_id} | Delete Tag Category
+*TagsApi* | [**delete_tag_using_delete**](docs/TagsApi.md#delete_tag_using_delete) | **DELETE** /v2/tags/{tag_id} | Delete Tag
+*TagsApi* | [**get_category_using_get**](docs/TagsApi.md#get_category_using_get) | **GET** /v2/tags/categories/{tag_category_id} | Retrieve a Tag Category
+*TagsApi* | [**get_tag_using_get1**](docs/TagsApi.md#get_tag_using_get1) | **GET** /v2/tags/{tag_id} | Retrieve a Tag
+*TagsApi* | [**list_companies_for_tag_id_using_get1**](docs/TagsApi.md#list_companies_for_tag_id_using_get1) | **GET** /v2/tags/{tag_id}/companies | List Tagged Companies
+*TagsApi* | [**list_contacts_with_tag_id_using_get**](docs/TagsApi.md#list_contacts_with_tag_id_using_get) | **GET** /v2/tags/{tag_id}/contacts | List Tagged Contacts
+*TagsApi* | [**list_tag_categories_using_get**](docs/TagsApi.md#list_tag_categories_using_get) | **GET** /v2/tags/categories | List Tag Categories
+*TagsApi* | [**list_tags_using_get1**](docs/TagsApi.md#list_tags_using_get1) | **GET** /v2/tags | List Tags
+*TagsApi* | [**remove_tags_using_post**](docs/TagsApi.md#remove_tags_using_post) | **POST** /v2/tags/{tag_id}/contacts:removeTags | Remove Tags
+*TagsApi* | [**update_tag_category_using_patch**](docs/TagsApi.md#update_tag_category_using_patch) | **PATCH** /v2/tags/categories/{tag_category_id} | Update a Tag Category
+*TagsApi* | [**update_tag_using_patch**](docs/TagsApi.md#update_tag_using_patch) | **PATCH** /v2/tags/{tag_id} | Update a Tag
+
+
+## Documentation For Models
+
+ - [AddContactsToSequenceRequest](docs/AddContactsToSequenceRequest.md)
+ - [AddContactsToSequenceResponse](docs/AddContactsToSequenceResponse.md)
+ - [AddToAutomationSequenceRequest](docs/AddToAutomationSequenceRequest.md)
+ - [AddToAutomationSequenceResponse](docs/AddToAutomationSequenceResponse.md)
+ - [Address](docs/Address.md)
+ - [AddressInformation](docs/AddressInformation.md)
+ - [AffiliateAddToProgramRequest](docs/AffiliateAddToProgramRequest.md)
+ - [AffiliateCommission](docs/AffiliateCommission.md)
+ - [AffiliateCommissionEarned](docs/AffiliateCommissionEarned.md)
+ - [AffiliateCommissionProgramResponse](docs/AffiliateCommissionProgramResponse.md)
+ - [AffiliateLink](docs/AffiliateLink.md)
+ - [AffiliateProgramV2](docs/AffiliateProgramV2.md)
+ - [AffiliateRemoveFromProgramRequest](docs/AffiliateRemoveFromProgramRequest.md)
+ - [AffiliateSummaryRecord](docs/AffiliateSummaryRecord.md)
+ - [ApplicationCompany](docs/ApplicationCompany.md)
+ - [ApplicationConfigurationModuleAffiliate](docs/ApplicationConfigurationModuleAffiliate.md)
+ - [ApplicationConfigurationModuleAffiliateCommission](docs/ApplicationConfigurationModuleAffiliateCommission.md)
+ - [ApplicationConfigurationModuleApplication](docs/ApplicationConfigurationModuleApplication.md)
+ - [ApplicationConfigurationModuleAppointment](docs/ApplicationConfigurationModuleAppointment.md)
+ - [ApplicationConfigurationModuleContact](docs/ApplicationConfigurationModuleContact.md)
+ - [ApplicationConfigurationModuleContactAddressLabels](docs/ApplicationConfigurationModuleContactAddressLabels.md)
+ - [ApplicationConfigurationModuleEcommerce](docs/ApplicationConfigurationModuleEcommerce.md)
+ - [ApplicationConfigurationModuleEmail](docs/ApplicationConfigurationModuleEmail.md)
+ - [ApplicationConfigurationModuleForms](docs/ApplicationConfigurationModuleForms.md)
+ - [ApplicationConfigurationModuleFulfillment](docs/ApplicationConfigurationModuleFulfillment.md)
+ - [ApplicationConfigurationModuleInvoice](docs/ApplicationConfigurationModuleInvoice.md)
+ - [ApplicationConfigurationModuleNote](docs/ApplicationConfigurationModuleNote.md)
+ - [ApplicationConfigurationModuleOpportunity](docs/ApplicationConfigurationModuleOpportunity.md)
+ - [ApplicationConfigurationModuleOpportunityStates](docs/ApplicationConfigurationModuleOpportunityStates.md)
+ - [ApplicationConfigurationModuleOpportunityStatesActive](docs/ApplicationConfigurationModuleOpportunityStatesActive.md)
+ - [ApplicationConfigurationModuleOpportunityStatesLoss](docs/ApplicationConfigurationModuleOpportunityStatesLoss.md)
+ - [ApplicationConfigurationModuleOpportunityStatesWin](docs/ApplicationConfigurationModuleOpportunityStatesWin.md)
+ - [ApplicationConfigurationModuleTask](docs/ApplicationConfigurationModuleTask.md)
+ - [ApplicationConfigurationModuleTemplate](docs/ApplicationConfigurationModuleTemplate.md)
+ - [ApplicationFeaturesEnabled](docs/ApplicationFeaturesEnabled.md)
+ - [ApplyRemoveTagRequest](docs/ApplyRemoveTagRequest.md)
+ - [ApplyTagsResponse](docs/ApplyTagsResponse.md)
+ - [AssignProductCategoriesRequest](docs/AssignProductCategoriesRequest.md)
+ - [AssignProductsRequest](docs/AssignProductsRequest.md)
+ - [Automation](docs/Automation.md)
+ - [AutomationCategory](docs/AutomationCategory.md)
+ - [AutomationLockStatus](docs/AutomationLockStatus.md)
+ - [BaseListResponseDeal](docs/BaseListResponseDeal.md)
+ - [BaseListResponseDealNote](docs/BaseListResponseDealNote.md)
+ - [BaseListResponsePipeline](docs/BaseListResponsePipeline.md)
+ - [BaseListResponsePipelineSummary](docs/BaseListResponsePipelineSummary.md)
+ - [BaseListResponseStage](docs/BaseListResponseStage.md)
+ - [BasicCompany](docs/BasicCompany.md)
+ - [BasicContact](docs/BasicContact.md)
+ - [BasicUser](docs/BasicUser.md)
+ - [BusinessProfileAddressRequest](docs/BusinessProfileAddressRequest.md)
+ - [BusinessProfileAddressResponse](docs/BusinessProfileAddressResponse.md)
+ - [Campaign](docs/Campaign.md)
+ - [CancelSubscriptionsRequest](docs/CancelSubscriptionsRequest.md)
+ - [CardInfo](docs/CardInfo.md)
+ - [CategoryDiscount](docs/CategoryDiscount.md)
+ - [CategoryReference](docs/CategoryReference.md)
+ - [CheckListItemDetails](docs/CheckListItemDetails.md)
+ - [ChecklistItem](docs/ChecklistItem.md)
+ - [Company](docs/Company.md)
+ - [Contact](docs/Contact.md)
+ - [ContactLink](docs/ContactLink.md)
+ - [ContactLinkType](docs/ContactLinkType.md)
+ - [ContactUtmResponse](docs/ContactUtmResponse.md)
+ - [Country](docs/Country.md)
+ - [CreateAffiliateRequest](docs/CreateAffiliateRequest.md)
+ - [CreateAutomationCategoryRequest](docs/CreateAutomationCategoryRequest.md)
+ - [CreateCategoryDiscountRequest](docs/CreateCategoryDiscountRequest.md)
+ - [CreateCommissionProgramRequest](docs/CreateCommissionProgramRequest.md)
+ - [CreateCompanyRequest](docs/CreateCompanyRequest.md)
+ - [CreateContactLinkTypeRequest](docs/CreateContactLinkTypeRequest.md)
+ - [CreateContactUtmPropertiesRequest](docs/CreateContactUtmPropertiesRequest.md)
+ - [CreateCustomFieldOptionRequest](docs/CreateCustomFieldOptionRequest.md)
+ - [CreateCustomFieldRequest](docs/CreateCustomFieldRequest.md)
+ - [CreateCustomFieldResponse](docs/CreateCustomFieldResponse.md)
+ - [CreateDealNoteRequest](docs/CreateDealNoteRequest.md)
+ - [CreateDefaultCommissionProgramRequest](docs/CreateDefaultCommissionProgramRequest.md)
+ - [CreateEmailSentRequest](docs/CreateEmailSentRequest.md)
+ - [CreateEmailsSentRequest](docs/CreateEmailsSentRequest.md)
+ - [CreateFunnelIntegrationRequest](docs/CreateFunnelIntegrationRequest.md)
+ - [CreateFunnelIntegrationTriggerEvents](docs/CreateFunnelIntegrationTriggerEvents.md)
+ - [CreateLeadSourceExpenseRequest](docs/CreateLeadSourceExpenseRequest.md)
+ - [CreateLeadSourceRecurringExpenseRequest](docs/CreateLeadSourceRecurringExpenseRequest.md)
+ - [CreateLeadSourceRequest](docs/CreateLeadSourceRequest.md)
+ - [CreateNoteRequest](docs/CreateNoteRequest.md)
+ - [CreateOpportunityRequest](docs/CreateOpportunityRequest.md)
+ - [CreateOpportunityStageChecklistItem](docs/CreateOpportunityStageChecklistItem.md)
+ - [CreateOpportunityStageRequest](docs/CreateOpportunityStageRequest.md)
+ - [CreateOrUpdateAffiliateLinkRequest](docs/CreateOrUpdateAffiliateLinkRequest.md)
+ - [CreateOrderTotalDiscountRequest](docs/CreateOrderTotalDiscountRequest.md)
+ - [CreatePaymentMethodConfigRequest](docs/CreatePaymentMethodConfigRequest.md)
+ - [CreatePaymentRequest](docs/CreatePaymentRequest.md)
+ - [CreatePipelineRequest](docs/CreatePipelineRequest.md)
+ - [CreateProductCategoryRequest](docs/CreateProductCategoryRequest.md)
+ - [CreateProductCommissionProgramRequest](docs/CreateProductCommissionProgramRequest.md)
+ - [CreateProductDiscountRequest](docs/CreateProductDiscountRequest.md)
+ - [CreateProductInterestBundleRequest](docs/CreateProductInterestBundleRequest.md)
+ - [CreateProductRequest](docs/CreateProductRequest.md)
+ - [CreateReferralRequest](docs/CreateReferralRequest.md)
+ - [CreateRestOrderItemRequest](docs/CreateRestOrderItemRequest.md)
+ - [CreateShippingDiscountRequest](docs/CreateShippingDiscountRequest.md)
+ - [CreateStageRequest](docs/CreateStageRequest.md)
+ - [CreateSubscriptionCommissionProgramRequest](docs/CreateSubscriptionCommissionProgramRequest.md)
+ - [CreateSubscriptionPlanRequest](docs/CreateSubscriptionPlanRequest.md)
+ - [CreateSubscriptionV2](docs/CreateSubscriptionV2.md)
+ - [CreateTaskRequest](docs/CreateTaskRequest.md)
+ - [CreateUpdateContactRequest](docs/CreateUpdateContactRequest.md)
+ - [CreateUpdateLeadSourceCategoryRequest](docs/CreateUpdateLeadSourceCategoryRequest.md)
+ - [CreateUpdateTagCategoryRequest](docs/CreateUpdateTagCategoryRequest.md)
+ - [CreateUpdateTagRequest](docs/CreateUpdateTagRequest.md)
+ - [CreateUpdateTaskRequest](docs/CreateUpdateTaskRequest.md)
+ - [CreateUserRequestV2](docs/CreateUserRequestV2.md)
+ - [CurrencyValue](docs/CurrencyValue.md)
+ - [CustomField](docs/CustomField.md)
+ - [CustomFieldMetaData](docs/CustomFieldMetaData.md)
+ - [CustomFieldOption](docs/CustomFieldOption.md)
+ - [CustomFieldValue](docs/CustomFieldValue.md)
+ - [Deal](docs/Deal.md)
+ - [DealContact](docs/DealContact.md)
+ - [DealNote](docs/DealNote.md)
+ - [DealNoteListResponse](docs/DealNoteListResponse.md)
+ - [DealStage](docs/DealStage.md)
+ - [DealStatus](docs/DealStatus.md)
+ - [DealValue](docs/DealValue.md)
+ - [DefaultCommission](docs/DefaultCommission.md)
+ - [DeleteEmailsRequest](docs/DeleteEmailsRequest.md)
+ - [DeleteEmailsResponse](docs/DeleteEmailsResponse.md)
+ - [DeleteFunnelIntegrationRequest](docs/DeleteFunnelIntegrationRequest.md)
+ - [DeleteSubscriptionPlanCommissionRequest](docs/DeleteSubscriptionPlanCommissionRequest.md)
+ - [Discount](docs/Discount.md)
+ - [DiscountCriteria](docs/DiscountCriteria.md)
+ - [EmailAddress](docs/EmailAddress.md)
+ - [EmailAddressRequest](docs/EmailAddressRequest.md)
+ - [EmailSendRequest](docs/EmailSendRequest.md)
+ - [EmailSendRequestAttachment](docs/EmailSendRequestAttachment.md)
+ - [EmailSentCreateError](docs/EmailSentCreateError.md)
+ - [EmailSentWithContent](docs/EmailSentWithContent.md)
+ - [EmailTemplate](docs/EmailTemplate.md)
+ - [EmailsSentList](docs/EmailsSentList.md)
+ - [Error](docs/Error.md)
+ - [FaxNumber](docs/FaxNumber.md)
+ - [File](docs/File.md)
+ - [FileMetadata](docs/FileMetadata.md)
+ - [FunnelIntegrationAction](docs/FunnelIntegrationAction.md)
+ - [FunnelIntegrationHttpRequest](docs/FunnelIntegrationHttpRequest.md)
+ - [FunnelIntegrationSchemaField](docs/FunnelIntegrationSchemaField.md)
+ - [FunnelIntegrationTriggerEventDTO](docs/FunnelIntegrationTriggerEventDTO.md)
+ - [FunnelIntegrationTriggerResultDTO](docs/FunnelIntegrationTriggerResultDTO.md)
+ - [GetApplicationEnabledStatusResponse](docs/GetApplicationEnabledStatusResponse.md)
+ - [GetBusinessProfileResponse](docs/GetBusinessProfileResponse.md)
+ - [GetContactOptionTypesResponse](docs/GetContactOptionTypesResponse.md)
+ - [GetNoteResponse](docs/GetNoteResponse.md)
+ - [GetSettingsResponse](docs/GetSettingsResponse.md)
+ - [GetTagCategoryResponse](docs/GetTagCategoryResponse.md)
+ - [GetUserInfoResponse](docs/GetUserInfoResponse.md)
+ - [Goal](docs/Goal.md)
+ - [HistoricalCounts](docs/HistoricalCounts.md)
+ - [InvoiceOrderPayment](docs/InvoiceOrderPayment.md)
+ - [Item](docs/Item.md)
+ - [LandingPage](docs/LandingPage.md)
+ - [LeadScore](docs/LeadScore.md)
+ - [LeadSource](docs/LeadSource.md)
+ - [LeadSourceCategory](docs/LeadSourceCategory.md)
+ - [LeadSourceExpense](docs/LeadSourceExpense.md)
+ - [LeadSourceRecurringExpense](docs/LeadSourceRecurringExpense.md)
+ - [Link](docs/Link.md)
+ - [LinkContactsRequest](docs/LinkContactsRequest.md)
+ - [ListAffiliateCommissionProgramsResponse](docs/ListAffiliateCommissionProgramsResponse.md)
+ - [ListAffiliateCommissionsResponse](docs/ListAffiliateCommissionsResponse.md)
+ - [ListAffiliateLinksResponse](docs/ListAffiliateLinksResponse.md)
+ - [ListAffiliateSummariesResponse](docs/ListAffiliateSummariesResponse.md)
+ - [ListAutomationCategoryResponse](docs/ListAutomationCategoryResponse.md)
+ - [ListAutomationIdsResponse](docs/ListAutomationIdsResponse.md)
+ - [ListAutomationResponse](docs/ListAutomationResponse.md)
+ - [ListBasicContactResponse](docs/ListBasicContactResponse.md)
+ - [ListCampaignsResponse](docs/ListCampaignsResponse.md)
+ - [ListCategoryDiscountsResponse](docs/ListCategoryDiscountsResponse.md)
+ - [ListCompaniesResponse](docs/ListCompaniesResponse.md)
+ - [ListContactLinkTypesResponse](docs/ListContactLinkTypesResponse.md)
+ - [ListContactLinksResponse](docs/ListContactLinksResponse.md)
+ - [ListContactsResponse](docs/ListContactsResponse.md)
+ - [ListCountriesResponse](docs/ListCountriesResponse.md)
+ - [ListFilesResponse](docs/ListFilesResponse.md)
+ - [ListLandingPagesResponse](docs/ListLandingPagesResponse.md)
+ - [ListLeadSourceCategoriesResponse](docs/ListLeadSourceCategoriesResponse.md)
+ - [ListLeadSourceExpensesResponse](docs/ListLeadSourceExpensesResponse.md)
+ - [ListLeadSourcesResponse](docs/ListLeadSourcesResponse.md)
+ - [ListNoteTemplateResponse](docs/ListNoteTemplateResponse.md)
+ - [ListNotesResponse](docs/ListNotesResponse.md)
+ - [ListOpportunitiesResponse](docs/ListOpportunitiesResponse.md)
+ - [ListOpportunityStagesResponse](docs/ListOpportunityStagesResponse.md)
+ - [ListOrderPaymentsResponse](docs/ListOrderPaymentsResponse.md)
+ - [ListOrderTotalDiscountsResponse](docs/ListOrderTotalDiscountsResponse.md)
+ - [ListOrders](docs/ListOrders.md)
+ - [ListProductCategoriesResponse](docs/ListProductCategoriesResponse.md)
+ - [ListProductInterestBundleResponse](docs/ListProductInterestBundleResponse.md)
+ - [ListProductsResponse](docs/ListProductsResponse.md)
+ - [ListProvincesResponse](docs/ListProvincesResponse.md)
+ - [ListRestMerchantAccountResponse](docs/ListRestMerchantAccountResponse.md)
+ - [ListRestMerchantResponse](docs/ListRestMerchantResponse.md)
+ - [ListRestShippingMethodsResponse](docs/ListRestShippingMethodsResponse.md)
+ - [ListShippingDiscountsResponse](docs/ListShippingDiscountsResponse.md)
+ - [ListSubscriptionPlansResponse](docs/ListSubscriptionPlansResponse.md)
+ - [ListSubscriptionsResponse](docs/ListSubscriptionsResponse.md)
+ - [ListTagCategoriesResponse](docs/ListTagCategoriesResponse.md)
+ - [ListTaggedCompaniesResponse](docs/ListTaggedCompaniesResponse.md)
+ - [ListTaggedContactsResponse](docs/ListTaggedContactsResponse.md)
+ - [ListTagsResponse](docs/ListTagsResponse.md)
+ - [ListTasksResponse](docs/ListTasksResponse.md)
+ - [ListUserResponse](docs/ListUserResponse.md)
+ - [Money](docs/Money.md)
+ - [Note](docs/Note.md)
+ - [NoteTemplate](docs/NoteTemplate.md)
+ - [ObjectModel](docs/ObjectModel.md)
+ - [OpportunityContact](docs/OpportunityContact.md)
+ - [OpportunityStage](docs/OpportunityStage.md)
+ - [OrderItemProduct](docs/OrderItemProduct.md)
+ - [OrderItemTax](docs/OrderItemTax.md)
+ - [OrderTotalDiscount](docs/OrderTotalDiscount.md)
+ - [Origin](docs/Origin.md)
+ - [OriginRequest](docs/OriginRequest.md)
+ - [Owner](docs/Owner.md)
+ - [PaymentMethodConfig](docs/PaymentMethodConfig.md)
+ - [PaymentMethodList](docs/PaymentMethodList.md)
+ - [PaymentPlan](docs/PaymentPlan.md)
+ - [PaymentResult](docs/PaymentResult.md)
+ - [PhoneNumber](docs/PhoneNumber.md)
+ - [Pipeline](docs/Pipeline.md)
+ - [PipelineListResponse](docs/PipelineListResponse.md)
+ - [PipelineOutcomeLabel](docs/PipelineOutcomeLabel.md)
+ - [PipelineOutcomeLabelListResponse](docs/PipelineOutcomeLabelListResponse.md)
+ - [PipelineStageListResponse](docs/PipelineStageListResponse.md)
+ - [PipelineSummariesListResponse](docs/PipelineSummariesListResponse.md)
+ - [PipelineSummary](docs/PipelineSummary.md)
+ - [ProductCategory](docs/ProductCategory.md)
+ - [ProductCommission](docs/ProductCommission.md)
+ - [ProductCommissionProgram](docs/ProductCommissionProgram.md)
+ - [ProductDiscount](docs/ProductDiscount.md)
+ - [ProductFixedOption](docs/ProductFixedOption.md)
+ - [ProductInterest](docs/ProductInterest.md)
+ - [ProductInterestBundle](docs/ProductInterestBundle.md)
+ - [ProductInventory](docs/ProductInventory.md)
+ - [ProductOptions](docs/ProductOptions.md)
+ - [ProductVariableSetting](docs/ProductVariableSetting.md)
+ - [Provinces](docs/Provinces.md)
+ - [Referral](docs/Referral.md)
+ - [RemoveContactsFromSequenceRequest](docs/RemoveContactsFromSequenceRequest.md)
+ - [RemoveContactsFromSequenceResponse](docs/RemoveContactsFromSequenceResponse.md)
+ - [ReportEntryRecord](docs/ReportEntryRecord.md)
+ - [ReportEntryValue](docs/ReportEntryValue.md)
+ - [ReportExecutionResult](docs/ReportExecutionResult.md)
+ - [Resource](docs/Resource.md)
+ - [RestAffiliate](docs/RestAffiliate.md)
+ - [RestCreateOrderRequest](docs/RestCreateOrderRequest.md)
+ - [RestEmailAddress](docs/RestEmailAddress.md)
+ - [RestOpportunityStage](docs/RestOpportunityStage.md)
+ - [RestPaymentGateway](docs/RestPaymentGateway.md)
+ - [RestPaymentMethod](docs/RestPaymentMethod.md)
+ - [RestProductOption](docs/RestProductOption.md)
+ - [RestProductOptionValue](docs/RestProductOptionValue.md)
+ - [RestSubscriptionPlan](docs/RestSubscriptionPlan.md)
+ - [RestSubscriptionV2](docs/RestSubscriptionV2.md)
+ - [RestV2Opportunity](docs/RestV2Opportunity.md)
+ - [RestV2Order](docs/RestV2Order.md)
+ - [RestV2OrderItem](docs/RestV2OrderItem.md)
+ - [RestV2Product](docs/RestV2Product.md)
+ - [RestV2Subscription](docs/RestV2Subscription.md)
+ - [RestV2User](docs/RestV2User.md)
+ - [SaveAutomationCategoryRequest](docs/SaveAutomationCategoryRequest.md)
+ - [Sequence](docs/Sequence.md)
+ - [SequencePath](docs/SequencePath.md)
+ - [SetDefaultCommissionProgramResponse](docs/SetDefaultCommissionProgramResponse.md)
+ - [ShippingDiscount](docs/ShippingDiscount.md)
+ - [ShippingInformation](docs/ShippingInformation.md)
+ - [ShippingMethod](docs/ShippingMethod.md)
+ - [SocialAccount](docs/SocialAccount.md)
+ - [StackTraceElement](docs/StackTraceElement.md)
+ - [Stage](docs/Stage.md)
+ - [StageDealListResponse](docs/StageDealListResponse.md)
+ - [StageDetails](docs/StageDetails.md)
+ - [StageListResponse](docs/StageListResponse.md)
+ - [SubscriptionCommission](docs/SubscriptionCommission.md)
+ - [SubscriptionCommissionProgram](docs/SubscriptionCommissionProgram.md)
+ - [SubscriptionPlan](docs/SubscriptionPlan.md)
+ - [SubscriptionPlanInterest](docs/SubscriptionPlanInterest.md)
+ - [Tag](docs/Tag.md)
+ - [TaggedCompany](docs/TaggedCompany.md)
+ - [Task](docs/Task.md)
+ - [Throwable](docs/Throwable.md)
+ - [Transaction](docs/Transaction.md)
+ - [URI](docs/URI.md)
+ - [URL](docs/URL.md)
+ - [UpdateAffiliateRequest](docs/UpdateAffiliateRequest.md)
+ - [UpdateAutomationCategoryRequest](docs/UpdateAutomationCategoryRequest.md)
+ - [UpdateBusinessProfileRequest](docs/UpdateBusinessProfileRequest.md)
+ - [UpdateCategoryDiscountRequest](docs/UpdateCategoryDiscountRequest.md)
+ - [UpdateCommissionProgramRequest](docs/UpdateCommissionProgramRequest.md)
+ - [UpdateCompanyRequest](docs/UpdateCompanyRequest.md)
+ - [UpdateCustomFieldMetaDataRequest](docs/UpdateCustomFieldMetaDataRequest.md)
+ - [UpdateDealNoteRequest](docs/UpdateDealNoteRequest.md)
+ - [UpdateDefaultCommissionProgramRequest](docs/UpdateDefaultCommissionProgramRequest.md)
+ - [UpdateEmailAddress](docs/UpdateEmailAddress.md)
+ - [UpdateNoteRequest](docs/UpdateNoteRequest.md)
+ - [UpdateNoteResponse](docs/UpdateNoteResponse.md)
+ - [UpdateOpportunityRequestV2](docs/UpdateOpportunityRequestV2.md)
+ - [UpdateOpportunityStageChecklistItem](docs/UpdateOpportunityStageChecklistItem.md)
+ - [UpdateOpportunityStageRequest](docs/UpdateOpportunityStageRequest.md)
+ - [UpdateOrderItemRequest](docs/UpdateOrderItemRequest.md)
+ - [UpdateOrderRequest](docs/UpdateOrderRequest.md)
+ - [UpdateOrderTotalDiscountRequest](docs/UpdateOrderTotalDiscountRequest.md)
+ - [UpdateOutcomeLabelsRequest](docs/UpdateOutcomeLabelsRequest.md)
+ - [UpdatePipelineRequest](docs/UpdatePipelineRequest.md)
+ - [UpdateProductCategoryRequest](docs/UpdateProductCategoryRequest.md)
+ - [UpdateProductCommissionProgramRequest](docs/UpdateProductCommissionProgramRequest.md)
+ - [UpdateProductDiscountRequest](docs/UpdateProductDiscountRequest.md)
+ - [UpdateProductInterestBundleRequest](docs/UpdateProductInterestBundleRequest.md)
+ - [UpdateProductInventoryRequest](docs/UpdateProductInventoryRequest.md)
+ - [UpdateProductRequest](docs/UpdateProductRequest.md)
+ - [UpdateShippingDiscountRequest](docs/UpdateShippingDiscountRequest.md)
+ - [UpdateStageRequest](docs/UpdateStageRequest.md)
+ - [UpdateSubscriptionCommissionProgramRequest](docs/UpdateSubscriptionCommissionProgramRequest.md)
+ - [UpdateSubscriptionPlanRequest](docs/UpdateSubscriptionPlanRequest.md)
+ - [UpdateSubscriptionRequest](docs/UpdateSubscriptionRequest.md)
+ - [UpdateTagCategoryResponse](docs/UpdateTagCategoryResponse.md)
+ - [UpdateTagResponse](docs/UpdateTagResponse.md)
+ - [UpdateTaskResponse](docs/UpdateTaskResponse.md)
+ - [UpdateUserRequest](docs/UpdateUserRequest.md)
+ - [User](docs/User.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="oauth2"></a>
+### oauth2
+
+- **Type**: OAuth
+- **Flow**: accessCode
+- **Authorization URL**: https://accounts.infusionsoft.com/app/oauth/authorize
+- **Scopes**: N/A
+
+
+## Author
+
+api@keap.com
+