Module: SmoochApi

Defined in:
lib/smooch-api/version.rb,
lib/smooch-api.rb,
lib/smooch-api/api_error.rb,
lib/smooch-api/api_client.rb,
lib/smooch-api/models/app.rb,
lib/smooch-api/api/app_api.rb,
lib/smooch-api/models/menu.rb,
lib/smooch-api/api/menu_api.rb,
lib/smooch-api/models/enums.rb,
lib/smooch-api/models/field.rb,
lib/smooch-api/configuration.rb,
lib/smooch-api/models/action.rb,
lib/smooch-api/models/author.rb,
lib/smooch-api/models/client.rb,
lib/smooch-api/models/option.rb,
lib/smooch-api/models/select.rb,
lib/smooch-api/models/source.rb,
lib/smooch-api/models/message.rb,
lib/smooch-api/models/webhook.rb,
lib/smooch-api/api/webhook_api.rb,
lib/smooch-api/models/app_user.rb,
lib/smooch-api/models/location.rb,
lib/smooch-api/models/template.rb,
lib/smooch-api/api/app_user_api.rb,
lib/smooch-api/api/template_api.rb,
lib/smooch-api/models/menu_item.rb,
lib/smooch-api/models/app_create.rb,
lib/smooch-api/models/app_update.rb,
lib/smooch-api/models/deployment.rb,
lib/smooch-api/models/field_post.rb,
lib/smooch-api/models/secret_key.rb,
lib/smooch-api/api/deployment_api.rb,
lib/smooch-api/models/client_info.rb,
lib/smooch-api/models/coordinates.rb,
lib/smooch-api/models/destination.rb,
lib/smooch-api/models/integration.rb,
lib/smooch-api/models/merged_user.rb,
lib/smooch-api/api/attachments_api.rb,
lib/smooch-api/api/integration_api.rb,
lib/smooch-api/models/app_response.rb,
lib/smooch-api/models/app_settings.rb,
lib/smooch-api/models/confirmation.rb,
lib/smooch-api/models/conversation.rb,
lib/smooch-api/models/jwt_response.rb,
lib/smooch-api/models/message_item.rb,
lib/smooch-api/models/message_post.rb,
lib/smooch-api/api/conversation_api.rb,
lib/smooch-api/api/notification_api.rb,
lib/smooch-api/models/app_user_link.rb,
lib/smooch-api/models/menu_response.rb,
lib/smooch-api/models/sub_menu_item.rb,
lib/smooch-api/models/app_user_merge.rb,
lib/smooch-api/models/quoted_message.rb,
lib/smooch-api/models/webhook_create.rb,
lib/smooch-api/models/webhook_update.rb,
lib/smooch-api/models/app_user_update.rb,
lib/smooch-api/models/service_account.rb,
lib/smooch-api/models/template_create.rb,
lib/smooch-api/models/template_update.rb,
lib/smooch-api/api/service_account_api.rb,
lib/smooch-api/models/display_settings.rb,
lib/smooch-api/models/message_override.rb,
lib/smooch-api/models/message_response.rb,
lib/smooch-api/models/webhook_response.rb,
lib/smooch-api/models/activity_response.rb,
lib/smooch-api/models/app_user_response.rb,
lib/smooch-api/models/attachment_remove.rb,
lib/smooch-api/models/deployment_create.rb,
lib/smooch-api/models/notification_post.rb,
lib/smooch-api/models/secret_key_create.rb,
lib/smooch-api/models/template_response.rb,
lib/smooch-api/models/auth_code_response.rb,
lib/smooch-api/models/integration_create.rb,
lib/smooch-api/models/integration_update.rb,
lib/smooch-api/models/list_apps_response.rb,
lib/smooch-api/models/app_user_pre_create.rb,
lib/smooch-api/models/attachment_response.rb,
lib/smooch-api/models/channel_entity_item.rb,
lib/smooch-api/models/deployment_response.rb,
lib/smooch-api/models/secret_key_response.rb,
lib/smooch-api/models/business_system_item.rb,
lib/smooch-api/models/get_sdk_ids_response.rb,
lib/smooch-api/models/integration_response.rb,
lib/smooch-api/models/conversation_activity.rb,
lib/smooch-api/models/get_messages_response.rb,
lib/smooch-api/models/link_request_response.rb,
lib/smooch-api/models/message_override_line.rb,
lib/smooch-api/models/notification_response.rb,
lib/smooch-api/models/list_webhooks_response.rb,
lib/smooch-api/models/service_account_create.rb,
lib/smooch-api/models/service_account_update.rb,
lib/smooch-api/models/deployment_confirm_code.rb,
lib/smooch-api/models/list_templates_response.rb,
lib/smooch-api/models/service_account_response.rb,
lib/smooch-api/models/list_deployments_response.rb,
lib/smooch-api/models/list_secret_keys_response.rb,
lib/smooch-api/models/message_override_whatsapp.rb,
lib/smooch-api/models/app_user_channels_response.rb,
lib/smooch-api/models/integration_profile_update.rb,
lib/smooch-api/models/list_integrations_response.rb,
lib/smooch-api/models/message_override_messenger.rb,
lib/smooch-api/models/notification_post_destination.rb,
lib/smooch-api/models/list_service_accounts_response.rb,
lib/smooch-api/models/deployment_activate_phone_number.rb,
lib/smooch-api/models/get_integration_profile_response.rb,
lib/smooch-api/models/app_user_business_systems_response.rb,
lib/smooch-api/models/notification_response_notification.rb,
lib/smooch-api/models/link_request_response_link_requests.rb,
lib/smooch-api/models/upload_integration_profile_photo_response.rb

