@microsoft/msgraph-sdk/models/termStore/index.d.ts

Microsoft Graph JavaScript client library

import { type BaseCollectionPaginationCountResponse, type Entity, type KeyValue } from '../index.js';
import { type AdditionalDataHolder, type BackedModel, type Parsable, type ParseNode, type SerializationWriter } from '@microsoft/kiota-abstractions';
/**
 * Creates a new instance of the appropriate class based on discriminator value
 * @param parseNode The parse node to use to read the discriminator value and create the object
 * @returns {GroupCollectionResponse}
 */
export declare function createGroupCollectionResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
/**
 * Creates a new instance of the appropriate class based on discriminator value
 * @param parseNode The parse node to use to read the discriminator value and create the object
 * @returns {Group}
 */
export declare function createGroupFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
/**
 * Creates a new instance of the appropriate class based on discriminator value
 * @param parseNode The parse node to use to read the discriminator value and create the object
 * @returns {LocalizedDescription}
 */
export declare function createLocalizedDescriptionFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
/**
 * Creates a new instance of the appropriate class based on discriminator value
 * @param parseNode The parse node to use to read the discriminator value and create the object
 * @returns {LocalizedLabel}
 */
export declare function createLocalizedLabelFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
/**
 * Creates a new instance of the appropriate class based on discriminator value
 * @param parseNode The parse node to use to read the discriminator value and create the object
 * @returns {LocalizedName}
 */
export declare function createLocalizedNameFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
/**
 * Creates a new instance of the appropriate class based on discriminator value
 * @param parseNode The parse node to use to read the discriminator value and create the object
 * @returns {RelationCollectionResponse}
 */
export declare function createRelationCollectionResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
/**
 * Creates a new instance of the appropriate class based on discriminator value
 * @param parseNode The parse node to use to read the discriminator value and create the object
 * @returns {Relation}
 */
export declare function createRelationFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
/**
 * Creates a new instance of the appropriate class based on discriminator value
 * @param parseNode The parse node to use to read the discriminator value and create the object
 * @returns {SetCollectionResponse}
 */
export declare function createSetCollectionResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
/**
 * Creates a new instance of the appropriate class based on discriminator value
 * @param parseNode The parse node to use to read the discriminator value and create the object
 * @returns {Set}
 */
export declare function createSetFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
/**
 * Creates a new instance of the appropriate class based on discriminator value
 * @param parseNode The parse node to use to read the discriminator value and create the object
 * @returns {StoreCollectionResponse}
 */
export declare function createStoreCollectionResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
/**
 * Creates a new instance of the appropriate class based on discriminator value
 * @param parseNode The parse node to use to read the discriminator value and create the object
 * @returns {Store}
 */
export declare function createStoreFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
/**
 * Creates a new instance of the appropriate class based on discriminator value
 * @param parseNode The parse node to use to read the discriminator value and create the object
 * @returns {TermCollectionResponse}
 */
export declare function createTermCollectionResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
/**
 * Creates a new instance of the appropriate class based on discriminator value
 * @param parseNode The parse node to use to read the discriminator value and create the object
 * @returns {Term}
 */
export declare function createTermFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
/**
 * The deserialization information for the current model
 * @param Group The instance to deserialize into.
 * @returns {Record<string, (node: ParseNode) => void>}
 */
export declare function deserializeIntoGroup(group?: Partial<Group> | undefined): Record<string, (node: ParseNode) => void>;
/**
 * The deserialization information for the current model
 * @param GroupCollectionResponse The instance to deserialize into.
 * @returns {Record<string, (node: ParseNode) => void>}
 */
export declare function deserializeIntoGroupCollectionResponse(groupCollectionResponse?: Partial<GroupCollectionResponse> | undefined): Record<string, (node: ParseNode) => void>;
/**
 * The deserialization information for the current model
 * @param LocalizedDescription The instance to deserialize into.
 * @returns {Record<string, (node: ParseNode) => void>}
 */
export declare function deserializeIntoLocalizedDescription(localizedDescription?: Partial<LocalizedDescription> | undefined): Record<string, (node: ParseNode) => void>;
/**
 * The deserialization information for the current model
 * @param LocalizedLabel The instance to deserialize into.
 * @returns {Record<string, (node: ParseNode) => void>}
 */
