Class MonetizationService

A model for the managed monetization service.

Hierarchy

ManagedServiceModel
- MonetizationService

Index

Constructors

constructor

new MonetizationService(page, uiShell, uiManagedWorkflows): MonetizationService
Parameters
- page: Page
  
  The playwright page object.
- uiShell: UiShellModel
  A model representing the Mosaic UI shell including methods for navigation.
  
  Use this model to interact with:
  - The breadcrumbs bar (on any page)
  - The landing page
  - The settings hub page
- uiManagedWorkflows: UiWorkflowsModel
  
  A model representing Mosaic UI workflows.
  
  Use this model to interact with workflows or modals of any managed service (Image, Video, Monetization, etc).
Returns MonetizationService

Inherited from ManagedServiceModel.constructor

Properties

`Protected` `Readonly` page

page: Page

The playwright page object.

`Protected` `Readonly` uiManagedWorkflows

uiManagedWorkflows: UiWorkflowsModel

A model representing Mosaic UI workflows.

Use this model to interact with workflows or modals of any managed service (Image, Video, Monetization, etc).

`Protected` `Readonly` uiShell

uiShell: UiShellModel

A model representing the Mosaic UI shell including methods for navigation.

Use this model to interact with:

The breadcrumbs bar (on any page)
The landing page
The settings hub page

Methods

assignClaimSetToSubscriptionPlan

assignClaimSetToSubscriptionPlan(args): Promise<void>
This method assigns a claim set to the subscription plan. The management system must be loaded & signed in before using this method. If the claim set does not exist, or is already added to this subscription plan then an exception will be raised.

The following steps will be taken:
- Navigate to the home breadcrumb, then tiles: 'Monetization', 'Subscription Plans'
- Filter by title and click the subscription plan row action
- Click the 'Claim Sets' action
- Open the claim sets explorer modal, filter by key and select the first result
- Click the 'previous' breadcrumb and wait for the subscription plan details station to load
Parameters
- args: {
  claimSetUniqueKey: string;
  subscriptionPlanTitle: string;
  }
  - claimSetUniqueKey: string
    
    The claim set unique key.
  - subscriptionPlanTitle: string
    
    A unique subscription plan title.
Returns Promise<void>

assignClaimsToClaimSet

assignClaimsToClaimSet(args): Promise<void>
This method assigns claims to a claim set. The management system must be loaded & signed in before using this method. NOTE: This method does not support adding claims by modal.

The following steps will be taken:
- Navigate to the home breadcrumb, then tiles: 'Monetization', 'Claim Sets'
- Filter by unique key and click the claim set row action
- Click 'Claims'
- Add each claim by checkbox or radio button
- Click the 'previous' breadcrumb and wait for the claim set details station to load
Parameters
- args: {
  claims: string[];
  uniqueKey: string;
  }
  - claims: string[]
    
    The list of claim values to be assigned. Each claim input will be clicked.
  - uniqueKey: string
    
    The claim set unique key.
Returns Promise<void>

assignClaimsToClaimSetByLabel

assignClaimsToClaimSetByLabel(args): Promise<void>
This method assigns claims to a claim set. The management system must be loaded & signed in before using this method. NOTE: This method does support adding claims by modal.

The following steps will be taken:
- Navigate to the home breadcrumb, then tiles: 'Monetization', 'Claim Sets'
- Filter by unique key and click the claim set row action
- Click 'Claims'
- Add each claim by checkbox or radio button
- Click the 'previous' breadcrumb and wait for the claim set details station to load
Parameters
- args: {
      claimGroupLabel: string;
      claimLabels: string[];
      uniqueKey: string;
  }
  - claimGroupLabel: string
    
    The label of the claim group.
  - claimLabels: string[]
    
    The claim labels in the claim group. Each will be clicked or added by modal as required.
  - uniqueKey: string
    
    The claim set unique key.
Returns Promise<void>

createClaimSet

createClaimSet(properties): Promise<void>
This method creates a new claim set. The management system must be loaded & signed in before using this method. When this method completes, the new claim set details station will be loaded.

