@squonk/account-server-client 4.9.0-beta.4 → 4.9.0-beta.6

package/dist/index.js

@@ -19,6 +19,7 @@ import { ProductChargesGetResponseProductType } from "./api/api-schemas/productC
 import { ProductDetailFlavour } from "./api/api-schemas/productDetailFlavour.js";
 import { ProductDetailType } from "./api/api-schemas/productDetailType.js";
 import { ProductTypeServiceKind } from "./api/api-schemas/productTypeServiceKind.js";
+import { QAssetScopeParameter } from "./api/api-schemas/qAssetScopeParameter.js";
 import { QFormatParameter } from "./api/api-schemas/qFormatParameter.js";
 import { QNotificationStateParameter } from "./api/api-schemas/qNotificationStateParameter.js";
 import { UnitAllDetailDefaultProductPrivacy } from "./api/api-schemas/unitAllDetailDefaultProductPrivacy.js";
@@ -27,4 +28,4 @@ import { UnitPatchBodyBodyDefaultProductPrivacy } from "./api/api-schemas/unitPa
 import { UnitProductPostBodyBodyFlavour } from "./api/api-schemas/unitProductPostBodyBodyFlavour.js";
 import { UnitProductPostBodyBodyType } from "./api/api-schemas/unitProductPostBodyBodyType.js";
 import { AXIOS_INSTANCE, customInstance, setAuthToken, setBaseUrl } from "./custom-axios.js";
-export { AXIOS_INSTANCE, AssetDetailScope, AssetPostBodyBodyScope, CapabilityDetailMerchantKind, ChargeSummaryType, EventStreamPostBodyBodyFormat, EventStreamVersionGetResponseProtocol, IncidentDetailScope, MerchantDetailKind, MerchantSummaryKind, NotificationDetailState, OrganisationAllDetailDefaultProductPrivacy, OrganisationDetailDefaultProductPrivacy, OrganisationGetDefaultResponseDefaultProductPrivacy, OrganisationPatchBodyBodyDefaultProductPrivacy, OrganisationPostBodyBodyDefaultProductPrivacy, OrganisationUnitPostBodyBodyDefaultProductPrivacy, ProcessingChargesMerchantKind, ProductChargesGetResponseProductType, ProductDetailFlavour, ProductDetailType, ProductTypeServiceKind, QFormatParameter, QNotificationStateParameter, UnitAllDetailDefaultProductPrivacy, UnitDetailDefaultProductPrivacy, UnitPatchBodyBodyDefaultProductPrivacy, UnitProductPostBodyBodyFlavour, UnitProductPostBodyBodyType, customInstance, setAuthToken, setBaseUrl };
+export { AXIOS_INSTANCE, AssetDetailScope, AssetPostBodyBodyScope, CapabilityDetailMerchantKind, ChargeSummaryType, EventStreamPostBodyBodyFormat, EventStreamVersionGetResponseProtocol, IncidentDetailScope, MerchantDetailKind, MerchantSummaryKind, NotificationDetailState, OrganisationAllDetailDefaultProductPrivacy, OrganisationDetailDefaultProductPrivacy, OrganisationGetDefaultResponseDefaultProductPrivacy, OrganisationPatchBodyBodyDefaultProductPrivacy, OrganisationPostBodyBodyDefaultProductPrivacy, OrganisationUnitPostBodyBodyDefaultProductPrivacy, ProcessingChargesMerchantKind, ProductChargesGetResponseProductType, ProductDetailFlavour, ProductDetailType, ProductTypeServiceKind, QAssetScopeParameter, QFormatParameter, QNotificationStateParameter, UnitAllDetailDefaultProductPrivacy, UnitDetailDefaultProductPrivacy, UnitPatchBodyBodyDefaultProductPrivacy, UnitProductPostBodyBodyFlavour, UnitProductPostBodyBodyType, customInstance, setAuthToken, setBaseUrl };

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "4.9.0-beta.4",
+  "version": "4.9.0-beta.6",
   "author": "Informatics Matters",
   "name": "@squonk/account-server-client",
   "private": false,

package/src/api/api-schemas/getAssetParams.fetch.ts

@@ -8,12 +8,17 @@
  *
  * OpenAPI spec version: 4.9
  */