export declare function deserializeIntoLocalizedLabel(localizedLabel?: Partial<LocalizedLabel> | undefined): Record<string, (node: ParseNode) => void>;
/**
 * The deserialization information for the current model
 * @param LocalizedName The instance to deserialize into.
 * @returns {Record<string, (node: ParseNode) => void>}
 */
export declare function deserializeIntoLocalizedName(localizedName?: Partial<LocalizedName> | undefined): Record<string, (node: ParseNode) => void>;
/**
 * The deserialization information for the current model
 * @param Relation The instance to deserialize into.
 * @returns {Record<string, (node: ParseNode) => void>}
 */
export declare function deserializeIntoRelation(relation?: Partial<Relation> | undefined): Record<string, (node: ParseNode) => void>;
/**
 * The deserialization information for the current model
 * @param RelationCollectionResponse The instance to deserialize into.
 * @returns {Record<string, (node: ParseNode) => void>}
 */
export declare function deserializeIntoRelationCollectionResponse(relationCollectionResponse?: Partial<RelationCollectionResponse> | undefined): Record<string, (node: ParseNode) => void>;
/**
 * The deserialization information for the current model
 * @param Set The instance to deserialize into.
 * @returns {Record<string, (node: ParseNode) => void>}
 */
export declare function deserializeIntoSet(set?: Partial<Set> | undefined): Record<string, (node: ParseNode) => void>;
/**
 * The deserialization information for the current model
 * @param SetCollectionResponse The instance to deserialize into.
 * @returns {Record<string, (node: ParseNode) => void>}
 */
export declare function deserializeIntoSetCollectionResponse(setCollectionResponse?: Partial<SetCollectionResponse> | undefined): Record<string, (node: ParseNode) => void>;
/**
 * The deserialization information for the current model
 * @param Store The instance to deserialize into.
 * @returns {Record<string, (node: ParseNode) => void>}
 */
export declare function deserializeIntoStore(store?: Partial<Store> | undefined): Record<string, (node: ParseNode) => void>;
/**
 * The deserialization information for the current model
 * @param StoreCollectionResponse The instance to deserialize into.
 * @returns {Record<string, (node: ParseNode) => void>}
 */
export declare function deserializeIntoStoreCollectionResponse(storeCollectionResponse?: Partial<StoreCollectionResponse> | undefined): Record<string, (node: ParseNode) => void>;
/**
 * The deserialization information for the current model
 * @param Term The instance to deserialize into.
 * @returns {Record<string, (node: ParseNode) => void>}
 */
export declare function deserializeIntoTerm(term?: Partial<Term> | undefined): Record<string, (node: ParseNode) => void>;
/**
 * The deserialization information for the current model
 * @param TermCollectionResponse The instance to deserialize into.
 * @returns {Record<string, (node: ParseNode) => void>}
 */
