accesstype-js | Documentation

AccessType

Available as a global variable on loading accesstype.js

new AccessType()

Instance Members

▸ version()

Returns version of the javascript

version()

▸ init(config)

Initializes AccessTypeJS with publisher specific configuration. This is an internal method and will be invoked as part of script initialization in Access Type JS script itself

init(config: InitConfig)

Parameters

config (InitConfig)

▸ setUser(user)

Set the user context before calling any other function

setUser(user: User): Promise<any>

Parameters

user (User)

Returns

Promise<any>

▸ unsetUser()

Unset user context when user logs out

unsetUser(): void

Returns

void

▸ getAllPaymentOptions()

Returns all the payment options enabled for the account. It doesn't require the user to be set in AT.

getAllPaymentOptions(): Promise<PaymentOptions>

Returns

Promise<PaymentOptions>

▸ getPaymentOptions(transactionAmountCents, subscriptionPlan, contextType)

Returns payment options available for the given user for a given transaction amount Payable amount has to be sent as transactionAmountCents, it's generally the price_cents of plan discounted_price_cents from discount_details has to be sent as transactionAmountCents if a coupon code is applied. subscriptionPlan object can be sent as second parameter to return only the payment gateways the plan supports. Both parameters are optional.

getPaymentOptions(transactionAmountCents: number?, subscriptionPlan: SubscriptionPlan?, contextType: string?): Promise<PaymentOptions>

Parameters

transactionAmountCents (number?)

subscriptionPlan (SubscriptionPlan?)

contextType

(string?
            = '')

Returns

Promise<PaymentOptions>

▸ getAssetPlans(asset)

Returns subscription plans for given param

getAssetPlans(asset: PurchaseableAsset): Promise<Array<SubscriptionPlan>>

Parameters

asset (PurchaseableAsset)

Returns

Promise<Array<SubscriptionPlan>>

▸ getSubscriptionPlans()

Returns list of subscription plans across all subscription groups

getSubscriptionPlans(): Promise<Array<SubscriptionPlan>>

Returns

Promise<Array<SubscriptionPlan>>

▸ isAssetAccessible(asset, disableMeter)

Returns if the user has access to an asset or not, along with its reason.

isAssetAccessible(asset: PurchaseableAsset, disableMeter: boolean?): Promise<AccessGrant>

Parameters

asset (PurchaseableAsset)

disableMeter (boolean?)

Returns

Promise<AccessGrant>

▸ pingbackAssetAccess(asset, accessGrant)

To be used for updating the meter after asset is accessed.

pingbackAssetAccess(asset: PurchaseableAsset, accessGrant: AccessGrant): Promise<any>

Parameters

asset (PurchaseableAsset)

accessGrant (AccessGrant)

Returns

Promise<any>

▸ previewSubscription(subscriptionParams)

Preview subscription independently without using the callbacks in getPaymentOptions. Useful for integrating with payment options that AccessTypeJS does not have first class support for

previewSubscription(subscriptionParams: SubscriptionParams): Promise<any>

Parameters

subscriptionParams (SubscriptionParams)

Returns

Promise<any>

▸ createSubscription(subscriptionParams)

Create subscription independently without using the callbacks in getPaymentOptions. Useful for integrating with payment options that AccessTypeJS does not have first class support for

createSubscription(subscriptionParams: SubscriptionParams): Promise<any>

Parameters

subscriptionParams (SubscriptionParams)

Returns

Promise<any>

▸ validateCoupon(params)

Validate coupon with plan

validateCoupon(params: CouponValidationRequest): Promise<CouponValidationResponse>

Parameters

params (CouponValidationRequest)

Returns

Promise<CouponValidationResponse>

▸ validateVoucher(params)

Validate voucher with plan

validateVoucher(params: VoucherValidationRequest): Promise<VoucherValidationRequest>

Parameters

params (VoucherValidationRequest)

Returns

Promise<VoucherValidationRequest>

▸ getSubscriptions()

Get all subscriptions for a user

getSubscriptions(): Promise<any>

Returns

Promise<any>

▸ getSubscriptionWithSwitchablePlans(subscriptionId, switchType)

Get single subscription with switch plan details for a user

getSubscriptionWithSwitchablePlans(subscriptionId: number, switchType: string): Promise<any>

Parameters

subscriptionId (number)

switchType (string)

Returns

Promise<any>

▸ updateSubscription(subscriptionId, updateParams)

update metadata for a subscription

updateSubscription(subscriptionId: number, updateParams: SubscriptionMetadata): Promise<any>

Parameters

subscriptionId (number)

updateParams (SubscriptionMetadata)

Returns

Promise<any>

▸ getSubscriptionGifts()

Get all subscriptions gifted by a user

getSubscriptionGifts(): Promise<any>

Returns

Promise<any>

▸ cancelSubscription(subscriptionId)

cancel a subscription

cancelSubscription(subscriptionId: number): Promise<any>

Parameters

subscriptionId (number)

Returns

Promise<any>

▸ getAssets()

Get all assets accessible to a user

getAssets(): Promise<any>

Returns

Promise<any>

▸ getRewards()

Get all rewards for a user

getRewards(): Promise<any>

Returns

Promise<any>

▸ resetWallets()

Reset user wallets For e.g. when user has changed their linked mobile number

resetWallets(): Promise<any>

Returns

Promise<any>

▸ downloadInvoice(subscriptionId, invoiceId)

Download Invoice for a subscription

downloadInvoice(subscriptionId: number, invoiceId: number): Promise<any>

Parameters

subscriptionId (number)

invoiceId (number)

Returns

Promise<any>

▸ isPrivateMode()

Check if browser is in private mode

isPrivateMode()

▸ getReferralVoucher()

Get Referral code for a user

