rainbow-submarine-test-3356

rainbow-submarine-test-3356

RainbowSubmarineTest3356 - the Ruby gem for the Smooch

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.2.2
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build rainbow-submarine-test-3356.gemspec

Then either install the gem locally:

gem install ./rainbow-submarine-test-3356-1.2.2.gem

(for development, run gem install --dev ./rainbow-submarine-test-3356-1.2.2.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'rainbow-submarine-test-3356', '~> 1.2.2'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'rainbow-submarine-test-3356', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'rainbow-submarine-test-3356'

# Setup authorization
RainbowSubmarineTest3356.configure do |config|
  # Configure API key authorization: appToken
  config.api_key['app-token'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['app-token'] = 'Bearer'

  # Configure API key authorization: jwt
  config.api_key['Authorization'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Authorization'] = 'Bearer'
end

api_instance = RainbowSubmarineTest3356::AppUserApi.new

user_id = "user_id_example" # String | Identifies the user. Can be either the smoochId or the userId.

device_id = "device_id_example" # String | Id of the device.

app_user_device_update = RainbowSubmarineTest3356::DeviceUpdate.new # DeviceUpdate | Supported properties for an updateAppUserDevice request.


begin
  result = api_instance.app_user_device_update(user_id, device_id, app_user_device_update)
  p result
rescue RainbowSubmarineTest3356::ApiError => e
  puts "Exception when calling AppUserApi->app_user_device_update: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.smooch.io/v1

Class	Method	HTTP request	Description
RainbowSubmarineTest3356::AppUserApi	app_user_device_update	PUT /appusers/{userId}/devices/{deviceId}
RainbowSubmarineTest3356::AppUserApi	delete_app_user_profile	DELETE /appusers/{userId}/profile
RainbowSubmarineTest3356::AppUserApi	get_app_user	GET /appusers/{userId}
RainbowSubmarineTest3356::AppUserApi	get_app_user_entity_ids	GET /appusers/{userId}/channels
RainbowSubmarineTest3356::AppUserApi	link_app_user	POST /appusers/{userId}/channels
RainbowSubmarineTest3356::AppUserApi	post_image_message	POST /appusers/{userId}/images
RainbowSubmarineTest3356::AppUserApi	pre_create_app_user	POST /appusers
RainbowSubmarineTest3356::AppUserApi	track_event	POST /appusers/{userId}/events
RainbowSubmarineTest3356::AppUserApi	unlink_app_user	DELETE /appusers/{userId}/channels/{channel}
RainbowSubmarineTest3356::AppUserApi	update_app_user	PUT /appusers/{userId}
RainbowSubmarineTest3356::ConversationApi	get_messages	GET /appusers/{userId}/messages
RainbowSubmarineTest3356::ConversationApi	reset_unread_count	POST /appusers/{userId}/conversation/read
RainbowSubmarineTest3356::ConversationApi	trigger_typing_activity	POST /appusers/{userId}/conversation/activity
RainbowSubmarineTest3356::MenuApi	delete_menu	DELETE /menu
RainbowSubmarineTest3356::MenuApi	get_menu	GET /menu
RainbowSubmarineTest3356::MenuApi	update_menu	PUT /menu

Documentation for Models

• RainbowSubmarineTest3356::AppUser
• RainbowSubmarineTest3356::AppUserLink
• RainbowSubmarineTest3356::AppUserPreCreate
• RainbowSubmarineTest3356::AppUserResponse
• RainbowSubmarineTest3356::AppUserUpdate
• RainbowSubmarineTest3356::Client
• RainbowSubmarineTest3356::ClientInfo
• RainbowSubmarineTest3356::ClientResponse
• RainbowSubmarineTest3356::Conversation
• RainbowSubmarineTest3356::DeviceUpdate
• RainbowSubmarineTest3356::Event
• RainbowSubmarineTest3356::GetMessagesResponse
• RainbowSubmarineTest3356::Menu
• RainbowSubmarineTest3356::MenuItem
• RainbowSubmarineTest3356::MenuResponse
• RainbowSubmarineTest3356::Message
• RainbowSubmarineTest3356::MessageResponse
• RainbowSubmarineTest3356::Postback
• RainbowSubmarineTest3356::TrackEventResponse
• RainbowSubmarineTest3356::TypingActivityTrigger

Documentation for Authorization

appToken

• Type: API key
• API key parameter name: app-token
• Location: HTTP header

jwt

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header