@microsoft/msgraph-beta-sdk-external
Version:
External fluent API for Microsoft Graph
99 lines • 5.26 kB
TypeScript
import { type ReferenceDefinition, type ReferenceDefinitionCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/industryData/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type ReferenceDefinitionItemRequestBuilder } 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 referenceDefinitions property of the microsoft.graph.industryData.industryDataRoot entity.
*/
export interface ReferenceDefinitionsRequestBuilder extends BaseRequestBuilder<ReferenceDefinitionsRequestBuilder> {
/**
* Provides operations to count the resources in the collection.
*/
get count(): CountRequestBuilder;
/**
* Provides operations to manage the referenceDefinitions property of the microsoft.graph.industryData.industryDataRoot entity.
* @param referenceDefinitionId The unique identifier of referenceDefinition
* @returns {ReferenceDefinitionItemRequestBuilder}
*/
byReferenceDefinitionId(referenceDefinitionId: string): ReferenceDefinitionItemRequestBuilder;
/**
* Get a list of the referenceDefinition objects and their properties.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<ReferenceDefinitionCollectionResponse>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/industrydata-referencedefinition-list?view=graph-rest-beta|Find more info here}
*/
get(requestConfiguration?: RequestConfiguration<ReferenceDefinitionsRequestBuilderGetQueryParameters> | undefined): Promise<ReferenceDefinitionCollectionResponse | undefined>;
/**
* Create a new referenceDefinition object. referenceDefinition objects associate incoming data with standardized reference types values for validation. You can extend the following reference types with other codes that better align with your source data.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {Promise<ReferenceDefinition>}
* @throws {ODataError} error when the service returns a 4XX or 5XX status code
* @see {@link https://learn.microsoft.com/graph/api/industrydata-referencedefinition-post?view=graph-rest-beta|Find more info here}
*/
post(body: ReferenceDefinition, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<ReferenceDefinition | undefined>;
/**
* Get a list of the referenceDefinition objects and their properties.
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toGetRequestInformation(requestConfiguration?: RequestConfiguration<ReferenceDefinitionsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
/**
* Create a new referenceDefinition object. referenceDefinition objects associate incoming data with standardized reference types values for validation. You can extend the following reference types with other codes that better align with your source data.
* @param body The request body
* @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
* @returns {RequestInformation}
*/
toPostRequestInformation(body: ReferenceDefinition, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
* Get a list of the referenceDefinition objects and their properties.
*/
export interface ReferenceDefinitionsRequestBuilderGetQueryParameters {
/**
* 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 ReferenceDefinitionsRequestBuilderUriTemplate = "{+baseurl}/external/industryData/referenceDefinitions{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
* Metadata for all the navigation properties in the request builder.
*/
export declare const ReferenceDefinitionsRequestBuilderNavigationMetadata: Record<Exclude<keyof ReferenceDefinitionsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
* Metadata for all the requests in the request builder.
*/
export declare const ReferenceDefinitionsRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map