Skip to content

Latest commit

 

History

History
338 lines (226 loc) · 8.54 KB

TagsApi.md

File metadata and controls

338 lines (226 loc) · 8.54 KB

SmallEodClient.TagsApi

All URIs are relative to /api

Method HTTP request Description
tagsCreate POST /tags/
tagsDelete DELETE /tags/{id}/
tagsList GET /tags/
tagsPartialUpdate PATCH /tags/{id}/
tagsRead GET /tags/{id}/
tagsUpdate PUT /tags/{id}/

tagsCreate

Tag tagsCreate(data)

Example

import SmallEodClient from 'small_eod_client';
let defaultClient = SmallEodClient.ApiClient.instance;
// Configure HTTP basic authorization: Basic
let Basic = defaultClient.authentications['Basic'];
Basic.username = 'YOUR USERNAME';
Basic.password = 'YOUR PASSWORD';
// Configure API key authorization: Bearer
let Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

let apiInstance = new SmallEodClient.TagsApi();
let data = new SmallEodClient.Tag(); // Tag | 
apiInstance.tagsCreate(data).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
data Tag

Return type

Tag

Authorization

Basic, Bearer

HTTP request headers

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

tagsDelete

tagsDelete(id)

Example

import SmallEodClient from 'small_eod_client';
let defaultClient = SmallEodClient.ApiClient.instance;
// Configure HTTP basic authorization: Basic
let Basic = defaultClient.authentications['Basic'];
Basic.username = 'YOUR USERNAME';
Basic.password = 'YOUR PASSWORD';
// Configure API key authorization: Bearer
let Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

let apiInstance = new SmallEodClient.TagsApi();
let id = 56; // Number | A unique integer value identifying this tag.
apiInstance.tagsDelete(id).then(() => {
  console.log('API called successfully.');
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number A unique integer value identifying this tag.

Return type

null (empty response body)

Authorization

Basic, Bearer

HTTP request headers

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

tagsList

InlineResponse20025 tagsList(opts)

Example

import SmallEodClient from 'small_eod_client';
let defaultClient = SmallEodClient.ApiClient.instance;
// Configure HTTP basic authorization: Basic
let Basic = defaultClient.authentications['Basic'];
Basic.username = 'YOUR USERNAME';
Basic.password = 'YOUR PASSWORD';
// Configure API key authorization: Bearer
let Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

let apiInstance = new SmallEodClient.TagsApi();
let opts = {
  'query': "query_example", // String | 
  'ordering': "ordering_example", // String | Which field to use when ordering the results.
  'limit': 56, // Number | Number of results to return per page.
  'offset': 56 // Number | The initial index from which to return the results.
};
apiInstance.tagsList(opts).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
query String [optional]
ordering String Which field to use when ordering the results. [optional]
limit Number Number of results to return per page. [optional]
offset Number The initial index from which to return the results. [optional]

Return type

InlineResponse20025

Authorization

Basic, Bearer

HTTP request headers

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

tagsPartialUpdate

Tag tagsPartialUpdate(id, data)

Example

import SmallEodClient from 'small_eod_client';
let defaultClient = SmallEodClient.ApiClient.instance;
// Configure HTTP basic authorization: Basic
let Basic = defaultClient.authentications['Basic'];
Basic.username = 'YOUR USERNAME';
Basic.password = 'YOUR PASSWORD';
// Configure API key authorization: Bearer
let Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

let apiInstance = new SmallEodClient.TagsApi();
let id = 56; // Number | A unique integer value identifying this tag.
let data = new SmallEodClient.Tag(); // Tag | 
apiInstance.tagsPartialUpdate(id, data).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number A unique integer value identifying this tag.
data Tag

Return type

Tag

Authorization

Basic, Bearer

HTTP request headers

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

tagsRead

Tag tagsRead(id)

Example

import SmallEodClient from 'small_eod_client';
let defaultClient = SmallEodClient.ApiClient.instance;
// Configure HTTP basic authorization: Basic
let Basic = defaultClient.authentications['Basic'];
Basic.username = 'YOUR USERNAME';
Basic.password = 'YOUR PASSWORD';
// Configure API key authorization: Bearer
let Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

let apiInstance = new SmallEodClient.TagsApi();
let id = 56; // Number | A unique integer value identifying this tag.
apiInstance.tagsRead(id).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number A unique integer value identifying this tag.

Return type

Tag

Authorization

Basic, Bearer

HTTP request headers

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

tagsUpdate

Tag tagsUpdate(id, data)

Example

import SmallEodClient from 'small_eod_client';
let defaultClient = SmallEodClient.ApiClient.instance;
// Configure HTTP basic authorization: Basic
let Basic = defaultClient.authentications['Basic'];
Basic.username = 'YOUR USERNAME';
Basic.password = 'YOUR PASSWORD';
// Configure API key authorization: Bearer
let Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

let apiInstance = new SmallEodClient.TagsApi();
let id = 56; // Number | A unique integer value identifying this tag.
let data = new SmallEodClient.Tag(); // Tag | 
apiInstance.tagsUpdate(id, data).then((data) => {
  console.log('API called successfully. Returned data: ' + data);
}, (error) => {
  console.error(error);
});

Parameters

Name Type Description Notes
id Number A unique integer value identifying this tag.
data Tag

Return type

Tag

Authorization

Basic, Bearer

HTTP request headers

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