The following steps will be taken:
- Navigate to the home breadcrumb, then tiles: 'Monetization', 'Claim Sets'
- Click 'New', enter the title and key then click 'Proceed'
- Wait for the claim set details station to load
Parameters
- properties: {
  title: string;
  uniqueKey: string;
  }
  - title: string
    
    A unique subscription plan title.
  - uniqueKey: string
    
    The claim set unique key.
Returns Promise<void>

deleteClaimSet

deleteClaimSet(args): Promise<void>
This method deletes a claim set by unique key. The management system must be loaded & signed in before using this method. If the claim set cannot be deleted then an exception will be raised.

The following steps will be taken:
- Navigate to the home breadcrumb, then tiles: 'Monetization', 'Claim Sets'
- Filter by unique key and click the claim set row action
- Click 'Delete' and confirm
- Wait for the claim sets explorer to load
Parameters
- args: {
  uniqueKey: string;
  }
  - uniqueKey: string
    
    The claim set unique key.
Returns Promise<void>

navigateToClaimSetDetails

navigateToClaimSetDetails(args): Promise<void>
This method navigates to a claim set details station by unique key. The management system must be loaded & signed in before using this method. If there is not exactly one matching claim set an exception will be raised.

The following steps will be taken:
- Navigate to the home breadcrumb, then tiles: 'Monetization', 'Claim Sets'
- Filter by unique key and click the claim set row action
- Wait for the claim set details station to load
Parameters
- args: {
  uniqueKey: string;
  }
  - uniqueKey: string
    
    The claim set unique key.
Returns Promise<void>

navigateToClaimSets

navigateToClaimSets(): Promise<void>
This method navigates to the claim sets explorer station. The management system must be loaded & signed in before using this method.

The following steps will be taken:
- Navigate to the home breadcrumb, then tiles: 'Monetization', 'Claim Sets'
- Wait for data to load
Returns Promise<void>

navigateToSubscriptionPlanDetails

navigateToSubscriptionPlanDetails(filterBy): Promise<void>
This method navigates to a subscription plan details station by title. The management system must be loaded & signed in before using this method. If there is not exactly one matching subscription plan an exception will be raised.

The following steps will be taken:
- Navigate to the home breadcrumb, then tiles: 'Monetization', 'Subscription Plans'
- Filter by title and click the subscription plan row action
- Wait for the subscription plan details page to load
Parameters
- filterBy: {
  title: string;
  }
  - title: string
    
    A unique subscription plan title.
Returns Promise<void>

navigateToSubscriptionPlans

navigateToSubscriptionPlans(): Promise<void>
This method navigates to the subscription plans explorer station. The management system must be loaded & signed in before using this method.

The following steps will be taken:
- Navigate to the home breadcrumb, then tiles: 'Monetization', 'Subscription Plans'
- Wait for data to load
Returns Promise<void>

publishClaimSet

publishClaimSet(args): Promise<void>
This method publishes a claim set. The management system must be loaded & signed in before using this method. If the claim set cannot be published then an exception will be raised.

The following steps will be taken:
- Navigate to the home breadcrumb, then tiles: 'Monetization', 'Claim Sets'
- Filter by unique key and click the claim set row action
- Click 'Publishing'
- Click 'Publish' and confirm
- Wait for the claim set details station to load
Parameters
- args: {
  uniqueKey: string;
  }
  - uniqueKey: string
    
    The claim set unique key.
Returns Promise<void>

publishSubscriptionPlan

publishSubscriptionPlan(args): Promise<void>
This method sets subscription plan status and publishes the subscription plan. The management system must be loaded & signed in before using this method. If the subscription plan cannot be published then an exception will be raised.

The following steps will be taken:
- Navigate to the home breadcrumb, then tiles: 'Monetization', 'Subscription Plans'
- Filter by title and click the subscription plan row action
- Set the Status field
- Click 'Publishing'
- Click 'Publish' and confirm
- Wait for the subscription plan details station to load and verify that the publication state is 'PUBLISHED'
Parameters
- args: {
  status?: "Active" | "Inactive";
  title: string;
  }
  - Optional status?: "Active" | "Inactive"
    
    The subscription plan status to be set. If omitted no change will be made.
  - title: string
    
    A unique subscription plan title.
Returns Promise<void>

removeClaimSetFromSubscriptionPlan

