@azure-rest/purview-sharing 1.0.0-beta.1 → 1.0.0-beta.4

package/dist/commonjs/outputModels.d.ts

@@ -0,0 +1,352 @@
+/** A received share data transfer object. */
+export interface ReceivedShareOutputParent extends ProxyResourceOutput {
+    shareKind: "ReceivedShare" | "InPlace";
+}
+/** Base data transfer object implementation for proxy resources. */
+export interface ProxyResourceOutput {
+    /** The unique id of the resource. */
+    readonly id?: string;
+    /** Type of the resource. */
+    readonly type?: string;
+}
+/** The purview share error model. */
+export interface PurviewShareErrorOutput {
+    /** The purview share error body model. */
+    error: PurviewShareErrorInfoOutput;
+}
+/** The purview share error body model. */
+export interface PurviewShareErrorInfoOutput {
+    /** Code of the error */
+    code: string;
+    /** Nested details of the error model */
+    details?: Array<PurviewShareErrorInfoOutput>;
+    /** Message of the error */
+    message: string;
+    /** Target of the error */
+    target?: string;
+}
+/** Response for long running operation. */
+export interface OperationResponseOutput {
+    /** End time of the long running operation. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */
+    endTime?: string;
+    /** The purview share error body model. */
+    error?: PurviewShareErrorInfoOutput;
+    /** Job id of the long running operation */
+    id?: string;
+    /** Start time of the long running operation. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */
+    startTime?: string;
+    /** States for long running operations. */
+    status: "Running" | "TransientFailure" | "Succeeded" | "Failed" | "NotStarted";
+}
+/** List of received shares. */
+export interface ReceivedShareListOutput {
+    /**
+     * The Url of next result page.
+     *
+     * Value may contain a URL
+     */
+    nextLink?: string;
+    /** Collection of items of type ReceivedShare */
+    value: Array<ReceivedShareOutput>;
+}
+/** List of sent shares. */
+export interface SentShareListOutput {
+    /**
+     * The Url of next result page.
+     *
+     * Value may contain a URL
+     */
+    nextLink?: string;
+    /** Collection of items of type SentShare */
+    value: Array<SentShareOutput>;
+}
+/** A sent share data transfer object. */
+export interface SentShareOutputParent extends ProxyResourceOutput {
+    shareKind: "SentShare" | "InPlace";
+}
+/** List of the sent share invitations */
+export interface SentShareInvitationListOutput {
+    /**
+     * The Url of next result page.
+     *
+     * Value may contain a URL
+     */
+    nextLink?: string;
+    /** Collection of items of type SentShareInvitation */
+    value: Array<SentShareInvitationOutput>;
+}
+/** A sent share invitation data transfer object. */
+export interface SentShareInvitationOutputParent extends ProxyResourceOutput {
+    invitationKind: "SentShareInvitation" | "Service" | "User";
+}
+/** A page of ShareResource results. */
+export interface ShareResourceListOutput {
+    /**
+     * The Url of next result page.
+     *
+     * Value may contain a URL
+     */
+    nextLink?: string;
+    /** Collection of items of type ShareResource */
+    value: Array<ShareResourceOutput>;
+}
+/** A share resource. */
+export interface ShareResourceOutput extends ProxyResourceOutput {
+    /** A count of Received Shares associated with the Microsoft.Azure.Purview.Share.ApiService.V3.DataTransferObjects.ShareResource. */
+    receivedSharesCount?: number;
+    /** A count of Sent Shares associated with the Microsoft.Azure.Purview.Share.ApiService.V3.DataTransferObjects.ShareResource. */
+    sentSharesCount?: number;
+    /** The types of asset. */
+    storeKind?: "AdlsGen2Account" | "BlobAccount";
+    /** A Store Reference for an artifact or sink. */
+    storeReference?: StoreReferenceOutput;
+}
+/** A Store Reference for an artifact or sink. */
+export interface StoreReferenceOutput {
+    /** Reference name for resource associated with the sink or artifact. */
+    referenceName?: string;
+    /** Defines the type of resource being shared */
+    type?: "ArmResourceReference";
+}
+/** A tenant email registration data transfer object. */
+export interface TenantEmailRegistrationOutput extends ProxyResourceOutput {
+    /** Tenant email registration property bag. */
+    properties?: TenantEmailRegistrationPropertiesOutput;
+}
+/** Tenant email registration property bag. */
+export interface TenantEmailRegistrationPropertiesOutput {
+    /** Activation code for the registration. */
+    activationCode: string;
+    /** Date of the activation expiration. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */
+    readonly activationExpiration?: string;
+    /** The email to register. */
+    readonly email?: string;
+    /** Defines the supported types for registration. */
+    readonly registrationStatus?: "ActivationPending" | "Activated" | "ActivationAttemptsExhausted";
+    /** State of the resource */
+    readonly state?: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed";
+    /** The tenant id to register. */
+    readonly tenantId?: string;
+}
+/** AdlsGen2 Sink */
+export interface AdlsGen2AccountSinkOutput extends SinkOutputParent {
+    /** Properties for AdlsGen2 storage account */
+    properties: AdlsGen2AccountSinkPropertiesOutput;
+    storeKind: "AdlsGen2Account";
+}
+/** Properties for AdlsGen2 storage account */
+export interface AdlsGen2AccountSinkPropertiesOutput {
+    /** Adls Gen 2 Container Name */
+    containerName: string;
+    /** Adls Gen 2 Folder */
+    folder: string;
+    /** Adls Gen 2 Location */
+    readonly location?: string;
+    /** Adls Gen 2 Mount Path */
+    mountPath?: string;
+}
+/** Holds details on the destination of the mapped artifact */
+export interface SinkOutputParent {
+    /** A Store Reference for an artifact or sink. */
+    storeReference: StoreReferenceOutput;
+    storeKind: "Sink" | "AdlsGen2Account" | "BlobAccount";
+}
+/** An Adls Gen2 storage account artifact. */
+export interface AdlsGen2ArtifactOutput extends ArtifactOutputParent {
+    /** Properties for Adls Gen2 storage account. */
+    properties: AdlsGen2ArtifactPropertiesOutput;
+    storeKind: "AdlsGen2Account";
+}
+/** Properties for Adls Gen2 storage account. */
+export interface AdlsGen2ArtifactPropertiesOutput {
+    /** Location of the storage account. */
+    readonly location?: string;
+    /** A list of Adls Gen2 storage account paths. */
+    paths: Array<StorageAccountPathOutput>;
+}
+/** Defines a single StorageAccountPath path */
+export interface StorageAccountPathOutput {
+    /** Gets or sets the container name */
+    containerName: string;
+    /** Gets or sets the path on the receiver side where the artifact is to be mapped */
+    receiverPath?: string;
+    /** Gets or sets the path to file/folder within the container to be shared */
+    senderPath?: string;
+}
+/** A class for sent share artifact. */
+export interface ArtifactOutputParent {
+    /** A Store Reference for an artifact or sink. */
+    storeReference: StoreReferenceOutput;
+    storeKind: "Artifact" | "AdlsGen2Account" | "BlobAccount";
+}
+/** Blob Sink */
+export interface BlobAccountSinkOutput extends SinkOutputParent {
+    /** Properties for blob storage account */
+    properties: BlobAccountSinkPropertiesOutput;
+    storeKind: "BlobAccount";
+}
+/** Properties for blob storage account */
+export interface BlobAccountSinkPropertiesOutput {
+    /** Blob Container Name */
+    containerName: string;
+    /** Blob Folder */
+    folder: string;
+    /** Blob Location */
+    readonly location?: string;
+    /** Blob Mount Path */
+    mountPath?: string;
+}
+/** Blob storage account artifact. */
+export interface BlobStorageArtifactOutput extends ArtifactOutputParent {
+    /** Properties for blob storage account. */
+    properties: BlobStorageArtifactPropertiesOutput;
+    storeKind: "BlobAccount";
+}
+/** Properties for blob storage account. */
+export interface BlobStorageArtifactPropertiesOutput {
+    /** Location of the storage account. */
+    readonly location?: string;
+    /** A list of blob storage account paths. */
+    paths: Array<StorageAccountPathOutput>;
+}
+/** An InPlace received share kind. */
+export interface InPlaceReceivedShareOutput extends ReceivedShareOutputParent {
+    /** Properties of in place received share. */
+    properties: InPlaceReceivedSharePropertiesOutput;
+    shareKind: "InPlace";
+}
+/** Properties of in place received share. */
+export interface InPlaceReceivedSharePropertiesOutput {
+    /** Location of the shared Asset. */
+    readonly assetLocation?: string;
+    /** The types of asset. */
+    assetStoreKind?: "AdlsGen2Account" | "BlobAccount";
+    /** Time at which the received share was created. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */
+    readonly createdAt?: string;
+    /** Received Share Name */
+    displayName?: string;
+    /** The expiration date of the received share. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */
+    readonly expirationDate?: string;
+    /** Email of the user/receiver who received the sent share invitation */
+    readonly receiverEmail?: string;
+    /** Name of the user/receiver who received the sent share invitation */
+    readonly receiverName?: string;
+    /** Tenant name of the user/receiver who received the sent share invitation */
+    readonly receiverTenantName?: string;
+    /** Email of the sender who created the sent share invitation */
+    readonly senderEmail?: string;
+    /** Name of the sender who created the sent share invitation */
+    readonly senderName?: string;
+    /** Tenant name of the sender who created the sent share invitation */
+    readonly senderTenantName?: string;
+    /** Share description. */
+    readonly sentShareDescription?: string;
+    /** Time at which the sent share was shared. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */
+    readonly sharedAt?: string;
+    /** Share status. */
+    shareStatus?: "Detached" | "Attached";
+    /** Holds details on the destination of the mapped artifact */
+    sink?: SinkOutput;
+    /** State of the resource */
+    readonly state?: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed";
+}
+/** An InPlace share kind. */
+export interface InPlaceSentShareOutput extends SentShareOutputParent {
+    /** Properties for InPlace sent share. */
+    properties: InPlaceSentSharePropertiesOutput;
+    shareKind: "InPlace";
+}
+/** Properties for InPlace sent share. */
+export interface InPlaceSentSharePropertiesOutput {
+    /** A class for sent share artifact. */
+    artifact: ArtifactOutput;
+    /** Time at which the sent share was created. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */
+    readonly createdAt?: string;
+    /** List of shares on which the sent share depends. */
+    readonly dependsOn?: Array<string>;
+    /** Sent share description. */
+    description?: string;
+    /** The name of the sent share */
+    displayName: string;
+    /** Email of the sender who created the sent share. */
+    readonly senderEmail?: string;
+    /** Name of the sender who created the sent share. */
+    readonly senderName?: string;
+    /** Tenant name of the sender who created the sent share. */
+    readonly senderTenantName?: string;
+    /** State of the resource */
+    readonly state?: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed";
+}
+/** An service invitation kind. */
+export interface ServiceInvitationOutput extends SentShareInvitationOutputParent {
+    /** Properties of the service invitation type. */
+    properties: ServiceInvitationPropertiesOutput;
+    invitationKind: "Service";
+}
+/** Properties of the service invitation type. */
+export interface ServiceInvitationPropertiesOutput {
+    /** The time at which the invitation will expire. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */
+    expirationDate?: string;
+    /** Email address of the sender. */
+    readonly senderEmail?: string;
+    /** Name of the sender */
+    readonly senderName?: string;
+    /** Tenant name of the sender */
+    readonly senderTenantName?: string;
+    /** Gets the time at which the invitation was sent. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */
+    readonly sentAt?: string;
+    /** Share status. */
+    shareStatus?: "Detached" | "Attached";
+    /** State of the resource */
+    readonly state?: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed";
+    /**
+     * The target azure active directory id the invitation is sent to.
+     *
+     * Value may contain a UUID
+     */
+    targetActiveDirectoryId: string;
+    /**
+     * The target object id in the azure active directory the invitation is sent to.
+     *
+     * Value may contain a UUID
+     */
+    targetObjectId: string;
+}
+/** A user invitation kind. */
+export interface UserInvitationOutput extends SentShareInvitationOutputParent {
+    /** Properties of the user invitation type. */
+    properties: UserInvitationPropertiesOutput;
+    invitationKind: "User";
+}
+/** Properties of the user invitation type. */
+export interface UserInvitationPropertiesOutput {
+    /** The time at which the invitation will expire. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */
+    expirationDate?: string;
+    /** Whether or not the recipient was notified via email. */
+    notify?: boolean;
+    /** Email address of the sender. */
+    readonly senderEmail?: string;
+    /** Name of the sender */
+    readonly senderName?: string;
+    /** Tenant name of the sender */
+    readonly senderTenantName?: string;
+    /** Gets the time at which the invitation was sent. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */
+    readonly sentAt?: string;
+    /** Share status. */
+    shareStatus?: "Detached" | "Attached";
+    /** State of the resource */
+    readonly state?: "Unknown" | "Succeeded" | "Creating" | "Deleting" | "Moving" | "Failed";
+    /** The receiver email for the invitation is being sent. */
+    targetEmail: string;
+}
+/** A received share data transfer object. */
+export type ReceivedShareOutput = InPlaceReceivedShareOutput;
+/** A sent share data transfer object. */
+export type SentShareOutput = InPlaceSentShareOutput;
+/** A sent share invitation data transfer object. */
+export type SentShareInvitationOutput = ServiceInvitationOutput | UserInvitationOutput;
+/** Holds details on the destination of the mapped artifact */
+export type SinkOutput = AdlsGen2AccountSinkOutput | BlobAccountSinkOutput;
+/** A class for sent share artifact. */
+export type ArtifactOutput = AdlsGen2ArtifactOutput | BlobStorageArtifactOutput;
+//# sourceMappingURL=outputModels.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"outputModels.d.ts","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":"AAGA,6CAA6C;AAC7C,MAAM,WAAW,yBAA0B,SAAQ,mBAAmB;IACpE,SAAS,EAAE,eAAe,GAAG,SAAS,CAAC;CACxC;AAED,oEAAoE;AACpE,MAAM,WAAW,mBAAmB;IAClC,qCAAqC;IACrC,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IACrB,4BAA4B;IAC5B,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,qCAAqC;AACrC,MAAM,WAAW,uBAAuB;IACtC,0CAA0C;IAC1C,KAAK,EAAE,2BAA2B,CAAC;CACpC;AAED,0CAA0C;AAC1C,MAAM,WAAW,2BAA2B;IAC1C,wBAAwB;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,wCAAwC;IACxC,OAAO,CAAC,EAAE,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC7C,2BAA2B;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,0BAA0B;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,2CAA2C;AAC3C,MAAM,WAAW,uBAAuB;IACtC,4JAA4J;IAC5J,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,KAAK,CAAC,EAAE,2BAA2B,CAAC;IACpC,2CAA2C;IAC3C,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,8JAA8J;IAC9J,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,MAAM,EAAE,SAAS,GAAG,kBAAkB,GAAG,WAAW,GAAG,QAAQ,GAAG,YAAY,CAAC;CAChF;AAED,+BAA+B;AAC/B,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CACnC;AAED,2BAA2B;AAC3B,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,KAAK,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;CAC/B;AAED,yCAAyC;AACzC,MAAM,WAAW,qBAAsB,SAAQ,mBAAmB;IAChE,SAAS,EAAE,WAAW,GAAG,SAAS,CAAC;CACpC;AAED,yCAAyC;AACzC,MAAM,WAAW,6BAA6B;IAC5C;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,KAAK,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;CACzC;AAED,oDAAoD;AACpD,MAAM,WAAW,+BAAgC,SAAQ,mBAAmB;IAC1E,cAAc,EAAE,qBAAqB,GAAG,SAAS,GAAG,MAAM,CAAC;CAC5D;AAED,uCAAuC;AACvC,MAAM,WAAW,uBAAuB;IACtC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,KAAK,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;CACnC;AAED,wBAAwB;AACxB,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D,oIAAoI;IACpI,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,gIAAgI;IAChI,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,iBAAiB,GAAG,aAAa,CAAC;IAC9C,iDAAiD;IACjD,cAAc,CAAC,EAAE,oBAAoB,CAAC;CACvC;AAED,iDAAiD;AACjD,MAAM,WAAW,oBAAoB;IACnC,wEAAwE;IACxE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,gDAAgD;IAChD,IAAI,CAAC,EAAE,sBAAsB,CAAC;CAC/B;AAED,wDAAwD;AACxD,MAAM,WAAW,6BAA8B,SAAQ,mBAAmB;IACxE,8CAA8C;IAC9C,UAAU,CAAC,EAAE,uCAAuC,CAAC;CACtD;AAED,8CAA8C;AAC9C,MAAM,WAAW,uCAAuC;IACtD,4CAA4C;IAC5C,cAAc,EAAE,MAAM,CAAC;IACvB,uJAAuJ;IACvJ,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IACvC,6BAA6B;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IACxB,oDAAoD;IACpD,QAAQ,CAAC,kBAAkB,CAAC,EAAE,mBAAmB,GAAG,WAAW,GAAG,6BAA6B,CAAC;IAChG,4BAA4B;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACzF,iCAAiC;IACjC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,oBAAoB;AACpB,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IACjE,8CAA8C;IAC9C,UAAU,EAAE,mCAAmC,CAAC;IAChD,SAAS,EAAE,iBAAiB,CAAC;CAC9B;AAED,8CAA8C;AAC9C,MAAM,WAAW,mCAAmC;IAClD,gCAAgC;IAChC,aAAa,EAAE,MAAM,CAAC;IACtB,wBAAwB;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,0BAA0B;IAC1B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,4BAA4B;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,8DAA8D;AAC9D,MAAM,WAAW,gBAAgB;IAC/B,iDAAiD;IACjD,cAAc,EAAE,oBAAoB,CAAC;IACrC,SAAS,EAAE,MAAM,GAAG,iBAAiB,GAAG,aAAa,CAAC;CACvD;AAED,6CAA6C;AAC7C,MAAM,WAAW,sBAAuB,SAAQ,oBAAoB;IAClE,gDAAgD;IAChD,UAAU,EAAE,gCAAgC,CAAC;IAC7C,SAAS,EAAE,iBAAiB,CAAC;CAC9B;AAED,gDAAgD;AAChD,MAAM,WAAW,gCAAgC;IAC/C,uCAAuC;IACvC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,iDAAiD;IACjD,KAAK,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;CACxC;AAED,+CAA+C;AAC/C,MAAM,WAAW,wBAAwB;IACvC,sCAAsC;IACtC,aAAa,EAAE,MAAM,CAAC;IACtB,oFAAoF;IACpF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,6EAA6E;IAC7E,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,uCAAuC;AACvC,MAAM,WAAW,oBAAoB;IACnC,iDAAiD;IACjD,cAAc,EAAE,oBAAoB,CAAC;IACrC,SAAS,EAAE,UAAU,GAAG,iBAAiB,GAAG,aAAa,CAAC;CAC3D;AAED,gBAAgB;AAChB,MAAM,WAAW,qBAAsB,SAAQ,gBAAgB;IAC7D,0CAA0C;IAC1C,UAAU,EAAE,+BAA+B,CAAC;IAC5C,SAAS,EAAE,aAAa,CAAC;CAC1B;AAED,0CAA0C;AAC1C,MAAM,WAAW,+BAA+B;IAC9C,0BAA0B;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,oBAAoB;IACpB,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,sBAAsB;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,qCAAqC;AACrC,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE,2CAA2C;IAC3C,UAAU,EAAE,mCAAmC,CAAC;IAChD,SAAS,EAAE,aAAa,CAAC;CAC1B;AAED,2CAA2C;AAC3C,MAAM,WAAW,mCAAmC;IAClD,uCAAuC;IACvC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,4CAA4C;IAC5C,KAAK,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;CACxC;AAED,sCAAsC;AACtC,MAAM,WAAW,0BAA2B,SAAQ,yBAAyB;IAC3E,6CAA6C;IAC7C,UAAU,EAAE,oCAAoC,CAAC;IACjD,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,6CAA6C;AAC7C,MAAM,WAAW,oCAAoC;IACnD,oCAAoC;IACpC,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,0BAA0B;IAC1B,cAAc,CAAC,EAAE,iBAAiB,GAAG,aAAa,CAAC;IACnD,kKAAkK;IAClK,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,0BAA0B;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,+JAA+J;IAC/J,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,wEAAwE;IACxE,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;IAChC,uEAAuE;IACvE,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,8EAA8E;IAC9E,QAAQ,CAAC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IACrC,gEAAgE;IAChE,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,+DAA+D;IAC/D,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,sEAAsE;IACtE,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,yBAAyB;IACzB,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IACvC,6JAA6J;IAC7J,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,oBAAoB;IACpB,WAAW,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IACtC,8DAA8D;IAC9D,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,4BAA4B;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,CAAC;CAC1F;AAED,6BAA6B;AAC7B,MAAM,WAAW,sBAAuB,SAAQ,qBAAqB;IACnE,yCAAyC;IACzC,UAAU,EAAE,gCAAgC,CAAC;IAC7C,SAAS,EAAE,SAAS,CAAC;CACtB;AAED,yCAAyC;AACzC,MAAM,WAAW,gCAAgC;IAC/C,uCAAuC;IACvC,QAAQ,EAAE,cAAc,CAAC;IACzB,8JAA8J;IAC9J,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,sDAAsD;IACtD,QAAQ,CAAC,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACnC,8BAA8B;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iCAAiC;IACjC,WAAW,EAAE,MAAM,CAAC;IACpB,sDAAsD;IACtD,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,qDAAqD;IACrD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,4DAA4D;IAC5D,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,4BAA4B;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,CAAC;CAC1F;AAED,kCAAkC;AAClC,MAAM,WAAW,uBAAwB,SAAQ,+BAA+B;IAC9E,iDAAiD;IACjD,UAAU,EAAE,iCAAiC,CAAC;IAC9C,cAAc,EAAE,SAAS,CAAC;CAC3B;AAED,iDAAiD;AACjD,MAAM,WAAW,iCAAiC;IAChD,kKAAkK;IAClK,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mCAAmC;IACnC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,yBAAyB;IACzB,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,gCAAgC;IAChC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,oKAAoK;IACpK,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,oBAAoB;IACpB,WAAW,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IACtC,4BAA4B;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACzF;;;;OAIG;IACH,uBAAuB,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,8BAA8B;AAC9B,MAAM,WAAW,oBAAqB,SAAQ,+BAA+B;IAC3E,8CAA8C;IAC9C,UAAU,EAAE,8BAA8B,CAAC;IAC3C,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,8CAA8C;AAC9C,MAAM,WAAW,8BAA8B;IAC7C,kKAAkK;IAClK,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,2DAA2D;IAC3D,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,mCAAmC;IACnC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,yBAAyB;IACzB,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,gCAAgC;IAChC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,oKAAoK;IACpK,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,oBAAoB;IACpB,WAAW,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IACtC,4BAA4B;IAC5B,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACzF,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,6CAA6C;AAC7C,MAAM,MAAM,mBAAmB,GAAG,0BAA0B,CAAC;AAC7D,yCAAyC;AACzC,MAAM,MAAM,eAAe,GAAG,sBAAsB,CAAC;AACrD,oDAAoD;AACpD,MAAM,MAAM,yBAAyB,GAAG,uBAAuB,GAAG,oBAAoB,CAAC;AACvF,8DAA8D;AAC9D,MAAM,MAAM,UAAU,GAAG,yBAAyB,GAAG,qBAAqB,CAAC;AAC3E,uCAAuC;AACvC,MAAM,MAAM,cAAc,GAAG,sBAAsB,GAAG,yBAAyB,CAAC"}

