Partner interface

Interface representing a Partner.

Methods

create(string, PartnerCreateOptionalParams)

Create a management partner for the objectId and tenantId.

delete(string, PartnerDeleteOptionalParams)

Delete the management partner for the objectId and tenantId.

get(string, PartnerGetOptionalParams)

Get the management partner using the partnerId, objectId and tenantId.

update(string, PartnerUpdateOptionalParams)

Update the management partner for the objectId and tenantId.

Method Details

create(string, PartnerCreateOptionalParams)

Create a management partner for the objectId and tenantId.

function create(partnerId: string, options?: PartnerCreateOptionalParams): Promise<PartnerResponse>

Parameters

partnerId

string

Id of the Partner

options
PartnerCreateOptionalParams

The options parameters.

Returns

Promise<PartnerResponse>

delete(string, PartnerDeleteOptionalParams)

Delete the management partner for the objectId and tenantId.

function delete(partnerId: string, options?: PartnerDeleteOptionalParams): Promise<void>

Parameters

partnerId

string

Id of the Partner

options
PartnerDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, PartnerGetOptionalParams)

Get the management partner using the partnerId, objectId and tenantId.

function get(partnerId: string, options?: PartnerGetOptionalParams): Promise<PartnerResponse>

Parameters

partnerId

string

Id of the Partner

options
PartnerGetOptionalParams

The options parameters.

Returns

Promise<PartnerResponse>

update(string, PartnerUpdateOptionalParams)

Update the management partner for the objectId and tenantId.

function update(partnerId: string, options?: PartnerUpdateOptionalParams): Promise<PartnerResponse>

Parameters

partnerId

string

Id of the Partner

options
PartnerUpdateOptionalParams

The options parameters.

Returns

Promise<PartnerResponse>