skapi-js 1.5.2-beta.9 → 1.5.2

package/dist/skapi.d.mts

@@ -463,6 +463,15 @@ type FetchOptions = {
     /** Callback for database request progress. Useful when building progress bar. */
     progress?: ProgressCallback;
 };
+type PollingResult = {
+    response_body: any;
+    error: any;
+    updated: number;
+    request_body: any;
+    status_code: number | null;
+    expires: number | null;
+    status: 'resolved' | 'failed' | 'pending';
+};
 type DatabaseResponse<T> = {
     list: T[];
     startKey: {
@@ -492,6 +501,11 @@ type Table = {
     table: string;
     number_of_records: string;
     size: number;
+    number_of_records_in_access_group_public?: number;
+    number_of_records_in_access_group_private?: number;
+    number_of_records_in_access_group_authorized?: number;
+    number_of_records_in_access_group_admin?: number;
+    [number_of_records_in_access_group_xx: string]: number | string | undefined;
 };
 type Index = {
     table: string;
@@ -536,6 +550,7 @@ type Types_Form<T> = Form<T>;
 type Types_GetRecordQuery = GetRecordQuery;
 type Types_Index = Index;
 type Types_Newsletter = Newsletter;
+type Types_PollingResult = PollingResult;
 type Types_PostRecordConfig = PostRecordConfig;
 type Types_ProgressCallback = ProgressCallback;
 type Types_RTCConnector = RTCConnector;
@@ -554,7 +569,7 @@ type Types_UserProfile = UserProfile;
 type Types_UserPublic = UserPublic;
 type Types_WebSocketMessage = WebSocketMessage;
 declare namespace Types {
-  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_PostRecordConfig as PostRecordConfig, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_UniqueId as UniqueId, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
+  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_PollingResult as PollingResult, Types_PostRecordConfig as PostRecordConfig, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_UniqueId as UniqueId, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
 }
 
 declare function terminatePendingRequests(): void;
@@ -787,7 +802,7 @@ declare class Skapi {
     resendInvitation(params: Form<{
         email: string;
         confirmation_url?: string;
-    }>): Promise<"SUCCESS: Invitation has been re-sent. (User ID: xxx...)">;
+    }>): Promise<'SUCCESS: Invitation has been re-sent. (User ID: xxx...)'>;
     /**
      * Cancels a pending invitation for the target email address.
      * @param params Request parameters.
@@ -795,7 +810,7 @@ declare class Skapi {
      */
     cancelInvitation(params: Form<{
         email: string;
-    }>): Promise<"SUCCESS: Invitation has been canceled.">;
+    }>): Promise<'SUCCESS: Invitation has been canceled.'>;
     /**
      * Lists invitation records with optional email filtering and pagination.
      * @param params Request parameters.
@@ -839,6 +854,7 @@ declare class Skapi {
         url: string;
         clientSecretName: string;
         poll?: boolean | number;
+        expires?: number;
         method: 'GET' | 'POST' | 'DELETE' | 'PUT';
         headers?: {
             [key: string]: string;
@@ -859,12 +875,10 @@ declare class Skapi {
     clientSecretRequestHistory(params: {
         url: string;
         method: 'GET' | 'POST' | 'DELETE' | 'PUT';
-    }, fetchOptions?: FetchOptions): DatabaseResponse<{
-        response_body: any;
-        error: any;
-        updated: number;
-        request_body: any;
-    }[]>;
+        poll?: number;
+    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<PollingResult[]> & {
+        pending: Promise<PollingResult>[];
+    }>;
     /**
      * Consumes a one-time ticket and executes the ticketed request payload.
      * @param params Request parameters.
@@ -924,7 +938,7 @@ declare class Skapi {
         email: string;
         subject: string;
         message: string;
-    }>): Promise<"SUCCESS: Inquiry has been sent.">;
+    }>): Promise<'SUCCESS: Inquiry has been sent.'>;
     /**
      * Blocks a user account by user_id.
      * @param params Payload for the request.
@@ -932,7 +946,7 @@ declare class Skapi {
      */
     blockAccount(params: {
         user_id: string;
-    }): Promise<"SUCCESS: The user has been blocked.">;
+    }): Promise<'SUCCESS: The user has been blocked.'>;
     /**
      * Unblocks a previously blocked user account by user_id.
      * @param params Payload for the request.
@@ -940,7 +954,7 @@ declare class Skapi {
      */
     unblockAccount(params: {
         user_id: string;
-    }): Promise<"SUCCESS: The user has been unblocked.">;
+    }): Promise<'SUCCESS: The user has been unblocked.'>;
     /**
      * Deletes a user account by user_id.
      * @param params Payload for the request.
@@ -948,7 +962,7 @@ declare class Skapi {
      */
     deleteAccount(params: {
         user_id: string;
-    }): Promise<"SUCCESS: Account has been deleted.">;
+    }): Promise<'SUCCESS: Account has been deleted.'>;
     /**
      * Invites a user by email with optional attributes and invitation email options.
      * @param params Payload for the request.
@@ -1150,7 +1164,7 @@ declare class Skapi {
      */
     recoverAccount(
     /** Redirect url on confirmation success. */
-    redirect?: boolean | string): Promise<"SUCCESS: Recovery e-mail has been sent.">;
+    redirect?: boolean | string): Promise<'SUCCESS: Recovery e-mail has been sent.'>;
     /**
      * Queries users by supported profile/search fields with pagination.
      * @param params Request parameters.
@@ -1224,7 +1238,7 @@ declare class Skapi {
     pushNotification(params: {
         title: string;
         body: string;
-    }, user_ids?: string | string[]): Promise<"SUCCESS: Notification sent.">;
+    }, user_ids?: string | string[]): Promise<'SUCCESS: Notification sent.'>;
     /**
      * Fetches newsletter delivery records with filters and pagination.
      * @param params Request parameters.
@@ -1415,7 +1429,7 @@ declare class Skapi {
         code: string | number;
         /** New password to set. Verification code is required. */
         new_password: string;
