Class Branding

getBranding

• getBranding(clientId: string, brandingId?: number | "default"): Promise<AxiosResponse<BrandingDetails>>

• Gets branding details for given merchant.

  method

  getBranding

  async

  example

  InPlayer.Branding
  .getBranding('eyJ0e-XAiOi-JKPEC-ENR5Y', '123')
  .then(data => console.log(data));
  

  Parameters

  • clientId: string

    The Merchant's unique universal identifier (Merchant UUID). You can find it on the InPlayer's dashboard at the Account Details section as Account ID.

  • brandingId: number | "default" = 'default'

    The id of created branding theme in InPlayer Dashboard. If it is not set the default branding details will be returned.

  Returns Promise<AxiosResponse<BrandingDetails>>

  Contains the data:

  {
     id: number;
     exists: boolean;
     brand_name: string;
     paywall_cover_photo: string;
     paywall_brand_logo: string;
     paywall_primary_color: string;
     paywall_secondary_color: string;
     paywall_buttons_bg_color: string;
     paywall_buttons_text_color: string;
     preview_buttons_bg_color: string;
     preview_buttons_text_color: string;
     preview_top_border: boolean;
     inplayer_protected_label: boolean;
     paywall_footer: string;
     default: boolean;
     template_id: number;
     terms_url: string;
     dark_mode: boolean;
  }