@microsoft/msgraph-beta-sdk-organization/organization/index.d.ts

Organization fluent API for Microsoft Graph

import { type Organization, type OrganizationCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type DeltaRequestBuilder } from './delta/index.js';
import { type GetByIdsRequestBuilder } from './getByIds/index.js';
import { type GetUserOwnedObjectsRequestBuilder } from './getUserOwnedObjects/index.js';
import { type OrganizationItemRequestBuilder } from './item/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 organization entities.
 */
export interface OrganizationRequestBuilder extends BaseRequestBuilder<OrganizationRequestBuilder> {
    /**
     * Provides operations to count the resources in the collection.
     */
    get count(): CountRequestBuilder;
    /**
     * Provides operations to call the delta method.
     */
    get delta(): DeltaRequestBuilder;
    /**
     * Provides operations to call the getByIds method.
     */
    get getByIds(): GetByIdsRequestBuilder;
    /**
     * Provides operations to call the getUserOwnedObjects method.
     */
    get getUserOwnedObjects(): GetUserOwnedObjectsRequestBuilder;
    /**
     * Provides operations to call the validateProperties method.
     */
    get validateProperties(): ValidatePropertiesRequestBuilder;
    /**
     * Provides operations to manage the collection of organization entities.
     * @param organizationId The unique identifier of organization
     * @returns {OrganizationItemRequestBuilder}
     */
    byOrganizationId(organizationId: string): OrganizationItemRequestBuilder;
    /**
     * Retrieve a list of organization objects. There's only one organization object in the collection.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<OrganizationCollectionResponse>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/organization-list?view=graph-rest-beta|Find more info here}
     */
    get(requestConfiguration?: RequestConfiguration<OrganizationRequestBuilderGetQueryParameters> | undefined): Promise<OrganizationCollectionResponse | undefined>;
    /**
     * Add new entity to organization
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<Organization>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     */
    post(body: Organization, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<Organization | undefined>;
    /**
     * Retrieve a list of organization objects. There's only one organization object in the collection.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<OrganizationRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Add new entity to organization
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toPostRequestInformation(body: Organization, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Retrieve a list of organization objects. There's only one organization object in the collection.
 */
export interface OrganizationRequestBuilderGetQueryParameters {
    /**
     * 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 OrganizationRequestBuilderUriTemplate = "{+baseurl}/organization{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const OrganizationRequestBuilderNavigationMetadata: Record<Exclude<keyof OrganizationRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const OrganizationRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map