Notes

(crm().notes())

Overview

Available Operations

list - List notes
create - Create note
get - Get note
update - Update note
delete - Delete note

list

List notes

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.errors.BadRequestResponse;
import com.apideck.unify.models.errors.NotFoundResponse;
import com.apideck.unify.models.errors.PaymentRequiredResponse;
import com.apideck.unify.models.errors.UnauthorizedResponse;
import com.apideck.unify.models.errors.UnprocessableResponse;
import com.apideck.unify.models.operations.CrmNotesAllRequest;
import java.lang.Exception;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws BadRequestResponse, UnauthorizedResponse, PaymentRequiredResponse, NotFoundResponse, UnprocessableResponse, Exception {

        Apideck sdk = Apideck.builder()
                .apiKey("<YOUR_BEARER_TOKEN_HERE>")
                .consumerId("test-consumer")
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
            .build();

        CrmNotesAllRequest req = CrmNotesAllRequest.builder()
                .serviceId("salesforce")
                .passThrough(Map.ofEntries(
                    Map.entry("search", "San Francisco")))
                .fields("id,updated_at")
                .build();

        sdk.crm().notes().list()
                .request(req)
                .callAsStream()
            .forEach(item -> {
               // handle item
            });

    }
}

Parameters

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

Response

CrmNotesAllResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/PaymentRequiredResponse	402	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/UnprocessableResponse	422	application/json
models/errors/APIException	4XX, 5XX	/

create

