Skip to content

Latest commit

 

History

History
828 lines (619 loc) · 27.1 KB

ContactGroupsApi.md

File metadata and controls

828 lines (619 loc) · 27.1 KB

ContactGroupsApi

All URIs are relative to http://localhost

Method HTTP request Description
contactGroupsCreate POST /api/v1/ContactGroups/group Creates contact group
contactGroupsCreateWithHttpInfo POST /api/v1/ContactGroups/group Creates contact group
contactGroupsDelete DELETE /api/v1/ContactGroups/{id} Removes contact by id
contactGroupsDeleteWithHttpInfo DELETE /api/v1/ContactGroups/{id} Removes contact by id
contactGroupsGet GET /api/v1/ContactGroups/{id} Returns contact group by id
contactGroupsGetWithHttpInfo GET /api/v1/ContactGroups/{id} Returns contact group by id
contactGroupsGetList GET /api/v1/ContactGroups/subscription/{subscriptionId}/groups Returns contact groups by subscriptionId
contactGroupsGetListWithHttpInfo GET /api/v1/ContactGroups/subscription/{subscriptionId}/groups Returns contact groups by subscriptionId
contactGroupsUpdate PUT /api/v1/ContactGroups/{id} Updates contact group by id
contactGroupsUpdateWithHttpInfo PUT /api/v1/ContactGroups/{id} Updates contact group by id

contactGroupsCreate

ContactGroupVM contactGroupsCreate(createContactGroupVM)

