sunshine-conversations-client 9.1.1

data/docs/Apple.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::Apple
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'apple']
+**business_id** | **String** | Apple Business Chat ID. | 
+**api_secret** | **String** | Your Apple API secret which is tied to your Messaging Service Provider. | 
+**msp_id** | **String** | Your Messaging Service Provider ID. | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Apple.new(type: null,
+                                 business_id: 2740f141-89c1-515f-07eb-1128dd73491,
+                                 api_secret: QLA//Z13paUYo/2tLReQa-43c5JEAASujGamiY/QTvs=,
+                                 msp_id: e7e495d5-bf78-531d-baf6-7f419f7fb592)
+```
+
+

data/docs/AppleAllOf.md

@@ -0,0 +1,23 @@
+# SunshineConversationsClient::AppleAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | The type of integration. | [optional] [default to 'apple']
+**business_id** | **String** | Apple Business Chat ID. | 
+**api_secret** | **String** | Your Apple API secret which is tied to your Messaging Service Provider. | 
+**msp_id** | **String** | Your Messaging Service Provider ID. | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AppleAllOf.new(type: null,
+                                 business_id: 2740f141-89c1-515f-07eb-1128dd73491,
+                                 api_secret: QLA//Z13paUYo/2tLReQa-43c5JEAASujGamiY/QTvs=,
+                                 msp_id: e7e495d5-bf78-531d-baf6-7f419f7fb592)
+```
+
+

data/docs/AppleUpdate.md

@@ -0,0 +1,16 @@
+# SunshineConversationsClient::AppleUpdate
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AppleUpdate.new()
+```
+
+

data/docs/AppsApi.md

@@ -0,0 +1,309 @@
+# SunshineConversationsClient::AppsApi
+
+All URIs are relative to *https://api.smooch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_app**](AppsApi.md#create_app) | **POST** /v2/apps | Create App
+[**delete_app**](AppsApi.md#delete_app) | **DELETE** /v2/apps/{appId} | Delete App
+[**get_app**](AppsApi.md#get_app) | **GET** /v2/apps/{appId} | Get App
+[**list_apps**](AppsApi.md#list_apps) | **GET** /v2/apps | List Apps
+[**update_app**](AppsApi.md#update_app) | **PATCH** /v2/apps/{appId} | Update App
+
+
+
+## create_app
+
+> AppResponse create_app(app_create_body)
+
+Create App
+
+Creates a new app. When using [service account](#service-accounts) credentials, the service account is automatically granted access to the app.
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+# setup authorization
+SunshineConversationsClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  # Uncomment this line to use JWTs
+  # config.access_token = 'YOUR_JWT'
+end
+
+api_instance = SunshineConversationsClient::AppsApi.new
+app_create_body = SunshineConversationsClient::AppCreateBody.new # AppCreateBody | 
+# Be sure to add the required body parameters
+
+begin
+  #Create App
+  result = api_instance.create_app(app_create_body)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling AppsApi->create_app: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_create_body** | [**AppCreateBody**](AppCreateBody.md)|  | 
+
+### Return type
+
+[**AppResponse**](AppResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_app
+
+> Object delete_app(app_id)
+
+Delete App
+
+Removes the specified app, including all its enabled integrations.
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+# setup authorization
+SunshineConversationsClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  # Uncomment this line to use JWTs
+  # config.access_token = 'YOUR_JWT'
+end
+
+api_instance = SunshineConversationsClient::AppsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+# Be sure to add the required body parameters
+
+begin
+  #Delete App
+  result = api_instance.delete_app(app_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling AppsApi->delete_app: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_app
+
+> AppResponse get_app(app_id)
+
+Get App
+
+Fetches an individual app.
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+# setup authorization
+SunshineConversationsClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  # Uncomment this line to use JWTs
+  # config.access_token = 'YOUR_JWT'
+end
+
+api_instance = SunshineConversationsClient::AppsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+# Be sure to add the required body parameters
+
+begin
+  #Get App
+  result = api_instance.get_app(app_id)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling AppsApi->get_app: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+
+### Return type
+
+[**AppResponse**](AppResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_apps
+
+> AppListResponse list_apps(opts)
+
+List Apps
+
+Lists all apps that a user is part of. This API is paginated through [cursor pagination](#section/Introduction/API-pagination-and-records-limits).  ```shell /v2/apps?page[after]=5e1606762556d93e9c176f69&page[size]=10 ``` 
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+# setup authorization
+SunshineConversationsClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  # Uncomment this line to use JWTs
+  # config.access_token = 'YOUR_JWT'
+end
+
+api_instance = SunshineConversationsClient::AppsApi.new
+# Be sure to add the required body parameters
+opts = {
+  page: SunshineConversationsClient::Page.new, # Page | Contains parameters for applying cursor pagination.
+  filter: SunshineConversationsClient::AppListFilter.new # AppListFilter | Contains parameters for filtering the results.
+}
+
+begin
+  #List Apps
+  result = api_instance.list_apps(opts)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling AppsApi->list_apps: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | [**Page**](.md)| Contains parameters for applying cursor pagination. | [optional] 
+ **filter** | [**AppListFilter**](.md)| Contains parameters for filtering the results. | [optional] 
+
+### Return type
+
+[**AppListResponse**](AppListResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_app
+
+> AppResponse update_app(app_id, app_update_body)
+
+Update App
+
+Updates an app.
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+# setup authorization
+SunshineConversationsClient.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR_USERNAME'
+  config.password = 'YOUR_PASSWORD'
+
+  # Configure Bearer authorization (JWT): bearerAuth
+  # Uncomment this line to use JWTs
+  # config.access_token = 'YOUR_JWT'
+end
+
+api_instance = SunshineConversationsClient::AppsApi.new
+app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
+app_update_body = SunshineConversationsClient::AppUpdateBody.new # AppUpdateBody | 
+# Be sure to add the required body parameters
+
+begin
+  #Update App
+  result = api_instance.update_app(app_id, app_update_body)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling AppsApi->update_app: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **app_update_body** | [**AppUpdateBody**](AppUpdateBody.md)|  | 
+
+### Return type
+
+[**AppResponse**](AppResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AttachmentDeleteBody.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::AttachmentDeleteBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**media_url** | **String** | The media URL used for a file or image message. | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AttachmentDeleteBody.new(media_url: https://s3.amazonaws.com/document.pdf)
+```
+
+