getReferralVoucher(): Promise<any>

Returns

Promise<any>

▸ getCampaignSubscriptionPlans()

Get campaign subscription plans

getCampaignSubscriptionPlans(): Promise<Array<SubscriptionPlan>>

Returns

Promise<Array<SubscriptionPlan>>

▸ getSubscriberMetadata()

Get metadata for a subscriber

getSubscriberMetadata(): Promise<any>

Returns

Promise<any>

▸ setSubscriberMetadata(subscriberMetadata)

set metadata for a subscriber

setSubscriberMetadata(subscriberMetadata: SubscriberMetadata): Promise<any>

Parameters

subscriberMetadata (SubscriberMetadata)

Returns

Promise<any>

DurationUnit

Represents duration unit

DurationUnit

Type: ("months" | "weeks" | "years")

SubscriptionType

Represents valid subscription types

SubscriptionType

Type: ("standard" | "dynamic_asset")

AssetType

Represents supported asset type

AssetType

Type: "story"

Environment

Represents environment

Environment

Type: ("production" | "sandbox")

User

Represents a user

User

Type: {accesstypeJwt: string?, isLoggedIn: boolean?, readerId: string?, accesstypeJwtUrl: string?, readerIdUrl: string?, name: string?, emailAddress: string?, mobileNumber: string?}

Properties

accesstypeJwt (string?)

isLoggedIn (boolean?)

readerId (string?)

accesstypeJwtUrl (string?)

readerIdUrl (string?)

name (string?)

emailAddress (string?)

mobileNumber (string?)

SubscriptionPlan

Represents a subscription plan

SubscriptionPlan

Type: {id: string, title: string?, description: string?, price_cents: number, price_currency: string, duration_length: number, duration_unit: DurationUnit, supported_payment_providers: Array<string>?}

Properties

id (string)

title (string?)

description (string?)

price_cents (number)

price_currency (string)

duration_length (number)

duration_unit (DurationUnit)

supported_payment_providers (Array<string>?)

SubscriptionAsset

Represents an Asset

SubscriptionAsset

Type: {id: string, title: string, slug: string}

Properties

id (string)

title (string)

slug (string)

PaymentParams

Represents payment request params payment_type is one of the supported payment types like 'razorpay', 'stripe', 'paypal', 'juspay', etc

PaymentParams

Type: {payment_type: string, amount_cents: string, amount_currency: string}

Properties

payment_type (string)

amount_cents (string)

amount_currency (string)

SubscriptionParams

Represents SubscriptionParams which encapsulates the parameters required to make a subscription

SubscriptionParams

Type: {type: SubscriptionType, plan: SubscriptionPlan, payment: PaymentParams, assets: Array<SubscriptionAsset>?, additional_data: Object?, coupon_code: string?, options: Object?, recipient_subscriber: Object?}

Properties

type (SubscriptionType)

plan (SubscriptionPlan)

payment (PaymentParams)

assets (Array<SubscriptionAsset>?)

additional_data (Object?)

coupon_code (string?)

options (Object?)

recipient_subscriber (Object?)

SubscriptionMetadata

Represents metadata fields required to be updated

SubscriptionMetadata

Type: {metadata: Object}

Properties

metadata (Object)

SubscriberMetadata

Represents subscriber metadata fields

SubscriberMetadata

Type: {address: Object, phone_number: string?, other: Object?}

Properties

address (Object)

phone_number (string?)

other (Object?)

InitConfig

Represents InitConfig which encapsulates initialization params. Used internally only.

InitConfig

Type: {accesstype_host: string, account_key: string, account_name: string, payment_providers: {}, env: Environment}

Properties

accesstype_host (string)

account_key (string)

account_name (string)

payment_providers ({})

env (Environment)

PurchaseableAsset

Represent a purchaseable asset

PurchaseableAsset

Type: {id: string, type: AssetType}

Properties

id (string)

type (AssetType)

PaymentOption

Represents a payment option

For simpl, possible values for action = 'link' | 'pay'

For razorpay, possible values for action = 'pay'

When action is 'pay', proceed(params: SubscriptionParams)

When action is 'link', proceed()

PaymentOption

Type: {action: string, proceed: function (): Promise<any>}

Properties

action (string)

proceed (function (): Promise<any>)

PaymentOptions

Represents payment options for current user with this publisher

PaymentOptions

Type: {}

Error

Represents error response

Error

Type: {code: string, message: string}

Properties

code (string)

message (string)

CouponValidationRequest

Represents a coupon validation request

CouponValidationRequest

Type: {subscriptionPlanId: string, couponCode: string}

Properties

subscriptionPlanId (string)

couponCode (string)

VoucherValidationRequest

Represents a voucher validation request

VoucherValidationRequest

Type: {subscriptionPlanId: string, voucher: string}

Properties

subscriptionPlanId (string)

voucher (string)

DiscountDetails

Represents coupon discount

DiscountDetails

Type: {code: string, discount_type: string, title: string, value: number, discounted_price_cents: number, price_cents: number, price_currency: string}

Properties

code (string)

discount_type (string)

title (string)

value (number)

discounted_price_cents (number)

price_cents (number)

price_currency (string)

CouponValidationResponse

Represents coupon validation response

new CouponValidationResponse()

Asset

Represents an Asset

Asset

Type: {id: string, type: AssetType, attributes: AssetAttributes}

Properties

id (string)

type (AssetType)

attributes (AssetAttributes)

GrantReason

Reason for access grant

GrantReason

Type: ("SUBSCRIBER" | "METERING")

AccessGrant

Represents an AccessGrant

AccessGrant

Type: {granted: Boolean, grantReason: GrantReason, data: Object}

Properties

granted (Boolean)

grantReason (GrantReason)

data (Object)