Skip to main content

Share API

All URIs are relative to http://localhost:1000

MethodHTTP requestDescription
shareScoresIncrementPOST /share/{share}/scores/increment'/share/{share}/scores/increment' [POST]
shareSnapshotGET /share/{share}/share/{share}
shareUpdatePOST /share/update/share/update [POST]

shareScoresIncrement

shareScoresIncrement()

This will take in a SeededScoreIncrement and will increment the material relative to the incoming body.

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.ShareApi(configuration)

const body: Pieces.ShareScoresIncrementRequest = {
// string | Share id
share: share_example,
// SeededScoreIncrement (optional)
seededScoreIncrement: ,
};

apiInstance.shareScoresIncrement(body).then((data: void (empty response body)) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
seededScoreIncrementSeededScoreIncrement
share[string]Share iddefaults to undefined

Return type

void (empty response body)

HTTP request headers

  • Content-Type: application/json
  • Accept: text/plain

HTTP response details

Status codeDescriptionResponse headers
204No Content-
500Internal Server Error-

shareSnapshot

Share shareSnapshot()

Get the snapshot of a specific share.

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.ShareApi(configuration)

const body: Pieces.ShareSnapshotRequest = {
// string | Share id
share: share_example,
// boolean | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional)
transferables: true,
};

apiInstance.shareSnapshot(body).then((data: Share) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
share[string]Share iddefaults to undefined
transferables[boolean]This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)(optional) defaults to undefined

Return type

Share

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-

shareUpdate

Share shareUpdate()

This endpoint will accept a Share that the user wants to update, and will return a full Share that was updated!

Example

import * as Pieces from '@pieces.app/pieces-os-client'

const configuration = Pieces.Configuration()
const apiInstance = new Pieces.ShareApi(configuration)

const body: Pieces.ShareUpdateRequest = {
// boolean | This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement) (optional)
transferables: true,
// Share | This is the Share that needs to be updated. (optional)
share: ,
};

apiInstance.shareUpdate(body).then((data: Share) => {
console.log('API called successfully. Returned data: ' + data)
}).catch((error: unknown) => console.error(error))

Parameters

NameTypeDescriptionNotes
shareShareThis is the Share that needs to be updated.
transferables[boolean]This is a boolean that will decided if we are want to return the transferable data (default) or not(performance enhancement)(optional) defaults to undefined

Return type

Share

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200OK-