smooch-api 5.25.1 → 5.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6953361cda33e901ed5ad46d57bc4ec2f43bbff4
-  data.tar.gz: 170cd69494f5fd36f1b3195b01a39a2e8d436f68
+  metadata.gz: e2727c1b447fe8d1aa90b56594946efb1b2e72c5
+  data.tar.gz: 9e8963b11b0a1f30d8653c6f0c51f507176e6afb
 SHA512:
-  metadata.gz: 8fa92ec43a8e0524d3b84fe0d9ec5aaa86d4c6424d656792e245443332f3afbfb77dbcb39bb4fcbec2f432f11a7d8be6e7a67110d0b32145f26a0ed2c05ee26b
-  data.tar.gz: 5e04fb67c58ea79f96853455c1406642458eeb329a93c958fb248e887f0e68a099247e50bfaee468cb5b3cc0c5b05c9d779ab5c3fac7a7971bd4e5a8e9cdbe15
+  metadata.gz: b11f0920c3dd52f00dd66a408622bfe6dbe2dd4aa78cbc60bf3b33f2cf78099a90b2270f170f531d1dcb14ad1b81886e7dbc42d5bb05ec84376d61ba236700b8
+  data.tar.gz: 1c68d47c89909996083ea286fa56f2e662cea97572c5f0f9fa5e7b178c913f5f7e17808174f35b2a2200caeb18214dcb9cc50f142b0ecbc465c6bc675c2772b1

data/README.md

@@ -25,7 +25,7 @@ gem install smooch-api
 
 Add this to the Gemfile:
 
-    gem 'smooch-api', '~> 5.25.1'
+    gem 'smooch-api', '~> 5.26.0'
 
 ## Getting Started
 
