one_msg_chat_api 1.0.0

data/docs/PatchFlowsFlowIdAssets200Response.md

@@ -0,0 +1,22 @@
+# OneMsgChatApi::PatchFlowsFlowIdAssets200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **validation_errors** | **Array<Hash<String, Object>>** |  | [optional] |
+| **error** | **Object** | Error details returned by the provider. May be a string or a JSON object. | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::PatchFlowsFlowIdAssets200Response.new(
+  success: null,
+  validation_errors: null,
+  error: null
+)
+```
+

data/docs/ProfileApi.md

@@ -0,0 +1,155 @@
+# OneMsgChatApi::ProfileApi
+
+All URIs are relative to *https://api.1msg.io*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_me**](ProfileApi.md#get_me) | **GET** /me | Get Profile Info |
+| [**update_me**](ProfileApi.md#update_me) | **POST** /me | Update profile info |
+
+
+## get_me
+
+> <ProfileInfo> get_me(token)
+
+Get Profile Info
+
+Get WhatsApp Business Account profile information
+
+### 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::ProfileApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+
+begin
+  # Get Profile Info
+  result = api_instance.get_me(token)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling ProfileApi->get_me: #{e}"
+end
+```
+
+#### Using the get_me_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ProfileInfo>, Integer, Hash)> get_me_with_http_info(token)
+
+```ruby
+begin
+  # Get Profile Info
+  data, status_code, headers = api_instance.get_me_with_http_info(token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProfileInfo>
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling ProfileApi->get_me_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+
+### Return type
+
+[**ProfileInfo**](ProfileInfo.md)
+
+### Authorization
+
+[tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_me
+
+> Hash&lt;String, Object&gt; update_me(token, opts)
+
+Update profile info
+
+Update WhatsApp Business Account profile fields. At least one of about, description, email, photo, address, vertical, websites is required. Blocked when the channel subscription limit is exceeded. 
+
+### 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::ProfileApi.new
+token = 'token_example' # String | JWT token or API key for authorization
+opts = {
+  update_me_request: OneMsgChatApi::UpdateMeRequest.new # UpdateMeRequest | 
+}
+
+begin
+  # Update profile info
+  result = api_instance.update_me(token, opts)
+  p result
+rescue OneMsgChatApi::ApiError => e
+  puts "Error when calling ProfileApi->update_me: #{e}"
+end
+```
+
+#### Using the update_me_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_me_with_http_info(token, opts)
+
+```ruby
+begin
+  # Update profile info
+  data, status_code, headers = api_instance.update_me_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 ProfileApi->update_me_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | JWT token or API key for authorization |  |
+| **update_me_request** | [**UpdateMeRequest**](UpdateMeRequest.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/ProfileInfo.md

@@ -0,0 +1,32 @@
+# OneMsgChatApi::ProfileInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **about** | **String** | Profile's About section | [optional] |
+| **address** | **String** | Address of the business | [optional] |
+| **description** | **String** | Description of the business | [optional] |
+| **email** | **String** | Business email | [optional] |
+| **phone** | **String** | Linked phone number | [optional] |
+| **vertical** | **String** | Industry of the business | [optional] |
+| **photo** | **String** | Profile photo URL | [optional] |
+| **websites** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::ProfileInfo.new(
+  about: null,
+  address: null,
+  description: null,
+  email: null,
+  phone: null,
+  vertical: null,
+  photo: null,
+  websites: null
+)
+```
+

data/docs/RetrieveMedia200Response.md

@@ -0,0 +1,26 @@
+# OneMsgChatApi::RetrieveMedia200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** |  | [optional] |
+| **mime_type** | **String** |  | [optional] |
+| **sha256** | **String** |  | [optional] |
+| **file_size** | **Integer** |  | [optional] |
+| **id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::RetrieveMedia200Response.new(
+  url: null,
+  mime_type: null,
+  sha256: null,
+  file_size: null,
+  id: null
+)
+```
+

data/docs/SendAddressMessageRequest.md

@@ -0,0 +1,32 @@
+# OneMsgChatApi::SendAddressMessageRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone** | **Integer** | Recipient phone (E.164 digits, no +). Must match country. | [optional] |
+| **chat_id** | **String** |  | [optional] |
+| **body** | **String** | Body text shown with the address request |  |
+| **country** | **String** | Address form country. Defaults to IN if omitted. | [optional] |
+| **values** | **Hash<String, Object>** | Optional prefilled address fields | [optional] |
+| **saved_addresses** | **Array<Hash<String, Object>>** | Optional previously saved addresses for the user | [optional] |
+| **validation_errors** | **Hash<String, Object>** | Optional field validation errors when re-prompting | [optional] |
+| **quoted_msg_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::SendAddressMessageRequest.new(
+  phone: null,
+  chat_id: null,
+  body: null,
+  country: SG,
+  values: null,
+  saved_addresses: null,
+  validation_errors: null,
+  quoted_msg_id: null
+)
+```
+

