smooch-api 4.1.0 → 4.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (137) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -3
  3. data/docs/Action.md +2 -2
  4. data/docs/App.md +2 -2
  5. data/docs/AppApi.md +48 -48
  6. data/docs/AppSettings.md +2 -2
  7. data/docs/AppUser.md +6 -6
  8. data/docs/AppUserApi.md +78 -78
  9. data/docs/AppUserBusinessSystemsResponse.md +1 -1
  10. data/docs/AppUserLink.md +2 -2
  11. data/docs/AppUserPreCreate.md +3 -3
  12. data/docs/AppUserResponse.md +1 -1
  13. data/docs/AppUserUpdate.md +2 -2
  14. data/docs/AttachmentRemove.md +1 -1
  15. data/docs/AttachmentResponse.md +2 -2
  16. data/docs/AttachmentsApi.md +16 -16
  17. data/docs/AuthCodeResponse.md +1 -1
  18. data/docs/BusinessSystemItem.md +4 -4
  19. data/docs/ChannelEntityItem.md +3 -3
  20. data/docs/Client.md +4 -4
  21. data/docs/ClientInfo.md +8 -8
  22. data/docs/Conversation.md +2 -2
  23. data/docs/ConversationApi.md +42 -42
  24. data/docs/Destination.md +2 -2
  25. data/docs/DisplaySettings.md +1 -1
  26. data/docs/GetMessagesResponse.md +1 -1
  27. data/docs/Integration.md +44 -44
  28. data/docs/IntegrationApi.md +66 -66
  29. data/docs/IntegrationCreate.md +36 -36
  30. data/docs/IntegrationProfileUpdate.md +1 -1
  31. data/docs/IntegrationUpdate.md +16 -16
  32. data/docs/LinkRequestResponse.md +1 -1
  33. data/docs/LinkRequestResponseLinkRequests.md +1 -1
  34. data/docs/ListAppsResponse.md +1 -1
  35. data/docs/ListServiceAccountsResponse.md +2 -2
  36. data/docs/ListTemplatesResponse.md +1 -1
  37. data/docs/MenuApi.md +14 -14
  38. data/docs/Message.md +6 -6
  39. data/docs/MessageItem.md +2 -2
  40. data/docs/MessageOverride.md +8 -0
  41. data/docs/MessageOverrideWhatsapp.md +8 -0
  42. data/docs/MessagePost.md +4 -3
  43. data/docs/MessageResponse.md +1 -1
  44. data/docs/SecretKey.md +1 -1
  45. data/docs/ServiceAccount.md +1 -1
  46. data/docs/ServiceAccountApi.md +46 -46
  47. data/docs/ServiceAccountResponse.md +1 -1
  48. data/docs/Template.md +1 -1
  49. data/docs/TemplateApi.md +30 -30
  50. data/docs/TypingActivityTrigger.md +1 -1
  51. data/docs/Webhook.md +1 -1
  52. data/docs/WebhookApi.md +30 -30
  53. data/lib/smooch-api.rb +3 -1
  54. data/lib/smooch-api/api/app_api.rb +112 -112
  55. data/lib/smooch-api/api/app_user_api.rb +190 -190
  56. data/lib/smooch-api/api/attachments_api.rb +34 -34
  57. data/lib/smooch-api/api/conversation_api.rb +102 -102
  58. data/lib/smooch-api/api/integration_api.rb +161 -161
  59. data/lib/smooch-api/api/menu_api.rb +34 -34
  60. data/lib/smooch-api/api/service_account_api.rb +109 -109
  61. data/lib/smooch-api/api/template_api.rb +73 -73
  62. data/lib/smooch-api/api/webhook_api.rb +73 -73
  63. data/lib/smooch-api/api_client.rb +1 -1
  64. data/lib/smooch-api/api_error.rb +1 -1
  65. data/lib/smooch-api/configuration.rb +1 -1
  66. data/lib/smooch-api/models/action.rb +12 -12
  67. data/lib/smooch-api/models/app.rb +18 -18
  68. data/lib/smooch-api/models/app_create.rb +1 -1
  69. data/lib/smooch-api/models/app_response.rb +1 -1
  70. data/lib/smooch-api/models/app_settings.rb +12 -12
  71. data/lib/smooch-api/models/app_update.rb +1 -1
  72. data/lib/smooch-api/models/app_user.rb +38 -38
  73. data/lib/smooch-api/models/app_user_business_systems_response.rb +10 -10
  74. data/lib/smooch-api/models/app_user_channels_response.rb +1 -1
  75. data/lib/smooch-api/models/app_user_link.rb +12 -12
  76. data/lib/smooch-api/models/app_user_pre_create.rb +20 -20
  77. data/lib/smooch-api/models/app_user_response.rb +10 -10
  78. data/lib/smooch-api/models/app_user_update.rb +12 -12
  79. data/lib/smooch-api/models/attachment_remove.rb +10 -10
  80. data/lib/smooch-api/models/attachment_response.rb +18 -18
  81. data/lib/smooch-api/models/auth_code_response.rb +10 -10
  82. data/lib/smooch-api/models/business_system_item.rb +22 -22
  83. data/lib/smooch-api/models/channel_entity_item.rb +17 -17
  84. data/lib/smooch-api/models/client.rb +22 -22
  85. data/lib/smooch-api/models/client_info.rb +42 -42
  86. data/lib/smooch-api/models/confirmation.rb +1 -1
  87. data/lib/smooch-api/models/conversation.rb +18 -18
  88. data/lib/smooch-api/models/destination.rb +18 -18
  89. data/lib/smooch-api/models/display_settings.rb +7 -7
  90. data/lib/smooch-api/models/get_messages_response.rb +7 -7
  91. data/lib/smooch-api/models/integration.rb +225 -225
  92. data/lib/smooch-api/models/integration_create.rb +182 -182
  93. data/lib/smooch-api/models/integration_profile_update.rb +7 -7
  94. data/lib/smooch-api/models/integration_response.rb +1 -1
  95. data/lib/smooch-api/models/integration_update.rb +82 -82
  96. data/lib/smooch-api/models/jwt_response.rb +1 -1
  97. data/lib/smooch-api/models/link_request_response.rb +7 -7
  98. data/lib/smooch-api/models/link_request_response_link_requests.rb +10 -10
  99. data/lib/smooch-api/models/list_apps_response.rb +7 -7
  100. data/lib/smooch-api/models/list_integrations_response.rb +1 -1
  101. data/lib/smooch-api/models/list_secret_keys_response.rb +1 -1
  102. data/lib/smooch-api/models/list_service_accounts_response.rb +12 -12
  103. data/lib/smooch-api/models/list_templates_response.rb +7 -7
  104. data/lib/smooch-api/models/list_webhooks_response.rb +1 -1
  105. data/lib/smooch-api/models/menu.rb +1 -1
  106. data/lib/smooch-api/models/menu_item.rb +1 -1
  107. data/lib/smooch-api/models/menu_response.rb +1 -1
  108. data/lib/smooch-api/models/message.rb +41 -41
  109. data/lib/smooch-api/models/message_item.rb +12 -12
  110. data/lib/smooch-api/models/message_override.rb +188 -0
  111. data/lib/smooch-api/models/message_override_whatsapp.rb +189 -0
  112. data/lib/smooch-api/models/message_post.rb +30 -20
  113. data/lib/smooch-api/models/message_response.rb +7 -7
  114. data/lib/smooch-api/models/secret_key.rb +10 -10
  115. data/lib/smooch-api/models/secret_key_create.rb +1 -1
  116. data/lib/smooch-api/models/secret_key_response.rb +1 -1
  117. data/lib/smooch-api/models/service_account.rb +10 -10
  118. data/lib/smooch-api/models/service_account_create.rb +1 -1
  119. data/lib/smooch-api/models/service_account_response.rb +7 -7
  120. data/lib/smooch-api/models/service_account_update.rb +1 -1
  121. data/lib/smooch-api/models/source.rb +1 -1
  122. data/lib/smooch-api/models/sub_menu_item.rb +1 -1
  123. data/lib/smooch-api/models/template.rb +10 -10
  124. data/lib/smooch-api/models/template_create.rb +1 -1
  125. data/lib/smooch-api/models/template_response.rb +1 -1
  126. data/lib/smooch-api/models/template_update.rb +1 -1
  127. data/lib/smooch-api/models/typing_activity_trigger.rb +7 -7
  128. data/lib/smooch-api/models/webhook.rb +10 -10
  129. data/lib/smooch-api/models/webhook_create.rb +1 -1
  130. data/lib/smooch-api/models/webhook_response.rb +1 -1
  131. data/lib/smooch-api/models/webhook_update.rb +1 -1
  132. data/lib/smooch-api/version.rb +2 -2
  133. data/smooch-api.gemspec +1 -1
  134. data/spec/api_client_spec.rb +1 -1
  135. data/spec/configuration_spec.rb +1 -1
  136. data/spec/spec_helper.rb +1 -1
  137. metadata +6 -2
