infusionsoft-sdk

infusionsoft_rest_api

InfusionsoftRestApi - JavaScript client for infusionsoft_rest_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

• API version: V1.0
• Package version: V1.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://developer.infusionsoft.com/get-support/

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install infusionsoft_rest_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/infusionsoft_rest_api then install it via:

    npm install YOUR_USERNAME/infusionsoft_rest_api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var InfusionsoftRestApi = require('infusionsoft_rest_api');
 
var api = new InfusionsoftRestApi.AppointmentApi()
 
var opts = { 
  'since': "since_example", // {String} Date to start searching from ex. `2017-01-01T22:17:59.039Z`
  'until': "until_example", // {String} Date to search to ex. `2017-01-01T22:17:59.039Z`
  'limit': 56, // {Number} Sets a total of items to return
  'offset': 56 // {Number} Sets a beginning range of items to return
};
 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.appointmentsUsingGET(opts, callback);
 

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
InfusionsoftRestApi.AppointmentApi	appointmentsUsingGET	GET /appointments	List Appointments
InfusionsoftRestApi.AppointmentApi	createAppointmentUsingPOST	POST /appointments	Create an Appointment
InfusionsoftRestApi.AppointmentApi	loadAppointmentUsingGET	GET /appointments/{appointmentId}	Retrieve an Appointment
InfusionsoftRestApi.AppointmentApi	removeAppointmentUsingDELETE	DELETE /appointments/{appointmentId}	Delete an Appointment
InfusionsoftRestApi.AppointmentApi	replaceAppointmentUsingPUT	PUT /appointments/{appointmentId}	Replace an Appointment
InfusionsoftRestApi.AppointmentApi	searchUsingGET	GET /appointments/search	Search Appointments
InfusionsoftRestApi.AppointmentApi	syncUsingGET	GET /appointments/sync	Retrieve Synced Appointments
InfusionsoftRestApi.AppointmentApi	updateAppointmentUsingPATCH	PATCH /appointments/{appointmentId}	Update an Appointment
InfusionsoftRestApi.CampaignApi	addContactsToCampaignSequenceUsingPOST	POST /campaigns/{campaignId}/sequences/{sequenceId}/contacts/{contactId}	Add to Campaign Sequence
InfusionsoftRestApi.CampaignApi	addContactsToCampaignSequenceUsingPOST1	POST /campaigns/{campaignId}/sequences/{sequenceId}/contacts	Add Multiple to Campaign Sequence
InfusionsoftRestApi.CampaignApi	getAllCampaignsUsingGET	GET /campaigns	List Campaigns
InfusionsoftRestApi.CampaignApi	getCampaignUsingGET	GET /campaigns/{campaignId}	Retrieve a Campaign
InfusionsoftRestApi.CampaignApi	removeContactsFromCampaignSequenceUsingDELETE	DELETE /campaigns/{campaignId}/sequences/{sequenceId}/contacts/{contactId}	Remove from Campaign Sequence
InfusionsoftRestApi.CampaignApi	removeContactsFromCampaignSequenceUsingDELETE1	DELETE /campaigns/{campaignId}/sequences/{sequenceId}/contacts	Remove Multiple from Campaign Sequence
InfusionsoftRestApi.ContactApi	applyTagsToContactIdUsingPOST	POST /contacts/{contactId}/tags	Apply Tags
InfusionsoftRestApi.ContactApi	createContactUsingPOST	POST /contacts	Create a Contact
InfusionsoftRestApi.ContactApi	createOrUpdateContactUsingPUT	PUT /contacts	Create or Update a Contact
InfusionsoftRestApi.ContactApi	deleteContactUsingDELETE	DELETE /contacts/{contactId}	Delete a Contact
InfusionsoftRestApi.ContactApi	listAppliedTagsUsingGET	GET /contacts/{contactId}/tags	List Applied Tags
InfusionsoftRestApi.ContactApi	listContactsUsingGET	GET /contacts	List Contacts
InfusionsoftRestApi.ContactApi	listCustomFieldsUsingGET	GET /contactCustomFields	List Contact Custom Fields
InfusionsoftRestApi.ContactApi	loadUsingGET	GET /contacts/{id}	Retrieve a Contact
InfusionsoftRestApi.ContactApi	removeTagsFromContactUsingDELETE	DELETE /contacts/{contactId}/tags/{tagId}	Remove Applied Tag
InfusionsoftRestApi.ContactApi	removeTagsFromContactUsingDELETE1	DELETE /contacts/{contactId}/tags	Remove Applied Tags
InfusionsoftRestApi.ContactApi	updateContactUsingPATCH	PATCH /contacts/{contactId}	Update a Contact
InfusionsoftRestApi.ECommerceApi	loadOrderUsingGET	GET /orders/{orderId}	Retrieve an Order
InfusionsoftRestApi.ECommerceApi	searchUsingGET1	GET /orders	List Orders
InfusionsoftRestApi.ECommerceApi	searchUsingGET2	GET /transactions	List Transactions
InfusionsoftRestApi.ECommerceApi	transactionByIdUsingGET	GET /transactions/{transactionId}	Retrieve a Transaction
InfusionsoftRestApi.ECommerceApi	transactionsForOrderUsingGET	GET /orders/{orderId}/transactions	Retrieve Order Transactions
InfusionsoftRestApi.OpportunityApi	createOpportunityUsingPOST	POST /opportunities	Create an Opportunity
InfusionsoftRestApi.OpportunityApi	getOpportunityUsingGET	GET /opportunities/{opportunityId}	Retrieve an Opportunity
InfusionsoftRestApi.OpportunityApi	getStagePipelineUsingGET	GET /opportunity/stage_pipeline	List Opportunity Stage Pipeline
InfusionsoftRestApi.OpportunityApi	listOpportunitiesUsingGET	GET /opportunities	List Opportunities
InfusionsoftRestApi.OpportunityApi	replaceOpportunityUsingPUT	PUT /opportunities	Replace an Opportunity
InfusionsoftRestApi.OpportunityApi	updateOpportunityUsingPATCH	PATCH /opportunities/{opportunityId}	Update an Opportunity
InfusionsoftRestApi.ProductApi	loadProductUsingGET	GET /products/{productId}	Retrieve a Product
InfusionsoftRestApi.ProductApi	searchUsingGET3	GET /products/search	List Products
InfusionsoftRestApi.ProductApi	syncUsingGET1	GET /products/sync	Retrieve Synced Products
InfusionsoftRestApi.RESTHooksApi	createAHookSubscription	POST /hooks	Create a Hook Subscription
InfusionsoftRestApi.RESTHooksApi	deleteAHookSubscription	DELETE /hooks/{key}	Delete a Hook Subscription
InfusionsoftRestApi.RESTHooksApi	listHookEventTypes	GET /hooks/event_keys	List Hook Event Types
InfusionsoftRestApi.RESTHooksApi	listStoredHookSubscriptions	GET /hooks	List Stored Hook Subscriptions
InfusionsoftRestApi.RESTHooksApi	retrieveAHookSubscription	GET /hooks/{key}	Retrieve a Hook Subscription
InfusionsoftRestApi.RESTHooksApi	updateAHookSubscription	PUT /hooks/{key}	Update a Hook Subscription
InfusionsoftRestApi.RESTHooksApi	verifyAHookSubscription	POST /hooks/{key}/verify	Verify a Hook Subscription
InfusionsoftRestApi.TaskApi	createTaskUsingPOST	POST /tasks	Create a Task
InfusionsoftRestApi.TaskApi	loadTaskUsingGET	GET /tasks/{taskId}	Retrieve a Task
InfusionsoftRestApi.TaskApi	removeTaskUsingDELETE	DELETE /tasks/{taskId}	Delete a Task
InfusionsoftRestApi.TaskApi	replaceTaskUsingPUT	PUT /tasks/{taskId}	Replace a Task
InfusionsoftRestApi.TaskApi	searchUsingGET4	GET /tasks/search	Search Tasks
InfusionsoftRestApi.TaskApi	syncUsingGET2	GET /tasks/sync	Retrieve Synced Tasks
InfusionsoftRestApi.TaskApi	tasksUsingGET	GET /tasks	List Tasks
InfusionsoftRestApi.TaskApi	updateTaskUsingPATCH	PATCH /tasks/{taskId}	Update a Task

