Skip to content

BrandProtectionApi.md

Latest commit

 

History

History
1011 lines (665 loc) · 31.5 KB

BrandProtectionApi.md

File metadata and controls

1011 lines (665 loc) · 31.5 KB

cloudflare_dart.api.BrandProtectionApi

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
accountsAccountIdBrandProtectionAlertsClearPatch PATCH /accounts/{account_id}/brand-protection/alerts/clear Update verification statuses of tracked URLs to awaiting by ID
accountsAccountIdBrandProtectionAlertsGet GET /accounts/{account_id}/brand-protection/alerts Read all alerts on submitted domains
accountsAccountIdBrandProtectionAlertsPatch PATCH /accounts/{account_id}/brand-protection/alerts Update alerts on submitted domains by ID
accountsAccountIdBrandProtectionAlertsRefutePatch PATCH /accounts/{account_id}/brand-protection/alerts/refute Update verification statuses of tracked URLs to disproven by ID
accountsAccountIdBrandProtectionAlertsVerifyPatch PATCH /accounts/{account_id}/brand-protection/alerts/verify Update verification statuses of tracked URLs to confirmed by ID
accountsAccountIdBrandProtectionBrandsDelete DELETE /accounts/{account_id}/brand-protection/brands Delete brands by ID
accountsAccountIdBrandProtectionBrandsGet GET /accounts/{account_id}/brand-protection/brands Read all brands
accountsAccountIdBrandProtectionBrandsPatternsDelete DELETE /accounts/{account_id}/brand-protection/brands/patterns Delete patterns for brands by ID
accountsAccountIdBrandProtectionBrandsPatternsGet GET /accounts/{account_id}/brand-protection/brands/patterns Read patterns for brands by ID
accountsAccountIdBrandProtectionBrandsPatternsPost POST /accounts/{account_id}/brand-protection/brands/patterns Create new patterns for brands by ID
accountsAccountIdBrandProtectionBrandsPost POST /accounts/{account_id}/brand-protection/brands Create new brands
accountsAccountIdBrandProtectionClearPatch PATCH /accounts/{account_id}/brand-protection/clear Update verification statuses of submitted URLs to awaiting by ID
accountsAccountIdBrandProtectionDomainInfoGet GET /accounts/{account_id}/brand-protection/domain-info Read submitted domains by ID
accountsAccountIdBrandProtectionRecentSubmissionsGet GET /accounts/{account_id}/brand-protection/recent-submissions Read recent URL submissions
accountsAccountIdBrandProtectionRefutePatch PATCH /accounts/{account_id}/brand-protection/refute Update verification statuses of submitted URLs to disproven by ID
accountsAccountIdBrandProtectionSubmissionInfoGet GET /accounts/{account_id}/brand-protection/submission-info Read URL submissions by ID
accountsAccountIdBrandProtectionSubmitPost POST /accounts/{account_id}/brand-protection/submit Create new URL submissions
accountsAccountIdBrandProtectionTrackedDomainsGet GET /accounts/{account_id}/brand-protection/tracked-domains Read submitted domains by pattern
accountsAccountIdBrandProtectionUrlInfoGet GET /accounts/{account_id}/brand-protection/url-info Read submitted URLs by ID
accountsAccountIdBrandProtectionVerifyPatch PATCH /accounts/{account_id}/brand-protection/verify Update verification statuses of submitted URLs to confirmed by ID
internalSubmitPost POST /internal/submit Internal route for testing URL submissions
liveGet GET /live Run liveness checks
readyGet GET /ready Run readiness checks

accountsAccountIdBrandProtectionAlertsClearPatch

BrandProtectionApiError accountsAccountIdBrandProtectionAlertsClearPatch(accountId)

Update verification statuses of tracked URLs to awaiting by ID

Return a success message after updating verification statuses of tracked URLs to awaiting by ID

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionAlertsGet

BrandProtectionApiError accountsAccountIdBrandProtectionAlertsGet(accountId)

Read all alerts on submitted domains

Return all alerts on submitted domains

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionAlertsPatch

BrandProtectionApiError accountsAccountIdBrandProtectionAlertsPatch(accountId)

Update alerts on submitted domains by ID

Return a success message after updating alerts on submitted domains by ID

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionAlertsRefutePatch

BrandProtectionApiError accountsAccountIdBrandProtectionAlertsRefutePatch(accountId)

Update verification statuses of tracked URLs to disproven by ID

Return a success message after updating verification statuses of tracked URLs to disproven by ID

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionAlertsVerifyPatch

