edge-impulse-api 1.71.60 → 1.72.0

package/build/library/sdk/api/adminApi.d.ts

@@ -13,6 +13,8 @@ import { AdminAddDisallowedEmailDomainRequest } from '../model/adminAddDisallowe
 import { AdminAddOrUpdateSSODomainIdPsRequest } from '../model/adminAddOrUpdateSSODomainIdPsRequest';
 import { AdminAddOrganizationUserRequest } from '../model/adminAddOrganizationUserRequest';
 import { AdminAddProjectUserRequest } from '../model/adminAddProjectUserRequest';
+import { AdminCreateOauthClientRequest } from '../model/adminCreateOauthClientRequest';
+import { AdminCreateOauthClientResponse } from '../model/adminCreateOauthClientResponse';
 import { AdminCreateOrganizationDataExportRequest } from '../model/adminCreateOrganizationDataExportRequest';
 import { AdminCreateOrganizationRequest } from '../model/adminCreateOrganizationRequest';
 import { AdminCreateProjectRequest } from '../model/adminCreateProjectRequest';
@@ -20,6 +22,8 @@ import { AdminGetDataMigrationResponse } from '../model/adminGetDataMigrationRes
 import { AdminGetDataMigrationsResponse } from '../model/adminGetDataMigrationsResponse';
 import { AdminGetDisallowedEmailDomainsResponse } from '../model/adminGetDisallowedEmailDomainsResponse';
 import { AdminGetMetricsResponse } from '../model/adminGetMetricsResponse';
+import { AdminGetOauthClientResponse } from '../model/adminGetOauthClientResponse';
+import { AdminGetOauthClientsResponse } from '../model/adminGetOauthClientsResponse';
 import { AdminGetOrganizationComputeTimeUsageResponse } from '../model/adminGetOrganizationComputeTimeUsageResponse';
 import { AdminGetOrganizationsResponse } from '../model/adminGetOrganizationsResponse';
 import { AdminGetReportResponse } from '../model/adminGetReportResponse';
@@ -34,9 +38,11 @@ import { AdminGetUsersResponse } from '../model/adminGetUsersResponse';
 import { AdminListProjectsResponse } from '../model/adminListProjectsResponse';
 import { AdminOrganizationInfoResponse } from '../model/adminOrganizationInfoResponse';
 import { AdminProjectInfoResponse } from '../model/adminProjectInfoResponse';
+import { AdminRotateOauthClientSecretResponse } from '../model/adminRotateOauthClientSecretResponse';
 import { AdminStartEnterpriseTrialRequest } from '../model/adminStartEnterpriseTrialRequest';
 import { AdminToggleDataMigrationRequest } from '../model/adminToggleDataMigrationRequest';
 import { AdminUpdateConfigRequest } from '../model/adminUpdateConfigRequest';
+import { AdminUpdateOauthClientRequest } from '../model/adminUpdateOauthClientRequest';
 import { AdminUpdateOrganizationDataExportRequest } from '../model/adminUpdateOrganizationDataExportRequest';
 import { AdminUpdateOrganizationRequest } from '../model/adminUpdateOrganizationRequest';
 import { AdminUpdateTrialRequest } from '../model/adminUpdateTrialRequest';
@@ -65,7 +71,7 @@ import { StartJobResponse } from '../model/startJobResponse';
 import { UpdateProjectRequest } from '../model/updateProjectRequest';
 import { UserTierEnum } from '../model/userTierEnum';
 import { Authentication } from '../model/models';
