README

Keap REST Core Service

For more information, please visit https://developer.keap.com/get-support/.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/infusionsoft/keap-sdk.git"
    }
  ],
  "require": {
    "infusionsoft/keap-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/core-v2-client/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new Keap\Core\V2\Api\AffiliateApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 'id_example'; // string | id
$affiliate_add_to_program_request = new \Keap\Core\V2\Model\AffiliateAddToProgramRequest(); // \Keap\Core\V2\Model\AffiliateAddToProgramRequest | affiliateAddToProgramRequest

try {
    $apiInstance->addAffiliateToProgramUsingPOST($id, $affiliate_add_to_program_request);
} catch (Exception $e) {
    echo 'Exception when calling AffiliateApi->addAffiliateToProgramUsingPOST: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.keap.com/crm/rest

Class	Method	HTTP request	Description
AffiliateApi	addAffiliateToProgramUsingPOST	POST /v2/affiliates/{id}:assignToProgram	Assign Affiliate to Commission program
AffiliateApi	addAffiliateUsingPOST	POST /v2/affiliates	Create an Affiliate
AffiliateApi	addCommissionProgramUsingPOST	POST /v2/affiliates/commissionPrograms	Create an Affiliate Commission Program
AffiliateApi	assignProductCommissionProgramUsingPOST	POST /v2/affiliates/commissionPrograms/productCommissionProgram/{commission_program_id}	Assign a Product Commission Program
AffiliateApi	assignSubscriptionCommissionProgramUsingPOST	POST /v2/affiliates/commissionPrograms/subscriptionCommissionProgram/{commission_program_id}	Assign a Subscription Commission Program
AffiliateApi	createDefaultCommissionProgramUsingPOST	POST /v2/affiliates/commissionPrograms/defaultCommissionProgram/{commission_program_id}	Create a Default Commission Program
AffiliateApi	createRedirectLinkUsingPOST	POST /v2/affiliates/redirects	Create an Affiliate Link
AffiliateApi	deleteAffiliateCommissionProgramUsingDELETE	DELETE /v2/affiliates/commissionPrograms/{commission_program_id}	Delete a Commission Program
AffiliateApi	deleteAffiliateUsingDELETE	DELETE /v2/affiliates/{id}	Delete Affiliate
AffiliateApi	deleteRedirectLinkUsingDELETE	DELETE /v2/affiliates/redirects/{redirect_id}	Delete an Affiliate Link
AffiliateApi	getAffiliateCommissionTotalUsingGET	GET /v2/affiliates/{affiliate_id}/commissionTotal	Retrieve Affiliate Commission Earned and View LedgerURl for portal
AffiliateApi	getAffiliateCommissionsUsingGET	GET /v2/affiliates/{affiliate_id}:commissions	Retrieve Affiliate Commission and Clawbacks
AffiliateApi	getAffiliateUsingGET1	GET /v2/affiliates/{id}	Retrieve an Affiliate
AffiliateApi	getCommissionProgramUsingGET	GET /v2/affiliates/commissionPrograms/{commission_program_id}	Retrieve a Commission Program
AffiliateApi	getRedirectLinkUsingGET	GET /v2/affiliates/redirects/{redirect_id}	Retrieve an Affiliate Link
AffiliateApi	listAffiliateCommissionProgramsUsingGET	GET /v2/affiliates/commissionPrograms	List Affiliate Commission Programs
AffiliateApi	listAffiliateLinksUsingGET	GET /v2/affiliates/redirects	List Affiliate Links
AffiliateApi	listSummariesUsingGET1	GET /v2/affiliates/summaries	List Affiliate Summaries
AffiliateApi	removeAffiliateFromProgramUsingPOST	POST /v2/affiliates/{id}:removeFromProgram	Remove an Affiliate from a Commission Program
AffiliateApi	removeProductCommissionFromCommissionsUsingPOST	POST /v2/affiliates/commissionPrograms/{commission_id}:removeProductCommission	Remove a Product from a Commission Program
AffiliateApi	removeSubscriptionPlanCommissionFromCommissionsUsingPOST	POST /v2/affiliates/commissionPrograms/{commission_id}:removeSubscriptionCommission	Remove a Subscription from a Commission Program
AffiliateApi	updateAffiliateUsingPATCH	PATCH /v2/affiliates/{id}	Update an Affiliate
AffiliateApi	updateCommissionProgramUsingPATCH	PATCH /v2/affiliates/commissionPrograms/{commission_program_id}	Update an Affiliate Commission Program
AffiliateApi	updateDefaultCommissionProgramUsingPATCH	PATCH /v2/affiliates/commissionPrograms/defaultCommissionPrograms/{commission_program_id}	Update a Default Commission Program
AffiliateApi	updateProductCommissionProgramUsingPATCH	PATCH /v2/affiliates/commissionPrograms/productCommissionPrograms/{commission_program_id}	Update a Product Commission Program
AffiliateApi	updateRedirectLinkUsingPATCH	PATCH /v2/affiliates/redirects/{redirect_id}	Update an Affiliate Link
AffiliateApi	updateSubscriptionCommissionProgramUsingPATCH	PATCH /v2/affiliates/commissionPrograms/subscriptionCommissionPrograms/{commission_program_id}	Update a Subscription Commission Program
AutomationApi	addContactsToAutomationSequenceUsingPOST	POST /v2/automations/{automation_id}/sequences/{sequence_id}:addContacts	Add Contacts to an Automation Sequence
AutomationApi	bulkAssignmentAutomationsCategoriesUsingPOST	POST /v2/automations/categories/batchAssign	Bulk update for Automations Categories
AutomationApi	deleteAutomationUsingDELETE	DELETE /v2/automations	Delete an Automation
AutomationApi	getAutomationUsingGET	GET /v2/automations/{automation_id}	Retrieve an Automation
AutomationApi	listAllAutomationIdsUsingGET	GET /v2/automations/ids	List Automations Ids
AutomationApi	listAutomationsUsingGET	GET /v2/automations	List Automations
AutomationApi	updateAutomationCategoryUsingPUT	PUT /v2/automations/category	Update an Automation's Category
AutomationCategoryApi	createCategoryUsingPOST	POST /v2/automationCategory	Create automation category
AutomationCategoryApi	deleteCategoriesUsingDELETE	DELETE /v2/automationCategory	Delete automation category
AutomationCategoryApi	listCategoriesUsingGET	GET /v2/automationCategory	List automation categories
AutomationCategoryApi	patchCategoryUsingPATCH	PATCH /v2/automationCategory/{id}	Update automation category
AutomationCategoryApi	saveCategoryUsingPUT	PUT /v2/automationCategory	Save automation category
BusinessProfileApi	getBusinessProfileUsingGET	GET /v2/businessProfile	Retrieve Business Profile
BusinessProfileApi	updateBusinessProfileUsingPATCH	PATCH /v2/businessProfile	Update Business Profile
CampaignApi	addContactsToCampaignSequenceUsingPOST1	POST /v2/campaigns/{campaign_id}/sequences/{sequence_id}:addContacts	Add Contacts to Campaign Sequence
CampaignApi	getCampaignUsingGET1	GET /v2/campaigns/{campaign_id}	Retrieve a Campaign
CampaignApi	listCampaignsUsingGET1	GET /v2/campaigns	List Campaigns
CampaignApi	removeContactsFromCampaignSequenceUsingPOST	POST /v2/campaigns/{campaign_id}/sequences/{sequence_id}:removeContacts	Remove Contacts from Campaign Sequence
CompanyApi	createCompanyUsingPOST1	POST /v2/companies	Create a Company
CompanyApi	deleteCompanyUsingDELETE	DELETE /v2/companies/{company_id}	Delete a Company
CompanyApi	getCompanyUsingGET1	GET /v2/companies/{company_id}	Retrieve a Company
CompanyApi	listCompaniesUsingGET1	GET /v2/companies	List Companies
CompanyApi	updateCompanyUsingPATCH1	PATCH /v2/companies/{company_id}	Update a Company
ContactApi	createContactLinkTypeUsingPOST	POST /v2/contacts/links/types	Create a Contact Link type
ContactApi	createContactUsingPOST1	POST /v2/contacts	Create a Contact
ContactApi	deleteContactUsingDELETE1	DELETE /v2/contacts/{contact_id}	Delete a Contact
ContactApi	getContactUsingGET1	GET /v2/contacts/{contact_id}	Retrieve a Contact
ContactApi	linkContactsUsingPOST	POST /v2/contacts:link	Link Contacts
ContactApi	listContactLinkTypesUsingGET	GET /v2/contacts/links/types	List Contact Link types
ContactApi	listContactLinksUsingGET	GET /v2/contacts/{contact_id}/links	List Linked Contacts
ContactApi	listContactsUsingGET1	GET /v2/contacts	List Contacts
ContactApi	retrieveContactModelUsingGET1	GET /v2/contacts/model	Retrieve Contact Model
ContactApi	unlinkContactsUsingPOST	POST /v2/contacts:unlink	Delete Link between two Contacts
ContactApi	updateContactUsingPATCH	PATCH /v2/contacts/{contact_id}	Update a Contact
CustomFieldsApi	getCustomFields	GET /v2/customFields	Retrieves a list of custom fields in a tenant.
CustomFieldsApi	updateCustomField	PATCH /v2/customFields/{id}	Updates a custom field
DateExpressionApi	queryDateExpressions	GET /v2/dateExpressions
DealsApi	createDeal	POST /v2/deals	Creates a new deal.
DealsApi	createNote	POST /v2/deals/{id}/notes	Creates a new note for a specific deal.
DealsApi	createNotesBulk	POST /v2/deals/-/notes	Creates new notes in bulk.
DealsApi	deleteDeal	DELETE /v2/deals/{id}	Deletes a specific deal by its ID.
DealsApi	deleteNote	DELETE /v2/deals/-/notes/{note_id}	Deletes a specific deal note by its ID.
DealsApi	getDeal	GET /v2/deals/{id}	Retrieves a specific deal by its ID.
DealsApi	getNote	GET /v2/deals/-/notes/{note_id}	Retrieves a specific deal note by its ID.
DealsApi	listDeals	GET /v2/deals/-/contacts/{contact_id}	Lists all deals associated with a specific contact.
DealsApi	listNotes	GET /v2/deals/{id}/notes	Lists all notes associated with a specific deal.
DealsApi	moveDealsForContacts	POST /v2/deals/moveByContactIds	Moves the active deals of specified contacts from one stage to another, in bulk.
DealsApi	updateNote	PATCH /v2/deals/-/notes/{note_id}	Updates a specific deal note by its ID.
DisplayFormsApi	getDisplayForm	GET /v2/pipelines/{id}/form	Retrieves a specific display form by a pipeline ID.
DisplayFormsApi	updateDisplayForm	PATCH /v2/pipelines/{id}/form	Updates a display form
EmailApi	createEmailUsingPOST1	POST /v2/emails	Create an Email Record
EmailApi	createEmailsUsingPOST1	POST /v2/emails:batchAdd	Create a set of Email Records
EmailApi	deleteEmailUsingDELETE1	DELETE /v2/emails/{id}	Delete an Email Record
EmailApi	deleteEmailsUsingPOST1	POST /v2/emails:batchRemove	Remove a set of Email Records
EmailApi	getEmailTemplateUsingGET	GET /v2/emails/templates/{email_template_id}	Retrieve an email template
EmailApi	getEmailUsingGET1	GET /v2/emails/{id}	Retrieve an Email
EmailApi	sendEmailTemplateUsingPOST	POST /v2/emails/templates:send	Send an email based on a template
EmailApi	sendEmailUsingPOST1	POST /v2/emails:send	Send an Email
FilesApi	createFileUsingPOST1	POST /v2/files	Create a file
FilesApi	deleteFileUsingDELETE1	DELETE /v2/files/{file_id}	Delete a file
FilesApi	getFileDataUsingGET	GET /v2/files/{file_id}:data	Retrieve a file's data
FilesApi	getFileUsingGET1	GET /v2/files/{file_id}	Retrieve a file
FilesApi	listFilesUsingGET1	GET /v2/files	List all files
FilesApi	updateFileUsingPOST	POST /v2/files/{file_id}	Update a file
FreeTrialDiscountsApi	createDiscountUsingPOST1	POST /v2/discounts/freeTrials	Create a Subscription Free Trial Discount
FreeTrialDiscountsApi	deleteDiscountUsingDELETE1	DELETE /v2/discounts/freeTrials/{discount_id}	Delete a Subscription Free Trial Discount
FreeTrialDiscountsApi	getDiscountUsingGET1	GET /v2/discounts/freeTrials/{discount_id}	Retrieve a Subscription Free Trial Discount
FreeTrialDiscountsApi	listFreeTrialsUsingGET	GET /v2/discounts/freeTrials	List all Subscription Free Trial Discounts
FreeTrialDiscountsApi	updateDiscountUsingPATCH1	PATCH /v2/discounts/freeTrials/{discount_id}	Update a Subscription Free Trial Discount
LeadSourceCategoriesApi	createLeadSourceCategoryUsingPOST	POST /v2/leadSourceCategories	Create a Lead Source Category
LeadSourceCategoriesApi	deleteLeadSourceCategoryUsingDELETE	DELETE /v2/leadSourceCategories/{lead_source_category_id}	Delete a Lead Source Category
LeadSourceCategoriesApi	getLeadSourceCategoryUsingGET	GET /v2/leadSourceCategories/{lead_source_category_id}	Retrieve a Lead Source Category
LeadSourceCategoriesApi	listCategoriesUsingGET1	GET /v2/leadSourceCategories	List Lead Source Categories
LeadSourceCategoriesApi	updateLeadSourceCategoryUsingPATCH	PATCH /v2/leadSourceCategories/{lead_source_category_id}	Update a Lead Source Category
LeadSourceExpensesApi	createLeadSourceExpenseUsingPOST	POST /v2/leadSources/{lead_source_id}/expenses	Create a Lead Source Expense
LeadSourceExpensesApi	deleteLeadSourceUsingDELETE1	DELETE /v2/leadSources/{lead_source_id}/expenses/{lead_source_expense_id}	Delete a lead source expense
LeadSourceExpensesApi	getLeadSourceExpenseUsingGET	GET /v2/leadSources/{lead_source_id}/expenses/{lead_source_expense_id}	Retrieve a Lead Source Expense
LeadSourceExpensesApi	listLeadSourceExpensesUsingGET	GET /v2/leadSources/{lead_source_id}/expenses	List Lead Source Expenses
LeadSourceExpensesApi	updateLeadSourceExpenseUsingPATCH	PATCH /v2/leadSources/{lead_source_id}/expenses/{lead_source_expense_id}	Update a Lead Source Expense
LeadSourceRecurringExpensesApi	createLeadSourceRecurringExpenseUsingPOST	POST /v2/leadSources/{lead_source_id}/recurringExpenses	Create a Lead Source Recurring Expense
LeadSourceRecurringExpensesApi	deleteLeadSourceRecurringExpenseUsingDELETE	DELETE /v2/leadSources/{lead_source_id}/recurringExpenses/{lead_source_recurring_expense_id}	Delete a Lead Source Recurring Expense
LeadSourceRecurringExpensesApi	getLeadSourceRecurringExpenseUsingGET	GET /v2/leadSources/{lead_source_id}/recurringExpenses/{lead_source_recurring_expense_id}	Retrieve a Lead Source Recurring Expense
LeadSourceRecurringExpensesApi	listExpensesIncurredFromLeadSourceRecurringExpenseUsingGET	GET /v2/leadSources/{lead_source_id}/recurringExpenses/{lead_source_recurring_expense_id}/expenses	Retrieves a list of expenses incurred from a recurring expense
LeadSourceRecurringExpensesApi	listLeadSourceRecurringExpensesUsingGET	GET /v2/leadSources/{lead_source_id}/recurringExpenses	Retrieves a list of lead source recurring expenses
LeadSourceRecurringExpensesApi	updateLeadSourceRecurringExpenseUsingPATCH	PATCH /v2/leadSources/{lead_source_id}/recurringExpenses/{lead_source_recurring_expense_id}	Update a Lead Source Recurring Expense
LeadSourcesApi	createLeadSourceUsingPOST	POST /v2/leadSources	Create a Lead Source
LeadSourcesApi	deleteLeadSourceUsingDELETE	DELETE /v2/leadSources/{lead_source_id}	Delete a Lead Source
LeadSourcesApi	getLeadSourceUsingGET	GET /v2/leadSources/{lead_source_id}	Retrieve a Lead Source
LeadSourcesApi	listLeadSourcesUsingGET	GET /v2/leadSources	List Lead Sources
LeadSourcesApi	updateLeadSourceUsingPATCH	PATCH /v2/leadSources/{lead_source_id}	Update a Lead Source
NoteApi	createNoteCustomFieldUsingPOST1	POST /v2/notes/model/customFields	Create a Custom Field
NoteApi	createNoteUsingPOST1	POST /v2/contacts/{contact_id}/notes	Create a Note
NoteApi	deleteNoteUsingDELETE1	DELETE /v2/contacts/{contact_id}/notes/{note_id}	Delete a Note
NoteApi	getNoteUsingGET1	GET /v2/contacts/{contact_id}/notes/{note_id}	Retrieve a Note
NoteApi	listNoteTemplatesUsingGET	GET /v2/notes/templates	Retrieve Note Templates
NoteApi	listNotesUsingGET1	GET /v2/contacts/{contact_id}/notes	List Notes
NoteApi	retrieveNoteModelUsingGET1	GET /v2/notes/model	Retrieve Note Model
NoteApi	updateNoteUsingPATCH	PATCH /v2/contacts/{contact_id}/notes/{note_id}	Update a Note
NoteApi	updateNotesCustomFieldUsingPATCH	PATCH /v2/notes/model/customFields/{custom_field_id}	Update a Custom Field
OpportunityApi	createOpportunityCustomFieldsUsingPOST	POST /v2/opportunities/model/customFields	Create an Opportunity Custom Field
OpportunityApi	createOpportunityStageUsingPOST	POST /v2/opportunities/stages	Create an Opportunity Stage
OpportunityApi	createOpportunityUsingPOST1	POST /v2/opportunities	Create an Opportunity
OpportunityApi	deleteOpportunityStageUsingDELETE	DELETE /v2/opportunities/stages/{stage_id}	Delete an Opportunity Stage
OpportunityApi	deleteOpportunityUsingDELETE	DELETE /v2/opportunities/{opportunity_id}	Delete an Opportunity
OpportunityApi	getOpportunityStageUsingGET	GET /v2/opportunities/stages/{stage_id}	Retrieve an Opportunity Stage
OpportunityApi	getOpportunityUsingGET1	GET /v2/opportunities/{opportunity_id}	Retrieve a Opportunity
OpportunityApi	listOpportunitiesUsingGET1	GET /v2/opportunities	List Opportunities
OpportunityApi	listOpportunityStagesUsingGET	GET /v2/opportunities/stages	List of Opportunity Stages
OpportunityApi	updateOpportunityCustomFieldUsingPATCH	PATCH /v2/opportunities/model/customFields/{custom_field_id}	Update a Opportunity's Custom Field
OpportunityApi	updateOpportunityStageUsingPATCH	PATCH /v2/opportunities/stages/{stage_id}	Update an Opportunity Stage
OpportunityApi	updateOpportunityUsingPATCH	PATCH /v2/opportunities/{opportunity_id}	Update an opportunity
OrderTotalDiscountsApi	createOrderTotalDiscountUsingPOST	POST /v2/discounts/orderTotals	Create an Order Total Discount
OrderTotalDiscountsApi	deleteOrderTotalDiscountUsingDELETE	DELETE /v2/discounts/orderTotals/{discount_id}	Delete an Order Total Discount
OrderTotalDiscountsApi	getOrderTotalDiscountUsingGET	GET /v2/discounts/orderTotals/{discount_id}	Retrieve an Order Total Discount
OrderTotalDiscountsApi	listOrderTotalDiscountsUsingGET	GET /v2/discounts/orderTotals	List all Order Total Discounts
OrderTotalDiscountsApi	updateOrderTotalDiscountUsingPATCH	PATCH /v2/discounts/orderTotals/{discount_id}	Update an Order Total Discount
OrdersApi	createOrderCustomFieldUsingPOST	POST /v2/orders/model/customFields	Create an Order Custom Field
OrdersApi	deleteOrderCustomFieldUsingDELETE	DELETE /v2/orders/model/customFields/{custom_field_id}	Delete an Order Custom Field
OrdersApi	retrieveOrderCustomFieldModelUsingGET	GET /v2/orders/model	Retrieve Order Custom Field Model
OrdersApi	updateOrderCustomFieldUsingPATCH	PATCH /v2/orders/model/customFields/{custom_field_id}	Update an Order Custom Field
PaymentMethodConfigsApi	createPaymentMethodConfigUsingPOST	POST /v2/paymentMethodConfigs	Create Payment Method Configuration
PipelinesApi	callList	GET /v2/pipelines	Lists entities based on the provided ListCommand.
PipelinesApi	create	POST /v2/pipelines	Creates a new entity.
PipelinesApi	delete	DELETE /v2/pipelines/{id}	Deletes a pipeline.
PipelinesApi	get	GET /v2/pipelines/{id}	Retrieves an entity by its identifier.
PipelinesApi	getDealCount	GET /v2/pipelines/{id}:dealsCount	Retrieves the count of deals for a specific pipeline.
PipelinesApi	getOutcomeLabels	GET /v2/pipelines/{id}/outcomes	Gets the outcome labels for a pipeline.
PipelinesApi	listStages	GET /v2/pipelines/{id}/stages	Retrieves a list of stages for a specific pipeline.
PipelinesApi	listSummaries	GET /v2/pipelines/summaries	Retrieves a list of pipeline summaries.
PipelinesApi	setOutcomeLabels	PATCH /v2/pipelines/{id}/outcomes	Sets the outcome labels for a pipeline.
PipelinesApi	update	PATCH /v2/pipelines/{id}	Updates an existing entity.
ProductDiscountsApi	createDiscountUsingPOST2	POST /v2/discounts/products	Create a Product Discount
ProductDiscountsApi	deleteDiscountUsingDELETE2	DELETE /v2/discounts/products/{discount_id}	Delete a Product Discount
ProductDiscountsApi	getDiscountUsingGET2	GET /v2/discounts/products/{discount_id}	Retrieve a Product Discount
ProductDiscountsApi	listDiscountsUsingGET	GET /v2/discounts/products	List all Product Discounts
ProductDiscountsApi	updateDiscountUsingPATCH2	PATCH /v2/discounts/products/{discount_id}	Update a Product Discount
ProductInterestBundlesApi	addProductInterestUsingPOST	POST /v2/productInterestBundles/{id}/interests	Create a Product Interest in an existing Bundle
ProductInterestBundlesApi	createProductInterestBundleUsingPOST	POST /v2/productInterestBundles	Create a Product Interest Bundle
ProductInterestBundlesApi	deleteProductInterestBundleUsingDELETE	DELETE /v2/productInterestBundles/{id}	Delete a Product Interest Bundle
ProductInterestBundlesApi	getProductInterestBundleUsingGET	GET /v2/productInterestBundles/{id}	Get a Product Interest Bundle
ProductInterestBundlesApi	listProductInterestBundlesUsingGET	GET /v2/productInterestBundles	List Product Interest Bundles
ProductInterestBundlesApi	removeProductInterestUsingDELETE	DELETE /v2/productInterestBundles/{id}/interests/{interest_id}	Delete a Product Interest from an existing Bundle
ProductInterestBundlesApi	updateProductInterestBundleUsingPATCH	PATCH /v2/productInterestBundles/{id}	Update a Product Interest Bundle
ProductInterestBundlesApi	updateProductInterestUsingPATCH	PATCH /v2/productInterestBundles/{id}/interests/{interest_id}	Update a Product Interest in an existing Bundle
ReportingApi	listReportsUsingGET	GET /v2/reporting/reports	List Reports
ReportingApi	retrieveReportUsingGET	GET /v2/reporting/reports/{report_id}	Retrieve Report
ReportingApi	runReportUsingPOST	POST /v2/reporting/reports/{report_id}:run	Run a Report
SalesApi	setMerchantGatewayAsDefaultUsingPOST	POST /v2/sales/merchants/{id}:setDefault	Set default Merchant Account
SettingsApi	getApplicationConfigurationsUsingGET	GET /v2/settings/applications:getConfiguration	Get Application Configuration
SettingsApi	getContactOptionTypesUsingGET1	GET /v2/settings/contactOptionTypes	Get Contact Option types
SettingsApi	isApplicationEnabledUsingGET	GET /v2/settings/applications:isEnabled	Get Application Status
ShippingDiscountsApi	createDiscountUsingPOST3	POST /v2/discounts/shipping	Create a Shipping Discount
ShippingDiscountsApi	deleteDiscountUsingDELETE3	DELETE /v2/discounts/shipping/{discount_id}	Delete a Shipping Discount
ShippingDiscountsApi	getDiscountUsingGET3	GET /v2/discounts/shipping/{discount_id}	Retrieve a Shipping Discount
ShippingDiscountsApi	listDiscountsUsingGET1	GET /v2/discounts/shipping	List all Shipping Discounts
ShippingDiscountsApi	updateDiscountUsingPATCH3	PATCH /v2/discounts/shipping/{discount_id}	Update a Shipping Discount
StagesApi	countDealsInStage	GET /v2/stages/{id}/dealCount	Counts the number of deals in a specific stage.
StagesApi	create1	POST /v2/stages	Creates a new entity.
StagesApi	delete1	DELETE /v2/stages/{id}	Deletes a stage by its identifier for a given tenant.
StagesApi	get1	GET /v2/stages/{id}	Retrieves an entity by its identifier.
StagesApi	list1	GET /v2/stages	Lists entities based on the provided ListCommand.
StagesApi	listStageDeals	GET /v2/stages/{id}/deals	Retrieves a list of deals for a specific stage.
StagesApi	update1	PATCH /v2/stages/{id}	Updates an existing entity.
SubscriptionsApi	createSubscriptionCustomFieldUsingPOST	POST /v2/subscriptions/model/customFields	Create a Subscription Custom Field
SubscriptionsApi	createSubscriptionV2UsingPOST	POST /v2/subscriptions	Create Subscription
SubscriptionsApi	deleteSubscriptionCustomFieldUsingDELETE	DELETE /v2/subscriptions/model/customFields/{custom_field_id}	Delete a Subscription Custom Field
SubscriptionsApi	retrieveSubscriptionCustomFieldModelUsingGET	GET /v2/subscriptions/model	Retrieve Subscription Custom Field Model
SubscriptionsApi	updateSubscriptionCustomFieldUsingPATCH	PATCH /v2/subscriptions/model/customFields/{custom_field_id}	Update a Subscription Custom Field
TagsApi	applyTagsUsingPOST	POST /v2/tags/{tag_id}/contacts:applyTags	Apply Tag
TagsApi	createTagCategoryUsingPOST1	POST /v2/tags/categories	Create Tag Category
TagsApi	createTagUsingPOST1	POST /v2/tags	Create Tag
TagsApi	deleteTagCategoryUsingDELETE	DELETE /v2/tags/categories/{tag_category_id}	Delete Tag Category
TagsApi	deleteTagUsingDELETE	DELETE /v2/tags/{tag_id}	Delete Tag
TagsApi	getCategoryUsingGET	GET /v2/tags/categories/{tag_category_id}	Retrieve a Tag Category
TagsApi	getTagUsingGET1	GET /v2/tags/{tag_id}	Retrieve a Tag
TagsApi	listCompaniesForTagIdUsingGET1	GET /v2/tags/{tag_id}/companies	List Tagged Companies
TagsApi	listContactsWithTagIdUsingGET	GET /v2/tags/{tag_id}/contacts	List Tagged Contacts
TagsApi	listTagCategoriesUsingGET	GET /v2/tags/categories	List Tag Categories
TagsApi	listTagsUsingGET1	GET /v2/tags	List Tags
TagsApi	removeTagsUsingPOST	POST /v2/tags/{tag_id}/contacts:removeTags	Remove Tags
TagsApi	updateTagCategoryUsingPATCH	PATCH /v2/tags/categories/{tag_category_id}	Update a Tag Category
TagsApi	updateTagUsingPATCH	PATCH /v2/tags/{tag_id}	Update a Tag
TaskApi	createTaskCustomFieldUsingPOST1	POST /v2/tasks/model/customFields	Create a Custom Field
TaskApi	createTaskUsingPOST1	POST /v2/tasks	Create a Task
TaskApi	deleteTaskCustomFieldUsingDELETE	DELETE /v2/tasks/model/customFields/{custom_field_id}	Delete a Custom Field
TaskApi	deleteTaskUsingDELETE1	DELETE /v2/tasks/{task_id}	Delete a Task
TaskApi	getTaskUsingGET1	GET /v2/tasks/{task_id}	Retrieve a Task
TaskApi	listTasksUsingGET1	GET /v2/tasks	List Tasks
TaskApi	retrieveTaskModelUsingGET1	GET /v2/tasks/model	Retrieve Task Model
TaskApi	updateTaskCustomFieldUsingPATCH	PATCH /v2/tasks/model/customFields/{custom_field_id}	Update a Task's Custom Field
TaskApi	updateTaskUsingPATCH	PATCH /v2/tasks/{task_id}	Update a Task
UsersApi	listPaginatedUsersUsingGET	GET /v2/users	List Users

Models

Authorization

Authentication schemes defined for the API:

oauth2

Type: OAuth
Flow: accessCode
Authorization URL: https://accounts.infusionsoft.com/app/oauth/authorize
Scopes: N/A

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

api@keap.com

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 2.70.0.812056
- Package version: 1.0.20
- Generator version: 7.13.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

keap / keap-sdk

Maintainers

Details