Skip to content

Latest commit

 

History

History
571 lines (369 loc) · 13 KB

DefaultApi.md

File metadata and controls

571 lines (369 loc) · 13 KB
Raw

openapi.api.DefaultApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to https://pulseox-prod.herokuapp.com

Method HTTP request Description
batchSignedUploadReq POST /signed-upload Allows batch creation of signed upload URLs when many files need to be uploaded
getSession GET /session Your GET endpoint
getSessionDiagnoses GET /session/diagnoses Your GET endpoint
getSessionDiagnosesUserid GET /session/diagnoses/{diagid} Your GET endpoint
getSignedUploadReq GET /signed-upload Retrieves a signed upload request
getUsers GET /users
getUsersUserid GET /users/{userid} Your GET endpoint
getUsersUseridDiagnoses GET /users/{userid}/diagnoses Your GET endpoint
postLogin POST /login
postRegister POST /register
postUsers POST /users
putSession PUT /session
putSessionDiagnosesUserid PUT /session/diagnoses/{diagid}
putUsersUserid PUT /users/{userid}

batchSignedUploadReq

batchSignedUploadReq(inlineObject)

Allows batch creation of signed upload URLs when many files need to be uploaded

Example

import 'package:openapi/api.dart';

var api_instance = DefaultApi();
var inlineObject = InlineObject(); // InlineObject | 

try { 
    api_instance.batchSignedUploadReq(inlineObject);
} catch (e) {
    print("Exception when calling DefaultApi->batchSignedUploadReq: $e\n");
}

Parameters

Name Type Description Notes
inlineObject InlineObject

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

getSession

getSession()

Your GET endpoint

Example

import 'package:openapi/api.dart';

var api_instance = DefaultApi();

try { 
    api_instance.getSession();
} catch (e) {
    print("Exception when calling DefaultApi->getSession: $e\n");
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

getSessionDiagnoses

getSessionDiagnoses()

Your GET endpoint

Example

import 'package:openapi/api.dart';

var api_instance = DefaultApi();

try { 
    api_instance.getSessionDiagnoses();
} catch (e) {
    print("Exception when calling DefaultApi->getSessionDiagnoses: $e\n");
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

getSessionDiagnosesUserid

List getSessionDiagnosesUserid(diagid)

Your GET endpoint

Example

import 'package:openapi/api.dart';

var api_instance = DefaultApi();
var diagid = diagid_example; // String | 

try { 
    var result = api_instance.getSessionDiagnosesUserid(diagid);
    print(result);
} catch (e) {
    print("Exception when calling DefaultApi->getSessionDiagnosesUserid: $e\n");
}

Parameters

Name Type Description Notes
diagid String [default to null]

Return type

List

Authorization

No authorization required

HTTP request headers

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

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

getSignedUploadReq

getSignedUploadReq(filename, filetype)

Retrieves a signed upload request

Example

import 'package:openapi/api.dart';

var api_instance = DefaultApi();
var filename = filename_example; // String | The name of the file you want to upload
var filetype = filetype_example; // String | The type of file you want to upload

try { 
    api_instance.getSignedUploadReq(filename, filetype);
} catch (e) {
    print("Exception when calling DefaultApi->getSignedUploadReq: $e\n");
}

Parameters

Name Type Description Notes
filename String The name of the file you want to upload [default to null]
filetype String The type of file you want to upload [default to null]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

getUsers

List getUsers()

Example

import 'package:openapi/api.dart';

var api_instance = DefaultApi();

try { 
    var result = api_instance.getUsers();
    print(result);
} catch (e) {
    print("Exception when calling DefaultApi->getUsers: $e\n");
}

Parameters

This endpoint does not need any parameter.

Return type

List

Authorization

No authorization required

HTTP request headers

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

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

getUsersUserid

User getUsersUserid(userid)

Your GET endpoint

Example

import 'package:openapi/api.dart';

var api_instance = DefaultApi();
var userid = userid_example; // String | 

try { 
    var result = api_instance.getUsersUserid(userid);
    print(result);
} catch (e) {
    print("Exception when calling DefaultApi->getUsersUserid: $e\n");
}

Parameters

Name Type Description Notes
userid String [default to null]

Return type

User

Authorization

No authorization required

HTTP request headers

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

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

getUsersUseridDiagnoses

List getUsersUseridDiagnoses(userid)

Your GET endpoint

Example

import 'package:openapi/api.dart';

var api_instance = DefaultApi();
var userid = userid_example; // String | 

try { 
    var result = api_instance.getUsersUseridDiagnoses(userid);
    print(result);
} catch (e) {
    print("Exception when calling DefaultApi->getUsersUseridDiagnoses: $e\n");
}

Parameters

Name Type Description Notes
userid String [default to null]

Return type

List

Authorization

No authorization required

HTTP request headers

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

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

postLogin

postLogin()

Example

import 'package:openapi/api.dart';

var api_instance = DefaultApi();

try { 
    api_instance.postLogin();
} catch (e) {
    print("Exception when calling DefaultApi->postLogin: $e\n");
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

postRegister

postRegister()

Example

import 'package:openapi/api.dart';

var api_instance = DefaultApi();

try { 
    api_instance.postRegister();
} catch (e) {
    print("Exception when calling DefaultApi->postRegister: $e\n");
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

postUsers

postUsers(user)

Example

import 'package:openapi/api.dart';

var api_instance = DefaultApi();
var user = User(); // User | 

try { 
    api_instance.postUsers(user);
} catch (e) {
    print("Exception when calling DefaultApi->postUsers: $e\n");
}

Parameters

Name Type Description Notes
user User [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

putSession

putSession()

Example

import 'package:openapi/api.dart';

var api_instance = DefaultApi();

try { 
    api_instance.putSession();
} catch (e) {
    print("Exception when calling DefaultApi->putSession: $e\n");
}

Parameters

This endpoint does not need any parameter.

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

putSessionDiagnosesUserid

putSessionDiagnosesUserid(diagid)

Example

import 'package:openapi/api.dart';

var api_instance = DefaultApi();
var diagid = diagid_example; // String | 

try { 
    api_instance.putSessionDiagnosesUserid(diagid);
} catch (e) {
    print("Exception when calling DefaultApi->putSessionDiagnosesUserid: $e\n");
}

Parameters

Name Type Description Notes
diagid String [default to null]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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

putUsersUserid

putUsersUserid(userid, user)

Example

import 'package:openapi/api.dart';

var api_instance = DefaultApi();
var userid = userid_example; // String | 
var user = User(); // User | 

try { 
    api_instance.putUsersUserid(userid, user);
} catch (e) {
    print("Exception when calling DefaultApi->putUsersUserid: $e\n");
}

Parameters

Name Type Description Notes
userid String [default to null]
user User [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

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