Skip to content

Latest commit

 

History

History

contribly

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
index.js
index.js
 
 
openapi.json
openapi.json
 
 
package.json
package.json
 
 

README.md

@datafire/contribly

Client library for Contribly

Installation and Usage

npm install --save @datafire/contribly
let contribly = require('@datafire/contribly').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

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

Description

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

contribly.oauthCallback({
  "code": ""
}, context)

Input

  • input object
    • code required string

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

contribly.oauthRefresh(null, context)

Input

This action has no parameters

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

artifact_formats.get

List the available artifact formats

contribly.artifact_formats.get(null, context)

Input

This action has no parameters

Output

assignments.get

List assignments

contribly.assignments.get({}, context)

Input

  • input object
    • ownedBy string: Restrict results to assignments owned by this user.
    • page integer: Pagination page
    • pageSize integer: Pagination page size
    • q string: Restrict results to assignments whose name or description matches this keyword.
    • urlWords string: Select an assignment by urlWords.
    • open boolean: Select open or closed assignments
    • alwaysOpen boolean: Select assignments with no closing date.
    • tag string: Restrict results to assignments which are tagged with this tag.
    • name string: Restrict results to the assignment (or potentially assignments) with this exact name

Output

assignments.post

Create a new assignment

contribly.assignments.post({
  "body": {
    "name": ""
  }
}, context)

Input

Output

assignments.id.delete

Delete this assignment and all of it's contributions

contribly.assignments.id.delete({
  "id": ""
}, context)

Input

  • input object
    • id required string: Id of the assignment to return

Output

Output schema unknown

assignments.id.get

Get a single assigment by id

contribly.assignments.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: Id of the assignment to return

Output

change_log.get

The Contribly change log.

contribly.change_log.get(null, context)

Input

This action has no parameters

Output

contribution_refinement_types.get

List valid contribution refinement types

contribly.contribution_refinement_types.get(null, context)

Input

This action has no parameters

Output

  • output array
    • items string

contribution_refinements.get

Given a contribution list query determine the available filter options. Can be used to generate the UI to refinement a filter.

contribly.contribution_refinements.get({}, context)

Input

  • input object
    • assignment string: Restrict results to contributions submitted to this assignment.
    • country string: Limit results to contributions which have a publicly visible location within the given country (specified by two letter country code).
    • createdBefore string: Limit results to contributions created before this date time.
    • createdAfter string: Limit results to contributions created after this date time.
    • geohash string: Restrict results to contributions which have specified a location which falls within this geohash (or comma seperated list of multiple geohashes)
    • hasLocation boolean: Restrict results to contributions which have a publicly visible location.
    • latLong string: Limit results to contributions with location near this latitude and longitude (comma seperated lat/long pair). Also see radius
    • radius number: When limiting result by location with the latLong parameter, specify the radius in kilometers.
    • mediaType string: Restrict results to contributions which include a media file of the given type (ie. image / video)
    • ownedBy string: Restrict results to contributions which are fall under the jurisdiction by this user.
    • q string: Restrict results to contributions whose headline text matches this keyword.
    • urlWords string: Locate a specific contribution by URL words
    • user string: Restrict results to contributions by this user identified by id.
    • refinements string: Comma seperated list of refinement names.
    • refinementSize number: Number of refinement options to return.

Output

  • output object

contributions.get

Retrieve contributions.

contribly.contributions.get({}, context)

Input

  • input object
    • assignment string: Restrict results to contributions submitted to this assignment.
    • country string: Limit results to contributions which have a publicly visible location within the given country (specified by two letter country code).
    • createdBefore string: Limit results to contributions created before this date time.
    • createdAfter string: Limit results to contributions created after this date time.
    • createdDay string: Limit results to contributions created on this day.
    • createdMonth string: Limit results to contributions created during this month.
    • geohash string: Restrict results to contributions which have specified a location which falls within this geohash (or comma seperated list of multiple geohashes)
    • hasLocation boolean: Restrict results to contributions which have a publicly visible location.
    • latLong string: Limit results to contributions with location near this latitude and longitude (comma seperated lat/long pair). Also see radius
    • radius number: When limiting result by location with the latLong parameter, specify the radius in kilometers.
    • mediaType string: Restrict results to contributions which include a media file of the given type (ie. image / video)
    • ownedBy string: Restrict results to contributions which are fall under the jurisdiction by this user.
    • q string: Restrict results to contributions whose headline text matches this keyword.
    • urlWords string: Locate a specific contribution by URL words
    • user string: Restrict results to contributions by this user identified by id.
    • ids string: Restrict results to a list of specific contributions identified by a comma seperated list of ids.
    • format string: Select output format. 'json' or 'rss'. Defaults to JSON.

Output

contributions.post

Create a new contribution

