@azure/arm-commerce 4.0.0-beta.3 → 4.0.0-beta.4

package/dist/commonjs/models/models.d.ts

@@ -0,0 +1,193 @@
+/**
+ * This file contains only generated model types and their (de)serializers.
+ * Disable the following rules for internal models with '_' prefix and deserializers which require 'any' for raw JSON input.
+ */
+/** The response of a UsageAggregation list operation. */
+export interface _UsageAggregationListResult {
+    /** The UsageAggregation items on this page */
+    value: UsageAggregation[];
+    /** The link to the next page of items */
+    nextLink?: string;
+}
+export declare function _usageAggregationListResultDeserializer(item: any): _UsageAggregationListResult;
+export declare function usageAggregationArrayDeserializer(result: Array<UsageAggregation>): any[];
+/** Describes the usageAggregation. */
+export interface UsageAggregation {
+    /** Unique Id for the usage aggregate. */
+    id?: string;
+    /** Name of the usage aggregate. */
+    name?: string;
+    /** Type of the resource being returned. */
+    type?: string;
+    /** The subscription identifier for the Azure user. */
+    subscriptionId?: string;
+    /** Unique ID for the resource that was consumed (aka ResourceID). */
+    meterId?: string;
+    /** UTC start time for the usage bucket to which this usage aggregate belongs. */
+    usageStartTime?: Date;
+    /** UTC end time for the usage bucket to which this usage aggregate belongs. */
+    usageEndTime?: Date;
+    /** The amount of the resource consumption that occurred in this time frame. */
+    quantity?: number;
+    /** The unit in which the usage for this resource is being counted, e.g. Hours, GB. */
+    unit?: string;
+    /** Friendly name of the resource being consumed. */
+    meterName?: string;
+    /** Category of the consumed resource. */
+    meterCategory?: string;
+    /** Sub-category of the consumed resource. */
+    meterSubCategory?: string;
+    /** Region of the meterId used for billing purposes */
+    meterRegion?: string;
+    /** Key-value pairs of instance details (legacy format). */
+    infoFields?: any;
+    /** Key-value pairs of instance details represented as a string. */
+    instanceData?: string;
+}
+export declare function usageAggregationDeserializer(item: any): UsageAggregation;
+/** Describes a sample of the usageAggregation. */
+export interface UsageSample {
+    /** The subscription identifier for the Azure user. */
+    subscriptionId?: string;
+    /** Unique ID for the resource that was consumed (aka ResourceID). */
+    meterId?: string;
+    /** UTC start time for the usage bucket to which this usage aggregate belongs. */
+    usageStartTime?: Date;
+    /** UTC end time for the usage bucket to which this usage aggregate belongs. */
+    usageEndTime?: Date;
+    /** The amount of the resource consumption that occurred in this time frame. */
+    quantity?: number;
+    /** The unit in which the usage for this resource is being counted, e.g. Hours, GB. */
+    unit?: string;
+    /** Friendly name of the resource being consumed. */
+    meterName?: string;
+    /** Category of the consumed resource. */
+    meterCategory?: string;
+    /** Sub-category of the consumed resource. */
+    meterSubCategory?: string;
+    /** Region of the meterId used for billing purposes */
+    meterRegion?: string;
+    /** Key-value pairs of instance details (legacy format). */
+    infoFields?: any;
+    /** Key-value pairs of instance details represented as a string. */
+    instanceData?: string;
+}
+export declare function usageSampleDeserializer(item: any): UsageSample;
+/** Describes the format of Error response with a wrapper object */
+export interface ErrorObjectResponse {
+    /** Wrapper object for error information */
+    error?: ErrorResponse;
+}
+export declare function errorObjectResponseDeserializer(item: any): ErrorObjectResponse;
+/** Describes the format of Error response. */
+export interface ErrorResponse {
+    /** Error code */
+    code?: string;
+    /** Error message indicating why the operation failed. */
+    message?: string;
+}
+export declare function errorResponseDeserializer(item: any): ErrorResponse;
+/** Price and Metadata information for resources */
+export interface ResourceRateCardInfo {
+    /** The currency in which the rates are provided. */
+    currency?: string;
+    /** The culture in which the resource information is localized. */
+    locale?: string;
+    /** All rates are pretax, so this will always be returned as 'false'. */
+    isTaxIncluded?: boolean;
+    /** A list of offer terms. */
+    offerTerms?: OfferTermInfoUnion[];
+    /** A list of meters. */
+    meters?: MeterInfo[];
+}
+export declare function resourceRateCardInfoDeserializer(item: any): ResourceRateCardInfo;
+export declare function offerTermInfoUnionArrayDeserializer(result: Array<OfferTermInfoUnion>): any[];
+/** Describes the offer term. */
+export interface OfferTermInfo {
+    /** Name of the offer term */
+    /** The discriminator possible values: Monetary Credit, Monetary Commitment, Recurring Charge */
+    name: OfferTermInfoName;
+    /** Indicates the date from which the offer term is effective. */
+    effectiveDate?: Date;
+}
+export declare function offerTermInfoDeserializer(item: any): OfferTermInfo;
+/** Alias for OfferTermInfoUnion */
+export type OfferTermInfoUnion = MonetaryCredit | MonetaryCommitment | RecurringCharge | OfferTermInfo;
+export declare function offerTermInfoUnionDeserializer(item: any): OfferTermInfoUnion;
+/** Name of the offer term */
+export type OfferTermInfoName = "Recurring Charge" | "Monetary Commitment" | "Monetary Credit";
+/** Indicates that this is a monetary credit offer. */
+export interface MonetaryCredit extends OfferTermInfo {
+    /** The amount of credit provided under the terms of the given offer level. */
+    credit?: number;
+    /** An array of meter ids that are excluded from the given offer terms. */
+    excludedMeterIds?: string[];
+    /** Name of the offer term */
+    name: "Monetary Credit";
+}
+export declare function monetaryCreditDeserializer(item: any): MonetaryCredit;
+/** Indicates that a monetary commitment is required for this offer */
+export interface MonetaryCommitment extends OfferTermInfo {
+    /** The list of key/value pairs for the tiered meter rates, in the format 'key':'value' where key = price, and value = the corresponding discount percentage. This field is used only by offer terms of type 'Monetary Commitment'. */
+    tieredDiscount?: Record<string, number>;
+    /** An array of meter ids that are excluded from the given offer terms. */
+    excludedMeterIds?: string[];
+    /** Name of the offer term */
+    name: "Monetary Commitment";
+}
+export declare function monetaryCommitmentDeserializer(item: any): MonetaryCommitment;
+/** Indicates a recurring charge is present for this offer. */
+export interface RecurringCharge extends OfferTermInfo {
+    /** The amount of recurring charge as per the offer term. */
+    recurringCharge?: number;
+    /** Name of the offer term */
+    name: "Recurring Charge";
+}
+export declare function recurringChargeDeserializer(item: any): RecurringCharge;
+export declare function meterInfoArrayDeserializer(result: Array<MeterInfo>): any[];
+/** Detailed information about the meter. */
+export interface MeterInfo {
+    /** The unique identifier of the resource. */
+    meterId?: string;
+    /** The name of the meter, within the given meter category */
+    meterName?: string;
+    /** The category of the meter, e.g., 'Cloud services', 'Networking', etc.. */
+    meterCategory?: string;
+    /** The subcategory of the meter, e.g., 'A6 Cloud services', 'ExpressRoute (IXP)', etc.. */
+    meterSubCategory?: string;
+    /** The unit in which the meter consumption is charged, e.g., 'Hours', 'GB', etc. */
+    unit?: string;
+    /** Provides additional meter data. 'Third Party' indicates a meter with no discount. Blanks indicate First Party. */
+    meterTags?: string[];
+    /** The region in which the Azure service is available. */
+    meterRegion?: string;
+    /** The list of key/value pairs for the meter rates, in the format 'key':'value' where key = the meter quantity, and value = the corresponding price */
+    meterRates?: Record<string, number>;
+    /** Indicates the date from which the meter rate is effective. */
+    effectiveDate?: Date;
+    /** The resource quantity that is included in the offer at no cost. Consumption beyond this quantity will be charged. */
+    includedQuantity?: number;
+}
+export declare function meterInfoDeserializer(item: any): MeterInfo;
+/** Type of AggregationGranularity */
+export type AggregationGranularity = "Daily" | "Hourly";
+/** The available API versions. */
+export declare enum KnownVersions {
+    /** The 2015-06-01-preview API version. */
+    V20150601Preview = "2015-06-01-preview"
+}
+export declare function _usageAggregationPropertiesDeserializer(item: any): {
+    subscriptionId: any;
+    meterId: any;
+    usageStartTime: any;
+    usageEndTime: any;
+    quantity: any;
+    unit: any;
+    meterName: any;
+    meterCategory: any;
+    meterSubCategory: any;
+    meterRegion: any;
+    infoFields: any;
+    instanceData: any;
+};
+//# sourceMappingURL=models.d.ts.map

