Skip to content

Latest commit

 

History

History
329 lines (220 loc) · 10.6 KB

NotificationsApi.md

File metadata and controls

329 lines (220 loc) · 10.6 KB
Raw

djangoflow_openapi.api.NotificationsApi

Load the API package

import 'package:djangoflow_openapi/api.dart';

All URIs are relative to http://localhost

Method HTTP request Description
notificationsActionCategoriesList GET /api/v1/notifications/action-categories/
notificationsDevicesCreate POST /api/v1/notifications/devices/
notificationsDevicesDestroy DELETE /api/v1/notifications/devices/{registration_id}/
notificationsDevicesList GET /api/v1/notifications/devices/
notificationsDevicesPartialUpdate PATCH /api/v1/notifications/devices/{registration_id}/
notificationsDevicesRetrieve GET /api/v1/notifications/devices/{registration_id}/
notificationsDevicesUpdate PUT /api/v1/notifications/devices/{registration_id}/

notificationsActionCategoriesList

List notificationsActionCategoriesList()

Example

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

final api = DjangoflowOpenapi().getNotificationsApi();

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

Parameters

This endpoint does not need any parameter.

Return type

List<PushActionCategory>

Authorization

jwtAuth

HTTP request headers

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

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

notificationsDevicesCreate

UserDevice notificationsDevicesCreate(userDeviceRequest)

Example

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

final api = DjangoflowOpenapi().getNotificationsApi();
final UserDeviceRequest userDeviceRequest = ; // UserDeviceRequest | 

try {
    final response = api.notificationsDevicesCreate(userDeviceRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling NotificationsApi->notificationsDevicesCreate: $e\n');
}

Parameters

Name Type Description Notes
userDeviceRequest UserDeviceRequest

Return type

UserDevice

Authorization

jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

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

notificationsDevicesDestroy

notificationsDevicesDestroy(registrationId)

Example

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

final api = DjangoflowOpenapi().getNotificationsApi();
final String registrationId = registrationId_example; // String | 

try {
    api.notificationsDevicesDestroy(registrationId);
} catch on DioError (e) {
    print('Exception when calling NotificationsApi->notificationsDevicesDestroy: $e\n');
}

Parameters

Name Type Description Notes
registrationId String

Return type

void (empty response body)

Authorization

jwtAuth

HTTP request headers

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

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

notificationsDevicesList

PaginatedUserDeviceList notificationsDevicesList(limit, offset)

Example

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

final api = DjangoflowOpenapi().getNotificationsApi();
final int limit = 56; // int | Number of results to return per page.
final int offset = 56; // int | The initial index from which to return the results.

try {
    final response = api.notificationsDevicesList(limit, offset);
    print(response);
} catch on DioError (e) {
    print('Exception when calling NotificationsApi->notificationsDevicesList: $e\n');
}

Parameters

Name Type Description Notes
limit int Number of results to return per page. [optional]
offset int The initial index from which to return the results. [optional]

Return type

PaginatedUserDeviceList

Authorization

jwtAuth

HTTP request headers

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

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

notificationsDevicesPartialUpdate

UserDevice notificationsDevicesPartialUpdate(registrationId, patchedUserDeviceRequest)

Example

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

final api = DjangoflowOpenapi().getNotificationsApi();
final String registrationId = registrationId_example; // String | 
final PatchedUserDeviceRequest patchedUserDeviceRequest = ; // PatchedUserDeviceRequest | 

try {
    final response = api.notificationsDevicesPartialUpdate(registrationId, patchedUserDeviceRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling NotificationsApi->notificationsDevicesPartialUpdate: $e\n');
}

Parameters

Name Type Description Notes
registrationId String
patchedUserDeviceRequest PatchedUserDeviceRequest [optional]

Return type

UserDevice

Authorization

jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

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

notificationsDevicesRetrieve

UserDevice notificationsDevicesRetrieve(registrationId)

Example

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

final api = DjangoflowOpenapi().getNotificationsApi();
final String registrationId = registrationId_example; // String | 

try {
    final response = api.notificationsDevicesRetrieve(registrationId);
    print(response);
} catch on DioError (e) {
    print('Exception when calling NotificationsApi->notificationsDevicesRetrieve: $e\n');
}

Parameters

Name Type Description Notes
registrationId String

Return type

UserDevice

Authorization

jwtAuth

HTTP request headers

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

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

notificationsDevicesUpdate

UserDevice notificationsDevicesUpdate(registrationId, userDeviceRequest)

Example

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

final api = DjangoflowOpenapi().getNotificationsApi();
final String registrationId = registrationId_example; // String | 
final UserDeviceRequest userDeviceRequest = ; // UserDeviceRequest | 

try {
    final response = api.notificationsDevicesUpdate(registrationId, userDeviceRequest);
    print(response);
} catch on DioError (e) {
    print('Exception when calling NotificationsApi->notificationsDevicesUpdate: $e\n');
}

Parameters

Name Type Description Notes
registrationId String
userDeviceRequest UserDeviceRequest

Return type

UserDevice

Authorization

jwtAuth

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded, multipart/form-data
  • Accept: application/json

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