Creates contact group

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.ContactGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        ContactGroupsApi apiInstance = new ContactGroupsApi(defaultClient);
        CreateContactGroupVM createContactGroupVM = new CreateContactGroupVM(); // CreateContactGroupVM | 
        try {
            ContactGroupVM result = apiInstance.contactGroupsCreate(createContactGroupVM);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactGroupsApi#contactGroupsCreate");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
createContactGroupVM CreateContactGroupVM [optional]

Return type

ContactGroupVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
403 Forbidden -
404 Not Found -
402 Client Error -
400 Bad Request -
500 Server Error -

contactGroupsCreateWithHttpInfo

ApiResponse contactGroupsCreate contactGroupsCreateWithHttpInfo(createContactGroupVM)

Creates contact group

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.ApiResponse;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.ContactGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        ContactGroupsApi apiInstance = new ContactGroupsApi(defaultClient);
        CreateContactGroupVM createContactGroupVM = new CreateContactGroupVM(); // CreateContactGroupVM | 
        try {
            ApiResponse<ContactGroupVM> response = apiInstance.contactGroupsCreateWithHttpInfo(createContactGroupVM);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactGroupsApi#contactGroupsCreate");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
createContactGroupVM CreateContactGroupVM [optional]

Return type

ApiResponse<ContactGroupVM>

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
403 Forbidden -
404 Not Found -
402 Client Error -
400 Bad Request -
500 Server Error -

contactGroupsDelete

void contactGroupsDelete(id)

Removes contact by id

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.ContactGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        ContactGroupsApi apiInstance = new ContactGroupsApi(defaultClient);
        String id = "id_example"; // String | 
        try {
            apiInstance.contactGroupsDelete(id);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactGroupsApi#contactGroupsDelete");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id String

Return type

null (empty response body)

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 No Content -
403 Forbidden -
404 Not Found -
402 Client Error -
400 Bad Request -
500 Server Error -

contactGroupsDeleteWithHttpInfo

ApiResponse contactGroupsDelete contactGroupsDeleteWithHttpInfo(id)

Removes contact by id

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.ApiResponse;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.ContactGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        ContactGroupsApi apiInstance = new ContactGroupsApi(defaultClient);
        String id = "id_example"; // String | 
        try {
            ApiResponse<Void> response = apiInstance.contactGroupsDeleteWithHttpInfo(id);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactGroupsApi#contactGroupsDelete");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id String

Return type

ApiResponse

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 No Content -
403 Forbidden -
404 Not Found -
402 Client Error -
400 Bad Request -
500 Server Error -

contactGroupsGet

ContactGroupVM contactGroupsGet(id)

Returns contact group by id

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.ContactGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        ContactGroupsApi apiInstance = new ContactGroupsApi(defaultClient);
        String id = "id_example"; // String | 
        try {
            ContactGroupVM result = apiInstance.contactGroupsGet(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactGroupsApi#contactGroupsGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id String

Return type

ContactGroupVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
403 Forbidden -
404 Not Found -
402 Client Error -
400 Bad Request -
500 Server Error -

contactGroupsGetWithHttpInfo

ApiResponse contactGroupsGet contactGroupsGetWithHttpInfo(id)

Returns contact group by id

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.ApiResponse;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.ContactGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        ContactGroupsApi apiInstance = new ContactGroupsApi(defaultClient);
        String id = "id_example"; // String | 
        try {
            ApiResponse<ContactGroupVM> response = apiInstance.contactGroupsGetWithHttpInfo(id);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactGroupsApi#contactGroupsGet");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id String

Return type

ApiResponse<ContactGroupVM>

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
403 Forbidden -
404 Not Found -
402 Client Error -
400 Bad Request -
500 Server Error -

contactGroupsGetList

ContactGroupsVM contactGroupsGetList(subscriptionId, skip, take)

Returns contact groups by subscriptionId

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.ContactGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        ContactGroupsApi apiInstance = new ContactGroupsApi(defaultClient);
        String subscriptionId = "subscriptionId_example"; // String | 
        Integer skip = 0; // Integer | 
        Integer take = 10; // Integer | 
        try {
            ContactGroupsVM result = apiInstance.contactGroupsGetList(subscriptionId, skip, take);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactGroupsApi#contactGroupsGetList");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
subscriptionId String
skip Integer [optional] [default to 0]
take Integer [optional] [default to 10]

Return type

ContactGroupsVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
403 Forbidden -
404 Not Found -
402 Client Error -
400 Bad Request -
500 Server Error -

contactGroupsGetListWithHttpInfo

ApiResponse contactGroupsGetList contactGroupsGetListWithHttpInfo(subscriptionId, skip, take)

Returns contact groups by subscriptionId

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.ApiResponse;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.ContactGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        ContactGroupsApi apiInstance = new ContactGroupsApi(defaultClient);
        String subscriptionId = "subscriptionId_example"; // String | 
        Integer skip = 0; // Integer | 
        Integer take = 10; // Integer | 
        try {
            ApiResponse<ContactGroupsVM> response = apiInstance.contactGroupsGetListWithHttpInfo(subscriptionId, skip, take);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactGroupsApi#contactGroupsGetList");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
subscriptionId String
skip Integer [optional] [default to 0]
take Integer [optional] [default to 10]

Return type

ApiResponse<ContactGroupsVM>

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
403 Forbidden -
404 Not Found -
402 Client Error -
400 Bad Request -
500 Server Error -

contactGroupsUpdate

ContactGroupVM contactGroupsUpdate(id, updateContactGroupVM)

Updates contact group by id

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.ContactGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        ContactGroupsApi apiInstance = new ContactGroupsApi(defaultClient);
        String id = "id_example"; // String | 
        UpdateContactGroupVM updateContactGroupVM = new UpdateContactGroupVM(); // UpdateContactGroupVM | 
        try {
            ContactGroupVM result = apiInstance.contactGroupsUpdate(id, updateContactGroupVM);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactGroupsApi#contactGroupsUpdate");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id String
updateContactGroupVM UpdateContactGroupVM [optional]

Return type

ContactGroupVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
402 Client Error -
403 Forbidden -
404 Not Found -
500 Server Error -

contactGroupsUpdateWithHttpInfo

ApiResponse contactGroupsUpdate contactGroupsUpdateWithHttpInfo(id, updateContactGroupVM)

Updates contact group by id

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.ApiResponse;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.ContactGroupsApi;

public class Example {
    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("http://localhost");
        
        // Configure HTTP basic authorization: ApiKey
        HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
        ApiKey.setUsername("YOUR USERNAME");
        ApiKey.setPassword("YOUR PASSWORD");

        // Configure HTTP bearer authorization: JWT
        HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
        JWT.setBearerToken("BEARER TOKEN");

        ContactGroupsApi apiInstance = new ContactGroupsApi(defaultClient);
        String id = "id_example"; // String | 
        UpdateContactGroupVM updateContactGroupVM = new UpdateContactGroupVM(); // UpdateContactGroupVM | 
        try {
            ApiResponse<ContactGroupVM> response = apiInstance.contactGroupsUpdateWithHttpInfo(id, updateContactGroupVM);
            System.out.println("Status code: " + response.getStatusCode());
            System.out.println("Response headers: " + response.getHeaders());
            System.out.println("Response body: " + response.getData());
        } catch (ApiException e) {
            System.err.println("Exception when calling ContactGroupsApi#contactGroupsUpdate");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Response headers: " + e.getResponseHeaders());
            System.err.println("Reason: " + e.getResponseBody());
            e.printStackTrace();
        }
    }
}

Parameters

Name Type Description Notes
id String
updateContactGroupVM UpdateContactGroupVM [optional]

Return type

ApiResponse<ContactGroupVM>

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Success -
400 Bad Request -
402 Client Error -
403 Forbidden -
404 Not Found -
500 Server Error -