Skip to content

Latest commit

 

History

History
124 lines (87 loc) · 4.8 KB

README.md

File metadata and controls

124 lines (87 loc) · 4.8 KB

Logos

(logos())

Overview

Available Operations

  • bulkSync - Get Logos for given search keys
  • search - Get Logos for given search keys

bulkSync

Get Logos for given search keys

Example Usage

package hello.world;

import com.benzinga.bzclient.Bzclient;
import com.benzinga.bzclient.models.errors.BzhttpResp;
import com.benzinga.bzclient.models.operations.LogoBulkSyncRequest;
import com.benzinga.bzclient.models.operations.LogoBulkSyncResponse;
import java.lang.Exception;
import java.util.List;

public class Application {

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

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        LogoBulkSyncRequest req = LogoBulkSyncRequest.builder()
                .searchKeys("<value>")
                .fields(List.of(
                    "<value>",
                    "<value>"))
                .build();

        LogoBulkSyncResponse res = sdk.logos().bulkSync()
                .request(req)
                .call();

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

Parameters

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

Response

LogoBulkSyncResponse

Errors

Error Type Status Code Content Type
models/errors/BzhttpResp 400, 404, 500 application/json
models/errors/APIException 4XX, 5XX */*

search

Get Logos for given search keys

Example Usage

package hello.world;

import com.benzinga.bzclient.Bzclient;
import com.benzinga.bzclient.models.errors.BzhttpResp;
import com.benzinga.bzclient.models.operations.GetSearchLogosRequest;
import com.benzinga.bzclient.models.operations.GetSearchLogosResponse;
import java.lang.Exception;

public class Application {

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

        Bzclient sdk = Bzclient.builder()
                .apiKeyAuth("<YOUR_API_KEY_HERE>")
            .build();

        GetSearchLogosRequest req = GetSearchLogosRequest.builder()
                .searchKeys("<value>")
                .fields("<value>")
                .build();

        GetSearchLogosResponse res = sdk.logos().search()
                .request(req)
                .call();

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

Parameters

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

Response

GetSearchLogosResponse

Errors

Error Type Status Code Content Type
models/errors/BzhttpResp 400, 404, 500 application/json
models/errors/APIException 4XX, 5XX */*