package/dist/commonjs/models/models.js

@@ -0,0 +1,209 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var models_exports = {};
+__export(models_exports, {
+  KnownVersions: () => KnownVersions,
+  _usageAggregationListResultDeserializer: () => _usageAggregationListResultDeserializer,
+  _usageAggregationPropertiesDeserializer: () => _usageAggregationPropertiesDeserializer,
+  errorObjectResponseDeserializer: () => errorObjectResponseDeserializer,
+  errorResponseDeserializer: () => errorResponseDeserializer,
+  meterInfoArrayDeserializer: () => meterInfoArrayDeserializer,
+  meterInfoDeserializer: () => meterInfoDeserializer,
+  monetaryCommitmentDeserializer: () => monetaryCommitmentDeserializer,
+  monetaryCreditDeserializer: () => monetaryCreditDeserializer,
+  offerTermInfoDeserializer: () => offerTermInfoDeserializer,
+  offerTermInfoUnionArrayDeserializer: () => offerTermInfoUnionArrayDeserializer,
+  offerTermInfoUnionDeserializer: () => offerTermInfoUnionDeserializer,
+  recurringChargeDeserializer: () => recurringChargeDeserializer,
+  resourceRateCardInfoDeserializer: () => resourceRateCardInfoDeserializer,
+  usageAggregationArrayDeserializer: () => usageAggregationArrayDeserializer,
+  usageAggregationDeserializer: () => usageAggregationDeserializer,
+  usageSampleDeserializer: () => usageSampleDeserializer
+});
+module.exports = __toCommonJS(models_exports);
+function _usageAggregationListResultDeserializer(item) {
+  return {
+    value: usageAggregationArrayDeserializer(item["value"]),
+    nextLink: item["nextLink"]
+  };
+}
+function usageAggregationArrayDeserializer(result) {
+  return result.map((item) => {
+    return usageAggregationDeserializer(item);
+  });
+}
+function usageAggregationDeserializer(item) {
+  return {
+    id: item["id"],
+    name: item["name"],
+    type: item["type"],
+    ...!item["properties"] ? item["properties"] : _usageAggregationPropertiesDeserializer(item["properties"])
+  };
+}
+function usageSampleDeserializer(item) {
+  return {
+    subscriptionId: item["subscriptionId"],
+    meterId: item["meterId"],
+    usageStartTime: !item["usageStartTime"] ? item["usageStartTime"] : new Date(item["usageStartTime"]),
+    usageEndTime: !item["usageEndTime"] ? item["usageEndTime"] : new Date(item["usageEndTime"]),
+    quantity: item["quantity"],
+    unit: item["unit"],
+    meterName: item["meterName"],
+    meterCategory: item["meterCategory"],
+    meterSubCategory: item["meterSubCategory"],
+    meterRegion: item["meterRegion"],
+    infoFields: item["infoFields"],
+    instanceData: item["instanceData"]
+  };
+}
+function errorObjectResponseDeserializer(item) {
+  return {
+    error: !item["error"] ? item["error"] : errorResponseDeserializer(item["error"])
+  };
+}
+function errorResponseDeserializer(item) {
+  return {
+    code: item["code"],
+    message: item["message"]
+  };
+}
+function resourceRateCardInfoDeserializer(item) {
+  return {
+    currency: item["Currency"],
+    locale: item["Locale"],
+    isTaxIncluded: item["IsTaxIncluded"],
+    offerTerms: !item["OfferTerms"] ? item["OfferTerms"] : offerTermInfoUnionArrayDeserializer(item["OfferTerms"]),
+    meters: !item["Meters"] ? item["Meters"] : meterInfoArrayDeserializer(item["Meters"])
+  };
+}
+function offerTermInfoUnionArrayDeserializer(result) {
+  return result.map((item) => {
+    return offerTermInfoUnionDeserializer(item);
+  });
+}
+function offerTermInfoDeserializer(item) {
+  return {
+    name: item["Name"],
+    effectiveDate: !item["EffectiveDate"] ? item["EffectiveDate"] : new Date(item["EffectiveDate"])
+  };
+}
+function offerTermInfoUnionDeserializer(item) {
+  switch (item["Name"]) {
+    case "Monetary Credit":
+      return monetaryCreditDeserializer(item);
+    case "Monetary Commitment":
+      return monetaryCommitmentDeserializer(item);
+    case "Recurring Charge":
+      return recurringChargeDeserializer(item);
+    default:
+      return offerTermInfoDeserializer(item);
+  }
+}
+function monetaryCreditDeserializer(item) {
+  return {
+    name: item["Name"],
+    effectiveDate: !item["EffectiveDate"] ? item["EffectiveDate"] : new Date(item["EffectiveDate"]),
+    credit: item["Credit"],
+    excludedMeterIds: !item["ExcludedMeterIds"] ? item["ExcludedMeterIds"] : item["ExcludedMeterIds"].map((p) => {
+      return p;
+    })
+  };
+}
+function monetaryCommitmentDeserializer(item) {
+  return {
+    name: item["Name"],
+    effectiveDate: !item["EffectiveDate"] ? item["EffectiveDate"] : new Date(item["EffectiveDate"]),
+    tieredDiscount: !item["TieredDiscount"] ? item["TieredDiscount"] : Object.fromEntries(
+      Object.entries(item["TieredDiscount"]).map(([k, p]) => [k, p])
+    ),
+    excludedMeterIds: !item["ExcludedMeterIds"] ? item["ExcludedMeterIds"] : item["ExcludedMeterIds"].map((p) => {
+      return p;
+    })
+  };
+}
+function recurringChargeDeserializer(item) {
+  return {
+    name: item["Name"],
+    effectiveDate: !item["EffectiveDate"] ? item["EffectiveDate"] : new Date(item["EffectiveDate"]),
+    recurringCharge: item["RecurringCharge"]
+  };
+}
+function meterInfoArrayDeserializer(result) {
+  return result.map((item) => {
+    return meterInfoDeserializer(item);
+  });
+}
+function meterInfoDeserializer(item) {
+  return {
+    meterId: item["MeterId"],
+    meterName: item["MeterName"],
+    meterCategory: item["MeterCategory"],
+    meterSubCategory: item["MeterSubCategory"],
+    unit: item["Unit"],
+    meterTags: !item["MeterTags"] ? item["MeterTags"] : item["MeterTags"].map((p) => {
+      return p;
+    }),
+    meterRegion: item["MeterRegion"],
+    meterRates: !item["MeterRates"] ? item["MeterRates"] : Object.fromEntries(
+      Object.entries(item["MeterRates"]).map(([k, p]) => [k, p])
+    ),
+    effectiveDate: !item["EffectiveDate"] ? item["EffectiveDate"] : new Date(item["EffectiveDate"]),
+    includedQuantity: item["IncludedQuantity"]
+  };
+}
+var KnownVersions = /* @__PURE__ */ ((KnownVersions2) => {
+  KnownVersions2["V20150601Preview"] = "2015-06-01-preview";
+  return KnownVersions2;
+})(KnownVersions || {});
+function _usageAggregationPropertiesDeserializer(item) {
+  return {
+    subscriptionId: item["subscriptionId"],
+    meterId: item["meterId"],
+    usageStartTime: !item["usageStartTime"] ? item["usageStartTime"] : new Date(item["usageStartTime"]),
+    usageEndTime: !item["usageEndTime"] ? item["usageEndTime"] : new Date(item["usageEndTime"]),
+    quantity: item["quantity"],
+    unit: item["unit"],
+    meterName: item["meterName"],
+    meterCategory: item["meterCategory"],
+    meterSubCategory: item["meterSubCategory"],
+    meterRegion: item["meterRegion"],
+    infoFields: item["infoFields"],
+    instanceData: item["instanceData"]
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  KnownVersions,
+  _usageAggregationListResultDeserializer,
+  _usageAggregationPropertiesDeserializer,
+  errorObjectResponseDeserializer,
+  errorResponseDeserializer,
+  meterInfoArrayDeserializer,
+  meterInfoDeserializer,
+  monetaryCommitmentDeserializer,
+  monetaryCreditDeserializer,
+  offerTermInfoDeserializer,
+  offerTermInfoUnionArrayDeserializer,
+  offerTermInfoUnionDeserializer,
+  recurringChargeDeserializer,
+  resourceRateCardInfoDeserializer,
+  usageAggregationArrayDeserializer,
+  usageAggregationDeserializer,
+  usageSampleDeserializer
+});
+//# sourceMappingURL=models.js.map

