one_msg_chat_api 1.0.0

data/docs/TemplatesApi.md

@@ -0,0 +1,301 @@
+# OneMsgChatApi::TemplatesApi
+
+All URIs are relative to *https://api.1msg.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_template**](TemplatesApi.md#add_template) | **POST** /addTemplate | Create message template |
+| [**list_templates**](TemplatesApi.md#list_templates) | **GET** /templates | Get templates list |
+| [**remove_template**](TemplatesApi.md#remove_template) | **POST** /removeTemplate | Remove message template |
+| [**send_template**](TemplatesApi.md#send_template) | **POST** /sendTemplate | Send Template Message |
+
+
+## add_template
+
+> Hash<String, Object> add_template(token, opts)
+
+Create message template
+
+### 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::TemplatesApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+opts = {
+  add_template_request: OneMsgChatApi::AddTemplateRequest.new # AddTemplateRequest | 
+}
+
+begin
+  # Create message template
+  result = api_instance.add_template(token, opts)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling TemplatesApi->add_template: #{e}"
+end
+```
+
+#### Using the add_template_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)> add_template_with_http_info(token, opts)
+
+```ruby
+begin
+  # Create message template
+  data, status_code, headers = api_instance.add_template_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 TemplatesApi->add_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+| **add_template_request** | [**AddTemplateRequest**](AddTemplateRequest.md) |  | [optional] |
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_templates
+
+> <ListTemplates200Response> list_templates(token)
+
+Get templates list
+
+### 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::TemplatesApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+
+begin
+  # Get templates list
+  result = api_instance.list_templates(token)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling TemplatesApi->list_templates: #{e}"
+end
+```
+
+#### Using the list_templates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListTemplates200Response>, Integer, Hash)> list_templates_with_http_info(token)
+
+```ruby
+begin
+  # Get templates list
+  data, status_code, headers = api_instance.list_templates_with_http_info(token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListTemplates200Response>
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling TemplatesApi->list_templates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+
+### Return type
+
+[**ListTemplates200Response**](ListTemplates200Response.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## remove_template
+
+> Hash&lt;String, Object&gt; remove_template(token, opts)
+
+Remove message template
+
+### 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::TemplatesApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+opts = {
+  request_body: { key: 3.56} # Hash<String, Object> | 
+}
+
+begin
+  # Remove message template
+  result = api_instance.remove_template(token, opts)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling TemplatesApi->remove_template: #{e}"
+end
+```
+
+#### Using the remove_template_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)> remove_template_with_http_info(token, opts)
+
+```ruby
+begin
+  # Remove message template
+  data, status_code, headers = api_instance.remove_template_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 TemplatesApi->remove_template_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
+
+
+## send_template
+
+> Hash&lt;String, Object&gt; send_template(token, opts)
+
+Send Template Message
+
+Send a WhatsApp template message (works outside the 24-hour session window).  Supported `params` button `sub_type` values include: `url`, `quick_reply`, `copy_code` / `coupon_code`, `catalog`, `flow`, `limited_time_offer`, and **`order_details`** (WhatsApp Payments **India only** — requires an approved Utility template with an ORDER_DETAILS button).  For India order/invoice payments outside 24h, include a button component:  ```json {   \"type\": \"button\",   \"sub_type\": \"order_details\",   \"index\": 0,   \"parameters\": [{     \"type\": \"action\",     \"action\": { \"order_details\": { \"reference_id\": \"...\", \"currency\": \"INR\", \"order\": {} } }   }] } ```  Convenience wrapper with structured fields: `POST /sendOrderDetails`. 
+
+### 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::TemplatesApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+opts = {
+  send_template_request: OneMsgChatApi::SendTemplateRequest.new # SendTemplateRequest | 
+}
+
+begin
+  # Send Template Message
+  result = api_instance.send_template(token, opts)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling TemplatesApi->send_template: #{e}"
+end
+```
+
+#### Using the send_template_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)> send_template_with_http_info(token, opts)
+
+```ruby
+begin
+  # Send Template Message
+  data, status_code, headers = api_instance.send_template_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 TemplatesApi->send_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+| **send_template_request** | [**SendTemplateRequest**](SendTemplateRequest.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/UpdateMeRequest.md

@@ -0,0 +1,30 @@
+# OneMsgChatApi::UpdateMeRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **about** | **String** | Profile About section | [optional] |
+| **address** | **String** |  | [optional] |
+| **description** | **String** | Business description (max 256 characters) | [optional] |
+| **email** | **String** |  | [optional] |
+| **vertical** | **String** | Industry of the business | [optional] |
+| **photo** | **String** | HTTPS URL or data:image/...;base64,... payload | [optional] |
+| **websites** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::UpdateMeRequest.new(
+  about: null,
+  address: null,
+  description: null,
+  email: null,
+  vertical: null,
+  photo: null,
+  websites: null
+)
+```
+

data/docs/UsersApi.md

@@ -0,0 +1,223 @@
+# OneMsgChatApi::UsersApi
+
+All URIs are relative to *https://api.1msg.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**block_user**](UsersApi.md#block_user) | **POST** /blockUser | Block WhatsApp user |
+| [**list_blocked_users**](UsersApi.md#list_blocked_users) | **GET** /blockedUsers | List blocked WhatsApp users |
+| [**unblock_user**](UsersApi.md#unblock_user) | **POST** /unblockUser | Unblock WhatsApp user |
+
+
+## block_user
+
+> <SuccessResponse> block_user(token, block_user_request)
+
+Block WhatsApp user
+
+### 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::UsersApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+block_user_request = OneMsgChatApi::BlockUserRequest.new({phone: 37}) # BlockUserRequest | 
+
+begin
+  # Block WhatsApp user
+  result = api_instance.block_user(token, block_user_request)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling UsersApi->block_user: #{e}"
+end
+```
+
+#### Using the block_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> block_user_with_http_info(token, block_user_request)
+
+```ruby
+begin
+  # Block WhatsApp user
+  data, status_code, headers = api_instance.block_user_with_http_info(token, block_user_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling UsersApi->block_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+| **block_user_request** | [**BlockUserRequest**](BlockUserRequest.md) |  |  |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_blocked_users
+
+> <ListBlockedUsers200Response> list_blocked_users(token)
+
+List blocked WhatsApp users
+
+Returns users currently blocked on this WhatsApp channel (WABA `GET /block_users`). Same channel token auth as `blockUser` / `unblockUser`. 
+
+### 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::UsersApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+
+begin
+  # List blocked WhatsApp users
+  result = api_instance.list_blocked_users(token)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling UsersApi->list_blocked_users: #{e}"
+end
+```
+
+#### Using the list_blocked_users_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListBlockedUsers200Response>, Integer, Hash)> list_blocked_users_with_http_info(token)
+
+```ruby
+begin
+  # List blocked WhatsApp users
+  data, status_code, headers = api_instance.list_blocked_users_with_http_info(token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListBlockedUsers200Response>
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling UsersApi->list_blocked_users_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+
+### Return type
+
+[**ListBlockedUsers200Response**](ListBlockedUsers200Response.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## unblock_user
+
+> <SuccessResponse> unblock_user(token, block_user_request)
+
+Unblock WhatsApp user
+
+### 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::UsersApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+block_user_request = OneMsgChatApi::BlockUserRequest.new({phone: 37}) # BlockUserRequest | 
+
+begin
+  # Unblock WhatsApp user
+  result = api_instance.unblock_user(token, block_user_request)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling UsersApi->unblock_user: #{e}"
+end
+```
+
+#### Using the unblock_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResponse>, Integer, Hash)> unblock_user_with_http_info(token, block_user_request)
+
+```ruby
+begin
+  # Unblock WhatsApp user
+  data, status_code, headers = api_instance.unblock_user_with_http_info(token, block_user_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResponse>
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling UsersApi->unblock_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+| **block_user_request** | [**BlockUserRequest**](BlockUserRequest.md) |  |  |
+
+### Return type
+
+[**SuccessResponse**](SuccessResponse.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/WebhooksApi.md

@@ -0,0 +1,155 @@
+# OneMsgChatApi::WebhooksApi
+
+All URIs are relative to *https://api.1msg.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_webhook**](WebhooksApi.md#get_webhook) | **GET** /webhook | Get webhook URL |
+| [**set_webhook**](WebhooksApi.md#set_webhook) | **POST** /webhook | Set webhook URL |
+
+
+## get_webhook
+
+> <GetWebhook200Response> get_webhook(token)
+
+Get webhook URL
+
+Returns the configured client webhook URL for this channel.
+
+### 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::WebhooksApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+
+begin
+  # Get webhook URL
+  result = api_instance.get_webhook(token)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling WebhooksApi->get_webhook: #{e}"
+end
+```
+
+#### Using the get_webhook_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetWebhook200Response>, Integer, Hash)> get_webhook_with_http_info(token)
+
+```ruby
+begin
+  # Get webhook URL
+  data, status_code, headers = api_instance.get_webhook_with_http_info(token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetWebhook200Response>
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling WebhooksApi->get_webhook_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+
+### Return type
+
+[**GetWebhook200Response**](GetWebhook200Response.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## set_webhook
+
+> Hash&lt;String, Object&gt; set_webhook(token, opts)
+
+Set webhook URL
+
+Configure the client webhook URL for inbound events.
+
+### 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::WebhooksApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+opts = {
+  get_webhook200_response: OneMsgChatApi::GetWebhook200Response.new # GetWebhook200Response | 
+}
+
+begin
+  # Set webhook URL
+  result = api_instance.set_webhook(token, opts)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling WebhooksApi->set_webhook: #{e}"
+end
+```
+
+#### Using the set_webhook_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_webhook_with_http_info(token, opts)
+
+```ruby
+begin
+  # Set webhook URL
+  data, status_code, headers = api_instance.set_webhook_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 WebhooksApi->set_webhook_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+| **get_webhook200_response** | [**GetWebhook200Response**](GetWebhook200Response.md) |  | [optional] |
+
+### Return type
+
+**Hash&lt;String, Object&gt;**
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+