@factern/factern-client
Javascript Client for Factern API
API version: 2.0.0
Installation
npm
npm install @factern/factern-client --save
Getting Started
Once you've installed the client, you can get started with this snippet:
var FacternApi = require('@factern/factern-client');
var defaultClient = FacternApi.ApiClient.instance;
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = "YOUR ACCESS TOKEN";
var api = new FacternApi.FactsApi();
// Example usage of the client to create a named entity
api.addEntity({
login: "Your login ID",
representing: "Your representing ID",
body: new FacternApi.CreateEntityRequest({
name: "example-entity"
})
}).then(function(response) {
console.log(`Node ID: ${response.data.nodeId}`);
}, function(error) {
console.error(error);
});
Documentation for API Endpoints
All URIs are relative to https://api.factern.com/v2
Class | Method | HTTP request | Description |
---|---|---|---|
FacternApi.FactsApi | addMember | POST /createmember | Create Member |
FacternApi.FactsApi | bid | POST /createbid | Create Bid |
FacternApi.FactsApi | callDelete | POST /delete | Deleting |
FacternApi.FactsApi | createAlias | POST /createalias | Create Alias |
FacternApi.FactsApi | createApplication | POST /createapplication | Create Application |
FacternApi.FactsApi | createDomain | POST /createdomain | Create Domain |
FacternApi.FactsApi | createEntity | POST /createentity | Create Entity |
FacternApi.FactsApi | createField | POST /createfield | Create Field |
FacternApi.FactsApi | createFilter | POST /createfilter | Create Filter |
FacternApi.FactsApi | createGroup | POST /creategroup | Create Group |
FacternApi.FactsApi | createInformation | POST /createinformation | Create Information |
FacternApi.FactsApi | createInterface | POST /createinterface | Create Interface |
FacternApi.FactsApi | createLabelList | POST /createlabellist | Create Label List |
FacternApi.FactsApi | createLogin | POST /createlogin | Create Login |
FacternApi.FactsApi | createMirror | POST /createmirror | Create Mirror |
FacternApi.FactsApi | createPrice | POST /createprice | Create Price |
FacternApi.FactsApi | createScope | POST /createscope | Create Scope |
FacternApi.FactsApi | createStatement | POST /createstatement | Create Statement |
FacternApi.FactsApi | createTemplate | POST /createtemplate | Create Template |
FacternApi.FactsApi | deleteNode | POST /deletenode | Delete Node |
FacternApi.FactsApi | describe | POST /describe | Describe |
FacternApi.FactsApi | history | POST /history | History |
FacternApi.FactsApi | label | POST /label | Label a Node |
FacternApi.FactsApi | obliterate | POST /obliterate | Obliterating Information Nodes |
FacternApi.FactsApi | permission | POST /permission | Create Permission |
FacternApi.FactsApi | read | POST /read | Reading |
FacternApi.FactsApi | readInformation | POST /readinformation | Read Information |
FacternApi.FactsApi | replaceInformation | POST /replaceinformation | Replace |
FacternApi.FactsApi | requestPermission | POST /requestpermission | Request Permission |
FacternApi.FactsApi | resetLogin | POST /resetlogin | Changing Login Password |
FacternApi.FactsApi | searchAlias | POST /searchalias | Search For Alias |
FacternApi.FactsApi | searchEntity | POST /searchentity | Search For Entity |
FacternApi.FactsApi | settleAccount | POST /settleaccount | Settle Account |
FacternApi.FactsApi | updateApplication | POST /updateapplication | Resetting Application Secret |
FacternApi.FactsApi | updateStatus | POST /updatestatus | Enabling/Disabling Nodes |
FacternApi.FactsApi | watch | POST /watch | Create Watch Trigger |
FacternApi.FactsApi | write | POST /write | Writing by Template |
Documentation for Models
- FacternApi.Account
- FacternApi.AddLabelRequest
- FacternApi.AddLabelResponse
- FacternApi.AddStatementRequest
- FacternApi.AddStatementResponse
- FacternApi.Agent
- FacternApi.Alias
- FacternApi.AliasNode
- FacternApi.ApiEndpoint
- FacternApi.Application
- FacternApi.ApplicationNode
- FacternApi.BaseRequest
- FacternApi.BaseResponse
- FacternApi.Bid
- FacternApi.BidNode
- FacternApi.Cost
- FacternApi.CreateAliasRequest
- FacternApi.CreateAliasResponse
- FacternApi.CreateApplicationRequest
- FacternApi.CreateApplicationResponse
- FacternApi.CreateBidRequest
- FacternApi.CreateBidResponse
- FacternApi.CreateChildRequest
- FacternApi.CreateDomainRequest
- FacternApi.CreateDomainResponse
- FacternApi.CreateEntityRequest
- FacternApi.CreateEntityResponse
- FacternApi.CreateFieldRequest
- FacternApi.CreateFieldResponse
- FacternApi.CreateFilterRequest
- FacternApi.CreateFilterResponse
- FacternApi.CreateGroupRequest
- FacternApi.CreateGroupResponse
- FacternApi.CreateInformationRequest
- FacternApi.CreateInformationResponse
- FacternApi.CreateInterfaceRequest
- FacternApi.CreateInterfaceResponse
- FacternApi.CreateLabelListRequest
- FacternApi.CreateLabelListResponse
- FacternApi.CreateLoginRequest
- FacternApi.CreateLoginResponse
- FacternApi.CreateMemberRequest
- FacternApi.CreateMemberResponse
- FacternApi.CreateMirrorRequest
- FacternApi.CreateMirrorResponse
- FacternApi.CreateNamedRequest
- FacternApi.CreatePermissionRequest
- FacternApi.CreatePermissionResponse
- FacternApi.CreatePriceRequest
- FacternApi.CreatePriceResponse
- FacternApi.CreateScopeRequest
- FacternApi.CreateScopeResponse
- FacternApi.CreateTemplateRequest
- FacternApi.CreateTemplateResponse
- FacternApi.CreateWatchRequest
- FacternApi.CreateWatchResponse
- FacternApi.DeleteRequest
- FacternApi.DeleteResponse
- FacternApi.DeletedItem
- FacternApi.DeletedStatusItem
- FacternApi.DescribeRequest
- FacternApi.DescribeResponse
- FacternApi.Domain
- FacternApi.DomainNode
- FacternApi.Entity
- FacternApi.EntityListResponse
- FacternApi.EntityNode
- FacternApi.ExternalDataUsage
- FacternApi.FactCount
- FacternApi.Field
- FacternApi.FieldNode
- FacternApi.FieldStoreValues
- FacternApi.Filter
- FacternApi.FilterNode
- FacternApi.FilterStatement
- FacternApi.GasCost
- FacternApi.Group
- FacternApi.GroupNode
- FacternApi.HttpHeader
- FacternApi.Information
- FacternApi.InformationListResponse
- FacternApi.InformationNode
- FacternApi.InterfaceNode
- FacternApi.Label
- FacternApi.LabelList
- FacternApi.LabelListMember
- FacternApi.LabelListMemberNode
- FacternApi.LabelListNode
- FacternApi.LabelStatement
- FacternApi.ListCriteria
- FacternApi.Login
- FacternApi.LoginNode
- FacternApi.Member
- FacternApi.MemberNode
- FacternApi.Mirror
- FacternApi.MirrorNode
- FacternApi.ModelInterface
- FacternApi.NamedNode
- FacternApi.NodeIdRequest
- FacternApi.NodeListing
- FacternApi.Permission
- FacternApi.PermissionAction
- FacternApi.PermissionEffect
- FacternApi.PermissionNode
- FacternApi.PermissionPolicyDocument
- FacternApi.Price
- FacternApi.PriceDetails
- FacternApi.PriceNode
- FacternApi.ReadInformationRequest
- FacternApi.ReadInformationResponse
- FacternApi.ReadItem
- FacternApi.ReadRequest
- FacternApi.ReadResponse
- FacternApi.ReadStatusItem
- FacternApi.ReplaceFieldRequest
- FacternApi.ResetLoginCredentialsRequest
- FacternApi.ResetLoginResponse
- FacternApi.Scope
- FacternApi.ScopeNode
- FacternApi.SearchAliasRequest
- FacternApi.SearchAliasResponse
- FacternApi.SearchEntityRequest
- FacternApi.Searches
- FacternApi.SettleAccountRequest
- FacternApi.SettleAccountResponse
- FacternApi.StandardNode
- FacternApi.StandardNodeResponse
- FacternApi.Statement
- FacternApi.StatementStatement
- FacternApi.Summary
- FacternApi.Template
- FacternApi.TemplateNode
- FacternApi.TokenPayment
- FacternApi.TransformElement
- FacternApi.UpdateApplicationRequest
- FacternApi.UpdateApplicationResponse
- FacternApi.UpdateStatusRequest
- FacternApi.Watch
- FacternApi.WatchEvent
- FacternApi.WatchEventNode
- FacternApi.WatchNode
- FacternApi.WriteItem
- FacternApi.WriteRequest
- FacternApi.WriteResponse
Documentation for Authorization
OAuth2
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://factern-test.eu.auth0.com/oauth/token
-
Scopes:
- profile: Grants read and write access to administrative information
- openid: Grants read and write access to administrative information
- email: Grants read and write access to administrative information
- phone: Grants write access
- address: Grants read access
License
MIT License
Copyright (c) 2018 Factern
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
Disclaimer
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.