Delete

Deletes one document by a specified document id or filter.

Use this API method when you want to find one document by a specified filter or id and delete it. If many documents are found, only the first one will be deleted.

Error with https://760328771-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-LwSkuCpTNI_AerL8J2a%2Fuploads%2FCpzJktmKXD6FMPSah1nK%2Fopenapi.json?alt=media&token=854cdd6a-61b2-49a5-99f4-6bc091e5c3d6: Failed to convert Swagger 2.0 to OpenAPI 3.0: Operation UpdateManyRequestdbCollectionNamebulk_Update has multiple requestBodies

.NET

var client = new CodeMashClient(apiKey, projectId);
var service = new CodeMashRepository<Person>(client);

await service.DeleteOneAsync(
    x => x.Id == "record_id"
);

Check the information about entities on how your filter parameters are mapped.

Node

import { db } from 'codemash';

export async function deleteEmployee(id) {
    return await db.deleteRecord('employees', { _id: id });
}

PHP

use Codemash\CodemashClient;
use Codemash\CodemashDb;

class CodemashService
{
    protected CodemashDb $codemashDb;
    protected string $collectionName = '{YOUR_COLLECTION_NAME}';

    public function __construct()
    {
        $secretKey = '{YOUR_SECRET_KEY}';
        $projectId = '{YOUR_PROJECT_ID}';

        $client = new CodemashClient($secretKey, $projectId);
        $this->codemashDb = new CodemashDb($client);
    }

    public function deleteOne()
    {
        $responseData = $this->codemashDb->deleteOneWithFilter([
        	'collectionName' => 'employees',
        	'filter' => [
        		'email' => '[e-mail]',
        	],
        ]);
    }
}

Check the docs on how to form filters.