UNPKG

@microsoft/msgraph-beta-sdk-groups

Version:
311 lines 18 kB
import { type Group } from '@microsoft/msgraph-beta-sdk/models/index.js'; import { type AcceptedSendersRequestBuilder } from './acceptedSenders/index.js'; import { type AddFavoriteRequestBuilder } from './addFavorite/index.js'; import { type AppRoleAssignmentsRequestBuilder } from './appRoleAssignments/index.js'; import { type AssignLicenseRequestBuilder } from './assignLicense/index.js'; import { type CalendarRequestBuilder } from './calendar/index.js'; import { type CalendarViewRequestBuilder } from './calendarView/index.js'; import { type CheckGrantedPermissionsForAppRequestBuilder } from './checkGrantedPermissionsForApp/index.js'; import { type CheckMemberGroupsRequestBuilder } from './checkMemberGroups/index.js'; import { type CheckMemberObjectsRequestBuilder } from './checkMemberObjects/index.js'; import { type ConversationsRequestBuilder } from './conversations/index.js'; import { type CreatedOnBehalfOfRequestBuilder } from './createdOnBehalfOf/index.js'; import { type DeletePasswordSingleSignOnCredentialsRequestBuilder } from './deletePasswordSingleSignOnCredentials/index.js'; import { type DriveRequestBuilder } from './drive/index.js'; import { type DrivesRequestBuilder } from './drives/index.js'; import { type EndpointsRequestBuilder } from './endpoints/index.js'; import { type EvaluateDynamicMembershipRequestBuilder } from './evaluateDynamicMembership/index.js'; import { type EventsRequestBuilder } from './events/index.js'; import { type ExtensionsRequestBuilder } from './extensions/index.js'; import { type GetMemberGroupsRequestBuilder } from './getMemberGroups/index.js'; import { type GetMemberObjectsRequestBuilder } from './getMemberObjects/index.js'; import { type GetPasswordSingleSignOnCredentialsRequestBuilder } from './getPasswordSingleSignOnCredentials/index.js'; import { type GroupLifecyclePoliciesRequestBuilder } from './groupLifecyclePolicies/index.js'; import { type MemberOfRequestBuilder } from './memberOf/index.js'; import { type MembersRequestBuilder } from './members/index.js'; import { type MembersWithLicenseErrorsRequestBuilder } from './membersWithLicenseErrors/index.js'; import { type OnenoteRequestBuilder } from './onenote/index.js'; import { type OwnersRequestBuilder } from './owners/index.js'; import { type PermissionGrantsRequestBuilder } from './permissionGrants/index.js'; import { type PhotoRequestBuilder } from './photo/index.js'; import { type PhotosRequestBuilder } from './photos/index.js'; import { type PlannerRequestBuilder } from './planner/index.js'; import { type RejectedSendersRequestBuilder } from './rejectedSenders/index.js'; import { type RemoveFavoriteRequestBuilder } from './removeFavorite/index.js'; import { type RenewRequestBuilder } from './renew/index.js'; import { type ResetUnseenCountRequestBuilder } from './resetUnseenCount/index.js'; import { type RestoreRequestBuilder } from './restore/index.js'; import { type RetryServiceProvisioningRequestBuilder } from './retryServiceProvisioning/index.js'; import { type ServiceProvisioningErrorsRequestBuilder } from './serviceProvisioningErrors/index.js'; import { type SettingsRequestBuilder } from './settings/index.js'; import { type SitesRequestBuilder } from './sites/index.js'; import { type SubscribeByMailRequestBuilder } from './subscribeByMail/index.js'; import { type TeamRequestBuilder } from './team/index.js'; import { type ThreadsRequestBuilder } from './threads/index.js'; import { type TransitiveMemberOfRequestBuilder } from './transitiveMemberOf/index.js'; import { type TransitiveMembersRequestBuilder } from './transitiveMembers/index.js'; import { type UnsubscribeByMailRequestBuilder } from './unsubscribeByMail/index.js'; import { type ValidatePropertiesRequestBuilder } from './validateProperties/index.js'; import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions'; /** * Provides operations to manage the collection of group entities. */ export interface GroupItemRequestBuilder extends BaseRequestBuilder<GroupItemRequestBuilder> { /** * Provides operations to manage the acceptedSenders property of the microsoft.graph.group entity. */ get acceptedSenders(): AcceptedSendersRequestBuilder; /** * Provides operations to call the addFavorite method. */ get addFavorite(): AddFavoriteRequestBuilder; /** * Provides operations to manage the appRoleAssignments property of the microsoft.graph.group entity. */ get appRoleAssignments(): AppRoleAssignmentsRequestBuilder; /** * Provides operations to call the assignLicense method. */ get assignLicense(): AssignLicenseRequestBuilder; /** * Provides operations to manage the calendar property of the microsoft.graph.group entity. */ get calendar(): CalendarRequestBuilder; /** * Provides operations to manage the calendarView property of the microsoft.graph.group entity. */ get calendarView(): CalendarViewRequestBuilder; /** * Provides operations to call the checkGrantedPermissionsForApp method. */ get checkGrantedPermissionsForApp(): CheckGrantedPermissionsForAppRequestBuilder; /** * Provides operations to call the checkMemberGroups method. */ get checkMemberGroups(): CheckMemberGroupsRequestBuilder; /** * Provides operations to call the checkMemberObjects method. */ get checkMemberObjects(): CheckMemberObjectsRequestBuilder; /** * Provides operations to manage the conversations property of the microsoft.graph.group entity. */ get conversations(): ConversationsRequestBuilder; /** * Provides operations to manage the createdOnBehalfOf property of the microsoft.graph.group entity. */ get createdOnBehalfOf(): CreatedOnBehalfOfRequestBuilder; /** * Provides operations to call the deletePasswordSingleSignOnCredentials method. */ get deletePasswordSingleSignOnCredentials(): DeletePasswordSingleSignOnCredentialsRequestBuilder; /** * Provides operations to manage the drive property of the microsoft.graph.group entity. */ get drive(): DriveRequestBuilder; /** * Provides operations to manage the drives property of the microsoft.graph.group entity. */ get drives(): DrivesRequestBuilder; /** * Provides operations to manage the endpoints property of the microsoft.graph.group entity. */ get endpoints(): EndpointsRequestBuilder; /** * Provides operations to call the evaluateDynamicMembership method. */ get evaluateDynamicMembership(): EvaluateDynamicMembershipRequestBuilder; /** * Provides operations to manage the events property of the microsoft.graph.group entity. */ get events(): EventsRequestBuilder; /** * Provides operations to manage the extensions property of the microsoft.graph.group entity. */ get extensions(): ExtensionsRequestBuilder; /** * Provides operations to call the getMemberGroups method. */ get getMemberGroups(): GetMemberGroupsRequestBuilder; /** * Provides operations to call the getMemberObjects method. */ get getMemberObjects(): GetMemberObjectsRequestBuilder; /** * Provides operations to call the getPasswordSingleSignOnCredentials method. */ get getPasswordSingleSignOnCredentials(): GetPasswordSingleSignOnCredentialsRequestBuilder; /** * Provides operations to manage the groupLifecyclePolicies property of the microsoft.graph.group entity. */ get groupLifecyclePolicies(): GroupLifecyclePoliciesRequestBuilder; /** * Provides operations to manage the memberOf property of the microsoft.graph.group entity. */ get memberOf(): MemberOfRequestBuilder; /** * Provides operations to manage the members property of the microsoft.graph.group entity. */ get members(): MembersRequestBuilder; /** * Provides operations to manage the membersWithLicenseErrors property of the microsoft.graph.group entity. */ get membersWithLicenseErrors(): MembersWithLicenseErrorsRequestBuilder; /** * Provides operations to manage the onenote property of the microsoft.graph.group entity. */ get onenote(): OnenoteRequestBuilder; /** * Provides operations to manage the owners property of the microsoft.graph.group entity. */ get owners(): OwnersRequestBuilder; /** * Provides operations to manage the permissionGrants property of the microsoft.graph.group entity. */ get permissionGrants(): PermissionGrantsRequestBuilder; /** * Provides operations to manage the photo property of the microsoft.graph.group entity. */ get photo(): PhotoRequestBuilder; /** * Provides operations to manage the photos property of the microsoft.graph.group entity. */ get photos(): PhotosRequestBuilder; /** * Provides operations to manage the planner property of the microsoft.graph.group entity. */ get planner(): PlannerRequestBuilder; /** * Provides operations to manage the rejectedSenders property of the microsoft.graph.group entity. */ get rejectedSenders(): RejectedSendersRequestBuilder; /** * Provides operations to call the removeFavorite method. */ get removeFavorite(): RemoveFavoriteRequestBuilder; /** * Provides operations to call the renew method. */ get renew(): RenewRequestBuilder; /** * Provides operations to call the resetUnseenCount method. */ get resetUnseenCount(): ResetUnseenCountRequestBuilder; /** * Provides operations to call the restore method. */ get restore(): RestoreRequestBuilder; /** * Provides operations to call the retryServiceProvisioning method. */ get retryServiceProvisioning(): RetryServiceProvisioningRequestBuilder; /** * The serviceProvisioningErrors property */ get serviceProvisioningErrors(): ServiceProvisioningErrorsRequestBuilder; /** * Provides operations to manage the settings property of the microsoft.graph.group entity. */ get settings(): SettingsRequestBuilder; /** * Provides operations to manage the sites property of the microsoft.graph.group entity. */ get sites(): SitesRequestBuilder; /** * Provides operations to call the subscribeByMail method. */ get subscribeByMail(): SubscribeByMailRequestBuilder; /** * Provides operations to manage the team property of the microsoft.graph.group entity. */ get team(): TeamRequestBuilder; /** * Provides operations to manage the threads property of the microsoft.graph.group entity. */ get threads(): ThreadsRequestBuilder; /** * Provides operations to manage the transitiveMemberOf property of the microsoft.graph.group entity. */ get transitiveMemberOf(): TransitiveMemberOfRequestBuilder; /** * Provides operations to manage the transitiveMembers property of the microsoft.graph.group entity. */ get transitiveMembers(): TransitiveMembersRequestBuilder; /** * Provides operations to call the unsubscribeByMail method. */ get unsubscribeByMail(): UnsubscribeByMailRequestBuilder; /** * Provides operations to call the validateProperties method. */ get validateProperties(): ValidatePropertiesRequestBuilder; /** * Delete a group. When deleted, Microsoft 365 groups are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. This isn't applicable to Security groups and Distribution groups that are permanently deleted immediately. To learn more, see deletedItems. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @throws {ODataError} error when the service returns a 4XX or 5XX status code * @see {@link https://learn.microsoft.com/graph/api/group-delete?view=graph-rest-beta|Find more info here} */ delete(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>; /** * Get the properties and relationships of a group object. This operation returns by default only a subset of all the available properties, as noted in the Properties section. To get properties that aren't_ returned by default, specify them in a $select OData query option. The hasMembersWithLicenseErrors and isArchived properties are an exception and aren't returned in the $select query. Because the group resource supports extensions, you can also use the GET operation to get custom properties and extension data in a group instance. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<Group>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code * @see {@link https://learn.microsoft.com/graph/api/group-get?view=graph-rest-beta|Find more info here} */ get(requestConfiguration?: RequestConfiguration<GroupItemRequestBuilderGetQueryParameters> | undefined): Promise<Group | undefined>; /** * Create a new group object if it doesn't exist, or update the properties of an existing group object.You can create or update the following types of group: By default, this operation returns only a subset of the properties for each group. For a list of properties that are returned by default, see the Properties section of the group resource. To get properties that are not returned by default, do a GET operation and specify the properties in a $select OData query option. * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise<Group>} * @throws {ODataError} error when the service returns a 4XX or 5XX status code * @see {@link https://learn.microsoft.com/graph/api/group-upsert?view=graph-rest-beta|Find more info here} */ patch(body: Group, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Group | undefined>; /** * Delete a group. When deleted, Microsoft 365 groups are moved to a temporary container and can be restored within 30 days. After that time, they are permanently deleted. This isn't applicable to Security groups and Distribution groups that are permanently deleted immediately. To learn more, see deletedItems. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toDeleteRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation; /** * Get the properties and relationships of a group object. This operation returns by default only a subset of all the available properties, as noted in the Properties section. To get properties that aren't_ returned by default, specify them in a $select OData query option. The hasMembersWithLicenseErrors and isArchived properties are an exception and aren't returned in the $select query. Because the group resource supports extensions, you can also use the GET operation to get custom properties and extension data in a group instance. * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toGetRequestInformation(requestConfiguration?: RequestConfiguration<GroupItemRequestBuilderGetQueryParameters> | undefined): RequestInformation; /** * Create a new group object if it doesn't exist, or update the properties of an existing group object.You can create or update the following types of group: By default, this operation returns only a subset of the properties for each group. For a list of properties that are returned by default, see the Properties section of the group resource. To get properties that are not returned by default, do a GET operation and specify the properties in a $select OData query option. * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toPatchRequestInformation(body: Group, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation; } /** * Get the properties and relationships of a group object. This operation returns by default only a subset of all the available properties, as noted in the Properties section. To get properties that aren't_ returned by default, specify them in a $select OData query option. The hasMembersWithLicenseErrors and isArchived properties are an exception and aren't returned in the $select query. Because the group resource supports extensions, you can also use the GET operation to get custom properties and extension data in a group instance. */ export interface GroupItemRequestBuilderGetQueryParameters { /** * Expand related entities */ expand?: string[]; /** * Select properties to be returned */ select?: string[]; } /** * Uri template for the request builder. */ export declare const GroupItemRequestBuilderUriTemplate = "{+baseurl}/groups/{group%2Did}{?%24expand,%24select}"; /** * Metadata for all the navigation properties in the request builder. */ export declare const GroupItemRequestBuilderNavigationMetadata: Record<Exclude<keyof GroupItemRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>; /** * Metadata for all the requests in the request builder. */ export declare const GroupItemRequestBuilderRequestsMetadata: RequestsMetadata; //# sourceMappingURL=index.d.ts.map