@azure-rest/ai-translation-document 1.0.0-alpha.20250226.1 → 1.0.0-alpha.20250228.1

package/dist/browser/parameters.d.ts

@@ -0,0 +1,184 @@
+import type { RawHttpHeadersInput } from "@azure/core-rest-pipeline";
+import type { RequestParameters } from "@azure-rest/core-client";
+import type { DocumentTranslateContent, StartTranslationDetails, FileFormatType } from "./models.js";
+export interface DocumentTranslateHeaders {
+    /** An opaque, globally-unique, client-generated string identifier for the request. */
+    "x-ms-client-request-id"?: string;
+}
+export interface DocumentTranslateBodyParam {
+    /** Document Translate Request Content */
+    body: DocumentTranslateContent;
+}
+export interface DocumentTranslateQueryParamProperties {
+    /**
+     * Specifies source language of the input document.
+     * If this parameter isn't specified, automatic language detection is applied to determine the source language.
+     * For example if the source document is written in English, then use sourceLanguage=en
+     */
+    sourceLanguage?: string;
+    /**
+     * Specifies the language of the output document.
+     * The target language must be one of the supported languages included in the translation scope.
+     * For example if you want to translate the document in German language, then use targetLanguage=de
+     */
+    targetLanguage: string;
+    /**
+     * A string specifying the category (domain) of the translation. This parameter is used to get translations
+     * from a customized system built with Custom Translator. Add the Category ID from your Custom Translator
+     * project details to this parameter to use your deployed customized system. Default value is: general.
+     */
+    category?: string;
+    /**
+     * Specifies that the service is allowed to fall back to a general system when a custom system doesn't exist.
+     * Possible values are: true (default) or false.
+     */
+    allowFallback?: boolean;
+}
+export interface DocumentTranslateQueryParam {
+    queryParameters: DocumentTranslateQueryParamProperties;
+}
+export interface DocumentTranslateHeaderParam {
+    headers?: RawHttpHeadersInput & DocumentTranslateHeaders;
+}
+export interface DocumentTranslateMediaTypesParam {
+    /** Content Type as multipart/form-data */
+    contentType: "multipart/form-data";
+}
+export type DocumentTranslateParameters = DocumentTranslateQueryParam & DocumentTranslateHeaderParam & DocumentTranslateMediaTypesParam & DocumentTranslateBodyParam & RequestParameters;
+export interface StartTranslationBodyParam {
+    /** Translation job submission batch request */
+    body: StartTranslationDetails;
+}
+export type StartTranslationParameters = StartTranslationBodyParam & RequestParameters;
+export interface GetTranslationsStatusQueryParamProperties {
+    /**
+     * top indicates the total number of records the user wants to be returned across
+     * all pages.
+     *
+     * Clients MAY use top and skip query parameters to
+     * specify a number of results to return and an offset into the collection.
+     * When
+     * both top and skip are given by a client, the server SHOULD first apply skip
+     * and then top on the collection.
+     *
+     * Note: If the server can't honor
+     * top and/or skip, the server MUST return an error to the client informing
+     * about it instead of just ignoring the query options.
+     */
+    top?: number;
+    /**
+     * skip indicates the number of records to skip from the list of records held by
+     * the server based on the sorting method specified.  By default, we sort by
+     * descending start time.
+     *
+     * Clients MAY use top and skip query
+     * parameters to specify a number of results to return and an offset into the
+     * collection.
+     * When both top and skip are given by a client, the server SHOULD
+     * first apply skip and then top on the collection.
+     *
+     * Note: If the
+     * server can't honor top and/or skip, the server MUST return an error to the
+     * client informing about it instead of just ignoring the query options.
+     */
+    skip?: number;
+    /**
+     * maxpagesize is the maximum items returned in a page.  If more items are
+     * requested via top (or top is not specified and there are more items to be
+     * returned), @nextLink will contain the link to the next page.
+     *
+     *
+     * Clients MAY request server-driven paging with a specific page size by
+     * specifying a maxpagesize preference. The server SHOULD honor this preference
+     * if the specified page size is smaller than the server's default page size.
+     */
+    maxpagesize?: number;
+    /** Ids to use in filtering */
+    ids?: string[];
+    /** Statuses to use in filtering */
+    statuses?: string[];
+    /** the start datetime to get items after */
+    createdDateTimeUtcStart?: Date | string;
+    /** the end datetime to get items before */
+    createdDateTimeUtcEnd?: Date | string;
+    /** the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc') */
+    orderby?: string[];
+}
+export interface GetTranslationsStatusQueryParam {
+    queryParameters?: GetTranslationsStatusQueryParamProperties;
+}
+export type GetTranslationsStatusParameters = GetTranslationsStatusQueryParam & RequestParameters;
+export type GetDocumentStatusParameters = RequestParameters;
+export type GetTranslationStatusParameters = RequestParameters;
+export type CancelTranslationParameters = RequestParameters;
+export interface GetDocumentsStatusQueryParamProperties {
+    /**
+     * top indicates the total number of records the user wants to be returned across
+     * all pages.
+     *
+     * Clients MAY use top and skip query parameters to
+     * specify a number of results to return and an offset into the collection.
+     * When
+     * both top and skip are given by a client, the server SHOULD first apply skip
+     * and then top on the collection.
+     *
+     * Note: If the server can't honor
+     * top and/or skip, the server MUST return an error to the client informing
+     * about it instead of just ignoring the query options.
+     */
+    top?: number;
+    /**
+     * skip indicates the number of records to skip from the list of records held by
+     * the server based on the sorting method specified.  By default, we sort by
+     * descending start time.
+     *
+     * Clients MAY use top and skip query
+     * parameters to specify a number of results to return and an offset into the
+     * collection.
+     * When both top and skip are given by a client, the server SHOULD
+     * first apply skip and then top on the collection.
+     *
+     * Note: If the
+     * server can't honor top and/or skip, the server MUST return an error to the
+     * client informing about it instead of just ignoring the query options.
+     */
+    skip?: number;
+    /**
+     * maxpagesize is the maximum items returned in a page.  If more items are
+     * requested via top (or top is not specified and there are more items to be
+     * returned), @nextLink will contain the link to the next page.
+     *
+     *
+     * Clients MAY request server-driven paging with a specific page size by
+     * specifying a maxpagesize preference. The server SHOULD honor this preference
+     * if the specified page size is smaller than the server's default page size.
+     */
+    maxpagesize?: number;
+    /** Ids to use in filtering */
+    ids?: string[];
+    /** Statuses to use in filtering */
+    statuses?: string[];
+    /** the start datetime to get items after */
+    createdDateTimeUtcStart?: Date | string;
+    /** the end datetime to get items before */
+    createdDateTimeUtcEnd?: Date | string;
+    /** the sorting query for the collection (ex: 'CreatedDateTimeUtc asc','CreatedDateTimeUtc desc') */
+    orderby?: string[];
+}
+export interface GetDocumentsStatusQueryParam {
+    queryParameters?: GetDocumentsStatusQueryParamProperties;
+}
+export type GetDocumentsStatusParameters = GetDocumentsStatusQueryParam & RequestParameters;
+export interface GetSupportedFormatsQueryParamProperties {
+    /**
+     * the type of format like document or glossary
+     *
+     * Possible values: "document", "glossary"
+     */
+    type?: FileFormatType;
+}
+export interface GetSupportedFormatsQueryParam {
+    queryParameters?: GetSupportedFormatsQueryParamProperties;
+}
+export type GetSupportedFormatsParameters = GetSupportedFormatsQueryParam & RequestParameters;
+//# sourceMappingURL=parameters.d.ts.map