data/docs/Destination.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **integration_id** | **String** | The ID of the target integration. |
7
- **integration_type** | **String** | The type of the target integration. |
6
+ **integrationId** | **String** | The ID of the target integration. |
7
+ **integrationType** | **String** | The type of the target integration. |
8
8
 
9
9
 
data/docs/DisplaySettings.md CHANGED
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **image_aspect_ratio** | **String** | Specifies how to display all carousel images. Valid values are *horizontal* (default) and *square*. | [optional]
6
+ **imageAspectRatio** | **String** | Specifies how to display all carousel images. Valid values are *horizontal* (default) and *square*. | [optional]
7
7
 
8
8
 
data/docs/GetMessagesResponse.md CHANGED
@@ -5,6 +5,6 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **conversation** | [**Conversation**](Conversation.md) | The conversation. | [optional]
7
7
  **messages** | [**Array<Message>**](Message.md) | The messages. | [optional]
8
- **_next** | **String** | The URI for the next set of messages in the conversation. | [optional]
8
+ **next** | **String** | The URI for the next set of messages in the conversation. | [optional]
9
9
 
10
10
 
data/docs/Integration.md CHANGED
@@ -3,61 +3,61 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **_id** | **String** | The integration ID, generated automatically. |
6
+ **id** | **String** | The integration ID, generated automatically. |
7
7
  **type** | **String** | The integration type. |
