From 5b4c8303827de01a1be0451bc6e989971255bb54 Mon Sep 17 00:00:00 2001 From: ExWeiv GitHub BOT Date: Tue, 26 Mar 2024 03:55:02 +0000 Subject: [PATCH] Build and Generate Docs - BOT --- docs/functions/discord.getTokens.html | 4 ++-- docs/functions/discord.redirectURL.html | 4 ++-- docs/functions/discord.userAuth.html | 4 ++-- docs/functions/facebook.authUser.html | 4 ++-- docs/functions/facebook.getTokens.html | 4 ++-- docs/functions/facebook.redirectURL.html | 4 ++-- docs/functions/github.authUser.html | 4 ++-- docs/functions/github.getTokens.html | 4 ++-- docs/functions/github.redirectURL.html | 4 ++-- docs/functions/google.authUser.html | 4 ++-- docs/functions/google.getTokens.html | 4 ++-- docs/functions/google.redirectURL.html | 4 ++-- docs/functions/oauth.getSessionToken.html | 4 ++-- docs/functions/steam.redirectURL.html | 4 ++-- docs/functions/steam.userAuth.html | 4 ++-- docs/index.html | 2 +- docs/modules.html | 2 +- docs/modules/discord.html | 4 ++-- docs/modules/facebook.html | 4 ++-- docs/modules/github.html | 4 ++-- docs/modules/google.html | 4 ++-- docs/modules/oauth.html | 4 ++-- docs/modules/steam.html | 4 ++-- docs/types/AuthResponse.html | 4 ++-- docs/types/discord.AuthOptions.html | 4 ++-- docs/types/discord.RedirectURLOptions.html | 4 ++-- docs/types/discord.TokensOptions.html | 4 ++-- docs/types/discord.TokensResponse.html | 4 ++-- docs/types/facebook.AuthOptions.html | 4 ++-- docs/types/facebook.RedirectURLOptions.html | 4 ++-- docs/types/facebook.TokensOptions.html | 4 ++-- docs/types/facebook.TokensResponse.html | 4 ++-- docs/types/github.AuthOptions.html | 4 ++-- docs/types/github.RedirectURLOptions.html | 4 ++-- docs/types/github.TokensOptions.html | 4 ++-- docs/types/github.TokensResponse.html | 4 ++-- docs/types/google.AuthOptions.html | 4 ++-- docs/types/google.RedirectURLOptions.html | 4 ++-- docs/types/google.TokensOptions.html | 4 ++-- docs/types/google.TokensResponse.html | 4 ++-- docs/types/oauth.OAuthOptions.html | 4 ++-- docs/types/oauth.OAuthProviders.html | 4 ++-- docs/types/steam.AuthOptions.html | 4 ++-- docs/types/steam.RedirectURLOptions.html | 4 ++-- 44 files changed, 86 insertions(+), 86 deletions(-) diff --git a/docs/functions/discord.getTokens.html b/docs/functions/discord.getTokens.html index 8cff274..d936e58 100644 --- a/docs/functions/discord.getTokens.html +++ b/docs/functions/discord.getTokens.html @@ -1,10 +1,10 @@ getTokens | Easy Auth API Reference | ExWeiv Apps

Function getTokens

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Returns Promise<discord.TokensResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function redirectURL

  • redirectURL(options): string

  • Creates a redirect url for authenticating user via Discord

    Parameters

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

Function getTokens

  • getTokens(options): Promise<facebook.TokensResponse>

  • Gets tokens for API calls to Facebook. Keep in mind Facebook has a different system for tokens. Facebook doesn't have any refresh_tokens instead you exhcnage expired tokens with new ones.

    Parameters

    Returns Promise<facebook.TokensResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Returns Promise<facebook.TokensResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function redirectURL

  • redirectURL(options): string

  • Creates a redirect url for authenticating user via Facebook

    Parameters

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

Function getTokens

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Returns Promise<github.TokensResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function redirectURL

  • redirectURL(options): string

  • Creates a redirect url for authenticating user via GitHub

    Parameters

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

Function getTokens

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Returns Promise<google.TokensResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function redirectURL

  • redirectURL(options): string

  • Creates a redirect url for authenticating user via Google

    Parameters

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

Function getSessionToken

  • getSessionToken(provider, options): Promise<string>

  • This function handles the user authentication and returns a session token to be used in the frontend with wix-members-frontend APIs.

    Parameters

    • provider: OAuthProviders

      Provider you want to use for the process (This function currently does not support Steam)

    • options: OAuthOptions

      authUser options for the process related options based on the provider

      -

    Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Returns Promise<string>

Settings

Member Visibility

Theme

Generated using TypeDoc

