Skip to content

Latest commit

 

History

History
491 lines (337 loc) · 13.6 KB

ListApi.md

File metadata and controls

491 lines (337 loc) · 13.6 KB
Raw

kabalist_client.api.ListApi

Load the API package

import 'package:kabalist_client/api.dart';

All URIs are relative to http://localhost

Method HTTP request Description
addList POST /api/list/{id}
createList POST /api/list
deleteItem DELETE /api/list/{id}/{item}
deleteList DELETE /api/list/{id}
getPublicList GET /api/list/{id}/public
listLists GET /api/list
readList GET /api/list/{id}
removePublic DELETE /api/list/{id}/public
setPublic PUT /api/list/{id}/public
updateItem PATCH /api/list/{id}/{item}

addList

OkAddToListResponse addList(id, addToListRequest)

Example

import 'package:kabalist_client/api.dart';
// TODO Configure HTTP Bearer authorization: token
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken(yourTokenGeneratorFunction);

final api_instance = ListApi();
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | List ID
final addToListRequest = AddToListRequest(); // AddToListRequest | 

try {
    final result = api_instance.addList(id, addToListRequest);
    print(result);
} catch (e) {
    print('Exception when calling ListApi->addList: $e\n');
}

Parameters

Name Type Description Notes
id String List ID
addToListRequest AddToListRequest

Return type

OkAddToListResponse

Authorization

token

HTTP request headers

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

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

createList

OkLoginResponse createList(createListRequest)

Example

import 'package:kabalist_client/api.dart';
// TODO Configure HTTP Bearer authorization: token
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken(yourTokenGeneratorFunction);

final api_instance = ListApi();
final createListRequest = CreateListRequest(); // CreateListRequest | 

try {
    final result = api_instance.createList(createListRequest);
    print(result);
} catch (e) {
    print('Exception when calling ListApi->createList: $e\n');
}

Parameters

Name Type Description Notes
createListRequest CreateListRequest

Return type

OkLoginResponse

Authorization

token

HTTP request headers

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

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

deleteItem

OkDeleteItemResponse deleteItem(id, item)

Example

import 'package:kabalist_client/api.dart';
// TODO Configure HTTP Bearer authorization: token
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken(yourTokenGeneratorFunction);

final api_instance = ListApi();
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | List ID
final item = 56; // int | Item ID

try {
    final result = api_instance.deleteItem(id, item);
    print(result);
} catch (e) {
    print('Exception when calling ListApi->deleteItem: $e\n');
}

Parameters

Name Type Description Notes
id String List ID
item int Item ID

Return type

OkDeleteItemResponse

Authorization

token

HTTP request headers

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

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

deleteList

OkDeleteListResponse deleteList(id)

Example

import 'package:kabalist_client/api.dart';
// TODO Configure HTTP Bearer authorization: token
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken(yourTokenGeneratorFunction);

final api_instance = ListApi();
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | List ID

try {
    final result = api_instance.deleteList(id);
    print(result);
} catch (e) {
    print('Exception when calling ListApi->deleteList: $e\n');
}

Parameters

Name Type Description Notes
id String List ID

Return type

OkDeleteListResponse

Authorization

token

HTTP request headers

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

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

getPublicList

String getPublicList(id)

Example

import 'package:kabalist_client/api.dart';

final api_instance = ListApi();
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | List ID

try {
    final result = api_instance.getPublicList(id);
    print(result);
} catch (e) {
    print('Exception when calling ListApi->getPublicList: $e\n');
}

Parameters

Name Type Description Notes
id String List ID

Return type

String

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/html, text/plain

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

listLists

OkGetListsResponse listLists()

Example

import 'package:kabalist_client/api.dart';
// TODO Configure HTTP Bearer authorization: token
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken(yourTokenGeneratorFunction);

final api_instance = ListApi();

try {
    final result = api_instance.listLists();
    print(result);
} catch (e) {
    print('Exception when calling ListApi->listLists: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

OkGetListsResponse

Authorization

token

HTTP request headers

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

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

readList

OkReadListResponse readList(id)

Example

import 'package:kabalist_client/api.dart';
// TODO Configure HTTP Bearer authorization: token
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken(yourTokenGeneratorFunction);

final api_instance = ListApi();
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | List ID

try {
    final result = api_instance.readList(id);
    print(result);
} catch (e) {
    print('Exception when calling ListApi->readList: $e\n');
}

Parameters

Name Type Description Notes
id String List ID

Return type

OkReadListResponse

Authorization

token

HTTP request headers

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

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

removePublic

OkRemovePublicResponse removePublic(id)

Example

import 'package:kabalist_client/api.dart';
// TODO Configure HTTP Bearer authorization: token
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken(yourTokenGeneratorFunction);

final api_instance = ListApi();
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | List ID

try {
    final result = api_instance.removePublic(id);
    print(result);
} catch (e) {
    print('Exception when calling ListApi->removePublic: $e\n');
}

Parameters

Name Type Description Notes
id String List ID

Return type

OkRemovePublicResponse

Authorization

token

HTTP request headers

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

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

setPublic

OkSetPublicResponse setPublic(id)

Example

import 'package:kabalist_client/api.dart';
// TODO Configure HTTP Bearer authorization: token
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken(yourTokenGeneratorFunction);

final api_instance = ListApi();
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | List ID

try {
    final result = api_instance.setPublic(id);
    print(result);
} catch (e) {
    print('Exception when calling ListApi->setPublic: $e\n');
}

Parameters

Name Type Description Notes
id String List ID

Return type

OkSetPublicResponse

Authorization

token

HTTP request headers

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

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

updateItem

OkUpdateItemResponse updateItem(id, item, updateItemRequest)

Example

import 'package:kabalist_client/api.dart';
// TODO Configure HTTP Bearer authorization: token
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('token').setAccessToken(yourTokenGeneratorFunction);

final api_instance = ListApi();
final id = 38400000-8cf0-11bd-b23e-10b96e4ef00d; // String | List ID
final item = 56; // int | Item ID
final updateItemRequest = UpdateItemRequest(); // UpdateItemRequest | 

try {
    final result = api_instance.updateItem(id, item, updateItemRequest);
    print(result);
} catch (e) {
    print('Exception when calling ListApi->updateItem: $e\n');
}

Parameters

Name Type Description Notes
id String List ID
item int Item ID
updateItemRequest UpdateItemRequest

Return type

OkUpdateItemResponse

Authorization

token

HTTP request headers

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

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