@datafire/redirection v3.0.0

@datafire/redirection

Client library for redirection.io

Installation and Usage

npm install --save @datafire/redirection

let redirection = require('@datafire/redirection').create({
  apiKey: ""
});

.then(data => {
  console.log(data);
});

Description

API documentation for redirection.io

Actions

postAgentFlushAggregateRequestCollection

Creates a AgentFlushAggregateRequest resource.

redirection.postAgentFlushAggregateRequestCollection({}, context)

Input

• input object
  • agentFlushAggregateRequest AgentFlushAggregateRequest

Output

• output AgentFlushAggregateRequest

agent_flush_requests.post

Creates a AgentFlushRequest resource.

redirection.agent_flush_requests.post({}, context)

Input

• input object
  • agentFlushRequest AgentFlushRequest

Output

• output AgentFlushRequest

postInstanceCollection

Creates a Instance resource.

redirection.postInstanceCollection({}, context)

Input

• input object
  • instance Instance-Write

Output

• output Instance-Read

putInstanceItem

Replaces the Instance resource.

redirection.putInstanceItem({
  "id": ""
}, context)

Input

• input object
  • id required string
  • instance Instance-Write

Output

• output Instance-Read

agent_rule_complexes.get

Retrieves the collection of Rule resources.

redirection.agent_rule_complexes.get({
  "projectId": ""
}, context)

Input

• input object
  • projectId required string

Output

• output array
  • items Rule-Read

agent_rule_straights.get

Retrieves the collection of Rule resources.

redirection.agent_rule_straights.get({
  "projectId": ""
}, context)

Input

• input object
  • projectId required string

Output

• output array
  • items Rule-Read

agentRuleCollection

Retrieves the collection of Rule resources.

redirection.agentRuleCollection({
  "projectId": ""
}, context)

Input

• input object
  • projectId required string

Output

• output array
  • items Rule-Read

getAggregateLogCollection

Retrieves the collection of AggregateLog resources.

redirection.getAggregateLogCollection({}, context)

Input

• input object
  • page integer: The collection page number
  • projectId string
  • createdAt string
  • source string
  • target string
  • statusCode string
  • referrer string
  • userAgent string
  • userAgentType string
  • simplifiedUserAgent string
  • ruleId string
  • instanceName string
  • excludeUrls string
  • excludeEmptyReferrer string
  • createdAt_gt string
  • createdAt_gte string
  • createdAt_lt string
  • createdAt_lte string
  • statusCode_gt string
  • statusCode_gte string
  • statusCode_lt string
  • statusCode_lte string

Output

• output array
  • items AggregateLog-Read

getAggregateLogItem

Retrieves a AggregateLog resource.

redirection.getAggregateLogItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output AggregateLog-Read

getCrawlUrlCollection

Retrieves the collection of CrawlUrl resources.

redirection.getCrawlUrlCollection({}, context)

Input

• input object
  • page integer: The collection page number

Output

• output array
  • items CrawlUrl-Read

getCrawlUrlItem

Retrieves a CrawlUrl resource.

redirection.getCrawlUrlItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output CrawlUrl-Read

getCrawlCollection

Retrieves the collection of Crawl resources.

redirection.getCrawlCollection({
  "projectId": ""
}, context)

Input

• input object
  • projectId required string
  • firstUrl string
  • sortcreatedAt string
  • page integer: The collection page number

Output

• output array
  • items Crawl-Read

postCrawlCollection

Creates a Crawl resource.

redirection.postCrawlCollection({}, context)

Input

• input object
  • crawl Crawl-Write

Output

• output Crawl

getCrawlItem

Retrieves a Crawl resource.

redirection.getCrawlItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output Crawl-ReadDetails

cancelCrawlItem

Creates a Crawl resource.

redirection.cancelCrawlItem({
  "id": ""
}, context)

Input

• input object
  • id required string
  • crawl Crawl

Output

• output Crawl-ReadDetails

postExplainUrlCollection

Creates a ExplainUrl resource.

redirection.postExplainUrlCollection({}, context)

Input

