saasy-sdk v0.8.16

Saasy SDK Documentation

This documentation provides a comprehensive guide to using the provided Saasy SDK. The SDK includes several functions for interacting with the agreement notary system. Each function is described below, along with their input parameters and return types.

Server Side SDK

Constructor

constructor(apiKey: string, production?: boolean)

Creates an instance of the server side SDK.

Parameters:

• apiKey: string - The API key to be used for making requests.
• production: boolean - if true notary api is gonna be production.

Here's an example of how to initialize the server side SDK in a Node.js application:

const sdk = new SaaSySDKServer(API_KEY);

In this example, API_KEY is your organization API key

createAgreement()

createAgreement( agreementData: CreateAgreementData | CreateYugaAgreementData, expectedAgreementHash: string, onchain_offerer_signature: string): Promise<CreatedAgreementData>

Creates a new agreement by sending the agreement data to the notary, before calling this method you need to call the method "signCreateAgreement" inside the SaaSySDKClient wich will return "expectedAgreementHash" and "onchain_offerer_signature".

Parameters:

• agreementData: CreateAgreementData | CreateYugaAgreementData - The agreement data.
• expectedAgreementHash:string - The expected agreementHash.
• onchain_offerer_signature: string | CreateYugaAgreementData - signature hash.

Returns: A Promise that resolves with the created agreement data. It throws an Error if there is an error creating the agreement.

getPDFBytes()

getPDFBytes(agreementHash: string): Promise<Uint8Array>

Retrieves the PDF bytes associated with the given agreement hash from the file service.

Parameters:

• agreementHash: string - The agreement hash.

Returns: A Promise that resolves with the PDF bytes as a Uint8Array. It throws an Error if there is an error getting the PDF bytes.

getAgreements()

getAgreements(searchCriteria: SearchAgreements): Promise<AgreementDataWithHash[]>

Retrieves a list of agreements based on the provided search criteria.

Parameters:

• searchCriteria: SearchAgreements - The search criteria for filtering the agreements.

Returns: A Promise that resolves with an array of AgreementDataWithHash objects representing the agreements. It throws an Error if there is an error retrieving the agreements.

counterSignAgreement()

counterSignAgreement(countersignAgreementData: CounterSignAgreementData): Promise<Agreement>

Performs the counter-signing of an agreement by sending the countersign agreement data to the notary and updating the agreement on-chain.

Parameters:

• countersignAgreementData: CounterSignAgreementData - The countersign agreement data.

Returns: A Promise that resolves with the updated Agreement object. It throws an Error if there is an error counter-signing the agreement or initializing GSN.