@juhuu/sdk-ts 1.2.143 → 1.2.145

package/dist/index.d.mts

@@ -12,6 +12,8 @@ type ExtractType<T> = T extends {
 } ? U : never;
 type UserGroup = "retailer" | "engineer" | "operator" | "user";
 type Frontend = "dashboard" | "app";
+type ApiKeyStatus = "enabled" | "disabled";
+type ApiKeyScope = "device:parameter:update";
 type Capability = {
     type: "predictiveMaintenance";
     stripePriceId: string | null;
@@ -846,6 +848,14 @@ declare class DeviceParameterHistoriesService extends Service {
     retrieve(DeviceParameterHistoryRetrieveParams: JUHUU.DeviceParameterHistory.Retrieve.Params, DeviceParameterHistoryRetrieveOptions?: JUHUU.DeviceParameterHistory.Retrieve.Options): Promise<JUHUU.HttpResponse<JUHUU.DeviceParameterHistory.Retrieve.Response>>;
 }
 
+declare class ApiKeysService extends Service {
+    constructor(config: JUHUU.SetupConfig);
+    create(ApiKeyCreateParams: JUHUU.ApiKey.Create.Params, ApiKeyCreateOptions?: JUHUU.ApiKey.Create.Options): Promise<JUHUU.HttpResponse<JUHUU.ApiKey.Create.Response>>;
+    list(ApiKeyListParams: JUHUU.ApiKey.List.Params, ApiKeyListOptions?: JUHUU.ApiKey.List.Options): Promise<JUHUU.HttpResponse<JUHUU.ApiKey.List.Response>>;
+    retrieve(ApiKeyRetrieveParams: JUHUU.ApiKey.Retrieve.Params, ApiKeyRetrieveOptions?: JUHUU.ApiKey.Retrieve.Options): Promise<JUHUU.HttpResponse<JUHUU.ApiKey.Retrieve.Response>>;
+    update(ApiKeyUpdateParams: JUHUU.ApiKey.Update.Params, ApiKeyUpdateOptions?: JUHUU.ApiKey.Update.Options): Promise<JUHUU.HttpResponse<JUHUU.ApiKey.Update.Response>>;
+}
+
 declare class Juhuu {
     constructor(config: JUHUU.SetupConfig);
     /**
@@ -879,6 +889,7 @@ declare class Juhuu {
     readonly tapkey: TapkeyService;
     readonly articleGroups: ArticleGroupGroupsService;
     readonly deviceParameterHistories: DeviceParameterHistoriesService;
+    readonly apiKeys: ApiKeysService;
 }
 declare namespace JUHUU {
     interface SetupConfig {
@@ -892,12 +903,12 @@ declare namespace JUHUU {
     }
     interface HttpResponse<T> {
         ok: boolean;
-        data: (T & {
+        data: T & {
             /**
              * Might be defined if the request failed
              */
             message?: string | LocaleString;
-        }) | null;
+        };
         statusText?: string;
         status?: number;
     }
@@ -1462,6 +1473,66 @@ declare namespace JUHUU {
             type Response = JUHUU.AccountingArea.Object;
         }
     }
