Class API

Fake API.

No Auth Service for end-to-end testing.

Hierarchy

API
- API

Index

Constructors

Methods

createHuman deleteHuman getHuman listHumans register runHuman smokeHuman updateHuman waitForHuman

Constructors

constructor

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

Methods

createHuman

createHuman(request): Promise<Human>
Create a new human.
Parameters
- request: Readonly<CreateHumanRequest>
  The request CreateHumanRequest
Returns Promise<Human>
A Promise of Human
- Defined in packages/clients/src/api/test/v1/api.gen.ts:136

deleteHuman

deleteHuman(request): Promise<Human>
Delete an existing human. Delete the human associated with the given id.
Parameters
- request: Readonly<DeleteHumanRequest>
  The request DeleteHumanRequest
Returns Promise<Human>
A Promise of Human
- Defined in packages/clients/src/api/test/v1/api.gen.ts:174

getHuman

getHuman(request): Promise<Human>
Get human details. Get the human details associated with the given id.
Parameters
- request: Readonly<GetHumanRequest>
  The request GetHumanRequest
Returns Promise<Human>
A Promise of Human
- Defined in packages/clients/src/api/test/v1/api.gen.ts:101

listHumans

listHumans(request?): Promise<ListHumansResponse> & {
[asyncIterator]: (() => AsyncGenerator<Human[], void, void>);
all: (() => Promise<Human[]>);
}
List all your humans.
Parameters
- request: Readonly<ListHumansRequest> = {}
  The request ListHumansRequest
Returns Promise<ListHumansResponse> & {
[asyncIterator]: (() => AsyncGenerator<Human[], void, void>);
all: (() => Promise<Human[]>);
}
A Promise of ListHumansResponse
- Defined in packages/clients/src/api/test/v1/api.gen.ts:92

register

register(request): Promise<RegisterResponse>
Register a user. Register a human and return a access-key and a secret-key that must be used in all other commands.

Hint: you can use other test commands by setting the SCW_SECRET_KEY env variable.
Parameters
- request: Readonly<RegisterRequest>
  The request RegisterRequest
Returns Promise<RegisterResponse>
A Promise of RegisterResponse
- Defined in packages/clients/src/api/test/v1/api.gen.ts:54

runHuman

runHuman(request): Promise<Human>
Start a 1h running for the given human. Start a one hour running for the given human.
Parameters
- request: Readonly<RunHumanRequest>
  The request RunHumanRequest
Returns Promise<Human>
A Promise of Human
- Defined in packages/clients/src/api/test/v1/api.gen.ts:190

smokeHuman

smokeHuman(request): Promise<Human>
Make a human smoke.
Parameters
- request: Readonly<SmokeHumanRequest>
  The request SmokeHumanRequest
Returns Promise<Human>
A Promise of Human

Deprecated
- Defined in packages/clients/src/api/test/v1/api.gen.ts:208

updateHuman

updateHuman(request): Promise<Human>
Update an existing human. Update the human associated with the given id.
Parameters
- request: Readonly<UpdateHumanRequest>
  The request UpdateHumanRequest
Returns Promise<Human>
A Promise of Human
- Defined in packages/clients/src/api/test/v1/api.gen.ts:155

waitForHuman

waitForHuman(request, options?): Promise<Human>
Waits for Human to be in a final state.
Parameters
- request: Readonly<GetHumanRequest>
  The request GetHumanRequest
- Optionaloptions: Readonly<WaitForOptions<Human>>
  The waiting options
Returns Promise<Human>
A Promise of Human
- Defined in packages/clients/src/api/test/v1/api.gen.ts:117