SubscriberResourceApi

All URIs are relative to https://sandbox.subscreasy.com

Method	HTTP request	Description
createSubscriberUsingPOST	POST /api/subscribers	createSubscriber
deleteSubscriberUsingDELETE	DELETE /api/subscribers/{id}	deleteSubscriber
findAllSubscribersUsingGET	GET /api/subscribers/find-all	findAllSubscribers
getAllSubscribersUsingGET	GET /api/subscribers	getAllSubscribers
getSubscriberByEmailUsingGET	GET /api/subscribers/email/{email}	getSubscriberByEmail
getSubscriberByNameUsingGET	GET /api/subscribers/name/{name}	getSubscriberByName
getSubscriberBySecureIdUsingGET	GET /api/subscribers/secureId/{secureId}	getSubscriberBySecureId
getSubscriberUsingGET	GET /api/subscribers/{id}	getSubscriber
updateSubscriberUsingPUT	PUT /api/subscribers	updateSubscriber

createSubscriberUsingPOST

Subscriber createSubscriberUsingPOST(subscriber)

createSubscriber

Example

// Import classes:
//import com.kodfarki.subscreasy.ApiClient;
//import com.kodfarki.subscreasy.ApiException;
//import com.kodfarki.subscreasy.Configuration;
//import com.kodfarki.subscreasy.auth.*;
//import com.kodfarki.subscreasy.client.SubscriberResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