• input object
  • explainUrl ExplainUrl-Write

Output

• output ExplainUrl

getExplainUrlItem

Retrieves a ExplainUrl resource.

redirection.getExplainUrlItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output ExplainUrl

exportRuleCollection

Retrieves the collection of Rule resources.

redirection.exportRuleCollection({
  "projectId": ""
}, context)

Input

• input object
  • projectId required string
  • sortid string
  • sortviewCount string

Output

• output array
  • items Rule-Read

postImpactRuleChangeCollection

Creates a ImpactRuleChange resource.

redirection.postImpactRuleChangeCollection({}, context)

Input

• input object
  • impactRuleChange ImpactRuleChange-Write

Output

• output ImpactRuleChange-Read

getImpactRuleChangeItem

Retrieves a ImpactRuleChange resource.

redirection.getImpactRuleChangeItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output ImpactRuleChange-Read

postImpactSmartListCollection

Creates a ImpactSmartList resource.

redirection.postImpactSmartListCollection({}, context)

Input

• input object
  • impactSmartList ImpactSmartList-Write

Output

• output ImpactSmartList-Read

getImpactSmartListItem

Retrieves a ImpactSmartList resource.

redirection.getImpactSmartListItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output ImpactSmartList-Read

getImportCollection

Retrieves the collection of Import resources.

redirection.getImportCollection({
  "projectId": ""
}, context)

Input

• input object
  • projectId required string
  • page integer: The collection page number

Output

• output array
  • items Import-Read

postImportCollection

Creates a Import resource.

redirection.postImportCollection({}, context)

Input

• input object
  • import Import-Write

Output

• output Import-Read

getImportItem

Retrieves a Import resource.

redirection.getImportItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output Import-Read

getInstanceCollection

Retrieves the collection of Instance resources.

redirection.getInstanceCollection({
  "projectId": ""
}, context)

Input

• input object
  • projectId required string

Output

• output array
  • items Instance-Read

getInstanceItem

Retrieves a Instance resource.

redirection.getInstanceItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output Instance-Read

loggingInstanceItem

Replaces the Instance resource.

redirection.loggingInstanceItem({
  "id": ""
}, context)

Input

• input object
  • id required string
  • instance Instance-Write

Output

• output Instance-Read

liveInstanceItem

Replaces the Instance resource.

redirection.liveInstanceItem({
  "id": ""
}, context)

Input

• input object
  • id required string
  • instance Instance-Write

Output

• output Instance-Read

getInvitationCollection

Retrieves the collection of Invitation resources.

redirection.getInvitationCollection({
  "targetId": "",
  "targetType": ""
}, context)

Input

• input object
  • targetId required string
  • targetType required string

Output

• output array
  • items Invitation-Read

postInvitationCollection

Creates a Invitation resource.

redirection.postInvitationCollection({}, context)

Input

• input object
  • invitation Invitation-Write

Output

• output Invitation-Read

acceptInvitationItem

Creates a Invitation resource.

redirection.acceptInvitationItem({
  "token": "",
  "invitation": {}
}, context)

Input

• input object
  • token required string: The invitation acceptation token
  • invitation required Invitation

Output

• output Invitation-Read

deleteInvitationItem

Removes the Invitation resource.

redirection.deleteInvitationItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

Output schema unknown

getInvitationItem

Retrieves a Invitation resource.

redirection.getInvitationItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output Invitation-Read

getLogCollection

Retrieves the collection of Log resources.

redirection.getLogCollection({}, context)

Input

• input object
  • page integer: The collection page number
  • projectId string
  • createdAt string
  • source string
  • target string
  • statusCode string
  • referrer string
  • userAgent string
  • userAgentType string
  • simplifiedUserAgent string
  • ruleId string
  • instanceName string
  • excludeUrls string
  • excludeEmptyReferrer string
  • createdAt_gt string
  • createdAt_gte string
  • createdAt_lt string
  • createdAt_lte string
  • statusCode_gt string
  • statusCode_gte string
  • statusCode_lt string
  • statusCode_lte string

Output

