1.0.3 • Published 6 years ago

infusionsoft-nodejs v1.0.3

Weekly downloads
4
License
MIT
Repository
github
Last release
6 years ago

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:

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

ClassMethodHTTP requestDescription
InfusionsoftRestApi.AppointmentApiappointmentsUsingGETGET /appointmentsList Appointments
InfusionsoftRestApi.AppointmentApicreateAppointmentUsingPOSTPOST /appointmentsCreate an Appointment
InfusionsoftRestApi.AppointmentApiloadAppointmentUsingGETGET /appointments/{appointmentId}Retrieve an Appointment
InfusionsoftRestApi.AppointmentApiremoveAppointmentUsingDELETEDELETE /appointments/{appointmentId}Delete an Appointment
InfusionsoftRestApi.AppointmentApireplaceAppointmentUsingPUTPUT /appointments/{appointmentId}Replace an Appointment
InfusionsoftRestApi.AppointmentApisearchUsingGETGET /appointments/searchSearch Appointments
InfusionsoftRestApi.AppointmentApisyncUsingGETGET /appointments/syncRetrieve Synced Appointments
InfusionsoftRestApi.AppointmentApiupdateAppointmentUsingPATCHPATCH /appointments/{appointmentId}Update an Appointment
InfusionsoftRestApi.CampaignApiaddContactsToCampaignSequenceUsingPOSTPOST /campaigns/{campaignId}/sequences/{sequenceId}/contacts/{contactId}Add to Campaign Sequence
InfusionsoftRestApi.CampaignApiaddContactsToCampaignSequenceUsingPOST1POST /campaigns/{campaignId}/sequences/{sequenceId}/contactsAdd Multiple to Campaign Sequence
InfusionsoftRestApi.CampaignApigetAllCampaignsUsingGETGET /campaignsList Campaigns
InfusionsoftRestApi.CampaignApigetCampaignUsingGETGET /campaigns/{campaignId}Retrieve a Campaign
InfusionsoftRestApi.CampaignApiremoveContactsFromCampaignSequenceUsingDELETEDELETE /campaigns/{campaignId}/sequences/{sequenceId}/contacts/{contactId}Remove from Campaign Sequence
InfusionsoftRestApi.CampaignApiremoveContactsFromCampaignSequenceUsingDELETE1DELETE /campaigns/{campaignId}/sequences/{sequenceId}/contactsRemove Multiple from Campaign Sequence
InfusionsoftRestApi.ContactApiapplyTagsToContactIdUsingPOSTPOST /contacts/{contactId}/tagsApply Tags
InfusionsoftRestApi.ContactApicreateContactUsingPOSTPOST /contactsCreate a Contact
InfusionsoftRestApi.ContactApicreateOrUpdateContactUsingPUTPUT /contactsCreate or Update a Contact
InfusionsoftRestApi.ContactApideleteContactUsingDELETEDELETE /contacts/{contactId}Delete a Contact
InfusionsoftRestApi.ContactApilistAppliedTagsUsingGETGET /contacts/{contactId}/tagsList Applied Tags
InfusionsoftRestApi.ContactApilistContactsUsingGETGET /contactsList Contacts
InfusionsoftRestApi.ContactApilistCustomFieldsUsingGETGET /contactCustomFieldsList Contact Custom Fields
InfusionsoftRestApi.ContactApiloadUsingGETGET /contacts/{id}Retrieve a Contact
InfusionsoftRestApi.ContactApiremoveTagsFromContactUsingDELETEDELETE /contacts/{contactId}/tags/{tagId}Remove Applied Tag
InfusionsoftRestApi.ContactApiremoveTagsFromContactUsingDELETE1DELETE /contacts/{contactId}/tagsRemove Applied Tags
InfusionsoftRestApi.ContactApiupdateContactUsingPATCHPATCH /contacts/{contactId}Update a Contact
InfusionsoftRestApi.ECommerceApiloadOrderUsingGETGET /orders/{orderId}Retrieve an Order
InfusionsoftRestApi.ECommerceApisearchUsingGET1GET /ordersList Orders
InfusionsoftRestApi.ECommerceApisearchUsingGET2GET /transactionsList Transactions
InfusionsoftRestApi.ECommerceApitransactionByIdUsingGETGET /transactions/{transactionId}Retrieve a Transaction
InfusionsoftRestApi.ECommerceApitransactionsForOrderUsingGETGET /orders/{orderId}/transactionsRetrieve Order Transactions
InfusionsoftRestApi.OpportunityApicreateOpportunityUsingPOSTPOST /opportunitiesCreate an Opportunity
InfusionsoftRestApi.OpportunityApigetOpportunityUsingGETGET /opportunities/{opportunityId}Retrieve an Opportunity
InfusionsoftRestApi.OpportunityApigetStagePipelineUsingGETGET /opportunity/stage_pipelineList Opportunity Stage Pipeline
InfusionsoftRestApi.OpportunityApilistOpportunitiesUsingGETGET /opportunitiesList Opportunities
InfusionsoftRestApi.OpportunityApireplaceOpportunityUsingPUTPUT /opportunitiesReplace an Opportunity
InfusionsoftRestApi.OpportunityApiupdateOpportunityUsingPATCHPATCH /opportunities/{opportunityId}Update an Opportunity
InfusionsoftRestApi.ProductApiloadProductUsingGETGET /products/{productId}Retrieve a Product
InfusionsoftRestApi.ProductApisearchUsingGET3GET /products/searchList Products
InfusionsoftRestApi.ProductApisyncUsingGET1GET /products/syncRetrieve Synced Products
InfusionsoftRestApi.RESTHooksApicreateAHookSubscriptionPOST /hooksCreate a Hook Subscription
InfusionsoftRestApi.RESTHooksApideleteAHookSubscriptionDELETE /hooks/{key}Delete a Hook Subscription
InfusionsoftRestApi.RESTHooksApilistHookEventTypesGET /hooks/event_keysList Hook Event Types
InfusionsoftRestApi.RESTHooksApilistStoredHookSubscriptionsGET /hooksList Stored Hook Subscriptions
InfusionsoftRestApi.RESTHooksApiretrieveAHookSubscriptionGET /hooks/{key}Retrieve a Hook Subscription
InfusionsoftRestApi.RESTHooksApiupdateAHookSubscriptionPUT /hooks/{key}Update a Hook Subscription
InfusionsoftRestApi.RESTHooksApiverifyAHookSubscriptionPOST /hooks/{key}/verifyVerify a Hook Subscription
InfusionsoftRestApi.TaskApicreateTaskUsingPOSTPOST /tasksCreate a Task
InfusionsoftRestApi.TaskApiloadTaskUsingGETGET /tasks/{taskId}Retrieve a Task
InfusionsoftRestApi.TaskApiremoveTaskUsingDELETEDELETE /tasks/{taskId}Delete a Task
InfusionsoftRestApi.TaskApireplaceTaskUsingPUTPUT /tasks/{taskId}Replace a Task
InfusionsoftRestApi.TaskApisearchUsingGET4GET /tasks/searchSearch Tasks
InfusionsoftRestApi.TaskApisyncUsingGET2GET /tasks/syncRetrieve Synced Tasks
InfusionsoftRestApi.TaskApitasksUsingGETGET /tasksList Tasks
InfusionsoftRestApi.TaskApiupdateTaskUsingPATCHPATCH /tasks/{taskId}Update a Task

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.