Skip to content

README.md

Latest commit

 

History

History
1203 lines (860 loc) · 50.5 KB

README.md

File metadata and controls

1203 lines (860 loc) · 50.5 KB

Uc

Overview

Available Operations

createUcComment

Create a comment

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.CreateUcCommentRequest;
import to.unified.unified_java_sdk.models.operations.CreateUcCommentResponse;
import to.unified.unified_java_sdk.models.shared.Security;
import to.unified.unified_java_sdk.models.shared.UcComment;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        CreateUcCommentRequest req = CreateUcCommentRequest.builder()
                .ucComment(UcComment.builder()
                    .content("<value>")
                    .build())
                .connectionId("<id>")
                .build();

        CreateUcCommentResponse res = sdk.uc().createUcComment()
                .request(req)
                .call();

        if (res.ucComment().isPresent()) {
            System.out.println(res.ucComment().get());
        }
    }
}

Parameters

Parameter Type Required Description
request CreateUcCommentRequest ✔️ The request object to use for the request.

Response

CreateUcCommentResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

createUcContact

Create a contact

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.CreateUcContactRequest;
import to.unified.unified_java_sdk.models.operations.CreateUcContactResponse;
import to.unified.unified_java_sdk.models.shared.Security;
import to.unified.unified_java_sdk.models.shared.UcContact;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        CreateUcContactRequest req = CreateUcContactRequest.builder()
                .ucContact(UcContact.builder()
                    .build())
                .connectionId("<id>")
                .build();

        CreateUcContactResponse res = sdk.uc().createUcContact()
                .request(req)
                .call();

        if (res.ucContact().isPresent()) {
            System.out.println(res.ucContact().get());
        }
    }
}

Parameters

Parameter Type Required Description
request CreateUcContactRequest ✔️ The request object to use for the request.

Response

CreateUcContactResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

createUcRecording

Create a recording

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.CreateUcRecordingRequest;
import to.unified.unified_java_sdk.models.operations.CreateUcRecordingResponse;
import to.unified.unified_java_sdk.models.shared.Security;
import to.unified.unified_java_sdk.models.shared.UcRecording;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        CreateUcRecordingRequest req = CreateUcRecordingRequest.builder()
                .ucRecording(UcRecording.builder()
                    .build())
                .connectionId("<id>")
                .build();

        CreateUcRecordingResponse res = sdk.uc().createUcRecording()
                .request(req)
                .call();

        if (res.ucRecording().isPresent()) {
            System.out.println(res.ucRecording().get());
        }
    }
}

Parameters

Parameter Type Required Description
request CreateUcRecordingRequest ✔️ The request object to use for the request.

Response

CreateUcRecordingResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

getUcCall

Retrieve a call

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.GetUcCallRequest;
import to.unified.unified_java_sdk.models.operations.GetUcCallResponse;
import to.unified.unified_java_sdk.models.shared.Security;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        GetUcCallRequest req = GetUcCallRequest.builder()
                .connectionId("<id>")
                .id("<id>")
                .build();

        GetUcCallResponse res = sdk.uc().getUcCall()
                .request(req)
                .call();

        if (res.ucCall().isPresent()) {
            System.out.println(res.ucCall().get());
        }
    }
}

Parameters

Parameter Type Required Description
request GetUcCallRequest ✔️ The request object to use for the request.

Response

GetUcCallResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

getUcComment

Retrieve a comment

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.GetUcCommentRequest;
import to.unified.unified_java_sdk.models.operations.GetUcCommentResponse;
import to.unified.unified_java_sdk.models.shared.Security;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        GetUcCommentRequest req = GetUcCommentRequest.builder()
                .connectionId("<id>")
                .id("<id>")
                .build();

        GetUcCommentResponse res = sdk.uc().getUcComment()
                .request(req)
                .call();

        if (res.ucComment().isPresent()) {
            System.out.println(res.ucComment().get());
        }
    }
}