-    }>): Promise<"SUCCESS: New password has been set.">;
+    }>): Promise<'SUCCESS: New password has been set.'>;
     /**
      * Verifies the user email address with a confirmation code.
      * @param params Payload for the request.
@@ -1440,7 +1454,7 @@ declare class Skapi {
     forgotPassword(params: Form<{
         /** Signin E-Mail. */
         email: string;
-    }>): Promise<"SUCCESS: Verification code has been sent.">;
+    }>): Promise<'SUCCESS: Verification code has been sent.'>;
     /**
      * Changes password for the authenticated user.
      * @param params Request parameters.
@@ -1526,7 +1540,7 @@ declare class Skapi {
         group: number | 'public' | 'authorized' | 'admin';
         redirect?: string;
     }>): Promise<string>;
-    bulkPostRecords(config: PostRecordConfig): Promise<RecordData[]>;
+    bulkPostRecords(config: PostRecordConfig[]): Promise<RecordData[]>;
 }
 
 declare class SkapiError extends Error {

package/dist/skapi.d.ts

@@ -463,6 +463,15 @@ type FetchOptions = {
     /** Callback for database request progress. Useful when building progress bar. */
     progress?: ProgressCallback;
 };
+type PollingResult = {
+    response_body: any;
+    error: any;
+    updated: number;
+    request_body: any;
+    status_code: number | null;
+    expires: number | null;
+    status: 'resolved' | 'failed' | 'pending';
+};
 type DatabaseResponse<T> = {
     list: T[];
     startKey: {
@@ -492,6 +501,11 @@ type Table = {
     table: string;
     number_of_records: string;
     size: number;
+    number_of_records_in_access_group_public?: number;
+    number_of_records_in_access_group_private?: number;
+    number_of_records_in_access_group_authorized?: number;
+    number_of_records_in_access_group_admin?: number;
+    [number_of_records_in_access_group_xx: string]: number | string | undefined;
 };
 type Index = {
     table: string;
@@ -536,6 +550,7 @@ type Types_Form<T> = Form<T>;
 type Types_GetRecordQuery = GetRecordQuery;
 type Types_Index = Index;
 type Types_Newsletter = Newsletter;
+type Types_PollingResult = PollingResult;
 type Types_PostRecordConfig = PostRecordConfig;
 type Types_ProgressCallback = ProgressCallback;
 type Types_RTCConnector = RTCConnector;
@@ -554,7 +569,7 @@ type Types_UserProfile = UserProfile;
 type Types_UserPublic = UserPublic;
 type Types_WebSocketMessage = WebSocketMessage;
 declare namespace Types {
-  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_PostRecordConfig as PostRecordConfig, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_UniqueId as UniqueId, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
+  export type { Types_BinaryFile as BinaryFile, Types_Condition as Condition, Types_Connection as Connection, Types_ConnectionInfo as ConnectionInfo, Types_DatabaseResponse as DatabaseResponse, Types_DelRecordQuery as DelRecordQuery, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_PollingResult as PollingResult, Types_PostRecordConfig as PostRecordConfig, Types_ProgressCallback as ProgressCallback, Types_RTCConnector as RTCConnector, Types_RTCConnectorParams as RTCConnectorParams, Types_RTCEvent as RTCEvent, Types_RTCReceiverParams as RTCReceiverParams, Types_RTCResolved as RTCResolved, Types_RealtimeCallback as RealtimeCallback, Types_RecordData as RecordData, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_UniqueId as UniqueId, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
 }
 
 declare function terminatePendingRequests(): void;
@@ -787,7 +802,7 @@ declare class Skapi {
     resendInvitation(params: Form<{
         email: string;
         confirmation_url?: string;
-    }>): Promise<"SUCCESS: Invitation has been re-sent. (User ID: xxx...)">;
+    }>): Promise<'SUCCESS: Invitation has been re-sent. (User ID: xxx...)'>;
     /**
      * Cancels a pending invitation for the target email address.
      * @param params Request parameters.
@@ -795,7 +810,7 @@ declare class Skapi {
      */
     cancelInvitation(params: Form<{
         email: string;
-    }>): Promise<"SUCCESS: Invitation has been canceled.">;
+    }>): Promise<'SUCCESS: Invitation has been canceled.'>;
     /**
      * Lists invitation records with optional email filtering and pagination.
      * @param params Request parameters.
@@ -839,6 +854,7 @@ declare class Skapi {
         url: string;
         clientSecretName: string;
         poll?: boolean | number;
+        expires?: number;
         method: 'GET' | 'POST' | 'DELETE' | 'PUT';
         headers?: {
             [key: string]: string;
@@ -859,12 +875,10 @@ declare class Skapi {
     clientSecretRequestHistory(params: {
         url: string;
         method: 'GET' | 'POST' | 'DELETE' | 'PUT';
-    }, fetchOptions?: FetchOptions): DatabaseResponse<{
-        response_body: any;
-        error: any;
-        updated: number;
-        request_body: any;
-    }[]>;
+        poll?: number;
+    }, fetchOptions?: FetchOptions): Promise<DatabaseResponse<PollingResult[]> & {
+        pending: Promise<PollingResult>[];
+    }>;
     /**
      * Consumes a one-time ticket and executes the ticketed request payload.
      * @param params Request parameters.
@@ -924,7 +938,7 @@ declare class Skapi {
         email: string;
         subject: string;
         message: string;
-    }>): Promise<"SUCCESS: Inquiry has been sent.">;
+    }>): Promise<'SUCCESS: Inquiry has been sent.'>;
     /**
      * Blocks a user account by user_id.
      * @param params Payload for the request.
@@ -932,7 +946,7 @@ declare class Skapi {
      */
     blockAccount(params: {
         user_id: string;
-    }): Promise<"SUCCESS: The user has been blocked.">;
+    }): Promise<'SUCCESS: The user has been blocked.'>;
     /**
      * Unblocks a previously blocked user account by user_id.
      * @param params Payload for the request.
@@ -940,7 +954,7 @@ declare class Skapi {
      */
     unblockAccount(params: {
         user_id: string;
-    }): Promise<"SUCCESS: The user has been unblocked.">;
+    }): Promise<'SUCCESS: The user has been unblocked.'>;
     /**
      * Deletes a user account by user_id.
      * @param params Payload for the request.
@@ -948,7 +962,7 @@ declare class Skapi {
      */
     deleteAccount(params: {
         user_id: string;
-    }): Promise<"SUCCESS: Account has been deleted.">;
+    }): Promise<'SUCCESS: Account has been deleted.'>;
     /**
      * Invites a user by email with optional attributes and invitation email options.
      * @param params Payload for the request.
@@ -1150,7 +1164,7 @@ declare class Skapi {
      */
     recoverAccount(
     /** Redirect url on confirmation success. */
-    redirect?: boolean | string): Promise<"SUCCESS: Recovery e-mail has been sent.">;
+    redirect?: boolean | string): Promise<'SUCCESS: Recovery e-mail has been sent.'>;
     /**
      * Queries users by supported profile/search fields with pagination.
      * @param params Request parameters.
@@ -1224,7 +1238,7 @@ declare class Skapi {
     pushNotification(params: {
         title: string;
         body: string;
-    }, user_ids?: string | string[]): Promise<"SUCCESS: Notification sent.">;
+    }, user_ids?: string | string[]): Promise<'SUCCESS: Notification sent.'>;
     /**
      * Fetches newsletter delivery records with filters and pagination.
      * @param params Request parameters.
@@ -1415,7 +1429,7 @@ declare class Skapi {
         code: string | number;
         /** New password to set. Verification code is required. */
         new_password: string;
-    }>): Promise<"SUCCESS: New password has been set.">;
+    }>): Promise<'SUCCESS: New password has been set.'>;
     /**
      * Verifies the user email address with a confirmation code.
      * @param params Payload for the request.
@@ -1440,7 +1454,7 @@ declare class Skapi {
     forgotPassword(params: Form<{
         /** Signin E-Mail. */
         email: string;
-    }>): Promise<"SUCCESS: Verification code has been sent.">;
+    }>): Promise<'SUCCESS: Verification code has been sent.'>;
     /**
      * Changes password for the authenticated user.
      * @param params Request parameters.
@@ -1526,7 +1540,7 @@ declare class Skapi {
         group: number | 'public' | 'authorized' | 'admin';
         redirect?: string;
     }>): Promise<string>;
-    bulkPostRecords(config: PostRecordConfig): Promise<RecordData[]>;
+    bulkPostRecords(config: PostRecordConfig[]): Promise<RecordData[]>;
 }
 
 declare class SkapiError extends Error {