smooch-api 5.7.0 → 5.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (126) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +13 -1
  3. data/docs/Action.md +2 -2
  4. data/docs/AppUserLink.md +1 -1
  5. data/docs/BusinessSystemItem.md +1 -1
  6. data/docs/ChannelEntityItem.md +1 -1
  7. data/docs/Client.md +1 -1
  8. data/docs/Confirmation.md +1 -1
  9. data/docs/ConversationActivity.md +2 -2
  10. data/docs/Deployment.md +17 -0
  11. data/docs/DeploymentActivatePhoneNumber.md +10 -0
  12. data/docs/DeploymentApi.md +325 -0
  13. data/docs/DeploymentConfirmCode.md +8 -0
  14. data/docs/DeploymentCreate.md +12 -0
  15. data/docs/DeploymentResponse.md +8 -0
  16. data/docs/Destination.md +1 -1
  17. data/docs/DisplaySettings.md +1 -1
  18. data/docs/Enums.md +3 -0
  19. data/docs/Integration.md +6 -5
  20. data/docs/IntegrationCreate.md +5 -4
  21. data/docs/LinkRequestResponseLinkRequests.md +1 -1
  22. data/docs/ListDeploymentsResponse.md +8 -0
  23. data/docs/MenuItem.md +1 -1
  24. data/docs/Message.md +2 -2
  25. data/docs/MessageItem.md +1 -1
  26. data/docs/MessagePost.md +2 -2
  27. data/docs/Source.md +1 -1
  28. data/docs/SubMenuItem.md +1 -1
  29. data/docs/Webhook.md +1 -1
  30. data/docs/WebhookCreate.md +1 -1
  31. data/docs/WebhookUpdate.md +1 -1
  32. data/lib/smooch-api.rb +8 -1
  33. data/lib/smooch-api/api/app_api.rb +1 -1
  34. data/lib/smooch-api/api/app_user_api.rb +1 -1
  35. data/lib/smooch-api/api/attachments_api.rb +1 -1
  36. data/lib/smooch-api/api/conversation_api.rb +1 -1
  37. data/lib/smooch-api/api/deployment_api.rb +358 -0
  38. data/lib/smooch-api/api/integration_api.rb +1 -1
  39. data/lib/smooch-api/api/menu_api.rb +1 -1
  40. data/lib/smooch-api/api/service_account_api.rb +1 -1
  41. data/lib/smooch-api/api/template_api.rb +1 -1
  42. data/lib/smooch-api/api/webhook_api.rb +1 -1
  43. data/lib/smooch-api/api_client.rb +1 -1
  44. data/lib/smooch-api/api_error.rb +1 -1
  45. data/lib/smooch-api/configuration.rb +1 -1
  46. data/lib/smooch-api/models/action.rb +3 -3
  47. data/lib/smooch-api/models/app.rb +1 -1
  48. data/lib/smooch-api/models/app_create.rb +1 -1
  49. data/lib/smooch-api/models/app_response.rb +1 -1
  50. data/lib/smooch-api/models/app_settings.rb +1 -1
  51. data/lib/smooch-api/models/app_update.rb +1 -1
  52. data/lib/smooch-api/models/app_user.rb +1 -1
  53. data/lib/smooch-api/models/app_user_business_systems_response.rb +1 -1
  54. data/lib/smooch-api/models/app_user_channels_response.rb +1 -1
  55. data/lib/smooch-api/models/app_user_link.rb +2 -2
  56. data/lib/smooch-api/models/app_user_pre_create.rb +1 -1
  57. data/lib/smooch-api/models/app_user_response.rb +1 -1
  58. data/lib/smooch-api/models/app_user_update.rb +1 -1
  59. data/lib/smooch-api/models/attachment_remove.rb +1 -1
  60. data/lib/smooch-api/models/attachment_response.rb +1 -1
  61. data/lib/smooch-api/models/auth_code_response.rb +1 -1
  62. data/lib/smooch-api/models/business_system_item.rb +2 -2
  63. data/lib/smooch-api/models/channel_entity_item.rb +2 -2
  64. data/lib/smooch-api/models/client.rb +2 -2
  65. data/lib/smooch-api/models/client_info.rb +1 -1
  66. data/lib/smooch-api/models/confirmation.rb +2 -2
  67. data/lib/smooch-api/models/conversation.rb +1 -1
  68. data/lib/smooch-api/models/conversation_activity.rb +3 -3
  69. data/lib/smooch-api/models/deployment.rb +294 -0
  70. data/lib/smooch-api/models/deployment_activate_phone_number.rb +224 -0
  71. data/lib/smooch-api/models/deployment_confirm_code.rb +194 -0
  72. data/lib/smooch-api/models/deployment_create.rb +234 -0
  73. data/lib/smooch-api/models/deployment_response.rb +194 -0
  74. data/lib/smooch-api/models/destination.rb +2 -2
  75. data/lib/smooch-api/models/display_settings.rb +2 -2
  76. data/lib/smooch-api/models/enums.rb +68 -5
  77. data/lib/smooch-api/models/get_integration_profile_response.rb +1 -1
  78. data/lib/smooch-api/models/get_messages_response.rb +1 -1
  79. data/lib/smooch-api/models/integration.rb +17 -7
  80. data/lib/smooch-api/models/integration_create.rb +16 -6
  81. data/lib/smooch-api/models/integration_profile_update.rb +1 -1
  82. data/lib/smooch-api/models/integration_response.rb +1 -1
  83. data/lib/smooch-api/models/integration_update.rb +1 -1
  84. data/lib/smooch-api/models/jwt_response.rb +1 -1
  85. data/lib/smooch-api/models/link_request_response.rb +1 -1
  86. data/lib/smooch-api/models/link_request_response_link_requests.rb +2 -2
  87. data/lib/smooch-api/models/list_apps_response.rb +1 -1
  88. data/lib/smooch-api/models/list_deployments_response.rb +196 -0
  89. data/lib/smooch-api/models/list_integrations_response.rb +1 -1
  90. data/lib/smooch-api/models/list_secret_keys_response.rb +1 -1
  91. data/lib/smooch-api/models/list_service_accounts_response.rb +1 -1
  92. data/lib/smooch-api/models/list_templates_response.rb +1 -1
  93. data/lib/smooch-api/models/list_webhooks_response.rb +1 -1
  94. data/lib/smooch-api/models/menu.rb +1 -1
  95. data/lib/smooch-api/models/menu_item.rb +2 -2
  96. data/lib/smooch-api/models/menu_response.rb +1 -1
  97. data/lib/smooch-api/models/message.rb +3 -3
  98. data/lib/smooch-api/models/message_item.rb +2 -2
  99. data/lib/smooch-api/models/message_override.rb +1 -1
  100. data/lib/smooch-api/models/message_override_whatsapp.rb +1 -1
  101. data/lib/smooch-api/models/message_post.rb +3 -3
  102. data/lib/smooch-api/models/message_response.rb +1 -1
  103. data/lib/smooch-api/models/secret_key.rb +1 -1
  104. data/lib/smooch-api/models/secret_key_create.rb +1 -1
  105. data/lib/smooch-api/models/secret_key_response.rb +1 -1
  106. data/lib/smooch-api/models/service_account.rb +1 -1
  107. data/lib/smooch-api/models/service_account_create.rb +1 -1
  108. data/lib/smooch-api/models/service_account_response.rb +1 -1
  109. data/lib/smooch-api/models/service_account_update.rb +1 -1
  110. data/lib/smooch-api/models/source.rb +2 -2
  111. data/lib/smooch-api/models/sub_menu_item.rb +2 -2
  112. data/lib/smooch-api/models/template.rb +1 -1
  113. data/lib/smooch-api/models/template_create.rb +1 -1
  114. data/lib/smooch-api/models/template_response.rb +1 -1
  115. data/lib/smooch-api/models/template_update.rb +1 -1
  116. data/lib/smooch-api/models/upload_integration_profile_photo_response.rb +1 -1
  117. data/lib/smooch-api/models/webhook.rb +2 -2
  118. data/lib/smooch-api/models/webhook_create.rb +2 -2
  119. data/lib/smooch-api/models/webhook_response.rb +1 -1
  120. data/lib/smooch-api/models/webhook_update.rb +2 -2
  121. data/lib/smooch-api/version.rb +2 -2
  122. data/smooch-api.gemspec +1 -1
  123. data/spec/api_client_spec.rb +1 -1
  124. data/spec/configuration_spec.rb +1 -1
  125. data/spec/spec_helper.rb +1 -1
  126. metadata +16 -2