+    namespace ApiKey {
+        type Object = {
+            id: string;
+            readonly object: "apiKey";
+            name: string;
+            status: ApiKeyStatus;
+            scopeArray: ApiKeyScope[];
+            propertyId: string;
+            expiresAt: Date | null;
+            createdAt: Date;
+            hash: string;
+        };
+        namespace Create {
+            type Params = {
+                propertyId: string;
+            };
+            type Options = JUHUU.RequestOptions;
+            type Response = {
+                apiKey: JUHUU.ApiKey.Object;
+                clearText: string;
+            };
+        }
+        namespace Retrieve {
+            type Params = {
+                apiKeyId: string;
+            };
+            type Options = {
+                expand?: Array<"property">;
+            } & JUHUU.RequestOptions;
+            type Response = {
+                apiKey: JUHUU.ApiKey.Object;
+                property?: JUHUU.Property.Object;
+            };
+        }
+        namespace List {
+            type Params = {
+                propertyId?: string;
+                statusArray?: JUHUU.Article.Object["status"][];
+            };
+            type Options = {
+                limit?: number;
+                skip?: number;
+            } & JUHUU.RequestOptions;
+            type Response = {
+                apiKeyArray: JUHUU.ApiKey.Object[];
+                count: number;
+                hasMore: boolean;
+            };
+        }
+        namespace Update {
+            type Params = {
+                apiKeyId: string;
+                status?: ApiKeyStatus;
+            };
+            type Options = JUHUU.RequestOptions;
+            type Response = {
+                apiKey: JUHUU.ApiKey.Object;
+            };
+        }
+    }
     namespace ArticleEmbedding {
         type Object = {
             id: string;
@@ -3317,4 +3388,4 @@ declare namespace JUHUU {
     }
 }
 
-export { type AccessControlListElement, type Address, type AutoRenewMode, type BusinessType, type Capability, type Category, type Circumstance, type Color, type ColorScheme, type Command, type Condition, ConditionType, type CountryCode, CountryCodeArray, type CurrencyCode, CurrencyCodeArray, type CustomClaims, type DeepNullable, type DevicePermission, type DeviceStatus, type DeviceType, type Environment, type EnvironmentSettings, type ExtractType, type Frontend, type FuelType, type GeneralSettings, type GeoPoint, type GraphNode, JUHUU, Juhuu, type LanguageCode, LanguageCodeArray, Layout, type LayoutBlock, type LicenseTariffIdMap, type LinkType, type LocaleString, type MapFilter, type Modality, type Offer, type OfferTime, type Parameter, type Party, type PaymentMethod, type PaymentReason, type PaymentRefundReason, type PaymentRefundStatus, type PaymentServiceProvider, type PaymentStatus, type PayoutSettings, type PayoutStatus, type PermissionTypes, type Person, type Platform, type PlatformString, type PostingRow, type Purpose, type PushToken, ReadonlyCategoryArray, ReadonlyModalityArray, ReadonlySectorArray, type RefundStatus, type Sector, type SessionCannotTerminateReason, type SessionSettings, type SessionStatus, type SessionTerminatedByType, type SessionType, Settings, type SimStatus, type StarRating, type TarifType, type TimeZone, type Unit, type UserGroup, type UserType, type Utilization, type VeloBrushDeviceDocumentUserManualStep, type Viewport, type ViewportPolygon, type VisualPriority, type hexColor };
+export { type AccessControlListElement, type Address, type ApiKeyScope, type ApiKeyStatus, type AutoRenewMode, type BusinessType, type Capability, type Category, type Circumstance, type Color, type ColorScheme, type Command, type Condition, ConditionType, type CountryCode, CountryCodeArray, type CurrencyCode, CurrencyCodeArray, type CustomClaims, type DeepNullable, type DevicePermission, type DeviceStatus, type DeviceType, type Environment, type EnvironmentSettings, type ExtractType, type Frontend, type FuelType, type GeneralSettings, type GeoPoint, type GraphNode, JUHUU, Juhuu, type LanguageCode, LanguageCodeArray, Layout, type LayoutBlock, type LicenseTariffIdMap, type LinkType, type LocaleString, type MapFilter, type Modality, type Offer, type OfferTime, type Parameter, type Party, type PaymentMethod, type PaymentReason, type PaymentRefundReason, type PaymentRefundStatus, type PaymentServiceProvider, type PaymentStatus, type PayoutSettings, type PayoutStatus, type PermissionTypes, type Person, type Platform, type PlatformString, type PostingRow, type Purpose, type PushToken, ReadonlyCategoryArray, ReadonlyModalityArray, ReadonlySectorArray, type RefundStatus, type Sector, type SessionCannotTerminateReason, type SessionSettings, type SessionStatus, type SessionTerminatedByType, type SessionType, Settings, type SimStatus, type StarRating, type TarifType, type TimeZone, type Unit, type UserGroup, type UserType, type Utilization, type VeloBrushDeviceDocumentUserManualStep, type Viewport, type ViewportPolygon, type VisualPriority, type hexColor };

package/dist/index.d.ts

@@ -12,6 +12,8 @@ type ExtractType<T> = T extends {
 } ? U : never;
 type UserGroup = "retailer" | "engineer" | "operator" | "user";
 type Frontend = "dashboard" | "app";
+type ApiKeyStatus = "enabled" | "disabled";
+type ApiKeyScope = "device:parameter:update";
 type Capability = {
     type: "predictiveMaintenance";
     stripePriceId: string | null;
@@ -846,6 +848,14 @@ declare class DeviceParameterHistoriesService extends Service {
     retrieve(DeviceParameterHistoryRetrieveParams: JUHUU.DeviceParameterHistory.Retrieve.Params, DeviceParameterHistoryRetrieveOptions?: JUHUU.DeviceParameterHistory.Retrieve.Options): Promise<JUHUU.HttpResponse<JUHUU.DeviceParameterHistory.Retrieve.Response>>;
 }
 
+declare class ApiKeysService extends Service {
+    constructor(config: JUHUU.SetupConfig);
+    create(ApiKeyCreateParams: JUHUU.ApiKey.Create.Params, ApiKeyCreateOptions?: JUHUU.ApiKey.Create.Options): Promise<JUHUU.HttpResponse<JUHUU.ApiKey.Create.Response>>;
+    list(ApiKeyListParams: JUHUU.ApiKey.List.Params, ApiKeyListOptions?: JUHUU.ApiKey.List.Options): Promise<JUHUU.HttpResponse<JUHUU.ApiKey.List.Response>>;
+    retrieve(ApiKeyRetrieveParams: JUHUU.ApiKey.Retrieve.Params, ApiKeyRetrieveOptions?: JUHUU.ApiKey.Retrieve.Options): Promise<JUHUU.HttpResponse<JUHUU.ApiKey.Retrieve.Response>>;
+    update(ApiKeyUpdateParams: JUHUU.ApiKey.Update.Params, ApiKeyUpdateOptions?: JUHUU.ApiKey.Update.Options): Promise<JUHUU.HttpResponse<JUHUU.ApiKey.Update.Response>>;
+}
+
 declare class Juhuu {
     constructor(config: JUHUU.SetupConfig);
     /**
@@ -879,6 +889,7 @@ declare class Juhuu {
     readonly tapkey: TapkeyService;
     readonly articleGroups: ArticleGroupGroupsService;
     readonly deviceParameterHistories: DeviceParameterHistoriesService;
+    readonly apiKeys: ApiKeysService;
 }
 declare namespace JUHUU {
     interface SetupConfig {
@@ -892,12 +903,12 @@ declare namespace JUHUU {
     }
     interface HttpResponse<T> {
         ok: boolean;
-        data: (T & {
+        data: T & {
             /**
              * Might be defined if the request failed
              */
             message?: string | LocaleString;
-        }) | null;
+        };
         statusText?: string;
         status?: number;
     }
