skapi-js 2.2.6-beta.4 → 2.2.6-beta.5

package/dist/skapi.d.mts

@@ -583,6 +583,28 @@ type FileUploadError = {
      */
     error: SkapiError;
 };
+/** One item of postRecords(): the two arguments postRecord() takes, as one object. */
+type PostRecordsItem = {
+    /**
+     * The record's data, as postRecord()'s first argument: an object, or null. Leave it out (undefined)
+     * to keep a record's stored data as it is on an update. Files are not attached here: attach them
+     * with uploadFiles() to the saved record.
+     */
+    data?: Record<string, any> | null;
+    /** The record's configuration, as postRecord()'s second argument. */
+    config: PostRecordConfig;
+};
+/** What postRecords() resolves with. `list.length + failed.length` is the number of items given. */
+type PostRecordsResult = {
+    /** The records that were saved, in the order their items were given. */
+    list: RecordData[];
+    /** The items that were not saved, in the order they were given. `index` is the item's position in the input. */
+    failed: {
+        index: number;
+        code: string;
+        message: string;
+    }[];
+};
 /** What uploadFiles() resolves with. */
 type UploadFilesResult = {
     /** Files that are stored. */
@@ -1272,6 +1294,8 @@ type Types_Index = Index;
 type Types_Newsletter = Newsletter;
 type Types_NewsletterGroup = NewsletterGroup;
 type Types_PostRecordConfig = PostRecordConfig;
+type Types_PostRecordsItem = PostRecordsItem;
+type Types_PostRecordsResult = PostRecordsResult;
 type Types_ProgressCallback = ProgressCallback;
 type Types_RTCConnector = RTCConnector;
 type Types_RTCConnectorParams = RTCConnectorParams;
@@ -1303,7 +1327,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_EncryptionOptions as EncryptionOptions, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_FileUploadError as FileUploadError, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_NewsletterGroup as NewsletterGroup, 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_RecordEncryptionInfo as RecordEncryptionInfo, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_Ticket as Ticket, Types_TicketAction as TicketAction, Types_TicketCondition as TicketCondition, Types_TicketConditionOperator as TicketConditionOperator, Types_TicketConditionRow as TicketConditionRow, Types_TicketError as TicketError, Types_TicketErrorCode as TicketErrorCode, Types_TicketReceipt as TicketReceipt, Types_TicketResponseCondition as TicketResponseCondition, Types_TicketSignatureCondition as TicketSignatureCondition, Types_UniqueId as UniqueId, Types_UploadFilesParams as UploadFilesParams, Types_UploadFilesResult as UploadFilesResult, 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_EncryptionOptions as EncryptionOptions, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_FileUploadError as FileUploadError, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_NewsletterGroup as NewsletterGroup, Types_PostRecordConfig as PostRecordConfig, Types_PostRecordsItem as PostRecordsItem, Types_PostRecordsResult as PostRecordsResult, 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_RecordEncryptionInfo as RecordEncryptionInfo, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_Ticket as Ticket, Types_TicketAction as TicketAction, Types_TicketCondition as TicketCondition, Types_TicketConditionOperator as TicketConditionOperator, Types_TicketConditionRow as TicketConditionRow, Types_TicketError as TicketError, Types_TicketErrorCode as TicketErrorCode, Types_TicketReceipt as TicketReceipt, Types_TicketResponseCondition as TicketResponseCondition, Types_TicketSignatureCondition as TicketSignatureCondition, Types_UniqueId as UniqueId, Types_UploadFilesParams as UploadFilesParams, Types_UploadFilesResult as UploadFilesResult, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
 }
 
 declare function terminatePendingRequests(): void;
@@ -3139,6 +3163,15 @@ declare class Skapi {
         name: string;
         file: File;
     }[]): Promise<RecordData>;
+    /**
+     * Creates or updates several records in one call, 100 records to a request. Each item is the two arguments of postRecord() as one object: `{ data, config }`.
+     * Resolves with `list`, the records that were saved in the order their items were given, and `failed`, the items that were not saved, each with its `index` in the input, a `code` and a `message`.
+     * A refused item never rejects the call, and the items after it are still posted; only a failure of a request itself (connection, sign-in, a server error) rejects, and the records saved before it stay saved.
+     * Files are not attached here: use uploadFiles() on a saved record.
+     * @param items Non-empty array of `{ data, config }` items.
+     * @returns A promise that resolves to Promise<PostRecordsResult>.
+     */
+    postRecords(items: PostRecordsItem[]): Promise<PostRecordsResult>;
     /**
      * Fetches subscriber/subscription relationships with filters and pagination. At least one of `subscriber` or `subscription` must be provided.
      * @param params Request parameters.

package/dist/skapi.d.ts

@@ -583,6 +583,28 @@ type FileUploadError = {
      */
     error: SkapiError;
 };