package/dist/commonjs/models/models.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/models/models.ts"],
+  "sourcesContent": ["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * This file contains only generated model types and their (de)serializers.\n * Disable the following rules for internal models with '_' prefix and deserializers which require 'any' for raw JSON input.\n */\n/* eslint-disable @typescript-eslint/naming-convention */\n/* eslint-disable @typescript-eslint/explicit-module-boundary-types */\n/** The response of a UsageAggregation list operation. */\nexport interface _UsageAggregationListResult {\n  /** The UsageAggregation items on this page */\n  value: UsageAggregation[];\n  /** The link to the next page of items */\n  nextLink?: string;\n}\n\nexport function _usageAggregationListResultDeserializer(item: any): _UsageAggregationListResult {\n  return {\n    value: usageAggregationArrayDeserializer(item[\"value\"]),\n    nextLink: item[\"nextLink\"],\n  };\n}\n\nexport function usageAggregationArrayDeserializer(result: Array<UsageAggregation>): any[] {\n  return result.map((item) => {\n    return usageAggregationDeserializer(item);\n  });\n}\n\n/** Describes the usageAggregation. */\nexport interface UsageAggregation {\n  /** Unique Id for the usage aggregate. */\n  id?: string;\n  /** Name of the usage aggregate. */\n  name?: string;\n  /** Type of the resource being returned. */\n  type?: string;\n  /** The subscription identifier for the Azure user. */\n  subscriptionId?: string;\n  /** Unique ID for the resource that was consumed (aka ResourceID). */\n  meterId?: string;\n  /** UTC start time for the usage bucket to which this usage aggregate belongs. */\n  usageStartTime?: Date;\n  /** UTC end time for the usage bucket to which this usage aggregate belongs. */\n  usageEndTime?: Date;\n  /** The amount of the resource consumption that occurred in this time frame. */\n  quantity?: number;\n  /** The unit in which the usage for this resource is being counted, e.g. Hours, GB. */\n  unit?: string;\n  /** Friendly name of the resource being consumed. */\n  meterName?: string;\n  /** Category of the consumed resource. */\n  meterCategory?: string;\n  /** Sub-category of the consumed resource. */\n  meterSubCategory?: string;\n  /** Region of the meterId used for billing purposes */\n  meterRegion?: string;\n  /** Key-value pairs of instance details (legacy format). */\n  infoFields?: any;\n  /** Key-value pairs of instance details represented as a string. */\n  instanceData?: string;\n}\n\nexport function usageAggregationDeserializer(item: any): UsageAggregation {\n  return {\n    id: item[\"id\"],\n    name: item[\"name\"],\n    type: item[\"type\"],\n    ...(!item[\"properties\"]\n      ? item[\"properties\"]\n      : _usageAggregationPropertiesDeserializer(item[\"properties\"])),\n  };\n}\n\n/** Describes a sample of the usageAggregation. */\nexport interface UsageSample {\n  /** The subscription identifier for the Azure user. */\n  subscriptionId?: string;\n  /** Unique ID for the resource that was consumed (aka ResourceID). */\n  meterId?: string;\n  /** UTC start time for the usage bucket to which this usage aggregate belongs. */\n  usageStartTime?: Date;\n  /** UTC end time for the usage bucket to which this usage aggregate belongs. */\n  usageEndTime?: Date;\n  /** The amount of the resource consumption that occurred in this time frame. */\n  quantity?: number;\n  /** The unit in which the usage for this resource is being counted, e.g. Hours, GB. */\n  unit?: string;\n  /** Friendly name of the resource being consumed. */\n  meterName?: string;\n  /** Category of the consumed resource. */\n  meterCategory?: string;\n  /** Sub-category of the consumed resource. */\n  meterSubCategory?: string;\n  /** Region of the meterId used for billing purposes */\n  meterRegion?: string;\n  /** Key-value pairs of instance details (legacy format). */\n  infoFields?: any;\n  /** Key-value pairs of instance details represented as a string. */\n  instanceData?: string;\n}\n\nexport function usageSampleDeserializer(item: any): UsageSample {\n  return {\n    subscriptionId: item[\"subscriptionId\"],\n    meterId: item[\"meterId\"],\n    usageStartTime: !item[\"usageStartTime\"]\n      ? item[\"usageStartTime\"]\n      : new Date(item[\"usageStartTime\"]),\n    usageEndTime: !item[\"usageEndTime\"] ? item[\"usageEndTime\"] : new Date(item[\"usageEndTime\"]),\n    quantity: item[\"quantity\"],\n    unit: item[\"unit\"],\n    meterName: item[\"meterName\"],\n    meterCategory: item[\"meterCategory\"],\n    meterSubCategory: item[\"meterSubCategory\"],\n    meterRegion: item[\"meterRegion\"],\n    infoFields: item[\"infoFields\"],\n    instanceData: item[\"instanceData\"],\n  };\n}\n\n/** Describes the format of Error response with a wrapper object */\nexport interface ErrorObjectResponse {\n  /** Wrapper object for error information */\n  error?: ErrorResponse;\n}\n\nexport function errorObjectResponseDeserializer(item: any): ErrorObjectResponse {\n  return {\n    error: !item[\"error\"] ? item[\"error\"] : errorResponseDeserializer(item[\"error\"]),\n  };\n}\n\n/** Describes the format of Error response. */\nexport interface ErrorResponse {\n  /** Error code */\n  code?: string;\n  /** Error message indicating why the operation failed. */\n  message?: string;\n}\n\nexport function errorResponseDeserializer(item: any): ErrorResponse {\n  return {\n    code: item[\"code\"],\n    message: item[\"message\"],\n  };\n}\n\n/** Price and Metadata information for resources */\nexport interface ResourceRateCardInfo {\n  /** The currency in which the rates are provided. */\n  currency?: string;\n  /** The culture in which the resource information is localized. */\n  locale?: string;\n  /** All rates are pretax, so this will always be returned as 'false'. */\n  isTaxIncluded?: boolean;\n  /** A list of offer terms. */\n  offerTerms?: OfferTermInfoUnion[];\n  /** A list of meters. */\n  meters?: MeterInfo[];\n}\n\nexport function resourceRateCardInfoDeserializer(item: any): ResourceRateCardInfo {\n  return {\n    currency: item[\"Currency\"],\n    locale: item[\"Locale\"],\n    isTaxIncluded: item[\"IsTaxIncluded\"],\n    offerTerms: !item[\"OfferTerms\"]\n      ? item[\"OfferTerms\"]\n      : offerTermInfoUnionArrayDeserializer(item[\"OfferTerms\"]),\n    meters: !item[\"Meters\"] ? item[\"Meters\"] : meterInfoArrayDeserializer(item[\"Meters\"]),\n  };\n}\n\nexport function offerTermInfoUnionArrayDeserializer(result: Array<OfferTermInfoUnion>): any[] {\n  return result.map((item) => {\n    return offerTermInfoUnionDeserializer(item);\n  });\n}\n\n/** Describes the offer term. */\nexport interface OfferTermInfo {\n  /** Name of the offer term */\n  /** The discriminator possible values: Monetary Credit, Monetary Commitment, Recurring Charge */\n  name: OfferTermInfoName;\n  /** Indicates the date from which the offer term is effective. */\n  effectiveDate?: Date;\n}\n\nexport function offerTermInfoDeserializer(item: any): OfferTermInfo {\n  return {\n    name: item[\"Name\"],\n    effectiveDate: !item[\"EffectiveDate\"] ? item[\"EffectiveDate\"] : new Date(item[\"EffectiveDate\"]),\n  };\n}\n\n/** Alias for OfferTermInfoUnion */\nexport type OfferTermInfoUnion =\n  | MonetaryCredit\n  | MonetaryCommitment\n  | RecurringCharge\n  | OfferTermInfo;\n\nexport function offerTermInfoUnionDeserializer(item: any): OfferTermInfoUnion {\n  switch (item[\"Name\"]) {\n    case \"Monetary Credit\":\n      return monetaryCreditDeserializer(item as MonetaryCredit);\n\n    case \"Monetary Commitment\":\n      return monetaryCommitmentDeserializer(item as MonetaryCommitment);\n\n    case \"Recurring Charge\":\n      return recurringChargeDeserializer(item as RecurringCharge);\n\n    default:\n      return offerTermInfoDeserializer(item);\n  }\n}\n\n/** Name of the offer term */\nexport type OfferTermInfoName = \"Recurring Charge\" | \"Monetary Commitment\" | \"Monetary Credit\";\n\n/** Indicates that this is a monetary credit offer. */\nexport interface MonetaryCredit extends OfferTermInfo {\n  /** The amount of credit provided under the terms of the given offer level. */\n  credit?: number;\n  /** An array of meter ids that are excluded from the given offer terms. */\n  excludedMeterIds?: string[];\n  /** Name of the offer term */\n  name: \"Monetary Credit\";\n}\n\nexport function monetaryCreditDeserializer(item: any): MonetaryCredit {\n  return {\n    name: item[\"Name\"],\n    effectiveDate: !item[\"EffectiveDate\"] ? item[\"EffectiveDate\"] : new Date(item[\"EffectiveDate\"]),\n    credit: item[\"Credit\"],\n    excludedMeterIds: !item[\"ExcludedMeterIds\"]\n      ? item[\"ExcludedMeterIds\"]\n      : item[\"ExcludedMeterIds\"].map((p: any) => {\n          return p;\n        }),\n  };\n}\n\n/** Indicates that a monetary commitment is required for this offer */\nexport interface MonetaryCommitment extends OfferTermInfo {\n  /** The list of key/value pairs for the tiered meter rates, in the format 'key':'value' where key = price, and value = the corresponding discount percentage. This field is used only by offer terms of type 'Monetary Commitment'. */\n  tieredDiscount?: Record<string, number>;\n  /** An array of meter ids that are excluded from the given offer terms. */\n  excludedMeterIds?: string[];\n  /** Name of the offer term */\n  name: \"Monetary Commitment\";\n}\n\nexport function monetaryCommitmentDeserializer(item: any): MonetaryCommitment {\n  return {\n    name: item[\"Name\"],\n    effectiveDate: !item[\"EffectiveDate\"] ? item[\"EffectiveDate\"] : new Date(item[\"EffectiveDate\"]),\n    tieredDiscount: !item[\"TieredDiscount\"]\n      ? item[\"TieredDiscount\"]\n      : Object.fromEntries(\n          Object.entries(item[\"TieredDiscount\"]).map(([k, p]: [string, any]) => [k, p]),\n        ),\n    excludedMeterIds: !item[\"ExcludedMeterIds\"]\n      ? item[\"ExcludedMeterIds\"]\n      : item[\"ExcludedMeterIds\"].map((p: any) => {\n          return p;\n        }),\n  };\n}\n\n/** Indicates a recurring charge is present for this offer. */\nexport interface RecurringCharge extends OfferTermInfo {\n  /** The amount of recurring charge as per the offer term. */\n  recurringCharge?: number;\n  /** Name of the offer term */\n  name: \"Recurring Charge\";\n}\n\nexport function recurringChargeDeserializer(item: any): RecurringCharge {\n  return {\n    name: item[\"Name\"],\n    effectiveDate: !item[\"EffectiveDate\"] ? item[\"EffectiveDate\"] : new Date(item[\"EffectiveDate\"]),\n    recurringCharge: item[\"RecurringCharge\"],\n  };\n}\n\nexport function meterInfoArrayDeserializer(result: Array<MeterInfo>): any[] {\n  return result.map((item) => {\n    return meterInfoDeserializer(item);\n  });\n}\n\n/** Detailed information about the meter. */\nexport interface MeterInfo {\n  /** The unique identifier of the resource. */\n  meterId?: string;\n  /** The name of the meter, within the given meter category */\n  meterName?: string;\n  /** The category of the meter, e.g., 'Cloud services', 'Networking', etc.. */\n  meterCategory?: string;\n  /** The subcategory of the meter, e.g., 'A6 Cloud services', 'ExpressRoute (IXP)', etc.. */\n  meterSubCategory?: string;\n  /** The unit in which the meter consumption is charged, e.g., 'Hours', 'GB', etc. */\n  unit?: string;\n  /** Provides additional meter data. 'Third Party' indicates a meter with no discount. Blanks indicate First Party. */\n  meterTags?: string[];\n  /** The region in which the Azure service is available. */\n  meterRegion?: string;\n  /** The list of key/value pairs for the meter rates, in the format 'key':'value' where key = the meter quantity, and value = the corresponding price */\n  meterRates?: Record<string, number>;\n  /** Indicates the date from which the meter rate is effective. */\n  effectiveDate?: Date;\n  /** The resource quantity that is included in the offer at no cost. Consumption beyond this quantity will be charged. */\n  includedQuantity?: number;\n}\n\nexport function meterInfoDeserializer(item: any): MeterInfo {\n  return {\n    meterId: item[\"MeterId\"],\n    meterName: item[\"MeterName\"],\n    meterCategory: item[\"MeterCategory\"],\n    meterSubCategory: item[\"MeterSubCategory\"],\n    unit: item[\"Unit\"],\n    meterTags: !item[\"MeterTags\"]\n      ? item[\"MeterTags\"]\n      : item[\"MeterTags\"].map((p: any) => {\n          return p;\n        }),\n    meterRegion: item[\"MeterRegion\"],\n    meterRates: !item[\"MeterRates\"]\n      ? item[\"MeterRates\"]\n      : Object.fromEntries(\n          Object.entries(item[\"MeterRates\"]).map(([k, p]: [string, any]) => [k, p]),\n        ),\n    effectiveDate: !item[\"EffectiveDate\"] ? item[\"EffectiveDate\"] : new Date(item[\"EffectiveDate\"]),\n    includedQuantity: item[\"IncludedQuantity\"],\n  };\n}\n\n/** Type of AggregationGranularity */\nexport type AggregationGranularity = \"Daily\" | \"Hourly\";\n\n/** The available API versions. */\nexport enum KnownVersions {\n  /** The 2015-06-01-preview API version. */\n  V20150601Preview = \"2015-06-01-preview\",\n}\n\nexport function _usageAggregationPropertiesDeserializer(item: any) {\n  return {\n    subscriptionId: item[\"subscriptionId\"],\n    meterId: item[\"meterId\"],\n    usageStartTime: !item[\"usageStartTime\"]\n      ? item[\"usageStartTime\"]\n      : new Date(item[\"usageStartTime\"]),\n    usageEndTime: !item[\"usageEndTime\"] ? item[\"usageEndTime\"] : new Date(item[\"usageEndTime\"]),\n    quantity: item[\"quantity\"],\n    unit: item[\"unit\"],\n    meterName: item[\"meterName\"],\n    meterCategory: item[\"meterCategory\"],\n    meterSubCategory: item[\"meterSubCategory\"],\n    meterRegion: item[\"meterRegion\"],\n    infoFields: item[\"infoFields\"],\n    instanceData: item[\"instanceData\"],\n  };\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAiBO,SAAS,wCAAwC,MAAwC;AAC9F,SAAO;AAAA,IACL,OAAO,kCAAkC,KAAK,OAAO,CAAC;AAAA,IACtD,UAAU,KAAK,UAAU;AAAA,EAC3B;AACF;AAEO,SAAS,kCAAkC,QAAwC;AACxF,SAAO,OAAO,IAAI,CAAC,SAAS;AAC1B,WAAO,6BAA6B,IAAI;AAAA,EAC1C,CAAC;AACH;AAoCO,SAAS,6BAA6B,MAA6B;AACxE,SAAO;AAAA,IACL,IAAI,KAAK,IAAI;AAAA,IACb,MAAM,KAAK,MAAM;AAAA,IACjB,MAAM,KAAK,MAAM;AAAA,IACjB,GAAI,CAAC,KAAK,YAAY,IAClB,KAAK,YAAY,IACjB,wCAAwC,KAAK,YAAY,CAAC;AAAA,EAChE;AACF;AA8BO,SAAS,wBAAwB,MAAwB;AAC9D,SAAO;AAAA,IACL,gBAAgB,KAAK,gBAAgB;AAAA,IACrC,SAAS,KAAK,SAAS;AAAA,IACvB,gBAAgB,CAAC,KAAK,gBAAgB,IAClC,KAAK,gBAAgB,IACrB,IAAI,KAAK,KAAK,gBAAgB,CAAC;AAAA,IACnC,cAAc,CAAC,KAAK,cAAc,IAAI,KAAK,cAAc,IAAI,IAAI,KAAK,KAAK,cAAc,CAAC;AAAA,IAC1F,UAAU,KAAK,UAAU;AAAA,IACzB,MAAM,KAAK,MAAM;AAAA,IACjB,WAAW,KAAK,WAAW;AAAA,IAC3B,eAAe,KAAK,eAAe;AAAA,IACnC,kBAAkB,KAAK,kBAAkB;AAAA,IACzC,aAAa,KAAK,aAAa;AAAA,IAC/B,YAAY,KAAK,YAAY;AAAA,IAC7B,cAAc,KAAK,cAAc;AAAA,EACnC;AACF;AAQO,SAAS,gCAAgC,MAAgC;AAC9E,SAAO;AAAA,IACL,OAAO,CAAC,KAAK,OAAO,IAAI,KAAK,OAAO,IAAI,0BAA0B,KAAK,OAAO,CAAC;AAAA,EACjF;AACF;AAUO,SAAS,0BAA0B,MAA0B;AAClE,SAAO;AAAA,IACL,MAAM,KAAK,MAAM;AAAA,IACjB,SAAS,KAAK,SAAS;AAAA,EACzB;AACF;AAgBO,SAAS,iCAAiC,MAAiC;AAChF,SAAO;AAAA,IACL,UAAU,KAAK,UAAU;AAAA,IACzB,QAAQ,KAAK,QAAQ;AAAA,IACrB,eAAe,KAAK,eAAe;AAAA,IACnC,YAAY,CAAC,KAAK,YAAY,IAC1B,KAAK,YAAY,IACjB,oCAAoC,KAAK,YAAY,CAAC;AAAA,IAC1D,QAAQ,CAAC,KAAK,QAAQ,IAAI,KAAK,QAAQ,IAAI,2BAA2B,KAAK,QAAQ,CAAC;AAAA,EACtF;AACF;AAEO,SAAS,oCAAoC,QAA0C;AAC5F,SAAO,OAAO,IAAI,CAAC,SAAS;AAC1B,WAAO,+BAA+B,IAAI;AAAA,EAC5C,CAAC;AACH;AAWO,SAAS,0BAA0B,MAA0B;AAClE,SAAO;AAAA,IACL,MAAM,KAAK,MAAM;AAAA,IACjB,eAAe,CAAC,KAAK,eAAe,IAAI,KAAK,eAAe,IAAI,IAAI,KAAK,KAAK,eAAe,CAAC;AAAA,EAChG;AACF;AASO,SAAS,+BAA+B,MAA+B;AAC5E,UAAQ,KAAK,MAAM,GAAG;AAAA,IACpB,KAAK;AACH,aAAO,2BAA2B,IAAsB;AAAA,IAE1D,KAAK;AACH,aAAO,+BAA+B,IAA0B;AAAA,IAElE,KAAK;AACH,aAAO,4BAA4B,IAAuB;AAAA,IAE5D;AACE,aAAO,0BAA0B,IAAI;AAAA,EACzC;AACF;AAeO,SAAS,2BAA2B,MAA2B;AACpE,SAAO;AAAA,IACL,MAAM,KAAK,MAAM;AAAA,IACjB,eAAe,CAAC,KAAK,eAAe,IAAI,KAAK,eAAe,IAAI,IAAI,KAAK,KAAK,eAAe,CAAC;AAAA,IAC9F,QAAQ,KAAK,QAAQ;AAAA,IACrB,kBAAkB,CAAC,KAAK,kBAAkB,IACtC,KAAK,kBAAkB,IACvB,KAAK,kBAAkB,EAAE,IAAI,CAAC,MAAW;AACvC,aAAO;AAAA,IACT,CAAC;AAAA,EACP;AACF;AAYO,SAAS,+BAA+B,MAA+B;AAC5E,SAAO;AAAA,IACL,MAAM,KAAK,MAAM;AAAA,IACjB,eAAe,CAAC,KAAK,eAAe,IAAI,KAAK,eAAe,IAAI,IAAI,KAAK,KAAK,eAAe,CAAC;AAAA,IAC9F,gBAAgB,CAAC,KAAK,gBAAgB,IAClC,KAAK,gBAAgB,IACrB,OAAO;AAAA,MACL,OAAO,QAAQ,KAAK,gBAAgB,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,MAAqB,CAAC,GAAG,CAAC,CAAC;AAAA,IAC9E;AAAA,IACJ,kBAAkB,CAAC,KAAK,kBAAkB,IACtC,KAAK,kBAAkB,IACvB,KAAK,kBAAkB,EAAE,IAAI,CAAC,MAAW;AACvC,aAAO;AAAA,IACT,CAAC;AAAA,EACP;AACF;AAUO,SAAS,4BAA4B,MAA4B;AACtE,SAAO;AAAA,IACL,MAAM,KAAK,MAAM;AAAA,IACjB,eAAe,CAAC,KAAK,eAAe,IAAI,KAAK,eAAe,IAAI,IAAI,KAAK,KAAK,eAAe,CAAC;AAAA,IAC9F,iBAAiB,KAAK,iBAAiB;AAAA,EACzC;AACF;AAEO,SAAS,2BAA2B,QAAiC;AAC1E,SAAO,OAAO,IAAI,CAAC,SAAS;AAC1B,WAAO,sBAAsB,IAAI;AAAA,EACnC,CAAC;AACH;AA0BO,SAAS,sBAAsB,MAAsB;AAC1D,SAAO;AAAA,IACL,SAAS,KAAK,SAAS;AAAA,IACvB,WAAW,KAAK,WAAW;AAAA,IAC3B,eAAe,KAAK,eAAe;AAAA,IACnC,kBAAkB,KAAK,kBAAkB;AAAA,IACzC,MAAM,KAAK,MAAM;AAAA,IACjB,WAAW,CAAC,KAAK,WAAW,IACxB,KAAK,WAAW,IAChB,KAAK,WAAW,EAAE,IAAI,CAAC,MAAW;AAChC,aAAO;AAAA,IACT,CAAC;AAAA,IACL,aAAa,KAAK,aAAa;AAAA,IAC/B,YAAY,CAAC,KAAK,YAAY,IAC1B,KAAK,YAAY,IACjB,OAAO;AAAA,MACL,OAAO,QAAQ,KAAK,YAAY,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,MAAqB,CAAC,GAAG,CAAC,CAAC;AAAA,IAC1E;AAAA,IACJ,eAAe,CAAC,KAAK,eAAe,IAAI,KAAK,eAAe,IAAI,IAAI,KAAK,KAAK,eAAe,CAAC;AAAA,IAC9F,kBAAkB,KAAK,kBAAkB;AAAA,EAC3C;AACF;AAMO,IAAK,gBAAL,kBAAKA,mBAAL;AAEL,EAAAA,eAAA,sBAAmB;AAFT,SAAAA;AAAA,GAAA;AAKL,SAAS,wCAAwC,MAAW;AACjE,SAAO;AAAA,IACL,gBAAgB,KAAK,gBAAgB;AAAA,IACrC,SAAS,KAAK,SAAS;AAAA,IACvB,gBAAgB,CAAC,KAAK,gBAAgB,IAClC,KAAK,gBAAgB,IACrB,IAAI,KAAK,KAAK,gBAAgB,CAAC;AAAA,IACnC,cAAc,CAAC,KAAK,cAAc,IAAI,KAAK,cAAc,IAAI,IAAI,KAAK,KAAK,cAAc,CAAC;AAAA,IAC1F,UAAU,KAAK,UAAU;AAAA,IACzB,MAAM,KAAK,MAAM;AAAA,IACjB,WAAW,KAAK,WAAW;AAAA,IAC3B,eAAe,KAAK,eAAe;AAAA,IACnC,kBAAkB,KAAK,kBAAkB;AAAA,IACzC,aAAa,KAAK,aAAa;AAAA,IAC/B,YAAY,KAAK,YAAY;AAAA,IAC7B,cAAc,KAAK,cAAc;AAAA,EACnC;AACF;",
+  "names": ["KnownVersions"]
+}