• output array
  • items Log-Read

getLogItem

Retrieves a Log resource.

redirection.getLogItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output Log-Read

postMarkerCollection

Creates a Marker resource.

redirection.postMarkerCollection({}, context)

Input

• input object
  • marker Marker-Write

Output

• output Marker

deleteMarkerItem

Removes the Marker resource.

redirection.deleteMarkerItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

Output schema unknown

getMarkerItem

Retrieves a Marker resource.

redirection.getMarkerItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output Marker

putMarkerItem

Replaces the Marker resource.

redirection.putMarkerItem({
  "id": ""
}, context)

Input

• input object
  • id required string
  • marker Marker

Output

• output Marker

postMatchingUrlCollection

Creates a MatchingUrl resource.

redirection.postMatchingUrlCollection({}, context)

Input

• input object
  • matchingUrl MatchingUrl-Write

Output

• output MatchingUrl-Read

getMatchingUrlItem

Retrieves a MatchingUrl resource.

redirection.getMatchingUrlItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output MatchingUrl-Read

getNotificationCollection

Retrieves the collection of Notification resources.

redirection.getNotificationCollection({}, context)

Input

• input object
  • page integer: The collection page number

Output

• output array
  • items Notification-Read

getNotificationItem

Retrieves a Notification resource.

redirection.getNotificationItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output Notification-Read

postOrganizationCollection

Creates a Organization resource.

redirection.postOrganizationCollection({}, context)

Input

• input object
  • organization Organization-Write

Output

• output Organization-Read

deleteOrganizationItem

Removes the Organization resource.

redirection.deleteOrganizationItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

Output schema unknown

getOrganizationItem

Retrieves a Organization resource.

redirection.getOrganizationItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output Organization-Read

putOrganizationItem

Replaces the Organization resource.

redirection.putOrganizationItem({
  "id": ""
}, context)

Input

• input object
  • id required string
  • organization Organization-Write

Output

• output Organization-Read

post_logs.post

Creates a AgentFlushRequest resource.

redirection.post_logs.post({}, context)

Input

• input object
  • agentFlushRequest AgentFlushRequest

Output

• output AgentFlushRequest

getProjectCollection

Retrieves the collection of Project resources.

redirection.getProjectCollection(null, context)

Input

This action has no parameters

Output

• output array
  • items Project-List

postProjectCollection

Creates a Project resource.

redirection.postProjectCollection({}, context)

Input

• input object
  • project Project-CreationWrite

Output

• output Project-Read

deleteProjectItem

Removes the Project resource.

redirection.deleteProjectItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

Output schema unknown

getProjectItem

Retrieves a Project resource.

redirection.getProjectItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output Project-Read

putProjectItem

Replaces the Project resource.

redirection.putProjectItem({
  "id": ""
}, context)

Input

• input object
  • id required string
  • project Project-Write

Output

• output Project-Read

getPublishHistoryCollection

Retrieves the collection of PublishHistory resources.

redirection.getPublishHistoryCollection({
  "projectId": ""
}, context)

Input

• input object
  • projectId required string
  • createdAtbefore string
  • createdAtstrictly_before string
  • createdAtafter string
  • createdAtstrictly_after string
  • page integer: The collection page number

Output

• output array
  • items PublishHistory-Read

getPublishHistoryItem

Retrieves a PublishHistory resource.

redirection.getPublishHistoryItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output PublishHistory-Read

getRuleChangeCollection

Retrieves the collection of RuleChange resources.

redirection.getRuleChangeCollection({
  "versionId": ""
}, context)

Input

• input object
  • versionId required string
  • page integer: The collection page number

Output

• output array
  • items RuleChange-Read

postRuleChangeCollection

Creates a RuleChange resource.

redirection.postRuleChangeCollection({}, context)

Input

• input object
  • ruleChange RuleChange-Write

Output

• output RuleChange-Read

deleteRuleChangeItem

Removes the RuleChange resource.

redirection.deleteRuleChangeItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

Output schema unknown

getRuleChangeItem

Retrieves a RuleChange resource.

