@microsoft/msgraph-beta-sdk-print
Version:
Print fluent API for Microsoft Graph
103 lines • 5.72 kB
TypeScript
import { type PrintJob, type PrintJobCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type PrintJobItemRequestBuilder } from './item/index.js';
import { type BaseRequestBuilder, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
* Provides operations to manage the jobs property of the microsoft.graph.printerBase entity.
*/
export interface JobsRequestBuilder extends BaseRequestBuilder<JobsRequestBuilder> {
/**
* Provides operations to count the resources in the collection.
* @deprecated The printerShares navigation property is deprecated and will stop returning data on July 31, 2023. Please use the shares navigation property instead of this. as of 2023-06/Tasks_And_Plans on 2023-06-13 and will be removed 2023-07-31
*/
get count(): CountRequestBuilder;
/**
* Provides operations to manage the jobs property of the microsoft.graph.printerBase entity.
* @param printJobId The unique identifier of printJob
* @returns {PrintJobItemRequestBuilder}
* @deprecated The printerShares navigation property is deprecated and will stop returning data on July 31, 2023. Please use the shares navigation property instead of this. as of 2023-06/Tasks_And_Plans on 2023-06-13 and will be removed 2023-07-31
*/
byPrintJobId(printJobId: string): PrintJobItemRequestBuilder;
/**
* The list of jobs that are queued for printing by the printer/printerShare.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<PrintJobCollectionResponse>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @deprecated The printerShares navigation property is deprecated and will stop returning data on July 31, 2023. Please use the shares navigation property instead of this. as of 2023-06/Tasks_And_Plans on 2023-06-13 and will be removed 2023-07-31
*/
get(requestConfiguration?: RequestConfiguration<JobsRequestBuilderGetQueryParameters> | undefined): Promise<PrintJobCollectionResponse | undefined>;
/**
* Create new navigation property to jobs for print
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<PrintJob>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @deprecated The printerShares navigation property is deprecated and will stop returning data on July 31, 2023. Please use the shares navigation property instead of this. as of 2023-06/Tasks_And_Plans on 2023-06-13 and will be removed 2023-07-31
*/
post(body: PrintJob, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<PrintJob | undefined>;
/**
* The list of jobs that are queued for printing by the printer/printerShare.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
* @deprecated The printerShares navigation property is deprecated and will stop returning data on July 31, 2023. Please use the shares navigation property instead of this. as of 2023-06/Tasks_And_Plans on 2023-06-13 and will be removed 2023-07-31
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<JobsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Create new navigation property to jobs for print
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
* @deprecated The printerShares navigation property is deprecated and will stop returning data on July 31, 2023. Please use the shares navigation property instead of this. as of 2023-06/Tasks_And_Plans on 2023-06-13 and will be removed 2023-07-31
*/
toPostRequestInformation(body: PrintJob, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* The list of jobs that are queued for printing by the printer/printerShare.
*/
export interface JobsRequestBuilderGetQueryParameters {
/**
* 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;
}
/**
* Uri template for the request builder.
*/
export declare const JobsRequestBuilderUriTemplate = "{+baseurl}/print/printerShares/{printerShare%2Did}/jobs{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const JobsRequestBuilderNavigationMetadata: Record<Exclude<keyof JobsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const JobsRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map