Class RpnV1API

Dedibox Phoenix RPN v1 API.

Hierarchy

API
- RpnV1API

Index

Constructors

Methods

acceptRpnInvite addRpnGroupMembers createRpnGroup deleteRpnGroup deleteRpnGroupMembers getRpnGroup leaveRpnGroup listRpnCapableSanServers listRpnCapableServers listRpnGroupMembers listRpnGroups listRpnInvites refuseRpnInvite rpnGroupInvite updateRpnGroupName

Constructors

constructor

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

Methods

acceptRpnInvite

acceptRpnInvite(request): Promise<void>
Parameters
- request: Readonly<Dedibox.v1.RpnV1ApiAcceptRpnInviteRequest>
Returns Promise<void>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1808

addRpnGroupMembers

addRpnGroupMembers(request): Promise<RpnGroup>
Parameters
- request: Readonly<Dedibox.v1.RpnV1ApiAddRpnGroupMembersRequest>
Returns Promise<RpnGroup>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1695

createRpnGroup

createRpnGroup(request): Promise<RpnGroup>
Parameters
- request: Readonly<RpnV1ApiCreateRpnGroupRequest>
Returns Promise<RpnGroup>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1616

deleteRpnGroup

deleteRpnGroup(request): Promise<void>
Parameters
- request: Readonly<Dedibox.v1.RpnV1ApiDeleteRpnGroupRequest>
Returns Promise<void>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1629

deleteRpnGroupMembers

deleteRpnGroupMembers(request): Promise<RpnGroup>
Parameters
- request: Readonly<Dedibox.v1.RpnV1ApiDeleteRpnGroupMembersRequest>
Returns Promise<RpnGroup>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1711

getRpnGroup

getRpnGroup(request): Promise<RpnGroup>
Parameters
- request: Readonly<Dedibox.v1.RpnV1ApiGetRpnGroupRequest>
Returns Promise<RpnGroup>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1607

leaveRpnGroup

leaveRpnGroup(request): Promise<void>
Parameters
- request: Readonly<Dedibox.v1.RpnV1ApiLeaveRpnGroupRequest>
Returns Promise<void>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1685

listRpnCapableSanServers

listRpnCapableSanServers(request?): Promise<ListRpnCapableSanServersResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnSanServer[], void, void>);
all: (() => Promise<RpnSanServer[]>);
}
Parameters
- request: Readonly<Dedibox.v1.RpnV1ApiListRpnCapableSanServersRequest> = {}
Returns Promise<ListRpnCapableSanServersResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnSanServer[], void, void>);
all: (() => Promise<RpnSanServer[]>);
}
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1773

listRpnCapableServers

listRpnCapableServers(request?): Promise<ListRpnCapableServersResponse> & {
[asyncIterator]: (() => AsyncGenerator<Dedibox.v1.Server[], void, void>);
all: (() => Promise<Dedibox.v1.Server[]>);
}
Parameters
- request: Readonly<Dedibox.v1.RpnV1ApiListRpnCapableServersRequest> = {}
Returns Promise<ListRpnCapableServersResponse> & {
[asyncIterator]: (() => AsyncGenerator<Dedibox.v1.Server[], void, void>);
all: (() => Promise<Dedibox.v1.Server[]>);
}
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1749

listRpnGroupMembers

listRpnGroupMembers(request): Promise<ListRpnGroupMembersResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnGroupMember[], void, void>);
all: (() => Promise<RpnGroupMember[]>);
}
Parameters
- request: Readonly<Dedibox.v1.RpnV1ApiListRpnGroupMembersRequest>
Returns Promise<ListRpnGroupMembersResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnGroupMember[], void, void>);
all: (() => Promise<RpnGroupMember[]>);
}
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1671

listRpnGroups

listRpnGroups(request?): Promise<ListRpnGroupsResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnGroup[], void, void>);
all: (() => Promise<RpnGroup[]>);
}
Parameters
- request: Readonly<Dedibox.v1.RpnV1ApiListRpnGroupsRequest> = {}
Returns Promise<ListRpnGroupsResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnGroup[], void, void>);
all: (() => Promise<RpnGroup[]>);
}
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1604