package/dist/commonjs/outputModels.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=outputModels.js.map

package/dist/commonjs/outputModels.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"outputModels.js","sourceRoot":"","sources":["../../src/outputModels.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/** A received share data transfer object. */\nexport interface ReceivedShareOutputParent extends ProxyResourceOutput {\n  shareKind: \"ReceivedShare\" | \"InPlace\";\n}\n\n/** Base data transfer object implementation for proxy resources. */\nexport interface ProxyResourceOutput {\n  /** The unique id of the resource. */\n  readonly id?: string;\n  /** Type of the resource. */\n  readonly type?: string;\n}\n\n/** The purview share error model. */\nexport interface PurviewShareErrorOutput {\n  /** The purview share error body model. */\n  error: PurviewShareErrorInfoOutput;\n}\n\n/** The purview share error body model. */\nexport interface PurviewShareErrorInfoOutput {\n  /** Code of the error */\n  code: string;\n  /** Nested details of the error model */\n  details?: Array<PurviewShareErrorInfoOutput>;\n  /** Message of the error */\n  message: string;\n  /** Target of the error */\n  target?: string;\n}\n\n/** Response for long running operation. */\nexport interface OperationResponseOutput {\n  /** End time of the long running operation. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */\n  endTime?: string;\n  /** The purview share error body model. */\n  error?: PurviewShareErrorInfoOutput;\n  /** Job id of the long running operation */\n  id?: string;\n  /** Start time of the long running operation. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */\n  startTime?: string;\n  /** States for long running operations. */\n  status: \"Running\" | \"TransientFailure\" | \"Succeeded\" | \"Failed\" | \"NotStarted\";\n}\n\n/** List of received shares. */\nexport interface ReceivedShareListOutput {\n  /**\n   * The Url of next result page.\n   *\n   * Value may contain a URL\n   */\n  nextLink?: string;\n  /** Collection of items of type ReceivedShare */\n  value: Array<ReceivedShareOutput>;\n}\n\n/** List of sent shares. */\nexport interface SentShareListOutput {\n  /**\n   * The Url of next result page.\n   *\n   * Value may contain a URL\n   */\n  nextLink?: string;\n  /** Collection of items of type SentShare */\n  value: Array<SentShareOutput>;\n}\n\n/** A sent share data transfer object. */\nexport interface SentShareOutputParent extends ProxyResourceOutput {\n  shareKind: \"SentShare\" | \"InPlace\";\n}\n\n/** List of the sent share invitations */\nexport interface SentShareInvitationListOutput {\n  /**\n   * The Url of next result page.\n   *\n   * Value may contain a URL\n   */\n  nextLink?: string;\n  /** Collection of items of type SentShareInvitation */\n  value: Array<SentShareInvitationOutput>;\n}\n\n/** A sent share invitation data transfer object. */\nexport interface SentShareInvitationOutputParent extends ProxyResourceOutput {\n  invitationKind: \"SentShareInvitation\" | \"Service\" | \"User\";\n}\n\n/** A page of ShareResource results. */\nexport interface ShareResourceListOutput {\n  /**\n   * The Url of next result page.\n   *\n   * Value may contain a URL\n   */\n  nextLink?: string;\n  /** Collection of items of type ShareResource */\n  value: Array<ShareResourceOutput>;\n}\n\n/** A share resource. */\nexport interface ShareResourceOutput extends ProxyResourceOutput {\n  /** A count of Received Shares associated with the Microsoft.Azure.Purview.Share.ApiService.V3.DataTransferObjects.ShareResource. */\n  receivedSharesCount?: number;\n  /** A count of Sent Shares associated with the Microsoft.Azure.Purview.Share.ApiService.V3.DataTransferObjects.ShareResource. */\n  sentSharesCount?: number;\n  /** The types of asset. */\n  storeKind?: \"AdlsGen2Account\" | \"BlobAccount\";\n  /** A Store Reference for an artifact or sink. */\n  storeReference?: StoreReferenceOutput;\n}\n\n/** A Store Reference for an artifact or sink. */\nexport interface StoreReferenceOutput {\n  /** Reference name for resource associated with the sink or artifact. */\n  referenceName?: string;\n  /** Defines the type of resource being shared */\n  type?: \"ArmResourceReference\";\n}\n\n/** A tenant email registration data transfer object. */\nexport interface TenantEmailRegistrationOutput extends ProxyResourceOutput {\n  /** Tenant email registration property bag. */\n  properties?: TenantEmailRegistrationPropertiesOutput;\n}\n\n/** Tenant email registration property bag. */\nexport interface TenantEmailRegistrationPropertiesOutput {\n  /** Activation code for the registration. */\n  activationCode: string;\n  /** Date of the activation expiration. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */\n  readonly activationExpiration?: string;\n  /** The email to register. */\n  readonly email?: string;\n  /** Defines the supported types for registration. */\n  readonly registrationStatus?: \"ActivationPending\" | \"Activated\" | \"ActivationAttemptsExhausted\";\n  /** State of the resource */\n  readonly state?: \"Unknown\" | \"Succeeded\" | \"Creating\" | \"Deleting\" | \"Moving\" | \"Failed\";\n  /** The tenant id to register. */\n  readonly tenantId?: string;\n}\n\n/** AdlsGen2 Sink */\nexport interface AdlsGen2AccountSinkOutput extends SinkOutputParent {\n  /** Properties for AdlsGen2 storage account */\n  properties: AdlsGen2AccountSinkPropertiesOutput;\n  storeKind: \"AdlsGen2Account\";\n}\n\n/** Properties for AdlsGen2 storage account */\nexport interface AdlsGen2AccountSinkPropertiesOutput {\n  /** Adls Gen 2 Container Name */\n  containerName: string;\n  /** Adls Gen 2 Folder */\n  folder: string;\n  /** Adls Gen 2 Location */\n  readonly location?: string;\n  /** Adls Gen 2 Mount Path */\n  mountPath?: string;\n}\n\n/** Holds details on the destination of the mapped artifact */\nexport interface SinkOutputParent {\n  /** A Store Reference for an artifact or sink. */\n  storeReference: StoreReferenceOutput;\n  storeKind: \"Sink\" | \"AdlsGen2Account\" | \"BlobAccount\";\n}\n\n/** An Adls Gen2 storage account artifact. */\nexport interface AdlsGen2ArtifactOutput extends ArtifactOutputParent {\n  /** Properties for Adls Gen2 storage account. */\n  properties: AdlsGen2ArtifactPropertiesOutput;\n  storeKind: \"AdlsGen2Account\";\n}\n\n/** Properties for Adls Gen2 storage account. */\nexport interface AdlsGen2ArtifactPropertiesOutput {\n  /** Location of the storage account. */\n  readonly location?: string;\n  /** A list of Adls Gen2 storage account paths. */\n  paths: Array<StorageAccountPathOutput>;\n}\n\n/** Defines a single StorageAccountPath path */\nexport interface StorageAccountPathOutput {\n  /** Gets or sets the container name */\n  containerName: string;\n  /** Gets or sets the path on the receiver side where the artifact is to be mapped */\n  receiverPath?: string;\n  /** Gets or sets the path to file/folder within the container to be shared */\n  senderPath?: string;\n}\n\n/** A class for sent share artifact. */\nexport interface ArtifactOutputParent {\n  /** A Store Reference for an artifact or sink. */\n  storeReference: StoreReferenceOutput;\n  storeKind: \"Artifact\" | \"AdlsGen2Account\" | \"BlobAccount\";\n}\n\n/** Blob Sink */\nexport interface BlobAccountSinkOutput extends SinkOutputParent {\n  /** Properties for blob storage account */\n  properties: BlobAccountSinkPropertiesOutput;\n  storeKind: \"BlobAccount\";\n}\n\n/** Properties for blob storage account */\nexport interface BlobAccountSinkPropertiesOutput {\n  /** Blob Container Name */\n  containerName: string;\n  /** Blob Folder */\n  folder: string;\n  /** Blob Location */\n  readonly location?: string;\n  /** Blob Mount Path */\n  mountPath?: string;\n}\n\n/** Blob storage account artifact. */\nexport interface BlobStorageArtifactOutput extends ArtifactOutputParent {\n  /** Properties for blob storage account. */\n  properties: BlobStorageArtifactPropertiesOutput;\n  storeKind: \"BlobAccount\";\n}\n\n/** Properties for blob storage account. */\nexport interface BlobStorageArtifactPropertiesOutput {\n  /** Location of the storage account. */\n  readonly location?: string;\n  /** A list of blob storage account paths. */\n  paths: Array<StorageAccountPathOutput>;\n}\n\n/** An InPlace received share kind. */\nexport interface InPlaceReceivedShareOutput extends ReceivedShareOutputParent {\n  /** Properties of in place received share. */\n  properties: InPlaceReceivedSharePropertiesOutput;\n  shareKind: \"InPlace\";\n}\n\n/** Properties of in place received share. */\nexport interface InPlaceReceivedSharePropertiesOutput {\n  /** Location of the shared Asset. */\n  readonly assetLocation?: string;\n  /** The types of asset. */\n  assetStoreKind?: \"AdlsGen2Account\" | \"BlobAccount\";\n  /** Time at which the received share was created. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */\n  readonly createdAt?: string;\n  /** Received Share Name */\n  displayName?: string;\n  /** The expiration date of the received share. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */\n  readonly expirationDate?: string;\n  /** Email of the user/receiver who received the sent share invitation */\n  readonly receiverEmail?: string;\n  /** Name of the user/receiver who received the sent share invitation */\n  readonly receiverName?: string;\n  /** Tenant name of the user/receiver who received the sent share invitation */\n  readonly receiverTenantName?: string;\n  /** Email of the sender who created the sent share invitation */\n  readonly senderEmail?: string;\n  /** Name of the sender who created the sent share invitation */\n  readonly senderName?: string;\n  /** Tenant name of the sender who created the sent share invitation */\n  readonly senderTenantName?: string;\n  /** Share description. */\n  readonly sentShareDescription?: string;\n  /** Time at which the sent share was shared. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */\n  readonly sharedAt?: string;\n  /** Share status. */\n  shareStatus?: \"Detached\" | \"Attached\";\n  /** Holds details on the destination of the mapped artifact */\n  sink?: SinkOutput;\n  /** State of the resource */\n  readonly state?: \"Unknown\" | \"Succeeded\" | \"Creating\" | \"Deleting\" | \"Moving\" | \"Failed\";\n}\n\n/** An InPlace share kind. */\nexport interface InPlaceSentShareOutput extends SentShareOutputParent {\n  /** Properties for InPlace sent share. */\n  properties: InPlaceSentSharePropertiesOutput;\n  shareKind: \"InPlace\";\n}\n\n/** Properties for InPlace sent share. */\nexport interface InPlaceSentSharePropertiesOutput {\n  /** A class for sent share artifact. */\n  artifact: ArtifactOutput;\n  /** Time at which the sent share was created. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */\n  readonly createdAt?: string;\n  /** List of shares on which the sent share depends. */\n  readonly dependsOn?: Array<string>;\n  /** Sent share description. */\n  description?: string;\n  /** The name of the sent share */\n  displayName: string;\n  /** Email of the sender who created the sent share. */\n  readonly senderEmail?: string;\n  /** Name of the sender who created the sent share. */\n  readonly senderName?: string;\n  /** Tenant name of the sender who created the sent share. */\n  readonly senderTenantName?: string;\n  /** State of the resource */\n  readonly state?: \"Unknown\" | \"Succeeded\" | \"Creating\" | \"Deleting\" | \"Moving\" | \"Failed\";\n}\n\n/** An service invitation kind. */\nexport interface ServiceInvitationOutput extends SentShareInvitationOutputParent {\n  /** Properties of the service invitation type. */\n  properties: ServiceInvitationPropertiesOutput;\n  invitationKind: \"Service\";\n}\n\n/** Properties of the service invitation type. */\nexport interface ServiceInvitationPropertiesOutput {\n  /** The time at which the invitation will expire. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */\n  expirationDate?: string;\n  /** Email address of the sender. */\n  readonly senderEmail?: string;\n  /** Name of the sender */\n  readonly senderName?: string;\n  /** Tenant name of the sender */\n  readonly senderTenantName?: string;\n  /** Gets the time at which the invitation was sent. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */\n  readonly sentAt?: string;\n  /** Share status. */\n  shareStatus?: \"Detached\" | \"Attached\";\n  /** State of the resource */\n  readonly state?: \"Unknown\" | \"Succeeded\" | \"Creating\" | \"Deleting\" | \"Moving\" | \"Failed\";\n  /**\n   * The target azure active directory id the invitation is sent to.\n   *\n   * Value may contain a UUID\n   */\n  targetActiveDirectoryId: string;\n  /**\n   * The target object id in the azure active directory the invitation is sent to.\n   *\n   * Value may contain a UUID\n   */\n  targetObjectId: string;\n}\n\n/** A user invitation kind. */\nexport interface UserInvitationOutput extends SentShareInvitationOutputParent {\n  /** Properties of the user invitation type. */\n  properties: UserInvitationPropertiesOutput;\n  invitationKind: \"User\";\n}\n\n/** Properties of the user invitation type. */\nexport interface UserInvitationPropertiesOutput {\n  /** The time at which the invitation will expire. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */\n  expirationDate?: string;\n  /** Whether or not the recipient was notified via email. */\n  notify?: boolean;\n  /** Email address of the sender. */\n  readonly senderEmail?: string;\n  /** Name of the sender */\n  readonly senderName?: string;\n  /** Tenant name of the sender */\n  readonly senderTenantName?: string;\n  /** Gets the time at which the invitation was sent. Represented in the standard date-time format as defined by [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339) */\n  readonly sentAt?: string;\n  /** Share status. */\n  shareStatus?: \"Detached\" | \"Attached\";\n  /** State of the resource */\n  readonly state?: \"Unknown\" | \"Succeeded\" | \"Creating\" | \"Deleting\" | \"Moving\" | \"Failed\";\n  /** The receiver email for the invitation is being sent. */\n  targetEmail: string;\n}\n\n/** A received share data transfer object. */\nexport type ReceivedShareOutput = InPlaceReceivedShareOutput;\n/** A sent share data transfer object. */\nexport type SentShareOutput = InPlaceSentShareOutput;\n/** A sent share invitation data transfer object. */\nexport type SentShareInvitationOutput = ServiceInvitationOutput | UserInvitationOutput;\n/** Holds details on the destination of the mapped artifact */\nexport type SinkOutput = AdlsGen2AccountSinkOutput | BlobAccountSinkOutput;\n/** A class for sent share artifact. */\nexport type ArtifactOutput = AdlsGen2ArtifactOutput | BlobStorageArtifactOutput;\n"]}