data/docs/SendButtonRequest.md

@@ -0,0 +1,24 @@
+# OneMsgChatApi::SendButtonRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone** | **String** |  | [optional] |
+| **body** | **String** |  | [optional] |
+| **footer** | **String** |  | [optional] |
+| **sections** | [**Array<SendButtonRequestSectionsInner>**](SendButtonRequestSectionsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::SendButtonRequest.new(
+  phone: null,
+  body: null,
+  footer: null,
+  sections: null
+)
+```
+

data/docs/SendButtonRequestSectionsInner.md

@@ -0,0 +1,20 @@
+# OneMsgChatApi::SendButtonRequestSectionsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **reply** | [**SendButtonRequestSectionsInnerReply**](SendButtonRequestSectionsInnerReply.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::SendButtonRequestSectionsInner.new(
+  type: null,
+  reply: null
+)
+```
+

data/docs/SendButtonRequestSectionsInnerReply.md

@@ -0,0 +1,20 @@
+# OneMsgChatApi::SendButtonRequestSectionsInnerReply
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **title** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::SendButtonRequestSectionsInnerReply.new(
+  id: null,
+  title: null
+)
+```
+

data/docs/SendCarouselRequest1.md

@@ -0,0 +1,26 @@
+# OneMsgChatApi::SendCarouselRequest1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** |  | [optional] |
+| **params** | **Array<Object>** |  |  |
+| **quoted_msg_id** | **String** |  | [optional] |
+| **chat_id** | **String** |  | [optional] |
+| **phone** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::SendCarouselRequest1.new(
+  body: null,
+  params: null,
+  quoted_msg_id: null,
+  chat_id: null,
+  phone: null
+)
+```
+

data/docs/SendContactRequest.md

@@ -0,0 +1,20 @@
+# OneMsgChatApi::SendContactRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone** | **String** |  | [optional] |
+| **contacts** | [**Array<SendContactRequestContactsInner>**](SendContactRequestContactsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::SendContactRequest.new(
+  phone: null,
+  contacts: null
+)
+```
+

data/docs/SendContactRequestContactsInner.md

@@ -0,0 +1,30 @@
+# OneMsgChatApi::SendContactRequestContactsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | [**SendContactRequestContactsInnerName**](SendContactRequestContactsInnerName.md) |  | [optional] |
+| **birthday** | **String** |  | [optional] |
+| **addresses** | **Array<Object>** |  | [optional] |
+| **emails** | **Array<Object>** |  | [optional] |
+| **org** | [**SendContactRequestContactsInnerOrg**](SendContactRequestContactsInnerOrg.md) |  | [optional] |
+| **phones** | [**Array<SendContactRequestContactsInnerPhonesInner>**](SendContactRequestContactsInnerPhonesInner.md) |  | [optional] |
+| **urls** | **Array<Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::SendContactRequestContactsInner.new(
+  name: null,
+  birthday: null,
+  addresses: null,
+  emails: null,
+  org: null,
+  phones: null,
+  urls: null
+)
+```
+

data/docs/SendContactRequestContactsInnerName.md

@@ -0,0 +1,28 @@
+# OneMsgChatApi::SendContactRequestContactsInnerName
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **formatted_name** | **String** |  | [optional] |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+| **middle_name** | **String** |  | [optional] |
+| **suffix** | **String** |  | [optional] |
+| **prefix** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::SendContactRequestContactsInnerName.new(
+  formatted_name: null,
+  first_name: null,
+  last_name: null,
+  middle_name: null,
+  suffix: null,
+  prefix: null
+)
+```
+

data/docs/SendContactRequestContactsInnerOrg.md

@@ -0,0 +1,22 @@
+# OneMsgChatApi::SendContactRequestContactsInnerOrg
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company** | **String** |  | [optional] |
+| **department** | **String** |  | [optional] |
+| **title** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::SendContactRequestContactsInnerOrg.new(
+  company: null,
+  department: null,
+  title: null
+)
+```
+

data/docs/SendContactRequestContactsInnerPhonesInner.md

@@ -0,0 +1,22 @@
+# OneMsgChatApi::SendContactRequestContactsInnerPhonesInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+| **wa_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::SendContactRequestContactsInnerPhonesInner.new(
+  phone: null,
+  type: null,
+  wa_id: null
+)
+```
+

data/docs/SendCtaUrlRequest.md

@@ -0,0 +1,32 @@
+# OneMsgChatApi::SendCtaUrlRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone** | **Integer** |  | [optional] |
+| **chat_id** | **String** |  | [optional] |
+| **body** | **String** |  |  |
+| **display_text** | **String** | Button label |  |
+| **url** | **String** |  |  |
+| **header** | **Hash<String, Object>** |  | [optional] |
+| **footer** | **String** |  | [optional] |
+| **quoted_msg_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::SendCtaUrlRequest.new(
+  phone: null,
+  chat_id: null,
+  body: null,
+  display_text: null,
+  url: null,
+  header: null,
+  footer: null,
+  quoted_msg_id: null
+)
+```
+

data/docs/SendFileRequest.md

@@ -0,0 +1,34 @@
+# OneMsgChatApi::SendFileRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** | File source (required unless mediaId is set): - HTTP/HTTPS URL - Base64 data URI  | [optional] |
+| **filename** | **String** | File name with extension (required with body, not with mediaId) | [optional] |
+| **media_id** | **String** | WABA media id from uploadMedia (alternative to body) | [optional] |
+| **media_type** | **String** | Required when using mediaId | [optional] |
+| **voice** | **Boolean** | Native WhatsApp voice note (audio/ogg only) | [optional] |
+| **caption** | **String** |  | [optional] |
+| **quoted_msg_id** | **String** |  | [optional] |
+| **chat_id** | **String** |  | [optional] |
+| **phone** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::SendFileRequest.new(
+  body: null,
+  filename: null,
+  media_id: null,
+  media_type: null,
+  voice: null,
+  caption: null,
+  quoted_msg_id: null,
+  chat_id: null,
+  phone: null
+)
+```
+

data/docs/SendFlowRequest1.md

@@ -0,0 +1,46 @@
+# OneMsgChatApi::SendFlowRequest1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** |  |  |
+| **header** | [**SendFlowRequest1Header**](SendFlowRequest1Header.md) |  | [optional] |
+| **footer** | **String** |  | [optional] |
+| **flow_id** | **String** |  |  |
+| **flow_token** | **String** |  |  |
+| **flow_cta** | **String** |  |  |
+| **flow_action** | **String** |  | [optional] |
+| **flow_action_payload** | **Object** |  | [optional] |
+| **flow_message_version** | **String** |  | [optional] |
+| **mode** | **String** |  | [optional] |
+| **flow_action_data** | **Object** |  | [optional] |
+| **flow_action_screen** | **String** |  | [optional] |
+| **quoted_msg_id** | **String** |  | [optional] |
+| **chat_id** | **String** |  | [optional] |
+| **phone** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'one_msg_chat_api'
+
+instance = OneMsgChatApi::SendFlowRequest1.new(
+  body: null,
+  header: null,
+  footer: null,
+  flow_id: null,
+  flow_token: null,
+  flow_cta: null,
+  flow_action: null,
+  flow_action_payload: null,
+  flow_message_version: null,
+  mode: null,
+  flow_action_data: null,
+  flow_action_screen: null,
+  quoted_msg_id: null,
+  chat_id: null,
+  phone: null
+)
+```
+

data/docs/SendFlowRequest1Header.md

@@ -0,0 +1,49 @@
+# OneMsgChatApi::SendFlowRequest1Header
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'one_msg_chat_api'
+
+OneMsgChatApi::SendFlowRequest1Header.openapi_one_of
+# =>
+# [
+#   :'Object',
+#   :'String'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'one_msg_chat_api'
+
+OneMsgChatApi::SendFlowRequest1Header.build(data)
+# => #<Object:0x00007fdd4aab02a0>
+
+OneMsgChatApi::SendFlowRequest1Header.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Object`
+- `String`
+- `nil` (if no type matches)
+