Skip to content

CloudflareImagesVariantsApi.md

Latest commit

 

History

History
283 lines (203 loc) · 11.2 KB

CloudflareImagesVariantsApi.md

File metadata and controls

283 lines (203 loc) · 11.2 KB

cloudflare_dart.api.CloudflareImagesVariantsApi

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
cloudflareImagesVariantsCreateAVariant POST /accounts/{account_id}/images/v1/variants Create a variant
cloudflareImagesVariantsDeleteAVariant DELETE /accounts/{account_id}/images/v1/variants/{variant_id} Delete a variant
cloudflareImagesVariantsListVariants GET /accounts/{account_id}/images/v1/variants List variants
cloudflareImagesVariantsUpdateAVariant PATCH /accounts/{account_id}/images/v1/variants/{variant_id} Update a variant
cloudflareImagesVariantsVariantDetails GET /accounts/{account_id}/images/v1/variants/{variant_id} Variant details

cloudflareImagesVariantsCreateAVariant

ImagesImageVariantSimpleResponse cloudflareImagesVariantsCreateAVariant(accountId, imagesImageVariantDefinition)

Create a variant

Specify variants that allow you to resize images for different use cases.

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().getCloudflareImagesVariantsApi();
final String accountId = accountId_example; // String | 
final ImagesImageVariantDefinition imagesImageVariantDefinition = ; // ImagesImageVariantDefinition | 

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

Parameters

Name Type Description Notes
accountId String
imagesImageVariantDefinition ImagesImageVariantDefinition

Return type

ImagesImageVariantSimpleResponse

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]

cloudflareImagesVariantsDeleteAVariant

ImagesDeletedResponse cloudflareImagesVariantsDeleteAVariant(variantId, accountId)

Delete a variant

Deleting a variant purges the cache for all images associated with the variant.

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().getCloudflareImagesVariantsApi();
final String variantId = variantId_example; // String | 
final String accountId = accountId_example; // String | 

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

Parameters

Name Type Description Notes
variantId String
accountId String

Return type

ImagesDeletedResponse

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]

cloudflareImagesVariantsListVariants

ImagesImageVariantListResponse cloudflareImagesVariantsListVariants(accountId)

List variants

Lists existing variants.

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().getCloudflareImagesVariantsApi();
final String accountId = accountId_example; // String | 

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

Parameters

Name Type Description Notes
accountId String

Return type

ImagesImageVariantListResponse

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]

cloudflareImagesVariantsUpdateAVariant

ImagesImageVariantSimpleResponse cloudflareImagesVariantsUpdateAVariant(variantId, accountId, imagesImageVariantPatchRequest)

Update a variant

Updating a variant purges the cache for all images associated with the variant.

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().getCloudflareImagesVariantsApi();
final String variantId = variantId_example; // String | 
final String accountId = accountId_example; // String | 
final ImagesImageVariantPatchRequest imagesImageVariantPatchRequest = ; // ImagesImageVariantPatchRequest | 

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

Parameters

Name Type Description Notes
variantId String
accountId String
imagesImageVariantPatchRequest ImagesImageVariantPatchRequest

Return type

ImagesImageVariantSimpleResponse

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]

cloudflareImagesVariantsVariantDetails

ImagesImageVariantSimpleResponse cloudflareImagesVariantsVariantDetails(variantId, accountId)

Variant details

Fetch details for a single variant.

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().getCloudflareImagesVariantsApi();
final String variantId = variantId_example; // String | 
final String accountId = accountId_example; // String | 

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

Parameters

Name Type Description Notes
variantId String
accountId String

Return type

ImagesImageVariantSimpleResponse

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]