MylistApi.md

SwaggerJsClient.MylistApi

All URIs are relative to /

Method	HTTP request	Description
deleteMylistItem	DELETE /api/mylists/{id}	Removes the Mylist resource.
getMylistCollection	GET /api/mylists	Retrieves the collection of Mylist resources.
getMylistItem	GET /api/mylists/{id}	Retrieves a Mylist resource.
patchMylistItem	PATCH /api/mylists/{id}	Updates the Mylist resource.
postMylistCollection	POST /api/mylists	Creates a Mylist resource.
putMylistItem	PUT /api/mylists/{id}	Replaces the Mylist resource.

deleteMylistItem

deleteMylistItem(id)

Removes the Mylist resource.

Removes the Mylist resource.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.MylistApi();
let id = "id_example"; // String | Resource identifier

apiInstance.deleteMylistItem(id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully.");
  }
});

Parameters

Name	Type	Description	Notes
id	String	Resource identifier

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

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

getMylistCollection

InlineResponse20010 getMylistCollection(opts)

Retrieves the collection of Mylist resources.

Retrieves the collection of Mylist resources.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.MylistApi();
let opts = {
  page: 1, // Number | The collection page number
};
apiInstance.getMylistCollection(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
});

Parameters

Name	Type	Description	Notes
page	Number	The collection page number	[optional] [default to 1]

Return type

InlineResponse20010

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/ld+json, application/json, text/html

getMylistItem

MylistJsonld getMylistItem(id)

Retrieves a Mylist resource.

Retrieves a Mylist resource.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.MylistApi();
let id = "id_example"; // String | Resource identifier

apiInstance.getMylistItem(id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
});

Parameters

Name	Type	Description	Notes
id	String	Resource identifier

Return type

MylistJsonld

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/ld+json, application/json, text/html

patchMylistItem

MylistJsonld patchMylistItem(body, id)

Updates the Mylist resource.

Updates the Mylist resource.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.MylistApi();
let body = new SwaggerJsClient.Mylist(); // Mylist | The updated Mylist resource
let id = "id_example"; // String | Resource identifier

apiInstance.patchMylistItem(body, id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
});

Parameters

Name	Type	Description	Notes
body	Mylist	The updated Mylist resource
id	String	Resource identifier

Return type

MylistJsonld

Authorization

No authorization required

HTTP request headers

• Content-Type: application/merge-patch+json
• Accept: application/ld+json, application/json, text/html

postMylistCollection

MylistJsonld postMylistCollection(body)

Creates a Mylist resource.

Creates a Mylist resource.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.MylistApi();
let body = new SwaggerJsClient.MylistJsonld(); // MylistJsonld | The new Mylist resource

apiInstance.postMylistCollection(body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
});

Parameters

Name	Type	Description	Notes
body	MylistJsonld	The new Mylist resource

Return type

MylistJsonld

Authorization

No authorization required

HTTP request headers

• Content-Type: application/ld+json, application/json, text/html
• Accept: application/ld+json, application/json, text/html

putMylistItem

MylistJsonld putMylistItem(body, id)

Replaces the Mylist resource.

Replaces the Mylist resource.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.MylistApi();
let body = new SwaggerJsClient.MylistJsonld(); // MylistJsonld | The updated Mylist resource
let id = "id_example"; // String | Resource identifier

apiInstance.putMylistItem(body, id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
});

Parameters

Name	Type	Description	Notes
body	MylistJsonld	The updated Mylist resource
id	String	Resource identifier

Return type

MylistJsonld

Authorization

No authorization required

HTTP request headers

• Content-Type: application/ld+json, application/json, text/html
• Accept: application/ld+json, application/json, text/html