All Downloads are FREE. Search and download functionalities are using the official Maven repository.

ss.symphony.symphony-agent-java-jersey2-client.1.0.1.source-code.README.md Maven / Gradle / Ivy

There is a newer version: 1.50.1
Show newest version
# swagger-java-client

## Requirements

Building the API client library requires [Maven](https://maven.apache.org/) to be installed.

## Installation

To install the API client library to your local Maven repository, simply execute:

```shell
mvn install
```

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

```shell
mvn deploy
```

Refer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information.

### Maven users

Add this dependency to your project's POM:

```xml

    io.swagger
    swagger-java-client
    1.0.0
    compile

```

### Gradle users

Add this dependency to your project's build file:

```groovy
compile "io.swagger:swagger-java-client:1.0.0"
```

### Others

At first generate the JAR by executing:

    mvn package

Then manually install the following JARs:

* target/swagger-java-client-1.0.0.jar
* target/lib/*.jar

## Getting Started

Please follow the [installation](#installation) instruction and execute the following Java code:

```java

import org.symphonyoss.symphony.agent.invoker.*;
import org.symphonyoss.symphony.agent.invoker.auth.*;
import org.symphonyoss.symphony.agent.invoker.model.*;
import org.symphonyoss.symphony.agent.api.AttachmentsApi;

import java.io.File;
import java.util.*;

public class AttachmentsApiExample {

    public static void main(String[] args) {
        
        AttachmentsApi apiInstance = new AttachmentsApi();
        String sid = "sid_example"; // String | Stream ID
        String sessionToken = "sessionToken_example"; // String | Session authentication token.
        String keyManagerToken = "keyManagerToken_example"; // String | Key Manager authentication token.
        File file = new File("/path/to/file.txt"); // File | The attachment body.
        try {
            AttachmentInfo result = apiInstance.v1StreamSidAttachmentCreatePost(sid, sessionToken, keyManagerToken, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AttachmentsApi#v1StreamSidAttachmentCreatePost");
            e.printStackTrace();
        }
    }
}

```

## Documentation for API Endpoints

All URIs are relative to *https://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AttachmentsApi* | [**v1StreamSidAttachmentCreatePost**](docs/AttachmentsApi.md#v1StreamSidAttachmentCreatePost) | **POST** /v1/stream/{sid}/attachment/create | Upload an attachment.
*AttachmentsApi* | [**v1StreamSidAttachmentGet**](docs/AttachmentsApi.md#v1StreamSidAttachmentGet) | **GET** /v1/stream/{sid}/attachment | Download an attachment.
*DatafeedApi* | [**v1DatafeedCreatePost**](docs/DatafeedApi.md#v1DatafeedCreatePost) | **POST** /v1/datafeed/create | Create a new real time message event stream.
*DatafeedApi* | [**v1DatafeedIdReadGet**](docs/DatafeedApi.md#v1DatafeedIdReadGet) | **GET** /v1/datafeed/{id}/read | Read a given datafeed.
*DatafeedApi* | [**v2DatafeedIdReadGet**](docs/DatafeedApi.md#v2DatafeedIdReadGet) | **GET** /v2/datafeed/{id}/read | Read a given datafeed.
*MessagesApi* | [**v1MessageImportPost**](docs/MessagesApi.md#v1MessageImportPost) | **POST** /v1/message/import | Import messages from other systems into Symphony.
*MessagesApi* | [**v1StreamSidMessageCreatePost**](docs/MessagesApi.md#v1StreamSidMessageCreatePost) | **POST** /v1/stream/{sid}/message/create | Post a message to one existing stream.
*MessagesApi* | [**v1StreamSidMessageGet**](docs/MessagesApi.md#v1StreamSidMessageGet) | **GET** /v1/stream/{sid}/message | Get messages from an existing stream.
*MessagesApi* | [**v2MessageImportPost**](docs/MessagesApi.md#v2MessageImportPost) | **POST** /v2/message/import | Import messages from other systems into Symphony.
*MessagesApi* | [**v2StreamSidMessageCreatePost**](docs/MessagesApi.md#v2StreamSidMessageCreatePost) | **POST** /v2/stream/{sid}/message/create | Post a message to one existing stream.
*MessagesApi* | [**v2StreamSidMessageGet**](docs/MessagesApi.md#v2StreamSidMessageGet) | **GET** /v2/stream/{sid}/message | Get messages from an existing stream.
*ShareApi* | [**v1StreamSidSharePost**](docs/ShareApi.md#v1StreamSidSharePost) | **POST** /v1/stream/{sid}/share | Share a piece of content into Symphony
*SystemApi* | [**v1HealthCheckGet**](docs/SystemApi.md#v1HealthCheckGet) | **GET** /v1/HealthCheck | Checks the health of the Agent.
*UtilApi* | [**v1UtilEchoPost**](docs/UtilApi.md#v1UtilEchoPost) | **POST** /v1/util/echo | Test endpoint, returns input.
*UtilApi* | [**v1UtilObsoletePost**](docs/UtilApi.md#v1UtilObsoletePost) | **POST** /v1/util/obsolete | Example of a deprecated endpoint, returns input.


## Documentation for Models

 - [AttachmentInfo](docs/AttachmentInfo.md)
 - [BaseMessage](docs/BaseMessage.md)
 - [Datafeed](docs/Datafeed.md)
 - [Error](docs/Error.md)
 - [ImportResponse](docs/ImportResponse.md)
 - [ImportResponseList](docs/ImportResponseList.md)
 - [ImportedMessage](docs/ImportedMessage.md)
 - [Message](docs/Message.md)
 - [MessageImportList](docs/MessageImportList.md)
 - [MessageList](docs/MessageList.md)
 - [MessageSubmission](docs/MessageSubmission.md)
 - [RoomCreatedMessage](docs/RoomCreatedMessage.md)
 - [RoomDeactivatedMessage](docs/RoomDeactivatedMessage.md)
 - [RoomMemberDemotedFromOwnerMessage](docs/RoomMemberDemotedFromOwnerMessage.md)
 - [RoomMemberPromotedToOwnerMessage](docs/RoomMemberPromotedToOwnerMessage.md)
 - [RoomReactivatedMessage](docs/RoomReactivatedMessage.md)
 - [RoomTag](docs/RoomTag.md)
 - [RoomUpdatedMessage](docs/RoomUpdatedMessage.md)
 - [ShareArticle](docs/ShareArticle.md)
 - [ShareContent](docs/ShareContent.md)
 - [SimpleMessage](docs/SimpleMessage.md)
 - [UserJoinedRoomMessage](docs/UserJoinedRoomMessage.md)
 - [UserLeftRoomMessage](docs/UserLeftRoomMessage.md)
 - [V1HealthCheckResponse](docs/V1HealthCheckResponse.md)
 - [V2BaseMessage](docs/V2BaseMessage.md)
 - [V2ImportResponse](docs/V2ImportResponse.md)
 - [V2ImportResponseList](docs/V2ImportResponseList.md)
 - [V2ImportedMessage](docs/V2ImportedMessage.md)
 - [V2Message](docs/V2Message.md)
 - [V2MessageImportList](docs/V2MessageImportList.md)
 - [V2MessageList](docs/V2MessageList.md)
 - [V2MessageSubmission](docs/V2MessageSubmission.md)


## Documentation for Authorization

All endpoints do not require authorization.
Authentication schemes defined for the API:

## Recommendation

It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issue.

## Author







© 2015 - 2024 Weber Informatics LLC | Privacy Policy