import { type DataRequest, type Pagination } from '../../../models/index.js'; import { type WithRequestItemRequestBuilder } from './item/index.js'; import { type AdditionalDataHolder, type BaseRequestBuilder, type Guid, type KeysToExcludeForNavigationMetadata, type NavigationMetadata, 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 {RequestsGetResponse} */ export declare function createRequestsGetResponseFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record void>); /** * 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 {RequestsPostRequestBody} */ export declare function createRequestsPostRequestBodyFromDiscriminatorValue(parseNode: ParseNode | undefined): ((instance?: Parsable) => Record void>); /** * The deserialization information for the current model * @param RequestsGetResponse The instance to deserialize into. * @returns {Record void>} */ export declare function deserializeIntoRequestsGetResponse(requestsGetResponse?: Partial | undefined): Record void>; /** * The deserialization information for the current model * @param RequestsPostRequestBody The instance to deserialize into. * @returns {Record void>} */ export declare function deserializeIntoRequestsPostRequestBody(requestsPostRequestBody?: Partial | undefined): Record void>; export type GetSortQueryParameterType = (typeof GetSortQueryParameterTypeObject)[keyof typeof GetSortQueryParameterTypeObject]; export interface RequestsGetResponse extends AdditionalDataHolder, Parsable { /** * The pagination property */ pagination?: Pagination | null; /** * The results property */ results?: DataRequest[] | null; } export interface RequestsPostRequestBody extends AdditionalDataHolder, Parsable { /** * The callback URL for job completion notifications */ callbackUrl?: string | null; /** * Specifies the timeframe for extracting data in a scheduled request */ dateRange?: RequestsPostRequestBody_dateRange | null; /** * The user-entered description of this data request */ description?: string | null; /** * The date and time when a one-time job execution or a recurring interval schedule begins (ISO 8601) */ effectiveFrom?: Date | null; /** * The date and time when the recurring interval schedule ends (ISO 8601) */ effectiveTo?: Date | null; /** * The end date and time for the data extraction (ISO 8601) */ endDate?: Date | null; /** * The data request's active/inactive status. Default is true */ isActive?: boolean | null; /** * (Legacy) A single project ID for the data request. Superseded by projectIdList */ projectId?: string | null; /** * A list of up to 50 project IDs for the data request */ projectIdList?: string[] | null; /** * The types of projects to be included in a request. Default is all */ projectStatus?: RequestsPostRequestBody_projectStatus | null; /** * The number of scheduleInterval units to wait between job execution */ reoccuringInterval?: number | null; /** * The scheduling interval unit for jobs spawned by this data request */ scheduleInterval?: RequestsPostRequestBody_scheduleInterval | null; /** * Send a notification email to the user upon job completion. Default is true */ sendEmail?: boolean | null; /** * The service groups from which to extract data */ serviceGroups?: string[] | null; /** * The start date and time for the data extraction (ISO 8601) */ startDate?: Date | null; } export type RequestsPostRequestBody_dateRange = (typeof RequestsPostRequestBody_dateRangeObject)[keyof typeof RequestsPostRequestBody_dateRangeObject]; export type RequestsPostRequestBody_projectStatus = (typeof RequestsPostRequestBody_projectStatusObject)[keyof typeof RequestsPostRequestBody_projectStatusObject]; export type RequestsPostRequestBody_scheduleInterval = (typeof RequestsPostRequestBody_scheduleIntervalObject)[keyof typeof RequestsPostRequestBody_scheduleIntervalObject]; /** * Builds and executes requests for operations under /accounts/{accountId}/requests */ export interface RequestsRequestBuilder extends BaseRequestBuilder { /** * Gets an item from the Autodesk.ACC.DataConnector.accounts.item.requests.item collection * @param requestId The ID of the specified request * @returns {WithRequestItemRequestBuilder} */ byRequestId(requestId: Guid): WithRequestItemRequestBuilder; /** * Retrieves a paginated list of data requests created by the authenticated user.Supports filtering, sorting, and pagination parameters.**Response Body**: Paginated array of data request objects * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise} */ get(requestConfiguration?: RequestConfiguration | undefined): Promise; /** * Creates a new data request that defines parameters for data extraction including:- Account and project scope- Service groups to extract data from- Scheduling parameters for job execution- Optional callback URL for notifications**Request Body**: JSON object with data request configuration**Response Body**: Complete data request object with generated ID and metadata * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {Promise} */ post(body: RequestsPostRequestBody, requestConfiguration?: RequestConfiguration | undefined): Promise; /** * Retrieves a paginated list of data requests created by the authenticated user.Supports filtering, sorting, and pagination parameters.**Response Body**: Paginated array of data request objects * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toGetRequestInformation(requestConfiguration?: RequestConfiguration | undefined): RequestInformation; /** * Creates a new data request that defines parameters for data extraction including:- Account and project scope- Service groups to extract data from- Scheduling parameters for job execution- Optional callback URL for notifications**Request Body**: JSON object with data request configuration**Response Body**: Complete data request object with generated ID and metadata * @param body The request body * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options. * @returns {RequestInformation} */ toPostRequestInformation(body: RequestsPostRequestBody, requestConfiguration?: RequestConfiguration | undefined): RequestInformation; } /** * Retrieves a paginated list of data requests created by the authenticated user.Supports filtering, sorting, and pagination parameters.**Response Body**: Paginated array of data request objects */ export interface RequestsRequestBuilderGetQueryParameters { /** * Return only the data requests in which the specified field has the specified value */ filtercreatedAt?: string; /** * Return only the data requests in which the specified field has the specified value */ filtereffectiveFrom?: string; /** * Return only the data requests in which the specified field has the specified value */ filtereffectiveTo?: string; /** * Return only the data requests in which the specified field has the specified value */ filterendDate?: string; /** * Return only the data requests in which the specified field has the specified value */ filterisActive?: string; /** * Return only the data requests in which the specified field has the specified value */ filterprojectId?: string; /** * Return only the data requests in which the specified field has the specified value */ filterreoccuringInterval?: string; /** * Return only the data requests in which the specified field has the specified value */ filterscheduleInterval?: string; /** * Return only the data requests in which the specified field has the specified value */ filterstartDate?: string; /** * Return only the data requests in which the specified field has the specified value */ filterupdatedAt?: string; /** * The number of data connector objects to return */ limit?: number; /** * The number of data objects to skip before starting to collect the result set */ offset?: number; /** * The sort order of returned data connector objects */ sort?: GetSortQueryParameterType; /** * A string of comma-separated names of the fields by which to sort the returned data requests */ sortFields?: string; } /** * Serializes information the current object * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type. * @param RequestsGetResponse The instance to serialize from. * @param writer Serialization writer to use to serialize this model */ export declare function serializeRequestsGetResponse(writer: SerializationWriter, requestsGetResponse?: Partial | undefined | null, isSerializingDerivedType?: boolean): void; /** * Serializes information the current object * @param isSerializingDerivedType A boolean indicating whether the serialization is for a derived type. * @param RequestsPostRequestBody The instance to serialize from. * @param writer Serialization writer to use to serialize this model */ export declare function serializeRequestsPostRequestBody(writer: SerializationWriter, requestsPostRequestBody?: Partial | undefined | null, isSerializingDerivedType?: boolean): void; /** * Uri template for the request builder. */ export declare const RequestsRequestBuilderUriTemplate = "{+baseurl}/accounts/{accountId}/requests{?filter%5BcreatedAt%5D*,filter%5BeffectiveFrom%5D*,filter%5BeffectiveTo%5D*,filter%5BendDate%5D*,filter%5BisActive%5D*,filter%5BprojectId%5D*,filter%5BreoccuringInterval%5D*,filter%5BscheduleInterval%5D*,filter%5BstartDate%5D*,filter%5BupdatedAt%5D*,limit*,offset*,sort*,sortFields*}"; export declare const GetSortQueryParameterTypeObject: { readonly Asc: "asc"; readonly Desc: "desc"; }; /** * Specifies the timeframe for extracting data in a scheduled request */ export declare const RequestsPostRequestBody_dateRangeObject: { readonly TODAY: "TODAY"; readonly YESTERDAY: "YESTERDAY"; readonly PAST_7_DAYS: "PAST_7_DAYS"; readonly MONTH_TO_DATE: "MONTH_TO_DATE"; readonly LAST_MONTH: "LAST_MONTH"; }; /** * The types of projects to be included in a request. Default is all */ export declare const RequestsPostRequestBody_projectStatusObject: { readonly All: "all"; readonly Archived: "archived"; readonly Active: "active"; }; /** * The scheduling interval unit for jobs spawned by this data request */ export declare const RequestsPostRequestBody_scheduleIntervalObject: { readonly ONE_TIME: "ONE_TIME"; readonly DAY: "DAY"; readonly WEEK: "WEEK"; readonly MONTH: "MONTH"; readonly YEAR: "YEAR"; }; /** * Metadata for all the navigation properties in the request builder. */ export declare const RequestsRequestBuilderNavigationMetadata: Record, NavigationMetadata>; /** * Metadata for all the requests in the request builder. */ export declare const RequestsRequestBuilderRequestsMetadata: RequestsMetadata; //# sourceMappingURL=index.d.ts.map