@azure/arm-neonpostgres 1.0.0-beta.1

package/review/arm-neonpostgres.api.md

@@ -0,0 +1,275 @@
+## API Report File for "@azure/arm-neonpostgres"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { AbortSignalLike } from '@azure/abort-controller';
+import { ClientOptions } from '@azure-rest/core-client';
+import { OperationOptions } from '@azure-rest/core-client';
+import { OperationState } from '@azure/core-lro';
+import { PathUncheckedResponse } from '@azure-rest/core-client';
+import { Pipeline } from '@azure/core-rest-pipeline';
+import { PollerLike } from '@azure/core-lro';
+import { TokenCredential } from '@azure/core-auth';
+
+// @public
+export type ActionType = string;
+
+// @public
+export interface CompanyDetails {
+    businessPhone?: string;
+    companyName?: string;
+    country?: string;
+    domain?: string;
+    numberOfEmployees?: number;
+    officeAddress?: string;
+}
+
+// @public
+export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
+    continuationToken?: string;
+};
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export enum KnownActionType {
+    Internal = "Internal"
+}
+
+// @public
+export enum KnownCreatedByType {
+    Application = "Application",
+    Key = "Key",
+    ManagedIdentity = "ManagedIdentity",
+    User = "User"
+}
+
+// @public
+export enum KnownMarketplaceSubscriptionStatus {
+    PendingFulfillmentStart = "PendingFulfillmentStart",
+    Subscribed = "Subscribed",
+    Suspended = "Suspended",
+    Unsubscribed = "Unsubscribed"
+}
+
+// @public
+export enum KnownOrigin {
+    System = "system",
+    User = "user",
+    UserSystem = "user,system"
+}
+
+// @public
+export enum KnownResourceProvisioningState {
+    Canceled = "Canceled",
+    Failed = "Failed",
+    Succeeded = "Succeeded"
+}
+
+// @public
+export enum KnownSingleSignOnStates {
+    Disable = "Disable",
+    Enable = "Enable",
+    Initial = "Initial"
+}
+
+// @public
+export enum KnownVersions {
+    V1_Preview = "2024-08-01-preview"
+}
+
+// @public
+export interface MarketplaceDetails {
+    offerDetails: OfferDetails;
+    subscriptionId?: string;
+    subscriptionStatus?: MarketplaceSubscriptionStatus;
+}
+
+// @public
+export type MarketplaceSubscriptionStatus = string;
+
+// @public
+export interface OfferDetails {
+    offerId: string;
+    planId: string;
+    planName?: string;
+    publisherId: string;
+    termId?: string;
+    termUnit?: string;
+}
+
+// @public
+export interface Operation {
+    actionType?: ActionType;
+    readonly display?: OperationDisplay;
+    readonly isDataAction?: boolean;
+    readonly name?: string;
+    readonly origin?: Origin;
+}
+
+// @public
+export interface OperationDisplay {
+    readonly description?: string;
+    readonly operation?: string;
+    readonly provider?: string;
+    readonly resource?: string;
+}
+
+// @public
+export interface OperationsListOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OperationsOperations {
+    list: (options?: OperationsListOptionalParams) => PagedAsyncIterableIterator<Operation>;
+}
+
+// @public
+export interface OrganizationProperties {
+    companyDetails: CompanyDetails;
+    marketplaceDetails: MarketplaceDetails;
+    partnerOrganizationProperties?: PartnerOrganizationProperties;
+    readonly provisioningState?: ResourceProvisioningState;
+    userDetails: UserDetails;
+}
+
+// @public
+export interface OrganizationResource extends TrackedResource {
+    properties?: OrganizationProperties;
+}
+
+// @public
+export interface OrganizationsCreateOrUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface OrganizationsDeleteOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface OrganizationsGetOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OrganizationsListByResourceGroupOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OrganizationsListBySubscriptionOptionalParams extends OperationOptions {
+}
+
+// @public
+export interface OrganizationsOperations {
+    createOrUpdate: (resourceGroupName: string, organizationName: string, resource: OrganizationResource, options?: OrganizationsCreateOrUpdateOptionalParams) => PollerLike<OperationState<OrganizationResource>, OrganizationResource>;
+    delete: (resourceGroupName: string, organizationName: string, options?: OrganizationsDeleteOptionalParams) => PollerLike<OperationState<void>, void>;
+    get: (resourceGroupName: string, organizationName: string, options?: OrganizationsGetOptionalParams) => Promise<OrganizationResource>;
+    listByResourceGroup: (resourceGroupName: string, options?: OrganizationsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<OrganizationResource>;
+    listBySubscription: (options?: OrganizationsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<OrganizationResource>;
+    update: (resourceGroupName: string, organizationName: string, properties: OrganizationResource, options?: OrganizationsUpdateOptionalParams) => PollerLike<OperationState<OrganizationResource>, OrganizationResource>;
+}
+
+// @public
+export interface OrganizationsUpdateOptionalParams extends OperationOptions {
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type Origin = string;
+
+// @public
+export interface PagedAsyncIterableIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
+    [Symbol.asyncIterator](): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+    byPage: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
+    next(): Promise<IteratorResult<TElement>>;
+}
+
+// @public
+export interface PageSettings {
+    continuationToken?: string;
+}
+
+// @public
+export interface PartnerOrganizationProperties {
+    organizationId?: string;
+    organizationName: string;
+    singleSignOnProperties?: SingleSignOnProperties;
+}
+
+// @public (undocumented)
+export class PostgresClient {
+    constructor(credential: TokenCredential, subscriptionId: string, options?: PostgresClientOptionalParams);
+    readonly operations: OperationsOperations;
+    readonly organizations: OrganizationsOperations;
+    readonly pipeline: Pipeline;
+}
+
+// @public
+export interface PostgresClientOptionalParams extends ClientOptions {
+    apiVersion?: string;
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly systemData?: SystemData;
+    readonly type?: string;
+}
+
+// @public
+export type ResourceProvisioningState = string;
+
+// @public
+export function restorePoller<TResponse extends PathUncheckedResponse, TResult>(client: PostgresClient, serializedState: string, sourceOperation: (...args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult>): PollerLike<OperationState<TResult>, TResult>;
+
+// @public (undocumented)
+export interface RestorePollerOptions<TResult, TResponse extends PathUncheckedResponse = PathUncheckedResponse> extends OperationOptions {
+    abortSignal?: AbortSignalLike;
+    processResponseBody?: (result: TResponse) => Promise<TResult>;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface SingleSignOnProperties {
+    aadDomains?: string[];
+    enterpriseAppId?: string;
+    singleSignOnState?: SingleSignOnStates;
+    singleSignOnUrl?: string;
+}
+
+// @public
+export type SingleSignOnStates = string;
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export interface TrackedResource extends Resource {
+    location: string;
+    tags?: Record<string, string>;
+}
+
+// @public
+export interface UserDetails {
+    emailAddress?: string;
+    firstName?: string;
+    lastName?: string;
+    phoneNumber?: string;
+    upn?: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```