export declare function deserializeIntoTermCollectionResponse(termCollectionResponse?: Partial<TermCollectionResponse> | undefined): Record<string, (node: ParseNode) => void>;
export interface Group extends Entity, Parsable {
    /**
     * Date and time of the group creation. Read-only.
     */
    createdDateTime?: Date | null;
    /**
     * Description that gives details on the term usage.
     */
    description?: string | null;
    /**
     * Name of the group.
     */
    displayName?: string | null;
    /**
     * ID of the parent site of this group.
     */
    parentSiteId?: string | null;
    /**
     * Returns the type of the group. Possible values are: global, system, and siteCollection.
     */
    scope?: TermGroupScope | null;
    /**
     * All sets under the group in a term [store].
     */
    sets?: Set[] | null;
}
export interface GroupCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable {
    /**
     * The value property
     */
    value?: Group[] | null;
}
export interface LocalizedDescription extends AdditionalDataHolder, BackedModel, Parsable {
    /**
     * Stores model information.
     */
    backingStoreEnabled?: boolean | null;
    /**
     * The description in the localized language.
     */
    description?: string | null;
    /**
     * The language tag for the label.
     */
    languageTag?: string | null;
    /**
     * The OdataType property
     */
    odataType?: string | null;
}
export interface LocalizedLabel extends AdditionalDataHolder, BackedModel, Parsable {
    /**
     * Stores model information.
     */
    backingStoreEnabled?: boolean | null;
    /**
     * Indicates whether the label is the default label.
     */
    isDefault?: boolean | null;
    /**
     * The language tag for the label.
     */
    languageTag?: string | null;
    /**
     * The name of the label.
     */
    name?: string | null;
    /**
     * The OdataType property
     */
    odataType?: string | null;
}
export interface LocalizedName extends AdditionalDataHolder, BackedModel, Parsable {
    /**
     * Stores model information.
     */
    backingStoreEnabled?: boolean | null;
    /**
     * The language tag for the label.
     */
    languageTag?: string | null;
    /**
     * The name in the localized language.
     */
    name?: string | null;
    /**
     * The OdataType property
     */
    odataType?: string | null;
}
export interface Relation extends Entity, Parsable {
    /**
     * The from [term] of the relation. The term from which the relationship is defined. A null value would indicate the relation is directly with the [set].
     */
    fromTerm?: Term | null;
    /**
     * The type of relation. Possible values are: pin, reuse.
     */
    relationship?: RelationType | null;
    /**
     * The [set] in which the relation is relevant.
     */
    set?: Set | null;
    /**
     * The to [term] of the relation. The term to which the relationship is defined.
     */
    toTerm?: Term | null;
}
export interface RelationCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable {
    /**
     * The value property
     */
    value?: Relation[] | null;
}
export type RelationType = (typeof RelationTypeObject)[keyof typeof RelationTypeObject];
/**
 * Serializes information the current object
 * @param Group The instance to serialize from.
 * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
 * @param writer Serialization writer to use to serialize this model
 */
export declare function serializeGroup(writer: SerializationWriter, group?: Partial<Group> | undefined | null, isSerializingDerivedType?: boolean): void;
/**
 * Serializes information the current object
 * @param GroupCollectionResponse The instance to serialize from.
 * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
 * @param writer Serialization writer to use to serialize this model
 */
