Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 10.8 KB

NotificationTemplateV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 10.8 KB

halo_client.api.NotificationTemplateV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

All URIs are relative to http://localhost:8091

Method HTTP request Description
createNotificationTemplate POST /apis/notification.halo.run/v1alpha1/notificationtemplates
deleteNotificationTemplate DELETE /apis/notification.halo.run/v1alpha1/notificationtemplates/{name}
getNotificationTemplate GET /apis/notification.halo.run/v1alpha1/notificationtemplates/{name}
listNotificationTemplate GET /apis/notification.halo.run/v1alpha1/notificationtemplates
patchNotificationTemplate PATCH /apis/notification.halo.run/v1alpha1/notificationtemplates/{name}
updateNotificationTemplate PUT /apis/notification.halo.run/v1alpha1/notificationtemplates/{name}

createNotificationTemplate

NotificationTemplate createNotificationTemplate(notificationTemplate)

Create NotificationTemplate

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getNotificationTemplateV1alpha1Api();
final NotificationTemplate notificationTemplate = ; // NotificationTemplate | Fresh notificationtemplate

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

Parameters

Name Type Description Notes
notificationTemplate NotificationTemplate Fresh notificationtemplate [optional]

Return type

NotificationTemplate

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

deleteNotificationTemplate

deleteNotificationTemplate(name)

Delete NotificationTemplate

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getNotificationTemplateV1alpha1Api();
final String name = name_example; // String | Name of notificationtemplate

try {
    api.deleteNotificationTemplate(name);
} catch on DioException (e) {
    print('Exception when calling NotificationTemplateV1alpha1Api->deleteNotificationTemplate: $e\n');
}

Parameters

Name Type Description Notes
name String Name of notificationtemplate

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

getNotificationTemplate

NotificationTemplate getNotificationTemplate(name)

Get NotificationTemplate

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getNotificationTemplateV1alpha1Api();
final String name = name_example; // String | Name of notificationtemplate

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

Parameters

Name Type Description Notes
name String Name of notificationtemplate

Return type

NotificationTemplate

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

listNotificationTemplate

NotificationTemplateList listNotificationTemplate(page, size, labelSelector, fieldSelector, sort)

List NotificationTemplate

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getNotificationTemplateV1alpha1Api();
final int page = 56; // int | Page number. Default is 0.
final int size = 56; // int | Size number. Default is 0.
final BuiltList<String> labelSelector = ; // BuiltList<String> | Label selector. e.g.: hidden!=true
final BuiltList<String> fieldSelector = ; // BuiltList<String> | Field selector. e.g.: metadata.name==halo
final BuiltList<String> sort = ; // BuiltList<String> | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

try {
    final response = api.listNotificationTemplate(page, size, labelSelector, fieldSelector, sort);
    print(response);
} catch on DioException (e) {
    print('Exception when calling NotificationTemplateV1alpha1Api->listNotificationTemplate: $e\n');
}

Parameters

Name Type Description Notes
page int Page number. Default is 0. [optional]
size int Size number. Default is 0. [optional]
labelSelector BuiltList<String> Label selector. e.g.: hidden!=true [optional]
fieldSelector BuiltList<String> Field selector. e.g.: metadata.name==halo [optional]
sort BuiltList<String> Sorting criteria in the format: property,(asc desc). Default sort order is ascending. Multiple sort criteria are supported.

Return type

NotificationTemplateList

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

patchNotificationTemplate

NotificationTemplate patchNotificationTemplate(name, jsonPatchInner)

Patch NotificationTemplate

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getNotificationTemplateV1alpha1Api();
final String name = name_example; // String | Name of notificationtemplate
final BuiltSet<JsonPatchInner> jsonPatchInner = ; // BuiltSet<JsonPatchInner> | 

try {
    final response = api.patchNotificationTemplate(name, jsonPatchInner);
    print(response);
} catch on DioException (e) {
    print('Exception when calling NotificationTemplateV1alpha1Api->patchNotificationTemplate: $e\n');
}

Parameters

Name Type Description Notes
name String Name of notificationtemplate
jsonPatchInner BuiltSet<JsonPatchInner> [optional]

Return type

NotificationTemplate

Authorization

basicAuth, bearerAuth

HTTP request headers

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

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

updateNotificationTemplate

NotificationTemplate updateNotificationTemplate(name, notificationTemplate)

Update NotificationTemplate

Example

import 'package:halo_client/api.dart';
// TODO Configure HTTP basic authorization: basicAuth
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').username = 'YOUR_USERNAME'
//defaultApiClient.getAuthentication<HttpBasicAuth>('basicAuth').password = 'YOUR_PASSWORD';

final api = HaloClient().getNotificationTemplateV1alpha1Api();
final String name = name_example; // String | Name of notificationtemplate
final NotificationTemplate notificationTemplate = ; // NotificationTemplate | Updated notificationtemplate

try {
    final response = api.updateNotificationTemplate(name, notificationTemplate);
    print(response);
} catch on DioException (e) {
    print('Exception when calling NotificationTemplateV1alpha1Api->updateNotificationTemplate: $e\n');
}

Parameters

Name Type Description Notes
name String Name of notificationtemplate
notificationTemplate NotificationTemplate Updated notificationtemplate [optional]

Return type

NotificationTemplate

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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