Skip to content

Commit

Permalink
Generate version 5.27.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Smooch Bot committed Apr 13, 2020
1 parent 9773527 commit 4c65fbc
Show file tree
Hide file tree
Showing 118 changed files with 493 additions and 119 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ gem install smooch-api

Add this to the Gemfile:

gem 'smooch-api', '~> 5.26.0'
gem 'smooch-api', '~> 5.27.0'

## Getting Started

Expand Down Expand Up @@ -110,6 +110,7 @@ Class | Method | HTTP request | Description
*SmoochApi::AppApi* | [**delete_secret_key**](docs/AppApi.md#delete_secret_key) | **DELETE** /v1.1/apps/{appId}/keys/{keyId} |
*SmoochApi::AppApi* | [**get_app**](docs/AppApi.md#get_app) | **GET** /v1.1/apps/{appId} |
*SmoochApi::AppApi* | [**get_app_jwt**](docs/AppApi.md#get_app_jwt) | **GET** /v1.1/apps/{appId}/keys/{keyId}/jwt |
*SmoochApi::AppApi* | [**get_sdk_ids**](docs/AppApi.md#get_sdk_ids) | **GET** /v1.1/apps/{appId}/sdks |
*SmoochApi::AppApi* | [**get_secret_key**](docs/AppApi.md#get_secret_key) | **GET** /v1.1/apps/{appId}/keys/{keyId} |
*SmoochApi::AppApi* | [**list_apps**](docs/AppApi.md#list_apps) | **GET** /v1.1/apps |
*SmoochApi::AppApi* | [**list_secret_keys**](docs/AppApi.md#list_secret_keys) | **GET** /v1.1/apps/{appId}/keys |
Expand Down Expand Up @@ -220,6 +221,7 @@ Class | Method | HTTP request | Description
- [SmoochApi::FieldPost](docs/FieldPost.md)
- [SmoochApi::GetIntegrationProfileResponse](docs/GetIntegrationProfileResponse.md)
- [SmoochApi::GetMessagesResponse](docs/GetMessagesResponse.md)
- [SmoochApi::GetSdkIdsResponse](docs/GetSdkIdsResponse.md)
- [SmoochApi::Integration](docs/Integration.md)
- [SmoochApi::IntegrationCreate](docs/IntegrationCreate.md)
- [SmoochApi::IntegrationProfileUpdate](docs/IntegrationProfileUpdate.md)
Expand Down
60 changes: 60 additions & 0 deletions docs/AppApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Method | HTTP request | Description
[**delete_secret_key**](AppApi.md#delete_secret_key) | **DELETE** /v1.1/apps/{appId}/keys/{keyId} |
[**get_app**](AppApi.md#get_app) | **GET** /v1.1/apps/{appId} |
[**get_app_jwt**](AppApi.md#get_app_jwt) | **GET** /v1.1/apps/{appId}/keys/{keyId}/jwt |
[**get_sdk_ids**](AppApi.md#get_sdk_ids) | **GET** /v1.1/apps/{appId}/sdks |
[**get_secret_key**](AppApi.md#get_secret_key) | **GET** /v1.1/apps/{appId}/keys/{keyId} |
[**list_apps**](AppApi.md#list_apps) | **GET** /v1.1/apps |
[**list_secret_keys**](AppApi.md#list_secret_keys) | **GET** /v1.1/apps/{appId}/keys |
Expand Down Expand Up @@ -377,6 +378,65 @@ Name | Type | Description | Notes



# **get_sdk_ids**
> GetSdkIdsResponse get_sdk_ids(appId)


Retrieve the IDs of the three SDK integrations (`android`, `ios`, and `web`) for the specified app, to be used when initializing the SDKs.

### Example
```ruby
# load the gem
require 'smooch-api'
# setup authorization
SmoochApi.configure do |config|
# Configure HTTP basic authorization (recommended): basicAuth
config.username = 'API_KEY_ID'
config.password = 'API_KEY_SECRET'


# OR

# Configure API key authorization (alternative): jwt
config.api_key['Authorization'] = 'YOUR JWT'
config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = SmoochApi::AppApi.new

appId = "appId_example" # String | Identifies the app.


begin
result = api_instance.get_sdk_ids(appId)
p result
rescue SmoochApi::ApiError => e
puts "Exception when calling AppApi->get_sdk_ids: #{e}"
end
```

### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**appId** | **String**| Identifies the app. |

### Return type

[**GetSdkIdsResponse**](GetSdkIdsResponse.md)

### Authorization

[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json



# **get_secret_key**
> SecretKeyResponse get_secret_key(appId, keyId)
Expand Down
10 changes: 10 additions & 0 deletions docs/GetSdkIdsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# SmoochApi::GetSdkIdsResponse

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**androidIntegrationId** | **String** | The ID of the `android` integration, used when initializing the Android SDK. |
**iosIntegrationId** | **String** | The ID of the `ios` integration, used when initializing the iOS SDK. |
**webIntegrationId** | **String** | The ID of the `web` integration, used when initializing the Web Messenger SDK. |


1 change: 1 addition & 0 deletions docs/Integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ Name | Type | Description | Notes
**incomingAddress** | **String** | Smooch will receive all emails sent to this address. Required for *mailgun* integrations. | [optional]
**accessKey** | **String** | The public API key of your MessageBird account. Required for *messagebird* integrations. | [optional]
**originator** | **String** | Smooch will receive all messages sent to this phone number. Required for *messagebird* integrations. | [optional]
**signingKey** | **String** | The signing key of your MessageBird account. Used to validate the webhooks' origin. (Optional) Used for *messagebird* integrations. | [optional]
**brandColor** | **String** | This color will be used in the messenger header and the button or tab in idle state. (Optional) Used for *Web Messenger* integrations. | [optional]
**fixedIntroPane** | **BOOLEAN** | When `true`, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. The default value is `false`. (Optional) Used for *Web Messenger* integrations. | [optional]
**conversationColor** | **String** | This color will be used for customer messages, quick replies and actions in the footer. (Optional) Used for *Web Messenger* integrations. | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/IntegrationCreate.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,6 @@ Name | Type | Description | Notes
**originWhitelist** | **Array<String>** | A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454 `scheme \"://\" host [ \":\" port ]`, where scheme is `http` or `https`. (Optional) Used for *Web Messenger* integrations. | [optional]
**qrCodeUrl** | **String** | URL provided by LINE in the [Developer Console](https://developers.line.biz/console/). | [optional]
**hideUnsubscribeLink** | **BOOLEAN** | When `true`, unsubscribe links will not be included in outbound emails. If this setting is enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. (Optional) Used for *mailgun* integrations. | [optional]
**signingKey** | **String** | The signing key of your MessageBird account. Used to validate the webhooks' origin. (Optional) Used for *messagebird* integrations. | [optional]


3 changes: 2 additions & 1 deletion lib/smooch-api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down Expand Up @@ -56,6 +56,7 @@
require 'smooch-api/models/field_post'
require 'smooch-api/models/get_integration_profile_response'
require 'smooch-api/models/get_messages_response'
require 'smooch-api/models/get_sdk_ids_response'
require 'smooch-api/models/integration'
require 'smooch-api/models/integration_create'
require 'smooch-api/models/integration_profile_update'
Expand Down
57 changes: 56 additions & 1 deletion lib/smooch-api/api/app_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down Expand Up @@ -366,6 +366,61 @@ def get_app_jwt_with_http_info(appId, keyId, opts = {})
return data, status_code, headers
end

#
# Retrieve the IDs of the three SDK integrations (`android`, `ios`, and `web`) for the specified app, to be used when initializing the SDKs.
# @param appId Identifies the app.
# @param [Hash] opts the optional parameters
# @return [GetSdkIdsResponse]
def get_sdk_ids(appId, opts = {})
data, _status_code, _headers = get_sdk_ids_with_http_info(appId, opts)
return data
end

#
# Retrieve the IDs of the three SDK integrations (`android`, `ios`, and `web`) for the specified app, to be used when initializing the SDKs.
# @param appId Identifies the app.
# @param [Hash] opts the optional parameters
# @return [Array<(GetSdkIdsResponse, Fixnum, Hash)>] GetSdkIdsResponse data, response status code and response headers
def get_sdk_ids_with_http_info(appId, opts = {})
if @api_client.config.debugging
@api_client.config.logger.debug "Calling API: AppApi.get_sdk_ids ..."
end
# verify the required parameter 'appId' is set
if @api_client.config.client_side_validation && appId.nil?
fail ArgumentError, "Missing the required parameter 'appId' when calling AppApi.get_sdk_ids"
end
# resource path
local_var_path = "/v1.1/apps/{appId}/sdks".sub('{' + 'appId' + '}', appId.to_s)

# query parameters
query_params = {}

# header parameters
header_params = {}
# HTTP header 'Accept' (if needed)
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
# HTTP header 'Content-Type'
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

# form parameters
form_params = {}

# http body (model)
post_body = nil
auth_names = ['basicAuth', 'jwt']
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
:header_params => header_params,
:query_params => query_params,
:form_params => form_params,
:body => post_body,
:auth_names => auth_names,
:return_type => 'GetSdkIdsResponse')
if @api_client.config.debugging
@api_client.config.logger.debug "API called: AppApi#get_sdk_ids\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
end
return data, status_code, headers
end

#
# Get the specified secret key.
# @param appId Identifies the app.
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/api/app_user_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/api/attachments_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/api/conversation_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/api/deployment_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/api/integration_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/api/menu_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/api/notification_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/api/service_account_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/api/template_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/api/webhook_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/api_client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/api_error.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/configuration.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/models/action.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/models/activity_response.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/models/app.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/models/app_create.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down
2 changes: 1 addition & 1 deletion lib/smooch-api/models/app_response.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#The Smooch API is a unified interface for powering messaging in your customer experiences across every channel. Our API speeds access to new markets, reduces time to ship, eliminates complexity, and helps you build the best experiences for your customers. For more information, visit our [official documentation](https://docs.smooch.io).
OpenAPI spec version: 5.25
OpenAPI spec version: 5.27
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: 2.2.3-SNAPSHOT
Expand Down

0 comments on commit 4c65fbc

Please sign in to comment.