@@ -0,0 +1,8 @@
1
+ # SmoochApi::DeploymentConfirmCode
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **code** | **String** | The code that was sent to you via SMS or phone call. |
7
+
8
+
@@ -0,0 +1,12 @@
1
+ # SmoochApi::DeploymentCreate
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **hosting** | **String** | The deployment hosting. See [**DeploymentHostingEnum**](Enums.md#DeploymentHostingEnum) for available values. |
7
+ **baseUrl** | **String** | The base URL to access your WhatsApp EC. Only provide for `self` hosted deployments. | [optional]
8
+ **username** | **String** | The username to access your WhatsApp EC. Only provide for `self` hosted deployments. | [optional]
9
+ **password** | **String** | The password to access your WhatsApp EC. Only provide for `self` hosted deployments. | [optional]
10
+ **callbackUrl** | **String** | The URL to be called by Smooch when the status of the deployment changes. | [optional]
11
+
12
+
@@ -0,0 +1,8 @@
1
+ # SmoochApi::DeploymentResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **deployment** | [**Deployment**](Deployment.md) | The deployment. |
7
+
8
+
data/docs/Destination.md CHANGED
@@ -4,6 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **integrationId** | **String** | The ID of the target integration. |
7
- **integrationType** | **String** | The type of the target integration. See Enums.md for available values. |
7
+ **integrationType** | **String** | The type of the target integration. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. |
8
8
 
9
9
 
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **imageAspectRatio** | **String** | Specifies how to display all carousel images. See Enums.md for available values. | [optional]
6
+ **imageAspectRatio** | **String** | Specifies how to display all carousel images. See [**ImageAspectRatioEnum**](Enums.md#ImageAspectRatioEnum) for available values. | [optional]
7
7
 
8
8
 
data/docs/Enums.md CHANGED
@@ -16,5 +16,8 @@ Name | Type | Description | Notes
16
16
  **messageType** | **String** | | [optional]
17
17
  **role** | **String** | | [optional]
18
18
  **webhookTriggers** | **String** | | [optional]
19
+ **deploymentHosting** | **String** | | [optional]
20
+ **deploymentStatus** | **String** | | [optional]
21
+ **deploymentActivationMethod** | **String** | | [optional]
19
22
 
20
23
 
data/docs/Integration.md CHANGED
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **id** | **String** | The integration ID, generated automatically. |
7
- **type** | **String** | The integration type. See Enums.md for available values. |
7
+ **type** | **String** | The integration type. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. |
8
8
  **displayName** | **String** | The integration display name. Used to map a human-friendly name to an integration. | [optional]
9
9
  **pageAccessToken** | **String** | Facebook Page Access Token. Required for *messenger* integrations. | [optional]
10
10
  **appId** | **String** | Facebook App ID OR WeChat App ID. Required for *messenger* and *wechat* integrations. | [optional]
@@ -28,9 +28,10 @@ Name | Type | Description | Notes
28
28
  **encodingAesKey** | **String** | AES Encoding Key. (Optional) Used for *wechat* integrations. | [optional]
29
29
  **fromAddress** | **String** | Email will display as coming from this address. (Optional) Used for *frontendEmail* integrations. | [optional]
30
30
  **certificate** | **String** | The binary of your APN certificate base64 encoded. Required for *apn* integrations. | [optional]
31
- **baseUrl** | **String** | Your WhatsApp API client's URL. Required for *WhatsApp* integrations. | [optional]
31
+ **deploymentId** | **String** | Your WhatsApp deployment ID. Required for *WhatsApp* integrations. | [optional]
32
+ **baseUrl** | **String** | Your WhatsApp API client's URL. Required for *WhatsApp* integrations. (this usage is deprecated) | [optional]
32
33
  **hsmFallbackLanguage** | **String** | Specification of a fallback language. (Optional) Used for *WhatsApp* integrations. | [optional]
33
- **password** | **String** | The password for your APN certificate or WhatsApp API client. Required for *WhatsApp* integrations. (Optional) Used for *apn* integrations. | [optional]
34
+ **password** | **String** | The password for your APN certificate or WhatsApp API client. Required for *WhatsApp* integrations. (this usage is deprecated) (Optional) Used for *apn* integrations. | [optional]
34
35
  **autoUpdateBadge** | **BOOLEAN** | Use the unread count of the conversation as the application badge. (Optional) Used for *apn* integrations. | [optional]
35
36
  **production** | **BOOLEAN** | Flag specifying whether the certificate is production. Returned on successful *apn* integrations. | [optional]
36
37
  **serverKey** | **String** | Your server key from the fcm console. Required for *fcm* integrations. | [optional]
@@ -42,7 +43,7 @@ Name | Type | Description | Notes
42
43
  **accessTokenKey** | **String** | The access token key obtained from your user via oauth. Required for *twitter* integrations. | [optional]
43
44
  **accessTokenSecret** | **String** | The access token secret obtained from your user via oauth. Required for *twitter* integrations. | [optional]
44
45
  **userId** | **String** | The twitter userId. Returned on successful *twitter* integrations. | [optional]
45
- **username** | **String** | The username for the account. Required for *WhatsApp* integrations. Returned on successful *twitter* and *telegram* integrations. | [optional]
46
+ **username** | **String** | The username for the account. Returned on successful *twitter* and *telegram* integrations. Required for *WhatsApp* integrations. (this usage is deprecated) | [optional]
46
47
  **apiKey** | **String** | The public API key of your Mailgun account. Required for *mailgun* integrations. | [optional]
47
48
  **domain** | **String** | The domain used to relay email. Required for *mailgun* integrations. | [optional]
48
49
  **incomingAddress** | **String** | Smooch will receive all emails sent to this address. Required for *mailgun* integrations. | [optional]
@@ -61,7 +62,7 @@ Name | Type | Description | Notes
61
62
  **businessIconUrl** | **String** | A custom business icon url for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional]
62
63
  **backgroundImageUrl** | **String** | A custom background url for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional]
