Class AliasApi

Hierarchy (View Summary)

BaseAPI
- AliasApi

Constructors

constructor

new AliasApi(configuration?: Configuration): AliasApi
Parameters
- configuration: Configuration = DefaultConfig
Returns AliasApi
Inherited from BaseAPI.constructor
- Defined in sdk/runtime.ts:104

Properties

`Protected`configuration

configuration: Configuration = DefaultConfig

Methods

createContact

createContact(
requestParameters: CreateContactRequest,
initOverrides?: any,
): Promise<AliasAliasIdContacts>
Create a new contact for an alias by id. Create contact
Parameters
- requestParameters: CreateContactRequest
- OptionalinitOverrides: any
Returns Promise<AliasAliasIdContacts>
- Defined in sdk/apis/AliasApi.ts:200

createContactRaw

createContactRaw(
requestParameters: CreateContactRequest,
initOverrides?: any,
): Promise<ApiResponse<AliasAliasIdContacts>>
Create a new contact for an alias by id. Create contact
Parameters
- requestParameters: CreateContactRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<AliasAliasIdContacts>>
- Defined in sdk/apis/AliasApi.ts:156

createCustomAlias

createCustomAlias(
requestParameters: CreateCustomAliasRequest,
initOverrides?: any,
): Promise<Alias>
Create a new custom alias Create custom alias
Parameters
- requestParameters: CreateCustomAliasRequest
- OptionalinitOverrides: any
Returns Promise<Alias>
- Defined in sdk/apis/AliasApi.ts:249

createCustomAliasRaw

createCustomAliasRaw(
requestParameters: CreateCustomAliasRequest,
initOverrides?: any,
): Promise<ApiResponse<Alias>>
Create a new custom alias Create custom alias
Parameters
- requestParameters: CreateCustomAliasRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<Alias>>
- Defined in sdk/apis/AliasApi.ts:209

createRandomAlias

createRandomAlias(
requestParameters: CreateRandomAliasRequest,
initOverrides?: any,
): Promise<Alias>
Create a new random alias Create random alias
Parameters
- requestParameters: CreateRandomAliasRequest
- OptionalinitOverrides: any
Returns Promise<Alias>
- Defined in sdk/apis/AliasApi.ts:302

createRandomAliasRaw

createRandomAliasRaw(
requestParameters: CreateRandomAliasRequest,
initOverrides?: any,
): Promise<ApiResponse<Alias>>
Create a new random alias Create random alias
Parameters
- requestParameters: CreateRandomAliasRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<Alias>>
- Defined in sdk/apis/AliasApi.ts:258

deleteAlias

deleteAlias(
requestParameters: DeleteAliasRequest,
initOverrides?: any,
): Promise<AliasAliasIdDelete>
Delete specific alias by id. Delete alias
Parameters
- requestParameters: DeleteAliasRequest
- OptionalinitOverrides: any
Returns Promise<AliasAliasIdDelete>
- Defined in sdk/apis/AliasApi.ts:345

deleteAliasRaw

deleteAliasRaw(
requestParameters: DeleteAliasRequest,
initOverrides?: any,
): Promise<ApiResponse<AliasAliasIdDelete>>
Delete specific alias by id. Delete alias
Parameters
- requestParameters: DeleteAliasRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<AliasAliasIdDelete>>
- Defined in sdk/apis/AliasApi.ts:311

deleteContact

deleteContact(
requestParameters: DeleteContactRequest,
initOverrides?: any,
): Promise<ContactsContactIdDelete>
Delete a contact by id. Delete contact
Parameters
- requestParameters: DeleteContactRequest
- OptionalinitOverrides: any
Returns Promise<ContactsContactIdDelete>
- Defined in sdk/apis/AliasApi.ts:388

deleteContactRaw

deleteContactRaw(
requestParameters: DeleteContactRequest,
initOverrides?: any,
): Promise<ApiResponse<ContactsContactIdDelete>>
Delete a contact by id. Delete contact
Parameters
- requestParameters: DeleteContactRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<ContactsContactIdDelete>>
- Defined in sdk/apis/AliasApi.ts:354

getActivities