+import type { QAssetScopeParameter } from "./qAssetScopeParameter.fetch";
 import type { QOrgIdParameter } from "./qOrgIdParameter.fetch";
 import type { QProductIdParameter } from "./qProductIdParameter.fetch";
 import type { QUnitIdParameter } from "./qUnitIdParameter.fetch";
 import type { QUserIdParameter } from "./qUserIdParameter.fetch";
 
 export type GetAssetParams = {
+  /**
+   * An Asset scope. Only an administrator can use `INTERNAL`
+   */
+  scope?: QAssetScopeParameter;
   /**
    * A User Identity
    * @minLength 3

package/src/api/api-schemas/getAssetParams.ts

@@ -8,12 +8,17 @@
  *
  * OpenAPI spec version: 4.9
  */
+import type { QAssetScopeParameter } from "./qAssetScopeParameter";
 import type { QOrgIdParameter } from "./qOrgIdParameter";
 import type { QProductIdParameter } from "./qProductIdParameter";
 import type { QUnitIdParameter } from "./qUnitIdParameter";
 import type { QUserIdParameter } from "./qUserIdParameter";
 
 export type GetAssetParams = {
+  /**
+   * An Asset scope. Only an administrator can use `INTERNAL`
+   */
+  scope?: QAssetScopeParameter;
   /**
    * A User Identity
    * @minLength 3

package/src/api/api-schemas/index.ts

@@ -106,6 +106,7 @@ export * from "./productsGetTypesResponse";
 export * from "./productType";
 export * from "./productTypeServiceKind";
 export * from "./productUnitGetResponse";
+export * from "./qAssetScopeParameter";
 export * from "./qCreatedFromParameter";
 export * from "./qCreatedUntilParameter";
 export * from "./qFormatParameter";

package/src/api/api-schemas/qAssetScopeParameter.fetch.ts

@@ -0,0 +1,21 @@
+/**
+ * Generated by orval v8.22.0 🍺
+ * Do not edit manually.
+ * Account Server API
+ * The Informatics Matters Account Server API.
+ *
+ * A service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
+ *
+ * OpenAPI spec version: 4.9
+ */
+
+export type QAssetScopeParameter = (typeof QAssetScopeParameter)[keyof typeof QAssetScopeParameter];
+
+export const QAssetScopeParameter = {
+  USER: "USER",
+  PRODUCT: "PRODUCT",
+  UNIT: "UNIT",
+  ORGANISATION: "ORGANISATION",
+  GLOBAL: "GLOBAL",
+  INTERNAL: "INTERNAL",
+} as const;

package/src/api/api-schemas/qAssetScopeParameter.ts

@@ -0,0 +1,21 @@
+/**
+ * Generated by orval v8.22.0 🍺
+ * Do not edit manually.
+ * Account Server API
+ * The Informatics Matters Account Server API.
+ *
+ * A service that provides access to the Account Server, which gives *registered* users access to and management of **Organisations**, **Units**, **Products**, **Users**, and **Assets**.
+ *
+ * OpenAPI spec version: 4.9
+ */
+
+export type QAssetScopeParameter = (typeof QAssetScopeParameter)[keyof typeof QAssetScopeParameter];
+
+export const QAssetScopeParameter = {
+  USER: "USER",
+  PRODUCT: "PRODUCT",
+  UNIT: "UNIT",
+  ORGANISATION: "ORGANISATION",
+  GLOBAL: "GLOBAL",
+  INTERNAL: "INTERNAL",
+} as const;

package/src/api/asset/asset.fetch.ts

@@ -92,6 +92,8 @@ export const getGetAssetUrl = (params?: GetAssetParams) => {
 
 /**
  * Gets Assets you have access to.
+ *
+ * You can filter the Assets using one of `user_id`, `product_id`, `unit_id` or `org_id`. You can also filter them by their `scope`. Only an administrator can get `INTERNAL` Assets, and as they do not have a scope ID you cannot combine the `INTERNAL` scope with any of the other filters.
  * @summary Gets Assets
  */
 export const getAsset = async (

package/src/api/asset/asset.ts

@@ -61,6 +61,8 @@ const withQueryKey = <T extends object, K>(query: T, queryKey: K): T & { queryKe
 
 /**
  * Gets Assets you have access to.
+ *
+ * You can filter the Assets using one of `user_id`, `product_id`, `unit_id` or `org_id`. You can also filter them by their `scope`. Only an administrator can get `INTERNAL` Assets, and as they do not have a scope ID you cannot combine the `INTERNAL` scope with any of the other filters.
  * @summary Gets Assets
  */
 export const getAsset = (