package/dist/commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/commonjs/paginateHelper.d.ts

@@ -0,0 +1,68 @@
+import type { Client, PathUncheckedResponse } from "@azure-rest/core-client";
+/**
+ * An interface that tracks the settings for paged iteration
+ */
+export interface PageSettings {
+    /**
+     * The token that keeps track of where to continue the iterator
+     */
+    continuationToken?: string;
+}
+/**
+ * An interface that allows async iterable iteration both to completion and by page.
+ */
+export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings = PageSettings> {
+    /**
+     * The next method, part of the iteration protocol
+     */
+    next(): Promise<IteratorResult<TElement>>;
+    /**
+     * The connection to the async iterator, part of the iteration protocol
+     */
+    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+    /**
+     * Return an AsyncIterableIterator that works a page at a time
+     */
+    byPage: (settings?: TPageSettings) => AsyncIterableIterator<TPage>;
+}
+/**
+ * Helper type to extract the type of an array
+ */
+export type GetArrayType<T> = T extends Array<infer TData> ? TData : never;
+/**
+ * The type of a custom function that defines how to get a page and a link to the next one if any.
+ */
+export type GetPage<TPage> = (pageLink: string) => Promise<{
+    page: TPage;
+    nextPageLink?: string;
+}>;
+/**
+ * Options for the paging helper
+ */
+export interface PagingOptions<TResponse> {
+    /**
+     * Custom function to extract pagination details for crating the PagedAsyncIterableIterator
+     */
+    customGetPage?: GetPage<PaginateReturn<TResponse>[]>;
+}
+/**
+ * Helper type to infer the Type of the paged elements from the response type
+ * This type is generated based on the swagger information for x-ms-pageable
+ * specifically on the itemName property which indicates the property of the response
+ * where the page items are found. The default value is `value`.
+ * This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
+ */
+export type PaginateReturn<TResult> = TResult extends {
+    body: {
+        value?: infer TPage;
+    };
+} ? GetArrayType<TPage> : Array<unknown>;
+/**
+ * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
+ * @param client - Client to use for sending the next page requests
+ * @param initialResponse - Initial response containing the nextLink and current page of elements
+ * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
+ * @returns - PagedAsyncIterableIterator to iterate the elements
+ */
+export declare function paginate<TResponse extends PathUncheckedResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>;
+//# sourceMappingURL=paginateHelper.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"paginateHelper.d.ts","sourceRoot":"","sources":["../../src/paginateHelper.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,MAAM,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAuF7E;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B,CACzC,QAAQ,EACR,KAAK,GAAG,QAAQ,EAAE,EAClB,aAAa,GAAG,YAAY;IAE5B;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1C;;OAEG;IACH,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,0BAA0B,CAAC,QAAQ,EAAE,KAAK,EAAE,aAAa,CAAC,CAAC;IACrF;;OAEG;IACH,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,aAAa,KAAK,qBAAqB,CAAC,KAAK,CAAC,CAAC;CACpE;AAyBD;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,KAAK,GAAG,KAAK,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,OAAO,CAAC,KAAK,IAAI,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC;IACzD,IAAI,EAAE,KAAK,CAAC;IACZ,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,SAAS;IACtC;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;CACtD;AAED;;;;;;GAMG;AACH,MAAM,MAAM,cAAc,CAAC,OAAO,IAAI,OAAO,SAAS;IACpD,IAAI,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAA;KAAE,CAAC;CAC/B,GACG,YAAY,CAAC,KAAK,CAAC,GACnB,KAAK,CAAC,OAAO,CAAC,CAAC;AAEnB;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,SAAS,SAAS,qBAAqB,EAC9D,MAAM,EAAE,MAAM,EACd,eAAe,EAAE,SAAS,EAC1B,OAAO,GAAE,aAAa,CAAC,SAAS,CAAM,GACrC,0BAA0B,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CA0BvD"}