Function redirectURL

  • redirectURL(options): string

  • Creates a redirect url for authenticating user via Steam

    Parameters

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

Function userAuth

  • userAuth(options, client_secret?): Promise<AuthResponse>

  • Gets user data from Steam

    Parameters

    • options: steam.AuthOptions

      Options that's used when getting user data from Steam.

    • Optional client_secret: string

      Defaults to undefined, if you don't pass a client_secret (apiKey) API will use Wix Secret Manager to find client_secret named as SteamClientSecret.

      -

    Returns Promise<AuthResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Returns Promise<AuthResponse>

Settings

Member Visibility

Theme

Generated using TypeDoc

Namespace discord

Read Discord Docs for more info about anything here.

-

Index

Type Aliases

AuthOptions +

Index

Type Aliases

AuthOptions RedirectURLOptions TokensOptions TokensResponse @@ -10,7 +10,7 @@

Settings

Member Visibility

Theme

Generated using TypeDoc

Namespace facebook

Read Facebook Docs for more info about anything here.

-

Index

Type Aliases

AuthOptions +

Index

Type Aliases

AuthOptions RedirectURLOptions TokensOptions TokensResponse @@ -10,7 +10,7 @@

Settings

Member Visibility

Theme

Generated using TypeDoc

Namespace github

Read GitHub Docs for more info about anything here.

-

Index

Type Aliases

AuthOptions +

Index

Type Aliases

AuthOptions RedirectURLOptions TokensOptions TokensResponse @@ -10,7 +10,7 @@

Settings

Member Visibility

Theme

Generated using TypeDoc

Namespace google

Read Google Docs for more info about anything here.

-

Index

Type Aliases

AuthOptions +

Index

Type Aliases

AuthOptions RedirectURLOptions TokensOptions TokensResponse @@ -10,7 +10,7 @@

Settings

Member Visibility

Theme

Generated using TypeDoc

Namespace oauth

Helper functions to quickly integrate OAuth providers with Wix Members in backend

-

Index

Type Aliases

OAuthOptions +

Index

Type Aliases

OAuthOptions OAuthProviders

Functions

getSessionToken

Settings

Member Visibility

Theme

Generated using TypeDoc

Namespace steam

Steam itself doesn't provide any OAuth 2.0 or something similar to authenticate users with their APIs. You'll need to implement a secure way to authenticate users via Steam. This isn't a realy OAuth 2.0 method since you won't get any access_token after user sign-in to Steam, what you'll get is users's public Steam ID (number). That you can use to get public info of that user after successful login.

-

Index

Type Aliases

AuthOptions +

Index

Type Aliases

AuthOptions RedirectURLOptions

Functions

redirectURL userAuth

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias AuthResponse

AuthResponse: {
    [key: string]: any;
}

Type declaration

  • [key: string]: any

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias AuthResponse

AuthResponse: {
    [key: string]: any;
}

Type declaration

  • [key: string]: any

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias AuthOptions

AuthOptions: {
    client_id: string;
    code: string;
    grant_type?: string;
    redirect_uri: string;
}

Type declaration

  • client_id: string
  • code: string
  • Optional grant_type?: string
  • redirect_uri: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias AuthOptions

AuthOptions: {
    client_id: string;
    code: string;
    grant_type?: string;
    redirect_uri: string;
}

Type declaration

  • client_id: string
  • code: string
  • Optional grant_type?: string
  • redirect_uri: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias RedirectURLOptions

RedirectURLOptions: {
    client_id: string;
    prompt?: string;
    redirect_uri: string;
    response_type?: string;
    scope?: string[];
    state?: string;
}

Type declaration

  • client_id: string
  • Optional prompt?: string
  • redirect_uri: string
  • Optional response_type?: string
  • Optional scope?: string[]
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias RedirectURLOptions

RedirectURLOptions: {
    client_id: string;
    prompt?: string;
    redirect_uri: string;
    response_type?: string;
    scope?: string[];
    state?: string;
}

Type declaration

  • client_id: string
  • Optional prompt?: string
  • redirect_uri: string
  • Optional response_type?: string
  • Optional scope?: string[]
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias TokensOptions

TokensOptions: {
    client_id: string;
    client_secret: string;
    code?: string;
    grant_type?: string;
    redirect_uri?: string;
    refresh_token?: string;
}

Type declaration

  • client_id: string
  • client_secret: string
  • Optional code?: string
  • Optional grant_type?: string
  • Optional redirect_uri?: string
  • Optional refresh_token?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias TokensOptions

TokensOptions: {
    client_id: string;
    client_secret: string;
    code?: string;
    grant_type?: string;
    redirect_uri?: string;
    refresh_token?: string;
}