SubscriberResourceApi apiInstance = new SubscriberResourceApi();
Subscriber subscriber = new Subscriber(); // Subscriber | subscriber
try {
    Subscriber result = apiInstance.createSubscriberUsingPOST(subscriber);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriberResourceApi#createSubscriberUsingPOST");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
subscriber	Subscriber	subscriber

Return type

Subscriber

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: /

deleteSubscriberUsingDELETE

deleteSubscriberUsingDELETE(id)

deleteSubscriber

Example

// Import classes:
//import com.kodfarki.subscreasy.ApiClient;
//import com.kodfarki.subscreasy.ApiException;
//import com.kodfarki.subscreasy.Configuration;
//import com.kodfarki.subscreasy.auth.*;
//import com.kodfarki.subscreasy.client.SubscriberResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

SubscriberResourceApi apiInstance = new SubscriberResourceApi();
Long id = 789L; // Long | id
try {
    apiInstance.deleteSubscriberUsingDELETE(id);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriberResourceApi#deleteSubscriberUsingDELETE");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Long	id

Return type

null (empty response body)

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: /

findAllSubscribersUsingGET

List<Subscriber> findAllSubscribersUsingGET()

findAllSubscribers

Example

// Import classes:
//import com.kodfarki.subscreasy.ApiClient;
//import com.kodfarki.subscreasy.ApiException;
//import com.kodfarki.subscreasy.Configuration;
//import com.kodfarki.subscreasy.auth.*;
//import com.kodfarki.subscreasy.client.SubscriberResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

SubscriberResourceApi apiInstance = new SubscriberResourceApi();
try {
    List<Subscriber> result = apiInstance.findAllSubscribersUsingGET();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriberResourceApi#findAllSubscribersUsingGET");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<Subscriber>

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: /

getAllSubscribersUsingGET

List<Subscriber> getAllSubscribersUsingGET(page, size, sort)

getAllSubscribers

Example

// Import classes:
//import com.kodfarki.subscreasy.ApiClient;
//import com.kodfarki.subscreasy.ApiException;
//import com.kodfarki.subscreasy.Configuration;
//import com.kodfarki.subscreasy.auth.*;
//import com.kodfarki.subscreasy.client.SubscriberResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

SubscriberResourceApi apiInstance = new SubscriberResourceApi();
Integer page = 56; // Integer | Page number of the requested page
Integer size = 56; // Integer | Size of a page
List<String> sort = Arrays.asList("sort_example"); // List<String> | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
try {
    List<Subscriber> result = apiInstance.getAllSubscribersUsingGET(page, size, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriberResourceApi#getAllSubscribersUsingGET");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
page	Integer	Page number of the requested page	[optional]
size	Integer	Size of a page	[optional]
sort	List<String>	Sorting criteria in the format: property(,asc	desc). Default sort order is ascending. Multiple sort criteria are supported.

Return type

List<Subscriber>

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: /

getSubscriberByEmailUsingGET

List<Subscriber> getSubscriberByEmailUsingGET(email, page, size, sort)

getSubscriberByEmail

Example

// Import classes:
//import com.kodfarki.subscreasy.ApiClient;
//import com.kodfarki.subscreasy.ApiException;
//import com.kodfarki.subscreasy.Configuration;
//import com.kodfarki.subscreasy.auth.*;
//import com.kodfarki.subscreasy.client.SubscriberResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

SubscriberResourceApi apiInstance = new SubscriberResourceApi();
String email = "email_example"; // String | email
Integer page = 56; // Integer | Page number of the requested page
Integer size = 56; // Integer | Size of a page
List<String> sort = Arrays.asList("sort_example"); // List<String> | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
try {
    List<Subscriber> result = apiInstance.getSubscriberByEmailUsingGET(email, page, size, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriberResourceApi#getSubscriberByEmailUsingGET");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
email	String	email
page	Integer	Page number of the requested page	[optional]
size	Integer	Size of a page	[optional]
sort	List<String>	Sorting criteria in the format: property(,asc	desc). Default sort order is ascending. Multiple sort criteria are supported.

Return type

List<Subscriber>

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: /

getSubscriberByNameUsingGET

List<Subscriber> getSubscriberByNameUsingGET(name, page, size, sort)

getSubscriberByName

Example

// Import classes:
//import com.kodfarki.subscreasy.ApiClient;
//import com.kodfarki.subscreasy.ApiException;
//import com.kodfarki.subscreasy.Configuration;
//import com.kodfarki.subscreasy.auth.*;
//import com.kodfarki.subscreasy.client.SubscriberResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

SubscriberResourceApi apiInstance = new SubscriberResourceApi();
String name = "name_example"; // String | name
Integer page = 56; // Integer | Page number of the requested page
Integer size = 56; // Integer | Size of a page
List<String> sort = Arrays.asList("sort_example"); // List<String> | Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
try {
    List<Subscriber> result = apiInstance.getSubscriberByNameUsingGET(name, page, size, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriberResourceApi#getSubscriberByNameUsingGET");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
name	String	name
page	Integer	Page number of the requested page	[optional]
size	Integer	Size of a page	[optional]
sort	List<String>	Sorting criteria in the format: property(,asc	desc). Default sort order is ascending. Multiple sort criteria are supported.

Return type

List<Subscriber>

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: /

getSubscriberBySecureIdUsingGET

Subscriber getSubscriberBySecureIdUsingGET(secureId)

getSubscriberBySecureId

Example

// Import classes:
//import com.kodfarki.subscreasy.ApiClient;
//import com.kodfarki.subscreasy.ApiException;
//import com.kodfarki.subscreasy.Configuration;
//import com.kodfarki.subscreasy.auth.*;
//import com.kodfarki.subscreasy.client.SubscriberResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

SubscriberResourceApi apiInstance = new SubscriberResourceApi();
String secureId = "secureId_example"; // String | secureId
try {
    Subscriber result = apiInstance.getSubscriberBySecureIdUsingGET(secureId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriberResourceApi#getSubscriberBySecureIdUsingGET");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
secureId	String	secureId

Return type

Subscriber

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: /

getSubscriberUsingGET

Subscriber getSubscriberUsingGET(id)

getSubscriber

Example

// Import classes:
//import com.kodfarki.subscreasy.ApiClient;
//import com.kodfarki.subscreasy.ApiException;
//import com.kodfarki.subscreasy.Configuration;
//import com.kodfarki.subscreasy.auth.*;
//import com.kodfarki.subscreasy.client.SubscriberResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

SubscriberResourceApi apiInstance = new SubscriberResourceApi();
Long id = 789L; // Long | id
try {
    Subscriber result = apiInstance.getSubscriberUsingGET(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriberResourceApi#getSubscriberUsingGET");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	Long	id

Return type

Subscriber

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: /

updateSubscriberUsingPUT

Subscriber updateSubscriberUsingPUT(subscriber)

updateSubscriber

Example

// Import classes:
//import com.kodfarki.subscreasy.ApiClient;
//import com.kodfarki.subscreasy.ApiException;
//import com.kodfarki.subscreasy.Configuration;
//import com.kodfarki.subscreasy.auth.*;
//import com.kodfarki.subscreasy.client.SubscriberResourceApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: apiKey
ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
apiKey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.setApiKeyPrefix("Token");

SubscriberResourceApi apiInstance = new SubscriberResourceApi();
Subscriber subscriber = new Subscriber(); // Subscriber | subscriber
try {
    Subscriber result = apiInstance.updateSubscriberUsingPUT(subscriber);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriberResourceApi#updateSubscriberUsingPUT");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
subscriber	Subscriber	subscriber

Return type

Subscriber

Authorization

apiKey

HTTP request headers

Content-Type: application/json
Accept: /

Files

SubscriberResourceApi.md

Latest commit

History

SubscriberResourceApi.md

File metadata and controls

SubscriberResourceApi

createSubscriberUsingPOST

Example

Parameters

Return type

Authorization

HTTP request headers

deleteSubscriberUsingDELETE

Example

Parameters

Return type

Authorization

HTTP request headers

findAllSubscribersUsingGET

Example

Parameters

Return type

Authorization

HTTP request headers

getAllSubscribersUsingGET

Example

Parameters

Return type

Authorization

HTTP request headers

getSubscriberByEmailUsingGET

Example

Parameters

Return type

Authorization

HTTP request headers

getSubscriberByNameUsingGET

Example

Parameters

Return type

Authorization

HTTP request headers

getSubscriberBySecureIdUsingGET

Example

Parameters

Return type

Authorization

HTTP request headers

getSubscriberUsingGET

Example

Parameters

Return type

Authorization

HTTP request headers

updateSubscriberUsingPUT

Example

Parameters

Return type

Authorization

HTTP request headers