smooch-api 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05e5d6a5440db8ce57b931197715169fc4edfb7d
-  data.tar.gz: 2bcae2052b881bea6b028337f7aec9aac7dd0221
+  metadata.gz: cbc6519935c85fa63982cda656b45cd3caec708c
+  data.tar.gz: ec72878c467142b8ace5ab5b9f0b88bf9b2c7d44
 SHA512:
-  metadata.gz: f946c36ffc82d556c9b2390c683e2e71f4f08a5c386a7ca4b32ad3df35d2bb6b47fbf0d9752122f8d5f8fbe307a69581085dc2d582d3ce0f8e646d2be6752d99
-  data.tar.gz: 0371b77ece795b3df0e4bb8ad83ea39664bc6d10664ed6cbc4b2a4b6a9848b38949ec60ac3fce2f1e00cfd68f9b24a591cebdd797e7b632cd4082ecfc34933bb
+  metadata.gz: 1f65a813f1bd8277ce08beef16e0097856c2963124c889d993dbc73a99618c9798fcf6dc309ab1bb3b64266f4f0800549bde572089a5414a8e9e47edbe1419b1
+  data.tar.gz: 34cf9ab375a81ddc3570bfb77bcb1c1cc23260b4f8ef19f91eb704e74f04e134946fd94f36f04459e06c9d177a3b2a2fe2e81ecd3d3dac0a80b1bdf6537db7ed

data/README.md

@@ -16,7 +16,7 @@ gem install smooch-api
 
 Add this to the Gemfile:
 
-    gem 'smooch-api', '~> 1.2.0'
+    gem 'smooch-api', '~> 1.3.0'
 
 ## Getting Started
 
