Skip to content

README.md

Latest commit

 

History

History
415 lines (326 loc) · 21.9 KB

README.md

File metadata and controls

415 lines (326 loc) · 21.9 KB

Crm.CustomObjects

Overview

Available Operations

  • list - List custom objects
  • create - Create custom object
  • get - Get custom object
  • update - Update custom object
  • delete - Delete custom object

list

List custom objects

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.errors.*;
import com.apideck.unify.models.operations.CrmCustomObjectsAllRequest;
import com.apideck.unify.models.operations.CrmCustomObjectsAllResponse;
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()
                .consumerId("test-consumer")
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
                .apiKey(System.getenv().getOrDefault("API_KEY", ""))
            .build();

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


        sdk.crm().customObjects().list()
                .callAsStream()
                .forEach((CrmCustomObjectsAllResponse item) -> {
                   // handle page
                });

    }
}

Parameters

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

Response

CrmCustomObjectsAllResponse

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 custom object

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.components.*;
import com.apideck.unify.models.errors.*;
import com.apideck.unify.models.operations.CrmCustomObjectsAddRequest;
import com.apideck.unify.models.operations.CrmCustomObjectsAddResponse;
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()
                .consumerId("test-consumer")
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
                .apiKey(System.getenv().getOrDefault("API_KEY", ""))
            .build();

        CrmCustomObjectsAddRequest req = CrmCustomObjectsAddRequest.builder()
                .objectId("<id>")
                .customObject(CustomObjectInput.builder()
                    .name("project")
                    .fields(List.of(
                        CustomObjectFields.builder()
                            .name("name")
                            .value("string")
                            .build(),
                        CustomObjectFields.builder()
                            .name("name")
                            .value("string")
                            .build(),
                        CustomObjectFields.builder()
                            .name("name")
                            .value("string")
                            .build()))
                    .passThrough(List.of(
                        PassThroughBody.builder()
                            .serviceId("<id>")
                            .extendPaths(List.of(
                                ExtendPaths.builder()
                                    .path("$.nested.property")
                                    .value(Map.ofEntries(
                                        Map.entry("TaxClassificationRef", Map.ofEntries(
                                            Map.entry("value", "EUC-99990201-V1-00020000")))))
                                    .build()))
                            .build(),
                        PassThroughBody.builder()
                            .serviceId("<id>")
                            .extendPaths(List.of(
                                ExtendPaths.builder()
                                    .path("$.nested.property")
                                    .value(Map.ofEntries(
                                        Map.entry("TaxClassificationRef", Map.ofEntries(
                                            Map.entry("value", "EUC-99990201-V1-00020000")))))
                                    .build()))
                            .build(),
                        PassThroughBody.builder()
                            .serviceId("<id>")
                            .extendPaths(List.of(
                                ExtendPaths.builder()
                                    .path("$.nested.property")
                                    .value(Map.ofEntries(
                                        Map.entry("TaxClassificationRef", Map.ofEntries(
                                            Map.entry("value", "EUC-99990201-V1-00020000")))))
                                    .build()))
                            .build()))
                    .build())
                .serviceId("salesforce")
                .build();

        CrmCustomObjectsAddResponse res = sdk.crm().customObjects().create()
                .request(req)
                .call();

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

Parameters

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

Response

CrmCustomObjectsAddResponse

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 custom object

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.errors.*;
import com.apideck.unify.models.operations.CrmCustomObjectsOneRequest;
import com.apideck.unify.models.operations.CrmCustomObjectsOneResponse;
import java.lang.Exception;

public class Application {

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

        Apideck sdk = Apideck.builder()
                .consumerId("test-consumer")
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
                .apiKey(System.getenv().getOrDefault("API_KEY", ""))
            .build();

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

        CrmCustomObjectsOneResponse res = sdk.crm().customObjects().get()
                .request(req)
                .call();

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

Parameters

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

Response

CrmCustomObjectsOneResponse

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 custom object

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.components.*;
import com.apideck.unify.models.errors.*;
import com.apideck.unify.models.operations.CrmCustomObjectsUpdateRequest;
import com.apideck.unify.models.operations.CrmCustomObjectsUpdateResponse;
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()
                .consumerId("test-consumer")
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
                .apiKey(System.getenv().getOrDefault("API_KEY", ""))
            .build();

        CrmCustomObjectsUpdateRequest req = CrmCustomObjectsUpdateRequest.builder()
                .id("<id>")
                .objectId("<id>")
                .customObject(CustomObjectInput.builder()
                    .name("project")
                    .fields(List.of(
                        CustomObjectFields.builder()
                            .name("name")
                            .value("string")
                            .build(),
                        CustomObjectFields.builder()
                            .name("name")
                            .value("string")
                            .build()))
                    .passThrough(List.of(
                        PassThroughBody.builder()
                            .serviceId("<id>")
                            .extendPaths(List.of(
                                ExtendPaths.builder()
                                    .path("$.nested.property")
                                    .value(Map.ofEntries(
                                        Map.entry("TaxClassificationRef", Map.ofEntries(
                                            Map.entry("value", "EUC-99990201-V1-00020000")))))
                                    .build(),
                                ExtendPaths.builder()
                                    .path("$.nested.property")
                                    .value(Map.ofEntries(
                                        Map.entry("TaxClassificationRef", Map.ofEntries(
                                            Map.entry("value", "EUC-99990201-V1-00020000")))))
                                    .build()))
                            .build()))
                    .build())
                .serviceId("salesforce")
                .build();

        CrmCustomObjectsUpdateResponse res = sdk.crm().customObjects().update()
                .request(req)
                .call();

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

Parameters

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

Response

CrmCustomObjectsUpdateResponse

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 custom object

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.errors.*;
import com.apideck.unify.models.operations.CrmCustomObjectsDeleteRequest;
import com.apideck.unify.models.operations.CrmCustomObjectsDeleteResponse;
import java.lang.Exception;

public class Application {

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

        Apideck sdk = Apideck.builder()
                .consumerId("test-consumer")
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
                .apiKey(System.getenv().getOrDefault("API_KEY", ""))
            .build();

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

        CrmCustomObjectsDeleteResponse res = sdk.crm().customObjects().delete()
                .request(req)
                .call();

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

Parameters

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

Response

CrmCustomObjectsDeleteResponse

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 */*