Overview

#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](docs.smooch.io).

OpenAPI spec version: 5.34

Generated by: github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.2.3-SNAPSHOT

Defined Under Namespace

Classes: Action, ActivityResponse, ApiClient, ApiError, App, AppApi, AppCreate, AppResponse, AppSettings, AppUpdate, AppUser, AppUserApi, AppUserBusinessSystemsResponse, AppUserChannelsResponse, AppUserLink, AppUserMerge, AppUserPreCreate, AppUserResponse, AppUserUpdate, AttachmentRemove, AttachmentResponse, AttachmentsApi, AuthCodeResponse, Author, BusinessSystemItem, ChannelEntityItem, Client, ClientInfo, Configuration, Confirmation, Conversation, ConversationActivity, ConversationApi, Coordinates, Deployment, DeploymentActivatePhoneNumber, DeploymentApi, DeploymentConfirmCode, DeploymentCreate, DeploymentResponse, Destination, DisplaySettings, Enums, Field, FieldPost, GetIntegrationProfileResponse, GetMessagesResponse, GetSdkIdsResponse, Integration, IntegrationApi, IntegrationCreate, IntegrationProfileUpdate, IntegrationResponse, IntegrationUpdate, JwtResponse, LinkRequestResponse, LinkRequestResponseLinkRequests, ListAppsResponse, ListDeploymentsResponse, ListIntegrationsResponse, ListSecretKeysResponse, ListServiceAccountsResponse, ListTemplatesResponse, ListWebhooksResponse, Location, Menu, MenuApi, MenuItem, MenuResponse, MergedUser, Message, MessageItem, MessageOverride, MessageOverrideLine, MessageOverrideMessenger, MessageOverrideWhatsapp, MessagePost, MessageResponse, NotificationApi, NotificationPost, NotificationPostDestination, NotificationResponse, NotificationResponseNotification, Option, QuotedMessage, SecretKey, SecretKeyCreate, SecretKeyResponse, Select, ServiceAccount, ServiceAccountApi, ServiceAccountCreate, ServiceAccountResponse, ServiceAccountUpdate, Source, SubMenuItem, Template, TemplateApi, TemplateCreate, TemplateResponse, TemplateUpdate, UploadIntegrationProfilePhotoResponse, Webhook, WebhookApi, WebhookCreate, WebhookResponse, WebhookUpdate

Constant Summary collapse

VERSION = 
"5.34.1"

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

SmoochApi.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



135
136
137
138
139
140
141
 
# File 'lib/smooch-api.rb', line 135

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end