smooch-api 3.19.0 → 4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +73 -64
- data/docs/AppApi.md +10 -10
- data/docs/AppUser.md +0 -1
- data/docs/AppUserApi.md +12 -12
- data/docs/AppUserLink.md +0 -1
- data/docs/AppUserPreCreate.md +0 -1
- data/docs/AttachmentsApi.md +2 -2
- data/docs/ConversationApi.md +6 -6
- data/docs/IntegrationApi.md +10 -10
- data/docs/MenuApi.md +3 -3
- data/docs/ServiceAccountApi.md +10 -10
- data/docs/TemplateApi.md +5 -5
- data/docs/WebhookApi.md +5 -5
- data/lib/smooch-api.rb +1 -1
- data/lib/smooch-api/api/app_api.rb +11 -11
- data/lib/smooch-api/api/app_user_api.rb +13 -13
- data/lib/smooch-api/api/attachments_api.rb +3 -3
- data/lib/smooch-api/api/conversation_api.rb +7 -7
- data/lib/smooch-api/api/integration_api.rb +11 -11
- data/lib/smooch-api/api/menu_api.rb +4 -4
- data/lib/smooch-api/api/service_account_api.rb +11 -11
- data/lib/smooch-api/api/template_api.rb +6 -6
- data/lib/smooch-api/api/webhook_api.rb +6 -6
- data/lib/smooch-api/api_client.rb +1 -1
- data/lib/smooch-api/api_error.rb +1 -1
- data/lib/smooch-api/configuration.rb +1 -1
- data/lib/smooch-api/models/action.rb +1 -1
- data/lib/smooch-api/models/app.rb +1 -1
- data/lib/smooch-api/models/app_create.rb +1 -1
- data/lib/smooch-api/models/app_response.rb +1 -1
- data/lib/smooch-api/models/app_settings.rb +1 -1
- data/lib/smooch-api/models/app_update.rb +1 -1
- data/lib/smooch-api/models/app_user.rb +2 -12
- data/lib/smooch-api/models/app_user_business_systems_response.rb +1 -1
- data/lib/smooch-api/models/app_user_channels_response.rb +1 -1
- data/lib/smooch-api/models/app_user_link.rb +2 -12
- data/lib/smooch-api/models/app_user_pre_create.rb +2 -12
- data/lib/smooch-api/models/app_user_response.rb +1 -1
- data/lib/smooch-api/models/app_user_update.rb +1 -1
- data/lib/smooch-api/models/attachment_remove.rb +1 -1
- data/lib/smooch-api/models/attachment_response.rb +1 -1
- data/lib/smooch-api/models/auth_code_response.rb +1 -1
- data/lib/smooch-api/models/business_system_item.rb +1 -1
- data/lib/smooch-api/models/channel_entity_item.rb +1 -1
- data/lib/smooch-api/models/client.rb +1 -1
- data/lib/smooch-api/models/client_info.rb +1 -1
- data/lib/smooch-api/models/confirmation.rb +1 -1
- data/lib/smooch-api/models/conversation.rb +1 -1
- data/lib/smooch-api/models/destination.rb +1 -1
- data/lib/smooch-api/models/display_settings.rb +1 -1
- data/lib/smooch-api/models/get_messages_response.rb +1 -1
- data/lib/smooch-api/models/integration.rb +1 -1
- data/lib/smooch-api/models/integration_create.rb +1 -1
- data/lib/smooch-api/models/integration_profile_update.rb +1 -1
- data/lib/smooch-api/models/integration_response.rb +1 -1
- data/lib/smooch-api/models/integration_update.rb +1 -1
- data/lib/smooch-api/models/jwt_response.rb +1 -1
- data/lib/smooch-api/models/link_request_response.rb +1 -1
- data/lib/smooch-api/models/link_request_response_link_requests.rb +1 -1
- data/lib/smooch-api/models/list_apps_response.rb +1 -1
- data/lib/smooch-api/models/list_integrations_response.rb +1 -1
- data/lib/smooch-api/models/list_secret_keys_response.rb +1 -1
- data/lib/smooch-api/models/list_service_accounts_response.rb +1 -1
- data/lib/smooch-api/models/list_templates_response.rb +1 -1
- data/lib/smooch-api/models/list_webhooks_response.rb +1 -1
- data/lib/smooch-api/models/menu.rb +1 -1
- data/lib/smooch-api/models/menu_item.rb +1 -1
- data/lib/smooch-api/models/menu_response.rb +1 -1
- data/lib/smooch-api/models/message.rb +1 -1
- data/lib/smooch-api/models/message_item.rb +1 -1
- data/lib/smooch-api/models/message_post.rb +1 -1
- data/lib/smooch-api/models/message_response.rb +1 -1
- data/lib/smooch-api/models/secret_key.rb +1 -1
- data/lib/smooch-api/models/secret_key_create.rb +1 -1
- data/lib/smooch-api/models/secret_key_response.rb +1 -1
- data/lib/smooch-api/models/service_account.rb +1 -1
- data/lib/smooch-api/models/service_account_create.rb +1 -1
- data/lib/smooch-api/models/service_account_response.rb +1 -1
- data/lib/smooch-api/models/service_account_update.rb +1 -1
- data/lib/smooch-api/models/source.rb +1 -1
- data/lib/smooch-api/models/sub_menu_item.rb +1 -1
- data/lib/smooch-api/models/template.rb +1 -1
- data/lib/smooch-api/models/template_create.rb +1 -1
- data/lib/smooch-api/models/template_response.rb +1 -1
- data/lib/smooch-api/models/template_update.rb +1 -1
- data/lib/smooch-api/models/typing_activity_trigger.rb +1 -1
- data/lib/smooch-api/models/webhook.rb +1 -1
- data/lib/smooch-api/models/webhook_create.rb +1 -1
- data/lib/smooch-api/models/webhook_response.rb +1 -1
- data/lib/smooch-api/models/webhook_update.rb +1 -1
- data/lib/smooch-api/version.rb +2 -2
- data/smooch-api.gemspec +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c72c9ca70c2671f5afdea96d597dfbd1211cfecf
|
4
|
+
data.tar.gz: c95c089995b34624309490797c62b53f2fb24d89
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ac47be2cfe02f8f365f72766e82214908565d4be3b5d8b5f2eabe086edb426ebd6a87722271810bdc4da926dc875463e929a3f530d63d44e0ac1e1f799e0aefe
|
7
|
+
data.tar.gz: 8c16e17e57ff8f439766944f4f0d0cd1ab9f182514b1886ec450b9a25ef4acaece141fe5cfd17fed84a5cd6780719ebaecd19ccff2821da5b7ceeaebda062c56
|
data/README.md
CHANGED
@@ -6,6 +6,15 @@ The Smooch API is a unified interface for powering messaging in your customer ex
|
|
6
6
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project using the [Smooch api spec](https://github.com/smooch/api-spec).
|
8
8
|
|
9
|
+
## Smooch API Version
|
10
|
+
|
11
|
+
The Smooch API offers multiple [versions](https://docs.smooch.io/guide/versioning/). Each release of this project targets one and only one Smooch API version. If you depend on an older version of the Smooch API, you may need to use an older release of this library. Use the table below as your guide:
|
12
|
+
|
13
|
+
| Smooch API version | `smooch-ruby` version to use |
|
14
|
+
|--------------------|--------------------------------|
|
15
|
+
| `v1.1` [Upgrade guide](https://docs.smooch.io/guide/versioning/#upgrading-to-v11-from-v1) | `4.0.0` or newer |
|
16
|
+
| `v1` | `3.*` or older |
|
17
|
+
|
9
18
|
## Installation
|
10
19
|
|
11
20
|
Install the gem:
|
@@ -16,7 +25,7 @@ gem install smooch-api
|
|
16
25
|
|
17
26
|
Add this to the Gemfile:
|
18
27
|
|
19
|
-
gem 'smooch-api', '~>
|
28
|
+
gem 'smooch-api', '~> 4.0'
|
20
29
|
|
21
30
|
## Getting Started
|
22
31
|
|
@@ -90,69 +99,69 @@ All URIs are relative to *https://api.smooch.io*
|
|
90
99
|
|
91
100
|
Class | Method | HTTP request | Description
|
92
101
|
------------ | ------------- | ------------- | -------------
|
93
|
-
*SmoochApi::AppApi* | [**create_app**](docs/AppApi.md#create_app) | **POST** /v1/apps |
|
94
|
-
*SmoochApi::AppApi* | [**create_secret_key**](docs/AppApi.md#create_secret_key) | **POST** /v1/apps/{appId}/keys |
|
95
|
-
*SmoochApi::AppApi* | [**delete_app**](docs/AppApi.md#delete_app) | **DELETE** /v1/apps/{appId} |
|
96
|
-
*SmoochApi::AppApi* | [**delete_secret_key**](docs/AppApi.md#delete_secret_key) | **DELETE** /v1/apps/{appId}/keys/{keyId} |
|
97
|
-
*SmoochApi::AppApi* | [**get_app**](docs/AppApi.md#get_app) | **GET** /v1/apps/{appId} |
|
98
|
-
*SmoochApi::AppApi* | [**get_app_jwt**](docs/AppApi.md#get_app_jwt) | **GET** /v1/apps/{appId}/keys/{keyId}/jwt |
|
99
|
-
*SmoochApi::AppApi* | [**get_secret_key**](docs/AppApi.md#get_secret_key) | **GET** /v1/apps/{appId}/keys/{keyId} |
|
100
|
-
*SmoochApi::AppApi* | [**list_apps**](docs/AppApi.md#list_apps) | **GET** /v1/apps |
|
101
|
-
*SmoochApi::AppApi* | [**list_secret_keys**](docs/AppApi.md#list_secret_keys) | **GET** /v1/apps/{appId}/keys |
|
102
|
-
*SmoochApi::AppApi* | [**update_app**](docs/AppApi.md#update_app) | **PUT** /v1/apps/{appId} |
|
103
|
-
*SmoochApi::AppUserApi* | [**delete_app_user**](docs/AppUserApi.md#delete_app_user) | **DELETE** /v1/apps/{appId}/appusers/{userId} |
|
104
|
-
*SmoochApi::AppUserApi* | [**delete_app_user_profile**](docs/AppUserApi.md#delete_app_user_profile) | **DELETE** /v1/apps/{appId}/appusers/{userId}/profile |
|
105
|
-
*SmoochApi::AppUserApi* | [**get_app_user**](docs/AppUserApi.md#get_app_user) | **GET** /v1/apps/{appId}/appusers/{userId} |
|
106
|
-
*SmoochApi::AppUserApi* | [**get_app_user_auth_code**](docs/AppUserApi.md#get_app_user_auth_code) | **GET** /v1/apps/{appId}/appusers/{userId}/authcode |
|
107
|
-
*SmoochApi::AppUserApi* | [**get_app_user_business_system_ids**](docs/AppUserApi.md#get_app_user_business_system_ids) | **GET** /v1/apps/{appId}/appusers/{userId}/businesssystems |
|
108
|
-
*SmoochApi::AppUserApi* | [**get_app_user_entity_ids**](docs/AppUserApi.md#get_app_user_entity_ids) | **GET** /v1/apps/{appId}/appusers/{userId}/channels |
|
109
|
-
*SmoochApi::AppUserApi* | [**get_link_requests**](docs/AppUserApi.md#get_link_requests) | **GET** /v1/apps/{appId}/appusers/{userId}/linkrequest |
|
110
|
-
*SmoochApi::AppUserApi* | [**link_app_user**](docs/AppUserApi.md#link_app_user) | **POST** /v1/apps/{appId}/appusers/{userId}/channels |
|
111
|
-
*SmoochApi::AppUserApi* | [**post_image_message**](docs/AppUserApi.md#post_image_message) | **POST** /v1/apps/{appId}/appusers/{userId}/images |
|
112
|
-
*SmoochApi::AppUserApi* | [**pre_create_app_user**](docs/AppUserApi.md#pre_create_app_user) | **POST** /v1/apps/{appId}/appusers |
|
113
|
-
*SmoochApi::AppUserApi* | [**unlink_app_user**](docs/AppUserApi.md#unlink_app_user) | **DELETE** /v1/apps/{appId}/appusers/{userId}/channels/{channel} |
|
114
|
-
*SmoochApi::AppUserApi* | [**update_app_user**](docs/AppUserApi.md#update_app_user) | **PUT** /v1/apps/{appId}/appusers/{userId} |
|
115
|
-
*SmoochApi::AttachmentsApi* | [**remove_attachment**](docs/AttachmentsApi.md#remove_attachment) | **POST** /v1/apps/{appId}/attachments/remove |
|
116
|
-
*SmoochApi::AttachmentsApi* | [**upload_attachment**](docs/AttachmentsApi.md#upload_attachment) | **POST** /v1/apps/{appId}/attachments |
|
117
|
-
*SmoochApi::ConversationApi* | [**delete_message**](docs/ConversationApi.md#delete_message) | **DELETE** /v1/apps/{appId}/appusers/{userId}/messages/{messageId} |
|
118
|
-
*SmoochApi::ConversationApi* | [**delete_messages**](docs/ConversationApi.md#delete_messages) | **DELETE** /v1/apps/{appId}/appusers/{userId}/messages |
|
119
|
-
*SmoochApi::ConversationApi* | [**get_messages**](docs/ConversationApi.md#get_messages) | **GET** /v1/apps/{appId}/appusers/{userId}/messages |
|
120
|
-
*SmoochApi::ConversationApi* | [**post_message**](docs/ConversationApi.md#post_message) | **POST** /v1/apps/{appId}/appusers/{userId}/messages |
|
121
|
-
*SmoochApi::ConversationApi* | [**reset_unread_count**](docs/ConversationApi.md#reset_unread_count) | **POST** /v1/apps/{appId}/appusers/{userId}/conversation/read |
|
122
|
-
*SmoochApi::ConversationApi* | [**trigger_typing_activity**](docs/ConversationApi.md#trigger_typing_activity) | **POST** /v1/apps/{appId}/appusers/{userId}/conversation/activity |
|
123
|
-
*SmoochApi::IntegrationApi* | [**create_integration**](docs/IntegrationApi.md#create_integration) | **POST** /v1/apps/{appId}/integrations |
|
124
|
-
*SmoochApi::IntegrationApi* | [**create_integration_menu**](docs/IntegrationApi.md#create_integration_menu) | **POST** /v1/apps/{appId}/integrations/{integrationId}/menu |
|
125
|
-
*SmoochApi::IntegrationApi* | [**delete_integration**](docs/IntegrationApi.md#delete_integration) | **DELETE** /v1/apps/{appId}/integrations/{integrationId} |
|
126
|
-
*SmoochApi::IntegrationApi* | [**delete_integration_menu**](docs/IntegrationApi.md#delete_integration_menu) | **DELETE** /v1/apps/{appId}/integrations/{integrationId}/menu |
|
127
|
-
*SmoochApi::IntegrationApi* | [**get_integration**](docs/IntegrationApi.md#get_integration) | **GET** /v1/apps/{appId}/integrations/{integrationId} |
|
128
|
-
*SmoochApi::IntegrationApi* | [**get_integration_menu**](docs/IntegrationApi.md#get_integration_menu) | **GET** /v1/apps/{appId}/integrations/{integrationId}/menu |
|
129
|
-
*SmoochApi::IntegrationApi* | [**list_integrations**](docs/IntegrationApi.md#list_integrations) | **GET** /v1/apps/{appId}/integrations |
|
130
|
-
*SmoochApi::IntegrationApi* | [**update_integration**](docs/IntegrationApi.md#update_integration) | **PUT** /v1/apps/{appId}/integrations/{integrationId} |
|
131
|
-
*SmoochApi::IntegrationApi* | [**update_integration_menu**](docs/IntegrationApi.md#update_integration_menu) | **PUT** /v1/apps/{appId}/integrations/{integrationId}/menu |
|
132
|
-
*SmoochApi::IntegrationApi* | [**update_integration_profile**](docs/IntegrationApi.md#update_integration_profile) | **PUT** /v1/apps/{appId}/integrations/{integrationId}/profile |
|
133
|
-
*SmoochApi::MenuApi* | [**delete_menu**](docs/MenuApi.md#delete_menu) | **DELETE** /v1/apps/{appId}/menu |
|
134
|
-
*SmoochApi::MenuApi* | [**get_menu**](docs/MenuApi.md#get_menu) | **GET** /v1/apps/{appId}/menu |
|
135
|
-
*SmoochApi::MenuApi* | [**update_menu**](docs/MenuApi.md#update_menu) | **PUT** /v1/apps/{appId}/menu |
|
136
|
-
*SmoochApi::ServiceAccountApi* | [**create_secret_key**](docs/ServiceAccountApi.md#create_secret_key) | **POST** /v1/serviceaccounts/{serviceAccountId}/keys |
|
137
|
-
*SmoochApi::ServiceAccountApi* | [**create_service_account**](docs/ServiceAccountApi.md#create_service_account) | **POST** /v1/serviceaccounts |
|
138
|
-
*SmoochApi::ServiceAccountApi* | [**delete_secret_key**](docs/ServiceAccountApi.md#delete_secret_key) | **DELETE** /v1/serviceaccounts/{serviceAccountId}/keys/{keyId} |
|
139
|
-
*SmoochApi::ServiceAccountApi* | [**delete_service_account**](docs/ServiceAccountApi.md#delete_service_account) | **DELETE** /v1/serviceaccounts/{serviceAccountId} |
|
140
|
-
*SmoochApi::ServiceAccountApi* | [**get_jwt**](docs/ServiceAccountApi.md#get_jwt) | **GET** /v1/serviceaccounts/{serviceAccountId}/keys/{keyId}/jwt |
|
141
|
-
*SmoochApi::ServiceAccountApi* | [**get_secret_key**](docs/ServiceAccountApi.md#get_secret_key) | **GET** /v1/serviceaccounts/{serviceAccountId}/keys/{keyId} |
|
142
|
-
*SmoochApi::ServiceAccountApi* | [**get_service_account**](docs/ServiceAccountApi.md#get_service_account) | **GET** /v1/serviceaccounts/{serviceAccountId} |
|
143
|
-
*SmoochApi::ServiceAccountApi* | [**list_secret_keys**](docs/ServiceAccountApi.md#list_secret_keys) | **GET** /v1/serviceaccounts/{serviceAccountId}/keys |
|
144
|
-
*SmoochApi::ServiceAccountApi* | [**list_service_accounts**](docs/ServiceAccountApi.md#list_service_accounts) | **GET** /v1/serviceaccounts |
|
145
|
-
*SmoochApi::ServiceAccountApi* | [**update_service_account**](docs/ServiceAccountApi.md#update_service_account) | **PUT** /v1/serviceaccounts/{serviceAccountId} |
|
146
|
-
*SmoochApi::TemplateApi* | [**create_template**](docs/TemplateApi.md#create_template) | **POST** /v1/apps/{appId}/templates |
|
147
|
-
*SmoochApi::TemplateApi* | [**delete_template**](docs/TemplateApi.md#delete_template) | **DELETE** /v1/apps/{appId}/templates/{templateId} |
|
148
|
-
*SmoochApi::TemplateApi* | [**get_template**](docs/TemplateApi.md#get_template) | **GET** /v1/apps/{appId}/templates/{templateId} |
|
149
|
-
*SmoochApi::TemplateApi* | [**list_templates**](docs/TemplateApi.md#list_templates) | **GET** /v1/apps/{appId}/templates |
|
150
|
-
*SmoochApi::TemplateApi* | [**update_template**](docs/TemplateApi.md#update_template) | **PUT** /v1/apps/{appId}/templates/{templateId} |
|
151
|
-
*SmoochApi::WebhookApi* | [**create_webhook**](docs/WebhookApi.md#create_webhook) | **POST** /v1/apps/{appId}/webhooks |
|
152
|
-
*SmoochApi::WebhookApi* | [**delete_webhook**](docs/WebhookApi.md#delete_webhook) | **DELETE** /v1/apps/{appId}/webhooks/{webhookId} |
|
153
|
-
*SmoochApi::WebhookApi* | [**get_webhook**](docs/WebhookApi.md#get_webhook) | **GET** /v1/apps/{appId}/webhooks/{webhookId} |
|
154
|
-
*SmoochApi::WebhookApi* | [**list_webhooks**](docs/WebhookApi.md#list_webhooks) | **GET** /v1/apps/{appId}/webhooks |
|
155
|
-
*SmoochApi::WebhookApi* | [**update_webhook**](docs/WebhookApi.md#update_webhook) | **PUT** /v1/apps/{appId}/webhooks/{webhookId} |
|
102
|
+
*SmoochApi::AppApi* | [**create_app**](docs/AppApi.md#create_app) | **POST** /v1.1/apps |
|
103
|
+
*SmoochApi::AppApi* | [**create_secret_key**](docs/AppApi.md#create_secret_key) | **POST** /v1.1/apps/{appId}/keys |
|
104
|
+
*SmoochApi::AppApi* | [**delete_app**](docs/AppApi.md#delete_app) | **DELETE** /v1.1/apps/{appId} |
|
105
|
+
*SmoochApi::AppApi* | [**delete_secret_key**](docs/AppApi.md#delete_secret_key) | **DELETE** /v1.1/apps/{appId}/keys/{keyId} |
|
106
|
+
*SmoochApi::AppApi* | [**get_app**](docs/AppApi.md#get_app) | **GET** /v1.1/apps/{appId} |
|
107
|
+
*SmoochApi::AppApi* | [**get_app_jwt**](docs/AppApi.md#get_app_jwt) | **GET** /v1.1/apps/{appId}/keys/{keyId}/jwt |
|
108
|
+
*SmoochApi::AppApi* | [**get_secret_key**](docs/AppApi.md#get_secret_key) | **GET** /v1.1/apps/{appId}/keys/{keyId} |
|
109
|
+
*SmoochApi::AppApi* | [**list_apps**](docs/AppApi.md#list_apps) | **GET** /v1.1/apps |
|
110
|
+
*SmoochApi::AppApi* | [**list_secret_keys**](docs/AppApi.md#list_secret_keys) | **GET** /v1.1/apps/{appId}/keys |
|
111
|
+
*SmoochApi::AppApi* | [**update_app**](docs/AppApi.md#update_app) | **PUT** /v1.1/apps/{appId} |
|
112
|
+
*SmoochApi::AppUserApi* | [**delete_app_user**](docs/AppUserApi.md#delete_app_user) | **DELETE** /v1.1/apps/{appId}/appusers/{userId} |
|
113
|
+
*SmoochApi::AppUserApi* | [**delete_app_user_profile**](docs/AppUserApi.md#delete_app_user_profile) | **DELETE** /v1.1/apps/{appId}/appusers/{userId}/profile |
|
114
|
+
*SmoochApi::AppUserApi* | [**get_app_user**](docs/AppUserApi.md#get_app_user) | **GET** /v1.1/apps/{appId}/appusers/{userId} |
|
115
|
+
*SmoochApi::AppUserApi* | [**get_app_user_auth_code**](docs/AppUserApi.md#get_app_user_auth_code) | **GET** /v1.1/apps/{appId}/appusers/{userId}/authcode |
|
116
|
+
*SmoochApi::AppUserApi* | [**get_app_user_business_system_ids**](docs/AppUserApi.md#get_app_user_business_system_ids) | **GET** /v1.1/apps/{appId}/appusers/{userId}/businesssystems |
|
117
|
+
*SmoochApi::AppUserApi* | [**get_app_user_entity_ids**](docs/AppUserApi.md#get_app_user_entity_ids) | **GET** /v1.1/apps/{appId}/appusers/{userId}/channels |
|
118
|
+
*SmoochApi::AppUserApi* | [**get_link_requests**](docs/AppUserApi.md#get_link_requests) | **GET** /v1.1/apps/{appId}/appusers/{userId}/linkrequest |
|
119
|
+
*SmoochApi::AppUserApi* | [**link_app_user**](docs/AppUserApi.md#link_app_user) | **POST** /v1.1/apps/{appId}/appusers/{userId}/channels |
|
120
|
+
*SmoochApi::AppUserApi* | [**post_image_message**](docs/AppUserApi.md#post_image_message) | **POST** /v1.1/apps/{appId}/appusers/{userId}/images |
|
121
|
+
*SmoochApi::AppUserApi* | [**pre_create_app_user**](docs/AppUserApi.md#pre_create_app_user) | **POST** /v1.1/apps/{appId}/appusers |
|
122
|
+
*SmoochApi::AppUserApi* | [**unlink_app_user**](docs/AppUserApi.md#unlink_app_user) | **DELETE** /v1.1/apps/{appId}/appusers/{userId}/channels/{channel} |
|
123
|
+
*SmoochApi::AppUserApi* | [**update_app_user**](docs/AppUserApi.md#update_app_user) | **PUT** /v1.1/apps/{appId}/appusers/{userId} |
|
124
|
+
*SmoochApi::AttachmentsApi* | [**remove_attachment**](docs/AttachmentsApi.md#remove_attachment) | **POST** /v1.1/apps/{appId}/attachments/remove |
|
125
|
+
*SmoochApi::AttachmentsApi* | [**upload_attachment**](docs/AttachmentsApi.md#upload_attachment) | **POST** /v1.1/apps/{appId}/attachments |
|
126
|
+
*SmoochApi::ConversationApi* | [**delete_message**](docs/ConversationApi.md#delete_message) | **DELETE** /v1.1/apps/{appId}/appusers/{userId}/messages/{messageId} |
|
127
|
+
*SmoochApi::ConversationApi* | [**delete_messages**](docs/ConversationApi.md#delete_messages) | **DELETE** /v1.1/apps/{appId}/appusers/{userId}/messages |
|
128
|
+
*SmoochApi::ConversationApi* | [**get_messages**](docs/ConversationApi.md#get_messages) | **GET** /v1.1/apps/{appId}/appusers/{userId}/messages |
|
129
|
+
*SmoochApi::ConversationApi* | [**post_message**](docs/ConversationApi.md#post_message) | **POST** /v1.1/apps/{appId}/appusers/{userId}/messages |
|
130
|
+
*SmoochApi::ConversationApi* | [**reset_unread_count**](docs/ConversationApi.md#reset_unread_count) | **POST** /v1.1/apps/{appId}/appusers/{userId}/conversation/read |
|
131
|
+
*SmoochApi::ConversationApi* | [**trigger_typing_activity**](docs/ConversationApi.md#trigger_typing_activity) | **POST** /v1.1/apps/{appId}/appusers/{userId}/conversation/activity |
|
132
|
+
*SmoochApi::IntegrationApi* | [**create_integration**](docs/IntegrationApi.md#create_integration) | **POST** /v1.1/apps/{appId}/integrations |
|
133
|
+
*SmoochApi::IntegrationApi* | [**create_integration_menu**](docs/IntegrationApi.md#create_integration_menu) | **POST** /v1.1/apps/{appId}/integrations/{integrationId}/menu |
|
134
|
+
*SmoochApi::IntegrationApi* | [**delete_integration**](docs/IntegrationApi.md#delete_integration) | **DELETE** /v1.1/apps/{appId}/integrations/{integrationId} |
|
135
|
+
*SmoochApi::IntegrationApi* | [**delete_integration_menu**](docs/IntegrationApi.md#delete_integration_menu) | **DELETE** /v1.1/apps/{appId}/integrations/{integrationId}/menu |
|
136
|
+
*SmoochApi::IntegrationApi* | [**get_integration**](docs/IntegrationApi.md#get_integration) | **GET** /v1.1/apps/{appId}/integrations/{integrationId} |
|
137
|
+
*SmoochApi::IntegrationApi* | [**get_integration_menu**](docs/IntegrationApi.md#get_integration_menu) | **GET** /v1.1/apps/{appId}/integrations/{integrationId}/menu |
|
138
|
+
*SmoochApi::IntegrationApi* | [**list_integrations**](docs/IntegrationApi.md#list_integrations) | **GET** /v1.1/apps/{appId}/integrations |
|
139
|
+
*SmoochApi::IntegrationApi* | [**update_integration**](docs/IntegrationApi.md#update_integration) | **PUT** /v1.1/apps/{appId}/integrations/{integrationId} |
|
140
|
+
*SmoochApi::IntegrationApi* | [**update_integration_menu**](docs/IntegrationApi.md#update_integration_menu) | **PUT** /v1.1/apps/{appId}/integrations/{integrationId}/menu |
|
141
|
+
*SmoochApi::IntegrationApi* | [**update_integration_profile**](docs/IntegrationApi.md#update_integration_profile) | **PUT** /v1.1/apps/{appId}/integrations/{integrationId}/profile |
|
142
|
+
*SmoochApi::MenuApi* | [**delete_menu**](docs/MenuApi.md#delete_menu) | **DELETE** /v1.1/apps/{appId}/menu |
|
143
|
+
*SmoochApi::MenuApi* | [**get_menu**](docs/MenuApi.md#get_menu) | **GET** /v1.1/apps/{appId}/menu |
|
144
|
+
*SmoochApi::MenuApi* | [**update_menu**](docs/MenuApi.md#update_menu) | **PUT** /v1.1/apps/{appId}/menu |
|
145
|
+
*SmoochApi::ServiceAccountApi* | [**create_secret_key**](docs/ServiceAccountApi.md#create_secret_key) | **POST** /v1.1/serviceaccounts/{serviceAccountId}/keys |
|
146
|
+
*SmoochApi::ServiceAccountApi* | [**create_service_account**](docs/ServiceAccountApi.md#create_service_account) | **POST** /v1.1/serviceaccounts |
|
147
|
+
*SmoochApi::ServiceAccountApi* | [**delete_secret_key**](docs/ServiceAccountApi.md#delete_secret_key) | **DELETE** /v1.1/serviceaccounts/{serviceAccountId}/keys/{keyId} |
|
148
|
+
*SmoochApi::ServiceAccountApi* | [**delete_service_account**](docs/ServiceAccountApi.md#delete_service_account) | **DELETE** /v1.1/serviceaccounts/{serviceAccountId} |
|
149
|
+
*SmoochApi::ServiceAccountApi* | [**get_jwt**](docs/ServiceAccountApi.md#get_jwt) | **GET** /v1.1/serviceaccounts/{serviceAccountId}/keys/{keyId}/jwt |
|
150
|
+
*SmoochApi::ServiceAccountApi* | [**get_secret_key**](docs/ServiceAccountApi.md#get_secret_key) | **GET** /v1.1/serviceaccounts/{serviceAccountId}/keys/{keyId} |
|
151
|
+
*SmoochApi::ServiceAccountApi* | [**get_service_account**](docs/ServiceAccountApi.md#get_service_account) | **GET** /v1.1/serviceaccounts/{serviceAccountId} |
|
152
|
+
*SmoochApi::ServiceAccountApi* | [**list_secret_keys**](docs/ServiceAccountApi.md#list_secret_keys) | **GET** /v1.1/serviceaccounts/{serviceAccountId}/keys |
|
153
|
+
*SmoochApi::ServiceAccountApi* | [**list_service_accounts**](docs/ServiceAccountApi.md#list_service_accounts) | **GET** /v1.1/serviceaccounts |
|
154
|
+
*SmoochApi::ServiceAccountApi* | [**update_service_account**](docs/ServiceAccountApi.md#update_service_account) | **PUT** /v1.1/serviceaccounts/{serviceAccountId} |
|
155
|
+
*SmoochApi::TemplateApi* | [**create_template**](docs/TemplateApi.md#create_template) | **POST** /v1.1/apps/{appId}/templates |
|
156
|
+
*SmoochApi::TemplateApi* | [**delete_template**](docs/TemplateApi.md#delete_template) | **DELETE** /v1.1/apps/{appId}/templates/{templateId} |
|
157
|
+
*SmoochApi::TemplateApi* | [**get_template**](docs/TemplateApi.md#get_template) | **GET** /v1.1/apps/{appId}/templates/{templateId} |
|
158
|
+
*SmoochApi::TemplateApi* | [**list_templates**](docs/TemplateApi.md#list_templates) | **GET** /v1.1/apps/{appId}/templates |
|
159
|
+
*SmoochApi::TemplateApi* | [**update_template**](docs/TemplateApi.md#update_template) | **PUT** /v1.1/apps/{appId}/templates/{templateId} |
|
160
|
+
*SmoochApi::WebhookApi* | [**create_webhook**](docs/WebhookApi.md#create_webhook) | **POST** /v1.1/apps/{appId}/webhooks |
|
161
|
+
*SmoochApi::WebhookApi* | [**delete_webhook**](docs/WebhookApi.md#delete_webhook) | **DELETE** /v1.1/apps/{appId}/webhooks/{webhookId} |
|
162
|
+
*SmoochApi::WebhookApi* | [**get_webhook**](docs/WebhookApi.md#get_webhook) | **GET** /v1.1/apps/{appId}/webhooks/{webhookId} |
|
163
|
+
*SmoochApi::WebhookApi* | [**list_webhooks**](docs/WebhookApi.md#list_webhooks) | **GET** /v1.1/apps/{appId}/webhooks |
|
164
|
+
*SmoochApi::WebhookApi* | [**update_webhook**](docs/WebhookApi.md#update_webhook) | **PUT** /v1.1/apps/{appId}/webhooks/{webhookId} |
|
156
165
|
|
157
166
|
|
158
167
|
## Documentation for Models
|
data/docs/AppApi.md
CHANGED
@@ -4,16 +4,16 @@ All URIs are relative to *https://api.smooch.io*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**create_app**](AppApi.md#create_app) | **POST** /v1/apps |
|
8
|
-
[**create_secret_key**](AppApi.md#create_secret_key) | **POST** /v1/apps/{appId}/keys |
|
9
|
-
[**delete_app**](AppApi.md#delete_app) | **DELETE** /v1/apps/{appId} |
|
10
|
-
[**delete_secret_key**](AppApi.md#delete_secret_key) | **DELETE** /v1/apps/{appId}/keys/{keyId} |
|
11
|
-
[**get_app**](AppApi.md#get_app) | **GET** /v1/apps/{appId} |
|
12
|
-
[**get_app_jwt**](AppApi.md#get_app_jwt) | **GET** /v1/apps/{appId}/keys/{keyId}/jwt |
|
13
|
-
[**get_secret_key**](AppApi.md#get_secret_key) | **GET** /v1/apps/{appId}/keys/{keyId} |
|
14
|
-
[**list_apps**](AppApi.md#list_apps) | **GET** /v1/apps |
|
15
|
-
[**list_secret_keys**](AppApi.md#list_secret_keys) | **GET** /v1/apps/{appId}/keys |
|
16
|
-
[**update_app**](AppApi.md#update_app) | **PUT** /v1/apps/{appId} |
|
7
|
+
[**create_app**](AppApi.md#create_app) | **POST** /v1.1/apps |
|
8
|
+
[**create_secret_key**](AppApi.md#create_secret_key) | **POST** /v1.1/apps/{appId}/keys |
|
9
|
+
[**delete_app**](AppApi.md#delete_app) | **DELETE** /v1.1/apps/{appId} |
|
10
|
+
[**delete_secret_key**](AppApi.md#delete_secret_key) | **DELETE** /v1.1/apps/{appId}/keys/{keyId} |
|
11
|
+
[**get_app**](AppApi.md#get_app) | **GET** /v1.1/apps/{appId} |
|
12
|
+
[**get_app_jwt**](AppApi.md#get_app_jwt) | **GET** /v1.1/apps/{appId}/keys/{keyId}/jwt |
|
13
|
+
[**get_secret_key**](AppApi.md#get_secret_key) | **GET** /v1.1/apps/{appId}/keys/{keyId} |
|
14
|
+
[**list_apps**](AppApi.md#list_apps) | **GET** /v1.1/apps |
|
15
|
+
[**list_secret_keys**](AppApi.md#list_secret_keys) | **GET** /v1.1/apps/{appId}/keys |
|
16
|
+
[**update_app**](AppApi.md#update_app) | **PUT** /v1.1/apps/{appId} |
|
17
17
|
|
18
18
|
|
19
19
|
# **create_app**
|
data/docs/AppUser.md
CHANGED
@@ -11,7 +11,6 @@ Name | Type | Description | Notes
|
|
11
11
|
**signed_up_at** | **String** | A datetime string with the format *yyyy-mm-ddThh:mm:ssZ* representing the moment an appUser was created. | [optional]
|
12
12
|
**properties** | **Object** | Custom properties for the app user. |
|
13
13
|
**conversation_started** | **BOOLEAN** | Flag indicating if the conversation has started for the app user. |
|
14
|
-
**credential_required** | **BOOLEAN** | Flag indicating if the appUser is secured by a JSON Web Token or not. | [optional]
|
15
14
|
**clients** | [**Array<Client>**](Client.md) | List of clients associated with the app user. | [optional]
|
16
15
|
**pending_clients** | [**Array<Client>**](Client.md) | As clients, but containing linked clients which have not been confirmed yet (i.e. Twilio SMS). | [optional]
|
17
16
|
|
data/docs/AppUserApi.md
CHANGED
@@ -4,18 +4,18 @@ All URIs are relative to *https://api.smooch.io*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**delete_app_user**](AppUserApi.md#delete_app_user) | **DELETE** /v1/apps/{appId}/appusers/{userId} |
|
8
|
-
[**delete_app_user_profile**](AppUserApi.md#delete_app_user_profile) | **DELETE** /v1/apps/{appId}/appusers/{userId}/profile |
|
9
|
-
[**get_app_user**](AppUserApi.md#get_app_user) | **GET** /v1/apps/{appId}/appusers/{userId} |
|
10
|
-
[**get_app_user_auth_code**](AppUserApi.md#get_app_user_auth_code) | **GET** /v1/apps/{appId}/appusers/{userId}/authcode |
|
11
|
-
[**get_app_user_business_system_ids**](AppUserApi.md#get_app_user_business_system_ids) | **GET** /v1/apps/{appId}/appusers/{userId}/businesssystems |
|
12
|
-
[**get_app_user_entity_ids**](AppUserApi.md#get_app_user_entity_ids) | **GET** /v1/apps/{appId}/appusers/{userId}/channels |
|
13
|
-
[**get_link_requests**](AppUserApi.md#get_link_requests) | **GET** /v1/apps/{appId}/appusers/{userId}/linkrequest |
|
14
|
-
[**link_app_user**](AppUserApi.md#link_app_user) | **POST** /v1/apps/{appId}/appusers/{userId}/channels |
|
15
|
-
[**post_image_message**](AppUserApi.md#post_image_message) | **POST** /v1/apps/{appId}/appusers/{userId}/images |
|
16
|
-
[**pre_create_app_user**](AppUserApi.md#pre_create_app_user) | **POST** /v1/apps/{appId}/appusers |
|
17
|
-
[**unlink_app_user**](AppUserApi.md#unlink_app_user) | **DELETE** /v1/apps/{appId}/appusers/{userId}/channels/{channel} |
|
18
|
-
[**update_app_user**](AppUserApi.md#update_app_user) | **PUT** /v1/apps/{appId}/appusers/{userId} |
|
7
|
+
[**delete_app_user**](AppUserApi.md#delete_app_user) | **DELETE** /v1.1/apps/{appId}/appusers/{userId} |
|
8
|
+
[**delete_app_user_profile**](AppUserApi.md#delete_app_user_profile) | **DELETE** /v1.1/apps/{appId}/appusers/{userId}/profile |
|
9
|
+
[**get_app_user**](AppUserApi.md#get_app_user) | **GET** /v1.1/apps/{appId}/appusers/{userId} |
|
10
|
+
[**get_app_user_auth_code**](AppUserApi.md#get_app_user_auth_code) | **GET** /v1.1/apps/{appId}/appusers/{userId}/authcode |
|
11
|
+
[**get_app_user_business_system_ids**](AppUserApi.md#get_app_user_business_system_ids) | **GET** /v1.1/apps/{appId}/appusers/{userId}/businesssystems |
|
12
|
+
[**get_app_user_entity_ids**](AppUserApi.md#get_app_user_entity_ids) | **GET** /v1.1/apps/{appId}/appusers/{userId}/channels |
|
13
|
+
[**get_link_requests**](AppUserApi.md#get_link_requests) | **GET** /v1.1/apps/{appId}/appusers/{userId}/linkrequest |
|
14
|
+
[**link_app_user**](AppUserApi.md#link_app_user) | **POST** /v1.1/apps/{appId}/appusers/{userId}/channels |
|
15
|
+
[**post_image_message**](AppUserApi.md#post_image_message) | **POST** /v1.1/apps/{appId}/appusers/{userId}/images |
|
16
|
+
[**pre_create_app_user**](AppUserApi.md#pre_create_app_user) | **POST** /v1.1/apps/{appId}/appusers |
|
17
|
+
[**unlink_app_user**](AppUserApi.md#unlink_app_user) | **DELETE** /v1.1/apps/{appId}/appusers/{userId}/channels/{channel} |
|
18
|
+
[**update_app_user**](AppUserApi.md#update_app_user) | **PUT** /v1.1/apps/{appId}/appusers/{userId} |
|
19
19
|
|
20
20
|
|
21
21
|
# **delete_app_user**
|
data/docs/AppUserLink.md
CHANGED
@@ -9,7 +9,6 @@ Name | Type | Description | Notes
|
|
9
9
|
**given_name** | **String** | A String of the appUser’s given name. Used as additional criteria to increase the likelihood of a match. (Optional) Used for *messenger* linking. | [optional]
|
10
10
|
**surname** | **String** | A String of the appUser’s surname. Used as additional criteria to increase the likelihood of a match. (Optional) Used for *messenger* linking. | [optional]
|
11
11
|
**subject** | **String** | Subject for the outgoing email. (Optional) Used for *mailgun* linking. | [optional]
|
12
|
-
**skip_confirmation** | **String** | (Deprecated, use confirmation instead) Flag indicating if the linking confirmation should be skipped. | [optional]
|
13
12
|
**confirmation** | [**Confirmation**](Confirmation.md) | Allows you to specify the strategy used to initiate a link with the target user. |
|
14
13
|
|
15
14
|
|
data/docs/AppUserPreCreate.md
CHANGED
@@ -4,7 +4,6 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**user_id** | **String** | The app user's userId. This ID is specified by the appMaker. |
|
7
|
-
**credential_required** | **BOOLEAN** | Flag indicating if the appUser is secured by a JSON Web Token or not. | [optional]
|
8
7
|
**given_name** | **String** | The app user's given name. | [optional]
|
9
8
|
**surname** | **String** | The app user's surname. | [optional]
|
10
9
|
**email** | **String** | The app user's email. | [optional]
|
data/docs/AttachmentsApi.md
CHANGED
@@ -4,8 +4,8 @@ All URIs are relative to *https://api.smooch.io*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**remove_attachment**](AttachmentsApi.md#remove_attachment) | **POST** /v1/apps/{appId}/attachments/remove |
|
8
|
-
[**upload_attachment**](AttachmentsApi.md#upload_attachment) | **POST** /v1/apps/{appId}/attachments |
|
7
|
+
[**remove_attachment**](AttachmentsApi.md#remove_attachment) | **POST** /v1.1/apps/{appId}/attachments/remove |
|
8
|
+
[**upload_attachment**](AttachmentsApi.md#upload_attachment) | **POST** /v1.1/apps/{appId}/attachments |
|
9
9
|
|
10
10
|
|
11
11
|
# **remove_attachment**
|
data/docs/ConversationApi.md
CHANGED
@@ -4,12 +4,12 @@ All URIs are relative to *https://api.smooch.io*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**delete_message**](ConversationApi.md#delete_message) | **DELETE** /v1/apps/{appId}/appusers/{userId}/messages/{messageId} |
|
8
|
-
[**delete_messages**](ConversationApi.md#delete_messages) | **DELETE** /v1/apps/{appId}/appusers/{userId}/messages |
|
9
|
-
[**get_messages**](ConversationApi.md#get_messages) | **GET** /v1/apps/{appId}/appusers/{userId}/messages |
|
10
|
-
[**post_message**](ConversationApi.md#post_message) | **POST** /v1/apps/{appId}/appusers/{userId}/messages |
|
11
|
-
[**reset_unread_count**](ConversationApi.md#reset_unread_count) | **POST** /v1/apps/{appId}/appusers/{userId}/conversation/read |
|
12
|
-
[**trigger_typing_activity**](ConversationApi.md#trigger_typing_activity) | **POST** /v1/apps/{appId}/appusers/{userId}/conversation/activity |
|
7
|
+
[**delete_message**](ConversationApi.md#delete_message) | **DELETE** /v1.1/apps/{appId}/appusers/{userId}/messages/{messageId} |
|
8
|
+
[**delete_messages**](ConversationApi.md#delete_messages) | **DELETE** /v1.1/apps/{appId}/appusers/{userId}/messages |
|
9
|
+
[**get_messages**](ConversationApi.md#get_messages) | **GET** /v1.1/apps/{appId}/appusers/{userId}/messages |
|
10
|
+
[**post_message**](ConversationApi.md#post_message) | **POST** /v1.1/apps/{appId}/appusers/{userId}/messages |
|
11
|
+
[**reset_unread_count**](ConversationApi.md#reset_unread_count) | **POST** /v1.1/apps/{appId}/appusers/{userId}/conversation/read |
|
12
|
+
[**trigger_typing_activity**](ConversationApi.md#trigger_typing_activity) | **POST** /v1.1/apps/{appId}/appusers/{userId}/conversation/activity |
|
13
13
|
|
14
14
|
|
15
15
|
# **delete_message**
|
data/docs/IntegrationApi.md
CHANGED
@@ -4,16 +4,16 @@ All URIs are relative to *https://api.smooch.io*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**create_integration**](IntegrationApi.md#create_integration) | **POST** /v1/apps/{appId}/integrations |
|
8
|
-
[**create_integration_menu**](IntegrationApi.md#create_integration_menu) | **POST** /v1/apps/{appId}/integrations/{integrationId}/menu |
|
9
|
-
[**delete_integration**](IntegrationApi.md#delete_integration) | **DELETE** /v1/apps/{appId}/integrations/{integrationId} |
|
10
|
-
[**delete_integration_menu**](IntegrationApi.md#delete_integration_menu) | **DELETE** /v1/apps/{appId}/integrations/{integrationId}/menu |
|
11
|
-
[**get_integration**](IntegrationApi.md#get_integration) | **GET** /v1/apps/{appId}/integrations/{integrationId} |
|
12
|
-
[**get_integration_menu**](IntegrationApi.md#get_integration_menu) | **GET** /v1/apps/{appId}/integrations/{integrationId}/menu |
|
13
|
-
[**list_integrations**](IntegrationApi.md#list_integrations) | **GET** /v1/apps/{appId}/integrations |
|
14
|
-
[**update_integration**](IntegrationApi.md#update_integration) | **PUT** /v1/apps/{appId}/integrations/{integrationId} |
|
15
|
-
[**update_integration_menu**](IntegrationApi.md#update_integration_menu) | **PUT** /v1/apps/{appId}/integrations/{integrationId}/menu |
|
16
|
-
[**update_integration_profile**](IntegrationApi.md#update_integration_profile) | **PUT** /v1/apps/{appId}/integrations/{integrationId}/profile |
|
7
|
+
[**create_integration**](IntegrationApi.md#create_integration) | **POST** /v1.1/apps/{appId}/integrations |
|
8
|
+
[**create_integration_menu**](IntegrationApi.md#create_integration_menu) | **POST** /v1.1/apps/{appId}/integrations/{integrationId}/menu |
|
9
|
+
[**delete_integration**](IntegrationApi.md#delete_integration) | **DELETE** /v1.1/apps/{appId}/integrations/{integrationId} |
|
10
|
+
[**delete_integration_menu**](IntegrationApi.md#delete_integration_menu) | **DELETE** /v1.1/apps/{appId}/integrations/{integrationId}/menu |
|
11
|
+
[**get_integration**](IntegrationApi.md#get_integration) | **GET** /v1.1/apps/{appId}/integrations/{integrationId} |
|
12
|
+
[**get_integration_menu**](IntegrationApi.md#get_integration_menu) | **GET** /v1.1/apps/{appId}/integrations/{integrationId}/menu |
|
13
|
+
[**list_integrations**](IntegrationApi.md#list_integrations) | **GET** /v1.1/apps/{appId}/integrations |
|
14
|
+
[**update_integration**](IntegrationApi.md#update_integration) | **PUT** /v1.1/apps/{appId}/integrations/{integrationId} |
|
15
|
+
[**update_integration_menu**](IntegrationApi.md#update_integration_menu) | **PUT** /v1.1/apps/{appId}/integrations/{integrationId}/menu |
|
16
|
+
[**update_integration_profile**](IntegrationApi.md#update_integration_profile) | **PUT** /v1.1/apps/{appId}/integrations/{integrationId}/profile |
|
17
17
|
|
18
18
|
|
19
19
|
# **create_integration**
|
data/docs/MenuApi.md
CHANGED
@@ -4,9 +4,9 @@ All URIs are relative to *https://api.smooch.io*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**delete_menu**](MenuApi.md#delete_menu) | **DELETE** /v1/apps/{appId}/menu |
|
8
|
-
[**get_menu**](MenuApi.md#get_menu) | **GET** /v1/apps/{appId}/menu |
|
9
|
-
[**update_menu**](MenuApi.md#update_menu) | **PUT** /v1/apps/{appId}/menu |
|
7
|
+
[**delete_menu**](MenuApi.md#delete_menu) | **DELETE** /v1.1/apps/{appId}/menu |
|
8
|
+
[**get_menu**](MenuApi.md#get_menu) | **GET** /v1.1/apps/{appId}/menu |
|
9
|
+
[**update_menu**](MenuApi.md#update_menu) | **PUT** /v1.1/apps/{appId}/menu |
|
10
10
|
|
11
11
|
|
12
12
|
# **delete_menu**
|
data/docs/ServiceAccountApi.md
CHANGED
@@ -4,16 +4,16 @@ All URIs are relative to *https://api.smooch.io*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**create_secret_key**](ServiceAccountApi.md#create_secret_key) | **POST** /v1/serviceaccounts/{serviceAccountId}/keys |
|
8
|
-
[**create_service_account**](ServiceAccountApi.md#create_service_account) | **POST** /v1/serviceaccounts |
|
9
|
-
[**delete_secret_key**](ServiceAccountApi.md#delete_secret_key) | **DELETE** /v1/serviceaccounts/{serviceAccountId}/keys/{keyId} |
|
10
|
-
[**delete_service_account**](ServiceAccountApi.md#delete_service_account) | **DELETE** /v1/serviceaccounts/{serviceAccountId} |
|
11
|
-
[**get_jwt**](ServiceAccountApi.md#get_jwt) | **GET** /v1/serviceaccounts/{serviceAccountId}/keys/{keyId}/jwt |
|
12
|
-
[**get_secret_key**](ServiceAccountApi.md#get_secret_key) | **GET** /v1/serviceaccounts/{serviceAccountId}/keys/{keyId} |
|
13
|
-
[**get_service_account**](ServiceAccountApi.md#get_service_account) | **GET** /v1/serviceaccounts/{serviceAccountId} |
|
14
|
-
[**list_secret_keys**](ServiceAccountApi.md#list_secret_keys) | **GET** /v1/serviceaccounts/{serviceAccountId}/keys |
|
15
|
-
[**list_service_accounts**](ServiceAccountApi.md#list_service_accounts) | **GET** /v1/serviceaccounts |
|
16
|
-
[**update_service_account**](ServiceAccountApi.md#update_service_account) | **PUT** /v1/serviceaccounts/{serviceAccountId} |
|
7
|
+
[**create_secret_key**](ServiceAccountApi.md#create_secret_key) | **POST** /v1.1/serviceaccounts/{serviceAccountId}/keys |
|
8
|
+
[**create_service_account**](ServiceAccountApi.md#create_service_account) | **POST** /v1.1/serviceaccounts |
|
9
|
+
[**delete_secret_key**](ServiceAccountApi.md#delete_secret_key) | **DELETE** /v1.1/serviceaccounts/{serviceAccountId}/keys/{keyId} |
|
10
|
+
[**delete_service_account**](ServiceAccountApi.md#delete_service_account) | **DELETE** /v1.1/serviceaccounts/{serviceAccountId} |
|
11
|
+
[**get_jwt**](ServiceAccountApi.md#get_jwt) | **GET** /v1.1/serviceaccounts/{serviceAccountId}/keys/{keyId}/jwt |
|
12
|
+
[**get_secret_key**](ServiceAccountApi.md#get_secret_key) | **GET** /v1.1/serviceaccounts/{serviceAccountId}/keys/{keyId} |
|
13
|
+
[**get_service_account**](ServiceAccountApi.md#get_service_account) | **GET** /v1.1/serviceaccounts/{serviceAccountId} |
|
14
|
+
[**list_secret_keys**](ServiceAccountApi.md#list_secret_keys) | **GET** /v1.1/serviceaccounts/{serviceAccountId}/keys |
|
15
|
+
[**list_service_accounts**](ServiceAccountApi.md#list_service_accounts) | **GET** /v1.1/serviceaccounts |
|
16
|
+
[**update_service_account**](ServiceAccountApi.md#update_service_account) | **PUT** /v1.1/serviceaccounts/{serviceAccountId} |
|
17
17
|
|
18
18
|
|
19
19
|
# **create_secret_key**
|
data/docs/TemplateApi.md
CHANGED
@@ -4,11 +4,11 @@ All URIs are relative to *https://api.smooch.io*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**create_template**](TemplateApi.md#create_template) | **POST** /v1/apps/{appId}/templates |
|
8
|
-
[**delete_template**](TemplateApi.md#delete_template) | **DELETE** /v1/apps/{appId}/templates/{templateId} |
|
9
|
-
[**get_template**](TemplateApi.md#get_template) | **GET** /v1/apps/{appId}/templates/{templateId} |
|
10
|
-
[**list_templates**](TemplateApi.md#list_templates) | **GET** /v1/apps/{appId}/templates |
|
11
|
-
[**update_template**](TemplateApi.md#update_template) | **PUT** /v1/apps/{appId}/templates/{templateId} |
|
7
|
+
[**create_template**](TemplateApi.md#create_template) | **POST** /v1.1/apps/{appId}/templates |
|
8
|
+
[**delete_template**](TemplateApi.md#delete_template) | **DELETE** /v1.1/apps/{appId}/templates/{templateId} |
|
9
|
+
[**get_template**](TemplateApi.md#get_template) | **GET** /v1.1/apps/{appId}/templates/{templateId} |
|
10
|
+
[**list_templates**](TemplateApi.md#list_templates) | **GET** /v1.1/apps/{appId}/templates |
|
11
|
+
[**update_template**](TemplateApi.md#update_template) | **PUT** /v1.1/apps/{appId}/templates/{templateId} |
|
12
12
|
|
13
13
|
|
14
14
|
# **create_template**
|
data/docs/WebhookApi.md
CHANGED
@@ -4,11 +4,11 @@ All URIs are relative to *https://api.smooch.io*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**create_webhook**](WebhookApi.md#create_webhook) | **POST** /v1/apps/{appId}/webhooks |
|
8
|
-
[**delete_webhook**](WebhookApi.md#delete_webhook) | **DELETE** /v1/apps/{appId}/webhooks/{webhookId} |
|
9
|
-
[**get_webhook**](WebhookApi.md#get_webhook) | **GET** /v1/apps/{appId}/webhooks/{webhookId} |
|
10
|
-
[**list_webhooks**](WebhookApi.md#list_webhooks) | **GET** /v1/apps/{appId}/webhooks |
|
11
|
-
[**update_webhook**](WebhookApi.md#update_webhook) | **PUT** /v1/apps/{appId}/webhooks/{webhookId} |
|
7
|
+
[**create_webhook**](WebhookApi.md#create_webhook) | **POST** /v1.1/apps/{appId}/webhooks |
|
8
|
+
[**delete_webhook**](WebhookApi.md#delete_webhook) | **DELETE** /v1.1/apps/{appId}/webhooks/{webhookId} |
|
9
|
+
[**get_webhook**](WebhookApi.md#get_webhook) | **GET** /v1.1/apps/{appId}/webhooks/{webhookId} |
|
10
|
+
[**list_webhooks**](WebhookApi.md#list_webhooks) | **GET** /v1.1/apps/{appId}/webhooks |
|
11
|
+
[**update_webhook**](WebhookApi.md#update_webhook) | **PUT** /v1.1/apps/{appId}/webhooks/{webhookId} |
|
12
12
|
|
13
13
|
|
14
14
|
# **create_webhook**
|
data/lib/smooch-api.rb
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#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).
|
5
5
|
|
6
|
-
OpenAPI spec version:
|
6
|
+
OpenAPI spec version: 4.0
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
Swagger Codegen version: 2.2.3-SNAPSHOT
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#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).
|
5
5
|
|
6
|
-
OpenAPI spec version:
|
6
|
+
OpenAPI spec version: 4.0
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
Swagger Codegen version: 2.2.3-SNAPSHOT
|
@@ -44,7 +44,7 @@ module SmoochApi
|
|
44
44
|
fail ArgumentError, "Missing the required parameter 'app_create_body' when calling AppApi.create_app"
|
45
45
|
end
|
46
46
|
# resource path
|
47
|
-
local_var_path = "/v1/apps"
|
47
|
+
local_var_path = "/v1.1/apps"
|
48
48
|
|
49
49
|
# query parameters
|
50
50
|
query_params = {}
|
@@ -105,7 +105,7 @@ module SmoochApi
|
|
105
105
|
fail ArgumentError, "Missing the required parameter 'secret_key_create_body' when calling AppApi.create_secret_key"
|
106
106
|
end
|
107
107
|
# resource path
|
108
|
-
local_var_path = "/v1/apps/{appId}/keys".sub('{' + 'appId' + '}', app_id.to_s)
|
108
|
+
local_var_path = "/v1.1/apps/{appId}/keys".sub('{' + 'appId' + '}', app_id.to_s)
|
109
109
|
|
110
110
|
# query parameters
|
111
111
|
query_params = {}
|
@@ -160,7 +160,7 @@ module SmoochApi
|
|
160
160
|
fail ArgumentError, "Missing the required parameter 'app_id' when calling AppApi.delete_app"
|
161
161
|
end
|
162
162
|
# resource path
|
163
|
-
local_var_path = "/v1/apps/{appId}".sub('{' + 'appId' + '}', app_id.to_s)
|
163
|
+
local_var_path = "/v1.1/apps/{appId}".sub('{' + 'appId' + '}', app_id.to_s)
|
164
164
|
|
165
165
|
# query parameters
|
166
166
|
query_params = {}
|
@@ -220,7 +220,7 @@ module SmoochApi
|
|
220
220
|
fail ArgumentError, "Missing the required parameter 'key_id' when calling AppApi.delete_secret_key"
|
221
221
|
end
|
222
222
|
# resource path
|
223
|
-
local_var_path = "/v1/apps/{appId}/keys/{keyId}".sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'keyId' + '}', key_id.to_s)
|
223
|
+
local_var_path = "/v1.1/apps/{appId}/keys/{keyId}".sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'keyId' + '}', key_id.to_s)
|
224
224
|
|
225
225
|
# query parameters
|
226
226
|
query_params = {}
|
@@ -274,7 +274,7 @@ module SmoochApi
|
|
274
274
|
fail ArgumentError, "Missing the required parameter 'app_id' when calling AppApi.get_app"
|
275
275
|
end
|
276
276
|
# resource path
|
277
|
-
local_var_path = "/v1/apps/{appId}".sub('{' + 'appId' + '}', app_id.to_s)
|
277
|
+
local_var_path = "/v1.1/apps/{appId}".sub('{' + 'appId' + '}', app_id.to_s)
|
278
278
|
|
279
279
|
# query parameters
|
280
280
|
query_params = {}
|
@@ -335,7 +335,7 @@ module SmoochApi
|
|
335
335
|
fail ArgumentError, "Missing the required parameter 'key_id' when calling AppApi.get_app_jwt"
|
336
336
|
end
|
337
337
|
# resource path
|
338
|
-
local_var_path = "/v1/apps/{appId}/keys/{keyId}/jwt".sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'keyId' + '}', key_id.to_s)
|
338
|
+
local_var_path = "/v1.1/apps/{appId}/keys/{keyId}/jwt".sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'keyId' + '}', key_id.to_s)
|
339
339
|
|
340
340
|
# query parameters
|
341
341
|
query_params = {}
|
@@ -396,7 +396,7 @@ module SmoochApi
|
|
396
396
|
fail ArgumentError, "Missing the required parameter 'key_id' when calling AppApi.get_secret_key"
|
397
397
|
end
|
398
398
|
# resource path
|
399
|
-
local_var_path = "/v1/apps/{appId}/keys/{keyId}".sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'keyId' + '}', key_id.to_s)
|
399
|
+
local_var_path = "/v1.1/apps/{appId}/keys/{keyId}".sub('{' + 'appId' + '}', app_id.to_s).sub('{' + 'keyId' + '}', key_id.to_s)
|
400
400
|
|
401
401
|
# query parameters
|
402
402
|
query_params = {}
|
@@ -451,7 +451,7 @@ module SmoochApi
|
|
451
451
|
@api_client.config.logger.debug "Calling API: AppApi.list_apps ..."
|
452
452
|
end
|
453
453
|
# resource path
|
454
|
-
local_var_path = "/v1/apps"
|
454
|
+
local_var_path = "/v1.1/apps"
|
455
455
|
|
456
456
|
# query parameters
|
457
457
|
query_params = {}
|
@@ -509,7 +509,7 @@ module SmoochApi
|
|
509
509
|
fail ArgumentError, "Missing the required parameter 'app_id' when calling AppApi.list_secret_keys"
|
510
510
|
end
|
511
511
|
# resource path
|
512
|
-
local_var_path = "/v1/apps/{appId}/keys".sub('{' + 'appId' + '}', app_id.to_s)
|
512
|
+
local_var_path = "/v1.1/apps/{appId}/keys".sub('{' + 'appId' + '}', app_id.to_s)
|
513
513
|
|
514
514
|
# query parameters
|
515
515
|
query_params = {}
|
@@ -570,7 +570,7 @@ module SmoochApi
|
|
570
570
|
fail ArgumentError, "Missing the required parameter 'app_update_body' when calling AppApi.update_app"
|
571
571
|
end
|
572
572
|
# resource path
|
573
|
-
local_var_path = "/v1/apps/{appId}".sub('{' + 'appId' + '}', app_id.to_s)
|
573
|
+
local_var_path = "/v1.1/apps/{appId}".sub('{' + 'appId' + '}', app_id.to_s)
|
574
574
|
|
575
575
|
# query parameters
|
576
576
|
query_params = {}
|