removeClaimSetFromSubscriptionPlan(args): Promise<void>
This method removes a claim set assignment from a subscription plan. The management system must be loaded & signed in before using this method. If the claim set is not assigned to this subscription plan then an exception will be raised.

The following steps will be taken:
- Navigate to the home breadcrumb, then tiles: 'Monetization', 'Subscription Plans'
- Filter by title and click the subscription plan row action
- Click the 'Claim Sets' action
- Unassign the claim set using the inline menu
- Click the 'previous' breadcrumb and wait for the subscription plan details station to load
Parameters
- args: {
  claimSetUniqueKey: string;
  subscriptionPlanTitle: string;
  }
  - claimSetUniqueKey: string
    
    The claim set unique key.
  - subscriptionPlanTitle: string
    
    A unique subscription plan title.
Returns Promise<void>

unpublishClaimSet

unpublishClaimSet(args): Promise<void>
This method unpublishes a claim set by unique key. The management system must be loaded & signed in before using this method. If the claim set cannot be unpublished then an exception will be raised.

The following steps will be taken:
- Navigate to the home breadcrumb, then tiles: 'Monetization', 'Claim Sets'
- Filter by unique key and click the claim set row action
- Click 'Unpublish' and confirm
- Wait for the claim sets details station to load
Parameters
- args: {
  uniqueKey: string;
  }
  - uniqueKey: string
Returns Promise<void>

Class MonetizationService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

page: Page

uiShell: UiShellModel

uiManagedWorkflows: UiWorkflowsModel

Returns MonetizationService

Properties

Protected Readonly page

Protected Readonly uiManagedWorkflows

Protected Readonly uiShell

Methods

assignClaimSetToSubscriptionPlan

Parameters

args: { claimSetUniqueKey: string; subscriptionPlanTitle: string; }

claimSetUniqueKey: string

subscriptionPlanTitle: string

Returns Promise<void>

assignClaimsToClaimSet

Parameters

args: { claims: string[]; uniqueKey: string; }

claims: string[]

uniqueKey: string

Returns Promise<void>

assignClaimsToClaimSetByLabel

Parameters

args: { claimGroupLabel: string; claimLabels: string[]; uniqueKey: string; }

claimGroupLabel: string

claimLabels: string[]

uniqueKey: string

Returns Promise<void>

createClaimSet

Parameters

properties: { title: string; uniqueKey: string; }

title: string

uniqueKey: string

Returns Promise<void>

deleteClaimSet

Parameters

args: { uniqueKey: string; }

uniqueKey: string

Returns Promise<void>

navigateToClaimSetDetails

Parameters

args: { uniqueKey: string; }

uniqueKey: string

Returns Promise<void>

navigateToClaimSets

Returns Promise<void>

navigateToSubscriptionPlanDetails

Parameters

filterBy: { title: string; }

title: string

Returns Promise<void>

navigateToSubscriptionPlans

Returns Promise<void>

publishClaimSet

Parameters

args: { uniqueKey: string; }

uniqueKey: string

Returns Promise<void>

publishSubscriptionPlan

Parameters

args: { status?: "Active" | "Inactive"; title: string; }

Optional status?: "Active" | "Inactive"

title: string

Returns Promise<void>

removeClaimSetFromSubscriptionPlan

Parameters

args: { claimSetUniqueKey: string; subscriptionPlanTitle: string; }

claimSetUniqueKey: string

subscriptionPlanTitle: string

Returns Promise<void>

unpublishClaimSet

`Protected` `Readonly` page

`Protected` `Readonly` uiManagedWorkflows

`Protected` `Readonly` uiShell

args: {
claimSetUniqueKey: string;
subscriptionPlanTitle: string;
}

args: {
claims: string[];
uniqueKey: string;
}

args: {
claimGroupLabel: string;
claimLabels: string[];
uniqueKey: string;
}

properties: {
title: string;
uniqueKey: string;
}

args: {
uniqueKey: string;
}

args: {
uniqueKey: string;
}

filterBy: {
title: string;
}

args: {
uniqueKey: string;
}

args: {
status?: "Active" | "Inactive";
title: string;
}

`Optional` status?: "Active" | "Inactive"

args: {
claimSetUniqueKey: string;
subscriptionPlanTitle: string;
}

args: {
uniqueKey: string;
}