@@ -87,6 +87,7 @@ Class | Method | HTTP request | Description
 *SmoochApi::AppApi* | [**get_secret_key**](docs/AppApi.md#get_secret_key) | **GET** /apps/{appId}/keys/{keyId} | 
 *SmoochApi::AppApi* | [**list_apps**](docs/AppApi.md#list_apps) | **GET** /apps | 
 *SmoochApi::AppApi* | [**list_secret_keys**](docs/AppApi.md#list_secret_keys) | **GET** /apps/{appId}/keys | 
+*SmoochApi::AppApi* | [**update_app**](docs/AppApi.md#update_app) | **PUT** /apps/{appId} | 
 *SmoochApi::AppUserApi* | [**app_user_device_update**](docs/AppUserApi.md#app_user_device_update) | **PUT** /appusers/{userId}/devices/{deviceId} | 
 *SmoochApi::AppUserApi* | [**delete_app_user_profile**](docs/AppUserApi.md#delete_app_user_profile) | **DELETE** /appusers/{userId}/profile | 
 *SmoochApi::AppUserApi* | [**get_app_user**](docs/AppUserApi.md#get_app_user) | **GET** /appusers/{userId} | 
@@ -127,6 +128,8 @@ Class | Method | HTTP request | Description
  - [SmoochApi::App](docs/App.md)
  - [SmoochApi::AppCreate](docs/AppCreate.md)
  - [SmoochApi::AppResponse](docs/AppResponse.md)
+ - [SmoochApi::AppSettings](docs/AppSettings.md)
+ - [SmoochApi::AppUpdate](docs/AppUpdate.md)
  - [SmoochApi::AppUser](docs/AppUser.md)
  - [SmoochApi::AppUserLink](docs/AppUserLink.md)
  - [SmoochApi::AppUserPreCreate](docs/AppUserPreCreate.md)

data/docs/App.md

@@ -6,5 +6,6 @@ Name | Type | Description | Notes
 **_id** | **String** | The app's ID. | 
 **app_token** | **String** | The appToken, used to initialize the Web, iOS and Android clients and to make calls to the app user facing API. | 
 **name** | **String** | The app's name. | 
+**settings** | [**AppSettings**](AppSettings.md) |  | [optional] 
 
 

data/docs/AppApi.md

@@ -13,6 +13,7 @@ Method | HTTP request | Description
 [**get_secret_key**](AppApi.md#get_secret_key) | **GET** /apps/{appId}/keys/{keyId} | 
 [**list_apps**](AppApi.md#list_apps) | **GET** /apps | 
 [**list_secret_keys**](AppApi.md#list_secret_keys) | **GET** /apps/{appId}/keys | 
+[**update_app**](AppApi.md#update_app) | **PUT** /apps/{appId} | 
 
 
 # **create_app**
@@ -496,3 +497,58 @@ Name | Type | Description  | Notes
 
 
 
+# **update_app**
+> AppResponse update_app(app_id, app_update_body)
+
+
+
+Update the specified app.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure API key authorization: jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::AppApi.new
+
+app_id = "app_id_example" # String | Identifies the app.
+
+app_update_body = SmoochApi::AppUpdate.new # AppUpdate | Body for an updateApp request.
+
+
+begin
+  result = api_instance.update_app(app_id, app_update_body)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling AppApi->update_app: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **app_id** | **String**| Identifies the app. | 
+ **app_update_body** | [**AppUpdate**](AppUpdate.md)| Body for an updateApp request. | 
+
+### Return type
+
+[**AppResponse**](AppResponse.md)
+
+### Authorization
+
+[jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/AppCreate.md

@@ -4,5 +4,6 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **String** | The app's name. | 
+**settings** | [**AppSettings**](AppSettings.md) |  | [optional] 
 
 

data/docs/AppSettings.md

@@ -0,0 +1,8 @@
+# SmoochApi::AppSettings
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**mask_credit_card_numbers** | **BOOLEAN** | Flag specifying whether credit card numbers will be automatically masked if sent through Smooch. | [optional] 
+
+

data/docs/AppUpdate.md

@@ -0,0 +1,9 @@
+# SmoochApi::AppUpdate
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The app's name. | 
+**settings** | [**AppSettings**](AppSettings.md) |  | [optional] 
+
+

data/lib/smooch-api.rb

@@ -3,7 +3,7 @@
 
 #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).
 
-OpenAPI spec version: 1.2
+OpenAPI spec version: 1.3
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -21,6 +21,8 @@ require 'smooch-api/models/action'
 require 'smooch-api/models/app'
 require 'smooch-api/models/app_create'
 require 'smooch-api/models/app_response'
+require 'smooch-api/models/app_settings'
+require 'smooch-api/models/app_update'
 require 'smooch-api/models/app_user'
 require 'smooch-api/models/app_user_link'
 require 'smooch-api/models/app_user_pre_create'

data/lib/smooch-api/api/app_api.rb

@@ -3,7 +3,7 @@
 
 #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).
 
-OpenAPI spec version: 1.2
+OpenAPI spec version: 1.3
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -536,5 +536,66 @@ module SmoochApi
       end
       return data, status_code, headers
     end
+
+    # 
+    # Update the specified app.
+    # @param app_id Identifies the app.
+    # @param app_update_body Body for an updateApp request.
+    # @param [Hash] opts the optional parameters
+    # @return [AppResponse]
+    def update_app(app_id, app_update_body, opts = {})
+      data, _status_code, _headers = update_app_with_http_info(app_id, app_update_body, opts)
+      return data
+    end
+
+    # 
+    # Update the specified app.
+    # @param app_id Identifies the app.
+    # @param app_update_body Body for an updateApp request.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AppResponse, Fixnum, Hash)>] AppResponse data, response status code and response headers
+    def update_app_with_http_info(app_id, app_update_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AppApi.update_app ..."
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling AppApi.update_app"
+      end
+      # verify the required parameter 'app_update_body' is set
+      if @api_client.config.client_side_validation && app_update_body.nil?
+        fail ArgumentError, "Missing the required parameter 'app_update_body' when calling AppApi.update_app"
+      end
+      # resource path
+      local_var_path = "/apps/{appId}".sub('{' + 'appId' + '}', app_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(app_update_body)
+      auth_names = ['jwt']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'AppResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AppApi#update_app\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/smooch-api/api/app_user_api.rb

@@ -3,7 +3,7 @@
 
 #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).
 
-OpenAPI spec version: 1.2
+OpenAPI spec version: 1.3
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

data/lib/smooch-api/api/conversation_api.rb

@@ -3,7 +3,7 @@
 
 #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).
 
-OpenAPI spec version: 1.2
+OpenAPI spec version: 1.3
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

data/lib/smooch-api/api/init_api.rb

@@ -3,7 +3,7 @@
 
 #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).
 
-OpenAPI spec version: 1.2
+OpenAPI spec version: 1.3
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

data/lib/smooch-api/api/integration_api.rb

@@ -3,7 +3,7 @@
 
 #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).
 
-OpenAPI spec version: 1.2
+OpenAPI spec version: 1.3
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

data/lib/smooch-api/api/menu_api.rb

@@ -3,7 +3,7 @@
 
 #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).
 
-OpenAPI spec version: 1.2
+OpenAPI spec version: 1.3
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

data/lib/smooch-api/api/webhook_api.rb

@@ -3,7 +3,7 @@
 
 #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).
 
-OpenAPI spec version: 1.2
+OpenAPI spec version: 1.3
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

data/lib/smooch-api/api_client.rb

@@ -3,7 +3,7 @@
 
 #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).
 
-OpenAPI spec version: 1.2
+OpenAPI spec version: 1.3
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

data/lib/smooch-api/api_error.rb

@@ -3,7 +3,7 @@
 
 #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).
 
-OpenAPI spec version: 1.2
+OpenAPI spec version: 1.3
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

data/lib/smooch-api/configuration.rb

@@ -3,7 +3,7 @@
 
 #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).
 
-OpenAPI spec version: 1.2
+OpenAPI spec version: 1.3
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

data/lib/smooch-api/models/action.rb

@@ -3,7 +3,7 @@
 
 #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).
 
-OpenAPI spec version: 1.2
+OpenAPI spec version: 1.3
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT

data/lib/smooch-api/models/app.rb

@@ -3,7 +3,7 @@
 
 #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).
 
-OpenAPI spec version: 1.2
+OpenAPI spec version: 1.3
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -24,13 +24,16 @@ module SmoochApi
     # The app's name.
     attr_accessor :name
 
+    attr_accessor :settings
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'_id' => :'_id',
         :'app_token' => :'appToken',
-        :'name' => :'name'
+        :'name' => :'name',
+        :'settings' => :'settings'
       }
     end
 
@@ -39,7 +42,8 @@ module SmoochApi
       {
         :'_id' => :'String',
         :'app_token' => :'String',
-        :'name' => :'String'
+        :'name' => :'String',
+        :'settings' => :'AppSettings'
       }
     end
 
@@ -63,6 +67,10 @@ module SmoochApi
         self.name = attributes[:'name']
       end
 
+      if attributes.has_key?(:'settings')
+        self.settings = attributes[:'settings']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -100,7 +108,8 @@ module SmoochApi
       self.class == o.class &&
           _id == o._id &&
           app_token == o.app_token &&
-          name == o.name
+          name == o.name &&
+          settings == o.settings
     end
 
     # @see the `==` method
@@ -112,7 +121,7 @@ module SmoochApi
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [_id, app_token, name].hash
+      [_id, app_token, name, settings].hash
     end
 
     # Builds the object from hash

data/lib/smooch-api/models/app_create.rb

@@ -3,7 +3,7 @@
 
 #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).
 
-OpenAPI spec version: 1.2
+OpenAPI spec version: 1.3
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: 2.2.3-SNAPSHOT
@@ -18,18 +18,22 @@ module SmoochApi
     # The app's name.
     attr_accessor :name
 
+    attr_accessor :settings
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'name' => :'name'
+        :'name' => :'name',
+        :'settings' => :'settings'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'name' => :'String'
+        :'name' => :'String',
+        :'settings' => :'AppSettings'
       }
     end
 
@@ -45,6 +49,10 @@ module SmoochApi
         self.name = attributes[:'name']
       end
 
+      if attributes.has_key?(:'settings')
+        self.settings = attributes[:'settings']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -70,7 +78,8 @@ module SmoochApi
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          name == o.name
+          name == o.name &&
+          settings == o.settings
     end
 
     # @see the `==` method
@@ -82,7 +91,7 @@ module SmoochApi
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name].hash
+      [name, settings].hash
     end
 
     # Builds the object from hash