smooch-api 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9dde887ae3ee8bfe19a1d2e44fa384d4f3739d9a
-  data.tar.gz: 75d345df5a62e79d58c6086049b3a554a88e6816
+  metadata.gz: 311548049691ffcd9c9e450673eec6155ddae0e9
+  data.tar.gz: 5e5c1177fddef392b7e0090bcfdfd9b31a1e9fc5
 SHA512:
-  metadata.gz: 75d7fd08469ed6525d400722514f3bf952796cc7eee31a4d49d593f98176a0e15fd9f22e62846460cea8fcd6c3442fab0de57f715a06b164593d3fe023adca0e
-  data.tar.gz: 7a7f30212e263f1d9ca1751afd7c2942a289fc53b9cf882933fb50ea922b57ffa99813dc2f37d3d2825fcd685918139d28c9da12a71781447ae3a4f5d531d561
+  metadata.gz: 46e201504ac41865dfc8a2a576b700599cc58b125cf43d12f08b184c87f119da7ec035cf0679196e95c40c96468fc154c66936621c9b24f5acc07a72613fe911
+  data.tar.gz: 86385ea46ec639b3ec40d9c8bbe61d670ad5880e1855ca22acfdc838797dc5206e68d1ef007036cb4f927fa6699974ae759120fcecc5278a6201f2ed6aad7cef

data/README.md

@@ -16,7 +16,7 @@ gem install smooch-api
 
 Add this to the Gemfile:
 
-    gem 'smooch-api', '~> 2.8.0'
+    gem 'smooch-api', '~> 2.9.0'
 
 ## Getting Started
 