export declare function serializeGroupCollectionResponse(writer: SerializationWriter, groupCollectionResponse?: Partial<GroupCollectionResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
/**
 * Serializes information the current object
 * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
 * @param LocalizedDescription The instance to serialize from.
 * @param writer Serialization writer to use to serialize this model
 */
export declare function serializeLocalizedDescription(writer: SerializationWriter, localizedDescription?: Partial<LocalizedDescription> | undefined | null, isSerializingDerivedType?: boolean): void;
/**
 * Serializes information the current object
 * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
 * @param LocalizedLabel The instance to serialize from.
 * @param writer Serialization writer to use to serialize this model
 */
export declare function serializeLocalizedLabel(writer: SerializationWriter, localizedLabel?: Partial<LocalizedLabel> | undefined | null, isSerializingDerivedType?: boolean): void;
/**
 * Serializes information the current object
 * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
 * @param LocalizedName The instance to serialize from.
 * @param writer Serialization writer to use to serialize this model
 */
export declare function serializeLocalizedName(writer: SerializationWriter, localizedName?: Partial<LocalizedName> | undefined | null, isSerializingDerivedType?: boolean): void;
/**
 * Serializes information the current object
 * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
 * @param Relation The instance to serialize from.
 * @param writer Serialization writer to use to serialize this model
 */
export declare function serializeRelation(writer: SerializationWriter, relation?: Partial<Relation> | undefined | null, isSerializingDerivedType?: boolean): void;
/**
 * Serializes information the current object
 * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
 * @param RelationCollectionResponse The instance to serialize from.
 * @param writer Serialization writer to use to serialize this model
 */
export declare function serializeRelationCollectionResponse(writer: SerializationWriter, relationCollectionResponse?: Partial<RelationCollectionResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
/**
 * Serializes information the current object
 * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
 * @param Set The instance to serialize from.
 * @param writer Serialization writer to use to serialize this model
 */
export declare function serializeSet(writer: SerializationWriter, set?: Partial<Set> | undefined | null, isSerializingDerivedType?: boolean): void;
/**
 * Serializes information the current object
 * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
 * @param SetCollectionResponse The instance to serialize from.
 * @param writer Serialization writer to use to serialize this model
 */
export declare function serializeSetCollectionResponse(writer: SerializationWriter, setCollectionResponse?: Partial<SetCollectionResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
/**
 * Serializes information the current object
 * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
 * @param Store The instance to serialize from.
 * @param writer Serialization writer to use to serialize this model
 */
export declare function serializeStore(writer: SerializationWriter, store?: Partial<Store> | undefined | null, isSerializingDerivedType?: boolean): void;
/**
 * Serializes information the current object
 * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
 * @param StoreCollectionResponse The instance to serialize from.
 * @param writer Serialization writer to use to serialize this model
 */
export declare function serializeStoreCollectionResponse(writer: SerializationWriter, storeCollectionResponse?: Partial<StoreCollectionResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
/**
 * Serializes information the current object
 * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
 * @param Term The instance to serialize from.
 * @param writer Serialization writer to use to serialize this model
 */
export declare function serializeTerm(writer: SerializationWriter, term?: Partial<Term> | undefined | null, isSerializingDerivedType?: boolean): void;
/**
 * Serializes information the current object
 * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type.
 * @param TermCollectionResponse The instance to serialize from.
 * @param writer Serialization writer to use to serialize this model
 */
export declare function serializeTermCollectionResponse(writer: SerializationWriter, termCollectionResponse?: Partial<TermCollectionResponse> | undefined | null, isSerializingDerivedType?: boolean): void;
export interface Set extends Entity, Parsable {
    /**
     * Children terms of set in term [store].
     */
    children?: Term[] | null;
    /**
     * Date and time of set creation. Read-only.
     */
    createdDateTime?: Date | null;
    /**
     * Description that gives details on the term usage.
     */
    description?: string | null;
    /**
     * Name of the set for each languageTag.
     */
    localizedNames?: LocalizedName[] | null;
    /**
     * The parentGroup property
     */
    parentGroup?: Group | null;
    /**
     * Custom properties for the set.
     */
    properties?: KeyValue[] | null;
    /**
     * Indicates which terms have been pinned or reused directly under the set.
     */
    relations?: Relation[] | null;
    /**
     * All the terms under the set.
     */
    terms?: Term[] | null;
}
export interface SetCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable {
    /**
     * The value property
     */
    value?: Set[] | null;
}
export interface Store extends Entity, Parsable {
    /**
     * Default language of the term store.
     */
    defaultLanguageTag?: string | null;
    /**
     * Collection of all groups available in the term store.
     */
    groups?: Group[] | null;
    /**
     * List of languages for the term store.
     */
    languageTags?: string[] | null;
    /**
     * Collection of all sets available in the term store. This relationship can only be used to load a specific term set.
     */
    sets?: Set[] | null;
}
export interface StoreCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable {
    /**
     * The value property
     */
    value?: Store[] | null;
}
export interface Term extends Entity, Parsable {
    /**
     * Children of current term.
     */
    children?: Term[] | null;
    /**
     * Date and time of term creation. Read-only.
     */
    createdDateTime?: Date | null;
    /**
     * Description about term that is dependent on the languageTag.
     */
    descriptions?: LocalizedDescription[] | null;
    /**
     * Label metadata for a term.
     */
    labels?: LocalizedLabel[] | null;
    /**
     * Last date and time of term modification. Read-only.
     */
    lastModifiedDateTime?: Date | null;
    /**
     * Collection of properties on the term.
     */
    properties?: KeyValue[] | null;
    /**
     * To indicate which terms are related to the current term as either pinned or reused.
     */
    relations?: Relation[] | null;
    /**
     * The [set] in which the term is created.
     */
    set?: Set | null;
}
export interface TermCollectionResponse extends BaseCollectionPaginationCountResponse, Parsable {
    /**
     * The value property
     */
    value?: Term[] | null;
}
export type TermGroupScope = (typeof TermGroupScopeObject)[keyof typeof TermGroupScopeObject];
export declare const RelationTypeObject: {
    readonly Pin: "pin";
    readonly Reuse: "reuse";
    readonly UnknownFutureValue: "unknownFutureValue";
};
export declare const TermGroupScopeObject: {
    readonly Global: "global";
    readonly System: "system";
    readonly SiteCollection: "siteCollection";
    readonly UnknownFutureValue: "unknownFutureValue";
};
//# sourceMappingURL=index.d.ts.map