@microsoft/msgraph-beta-sdk-directory/directory/subscriptions/index.d.ts

Directory fluent API for Microsoft Graph

import { type CompanySubscription, type CompanySubscriptionCollectionResponse } from '@microsoft/msgraph-beta-sdk/models/index.js';
import { type CountRequestBuilder } from './count/index.js';
import { type CompanySubscriptionItemRequestBuilder } 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 subscriptions property of the microsoft.graph.directory entity.
 */
export interface SubscriptionsRequestBuilder extends BaseRequestBuilder<SubscriptionsRequestBuilder> {
    /**
     * Provides operations to count the resources in the collection.
     */
    get count(): CountRequestBuilder;
    /**
     * Provides operations to manage the subscriptions property of the microsoft.graph.directory entity.
     * @param companySubscriptionId The unique identifier of companySubscription
     * @returns {CompanySubscriptionItemRequestBuilder}
     */
    byCompanySubscriptionId(companySubscriptionId: string): CompanySubscriptionItemRequestBuilder;
    /**
     * Get the list of commercial subscriptions that an organization has acquired.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<CompanySubscriptionCollectionResponse>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     * @see {@link https://learn.microsoft.com/graph/api/directory-list-subscriptions?view=graph-rest-beta|Find more info here}
     */
    get(requestConfiguration?: RequestConfiguration<SubscriptionsRequestBuilderGetQueryParameters> | undefined): Promise<CompanySubscriptionCollectionResponse | undefined>;
    /**
     * Create new navigation property to subscriptions for directory
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {Promise<CompanySubscription>}
     * @throws {ODataError} error when the service returns a 4XX or 5XX status code
     */
    post(body: CompanySubscription, requestConfiguration?: RequestConfiguration<object> | undefined): Promise<CompanySubscription | undefined>;
    /**
     * Get the list of commercial subscriptions that an organization has acquired.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<SubscriptionsRequestBuilderGetQueryParameters> | undefined): RequestInformation;
    /**
     * Create new navigation property to subscriptions for directory
     * @param body The request body
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toPostRequestInformation(body: CompanySubscription, requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Get the list of commercial subscriptions that an organization has acquired.
 */
export interface SubscriptionsRequestBuilderGetQueryParameters {
    /**
     * 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 SubscriptionsRequestBuilderUriTemplate = "{+baseurl}/directory/subscriptions{?%24count,%24expand,%24filter,%24orderby,%24search,%24select,%24skip,%24top}";
/**
 * Metadata for all the navigation properties in the request builder.
 */
export declare const SubscriptionsRequestBuilderNavigationMetadata: Record<Exclude<keyof SubscriptionsRequestBuilder, KeysToExcludeForNavigationMetadata>, NavigationMetadata>;
/**
 * Metadata for all the requests in the request builder.
 */
export declare const SubscriptionsRequestBuilderRequestsMetadata: RequestsMetadata;
//# sourceMappingURL=index.d.ts.map