@omnikit-ai/sdk 2.2.5 → 2.2.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +39 -5
- package/dist/index.d.ts +39 -5
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +2 -2
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -4,8 +4,7 @@ export { cleanTokenFromUrl, getAccessToken, isTokenInUrl, removeAccessToken, sav
|
|
|
4
4
|
* Omnikit SDK - Connectors Module
|
|
5
5
|
*
|
|
6
6
|
* Provides access to connected external services (Slack, Google Calendar, Notion, etc.)
|
|
7
|
-
*
|
|
8
|
-
* for making direct API calls to external services.
|
|
7
|
+
* Allows backend functions to get access tokens for making direct API calls to external services.
|
|
9
8
|
*
|
|
10
9
|
* SECURITY: getAccessToken requires API key (X-API-Key) authentication.
|
|
11
10
|
* Only available to backend functions, not frontend code.
|
|
@@ -1012,9 +1011,44 @@ type UserEntityClass<T = UserInfo> = UserCollectionClass<T>;
|
|
|
1012
1011
|
*/
|
|
1013
1012
|
type IntegrationMethod = (params?: Record<string, any>, useServiceToken?: boolean) => Promise<any>;
|
|
1014
1013
|
/**
|
|
1015
|
-
* BuiltIn integration methods
|
|
1014
|
+
* BuiltIn integration methods.
|
|
1015
|
+
* Supports both camelCase (industry standard) and PascalCase (legacy).
|
|
1016
|
+
* camelCase is recommended for new code.
|
|
1016
1017
|
*/
|
|
1017
1018
|
interface BuiltInIntegration {
|
|
1019
|
+
sendEmail(params: EmailParams): Promise<ServiceResponse>;
|
|
1020
|
+
sendSMS(params: SMSParams): Promise<ServiceResponse>;
|
|
1021
|
+
invokeLLM(params: LLMParams, options?: AsyncOptions): Promise<LLMResponse | AsyncJobCreatedResponse>;
|
|
1022
|
+
uploadFile(params: {
|
|
1023
|
+
file: File;
|
|
1024
|
+
metadata?: Record<string, any>;
|
|
1025
|
+
}): Promise<ServiceResponse>;
|
|
1026
|
+
uploadPrivateFile(params: {
|
|
1027
|
+
file: File;
|
|
1028
|
+
}): Promise<{
|
|
1029
|
+
file_uri: string;
|
|
1030
|
+
file_id: string;
|
|
1031
|
+
filename: string;
|
|
1032
|
+
size: number;
|
|
1033
|
+
content_type: string;
|
|
1034
|
+
}>;
|
|
1035
|
+
createFileSignedUrl(params: {
|
|
1036
|
+
file_uri: string;
|
|
1037
|
+
expires_in?: number;
|
|
1038
|
+
}): Promise<{
|
|
1039
|
+
signed_url: string;
|
|
1040
|
+
expires_in: number;
|
|
1041
|
+
}>;
|
|
1042
|
+
downloadPrivateFile(params: {
|
|
1043
|
+
file_uri: string;
|
|
1044
|
+
filename?: string;
|
|
1045
|
+
}): Promise<void>;
|
|
1046
|
+
generateImage(params: ImageParams): Promise<ServiceResponse>;
|
|
1047
|
+
generateSpeech(params: SpeechParams): Promise<ServiceResponse>;
|
|
1048
|
+
generateVideo(params: VideoParams): Promise<ServiceResponse>;
|
|
1049
|
+
checkVideoStatus(params: VideoStatusParams): Promise<ServiceResponse>;
|
|
1050
|
+
extractData(params: ExtractParams): Promise<ServiceResponse>;
|
|
1051
|
+
checkJobStatus(params: CheckJobStatusParams): Promise<AsyncJobStatusResponse>;
|
|
1018
1052
|
SendEmail(params: EmailParams): Promise<ServiceResponse>;
|
|
1019
1053
|
SendSMS(params: SMSParams): Promise<ServiceResponse>;
|
|
1020
1054
|
/**
|
|
@@ -1906,8 +1940,8 @@ declare class APIClient implements OmnikitClient {
|
|
|
1906
1940
|
*/
|
|
1907
1941
|
get asServiceRole(): ServiceRoleClient;
|
|
1908
1942
|
/**
|
|
1909
|
-
* Lazy getter for connectors module
|
|
1910
|
-
*
|
|
1943
|
+
* Lazy getter for connectors module.
|
|
1944
|
+
* Provides access to external service tokens.
|
|
1911
1945
|
*
|
|
1912
1946
|
* SECURITY: getAccessToken requires service token authentication.
|
|
1913
1947
|
* Only use in backend functions, not frontend code.
|
package/dist/index.d.ts
CHANGED
|
@@ -4,8 +4,7 @@ export { cleanTokenFromUrl, getAccessToken, isTokenInUrl, removeAccessToken, sav
|
|
|
4
4
|
* Omnikit SDK - Connectors Module
|
|
5
5
|
*
|
|
6
6
|
* Provides access to connected external services (Slack, Google Calendar, Notion, etc.)
|
|
7
|
-
*
|
|
8
|
-
* for making direct API calls to external services.
|
|
7
|
+
* Allows backend functions to get access tokens for making direct API calls to external services.
|
|
9
8
|
*
|
|
10
9
|
* SECURITY: getAccessToken requires API key (X-API-Key) authentication.
|
|
11
10
|
* Only available to backend functions, not frontend code.
|
|
@@ -1012,9 +1011,44 @@ type UserEntityClass<T = UserInfo> = UserCollectionClass<T>;
|
|
|
1012
1011
|
*/
|
|
1013
1012
|
type IntegrationMethod = (params?: Record<string, any>, useServiceToken?: boolean) => Promise<any>;
|
|
1014
1013
|
/**
|
|
1015
|
-
* BuiltIn integration methods
|
|
1014
|
+
* BuiltIn integration methods.
|
|
1015
|
+
* Supports both camelCase (industry standard) and PascalCase (legacy).
|
|
1016
|
+
* camelCase is recommended for new code.
|
|
1016
1017
|
*/
|
|
1017
1018
|
interface BuiltInIntegration {
|
|
1019
|
+
sendEmail(params: EmailParams): Promise<ServiceResponse>;
|
|
1020
|
+
sendSMS(params: SMSParams): Promise<ServiceResponse>;
|
|
1021
|
+
invokeLLM(params: LLMParams, options?: AsyncOptions): Promise<LLMResponse | AsyncJobCreatedResponse>;
|
|
1022
|
+
uploadFile(params: {
|
|
1023
|
+
file: File;
|
|
1024
|
+
metadata?: Record<string, any>;
|
|
1025
|
+
}): Promise<ServiceResponse>;
|
|
1026
|
+
uploadPrivateFile(params: {
|
|
1027
|
+
file: File;
|
|
1028
|
+
}): Promise<{
|
|
1029
|
+
file_uri: string;
|
|
1030
|
+
file_id: string;
|
|
1031
|
+
filename: string;
|
|
1032
|
+
size: number;
|
|
1033
|
+
content_type: string;
|
|
1034
|
+
}>;
|
|
1035
|
+
createFileSignedUrl(params: {
|
|
1036
|
+
file_uri: string;
|
|
1037
|
+
expires_in?: number;
|
|
1038
|
+
}): Promise<{
|
|
1039
|
+
signed_url: string;
|
|
1040
|
+
expires_in: number;
|
|
1041
|
+
}>;
|
|
1042
|
+
downloadPrivateFile(params: {
|
|
1043
|
+
file_uri: string;
|
|
1044
|
+
filename?: string;
|
|
1045
|
+
}): Promise<void>;
|
|
1046
|
+
generateImage(params: ImageParams): Promise<ServiceResponse>;
|
|
1047
|
+
generateSpeech(params: SpeechParams): Promise<ServiceResponse>;
|
|
1048
|
+
generateVideo(params: VideoParams): Promise<ServiceResponse>;
|
|
1049
|
+
checkVideoStatus(params: VideoStatusParams): Promise<ServiceResponse>;
|
|
1050
|
+
extractData(params: ExtractParams): Promise<ServiceResponse>;
|
|
1051
|
+
checkJobStatus(params: CheckJobStatusParams): Promise<AsyncJobStatusResponse>;
|
|
1018
1052
|
SendEmail(params: EmailParams): Promise<ServiceResponse>;
|
|
1019
1053
|
SendSMS(params: SMSParams): Promise<ServiceResponse>;
|
|
1020
1054
|
/**
|
|
@@ -1906,8 +1940,8 @@ declare class APIClient implements OmnikitClient {
|
|
|
1906
1940
|
*/
|
|
1907
1941
|
get asServiceRole(): ServiceRoleClient;
|
|
1908
1942
|
/**
|
|
1909
|
-
* Lazy getter for connectors module
|
|
1910
|
-
*
|
|
1943
|
+
* Lazy getter for connectors module.
|
|
1944
|
+
* Provides access to external service tokens.
|
|
1911
1945
|
*
|
|
1912
1946
|
* SECURITY: getAccessToken requires service token authentication.
|
|
1913
1947
|
* Only use in backend functions, not frontend code.
|
package/dist/index.js
CHANGED
|
@@ -852,8 +852,8 @@ var APIClient = class {
|
|
|
852
852
|
return this.service;
|
|
853
853
|
}
|
|
854
854
|
/**
|
|
855
|
-
* Lazy getter for connectors module
|
|
856
|
-
*
|
|
855
|
+
* Lazy getter for connectors module.
|
|
856
|
+
* Provides access to external service tokens.
|
|
857
857
|
*
|
|
858
858
|
* SECURITY: getAccessToken requires service token authentication.
|
|
859
859
|
* Only use in backend functions, not frontend code.
|