Class Provider

Provider class for managing a provider

Constructors

constructor

Properties

_alt_id _uuid accountServiceEnabled apiKey providerProfile scriptGroups secretKey url

Accessors

alt_id id secretKeyHeaders uuid

Methods

assertAccountService checkProfile getEarnings getPermissionsForSubscriber getProfile issueSubscriberToken publicKey validateSubscriberToken initialize

Constructors

Private constructor

Properties

Private _alt_id

_alt_id: undefined | null | string

Alt ID of the provider

Private _uuid

_uuid: undefined | string

UUID of the provider

Private accountServiceEnabled

accountServiceEnabled: undefined | boolean

Private apiKey

apiKey: string

API key for the provider

Private providerProfile

providerProfile: undefined | Promise<{
    __typename?: "AuthorizedProvider";
    account_service: {
        __typename?: "AccountServiceQuery";
        enabled: boolean;
    };
    alt_id?: null | string;
    script_groups?: null | {
        __typename?: "ProviderScriptGroup";
        alt_id: string;
        scripts?: null | (null | {
            __typename?: (...) | (...);
            alt_id: string;
            uuid: string;
        })[];
        uuid: string;
    }[];
    uuid: string;
}>

Private scriptGroups

scriptGroups: ScriptGroup[] = []

Script groups belonging to this provider

Private secretKey

secretKey: string

Secret key for the provider

Private url

url: string

MyScribae remote URL.

Accessors

alt_id

id

Private secretKeyHeaders

  • get secretKeyHeaders(): {
        X-MyScribae-SecretKey: string;
    }

  • Headers to be used for requests that require the secret key

    Returns {
        X-MyScribae-SecretKey: string;
    }

    • X-MyScribae-SecretKey: string

uuid

Methods

Private assertAccountService

checkProfile

  • checkProfile(assertion): Promise<void>

  • Updates the provider's profile from MyScribae

    Parameters

    • assertion: ProviderStruct

    Returns Promise<void>

getEarnings

  • getEarnings(from, to?): Promise<{
        __typename?: "ProviderEarnings";
        amount_in_cents: number;
        unique_subscribers: number;
    }>

  • Fetches the provider's profile from MyScribae

    Parameters

    • from: Date
    • Optional to: Date

    Returns Promise<{
        __typename?: "ProviderEarnings";
        amount_in_cents: number;
        unique_subscribers: number;
    }>

getPermissionsForSubscriber

  • getPermissionsForSubscriber(subscriber_id): Promise<string[]>

  • Parameters

    • subscriber_id: string

    Returns Promise<string[]>

getProfile

  • getProfile(): Promise<{
        __typename?: "AuthorizedProvider";
        account_service: {
            __typename?: "AccountServiceQuery";
            enabled: boolean;
        };
        alt_id?: null | string;
        script_groups?: null | {
            __typename?: "ProviderScriptGroup";
            alt_id: string;
            scripts?: null | (null | {
                __typename?: "ProviderScript";
                alt_id: string;
                uuid: string;
            })[];
            uuid: string;
        }[];
        uuid: string;
    }>

  • Returns Promise<{
        __typename?: "AuthorizedProvider";
        account_service: {
            __typename?: "AccountServiceQuery";
            enabled: boolean;
        };
        alt_id?: null | string;
        script_groups?: null | {
            __typename?: "ProviderScriptGroup";
            alt_id: string;
            scripts?: null | (null | {
                __typename?: "ProviderScript";
                alt_id: string;
                uuid: string;
            })[];
            uuid: string;
        }[];
        uuid: string;
    }>

issueSubscriberToken

  • issueSubscriberToken(subscriberId): Promise<string>

  • Issues a token on behalf of the provider

    Parameters

    • subscriberId: string

    Returns Promise<string>

publicKey

  • publicKey(): Promise<string>

  • Fetches the public key for the provider from MyScribae

    Returns Promise<string>

validateSubscriberToken

  • validateSubscriberToken(token): Promise<SubscriptionToken>

  • Validates a MyScribae token provided by a subscriber

    Parameters

    • token: string

      JWT token provided by the subscriber

    Returns Promise<SubscriptionToken>

    A promise that resolves to a SubscriptionToken

Static initialize

  • initialize(config, assertion, debug?): Promise<Provider>

  • Safe constructor for Provider

    Parameters

    • config: ProviderConfig

      Configuration for the provider

    • assertion: ProviderStruct
    • debug: boolean = false

    Returns Promise<Provider>

    A promise that resolves to a fully initialized provider

    Example: Initializing a provider

    const config = {
            url: 'https://api.myscribae.com',	
            apiKey: '...',
            secretKey: '...',
        };

        const provider = await Provider.initialize(config, providerProfile);

Settings

Member Visibility

Theme

On This Page

constructor_alt_id_uuidaccountServiceEnabledapiKeyproviderProfilescriptGroupssecretKeyurlalt_ididsecretKeyHeadersuuidassertAccountServicecheckProfilegetEarningsgetPermissionsForSubscribergetProfileissueSubscriberTokenpublicKeyvalidateSubscriberTokeninitialize

Generated using TypeDoc