@@ -117,6 +117,16 @@ Class | Method | HTTP request | Description
 *SmoochApi::MenuApi* | [**delete_menu**](docs/MenuApi.md#delete_menu) | **DELETE** /apps/{appId}/menu | 
 *SmoochApi::MenuApi* | [**get_menu**](docs/MenuApi.md#get_menu) | **GET** /apps/{appId}/menu | 
 *SmoochApi::MenuApi* | [**update_menu**](docs/MenuApi.md#update_menu) | **PUT** /apps/{appId}/menu | 
+*SmoochApi::ServiceAccountApi* | [**create_secret_key**](docs/ServiceAccountApi.md#create_secret_key) | **POST** /serviceaccounts/{serviceAccountId}/keys | 
+*SmoochApi::ServiceAccountApi* | [**create_service_account**](docs/ServiceAccountApi.md#create_service_account) | **POST** /serviceaccounts | 
+*SmoochApi::ServiceAccountApi* | [**delete_secret_key**](docs/ServiceAccountApi.md#delete_secret_key) | **DELETE** /serviceaccounts/{serviceAccountId}/keys/{keyId} | 
+*SmoochApi::ServiceAccountApi* | [**delete_service_account**](docs/ServiceAccountApi.md#delete_service_account) | **DELETE** /serviceaccounts/{serviceAccountId} | 
+*SmoochApi::ServiceAccountApi* | [**get_jwt**](docs/ServiceAccountApi.md#get_jwt) | **GET** /serviceaccounts/{serviceAccountId}/keys/{keyId}/jwt | 
+*SmoochApi::ServiceAccountApi* | [**get_secret_key**](docs/ServiceAccountApi.md#get_secret_key) | **GET** /serviceaccounts/{serviceAccountId}/keys/{keyId} | 
+*SmoochApi::ServiceAccountApi* | [**get_service_account**](docs/ServiceAccountApi.md#get_service_account) | **GET** /serviceaccounts/{serviceAccountId} | 
+*SmoochApi::ServiceAccountApi* | [**list_secret_keys**](docs/ServiceAccountApi.md#list_secret_keys) | **GET** /serviceaccounts/{serviceAccountId}/keys | 
+*SmoochApi::ServiceAccountApi* | [**list_service_accounts**](docs/ServiceAccountApi.md#list_service_accounts) | **GET** /serviceaccounts | 
+*SmoochApi::ServiceAccountApi* | [**update_service_account**](docs/ServiceAccountApi.md#update_service_account) | **PUT** /serviceaccounts/{serviceAccountId} | 
 *SmoochApi::WebhookApi* | [**create_webhook**](docs/WebhookApi.md#create_webhook) | **POST** /apps/{appId}/webhooks | 
 *SmoochApi::WebhookApi* | [**delete_webhook**](docs/WebhookApi.md#delete_webhook) | **DELETE** /apps/{appId}/webhooks/{webhookId} | 
 *SmoochApi::WebhookApi* | [**get_webhook**](docs/WebhookApi.md#get_webhook) | **GET** /apps/{appId}/webhooks/{webhookId} | 
@@ -160,6 +170,7 @@ Class | Method | HTTP request | Description
  - [SmoochApi::ListAppsResponse](docs/ListAppsResponse.md)
  - [SmoochApi::ListIntegrationsResponse](docs/ListIntegrationsResponse.md)
  - [SmoochApi::ListSecretKeysResponse](docs/ListSecretKeysResponse.md)
+ - [SmoochApi::ListServiceAccountsResponse](docs/ListServiceAccountsResponse.md)
  - [SmoochApi::ListWebhooksResponse](docs/ListWebhooksResponse.md)
  - [SmoochApi::Menu](docs/Menu.md)
  - [SmoochApi::MenuItem](docs/MenuItem.md)
@@ -171,6 +182,10 @@ Class | Method | HTTP request | Description
  - [SmoochApi::SecretKey](docs/SecretKey.md)
  - [SmoochApi::SecretKeyCreate](docs/SecretKeyCreate.md)
  - [SmoochApi::SecretKeyResponse](docs/SecretKeyResponse.md)
+ - [SmoochApi::ServiceAccount](docs/ServiceAccount.md)
+ - [SmoochApi::ServiceAccountCreate](docs/ServiceAccountCreate.md)
+ - [SmoochApi::ServiceAccountResponse](docs/ServiceAccountResponse.md)
+ - [SmoochApi::ServiceAccountUpdate](docs/ServiceAccountUpdate.md)
  - [SmoochApi::Source](docs/Source.md)
  - [SmoochApi::TypingActivityTrigger](docs/TypingActivityTrigger.md)
  - [SmoochApi::Webhook](docs/Webhook.md)

data/docs/AppApi.md

@@ -411,8 +411,9 @@ end
 api_instance = SmoochApi::AppApi.new
 
 opts = { 
-  limit: 0, # Integer | The number of records to return.
-  offset: 0 # Integer | The number of initial records to skip before picking records to return.
+  limit: 25, # Integer | The number of records to return.
+  offset: 0, # Integer | The number of initial records to skip before picking records to return.
+  service_account_id: "" # String | The service account ID for which to list apps.
 }
 
 begin
@@ -427,8 +428,9 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **limit** | **Integer**| The number of records to return. | [optional] [default to 0]
+ **limit** | **Integer**| The number of records to return. | [optional] [default to 25]
  **offset** | **Integer**| The number of initial records to skip before picking records to return. | [optional] [default to 0]
+ **service_account_id** | **String**| The service account ID for which to list apps. | [optional] [default to ]
 
 ### Return type
 

data/docs/ListServiceAccountsResponse.md

@@ -0,0 +1,10 @@
+# SmoochApi::ListServiceAccountsResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**service_accounts** | [**Array<ServiceAccount>**](ServiceAccount.md) | The list of service accounts. | [optional] 
+**has_more** | **BOOLEAN** | Flag indicating if there are more service accounts that are not present in the response. | [optional] 
+**offset** | **Integer** | The number of service account records skipped in the returned list. | [optional] 
+
+

data/docs/ServiceAccount.md

@@ -0,0 +1,9 @@
+# SmoochApi::ServiceAccount
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_id** | **String** | The service account's ID. | 
+**name** | **String** | The service account's name. | 
+
+

data/docs/ServiceAccountApi.md

@@ -0,0 +1,554 @@
+# SmoochApi::ServiceAccountApi
+
+All URIs are relative to *https://api.smooch.io/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_secret_key**](ServiceAccountApi.md#create_secret_key) | **POST** /serviceaccounts/{serviceAccountId}/keys | 
+[**create_service_account**](ServiceAccountApi.md#create_service_account) | **POST** /serviceaccounts | 
+[**delete_secret_key**](ServiceAccountApi.md#delete_secret_key) | **DELETE** /serviceaccounts/{serviceAccountId}/keys/{keyId} | 
+[**delete_service_account**](ServiceAccountApi.md#delete_service_account) | **DELETE** /serviceaccounts/{serviceAccountId} | 
+[**get_jwt**](ServiceAccountApi.md#get_jwt) | **GET** /serviceaccounts/{serviceAccountId}/keys/{keyId}/jwt | 
+[**get_secret_key**](ServiceAccountApi.md#get_secret_key) | **GET** /serviceaccounts/{serviceAccountId}/keys/{keyId} | 
+[**get_service_account**](ServiceAccountApi.md#get_service_account) | **GET** /serviceaccounts/{serviceAccountId} | 
+[**list_secret_keys**](ServiceAccountApi.md#list_secret_keys) | **GET** /serviceaccounts/{serviceAccountId}/keys | 
+[**list_service_accounts**](ServiceAccountApi.md#list_service_accounts) | **GET** /serviceaccounts | 
+[**update_service_account**](ServiceAccountApi.md#update_service_account) | **PUT** /serviceaccounts/{serviceAccountId} | 
+
+
+# **create_secret_key**
+> SecretKeyResponse create_secret_key(service_account_id, secret_key_create_body)
+
+
+
+Create a secret key for the specified service account.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::ServiceAccountApi.new
+
+service_account_id = "service_account_id_example" # String | Identifies the service account.
+
+secret_key_create_body = SmoochApi::SecretKeyCreate.new # SecretKeyCreate | Body for a createSecretKey request.
+
+
+begin
+  result = api_instance.create_secret_key(service_account_id, secret_key_create_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling ServiceAccountApi->create_secret_key: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **service_account_id** | **String**| Identifies the service account. | 
+ **secret_key_create_body** | [**SecretKeyCreate**](SecretKeyCreate.md)| Body for a createSecretKey request. | 
+
+### Return type
+
+[**SecretKeyResponse**](SecretKeyResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **create_service_account**
+> ServiceAccountResponse create_service_account(service_account_create_body)
+
+
+
+Create a new service account.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::ServiceAccountApi.new
+
+service_account_create_body = SmoochApi::ServiceAccountCreate.new # ServiceAccountCreate | Body for a createServiceAccount request.
+
+
+begin
+  result = api_instance.create_service_account(service_account_create_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling ServiceAccountApi->create_service_account: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **service_account_create_body** | [**ServiceAccountCreate**](ServiceAccountCreate.md)| Body for a createServiceAccount request. | 
+
+### Return type
+
+[**ServiceAccountResponse**](ServiceAccountResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_secret_key**
+> delete_secret_key(service_account_id, key_id)
+
+
+
+Delete the specified service account secret key.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::ServiceAccountApi.new
+
+service_account_id = "service_account_id_example" # String | Identifies the service account.
+
+key_id = "key_id_example" # String | Identifies the secret key.
+
+
+begin
+  api_instance.delete_secret_key(service_account_id, key_id)
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling ServiceAccountApi->delete_secret_key: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **service_account_id** | **String**| Identifies the service account. | 
+ **key_id** | **String**| Identifies the secret key. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **delete_service_account**
+> delete_service_account(service_account_id, )
+
+
+
+Delete the specified service account.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::ServiceAccountApi.new
+
+service_account_id = "service_account_id_example" # String | Identifies the service account.
+
+
+begin
+  api_instance.delete_service_account(service_account_id, )
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling ServiceAccountApi->delete_service_account: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **service_account_id** | **String**| Identifies the service account. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_jwt**
+> JwtResponse get_jwt(service_account_id, key_id)
+
+
+
+Get an account-scoped JWT for the specified service account secret key.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::ServiceAccountApi.new
+
+service_account_id = "service_account_id_example" # String | Identifies the service account.
+
+key_id = "key_id_example" # String | Identifies the secret key.
+
+
+begin
+  result = api_instance.get_jwt(service_account_id, key_id)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling ServiceAccountApi->get_jwt: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **service_account_id** | **String**| Identifies the service account. | 
+ **key_id** | **String**| Identifies the secret key. | 
+
+### Return type
+
+[**JwtResponse**](JwtResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_secret_key**
+> SecretKeyResponse get_secret_key(service_account_id, key_id)
+
+
+
+Get the specified service account secret key.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::ServiceAccountApi.new
+
+service_account_id = "service_account_id_example" # String | Identifies the service account.
+
+key_id = "key_id_example" # String | Identifies the secret key.
+
+
+begin
+  result = api_instance.get_secret_key(service_account_id, key_id)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling ServiceAccountApi->get_secret_key: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **service_account_id** | **String**| Identifies the service account. | 
+ **key_id** | **String**| Identifies the secret key. | 
+
+### Return type
+
+[**SecretKeyResponse**](SecretKeyResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **get_service_account**
+> ServiceAccountResponse get_service_account(service_account_id, )
+
+
+
+Get the specified service account.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::ServiceAccountApi.new
+
+service_account_id = "service_account_id_example" # String | Identifies the service account.
+
+
+begin
+  result = api_instance.get_service_account(service_account_id, )
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling ServiceAccountApi->get_service_account: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **service_account_id** | **String**| Identifies the service account. | 
+
+### Return type
+
+[**ServiceAccountResponse**](ServiceAccountResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_secret_keys**
+> ListSecretKeysResponse list_secret_keys(service_account_id, )
+
+
+
+List the secret keys for the specified service account.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::ServiceAccountApi.new
+
+service_account_id = "service_account_id_example" # String | Identifies the service account.
+
+
+begin
+  result = api_instance.list_secret_keys(service_account_id, )
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling ServiceAccountApi->list_secret_keys: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **service_account_id** | **String**| Identifies the service account. | 
+
+### Return type
+
+[**ListSecretKeysResponse**](ListSecretKeysResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_service_accounts**
+> ListServiceAccountsResponse list_service_accounts(opts)
+
+
+
+List all service accounts configured.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::ServiceAccountApi.new
+
+opts = { 
+  limit: 25, # Integer | The number of records to return.
+  offset: 0 # Integer | The number of initial records to skip before picking records to return.
+}
+
+begin
+  result = api_instance.list_service_accounts(opts)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling ServiceAccountApi->list_service_accounts: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **limit** | **Integer**| The number of records to return. | [optional] [default to 25]
+ **offset** | **Integer**| The number of initial records to skip before picking records to return. | [optional] [default to 0]
+
+### Return type
+
+[**ListServiceAccountsResponse**](ListServiceAccountsResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **update_service_account**
+> ServiceAccountResponse update_service_account(service_account_id, service_account_update_body)
+
+
+
+Update the specified service account.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::ServiceAccountApi.new
+
+service_account_id = "service_account_id_example" # String | Identifies the service account.
+
+service_account_update_body = SmoochApi::ServiceAccountUpdate.new # ServiceAccountUpdate | Body for an updateServiceAccount request.
+
+
+begin
+  result = api_instance.update_service_account(service_account_id, service_account_update_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling ServiceAccountApi->update_service_account: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **service_account_id** | **String**| Identifies the service account. | 
+ **service_account_update_body** | [**ServiceAccountUpdate**](ServiceAccountUpdate.md)| Body for an updateServiceAccount request. | 
+
+### Return type
+
+[**ServiceAccountResponse**](ServiceAccountResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+