Function AppsApiFactory

AppsApi - factory interface export

  • AppsApiFactory(configuration?, basePath?, axios?): {
        apiAppsDelete(id?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiAppsGet(options?: RawAxiosRequestConfig): AxiosPromise<UserApplicationListResponse>;
        apiAppsIdPut(id: string, description?: string, name?: string, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<UserApplicationCreateDeets>;
        apiAppsPost(description?: string, name?: string, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<UserApplicationCreateDeets>;
    }

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns {
        apiAppsDelete(id?: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
        apiAppsGet(options?: RawAxiosRequestConfig): AxiosPromise<UserApplicationListResponse>;
        apiAppsIdPut(id: string, description?: string, name?: string, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<UserApplicationCreateDeets>;
        apiAppsPost(description?: string, name?: string, userId?: string, options?: RawAxiosRequestConfig): AxiosPromise<UserApplicationCreateDeets>;
    }

    • apiAppsDelete:function
      • apiAppsDelete(id?, options?): AxiosPromise<void>

      • summary Delete an application

        Parameters

        • Optionalid: string

          The id for the application to delete.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns AxiosPromise<void>

        Throws

    • apiAppsGet:function
    • apiAppsIdPut:function
      • apiAppsIdPut(id, description?, name?, userId?, options?): AxiosPromise<UserApplicationCreateDeets>

      • 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 AxiosPromise<UserApplicationCreateDeets>

        Throws

    • apiAppsPost:function
      • apiAppsPost(description?, name?, userId?, options?): AxiosPromise<UserApplicationCreateDeets>

      • 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 AxiosPromise<UserApplicationCreateDeets>

        Throws

Settings

Member Visibility