@envsync-cloud/envsync-ts-sdk 0.1.2 → 0.2.2

package/dist/index.d.mts

@@ -74,20 +74,12 @@ declare class AccessService {
     readonly httpRequest: BaseHttpRequest;
     constructor(httpRequest: BaseHttpRequest);
     /**
-     * Create CLI Login URL
+     * Initiate CLI Login
      * Generate authentication URL for CLI login
-     * @returns LoginUrlResponse CLI login URL created successfully
+     * @returns LoginUrlResponse CLI login initiated successfully.
      * @throws ApiError
      */
     createCliLogin(): CancelablePromise<LoginUrlResponse>;
-    /**
-     * CLI Login Callback
-     * Handle CLI login callback from Auth0
-     * @param code
-     * @returns void
-     * @throws ApiError
-     */
-    callbackCliLogin(code: string): CancelablePromise<void>;
     /**
      * Create Web Login URL
      * Generate authentication URL for web login
@@ -120,6 +112,89 @@ declare class AccessService {
     callbackApiLogin(code: string): CancelablePromise<CallbackResponse>;
 }
 
+type ApiKeyResponse = {
+    id: string;
+    user_id: string;
+    org_id: string;
+    description: string;
+    is_active: boolean;
+    key: string;
+    created_at: string;
+    updated_at: string;
+    last_used_at: string | null;
+};
+
+type ApiKeysResponse = Array<ApiKeyResponse>;
+
+type CreateApiKeyRequest = {
+    name: string;
+    description?: string;
+};
+
+type RegenerateApiKeyResponse = {
+    newKey: string;
+    id: string;
+};
+
+type UpdateApiKeyRequest = {
+    description?: string;
+    is_active?: boolean;
+    last_used_at?: string;
+};
+
+declare class ApiKeysService {
+    readonly httpRequest: BaseHttpRequest;
+    constructor(httpRequest: BaseHttpRequest);
+    /**
+     * Create API Key
+     * Create a new API key for the organization
+     * @param requestBody
+     * @returns ApiKeyResponse API key created successfully
+     * @throws ApiError
+     */
+    createApiKey(requestBody?: CreateApiKeyRequest): CancelablePromise<ApiKeyResponse>;
+    /**
+     * Get All API Keys
+     * Retrieve all API keys for the organization
+     * @returns ApiKeysResponse API keys retrieved successfully
+     * @throws ApiError
+     */
+    getAllApiKeys(): CancelablePromise<ApiKeysResponse>;
+    /**
+     * Get API Key
+     * Retrieve a specific API key
+     * @param id
+     * @returns ApiKeyResponse API key retrieved successfully
+     * @throws ApiError
+     */
+    getApiKey(id: string): CancelablePromise<ApiKeyResponse>;
+    /**
+     * Update API Key
+     * Update an existing API key
+     * @param id
+     * @param requestBody
+     * @returns ApiKeyResponse API key updated successfully
+     * @throws ApiError
+     */
+    updateApiKey(id: string, requestBody?: UpdateApiKeyRequest): CancelablePromise<ApiKeyResponse>;
+    /**
+     * Delete API Key
+     * Delete an existing API key
+     * @param id
+     * @returns ApiKeyResponse API key deleted successfully
+     * @throws ApiError
+     */
+    deleteApiKey(id: string): CancelablePromise<ApiKeyResponse>;
+    /**
+     * Regenerate API Key
+     * Generate a new value for an existing API key
+     * @param id
+     * @returns RegenerateApiKeyResponse API key regenerated successfully
+     * @throws ApiError
+     */
+    regenerateApiKey(id: string): CancelablePromise<RegenerateApiKeyResponse>;
+}
+
 type CreateAppRequest = {
     name: string;
     description: string;
@@ -136,28 +211,24 @@ type DeleteAppResponse = {
 };
 
 type GetAppResponse = {
-    app: {
-        id: string;
-        name: string;
-        description: string;
-        metadata: Record<string, any>;
-        org_id: string;
-        created_at: string;
-        updated_at: string;
-    };
+    id: string;
+    name: string;
+    description: string;
+    metadata: Record<string, any>;
+    org_id: string;
+    created_at: string;
+    updated_at: string;
 };
 
-type GetAppsResponse = {
-    apps: Array<{
-        id: string;
-        name: string;
-        description: string;
-        metadata: Record<string, any>;
-        org_id: string;
-        created_at: string;
-        updated_at: string;
-    }>;
-};
+type GetAppsResponse = Array<{
+    id: string;
+    name: string;
+    description: string;
+    metadata: Record<string, any>;
+    org_id: string;
+    created_at: string;
+    updated_at: string;
+}>;
 
 type UpdateAppRequest = {
     name?: string;
@@ -235,9 +306,24 @@ declare class AuditLogsService {
      * @returns GetAuditLogsResponse Audit logs retrieved successfully
      * @throws ApiError
      */
-    getAuditLogs(page?: number, perPage?: number): CancelablePromise<GetAuditLogsResponse>;
+    getAuditLogs(page?: string, perPage?: string): CancelablePromise<GetAuditLogsResponse>;
 }
 
+type RoleResponse = {
+    id: string;
+    name: string;
+    org_id: string;
+    can_edit: boolean;
+    can_view: boolean;
+    have_api_access: boolean;
+    have_billing_options: boolean;
+    have_webhook_access: boolean;
+    is_admin: boolean;
+    is_master: boolean;
+    created_at: string;
+    updated_at: string;
+};
+
 type WhoAmIResponse = {
     user: {
         id: string;
@@ -261,6 +347,7 @@ type WhoAmIResponse = {
         created_at: string;
         updated_at: string;
     };
+    role: RoleResponse;
 };
 
 declare class AuthenticationService {
@@ -275,14 +362,6 @@ declare class AuthenticationService {
     whoami(): CancelablePromise<WhoAmIResponse>;
 }
 
-type CreateEnvTypeRequest = {
-    name: string;
-};
-
-type DeleteEnvTypeRequest = {
-    id: string;
-};
-
 type EnvTypeResponse = {
     id: string;
     name: string;
@@ -293,11 +372,6 @@ type EnvTypeResponse = {
 
 type EnvTypesResponse = Array<EnvTypeResponse>;
 
-type UpdateEnvTypeRequest = {
-    id: string;
-    name: string;
-};
-
 declare class EnvironmentTypesService {
     readonly httpRequest: BaseHttpRequest;
     constructor(httpRequest: BaseHttpRequest);
@@ -308,14 +382,6 @@ declare class EnvironmentTypesService {
      * @throws ApiError
      */
     getEnvTypes(): CancelablePromise<EnvTypesResponse>;
-    /**
-     * Create Environment Type
-     * Create a new environment type
-     * @param requestBody
-     * @returns EnvTypeResponse Environment type created successfully
-     * @throws ApiError
-     */
-    createEnvType(requestBody?: CreateEnvTypeRequest): CancelablePromise<EnvTypeResponse>;
     /**
      * Get Environment Type
      * Retrieve a specific environment type
@@ -324,23 +390,6 @@ declare class EnvironmentTypesService {
      * @throws ApiError
      */
     getEnvType(id: string): CancelablePromise<EnvTypeResponse>;
-    /**
-     * Update Environment Type
-     * Update an existing environment type
-     * @param id
-     * @param requestBody
-     * @returns EnvTypeResponse Environment type updated successfully
-     * @throws ApiError
-     */
-    updateEnvType(id: string, requestBody?: UpdateEnvTypeRequest): CancelablePromise<EnvTypeResponse>;
-    /**
-     * Delete Environment Type
-     * Delete an existing environment type
-     * @param id
-     * @returns DeleteEnvTypeRequest Environment type deleted successfully
-     * @throws ApiError
-     */
-    deleteEnvType(id: string): CancelablePromise<DeleteEnvTypeRequest>;
 }
 
 type BatchCreateEnvsRequest = {
@@ -417,15 +466,6 @@ declare class EnvironmentVariablesService {
      * @throws ApiError
      */
     getEnv(key: string, requestBody?: GetEnvRequest): CancelablePromise<EnvResponse>;
-    /**
-     * Update Environment Variable
-     * Update an existing environment variable
-     * @param key
-     * @param requestBody
-     * @returns EnvResponse Environment variable updated successfully
-     * @throws ApiError
-     */
-    updateEnv(key: string, requestBody?: UpdateEnvRequest): CancelablePromise<EnvResponse>;
     /**
      * Create Environment Variable
      * Create a new environment variable
@@ -442,6 +482,43 @@ declare class EnvironmentVariablesService {
      * @throws ApiError
      */
     batchCreateEnvs(requestBody?: BatchCreateEnvsRequest): CancelablePromise<EnvsResponse>;
+    /**
+     * Batch Update Environment Variables
+     * Update multiple environment variables in a single request
+     * @param requestBody
+     * @returns EnvsResponse Environment variables updated successfully
+     * @throws ApiError
+     */
+    batchUpdateEnvs(requestBody?: BatchCreateEnvsRequest): CancelablePromise<EnvsResponse>;
+    /**
+     * Update Environment Variable
+     * Update an existing environment variable
+     * @param key
+     * @param requestBody
+     * @returns EnvResponse Environment variable updated successfully
+     * @throws ApiError
+     */
+    updateEnv(key: string, requestBody?: UpdateEnvRequest): CancelablePromise<EnvResponse>;
+}
+
+type UploadFileResponse = {
+    message: string;
+    s3_url: string;
+};
+
+declare class FileUploadService {
+    readonly httpRequest: BaseHttpRequest;
+    constructor(httpRequest: BaseHttpRequest);
+    /**
+     * Upload File
+     * Upload a file to the server. The file should be less than 5MB in size.
+     * @param formData
+     * @returns UploadFileResponse File uploaded successfully
+     * @throws ApiError
+     */
+    uploadFile(formData?: {
+        file: any;
+    }): CancelablePromise<UploadFileResponse>;
 }
 
 type AcceptOrgInviteRequest = {
@@ -646,14 +723,88 @@ declare class OrganizationsService {
     checkIfSlugExists(slug: string): CancelablePromise<CheckSlugResponse>;
 }
 
-type UpdatePasswordRequest = {
-    password: string;
+type CreateRoleRequest = {
+    name: string;
+    can_edit: boolean;
+    can_view: boolean;
+    have_api_access: boolean;
+    have_billing_options: boolean;
+    have_webhook_access: boolean;
+    is_admin: boolean;
+};
+
+type RolesResponse = Array<RoleResponse>;
+
+type RoleStatsResponse = {
+    admin_access_count: number;
+    billing_access_count: number;
+    api_access_count: number;
+    webhook_access_count: number;
+    view_access_count: number;
+    edit_access_count: number;
+    total_roles: number;
 };
 
 type UpdateRoleRequest = {
     role_id: string;
 };
 
+declare class RolesService {
+    readonly httpRequest: BaseHttpRequest;
+    constructor(httpRequest: BaseHttpRequest);
+    /**
+     * Get All Roles
+     * Retrieve all roles in the organization
+     * @returns RolesResponse Roles retrieved successfully
+     * @throws ApiError
+     */
+    getAllRoles(): CancelablePromise<RolesResponse>;
+    /**
+     * Create Role
+     * Create a new role in the organization
+     * @param requestBody
+     * @returns RoleResponse Role created successfully
+     * @throws ApiError
+     */
+    createRole(requestBody?: CreateRoleRequest): CancelablePromise<RoleResponse>;
+    /**
+     * Get Role Statistics
+     * Retrieve statistics about roles in the organization
+     * @returns RoleStatsResponse Role statistics retrieved successfully
+     * @throws ApiError
+     */
+    getRoleStats(): CancelablePromise<RoleStatsResponse>;
+    /**
+     * Get Role
+     * Retrieve a specific role by ID
+     * @param id
+     * @returns RoleResponse Role retrieved successfully
+     * @throws ApiError
+     */
+    getRole(id: string): CancelablePromise<RoleResponse>;
+    /**
+     * Update Role
+     * Update an existing role
+     * @param id
+     * @param requestBody
+     * @returns RoleResponse Role updated successfully
+     * @throws ApiError
+     */
+    updateRole(id: string, requestBody?: UpdateRoleRequest): CancelablePromise<RoleResponse>;
+    /**
+     * Delete Role
+     * Delete an existing role (non-master roles only)
+     * @param id
+     * @returns RoleResponse Role deleted successfully
+     * @throws ApiError
+     */
+    deleteRole(id: string): CancelablePromise<RoleResponse>;
+}
+
+type UpdatePasswordRequest = {
+    password: string;
+};
+
 type UpdateUserRequest = {
     full_name?: string;
     profile_picture_url?: string;
@@ -733,13 +884,16 @@ declare class UsersService {
 type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
 declare class EnvSyncAPISDK {
     readonly access: AccessService;
+    readonly apiKeys: ApiKeysService;
     readonly applications: ApplicationsService;
     readonly auditLogs: AuditLogsService;
     readonly authentication: AuthenticationService;
     readonly environmentTypes: EnvironmentTypesService;
     readonly environmentVariables: EnvironmentVariablesService;
+    readonly fileUpload: FileUploadService;
     readonly onboarding: OnboardingService;
     readonly organizations: OrganizationsService;
+    readonly roles: RolesService;
     readonly users: UsersService;
     readonly request: BaseHttpRequest;
     constructor(config?: Partial<OpenAPIConfig>, HttpRequest?: HttpRequestConstructor);
@@ -766,4 +920,8 @@ type ErrorResponse = {
     error: string;
 };
 
-export { type AcceptOrgInviteRequest, type AcceptOrgInviteResponse, type AcceptUserInviteRequest, type AcceptUserInviteResponse, AccessService, ApiError, ApplicationsService, AuditLogsService, AuthenticationService, BaseHttpRequest, type BatchCreateEnvsRequest, type CallbackResponse, CancelError, CancelablePromise, type CheckSlugResponse, type CreateAppRequest, type CreateAppResponse, type CreateEnvRequest, type CreateEnvTypeRequest, type CreateOrgInviteRequest, type CreateOrgInviteResponse, type CreateUserInviteRequest, type CreateUserInviteResponse, type DeleteAppResponse, type DeleteEnvRequest, type DeleteEnvTypeRequest, type DeleteUserInviteResponse, type EnvResponse, EnvSyncAPISDK, type EnvTypeResponse, type EnvTypesResponse, EnvironmentTypesService, EnvironmentVariablesService, type EnvsResponse, type ErrorResponse, type GetAppResponse, type GetAppsResponse, type GetAuditLogsResponse, type GetEnvRequest, type GetOrgInviteByCodeResponse, type GetUserInviteByTokenResponse, type LoginUrlResponse, OnboardingService, OpenAPI, type OpenAPIConfig, type OrgResponse, OrganizationsService, type UpdateAppRequest, type UpdateAppResponse, type UpdateEnvRequest, type UpdateEnvTypeRequest, type UpdateOrgRequest, type UpdatePasswordRequest, type UpdateRoleRequest, type UpdateUserInviteRequest, type UpdateUserInviteResponse, type UpdateUserRequest, type UserResponse, type UsersResponse, UsersService, type WhoAmIResponse };
+type UploadFileError = {
+    error: string;
+};
+
+export { type AcceptOrgInviteRequest, type AcceptOrgInviteResponse, type AcceptUserInviteRequest, type AcceptUserInviteResponse, AccessService, ApiError, type ApiKeyResponse, type ApiKeysResponse, ApiKeysService, ApplicationsService, AuditLogsService, AuthenticationService, BaseHttpRequest, type BatchCreateEnvsRequest, type CallbackResponse, CancelError, CancelablePromise, type CheckSlugResponse, type CreateApiKeyRequest, type CreateAppRequest, type CreateAppResponse, type CreateEnvRequest, type CreateOrgInviteRequest, type CreateOrgInviteResponse, type CreateRoleRequest, type CreateUserInviteRequest, type CreateUserInviteResponse, type DeleteAppResponse, type DeleteEnvRequest, type DeleteUserInviteResponse, type EnvResponse, EnvSyncAPISDK, type EnvTypeResponse, type EnvTypesResponse, EnvironmentTypesService, EnvironmentVariablesService, type EnvsResponse, type ErrorResponse, FileUploadService, type GetAppResponse, type GetAppsResponse, type GetAuditLogsResponse, type GetEnvRequest, type GetOrgInviteByCodeResponse, type GetUserInviteByTokenResponse, type LoginUrlResponse, OnboardingService, OpenAPI, type OpenAPIConfig, type OrgResponse, OrganizationsService, type RegenerateApiKeyResponse, type RoleResponse, type RoleStatsResponse, type RolesResponse, RolesService, type UpdateApiKeyRequest, type UpdateAppRequest, type UpdateAppResponse, type UpdateEnvRequest, type UpdateOrgRequest, type UpdatePasswordRequest, type UpdateRoleRequest, type UpdateUserInviteRequest, type UpdateUserInviteResponse, type UpdateUserRequest, type UploadFileError, type UploadFileResponse, type UserResponse, type UsersResponse, UsersService, type WhoAmIResponse };