sunshine-conversations-client 9.1.1

data/docs/MessengerUpdateAllOf.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::MessengerUpdateAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page_access_token** | **String** | A Facebook Page Access Token. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::MessengerUpdateAllOf.new(page_access_token: your_access_token)
+```
+
+

data/docs/Meta.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::Meta
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**has_more** | **Boolean** | A flag that indicates if there are more records that can be fetched. | [optional] 
+**after_cursor** | **String** | A record id that can be used as a `page[after]` parameter in a new request to get the next page.  Not specified if there are no subsequent pages.  | [optional] 
+**before_cursor** | **String** | A record id that can be used as a `page[before]` parameter in a new request to get the previous page.  Not specified if there are no previous pages.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Meta.new(has_more: null,
+                                 after_cursor: 55c8d9758590aa1900b9b9f6,
+                                 before_cursor: 55c8d9758590aa1900b9b9f6)
+```
+
+

data/docs/OAuthEndpointsApi.md

@@ -0,0 +1,168 @@
+# SunshineConversationsClient::OAuthEndpointsApi
+
+All URIs are relative to *https://api.smooch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**authorize**](OAuthEndpointsApi.md#authorize) | **GET** /oauth/authorize | Authorize
+[**get_token**](OAuthEndpointsApi.md#get_token) | **POST** /oauth/token | Get Token
+[**revoke_access**](OAuthEndpointsApi.md#revoke_access) | **DELETE** /oauth/authorization | Revoke Access
+
+
+
+## authorize
+
+> authorize(client_id, response_type, opts)
+
+Authorize
+
+This endpoint begins the OAuth flow. It relies on a browser session for authentication. If the user is not logged in to Sunshine Conversations they will be redirected to the login page. If the user has many apps, they will first be prompted to select the one they wish to integrate with. They will then be presented with an Allow/Deny dialog, describing details of the access your integration is requesting.
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+
+api_instance = SunshineConversationsClient::OAuthEndpointsApi.new
+client_id = '5e4af71a81966cfff3ef6550' # String | Your integration’s unique identifier
+response_type = 'code' # String | For now the only acceptable value is code.
+# Be sure to add the required body parameters
+opts = {
+  state: 'Pending', # String | You may pass in any arbitrary string value here which will be returned to you along with the code via browser redirect.
+  redirect_uri: 'https://example.org' # String | You may pass in a redirect_uri to determine which URI the response is redirected to. This URI must be contained in the list configured by your integration. If this option is not passed, the first URI present in the list will be used.
+}
+
+begin
+  #Authorize
+  api_instance.authorize(client_id, response_type, opts)
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling OAuthEndpointsApi->authorize: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **client_id** | **String**| Your integration’s unique identifier | 
+ **response_type** | **String**| For now the only acceptable value is code. | 
+ **state** | **String**| You may pass in any arbitrary string value here which will be returned to you along with the code via browser redirect. | [optional] 
+ **redirect_uri** | **String**| You may pass in a redirect_uri to determine which URI the response is redirected to. This URI must be contained in the list configured by your integration. If this option is not passed, the first URI present in the list will be used. | [optional] 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## get_token
+
+> Object get_token(inline_object)
+
+Get Token
+
+This endpoint is used to exchange an authorization code for an access token. It should only be used in server-to-server calls.
+
+### Example
+
+```ruby
+# load the gem
+require 'sunshine-conversations-client'
+
+api_instance = SunshineConversationsClient::OAuthEndpointsApi.new
+inline_object = SunshineConversationsClient::InlineObject.new # InlineObject | 
+# Be sure to add the required body parameters
+
+begin
+  #Get Token
+  result = api_instance.get_token(inline_object)
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling OAuthEndpointsApi->get_token: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **inline_object** | [**InlineObject**](InlineObject.md)|  | 
+
+### Return type
+
+**Object**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## revoke_access
+
+> Object revoke_access
+
+Revoke Access
+
+This endpoint is used to revoke your integration’s access to the user’s Sunshine Conversations app. Revoking access means your integration will no longer be able to interact with the app, and any webhooks the integration had previously configured will be removed.  Calling this endpoint is equivalent to the user removing your integration manually in the Sunshine Conversations web app. Your integration’s `removeUrl` (if configured) will also be called when an integration is removed in this way. 
+
+### 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::OAuthEndpointsApi.new
+# Be sure to add the required body parameters
+
+begin
+  #Revoke Access
+  result = api_instance.revoke_access
+  p result
+rescue SunshineConversationsClient::ApiError => e
+  puts "Exception when calling OAuthEndpointsApi->revoke_access: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/OfferControlBody.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::OfferControlBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**switchboard_integration** | **String** | The id or the name of the switchboard integration that will become pending. Also supports the `next` keyword to offer control to the next switchboard integration designated in the switchboard hierarchy configuration. This cannot match the active switchboard integration. | 
+**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:offerControl` and `switchboard:offerControl:failure` webhooks. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::OfferControlBody.new(switchboard_integration: next,
+                                 metadata: null)
+```
+
+

data/docs/Page.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::Page
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**after** | **String** | A record id. Results will only contain the records that come after the specified record.  Only one of `after` or `before` can be provided, not both.  | [optional] 
+**before** | **String** | A record id. Results will only contain the records that come before the specified record. Only one of `after` or `before` can be provided, not both.  | [optional] 
+**size** | **Integer** | The number of records to return. | [optional] [default to 25]
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Page.new(after: 5e1606762556d93e9c176f69,
+                                 before: 5e1606762556d93e9c176f69,
+                                 size: 10)
+```
+
+

data/docs/Participant.md

@@ -0,0 +1,27 @@
+# SunshineConversationsClient::Participant
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The unique ID of the participant. | [optional] 
+**user_id** | **String** | The id of the associated user. | [optional] 
+**unread_count** | **Integer** | Number of messages the user has not yet read. | [optional] 
+**client_associations** | [**Array<ClientAssociation>**](ClientAssociation.md) | Represents the clients that are active in the conversation for a particular user. A participant can have multiple clientAssociations in the case of channel transfer, business initiated conversations, or identified users. The order of the array indicates how recently a client has interacted with the conversation, with the most recent client first. The first item in the array is considered to be the user's primary client for that conversation, and will be selected first for message delivery.  | [optional] 
+**user_external_id** | **String** | The externalId of the associated user. | [optional] 
+**last_read** | **String** | A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the latest message the user has read. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::Participant.new(id: c93bb9c14dde8ffb94564eae,
+                                 user_id: 42589ad070d43be9b00ff7e5,
+                                 unread_count: 0,
+                                 client_associations: null,
+                                 user_external_id: your-own-id,
+                                 last_read: 2019-01-14T18:55:12.515Z)
+```
+
+

data/docs/ParticipantJoinBody.md

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

data/docs/ParticipantLeaveBody.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::ParticipantLeaveBody
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **String** | The id of the user that will be removed from the conversation. It will return 404 if the user can’t be found.  | [optional] 
+**user_external_id** | **String** | The externalId of the user that will be removed from the conversation. It will return 404 if the user can’t be found.  | [optional] 
+**participant_id** | **String** | The participantId of the user that will be removed from the conversation. It will return 404 if the user can’t be found.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ParticipantLeaveBody.new(user_id: 42589ad070d43be9b00ff7e5,
+                                 user_external_id: your-own-user-id,
+                                 participant_id: 42589ad070d43be9b00ff7e5)
+```
+
+

data/docs/ParticipantLeaveBodyParticipantId.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::ParticipantLeaveBodyParticipantId
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**participant_id** | **String** | The participantId of the user that will be removed from the conversation. It will return 404 if the user can’t be found.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ParticipantLeaveBodyParticipantId.new(participant_id: 42589ad070d43be9b00ff7e5)
+```
+
+

data/docs/ParticipantLeaveBodyUserExternalId.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::ParticipantLeaveBodyUserExternalId
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_external_id** | **String** | The externalId of the user that will be removed from the conversation. It will return 404 if the user can’t be found.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ParticipantLeaveBodyUserExternalId.new(user_external_id: your-own-user-id)
+```
+
+

data/docs/ParticipantLeaveBodyUserId.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::ParticipantLeaveBodyUserId
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **String** | The id of the user that will be removed from the conversation. It will return 404 if the user can’t be found.  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ParticipantLeaveBodyUserId.new(user_id: 42589ad070d43be9b00ff7e5)
+```
+
+

data/docs/ParticipantListResponse.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::ParticipantListResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**participants** | [**Array<Participant>**](Participant.md) |  | [optional] 
+**meta** | [**Meta**](Meta.md) |  | [optional] 
+**links** | [**Links**](Links.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ParticipantListResponse.new(participants: null,
+                                 meta: null,
+                                 links: null)
+```
+
+

data/docs/ParticipantResponse.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::ParticipantResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**participant** | [**Participant**](Participant.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ParticipantResponse.new(participant: null)
+```
+
+

data/docs/ParticipantSubSchema.md

@@ -0,0 +1,21 @@
+# SunshineConversationsClient::ParticipantSubSchema
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **String** | The id of the user that will be participating in the conversation. It will return `404` if the user can’t be found. One of `userId` or `userExternalId` is required, but not both. | [optional] 
+**subscribe_sdk_client** | **Boolean** | When passed as true, the SDK client of the concerned participant will be subscribed to the conversation. The user will start receiving push notifications for this conversation right away, without having to view the conversation on the SDK beforehand. An SDK client will be created for users that don’t already have one. This field is required if the conversation is of type `sdkGroup`. | [optional] 
+**user_external_id** | **String** | The `externalId` of the user that will be participating in the conversation. It will return `404` if the user can’t be found. One of `userId` or `userExternalId` is required, but not both. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ParticipantSubSchema.new(user_id: 42589ad070d43be9b00ff7e5,
+                                 subscribe_sdk_client: false,
+                                 user_external_id: your-own-user-id)
+```
+
+

data/docs/ParticipantWithUserExternalId.md

@@ -0,0 +1,19 @@
+# SunshineConversationsClient::ParticipantWithUserExternalId
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_external_id** | **String** | The `externalId` of the user that will be participating in the conversation. It will return `404` if the user can’t be found. One of `userId` or `userExternalId` is required, but not both. | [optional] 
+**subscribe_sdk_client** | **Boolean** | When passed as true, the SDK client of the concerned participant will be subscribed to the conversation. The user will start receiving push notifications for this conversation right away, without having to view the conversation on the SDK beforehand. An SDK client will be created for users that don’t already have one. This field is required if the conversation is of type `sdkGroup`. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::ParticipantWithUserExternalId.new(user_external_id: your-own-user-id,
+                                 subscribe_sdk_client: false)
+```
+
+