@blimu/backend 0.7.0 → 1.1.0

package/src/services/plans.ts

@@ -0,0 +1,57 @@
+import { CoreClient } from '../client';
+import * as Schema from '../schema';
+import type { ResourceType } from '@blimu/types';
+
+export class PlansService {
+  constructor(private core: CoreClient) {}
+
+  /**
+   * DELETE /v1/resources/{resourceType}/{resourceId}/plan*
+   * @summary Remove plan assignment from a tenant resource*
+   * @description Removes the billing plan assignment from a tenant resource. After removal, the resource will have no plan and will be subject to default limits.*/
+  delete(
+    resourceType: ResourceType,
+    resourceId: string,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.PlanDeleteResponse> {
+    return this.core.request({
+      method: 'DELETE',
+      path: `/v1/resources/${encodeURIComponent(resourceType)}/${encodeURIComponent(resourceId)}/plan`,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * GET /v1/resources/{resourceType}/{resourceId}/plan*
+   * @summary Get the plan assigned to a tenant resource*
+   * @description Retrieves the billing plan currently assigned to a tenant resource, if any.*/
+  read(
+    resourceType: ResourceType,
+    resourceId: string,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.PlanResponse> {
+    return this.core.request({
+      method: 'GET',
+      path: `/v1/resources/${encodeURIComponent(resourceType)}/${encodeURIComponent(resourceId)}/plan`,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * POST /v1/resources/{resourceType}/{resourceId}/plan*
+   * @summary Assign a plan to a tenant resource*
+   * @description Assigns a billing plan to a tenant resource. Plans control feature access and usage limits based on your plan definitions. The resource must be marked as a tenant in your resource definitions.*/
+  assign(
+    resourceType: ResourceType,
+    resourceId: string,
+    body: Schema.PlanAssignBody,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<unknown> {
+    return this.core.request({
+      method: 'POST',
+      path: `/v1/resources/${encodeURIComponent(resourceType)}/${encodeURIComponent(resourceId)}/plan`,
+      body: body as any,
+      ...(init || {}),
+    });
+  }
+}

package/src/services/resource_members.ts

@@ -0,0 +1,25 @@
+import { CoreClient } from '../client';
+import * as Schema from '../schema';
+import type { ResourceType } from '@blimu/types';
+
+export class ResourceMembersService {
+  constructor(private core: CoreClient) {}
+
+  /**
+   * GET /v1/resources/{resourceType}/{resourceId}/members*
+   * @summary List members for a resource*
+   * @description Retrieves a paginated list of users who have roles (direct or inherited) on the specified resource. Supports search functionality to filter users by email or name.*/
+  list(
+    resourceType: ResourceType,
+    resourceId: string,
+    query?: Schema.ResourceMembersListQuery,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.ResourceMemberList> {
+    return this.core.request({
+      method: 'GET',
+      path: `/v1/resources/${encodeURIComponent(resourceType)}/${encodeURIComponent(resourceId)}/members`,
+      query,
+      ...(init || {}),
+    });
+  }
+}

package/src/services/resources.ts

@@ -0,0 +1,91 @@
+import { CoreClient } from '../client';
+import * as Schema from '../schema';
+import type { ResourceType } from '@blimu/types';
+
+export class ResourcesService {
+  constructor(private core: CoreClient) {}
+
+  /**
+   * GET /v1/resources/{resourceType}*
+   * @summary List resources*
+   * @description Retrieves a paginated list of resources of the specified type. Supports search and filtering. Resources are returned with their parent relationships and metadata.*/
+  list(
+    resourceType: ResourceType,
+    query?: Schema.ResourcesListQuery,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.ResourceList> {
+    return this.core.request({
+      method: 'GET',
+      path: `/v1/resources/${encodeURIComponent(resourceType)}`,
+      query,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * POST /v1/resources/{resourceType}*
+   * @summary Create a resource*
+   * @description Creates a new resource of the specified type. Resources can have parent relationships to form hierarchies. You can optionally assign initial roles to users when creating the resource. Parent resources must already exist.*/
+  create(
+    resourceType: ResourceType,
+    body: Schema.ResourceCreateBody,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.Resource> {
+    return this.core.request({
+      method: 'POST',
+      path: `/v1/resources/${encodeURIComponent(resourceType)}`,
+      body: body as any,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * DELETE /v1/resources/{resourceType}/{resourceId}*
+   * @summary Delete a resource*
+   * @description Deletes a resource by its type and ID. This operation is permanent and cannot be undone. Deleting a resource may affect child resources that depend on it.*/
+  delete(
+    resourceType: ResourceType,
+    resourceId: string,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<unknown> {
+    return this.core.request({
+      method: 'DELETE',
+      path: `/v1/resources/${encodeURIComponent(resourceType)}/${encodeURIComponent(resourceId)}`,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * GET /v1/resources/{resourceType}/{resourceId}*
+   * @summary Read a resource*
+   * @description Retrieves a single resource by its type and ID. Returns the resource with its parent relationships and metadata.*/
+  read(
+    resourceType: ResourceType,
+    resourceId: string,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.Resource> {
+    return this.core.request({
+      method: 'GET',
+      path: `/v1/resources/${encodeURIComponent(resourceType)}/${encodeURIComponent(resourceId)}`,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * PUT /v1/resources/{resourceType}/{resourceId}*
+   * @summary Update a resource*
+   * @description Updates an existing resource. You can update the resource name and modify parent relationships. Parent resources must already exist.*/
+  update(
+    resourceType: ResourceType,
+    resourceId: string,
+    body: Schema.ResourceUpdateBody,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<unknown> {
+    return this.core.request({
+      method: 'PUT',
+      path: `/v1/resources/${encodeURIComponent(resourceType)}/${encodeURIComponent(resourceId)}`,
+      body: body as any,
+      ...(init || {}),
+    });
+  }
+}

package/src/services/roles.ts

@@ -0,0 +1,58 @@
+import { CoreClient } from '../client';
+import * as Schema from '../schema';
+import type { ResourceType } from '@blimu/types';
+
+export class RolesService {
+  constructor(private core: CoreClient) {}
+
+  /**
+   * GET /v1/users/{userId}/roles*
+   * @summary List user roles*
+   * @description Retrieves a paginated list of roles assigned to a user. Supports filtering by resource type, resource ID, and role name. Returns both directly assigned roles and inherited roles.*/
+  list(
+    userId: string,
+    query?: Schema.RolesListQuery,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.RoleList> {
+    return this.core.request({
+      method: 'GET',
+      path: `/v1/users/${encodeURIComponent(userId)}/roles`,
+      query,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * POST /v1/users/{userId}/roles*
+   * @summary Create a role (assign role to user on resource)*
+   * @description Assigns a role to a user on a specific resource. The role must be defined in your resource definitions for the specified resource type. Roles can be inherited from parent resources based on your resource configuration.*/
+  create(
+    userId: string,
+    body: Schema.RoleCreateBody,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.Role> {
+    return this.core.request({
+      method: 'POST',
+      path: `/v1/users/${encodeURIComponent(userId)}/roles`,
+      body: body as any,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * DELETE /v1/users/{userId}/roles/{resourceType}/{resourceId}*
+   * @summary Delete a role*
+   * @description Removes a role assignment from a user on a specific resource. This only removes the direct role assignment and does not affect inherited roles from parent resources.*/
+  delete(
+    userId: string,
+    resourceType: ResourceType,
+    resourceId: string,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<unknown> {
+    return this.core.request({
+      method: 'DELETE',
+      path: `/v1/users/${encodeURIComponent(userId)}/roles/${encodeURIComponent(resourceType)}/${encodeURIComponent(resourceId)}`,
+      ...(init || {}),
+    });
+  }
+}

package/src/services/usage.ts

@@ -0,0 +1,93 @@
+import { CoreClient } from '../client';
+import * as Schema from '../schema';
+import type { ResourceType, UsageLimitType } from '@blimu/types';
+
+export class UsageService {
+  constructor(private core: CoreClient) {}
+
+  /**
+   * GET /v1/usage/balance/{resourceType}/{resourceId}/{limitType}*
+   * @summary Get wallet balance*
+   * @description Retrieves the current balance of a usage wallet for a specific resource and limit type within a given time period. The balance reflects all credits and consumption transactions.*/
+  getBalance(
+    resourceType: ResourceType,
+    resourceId: string,
+    limitType: UsageLimitType,
+    query?: Schema.UsageGetBalanceQuery,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.BalanceResponse> {
+    return this.core.request({
+      method: 'GET',
+      path: `/v1/usage/balance/${encodeURIComponent(resourceType)}/${encodeURIComponent(resourceId)}/${encodeURIComponent(limitType)}`,
+      query,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * POST /v1/usage/check*
+   * @summary Check if consumption is allowed*
+   * @description Checks whether a specific amount of consumption is allowed for a resource and limit type within a given time period. Returns the current balance, requested amount, and remaining balance after the consumption.*/
+  checkLimit(
+    body: Schema.UsageCheckBody,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.CheckLimitResponse> {
+    return this.core.request({
+      method: 'POST',
+      path: `/v1/usage/check`,
+      body: body as any,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * POST /v1/usage/consume*
+   * @summary Record consumption (inserts negative amount)*
+   * @description Records consumption from a usage wallet for a specific resource and limit type. This decreases the available balance. Consumption can be tagged for tracking purposes.*/
+  consume(
+    body: Schema.UsageConsumeBody,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.UsageWalletResponse> {
+    return this.core.request({
+      method: 'POST',
+      path: `/v1/usage/consume`,
+      body: body as any,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * POST /v1/usage/credit*
+   * @summary Add credits to wallet (inserts positive amount)*
+   * @description Adds credits to a usage wallet for a specific resource and limit type. This increases the available balance for usage-based limits. Credits can be tagged for tracking purposes.*/
+  credit(
+    body: Schema.UsageCreditBody,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.UsageWalletResponse> {
+    return this.core.request({
+      method: 'POST',
+      path: `/v1/usage/credit`,
+      body: body as any,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * GET /v1/usage/transactions/{resourceType}/{resourceId}/{limitType}*
+   * @summary Get transaction history*
+   * @description Retrieves the transaction history for a usage wallet, including all credits and consumption records. Supports filtering by time period and date range.*/
+  getTransactionHistory(
+    resourceType: ResourceType,
+    resourceId: string,
+    limitType: UsageLimitType,
+    query?: Schema.UsageGetTransactionHistoryQuery,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.TransactionHistoryResponse> {
+    return this.core.request({
+      method: 'GET',
+      path: `/v1/usage/transactions/${encodeURIComponent(resourceType)}/${encodeURIComponent(resourceId)}/${encodeURIComponent(limitType)}`,
+      query,
+      ...(init || {}),
+    });
+  }
+}

package/src/services/users.ts

@@ -0,0 +1,100 @@
+import { CoreClient } from '../client';
+import * as Schema from '../schema';
+
+export class UsersService {
+  constructor(private core: CoreClient) {}
+
+  /**
+   * GET /v1/users*
+   * @summary List users*
+   * @description Retrieves a paginated list of users in your environment. Supports search functionality to filter users by email, name, or lookup key.*/
+  list(
+    query?: Schema.UsersListQuery,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.UserList> {
+    return this.core.request({
+      method: 'GET',
+      path: `/v1/users`,
+      query,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * POST /v1/users*
+   * @summary Create a user*
+   * @description Creates a new user in your environment. The lookupKey is a unique identifier that you can use to reference the user in your system. It should be stable and not change over time.*/
+  create(
+    body: Schema.UserCreateBody,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.User> {
+    return this.core.request({
+      method: 'POST',
+      path: `/v1/users`,
+      body: body as any,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * DELETE /v1/users/{userId}*
+   * @summary Delete a user*
+   * @description Deletes a user by their ID or lookup key. This operation is permanent and cannot be undone. Deleting a user will also remove all role assignments for that user.*/
+  delete(
+    userId: string,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<unknown> {
+    return this.core.request({
+      method: 'DELETE',
+      path: `/v1/users/${encodeURIComponent(userId)}`,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * GET /v1/users/{userId}*
+   * @summary Get a user by ID*
+   * @description Retrieves a single user by their ID or lookup key. Returns user information including email, name, and metadata.*/
+  read(
+    userId: string,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.User> {
+    return this.core.request({
+      method: 'GET',
+      path: `/v1/users/${encodeURIComponent(userId)}`,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * PUT /v1/users/{userId}*
+   * @summary Update a user*
+   * @description Updates an existing user. You can modify email, name, and other user properties. The lookupKey can be updated but should remain stable.*/
+  update(
+    userId: string,
+    body: Schema.UserUpdateBody,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.User> {
+    return this.core.request({
+      method: 'PUT',
+      path: `/v1/users/${encodeURIComponent(userId)}`,
+      body: body as any,
+      ...(init || {}),
+    });
+  }
+
+  /**
+   * GET /v1/users/{userId}/effective-user-resources-roles*
+   * @summary List effective user resources roles*
+   * @description Retrieves all resources and roles for a user, including inherited roles from parent resources. The response indicates whether each role is directly assigned or inherited through resource hierarchies.*/
+  listEffectiveUserResourcesRoles(
+    userId: string,
+    init?: Omit<RequestInit, 'method' | 'body'>
+  ): Promise<Schema.UserResourceList> {
+    return this.core.request({
+      method: 'GET',
+      path: `/v1/users/${encodeURIComponent(userId)}/effective-user-resources-roles`,
+      ...(init || {}),
+    });
+  }
+}