package/dist/commonjs/package.json

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

package/dist/commonjs/static-helpers/cloudSettingHelpers.d.ts

@@ -0,0 +1,22 @@
+/**
+ * An enum to describe Azure Cloud environments.
+ * @enum {string}
+ */
+export declare enum AzureClouds {
+    /** Azure public cloud, which is the default cloud for Azure SDKs. */
+    AZURE_PUBLIC_CLOUD = "AZURE_PUBLIC_CLOUD",
+    /** Azure China cloud */
+    AZURE_CHINA_CLOUD = "AZURE_CHINA_CLOUD",
+    /** Azure US government cloud */
+    AZURE_US_GOVERNMENT = "AZURE_US_GOVERNMENT"
+}
+/** The supported values for cloud setting as a string literal type */
+export type AzureSupportedClouds = `${AzureClouds}`;
+/**
+ * Gets the Azure Resource Manager endpoint URL for the specified cloud setting.
+ * @param cloudSetting - The Azure cloud environment setting. Use one of the AzureClouds enum values.
+ * @returns The ARM endpoint URL for the specified cloud, or undefined if cloudSetting is undefined.
+ * @throws {Error} Throws an error if an unknown cloud setting is provided.
+ */
+export declare function getArmEndpoint(cloudSetting?: AzureSupportedClouds): string | undefined;
+//# sourceMappingURL=cloudSettingHelpers.d.ts.map

