Function ApiKeyApiFp

ApiKeyApi - functional programming interface export

  • ApiKeyApiFp(configuration?): {
        apiKeyDelete(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OkObjectResult>)>;
        apiKeyGet(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiKey>)>;
    }

  • Parameters

    Returns {
        apiKeyDelete(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<OkObjectResult>)>;
        apiKeyGet(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<ApiKey>)>;
    }

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

      • summary Deletes the current API key for the current user.

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

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

      • The user's account must have Jammber.RainCloud.ApiKey.Create. permissions summary Retrieves the user's current API Keys if they already exist, otherwise a new ClientID and ClientSecret will be generated for the user's account.

        Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility