sp

Service Provider HTTP Operations

Example

import * as SP from '@filoz/synapse-core/sp'

Namespace	Description
addPieces	-
addPiecesApiRequest	-
createDataSet	-
createDataSetAndAddPieces	-
createDataSetAndAddPiecesApiRequest	-
createDataSetApiRequest	-
deletePiece	-
findPiece	-
getDataSet	-
pullPieces	-
pullPiecesApiRequest	-
schedulePieceDeletion	-
upload	-
uploadPiece	-
uploadPieceStreaming	-
waitForAddPieces	-
waitForCreateDataSet	-
waitForCreateDataSetAddPieces	-
waitForPullPieces	-
waitForPullPiecesApiRequest	-

Type Alias	Description
AddPiecesOutput	-
AddPiecesPending	-
AddPiecesRejected	-
AddPiecesResponse	-
AddPiecesSuccess	-
BasePullPiecesOptions	Base options for pulling pieces.
CreateDataSetAndAddPiecesOptions	-
CreateDataSetPending	-
CreateDataSetRejected	-
CreateDataSetResponse	-
CreateDataSetSuccess	-
DataSet	Data set from the PDP API.
PullPieceInput	Input piece for a pull request with typed PieceCID.
PullToExistingDataSetOptions	Options for pulling pieces into an existing data set.
PullToNewDataSetOptions	Options for creating a new data set and pulling pieces into it.
UploadPieceStreamingData	-

Variable	Description
AddPiecesPendingSchema	-
AddPiecesRejectedSchema	-
AddPiecesSuccessSchema	-
CreateDataSetPendingSchema	Schema for the create data set pending response.
CreateDataSetRejectedSchema	Schema for the create data set rejected response.
CreateDataSetSuccessSchema	Schema for the create data set success response.
DataSetSchema	-

Function	Description
addPieces	Add pieces to a data set
addPiecesApiRequest	Add pieces to a data set on the PDP API.
createDataSet	Create a data set
createDataSetAndAddPieces	Create a data set and add pieces to it
createDataSetAndAddPiecesApiRequest	Create a data set and add pieces to it on PDP API
createDataSetApiRequest	Create a data set on PDP API
deletePiece	Delete a piece from a data set on the PDP API.
findPiece	Find a piece on the PDP API.
~~getDataSet~~	Get a data set from the PDP API.
ping	Ping the PDP API.
pullPieces	Pull pieces from external storage providers into a data set.
pullPiecesApiRequest	Initiate a piece pull request or get status of an existing one.
schedulePieceDeletion	Schedule a piece deletion
upload	Upload multiple pieces to a data set on the PDP API.
uploadPiece	Upload a piece to the PDP API.
uploadPieceStreaming	Upload piece data using the 3-step CommP-last streaming protocol.
waitForAddPieces	Wait for the add pieces status.
waitForCreateDataSet	Wait for the data set creation status.
waitForCreateDataSetAddPieces	Wait for the data set creation status.
waitForPullPieces	Wait for pull pieces completion.
waitForPullPiecesApiRequest	Wait for pull pieces completion API request.