Type declaration

  • client_id: string
  • client_secret: string
  • Optional code?: string
  • Optional grant_type?: string
  • Optional redirect_uri?: string
  • Optional refresh_token?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias TokensResponse

TokensResponse: {
    access_token: string;
    expires_in: number;
    refresh_token: string;
    scope: string;
    token_type: string;
}

Type declaration

  • access_token: string
  • expires_in: number
  • refresh_token: string
  • scope: string
  • token_type: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias TokensResponse

TokensResponse: {
    access_token: string;
    expires_in: number;
    refresh_token: string;
    scope: string;
    token_type: string;
}

Type declaration

  • access_token: string
  • expires_in: number
  • refresh_token: string
  • scope: string
  • token_type: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias AuthOptions

AuthOptions: {
    client_id: string;
    code?: string;
    fields?: string[];
    redirect_uri: string;
}

Type declaration

  • client_id: string
  • Optional code?: string
  • Optional fields?: string[]
  • redirect_uri: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias AuthOptions

AuthOptions: {
    client_id: string;
    code?: string;
    fields?: string[];
    redirect_uri: string;
}

Type declaration

  • client_id: string
  • Optional code?: string
  • Optional fields?: string[]
  • redirect_uri: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias RedirectURLOptions

RedirectURLOptions: {
    client_id: string;
    redirect_uri: string;
    response_type?: string[];
    scope?: string[];
    state?: string;
}

Type declaration

  • client_id: string
  • redirect_uri: string
  • Optional response_type?: string[]
  • Optional scope?: string[]
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias RedirectURLOptions

RedirectURLOptions: {
    client_id: string;
    redirect_uri: string;
    response_type?: string[];
    scope?: string[];
    state?: string;
}

Type declaration

  • client_id: string
  • redirect_uri: string
  • Optional response_type?: string[]
  • Optional scope?: string[]
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias TokensOptions

TokensOptions: {
    client_id: string;
    client_secret: string;
    code?: string;
    fb_exchange_token?: string;
    grant_type?: string;
    redirect_uri?: string;
}

Type declaration

  • client_id: string
  • client_secret: string
  • Optional code?: string
  • Optional fb_exchange_token?: string
  • Optional grant_type?: string
  • Optional redirect_uri?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias TokensOptions

TokensOptions: {
    client_id: string;
    client_secret: string;
    code?: string;
    fb_exchange_token?: string;
    grant_type?: string;
    redirect_uri?: string;
}

Type declaration

  • client_id: string
  • client_secret: string
  • Optional code?: string
  • Optional fb_exchange_token?: string
  • Optional grant_type?: string
  • Optional redirect_uri?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias TokensResponse

TokensResponse: {
    access_token: string;
    expires_in: number;
    token_type: string;
}

Type declaration

  • access_token: string
  • expires_in: number
  • token_type: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias TokensResponse

TokensResponse: {
    access_token: string;
    expires_in: number;
    token_type: string;
}

Type declaration

  • access_token: string
  • expires_in: number
  • token_type: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias AuthOptions

AuthOptions: {
    client_id: string;
    code: string;
    redirect_uri: string;
    repository_id?: string;
}

Type declaration

  • client_id: string
  • code: string
  • redirect_uri: string
  • Optional repository_id?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias AuthOptions

AuthOptions: {
    client_id: string;
    code: string;
    redirect_uri: string;
    repository_id?: string;
}

Type declaration

  • client_id: string
  • code: string
  • redirect_uri: string
  • Optional repository_id?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias RedirectURLOptions

RedirectURLOptions: {
    allow_signup?: boolean;
    client_id: string;
    redirect_uri: string;
    state?: string;
}

Type declaration

  • Optional allow_signup?: boolean
  • client_id: string
  • redirect_uri: string
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias RedirectURLOptions

RedirectURLOptions: {
    allow_signup?: boolean;
    client_id: string;
    redirect_uri: string;
    state?: string;
}

Type declaration

  • Optional allow_signup?: boolean
  • client_id: string
  • redirect_uri: string
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias TokensOptions

TokensOptions: {
    client_id: string;
    client_secret: string;
    code?: string;
    grant_type?: string;
    redirect_uri?: string;
    refresh_token?: string;
    repository_id?: string;
}

Type declaration

  • client_id: string
  • client_secret: string
  • Optional code?: string
  • Optional grant_type?: string
  • Optional redirect_uri?: string
  • Optional refresh_token?: string
  • Optional repository_id?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias TokensOptions

TokensOptions: {
    client_id: string;
    client_secret: string;
    code?: string;
    grant_type?: string;
    redirect_uri?: string;
    refresh_token?: string;
    repository_id?: string;
}

