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
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 53a7d1c10ebc05bd858a1f7e34aed70776feafca
4
- data.tar.gz: eb9db340fb6c330d0e2c4a65d58b7c0e1fb34f22
3
+ metadata.gz: eacfbd23af7878fa101cff6c9e700895d9fc048a
4
+ data.tar.gz: 207c01673bbc715c2db72ceebcf4fdfea7e34606
5
5
  SHA512:
6
- metadata.gz: 88d2c67d5042d53d665c517132e89a95364742b241a4b6373067aba09c6082a31033dcc522b59b7b2b1768514bb66d72b0f2e08eac12bc3895389c346087b86f
7
- data.tar.gz: dde5f758bf76b0e0d0edb6b1e2852ed7639604aace7d08641e96e2c04031d0fb8fa2e0b0fd3d443e4cd0ed924e8c52707df65de8d734b5fd03b9f05c8a1ec779
6
+ metadata.gz: 53e33e973b0c935dbf6b004a2de6b1275cca123eb05b43c45988a2c310114976a5e9b5c1fd629b0676dd98fda029e9d3a0979b253731db493b6d4bf70c77a5d5
7
+ data.tar.gz: f6dace030dccacf39407b45b7cc4adf03d948c68deee88f47205e4f4c3b77943b556faf95a5c352a59aeaf5377f9f884917aefc7bd1f4d15ed76411744196f49
data/README.md CHANGED
@@ -25,7 +25,7 @@ gem install smooch-api
25
25
 
26
26
  Add this to the Gemfile:
27
27
 
28
- gem 'smooch-api', '~> 5.7.0'
28
+ gem 'smooch-api', '~> 5.8.0'
29
29
 
30
30
  ## Getting Started
31
31
 