getActivities(
requestParameters: GetActivitiesRequest,
initOverrides?: any,
): Promise<AliasAliasIdActivitiesModelArray>
Get activities for specific alias by id. Get activities
Parameters
- requestParameters: GetActivitiesRequest
- OptionalinitOverrides: any
Returns Promise<AliasAliasIdActivitiesModelArray>
- Defined in sdk/apis/AliasApi.ts:442

getActivitiesRaw

getActivitiesRaw(
requestParameters: GetActivitiesRequest,
initOverrides?: any,
): Promise<ApiResponse<AliasAliasIdActivitiesModelArray>>
Get activities for specific alias by id. Get activities
Parameters
- requestParameters: GetActivitiesRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<AliasAliasIdActivitiesModelArray>>
- Defined in sdk/apis/AliasApi.ts:397

getAlias

getAlias(
requestParameters: GetAliasRequest,
initOverrides?: any,
): Promise<Alias>
Get specific alias by id. Get alias
Parameters
- requestParameters: GetAliasRequest
- OptionalinitOverrides: any
Returns Promise<Alias>
- Defined in sdk/apis/AliasApi.ts:485

getAliases

getAliases(
requestParameters: GetAliasesRequest,
initOverrides?: any,
): Promise<AliasModelArray>
Get user aliases. Please note pinned, disabled, enabled are exclusive, i.e. only one can be present. They can only be set to true. Get aliases
Parameters
- requestParameters: GetAliasesRequest
- OptionalinitOverrides: any
Returns Promise<AliasModelArray>
- Defined in sdk/apis/AliasApi.ts:582

getAliasesRaw

getAliasesRaw(
requestParameters: GetAliasesRequest,
initOverrides?: any,
): Promise<ApiResponse<AliasModelArray>>
Get user aliases. Please note pinned, disabled, enabled are exclusive, i.e. only one can be present. They can only be set to true. Get aliases
Parameters
- requestParameters: GetAliasesRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<AliasModelArray>>
- Defined in sdk/apis/AliasApi.ts:533

getAliasOptions

getAliasOptions(
requestParameters?: GetAliasOptionsRequest,
initOverrides?: any,
): Promise<AliasOptions>
User alias info and suggestion. Used by the first extension screen when user opens the extension. Get alias options
Parameters
- requestParameters: GetAliasOptionsRequest = {}
- OptionalinitOverrides: any
Returns Promise<AliasOptions>
- Defined in sdk/apis/AliasApi.ts:524

getAliasOptionsRaw

getAliasOptionsRaw(
requestParameters: GetAliasOptionsRequest,
initOverrides?: any,
): Promise<ApiResponse<AliasOptions>>
User alias info and suggestion. Used by the first extension screen when user opens the extension. Get alias options
Parameters
- requestParameters: GetAliasOptionsRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<AliasOptions>>
- Defined in sdk/apis/AliasApi.ts:494

getAliasRaw

getAliasRaw(
requestParameters: GetAliasRequest,
initOverrides?: any,
): Promise<ApiResponse<Alias>>
Get specific alias by id. Get alias
Parameters
- requestParameters: GetAliasRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<Alias>>
- Defined in sdk/apis/AliasApi.ts:451

getContacts

getContacts(
requestParameters: GetContactsRequest,
initOverrides?: any,
): Promise<AliasAliasIdContactsModelArray>
Get contacts for specific alias by id. Get contacts
Parameters
- requestParameters: GetContactsRequest
- OptionalinitOverrides: any
Returns Promise<AliasAliasIdContactsModelArray>
- Defined in sdk/apis/AliasApi.ts:636

getContactsRaw

getContactsRaw(
requestParameters: GetContactsRequest,
initOverrides?: any,
): Promise<ApiResponse<AliasAliasIdContactsModelArray>>
Get contacts for specific alias by id. Get contacts
Parameters
- requestParameters: GetContactsRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<AliasAliasIdContactsModelArray>>
- Defined in sdk/apis/AliasApi.ts:591

`Protected`isJsonMime

isJsonMime(mime: string | null | undefined): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: string | null | undefined
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in sdk/runtime.ts:134

`Protected`request

request(context: RequestOpts, initOverrides?: any): Promise<any>
Parameters
- context: RequestOpts
- OptionalinitOverrides: any
Returns Promise<any>
Inherited from BaseAPI.request
- Defined in sdk/runtime.ts:141