8
- **page_access_token** | **String** | Facebook Page Access Token. Required for *messenger* integrations. | [optional]
9
- **app_id** | **String** | Facebook App ID OR WeChat App ID. Required for *messenger* and *wechat* integrations. | [optional]
10
- **app_secret** | **String** | Facebook Page App Secret OR WeChat App Secret. Required for *messenger* and *wechat* integrations. | [optional]
11
- **access_token_url** | **String** | Optional endpoint to generate access tokens for WeChat. Used to coordinate API access with third party systems. | [optional]
12
- **webhook_secret** | **String** | Secret to verify webhooks. Returned on successful *wechat* and *messagebird* integrations. | [optional]
13
- **page_id** | **String** | Facebook Page App ID. Returned on successful *messenger* integrations. | [optional]
14
- **account_sid** | **String** | Twilio Account SID. Required for *twilio* integrations. | [optional]
15
- **auth_token** | **String** | Twilio Auth Token. Required for *twilio* integrations. | [optional]
16
- **phone_number_sid** | **String** | SID for specific phone number. Required for *twilio* integrations. | [optional]
17
- **phone_number** | **String** | Smooch will receive all messages sent to this phone number. Returned on successful *twilio* integrations. | [optional]
8
+ **pageAccessToken** | **String** | Facebook Page Access Token. Required for *messenger* integrations. | [optional]
9
+ **appId** | **String** | Facebook App ID OR WeChat App ID. Required for *messenger* and *wechat* integrations. | [optional]
10
+ **appSecret** | **String** | Facebook Page App Secret OR WeChat App Secret. Required for *messenger* and *wechat* integrations. | [optional]
11
+ **accessTokenUrl** | **String** | Optional endpoint to generate access tokens for WeChat. Used to coordinate API access with third party systems. | [optional]
12
+ **webhookSecret** | **String** | Secret to verify webhooks. Returned on successful *wechat* and *messagebird* integrations. | [optional]
13
+ **pageId** | **String** | Facebook Page App ID. Returned on successful *messenger* integrations. | [optional]
14
+ **accountSid** | **String** | Twilio Account SID. Required for *twilio* integrations. | [optional]
15
+ **authToken** | **String** | Twilio Auth Token. Required for *twilio* integrations. | [optional]
16
+ **phoneNumberSid** | **String** | SID for specific phone number. Required for *twilio* integrations. | [optional]
17
+ **phoneNumber** | **String** | Smooch will receive all messages sent to this phone number. Returned on successful *twilio* integrations. | [optional]
18
18
  **name** | **String** | Name on the account. Returned on successful *twilio* integrations. | [optional]
19
19
  **token** | **String** | Telegram Bot Token OR Viber Public Account token. Required for *twilio* and *viber* integrations. | [optional]
20
20
  **uri** | **String** | The viber URI to find the account. Returned on successful *viber* integrations. | [optional]
21
- **channel_id** | **String** | LINE Channel ID. Required for *line* integrations. | [optional]
22
- **channel_secret** | **String** | LINE Channel Secret. Required for *line* integrations. | [optional]
23
- **channel_access_token** | **String** | LINE Channel Access Token. Required for *line* integrations. | [optional]
24
- **bot_name** | **String** | The bot's name. Returned on successful *line* integrations. | [optional]
25
- **encoding_aes_key** | **String** | AES Encoding Key. (Optional) Used for *wechat* integrations. | [optional]
26
- **from_address** | **String** | Email will display as coming from this address. (Optional) Used for *frontendEmail* integrations. | [optional]
21
+ **channelId** | **String** | LINE Channel ID. Required for *line* integrations. | [optional]
22
+ **channelSecret** | **String** | LINE Channel Secret. Required for *line* integrations. | [optional]
23
+ **channelAccessToken** | **String** | LINE Channel Access Token. Required for *line* integrations. | [optional]
24
+ **botName** | **String** | The bot's name. Returned on successful *line* integrations. | [optional]
25
+ **encodingAesKey** | **String** | AES Encoding Key. (Optional) Used for *wechat* integrations. | [optional]
26
+ **fromAddress** | **String** | Email will display as coming from this address. (Optional) Used for *frontendEmail* integrations. | [optional]
27
27
  **certificate** | **String** | The binary of your APN certificate base64 encoded. Required for *apn* integrations. | [optional]
28
- **base_url** | **String** | Your WhatsApp API client's URL. Required for *WhatsApp* integrations. | [optional]
29
- **hsm_fallback_language** | **String** | Specification of a fallback language. (Optional) Used for *WhatsApp* integrations. | [optional]
28
+ **baseUrl** | **String** | Your WhatsApp API client's URL. Required for *WhatsApp* integrations. | [optional]
29
+ **hsmFallbackLanguage** | **String** | Specification of a fallback language. (Optional) Used for *WhatsApp* integrations. | [optional]
30
30
  **password** | **String** | The password for your APN certificate or WhatsApp API client. Required for *WhatsApp* integrations. (Optional) Used for *apn* integrations. | [optional]