+/** One item of postRecords(): the two arguments postRecord() takes, as one object. */
+type PostRecordsItem = {
+    /**
+     * The record's data, as postRecord()'s first argument: an object, or null. Leave it out (undefined)
+     * to keep a record's stored data as it is on an update. Files are not attached here: attach them
+     * with uploadFiles() to the saved record.
+     */
+    data?: Record<string, any> | null;
+    /** The record's configuration, as postRecord()'s second argument. */
+    config: PostRecordConfig;
+};
+/** What postRecords() resolves with. `list.length + failed.length` is the number of items given. */
+type PostRecordsResult = {
+    /** The records that were saved, in the order their items were given. */
+    list: RecordData[];
+    /** The items that were not saved, in the order they were given. `index` is the item's position in the input. */
+    failed: {
+        index: number;
+        code: string;
+        message: string;
+    }[];
+};
 /** What uploadFiles() resolves with. */
 type UploadFilesResult = {
     /** Files that are stored. */
@@ -1272,6 +1294,8 @@ type Types_Index = Index;
 type Types_Newsletter = Newsletter;
 type Types_NewsletterGroup = NewsletterGroup;
 type Types_PostRecordConfig = PostRecordConfig;
+type Types_PostRecordsItem = PostRecordsItem;
+type Types_PostRecordsResult = PostRecordsResult;
 type Types_ProgressCallback = ProgressCallback;
 type Types_RTCConnector = RTCConnector;
 type Types_RTCConnectorParams = RTCConnectorParams;
@@ -1303,7 +1327,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_EncryptionOptions as EncryptionOptions, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_FileUploadError as FileUploadError, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_NewsletterGroup as NewsletterGroup, 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_RecordEncryptionInfo as RecordEncryptionInfo, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_Ticket as Ticket, Types_TicketAction as TicketAction, Types_TicketCondition as TicketCondition, Types_TicketConditionOperator as TicketConditionOperator, Types_TicketConditionRow as TicketConditionRow, Types_TicketError as TicketError, Types_TicketErrorCode as TicketErrorCode, Types_TicketReceipt as TicketReceipt, Types_TicketResponseCondition as TicketResponseCondition, Types_TicketSignatureCondition as TicketSignatureCondition, Types_UniqueId as UniqueId, Types_UploadFilesParams as UploadFilesParams, Types_UploadFilesResult as UploadFilesResult, 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_EncryptionOptions as EncryptionOptions, Types_FetchOptions as FetchOptions, Types_FileInfo as FileInfo, Types_FileUploadError as FileUploadError, Types_Form as Form, Types_GetRecordQuery as GetRecordQuery, Types_Index as Index, Types_Newsletter as Newsletter, Types_NewsletterGroup as NewsletterGroup, Types_PostRecordConfig as PostRecordConfig, Types_PostRecordsItem as PostRecordsItem, Types_PostRecordsResult as PostRecordsResult, 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_RecordEncryptionInfo as RecordEncryptionInfo, Types_RequestHistory as RequestHistory, Types_Subscription as Subscription, Types_Table as Table, Types_Tag as Tag, Types_Ticket as Ticket, Types_TicketAction as TicketAction, Types_TicketCondition as TicketCondition, Types_TicketConditionOperator as TicketConditionOperator, Types_TicketConditionRow as TicketConditionRow, Types_TicketError as TicketError, Types_TicketErrorCode as TicketErrorCode, Types_TicketReceipt as TicketReceipt, Types_TicketResponseCondition as TicketResponseCondition, Types_TicketSignatureCondition as TicketSignatureCondition, Types_UniqueId as UniqueId, Types_UploadFilesParams as UploadFilesParams, Types_UploadFilesResult as UploadFilesResult, Types_UserAttributes as UserAttributes, Types_UserProfile as UserProfile, Types_UserPublic as UserPublic, Types_WebSocketMessage as WebSocketMessage };
 }
 
 declare function terminatePendingRequests(): void;
@@ -3139,6 +3163,15 @@ declare class Skapi {
         name: string;
         file: File;
     }[]): Promise<RecordData>;
+    /**
+     * Creates or updates several records in one call, 100 records to a request. Each item is the two arguments of postRecord() as one object: `{ data, config }`.
+     * Resolves with `list`, the records that were saved in the order their items were given, and `failed`, the items that were not saved, each with its `index` in the input, a `code` and a `message`.
+     * A refused item never rejects the call, and the items after it are still posted; only a failure of a request itself (connection, sign-in, a server error) rejects, and the records saved before it stay saved.
+     * Files are not attached here: use uploadFiles() on a saved record.
+     * @param items Non-empty array of `{ data, config }` items.
+     * @returns A promise that resolves to Promise<PostRecordsResult>.
+     */
+    postRecords(items: PostRecordsItem[]): Promise<PostRecordsResult>;
     /**
      * Fetches subscriber/subscription relationships with filters and pagination. At least one of `subscriber` or `subscription` must be provided.
      * @param params Request parameters.