package/dist/commonjs/static-helpers/cloudSettingHelpers.js

@@ -0,0 +1,52 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var cloudSettingHelpers_exports = {};
+__export(cloudSettingHelpers_exports, {
+  AzureClouds: () => AzureClouds,
+  getArmEndpoint: () => getArmEndpoint
+});
+module.exports = __toCommonJS(cloudSettingHelpers_exports);
+var AzureClouds = /* @__PURE__ */ ((AzureClouds2) => {
+  AzureClouds2["AZURE_PUBLIC_CLOUD"] = "AZURE_PUBLIC_CLOUD";
+  AzureClouds2["AZURE_CHINA_CLOUD"] = "AZURE_CHINA_CLOUD";
+  AzureClouds2["AZURE_US_GOVERNMENT"] = "AZURE_US_GOVERNMENT";
+  return AzureClouds2;
+})(AzureClouds || {});
+function getArmEndpoint(cloudSetting) {
+  if (cloudSetting === void 0) {
+    return void 0;
+  }
+  const cloudEndpoints = {
+    AZURE_CHINA_CLOUD: "https://management.chinacloudapi.cn/",
+    AZURE_US_GOVERNMENT: "https://management.usgovcloudapi.net/",
+    AZURE_PUBLIC_CLOUD: "https://management.azure.com/"
+  };
+  if (cloudSetting in cloudEndpoints) {
+    return cloudEndpoints[cloudSetting];
+  } else {
+    throw new Error(
+      `Unknown cloud setting: ${cloudSetting}. Please refer to the enum AzureClouds for possible values.`
+    );
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AzureClouds,
+  getArmEndpoint
+});
+//# sourceMappingURL=cloudSettingHelpers.js.map

