one_msg_chat_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6dce23a8916afa6b401d251d669129097e53c9f55eb3d45a0a3570c62062f3a4
+  data.tar.gz: 8943e5450c9bdb9ff64d4eff2ac2fac92b0f726c5ef47f2abb6678fbfc513b31
+SHA512:
+  metadata.gz: 680a29f3c07c177d42d6af37832f85208ff75a1e2b9764ebdc6bb0a40917cb7e8224f0241065d6a9c8dfd5b7049bfd9accf05813c87f0f74f412bfcc116e8ed5
+  data.tar.gz: 43656c542b197e26324e80fc9d5029fa918cea38dd03e72a6bc62263cc004e0e86499ba8602fef9fd8a79723ff9389ef99fd989361ca08088a315f5165b25269

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 1MSG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AddTemplateRequest.md

@@ -0,0 +1,24 @@
+# OneMsgChatApi::AddTemplateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **category** | **String** |  | [optional] |
+| **language** | **String** |  | [optional] |
+| **components** | **Array<Hash<String, Object>>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::AddTemplateRequest.new(
+  name: null,
+  category: null,
+  language: null,
+  components: null
+)
+```
+

data/docs/BlockUserRequest.md

@@ -0,0 +1,18 @@
+# OneMsgChatApi::BlockUserRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::BlockUserRequest.new(
+  phone: null
+)
+```
+

data/docs/CallingApi.md