contribly.contributions.post({
  "body": {}
}, context)

Input

Output

contributions.id.delete

Delete this contribution

contribly.contributions.id.delete({
  "id": ""
}, context)

Input

  • input object
    • id required string: Id of the contribution to delete

Output

contributions.id.get

Get a single contribution by id

contribly.contributions.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: Id of the contribution to return

Output

contributions.id.flag.post

Allows end users to bring potential issues with publicly visible content to the attention of moderators.

contribly.contributions.id.flag.post({
  "id": "",
  "body": {}
}, context)

Input

  • input object
    • id required string: Id of the contribution to flag
    • body required Flag

Output

contributions.id.like.post

Allows a user to mark a contribution as liked

contribly.contributions.id.like.post({
  "id": ""
}, context)

Input

  • input object
    • id required string: Id of the contribution

Output

  • output number

contributions.id.likes.get

Returns a list of user ids of users who have liked this conribution

contribly.contributions.id.likes.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: Id of the contribution

Output

  • output array
    • items string

contributions.id.moderate.post

Allows the contribution to approved of rejected.

contribly.contributions.id.moderate.post({
  "id": "",
  "body": {}
}, context)

Input

Output

  • output string

credentials.get

List the credentials associated with the authenticated user.

contribly.credentials.get(null, context)

Input

This action has no parameters

Output

event_types.get

List available notification event types

contribly.event_types.get(null, context)

Input

This action has no parameters

Output

export.post

Begin an export job. Returns a export job which can be polled to follow the progress of an export.

contribly.export.post({}, context)

Input

  • input object
    • assignment string: Restrict results to contributions submitted to this assignment.
    • country string: Limit results to contributions which have a publicly visible location within the given country (specified by two letter country code).
    • createdBefore string: Limit results to contributions created before this date time.
    • createdAfter string: Limit results to contributions created after this date time.
    • geohash string: Restrict results to contributions which have specified a location which falls within this geohash (or comma seperated list of multiple geohashes)
    • hasLocation boolean: Restrict results to contributions which have a publicly visible location.
    • latLong string: Limit results to contributions with location near this latitude and longitude (comma seperated lat/long pair). Also see radius
    • radius number: When limiting result by location with the latLong parameter, specify the radius in kilometers.
    • mediaType string: Restrict results to contributions which include a media file of the given type (ie. image / video)
    • ownedBy string: Restrict results to contributions which are fall under the jurisdiction by this user.
    • q string: Restrict results to contributions whose headline text matches this keyword.
    • urlWords string: Locate a specific contribution by URL words
    • user string: Restrict results to contributions by this user identified by id.
    • tagged boolean: Should exported media files be tagged with metadata. Deprecated; use format instead.
    • combined boolean: Included a combined file with all contribution text.
    • individual boolean: Include individual text files for each contribution.
    • format string: Media format to export; none, fullsize, tagged or original.
    • json boolean: Include raw JSON for each contribution.

Output

export_summary.post

Provide a preflight summary of an export request.

contribly.export_summary.post({}, context)

Input

  • input object
    • assignment string: Restrict results to contributions submitted to this assignment.
    • country string: Limit results to contributions which have a publicly visible location within the given country (specified by two letter country code).
    • createdBefore string: Limit results to contributions created before this date time.
    • createdAfter string: Limit results to contributions created after this date time.
    • geohash string: Restrict results to contributions which have specified a location which falls within this geohash (or comma seperated list of multiple geohashes)
    • hasLocation boolean: Restrict results to contributions which have a publicly visible location.
    • latLong string: Limit results to contributions with location near this latitude and longitude (comma seperated lat/long pair). Also see radius
    • radius number: When limiting result by location with the latLong parameter, specify the radius in kilometers.
    • mediaType string: Restrict results to contributions which include a media file of the given type (ie. image / video)
    • ownedBy string: Restrict results to contributions which are fall under the jurisdiction by this user.
    • q string: Restrict results to contributions whose headline text matches this keyword.
    • urlWords string: Locate a specific contribution by URL words
    • user string: Restrict results to contributions by this user identified by id.

Output

exports.id.get

Get a single export job; poll to follow export progress.

contribly.exports.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: Id of the export job to return

Output

form_responses.get

List form responses

contribly.form_responses.get({}, context)

Input

  • input object
    • user string: Restrict results to responses submitted by this user.
    • form string: Restrict results to responses submitted to this form.
    • contribution string: Restrict results to responses relating to this contribution.

Output

form_responses.post

Submit a response to a form

contribly.form_responses.post({
  "body": {}
}, context)

Input

Output

form_responses.id.get

Get a single form response by id

contribly.form_responses.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: Id of the assignment to return

Output

forms.get

List forms

contribly.forms.get({
  "ownedBy": ""
}, context)

