Add method for getting credit limits

Add get limits method

Author: clostao

packages/auto-drive/src/api/calls/read.ts

@@ -2,6 +2,7 @@ import { ArgsWithoutPagination, ArgsWithPagination } from '../../utils/types'
 import { AutoDriveApi } from '../connection'
 import { PaginatedResult } from '../models/common'
 import { ObjectInformation, ObjectSummary, Scope } from '../models/objects'
+import { UserInfo } from '../models/user'
 
 /**
  * Retrieves the root objects based on the specified scope.
@@ -193,3 +194,21 @@ export const getObjectMetadata = async (
 
   return response.json()
 }
+
+/**
+ * Get upload and download limits of the user
+ *
+ * @param {AutoDriveApi} api - The API instance used to send requests.
+ * @returns {Promise<UserInfo>} - A promise that resolves to the user info.
+ * @throws {Error} - Throws an error if the request fails.
+ */
+export const getMe = async (api: AutoDriveApi): Promise<UserInfo> => {
+  const response = await api.sendRequest('@me', {
+    method: 'GET',
+  })
+  if (!response.ok) {
+    throw new Error(`Failed to get limits: ${response.statusText}`)
+  }
+
+  return response.json()
+}

packages/auto-drive/src/api/models/user.ts

@@ -0,0 +1,31 @@
+export type SubscriptionGranularity = 'monthly'
+
+export type SubscriptionInfo = {
+  id: string
+  organizationId: string
+  uploadLimit: number
+  downloadLimit: number
+  granularity: SubscriptionGranularity
+  pendingUploadCredits: number
+  pendingDownloadCredits: number
+}
+
+export enum UserRole {
+  User = 'User',
+  Admin = 'Admin',
+}
+
+export type User = {
+  oauthProvider: string
+  oauthUserId: string
+  role: UserRole
+  downloadCredits: number
+  uploadCredits: number
+  publicId: string
+  onboarded: true
+}
+
+export type UserInfo = {
+  user: User
+  subscription: SubscriptionInfo
+}

packages/auto-drive/src/api/wrappers.ts

@@ -5,6 +5,7 @@ import { apiCalls } from './calls/index'
 import { AutoDriveApi } from './connection'
 import { GenericFile, GenericFileWithinFolder } from './models/file'
 import { constructFromInput, constructZipBlobFromTreeAndPaths } from './models/folderTree'
+import { SubscriptionInfo } from './models/user'
 
 export type UploadFileOptions = {
   password?: string
@@ -375,3 +376,19 @@ export const downloadFile = async (
 
   return iterable
 }
+
+export const getPendingCredits = async (
+  api: AutoDriveApi,
+): Promise<{ upload: number; download: number }> => {
+  const me = await apiCalls.getMe(api)
+  return {
+    upload: me.subscription.pendingUploadCredits,
+    download: me.subscription.pendingDownloadCredits,
+  }
+}
+
+export const getSubscriptionInfo = async (api: AutoDriveApi): Promise<SubscriptionInfo> => {
+  const me = await apiCalls.getMe(api)
+
+  return me.subscription
+}