redirection.getRuleChangeItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output RuleChange-Read

getRuleSetVersionCollection

Retrieves the collection of RuleSetVersion resources.

redirection.getRuleSetVersionCollection({
  "projectId": ""
}, context)

Input

• input object
  • projectId required string
  • sortcreatedAt string
  • page integer: The collection page number

Output

• output array
  • items RuleSetVersion-Read

getRuleSetVersionItem

Retrieves a RuleSetVersion resource.

redirection.getRuleSetVersionItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output RuleSetVersion-Read

clearRuleSetVersionItem

Clear a version

redirection.clearRuleSetVersionItem({
  "id": "",
  "ruleSetVersion": {}
}, context)

Input

• input object
  • id required string: The id of the version
  • ruleSetVersion required RuleSetVersion

Output

• output RuleSetVersion-Read

publishRuleSetVersionItem

Publish a version

redirection.publishRuleSetVersionItem({
  "id": "",
  "ruleSetVersion": {}
}, context)

Input

• input object
  • id required string: The id of the version
  • ruleSetVersion required RuleSetVersion

Output

• output RuleSetVersion-Read

getRuleStatisticCollection

Retrieves the collection of RuleStatistic resources.

redirection.getRuleStatisticCollection({
  "projectId": ""
}, context)

Input

• input object
  • projectId required string

Output

• output array
  • items RuleStatistic

getRuleStatisticItem

Retrieves a RuleStatistic resource.

redirection.getRuleStatisticItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output RuleStatistic

getRuleCollection

Retrieves the collection of Rule resources.

redirection.getRuleCollection({
  "projectId": ""
}, context)

Input

• input object
  • projectId required string
  • sortid string
  • sortviewCount string
  • page integer: The collection page number

Output

• output array
  • items Rule-Read

getRuleItem

Retrieves a Rule resource.

redirection.getRuleItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output Rule-Read

getSmartListCollection

Retrieves the collection of SmartList resources.

redirection.getSmartListCollection(null, context)

Input

This action has no parameters

Output

• output array
  • items SmartList

getSmartListItem

Retrieves a SmartList resource.

redirection.getSmartListItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output SmartList

postUserOrganizationCollection

Creates a UserOrganization resource.

redirection.postUserOrganizationCollection({}, context)

Input

• input object
  • userOrganization UserOrganization-CreationWrite

Output

• output UserOrganization-Read

deleteUserOrganizationItem

Removes the UserOrganization resource.

redirection.deleteUserOrganizationItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

Output schema unknown

getUserOrganizationItem

Retrieves a UserOrganization resource.

redirection.getUserOrganizationItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output UserOrganization-Read

putUserOrganizationItem

Replaces the UserOrganization resource.

redirection.putUserOrganizationItem({
  "id": ""
}, context)

Input

• input object
  • id required string
  • userOrganization UserOrganization-Write

Output

• output UserOrganization-Read

getUserProjectFlattenedItem

Retrieves a UserProjectFlattened resource.

redirection.getUserProjectFlattenedItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output UserProjectFlattened-Read

postUserProjectCollection

Creates a UserProject resource.

redirection.postUserProjectCollection({}, context)

Input

• input object
  • userProject UserProject-CreationWrite

Output

• output UserProject-Read

deleteUserProjectItem

Removes the UserProject resource.

redirection.deleteUserProjectItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

Output schema unknown

getUserProjectItem

Retrieves a UserProject resource.

redirection.getUserProjectItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output UserProject-Read

putUserProjectItem

Replaces the UserProject resource.

redirection.putUserProjectItem({
  "id": ""
}, context)

Input

• input object
  • id required string
  • userProject UserProject-Write

Output

• output UserProject-Read

getUserCollection

Retrieves the collection of User resources.

redirection.getUserCollection({
  "organizationId": ""
}, context)

Input

• input object
  • organizationId required string
  • search string

Output

• output array
  • items User-List

postUserCollection

Creates a User resource.

redirection.postUserCollection({}, context)

Input

• input object
  • user User-CreationWrite