31
- **auto_update_badge** | **BOOLEAN** | Use the unread count of the conversation as the application badge. (Optional) Used for *apn* integrations. | [optional]
31
+ **autoUpdateBadge** | **BOOLEAN** | Use the unread count of the conversation as the application badge. (Optional) Used for *apn* integrations. | [optional]
32
32
  **production** | **BOOLEAN** | Flag specifying whether the certificate is production. Returned on successful *apn* integrations. | [optional]
33
- **server_key** | **String** | Your server key from the fcm console. Required for *fcm* integrations. | [optional]
34
- **sender_id** | **String** | Your sender id from the fcm console. Required for *fcm* integrations. | [optional]
33
+ **serverKey** | **String** | Your server key from the fcm console. Required for *fcm* integrations. | [optional]
34
+ **senderId** | **String** | Your sender id from the fcm console. Required for *fcm* integrations. | [optional]
35
35
  **tier** | **String** | Your Twitter app’s tier. Accepted values are enterprise or premium. | [optional]
36
- **env_name** | **String** | The Twitter environment name, e.g.: env-beta. Required for *twitter* integrations with *premium* tier. | [optional]
37
- **consumer_key** | **String** | The consumer key for your Twitter app. Required for *twitter* integrations. | [optional]
38
- **consumer_secret** | **String** | The consumer secret for your Twitter app. Required for *twitter* integrations. | [optional]
39
- **access_token_key** | **String** | The access token key obtained from your user via oauth. Required for *twitter* integrations. | [optional]
40
- **access_token_secret** | **String** | The access token secret obtained from your user via oauth. Required for *twitter* integrations. | [optional]
41
- **user_id** | **String** | The twitter userId. Returned on successful *twitter* integrations. | [optional]
36
+ **envName** | **String** | The Twitter environment name, e.g.: env-beta. Required for *twitter* integrations with *premium* tier. | [optional]
37
+ **consumerKey** | **String** | The consumer key for your Twitter app. Required for *twitter* integrations. | [optional]
38
+ **consumerSecret** | **String** | The consumer secret for your Twitter app. Required for *twitter* integrations. | [optional]
39
+ **accessTokenKey** | **String** | The access token key obtained from your user via oauth. Required for *twitter* integrations. | [optional]
40
+ **accessTokenSecret** | **String** | The access token secret obtained from your user via oauth. Required for *twitter* integrations. | [optional]
41
+ **userId** | **String** | The twitter userId. Returned on successful *twitter* integrations. | [optional]
42
42
  **username** | **String** | The username for the account. Required for *WhatsApp* integrations. Returned on successful *twitter* and *telegram* integrations. | [optional]
43
- **api_key** | **String** | The public API key of your Mailgun account. Required for *mailgun* integrations. | [optional]
43
+ **apiKey** | **String** | The public API key of your Mailgun account. Required for *mailgun* integrations. | [optional]
44
44
  **domain** | **String** | The domain used to relay email. Required for *mailgun* integrations. | [optional]
45
- **incoming_address** | **String** | Smooch will receive all emails sent to this address. Required for *mailgun* integrations. | [optional]
46
- **access_key** | **String** | The public API key of your MessageBird account. Required for *messagebird* integrations. | [optional]
45
+ **incomingAddress** | **String** | Smooch will receive all emails sent to this address. Required for *mailgun* integrations. | [optional]
46
+ **accessKey** | **String** | The public API key of your MessageBird account. Required for *messagebird* integrations. | [optional]
47
47
  **originator** | **String** | Smooch will receive all messages sent to this phone number. Required for *messagebird* integrations. | [optional]