Type declaration

  • client_id: string
  • client_secret: string
  • Optional code?: string
  • Optional grant_type?: string
  • Optional redirect_uri?: string
  • Optional refresh_token?: string
  • Optional repository_id?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias TokensResponse

TokensResponse: {
    access_token: string;
    expires_in: number;
    refresh_token: string;
    refresh_token_expires_in: number;
    scope: string;
    token_type: string;
}

Type declaration

  • access_token: string
  • expires_in: number
  • refresh_token: string
  • refresh_token_expires_in: number
  • scope: string
  • token_type: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias TokensResponse

TokensResponse: {
    access_token: string;
    expires_in: number;
    refresh_token: string;
    refresh_token_expires_in: number;
    scope: string;
    token_type: string;
}

Type declaration

  • access_token: string
  • expires_in: number
  • refresh_token: string
  • refresh_token_expires_in: number
  • scope: string
  • token_type: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias AuthOptions

AuthOptions: {
    client_id: string;
    code: string;
    grant_type?: string;
    redirect_uri: string;
}

Type declaration

  • client_id: string
  • code: string
  • Optional grant_type?: string
  • redirect_uri: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias AuthOptions

AuthOptions: {
    client_id: string;
    code: string;
    grant_type?: string;
    redirect_uri: string;
}

Type declaration

  • client_id: string
  • code: string
  • Optional grant_type?: string
  • redirect_uri: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias RedirectURLOptions

RedirectURLOptions: {
    access_type?: string;
    client_id: string;
    prompt?: string;
    redirect_uri: string;
    response_type?: string;
    scope?: string[];
    state?: string;
}

Type declaration

  • Optional access_type?: string
  • client_id: string
  • Optional prompt?: string
  • redirect_uri: string
  • Optional response_type?: string
  • Optional scope?: string[]
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias RedirectURLOptions

RedirectURLOptions: {
    access_type?: string;
    client_id: string;
    prompt?: string;
    redirect_uri: string;
    response_type?: string;
    scope?: string[];
    state?: string;
}

Type declaration

  • Optional access_type?: string
  • client_id: string
  • Optional prompt?: string
  • redirect_uri: string
  • Optional response_type?: string
  • Optional scope?: string[]
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias TokensOptions

TokensOptions: {
    client_id: string;
    client_secret?: string;
    code: string;
    grant_type?: string;
    redirect_uri: string;
    refresh_token?: string;
}

Type declaration

  • client_id: string
  • Optional client_secret?: string
  • code: string
  • Optional grant_type?: string
  • redirect_uri: string
  • Optional refresh_token?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias TokensOptions

TokensOptions: {
    client_id: string;
    client_secret?: string;
    code: string;
    grant_type?: string;
    redirect_uri: string;
    refresh_token?: string;
}

Type declaration

  • client_id: string
  • Optional client_secret?: string
  • code: string
  • Optional grant_type?: string
  • redirect_uri: string
  • Optional refresh_token?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias TokensResponse

TokensResponse: {
    access_token: string;
    expires_in: number;
    refresh_token: string;
    scope: string;
    token_type: string;
}

Type declaration

  • access_token: string
  • expires_in: number
  • refresh_token: string
  • scope: string
  • token_type: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias TokensResponse

TokensResponse: {
    access_token: string;
    expires_in: number;
    refresh_token: string;
    scope: string;
    token_type: string;
}

Type declaration

  • access_token: string
  • expires_in: number
  • refresh_token: string
  • scope: string
  • token_type: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias OAuthOptions

OAuthOptions: google.AuthOptions & facebook.AuthOptions & discord.AuthOptions & github.AuthOptions

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias OAuthOptions

OAuthOptions: google.AuthOptions & facebook.AuthOptions & discord.AuthOptions & github.AuthOptions

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias OAuthProviders

OAuthProviders: "google" | "facebook" | "discord" | "github"

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias OAuthProviders

OAuthProviders: "google" | "facebook" | "discord" | "github"

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias AuthOptions

AuthOptions: {
    steamId: string;
}

Type declaration

  • steamId: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias AuthOptions

AuthOptions: {
    steamId: string;
}

Type declaration

  • steamId: string

Settings

Member Visibility

Theme

Generated using TypeDoc
-

Type alias RedirectURLOptions

RedirectURLOptions: {
    realm: string;
    redirect_uri: string;
    state?: string;
}

Type declaration

  • realm: string
  • redirect_uri: string
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc
+

Type alias RedirectURLOptions

RedirectURLOptions: {
    realm: string;
    redirect_uri: string;
    state?: string;
}

Type declaration

  • realm: string
  • redirect_uri: string
  • Optional state?: string

Settings

Member Visibility

Theme

Generated using TypeDoc