Output

• output User-Read

postForgotPasswordRequestCollection

Creates a ForgotPasswordRequest resource.

redirection.postForgotPasswordRequestCollection({}, context)

Input

• input object
  • forgotPasswordRequest ForgotPasswordRequest

Output

• output ForgotPasswordRequest

forgot_passwordUserItem

Replaces the User resource.

redirection.forgot_passwordUserItem({
  "resetToken": ""
}, context)

Input

• input object
  • resetToken required string
  • user User-Password

Output

• output User-Read

deleteUserItem

Removes the User resource.

redirection.deleteUserItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

Output schema unknown

getUserItem

Retrieves a User resource.

redirection.getUserItem({
  "id": ""
}, context)

Input

• input object
  • id required string

Output

• output User-Read

confirm_new_emailUserItem

Retrieves a User resource.

redirection.confirm_new_emailUserItem({
  "id": "",
  "newEmailToken": ""
}, context)

Input

• input object
  • id required string
  • newEmailToken required string

Output

• output User-Read

edit_emailUserItem

Replaces the User resource.

redirection.edit_emailUserItem({
  "id": ""
}, context)

Input

• input object
  • id required string
  • user User-EditInfo

Output

• output User-Read

edit_infoUserItem

Replaces the User resource.

redirection.edit_infoUserItem({
  "id": ""
}, context)

Input

• input object
  • id required string
  • user User-EditInfo

Output

• output User-Read

edit_passwordUserItem

Replaces the User resource.

redirection.edit_passwordUserItem({
  "id": ""
}, context)

Input

• input object
  • id required string
  • user User-EditInfo

Output

• output User-Read

Definitions

AgentFlushAggregateRequest

• AgentFlushAggregateRequest object

AgentFlushRequest

• AgentFlushRequest object
  • instanceTime required integer
  • logs required array
    • items string

AggregateLog-Read

• AggregateLog-Read object
  • fixed boolean
  • lastOccurrenceAt string
  • ruleId string
  • statusCode integer
  • viewCount integer

Crawl

• Crawl object
  • archived boolean
  • author User
  • createdAt string
  • currentConcurrency integer
  • error string
  • finishedAt string
  • firstUrl string
  • id string
  • marking array
    • items string
  • stats array
    • items string
  • trigger string
  • updatedAt string

Crawl-Read

• Crawl-Read object
  • archived boolean
  • author User-Read
  • createdAt string
  • error string
  • finishedAt string
  • firstUrl string
  • id string
  • stats array
    • items string
  • trigger string
  • updatedAt string

Crawl-ReadDetails

• Crawl-ReadDetails object
  • archived boolean
  • author User-ReadDetails
  • createdAt string
  • error string
  • finishedAt string
  • firstUrl string
  • id string
  • stats array
    • items string
  • trigger string
  • updatedAt string

Crawl-Write

• Crawl-Write object
  • concurrency required integer
  • headers array
    • items string
  • maxDepth required integer
  • maxDuration required integer
  • maxUrls required integer
  • otherDomains array
    • items string
  • project required string
  • sslCheckingDisabled required boolean
  • subdomainIncluded required boolean

CrawlUrl-Read

• CrawlUrl-Read object
  • urlsTo string

ExplainUrl

• ExplainUrl object
  • id string
  • project required string
  • url required string

ExplainUrl-Write

• ExplainUrl-Write object
  • project required string
  • url required string

ForgotPasswordRequest

• ForgotPasswordRequest object
  • email required string

ImpactRuleChange-Read

• ImpactRuleChange-Read object

ImpactRuleChange-Write

• ImpactRuleChange-Write object
  • project required string
  • ruleChange required string

ImpactSmartList-Read

• ImpactSmartList-Read object

ImpactSmartList-Write

• ImpactSmartList-Write object
  • project required string
  • smartListId required string
  • smartListVersion string

Import-Read

• Import-Read object
  • author string
  • completedAt string
  • errorCount integer
  • id string
  • importDuration integer
  • message string
  • project required string
  • startedAt string
  • successCount integer
  • updatedAt string

