Class ContractsApiWrapper

constructor

• new ContractsApiWrapper(accessToken, basePath?): ContractsApiWrapper

• Parameters

  • accessToken: string
  • Optional basePath: string

  Returns ContractsApiWrapper

Static type

create

• create(req): Promise<ContractResponse>

• Creates a contract object.

  Parameters

  • req: CreateContractRequest

    Parameters to create contract

  Returns Promise<ContractResponse>

delete

• delete(id): Promise<ContractDeleteResponse>

• Deletes a contract object.

  Parameters

  • id: string

    Id of the contract to delete

  Returns Promise<ContractDeleteResponse>

get

• get(req): Promise<ContractResponse>

• Retrieves the details of an existing contract. Supply the unique contract ID from either a contract creation request or the contract list, and Openfort will return the corresponding contract information.

  Parameters

  • req: GetContractRequest

    Criteria to get the contract.

  Returns Promise<ContractResponse>

list

• list(req?): Promise<ContractListResponse>

• Returns a list of your contracts. The contracts are returned sorted by creation date, with the most recently created contracts appearing first.

  Parameters

  • Optional req: ContractListQueries

    Criteria to retrieve list of contracts.

  Returns Promise<ContractListResponse>

read

• read(req): Promise<ContractReadResponse>

• Read on chain contract data.

  Parameters

  • req: ReadContractRequest

    Parameters to get the contract data

  Returns Promise<ContractReadResponse>

update

• update(req): Promise<ContractResponse>

• Updates a contract object.

  Parameters

  • req: UpdateContractRequest

    Parameters to update the contract

  Returns Promise<ContractResponse>