BrandProtectionApiError accountsAccountIdBrandProtectionAlertsVerifyPatch(accountId)

Update verification statuses of tracked URLs to confirmed by ID

Return a success message after updating verification statuses of tracked URLs to confirmed by ID

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionBrandsDelete

BrandProtectionApiError accountsAccountIdBrandProtectionBrandsDelete(accountId)

Delete brands by ID

Return a success message after deleting brands by ID

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionBrandsGet

BrandProtectionApiError accountsAccountIdBrandProtectionBrandsGet(accountId)

Read all brands

Return all brands

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionBrandsPatternsDelete

BrandProtectionApiError accountsAccountIdBrandProtectionBrandsPatternsDelete(accountId)

Delete patterns for brands by ID

Return a success message after deleting patterns for brands by ID

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionBrandsPatternsGet

BrandProtectionApiError accountsAccountIdBrandProtectionBrandsPatternsGet(accountId)

Read patterns for brands by ID

Return patterns for brands based on ID

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionBrandsPatternsPost

BrandProtectionApiError accountsAccountIdBrandProtectionBrandsPatternsPost(accountId)

Create new patterns for brands by ID

Return a success message after creating new patterns for brands by ID

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionBrandsPost

BrandProtectionApiError accountsAccountIdBrandProtectionBrandsPost(accountId)

Create new brands

Return new brands

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionClearPatch

BrandProtectionApiError accountsAccountIdBrandProtectionClearPatch(accountId)

Update verification statuses of submitted URLs to awaiting by ID

Return a success message after updating verification statuses of submitted URLs to awaiting by ID

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionDomainInfoGet

BrandProtectionApiError accountsAccountIdBrandProtectionDomainInfoGet(accountId)

Read submitted domains by ID

Return submitted domains based on ID

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionRecentSubmissionsGet

BrandProtectionApiError accountsAccountIdBrandProtectionRecentSubmissionsGet(accountId)

Read recent URL submissions

Return recent URL submissions

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionRefutePatch

BrandProtectionApiError accountsAccountIdBrandProtectionRefutePatch(accountId)

Update verification statuses of submitted URLs to disproven by ID

Return a success message after updating verification statuses of submitted URLs to disproven by ID

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionSubmissionInfoGet

BrandProtectionApiError accountsAccountIdBrandProtectionSubmissionInfoGet(accountId)

Read URL submissions by ID

Return URL submissions based on ID

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionSubmitPost

BrandProtectionApiURLSubmit accountsAccountIdBrandProtectionSubmitPost(accountId)

Create new URL submissions

Return new URL submissions

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiURLSubmit

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionTrackedDomainsGet

BrandProtectionApiError accountsAccountIdBrandProtectionTrackedDomainsGet(accountId)

Read submitted domains by pattern

Return submitted domains based on pattern

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionUrlInfoGet

BrandProtectionApiURLInfo accountsAccountIdBrandProtectionUrlInfoGet(accountId)

Read submitted URLs by ID

Return submitted URLs based on ID

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiURLInfo

Authorization

api_token

HTTP request headers

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

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

accountsAccountIdBrandProtectionVerifyPatch

BrandProtectionApiError accountsAccountIdBrandProtectionVerifyPatch(accountId)

Update verification statuses of submitted URLs to confirmed by ID

Return a success message after updating verification statuses of submitted URLs to confirmed by ID

Example

import 'package:cloudflare_dart/api.dart';

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

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

Parameters

Name Type Description Notes
accountId String

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

internalSubmitPost

BrandProtectionApiError internalSubmitPost()

Internal route for testing URL submissions

Example

import 'package:cloudflare_dart/api.dart';

final api = CloudflareDart().getBrandProtectionApi();

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

Parameters

This endpoint does not need any parameter.

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

liveGet

BrandProtectionApiError liveGet()

Run liveness checks

Return a success message after running liveness checks

Example

import 'package:cloudflare_dart/api.dart';

final api = CloudflareDart().getBrandProtectionApi();

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

Parameters

This endpoint does not need any parameter.

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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

readyGet

BrandProtectionApiError readyGet()

Run readiness checks

Return a success message after running readiness checks

Example

import 'package:cloudflare_dart/api.dart';

final api = CloudflareDart().getBrandProtectionApi();

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

Parameters

This endpoint does not need any parameter.

Return type

BrandProtectionApiError

Authorization

api_token

HTTP request headers

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

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