Import-Write

• Import-Write object
  • project required string

Instance-Read

• Instance-Read object
  • agentDuration integer
  • agentVersion string
  • agentVersionStatus string
  • config string
  • createdAt string
  • gone boolean
  • id string
  • lastCompletedAt string
  • lastStartedAt string
  • live boolean
  • logging boolean
  • logsLastFlushedAt string
  • message string
  • misconfigured boolean
  • name required string
  • rulesCount integer
  • rulesHash string
  • stale boolean
  • status integer
  • updatedAt string

Instance-Write

• Instance-Write object
  • agentDuration integer
  • message string
  • rulesCount integer
  • rulesHash string

Invitation

• Invitation object
  • createdAt string
  • email string
  • id string

Invitation-Read

• Invitation-Read object
  • createdAt string
  • email string
  • id string

Invitation-Write

• Invitation-Write object
  • email required string
  • target required string

Log-Read

• Log-Read object
  • createdAt string
  • fixed boolean
  • fixedByVersions array
    • items string
  • fromSmartList boolean
  • notFixedByVersions array
    • items string
  • proxy string
  • ruleId string
  • smartList string

Marker

• Marker object
  • id string
  • maximumOccurrence integer
  • minimumOccurrence integer
  • name required string
  • options array
    • items string
  • regex string
  • transformers array
    • items string
  • type required string

Marker-Read

• Marker-Read object
  • maximumOccurrence integer
  • minimumOccurrence integer
  • name required string
  • options array
    • items string
  • transformers array
    • items string
  • type required string

Marker-Write

• Marker-Write object
  • maximumOccurrence integer
  • minimumOccurrence integer
  • name required string
  • options array
    • items string
  • transformers array
    • items string
  • type required string

MatchingUrl-Read

• MatchingUrl-Read object

MatchingUrl-Write

• MatchingUrl-Write object
  • project string
  • ruleChange string

Notification-Read

• Notification-Read object
  • createdAt string
  • id string
  • message string
  • updatedAt string

Organization

• Organization object
  • createdAt string
  • id string
  • name required string
  • projects array
    • items Project
  • slug string
  • updatedAt string
  • userOrganizations array
    • items UserOrganization

Organization-CreationWrite

• Organization-CreationWrite object

Organization-List

• Organization-List object
  • name required string
  • slug string

Organization-Read

• Organization-Read object
  • id string
  • name required string
  • slug string

Organization-Write

• Organization-Write object
  • name required string

Project

• Project object
  • complexRulesCount integer
  • complexRulesUpdatedAt string
  • configuration array
    • items string
  • createdAt string
  • currentVersion RuleSetVersion
  • id string
  • ignoreProjectTypes array
    • items string
  • isPublishing boolean
  • name required string
  • onboardingCompletedDemos array
    • items string
  • organization Organization
  • plan integer
  • rulesHash string
  • slug string
  • straightRulesCount integer
  • straightRulesUpdatedAt string
  • token string
  • updatedAt string
  • userProjects array
    • items UserProject
  • usersFlattened array
    • items UserProjectFlattened
  • workingVersion RuleSetVersion

Project-CreationWrite

• Project-CreationWrite object
  • ignoreProjectTypes array
    • items string
  • name required string
  • onboardingCompletedDemos array
    • items string
  • organization Organization-CreationWrite

Project-List

• Project-List object
  • id string
  • name required string
  • organization Organization-List
  • slug string
  • token string

Project-Read

• Project-Read object
  • complexRulesCount integer
  • complexRulesUpdatedAt string
  • configuration array
    • items string
  • createdAt string
  • currentVersion RuleSetVersion-Read
  • id string
  • ignoreProjectTypes array
    • items string
  • isPublishing boolean
  • name required string
  • onboardingCompletedDemos array
    • items string
  • organization Organization-Read
  • plan integer
  • rulesHash string
  • slug string
  • straightRulesCount integer
  • straightRulesUpdatedAt string
  • token string
  • updatedAt string
  • userProjects array
    • items UserProject-Read
  • usersFlattened array
    • items UserProjectFlattened-Read
  • workingVersion RuleSetVersion-Read