@@ -156,6 +156,7 @@ Class | Method | HTTP request | Description
 *SmoochApi::MenuApi* | [**delete_menu**](docs/MenuApi.md#delete_menu) | **DELETE** /v1.1/apps/{appId}/menu | 
 *SmoochApi::MenuApi* | [**get_menu**](docs/MenuApi.md#get_menu) | **GET** /v1.1/apps/{appId}/menu | 
 *SmoochApi::MenuApi* | [**update_menu**](docs/MenuApi.md#update_menu) | **PUT** /v1.1/apps/{appId}/menu | 
+*SmoochApi::NotificationApi* | [**post_notification**](docs/NotificationApi.md#post_notification) | **POST** /v1/apps/{appId}/notifications | 
 *SmoochApi::ServiceAccountApi* | [**create_secret_key**](docs/ServiceAccountApi.md#create_secret_key) | **POST** /v1.1/serviceaccounts/{serviceAccountId}/keys | 
 *SmoochApi::ServiceAccountApi* | [**create_service_account**](docs/ServiceAccountApi.md#create_service_account) | **POST** /v1.1/serviceaccounts | 
 *SmoochApi::ServiceAccountApi* | [**delete_secret_key**](docs/ServiceAccountApi.md#delete_secret_key) | **DELETE** /v1.1/serviceaccounts/{serviceAccountId}/keys/{keyId} | 
@@ -198,6 +199,7 @@ Class | Method | HTTP request | Description
  - [SmoochApi::AttachmentRemove](docs/AttachmentRemove.md)
  - [SmoochApi::AttachmentResponse](docs/AttachmentResponse.md)
  - [SmoochApi::AuthCodeResponse](docs/AuthCodeResponse.md)
+ - [SmoochApi::Author](docs/Author.md)
  - [SmoochApi::BusinessSystemItem](docs/BusinessSystemItem.md)
  - [SmoochApi::ChannelEntityItem](docs/ChannelEntityItem.md)
  - [SmoochApi::Client](docs/Client.md)
@@ -246,6 +248,10 @@ Class | Method | HTTP request | Description
  - [SmoochApi::MessageOverrideWhatsapp](docs/MessageOverrideWhatsapp.md)
  - [SmoochApi::MessagePost](docs/MessagePost.md)
  - [SmoochApi::MessageResponse](docs/MessageResponse.md)
+ - [SmoochApi::NotificationPost](docs/NotificationPost.md)
+ - [SmoochApi::NotificationPostDestination](docs/NotificationPostDestination.md)
+ - [SmoochApi::NotificationResponse](docs/NotificationResponse.md)
+ - [SmoochApi::NotificationResponseNotification](docs/NotificationResponseNotification.md)
  - [SmoochApi::Option](docs/Option.md)
  - [SmoochApi::QuotedMessage](docs/QuotedMessage.md)
  - [SmoochApi::SecretKey](docs/SecretKey.md)

data/docs/Author.md

@@ -0,0 +1,11 @@
+# SmoochApi::Author
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role** | **String** | The role of the individual posting the message. The only accepted value is \"appMaker\". | 
+**name** | **String** | The display name of the message author. | [optional] 
+**email** | **String** | The email address of the message author. | [optional] 
+**avatarUrl** | **String** | The URL of the desired message avatar image. | [optional] 
+
+

data/docs/NotificationApi.md

@@ -0,0 +1,71 @@
+# SmoochApi::NotificationApi
+
+All URIs are relative to *https://api.smooch.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**post_notification**](NotificationApi.md#post_notification) | **POST** /v1/apps/{appId}/notifications | 
+
+
+# **post_notification**
+> NotificationResponse post_notification(appId, notificationPostBody)
+
+
+
+Post a notification to an externalId.
+
+### Example
+```ruby
+# load the gem
+require 'smooch-api'
+# setup authorization
+SmoochApi.configure do |config|
+  # Configure HTTP basic authorization (recommended): basicAuth
+  config.username = 'API_KEY_ID'
+  config.password = 'API_KEY_SECRET'
+
+
+  # OR
+
+  # Configure API key authorization (alternative): jwt
+  config.api_key['Authorization'] = 'YOUR JWT'
+  config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = SmoochApi::NotificationApi.new
+
+appId = "appId_example" # String | Identifies the app.
+
+notificationPostBody = SmoochApi::NotificationPost.new # NotificationPost | Body for a postNotification request. 
+
+
+begin
+  result = api_instance.post_notification(appId, notificationPostBody)
+  p result
+rescue SmoochApi::ApiError => e
+  puts "Exception when calling NotificationApi->post_notification: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **appId** | **String**| Identifies the app. | 
+ **notificationPostBody** | [**NotificationPost**](NotificationPost.md)| Body for a postNotification request.  | 
+
+### Return type
+
+[**NotificationResponse**](NotificationResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth), [jwt](../README.md#jwt)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/NotificationPost.md

@@ -0,0 +1,11 @@
+# SmoochApi::NotificationPost
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**destination** | [**NotificationPostDestination**](NotificationPostDestination.md) | The destination of the notification. | 
+**messageSchema** | **String** | If specified, the only accepted value is `whatsapp`. To be included when sending WhatsApp message templates. | [optional] 
+**author** | [**Author**](Author.md) | An object containing role, email, name and avatarUrl. | 
+**message** | **Object** | The notification message to send. | 
+
+

data/docs/NotificationPostDestination.md

@@ -0,0 +1,9 @@
+# SmoochApi::NotificationPostDestination
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**integrationId** | **String** | The ID of the target integration. | 
+**destinationId** | **String** | The external ID (channel specific) of the target user. | 
+
+

data/docs/NotificationResponse.md

@@ -0,0 +1,8 @@
+# SmoochApi::NotificationResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**notification** | [**NotificationResponseNotification**](NotificationResponseNotification.md) |  | [optional] 
+
+

data/docs/NotificationResponseNotification.md

@@ -0,0 +1,8 @@
+# SmoochApi::NotificationResponseNotification
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Automatically generated UUID used to identify the notification in Webhooks. | 
+
+

data/lib/smooch-api.rb

@@ -35,6 +35,7 @@ require 'smooch-api/models/app_user_update'
 require 'smooch-api/models/attachment_remove'
 require 'smooch-api/models/attachment_response'
 require 'smooch-api/models/auth_code_response'
+require 'smooch-api/models/author'
 require 'smooch-api/models/business_system_item'
 require 'smooch-api/models/channel_entity_item'
 require 'smooch-api/models/client'
@@ -83,6 +84,10 @@ require 'smooch-api/models/message_override_messenger'
 require 'smooch-api/models/message_override_whatsapp'
 require 'smooch-api/models/message_post'
 require 'smooch-api/models/message_response'
+require 'smooch-api/models/notification_post'
+require 'smooch-api/models/notification_post_destination'
+require 'smooch-api/models/notification_response'
+require 'smooch-api/models/notification_response_notification'
 require 'smooch-api/models/option'
 require 'smooch-api/models/quoted_message'
 require 'smooch-api/models/secret_key'
@@ -113,6 +118,7 @@ require 'smooch-api/api/conversation_api'
 require 'smooch-api/api/deployment_api'
 require 'smooch-api/api/integration_api'
 require 'smooch-api/api/menu_api'
+require 'smooch-api/api/notification_api'
 require 'smooch-api/api/service_account_api'
 require 'smooch-api/api/template_api'
 require 'smooch-api/api/webhook_api'

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

@@ -0,0 +1,84 @@
+=begin
+#Smooch
+
+#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: 5.25
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3-SNAPSHOT
+
+=end
+
+require "uri"
+
+module SmoochApi
+  class NotificationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # 
+    # Post a notification to an externalId.
+    # @param appId Identifies the app.
+    # @param notificationPostBody Body for a postNotification request. 
+    # @param [Hash] opts the optional parameters
+    # @return [NotificationResponse]
+    def post_notification(appId, notificationPostBody, opts = {})
+      data, _status_code, _headers = post_notification_with_http_info(appId, notificationPostBody, opts)
+      return data
+    end
+
+    # 
+    # Post a notification to an externalId.
+    # @param appId Identifies the app.
+    # @param notificationPostBody Body for a postNotification request. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(NotificationResponse, Fixnum, Hash)>] NotificationResponse data, response status code and response headers
+    def post_notification_with_http_info(appId, notificationPostBody, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: NotificationApi.post_notification ..."
+      end
+      # verify the required parameter 'appId' is set
+      if @api_client.config.client_side_validation && appId.nil?
+        fail ArgumentError, "Missing the required parameter 'appId' when calling NotificationApi.post_notification"
+      end
+      # verify the required parameter 'notificationPostBody' is set
+      if @api_client.config.client_side_validation && notificationPostBody.nil?
+        fail ArgumentError, "Missing the required parameter 'notificationPostBody' when calling NotificationApi.post_notification"
+      end
+      # resource path
+      local_var_path = "/v1/apps/{appId}/notifications".sub('{' + 'appId' + '}', appId.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(notificationPostBody)
+      auth_names = ['basicAuth', 'jwt']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'NotificationResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: NotificationApi#post_notification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,224 @@
+=begin
+#Smooch
+
+#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: 5.25
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3-SNAPSHOT
+
+=end
+
+require 'date'
+
+module SmoochApi
+
+  class Author
+    # The role of the individual posting the message. The only accepted value is \"appMaker\".
+    attr_accessor :role
+
+    # The display name of the message author.
+    attr_accessor :name
+
+    # The email address of the message author.
+    attr_accessor :email
+
+    # The URL of the desired message avatar image.
+    attr_accessor :avatarUrl
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'role' => :'role',
+        :'name' => :'name',
+        :'email' => :'email',
+        :'avatarUrl' => :'avatarUrl'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'role' => :'String',
+        :'name' => :'String',
+        :'email' => :'String',
+        :'avatarUrl' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'role')
+        self.role = attributes[:'role']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.has_key?(:'avatarUrl')
+        self.avatarUrl = attributes[:'avatarUrl']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @role.nil?
+        invalid_properties.push("invalid value for 'role', role cannot be nil.")
+      end
+
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @role.nil?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          role == o.role &&
+          name == o.name &&
+          email == o.email &&
+          avatarUrl == o.avatarUrl
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [role, name, email, avatarUrl].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = SmoochApi.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end