package/dist/browser/parameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../src/parameters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACjE,OAAO,KAAK,EACV,wBAAwB,EACxB,uBAAuB,EACvB,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,MAAM,WAAW,wBAAwB;IACvC,sFAAsF;IACtF,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAED,MAAM,WAAW,0BAA0B;IACzC,yCAAyC;IACzC,IAAI,EAAE,wBAAwB,CAAC;CAChC;AAED,MAAM,WAAW,qCAAqC;IACpD;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,2BAA2B;IAC1C,eAAe,EAAE,qCAAqC,CAAC;CACxD;AAED,MAAM,WAAW,4BAA4B;IAC3C,OAAO,CAAC,EAAE,mBAAmB,GAAG,wBAAwB,CAAC;CAC1D;AAED,MAAM,WAAW,gCAAgC;IAC/C,0CAA0C;IAC1C,WAAW,EAAE,qBAAqB,CAAC;CACpC;AAED,MAAM,MAAM,2BAA2B,GAAG,2BAA2B,GACnE,4BAA4B,GAC5B,gCAAgC,GAChC,0BAA0B,GAC1B,iBAAiB,CAAC;AAEpB,MAAM,WAAW,yBAAyB;IACxC,+CAA+C;IAC/C,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,MAAM,0BAA0B,GAAG,yBAAyB,GAAG,iBAAiB,CAAC;AAEvF,MAAM,WAAW,yCAAyC;IACxD;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,4CAA4C;IAC5C,uBAAuB,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IACxC,2CAA2C;IAC3C,qBAAqB,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IACtC,oGAAoG;IACpG,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,+BAA+B;IAC9C,eAAe,CAAC,EAAE,yCAAyC,CAAC;CAC7D;AAED,MAAM,MAAM,+BAA+B,GAAG,+BAA+B,GAAG,iBAAiB,CAAC;AAClG,MAAM,MAAM,2BAA2B,GAAG,iBAAiB,CAAC;AAC5D,MAAM,MAAM,8BAA8B,GAAG,iBAAiB,CAAC;AAC/D,MAAM,MAAM,2BAA2B,GAAG,iBAAiB,CAAC;AAE5D,MAAM,WAAW,sCAAsC;IACrD;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,8BAA8B;IAC9B,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,4CAA4C;IAC5C,uBAAuB,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IACxC,2CAA2C;IAC3C,qBAAqB,CAAC,EAAE,IAAI,GAAG,MAAM,CAAC;IACtC,oGAAoG;IACpG,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,4BAA4B;IAC3C,eAAe,CAAC,EAAE,sCAAsC,CAAC;CAC1D;AAED,MAAM,MAAM,4BAA4B,GAAG,4BAA4B,GAAG,iBAAiB,CAAC;AAE5F,MAAM,WAAW,uCAAuC;IACtD;;;;OAIG;IACH,IAAI,CAAC,EAAE,cAAc,CAAC;CACvB;AAED,MAAM,WAAW,6BAA6B;IAC5C,eAAe,CAAC,EAAE,uCAAuC,CAAC;CAC3D;AAED,MAAM,MAAM,6BAA6B,GAAG,6BAA6B,GAAG,iBAAiB,CAAC"}

package/dist/browser/pollingHelper.d.ts