Create note

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.components.ExtendPaths;
import com.apideck.unify.models.components.NoteInput;
import com.apideck.unify.models.components.PassThroughBody;
import com.apideck.unify.models.errors.BadRequestResponse;
import com.apideck.unify.models.errors.NotFoundResponse;
import com.apideck.unify.models.errors.PaymentRequiredResponse;
import com.apideck.unify.models.errors.UnauthorizedResponse;
import com.apideck.unify.models.errors.UnprocessableResponse;
import com.apideck.unify.models.operations.CrmNotesAddRequest;
import com.apideck.unify.models.operations.CrmNotesAddResponse;
import java.lang.Exception;
import java.util.List;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws BadRequestResponse, UnauthorizedResponse, PaymentRequiredResponse, NotFoundResponse, UnprocessableResponse, Exception {

        Apideck sdk = Apideck.builder()
                .apiKey("<YOUR_BEARER_TOKEN_HERE>")
                .consumerId("test-consumer")
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
            .build();

        CrmNotesAddRequest req = CrmNotesAddRequest.builder()
                .note(NoteInput.builder()
                    .title("Meeting Notes")
                    .content("Office hours are 9AM-6PM")
                    .ownerId("12345")
                    .contactId("12345")
                    .companyId("12345")
                    .opportunityId("12345")
                    .leadId("12345")
                    .active(true)
                    .passThrough(List.of(
                        PassThroughBody.builder()
                            .serviceId("<id>")
                            .extendPaths(List.of(
                                ExtendPaths.builder()
                                    .path("$.nested.property")
                                    .value(Map.ofEntries(\n    Map.entry("TaxClassificationRef", Map.ofEntries(\n    Map.entry("value", "EUC-99990201-V1-00020000")))))
                                    .build(),
                                ExtendPaths.builder()
                                    .path("$.nested.property")
                                    .value(Map.ofEntries(\n    Map.entry("TaxClassificationRef", Map.ofEntries(\n    Map.entry("value", "EUC-99990201-V1-00020000")))))
                                    .build()))
                            .build()))
                    .build())
                .serviceId("salesforce")
                .build();

        CrmNotesAddResponse res = sdk.crm().notes().create()
                .request(req)
                .call();

        if (res.createNoteResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

CrmNotesAddResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/PaymentRequiredResponse	402	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/UnprocessableResponse	422	application/json
models/errors/APIException	4XX, 5XX	/

get

Get note

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.errors.BadRequestResponse;
import com.apideck.unify.models.errors.NotFoundResponse;
import com.apideck.unify.models.errors.PaymentRequiredResponse;
import com.apideck.unify.models.errors.UnauthorizedResponse;
import com.apideck.unify.models.errors.UnprocessableResponse;
import com.apideck.unify.models.operations.CrmNotesOneRequest;
import com.apideck.unify.models.operations.CrmNotesOneResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws BadRequestResponse, UnauthorizedResponse, PaymentRequiredResponse, NotFoundResponse, UnprocessableResponse, Exception {

        Apideck sdk = Apideck.builder()
                .apiKey("<YOUR_BEARER_TOKEN_HERE>")
                .consumerId("test-consumer")
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
            .build();

        CrmNotesOneRequest req = CrmNotesOneRequest.builder()
                .id("<id>")
                .serviceId("salesforce")
                .fields("id,updated_at")
                .build();

        CrmNotesOneResponse res = sdk.crm().notes().get()
                .request(req)
                .call();

        if (res.getNoteResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

CrmNotesOneResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/PaymentRequiredResponse	402	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/UnprocessableResponse	422	application/json
models/errors/APIException	4XX, 5XX	/

update

Update note

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.components.ExtendPaths;
import com.apideck.unify.models.components.NoteInput;
import com.apideck.unify.models.components.PassThroughBody;
import com.apideck.unify.models.errors.BadRequestResponse;
import com.apideck.unify.models.errors.NotFoundResponse;
import com.apideck.unify.models.errors.PaymentRequiredResponse;
import com.apideck.unify.models.errors.UnauthorizedResponse;
import com.apideck.unify.models.errors.UnprocessableResponse;
import com.apideck.unify.models.operations.CrmNotesUpdateRequest;
import com.apideck.unify.models.operations.CrmNotesUpdateResponse;
import java.lang.Exception;
import java.util.List;
import java.util.Map;

public class Application {

    public static void main(String[] args) throws BadRequestResponse, UnauthorizedResponse, PaymentRequiredResponse, NotFoundResponse, UnprocessableResponse, Exception {

        Apideck sdk = Apideck.builder()
                .apiKey("<YOUR_BEARER_TOKEN_HERE>")
                .consumerId("test-consumer")
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
            .build();

        CrmNotesUpdateRequest req = CrmNotesUpdateRequest.builder()
                .id("<id>")
                .note(NoteInput.builder()
                    .title("Meeting Notes")
                    .content("Office hours are 9AM-6PM")
                    .ownerId("12345")
                    .contactId("12345")
                    .companyId("12345")
                    .opportunityId("12345")
                    .leadId("12345")
                    .active(true)
                    .passThrough(List.of(
                        PassThroughBody.builder()
                            .serviceId("<id>")
                            .extendPaths(List.of(
                                ExtendPaths.builder()
                                    .path("$.nested.property")
                                    .value(Map.ofEntries(\n    Map.entry("TaxClassificationRef", Map.ofEntries(\n    Map.entry("value", "EUC-99990201-V1-00020000")))))
                                    .build(),
                                ExtendPaths.builder()
                                    .path("$.nested.property")
                                    .value(Map.ofEntries(\n    Map.entry("TaxClassificationRef", Map.ofEntries(\n    Map.entry("value", "EUC-99990201-V1-00020000")))))
                                    .build()))
                            .build(),
                        PassThroughBody.builder()
                            .serviceId("<id>")
                            .extendPaths(List.of(
                                ExtendPaths.builder()
                                    .path("$.nested.property")
                                    .value(Map.ofEntries(\n    Map.entry("TaxClassificationRef", Map.ofEntries(\n    Map.entry("value", "EUC-99990201-V1-00020000")))))
                                    .build()))
                            .build(),
                        PassThroughBody.builder()
                            .serviceId("<id>")
                            .extendPaths(List.of(
                                ExtendPaths.builder()
                                    .path("$.nested.property")
                                    .value(Map.ofEntries(\n    Map.entry("TaxClassificationRef", Map.ofEntries(\n    Map.entry("value", "EUC-99990201-V1-00020000")))))
                                    .build(),
                                ExtendPaths.builder()
                                    .path("$.nested.property")
                                    .value(Map.ofEntries(\n    Map.entry("TaxClassificationRef", Map.ofEntries(\n    Map.entry("value", "EUC-99990201-V1-00020000")))))
                                    .build(),
                                ExtendPaths.builder()
                                    .path("$.nested.property")
                                    .value(Map.ofEntries(\n    Map.entry("TaxClassificationRef", Map.ofEntries(\n    Map.entry("value", "EUC-99990201-V1-00020000")))))
                                    .build()))
                            .build()))
                    .build())
                .serviceId("salesforce")
                .build();

        CrmNotesUpdateResponse res = sdk.crm().notes().update()
                .request(req)
                .call();

        if (res.updateNoteResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

CrmNotesUpdateResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/PaymentRequiredResponse	402	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/UnprocessableResponse	422	application/json
models/errors/APIException	4XX, 5XX	/

delete

Delete note

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.errors.BadRequestResponse;
import com.apideck.unify.models.errors.NotFoundResponse;
import com.apideck.unify.models.errors.PaymentRequiredResponse;
import com.apideck.unify.models.errors.UnauthorizedResponse;
import com.apideck.unify.models.errors.UnprocessableResponse;
import com.apideck.unify.models.operations.CrmNotesDeleteRequest;
import com.apideck.unify.models.operations.CrmNotesDeleteResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws BadRequestResponse, UnauthorizedResponse, PaymentRequiredResponse, NotFoundResponse, UnprocessableResponse, Exception {

        Apideck sdk = Apideck.builder()
                .apiKey("<YOUR_BEARER_TOKEN_HERE>")
                .consumerId("test-consumer")
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
            .build();

        CrmNotesDeleteRequest req = CrmNotesDeleteRequest.builder()
                .id("<id>")
                .serviceId("salesforce")
                .build();

        CrmNotesDeleteResponse res = sdk.crm().notes().delete()
                .request(req)
                .call();

        if (res.deleteNoteResponse().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

CrmNotesDeleteResponse

Errors

Error Type	Status Code	Content Type
models/errors/BadRequestResponse	400	application/json
models/errors/UnauthorizedResponse	401	application/json
models/errors/PaymentRequiredResponse	402	application/json
models/errors/NotFoundResponse	404	application/json
models/errors/UnprocessableResponse	422	application/json
models/errors/APIException	4XX, 5XX	/

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

Notes

Overview

Available Operations

list

Example Usage

Parameters

Response

Errors

create

Example Usage

Parameters

Response

Errors

get

Example Usage

Parameters

Response

Errors

update

Example Usage

Parameters

Response

Errors

delete

Example Usage

Parameters

Response

Errors

Files

README.md

Latest commit

History

README.md

File metadata and controls

Notes

Overview

Available Operations

list

Example Usage

Parameters

Response

Errors

create

Example Usage

Parameters

Response

Errors

get

Example Usage

Parameters

Response

Errors

update

Example Usage

Parameters

Response

Errors

delete

Example Usage

Parameters

Response

Errors