63
64
  **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]
64
- **status** | **String** | The integration status. See Enums.md for available values. [More info](https://docs.smooch.io/#integration-status). | [optional]
65
+ **status** | **String** | The integration status. See [**IntegrationStatusEnum**](Enums.md#IntegrationStatusEnum) for available values. [More info](https://docs.smooch.io/#integration-status). | [optional]
65
66
  **error** | **String** | The error causing the integration to fail. Will be present when `status` is 'error'. | [optional]
66
67
 
67
68
 
@@ -3,27 +3,28 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | The integration type. See Enums.md for available values. |
6
+ **type** | **String** | The integration type. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. |
7
7
  **displayName** | **String** | The integration display name. Used to map a human-friendly name to an integration. | [optional]
8
8
  **pageAccessToken** | **String** | Facebook Page Access Token. Required for *messenger* integrations. | [optional]
9
9
  **appId** | **String** | Facebook App ID OR WeChat App ID. Required for *messenger* and *wechat* integrations. | [optional]
10
10
  **appSecret** | **String** | Facebook Page App Secret OR WeChat App Secret. Required for *messenger* and *wechat* integrations. | [optional]
11
11
  **accountSid** | **String** | Twilio Account SID. Required for *twilio* integrations. | [optional]
12
12
  **authToken** | **String** | Twilio Auth Token. Required for *twilio* integrations. | [optional]
13
- **baseUrl** | **String** | Your WhatsApp API client's URL. Required for *WhatsApp* integrations. | [optional]
13
+ **baseUrl** | **String** | Your WhatsApp API client's URL. Required for *WhatsApp* integrations. (this usage is deprecated) | [optional]
14
14
  **hsmFallbackLanguage** | **String** | Specification of a fallback language. (Optional) Used for *WhatsApp* integrations. | [optional]
15
15
  **phoneNumberSid** | **String** | SID for specific phone number. Required for *twilio* integrations. | [optional]
16
16
  **token** | **String** | Telegram Bot Token OR Viber Public Account token. Required for *twilio* and *viber* integrations. | [optional]
17
17
  **channelId** | **String** | LINE Channel ID. Required for *line* integrations. | [optional]
18
18
  **channelSecret** | **String** | LINE Channel Secret. Required for *line* integrations. | [optional]
19
19
  **channelAccessToken** | **String** | LINE Channel Access Token. Required for *line* integrations. | [optional]
20
+ **deploymentId** | **String** | Your WhatsApp deployment ID. Required for *WhatsApp* integrations. | [optional]
20
21
  **serviceCode** | **String** | LINE Service Code. | [optional]
21
22
  **switcherSecret** | **String** | LINE Switcher Secret. | [optional]
22
23
  **encodingAesKey** | **String** | AES Encoding Key. (Optional) Used for *wechat* integrations. | [optional]
23
24
  **fromAddress** | **String** | Email will display as coming from this address. (Optional) Used for *frontendEmail* integrations. | [optional]
24
25
  **certificate** | **String** | The binary of your APN certificate base64 encoded. Required for *apn* integrations. | [optional]
25
- **password** | **String** | The password for your APN certificate or WhatsApp API client. Required for *WhatsApp* integrations. (Optional) Used for *apn* integrations. | [optional]
26
- **username** | **String** | The username for the account. Required for *WhatsApp* integrations. Returned on successful *twitter* and *telegram* integrations. | [optional]
26
+ **password** | **String** | The password for your APN certificate or WhatsApp API client. Required for *WhatsApp* integrations. (this usage is deprecated) (Optional) Used for *apn* integrations. | [optional]
27
+ **username** | **String** | The username for the account. Returned on successful *twitter* and *telegram* integrations. Required for *WhatsApp* integrations. (this usage is deprecated) | [optional]
27
28
  **autoUpdateBadge** | **BOOLEAN** | Use the unread count of the conversation as the application badge. (Optional) Used for *apn* integrations. | [optional]
28
29
  **serverKey** | **String** | Your server key from the fcm console. Required for *fcm* integrations. | [optional]
29
30
  **senderId** | **String** | Your sender id from the fcm console. Required for *fcm* integrations. | [optional]
@@ -4,7 +4,7 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **integrationId** | **String** | The integration ID. |
7
- **type** | **String** | The integration type. See Enums.md for available values. |
7
+ **type** | **String** | The integration type. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. |
8
8
  **code** | **String** | The link request code. |
9
9
  **url** | **String** | The link request url. |
10
10
 
@@ -0,0 +1,8 @@
1
+ # SmoochApi::ListDeploymentsResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **deployments** | [**Array<Deployment>**](Deployment.md) | The list of deployments. |
7
+
8
+
data/docs/MenuItem.md CHANGED
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **text** | **String** | The button text of the menu item. |
7
7
  **uri** | **String** | A valid address, like http://smooch.io. Required for a link type item. | [optional]
8
- **type** | **String** | Can either be link, postback, which correspond to Smooch’s link and postback actions, or submenu for nested menus. See Enums.md for available values. |
8
+ **type** | **String** | Can either be link, postback, which correspond to Smooch’s link and postback actions, or submenu for nested menus. See [**MenuItemTypeEnum**](Enums.md#MenuItemTypeEnum) for available values. |
9
9
  **payload** | **String** | A payload for a postback. Required for a postback type item. | [optional]
10
10
  **items** | [**Array<SubMenuItem>**](SubMenuItem.md) | A list of menu items for a submenu. | [optional]
11
11
 
data/docs/Message.md CHANGED
@@ -5,8 +5,8 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **id** | **String** | The message ID, generated automatically. |
7
7
  **authorId** | **String** | The ID of the message's author. |
8
- **role** | **String** | The role of the individual posting the message. See Enums.md for available values. |
9
- **type** | **String** | The message type. See Enums.md for available values. |
8
+ **role** | **String** | The role of the individual posting the message. See [**RoleEnum**](Enums.md#RoleEnum) for available values. |
9
+ **type** | **String** | The message type. See [**MessageTypeEnum**](Enums.md#MessageTypeEnum) for available values. |
10
10
  **source** | [**Source**](Source.md) | The source of the message. | [optional]
11
11
  **name** | **String** | The display name of the message author. |
12
12
  **text** | **String** | The message text. Required for text messages. |
data/docs/MessageItem.md CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  **title** | **String** | The title of the message item. |
7
7
  **description** | **String** | The text description, or subtitle. | [optional]
8
8
  **mediaUrl** | **String** | The image URL to be shown in the carousel/list item. | [optional]
9
- **size** | **String** | The size of the image to be shown in the carousel/list item. Only top item of Facebook Messenger carousel supported. See Enums.md for available values. | [optional]
9
+ **size** | **String** | The size of the image to be shown in the carousel/list item. Only top item of Facebook Messenger carousel supported. See [**MessageItemSizeEnum**](Enums.md#MessageItemSizeEnum) for available values. | [optional]
10
10
  **mediaType** | **String** | If a *mediaUrl* was specified, the media type is defined here, for example *image/jpeg*. | [optional]
11
11
  **actions** | [**Array<Action>**](Action.md) | Array of [action buttons](https://docs.smooch.io/rest/#action-buttons). At least 1 is required, a maximum of 3 are allowed. |
12
12
 
data/docs/MessagePost.md CHANGED
@@ -3,8 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **role** | **String** | The role of the individual posting the message. See Enums.md for available values. |
7
- **type** | **String** | The message type. See Enums.md for available values. |
6
+ **role** | **String** | The role of the individual posting the message. See [**RoleEnum**](Enums.md#RoleEnum) for available values. |
7
+ **type** | **String** | The message type. See [**MessageTypeEnum**](Enums.md#MessageTypeEnum) for available values. |
8
8
  **name** | **String** | The display name of the message author. | [optional]
9
9
  **email** | **String** | The email address of the message author. | [optional]
10
10
  **avatarUrl** | **String** | The URL of the desired message avatar image. | [optional]
data/docs/Source.md CHANGED
@@ -4,6 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **id** | **String** | An identifier used by Smooch for internal purposes. | [optional]
7
- **type** | **String** | An identifier for the channel from which a message originated. See Enums.md for available values. | [optional]
7
+ **type** | **String** | An identifier for the channel from which a message originated. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. | [optional]
8
8
 
9
9
 
data/docs/SubMenuItem.md CHANGED
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **text** | **String** | The button text of the menu item. |
7
7
  **uri** | **String** | A valid address, like http://smooch.io. Required for a link type item. | [optional]
8
- **type** | **String** | Can either be link, postback, which correspond to Smooch’s link and postback actions, or submenu for nested menus. See Enums.md for available values. |
8
+ **type** | **String** | Can either be link, postback, which correspond to Smooch’s link and postback actions, or submenu for nested menus. See [**MenuItemTypeEnum**](Enums.md#MenuItemTypeEnum) for available values. |
9
9
  **payload** | **String** | A payload for a postback. Required for a postback type item. | [optional]
10
10
 
11
11
 
data/docs/Webhook.md CHANGED
@@ -5,7 +5,7 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **id** | **String** | The webhook ID, generated automatically. |
7
7
  **target** | **String** | URL to be called when the webhook is triggered. |
8
- **triggers** | **Array<String>** | An array of triggers you wish to have the webhook listen to. See Enums.md for available values. |
8
+ **triggers** | **Array<String>** | An array of triggers you wish to have the webhook listen to. See [**WebhookTriggersEnum**](Enums.md#WebhookTriggersEnum) for available values. |
9
9
  **secret** | **String** | Secret which will be transmitted with each webhook invocation and can be used to verify the authenticity of the caller. |
10
10
  **version** | **String** | The payload version of the webhook. | [optional]
11
11
 
@@ -4,6 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **target** | **String** | URL to be called when the webhook is triggered. |
7
- **triggers** | **Array<String>** | An array of triggers you wish to have the webhook listen to. See Enums.md for available values. | [optional]
7
+ **triggers** | **Array<String>** | An array of triggers you wish to have the webhook listen to. See [**WebhookTriggersEnum**](Enums.md#WebhookTriggersEnum) for available values. | [optional]
8
8
 
9
9
 
@@ -4,6 +4,6 @@
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **target** | **String** | URL to be called when the webhook is triggered. | [optional]
7
- **triggers** | **Array<String>** | An array of triggers you wish to have the webhook listen to. See Enums.md for available values. | [optional]
7
+ **triggers** | **Array<String>** | An array of triggers you wish to have the webhook listen to. See [**WebhookTriggersEnum**](Enums.md#WebhookTriggersEnum) for available values. | [optional]
8
8
 
9
9
 
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: 5.7
6
+ OpenAPI spec version: 5.8
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -40,6 +40,11 @@ require 'smooch-api/models/client_info'
40
40
  require 'smooch-api/models/confirmation'
41
41
  require 'smooch-api/models/conversation'
42
42
  require 'smooch-api/models/conversation_activity'
43
+ require 'smooch-api/models/deployment'
44
+ require 'smooch-api/models/deployment_activate_phone_number'
45
+ require 'smooch-api/models/deployment_confirm_code'
46
+ require 'smooch-api/models/deployment_create'
47
+ require 'smooch-api/models/deployment_response'
43
48
  require 'smooch-api/models/destination'
44
49
  require 'smooch-api/models/display_settings'
45
50
  require 'smooch-api/models/enums'
@@ -54,6 +59,7 @@ require 'smooch-api/models/jwt_response'
54
59
  require 'smooch-api/models/link_request_response'
55
60
  require 'smooch-api/models/link_request_response_link_requests'
56
61
  require 'smooch-api/models/list_apps_response'
62
+ require 'smooch-api/models/list_deployments_response'
57
63
  require 'smooch-api/models/list_integrations_response'
58
64
  require 'smooch-api/models/list_secret_keys_response'
59
65
  require 'smooch-api/models/list_service_accounts_response'
@@ -92,6 +98,7 @@ require 'smooch-api/api/app_api'
92
98
  require 'smooch-api/api/app_user_api'
93
99
  require 'smooch-api/api/attachments_api'
94
100
  require 'smooch-api/api/conversation_api'
101
+ require 'smooch-api/api/deployment_api'
95
102
  require 'smooch-api/api/integration_api'
96
103
  require 'smooch-api/api/menu_api'
97
104
  require 'smooch-api/api/service_account_api'
@@ -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: 5.7
6
+ OpenAPI spec version: 5.8
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: 5.7
6
+ OpenAPI spec version: 5.8
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: 5.7
6
+ OpenAPI spec version: 5.8
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: 5.7
6
+ OpenAPI spec version: 5.8
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -0,0 +1,358 @@
1
+ =begin
2
+ #Smooch
3
+
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
+
6
+ OpenAPI spec version: 5.8
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.2.3-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require "uri"
14
+
15
+ module SmoochApi
16
+ class DeploymentApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+
23
+ #
24
+ # Activate a phone number on the specified deployment.
25
+ # @param deploymentId Identifies the deployment.
26
+ # @param deploymentActivatePhoneNumberBody Body for an activatePhoneNumber request.
27
+ # @param [Hash] opts the optional parameters
28
+ # @return [DeploymentResponse]
29
+ def activate_phone_number(deploymentId, deploymentActivatePhoneNumberBody, opts = {})
30
+ data, _status_code, _headers = activate_phone_number_with_http_info(deploymentId, deploymentActivatePhoneNumberBody, opts)
31
+ return data
32
+ end
33
+
34
+ #
35
+ # Activate a phone number on the specified deployment.
36
+ # @param deploymentId Identifies the deployment.
37
+ # @param deploymentActivatePhoneNumberBody Body for an activatePhoneNumber request.
38
+ # @param [Hash] opts the optional parameters
39
+ # @return [Array<(DeploymentResponse, Fixnum, Hash)>] DeploymentResponse data, response status code and response headers
40
+ def activate_phone_number_with_http_info(deploymentId, deploymentActivatePhoneNumberBody, opts = {})
41
+ if @api_client.config.debugging
42
+ @api_client.config.logger.debug "Calling API: DeploymentApi.activate_phone_number ..."
43
+ end
44
+ # verify the required parameter 'deploymentId' is set
45
+ if @api_client.config.client_side_validation && deploymentId.nil?
46
+ fail ArgumentError, "Missing the required parameter 'deploymentId' when calling DeploymentApi.activate_phone_number"
47
+ end
48
+ # verify the required parameter 'deploymentActivatePhoneNumberBody' is set
49
+ if @api_client.config.client_side_validation && deploymentActivatePhoneNumberBody.nil?
50
+ fail ArgumentError, "Missing the required parameter 'deploymentActivatePhoneNumberBody' when calling DeploymentApi.activate_phone_number"
51
+ end
52
+ # resource path
53
+ local_var_path = "/v1.1/whatsapp/deployments/{deploymentId}/activate".sub('{' + 'deploymentId' + '}', deploymentId.to_s)
54
+
55
+ # query parameters
56
+ query_params = {}
57
+
58
+ # header parameters
59
+ header_params = {}
60
+ # HTTP header 'Accept' (if needed)
61
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
62
+ # HTTP header 'Content-Type'
63
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
64
+
65
+ # form parameters
66
+ form_params = {}
67
+
68
+ # http body (model)
69
+ post_body = @api_client.object_to_http_body(deploymentActivatePhoneNumberBody)
70
+ auth_names = ['jwt']
71
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
72
+ :header_params => header_params,
73
+ :query_params => query_params,
74
+ :form_params => form_params,
75
+ :body => post_body,
76
+ :auth_names => auth_names,
77
+ :return_type => 'DeploymentResponse')
78
+ if @api_client.config.debugging
79
+ @api_client.config.logger.debug "API called: DeploymentApi#activate_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
80
+ end
81
+ return data, status_code, headers
82
+ end
83
+
84
+ #
85
+ # Confirm code to complete phone number activation.
86
+ # @param deploymentId Identifies the deployment.
87
+ # @param deploymentConfirmCode Body for a confirmCode request.
88
+ # @param [Hash] opts the optional parameters
89
+ # @return [DeploymentResponse]
90
+ def confirm_code(deploymentId, deploymentConfirmCode, opts = {})
91
+ data, _status_code, _headers = confirm_code_with_http_info(deploymentId, deploymentConfirmCode, opts)
92
+ return data
93
+ end
94
+
95
+ #
96
+ # Confirm code to complete phone number activation.
97
+ # @param deploymentId Identifies the deployment.
98
+ # @param deploymentConfirmCode Body for a confirmCode request.
99
+ # @param [Hash] opts the optional parameters
100
+ # @return [Array<(DeploymentResponse, Fixnum, Hash)>] DeploymentResponse data, response status code and response headers
101
+ def confirm_code_with_http_info(deploymentId, deploymentConfirmCode, opts = {})
102
+ if @api_client.config.debugging
103
+ @api_client.config.logger.debug "Calling API: DeploymentApi.confirm_code ..."
104
+ end
105
+ # verify the required parameter 'deploymentId' is set
106
+ if @api_client.config.client_side_validation && deploymentId.nil?
107
+ fail ArgumentError, "Missing the required parameter 'deploymentId' when calling DeploymentApi.confirm_code"
108
+ end
109
+ # verify the required parameter 'deploymentConfirmCode' is set
110
+ if @api_client.config.client_side_validation && deploymentConfirmCode.nil?
111
+ fail ArgumentError, "Missing the required parameter 'deploymentConfirmCode' when calling DeploymentApi.confirm_code"
112
+ end
113
+ # resource path
114
+ local_var_path = "/v1.1/whatsapp/deployments/{deploymentId}/code/confirm".sub('{' + 'deploymentId' + '}', deploymentId.to_s)
115
+
116
+ # query parameters
117
+ query_params = {}
118
+
119
+ # header parameters
120
+ header_params = {}
121
+ # HTTP header 'Accept' (if needed)
122
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
123
+ # HTTP header 'Content-Type'
124
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
125
+
126
+ # form parameters
127
+ form_params = {}
128
+
129
+ # http body (model)
130
+ post_body = @api_client.object_to_http_body(deploymentConfirmCode)
131
+ auth_names = ['jwt']
132
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
133
+ :header_params => header_params,
134
+ :query_params => query_params,
135
+ :form_params => form_params,
136
+ :body => post_body,
137
+ :auth_names => auth_names,
138
+ :return_type => 'DeploymentResponse')
139
+ if @api_client.config.debugging
140
+ @api_client.config.logger.debug "API called: DeploymentApi#confirm_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
141
+ end
142
+ return data, status_code, headers
143
+ end
144
+
145
+ #
146
+ # Create a WhatsApp deployment.
147
+ # @param deploymentCreateBody Body for a createDeployment request.
148
+ # @param [Hash] opts the optional parameters
149
+ # @return [DeploymentResponse]
150
+ def create_deployment(deploymentCreateBody, opts = {})
151
+ data, _status_code, _headers = create_deployment_with_http_info(deploymentCreateBody, opts)
152
+ return data
153
+ end
154
+
155
+ #
156
+ # Create a WhatsApp deployment.
157
+ # @param deploymentCreateBody Body for a createDeployment request.
158
+ # @param [Hash] opts the optional parameters
159
+ # @return [Array<(DeploymentResponse, Fixnum, Hash)>] DeploymentResponse data, response status code and response headers
160
+ def create_deployment_with_http_info(deploymentCreateBody, opts = {})
161
+ if @api_client.config.debugging
162
+ @api_client.config.logger.debug "Calling API: DeploymentApi.create_deployment ..."
163
+ end
164
+ # verify the required parameter 'deploymentCreateBody' is set
165
+ if @api_client.config.client_side_validation && deploymentCreateBody.nil?
166
+ fail ArgumentError, "Missing the required parameter 'deploymentCreateBody' when calling DeploymentApi.create_deployment"
167
+ end
168
+ # resource path
169
+ local_var_path = "/v1.1/whatsapp/deployments"
170
+
171
+ # query parameters
172
+ query_params = {}
173
+
174
+ # header parameters
175
+ header_params = {}
176
+ # HTTP header 'Accept' (if needed)
177
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
178
+ # HTTP header 'Content-Type'
179
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
180
+
181
+ # form parameters
182
+ form_params = {}
183
+
184
+ # http body (model)
185
+ post_body = @api_client.object_to_http_body(deploymentCreateBody)
186
+ auth_names = ['jwt']
187
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
188
+ :header_params => header_params,
189
+ :query_params => query_params,
190
+ :form_params => form_params,
191
+ :body => post_body,
192
+ :auth_names => auth_names,
193
+ :return_type => 'DeploymentResponse')
194
+ if @api_client.config.debugging
195
+ @api_client.config.logger.debug "API called: DeploymentApi#create_deployment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
196
+ end
197
+ return data, status_code, headers
198
+ end
199
+
200
+ #
201
+ # Delete the specified deployment.
202
+ # @param deploymentId Identifies the deployment.
203
+ # @param [Hash] opts the optional parameters
204
+ # @return [nil]
205
+ def delete_deployment(deploymentId, opts = {})
206
+ delete_deployment_with_http_info(deploymentId, opts)
207
+ return nil
208
+ end
209
+
210
+ #
211
+ # Delete the specified deployment.
212
+ # @param deploymentId Identifies the deployment.
213
+ # @param [Hash] opts the optional parameters
214
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
215
+ def delete_deployment_with_http_info(deploymentId, opts = {})
216
+ if @api_client.config.debugging
217
+ @api_client.config.logger.debug "Calling API: DeploymentApi.delete_deployment ..."
218
+ end
219
+ # verify the required parameter 'deploymentId' is set
220
+ if @api_client.config.client_side_validation && deploymentId.nil?
221
+ fail ArgumentError, "Missing the required parameter 'deploymentId' when calling DeploymentApi.delete_deployment"
222
+ end
223
+ # resource path
224
+ local_var_path = "/v1.1/whatsapp/deployments/{deploymentId}".sub('{' + 'deploymentId' + '}', deploymentId.to_s)
225
+
226
+ # query parameters
227
+ query_params = {}
228
+
229
+ # header parameters
230
+ header_params = {}
231
+ # HTTP header 'Accept' (if needed)
232
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
233
+ # HTTP header 'Content-Type'
234
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
235
+
236
+ # form parameters
237
+ form_params = {}
238
+
239
+ # http body (model)
240
+ post_body = nil
241
+ auth_names = ['jwt']
242
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
243
+ :header_params => header_params,
244
+ :query_params => query_params,
245
+ :form_params => form_params,
246
+ :body => post_body,
247
+ :auth_names => auth_names)
248
+ if @api_client.config.debugging
249
+ @api_client.config.logger.debug "API called: DeploymentApi#delete_deployment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
250
+ end
251
+ return data, status_code, headers
252
+ end
253
+
254
+ #
255
+ # Get the specified deployment.
256
+ # @param deploymentId Identifies the deployment.
257
+ # @param [Hash] opts the optional parameters
258
+ # @return [DeploymentResponse]
259
+ def get_deployment(deploymentId, opts = {})
260
+ data, _status_code, _headers = get_deployment_with_http_info(deploymentId, opts)
261
+ return data
262
+ end
263
+
264
+ #
265
+ # Get the specified deployment.
266
+ # @param deploymentId Identifies the deployment.
267
+ # @param [Hash] opts the optional parameters
268
+ # @return [Array<(DeploymentResponse, Fixnum, Hash)>] DeploymentResponse data, response status code and response headers
269
+ def get_deployment_with_http_info(deploymentId, opts = {})
270
+ if @api_client.config.debugging
271
+ @api_client.config.logger.debug "Calling API: DeploymentApi.get_deployment ..."
272
+ end
273
+ # verify the required parameter 'deploymentId' is set
274
+ if @api_client.config.client_side_validation && deploymentId.nil?
275
+ fail ArgumentError, "Missing the required parameter 'deploymentId' when calling DeploymentApi.get_deployment"
276
+ end
277
+ # resource path
278
+ local_var_path = "/v1.1/whatsapp/deployments/{deploymentId}".sub('{' + 'deploymentId' + '}', deploymentId.to_s)
279
+
280
+ # query parameters
281
+ query_params = {}
282
+
283
+ # header parameters
284
+ header_params = {}
285
+ # HTTP header 'Accept' (if needed)
286
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
287
+ # HTTP header 'Content-Type'
288
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
289
+
290
+ # form parameters
291
+ form_params = {}
292
+
293
+ # http body (model)
294
+ post_body = nil
295
+ auth_names = ['jwt']
296
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
297
+ :header_params => header_params,
298
+ :query_params => query_params,
299
+ :form_params => form_params,
300
+ :body => post_body,
301
+ :auth_names => auth_names,
302
+ :return_type => 'DeploymentResponse')
303
+ if @api_client.config.debugging
304
+ @api_client.config.logger.debug "API called: DeploymentApi#get_deployment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
305
+ end
306
+ return data, status_code, headers
307
+ end
308
+
309
+ #
310
+ # List owned WhatsApp deployments.
311
+ # @param [Hash] opts the optional parameters
312
+ # @return [ListDeploymentsResponse]
313
+ def list_deployments(opts = {})
314
+ data, _status_code, _headers = list_deployments_with_http_info(opts)
315
+ return data
316
+ end
317
+
318
+ #
319
+ # List owned WhatsApp deployments.
320
+ # @param [Hash] opts the optional parameters
321
+ # @return [Array<(ListDeploymentsResponse, Fixnum, Hash)>] ListDeploymentsResponse data, response status code and response headers
322
+ def list_deployments_with_http_info(opts = {})
323
+ if @api_client.config.debugging
324
+ @api_client.config.logger.debug "Calling API: DeploymentApi.list_deployments ..."
325
+ end
326
+ # resource path
327
+ local_var_path = "/v1.1/whatsapp/deployments"
328
+
329
+ # query parameters
330
+ query_params = {}
331
+
332
+ # header parameters
333
+ header_params = {}
334
+ # HTTP header 'Accept' (if needed)
335
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
336
+ # HTTP header 'Content-Type'
337
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
338
+
339
+ # form parameters
340
+ form_params = {}
341
+
342
+ # http body (model)
343
+ post_body = nil
344
+ auth_names = ['jwt']
345
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
346
+ :header_params => header_params,
347
+ :query_params => query_params,
348
+ :form_params => form_params,
349
+ :body => post_body,
350
+ :auth_names => auth_names,
351
+ :return_type => 'ListDeploymentsResponse')
352
+ if @api_client.config.debugging
353
+ @api_client.config.logger.debug "API called: DeploymentApi#list_deployments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
354
+ end
355
+ return data, status_code, headers
356
+ end
357
+ end
358
+ end