@@ -129,6 +129,12 @@ Class | Method | HTTP request | Description
129
129
  *SmoochApi::ConversationApi* | [**get_messages**](docs/ConversationApi.md#get_messages) | **GET** /v1.1/apps/{appId}/appusers/{userId}/messages |
130
130
  *SmoochApi::ConversationApi* | [**post_message**](docs/ConversationApi.md#post_message) | **POST** /v1.1/apps/{appId}/appusers/{userId}/messages |
131
131
  *SmoochApi::ConversationApi* | [**reset_unread_count**](docs/ConversationApi.md#reset_unread_count) | **POST** /v1.1/apps/{appId}/appusers/{userId}/conversation/read |
132
+ *SmoochApi::DeploymentApi* | [**activate_phone_number**](docs/DeploymentApi.md#activate_phone_number) | **POST** /v1.1/whatsapp/deployments/{deploymentId}/activate |
133
+ *SmoochApi::DeploymentApi* | [**confirm_code**](docs/DeploymentApi.md#confirm_code) | **POST** /v1.1/whatsapp/deployments/{deploymentId}/code/confirm |
134
+ *SmoochApi::DeploymentApi* | [**create_deployment**](docs/DeploymentApi.md#create_deployment) | **POST** /v1.1/whatsapp/deployments |
135
+ *SmoochApi::DeploymentApi* | [**delete_deployment**](docs/DeploymentApi.md#delete_deployment) | **DELETE** /v1.1/whatsapp/deployments/{deploymentId} |
136
+ *SmoochApi::DeploymentApi* | [**get_deployment**](docs/DeploymentApi.md#get_deployment) | **GET** /v1.1/whatsapp/deployments/{deploymentId} |
137
+ *SmoochApi::DeploymentApi* | [**list_deployments**](docs/DeploymentApi.md#list_deployments) | **GET** /v1.1/whatsapp/deployments |
132
138
  *SmoochApi::IntegrationApi* | [**create_integration**](docs/IntegrationApi.md#create_integration) | **POST** /v1.1/apps/{appId}/integrations |
133
139
  *SmoochApi::IntegrationApi* | [**create_integration_menu**](docs/IntegrationApi.md#create_integration_menu) | **POST** /v1.1/apps/{appId}/integrations/{integrationId}/menu |
134
140
  *SmoochApi::IntegrationApi* | [**delete_integration**](docs/IntegrationApi.md#delete_integration) | **DELETE** /v1.1/apps/{appId}/integrations/{integrationId} |
@@ -191,6 +197,11 @@ Class | Method | HTTP request | Description
191
197
  - [SmoochApi::Confirmation](docs/Confirmation.md)
192
198
  - [SmoochApi::Conversation](docs/Conversation.md)
193
199
  - [SmoochApi::ConversationActivity](docs/ConversationActivity.md)
200
+ - [SmoochApi::Deployment](docs/Deployment.md)
201
+ - [SmoochApi::DeploymentActivatePhoneNumber](docs/DeploymentActivatePhoneNumber.md)
202
+ - [SmoochApi::DeploymentConfirmCode](docs/DeploymentConfirmCode.md)
203
+ - [SmoochApi::DeploymentCreate](docs/DeploymentCreate.md)
204
+ - [SmoochApi::DeploymentResponse](docs/DeploymentResponse.md)
194
205
  - [SmoochApi::Destination](docs/Destination.md)
195
206
  - [SmoochApi::DisplaySettings](docs/DisplaySettings.md)
196
207
  - [SmoochApi::Enums](docs/Enums.md)
@@ -205,6 +216,7 @@ Class | Method | HTTP request | Description
205
216
  - [SmoochApi::LinkRequestResponse](docs/LinkRequestResponse.md)
206
217
  - [SmoochApi::LinkRequestResponseLinkRequests](docs/LinkRequestResponseLinkRequests.md)
207
218
  - [SmoochApi::ListAppsResponse](docs/ListAppsResponse.md)
219
+ - [SmoochApi::ListDeploymentsResponse](docs/ListDeploymentsResponse.md)
208
220
  - [SmoochApi::ListIntegrationsResponse](docs/ListIntegrationsResponse.md)
209
221
  - [SmoochApi::ListSecretKeysResponse](docs/ListSecretKeysResponse.md)
210
222
  - [SmoochApi::ListServiceAccountsResponse](docs/ListServiceAccountsResponse.md)
data/docs/Action.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | The action type. See Enums.md for available values. |
6
+ **type** | **String** | The action type. See [**ActionTypeEnum**](Enums.md#ActionTypeEnum) for available values. |
7
7
  **text** | **String** | The button text. |
8
8
  **payload** | **String** | The payload to be sent with the resulting webhook. Required for *postback* and *reply* actions. | [optional]
9
9
  **metadata** | **Object** | Flat JSON object containing any custom properties associated with the action. | [optional]
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
13
13
  **iconUrl** | **String** | An icon to render next to the reply option (Facebook Messenger and Web Messenger only). | [optional]
14
14
  **uri** | **String** | The action URI. This is the link that will be used in the clients when clicking the button. Required for *link* and *webview* actions. | [optional]
15
15
  **fallback** | **String** | The webview action fallback uri. This is the link that will be used in clients that do not support webviews. Required for *webview* actions. | [optional]
16
- **size** | **String** | The size used to display the webview. Allowed values are [\"compact\", \"tall\", \"full\"]. (Optional) Used for *webview* actions. See Enums.md for available values. | [optional]
16
+ **size** | **String** | The size used to display the webview. Allowed values are [\"compact\", \"tall\", \"full\"]. (Optional) Used for *webview* actions. See [**ActionSizeEnum**](Enums.md#ActionSizeEnum) for available values. | [optional]
17
17
  **extraChannelOptions** | **Object** | Extra options to pass directly to the channel API. See [Extra Channel Options](https://docs.smooch.io/rest#extra-channel-options-schema) | [optional]
18
18
 
19
19
 
data/docs/AppUserLink.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | The type of the channel to link. See Enums.md for available values. |
6
+ **type** | **String** | The type of the channel to link. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. |
7
7
  **phoneNumber** | **String** | A String of the appUser’s phone number. It must contain the + prefix and the country code. Required for *messenger*, *twilio*, *messagebird* and *whatsapp* linking. | [optional]
8
8
  **address** | **String** | A String of the appUser’s email address. Required for *mailgun* linking. | [optional]
9
9
  **givenName** | **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]
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | The type of business system. See Enums.md for available values. |
6
+ **type** | **String** | The type of business system. See [**BusinessSystemTypeEnum**](Enums.md#BusinessSystemTypeEnum) for available values. |
7
7
  **channelId** | **String** | The channel id for a *slack* integration | [optional]
8
8
  **ticketId** | **String** | The ticket id for a *zendesk* integration | [optional]
9
9
  **roomId** | **Integer** | The room id for a *hipchat* integration | [optional]
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | The type of channel. See Enums.md for available values. |
6
+ **type** | **String** | The type of channel. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. |
7
7
  **integrationId** | **String** | The ID of the integration. | [optional]
8
8
  **phoneNumber** | **String** | The phone number for a *twilio* or *messagebird* integration | [optional]
9
9
  **userId** | **String** | The userId for a *messenger*, *viber*, *line*, *wechat* or *twitter* integration | [optional]
data/docs/Client.md CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
  **id** | **String** | An identifier for the client. Must be globally unique. |
7
7
  **active** | **BOOLEAN** | Flag indicating if the client is active. | [optional]
8
8
  **lastSeen** | **String** | The date time the client was last seen. | [optional]
9
- **platform** | **String** | The client's platform. See Enums.md for available values. |
9
+ **platform** | **String** | The client's platform. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. |
10
10
  **integrationId** | **String** | The ID of the integration that the client was created for. | [optional]
11
11
  **pushNotificationToken** | **String** | The GCM or APN token to be used for sending push notifications to the device. Applies to only *android* and *ios* clients. | [optional]
12
12
  **appVersion** | **String** | A reserved string field for reporting the app version running on the device. | [optional]
data/docs/Confirmation.md CHANGED
@@ -3,7 +3,7 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **type** | **String** | The confirmation type. See Enums.md for available values. |
6
+ **type** | **String** | The confirmation type. See [**ConfirmationTypeEnum**](Enums.md#ConfirmationTypeEnum) for available values. |
7
7
  **message** | [**Message**](Message.md) | The message used to reach out to the user. Must be a valid message object as per the post message API. | [optional]
8
8
 
9
9
 
@@ -3,8 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **role** | **String** | The role of the actor. Must be *appMaker*. See Enums.md for available values. |
7
- **type** | **String** | The type of activity to trigger. Must be either *typing:start* or *typing:stop*. See Enums.md for available values. |
6
+ **role** | **String** | The role of the actor. Must be *appMaker*. See [**RoleEnum**](Enums.md#RoleEnum) for available values. |
7
+ **type** | **String** | The type of activity to trigger. Must be either *typing:start* or *typing:stop*. See [**MessageTypeEnum**](Enums.md#MessageTypeEnum) for available values. |
8
8
  **name** | **String** | The name of the app maker that starts or stops typing a response. | [optional]
9
9
  **avatarUrl** | **String** | The avatar URL of the app maker that starts typing a response. | [optional]
10
10
 
@@ -0,0 +1,17 @@
1
+ # SmoochApi::Deployment
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | The deployment ID, generated automatically. |
7
+ **status** | **String** | The deployment status. See [**DeploymentStatusEnum**](Enums.md#DeploymentStatusEnum) for available values. |
8
+ **hosting** | **String** | The deployment hosting. See [**DeploymentHostingEnum**](Enums.md#DeploymentHostingEnum) for available values. |
9
+ **baseUrl** | **String** | The baseUrl of the deployment. Only present for `self` hosted deployments. | [optional]
10
+ **username** | **String** | The username of the deployment. Only present for `self` hosted deployments. | [optional]
11
+ **phoneNumber** | **String** | The phoneNumber of the deployment. Only present once the deployment has been registered. | [optional]
12
+ **callbackUrl** | **String** | The URL to be called by Smooch when the status of the deployment changes. | [optional]
13
+ **callbackSecret** | **String** | The secret used to secure the callback. | [optional]
14
+ **integrationId** | **String** | The integrationId of the integration using this deployment. | [optional]
15
+ **appId** | **String** | The appId of the integration using this deployment. | [optional]
16
+
17
+
@@ -0,0 +1,10 @@
1
+ # SmoochApi::DeploymentActivatePhoneNumber
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **phoneNumber** | **String** | The phone number to send the activation code to. |
7
+ **verifiedNameCertificate** | **String** | The verified name certificate for the phone number. |
8
+ **method** | **String** | The method desired to receive the activation code. See [**DeploymentActivationMethodEnum**](Enums.md#DeploymentActivationMethodEnum) for available values. |
9
+
10
+
@@ -0,0 +1,325 @@
1
+ # SmoochApi::DeploymentApi
2
+
3
+ All URIs are relative to *https://api.smooch.io*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**activate_phone_number**](DeploymentApi.md#activate_phone_number) | **POST** /v1.1/whatsapp/deployments/{deploymentId}/activate |
8
+ [**confirm_code**](DeploymentApi.md#confirm_code) | **POST** /v1.1/whatsapp/deployments/{deploymentId}/code/confirm |
9
+ [**create_deployment**](DeploymentApi.md#create_deployment) | **POST** /v1.1/whatsapp/deployments |
10
+ [**delete_deployment**](DeploymentApi.md#delete_deployment) | **DELETE** /v1.1/whatsapp/deployments/{deploymentId} |
11
+ [**get_deployment**](DeploymentApi.md#get_deployment) | **GET** /v1.1/whatsapp/deployments/{deploymentId} |
12
+ [**list_deployments**](DeploymentApi.md#list_deployments) | **GET** /v1.1/whatsapp/deployments |
13
+
14
+
15
+ # **activate_phone_number**
16
+ > DeploymentResponse activate_phone_number(deploymentId, deploymentActivatePhoneNumberBody)
17
+
18
+
19
+
20
+ Activate a phone number on the specified deployment.
21
+
22
+ ### Example
23
+ ```ruby
24
+ # load the gem
25
+ require 'smooch-api'
26
+ # setup authorization
27
+ SmoochApi.configure do |config|
28
+ # Configure API key authorization: jwt
29
+ config.api_key['Authorization'] = 'YOUR JWT'
30
+ config.api_key_prefix['Authorization'] = 'Bearer'
31
+ end
32
+
33
+ api_instance = SmoochApi::DeploymentApi.new
34
+
35
+ deploymentId = "deploymentId_example" # String | Identifies the deployment.
36
+
37
+ deploymentActivatePhoneNumberBody = SmoochApi::DeploymentActivatePhoneNumber.new # DeploymentActivatePhoneNumber | Body for an activatePhoneNumber request.
38
+
39
+
40
+ begin
41
+ result = api_instance.activate_phone_number(deploymentId, deploymentActivatePhoneNumberBody)
42
+ p result
43
+ rescue SmoochApi::ApiError => e
44
+ puts "Exception when calling DeploymentApi->activate_phone_number: #{e}"
45
+ end
46
+ ```
47
+
48
+ ### Parameters
49
+
50
+ Name | Type | Description | Notes
51
+ ------------- | ------------- | ------------- | -------------
52
+ **deploymentId** | **String**| Identifies the deployment. |
53
+ **deploymentActivatePhoneNumberBody** | [**DeploymentActivatePhoneNumber**](DeploymentActivatePhoneNumber.md)| Body for an activatePhoneNumber request. |
54
+
55
+ ### Return type
56
+
57
+ [**DeploymentResponse**](DeploymentResponse.md)
58
+
59
+ ### Authorization
60
+
61
+ [jwt](../README.md#jwt)
62
+
63
+ ### HTTP request headers
64
+
65
+ - **Content-Type**: application/json
66
+ - **Accept**: application/json
67
+
68
+
69
+
70
+ # **confirm_code**
71
+ > DeploymentResponse confirm_code(deploymentId, deploymentConfirmCode)
72
+
73
+
74
+
75
+ Confirm code to complete phone number activation.
76
+
77
+ ### Example
78
+ ```ruby
79
+ # load the gem
80
+ require 'smooch-api'
81
+ # setup authorization
82
+ SmoochApi.configure do |config|
83
+ # Configure API key authorization: jwt
84
+ config.api_key['Authorization'] = 'YOUR JWT'
85
+ config.api_key_prefix['Authorization'] = 'Bearer'
86
+ end
87
+
88
+ api_instance = SmoochApi::DeploymentApi.new
89
+
90
+ deploymentId = "deploymentId_example" # String | Identifies the deployment.
91
+
92
+ deploymentConfirmCode = SmoochApi::DeploymentConfirmCode.new # DeploymentConfirmCode | Body for a confirmCode request.
93
+
94
+
95
+ begin
96
+ result = api_instance.confirm_code(deploymentId, deploymentConfirmCode)
97
+ p result
98
+ rescue SmoochApi::ApiError => e
99
+ puts "Exception when calling DeploymentApi->confirm_code: #{e}"
100
+ end
101
+ ```
102
+
103
+ ### Parameters
104
+
105
+ Name | Type | Description | Notes
106
+ ------------- | ------------- | ------------- | -------------
107
+ **deploymentId** | **String**| Identifies the deployment. |
108
+ **deploymentConfirmCode** | [**DeploymentConfirmCode**](DeploymentConfirmCode.md)| Body for a confirmCode request. |
109
+
110
+ ### Return type
111
+
112
+ [**DeploymentResponse**](DeploymentResponse.md)
113
+
114
+ ### Authorization
115
+
116
+ [jwt](../README.md#jwt)
117
+
118
+ ### HTTP request headers
119
+
120
+ - **Content-Type**: application/json
121
+ - **Accept**: application/json
122
+
123
+
124
+
125
+ # **create_deployment**
126
+ > DeploymentResponse create_deployment(deploymentCreateBody)
127
+
128
+
129
+
130
+ Create a WhatsApp deployment.
131
+
132
+ ### Example
133
+ ```ruby
134
+ # load the gem
135
+ require 'smooch-api'
136
+ # setup authorization
137
+ SmoochApi.configure do |config|
138
+ # Configure API key authorization: jwt
139
+ config.api_key['Authorization'] = 'YOUR JWT'
140
+ config.api_key_prefix['Authorization'] = 'Bearer'
141
+ end
142
+
143
+ api_instance = SmoochApi::DeploymentApi.new
144
+
145
+ deploymentCreateBody = SmoochApi::DeploymentCreate.new # DeploymentCreate | Body for a createDeployment request.
146
+
147
+
148
+ begin
149
+ result = api_instance.create_deployment(deploymentCreateBody)
150
+ p result
151
+ rescue SmoochApi::ApiError => e
152
+ puts "Exception when calling DeploymentApi->create_deployment: #{e}"
153
+ end
154
+ ```
155
+
156
+ ### Parameters
157
+
158
+ Name | Type | Description | Notes
159
+ ------------- | ------------- | ------------- | -------------
160
+ **deploymentCreateBody** | [**DeploymentCreate**](DeploymentCreate.md)| Body for a createDeployment request. |
161
+
162
+ ### Return type
163
+
164
+ [**DeploymentResponse**](DeploymentResponse.md)
165
+
166
+ ### Authorization
167
+
168
+ [jwt](../README.md#jwt)
169
+
170
+ ### HTTP request headers
171
+
172
+ - **Content-Type**: application/json
173
+ - **Accept**: application/json
174
+
175
+
176
+
177
+ # **delete_deployment**
178
+ > delete_deployment(deploymentId, )
179
+
180
+
181
+
182
+ Delete the specified deployment.
183
+
184
+ ### Example
185
+ ```ruby
186
+ # load the gem
187
+ require 'smooch-api'
188
+ # setup authorization
189
+ SmoochApi.configure do |config|
190
+ # Configure API key authorization: jwt
191
+ config.api_key['Authorization'] = 'YOUR JWT'
192
+ config.api_key_prefix['Authorization'] = 'Bearer'
193
+ end
194
+
195
+ api_instance = SmoochApi::DeploymentApi.new
196
+
197
+ deploymentId = "deploymentId_example" # String | Identifies the deployment.
198
+
199
+
200
+ begin
201
+ api_instance.delete_deployment(deploymentId, )
202
+ rescue SmoochApi::ApiError => e
203
+ puts "Exception when calling DeploymentApi->delete_deployment: #{e}"
204
+ end
205
+ ```
206
+
207
+ ### Parameters
208
+
209
+ Name | Type | Description | Notes
210
+ ------------- | ------------- | ------------- | -------------
211
+ **deploymentId** | **String**| Identifies the deployment. |
212
+
213
+ ### Return type
214
+
215
+ nil (empty response body)
216
+
217
+ ### Authorization
218
+
219
+ [jwt](../README.md#jwt)
220
+
221
+ ### HTTP request headers
222
+
223
+ - **Content-Type**: application/json
224
+ - **Accept**: application/json
225
+
226
+
227
+
228
+ # **get_deployment**
229
+ > DeploymentResponse get_deployment(deploymentId, )
230
+
231
+
232
+
233
+ Get the specified deployment.
234
+
235
+ ### Example
236
+ ```ruby
237
+ # load the gem
238
+ require 'smooch-api'
239
+ # setup authorization
240
+ SmoochApi.configure do |config|
241
+ # Configure API key authorization: jwt
242
+ config.api_key['Authorization'] = 'YOUR JWT'
243
+ config.api_key_prefix['Authorization'] = 'Bearer'
244
+ end
245
+
246
+ api_instance = SmoochApi::DeploymentApi.new
247
+
248
+ deploymentId = "deploymentId_example" # String | Identifies the deployment.
249
+
250
+
251
+ begin
252
+ result = api_instance.get_deployment(deploymentId, )
253
+ p result
254
+ rescue SmoochApi::ApiError => e
255
+ puts "Exception when calling DeploymentApi->get_deployment: #{e}"
256
+ end
257
+ ```
258
+
259
+ ### Parameters
260
+
261
+ Name | Type | Description | Notes
262
+ ------------- | ------------- | ------------- | -------------
263
+ **deploymentId** | **String**| Identifies the deployment. |
264
+
265
+ ### Return type
266
+
267
+ [**DeploymentResponse**](DeploymentResponse.md)
268
+
269
+ ### Authorization
270
+
271
+ [jwt](../README.md#jwt)
272
+
273
+ ### HTTP request headers
274
+
275
+ - **Content-Type**: application/json
276
+ - **Accept**: application/json
277
+
278
+
279
+
280
+ # **list_deployments**
281
+ > ListDeploymentsResponse list_deployments
282
+
283
+
284
+
285
+ List owned WhatsApp deployments.
286
+
287
+ ### Example
288
+ ```ruby
289
+ # load the gem
290
+ require 'smooch-api'
291
+ # setup authorization
292
+ SmoochApi.configure do |config|
293
+ # Configure API key authorization: jwt
294
+ config.api_key['Authorization'] = 'YOUR JWT'
295
+ config.api_key_prefix['Authorization'] = 'Bearer'
296
+ end
297
+
298
+ api_instance = SmoochApi::DeploymentApi.new
299
+
300
+ begin
301
+ result = api_instance.list_deployments
302
+ p result
303
+ rescue SmoochApi::ApiError => e
304
+ puts "Exception when calling DeploymentApi->list_deployments: #{e}"
305
+ end
306
+ ```
307
+
308
+ ### Parameters
309
+ This endpoint does not need any parameter.
310
+
311
+ ### Return type
312
+
313
+ [**ListDeploymentsResponse**](ListDeploymentsResponse.md)
314
+
315
+ ### Authorization
316
+
317
+ [jwt](../README.md#jwt)
318
+
319
+ ### HTTP request headers
320
+
321
+ - **Content-Type**: application/json
322
+ - **Accept**: application/json
323
+
324
+
325
+