data/docs/AttachmentMediaTokenBody.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::AttachmentMediaTokenBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**paths** | **Array<String>** | An array of strings representing the list of attachment paths used to generate the media JWT. One token will be generated for each path. Each token will be valid for 2 hours by default. This value can be modified, see [App Settings](#operation/createApp) for more information. | 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AttachmentMediaTokenBody.new(paths: null)
+```
+
+

data/docs/AttachmentMediaTokenResponse.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::AttachmentMediaTokenResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tokens** | **Hash<String, String>** | Object with key value pair where the key is the path and the value is the media JWT. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AttachmentMediaTokenResponse.new(tokens: {"/apps/5ec41c54fe13cc5ac404bedc":"eyJhbGciOiJSUzUxMiIsInR5cCI6IkpXVCIsImtpZCI6IjM3NzdBNUM3LUI3QUQtNDEyMC1BNEVDLUNBNzk1ODlDRTYxNSJ9.eyJwYXRoIjoiL2FwcHMvNWVkYTk3ZDBhNmQ5ZmUwMDBmN2U2ODQyIiwiZXhwIjoxNTkzMjA2MzEzLCJpYXQiOjE1OTMxOTkxMTN9.R1i7e5YgRHv_QjUqUcP9c5xa4VgJ5aen675V84r1euCjNz165qqkZaep6of7aXNBKsZ29AI1CgbVt_nPn3ZsYTBc1cQ96ucqTv8tFR0FHf20-oR-_1egdyyLqJjxb0UI1wGZPGCP8mEs3mQwMu4lvZMF9vaty1Ye8wy-lPAPYFuZMb1rCES0QT6QUOAn45hAAfdT1zKqQ8ImV5eWVi6m0ENqV-JjExsiZ2mAMwyguDJ5yJUQLGKOV3f_Our1fVWfit5cGoMk-97o3009o628gVfSZVzPuvdNIfQOb0UUr_ELsI2qbY_Ju4REpSqYwdkjvSd3T20baf5K7_FGOrxPQitHAZojQAdlRK3mB-kC3IbVa93YFBcLK5UbRXnJYAo24UH828vU-MLgRrgzD6oVpcxNk8yyaLThJpTynO9Eoi0vKJ0m-_3A1ASKzYrR6ZZZWmRsFtZVtlpS21oYuO2tvS4EkbM8AhH4nh6V8oQUkQtvYIZKkEOadc0AFTjbv-le35hHLmHBZigUTRoZKokeglSDKr0FwDZylp7V3O8l6X0EhOU0BCoP1UYrEf8GjPdSLvu0Mno_k6hFw2Hx9DTdvnybZYroMkG31To2nmVhPglZ4FCswGV85HcqCcWQjhugFmB--9aE19G-OGOVFJfH6rFp0_cB4AxM9kSHQsWyuUs"})
+```
+
+

data/docs/AttachmentResponse.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::AttachmentResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attachment** | [**AttachmentSchema**](AttachmentSchema.md) | The uploaded attachment object. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::AttachmentResponse.new(attachment: null)
+```
+
+