Skip to content

Latest commit

 

History

History
306 lines (205 loc) · 9.78 KB

ReasonTypeV1alpha1Api.md

File metadata and controls

306 lines (205 loc) · 9.78 KB

halo_client.api.ReasonTypeV1alpha1Api

Load the API package

import 'package:halo_client/api.dart';

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

Method HTTP request Description
createReasonType POST /apis/notification.halo.run/v1alpha1/reasontypes
deleteReasonType DELETE /apis/notification.halo.run/v1alpha1/reasontypes/{name}
getReasonType GET /apis/notification.halo.run/v1alpha1/reasontypes/{name}
listReasonType GET /apis/notification.halo.run/v1alpha1/reasontypes
patchReasonType PATCH /apis/notification.halo.run/v1alpha1/reasontypes/{name}
updateReasonType PUT /apis/notification.halo.run/v1alpha1/reasontypes/{name}

createReasonType

ReasonType createReasonType(reasonType)

Create ReasonType

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().getReasonTypeV1alpha1Api();
final ReasonType reasonType = ; // ReasonType | Fresh reasontype

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

Parameters

Name Type Description Notes
reasonType ReasonType Fresh reasontype [optional]

Return type

ReasonType

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]

deleteReasonType

deleteReasonType(name)

Delete ReasonType

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().getReasonTypeV1alpha1Api();
final String name = name_example; // String | Name of reasontype

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

Parameters

Name Type Description Notes
name String Name of reasontype

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]

getReasonType

ReasonType getReasonType(name)

Get ReasonType

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().getReasonTypeV1alpha1Api();
final String name = name_example; // String | Name of reasontype

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

Parameters

Name Type Description Notes
name String Name of reasontype

Return type

ReasonType

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]

listReasonType

ReasonTypeList listReasonType(page, size, labelSelector, fieldSelector, sort)

List ReasonType

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().getReasonTypeV1alpha1Api();
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.listReasonType(page, size, labelSelector, fieldSelector, sort);
    print(response);
} catch on DioException (e) {
    print('Exception when calling ReasonTypeV1alpha1Api->listReasonType: $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

ReasonTypeList

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]

patchReasonType

ReasonType patchReasonType(name, jsonPatchInner)

Patch ReasonType

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().getReasonTypeV1alpha1Api();
final String name = name_example; // String | Name of reasontype
final BuiltSet<JsonPatchInner> jsonPatchInner = ; // BuiltSet<JsonPatchInner> | 

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

Parameters

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

Return type

ReasonType

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]

updateReasonType

ReasonType updateReasonType(name, reasonType)

Update ReasonType

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().getReasonTypeV1alpha1Api();
final String name = name_example; // String | Name of reasontype
final ReasonType reasonType = ; // ReasonType | Updated reasontype

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

Parameters

Name Type Description Notes
name String Name of reasontype
reasonType ReasonType Updated reasontype [optional]

Return type

ReasonType

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]