@@ -1462,6 +1473,66 @@ declare namespace JUHUU {
             type Response = JUHUU.AccountingArea.Object;
         }
     }
+    namespace ApiKey {
+        type Object = {
+            id: string;
+            readonly object: "apiKey";
+            name: string;
+            status: ApiKeyStatus;
+            scopeArray: ApiKeyScope[];
+            propertyId: string;
+            expiresAt: Date | null;
+            createdAt: Date;
+            hash: string;
+        };
+        namespace Create {
+            type Params = {
+                propertyId: string;
+            };
+            type Options = JUHUU.RequestOptions;
+            type Response = {
+                apiKey: JUHUU.ApiKey.Object;
+                clearText: string;
+            };
+        }
+        namespace Retrieve {
+            type Params = {
+                apiKeyId: string;
+            };
+            type Options = {
+                expand?: Array<"property">;
+            } & JUHUU.RequestOptions;
+            type Response = {
+                apiKey: JUHUU.ApiKey.Object;
+                property?: JUHUU.Property.Object;
+            };
+        }
+        namespace List {
+            type Params = {
+                propertyId?: string;
+                statusArray?: JUHUU.Article.Object["status"][];
+            };
+            type Options = {
+                limit?: number;
+                skip?: number;
+            } & JUHUU.RequestOptions;
+            type Response = {
+                apiKeyArray: JUHUU.ApiKey.Object[];
+                count: number;
+                hasMore: boolean;
+            };
+        }
+        namespace Update {
+            type Params = {
+                apiKeyId: string;
+                status?: ApiKeyStatus;
+            };
+            type Options = JUHUU.RequestOptions;
+            type Response = {
+                apiKey: JUHUU.ApiKey.Object;
+            };
+        }
+    }
     namespace ArticleEmbedding {
         type Object = {
             id: string;
@@ -3317,4 +3388,4 @@ declare namespace JUHUU {
     }
 }
 
-export { type AccessControlListElement, type Address, type AutoRenewMode, type BusinessType, type Capability, type Category, type Circumstance, type Color, type ColorScheme, type Command, type Condition, ConditionType, type CountryCode, CountryCodeArray, type CurrencyCode, CurrencyCodeArray, type CustomClaims, type DeepNullable, type DevicePermission, type DeviceStatus, type DeviceType, type Environment, type EnvironmentSettings, type ExtractType, type Frontend, type FuelType, type GeneralSettings, type GeoPoint, type GraphNode, JUHUU, Juhuu, type LanguageCode, LanguageCodeArray, Layout, type LayoutBlock, type LicenseTariffIdMap, type LinkType, type LocaleString, type MapFilter, type Modality, type Offer, type OfferTime, type Parameter, type Party, type PaymentMethod, type PaymentReason, type PaymentRefundReason, type PaymentRefundStatus, type PaymentServiceProvider, type PaymentStatus, type PayoutSettings, type PayoutStatus, type PermissionTypes, type Person, type Platform, type PlatformString, type PostingRow, type Purpose, type PushToken, ReadonlyCategoryArray, ReadonlyModalityArray, ReadonlySectorArray, type RefundStatus, type Sector, type SessionCannotTerminateReason, type SessionSettings, type SessionStatus, type SessionTerminatedByType, type SessionType, Settings, type SimStatus, type StarRating, type TarifType, type TimeZone, type Unit, type UserGroup, type UserType, type Utilization, type VeloBrushDeviceDocumentUserManualStep, type Viewport, type ViewportPolygon, type VisualPriority, type hexColor };
+export { type AccessControlListElement, type Address, type ApiKeyScope, type ApiKeyStatus, type AutoRenewMode, type BusinessType, type Capability, type Category, type Circumstance, type Color, type ColorScheme, type Command, type Condition, ConditionType, type CountryCode, CountryCodeArray, type CurrencyCode, CurrencyCodeArray, type CustomClaims, type DeepNullable, type DevicePermission, type DeviceStatus, type DeviceType, type Environment, type EnvironmentSettings, type ExtractType, type Frontend, type FuelType, type GeneralSettings, type GeoPoint, type GraphNode, JUHUU, Juhuu, type LanguageCode, LanguageCodeArray, Layout, type LayoutBlock, type LicenseTariffIdMap, type LinkType, type LocaleString, type MapFilter, type Modality, type Offer, type OfferTime, type Parameter, type Party, type PaymentMethod, type PaymentReason, type PaymentRefundReason, type PaymentRefundStatus, type PaymentServiceProvider, type PaymentStatus, type PayoutSettings, type PayoutStatus, type PermissionTypes, type Person, type Platform, type PlatformString, type PostingRow, type Purpose, type PushToken, ReadonlyCategoryArray, ReadonlyModalityArray, ReadonlySectorArray, type RefundStatus, type Sector, type SessionCannotTerminateReason, type SessionSettings, type SessionStatus, type SessionTerminatedByType, type SessionType, Settings, type SimStatus, type StarRating, type TarifType, type TimeZone, type Unit, type UserGroup, type UserType, type Utilization, type VeloBrushDeviceDocumentUserManualStep, type Viewport, type ViewportPolygon, type VisualPriority, type hexColor };

package/dist/index.js

@@ -101,7 +101,7 @@ var Service = class {
       );
       return {
         ok: false,
-        data: null
+        data: {}
       };
     }
     const uri = this.httpBaseUrl + url;
