UNPKG

gd-sprest-def

Version:

TypeScript definition files generated from the $metadata REST endpoint in SharePoint.

1,197 lines (1,011 loc) 382 kB
import { Base } from "../"; import { SP } from "../"; import { Microsoft } from "../"; /********************************************* * IApiMetadata **********************************************/ export interface IApiMetadata extends ApiMetadataCollections, ApiMetadataMethods, Base.IBaseQuery<ApiMetadata, IApiMetadataQuery> { } /********************************************* * IApiMetadataCollection **********************************************/ export interface IApiMetadataCollection extends Base.IBaseResults<ApiMetadata> { done?: (resolve: (value?: Array<ApiMetadata>) => void) => void; } /********************************************* * IApiMetadataQueryCollection **********************************************/ export interface IApiMetadataQueryCollection extends Base.IBaseResults<ApiMetadataOData> { done?: (resolve: (value?: Array<ApiMetadataOData>) => void) => void; } /********************************************* * IApiMetadataQuery **********************************************/ export interface IApiMetadataQuery extends ApiMetadataOData, ApiMetadataMethods { } /********************************************* * ApiMetadata **********************************************/ export interface ApiMetadata extends Base.IBaseResult, ApiMetadataProps, ApiMetadataCollections, ApiMetadataMethods { } /********************************************* * ApiMetadataProps **********************************************/ export interface ApiMetadataProps { Id4a81de82eeb94d6080ea5bf63e27023a?: string; } /********************************************* * ApiMetadataPropMethods **********************************************/ export interface ApiMetadataPropMethods { Current(): Base.IBaseQuery<SP.ApiMetadata, SP.ApiMetadataOData> & SP.ApiMetadataCollections; } /********************************************* * ApiMetadataCollections **********************************************/ export interface ApiMetadataCollections extends ApiMetadataPropMethods { Types(): Base.IBaseCollection<SP.TypeInformation>; Types(id: string | number): Base.IBaseQuery<SP.TypeInformation> & SP.TypeInformationCollections; } /********************************************* * ApiMetadataOData **********************************************/ export interface ApiMetadataOData extends Base.IBaseResult, ApiMetadataProps, ApiMetadataMethods { Current: SP.ApiMetadata & SP.ApiMetadataCollections; Types: Base.IBaseResults<SP.TypeInformation>; } /********************************************* * ApiMetadataMethods **********************************************/ export interface ApiMetadataMethods { } /********************************************* * TypeInformation **********************************************/ export interface TypeInformation { BaseTypeFullName?: string; FullName?: string; IsValueObject?: boolean; Methods?: { results: Array<SP.MethodInformation> }; Properties?: { results: Array<SP.PropertyInformation> }; } /********************************************* * TypeInformationCollections **********************************************/ export interface TypeInformationCollections { } /********************************************* * ISite **********************************************/ export interface ISite extends SiteCollections, SiteMethods, Base.IBaseQuery<Site, ISiteQuery> { } /********************************************* * ISiteCollection **********************************************/ export interface ISiteCollection extends Base.IBaseResults<Site> { done?: (resolve: (value?: Array<Site>) => void) => void; } /********************************************* * ISiteQueryCollection **********************************************/ export interface ISiteQueryCollection extends Base.IBaseResults<SiteOData> { done?: (resolve: (value?: Array<SiteOData>) => void) => void; } /********************************************* * ISiteQuery **********************************************/ export interface ISiteQuery extends SiteOData, SiteMethods { } /********************************************* * Site **********************************************/ export interface Site extends Base.IBaseResult, SiteProps, SiteCollections, SiteMethods { } /********************************************* * SiteProps **********************************************/ export interface SiteProps { AllowCreateDeclarativeWorkflow?: boolean; AllowDesigner?: boolean; AllowedExternalDomains?: SP.HTMLFieldSecuritySetting; AllowExternalEmbeddingWrapper?: number; AllowMasterPageEditing?: boolean; AllowRevertFromTemplate?: boolean; AllowSaveDeclarativeWorkflowAsTemplate?: boolean; AllowSavePublishDeclarativeWorkflow?: boolean; AllowSelfServiceUpgrade?: boolean; AllowSelfServiceUpgradeEvaluation?: boolean; AuditLogTrimmingRetention?: number; CanSyncHubSitePermissions?: boolean; CanUpgrade?: boolean; ChannelGroupId?: any; Classification?: string; CommentsOnSitePagesDisabled?: boolean; CompatibilityLevel?: number; ComplianceAttribute?: string; CurrentChangeToken?: SP.ChangeToken; CustomizedFormsPages?: SP.CustomizedFormsPageCollection; DisableAppViews?: boolean; DisableCompanyWideSharingLinks?: boolean; DisableFlows?: boolean; ExternalSharingTipsEnabled?: boolean; ExternalUserExpirationInDays?: number; GeoLocation?: string; GroupId?: any; HubSiteId?: any; Id?: any; SensitivityLabelId?: string; SensitivityLabel?: any; IsExternalWorkspace?: boolean; IsHubSite?: boolean; IsRestrictContentOrgWideSearchPolicyEnforcedOnSite?: boolean; IsRestrictedAccessControlPolicyEnforcedOnSite?: boolean; IsRubySite?: boolean; IsUnlicensedOdb?: boolean; LockIssue?: string; MaxItemsPerThrottledOperation?: number; MediaTranscriptionDisabled?: boolean; NeedsB2BUpgrade?: boolean; ResourcePath?: SP.ResourcePath; PrimaryUri?: string; ReadOnly?: boolean; RelatedGroupId?: any; RequiredDesignerVersion?: string; RestrictedAccessControlGroupsEnforcedOnSite?: { results: Array<string> }; SandboxedCodeActivationCapability?: number; SearchBoxInNavBar?: number; SearchBoxPlaceholderText?: string; SensitivityLabelInfo?: SP.SensitivityLabelInfo; ServerRelativePath?: SP.ResourcePath; ServerRelativeUrl?: string; ShareByEmailEnabled?: boolean; ShareByLinkEnabled?: boolean; ShowPeoplePickerSuggestionsForGuestUsers?: boolean; ShowUrlStructure?: boolean; SitePolicyEnabled?: boolean; SocialBarOnSitePagesDisabled?: boolean; StatusBarLink?: string; StatusBarText?: string; ThicketSupportDisabled?: boolean; TrimAuditLog?: boolean; UIVersionConfigurationEnabled?: boolean; UnifiedDomainUrl?: string; UnlicensedOdbLicenseEnforcementWarningContext?: Microsoft.SharePoint.Administration.OdbLicenseEnforcement.UnlicensedOdbLicenseEnforcementWarningContext; UpgradeInfo?: SP.UpgradeInfo; UpgradeReminderDate?: any; UpgradeScheduled?: boolean; UpgradeScheduledDate?: any; Upgrading?: boolean; Url?: string; Usage?: SP.UsageInfo; WriteLocked?: boolean; } /********************************************* * SitePropMethods **********************************************/ export interface SitePropMethods { Audit(): Base.IBaseExecution<SP.Audit> & SP.AuditCollections & SP.AuditMethods; HubSiteSynchronizableVisitorGroup(): Base.IBaseQuery<SP.Group, SP.GroupOData> & SP.GroupCollections & SP.GroupMethods; Owner(): Base.IBaseQuery<SP.User, SP.UserOData> & SP.UserCollections & SP.UserMethods; RootWeb(): Base.IBaseQuery<SP.Web, SP.WebOData> & SP.WebCollections & SP.WebMethods; SecondaryContact(): Base.IBaseQuery<SP.User, SP.UserOData> & SP.UserCollections & SP.UserMethods; VersionPolicyForNewLibrariesTemplate(): Base.IBaseQuery<SP.SiteVersionPolicyManager, SP.SiteVersionPolicyManagerOData> & SP.SiteVersionPolicyManagerCollections & SP.SiteVersionPolicyManagerMethods; } /********************************************* * SiteCollections **********************************************/ export interface SiteCollections extends SitePropMethods { CustomScriptSafeDomains(): Base.IBaseCollection<SP.ScriptSafeDomain> & SP.ScriptSafeDomainCollectionMethods; CustomScriptSafeDomains(id: string | number): Base.IBaseQuery<SP.ScriptSafeDomain> & SP.ScriptSafeDomainCollections & SP.ScriptSafeDomainMethods; EventReceivers(): Base.IBaseCollection<SP.EventReceiverDefinition> & SP.EventReceiverDefinitionCollectionMethods; EventReceivers(id: string | number): Base.IBaseQuery<SP.EventReceiverDefinition> & SP.EventReceiverDefinitionCollections & SP.EventReceiverDefinitionMethods; Features(): Base.IBaseCollection<SP.Feature> & SP.FeatureCollectionMethods; Features(id: string | number): Base.IBaseQuery<SP.Feature> & SP.FeatureCollections; RecycleBin(): Base.IBaseCollection<SP.RecycleBinItem, SP.RecycleBinItemOData, Base.IBaseExecution & SP.RecycleBinItemCollectionMethods> & Base.IBaseExecution & SP.RecycleBinItemCollectionMethods; RecycleBin(id: string | number): Base.IBaseQuery<SP.RecycleBinItem, SP.RecycleBinItemOData> & SP.RecycleBinItemCollections & SP.RecycleBinItemMethods; UserCustomActions(): Base.IBaseCollection<SP.UserCustomAction, SP.UserCustomActionOData, Base.IBaseExecution & SP.UserCustomActionCollectionMethods> & Base.IBaseExecution & SP.UserCustomActionCollectionMethods; UserCustomActions(id: string | number): Base.IBaseQuery<SP.UserCustomAction, SP.UserCustomActionOData> & SP.UserCustomActionCollections & SP.UserCustomActionMethods; } /********************************************* * SiteOData **********************************************/ export interface SiteOData extends Base.IBaseResult, SiteProps, SiteMethods { Audit: SP.Audit & SP.AuditCollections; CustomScriptSafeDomains: Base.IBaseResults<SP.ScriptSafeDomain> & SP.ScriptSafeDomainCollectionMethods; EventReceivers: Base.IBaseResults<SP.EventReceiverDefinition> & SP.EventReceiverDefinitionCollectionMethods; Features: Base.IBaseResults<SP.Feature> & SP.FeatureCollectionMethods; HubSiteSynchronizableVisitorGroup: SP.Group & SP.GroupCollections & SP.GroupCollectionMethods; Owner: SP.User & SP.UserCollections & SP.UserCollectionMethods; RecycleBin: Base.IBaseResults<SP.RecycleBinItem> & SP.RecycleBinItemCollectionMethods; RootWeb: SP.Web & SP.WebCollections & SP.WebCollectionMethods; SecondaryContact: SP.User & SP.UserCollections & SP.UserCollectionMethods; UserCustomActions: Base.IBaseResults<SP.UserCustomAction> & SP.UserCustomActionCollectionMethods; VersionPolicyForNewLibrariesTemplate: SP.SiteVersionPolicyManager & SP.SiteVersionPolicyManagerCollections; } /********************************************* * SiteMethods **********************************************/ export interface SiteMethods { cancelDeleteFileVersions(): Base.IBaseExecution<any>; cancelSetVersionPolicyForDocLibs(): Base.IBaseExecution<any>; createCopyJob(exportObjectUris?: Array<string>, destinationUri?: string, options?: SP.CopyMigrationOptions): Base.IBaseExecution<SP.CopyMigrationInfo>; createCopyJobs(exportObjectUris?: Array<string>, destinationUri?: string, options?: SP.CopyMigrationOptions): Base.IBaseCollection<SP.CopyMigrationInfo>; createMigrationIngestionJob(gWebId?: any, azureContainerSourceUri?: string, azureContainerManifestUri?: string, azureQueueReportUri?: string, ingestionTaskKey?: SP.IngestionTaskKey): Base.IBaseExecution<any>; createMigrationJob(gWebId?: any, azureContainerSourceUri?: string, azureContainerManifestUri?: string, azureQueueReportUri?: string): Base.IBaseExecution<any>; createMigrationJobEncrypted(gWebId?: any, azureContainerSourceUri?: string, azureContainerManifestUri?: string, azureQueueReportUri?: string, options?: SP.EncryptionOption): Base.IBaseExecution<any>; createPreviewSPSite(upgrade?: boolean, sendemail?: boolean): Base.IBaseExecution<any>; createSPAsyncReadJob(url?: string, readOptions?: SP.AsyncReadOptions, encryptionOption?: SP.EncryptionOption, azureContainerManifestUri?: string, azureQueueReportUri?: string): Base.IBaseExecution<SP.AsyncReadJobInfo>; createSPAsyncReadJobWithMultiUrl(urls?: Array<string>, readOptions?: SP.AsyncReadOptions, encryptionOption?: SP.EncryptionOption, azureContainerManifestUri?: string, azureQueueReportUri?: string): Base.IBaseExecution<SP.AsyncReadJobInfo>; deleteMigrationJob(id?: any): Base.IBaseExecution<boolean>; enqueueApplySensitivityLabelWork(workItemInformation?: SP.AutoLabellingWorkInformation): Base.IBaseExecution<SP.EnqueueJobInformation>; extendUpgradeReminderDate(): Base.IBaseExecution<any>; getBlockDownloadPolicyForFilesData(): Base.IBaseExecution<string>; getBringYourOwnKeyRecoveryKeyMode(): Base.IBaseExecution<number>; getBringYourOwnKeySiteStatus(): Base.IBaseExecution<SP.CustomerKeyStatusInfo>; getBringYourOwnKeyTenantStatus(): Base.IBaseExecution<SP.CustomerKeyStatusInfo>; getCatalog(typeCatalog?: number): Base.IBaseQuery<SP.List, SP.ListOData> & SP.ListCollections & SP.ListMethods; getChanges(query?: SP.ChangeQuery): Base.IBaseCollection<SP.Change>; getCopyJobProgress(copyJobInfo?: SP.CopyMigrationInfo): Base.IBaseExecution<SP.CopyJobProgress>; getHubSiteJoinApprovalCorrelationId(): Base.IBaseExecution<string>; getMigrationJobProgress(jobId?: any, nextToken?: string): Base.IBaseExecution<SP.MigrationJobProgress>; getMigrationJobStatus(id?: any): Base.IBaseExecution<number>; getMigrationStatus(): Base.IBaseCollection<SP.SPMigrationJobStatus>; getProgressForDeleteFileVersions(): Base.IBaseExecution<string>; getProgressForExpireFileVersionsBySchedule(scheduleFilePath?: SP.ResourcePath): Base.IBaseExecution<string>; getProgressForFileVersionExpirationReport(reportFileUrl?: string): Base.IBaseExecution<string>; getProgressForSetVersionPolicyForDocLibs(): Base.IBaseExecution<string>; getRecycleBinItems(pagingInfo?: string, rowLimit?: number, isAscending?: boolean, orderBy?: number, itemState?: number): Base.IBaseCollection<SP.RecycleBinItem, SP.RecycleBinItemOData, Base.IBaseExecution & SP.RecycleBinItemCollectionMethods> & Base.IBaseExecution & SP.RecycleBinItemCollectionMethods; getWebPath(siteId?: any, webId?: any): Base.IBaseExecution<SP.ResourcePath>; getWebTemplates(LCID?: number, overrideCompatLevel?: number): Base.IBaseCollection<SP.WebTemplate> & SP.WebTemplateCollectionMethods; invalidate(): Base.IBaseExecution<any>; joinHubSite(hubSiteId?: any, approvalToken?: string, approvalCorrelationId?: string): Base.IBaseExecution<any>; multiGeoCopyJob(jobId?: any, userId?: number, binaryPayload?: any): Base.IBaseExecution<any>; needsUpgradeByType(versionUpgrade?: boolean, recursive?: boolean): Base.IBaseExecution<boolean>; needsUpgradeByTypeFromSpoShell(versionUpgrade?: boolean, recursive?: boolean): Base.IBaseExecution<boolean>; onboardTenantForBringYourOwnKey(keyInfo?: SP.CustomerKeyInfo): Base.IBaseExecution<SP.CustomerKeyStatusInfo>; onHubSiteJoinRequestApproved(joiningSiteId?: any): Base.IBaseExecution<string>; onHubSiteJoinRequestCanceled(approvalCorrelationId?: string): Base.IBaseExecution<any>; onHubSiteJoinRequestStarted(approvalCorrelationId?: string): Base.IBaseExecution<any>; openWeb(strUrl?: string): Base.IBaseQuery<SP.Web, SP.WebOData> & SP.WebCollections & SP.WebMethods; openWebById(gWebId?: any): Base.IBaseQuery<SP.Web, SP.WebOData> & SP.WebCollections & SP.WebMethods; openWebUsingPath(path?: SP.ResourcePath): Base.IBaseQuery<SP.Web, SP.WebOData> & SP.WebCollections & SP.WebMethods; processStorageMetricsChanges(): Base.IBaseExecution<any>; provisionMigrationContainers(): Base.IBaseExecution<SP.ProvisionedMigrationContainersInfo>; provisionMigrationQueue(): Base.IBaseExecution<SP.ProvisionedMigrationQueueInfo>; provisionTemporaryAzureContainer(): Base.IBaseExecution<SP.ProvisionedTemporaryAzureContainerInfo>; recoverTenantForBringYourOwnKey(keyInfo?: SP.CustomerKeyInfo): Base.IBaseExecution<SP.CustomerKeyStatusInfo>; registerHubSite(creationInformation?: SP.HubSiteCreationInformation): Base.IBaseExecution<SP.HubSite>; rollTenantBringYourOwnKey(keyType?: number, keyVaultInfo?: SP.CustomerKeyVaultInfo): Base.IBaseExecution<SP.CustomerKeyStatusInfo>; runHealthCheck(ruleId?: any, bRepair?: boolean, bRunAlways?: boolean): Base.IBaseExecution<SP.SiteHealth.SiteHealthSummary>; runUpgradeSiteSession(versionUpgrade?: boolean, queueOnly?: boolean, sendEmail?: boolean): Base.IBaseExecution<any>; setBlockDownloadPolicyForFiles(blockDownloadPolicyFileTypeIds?: Array<string>): Base.IBaseExecution<any>; setIsContributorOwnerEnabledPropertyForDefaultDocLib(propertyValue?: boolean, forceDocLibActivation?: boolean, deleteIfDocLibAlreadyExists?: boolean): Base.IBaseExecution<boolean>; startDeleteFileVersions(deleteOlderThanDays?: number): Base.IBaseExecution<any>; startDeleteFileVersionsByMode(batchDeleteParameters?: SP.FileVersionBatchDeleteParameters): Base.IBaseExecution<any>; startExpireFileVersionsBySchedule(scheduleFilePath?: SP.ResourcePath): Base.IBaseExecution<any>; startFileVersionExpirationReport(reportFileUrl?: string): Base.IBaseExecution<any>; startSetVersionPolicyForDocLibs(enableAutoTrim?: boolean, majorVersionLimit?: number, majorWithMinorVersionsLimit?: number, expireAfterDays?: number): Base.IBaseExecution<any>; unregisterHubSite(): Base.IBaseExecution<any>; updateClientObjectModelUseRemoteAPIsPermissionSetting(requireUseRemoteAPIs?: boolean): Base.IBaseExecution<any>; updateInactiveSiteProperties(operation?: string, executionId?: number): Base.IBaseExecution<Microsoft.SharePoint.ActionableMessage.UpdateCard>; validateHubSiteJoinApprovalToken(joiningSiteId?: any, approvalToken?: string): Base.IBaseExecution<boolean>; update(properties?: any): Base.IBaseExecution<any>; } /********************************************* * IAudit **********************************************/ export interface IAudit extends AuditCollections, AuditMethods, Base.IBaseQuery<Audit, IAuditQuery> { } /********************************************* * IAuditCollection **********************************************/ export interface IAuditCollection extends Base.IBaseResults<Audit> { done?: (resolve: (value?: Array<Audit>) => void) => void; } /********************************************* * IAuditQueryCollection **********************************************/ export interface IAuditQueryCollection extends Base.IBaseResults<AuditOData> { done?: (resolve: (value?: Array<AuditOData>) => void) => void; } /********************************************* * IAuditQuery **********************************************/ export interface IAuditQuery extends AuditOData, AuditMethods { } /********************************************* * Audit **********************************************/ export interface Audit extends Base.IBaseResult, AuditProps, AuditCollections, AuditMethods { } /********************************************* * AuditProps **********************************************/ export interface AuditProps { AuditFlags?: number; } /********************************************* * AuditPropMethods **********************************************/ export interface AuditPropMethods { } /********************************************* * AuditCollections **********************************************/ export interface AuditCollections extends AuditPropMethods { } /********************************************* * AuditOData **********************************************/ export interface AuditOData extends Base.IBaseResult, AuditProps, AuditMethods { } /********************************************* * AuditMethods **********************************************/ export interface AuditMethods { update(): Base.IBaseExecution<any>; } /********************************************* * IScriptSafeDomain **********************************************/ export interface IScriptSafeDomain extends ScriptSafeDomainCollections, ScriptSafeDomainMethods, Base.IBaseQuery<ScriptSafeDomain, IScriptSafeDomainQuery> { } /********************************************* * IScriptSafeDomainCollection **********************************************/ export interface IScriptSafeDomainCollection extends Base.IBaseResults<ScriptSafeDomain>, ScriptSafeDomainCollectionMethods { done?: (resolve: (value?: Array<ScriptSafeDomain>) => void) => void; } /********************************************* * IScriptSafeDomainQueryCollection **********************************************/ export interface IScriptSafeDomainQueryCollection extends Base.IBaseResults<ScriptSafeDomainOData>, ScriptSafeDomainCollectionMethods { done?: (resolve: (value?: Array<ScriptSafeDomainOData>) => void) => void; } /********************************************* * IScriptSafeDomainQuery **********************************************/ export interface IScriptSafeDomainQuery extends ScriptSafeDomainOData, ScriptSafeDomainMethods { } /********************************************* * ScriptSafeDomain **********************************************/ export interface ScriptSafeDomain extends Base.IBaseResult, ScriptSafeDomainProps, ScriptSafeDomainCollections, ScriptSafeDomainMethods { } /********************************************* * ScriptSafeDomainProps **********************************************/ export interface ScriptSafeDomainProps { Id4a81de82eeb94d6080ea5bf63e27023a?: string; } /********************************************* * ScriptSafeDomainPropMethods **********************************************/ export interface ScriptSafeDomainPropMethods { } /********************************************* * ScriptSafeDomainCollections **********************************************/ export interface ScriptSafeDomainCollections extends ScriptSafeDomainPropMethods { } /********************************************* * ScriptSafeDomainCollectionMethods **********************************************/ export interface ScriptSafeDomainCollectionMethods { create(parameters?: SP.ScriptSafeDomainEntityData): Base.IBaseExecution<SP.ScriptSafeDomain>; getByDomainName(domainName?: string): Base.IBaseQuery<SP.ScriptSafeDomain> & SP.ScriptSafeDomainCollections & SP.ScriptSafeDomainMethods; } /********************************************* * ScriptSafeDomainOData **********************************************/ export interface ScriptSafeDomainOData extends Base.IBaseResult, ScriptSafeDomainProps, ScriptSafeDomainMethods { } /********************************************* * ScriptSafeDomainMethods **********************************************/ export interface ScriptSafeDomainMethods { delete(): Base.IBaseExecution<any>; } /********************************************* * IEventReceiverDefinition **********************************************/ export interface IEventReceiverDefinition extends EventReceiverDefinitionCollections, EventReceiverDefinitionMethods, Base.IBaseQuery<EventReceiverDefinition, IEventReceiverDefinitionQuery> { } /********************************************* * IEventReceiverDefinitionCollection **********************************************/ export interface IEventReceiverDefinitionCollection extends Base.IBaseResults<EventReceiverDefinition>, EventReceiverDefinitionCollectionMethods { done?: (resolve: (value?: Array<EventReceiverDefinition>) => void) => void; } /********************************************* * IEventReceiverDefinitionQueryCollection **********************************************/ export interface IEventReceiverDefinitionQueryCollection extends Base.IBaseResults<EventReceiverDefinitionOData>, EventReceiverDefinitionCollectionMethods { done?: (resolve: (value?: Array<EventReceiverDefinitionOData>) => void) => void; } /********************************************* * IEventReceiverDefinitionQuery **********************************************/ export interface IEventReceiverDefinitionQuery extends EventReceiverDefinitionOData, EventReceiverDefinitionMethods { } /********************************************* * EventReceiverDefinition **********************************************/ export interface EventReceiverDefinition extends Base.IBaseResult, EventReceiverDefinitionProps, EventReceiverDefinitionCollections, EventReceiverDefinitionMethods { } /********************************************* * EventReceiverDefinitionProps **********************************************/ export interface EventReceiverDefinitionProps { ReceiverAssembly?: string; ReceiverClass?: string; ReceiverId?: any; ReceiverName?: string; SequenceNumber?: number; Synchronization?: number; EventType?: number; ReceiverUrl?: string; } /********************************************* * EventReceiverDefinitionPropMethods **********************************************/ export interface EventReceiverDefinitionPropMethods { } /********************************************* * EventReceiverDefinitionCollections **********************************************/ export interface EventReceiverDefinitionCollections extends EventReceiverDefinitionPropMethods { } /********************************************* * EventReceiverDefinitionCollectionMethods **********************************************/ export interface EventReceiverDefinitionCollectionMethods { add(eventReceiverCreationInformation?: SP.EventReceiverDefinitionCreationInformation): Base.IBaseExecution<SP.EventReceiverDefinition>; getById(eventReceiverId?: any): Base.IBaseQuery<SP.EventReceiverDefinition> & SP.EventReceiverDefinitionCollections & SP.EventReceiverDefinitionMethods; } /********************************************* * EventReceiverDefinitionOData **********************************************/ export interface EventReceiverDefinitionOData extends Base.IBaseResult, EventReceiverDefinitionProps, EventReceiverDefinitionMethods { } /********************************************* * EventReceiverDefinitionMethods **********************************************/ export interface EventReceiverDefinitionMethods { delete(): Base.IBaseExecution<any>; // update(): Base.IBaseExecution<any>; update(properties?: any): Base.IBaseExecution<any>; } /********************************************* * Feature **********************************************/ export interface Feature { DefinitionId?: any; DisplayName?: string; } /********************************************* * FeatureCollections **********************************************/ export interface FeatureCollections extends FeatureCollectionMethods { } /********************************************* * FeatureCollectionMethods **********************************************/ export interface FeatureCollectionMethods { add(featureId?: any, force?: boolean, featdefScope?: number): Base.IBaseExecution<SP.Feature>; getById(featureId?: any): Base.IBaseQuery<SP.Feature> & SP.FeatureCollections; remove(featureId?: any, force?: boolean): Base.IBaseExecution<any>; } /********************************************* * Principal **********************************************/ export interface Principal { Id?: number; IsHiddenInUI?: boolean; LoginName?: string; Title?: string; PrincipalType?: number; } /********************************************* * PrincipalCollections **********************************************/ export interface PrincipalCollections { } /********************************************* * IGroup **********************************************/ export interface IGroup extends SP.PrincipalCollections, GroupCollections, GroupMethods, Base.IBaseQuery<Group, IGroupQuery> { } /********************************************* * IGroupCollection **********************************************/ export interface IGroupCollection extends Base.IBaseResults<Group>, GroupCollectionMethods { done?: (resolve: (value?: Array<Group>) => void) => void; } /********************************************* * IGroupQueryCollection **********************************************/ export interface IGroupQueryCollection extends Base.IBaseResults<GroupOData>, GroupCollectionMethods { done?: (resolve: (value?: Array<GroupOData>) => void) => void; } /********************************************* * IGroupQuery **********************************************/ export interface IGroupQuery extends GroupOData, GroupMethods { } /********************************************* * Group **********************************************/ export interface Group extends SP.Principal, Base.IBaseResult, GroupProps, GroupCollections, GroupMethods { } /********************************************* * GroupProps **********************************************/ export interface GroupProps { AllowMembersEditMembership?: boolean; AllowRequestToJoinLeave?: boolean; AutoAcceptRequestToJoinLeave?: boolean; CanCurrentUserEditMembership?: boolean; CanCurrentUserManageGroup?: boolean; CanCurrentUserViewMembership?: boolean; Description?: string; OnlyAllowMembersViewMembership?: boolean; OwnerTitle?: string; RequestToJoinLeaveEmailSetting?: string; } /********************************************* * GroupPropMethods **********************************************/ export interface GroupPropMethods { Owner(): Base.IBaseExecution<SP.Principal> & SP.PrincipalCollections; } /********************************************* * GroupCollections **********************************************/ export interface GroupCollections extends GroupPropMethods { Users(): Base.IBaseCollection<SP.User, SP.UserOData, Base.IBaseExecution & SP.UserCollectionMethods> & Base.IBaseExecution & SP.UserCollectionMethods; Users(id: string | number): SP.PrincipalCollections & Base.IBaseQuery<SP.User, SP.UserOData> & SP.UserCollections & SP.UserMethods; } /********************************************* * GroupCollectionMethods **********************************************/ export interface GroupCollectionMethods { getById(id?: number): Base.IBaseQuery<SP.Group, SP.GroupOData> & SP.GroupCollections & SP.GroupMethods; getByName(name?: string): Base.IBaseQuery<SP.Group, SP.GroupOData> & SP.GroupCollections & SP.GroupMethods; removeById(id?: number): Base.IBaseExecution<any>; removeByLoginName(loginName?: string): Base.IBaseExecution<any>; add(parameters?: SP.GroupCreationInformation): Base.IBaseExecution<SP.Group>; } /********************************************* * GroupOData **********************************************/ export interface GroupOData extends SP.Principal, Base.IBaseResult, GroupProps, GroupMethods { Owner: SP.Principal & SP.PrincipalCollections; Users: Base.IBaseResults<SP.User> & SP.UserCollectionMethods; } /********************************************* * GroupMethods **********************************************/ export interface GroupMethods { setUserAsOwner(ownerId?: number): Base.IBaseExecution<any>; update(): Base.IBaseExecution<any>; } /********************************************* * IUser **********************************************/ export interface IUser extends SP.PrincipalCollections, UserCollections, UserMethods, Base.IBaseQuery<User, IUserQuery> { } /********************************************* * IUserCollection **********************************************/ export interface IUserCollection extends Base.IBaseResults<User>, UserCollectionMethods { done?: (resolve: (value?: Array<User>) => void) => void; } /********************************************* * IUserQueryCollection **********************************************/ export interface IUserQueryCollection extends Base.IBaseResults<UserOData>, UserCollectionMethods { done?: (resolve: (value?: Array<UserOData>) => void) => void; } /********************************************* * IUserQuery **********************************************/ export interface IUserQuery extends UserOData, UserMethods { } /********************************************* * User **********************************************/ export interface User extends SP.Principal, Base.IBaseResult, UserProps, UserCollections, UserMethods { } /********************************************* * UserProps **********************************************/ export interface UserProps { AadObjectId?: SP.UserIdInfo; Email?: string; EmailWithFallback?: string; Expiration?: string; HexCid?: string; IsEmailAuthenticationGuestUser?: boolean; IsShareByEmailGuestUser?: boolean; IsSiteAdmin?: boolean; UserId?: SP.UserIdInfo; UserPrincipalName?: string; } /********************************************* * UserPropMethods **********************************************/ export interface UserPropMethods { } /********************************************* * UserCollections **********************************************/ export interface UserCollections extends UserPropMethods { Alerts(): Base.IBaseCollection<SP.Alert, SP.AlertOData, Base.IBaseExecution & SP.AlertCollectionMethods> & Base.IBaseExecution & SP.AlertCollectionMethods; Alerts(id: string | number): SP.PrincipalCollections & Base.IBaseQuery<SP.Alert, SP.AlertOData> & SP.AlertCollections & SP.AlertMethods; Groups(): Base.IBaseCollection<SP.Group, SP.GroupOData, Base.IBaseExecution & SP.GroupCollectionMethods> & Base.IBaseExecution & SP.GroupCollectionMethods; Groups(id: string | number): SP.PrincipalCollections & Base.IBaseQuery<SP.Group, SP.GroupOData> & SP.GroupCollections & SP.GroupMethods; } /********************************************* * UserCollectionMethods **********************************************/ export interface UserCollectionMethods { addUserById(id?: number): Base.IBaseExecution<SP.User>; getByEmail(emailAddress?: string): Base.IBaseQuery<SP.User, SP.UserOData> & SP.UserCollections & SP.UserMethods; getById(id?: number): Base.IBaseQuery<SP.User, SP.UserOData> & SP.UserCollections & SP.UserMethods; getByLoginName(loginName?: string): Base.IBaseQuery<SP.User, SP.UserOData> & SP.UserCollections & SP.UserMethods; getByObjectId(objectId?: any): Base.IBaseQuery<SP.User, SP.UserOData> & SP.UserCollections & SP.UserMethods; getByPuid(puid?: string): Base.IBaseQuery<SP.User, SP.UserOData> & SP.UserCollections & SP.UserMethods; removeById(id?: number): Base.IBaseExecution<any>; removeByLoginName(loginName?: string): Base.IBaseExecution<any>; add(properties?: SP.UserCreationInformation): Base.IBaseExecution<any>; } /********************************************* * UserOData **********************************************/ export interface UserOData extends SP.Principal, Base.IBaseResult, UserProps, UserMethods { Alerts: Base.IBaseResults<SP.Alert> & SP.AlertCollectionMethods; Groups: Base.IBaseResults<SP.Group> & SP.GroupCollectionMethods; } /********************************************* * UserMethods **********************************************/ export interface UserMethods { expire(): Base.IBaseExecution<any>; // update(): Base.IBaseExecution<any>; update(properties?: any): Base.IBaseExecution<any>; } /********************************************* * IAlert **********************************************/ export interface IAlert extends AlertCollections, AlertMethods, Base.IBaseQuery<Alert, IAlertQuery> { } /********************************************* * IAlertCollection **********************************************/ export interface IAlertCollection extends Base.IBaseResults<Alert>, AlertCollectionMethods { done?: (resolve: (value?: Array<Alert>) => void) => void; } /********************************************* * IAlertQueryCollection **********************************************/ export interface IAlertQueryCollection extends Base.IBaseResults<AlertOData>, AlertCollectionMethods { done?: (resolve: (value?: Array<AlertOData>) => void) => void; } /********************************************* * IAlertQuery **********************************************/ export interface IAlertQuery extends AlertOData, AlertMethods { } /********************************************* * Alert **********************************************/ export interface Alert extends Base.IBaseResult, AlertProps, AlertCollections, AlertMethods { } /********************************************* * AlertProps **********************************************/ export interface AlertProps { AlertFrequency?: number; AlertTemplateName?: string; AlertTime?: any; AlertType?: number; AlwaysNotify?: boolean; DeliveryChannels?: number; EventType?: number; Filter?: string; ID?: any; ItemID?: number; ListID?: any; ListUrl?: string; Properties?: { results: Array<SP.KeyValue> }; Status?: number; Title?: string; UserId?: number; } /********************************************* * AlertPropMethods **********************************************/ export interface AlertPropMethods { AllProperties(): Base.IBaseExecution<SP.PropertyValues> & SP.PropertyValuesCollections; Item(): Base.IBaseQuery<SP.ListItem, SP.ListItemOData> & SP.ListItemCollections & SP.ListItemMethods; List(): Base.IBaseQuery<SP.List, SP.ListOData> & SP.ListCollections & SP.ListMethods; User(): Base.IBaseQuery<SP.User, SP.UserOData> & SP.UserCollections & SP.UserMethods; } /********************************************* * AlertCollections **********************************************/ export interface AlertCollections extends AlertPropMethods { } /********************************************* * AlertCollectionMethods **********************************************/ export interface AlertCollectionMethods { add(alertCreationInformation?: SP.AlertCreationInformation): Base.IBaseExecution<any>; contains(idAlert?: any): Base.IBaseExecution<boolean>; deleteAlert(idAlert?: any): Base.IBaseExecution<any>; deleteAlertAtIndex(index?: number): Base.IBaseExecution<any>; getById(idAlert?: any): Base.IBaseQuery<SP.Alert, SP.AlertOData> & SP.AlertCollections & SP.AlertMethods; } /********************************************* * AlertOData **********************************************/ export interface AlertOData extends Base.IBaseResult, AlertProps, AlertMethods { AllProperties: SP.PropertyValues & SP.PropertyValuesCollections & SP.PropertyValuesCollectionMethods; Item: SP.ListItem & SP.ListItemCollections & SP.ListItemCollectionMethods; List: SP.List & SP.ListCollections & SP.ListCollectionMethods; User: SP.User & SP.UserCollections & SP.UserCollectionMethods; } /********************************************* * AlertMethods **********************************************/ export interface AlertMethods { updateAlert(): Base.IBaseExecution<any>; } /********************************************* * PropertyValues **********************************************/ export interface PropertyValues { Id4a81de82eeb94d6080ea5bf63e27023a?: string; } /********************************************* * PropertyValuesCollections **********************************************/ export interface PropertyValuesCollections extends PropertyValuesCollectionMethods { } /********************************************* * PropertyValuesCollectionMethods **********************************************/ export interface PropertyValuesCollectionMethods { add(key?: string, value?: string): Base.IBaseExecution<any>; remove(key?: string): Base.IBaseExecution<any>; } /********************************************* * ISecurableObject **********************************************/ export interface ISecurableObject extends SecurableObjectCollections, SecurableObjectMethods, Base.IBaseQuery<SecurableObject, ISecurableObjectQuery> { } /********************************************* * ISecurableObjectCollection **********************************************/ export interface ISecurableObjectCollection extends Base.IBaseResults<SecurableObject> { done?: (resolve: (value?: Array<SecurableObject>) => void) => void; } /********************************************* * ISecurableObjectQueryCollection **********************************************/ export interface ISecurableObjectQueryCollection extends Base.IBaseResults<SecurableObjectOData> { done?: (resolve: (value?: Array<SecurableObjectOData>) => void) => void; } /********************************************* * ISecurableObjectQuery **********************************************/ export interface ISecurableObjectQuery extends SecurableObjectOData, SecurableObjectMethods { } /********************************************* * SecurableObject **********************************************/ export interface SecurableObject extends Base.IBaseResult, SecurableObjectProps, SecurableObjectCollections, SecurableObjectMethods { } /********************************************* * SecurableObjectProps **********************************************/ export interface SecurableObjectProps { HasUniqueRoleAssignments?: boolean; } /********************************************* * SecurableObjectPropMethods **********************************************/ export interface SecurableObjectPropMethods { FirstUniqueAncestorSecurableObject(): Base.IBaseQuery<SP.SecurableObject, SP.SecurableObjectOData> & SP.SecurableObjectCollections & SP.SecurableObjectMethods; } /********************************************* * SecurableObjectCollections **********************************************/ export interface SecurableObjectCollections extends SecurableObjectPropMethods { RoleAssignments(): Base.IBaseCollection<SP.RoleAssignment, SP.RoleAssignmentOData, Base.IBaseExecution & SP.RoleAssignmentCollectionMethods> & Base.IBaseExecution & SP.RoleAssignmentCollectionMethods; RoleAssignments(id: string | number): Base.IBaseQuery<SP.RoleAssignment, SP.RoleAssignmentOData> & SP.RoleAssignmentCollections & SP.RoleAssignmentMethods; } /********************************************* * SecurableObjectOData **********************************************/ export interface SecurableObjectOData extends Base.IBaseResult, SecurableObjectProps, SecurableObjectMethods { FirstUniqueAncestorSecurableObject: SP.SecurableObject & SP.SecurableObjectCollections; RoleAssignments: Base.IBaseResults<SP.RoleAssignment> & SP.RoleAssignmentCollectionMethods; } /********************************************* * SecurableObjectMethods **********************************************/ export interface SecurableObjectMethods { breakRoleInheritance(copyRoleAssignments?: boolean, clearSubscopes?: boolean): Base.IBaseExecution<any>; resetRoleInheritance(): Base.IBaseExecution<any>; } /********************************************* * IRoleAssignment **********************************************/ export interface IRoleAssignment extends RoleAssignmentCollections, RoleAssignmentMethods, Base.IBaseQuery<RoleAssignment, IRoleAssignmentQuery> { } /********************************************* * IRoleAssignmentCollection **********************************************/ export interface IRoleAssignmentCollection extends Base.IBaseResults<RoleAssignment>, RoleAssignmentCollectionMethods { done?: (resolve: (value?: Array<RoleAssignment>) => void) => void; } /********************************************* * IRoleAssignmentQueryCollection **********************************************/ export interface IRoleAssignmentQueryCollection extends Base.IBaseResults<RoleAssignmentOData>, RoleAssignmentCollectionMethods { done?: (resolve: (value?: Array<RoleAssignmentOData>) => void) => void; } /********************************************* * IRoleAssignmentQuery **********************************************/ export interface IRoleAssignmentQuery extends RoleAssignmentOData, RoleAssignmentMethods { } /********************************************* * RoleAssignment **********************************************/ export interface RoleAssignment extends Base.IBaseResult, RoleAssignmentProps, RoleAssignmentCollections, RoleAssignmentMethods { } /********************************************* * RoleAssignmentProps **********************************************/ export interface RoleAssignmentProps { PrincipalId?: number; } /********************************************* * RoleAssignmentPropMethods **********************************************/ export interface RoleAssignmentPropMethods { Member(): Base.IBaseExecution<SP.Principal> & SP.PrincipalCollections; } /********************************************* * RoleAssignmentCollections **********************************************/ export interface RoleAssignmentCollections extends RoleAssignmentPropMethods { RoleDefinitionBindings(): Base.IBaseCollection<SP.RoleDefinition> & SP.RoleDefinitionCollectionMethods; RoleDefinitionBindings(id: string | number): Base.IBaseQuery<SP.RoleDefinition> & SP.RoleDefinitionCollections & SP.RoleDefinitionMethods; } /********************************************* * RoleAssignmentCollectionMethods **********************************************/ export interface RoleAssignmentCollectionMethods { addRoleAssignment(principalId?: number, roleDefId?: number): Base.IBaseExecution<any>; getByPrincipalId(principalId?: number): Base.IBaseQuery<SP.RoleAssignment, SP.RoleAssignmentOData> & SP.RoleAssignmentCollections & SP.RoleAssignmentMethods; removeRoleAssignment(principalId?: number, roleDefId?: number): Base.IBaseExecution<any>; } /********************************************* * RoleAssignmentOData **********************************************/ export interface RoleAssignmentOData extends Base.IBaseResult, RoleAssignmentProps, RoleAssignmentMethods { Member: SP.Principal & SP.PrincipalCollections; RoleDefinitionBindings: Base.IBaseResults<SP.RoleDefinition> & SP.RoleDefinitionCollectionMethods; } /********************************************* * RoleAssignmentMethods **********************************************/ export interface RoleAssignmentMethods { delete(): Base.IBaseExecution<any>; // update(): Base.IBaseExecution<any>; update(properties?: any): Base.IBaseExecution<any>; } /********************************************* * IRoleDefinition **********************************************/ export interface IRoleDefinition extends RoleDefinitionCollections, RoleDefinitionMethods, Base.IBaseQuery<RoleDefinition, IRoleDefinitionQuery> { } /********************************************* * IRoleDefinitionCollection **********************************************/ export interface IRoleDefinitionCollection extends Base.IBaseResults<RoleDefinition>, RoleDefinitionCollectionMethods { done?: (resolve: (value?: Array<RoleDefinition>) => void) => void; } /********************************************* * IRoleDefinitionQueryCollection **********************************************/ export interface IRoleDefinitionQueryCollection extends Base.IBaseResults<RoleDefinitionOData>, RoleDefinitionCollectionMethods { done?: (resolve: (value?: Array<RoleDefinitionOData>) => void) => void; } /********************************************* * IRoleDefinitionQuery **********************************************/ export interface IRoleDefinitionQuery extends RoleDefinitionOData, RoleDefinitionMethods { } /********************************************* * RoleDefinition **********************************************/ export interface RoleDefinition extends Base.IBaseResult, RoleDefinitionProps, RoleDefinitionCollections, RoleDefinitionMethods { } /********************************************* * RoleDefinitionProps **********************************************/ export interface RoleDefinitionProps { BasePermissions?: SP.BasePermissions; Description?: string; Hidden?: boolean; Id?: number; Name?: string; Order?: number; RoleTypeKind?: number; } /********************************************* * RoleDefinitionPropMethods **********************************************/ export interface RoleDefinitionPropMethods { } /********************************************* * RoleDefinitionCollections **********************************************/ export interface RoleDefinitionCollections extends RoleDefinitionPropMethods { } /********************************************* * RoleDefinitionCollectionMethods **********************************************/ export interface RoleDefinitionCollectionMethods { // getById(id?: number): Base.IBaseExecution<SP.RoleDefinition>; removeAll(): Base.IBaseExecution<any>; getByName(name?: string): Base.IBaseQuery<SP.RoleDefinition> & SP.RoleDefinitionCollections & SP.RoleDefinitionMethods; getByType(roleType?: number): Base.IBaseQuery<SP.RoleDefinition> & SP.RoleDefinitionCollections & SP.RoleDefinitionMethods; recreateMissingDefaultRoleDefinitions(): Base.IBaseExecution<any>; add(properties?: SP.RoleDefinitionCreationInformation): Base.IBaseExecution<any>; getById(id?: number): Base.IBaseQuery<SP.RoleDefinition> & SP.RoleDefinitionCollections & SP.RoleDefinitionMethods; } /********************************************* * RoleDefinitionOData **********************************************/ export interface RoleDefinitionOData extends Base.IBaseResult, RoleDefinitionProps, RoleDefinitionMethods { } /********************************************* * RoleDefinitionMethods **********************************************/ export interface RoleDefinitionMethods { delete(): Base.IBaseExecution<any>; // update(): Base.IBaseExecution<any>; update(properties?: any): Base.IBaseExecution<any>; } /********************************************* * IListItem **********************************************/ export interface IListItem extends SP.SecurableObjectCollections, ListItemCollections, ListItemMethods, Base.IBaseQuery<ListItem, IListItemQuery> { } /********************************************* * IListItemCollection **********************************************/ export interface IListItemCollection extends Base.IBaseResults<ListItem>, ListItemCollectionMethods { done?: (resolve: (value?: Array<ListItem>) => void) => void; } /********************************************* * IListItemQueryCollection **********************************************/ export interface IListItemQueryCollection extends Base.IBaseResults<ListItemOData>, ListItemCollectionMethods { done?: (resolve: (value?: Array<ListItemOData>) => void) => void; } /********************************************* * IListItemQuery **********************************************/ export interface IListItemQuery extends ListItemOData, ListItemMethods { } /********************************************* * ListItem **********************************************/ export inte