Parameters

Parameter Type Required Description
request GetUcCommentRequest ✔️ The request object to use for the request.

Response

GetUcCommentResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

getUcContact

Retrieve a contact

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.GetUcContactRequest;
import to.unified.unified_java_sdk.models.operations.GetUcContactResponse;
import to.unified.unified_java_sdk.models.shared.Security;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        GetUcContactRequest req = GetUcContactRequest.builder()
                .connectionId("<id>")
                .id("<id>")
                .build();

        GetUcContactResponse res = sdk.uc().getUcContact()
                .request(req)
                .call();

        if (res.ucContact().isPresent()) {
            System.out.println(res.ucContact().get());
        }
    }
}

Parameters

Parameter Type Required Description
request GetUcContactRequest ✔️ The request object to use for the request.

Response

GetUcContactResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

getUcRecording

Retrieve a recording

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.GetUcRecordingRequest;
import to.unified.unified_java_sdk.models.operations.GetUcRecordingResponse;
import to.unified.unified_java_sdk.models.shared.Security;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        GetUcRecordingRequest req = GetUcRecordingRequest.builder()
                .connectionId("<id>")
                .id("<id>")
                .build();

        GetUcRecordingResponse res = sdk.uc().getUcRecording()
                .request(req)
                .call();

        if (res.ucRecording().isPresent()) {
            System.out.println(res.ucRecording().get());
        }
    }
}

Parameters

Parameter Type Required Description
request GetUcRecordingRequest ✔️ The request object to use for the request.

Response

GetUcRecordingResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

listUcCalls

List all calls

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.ListUcCallsRequest;
import to.unified.unified_java_sdk.models.operations.ListUcCallsResponse;
import to.unified.unified_java_sdk.models.shared.Security;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        ListUcCallsRequest req = ListUcCallsRequest.builder()
                .connectionId("<id>")
                .build();

        ListUcCallsResponse res = sdk.uc().listUcCalls()
                .request(req)
                .call();

        if (res.ucCalls().isPresent()) {
            System.out.println(res.ucCalls().get());
        }
    }
}

Parameters

Parameter Type Required Description
request ListUcCallsRequest ✔️ The request object to use for the request.

Response

ListUcCallsResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

listUcComments

List all comments

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.ListUcCommentsRequest;
import to.unified.unified_java_sdk.models.operations.ListUcCommentsResponse;
import to.unified.unified_java_sdk.models.shared.Security;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        ListUcCommentsRequest req = ListUcCommentsRequest.builder()
                .connectionId("<id>")
                .build();

        ListUcCommentsResponse res = sdk.uc().listUcComments()
                .request(req)
                .call();

        if (res.ucComments().isPresent()) {
            System.out.println(res.ucComments().get());
        }
    }
}

Parameters

Parameter Type Required Description
request ListUcCommentsRequest ✔️ The request object to use for the request.

Response

ListUcCommentsResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

listUcContacts

List all contacts

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.ListUcContactsRequest;
import to.unified.unified_java_sdk.models.operations.ListUcContactsResponse;
import to.unified.unified_java_sdk.models.shared.Security;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        ListUcContactsRequest req = ListUcContactsRequest.builder()
                .connectionId("<id>")
                .build();

        ListUcContactsResponse res = sdk.uc().listUcContacts()
                .request(req)
                .call();

        if (res.ucContacts().isPresent()) {
            System.out.println(res.ucContacts().get());
        }
    }
}

Parameters

Parameter Type Required Description
request ListUcContactsRequest ✔️ The request object to use for the request.

Response

ListUcContactsResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

listUcRecordings

