@microsoft/msgraph-beta-sdk-users
Version:
Users fluent API for Microsoft Graph
89 lines • 4.7 kB
TypeScript
import { type BaseDeltaFunctionResponse, type PlannerDelta } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type BaseRequestBuilder, type Parsable, type ParseNode, type RequestConfiguration, type RequestInformation, type RequestsMetadata, 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 {DeltaGetResponse}
*/
export declare function createDeltaGetResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record<string, (node: ParseNode) => void>);
export interface DeltaGetResponse extends BaseDeltaFunctionResponse, Parsable {
/**
* The value property
*/
value?: PlannerDelta[] | null;
}
/**
* Provides operations to call the delta method.
*/
export interface DeltaRequestBuilder extends BaseRequestBuilder<DeltaRequestBuilder> {
/**
* Retrieves changes to objects that the user is subscribed to. This method allows your application to track changes to objects that the user can access from within Planner over time. The return value of this method might contain heterogeneous types of objects from Planner. For more information about tracking changes in Microsoft Graph data, see Use delta query to track changes in Microsoft Graph data.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<DeltaGetResponse>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/planneruser-list-delta?view=graph-rest-beta|Find more info here}
*/
get(requestConfiguration?: RequestConfiguration<DeltaRequestBuilderGetQueryParameters> | undefined): Promise<DeltaGetResponse | undefined>;
/**
* Retrieves changes to objects that the user is subscribed to. This method allows your application to track changes to objects that the user can access from within Planner over time. The return value of this method might contain heterogeneous types of objects from Planner. For more information about tracking changes in Microsoft Graph data, see Use delta query to track changes in Microsoft Graph data.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<DeltaRequestBuilderGetQueryParameters> | undefined): RequestInformation;
}
/**
* Retrieves changes to objects that the user is subscribed to. This method allows your application to track changes to objects that the user can access from within Planner over time. The return value of this method might contain heterogeneous types of objects from Planner. For more information about tracking changes in Microsoft Graph data, see Use delta query to track changes in Microsoft Graph data.
*/
export interface DeltaRequestBuilderGetQueryParameters {
/**
* Include count of items
*/
count?: boolean;
/**
* Expand related entities
*/
expand?: string[];
/**
* Filter items by property values
*/
filter?: string;
/**
* Order items by property values
*/
orderby?: string[];
/**
* Search items by search phrases
*/
search?: string;
/**
* Select properties to be returned
*/
select?: string[];
/**
* Skip the first n items
*/
skip?: number;
/**
* Show only the first n items
*/
top?: number;
}
/**
* The deserialization information for the current model
* @returns {Record<string, (node: ParseNode) => void>}
*/
export declare function deserializeIntoDeltaGetResponse(deltaGetResponse?: Partial<DeltaGetResponse> | undefined): Record<string, (node: ParseNode) => void>;
/**
* Serializes information the current object
* @param writer Serialization writer to use to serialize this model
*/
export declare function serializeDeltaGetResponse(writer: SerializationWriter, deltaGetResponse?: Partial<DeltaGetResponse> | undefined | null): void;
/**
* Uri template for the request builder.
*/
export declare const DeltaRequestBuilderUriTemplate = "{+baseurl}/users/{user%2Did}/planner/all/delta(){?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the requests in the request builder.
*/
export declare const DeltaRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map