liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
2,001 lines • 175 kB
TypeScript
/**
* A list of the user's account.
*/
export type AccountBrief = {
/**
* The account's external reference code.
*/
externalReferenceCode?: string;
/**
* The account's ID.
*/
readonly id?: number;
/**
* The account's name.
*/
name?: string;
/**
* A list of the user's roles.
*/
readonly roleBriefs?: Array<RoleBrief>;
/**
* The account's type.
*/
type?: string;
readonly 'x-class-name'?: string;
};
export type AccountGroup = {
/**
* The list of accounts associated with this account group.
*/
accountBriefs?: Array<AccountBrief>;
/**
* Block of actions allowed by the user making the request.
*/
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
creator?: Creator;
customFields?: Array<CustomField>;
/**
* The account group's creation date.
*/
readonly dateCreated?: string;
/**
* The account group's most recent modification date.
*/
readonly dateModified?: string;
description?: string;
externalReferenceCode?: string;
readonly id?: number;
name?: string;
permissions?: Array<Permission>;
readonly 'x-class-name'?: string;
};
/**
* The user who created the user group.
*/
export type Creator = {
/**
* The user's additional name, which can be used as a middle name.
*/
readonly additionalName?: string;
/**
* The type of the content.
*/
readonly contentType?: string;
/**
* The user's surname (last name).
*/
readonly familyName?: string;
/**
* The user's first name.
*/
readonly givenName?: string;
/**
* The user's ID.
*/
readonly id?: number;
/**
* A relative URL to the user's profile image.
*/
readonly image?: string;
/**
* The user's full name.
*/
readonly name?: string;
/**
* A relative URL to the user's profile.
*/
readonly profileURL?: string;
readonly 'x-class-name'?: string;
};
export type CustomField = {
readonly 'x-class-name'?: string;
customValue?: CustomValue;
/**
* The field type (e.g., image, text, etc.).
*/
readonly dataType?: string;
/**
* The field's internal name. This is valid for comparisons and unique in the structured content.
*/
name?: string;
};
/**
* The field's value.
*/
export type CustomValue = {
readonly 'x-class-name'?: string;
/**
* The field's content value for simple types.
*/
data?: {
[key: string]: unknown;
};
/**
* The localized field's content values for simple types.
*/
data_i18n?: {
[key: string]: string;
};
geo?: Geo;
};
export type Facet = {
facetCriteria?: string;
facetValues?: Array<FacetValue>;
};
export type FacetValue = {
numberOfOccurrences?: number;
term?: string;
};
/**
* A point determined by latitude and longitude.
*/
export type Geo = {
readonly 'x-class-name'?: string;
/**
* The latitude of a point in space.
*/
latitude?: number;
/**
* The longitude of a point in space.
*/
longitude?: number;
};
export type PageAccountGroup = {
items?: Array<AccountGroup>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Permission = {
actionIds?: Array<string>;
roleExternalReferenceCode?: string;
roleName?: string;
roleType?: string;
};
/**
* The list of roles associated with this user group.
*/
export type RoleBrief = {
/**
* The role's external reference code.
*/
externalReferenceCode?: string;
/**
* The role's ID.
*/
readonly id?: number;
/**
* The role's key.
*/
key?: string;
/**
* The role's name.
*/
name?: string;
readonly name_i18n?: {
[key: string]: string;
};
/**
* The role's type.
*/
roleType?: number;
readonly 'x-class-name'?: string;
};
export type Account = {
accountContactInformation?: AccountContactInformation;
/**
* A list of the account's account groups.
*/
readonly accountGroupBriefs?: Array<AccountGroupBrief>;
/**
* A list of the account's roles.
*/
readonly accountRoles?: Array<AccountRole>;
/**
* The users linked to the account
*/
accountUserAccounts?: Array<UserAccount>;
/**
* Block of actions allowed by the user making the request.
*/
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
creator?: Creator;
customFields?: Array<CustomField>;
/**
* The account's creation date.
*/
readonly dateCreated?: string;
/**
* The account's most recent modification date.
*/
readonly dateModified?: string;
defaultBillingAddressExternalReferenceCode?: string;
defaultBillingAddressId?: number;
defaultShippingAddressExternalReferenceCode?: string;
defaultShippingAddressId?: number;
description?: string;
/**
* The account's email domains. Users assigned to this account generally will have email addresses under one of these domains.
*/
domains?: Array<string>;
/**
* The optional external key of this account.
*/
externalReferenceCode?: string;
readonly id?: number;
/**
* A list of keywords describing the account.
*/
keywords?: Array<string>;
logoBase64?: string;
logoExternalReferenceCode?: string;
logoId?: number;
logoURL?: string;
name?: string;
/**
* The number of this account's associated users.
*/
readonly numberOfUsers?: number;
organizationExternalReferenceCodes?: Array<string>;
organizationIds?: Array<number>;
parentAccountExternalReferenceCode?: string;
parentAccountId?: number;
permissions?: Array<Permission>;
/**
* The addresses linked to the account
*/
postalAddresses?: Array<PostalAddress>;
status?: number;
taxId?: string;
/**
* The categories associated with this account.
*/
readonly taxonomyCategoryBriefs?: Array<TaxonomyCategoryBrief>;
readonly 'x-class-name'?: string;
type?: 'business' | 'guest' | 'person' | 'supplier';
};
/**
* The account's contact information.
*/
export type AccountContactInformation = {
/**
* A list of the account's email addresses, with one optionally marked as primary.
*/
emailAddresses?: Array<EmailAddress>;
/**
* The account's Facebook account.
*/
facebook?: string;
/**
* The ID of the `contactInformation`.
*/
readonly id?: number;
/**
* The account's Jabber handle.
*/
jabber?: string;
/**
* A list of account's postal addresses, with one optionally marked as primary.
*/
postalAddresses?: Array<PostalAddress>;
/**
* The account's Skype handle.
*/
skype?: string;
/**
* The account's SMS number.
*/
sms?: string;
/**
* A list of the account's phone numbers, with one optionally marked as primary.
*/
telephones?: Array<Phone>;
/**
* The account's Twitter handle.
*/
twitter?: string;
/**
* A list of the account's web URLs, with one optionally marked as primary.
*/
webUrls?: Array<WebUrl>;
readonly 'x-class-name'?: string;
};
/**
* A list of the account's account groups.
*/
export type AccountGroupBrief = {
externalReferenceCode?: string;
readonly id?: number;
name?: string;
readonly 'x-class-name'?: string;
};
/**
* A list of the account's roles.
*/
export type AccountRole = {
/**
* The primary key of the account that owns this role.
*/
readonly accountId?: number;
description?: string;
displayName?: string;
/**
* The optional external key of this account role.
*/
externalReferenceCode?: string;
readonly id?: number;
name?: string;
/**
* The primary key of the underlying system role.
*/
readonly roleId?: number;
/**
* The role's type.
*/
readonly roleType?: number;
readonly 'x-class-name'?: string;
};
/**
* The user's asset libraries.
*/
export type AssetLibraryBrief = {
/**
* The asset library's external reference code.
*/
externalReferenceCode?: string;
/**
* The asset library's group ID.
*/
readonly groupId?: number;
/**
* The asset library's name.
*/
readonly name?: string;
readonly 'x-class-name'?: string;
};
/**
* A list of the user's email addresses, with one optionally marked as primary.
*/
export type EmailAddress = {
/**
* The email address.
*/
emailAddress?: string;
/**
* The email address's external reference code.
*/
externalReferenceCode?: string;
/**
* The email address's ID.
*/
readonly id?: number;
/**
* A flag that indicates whether this is the main email address of the user/organization.
*/
primary?: boolean;
/**
* The email address's type.
*/
type?: string;
readonly 'x-class-name'?: string;
};
/**
* A list of the user's organizations.
*/
export type OrganizationBrief = {
/**
* The organization's external reference code.
*/
readonly externalReferenceCode?: string;
/**
* The organization's ID.
*/
readonly id?: number;
/**
* The organization's name.
*/
readonly name?: string;
/**
* A list of the user's roles.
*/
readonly roleBriefs?: Array<RoleBrief>;
readonly 'x-class-name'?: string;
};
/**
* A list of the user's phone numbers, with one optionally marked as primary.
*/
export type Phone = {
/**
* The phone number's extension.
*/
extension?: string;
/**
* The phone number's external reference code.
*/
externalReferenceCode?: string;
/**
* The phone number's ID.
*/
id?: number;
/**
* The phone number without its extension.
*/
phoneNumber?: string;
/**
* The phone number's type.
*/
phoneType?: string;
/**
* A flag that identifies whether this is the main phone number of the user/organization.
*/
primary?: boolean;
readonly 'x-class-name'?: string;
};
/**
* A list of user's postal addresses, with one optionally marked as primary.
*/
export type PostalAddress = {
/**
* The address's country (e.g., USA).
*/
addressCountry?: string;
addressCountry_i18n?: {
[key: string]: string;
};
/**
* The address's locality (e.g., city).
*/
addressLocality?: string;
/**
* The address's region (e.g., state).
*/
addressRegion?: string;
/**
* The address's subtype.
*/
addressSubtype?: string;
/**
* The address's type.
*/
addressType?: string;
/**
* The optional external key of this address.
*/
externalReferenceCode?: string;
/**
* The address's ID.
*/
readonly id?: number;
/**
* The address's name.
*/
name?: string;
/**
* The phone number.
*/
phoneNumber?: string;
/**
* The address's postal code (e.g., zip code).
*/
postalCode?: string;
/**
* A flag that identifies whether this is the main address of the user/organization.
*/
primary?: boolean;
/**
* The street address's first line (e.g., 1600 Amphitheatre Pkwy.).
*/
streetAddressLine1?: string;
/**
* The street address's second line.
*/
streetAddressLine2?: string;
/**
* The street address's third line.
*/
streetAddressLine3?: string;
readonly 'x-class-name'?: string;
};
/**
* A list of the user's sites.
*/
export type SiteBrief = {
/**
* The site's descriptive name.
*/
readonly descriptiveName?: string;
readonly descriptiveName_i18n?: {
[key: string]: string;
};
/**
* The site's external reference code.
*/
readonly externalReferenceCode?: string;
/**
* The site's ID.
*/
readonly id?: number;
/**
* The site's name.
*/
readonly name?: string;
readonly name_i18n?: {
[key: string]: string;
};
/**
* A list of the user's roles.
*/
readonly roleBriefs?: Array<RoleBrief>;
readonly 'x-class-name'?: string;
};
/**
* The categories associated with this user.
*/
export type TaxonomyCategoryBrief = {
/**
* Optional field with the embedded taxonomy category, can be embedded with nestedFields
*/
readonly embeddedTaxonomyCategory?: {
[key: string]: unknown;
};
/**
* The category's ID.
*/
readonly taxonomyCategoryId?: number;
/**
* The category's name.
*/
readonly taxonomyCategoryName?: string;
/**
* The localized category's names.
*/
readonly taxonomyCategoryName_i18n?: {
[key: string]: string;
};
taxonomyCategoryReference?: TaxonomyCategoryReference;
readonly 'x-class-name'?: string;
};
/**
* A unique reference to a taxonomy category.
*/
export type TaxonomyCategoryReference = {
/**
* The taxonomy category's external reference code.
*/
externalReferenceCode?: string;
/**
* The key of the site or asset library where the taxonomy category is located.
*/
siteKey?: string;
readonly 'x-class-name'?: string;
};
export type UserAccount = {
/**
* A list of the user's account.
*/
readonly accountBriefs?: Array<AccountBrief>;
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
/**
* The user's additional name (e.g., middle name).
*/
additionalName?: string;
/**
* The user's alias or screen name.
*/
alternateName?: string;
/**
* The user's asset libraries.
*/
readonly assetLibraryBriefs?: Array<AssetLibraryBrief>;
/**
* The user's date of birth.
*/
birthDate?: string;
creator?: Creator;
currentPassword?: string;
customFields?: Array<CustomField>;
/**
* A relative URL to the user's dashboard.
*/
readonly dashboardURL?: string;
/**
* The creation date of the user's account.
*/
readonly dateCreated?: string;
/**
* The last time any field of the user's account was changed.
*/
readonly dateModified?: string;
/**
* The user's main email address.
*/
emailAddress?: string;
/**
* The optional external key of this user account.
*/
externalReferenceCode?: string;
/**
* The user's surname (last name).
*/
familyName?: string;
/**
* The user's first name.
*/
givenName?: string;
/**
* A flag that indicates whether the user has been signed in.
*/
readonly hasLoginDate?: boolean;
/**
* The user's title (e.g., Dr., Mr., Mrs, Ms., etc.).
*/
honorificPrefix?: string;
/**
* The user's suffix (e.g., II, Jr., PhD, etc.).
*/
honorificSuffix?: string;
/**
* The user's ID.
*/
id?: number;
/**
* A relative URL to the user's profile image.
*/
readonly image?: string;
/**
* The user's profile image external reference code.
*/
imageExternalReferenceCode?: string;
/**
* The user's profile image id.
*/
imageId?: number;
/**
* The user's job title.
*/
jobTitle?: string;
/**
* A list of keywords describing the user.
*/
readonly keywords?: Array<string>;
/**
* The user's preferred language.
*/
readonly languageDisplayName?: string;
/**
* The user's preferred language id.
*/
languageId?: string;
/**
* The last time the user logged in.
*/
readonly lastLoginDate?: string;
/**
* The user's full name.
*/
readonly name?: string;
/**
* A list of the user's organizations.
*/
readonly organizationBriefs?: Array<OrganizationBrief>;
password?: string;
permissions?: Array<Permission>;
/**
* A relative URL to the user's profile.
*/
readonly profileURL?: string;
/**
* A list of the user's roles.
*/
readonly roleBriefs?: Array<RoleBrief>;
/**
* A list of the user's sites.
*/
readonly siteBriefs?: Array<SiteBrief>;
/**
* The categories associated with this user.
*/
readonly taxonomyCategoryBriefs?: Array<TaxonomyCategoryBrief>;
userAccountContactInformation?: UserAccountContactInformation;
/**
* A list of the user's userGroups.
*/
readonly userGroupBriefs?: Array<UserGroupBrief>;
readonly 'x-class-name'?: string;
/**
* The user's gender.
*/
gender?: 'Male' | 'Female';
/**
* The user's status.
*/
status?: 'Active' | 'Inactive';
};
/**
* The user's contact information.
*/
export type UserAccountContactInformation = {
/**
* A list of the user's email addresses, with one optionally marked as primary.
*/
emailAddresses?: Array<EmailAddress>;
/**
* The user's Facebook account.
*/
facebook?: string;
/**
* The ID of the `contactInformation`.
*/
readonly id?: number;
/**
* The user's Jabber handle.
*/
jabber?: string;
/**
* A list of user's postal addresses, with one optionally marked as primary.
*/
postalAddresses?: Array<PostalAddress>;
/**
* The user's Skype handle.
*/
skype?: string;
/**
* The user's SMS number.
*/
sms?: string;
/**
* A list of the user's phone numbers, with one optionally marked as primary.
*/
telephones?: Array<Phone>;
/**
* The user's Twitter handle.
*/
twitter?: string;
/**
* A list of the user's web URLs, with one optionally marked as primary.
*/
webUrls?: Array<WebUrl>;
readonly 'x-class-name'?: string;
};
/**
* A list of the user's userGroups.
*/
export type UserGroupBrief = {
description?: string;
/**
* The user group's external reference code.
*/
readonly externalReferenceCode?: string;
readonly id?: number;
name?: string;
readonly 'x-class-name'?: string;
};
export type WebUrl = {
/**
* The optional external key of this URL.
*/
externalReferenceCode?: string;
/**
* The URL's ID.
*/
id?: number;
/**
* A flag that identifies whether this is the main web address of the user/organization.
*/
primary?: boolean;
/**
* The absolute URL.
*/
url?: string;
/**
* The URL's type.
*/
urlType?: string;
readonly 'x-class-name'?: string;
};
export type PageAccount = {
items?: Array<Account>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageAccountRole = {
items?: Array<AccountRole>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageEmailAddress = {
items?: Array<EmailAddress>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
/**
* A list of hours when the organization is open. This follows the [`OpeningHoursSpecification`](https://www.schema.org/OpeningHoursSpecification) specification.
*/
export type HoursAvailable = {
/**
* The organization's closing time (in `HH:MM` format).
*/
closes?: string;
/**
* The day of the week.
*/
dayOfWeek?: string;
/**
* The organization's opening time (in `HH:MM` format).
*/
opens?: string;
readonly 'x-class-name'?: string;
};
/**
* The organization's postal information (country and region).
*/
export type Location = {
/**
* The organization's country. This follows the [`addressCountry`](https://schema.org/addressCountry) specification.
*/
addressCountry?: string;
/**
* The organization's country isocode.
*/
readonly addressCountryCode?: string;
addressCountry_i18n?: {
[key: string]: string;
};
/**
* The organization's region. This follows the [`addressRegion`](https://schema.org/addressRegion) specification.
*/
addressRegion?: string;
/**
* The organization's region code.
*/
readonly addressRegionCode?: string;
/**
* The location's ID.
*/
readonly id?: number;
readonly 'x-class-name'?: string;
};
export type Organization = {
/**
* The list of accounts associated with this organization.
*/
readonly accountBriefs?: Array<AccountBrief>;
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
childOrganizations?: Array<Organization>;
/**
* The text of a comment associated with the organization.
*/
comment?: string;
creator?: Creator;
customFields?: Array<CustomField>;
/**
* The organization's creation date.
*/
readonly dateCreated?: string;
/**
* The most recent time any of the organization's fields changed.
*/
readonly dateModified?: string;
/**
* The optional external key of this organization.
*/
externalReferenceCode?: string;
/**
* The organization's ID.
*/
id?: string;
/**
* A relative URL to the organization's image.
*/
readonly image?: string;
imageBase64?: string;
/**
* The organization's image external reference code.
*/
imageExternalReferenceCode?: string;
/**
* The organization's image id.
*/
imageId?: number;
/**
* A list of keywords describing the organization.
*/
keywords?: Array<string>;
location?: Location;
/**
* The organization's name.
*/
name?: string;
/**
* The number of this organization's associated accounts.
*/
readonly numberOfAccounts?: number;
/**
* The number of this organization's child organizations.
*/
readonly numberOfOrganizations?: number;
/**
* The number of this organization's associated users.
*/
readonly numberOfUsers?: number;
organizationAccounts?: Array<Account>;
organizationContactInformation?: OrganizationContactInformation;
parentOrganization?: Organization;
permissions?: Array<Permission>;
/**
* The list of roles associated with this organization.
*/
readonly roleBriefs?: Array<RoleBrief>;
/**
* A list of services the organization provides. This follows the [`Service`](https://www.schema.org/Service) specification.
*/
services?: Array<Service>;
/**
* The categories associated with this organization.
*/
readonly taxonomyCategoryBriefs?: Array<TaxonomyCategoryBrief>;
/**
* The tree path of the organization.
*/
treePath?: string;
/**
* The list of users associated with this organization.
*/
readonly userAccountBriefs?: Array<UserAccountBrief>;
userAccounts?: Array<UserAccount>;
readonly 'x-class-name'?: string;
};
/**
* The organization's contact information, which includes email addresses, postal addresses, phone numbers, and web URLs. This is modeled internally as a `Contact`.
*/
export type OrganizationContactInformation = {
/**
* The organization's email addresses, with one optionally marked as primary.
*/
emailAddresses?: Array<EmailAddress>;
/**
* The organization's postal addresses, with one optionally marked as primary.
*/
postalAddresses?: Array<PostalAddress>;
/**
* The organization's phones numbers, with one optionally marked as primary.
*/
telephones?: Array<Phone>;
/**
* The organization's web URLs, with one optionally marked as primary.
*/
webUrls?: Array<WebUrl>;
readonly 'x-class-name'?: string;
};
/**
* A list of services the organization provides. This follows the [`Service`](https://www.schema.org/Service) specification.
*/
export type Service = {
/**
* A list of hours when the organization is open. This follows the [`OpeningHoursSpecification`](https://www.schema.org/OpeningHoursSpecification) specification.
*/
hoursAvailable?: Array<HoursAvailable>;
/**
* The type of service the organization provides.
*/
serviceType?: string;
readonly 'x-class-name'?: string;
};
/**
* The list of users associated with this user group.
*/
export type UserAccountBrief = {
/**
* The user's alias or screen name.
*/
alternateName?: string;
/**
* The user's main email address.
*/
emailAddress?: string;
/**
* The optional external key of this user account.
*/
externalReferenceCode?: string;
/**
* The user's ID.
*/
id?: number;
/**
* The user's full name.
*/
readonly name?: string;
readonly 'x-class-name'?: string;
};
export type PageOrganization = {
items?: Array<Organization>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageUserAccount = {
items?: Array<UserAccount>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PagePhone = {
items?: Array<Phone>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PagePostalAddress = {
items?: Array<PostalAddress>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Role = {
/**
* Block of actions that the user can perform with the roles.
*/
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
/**
* A list of languages for which the role has a translation.
*/
readonly availableLanguages?: Array<string>;
creator?: Creator;
/**
* The role's creation date.
*/
readonly dateCreated?: string;
/**
* The last time any of the role's fields were changed.
*/
readonly dateModified?: string;
/**
* The role's description.
*/
description?: string;
description_i18n?: {
[key: string]: string;
};
/**
* The optional external key of this role.
*/
externalReferenceCode?: string;
/**
* The role's ID.
*/
readonly id?: number;
/**
* The role's name.
*/
name?: string;
name_i18n?: {
[key: string]: string;
};
permissions?: Array<Permission>;
rolePermissions?: Array<RolePermission>;
/**
* The role's type.
*/
roleType?: string;
readonly 'x-class-name'?: string;
};
export type RolePermission = {
actionIds?: Array<string>;
id?: number;
label?: string;
primaryKey?: string;
resourceName?: string;
roleId?: number;
scope?: number;
readonly 'x-class-name'?: string;
};
export type PageRole = {
items?: Array<Role>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageSegment = {
items?: Array<Segment>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
/**
* Represents a set of users that meet certain criteria. Segments may be used to create customized experiences for users.
*/
export type Segment = {
/**
* A flag that indicates whether the segment is active.
*/
readonly active?: boolean;
/**
* The segment's criteria.
*/
readonly criteria: string;
/**
* The segment's criteria in JSON.
*/
readonly criteriaValue?: {
[key: string]: {
[key: string]: unknown;
};
};
/**
* The segment's creation date.
*/
readonly dateCreated?: string;
/**
* The segment's most recent modification date.
*/
readonly dateModified?: string;
/**
* The segment's ID.
*/
readonly id?: number;
/**
* The segment's name.
*/
readonly name: string;
/**
* The ID of the segment's site.
*/
readonly siteId?: number;
/**
* The segment's source.
*/
readonly source?: string;
readonly 'x-class-name'?: string;
};
export type PageSegmentUser = {
items?: Array<SegmentUser>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type SegmentUser = {
/**
* The user's email address.
*/
readonly emailAddress?: string;
/**
* The user's ID.
*/
readonly id?: number;
/**
* The user's full name.
*/
readonly name?: string;
readonly 'x-class-name'?: string;
};
export type PageSharedAsset = {
items?: Array<SharedAsset>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type SharedAsset = {
/**
* The shared asset actions.
*/
readonly actionIds?: Array<string>;
/**
* Block of actions allowed by the user making the request.
*/
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
/**
* The shared asset type.
*/
readonly assetType?: string;
readonly className?: string;
readonly classPK?: number;
creator?: Creator;
/**
* The shared asset creation date.
*/
readonly dateCreated?: string;
/**
* The shared asset modified date.
*/
readonly dateModified?: string;
/**
* The shared asset external reference code.
*/
readonly externalReferenceCode?: string;
/**
* The shared asset file type icon.
*/
readonly fileTypeIcon?: string;
/**
* The shared asset file type icon color.
*/
readonly fileTypeIconColor?: string;
/**
* The shared asset ID.
*/
readonly id?: number;
/**
* Whether the shared asset is shareable or not
*/
readonly shareable?: boolean;
/**
* The name of the site to which this shared asset is scoped.
*/
readonly siteName?: string;
/**
* The shared asset title.
*/
readonly title?: string;
readonly 'x-class-name'?: string;
};
export type PageSite = {
items?: Array<Site>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Site = {
availableLanguages?: Array<string>;
creator?: Creator;
description?: string;
description_i18n?: {
[key: string]: string;
};
descriptiveName?: string;
descriptiveName_i18n?: {
[key: string]: string;
};
friendlyUrlPath?: string;
id?: number;
key?: string;
membershipType?: string;
name?: string;
name_i18n?: {
[key: string]: string;
};
parentSiteId?: number;
sites?: Array<Site>;
readonly 'x-class-name'?: string;
};
export type Subscription = {
contentId?: {
[key: string]: unknown;
};
contentType?: string;
readonly dateCreated?: string;
readonly dateModified?: string;
frequency?: string;
readonly id?: number;
siteId?: number;
readonly 'x-class-name'?: string;
};
export type PageSubscription = {
items?: Array<Subscription>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Ticket = {
readonly expirationDate?: string;
readonly extraInfo?: string;
readonly id?: number;
readonly key?: string;
readonly 'x-class-name'?: string;
};
export type UserAccountFullNameDefinition = {
/**
* A list of the user's account.
*/
readonly userAccountFullNameDefinitionFields?: Array<UserAccountFullNameDefinitionField>;
readonly 'x-class-name'?: string;
};
/**
* A list of the user's account.
*/
export type UserAccountFullNameDefinitionField = {
readonly key?: string;
readonly required?: boolean;
readonly values?: Array<string>;
readonly 'x-class-name'?: string;
};
export type MultipartBody = {
values?: {
[key: string]: string;
};
};
export type UserGroup = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
creator?: Creator;
/**
* The user group's creation date.
*/
readonly dateCreated?: string;
/**
* The user group's most recent modification date.
*/
readonly dateModified?: string;
description?: string;
externalReferenceCode?: string;
readonly id?: number;
name?: string;
permissions?: Array<Permission>;
/**
* The list of roles associated with this user group.
*/
readonly roleBriefs?: Array<RoleBrief>;
/**
* The list of users associated with this user group.
*/
readonly userAccountBriefs?: Array<UserAccountBrief>;
readonly usersCount?: number;
readonly 'x-class-name'?: string;
};
export type PageUserGroup = {
items?: Array<UserGroup>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageWebUrl = {
items?: Array<WebUrl>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type DeleteAccountGroupData = {
body?: never;
path: {
accountGroupId: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/account-groups/{accountGroupId}';
};
export type DeleteAccountGroupResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountGroupData = {
body?: never;
path: {
accountGroupId: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/account-groups/{accountGroupId}';
};
export type GetAccountGroupResponses = {
/**
* default response
*/
default: AccountGroup;
};
export type GetAccountGroupResponse = GetAccountGroupResponses[keyof GetAccountGroupResponses];
export type PatchAccountGroupData = {
body?: AccountGroup;
path: {
accountGroupId: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/account-groups/{accountGroupId}';
};
export type PatchAccountGroupResponses = {
/**
* default response
*/
default: AccountGroup;
};
export type PatchAccountGroupResponse = PatchAccountGroupResponses[keyof PatchAccountGroupResponses];
export type PutAccountGroupData = {
body?: AccountGroup;
path: {
accountGroupId: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/account-groups/{accountGroupId}';
};
export type PutAccountGroupResponses = {
/**
* default response
*/
default: AccountGroup;
};
export type PutAccountGroupResponse = PutAccountGroupResponses[keyof PutAccountGroupResponses];
export type DeleteAccountGroupBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-admin-user/v1.0/account-groups/batch';
};
export type DeleteAccountGroupBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostAccountGroupBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-admin-user/v1.0/account-groups/batch';
};
export type PostAccountGroupBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutAccountGroupBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-admin-user/v1.0/account-groups/batch';
};
export type PutAccountGroupBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteAccountGroupByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/account-groups/by-external-reference-code/{externalReferenceCode}';
};
export type DeleteAccountGroupByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountGroupByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/account-groups/by-external-reference-code/{externalReferenceCode}';
};
export type GetAccountGroupByExternalReferenceCodeResponses = {
/**
* default response
*/
default: AccountGroup;
};
export type GetAccountGroupByExternalReferenceCodeResponse = GetAccountGroupByExternalReferenceCodeResponses[keyof GetAccountGroupByExternalReferenceCodeResponses];
export type PatchAccountGroupByExternalReferenceCodeData = {
body?: AccountGroup;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/account-groups/by-external-reference-code/{externalReferenceCode}';
};
export type PatchAccountGroupByExternalReferenceCodeResponses = {
/**
* default response
*/
default: AccountGroup;
};
export type PatchAccountGroupByExternalReferenceCodeResponse = PatchAccountGroupByExternalReferenceCodeResponses[keyof PatchAccountGroupByExternalReferenceCodeResponses];
export type PutAccountGroupByExternalReferenceCodeData = {
body?: AccountGroup;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/account-groups/by-external-reference-code/{externalReferenceCode}';
};
export type PutAccountGroupByExternalReferenceCodeResponses = {
/**
* default response
*/
default: AccountGroup;
};
export type PutAccountGroupByExternalReferenceCodeResponse = PutAccountGroupByExternalReferenceCodeResponses[keyof PutAccountGroupByExternalReferenceCodeResponses];
export type DeleteAccountGroupByExternalReferenceCodeAccountByExternalReferenceCodeData = {
body?: never;
path: {
accountExternalReferenceCode: string;
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/account-groups/by-external-reference-code/{accountExternalReferenceCode}/accounts/by-external-reference-code/{externalReferenceCode}';
};
export type DeleteAccountGroupByExternalReferenceCodeAccountByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type PostAccountGroupByExternalReferenceCodeAccountByExternalReferenceCodeData = {
body?: never;
path: {
accountExternalReferenceCode: string;
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/account-groups/by-external-reference-code/{accountExternalReferenceCode}/accounts/by-external-reference-code/{externalReferenceCode}';
};
export type PostAccountGroupByExternalReferenceCodeAccountByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountAccountGroupsPageData = {
body?: never;
path: {
accountId: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-admin-user/v1.0/accounts/{accountId}/account-groups';
};
export type GetAccountAccountGroupsPageResponses = {
/**
* default response
*/
default: PageAccountGroup;
};
export type GetAccountAccountGroupsPageResponse = GetAccountAccountGroupsPageResponses[keyof GetAccountAccountGroupsPageResponses];
export type GetAccountByExternalReferenceCodeAccountExternalReferenceCodeAccountGroupsPageData = {
body?: never;
path: {
accountExternalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-admin-user/v1.0/accounts/by-external-reference-code/{accountExternalReferenceCode}/account-groups';
};
export type GetAccountByExternalReferenceCodeAccountExternalReferenceCodeAccountGroupsPageResponses = {
/**
* default response
*/
default: PageAccountGroup;
};
export type GetAccountByExternalReferenceCodeAccountExternalReferenceCodeAccountGroupsPageResponse = GetAccountByExternalReferenceCodeAccountExternalReferenceCodeAccountGroupsPageResponses[keyof GetAccountByExternalReferenceCodeAccountExternalReferenceCodeAccountGroupsPageResponses];
export type GetAccountGroupsPageData = {
body?: never;
path?: never;
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-admin-user/v1.0/account-groups';
};
export type GetAccountGroupsPageResponses = {
/**
* default response
*/
default: PageAccountGroup;
};
export type GetAccountGroupsPageResponse = GetAccountGroupsPageResponses[keyof GetAccountGroupsPageResponses];
export type PostAccountGroupData = {
body?: AccountGroup;
path?: never;
query?: never;
url: '/o/headless-admin-user/v1.0/account-groups';
};
export type PostAccountGroupResponses = {
/**
* default response
*/
default: AccountGroup;
};
export type PostAccountGroupResponse = PostAccountGroupResponses[keyof PostAccountGroupResponses];
export type PostAccountAccountGroupsPageExportBatchData = {
body?: never;
path: {
accountId: string;
};
query?: {
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/headless-admin-user/v1.0/accounts/{accountId}/account-groups/export-batch';
};
export type PostAccountAccountGroupsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostAccountGroupsPageExportBatchData = {
body?: never;
path?: never;
query?: {
filter?: string;
search?: string;
sort?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/headless-admin-user/v1.0/account-groups/export-batch';
};
export type PostAccountGroupsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteAccountData = {
body?: never;
path: {
accountId: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/accounts/{accountId}';
};
export type DeleteAccountResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountData = {
body?: never;
path: {
accountId: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/accounts/{accountId}';
};
export type GetAccountResponses = {
/**
* default response
*/
default: Account;
};
export type GetAccountResponse = GetAccountResponses[keyof GetAccountResponses];
export type PatchAccountData = {
body?: Account;
path: {
accountId: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/accounts/{accountId}';
};
export type PatchAccountResponses = {
/**
* default response
*/
default: Account;
};
export type PatchAccountResponse = PatchAccountResponses[keyof PatchAccountResponses];
export type PutAccountData = {
body?: Account;
path: {
accountId: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/accounts/{accountId}';
};
export type PutAccountResponses = {
/**
* default response
*/
default: Account;
};
export type PutAccountResponse = PutAccountResponses[keyof PutAccountResponses];
export type DeleteAccountBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-admin-user/v1.0/accounts/batch';
};
export type DeleteAccountBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostAccountBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-admin-user/v1.0/accounts/batch';
};
export type PostAccountBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutAccountBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-admin-user/v1.0/accounts/batch';
};
export type PutAccountBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteAccountByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/accounts/by-external-reference-code/{externalReferenceCode}';
};
export type DeleteAccountByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetAccountByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/accounts/by-external-reference-code/{externalReferenceCode}';
};
export type GetAccountByExternalReferenceCodeResponses = {
/**
* default response
*/
default: Account;
};
export type GetAccountByExternalReferenceCodeResponse = GetAccountByExternalReferenceCodeResponses[keyof GetAccountByExternalReferenceCodeResponses];
export type PatchAccountByExternalReferenceCodeData = {
body?: Account;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/accounts/by-external-reference-code/{externalReferenceCode}';
};
export type PatchAccountByExternalReferenceCodeResponses = {
/**
* default response
*/
default: Account;
};
export type PatchAccountByExternalReferenceCodeResponse = PatchAccountByExternalReferenceCodeResponses[keyof PatchAccountByExternalReferenceCodeResponses];
export type PutAccountByExternalReferenceCodeData = {
body?: Account;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/accounts/by-external-reference-code/{externalReferenceCode}';
};
export type PutAccountByExternalReferenceCodeResponses = {
/**
* default response
*/
default: Account;
};
export type PutAccountByExternalReferenceCodeResponse = PutAccountByExternalReferenceCodeResponses[keyof PutAccountByExternalReferenceCodeResponses];
export type DeleteOrganizationAccountsData = {
body?: Array<number>;
path: {
organizationId: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/organizations/{organizationId}/accounts';
};
export type DeleteOrganizationAccountsResponses = {
/**
* default response
*/
default: unknown;
};
export type GetOrganizationAccountsPageData = {
body?: never;
path: {
organizationId: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-admin-user/v1.0/organizations/{organizationId}/accounts';
};
export type GetOrganizationAccountsPageResponses = {
/**
* default response
*/
default: PageAccount;
};
export type GetOrganizationAccountsPageResponse = GetOrganizationAccountsPageResponses[keyof GetOrganizationAccountsPageResponses];
export type PostOrganizationAccountsData = {
body?: Array<number>;
path: {
organizationId: string;
};
query?: never;
url: '/o/headless-admin-user/v1.0/organizations/{organizat