@azure/storage-file-share 12.20.0-alpha.20230620.2 → 12.20.0-alpha.20230720.6

package/types/latest/storage-file-share.d.ts

@@ -2,26 +2,26 @@
 
 import { AbortSignalLike } from '@azure/abort-controller';
 import { AzureLogger } from '@azure/logger';
-import { CompatResponse } from '@azure/core-http-compat';
 import * as coreClient from '@azure/core-client';
 import * as coreHttpCompat from '@azure/core-http-compat';
 import * as coreRestPipeline from '@azure/core-rest-pipeline';
-import { HttpHeadersLike } from '@azure/core-http-compat';
+import { HttpHeadersLike as HttpHeaders } from '@azure/core-http-compat';
+import { CompatResponse as HttpOperationResponse } from '@azure/core-http-compat';
 import { HttpPipelineLogLevel } from '@azure/core-http-compat';
+import { RequestBodyType as HttpRequestBody } from '@azure/core-rest-pipeline';
 import { KeepAliveOptions } from '@azure/core-http-compat';
 import { OperationTracingOptions } from '@azure/core-tracing';
 import { PagedAsyncIterableIterator } from '@azure/core-paging';
 import { ProxySettings } from '@azure/core-rest-pipeline';
 import { Readable } from 'stream';
-import { RequestBodyType } from '@azure/core-rest-pipeline';
 import { RequestPolicy } from '@azure/core-http-compat';
 import { RequestPolicyFactory } from '@azure/core-http-compat';
-import { RequestPolicyOptionsLike } from '@azure/core-http-compat';
+import { RequestPolicyOptionsLike as RequestPolicyOptions } from '@azure/core-http-compat';
 import { RestError } from '@azure/core-rest-pipeline';
 import { TokenCredential } from '@azure/core-auth';
 import { TransferProgressEvent } from '@azure/core-rest-pipeline';
 import { UserAgentPolicyOptions } from '@azure/core-rest-pipeline';
-import { WebResourceLike } from '@azure/core-http-compat';
+import { WebResourceLike as WebResource } from '@azure/core-http-compat';
 
 /** An Access policy. */
 export declare interface AccessPolicy {
@@ -238,7 +238,7 @@ export declare class AnonymousCredential extends Credential_2 {
      * @param nextPolicy -
      * @param options -
      */
-    create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): AnonymousCredentialPolicy;
+    create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): AnonymousCredentialPolicy;
 }
 
 /**
@@ -251,7 +251,7 @@ export declare class AnonymousCredentialPolicy extends CredentialPolicy {
      * @param nextPolicy -
      * @param options -
      */
-    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike);
+    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
 }
 
 /**
@@ -265,7 +265,7 @@ export declare abstract class BaseRequestPolicy implements RequestPolicy {
     /**
      * The options that can be passed to a given request policy.
      */
-    readonly _options: RequestPolicyOptionsLike;
+    readonly _options: RequestPolicyOptions;
     /**
      * The main method to implement that manipulates a request/response.
      */
@@ -277,12 +277,12 @@ export declare abstract class BaseRequestPolicy implements RequestPolicy {
     /**
      * The options that can be passed to a given request policy.
      */
-    _options: RequestPolicyOptionsLike);
+    _options: RequestPolicyOptions);
     /**
      * Sends a network request based on the given web resource.
      * @param webResource - A {@link WebResourceLike} that describes a HTTP request to be made.
      */
-    abstract sendRequest(webResource: WebResourceLike): Promise<CompatResponse>;
+    abstract sendRequest(webResource: WebResource): Promise<HttpOperationResponse>;
     /**
      * Get whether or not a log with the provided log level should be logged.
      * @param logLevel - The log level of the log that will be logged.
@@ -420,7 +420,7 @@ declare abstract class Credential_2 implements RequestPolicyFactory {
      * @param _nextPolicy -
      * @param _options -
      */
-    create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptionsLike): RequestPolicy;
+    create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptions): RequestPolicy;
 }
 export { Credential_2 as Credential }
 
@@ -434,20 +434,20 @@ export declare abstract class CredentialPolicy extends BaseRequestPolicy {
      *
      * @param request -
      */
-    sendRequest(request: WebResourceLike): Promise<CompatResponse>;
+    sendRequest(request: WebResource): Promise<HttpOperationResponse>;
     /**
      * Child classes must implement this method with request signing. This method
      * will be executed in {@link sendRequest}.
      *
      * @param request -
      */
-    protected signRequest(request: WebResourceLike): WebResourceLike;
+    protected signRequest(request: WebResource): WebResource;
 }
 
 /**
  * A factory function that creates a new CredentialPolicy that uses the provided nextPolicy.
  */
-export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike) => CredentialPolicy;
+export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptions) => CredentialPolicy;
 
 /** Defines values for DeleteSnapshotsOptionType. */
 export declare type DeleteSnapshotsOptionType = "include" | "include-leased";
@@ -3216,6 +3216,12 @@ export declare interface HttpAuthorization {
     value: string;
 }
 