@@ -0,0 +1,231 @@
+# OneMsgChatApi::CallingApi
+
+All URIs are relative to *https://api.1msg.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_calling_settings**](CallingApi.md#get_calling_settings) | **GET** /callingSettings | Get calling settings |
+| [**initiate_call**](CallingApi.md#initiate_call) | **POST** /initiateCall | Initiate WhatsApp call |
+| [**update_calling_settings**](CallingApi.md#update_calling_settings) | **POST** /callingSettings | Update calling settings |
+
+
+## get_calling_settings
+
+> Hash<String, Object> get_calling_settings(token)
+
+Get calling settings
+
+WhatsApp Calling API settings (beta). Requires Meta Calling enablement on the WABA. Not production-complete — paths and webhook field names may change. Trial/subscription-limited channels are blocked. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'one_msg_chat_api'
+# setup authorization
+OneMsgChatApi.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['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['token'] = 'Bearer'
+end
+
+api_instance = OneMsgChatApi::CallingApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+
+begin
+  # Get calling settings
+  result = api_instance.get_calling_settings(token)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling CallingApi->get_calling_settings: #{e}"
+end
+```
+
+#### Using the get_calling_settings_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_calling_settings_with_http_info(token)
+
+```ruby
+begin
+  # Get calling settings
+  data, status_code, headers = api_instance.get_calling_settings_with_http_info(token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Hash&lt;String, Object&gt;
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling CallingApi->get_calling_settings_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## initiate_call
+
+> Hash&lt;String, Object&gt; initiate_call(token, opts)
+
+Initiate WhatsApp call
+
+Outbound Calling API (beta). Requires Meta Calling enablement and product consent. Not production-complete — verify on stage before relying on this in production. Trial/subscription-limited channels are blocked. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'one_msg_chat_api'
+# setup authorization
+OneMsgChatApi.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['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['token'] = 'Bearer'
+end
+
+api_instance = OneMsgChatApi::CallingApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+opts = {
+  request_body: { key: 3.56} # Hash<String, Object> | 
+}
+
+begin
+  # Initiate WhatsApp call
+  result = api_instance.initiate_call(token, opts)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling CallingApi->initiate_call: #{e}"
+end
+```
+
+#### Using the initiate_call_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> initiate_call_with_http_info(token, opts)
+
+```ruby
+begin
+  # Initiate WhatsApp call
+  data, status_code, headers = api_instance.initiate_call_with_http_info(token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Hash&lt;String, Object&gt;
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling CallingApi->initiate_call_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+| **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) |  | [optional] |
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_calling_settings
+
+> Hash&lt;String, Object&gt; update_calling_settings(token, opts)
+
+Update calling settings
+
+Update WhatsApp Calling API settings (beta). Requires Meta Calling enablement. Trial/subscription-limited channels are blocked. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'one_msg_chat_api'
+# setup authorization
+OneMsgChatApi.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['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['token'] = 'Bearer'
+end
+
+api_instance = OneMsgChatApi::CallingApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+opts = {
+  request_body: { key: 3.56} # Hash<String, Object> | 
+}
+
+begin
+  # Update calling settings
+  result = api_instance.update_calling_settings(token, opts)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling CallingApi->update_calling_settings: #{e}"
+end
+```
+
+#### Using the update_calling_settings_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> update_calling_settings_with_http_info(token, opts)
+
+```ruby
+begin
+  # Update calling settings
+  data, status_code, headers = api_instance.update_calling_settings_with_http_info(token, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Hash&lt;String, Object&gt;
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling CallingApi->update_calling_settings_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+| **request_body** | [**Hash&lt;String, Object&gt;**](Object.md) |  | [optional] |
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/CatalogApi.md

@@ -0,0 +1,153 @@
+# OneMsgChatApi::CatalogApi
+
+All URIs are relative to *https://api.1msg.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_commerce**](CatalogApi.md#create_commerce) | **POST** /commerce | Set Commerce Settings |
+| [**get_commerce**](CatalogApi.md#get_commerce) | **GET** /commerce | Get Commerce Settings |
+
+
+## create_commerce
+
+> <CreateCommerce200Response> create_commerce(token, create_commerce_request)
+
+Set Commerce Settings
+
+Update catalog/cart commerce settings via the `params` object.  - `params.is_catalog_visible` — show catalog storefront icon (`true`) or hide it (`false`). - `params.is_cart_enabled` — enable cart (`true`) or disable it (`false`).  Blocked when the channel subscription limit is exceeded. Requires a commerce-capable channel (Cloud Functions `/commerceWAV2`). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'one_msg_chat_api'
+# setup authorization
+OneMsgChatApi.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['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['token'] = 'Bearer'
+end
+
+api_instance = OneMsgChatApi::CatalogApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+create_commerce_request = OneMsgChatApi::CreateCommerceRequest.new({params: OneMsgChatApi::CreateCommerceRequestParams.new({is_cart_enabled: false, is_catalog_visible: false})}) # CreateCommerceRequest | 
+
+begin
+  # Set Commerce Settings
+  result = api_instance.create_commerce(token, create_commerce_request)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling CatalogApi->create_commerce: #{e}"
+end
+```
+
+#### Using the create_commerce_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateCommerce200Response>, Integer, Hash)> create_commerce_with_http_info(token, create_commerce_request)
+
+```ruby
+begin
+  # Set Commerce Settings
+  data, status_code, headers = api_instance.create_commerce_with_http_info(token, create_commerce_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateCommerce200Response>
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling CatalogApi->create_commerce_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+| **create_commerce_request** | [**CreateCommerceRequest**](CreateCommerceRequest.md) |  |  |
+
+### Return type
+
+[**CreateCommerce200Response**](CreateCommerce200Response.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_commerce
+
+> <Array<GetCommerce200ResponseInner>> get_commerce(token)
+
+Get Commerce Settings
+
+Returns catalog/cart commerce settings for the channel.  - `is_catalog_visible` — show catalog storefront icon (`true`) or hide it (`false`). - `is_cart_enabled` — enable cart (`true`) or disable it (`false`). 
+
+### Examples
+
+```ruby
+require 'time'
+require 'one_msg_chat_api'
+# setup authorization
+OneMsgChatApi.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['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['token'] = 'Bearer'
+end
+
+api_instance = OneMsgChatApi::CatalogApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+
+begin
+  # Get Commerce Settings
+  result = api_instance.get_commerce(token)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling CatalogApi->get_commerce: #{e}"
+end
+```
+
+#### Using the get_commerce_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<GetCommerce200ResponseInner>>, Integer, Hash)> get_commerce_with_http_info(token)
+
+```ruby
+begin
+  # Get Commerce Settings
+  data, status_code, headers = api_instance.get_commerce_with_http_info(token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<GetCommerce200ResponseInner>>
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling CatalogApi->get_commerce_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+
+### Return type
+
+[**Array&lt;GetCommerce200ResponseInner&gt;**](GetCommerce200ResponseInner.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ChannelApi.md

@@ -0,0 +1,225 @@
+# OneMsgChatApi::ChannelApi
+
+All URIs are relative to *https://api.1msg.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_conversational_automation**](ChannelApi.md#get_conversational_automation) | **GET** /conversationalAutomation | Get conversational automation settings |
+| [**get_status**](ChannelApi.md#get_status) | **GET** /status | Get channel status |
+| [**set_conversational_automation**](ChannelApi.md#set_conversational_automation) | **POST** /conversationalAutomation | Set conversational automation settings |
+
+
+## get_conversational_automation
+
+> <ConversationalAutomation> get_conversational_automation(token)
+
+Get conversational automation settings
+
+Get WhatsApp conversational components for the channel (welcome message, ice-breaker prompts, and slash commands).  Proxies Meta/360dialog `GET /conversational_automation`.  When `enable_welcome_message` is true and a user opens chat for the first time, Meta delivers a webhook message with `type: request_welcome`. The inbound formatter exposes that as `type: \"request_welcome\"` and `meta.request_welcome: true` so your webhook can send a custom welcome reply. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'one_msg_chat_api'
+# setup authorization
+OneMsgChatApi.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['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['token'] = 'Bearer'
+end
+
+api_instance = OneMsgChatApi::ChannelApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+
+begin
+  # Get conversational automation settings
+  result = api_instance.get_conversational_automation(token)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling ChannelApi->get_conversational_automation: #{e}"
+end
+```
+
+#### Using the get_conversational_automation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConversationalAutomation>, Integer, Hash)> get_conversational_automation_with_http_info(token)
+
+```ruby
+begin
+  # Get conversational automation settings
+  data, status_code, headers = api_instance.get_conversational_automation_with_http_info(token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConversationalAutomation>
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling ChannelApi->get_conversational_automation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+
+### Return type
+
+[**ConversationalAutomation**](ConversationalAutomation.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_status
+
+> Hash&lt;String, Object&gt; get_status(token)
+
+Get channel status
+
+Returns WhatsApp Business API client connection status.
+
+### Examples
+
+```ruby
+require 'time'
+require 'one_msg_chat_api'
+# setup authorization
+OneMsgChatApi.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['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['token'] = 'Bearer'
+end
+
+api_instance = OneMsgChatApi::ChannelApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+
+begin
+  # Get channel status
+  result = api_instance.get_status(token)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling ChannelApi->get_status: #{e}"
+end
+```
+
+#### Using the get_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_status_with_http_info(token)
+
+```ruby
+begin
+  # Get channel status
+  data, status_code, headers = api_instance.get_status_with_http_info(token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Hash&lt;String, Object&gt;
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling ChannelApi->get_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## set_conversational_automation
+
+> Hash&lt;String, Object&gt; set_conversational_automation(token, conversational_automation)
+
+Set conversational automation settings
+
+Update WhatsApp conversational components.  Allowed body fields (others are ignored): - `enable_welcome_message` (boolean) - `prompts` (string[], max 4, each ≤ 80 chars) - `commands` (`{ command_name, command_description }[]`)  Proxies Meta/360dialog `POST /conversational_automation`. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'one_msg_chat_api'
+# setup authorization
+OneMsgChatApi.configure do |config|
+  # Configure API key authorization: tokenAuth
+  config.api_key['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['token'] = 'Bearer'
+end
+
+api_instance = OneMsgChatApi::ChannelApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+conversational_automation = OneMsgChatApi::ConversationalAutomation.new # ConversationalAutomation | 
+
+begin
+  # Set conversational automation settings
+  result = api_instance.set_conversational_automation(token, conversational_automation)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling ChannelApi->set_conversational_automation: #{e}"
+end
+```
+
+#### Using the set_conversational_automation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Hash&lt;String, Object&gt;, Integer, Hash)> set_conversational_automation_with_http_info(token, conversational_automation)
+
+```ruby
+begin
+  # Set conversational automation settings
+  data, status_code, headers = api_instance.set_conversational_automation_with_http_info(token, conversational_automation)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Hash&lt;String, Object&gt;
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling ChannelApi->set_conversational_automation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+| **conversational_automation** | [**ConversationalAutomation**](ConversationalAutomation.md) |  |  |
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+