Class AppsApi

AppsApi - object-oriented interface export AppsApi

Hierarchy (view full)

BaseAPI
- AppsApi

Index

Constructors

Properties

axios basePath configuration

Methods

apiAppsDelete apiAppsGet apiAppsIdPut apiAppsPost

Constructors

constructor

new AppsApi(configuration?, basePath?, axios?): AppsApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns AppsApi
Inherited from BaseAPI.constructor
- Defined in src/api/base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

apiAppsDelete

apiAppsDelete(id?, options?): Promise<AxiosResponse<void, any>>
summary Delete an application
Parameters
- Optionalid: string
  The id for the application to delete.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
memberof AppsApi
- Defined in src/api/api.ts:12318

apiAppsGet

apiAppsGet(options?): Promise<AxiosResponse<UserApplicationListResponse, any>>
summary Retrieve the info for applications you've created
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserApplicationListResponse, any>>
Throws
memberof AppsApi
- Defined in src/api/api.ts:12329

apiAppsIdPut

apiAppsIdPut(id, description?, name?, userId?, options?): Promise<AxiosResponse<UserApplicationCreateDeets, any>>
summary Create an application that can call the Mozaic API.
Parameters
- id: string
  The id of the record you wish to retrieve
- Optionaldescription: string
- Optionalname: string
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserApplicationCreateDeets, any>>
Throws
memberof AppsApi
- Defined in src/api/api.ts:12344

apiAppsPost

apiAppsPost(description?, name?, userId?, options?): Promise<AxiosResponse<UserApplicationCreateDeets, any>>
summary Create an application that can call the Mozaic API.
Parameters
- Optionaldescription: string
  A description for the application. Max 140 characters.
- Optionalname: string
  A name for the application
- OptionaluserId: string
  The user id to operate on their behalf (tenants only)
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UserApplicationCreateDeets, any>>
Throws
memberof AppsApi
- Defined in src/api/api.ts:12358