List all recordings

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.ListUcRecordingsRequest;
import to.unified.unified_java_sdk.models.operations.ListUcRecordingsResponse;
import to.unified.unified_java_sdk.models.shared.Security;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        ListUcRecordingsRequest req = ListUcRecordingsRequest.builder()
                .connectionId("<id>")
                .build();

        ListUcRecordingsResponse res = sdk.uc().listUcRecordings()
                .request(req)
                .call();

        if (res.ucRecordings().isPresent()) {
            System.out.println(res.ucRecordings().get());
        }
    }
}

Parameters

Parameter Type Required Description
request ListUcRecordingsRequest ✔️ The request object to use for the request.

Response

ListUcRecordingsResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

patchUcComment

Update a comment

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.PatchUcCommentRequest;
import to.unified.unified_java_sdk.models.operations.PatchUcCommentResponse;
import to.unified.unified_java_sdk.models.shared.Security;
import to.unified.unified_java_sdk.models.shared.UcComment;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        PatchUcCommentRequest req = PatchUcCommentRequest.builder()
                .ucComment(UcComment.builder()
                    .content("<value>")
                    .build())
                .connectionId("<id>")
                .id("<id>")
                .build();

        PatchUcCommentResponse res = sdk.uc().patchUcComment()
                .request(req)
                .call();

        if (res.ucComment().isPresent()) {
            System.out.println(res.ucComment().get());
        }
    }
}

Parameters

Parameter Type Required Description
request PatchUcCommentRequest ✔️ The request object to use for the request.

Response

PatchUcCommentResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

patchUcContact

Update a contact

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.PatchUcContactRequest;
import to.unified.unified_java_sdk.models.operations.PatchUcContactResponse;
import to.unified.unified_java_sdk.models.shared.Security;
import to.unified.unified_java_sdk.models.shared.UcContact;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        PatchUcContactRequest req = PatchUcContactRequest.builder()
                .ucContact(UcContact.builder()
                    .build())
                .connectionId("<id>")
                .id("<id>")
                .build();

        PatchUcContactResponse res = sdk.uc().patchUcContact()
                .request(req)
                .call();

        if (res.ucContact().isPresent()) {
            System.out.println(res.ucContact().get());
        }
    }
}

Parameters

Parameter Type Required Description
request PatchUcContactRequest ✔️ The request object to use for the request.

Response

PatchUcContactResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

patchUcRecording

Update a recording

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.PatchUcRecordingRequest;
import to.unified.unified_java_sdk.models.operations.PatchUcRecordingResponse;
import to.unified.unified_java_sdk.models.shared.Security;
import to.unified.unified_java_sdk.models.shared.UcRecording;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        PatchUcRecordingRequest req = PatchUcRecordingRequest.builder()
                .ucRecording(UcRecording.builder()
                    .build())
                .connectionId("<id>")
                .id("<id>")
                .build();

        PatchUcRecordingResponse res = sdk.uc().patchUcRecording()
                .request(req)
                .call();

        if (res.ucRecording().isPresent()) {
            System.out.println(res.ucRecording().get());
        }
    }
}

Parameters

Parameter Type Required Description
request PatchUcRecordingRequest ✔️ The request object to use for the request.

Response

PatchUcRecordingResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

removeUcComment

Remove a comment

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.RemoveUcCommentRequest;
import to.unified.unified_java_sdk.models.operations.RemoveUcCommentResponse;
import to.unified.unified_java_sdk.models.shared.Security;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        RemoveUcCommentRequest req = RemoveUcCommentRequest.builder()
                .connectionId("<id>")
                .id("<id>")
                .build();

        RemoveUcCommentResponse res = sdk.uc().removeUcComment()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter Type Required Description
request RemoveUcCommentRequest ✔️ The request object to use for the request.

Response

RemoveUcCommentResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

removeUcContact

Remove a contact

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.RemoveUcContactRequest;
import to.unified.unified_java_sdk.models.operations.RemoveUcContactResponse;
import to.unified.unified_java_sdk.models.shared.Security;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        RemoveUcContactRequest req = RemoveUcContactRequest.builder()
                .connectionId("<id>")
                .id("<id>")
                .build();

        RemoveUcContactResponse res = sdk.uc().removeUcContact()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter Type Required Description
