Type alias ContractInvocationAPIClient

ContractInvocationAPIClient: {
    broadcastContractInvocation(walletId, addressId, contractInvocationId, broadcastContractInvocationRequest, options?): AxiosPromise<ContractInvocation>;
    createContractInvocation(walletId, addressId, createContractInvocationRequest, options?): AxiosPromise<ContractInvocation>;
    getContractInvocation(walletId, addressId, contractInvocationId, options?): AxiosPromise<ContractInvocation>;
    listContractInvocations(walletId, addressId, limit?, page?, options?): AxiosPromise<ContractInvocationList>;
}

ContractInvocationAPI client type definition.

Type declaration

  • broadcastContractInvocation:function
    • broadcastContractInvocation(walletId, addressId, contractInvocationId, broadcastContractInvocationRequest, options?): AxiosPromise<ContractInvocation>

    • Broadcasts a contract invocation.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the contract invocation belongs to.

      • contractInvocationId: string

        The ID of the contract invocation to broadcast.

      • broadcastContractInvocationRequest: BroadcastContractInvocationRequest

        The request body.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<ContractInvocation>

      • A promise resolving to the ContractInvocation model.

      Throws

      If the request fails.

  • createContractInvocation:function
    • createContractInvocation(walletId, addressId, createContractInvocationRequest, options?): AxiosPromise<ContractInvocation>

    • Creates a Contract Invocation.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the contract invocation belongs to.

      • createContractInvocationRequest: CreateContractInvocationRequest

        The request body.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<ContractInvocation>

      • A promise resolving to the ContractInvocation model.

      Throws

      If the request fails.

  • getContractInvocation:function
    • getContractInvocation(walletId, addressId, contractInvocationId, options?): AxiosPromise<ContractInvocation>

    • Retrieves a Contract Invocation.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the contract invocation belongs to.

      • contractInvocationId: string

        The ID of the contract invocation to retrieve.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<ContractInvocation>

      • A promise resolving to the ContractInvocation model.

      Throws

      If the request fails.

  • listContractInvocations:function
    • listContractInvocations(walletId, addressId, limit?, page?, options?): AxiosPromise<ContractInvocationList>

    • Lists Contract Invocations.

      Parameters

      • walletId: string

        The ID of the wallet the address belongs to.

      • addressId: string

        The ID of the address the contract invocations belong to.

      • Optional limit: number

        The maximum number of contract invocations to return.

      • Optional page: string

        The cursor for pagination across multiple pages of contract invocations.

      • Optional options: AxiosRequestConfig<any>

        Axios request options.

      Returns AxiosPromise<ContractInvocationList>

      • A promise resolving to the ContractInvocation list.

      Throws

      If the request fails.

Settings

Member Visibility

Theme