package/dist/commonjs/paginateHelper.js

@@ -0,0 +1,140 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.paginate = paginate;
+const core_client_1 = require("@azure-rest/core-client");
+/**
+ * returns an async iterator that iterates over results. It also has a `byPage`
+ * method that returns pages of items at once.
+ *
+ * @param pagedResult - an object that specifies how to get pages.
+ * @returns a paged async iterator that iterates over results.
+ */
+function getPagedAsyncIterator(pagedResult) {
+    const iter = getItemAsyncIterator(pagedResult);
+    return {
+        next() {
+            return iter.next();
+        },
+        [Symbol.asyncIterator]() {
+            return this;
+        },
+        byPage: pagedResult?.byPage ??
+            ((settings) => {
+                const { continuationToken } = settings ?? {};
+                return getPageAsyncIterator(pagedResult, {
+                    pageLink: continuationToken,
+                });
+            }),
+    };
+}
+async function* getItemAsyncIterator(pagedResult) {
+    const pages = getPageAsyncIterator(pagedResult);
+    const firstVal = await pages.next();
+    // if the result does not have an array shape, i.e. TPage = TElement, then we return it as is
+    if (!Array.isArray(firstVal.value)) {
+        // can extract elements from this page
+        const { toElements } = pagedResult;
+        if (toElements) {
+            yield* toElements(firstVal.value);
+            for await (const page of pages) {
+                yield* toElements(page);
+            }
+        }
+        else {
+            yield firstVal.value;
+            // `pages` is of type `AsyncIterableIterator<TPage>` but TPage = TElement in this case
+            yield* pages;
+        }
+    }
+    else {
+        yield* firstVal.value;
+        for await (const page of pages) {
+            // pages is of type `AsyncIterableIterator<TPage>` so `page` is of type `TPage`. In this branch,
+            // it must be the case that `TPage = TElement[]`
+            yield* page;
+        }
+    }
+}
+async function* getPageAsyncIterator(pagedResult, options = {}) {
+    const { pageLink } = options;
+    let response = await pagedResult.getPage(pageLink ?? pagedResult.firstPageLink);
+    if (!response) {
+        return;
+    }
+    yield response.page;
+    while (response.nextPageLink) {
+        response = await pagedResult.getPage(response.nextPageLink);
+        if (!response) {
+            return;
+        }
+        yield response.page;
+    }
+}
+/**
+ * Helper to paginate results from an initial response that follows the specification of Autorest `x-ms-pageable` extension
+ * @param client - Client to use for sending the next page requests
+ * @param initialResponse - Initial response containing the nextLink and current page of elements
+ * @param customGetPage - Optional - Function to define how to extract the page and next link to be used to paginate the results
+ * @returns - PagedAsyncIterableIterator to iterate the elements
+ */
+function paginate(client, initialResponse, options = {}) {
+    let firstRun = true;
+    const itemName = "value";
+    const nextLinkName = "nextLink";
+    const { customGetPage } = options;
+    const pagedResult = {
+        firstPageLink: "",
+        getPage: typeof customGetPage === "function"
+            ? customGetPage
+            : async (pageLink) => {
+                const result = firstRun ? initialResponse : await client.pathUnchecked(pageLink).get();
+                firstRun = false;
+                checkPagingRequest(result);
+                const nextLink = getNextLink(result.body, nextLinkName);
+                const values = getElements(result.body, itemName);
+                return {
+                    page: values,
+                    nextPageLink: nextLink,
+                };
+            },
+    };
+    return getPagedAsyncIterator(pagedResult);
+}
+/**
+ * Gets for the value of nextLink in the body
+ */
+function getNextLink(body, nextLinkName) {
+    if (!nextLinkName) {
+        return undefined;
+    }
+    const nextLink = body[nextLinkName];
+    if (typeof nextLink !== "string" && typeof nextLink !== "undefined") {
+        throw new Error(`Body Property ${nextLinkName} should be a string or undefined`);
+    }
+    return nextLink;
+}
+/**
+ * Gets the elements of the current request in the body.
+ */
+function getElements(body, itemName) {
+    const value = body[itemName];
+    // value has to be an array according to the x-ms-pageable extension.
+    // The fact that this must be an array is used above to calculate the
+    // type of elements in the page in PaginateReturn
+    if (!Array.isArray(value)) {
+        throw new Error(`Couldn't paginate response\n Body doesn't contain an array property with name: ${itemName}`);
+    }
+    return value ?? [];
+}
+/**
+ * Checks if a request failed
+ */
+function checkPagingRequest(response) {
+    const Http2xxStatusCodes = ["200", "201", "202", "203", "204", "205", "206", "207", "208", "226"];
+    if (!Http2xxStatusCodes.includes(response.status)) {
+        throw (0, core_client_1.createRestError)(`Pagination failed with unexpected statusCode ${response.status}`, response);
+    }
+}
+//# sourceMappingURL=paginateHelper.js.map