Skip to content

Latest commit

 

History

History
162 lines (96 loc) · 3.56 KB

NotificationsApi.md

File metadata and controls

162 lines (96 loc) · 3.56 KB

.NotificationsApi

All URIs are relative to https://roketo-test-api.herokuapp.com

Method HTTP request Description
findAll GET /notifications
markAllRead POST /notifications/readAll
unsubscribe GET /notifications/{accountId}/unsubscribe/{jwt}

findAll

Array findAll()

Example

import {  } from '@roketo/api-client';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .NotificationsApi(configuration);

let body:any = {};

apiInstance.findAll(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

Array

Authorization

bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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

markAllRead

void markAllRead()

Example

import {  } from '@roketo/api-client';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .NotificationsApi(configuration);

let body:any = {};

apiInstance.markAllRead(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

void

Authorization

bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 -

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

unsubscribe

void unsubscribe()

Example

import {  } from '@roketo/api-client';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .NotificationsApi(configuration);

let body:.NotificationsApiUnsubscribeRequest = {
  // string
  accountId: "accountId_example",
  // string
  jwt: "jwt_example",
};

apiInstance.unsubscribe(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
accountId [string] defaults to undefined
jwt [string] defaults to undefined

Return type

void

Authorization

bearer

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 -

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