48
- **brand_color** | **String** | This color will be used in the messenger header and the button or tab in idle state. (Optional) Used for *Web Messenger* integrations. | [optional]
49
- **fixed_intro_pane** | **BOOLEAN** | When `true`, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. The default value is `false`. (Optional) Used for *Web Messenger* integrations. | [optional]
50
- **conversation_color** | **String** | This color will be used for customer messages, quick replies and actions in the footer. (Optional) Used for *Web Messenger* integrations. | [optional]
51
- **action_color** | **String** | This color will be used for call-to-actions inside your messages. (Optional) Used for *Web Messenger* integrations. | [optional]
52
- **display_style** | **String** | Choose how the messenger will appear on your website. Must be either button or tab. (Optional) Used for *Web Messenger* integrations. | [optional]
53
- **button_icon_url** | **String** | With the button style Web Messenger, you have the option of selecting your own button icon. (Optional) Used for *Web Messenger* integrations. | [optional]
54
- **button_width** | **String** | With the button style Web Messenger, you have the option of specifying its width. (Optional) Used for *Web Messenger* integrations. | [optional]
55
- **button_height** | **String** | With the button style Web Messenger, you have the option of specifying its height. (Optional) Used for *Web Messenger* integrations. | [optional]
56
- **integration_order** | **Array<String>** | Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed (Optional) Used for *Web Messenger* integrations. | [optional]
57
- **business_name** | **String** | A custom business name for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional]
58
- **business_icon_url** | **String** | A custom business icon url for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional]
59
- **background_image_url** | **String** | A custom background url for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional]
60
- **origin_whitelist** | **Array<String>** | A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454 `scheme \"://\" host [ \":\" port ]`, where scheme is `http` or `https`. (Optional) Used for *Web Messenger* integrations. | [optional]
48
+ **brandColor** | **String** | This color will be used in the messenger header and the button or tab in idle state. (Optional) Used for *Web Messenger* integrations. | [optional]
49
+ **fixedIntroPane** | **BOOLEAN** | When `true`, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. The default value is `false`. (Optional) Used for *Web Messenger* integrations. | [optional]
50
+ **conversationColor** | **String** | This color will be used for customer messages, quick replies and actions in the footer. (Optional) Used for *Web Messenger* integrations. | [optional]
51
+ **actionColor** | **String** | This color will be used for call-to-actions inside your messages. (Optional) Used for *Web Messenger* integrations. | [optional]
52
+ **displayStyle** | **String** | Choose how the messenger will appear on your website. Must be either button or tab. (Optional) Used for *Web Messenger* integrations. | [optional]
53
+ **buttonIconUrl** | **String** | With the button style Web Messenger, you have the option of selecting your own button icon. (Optional) Used for *Web Messenger* integrations. | [optional]
54
+ **buttonWidth** | **String** | With the button style Web Messenger, you have the option of specifying its width. (Optional) Used for *Web Messenger* integrations. | [optional]
55
+ **buttonHeight** | **String** | With the button style Web Messenger, you have the option of specifying its height. (Optional) Used for *Web Messenger* integrations. | [optional]
56
+ **integrationOrder** | **Array<String>** | Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed (Optional) Used for *Web Messenger* integrations. | [optional]
57
+ **businessName** | **String** | A custom business name for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional]
58
+ **businessIconUrl** | **String** | A custom business icon url for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional]
59
+ **backgroundImageUrl** | **String** | A custom background url for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional]
60
+ **originWhitelist** | **Array<String>** | A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454 `scheme \"://\" host [ \":\" port ]`, where scheme is `http` or `https`. (Optional) Used for *Web Messenger* integrations. | [optional]
61
61
  **status** | **String** | The integration status. Possible values are active, inactive or error. [More info](https://docs.smooch.io/#integration-status). | [optional]
62
62
  **error** | **String** | The error causing the integration to fail. Will be present when `status` is 'error'. | [optional]
63
63
 
data/docs/IntegrationApi.md CHANGED
@@ -17,7 +17,7 @@ Method | HTTP request | Description
17
17
 
18
18
 
19
19
  # **create_integration**
20
- > IntegrationResponse create_integration(app_id, integration_create_body)
20
+ > IntegrationResponse create_integration(appId, integrationCreateBody)
21
21
 
22
22
 
23
23
 
@@ -36,13 +36,13 @@ end
36
36
 
37
37
  api_instance = SmoochApi::IntegrationApi.new
38
38
 
39
- app_id = "app_id_example" # String | Identifies the app.
39
+ appId = "appId_example" # String | Identifies the app.
40
40
 
41
- integration_create_body = SmoochApi::IntegrationCreate.new # IntegrationCreate | Body for a createIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](https://docs.smooch.io/rest/#create-integration)
41
+ integrationCreateBody = SmoochApi::IntegrationCreate.new # IntegrationCreate | Body for a createIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](https://docs.smooch.io/rest/#create-integration)
42
42
 
43
43
 
44
44
  begin
45
- result = api_instance.create_integration(app_id, integration_create_body)
45
+ result = api_instance.create_integration(appId, integrationCreateBody)
46
46
  p result
47
47
  rescue SmoochApi::ApiError => e
48
48
  puts "Exception when calling IntegrationApi->create_integration: #{e}"
@@ -53,8 +53,8 @@ end
53
53
 
54
54
  Name | Type | Description | Notes
55
55
  ------------- | ------------- | ------------- | -------------
56
- **app_id** | **String**| Identifies the app. |
57
- **integration_create_body** | [**IntegrationCreate**](IntegrationCreate.md)| Body for a createIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](https://docs.smooch.io/rest/#create-integration) |
56
+ **appId** | **String**| Identifies the app. |
57
+ **integrationCreateBody** | [**IntegrationCreate**](IntegrationCreate.md)| Body for a createIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](https://docs.smooch.io/rest/#create-integration) |
58
58
 
59
59
  ### Return type
60
60
 
@@ -72,7 +72,7 @@ Name | Type | Description | Notes
72
72
 
73
73
 
74
74
  # **create_integration_menu**
75
- > MenuResponse create_integration_menu(app_id, integration_id, menu_create_body)
75
+ > MenuResponse create_integration_menu(appId, integrationId, menuCreateBody)
76
76
 
77
77
 
78
78
 
@@ -91,15 +91,15 @@ end
91
91
 
92
92
  api_instance = SmoochApi::IntegrationApi.new
93
93
 
94
- app_id = "app_id_example" # String | Identifies the app.
94
+ appId = "appId_example" # String | Identifies the app.
95
95
 
96
- integration_id = "integration_id_example" # String | Identifies the integration.
96
+ integrationId = "integrationId_example" # String | Identifies the integration.
97
97
 
98
- menu_create_body = SmoochApi::Menu.new # Menu | Body for a createMenu request.
98
+ menuCreateBody = SmoochApi::Menu.new # Menu | Body for a createMenu request.
99
99
 
100
100
 
101
101
  begin
102
- result = api_instance.create_integration_menu(app_id, integration_id, menu_create_body)
102
+ result = api_instance.create_integration_menu(appId, integrationId, menuCreateBody)
103
103
  p result
104
104
  rescue SmoochApi::ApiError => e
105
105
  puts "Exception when calling IntegrationApi->create_integration_menu: #{e}"
@@ -110,9 +110,9 @@ end
110
110
 
111
111
  Name | Type | Description | Notes
112
112
  ------------- | ------------- | ------------- | -------------
113
- **app_id** | **String**| Identifies the app. |
114
- **integration_id** | **String**| Identifies the integration. |
115
- **menu_create_body** | [**Menu**](Menu.md)| Body for a createMenu request. |
113
+ **appId** | **String**| Identifies the app. |
114
+ **integrationId** | **String**| Identifies the integration. |
115
+ **menuCreateBody** | [**Menu**](Menu.md)| Body for a createMenu request. |
116
116
 
117
117
  ### Return type
118
118
 
@@ -130,7 +130,7 @@ Name | Type | Description | Notes
130
130
 
131
131
 
132
132
  # **delete_integration**
133
- > delete_integration(app_id, integration_id, )
133
+ > delete_integration(appId, integrationId, )
134
134
 
135
135
 
136
136
 
@@ -149,13 +149,13 @@ end
149
149
 
150
150
  api_instance = SmoochApi::IntegrationApi.new
151
151
 
152
- app_id = "app_id_example" # String | Identifies the app.
152
+ appId = "appId_example" # String | Identifies the app.
153
153
 
154
- integration_id = "integration_id_example" # String | Identifies the integration.
154
+ integrationId = "integrationId_example" # String | Identifies the integration.
155
155
 
156
156
 
157
157
  begin
158
- api_instance.delete_integration(app_id, integration_id, )
158
+ api_instance.delete_integration(appId, integrationId, )
159
159
  rescue SmoochApi::ApiError => e
160
160
  puts "Exception when calling IntegrationApi->delete_integration: #{e}"
161
161
  end
@@ -165,8 +165,8 @@ end
165
165
 
166
166
  Name | Type | Description | Notes
167
167
  ------------- | ------------- | ------------- | -------------
168
- **app_id** | **String**| Identifies the app. |
169
- **integration_id** | **String**| Identifies the integration. |
168
+ **appId** | **String**| Identifies the app. |
169
+ **integrationId** | **String**| Identifies the integration. |
170
170
 
171
171
  ### Return type
172
172
 
@@ -184,7 +184,7 @@ nil (empty response body)
184
184
 
185
185
 
186
186
  # **delete_integration_menu**
187
- > delete_integration_menu(app_id, integration_id, )
187
+ > delete_integration_menu(appId, integrationId, )
188
188
 
189
189
 
190
190
 
@@ -203,13 +203,13 @@ end
203
203
 
204
204
  api_instance = SmoochApi::IntegrationApi.new
205
205
 
206
- app_id = "app_id_example" # String | Identifies the app.
206
+ appId = "appId_example" # String | Identifies the app.
207
207
 
208
- integration_id = "integration_id_example" # String | Identifies the integration.
208
+ integrationId = "integrationId_example" # String | Identifies the integration.
209
209
 
210
210
 
211
211
  begin
212
- api_instance.delete_integration_menu(app_id, integration_id, )
212
+ api_instance.delete_integration_menu(appId, integrationId, )
213
213
  rescue SmoochApi::ApiError => e
214
214
  puts "Exception when calling IntegrationApi->delete_integration_menu: #{e}"
215
215
  end
@@ -219,8 +219,8 @@ end
219
219
 
220
220
  Name | Type | Description | Notes
221
221
  ------------- | ------------- | ------------- | -------------
222
- **app_id** | **String**| Identifies the app. |
223
- **integration_id** | **String**| Identifies the integration. |
222
+ **appId** | **String**| Identifies the app. |
223
+ **integrationId** | **String**| Identifies the integration. |
224
224
 
225
225
  ### Return type
226
226
 
@@ -238,7 +238,7 @@ nil (empty response body)
238
238
 
239
239
 
240
240
  # **get_integration**
241
- > IntegrationResponse get_integration(app_id, integration_id, )
241
+ > IntegrationResponse get_integration(appId, integrationId, )
242
242
 
243
243
 
244
244
 
@@ -257,13 +257,13 @@ end
257
257
 
258
258
  api_instance = SmoochApi::IntegrationApi.new
259
259
 
260
- app_id = "app_id_example" # String | Identifies the app.
260
+ appId = "appId_example" # String | Identifies the app.
261
261
 
262
- integration_id = "integration_id_example" # String | Identifies the integration.
262
+ integrationId = "integrationId_example" # String | Identifies the integration.
263
263
 
264
264
 
265
265
  begin
266
- result = api_instance.get_integration(app_id, integration_id, )
266
+ result = api_instance.get_integration(appId, integrationId, )
267
267
  p result
268
268
  rescue SmoochApi::ApiError => e
269
269
  puts "Exception when calling IntegrationApi->get_integration: #{e}"
@@ -274,8 +274,8 @@ end
274
274
 
275
275
  Name | Type | Description | Notes
276
276
  ------------- | ------------- | ------------- | -------------
277
- **app_id** | **String**| Identifies the app. |
278
- **integration_id** | **String**| Identifies the integration. |
277
+ **appId** | **String**| Identifies the app. |
278
+ **integrationId** | **String**| Identifies the integration. |
279
279
 
280
280
  ### Return type
281
281
 
@@ -293,7 +293,7 @@ Name | Type | Description | Notes
293
293
 
294
294
 
295
295
  # **get_integration_menu**
296
- > MenuResponse get_integration_menu(app_id, integration_id, )
296
+ > MenuResponse get_integration_menu(appId, integrationId, )
297
297
 
298
298
 
299
299
 
@@ -312,13 +312,13 @@ end
312
312
 
313
313
  api_instance = SmoochApi::IntegrationApi.new
314
314
 
315
- app_id = "app_id_example" # String | Identifies the app.
315
+ appId = "appId_example" # String | Identifies the app.
316
316
 
317
- integration_id = "integration_id_example" # String | Identifies the integration.
317
+ integrationId = "integrationId_example" # String | Identifies the integration.
318
318
 
319
319
 
320
320
  begin
321
- result = api_instance.get_integration_menu(app_id, integration_id, )
321
+ result = api_instance.get_integration_menu(appId, integrationId, )
322
322
  p result
323
323
  rescue SmoochApi::ApiError => e
324
324
  puts "Exception when calling IntegrationApi->get_integration_menu: #{e}"
@@ -329,8 +329,8 @@ end
329
329
 
330
330
  Name | Type | Description | Notes
331
331
  ------------- | ------------- | ------------- | -------------
332
- **app_id** | **String**| Identifies the app. |
333
- **integration_id** | **String**| Identifies the integration. |
332
+ **appId** | **String**| Identifies the app. |
333
+ **integrationId** | **String**| Identifies the integration. |
334
334
 
335
335
  ### Return type
336
336
 
@@ -348,7 +348,7 @@ Name | Type | Description | Notes
348
348
 
349
349
 
350
350
  # **list_integrations**
351
- > ListIntegrationsResponse list_integrations(app_id, , opts)
351
+ > ListIntegrationsResponse list_integrations(appId, , opts)
352
352
 
353
353
 
354
354
 
@@ -367,14 +367,14 @@ end
367
367
 
368
368
  api_instance = SmoochApi::IntegrationApi.new
369
369
 
370
- app_id = "app_id_example" # String | Identifies the app.
370
+ appId = "appId_example" # String | Identifies the app.
371
371
 
372
372
  opts = {
373
373
  types: "types_example" # String | List of types to filter the query by. More than one value can be specified through comma separation e.g. ?types=*twilio*,*line*.
374
374
  }
375
375
 
376
376
  begin
377
- result = api_instance.list_integrations(app_id, , opts)
377
+ result = api_instance.list_integrations(appId, , opts)
378
378
  p result
379
379
  rescue SmoochApi::ApiError => e
380
380
  puts "Exception when calling IntegrationApi->list_integrations: #{e}"
@@ -385,7 +385,7 @@ end
385
385
 
386
386
  Name | Type | Description | Notes
387
387
  ------------- | ------------- | ------------- | -------------
388
- **app_id** | **String**| Identifies the app. |
388
+ **appId** | **String**| Identifies the app. |
389
389
  **types** | **String**| List of types to filter the query by. More than one value can be specified through comma separation e.g. ?types=*twilio*,*line*. | [optional]
390
390
 
391
391
  ### Return type
@@ -404,7 +404,7 @@ Name | Type | Description | Notes
404
404
 
405
405
 
406
406
  # **update_integration**
407
- > IntegrationResponse update_integration(app_id, integration_id, integration_update_body)
407
+ > IntegrationResponse update_integration(appId, integrationId, integrationUpdateBody)
408
408
 
409
409
 
410
410
 
@@ -423,15 +423,15 @@ end
423
423
 
424
424
  api_instance = SmoochApi::IntegrationApi.new
425
425
 
426
- app_id = "app_id_example" # String | Identifies the app.
426
+ appId = "appId_example" # String | Identifies the app.
427
427
 
428
- integration_id = "integration_id_example" # String | Identifies the integration.
428
+ integrationId = "integrationId_example" # String | Identifies the integration.
429
429
 
430
- integration_update_body = SmoochApi::IntegrationUpdate.new # IntegrationUpdate | Body for a updateIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](https://docs.smooch.io/rest/#create-integration)
430
+ integrationUpdateBody = SmoochApi::IntegrationUpdate.new # IntegrationUpdate | Body for a updateIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](https://docs.smooch.io/rest/#create-integration)
431
431
 
432
432
 
433
433
  begin
434
- result = api_instance.update_integration(app_id, integration_id, integration_update_body)
434
+ result = api_instance.update_integration(appId, integrationId, integrationUpdateBody)
435
435
  p result
436
436
  rescue SmoochApi::ApiError => e
437
437
  puts "Exception when calling IntegrationApi->update_integration: #{e}"
@@ -442,9 +442,9 @@ end
442
442
 
443
443
  Name | Type | Description | Notes
444
444
  ------------- | ------------- | ------------- | -------------
445
- **app_id** | **String**| Identifies the app. |
446
- **integration_id** | **String**| Identifies the integration. |
447
- **integration_update_body** | [**IntegrationUpdate**](IntegrationUpdate.md)| Body for a updateIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](https://docs.smooch.io/rest/#create-integration) |
445
+ **appId** | **String**| Identifies the app. |
446
+ **integrationId** | **String**| Identifies the integration. |
447
+ **integrationUpdateBody** | [**IntegrationUpdate**](IntegrationUpdate.md)| Body for a updateIntegration request. Additional arguments are necessary based on integration type. For detailed instructions, visit our [official docs](https://docs.smooch.io/rest/#create-integration) |
448
448
 
449
449
  ### Return type
450
450
 
@@ -462,7 +462,7 @@ Name | Type | Description | Notes
462
462
 
463
463
 
464
464
  # **update_integration_menu**
465
- > MenuResponse update_integration_menu(app_id, integration_id, menu_update_body)
465
+ > MenuResponse update_integration_menu(appId, integrationId, menuUpdateBody)
466
466
 
467
467
 
468
468
 
@@ -481,15 +481,15 @@ end
481
481
 
482
482
  api_instance = SmoochApi::IntegrationApi.new
483
483
 
484
- app_id = "app_id_example" # String | Identifies the app.
484
+ appId = "appId_example" # String | Identifies the app.
485
485
 
486
- integration_id = "integration_id_example" # String | Identifies the integration.
486
+ integrationId = "integrationId_example" # String | Identifies the integration.
487
487
 
488
- menu_update_body = SmoochApi::Menu.new # Menu | Body for a updateMenu request.
488
+ menuUpdateBody = SmoochApi::Menu.new # Menu | Body for a updateMenu request.
489
489
 
490
490
 
491
491
  begin
492
- result = api_instance.update_integration_menu(app_id, integration_id, menu_update_body)
492
+ result = api_instance.update_integration_menu(appId, integrationId, menuUpdateBody)
493
493
  p result
494
494
  rescue SmoochApi::ApiError => e
495
495
  puts "Exception when calling IntegrationApi->update_integration_menu: #{e}"
@@ -500,9 +500,9 @@ end
500
500
 
501
501
  Name | Type | Description | Notes
502
502
  ------------- | ------------- | ------------- | -------------
503
- **app_id** | **String**| Identifies the app. |
504
- **integration_id** | **String**| Identifies the integration. |
505
- **menu_update_body** | [**Menu**](Menu.md)| Body for a updateMenu request. |
503
+ **appId** | **String**| Identifies the app. |
504
+ **integrationId** | **String**| Identifies the integration. |
505
+ **menuUpdateBody** | [**Menu**](Menu.md)| Body for a updateMenu request. |
506
506
 
507
507
  ### Return type
508
508
 
@@ -520,7 +520,7 @@ Name | Type | Description | Notes
520
520
 
521
521
 
522
522
  # **update_integration_profile**
523
- > update_integration_profile(app_id, integration_id, integration_profile_body)
523
+ > update_integration_profile(appId, integrationId, integrationProfileBody)
524
524
 
525
525
 
526
526
 
@@ -539,15 +539,15 @@ end
539
539
 
540
540
  api_instance = SmoochApi::IntegrationApi.new
541
541
 
542
- app_id = "app_id_example" # String | Identifies the app.
542
+ appId = "appId_example" # String | Identifies the app.
543
543
 
544
- integration_id = "integration_id_example" # String | Identifies the integration.
544
+ integrationId = "integrationId_example" # String | Identifies the integration.
545
545
 
546
- integration_profile_body = SmoochApi::IntegrationProfileUpdate.new # IntegrationProfileUpdate | Body for a profileUpdate request.
546
+ integrationProfileBody = SmoochApi::IntegrationProfileUpdate.new # IntegrationProfileUpdate | Body for a profileUpdate request.
547
547
 
548
548
 
549
549
  begin
550
- api_instance.update_integration_profile(app_id, integration_id, integration_profile_body)
550
+ api_instance.update_integration_profile(appId, integrationId, integrationProfileBody)
551
551
  rescue SmoochApi::ApiError => e
552
552
  puts "Exception when calling IntegrationApi->update_integration_profile: #{e}"
553
553
  end
@@ -557,9 +557,9 @@ end
557
557
 
558
558
  Name | Type | Description | Notes
559
559
  ------------- | ------------- | ------------- | -------------
560
- **app_id** | **String**| Identifies the app. |
561
- **integration_id** | **String**| Identifies the integration. |
562
- **integration_profile_body** | [**IntegrationProfileUpdate**](IntegrationProfileUpdate.md)| Body for a profileUpdate request. |
560
+ **appId** | **String**| Identifies the app. |
561
+ **integrationId** | **String**| Identifies the integration. |
562
+ **integrationProfileBody** | [**IntegrationProfileUpdate**](IntegrationProfileUpdate.md)| Body for a profileUpdate request. |
563
563
 
564
564
  ### Return type
565
565