Documentation for Models

• InfusionsoftRestApi.Address
• InfusionsoftRestApi.Appointment
• InfusionsoftRestApi.AppointmentList
• InfusionsoftRestApi.AppointmentStatus
• InfusionsoftRestApi.AppointmentStatusList
• InfusionsoftRestApi.BasicContact
• InfusionsoftRestApi.Campaign
• InfusionsoftRestApi.CampaignList
• InfusionsoftRestApi.CheckListItemDetails
• InfusionsoftRestApi.Company
• InfusionsoftRestApi.ContactList
• InfusionsoftRestApi.ContactTag
• InfusionsoftRestApi.ContactTagList
• InfusionsoftRestApi.CustomFieldMetaData
• InfusionsoftRestApi.CustomFieldOption
• InfusionsoftRestApi.CustomFieldValue
• InfusionsoftRestApi.EmailAddress
• InfusionsoftRestApi.Entrylongstring
• InfusionsoftRestApi.FaxNumber
• InfusionsoftRestApi.FullContact
• InfusionsoftRestApi.Goal
• InfusionsoftRestApi.HistoricalCounts
• InfusionsoftRestApi.Item
• InfusionsoftRestApi.Opportunity
• InfusionsoftRestApi.OpportunityContact
• InfusionsoftRestApi.OpportunityList
• InfusionsoftRestApi.Order
• InfusionsoftRestApi.OrderContactDetails
• InfusionsoftRestApi.OrderItem
• InfusionsoftRestApi.OrderList
• InfusionsoftRestApi.PhoneNumber
• InfusionsoftRestApi.Product
• InfusionsoftRestApi.ProductList
• InfusionsoftRestApi.ProductOption
• InfusionsoftRestApi.ProductOptionValue
• InfusionsoftRestApi.ProductStatus
• InfusionsoftRestApi.ProductStatusList
• InfusionsoftRestApi.Relationship
• InfusionsoftRestApi.RestHook
• InfusionsoftRestApi.RestHookRequest
• InfusionsoftRestApi.SalesPipeline
• InfusionsoftRestApi.Sequence
• InfusionsoftRestApi.SequencePath
• InfusionsoftRestApi.SetOfIds
• InfusionsoftRestApi.ShippingInformation
• InfusionsoftRestApi.SimpleOpportunityStage
• InfusionsoftRestApi.SimpleProduct
• InfusionsoftRestApi.SimpleTag
• InfusionsoftRestApi.SimpleUser
• InfusionsoftRestApi.StageDetails
• InfusionsoftRestApi.SubscriptionPlan
• InfusionsoftRestApi.TagId
• InfusionsoftRestApi.Task
• InfusionsoftRestApi.TaskList
• InfusionsoftRestApi.TaskStatus
• InfusionsoftRestApi.TaskStatusList
• InfusionsoftRestApi.Transaction
• InfusionsoftRestApi.TransactionList
• InfusionsoftRestApi.UpsertContact

Documentation for Authorization

All endpoints do not require authorization.