-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Smooch Bot
committed
Sep 30, 2020
1 parent
2fef53f
commit 2b158ab
Showing
732 changed files
with
69,571 additions
and
38,266 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,26 @@ | ||
lazy val root = (project in file(".")). | ||
settings( | ||
organization := "io.smooch", | ||
name := "api", | ||
version := "5.29.0", | ||
organization := "com.zendesk", | ||
name := "sunshine-conversations-client", | ||
version := "9.0.0", | ||
scalaVersion := "2.11.4", | ||
scalacOptions ++= Seq("-feature"), | ||
javacOptions in compile ++= Seq("-Xlint:deprecation"), | ||
publishArtifact in (Compile, packageDoc) := false, | ||
resolvers += Resolver.mavenLocal, | ||
libraryDependencies ++= Seq( | ||
"io.swagger" % "swagger-annotations" % "1.5.8", | ||
"com.squareup.okhttp" % "okhttp" % "2.7.5", | ||
"com.squareup.okhttp" % "logging-interceptor" % "2.7.5", | ||
"com.google.code.gson" % "gson" % "2.6.2", | ||
"joda-time" % "joda-time" % "2.9.3" % "compile", | ||
"junit" % "junit" % "4.12" % "test", | ||
"io.swagger" % "swagger-annotations" % "1.5.22" % "compile", | ||
"org.jboss.resteasy" % "resteasy-client" % "3.1.3.Final" % "compile", | ||
"org.jboss.resteasy" % "resteasy-multipart-provider" % "3.1.3.Final" % "compile", | ||
"org.jboss.resteasy" % "resteasy-jackson2-provider" % "3.1.3.Final" % "compile", | ||
"com.fasterxml.jackson.core" % "jackson-core" % "2.10.3" % "compile", | ||
"com.fasterxml.jackson.core" % "jackson-annotations" % "2.10.3" % "compile", | ||
"com.fasterxml.jackson.core" % "jackson-databind" % "2.10.3" % "compile", | ||
"com.github.joschi.jackson" % "jackson-datatype-threetenbp" % "2.9.10" % "compile", | ||
"com.fasterxml.jackson.datatype" % "jackson-datatype-joda" % "2.9.10" % "compile", | ||
"joda-time" % "joda-time" % "2.9.9" % "compile", | ||
"com.brsanthu" % "migbase64" % "2.2" % "compile", | ||
"junit" % "junit" % "4.13" % "test", | ||
"com.novocode" % "junit-interface" % "0.10" % "test" | ||
) | ||
) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
|
||
|
||
# AcceptControlBody | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**metadata** | **Object** | Flat object containing custom properties. Strings, numbers and booleans are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size. The metadata object will be included in the `switchboard:acceptControl` and `switchboard:acceptControl:failure` webhooks. | [optional] | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,14 @@ | ||
|
||
# Action | ||
|
||
## Properties | ||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**type** | **String** | The action type. See [**ActionTypeEnum**](Enums.md#ActionTypeEnum) for available values. | | ||
**text** | **String** | The button text. | | ||
**payload** | **String** | The payload to be sent with the resulting webhook. Required for *postback* and *reply* actions. | [optional] | ||
**metadata** | **Object** | Flat JSON object containing any custom properties associated with the action. | [optional] | ||
**amount** | **Integer** | The amount being charged. It needs to be specified in cents and is an integer. Required for *buy* actions. | [optional] | ||
**currency** | **String** | The currency of the amount being charged (USD, CAD, etc.). | [optional] | ||
**_default** | **Boolean** | Flag indicating if the message action is the default for a message item in Facebook Messenger. | [optional] | ||
**iconUrl** | **String** | An icon to render next to the reply option (Facebook Messenger and Web Messenger only). | [optional] | ||
**uri** | **String** | The action URI. This is the link that will be used in the clients when clicking the button. Required for *link* and *webview* actions. | [optional] | ||
**fallback** | **String** | The webview action fallback uri. This is the link that will be used in clients that do not support webviews. Required for *webview* actions. | [optional] | ||
**size** | **String** | The size used to display the webview. Allowed values are [\"compact\", \"tall\", \"full\"]. (Optional) Used for *webview* actions. See [**ActionSizeEnum**](Enums.md#ActionSizeEnum) for available values. | [optional] | ||
**extraChannelOptions** | **Object** | Extra options to pass directly to the channel API. See [Extra Channel Options](https://docs.smooch.io/rest#extra-channel-options-schema) | [optional] | ||
**openOnReceive** | **Boolean** | Flag indicating if the webview should open automatically. Only one action per message can be set to true. Currently only supported on the Web Messenger. | [optional] | ||
# Interface Action | ||
|
||
## Implementing Classes | ||
|
||
* Buy | ||
* Link | ||
* LocationRequest | ||
* Postback | ||
* Reply | ||
* Webview | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
|
||
|
||
# Interface ActionSubset | ||
|
||
## Implementing Classes | ||
|
||
* Buy | ||
* Link | ||
* Postback | ||
* Webview | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
# ActivitiesApi | ||
|
||
All URIs are relative to *https://api.smooch.io* | ||
|
||
Method | HTTP request | Description | ||
------------- | ------------- | ------------- | ||
[**postActivity**](ActivitiesApi.md#postActivity) | **POST** /v2/apps/{appId}/conversations/{conversationId}/activity | Post Activity | ||
|
||
|
||
|
||
## postActivity | ||
|
||
> Object postActivity(activityPost, appId, conversationId) | ||
Post Activity | ||
|
||
Notify Sunshine Conversations of different conversation activities. Supported activity types are: * Typing activity * Conversation read event | ||
|
||
### Example | ||
|
||
```java | ||
import com.zendesk.sunshine_conversations_client.ApiClient; | ||
import com.zendesk.sunshine_conversations_client.ApiException; | ||
import com.zendesk.sunshine_conversations_client.Configuration; | ||
import com.zendesk.sunshine_conversations_client.auth.*; | ||
import com.zendesk.sunshine_conversations_client.model.*; | ||
import com.zendesk.sunshine_conversations_client.api.ActivitiesApi; | ||
|
||
public class Example { | ||
public static void main(String[] args) { | ||
ApiClient defaultClient = Configuration.getDefaultApiClient(); | ||
defaultClient.setBasePath("https://api.smooch.io"); | ||
|
||
// Configure HTTP basic authorization: basicAuth | ||
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth"); | ||
basicAuth.setUsername("API_KEY_ID"); | ||
basicAuth.setPassword("API_KEY_SECRET"); | ||
|
||
// Uncomment this section to use JWTs instead | ||
// HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth"); | ||
// bearerAuth.setBearerToken("YOUR TOKEN OR JWT"); | ||
|
||
ActivitiesApi apiInstance = new ActivitiesApi(defaultClient); | ||
ActivityPost activityPost = {"author":{"type":"user","userId":"5963c0d619a30a2e00de36b8"},"type":"conversation:read"}; // ActivityPost | | ||
String appId = "5d8cff3cd55b040010928b5b"; // String | Identifies the app. | ||
String conversationId = "029c31f25a21b47effd7be90"; // String | Identifies the conversation. | ||
// Add required body parameters | ||
|
||
try { | ||
Object result = apiInstance.postActivity(activityPost, appId, conversationId); | ||
System.out.println(result); | ||
} catch (ApiException e) { | ||
System.err.println("Exception when calling ActivitiesApi#postActivity"); | ||
System.err.println("Status code: " + e.getCode()); | ||
System.err.println("Reason: " + e.getResponseBody()); | ||
System.err.println("Response headers: " + e.getResponseHeaders()); | ||
e.printStackTrace(); | ||
} | ||
} | ||
} | ||
``` | ||
|
||
### Parameters | ||
|
||
|
||
Name | Type | Description | Notes | ||
------------- | ------------- | ------------- | ------------- | ||
**activityPost** | [**ActivityPost**](ActivityPost.md)| | | ||
**appId** | **String**| Identifies the app. | | ||
**conversationId** | **String**| Identifies the conversation. | | ||
|
||
### Return type | ||
|
||
**Object** | ||
|
||
### Authorization | ||
|
||
[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth) | ||
|
||
### HTTP request headers | ||
|
||
- **Content-Type**: application/json | ||
- **Accept**: application/json | ||
|
||
### HTTP response details | ||
| Status code | Description | Response headers | | ||
|-------------|-------------|------------------| | ||
| **200** | Ok | - | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
|
||
|
||
# Activity | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**type** | [**TypeEnum**](#TypeEnum) | If the author type is `user`, only `conversation:read` is supported. | [optional] | ||
**source** | [**SourceWebhook**](SourceWebhook.md) | The source of the activity. | [optional] | ||
**author** | [**AuthorWebhook**](AuthorWebhook.md) | | [optional] | ||
|
||
|
||
|
||
## Enum: TypeEnum | ||
|
||
Name | Value | ||
---- | ----- | ||
CONVERSATION_READ | "conversation:read" | ||
TYPING_START | "typing:start" | ||
TYPING_STOP | "typing:stop" | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
|
||
|
||
# ActivityAllOf | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**source** | [**SourceWebhook**](SourceWebhook.md) | The source of the activity. | [optional] | ||
**author** | [**AuthorWebhook**](AuthorWebhook.md) | | [optional] | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
|
||
|
||
# ActivityPost | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**author** | [**Author**](Author.md) | The author of the activity. | | ||
**type** | [**TypeEnum**](#TypeEnum) | If the author type is `user`, only `conversation:read` is supported. | | ||
|
||
|
||
|
||
## Enum: TypeEnum | ||
|
||
Name | Value | ||
---- | ----- | ||
CONVERSATION_READ | "conversation:read" | ||
TYPING_START | "typing:start" | ||
TYPING_STOP | "typing:stop" | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
|
||
|
||
# ActivityPostAllOf | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**author** | [**Author**](Author.md) | The author of the activity. | [optional] | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
|
||
|
||
# ActivityTypes | ||
|
||
## Properties | ||
|
||
Name | Type | Description | Notes | ||
------------ | ------------- | ------------- | ------------- | ||
**type** | [**TypeEnum**](#TypeEnum) | If the author type is `user`, only `conversation:read` is supported. | [optional] | ||
|
||
|
||
|
||
## Enum: TypeEnum | ||
|
||
Name | Value | ||
---- | ----- | ||
CONVERSATION_READ | "conversation:read" | ||
TYPING_START | "typing:start" | ||
TYPING_STOP | "typing:stop" | ||
|
||
|
||
|
Oops, something went wrong.