Skip to main content

SubscriberListApi

valkyrai-api

All URIs are relative to http://localhost:8080/v1

MethodHTTP requestDescription
deleteSubscriberListDELETE SubscriberListApiDelete a SubscriberList.

deleteSubscriberList

Void
deleteSubscriberList(id)

Delete a SubscriberList.

Deletes a specific SubscriberList.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.SubscriberListApi;


SubscriberListApi apiInstance = new SubscriberListApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the SubscriberList.

try {
Void result = apiInstance.deleteSubscriberList(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SubscriberListApi#deleteSubscriberList");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
idUUIDUnique identifier for the SubscriberList.

Return type

Void

Authorization

No authorization required

HTTP request headers

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

getSubscriberList

SubscriberList
getSubscriberList(id)

Retrieve a single SubscriberList

Retrieves a single SubscriberList for a specific uid.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.SubscriberListApi;


SubscriberListApi apiInstance = new SubscriberListApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the SubscriberList.

try {
SubscriberList result = apiInstance.getSubscriberList(id);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SubscriberListApi#getSubscriberList");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
idUUIDUnique identifier for the SubscriberList.

Return type

SubscriberList

Authorization

No authorization required

HTTP request headers

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

getSubscriberListList

SubscriberList
getSubscriberListList(pagesizesort)

Retrieve a list of SubscriberLists

Retrieves a list of SubscriberLists.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.SubscriberListApi;


SubscriberListApi apiInstance = new SubscriberListApi();
Integer page = 0; // Integer |
Integer size = 20; // Integer |
List<String> sort = Arrays.asList(); // List<String> |

try {
SubscriberList result = apiInstance.getSubscriberListList(pagesizesort);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SubscriberListApi#getSubscriberListList");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
pageInteger[optional] [default to 0]
sizeInteger[optional] [default to 20]
sortList<String>[optional]

Return type

SubscriberList

Authorization

No authorization required

HTTP request headers

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

patchSubscriberListById

SubscriberList
patchSubscriberListById(idsubscriberList)

Partially update an existing SubscriberList

Updates an existing SubscriberList.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.SubscriberListApi;


SubscriberListApi apiInstance = new SubscriberListApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the SubscriberList.
SubscriberList subscriberList = new SubscriberList(); // SubscriberList | Merge-patch fields for SubscriberList.

try {
SubscriberList result = apiInstance.patchSubscriberListById(idsubscriberList);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SubscriberListApi#patchSubscriberListById");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
idUUIDUnique identifier for the SubscriberList.
subscriberListSubscriberListMerge-patch fields for SubscriberList.

Return type

SubscriberList

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/merge-patch+jsonapplication/json-patch+jsonapplication/json
  • Accept: application/json

postSubscriberList

SubscriberList
postSubscriberList(subscriberList)

Create a new SubscriberList

Creates a new SubscriberList.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.SubscriberListApi;


SubscriberListApi apiInstance = new SubscriberListApi();
SubscriberList subscriberList = new SubscriberList(); // SubscriberList | SubscriberList details.

try {
SubscriberList result = apiInstance.postSubscriberList(subscriberList);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SubscriberListApi#postSubscriberList");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
subscriberListSubscriberListSubscriberList details.

Return type

SubscriberList

Authorization

No authorization required

HTTP request headers

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

updateSubscriberList

SubscriberList
updateSubscriberList(idsubscriberList)

Update an existing SubscriberList

Updates an existing SubscriberList.

Example

Import classes:
import com.valkyrlabs.ApiException;
import com.valkyrlabs.api.SubscriberListApi;


SubscriberListApi apiInstance = new SubscriberListApi();
UUID id = UUID.randomUUID(); // UUID | Unique identifier for the SubscriberList.
SubscriberList subscriberList = new SubscriberList(); // SubscriberList | Updated SubscriberList details.

try {
SubscriberList result = apiInstance.updateSubscriberList(idsubscriberList);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling SubscriberListApi#updateSubscriberList");
e.printStackTrace();
}

Parameters

NameTypeDescriptionNotes
idUUIDUnique identifier for the SubscriberList.
subscriberListSubscriberListUpdated SubscriberList details.

Return type

SubscriberList

Authorization

No authorization required

HTTP request headers

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

Generated Version Details

~value
GENERATOR VERSIONcom.valkyrlabs:ValkyrAI API 1.0.3-SNAPSHOT
API ARTIFACTcom.valkyrlabs.valkyrai-api.jar
GENERATOR VERSIONorg.openapitools.openapi-generator:7.5.0
GENERATOR CLASSorg.openapitools.codegen.languages.SpringCodegen
GENERATED DATE2026-04-20T19:24:54.195235-07:00[America/Los_Angeles]