searchAliases

searchAliases(
requestParameters: SearchAliasesRequest,
initOverrides?: any,
): Promise<AliasModelArray>
Search user aliases. Please note pinned, disabled, enabled are exclusive, i.e. only one can be present. They can only be set to true. Search aliases
Parameters
- requestParameters: SearchAliasesRequest
- OptionalinitOverrides: any
Returns Promise<AliasModelArray>
- Defined in sdk/apis/AliasApi.ts:697

searchAliasesRaw

searchAliasesRaw(
requestParameters: SearchAliasesRequest,
initOverrides?: any,
): Promise<ApiResponse<AliasModelArray>>
Search user aliases. Please note pinned, disabled, enabled are exclusive, i.e. only one can be present. They can only be set to true. Search aliases
Parameters
- requestParameters: SearchAliasesRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<AliasModelArray>>
- Defined in sdk/apis/AliasApi.ts:645

toggleAlias

toggleAlias(
requestParameters: ToggleAliasRequest,
initOverrides?: any,
): Promise<AliasAliasIdTogglePost>
Enable or disable specific alias by id. Toggle alias
Parameters
- requestParameters: ToggleAliasRequest
- OptionalinitOverrides: any
Returns Promise<AliasAliasIdTogglePost>
- Defined in sdk/apis/AliasApi.ts:740

toggleAliasRaw

toggleAliasRaw(
requestParameters: ToggleAliasRequest,
initOverrides?: any,
): Promise<ApiResponse<AliasAliasIdTogglePost>>
Enable or disable specific alias by id. Toggle alias
Parameters
- requestParameters: ToggleAliasRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<AliasAliasIdTogglePost>>
- Defined in sdk/apis/AliasApi.ts:706

toggleContactBlocking

toggleContactBlocking(
requestParameters: ToggleContactBlockingRequest,
initOverrides?: any,
): Promise<ContactsContactIdToggle>
Block or unblock a contact by id. Toggles the block_forward status. Toggle contact blocking
Parameters
- requestParameters: ToggleContactBlockingRequest
- OptionalinitOverrides: any
Returns Promise<ContactsContactIdToggle>
- Defined in sdk/apis/AliasApi.ts:783

toggleContactBlockingRaw

toggleContactBlockingRaw(
requestParameters: ToggleContactBlockingRequest,
initOverrides?: any,
): Promise<ApiResponse<ContactsContactIdToggle>>
Block or unblock a contact by id. Toggles the block_forward status. Toggle contact blocking
Parameters
- requestParameters: ToggleContactBlockingRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<ContactsContactIdToggle>>
- Defined in sdk/apis/AliasApi.ts:749

updateAlias

updateAlias(
requestParameters: UpdateAliasRequest,
initOverrides?: any,
): Promise<Success>
Update specific alias by id. Update alias
Parameters
- requestParameters: UpdateAliasRequest
- OptionalinitOverrides: any
Returns Promise<Success>
- Defined in sdk/apis/AliasApi.ts:836

updateAliasRaw

updateAliasRaw(
requestParameters: UpdateAliasRequest,
initOverrides?: any,
): Promise<ApiResponse<Success>>
Update specific alias by id. Update alias
Parameters
- requestParameters: UpdateAliasRequest
- OptionalinitOverrides: any
Returns Promise<ApiResponse<Success>>
- Defined in sdk/apis/AliasApi.ts:792

withMiddleware

withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in sdk/runtime.ts:108

withPostMiddleware

withPostMiddleware<T extends BaseAPI>(
    this: T,
    ...postMiddlewares: (
        ((context: ResponseContext) => Promise<any>)
        | undefined
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...postMiddlewares: (((context: ResponseContext) => Promise<any>) | undefined)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in sdk/runtime.ts:119

withPreMiddleware

withPreMiddleware<T extends BaseAPI>(
    this: T,
    ...preMiddlewares: (
        ((context: RequestContext) => Promise<void | FetchParams>)
        | undefined
    )[],
): T
Type Parameters
- T extends BaseAPI
Parameters
- this: T
- ...preMiddlewares: (((context: RequestContext) => Promise<void | FetchParams>) | undefined)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in sdk/runtime.ts:114