package/dist/commonjs/static-helpers/cloudSettingHelpers.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../../src/static-helpers/cloudSettingHelpers.ts"],
+  "sourcesContent": ["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * An enum to describe Azure Cloud environments.\n * @enum {string}\n */\nexport enum AzureClouds {\n  /** Azure public cloud, which is the default cloud for Azure SDKs. */\n  AZURE_PUBLIC_CLOUD = \"AZURE_PUBLIC_CLOUD\",\n  /** Azure China cloud */\n  AZURE_CHINA_CLOUD = \"AZURE_CHINA_CLOUD\",\n  /** Azure US government cloud */\n  AZURE_US_GOVERNMENT = \"AZURE_US_GOVERNMENT\",\n}\n\n/** The supported values for cloud setting as a string literal type */\nexport type AzureSupportedClouds = `${AzureClouds}`;\n\n/**\n * Gets the Azure Resource Manager endpoint URL for the specified cloud setting.\n * @param cloudSetting - The Azure cloud environment setting. Use one of the AzureClouds enum values.\n * @returns The ARM endpoint URL for the specified cloud, or undefined if cloudSetting is undefined.\n * @throws {Error} Throws an error if an unknown cloud setting is provided.\n */\nexport function getArmEndpoint(cloudSetting?: AzureSupportedClouds): string | undefined {\n  if (cloudSetting === undefined) {\n    return undefined;\n  }\n  const cloudEndpoints: Record<keyof typeof AzureClouds, string> = {\n    AZURE_CHINA_CLOUD: \"https://management.chinacloudapi.cn/\",\n    AZURE_US_GOVERNMENT: \"https://management.usgovcloudapi.net/\",\n    AZURE_PUBLIC_CLOUD: \"https://management.azure.com/\",\n  };\n  if (cloudSetting in cloudEndpoints) {\n    return cloudEndpoints[cloudSetting];\n  } else {\n    throw new Error(\n      `Unknown cloud setting: ${cloudSetting}. Please refer to the enum AzureClouds for possible values.`,\n    );\n  }\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAOO,IAAK,cAAL,kBAAKA,iBAAL;AAEL,EAAAA,aAAA,wBAAqB;AAErB,EAAAA,aAAA,uBAAoB;AAEpB,EAAAA,aAAA,yBAAsB;AANZ,SAAAA;AAAA,GAAA;AAkBL,SAAS,eAAe,cAAyD;AACtF,MAAI,iBAAiB,QAAW;AAC9B,WAAO;AAAA,EACT;AACA,QAAM,iBAA2D;AAAA,IAC/D,mBAAmB;AAAA,IACnB,qBAAqB;AAAA,IACrB,oBAAoB;AAAA,EACtB;AACA,MAAI,gBAAgB,gBAAgB;AAClC,WAAO,eAAe,YAAY;AAAA,EACpC,OAAO;AACL,UAAM,IAAI;AAAA,MACR,0BAA0B,YAAY;AAAA,IACxC;AAAA,EACF;AACF;",
+  "names": ["AzureClouds"]
+}