Project-Write

• Project-Write object
  • ignoreProjectTypes array
    • items string
  • name required string
  • onboardingCompletedDemos array
    • items string

PublishHistory-Read

• PublishHistory-Read object
  • added integer
  • author User-Read
  • createdAt string
  • deleted integer
  • id string
  • summary string
  • type string
  • updated integer
  • version RuleSetVersion-Read

Rule-Read

• Rule-Read object
  • actions array
    • items string
  • changes array
    • items RuleChange-Read
  • currentChange RuleChange-Read
  • examples array
    • items string
  • formattedSource string
  • id string
  • markers array
    • items Marker-Read
  • matchOnResponseStatus integer
  • rank integer
  • source string
  • updatedAt string
  • viewCount integer

RuleChange-Read

• RuleChange-Read object
  • action required string
  • actions array
    • items string
  • author User-Read
  • createdAt string
  • examples array
    • items string
  • formattedSource string
  • id string
  • markers array
    • items Marker-Read
  • matchOnResponseStatus integer
  • rank required integer
  • ruleId string
  • source required string

RuleChange-Write

• RuleChange-Write object
  • action required string
  • actions array
    • items string
  • examples array
    • items string
  • formattedSource string
  • markers array
    • items Marker-Write
  • matchOnResponseStatus integer
  • rank required integer
  • ruleId string
  • source required string

RuleSetVersion

• RuleSetVersion object
  • createdAt string
  • current boolean
  • id string
  • isSnapshot boolean
  • mergedRulesCount integer
  • name string
  • publishedAt string
  • working boolean

RuleSetVersion-Read

• RuleSetVersion-Read object
  • createdAt string
  • current boolean
  • id string
  • isSnapshot boolean
  • mergedRulesCount integer
  • name string
  • publishedAt string
  • working boolean

RuleStatistic

• RuleStatistic object
  • id string
  • stats string

SmartList

• SmartList object
  • defaultVersion string
  • description string
  • id string
  • name string
  • rules string
  • versions array
    • items string

User

• User object
  • defaultOrganization Organization
  • email required string
  • id string
  • name required string
  • newEmail string
  • newEmailToken string
  • newEmailTokenExpiredAt string
  • password string
  • plainPassword string
  • projectsFlattened array
    • items string
  • superAdmin boolean
  • updatedAt string
  • userOrganizations array
    • items UserOrganization
  • userProjects array
    • items string

User-CreationWrite

• User-CreationWrite object
  • email required string
  • name required string

User-EditInfo

• User-EditInfo object
  • name required string

User-List

• User-List object
  • email required string
  • id string
  • name required string

User-Password

• User-Password object
  • plainPassword string

User-Read

• User-Read object
  • name required string

User-ReadDetails

• User-ReadDetails object
  • name required string

UserOrganization

• UserOrganization object
  • functionalRoles required array
    • items string
  • id string
  • organization string
  • user string

UserOrganization-CreationWrite

• UserOrganization-CreationWrite object
  • functionalRoles required array
    • items string
  • organization string
  • user string

UserOrganization-Read

• UserOrganization-Read object
  • functionalRoles required array
    • items string
  • id string
  • organization string
  • user string

UserOrganization-Write

• UserOrganization-Write object
  • functionalRoles required array
    • items string

UserProject

• UserProject object
  • functionalRoles required array
    • items string
  • id string
  • project required string
  • user required string

UserProject-CreationWrite

• UserProject-CreationWrite object
  • functionalRoles required array
    • items string
  • project required string
  • user required string

UserProject-Read

• UserProject-Read object
  • functionalRoles required array
    • items string
  • id string
  • user required string

UserProject-Write

• UserProject-Write object
  • functionalRoles required array
    • items string

UserProjectFlattened

• UserProjectFlattened object
  • functionalRoles array
    • items string
  • project string
  • user string

UserProjectFlattened-Read

• UserProjectFlattened-Read object
  • functionalRoles array
    • items string
  • user string