-import { ApiKeyAuth } from '../model/models';
+import { ApiKeyAuth, OAuth } from '../model/models';
 export declare enum AdminApiApiKeys {
     ApiKeyAuthentication = 0,
     JWTAuthentication = 1,
@@ -108,6 +114,13 @@ type adminGetMetricsReportsQueryParams = {
     limit?: number;
     offset?: number;
 };
+type adminGetOauthClientsQueryParams = {
+    sort?: string;
+    filters?: string;
+    limit?: number;
+    offset?: number;
+    search?: string;
+};
 type adminGetOrganizationComputeTimeUsageQueryParams = {
     startDate: Date;
     endDate: Date;
@@ -214,6 +227,7 @@ export declare class AdminApi {
     protected authentications: {
         default: Authentication;
         ApiKeyAuthentication: ApiKeyAuth;
+        OAuth2: OAuth;
         JWTAuthentication: ApiKeyAuth;
         JWTHttpHeaderAuthentication: ApiKeyAuth;
     };
@@ -225,6 +239,7 @@ export declare class AdminApi {
     get opts(): AdminApiOpts;
     setDefaultAuthentication(auth: Authentication): void;
     setApiKey(key: AdminApiApiKeys, value: string | undefined): void;
+    set accessToken(token: string);
     /**
      * Admin-only API to add an email domain to the list of disallowed email domains.
      * @summary Add a disallowed email domain
@@ -289,6 +304,16 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<StartJobResponse>;
+    /**
+     * Create a new OAuth client in the system. This endpoint generates a unique client ID and secret that will be used for OAuth authentication. The client can be configured with specific redirect URIs, allowed grant types, and scopes. By default, the authorization_code grant type is enabled. Requires admin:oauth:write permission.
+     * @summary Register a new OAuth client
+     * @param adminCreateOauthClientRequest
+     */
+    adminCreateOauthClient(adminCreateOauthClientRequest: AdminCreateOauthClientRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminCreateOauthClientResponse>;
     /**
      * Admin-only API to create a new organization.
      * @summary Create a new organization
@@ -373,6 +398,16 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Deactivate an existing OAuth client. This operation performs a soft delete, marking the client as inactive while preserving its historical data. The client\'s credentials will no longer be valid for new OAuth flows. Requires admin:oauth:write permission.
+     * @summary Deactivate OAuth client
+     * @param clientId Client ID
+     */
+    adminDeleteOauthClient(clientId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Admin-only API to delete an organization. The deletion process varies based on the `fullDelete` parameter:  **Soft Delete** (default, `fullDelete=false`):     - Organization is marked as deleted in the database     - Organization remains hidden from the product     - All data is preserved and recoverable     - No data is removed from S3 or FSx  **Full Delete** (`fullDelete=true`): 1. Immediate soft deletion     - Organization is marked as deleted and hidden from the product     - Access is immediately revoked for all organization members 2. Data preservation     - S3 and FSx assets are moved to a trash bin 3. Scheduled permanent deletion     - A 30-day grace period begins     - After 30 days, all organization data and S3 and FSx assets are permanently deleted     - During the grace period:         - Deletion can be cancelled by administrators         - Data can be recovered if needed         - Progress can be monitored via admin API
      * @summary Delete an organization
@@ -650,6 +685,30 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<AdminGetReportsResponse>;
+    /**
+     * Retrieve detailed information about a specific OAuth client, including its configuration, allowed grant types, redirect URIs, and creation metadata. The response includes the creator\'s information (name and email) who registered the client. Requires admin:oauth:read permission.
+     * @summary Get OAuth client details
+     * @param clientId Client ID
+     */
+    adminGetOauthClient(clientId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetOauthClientResponse>;
+    /**
+     * Retrieve a paginated list of all registered OAuth clients in the system. The response includes client metadata such as name, redirect URIs, allowed grant types, and creation information. Results can be filtered, sorted, and searched using query parameters. Requires admin:oauth:read permission.
+     * @summary List OAuth clients
+     * @param sort Fields and order to sort query by
+     * @param filters
+     * @param limit Maximum number of results
+     * @param offset Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
+     * @param search Search query
+     */
+    adminGetOauthClients(queryParams?: adminGetOauthClientsQueryParams, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminGetOauthClientsResponse>;
     /**
      * Admin-only API to get compute time usage for an organization over a period of time.
      * @summary Get organization compute time usage
@@ -1086,6 +1145,16 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<StartJobResponse>;
+    /**
+     * Rotate the client secret for an existing OAuth client. This operation invalidates the previous secret and generates a new one, which must be used for future OAuth authentication flows. Requires admin:oauth:write permission.
+     * @summary Rotate OAuth client secret
+     * @param clientId Client ID
+     */
+    adminRotateOauthClientSecret(clientId: number, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<AdminRotateOauthClientSecretResponse>;
     /**
      * Admin-only API to update a studio config item.
      * @summary Update studio config
@@ -1108,6 +1177,17 @@ export declare class AdminApi {
             [name: string]: string;
         };
     }): Promise<GenericApiResponse>;
+    /**
+     * Update an existing OAuth client\'s configuration. This endpoint allows updating the client\'s properties such as name, description, redirect URIs, allowed grant types, and scopes. The client ID and secret cannot be modified. Requires admin:oauth:write permission.
+     * @summary Update OAuth client
+     * @param clientId Client ID
+     * @param adminUpdateOauthClientRequest
+     */
+    adminUpdateOauthClient(clientId: number, adminUpdateOauthClientRequest: AdminUpdateOauthClientRequest, options?: {
+        headers: {
+            [name: string]: string;
+        };
+    }): Promise<GenericApiResponse>;
     /**
      * Admin-only API to update organization properties such as name and logo.
      * @summary Update organization