Skip to content

DLPDocumentFingerprintsApi.md

Latest commit

 

History

History
326 lines (237 loc) · 13.7 KB

DLPDocumentFingerprintsApi.md

File metadata and controls

326 lines (237 loc) · 13.7 KB

cloudflare_dart.api.DLPDocumentFingerprintsApi

Load the API package

import 'package:cloudflare_dart/api.dart';

All URIs are relative to https://api.cloudflare.com/client/v4

Method HTTP request Description
dlpDocumentFingerprintsCreate POST /accounts/{account_id}/dlp/document_fingerprints Creates a new document fingerprint.
dlpDocumentFingerprintsDelete DELETE /accounts/{account_id}/dlp/document_fingerprints/{document_fingerprint_id} Delete a single document fingerprint.
dlpDocumentFingerprintsRead GET /accounts/{account_id}/dlp/document_fingerprints/{document_fingerprint_id} Retrieve data about a specific document fingerprint.
dlpDocumentFingerprintsReadAll GET /accounts/{account_id}/dlp/document_fingerprints Retrieve data about all document fingerprints.
dlpDocumentFingerprintsUpdate POST /accounts/{account_id}/dlp/document_fingerprints/{document_fingerprint_id} Update the attributes of a single document fingerprint.
dlpDocumentFingerprintsUpload PUT /accounts/{account_id}/dlp/document_fingerprints/{document_fingerprint_id} Uploads a new version for a document fingerprint.

dlpDocumentFingerprintsCreate

DlpDocumentFingerprintsCreate200Response dlpDocumentFingerprintsCreate(accountId, dlpNewDocumentFingerprint)

Creates a new document fingerprint.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getDLPDocumentFingerprintsApi();
final String accountId = accountId_example; // String | 
final DlpNewDocumentFingerprint dlpNewDocumentFingerprint = ; // DlpNewDocumentFingerprint | Attributes of the new document fingerprint.

try {
    final response = api.dlpDocumentFingerprintsCreate(accountId, dlpNewDocumentFingerprint);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DLPDocumentFingerprintsApi->dlpDocumentFingerprintsCreate: $e\n');
}

Parameters

Name Type Description Notes
accountId String
dlpNewDocumentFingerprint DlpNewDocumentFingerprint Attributes of the new document fingerprint.

Return type

DlpDocumentFingerprintsCreate200Response

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dlpDocumentFingerprintsDelete

dlpDocumentFingerprintsDelete(accountId, documentFingerprintId)

Delete a single document fingerprint.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getDLPDocumentFingerprintsApi();
final String accountId = accountId_example; // String | 
final String documentFingerprintId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 

try {
    api.dlpDocumentFingerprintsDelete(accountId, documentFingerprintId);
} catch on DioException (e) {
    print('Exception when calling DLPDocumentFingerprintsApi->dlpDocumentFingerprintsDelete: $e\n');
}

Parameters

Name Type Description Notes
accountId String
documentFingerprintId String

Return type

void (empty response body)

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dlpDocumentFingerprintsRead

DlpDocumentFingerprintsCreate200Response dlpDocumentFingerprintsRead(accountId, documentFingerprintId)

Retrieve data about a specific document fingerprint.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getDLPDocumentFingerprintsApi();
final String accountId = accountId_example; // String | 
final String documentFingerprintId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 

try {
    final response = api.dlpDocumentFingerprintsRead(accountId, documentFingerprintId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DLPDocumentFingerprintsApi->dlpDocumentFingerprintsRead: $e\n');
}

Parameters

Name Type Description Notes
accountId String
documentFingerprintId String

Return type

DlpDocumentFingerprintsCreate200Response

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dlpDocumentFingerprintsReadAll

DlpDocumentFingerprintsReadAll200Response dlpDocumentFingerprintsReadAll(accountId)

Retrieve data about all document fingerprints.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getDLPDocumentFingerprintsApi();
final String accountId = accountId_example; // String | 

try {
    final response = api.dlpDocumentFingerprintsReadAll(accountId);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DLPDocumentFingerprintsApi->dlpDocumentFingerprintsReadAll: $e\n');
}

Parameters

Name Type Description Notes
accountId String

Return type

DlpDocumentFingerprintsReadAll200Response

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dlpDocumentFingerprintsUpdate

DlpDocumentFingerprintsCreate200Response dlpDocumentFingerprintsUpdate(accountId, documentFingerprintId, dlpUpdateDocumentFingerprint)

Update the attributes of a single document fingerprint.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getDLPDocumentFingerprintsApi();
final String accountId = accountId_example; // String | 
final String documentFingerprintId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final DlpUpdateDocumentFingerprint dlpUpdateDocumentFingerprint = ; // DlpUpdateDocumentFingerprint | Attributes of the document fingerprint to update.

try {
    final response = api.dlpDocumentFingerprintsUpdate(accountId, documentFingerprintId, dlpUpdateDocumentFingerprint);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DLPDocumentFingerprintsApi->dlpDocumentFingerprintsUpdate: $e\n');
}

Parameters

Name Type Description Notes
accountId String
documentFingerprintId String
dlpUpdateDocumentFingerprint DlpUpdateDocumentFingerprint Attributes of the document fingerprint to update.

Return type

DlpDocumentFingerprintsCreate200Response

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

dlpDocumentFingerprintsUpload

DlpDocumentFingerprintsUpload200Response dlpDocumentFingerprintsUpload(accountId, documentFingerprintId, file)

Uploads a new version for a document fingerprint.

Example

import 'package:cloudflare_dart/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
// TODO Configure API key authorization: api_email
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('api_email').apiKeyPrefix = 'Bearer';

final api = CloudflareDart().getDLPDocumentFingerprintsApi();
final String accountId = accountId_example; // String | 
final String documentFingerprintId = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | 
final MultipartFile file = BINARY_DATA_HERE; // MultipartFile | 

try {
    final response = api.dlpDocumentFingerprintsUpload(accountId, documentFingerprintId, file);
    print(response);
} catch on DioException (e) {
    print('Exception when calling DLPDocumentFingerprintsApi->dlpDocumentFingerprintsUpload: $e\n');
}

Parameters

Name Type Description Notes
accountId String
documentFingerprintId String
file MultipartFile

Return type

DlpDocumentFingerprintsUpload200Response

Authorization

api_key, api_token, api_email

HTTP request headers

  • Content-Type: multipart/form-data
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]