Input

  • input object
    • ownedBy required string: Restrict results to forms owned by this user.

Output

  • output array

forms.post

Create a form

contribly.forms.post({
  "body": {}
}, context)

Input

Output

forms.id.delete

Delete this form and all of it's responses.

contribly.forms.id.delete({
  "id": ""
}, context)

Input

  • input object
    • id required string: Id of the form to delete

Output

Output schema unknown

forms.id.get

Get a single form by id

contribly.forms.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: Id of the form to return

Output

media.post

Submit a new media file

contribly.media.post({
  "body": ""
}, context)

Input

  • input object
    • body required string

Output

notifications.contributions.id.preview.get

contribly.notifications.contributions.id.preview.get({
  "id": "",
  "message": ""
}, context)

Input

  • input object
    • id required string: Id of the contribution to preview a notification for
    • message required string: Type of message to preview.

Output

scopes.get

List available token scopes

contribly.scopes.get(null, context)

Input

This action has no parameters

Output

  • output array
    • items string

subscription_types.get

List available subscription types

contribly.subscription_types.get(null, context)

Input

This action has no parameters

Output

subscriptions.get

List subscriptions for the authorised user.

contribly.subscriptions.get({
  "body": {
    "types": [],
    "includeBody": true
  }
}, context)

Input

Output

subscriptions.id.delete

Delete a subscription.

contribly.subscriptions.id.delete({
  "id": ""
}, context)

Input

  • input object
    • id required string: Id of the subscription to delete

Output

Output schema unknown

tags.get

Retrieve tags.

contribly.tags.get({}, context)

Input

  • input object
    • ownedBy string: Restrict results to those owned by this user.
    • tagSet string: Restrict results to tags belonging to this tag set.
    • urlWords string: Restrict results by urlWords. Should be used with ownedBy when searching for one of your own tags.

Output

  • output array

tags.post

Create a new tag

contribly.tags.post({
  "body": {
    "name": ""
  }
}, context)

Input

Output

tags.id.get

Retrieve a single tag by id

contribly.tags.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: Id of the tag to return

Output

tagsets.get

Retrieve tag sets.

contribly.tagsets.get({}, context)

Input

  • input object
    • ownedBy string: Restrict results to those owned by this user.
    • urlWords string: Restrict results by urlWords. Should be used with ownedBy when searching for one of your own tag sets.

Output

tagsets.post

Create a new tag set

contribly.tagsets.post({
  "body": {
    "name": "",
    "urlWords": ""
  }
}, context)

Input

Output

tagsets.id.get

Retrieve a single tag set by id

contribly.tagsets.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: Id of the tag set to return

Output

users.get

List users

contribly.users.get({}, context)

Input

  • input object
    • assignment string: Restrict results to the users who have contributed to this assignment.
    • country string: Restrict results to the users who have submitted a contribution with a public location located within this country.
    • minimumContributions number: Restrict results to the users who have submitted at least this many contributions.
    • linkedProfile string: Restrict results to the users who a linked profile of this type.
    • ownedBy string: Restrict results to the users who are owned by of this owner.
    • submittedBefore string: Limit results to users who have submitted at least one contribution before this date time.
    • submittedAfter string: Limit results to users who have submitted at least one contribution after this date time.
    • username string: Restrict results to the user with this username.

Output

  • output array

users.id.get

Retrieve a single user by id

contribly.users.id.get({
  "id": ""
}, context)

Input

  • input object
    • id required string: Id of the user to return

Output

users.id.linked.type.get

Retrieve a users linked profile by type

contribly.users.id.linked.type.get({
  "id": "",
  "type": ""
}, context)

Input

  • input object
    • id required string: Id of the user to return
    • type required string: Type of the linked profile to fetch

Output

verify.post

Verify token and return details of the owning user

contribly.verify.post(null, context)

Input

This action has no parameters

Output

Definitions

Artifact

  • Artifact object
    • contentLength number
    • contentType string
    • height number
    • label string
    • url string
    • width number

ArtifactFormat

  • ArtifactFormat object
    • contentType string
    • fileExtension string
    • forContentType string
    • label string
    • preserveAspectRatio boolean
    • public boolean
    • upscaleAllowed boolean

ArtifactFormats

Assignment

  • Assignment object
    • allowsAnonymousContributions boolean
    • callToAction string: An optional call to action specific to this assignment. ie. Submit your snow pictures.
    • cover MediaUsage
    • created string
    • description string
    • embargo string
    • ends string
    • featured boolean
    • id string
    • mediaRequired boolean
    • moderator string: Optional credential id of the moderator who owns this particular assignment.
    • name string
    • open boolean: Helper value. Is this assignment currently open? Based on the value of the ends field.
    • receiptMessage string: An optional assignment specific message to be displayed on successful contribution submission. For example, this might be used to inform contributors of assignment specific moderation time frames.
    • starts string
    • tags array
    • urlWords string
    • webUrl string