request RemoveUcContactRequest ✔️ The request object to use for the request.

Response

RemoveUcContactResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

removeUcRecording

Remove a recording

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.RemoveUcRecordingRequest;
import to.unified.unified_java_sdk.models.operations.RemoveUcRecordingResponse;
import to.unified.unified_java_sdk.models.shared.Security;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        RemoveUcRecordingRequest req = RemoveUcRecordingRequest.builder()
                .connectionId("<id>")
                .id("<id>")
                .build();

        RemoveUcRecordingResponse res = sdk.uc().removeUcRecording()
                .request(req)
                .call();

        // handle response
    }
}

Parameters

Parameter Type Required Description
request RemoveUcRecordingRequest ✔️ The request object to use for the request.

Response

RemoveUcRecordingResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

updateUcComment

Update a comment

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.UpdateUcCommentRequest;
import to.unified.unified_java_sdk.models.operations.UpdateUcCommentResponse;
import to.unified.unified_java_sdk.models.shared.Security;
import to.unified.unified_java_sdk.models.shared.UcComment;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        UpdateUcCommentRequest req = UpdateUcCommentRequest.builder()
                .ucComment(UcComment.builder()
                    .content("<value>")
                    .build())
                .connectionId("<id>")
                .id("<id>")
                .build();

        UpdateUcCommentResponse res = sdk.uc().updateUcComment()
                .request(req)
                .call();

        if (res.ucComment().isPresent()) {
            System.out.println(res.ucComment().get());
        }
    }
}

Parameters

Parameter Type Required Description
request UpdateUcCommentRequest ✔️ The request object to use for the request.

Response

UpdateUcCommentResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

updateUcContact

Update a contact

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.UpdateUcContactRequest;
import to.unified.unified_java_sdk.models.operations.UpdateUcContactResponse;
import to.unified.unified_java_sdk.models.shared.Security;
import to.unified.unified_java_sdk.models.shared.UcContact;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        UpdateUcContactRequest req = UpdateUcContactRequest.builder()
                .ucContact(UcContact.builder()
                    .build())
                .connectionId("<id>")
                .id("<id>")
                .build();

        UpdateUcContactResponse res = sdk.uc().updateUcContact()
                .request(req)
                .call();

        if (res.ucContact().isPresent()) {
            System.out.println(res.ucContact().get());
        }
    }
}

Parameters

Parameter Type Required Description
request UpdateUcContactRequest ✔️ The request object to use for the request.

Response

UpdateUcContactResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

updateUcRecording

Update a recording

Example Usage

package hello.world;

import java.lang.Exception;
import to.unified.unified_java_sdk.UnifiedTo;
import to.unified.unified_java_sdk.models.operations.UpdateUcRecordingRequest;
import to.unified.unified_java_sdk.models.operations.UpdateUcRecordingResponse;
import to.unified.unified_java_sdk.models.shared.Security;
import to.unified.unified_java_sdk.models.shared.UcRecording;

public class Application {

    public static void main(String[] args) throws Exception {

        UnifiedTo sdk = UnifiedTo.builder()
                .security(Security.builder()
                    .jwt(System.getenv().getOrDefault("JWT", ""))
                    .build())
            .build();

        UpdateUcRecordingRequest req = UpdateUcRecordingRequest.builder()
                .ucRecording(UcRecording.builder()
                    .build())
                .connectionId("<id>")
                .id("<id>")
                .build();

        UpdateUcRecordingResponse res = sdk.uc().updateUcRecording()
                .request(req)
                .call();

        if (res.ucRecording().isPresent()) {
            System.out.println(res.ucRecording().get());
        }
    }
}

Parameters

Parameter Type Required Description
request UpdateUcRecordingRequest ✔️ The request object to use for the request.

Response

UpdateUcRecordingResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*