@@ -0,0 +1,77 @@
+import type { Client } from "@azure-rest/core-client";
+import type { AbortSignalLike } from "@azure/abort-controller";
+import type { CancelOnProgress, CreateHttpPollerOptions, OperationState } from "@azure/core-lro";
+import type { StartTranslation202Response, StartTranslationDefaultResponse, StartTranslationLogicalResponse } from "./responses.js";
+/**
+ * A simple poller that can be used to poll a long running operation.
+ */
+export interface SimplePollerLike<TState extends OperationState<TResult>, TResult> {
+    /**
+     * Returns true if the poller has finished polling.
+     */
+    isDone(): boolean;
+    /**
+     * Returns the state of the operation.
+     */
+    getOperationState(): TState;
+    /**
+     * Returns the result value of the operation,
+     * regardless of the state of the poller.
+     * It can return undefined or an incomplete form of the final TResult value
+     * depending on the implementation.
+     */
+    getResult(): TResult | undefined;
+    /**
+     * Returns a promise that will resolve once a single polling request finishes.
+     * It does this by calling the update method of the Poller's operation.
+     */
+    poll(options?: {
+        abortSignal?: AbortSignalLike;
+    }): Promise<TState>;
+    /**
+     * Returns a promise that will resolve once the underlying operation is completed.
+     */
+    pollUntilDone(pollOptions?: {
+        abortSignal?: AbortSignalLike;
+    }): Promise<TResult>;
+    /**
+     * Invokes the provided callback after each polling is completed,
+     * sending the current state of the poller's operation.
+     *
+     * It returns a method that can be used to stop receiving updates on the given callback function.
+     */
+    onProgress(callback: (state: TState) => void): CancelOnProgress;
+    /**
+     * Returns a promise that could be used for serialized version of the poller's operation
+     * by invoking the operation's serialize method.
+     */
+    serialize(): Promise<string>;
+    /**
+     * Wait the poller to be submitted.
+     */
+    submitted(): Promise<void>;
+    /**
+     * Returns a string representation of the poller's operation. Similar to serialize but returns a string.
+     * @deprecated Use serialize() instead.
+     */
+    toString(): string;
+    /**
+     * Stops the poller from continuing to poll. Please note this will only stop the client-side polling
+     * @deprecated Use abortSignal to stop polling instead.
+     */
+    stopPolling(): void;
+    /**
+     * Returns true if the poller is stopped.
+     * @deprecated Use abortSignal status to track this instead.
+     */
+    isStopped(): boolean;
+}
+/**
+ * Helper function that builds a Poller object to help polling a long running operation.
+ * @param client - Client to use for sending the request to get additional pages.
+ * @param initialResponse - The initial response.
+ * @param options - Options to set a resume state or custom polling interval.
+ * @returns - A poller object to poll for operation state updates and eventually get the final response.
+ */
+export declare function getLongRunningPoller<TResult extends StartTranslationLogicalResponse | StartTranslationDefaultResponse>(client: Client, initialResponse: StartTranslation202Response | StartTranslationDefaultResponse, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>;
+//# sourceMappingURL=pollingHelper.d.ts.map

package/dist/browser/pollingHelper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pollingHelper.d.ts","sourceRoot":"","sources":["../../src/pollingHelper.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAgB,MAAM,yBAAyB,CAAC;AACpE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,KAAK,EACV,gBAAgB,EAChB,uBAAuB,EAGvB,cAAc,EACf,MAAM,iBAAiB,CAAC;AAEzB,OAAO,KAAK,EACV,2BAA2B,EAC3B,+BAA+B,EAC/B,+BAA+B,EAChC,MAAM,gBAAgB,CAAC;AAExB;;GAEG;AACH,MAAM,WAAW,gBAAgB,CAAC,MAAM,SAAS,cAAc,CAAC,OAAO,CAAC,EAAE,OAAO;IAC/E;;OAEG;IACH,MAAM,IAAI,OAAO,CAAC;IAClB;;OAEG;IACH,iBAAiB,IAAI,MAAM,CAAC;IAC5B;;;;;OAKG;IACH,SAAS,IAAI,OAAO,GAAG,SAAS,CAAC;IACjC;;;OAGG;IACH,IAAI,CAAC,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,eAAe,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACnE;;OAEG;IACH,aAAa,CAAC,WAAW,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,eAAe,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IACjF;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,GAAG,gBAAgB,CAAC;IAEhE;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE3B;;;OAGG;IACH,QAAQ,IAAI,MAAM,CAAC;IAEnB;;;OAGG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB;;;OAGG;IACH,SAAS,IAAI,OAAO,CAAC;CACtB;AAED;;;;;;GAMG;AACH,wBAAsB,oBAAoB,CACxC,OAAO,SAAS,+BAA+B,GAAG,+BAA+B,EAEjF,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,2BAA2B,GAAG,+BAA+B,EAC9E,OAAO,CAAC,EAAE,uBAAuB,CAAC,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,GAClE,OAAO,CAAC,gBAAgB,CAAC,cAAc,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC"}

package/dist/browser/responses.d.ts

@@ -0,0 +1,132 @@
+import type { RawHttpHeaders } from "@azure/core-rest-pipeline";
+import type { HttpResponse, ErrorResponse } from "@azure-rest/core-client";
+import type { TranslationsStatusOutput, DocumentStatusOutput, TranslationStatusOutput, DocumentsStatusOutput, SupportedFileFormatsOutput } from "./outputModels.js";
+export interface DocumentTranslate200Headers {
+    /** An opaque, globally-unique, client-generated string identifier for the request. */
+    "x-ms-client-request-id"?: string;
+    /** response content type */
+    "content-type": "application/octet-stream";
+}
+/** The request has succeeded. */
+export interface DocumentTranslate200Response extends HttpResponse {
+    status: "200";
+    /** Value may contain any sequence of octets */
+    body: Uint8Array;
+    headers: RawHttpHeaders & DocumentTranslate200Headers;
+}
+export interface DocumentTranslateDefaultHeaders {
+    /** String error code indicating what went wrong. */
+    "x-ms-error-code"?: string;
+}
+export interface DocumentTranslateDefaultResponse extends HttpResponse {
+    status: string;
+    body: ErrorResponse;
+    headers: RawHttpHeaders & DocumentTranslateDefaultHeaders;
+}
+export interface StartTranslation202Headers {
+    /** Link to the translation operation status */
+    "operation-location": string;
+}
+/** The request has been accepted for processing, but processing has not yet completed. */
+export interface StartTranslation202Response extends HttpResponse {
+    status: "202";
+    headers: RawHttpHeaders & StartTranslation202Headers;
+}
+export interface StartTranslationDefaultHeaders {
+    /** String error code indicating what went wrong. */
+    "x-ms-error-code"?: string;
+}
+export interface StartTranslationDefaultResponse extends HttpResponse {
+    status: string;
+    body: ErrorResponse;
+    headers: RawHttpHeaders & StartTranslationDefaultHeaders;
+}
+/** The final response for long-running startTranslation operation */
+export interface StartTranslationLogicalResponse extends HttpResponse {
+    status: "200";
+}
+/** The request has succeeded. */
+export interface GetTranslationsStatus200Response extends HttpResponse {
+    status: "200";
+    body: TranslationsStatusOutput;
+}
+export interface GetTranslationsStatusDefaultHeaders {
+    /** String error code indicating what went wrong. */
+    "x-ms-error-code"?: string;
+}
+export interface GetTranslationsStatusDefaultResponse extends HttpResponse {
+    status: string;
+    body: ErrorResponse;
+    headers: RawHttpHeaders & GetTranslationsStatusDefaultHeaders;
+}
+/** The request has succeeded. */
+export interface GetDocumentStatus200Response extends HttpResponse {
+    status: "200";
+    body: DocumentStatusOutput;
+}
+export interface GetDocumentStatusDefaultHeaders {
+    /** String error code indicating what went wrong. */
+    "x-ms-error-code"?: string;
+}
+export interface GetDocumentStatusDefaultResponse extends HttpResponse {
+    status: string;
+    body: ErrorResponse;
+    headers: RawHttpHeaders & GetDocumentStatusDefaultHeaders;
+}
+/** The request has succeeded. */
+export interface GetTranslationStatus200Response extends HttpResponse {
+    status: "200";
+    body: TranslationStatusOutput;
+}
+export interface GetTranslationStatusDefaultHeaders {
+    /** String error code indicating what went wrong. */
+    "x-ms-error-code"?: string;
+}
+export interface GetTranslationStatusDefaultResponse extends HttpResponse {
+    status: string;
+    body: ErrorResponse;
+    headers: RawHttpHeaders & GetTranslationStatusDefaultHeaders;
+}
+/** The request has succeeded. */
+export interface CancelTranslation200Response extends HttpResponse {
+    status: "200";
+    body: TranslationStatusOutput;
+}
+export interface CancelTranslationDefaultHeaders {
+    /** String error code indicating what went wrong. */
+    "x-ms-error-code"?: string;
+}
+export interface CancelTranslationDefaultResponse extends HttpResponse {
+    status: string;
+    body: ErrorResponse;
+    headers: RawHttpHeaders & CancelTranslationDefaultHeaders;
+}
+/** The request has succeeded. */
+export interface GetDocumentsStatus200Response extends HttpResponse {
+    status: "200";
+    body: DocumentsStatusOutput;
+}
+export interface GetDocumentsStatusDefaultHeaders {
+    /** String error code indicating what went wrong. */
+    "x-ms-error-code"?: string;
+}
+export interface GetDocumentsStatusDefaultResponse extends HttpResponse {
+    status: string;
+    body: ErrorResponse;
+    headers: RawHttpHeaders & GetDocumentsStatusDefaultHeaders;
+}
+/** The request has succeeded. */
+export interface GetSupportedFormats200Response extends HttpResponse {
+    status: "200";
+    body: SupportedFileFormatsOutput;
+}
+export interface GetSupportedFormatsDefaultHeaders {
+    /** String error code indicating what went wrong. */
+    "x-ms-error-code"?: string;
+}
+export interface GetSupportedFormatsDefaultResponse extends HttpResponse {
+    status: string;
+    body: ErrorResponse;
+    headers: RawHttpHeaders & GetSupportedFormatsDefaultHeaders;
+}
+//# sourceMappingURL=responses.d.ts.map

package/dist/browser/responses.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.d.ts","sourceRoot":"","sources":["../../src/responses.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAChE,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,KAAK,EACV,wBAAwB,EACxB,oBAAoB,EACpB,uBAAuB,EACvB,qBAAqB,EACrB,0BAA0B,EAC3B,MAAM,mBAAmB,CAAC;AAE3B,MAAM,WAAW,2BAA2B;IAC1C,sFAAsF;IACtF,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC,4BAA4B;IAC5B,cAAc,EAAE,0BAA0B,CAAC;CAC5C;AAED,iCAAiC;AACjC,MAAM,WAAW,4BAA6B,SAAQ,YAAY;IAChE,MAAM,EAAE,KAAK,CAAC;IACd,+CAA+C;IAC/C,IAAI,EAAE,UAAU,CAAC;IACjB,OAAO,EAAE,cAAc,GAAG,2BAA2B,CAAC;CACvD;AAED,MAAM,WAAW,+BAA+B;IAC9C,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,gCAAiC,SAAQ,YAAY;IACpE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,cAAc,GAAG,+BAA+B,CAAC;CAC3D;AAED,MAAM,WAAW,0BAA0B;IACzC,+CAA+C;IAC/C,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED,0FAA0F;AAC1F,MAAM,WAAW,2BAA4B,SAAQ,YAAY;IAC/D,MAAM,EAAE,KAAK,CAAC;IACd,OAAO,EAAE,cAAc,GAAG,0BAA0B,CAAC;CACtD;AAED,MAAM,WAAW,8BAA8B;IAC7C,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,+BAAgC,SAAQ,YAAY;IACnE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,cAAc,GAAG,8BAA8B,CAAC;CAC1D;AAED,qEAAqE;AACrE,MAAM,WAAW,+BAAgC,SAAQ,YAAY;IACnE,MAAM,EAAE,KAAK,CAAC;CACf;AAED,iCAAiC;AACjC,MAAM,WAAW,gCAAiC,SAAQ,YAAY;IACpE,MAAM,EAAE,KAAK,CAAC;IACd,IAAI,EAAE,wBAAwB,CAAC;CAChC;AAED,MAAM,WAAW,mCAAmC;IAClD,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,oCAAqC,SAAQ,YAAY;IACxE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,cAAc,GAAG,mCAAmC,CAAC;CAC/D;AAED,iCAAiC;AACjC,MAAM,WAAW,4BAA6B,SAAQ,YAAY;IAChE,MAAM,EAAE,KAAK,CAAC;IACd,IAAI,EAAE,oBAAoB,CAAC;CAC5B;AAED,MAAM,WAAW,+BAA+B;IAC9C,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,gCAAiC,SAAQ,YAAY;IACpE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,cAAc,GAAG,+BAA+B,CAAC;CAC3D;AAED,iCAAiC;AACjC,MAAM,WAAW,+BAAgC,SAAQ,YAAY;IACnE,MAAM,EAAE,KAAK,CAAC;IACd,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,kCAAkC;IACjD,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,mCAAoC,SAAQ,YAAY;IACvE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,cAAc,GAAG,kCAAkC,CAAC;CAC9D;AAED,iCAAiC;AACjC,MAAM,WAAW,4BAA6B,SAAQ,YAAY;IAChE,MAAM,EAAE,KAAK,CAAC;IACd,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,MAAM,WAAW,+BAA+B;IAC9C,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,gCAAiC,SAAQ,YAAY;IACpE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,cAAc,GAAG,+BAA+B,CAAC;CAC3D;AAED,iCAAiC;AACjC,MAAM,WAAW,6BAA8B,SAAQ,YAAY;IACjE,MAAM,EAAE,KAAK,CAAC;IACd,IAAI,EAAE,qBAAqB,CAAC;CAC7B;AAED,MAAM,WAAW,gCAAgC;IAC/C,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,iCAAkC,SAAQ,YAAY;IACrE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,cAAc,GAAG,gCAAgC,CAAC;CAC5D;AAED,iCAAiC;AACjC,MAAM,WAAW,8BAA+B,SAAQ,YAAY;IAClE,MAAM,EAAE,KAAK,CAAC;IACd,IAAI,EAAE,0BAA0B,CAAC;CAClC;AAED,MAAM,WAAW,iCAAiC;IAChD,oDAAoD;IACpD,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,WAAW,kCAAmC,SAAQ,YAAY;IACtE,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,aAAa,CAAC;IACpB,OAAO,EAAE,cAAc,GAAG,iCAAiC,CAAC;CAC7D"}

package/dist/commonjs/clientDefinitions.d.ts

@@ -0,0 +1,191 @@
+import type { DocumentTranslateParameters, StartTranslationParameters, GetTranslationsStatusParameters, GetDocumentStatusParameters, GetTranslationStatusParameters, CancelTranslationParameters, GetDocumentsStatusParameters, GetSupportedFormatsParameters } from "./parameters.js";
+import type { DocumentTranslate200Response, DocumentTranslateDefaultResponse, StartTranslation202Response, StartTranslationDefaultResponse, GetTranslationsStatus200Response, GetTranslationsStatusDefaultResponse, GetDocumentStatus200Response, GetDocumentStatusDefaultResponse, GetTranslationStatus200Response, GetTranslationStatusDefaultResponse, CancelTranslation200Response, CancelTranslationDefaultResponse, GetDocumentsStatus200Response, GetDocumentsStatusDefaultResponse, GetSupportedFormats200Response, GetSupportedFormatsDefaultResponse } from "./responses.js";
+import type { Client, StreamableMethod } from "@azure-rest/core-client";
+export interface DocumentTranslate {
+    /** Use this API to submit a single translation request to the Document Translation Service. */
+    post(options: DocumentTranslateParameters): StreamableMethod<DocumentTranslate200Response | DocumentTranslateDefaultResponse>;
+}
+export interface StartTranslation {
+    /**
+     * Use this API to submit a bulk (batch) translation request to the Document
+     * Translation service.
+     * Each request can contain multiple documents and must
+     * contain a source and destination container for each document.
+     *
+     * The
+     * prefix and suffix filter (if supplied) are used to filter folders. The prefix
+     * is applied to the subpath after the container name.
+     *
+     * Glossaries /
+     * Translation memory can be included in the request and are applied by the
+     * service when the document is translated.
+     *
+     * If the glossary is
+     * invalid or unreachable during translation, an error is indicated in the
+     * document status.
+     * If a file with the same name already exists at the
+     * destination, it will be overwritten. The targetUrl for each target language
+     * must be unique.
+     */
+    post(options: StartTranslationParameters): StreamableMethod<StartTranslation202Response | StartTranslationDefaultResponse>;
+    /**
+     * Returns a list of batch requests submitted and the status for each
+     * request.
+     * This list only contains batch requests submitted by the user (based on
+     * the resource).
+     *
+     * If the number of requests exceeds our paging limit,
+     * server-side paging is used. Paginated responses indicate a partial result and
+     * include a continuation token in the response.
+     * The absence of a continuation
+     * token means that no additional pages are available.
+     *
+     * top, skip
+     * and maxpagesize query parameters can be used to specify a number of results to
+     * return and an offset for the collection.
+     *
+     * top indicates the total
+     * number of records the user wants to be returned across all pages.
+     * skip
+     * indicates the number of records to skip from the list of batches based on the
+     * sorting method specified.  By default, we sort by descending start
+     * time.
+     * maxpagesize is the maximum items returned in a page.  If more items are
+     * requested via top (or top is not specified and there are more items to be
+     * returned), @nextLink will contain the link to the next page.
+     *
+     *
+     * orderby query parameter can be used to sort the returned list (ex
+     * "orderby=createdDateTimeUtc asc" or "orderby=createdDateTimeUtc
+     * desc").
+     * The default sorting is descending by createdDateTimeUtc.
+     * Some query
+     * parameters can be used to filter the returned list (ex:
+     * "status=Succeeded,Cancelled") will only return succeeded and cancelled
+     * operations.
+     * createdDateTimeUtcStart and createdDateTimeUtcEnd can be used
+     * combined or separately to specify a range of datetime to filter the returned
+     * list by.
+     * The supported filtering query parameters are (status, ids,
+     * createdDateTimeUtcStart, createdDateTimeUtcEnd).
+     *
+     * The server honors
+     * the values specified by the client. However, clients must be prepared to handle
+     * responses that contain a different page size or contain a continuation token.
+     *
+     *
+     * When both top and skip are included, the server should first apply
+     * skip and then top on the collection.
+     * Note: If the server can't honor top
+     * and/or skip, the server must return an error to the client informing about it
+     * instead of just ignoring the query options.
+     * This reduces the risk of the client
+     * making assumptions about the data returned.
+     */
+    get(options?: GetTranslationsStatusParameters): StreamableMethod<GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse>;
+}
+export interface GetDocumentStatus {
+    /**
+     * Returns the translation status for a specific document based on the request Id
+     * and document Id.
+     */
+    get(options?: GetDocumentStatusParameters): StreamableMethod<GetDocumentStatus200Response | GetDocumentStatusDefaultResponse>;
+}
+export interface GetTranslationStatus {
+    /**
+     * Returns the status for a document translation request.
+     * The status includes the
+     * overall request status, as well as the status for documents that are being
+     * translated as part of that request.
+     */
+    get(options?: GetTranslationStatusParameters): StreamableMethod<GetTranslationStatus200Response | GetTranslationStatusDefaultResponse>;
+    /**
+     * Cancel a currently processing or queued translation.
+     * A translation will not be
+     * cancelled if it is already completed or failed or cancelling. A bad request
+     * will be returned.
+     * All documents that have completed translation will not be
+     * cancelled and will be charged.
+     * All pending documents will be cancelled if
+     * possible.
+     */
+    delete(options?: CancelTranslationParameters): StreamableMethod<CancelTranslation200Response | CancelTranslationDefaultResponse>;
+}
+export interface GetDocumentsStatus {
+    /**
+     * Returns the status for all documents in a batch document translation request.
+     *
+     *
+     * If the number of documents in the response exceeds our paging limit,
+     * server-side paging is used.
+     * Paginated responses indicate a partial result and
+     * include a continuation token in the response. The absence of a continuation
+     * token means that no additional pages are available.
+     *
+     * top, skip
+     * and maxpagesize query parameters can be used to specify a number of results to
+     * return and an offset for the collection.
+     *
+     * top indicates the total
+     * number of records the user wants to be returned across all pages.
+     * skip
+     * indicates the number of records to skip from the list of document status held
+     * by the server based on the sorting method specified.  By default, we sort by
+     * descending start time.
+     * maxpagesize is the maximum items returned in a page.
+     * If more items are requested via top (or top is not specified and there are
+     * more items to be returned), @nextLink will contain the link to the next page.
+     *
+     *
+     * orderby query parameter can be used to sort the returned list (ex
+     * "orderby=createdDateTimeUtc asc" or "orderby=createdDateTimeUtc
+     * desc").
+     * The default sorting is descending by createdDateTimeUtc.
+     * Some query
+     * parameters can be used to filter the returned list (ex:
+     * "status=Succeeded,Cancelled") will only return succeeded and cancelled
+     * documents.
+     * createdDateTimeUtcStart and createdDateTimeUtcEnd can be used
+     * combined or separately to specify a range of datetime to filter the returned
+     * list by.
+     * The supported filtering query parameters are (status, ids,
+     * createdDateTimeUtcStart, createdDateTimeUtcEnd).
+     *
+     * When both top
+     * and skip are included, the server should first apply skip and then top on
+     * the collection.
+     * Note: If the server can't honor top and/or skip, the server
+     * must return an error to the client informing about it instead of just ignoring
+     * the query options.
+     * This reduces the risk of the client making assumptions about
+     * the data returned.
+     */
+    get(options?: GetDocumentsStatusParameters): StreamableMethod<GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse>;
+}
+export interface GetSupportedFormats {
+    /**
+     * The list of supported formats supported by the Document Translation
+     * service.
+     * The list includes the common file extension, as well as the
+     * content-type if using the upload API.
+     */
+    get(options?: GetSupportedFormatsParameters): StreamableMethod<GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse>;
+}
+export interface Routes {
+    /** Resource for '/document:translate' has methods for the following verbs: post */
+    (path: "/document:translate"): DocumentTranslate;
+    /** Resource for '/document/batches' has methods for the following verbs: post, get */
+    (path: "/document/batches"): StartTranslation;
+    /** Resource for '/document/batches/\{id\}/documents/\{documentId\}' has methods for the following verbs: get */
+    (path: "/document/batches/{id}/documents/{documentId}", id: string, documentId: string): GetDocumentStatus;
+    /** Resource for '/document/batches/\{id\}' has methods for the following verbs: get, delete */
+    (path: "/document/batches/{id}", id: string): GetTranslationStatus;
+    /** Resource for '/document/batches/\{id\}/documents' has methods for the following verbs: get */
+    (path: "/document/batches/{id}/documents", id: string): GetDocumentsStatus;
+    /** Resource for '/document/formats' has methods for the following verbs: get */
+    (path: "/document/formats"): GetSupportedFormats;
+}
+export type DocumentTranslationClient = Client & {
+    path: Routes;
+};
+//# sourceMappingURL=clientDefinitions.d.ts.map

package/dist/commonjs/clientDefinitions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientDefinitions.d.ts","sourceRoot":"","sources":["../../src/clientDefinitions.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,2BAA2B,EAC3B,0BAA0B,EAC1B,+BAA+B,EAC/B,2BAA2B,EAC3B,8BAA8B,EAC9B,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC9B,MAAM,iBAAiB,CAAC;AACzB,OAAO,KAAK,EACV,4BAA4B,EAC5B,gCAAgC,EAChC,2BAA2B,EAC3B,+BAA+B,EAC/B,gCAAgC,EAChC,oCAAoC,EACpC,4BAA4B,EAC5B,gCAAgC,EAChC,+BAA+B,EAC/B,mCAAmC,EACnC,4BAA4B,EAC5B,gCAAgC,EAChC,6BAA6B,EAC7B,iCAAiC,EACjC,8BAA8B,EAC9B,kCAAkC,EACnC,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAExE,MAAM,WAAW,iBAAiB;IAChC,+FAA+F;IAC/F,IAAI,CACF,OAAO,EAAE,2BAA2B,GACnC,gBAAgB,CAAC,4BAA4B,GAAG,gCAAgC,CAAC,CAAC;CACtF;AAED,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,CACF,OAAO,EAAE,0BAA0B,GAClC,gBAAgB,CAAC,2BAA2B,GAAG,+BAA+B,CAAC,CAAC;IACnF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqDG;IACH,GAAG,CACD,OAAO,CAAC,EAAE,+BAA+B,GACxC,gBAAgB,CAAC,gCAAgC,GAAG,oCAAoC,CAAC,CAAC;CAC9F;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,GAAG,CACD,OAAO,CAAC,EAAE,2BAA2B,GACpC,gBAAgB,CAAC,4BAA4B,GAAG,gCAAgC,CAAC,CAAC;CACtF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,GAAG,CACD,OAAO,CAAC,EAAE,8BAA8B,GACvC,gBAAgB,CAAC,+BAA+B,GAAG,mCAAmC,CAAC,CAAC;IAC3F;;;;;;;;;OASG;IACH,MAAM,CACJ,OAAO,CAAC,EAAE,2BAA2B,GACpC,gBAAgB,CAAC,4BAA4B,GAAG,gCAAgC,CAAC,CAAC;CACtF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+CG;IACH,GAAG,CACD,OAAO,CAAC,EAAE,4BAA4B,GACrC,gBAAgB,CAAC,6BAA6B,GAAG,iCAAiC,CAAC,CAAC;CACxF;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;OAKG;IACH,GAAG,CACD,OAAO,CAAC,EAAE,6BAA6B,GACtC,gBAAgB,CAAC,8BAA8B,GAAG,kCAAkC,CAAC,CAAC;CAC1F;AAED,MAAM,WAAW,MAAM;IACrB,mFAAmF;IACnF,CAAC,IAAI,EAAE,qBAAqB,GAAG,iBAAiB,CAAC;IACjD,sFAAsF;IACtF,CAAC,IAAI,EAAE,mBAAmB,GAAG,gBAAgB,CAAC;IAC9C,gHAAgH;IAChH,CACE,IAAI,EAAE,+CAA+C,EACrD,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,MAAM,GACjB,iBAAiB,CAAC;IACrB,+FAA+F;IAC/F,CAAC,IAAI,EAAE,wBAAwB,EAAE,EAAE,EAAE,MAAM,GAAG,oBAAoB,CAAC;IACnE,iGAAiG;IACjG,CAAC,IAAI,EAAE,kCAAkC,EAAE,EAAE,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAC3E,gFAAgF;IAChF,CAAC,IAAI,EAAE,mBAAmB,GAAG,mBAAmB,CAAC;CAClD;AAED,MAAM,MAAM,yBAAyB,GAAG,MAAM,GAAG;IAC/C,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/commonjs/clientDefinitions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=clientDefinitions.js.map

package/dist/commonjs/clientDefinitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clientDefinitions.js","sourceRoot":"","sources":["../../src/clientDefinitions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\nimport type {\n  DocumentTranslateParameters,\n  StartTranslationParameters,\n  GetTranslationsStatusParameters,\n  GetDocumentStatusParameters,\n  GetTranslationStatusParameters,\n  CancelTranslationParameters,\n  GetDocumentsStatusParameters,\n  GetSupportedFormatsParameters,\n} from \"./parameters.js\";\nimport type {\n  DocumentTranslate200Response,\n  DocumentTranslateDefaultResponse,\n  StartTranslation202Response,\n  StartTranslationDefaultResponse,\n  GetTranslationsStatus200Response,\n  GetTranslationsStatusDefaultResponse,\n  GetDocumentStatus200Response,\n  GetDocumentStatusDefaultResponse,\n  GetTranslationStatus200Response,\n  GetTranslationStatusDefaultResponse,\n  CancelTranslation200Response,\n  CancelTranslationDefaultResponse,\n  GetDocumentsStatus200Response,\n  GetDocumentsStatusDefaultResponse,\n  GetSupportedFormats200Response,\n  GetSupportedFormatsDefaultResponse,\n} from \"./responses.js\";\nimport type { Client, StreamableMethod } from \"@azure-rest/core-client\";\n\nexport interface DocumentTranslate {\n  /** Use this API to submit a single translation request to the Document Translation Service. */\n  post(\n    options: DocumentTranslateParameters,\n  ): StreamableMethod<DocumentTranslate200Response | DocumentTranslateDefaultResponse>;\n}\n\nexport interface StartTranslation {\n  /**\n   * Use this API to submit a bulk (batch) translation request to the Document\n   * Translation service.\n   * Each request can contain multiple documents and must\n   * contain a source and destination container for each document.\n   *\n   * The\n   * prefix and suffix filter (if supplied) are used to filter folders. The prefix\n   * is applied to the subpath after the container name.\n   *\n   * Glossaries /\n   * Translation memory can be included in the request and are applied by the\n   * service when the document is translated.\n   *\n   * If the glossary is\n   * invalid or unreachable during translation, an error is indicated in the\n   * document status.\n   * If a file with the same name already exists at the\n   * destination, it will be overwritten. The targetUrl for each target language\n   * must be unique.\n   */\n  post(\n    options: StartTranslationParameters,\n  ): StreamableMethod<StartTranslation202Response | StartTranslationDefaultResponse>;\n  /**\n   * Returns a list of batch requests submitted and the status for each\n   * request.\n   * This list only contains batch requests submitted by the user (based on\n   * the resource).\n   *\n   * If the number of requests exceeds our paging limit,\n   * server-side paging is used. Paginated responses indicate a partial result and\n   * include a continuation token in the response.\n   * The absence of a continuation\n   * token means that no additional pages are available.\n   *\n   * top, skip\n   * and maxpagesize query parameters can be used to specify a number of results to\n   * return and an offset for the collection.\n   *\n   * top indicates the total\n   * number of records the user wants to be returned across all pages.\n   * skip\n   * indicates the number of records to skip from the list of batches based on the\n   * sorting method specified.  By default, we sort by descending start\n   * time.\n   * maxpagesize is the maximum items returned in a page.  If more items are\n   * requested via top (or top is not specified and there are more items to be\n   * returned), @nextLink will contain the link to the next page.\n   *\n   *\n   * orderby query parameter can be used to sort the returned list (ex\n   * \"orderby=createdDateTimeUtc asc\" or \"orderby=createdDateTimeUtc\n   * desc\").\n   * The default sorting is descending by createdDateTimeUtc.\n   * Some query\n   * parameters can be used to filter the returned list (ex:\n   * \"status=Succeeded,Cancelled\") will only return succeeded and cancelled\n   * operations.\n   * createdDateTimeUtcStart and createdDateTimeUtcEnd can be used\n   * combined or separately to specify a range of datetime to filter the returned\n   * list by.\n   * The supported filtering query parameters are (status, ids,\n   * createdDateTimeUtcStart, createdDateTimeUtcEnd).\n   *\n   * The server honors\n   * the values specified by the client. However, clients must be prepared to handle\n   * responses that contain a different page size or contain a continuation token.\n   *\n   *\n   * When both top and skip are included, the server should first apply\n   * skip and then top on the collection.\n   * Note: If the server can't honor top\n   * and/or skip, the server must return an error to the client informing about it\n   * instead of just ignoring the query options.\n   * This reduces the risk of the client\n   * making assumptions about the data returned.\n   */\n  get(\n    options?: GetTranslationsStatusParameters,\n  ): StreamableMethod<GetTranslationsStatus200Response | GetTranslationsStatusDefaultResponse>;\n}\n\nexport interface GetDocumentStatus {\n  /**\n   * Returns the translation status for a specific document based on the request Id\n   * and document Id.\n   */\n  get(\n    options?: GetDocumentStatusParameters,\n  ): StreamableMethod<GetDocumentStatus200Response | GetDocumentStatusDefaultResponse>;\n}\n\nexport interface GetTranslationStatus {\n  /**\n   * Returns the status for a document translation request.\n   * The status includes the\n   * overall request status, as well as the status for documents that are being\n   * translated as part of that request.\n   */\n  get(\n    options?: GetTranslationStatusParameters,\n  ): StreamableMethod<GetTranslationStatus200Response | GetTranslationStatusDefaultResponse>;\n  /**\n   * Cancel a currently processing or queued translation.\n   * A translation will not be\n   * cancelled if it is already completed or failed or cancelling. A bad request\n   * will be returned.\n   * All documents that have completed translation will not be\n   * cancelled and will be charged.\n   * All pending documents will be cancelled if\n   * possible.\n   */\n  delete(\n    options?: CancelTranslationParameters,\n  ): StreamableMethod<CancelTranslation200Response | CancelTranslationDefaultResponse>;\n}\n\nexport interface GetDocumentsStatus {\n  /**\n   * Returns the status for all documents in a batch document translation request.\n   *\n   *\n   * If the number of documents in the response exceeds our paging limit,\n   * server-side paging is used.\n   * Paginated responses indicate a partial result and\n   * include a continuation token in the response. The absence of a continuation\n   * token means that no additional pages are available.\n   *\n   * top, skip\n   * and maxpagesize query parameters can be used to specify a number of results to\n   * return and an offset for the collection.\n   *\n   * top indicates the total\n   * number of records the user wants to be returned across all pages.\n   * skip\n   * indicates the number of records to skip from the list of document status held\n   * by the server based on the sorting method specified.  By default, we sort by\n   * descending start time.\n   * maxpagesize is the maximum items returned in a page.\n   * If more items are requested via top (or top is not specified and there are\n   * more items to be returned), @nextLink will contain the link to the next page.\n   *\n   *\n   * orderby query parameter can be used to sort the returned list (ex\n   * \"orderby=createdDateTimeUtc asc\" or \"orderby=createdDateTimeUtc\n   * desc\").\n   * The default sorting is descending by createdDateTimeUtc.\n   * Some query\n   * parameters can be used to filter the returned list (ex:\n   * \"status=Succeeded,Cancelled\") will only return succeeded and cancelled\n   * documents.\n   * createdDateTimeUtcStart and createdDateTimeUtcEnd can be used\n   * combined or separately to specify a range of datetime to filter the returned\n   * list by.\n   * The supported filtering query parameters are (status, ids,\n   * createdDateTimeUtcStart, createdDateTimeUtcEnd).\n   *\n   * When both top\n   * and skip are included, the server should first apply skip and then top on\n   * the collection.\n   * Note: If the server can't honor top and/or skip, the server\n   * must return an error to the client informing about it instead of just ignoring\n   * the query options.\n   * This reduces the risk of the client making assumptions about\n   * the data returned.\n   */\n  get(\n    options?: GetDocumentsStatusParameters,\n  ): StreamableMethod<GetDocumentsStatus200Response | GetDocumentsStatusDefaultResponse>;\n}\n\nexport interface GetSupportedFormats {\n  /**\n   * The list of supported formats supported by the Document Translation\n   * service.\n   * The list includes the common file extension, as well as the\n   * content-type if using the upload API.\n   */\n  get(\n    options?: GetSupportedFormatsParameters,\n  ): StreamableMethod<GetSupportedFormats200Response | GetSupportedFormatsDefaultResponse>;\n}\n\nexport interface Routes {\n  /** Resource for '/document:translate' has methods for the following verbs: post */\n  (path: \"/document:translate\"): DocumentTranslate;\n  /** Resource for '/document/batches' has methods for the following verbs: post, get */\n  (path: \"/document/batches\"): StartTranslation;\n  /** Resource for '/document/batches/\\{id\\}/documents/\\{documentId\\}' has methods for the following verbs: get */\n  (\n    path: \"/document/batches/{id}/documents/{documentId}\",\n    id: string,\n    documentId: string,\n  ): GetDocumentStatus;\n  /** Resource for '/document/batches/\\{id\\}' has methods for the following verbs: get, delete */\n  (path: \"/document/batches/{id}\", id: string): GetTranslationStatus;\n  /** Resource for '/document/batches/\\{id\\}/documents' has methods for the following verbs: get */\n  (path: \"/document/batches/{id}/documents\", id: string): GetDocumentsStatus;\n  /** Resource for '/document/formats' has methods for the following verbs: get */\n  (path: \"/document/formats\"): GetSupportedFormats;\n}\n\nexport type DocumentTranslationClient = Client & {\n  path: Routes;\n};\n"]}

package/dist/commonjs/documentTranslationClient.d.ts

@@ -0,0 +1,16 @@
+import type { ClientOptions } from "@azure-rest/core-client";
+import type { TokenCredential, KeyCredential } from "@azure/core-auth";
+import type { DocumentTranslationClient } from "./clientDefinitions.js";
+/** The optional parameters for the client */
+export interface DocumentTranslationClientOptions extends ClientOptions {
+    /** The api version option of the client */
+    apiVersion?: string;
+}
+/**
+ * Initialize a new instance of `DocumentTranslationClient`
+ * @param endpointParam - Supported document Translation endpoint, protocol and hostname, for example: https://{TranslatorResourceName}.cognitiveservices.azure.com/translator.
+ * @param credentials - uniquely identify client credential
+ * @param options - the parameter for all optional parameters
+ */
+export default function createClient(endpointParam: string, credentials: TokenCredential | KeyCredential, { apiVersion, ...options }?: DocumentTranslationClientOptions): DocumentTranslationClient;
+//# sourceMappingURL=documentTranslationClient.d.ts.map