@@ -2749,6 +2749,78 @@ var DeviceParameterHistoriesService = class extends Service {
   }
 };
 
+// src/apiKeys/apiKeys.service.ts
+var ApiKeysService = class extends Service {
+  constructor(config) {
+    super(config);
+  }
+  async create(ApiKeyCreateParams, ApiKeyCreateOptions) {
+    return await super.sendRequest(
+      {
+        method: "POST",
+        url: "apiKeys",
+        body: {
+          propertyId: ApiKeyCreateParams.propertyId
+        },
+        authenticationNotOptional: true
+      },
+      ApiKeyCreateOptions
+    );
+  }
+  async list(ApiKeyListParams, ApiKeyListOptions) {
+    const queryArray = [];
+    if (ApiKeyListOptions?.limit !== void 0) {
+      queryArray.push("limit=" + ApiKeyListOptions.limit);
+    }
+    if (ApiKeyListParams?.propertyId !== void 0) {
+      queryArray.push("propertyId=" + ApiKeyListParams.propertyId);
+    }
+    if (ApiKeyListParams?.statusArray !== void 0) {
+      queryArray.push("statusArray=" + ApiKeyListParams.statusArray.join(","));
+    }
+    if (ApiKeyListOptions?.skip !== void 0) {
+      queryArray.push("skip=" + ApiKeyListOptions.skip);
+    }
+    return await super.sendRequest(
+      {
+        method: "GET",
+        url: "apiKeys?" + queryArray.join("&"),
+        body: void 0,
+        authenticationNotOptional: false
+      },
+      ApiKeyListOptions
+    );
+  }
+  async retrieve(ApiKeyRetrieveParams, ApiKeyRetrieveOptions) {
+    const queryArray = [];
+    if (ApiKeyRetrieveOptions?.expand !== void 0) {
+      queryArray.push("expand=" + ApiKeyRetrieveOptions.expand.join(","));
+    }
+    return await super.sendRequest(
+      {
+        method: "GET",
+        url: "apiKeys/" + ApiKeyRetrieveParams.apiKeyId + "?" + queryArray.join("&"),
+        body: void 0,
+        authenticationNotOptional: false
+      },
+      ApiKeyRetrieveOptions
+    );
+  }
+  async update(ApiKeyUpdateParams, ApiKeyUpdateOptions) {
+    return await super.sendRequest(
+      {
+        method: "PATCH",
+        url: "apiKeys/" + ApiKeyUpdateParams.apiKeyId,
+        body: {
+          status: ApiKeyUpdateParams.status
+        },
+        authenticationNotOptional: true
+      },
+      ApiKeyUpdateOptions
+    );
+  }
+};
+
 // src/types/types.ts
 var LanguageCodeArray = [
   "en",
@@ -2926,6 +2998,7 @@ var Juhuu = class {
     this.tapkey = new TapkeyService(config);
     this.articleGroups = new ArticleGroupGroupsService(config);
     this.deviceParameterHistories = new DeviceParameterHistoriesService(config);
+    this.apiKeys = new ApiKeysService(config);
   }
   /**
    * Top Level Resources
@@ -2958,6 +3031,7 @@ var Juhuu = class {
   tapkey;
   articleGroups;
   deviceParameterHistories;
+  apiKeys;
 };
 var JUHUU;
 ((JUHUU2) => {

package/dist/index.mjs

@@ -57,7 +57,7 @@ var Service = class {
       );
       return {
         ok: false,
-        data: null
+        data: {}
       };
     }
     const uri = this.httpBaseUrl + url;
@@ -2705,6 +2705,78 @@ var DeviceParameterHistoriesService = class extends Service {
   }
 };
 
+// src/apiKeys/apiKeys.service.ts
+var ApiKeysService = class extends Service {
+  constructor(config) {
+    super(config);
+  }
+  async create(ApiKeyCreateParams, ApiKeyCreateOptions) {
+    return await super.sendRequest(
+      {
+        method: "POST",
+        url: "apiKeys",
+        body: {
+          propertyId: ApiKeyCreateParams.propertyId
+        },
+        authenticationNotOptional: true
+      },
+      ApiKeyCreateOptions
+    );
+  }
+  async list(ApiKeyListParams, ApiKeyListOptions) {
+    const queryArray = [];
+    if (ApiKeyListOptions?.limit !== void 0) {
+      queryArray.push("limit=" + ApiKeyListOptions.limit);
+    }
+    if (ApiKeyListParams?.propertyId !== void 0) {
+      queryArray.push("propertyId=" + ApiKeyListParams.propertyId);
+    }
+    if (ApiKeyListParams?.statusArray !== void 0) {
+      queryArray.push("statusArray=" + ApiKeyListParams.statusArray.join(","));
+    }
+    if (ApiKeyListOptions?.skip !== void 0) {
+      queryArray.push("skip=" + ApiKeyListOptions.skip);
+    }
+    return await super.sendRequest(
+      {
+        method: "GET",
+        url: "apiKeys?" + queryArray.join("&"),
+        body: void 0,
+        authenticationNotOptional: false
+      },
+      ApiKeyListOptions
+    );
+  }
+  async retrieve(ApiKeyRetrieveParams, ApiKeyRetrieveOptions) {
+    const queryArray = [];
+    if (ApiKeyRetrieveOptions?.expand !== void 0) {
+      queryArray.push("expand=" + ApiKeyRetrieveOptions.expand.join(","));
+    }
+    return await super.sendRequest(
+      {
+        method: "GET",
+        url: "apiKeys/" + ApiKeyRetrieveParams.apiKeyId + "?" + queryArray.join("&"),
+        body: void 0,
+        authenticationNotOptional: false
+      },
+      ApiKeyRetrieveOptions
+    );
+  }
+  async update(ApiKeyUpdateParams, ApiKeyUpdateOptions) {
+    return await super.sendRequest(
+      {
+        method: "PATCH",
+        url: "apiKeys/" + ApiKeyUpdateParams.apiKeyId,
+        body: {
+          status: ApiKeyUpdateParams.status
+        },
+        authenticationNotOptional: true
+      },
+      ApiKeyUpdateOptions
+    );
+  }
+};
+
 // src/types/types.ts
 var LanguageCodeArray = [
   "en",
@@ -2882,6 +2954,7 @@ var Juhuu = class {
     this.tapkey = new TapkeyService(config);
     this.articleGroups = new ArticleGroupGroupsService(config);
     this.deviceParameterHistories = new DeviceParameterHistoriesService(config);
+    this.apiKeys = new ApiKeysService(config);
   }
   /**
    * Top Level Resources
@@ -2914,6 +2987,7 @@ var Juhuu = class {
   tapkey;
   articleGroups;
   deviceParameterHistories;
+  apiKeys;
 };
 var JUHUU;
 ((JUHUU2) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@juhuu/sdk-ts",
-  "version": "1.2.143",
+  "version": "1.2.145",
   "description": "Typescript wrapper for JUHUU services",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",