AssignmentSubmission

  • AssignmentSubmission object
    • allowsAnonymousContributions boolean
    • cover MediaUsage
    • description string
    • embargo string
    • ends string
    • featured boolean
    • id string
    • mediaRequired boolean
    • moderator string: Optional credential id of the login which will moderator this assignment.
    • name required string
    • receiptMessage string: An optional assignment specific message to be displayed on successful contribution submission. For example, this might be used to inform contributors of assignment specific moderation time frames.
    • starts string
    • tags array
    • urlWords string

Authority

  • Authority object

ChangeLogItem

  • ChangeLogItem object
    • date required string
    • description string
    • title required string

Client

  • Client object
    • id string
    • name string

Contribution

  • Contribution object
    • assignment Assignment
    • attribution string: The public attribution for this contribution. This will be the display name of the registered user or the contributor's first and last name if they provided them while making a non authenticated contribution. A blank attribution field indicates and anonymous contribution.
    • body string
    • created string
    • headline string
    • id string
    • mediaUsages array
    • moderationHistory array
    • place Place
    • urlWords string
    • via Via

Credential

  • Credential object
    • scopes array
      • items string
    • type string
    • user string
    • value string

ErrorField

  • ErrorField object
    • message string
    • name required string

ErrorResponse

  • ErrorResponse object

EventType

  • EventType object
    • id required string
    • name required string

Export

  • Export object
    • downloadUrl string
    • finished string
    • id required string
    • owner required string
    • progress number
    • started required string
    • step string

ExportSummary

  • ExportSummary object
    • contributions required number: The number of contributions selected for export.
    • estimatedSize string: Human readable estimate of the export size. ie. '10MB'.
    • media required number: The number of media files included in this export.
    • totalMediaSize required number: The expected total size of the media files to be exported.

Flag

  • Flag object
    • date string
    • email string
    • id string
    • notes string
    • type string

Form

  • Form object
    • callToAction string
    • cssUrl string
    • fields array
    • heading string
    • id string
    • name string
    • noCss boolean
    • ownedBy string
    • tags array

FormField

  • FormField object
    • description string
    • label string
    • name string
    • options array
      • items string
    • public boolean
    • required boolean
    • type string

FormResponse

  • FormResponse object
    • contribution string
    • date string
    • form string
    • id string
    • responses object
    • user string

FormResponseSubmission

  • FormResponseSubmission object
    • contribution string
    • form string
    • responses object

FormSubmission

  • FormSubmission object
    • callToAction string
    • cssUrl string
    • fields array
    • heading string
    • name string
    • noCss boolean
    • tags array

Group

  • Group object
    • id string
    • name string

LatLong

  • LatLong object
    • latitude number
    • longitude number

LinkedProfile

  • LinkedProfile object
    • bio string
    • email string
    • id string
    • name string
    • picture string
    • profile string
    • registered string

Media

  • Media object
    • duration number
    • id string
    • place Place
    • type string

MediaUsage

  • MediaUsage object

ModerationAction

  • ModerationAction object
    • id required string
    • label required string
    • resultingState required ModerationState

ModerationHistoryItem

  • ModerationHistoryItem object

ModerationHistoryItemSubmission

ModerationState

  • ModerationState object
    • id required string
    • label required string
    • public required boolean

NotificationPreview

  • NotificationPreview object
    • email string
    • html string
    • subject string

OsmId

  • OsmId object
    • osmId number
    • osmType string

Place

  • Place object
    • country string
    • geohash string
    • google string
    • latLong LatLong
    • name string
    • osm OsmId

Subscription

  • Subscription object
    • assignment string
    • email string
    • id required string
    • includeBody required boolean
    • includeThumbenail boolean
    • slackChannel string
    • token required string
    • types required array
      • items string
    • user required string

SubscriptionSubmission

  • SubscriptionSubmission object
    • assignment string
    • email string
    • includeBody required boolean
    • includeThumbenail boolean
    • slackChannel string
    • types required array
      • items string

SubscriptionType

  • SubscriptionType object
    • id required string
    • name required string

Tag

  • Tag object
    • colour string: Optional HTML hexcode colour
    • id required string
    • name required string
    • tagSet TagSet
    • urlWords string

TagSet

  • TagSet object
    • id required string
    • name required string

TagSetSubmission

  • TagSetSubmission object
    • name required string
    • urlWords required string

TagSubmission

  • TagSubmission object
    • colour string
    • name required string
    • tagSet TagSet
    • urlWords string

User

  • User object
    • bio string
    • displayName string
    • id string
    • registered string
    • username string

Via

  • Via object