listRpnInvites

listRpnInvites(request?): Promise<ListRpnInvitesResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnGroupMember[], void, void>);
all: (() => Promise<RpnGroupMember[]>);
}
Parameters
- request: Readonly<Dedibox.v1.RpnV1ApiListRpnInvitesRequest> = {}
Returns Promise<ListRpnInvitesResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnGroupMember[], void, void>);
all: (() => Promise<RpnGroupMember[]>);
}
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1805

refuseRpnInvite

refuseRpnInvite(request): Promise<void>
Parameters
- request: Readonly<Dedibox.v1.RpnV1ApiRefuseRpnInviteRequest>
Returns Promise<void>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1814

rpnGroupInvite

rpnGroupInvite(request): Promise<void>
Parameters
- request: Readonly<Dedibox.v1.RpnV1ApiRpnGroupInviteRequest>
Returns Promise<void>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1675

updateRpnGroupName

updateRpnGroupName(request): Promise<RpnGroup>
Parameters
- request: Readonly<Dedibox.v1.RpnV1ApiUpdateRpnGroupNameRequest>
Returns Promise<RpnGroup>
- Defined in packages/clients/src/api/dedibox/v1/api.gen.ts:1635

Class RpnV1API

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns RpnV1API

Methods

acceptRpnInvite

Parameters

Returns Promise<void>

addRpnGroupMembers

Parameters

Returns Promise<RpnGroup>

createRpnGroup

Parameters

Returns Promise<RpnGroup>

deleteRpnGroup

Parameters

Returns Promise<void>

deleteRpnGroupMembers

Parameters

Returns Promise<RpnGroup>

getRpnGroup

Parameters

Returns Promise<RpnGroup>

leaveRpnGroup

Parameters

Returns Promise<void>

listRpnCapableSanServers

Parameters

Returns Promise<ListRpnCapableSanServersResponse> & { [asyncIterator]: (() => AsyncGenerator<RpnSanServer[], void, void>); all: (() => Promise<RpnSanServer[]>); }

listRpnCapableServers

Parameters

Returns Promise<ListRpnCapableServersResponse> & { [asyncIterator]: (() => AsyncGenerator<Dedibox.v1.Server[], void, void>); all: (() => Promise<Dedibox.v1.Server[]>); }

listRpnGroupMembers

Parameters

Returns Promise<ListRpnGroupMembersResponse> & { [asyncIterator]: (() => AsyncGenerator<RpnGroupMember[], void, void>); all: (() => Promise<RpnGroupMember[]>); }

listRpnGroups

Parameters

Returns Promise<ListRpnGroupsResponse> & { [asyncIterator]: (() => AsyncGenerator<RpnGroup[], void, void>); all: (() => Promise<RpnGroup[]>); }

listRpnInvites

Parameters

Returns Promise<ListRpnInvitesResponse> & { [asyncIterator]: (() => AsyncGenerator<RpnGroupMember[], void, void>); all: (() => Promise<RpnGroupMember[]>); }

refuseRpnInvite

Parameters

Returns Promise<void>

rpnGroupInvite

Parameters

Returns Promise<void>

updateRpnGroupName

Parameters

Returns Promise<RpnGroup>

Settings

On This Page

Returns Promise<ListRpnCapableSanServersResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnSanServer[], void, void>);
all: (() => Promise<RpnSanServer[]>);
}

Returns Promise<ListRpnCapableServersResponse> & {
[asyncIterator]: (() => AsyncGenerator<Dedibox.v1.Server[], void, void>);
all: (() => Promise<Dedibox.v1.Server[]>);
}

Returns Promise<ListRpnGroupMembersResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnGroupMember[], void, void>);
all: (() => Promise<RpnGroupMember[]>);
}

Returns Promise<ListRpnGroupsResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnGroup[], void, void>);
all: (() => Promise<RpnGroup[]>);
}

Returns Promise<ListRpnInvitesResponse> & {
[asyncIterator]: (() => AsyncGenerator<RpnGroupMember[], void, void>);
all: (() => Promise<RpnGroupMember[]>);
}