Function AppsApiFp

AppsApi - functional programming interface export

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

  • Parameters

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

    • apiAppsDelete:function
      • apiAppsDelete(id?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

      • summary Delete an application

        Parameters

        • Optionalid: string

          The id for the application to delete.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Throws

    • apiAppsGet:function
      • apiAppsGet(options?): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserApplicationListResponse>)>

      • summary Retrieve the info for applications you've created

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserApplicationListResponse>)>

        Throws

    • apiAppsIdPut:function
      • apiAppsIdPut(id, description?, name?, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => 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 Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserApplicationCreateDeets>)>

        Throws

    • apiAppsPost:function
      • apiAppsPost(description?, name?, userId?, options?): Promise<((axios?: AxiosInstance, basePath?: string) => 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 Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserApplicationCreateDeets>)>

        Throws

Settings

Member Visibility