Class PublicSubscriptionStatus

The status of a subscription for a contact.

Hierarchy

PublicSubscriptionStatus

Index

Constructors

Properties

brandId? description id legalBasis? legalBasisExplanation? name preferenceGroupName? sourceOfStatus status attributeTypeMap discriminator

Methods

getAttributeTypeMap

Constructors

constructor

new PublicSubscriptionStatus(): PublicSubscriptionStatus
Returns PublicSubscriptionStatus
- Defined in codegen/communication_preferences/models/PublicSubscriptionStatus.ts:117

Properties

`Optional` brandId

brandId?: number

The ID of the brand that the subscription is associated with, if there is one.

description

description: string

A description of the subscription.

id

id: string

The ID for the subscription.

`Optional` legalBasis

legalBasis?: PublicSubscriptionStatusLegalBasisEnum

The legal reason for the current status of the subscription.

`Optional` legalBasisExplanation

legalBasisExplanation?: string

A more detailed explanation to go with the legal basis.

name

name: string

The name of the subscription.

`Optional` preferenceGroupName

preferenceGroupName?: string

The name of the preferences group that the subscription is associated with.

sourceOfStatus

sourceOfStatus: PublicSubscriptionStatusSourceOfStatusEnum

Where the status is determined from e.g. PORTAL_WIDE_STATUS if the contact opted out from the portal.

status

status: PublicSubscriptionStatusStatusEnum

Whether the contact is subscribed.

`Static` `Readonly` attributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Type declaration

baseName: string
format: string
name: string
type: string

`Static` `Readonly` discriminator

discriminator: undefined | string = undefined

Methods

`Static` getAttributeTypeMap

getAttributeTypeMap(): {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[]
Returns {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[]
- Defined in codegen/communication_preferences/models/PublicSubscriptionStatus.ts:113

Class PublicSubscriptionStatus

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PublicSubscriptionStatus

Properties

`Optional` brandId

description

id

`Optional` legalBasis

`Optional` legalBasisExplanation

name

`Optional` preferenceGroupName

sourceOfStatus

status

`Static` `Readonly` attributeTypeMap

Type declaration

baseName: string

format: string

name: string

type: string

`Static` `Readonly` discriminator

Methods

`Static` getAttributeTypeMap

Returns {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[]

Settings

Member Visibility

Theme

On This Page

Class PublicSubscriptionStatus

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns PublicSubscriptionStatus

Properties

Optional brandId

description

id

Optional legalBasis

Optional legalBasisExplanation

name

Optional preferenceGroupName

sourceOfStatus

status

Static Readonly attributeTypeMap

Type declaration

baseName: string

format: string

name: string

type: string

Static Readonly discriminator

Methods

Static getAttributeTypeMap

Returns { baseName: string; format: string; name: string; type: string; }[]

Settings

Member Visibility

Theme

On This Page

`Optional` brandId

`Optional` legalBasis

`Optional` legalBasisExplanation

`Optional` preferenceGroupName

`Static` `Readonly` attributeTypeMap

`Static` `Readonly` discriminator

`Static` getAttributeTypeMap

Returns {
baseName: string;
format: string;
name: string;
type: string;
}[]