+export { HttpHeaders }
+
+export { HttpOperationResponse }
+
+export { HttpRequestBody }
+
 /**
  * A representation of an HTTP response that
  * includes a reference to the request that
@@ -3225,11 +3231,11 @@ export declare interface HttpResponse {
     /**
      * The headers from the response.
      */
-    headers: HttpHeadersLike;
+    headers: HttpHeaders;
     /**
      * The original request that resulted in this response.
      */
-    request: WebResourceLike;
+    request: WebResource;
     /**
      * The HTTP status code returned from the service.
      */
@@ -3533,6 +3539,13 @@ export declare type RawFileDownloadResponse = FileDownloadHeaders & {
     readableStreamBody?: NodeJS.ReadableStream;
 };
 
+export { RequestPolicy as IHttpClient }
+export { RequestPolicy }
+
+export { RequestPolicyFactory }
+
+export { RequestPolicyOptions }
+
 /**
  * An object with a simple _response property.
  */
@@ -5466,7 +5479,7 @@ export declare class ShareFileClient extends StorageClient {
      * console.log("Updated file successfully!")
      * ```
      */
-    uploadRange(body: RequestBodyType, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>;
+    uploadRange(body: HttpRequestBody, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>;
     /**
      * Upload a range of bytes to a file where the contents are read from a another file's URL.
      * The range can be up to 4 MB in size.
@@ -6799,13 +6812,13 @@ export declare class StorageBrowserPolicy extends BaseRequestPolicy {
      * @param nextPolicy -
      * @param options -
      */
-    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike);
+    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
     /**
      * Sends out request.
      *
      * @param request -
      */
-    sendRequest(request: WebResourceLike): Promise<CompatResponse>;
+    sendRequest(request: WebResource): Promise<HttpOperationResponse>;
 }
 
 /**
@@ -6818,7 +6831,7 @@ export declare class StorageBrowserPolicyFactory implements RequestPolicyFactory
      * @param nextPolicy -
      * @param options -
      */
-    create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageBrowserPolicy;
+    create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageBrowserPolicy;
 }
 
 /**
@@ -6872,6 +6885,11 @@ declare interface StorageClientOptionalParams extends coreHttpCompat.ExtendedSer
     endpoint?: string;
 }
 
+/**
+ * The OAuth scope to use with Azure Storage.
+ */
+export declare const StorageOAuthScopes: string | string[];
+
 /**
  * Options interface for the {@link newPipeline} function.
  */
@@ -6961,13 +6979,13 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
      * @param options -
      * @param retryOptions -
      */
-    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike, retryOptions?: StorageRetryOptions);
+    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, retryOptions?: StorageRetryOptions);
     /**
      * Sends request.
      *
      * @param request -
      */
-    sendRequest(request: WebResourceLike): Promise<CompatResponse>;
+    sendRequest(request: WebResource): Promise<HttpOperationResponse>;
     /**
      * Decide and perform next retry. Won't mutate request parameter.
      *
@@ -6978,7 +6996,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
      * @param attempt -           How many retries has been attempted to performed, starting from 1, which includes
      *                                   the attempt will be performed by this method call.
      */
-    protected attemptSendRequest(request: WebResourceLike, secondaryHas404: boolean, attempt: number): Promise<CompatResponse>;
+    protected attemptSendRequest(request: WebResource, secondaryHas404: boolean, attempt: number): Promise<HttpOperationResponse>;
     /**
      * Decide whether to retry according to last HTTP response and retry counters.
      *
@@ -6987,7 +7005,7 @@ export declare class StorageRetryPolicy extends BaseRequestPolicy {
      * @param response -
      * @param err -
      */
-    protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: CompatResponse, err?: RestError): boolean;
+    protected shouldRetry(isPrimaryRetry: boolean, attempt: number, response?: HttpOperationResponse, err?: RestError): boolean;
     /**
      * Delay a calculated time between retries.
      *
@@ -7014,7 +7032,7 @@ export declare class StorageRetryPolicyFactory implements RequestPolicyFactory {
      * @param nextPolicy -
      * @param options -
      */
-    create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageRetryPolicy;
+    create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageRetryPolicy;
 }
 
 /**
@@ -7057,7 +7075,7 @@ export declare class StorageSharedKeyCredential extends Credential_2 {
      * @param nextPolicy -
      * @param options -
      */
-    create(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike): StorageSharedKeyCredentialPolicy;
+    create(nextPolicy: RequestPolicy, options: RequestPolicyOptions): StorageSharedKeyCredentialPolicy;
     /**
      * Generates a hash signature for an HTTP request or for a SAS.
      *
@@ -7080,13 +7098,13 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
      * @param options -
      * @param factory -
      */
-    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptionsLike, factory: StorageSharedKeyCredential);
+    constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions, factory: StorageSharedKeyCredential);
     /**
      * Signs request.
      *
      * @param request -
      */
-    protected signRequest(request: WebResourceLike): WebResourceLike;
+    protected signRequest(request: WebResource): WebResource;
     /**
      * Retrieve header value according to shared key sign rules.
      * @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
@@ -7132,6 +7150,8 @@ export declare type TimeNowType = "now";
  */
 export declare type TimePreserveType = "preserve";
 
+export { WebResource }
+
 /**
  * A type that represents an operation result with a known _response property.
  */