Class ContractAPI

Contract API.

The Contract API allows you to manage contracts.

Hierarchy

API
- ContractAPI

Index

Constructors

Methods

checkContractSignature createContractSignature downloadContractSignature listContractSignatures validateContractSignature

Constructors

constructor

new ContractAPI(client: Client): ContractAPI
Parameters
- client: Client
Returns ContractAPI
Inherited from ParentAPI.constructor
- Defined in packages/clients/src/scw/api.ts:9

Methods

checkContractSignature

checkContractSignature(
request: Readonly<Account.v3.ContractApiCheckContractSignatureRequest>,
): Promise<CheckContractSignatureResponse>
Check if a contract is signed for your Organization.
Parameters
- request: Readonly<Account.v3.ContractApiCheckContractSignatureRequest>
  The request ContractApiCheckContractSignatureRequest
Returns Promise<CheckContractSignatureResponse>
A Promise of CheckContractSignatureResponse
- Defined in packages/clients/src/api/account/v3/api.gen.ts:118

createContractSignature

createContractSignature(
request: Readonly<Account.v3.ContractApiCreateContractSignatureRequest>,
): Promise<ContractSignature>
Create a signature for your Organization for the latest version of the requested contract.
Parameters
- request: Readonly<Account.v3.ContractApiCreateContractSignatureRequest>
  The request ContractApiCreateContractSignatureRequest
Returns Promise<ContractSignature>
A Promise of ContractSignature
- Defined in packages/clients/src/api/account/v3/api.gen.ts:73

downloadContractSignature

downloadContractSignature(
request: Readonly<ContractApiDownloadContractSignatureRequest>,
): Promise<Blob>
Download a contract content.
Parameters
- request: Readonly<ContractApiDownloadContractSignatureRequest>
  The request ContractApiDownloadContractSignatureRequest
Returns Promise<Blob>
A Promise of Blob
- Defined in packages/clients/src/api/account/v3/api.gen.ts:55

listContractSignatures

listContractSignatures(
    request?: Readonly<Account.v3.ContractApiListContractSignaturesRequest>,
): Promise<ListContractSignaturesResponse> & {
    "[asyncIterator]": () => AsyncGenerator<ContractSignature[], void, void>;
    all: () => Promise<ContractSignature[]>;
}
List contract signatures for an Organization.
Parameters
- request: Readonly<Account.v3.ContractApiListContractSignaturesRequest> = {}
  The request ContractApiListContractSignaturesRequest
Returns Promise<ListContractSignaturesResponse> & {
"[asyncIterator]": () => AsyncGenerator<ContractSignature[], void, void>;
all: () => Promise<ContractSignature[]>;
}
A Promise of ListContractSignaturesResponse
- Defined in packages/clients/src/api/account/v3/api.gen.ts:167

validateContractSignature

validateContractSignature(
request: Readonly<ContractApiValidateContractSignatureRequest>,
): Promise<ContractSignature>
Sign a contract for your Organization.
Parameters
- request: Readonly<ContractApiValidateContractSignatureRequest>
  The request ContractApiValidateContractSignatureRequest
Returns Promise<ContractSignature>
A Promise of ContractSignature
- Defined in packages/clients/src/api/account/v3/api.gen.ts:98

Class ContractAPI

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ContractAPI

Methods

checkContractSignature

Parameters

Returns Promise<CheckContractSignatureResponse>

createContractSignature

Parameters

Returns Promise<ContractSignature>

downloadContractSignature

Parameters

Returns Promise<Blob>

listContractSignatures

Parameters

Returns Promise<ListContractSignaturesResponse> & {
"[asyncIterator]": () => AsyncGenerator<ContractSignature[], void, void>;
all: () => Promise<ContractSignature[]>;
}

validateContractSignature

Parameters

Returns Promise<ContractSignature>

Settings

On This Page

Class ContractAPI

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ContractAPI

Methods

checkContractSignature

Parameters

Returns Promise<CheckContractSignatureResponse>

createContractSignature

Parameters

Returns Promise<ContractSignature>

downloadContractSignature

Parameters

Returns Promise<Blob>

listContractSignatures

Parameters

Returns Promise<ListContractSignaturesResponse> & { "[asyncIterator]": () => AsyncGenerator<ContractSignature[], void, void>; all: () => Promise<ContractSignature[]>;}

validateContractSignature

Parameters

Returns Promise<ContractSignature>

Settings

On This Page

Returns Promise<ListContractSignaturesResponse> & {
"[asyncIterator]": () => AsyncGenerator<ContractSignature[], void, void>;
all: () => Promise<ContractSignature[]>;
}