@dynamic-labs/sdk-api 0.0.868 → 0.0.869

package/src/apis/UserApiTokensApi.js

@@ -103,7 +103,8 @@ import '../models/WalletTransactionType.js';
  */
 class UserApiTokensApi extends BaseAPI {
     /**
-     * Create a new API Token for Dashboard User
+     * Creates a new API token for the current user.
+     * Create an API token for the current user
      */
     createUserApiTokenRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -131,7 +132,8 @@ class UserApiTokensApi extends BaseAPI {
         });
     }
     /**
-     * Create a new API Token for Dashboard User
+     * Creates a new API token for the current user.
+     * Create an API token for the current user
      */
     createUserApiToken(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -140,7 +142,8 @@ class UserApiTokensApi extends BaseAPI {
         });
     }
     /**
-     * Delete a API token by token id
+     * Permanently removes the specified user API token.
+     * Delete an API token by ID
      */
     deleteUserApiTokenRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -166,7 +169,8 @@ class UserApiTokensApi extends BaseAPI {
         });
     }
     /**
-     * Delete a API token by token id
+     * Permanently removes the specified user API token.
+     * Delete an API token by ID
      */
     deleteUserApiToken(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -174,7 +178,8 @@ class UserApiTokensApi extends BaseAPI {
         });
     }
     /**
-     * Get all API Tokens for Dashboard User
+     * Returns the API tokens for the current user.
+     * Get API tokens for the current user
      */
     getUserApiTokensRaw(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -197,7 +202,8 @@ class UserApiTokensApi extends BaseAPI {
         });
     }
     /**
-     * Get all API Tokens for Dashboard User
+     * Returns the API tokens for the current user.
+     * Get API tokens for the current user
      */
     getUserApiTokens(initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {

package/src/apis/UsersApi.cjs

@@ -112,7 +112,8 @@ require('../models/WalletTransactionType.cjs');
  */
 class UsersApi extends runtime.BaseAPI {
     /**
-     * Creates many new users
+     * Creates multiple users in a single request.
+     * Bulk create users
      */
     bulkCreateUserRaw(requestParameters, initOverrides) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -146,7 +147,8 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Creates many new users
+     * Creates multiple users in a single request.
+     * Bulk create users
      */
     bulkCreateUser(requestParameters, initOverrides) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -155,7 +157,8 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Creates a new user
+     * Creates a new user for the specified environment.
+     * Create a user
      */
     createUserRaw(requestParameters, initOverrides) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -186,7 +189,8 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Creates a new user
+     * Creates a new user for the specified environment.
+     * Create a user
      */
     createUser(requestParameters, initOverrides) {
         return _tslib.__awaiter(this, void 0, void 0, function* () {
@@ -195,6 +199,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Permanently removes the specified user.
      * Delete user
      */
     deleteUserRaw(requestParameters, initOverrides) {
@@ -224,6 +229,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Permanently removes the specified user.
      * Delete user
      */
     deleteUser(requestParameters, initOverrides) {
@@ -232,6 +238,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Permanently removes the specified user (deprecated).
      * Delete user (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     deleteUserLegacyRaw(requestParameters, initOverrides) {
@@ -258,6 +265,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Permanently removes the specified user (deprecated).
      * Delete user (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     deleteUserLegacy(requestParameters, initOverrides) {
@@ -266,6 +274,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns all users for the specified environment.
      * Get all users for an environment
      */
     getEnvironmentUsersRaw(requestParameters, initOverrides) {
@@ -307,6 +316,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns all users for the specified environment.
      * Get all users for an environment
      */
     getEnvironmentUsers(requestParameters, initOverrides) {
@@ -316,6 +326,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns a user by their unique identifier.
      * Get a user by Id
      */
     getUserRaw(requestParameters, initOverrides) {
@@ -345,6 +356,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns a user by their unique identifier.
      * Get a user by Id
      */
     getUser(requestParameters, initOverrides) {
@@ -354,6 +366,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns a user by their ID (deprecated).
      * Get a user by Id (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     getUserLegacyRaw(requestParameters, initOverrides) {
@@ -380,6 +393,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns a user by their ID (deprecated).
      * Get a user by Id (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     getUserLegacy(requestParameters, initOverrides) {
@@ -389,6 +403,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns the OAuth access token for the specified user account.
      * Get the access token for a user OAuth account
      */
     getUserOauthAccessTokenRaw(requestParameters, initOverrides) {
@@ -415,6 +430,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns the OAuth access token for the specified user account.
      * Get the access token for a user OAuth account
      */
     getUserOauthAccessToken(requestParameters, initOverrides) {
@@ -424,6 +440,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns all sessions for the specified user.
      * Get all sessions for a user by user ID
      */
     getUserSessionsRaw(requestParameters, initOverrides) {
@@ -462,6 +479,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns all sessions for the specified user.
      * Get all sessions for a user by user ID
      */
     getUserSessions(requestParameters, initOverrides) {
@@ -471,6 +489,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Revokes all sessions for the specified user.
      * Revoke sessions by user ID
      */
     revokeUserSessionsRaw(requestParameters, initOverrides) {
@@ -500,6 +519,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Revokes all sessions for the specified user.
      * Revoke sessions by user ID
      */
     revokeUserSessions(requestParameters, initOverrides) {
@@ -544,6 +564,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Updates the specified user.
      * Update a user
      */
     updateUserRaw(requestParameters, initOverrides) {
@@ -578,6 +599,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Updates the specified user.
      * Update a user
      */
     updateUser(requestParameters, initOverrides) {
@@ -587,6 +609,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Updates the specified user (deprecated).
      * Update a user (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     updateUserLegacyRaw(requestParameters, initOverrides) {
@@ -618,6 +641,7 @@ class UsersApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Updates the specified user (deprecated).
      * Update a user (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     updateUserLegacy(requestParameters, initOverrides) {

package/src/apis/UsersApi.d.ts

@@ -73,82 +73,102 @@ export interface UpdateUserLegacyRequest {
  */
 export declare class UsersApi extends runtime.BaseAPI {
     /**
-     * Creates many new users
+     * Creates multiple users in a single request.
+     * Bulk create users
      */
     bulkCreateUserRaw(requestParameters: BulkCreateUserRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BulkUserCreateResponse>>;
     /**
-     * Creates many new users
+     * Creates multiple users in a single request.
+     * Bulk create users
      */
     bulkCreateUser(requestParameters: BulkCreateUserRequest, initOverrides?: RequestInit): Promise<BulkUserCreateResponse>;
     /**
-     * Creates a new user
+     * Creates a new user for the specified environment.
+     * Create a user
      */
     createUserRaw(requestParameters: CreateUserRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<UserResponse>>;
     /**
-     * Creates a new user
+     * Creates a new user for the specified environment.
+     * Create a user
      */
     createUser(requestParameters: CreateUserRequest, initOverrides?: RequestInit): Promise<UserResponse>;
     /**
+     * Permanently removes the specified user.
      * Delete user
      */
     deleteUserRaw(requestParameters: DeleteUserRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
     /**
+     * Permanently removes the specified user.
      * Delete user
      */
     deleteUser(requestParameters: DeleteUserRequest, initOverrides?: RequestInit): Promise<void>;
     /**
+     * Permanently removes the specified user (deprecated).
      * Delete user (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     deleteUserLegacyRaw(requestParameters: DeleteUserLegacyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
     /**
+     * Permanently removes the specified user (deprecated).
      * Delete user (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     deleteUserLegacy(requestParameters: DeleteUserLegacyRequest, initOverrides?: RequestInit): Promise<void>;
     /**
+     * Returns all users for the specified environment.
      * Get all users for an environment
      */
     getEnvironmentUsersRaw(requestParameters: GetEnvironmentUsersRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<UsersResponse>>;
     /**
+     * Returns all users for the specified environment.
      * Get all users for an environment
      */
     getEnvironmentUsers(requestParameters: GetEnvironmentUsersRequest, initOverrides?: RequestInit): Promise<UsersResponse>;
     /**
+     * Returns a user by their unique identifier.
      * Get a user by Id
      */
     getUserRaw(requestParameters: GetUserRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<UserResponse>>;
     /**
+     * Returns a user by their unique identifier.
      * Get a user by Id
      */
     getUser(requestParameters: GetUserRequest, initOverrides?: RequestInit): Promise<UserResponse>;
     /**
+     * Returns a user by their ID (deprecated).
      * Get a user by Id (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     getUserLegacyRaw(requestParameters: GetUserLegacyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<UserResponse>>;
     /**
+     * Returns a user by their ID (deprecated).
      * Get a user by Id (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     getUserLegacy(requestParameters: GetUserLegacyRequest, initOverrides?: RequestInit): Promise<UserResponse>;
     /**
+     * Returns the OAuth access token for the specified user account.
      * Get the access token for a user OAuth account
      */
     getUserOauthAccessTokenRaw(requestParameters: GetUserOauthAccessTokenRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<UserOauthAccessTokenResponse>>;
     /**
+     * Returns the OAuth access token for the specified user account.
      * Get the access token for a user OAuth account
      */
     getUserOauthAccessToken(requestParameters: GetUserOauthAccessTokenRequest, initOverrides?: RequestInit): Promise<UserOauthAccessTokenResponse>;
     /**
+     * Returns all sessions for the specified user.
      * Get all sessions for a user by user ID
      */
     getUserSessionsRaw(requestParameters: GetUserSessionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<SessionsResponse>>;
     /**
+     * Returns all sessions for the specified user.
      * Get all sessions for a user by user ID
      */
     getUserSessions(requestParameters: GetUserSessionsRequest, initOverrides?: RequestInit): Promise<SessionsResponse>;
     /**
+     * Revokes all sessions for the specified user.
      * Revoke sessions by user ID
      */
     revokeUserSessionsRaw(requestParameters: RevokeUserSessionsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
     /**
+     * Revokes all sessions for the specified user.
      * Revoke sessions by user ID
      */
     revokeUserSessions(requestParameters: RevokeUserSessionsRequest, initOverrides?: RequestInit): Promise<void>;
@@ -163,18 +183,22 @@ export declare class UsersApi extends runtime.BaseAPI {
      */
     revokeUserSessionsLegacy(requestParameters: RevokeUserSessionsLegacyRequest, initOverrides?: RequestInit): Promise<void>;
     /**
+     * Updates the specified user.
      * Update a user
      */
     updateUserRaw(requestParameters: UpdateUserRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<UserResponse>>;
     /**
+     * Updates the specified user.
      * Update a user
      */
     updateUser(requestParameters: UpdateUserRequest, initOverrides?: RequestInit): Promise<UserResponse>;
     /**
+     * Updates the specified user (deprecated).
      * Update a user (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     updateUserLegacyRaw(requestParameters: UpdateUserLegacyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<UserResponse>>;
     /**
+     * Updates the specified user (deprecated).
      * Update a user (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     updateUserLegacy(requestParameters: UpdateUserLegacyRequest, initOverrides?: RequestInit): Promise<UserResponse>;

package/src/apis/UsersApi.js

@@ -108,7 +108,8 @@ import '../models/WalletTransactionType.js';
  */
 class UsersApi extends BaseAPI {
     /**
-     * Creates many new users
+     * Creates multiple users in a single request.
+     * Bulk create users
      */
     bulkCreateUserRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -142,7 +143,8 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
-     * Creates many new users
+     * Creates multiple users in a single request.
+     * Bulk create users
      */
     bulkCreateUser(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -151,7 +153,8 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
-     * Creates a new user
+     * Creates a new user for the specified environment.
+     * Create a user
      */
     createUserRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -182,7 +185,8 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
-     * Creates a new user
+     * Creates a new user for the specified environment.
+     * Create a user
      */
     createUser(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -191,6 +195,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Permanently removes the specified user.
      * Delete user
      */
     deleteUserRaw(requestParameters, initOverrides) {
@@ -220,6 +225,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Permanently removes the specified user.
      * Delete user
      */
     deleteUser(requestParameters, initOverrides) {
@@ -228,6 +234,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Permanently removes the specified user (deprecated).
      * Delete user (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     deleteUserLegacyRaw(requestParameters, initOverrides) {
@@ -254,6 +261,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Permanently removes the specified user (deprecated).
      * Delete user (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     deleteUserLegacy(requestParameters, initOverrides) {
@@ -262,6 +270,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Returns all users for the specified environment.
      * Get all users for an environment
      */
     getEnvironmentUsersRaw(requestParameters, initOverrides) {
@@ -303,6 +312,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Returns all users for the specified environment.
      * Get all users for an environment
      */
     getEnvironmentUsers(requestParameters, initOverrides) {
@@ -312,6 +322,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Returns a user by their unique identifier.
      * Get a user by Id
      */
     getUserRaw(requestParameters, initOverrides) {
@@ -341,6 +352,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Returns a user by their unique identifier.
      * Get a user by Id
      */
     getUser(requestParameters, initOverrides) {
@@ -350,6 +362,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Returns a user by their ID (deprecated).
      * Get a user by Id (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     getUserLegacyRaw(requestParameters, initOverrides) {
@@ -376,6 +389,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Returns a user by their ID (deprecated).
      * Get a user by Id (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     getUserLegacy(requestParameters, initOverrides) {
@@ -385,6 +399,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Returns the OAuth access token for the specified user account.
      * Get the access token for a user OAuth account
      */
     getUserOauthAccessTokenRaw(requestParameters, initOverrides) {
@@ -411,6 +426,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Returns the OAuth access token for the specified user account.
      * Get the access token for a user OAuth account
      */
     getUserOauthAccessToken(requestParameters, initOverrides) {
@@ -420,6 +436,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Returns all sessions for the specified user.
      * Get all sessions for a user by user ID
      */
     getUserSessionsRaw(requestParameters, initOverrides) {
@@ -458,6 +475,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Returns all sessions for the specified user.
      * Get all sessions for a user by user ID
      */
     getUserSessions(requestParameters, initOverrides) {
@@ -467,6 +485,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Revokes all sessions for the specified user.
      * Revoke sessions by user ID
      */
     revokeUserSessionsRaw(requestParameters, initOverrides) {
@@ -496,6 +515,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Revokes all sessions for the specified user.
      * Revoke sessions by user ID
      */
     revokeUserSessions(requestParameters, initOverrides) {
@@ -540,6 +560,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Updates the specified user.
      * Update a user
      */
     updateUserRaw(requestParameters, initOverrides) {
@@ -574,6 +595,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Updates the specified user.
      * Update a user
      */
     updateUser(requestParameters, initOverrides) {
@@ -583,6 +605,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Updates the specified user (deprecated).
      * Update a user (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     updateUserLegacyRaw(requestParameters, initOverrides) {
@@ -614,6 +637,7 @@ class UsersApi extends BaseAPI {
         });
     }
     /**
+     * Updates the specified user (deprecated).
      * Update a user (deprecated - use /environments/{environmentId}/users/{userId} instead)
      */
     updateUserLegacy(requestParameters, initOverrides) {

package/src/apis/VisitsApi.cjs

@@ -105,6 +105,7 @@ require('../models/WalletTransactionType.cjs');
  */
 class VisitsApi extends runtime.BaseAPI {
     /**
+     * Returns all visitors for the specified environment.
      * Get all visitors for an environment
      */
     getEnvironmentVisitorsRaw(requestParameters, initOverrides) {
@@ -143,6 +144,7 @@ class VisitsApi extends runtime.BaseAPI {
         });
     }
     /**
+     * Returns all visitors for the specified environment.
      * Get all visitors for an environment
      */
     getEnvironmentVisitors(requestParameters, initOverrides) {

package/src/apis/VisitsApi.d.ts

@@ -23,10 +23,12 @@ export interface GetEnvironmentVisitorsRequest {
  */
 export declare class VisitsApi extends runtime.BaseAPI {
     /**
+     * Returns all visitors for the specified environment.
      * Get all visitors for an environment
      */
     getEnvironmentVisitorsRaw(requestParameters: GetEnvironmentVisitorsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<VisitorsResponse>>;
     /**
+     * Returns all visitors for the specified environment.
      * Get all visitors for an environment
      */
     getEnvironmentVisitors(requestParameters: GetEnvironmentVisitorsRequest, initOverrides?: RequestInit): Promise<VisitorsResponse>;

package/src/apis/VisitsApi.js

@@ -101,6 +101,7 @@ import '../models/WalletTransactionType.js';
  */
 class VisitsApi extends BaseAPI {
     /**
+     * Returns all visitors for the specified environment.
      * Get all visitors for an environment
      */
     getEnvironmentVisitorsRaw(requestParameters, initOverrides) {
@@ -139,6 +140,7 @@ class VisitsApi extends BaseAPI {
         });
     }
     /**
+     * Returns all visitors for the specified environment.
      * Get all visitors for an environment
      */
     getEnvironmentVisitors(requestParameters, initOverrides) {