package/dist/commonjs/static-helpers/pagingHelpers.d.ts

@@ -0,0 +1,74 @@
+import type { Client, PathUncheckedResponse } from "@azure-rest/core-client";
+/**
+ * Options for the byPage method
+ */
+export interface PageSettings {
+    /**
+     * A reference to a specific page to start iterating from.
+     */
+    continuationToken?: string;
+}
+/**
+ * An interface that describes a page of results.
+ */
+export type ContinuablePage<TElement, TPage = TElement[]> = TPage & {
+    /**
+     * 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 extends PageSettings = 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<ContinuablePage<TElement, TPage>>;
+}
+/**
+ * An interface that describes how to communicate with the service.
+ */
+export interface PagedResult<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings> {
+    /**
+     * Link to the first page of results.
+     */
+    firstPageLink?: string;
+    /**
+     * A method that returns a page of results.
+     */
+    getPage: (pageLink?: string) => Promise<{
+        page: TPage;
+        nextPageLink?: string;
+    } | undefined>;
+    /**
+     * a function to implement the `byPage` method on the paged async iterator.
+     */
+    byPage?: (settings?: TPageSettings) => AsyncIterableIterator<ContinuablePage<TElement, TPage>>;
+    /**
+     * A function to extract elements from a page.
+     */
+    toElements?: (page: TPage) => TElement[];
+}
+/**
+ * Options for the paging helper
+ */
+export interface BuildPagedAsyncIteratorOptions {
+    itemName?: string;
+    nextLinkName?: string;
+    nextLinkMethod?: "GET" | "POST";
+    apiVersion?: string;
+}
+/**
+ * Helper to paginate results in a generic way and return a PagedAsyncIterableIterator
+ */
+export declare function buildPagedAsyncIterator<TElement, TPage = TElement[], TPageSettings extends PageSettings = PageSettings, TResponse extends PathUncheckedResponse = PathUncheckedResponse>(client: Client, getInitialResponse: () => PromiseLike<TResponse>, processResponseBody: (result: TResponse) => PromiseLike<unknown>, expectedStatuses: string[], options?: BuildPagedAsyncIteratorOptions): PagedAsyncIterableIterator<TElement, TPage, TPageSettings>;
+//# sourceMappingURL=pagingHelpers.d.ts.map