one_msg_chat_api 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (227) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/LICENSE.txt +21 -0
  4. data/Rakefile +10 -0
  5. data/docs/AddTemplateRequest.md +24 -0
  6. data/docs/BlockUserRequest.md +18 -0
  7. data/docs/CallingApi.md +231 -0
  8. data/docs/CatalogApi.md +153 -0
  9. data/docs/ChannelApi.md +225 -0
  10. data/docs/ConversationalAutomation.md +22 -0
  11. data/docs/ConversationalAutomationCommandsInner.md +20 -0
  12. data/docs/CreateCommerce200Response.md +18 -0
  13. data/docs/CreateCommerceRequest.md +18 -0
  14. data/docs/CreateCommerceRequestParams.md +20 -0
  15. data/docs/CreateGroups200Response.md +18 -0
  16. data/docs/CreateReadMessage200Response.md +18 -0
  17. data/docs/CreateReadMessage401Response.md +18 -0
  18. data/docs/CreateReadMessageRequest.md +22 -0
  19. data/docs/DeleteFlowsFlowId200Response.md +20 -0
  20. data/docs/DeleteGroupsGroupId200Response.md +20 -0
  21. data/docs/DeleteMediaLegacyRequest.md +18 -0
  22. data/docs/ErrorResponse.md +18 -0
  23. data/docs/FlowsApi.md +836 -0
  24. data/docs/GetCommerce200ResponseInner.md +22 -0
  25. data/docs/GetMmLiteStatus200Response.md +22 -0
  26. data/docs/GetWebhook200Response.md +18 -0
  27. data/docs/GetWhatsappBusinessEncryption200Response.md +22 -0
  28. data/docs/GroupsApi.md +507 -0
  29. data/docs/ListBlockedUsers200Response.md +18 -0
  30. data/docs/ListFlows200Response.md +26 -0
  31. data/docs/ListMessages200Response.md +20 -0
  32. data/docs/ListTemplates200Response.md +22 -0
  33. data/docs/MessageSentResponse.md +24 -0
  34. data/docs/MessagingApi.md +1784 -0
  35. data/docs/PatchFlowsFlowIdAssets200Response.md +22 -0
  36. data/docs/ProfileApi.md +155 -0
  37. data/docs/ProfileInfo.md +32 -0
  38. data/docs/RetrieveMedia200Response.md +26 -0
  39. data/docs/SendAddressMessageRequest.md +32 -0
  40. data/docs/SendButtonRequest.md +24 -0
  41. data/docs/SendButtonRequestSectionsInner.md +20 -0
  42. data/docs/SendButtonRequestSectionsInnerReply.md +20 -0
  43. data/docs/SendCarouselRequest1.md +26 -0
  44. data/docs/SendContactRequest.md +20 -0
  45. data/docs/SendContactRequestContactsInner.md +30 -0
  46. data/docs/SendContactRequestContactsInnerName.md +28 -0
  47. data/docs/SendContactRequestContactsInnerOrg.md +22 -0
  48. data/docs/SendContactRequestContactsInnerPhonesInner.md +22 -0
  49. data/docs/SendCtaUrlRequest.md +32 -0
  50. data/docs/SendFileRequest.md +34 -0
  51. data/docs/SendFlowRequest1.md +46 -0
  52. data/docs/SendFlowRequest1Header.md +49 -0
  53. data/docs/SendFlowRequestHeader.md +49 -0
  54. data/docs/SendListRequest.md +26 -0
  55. data/docs/SendListRequestSectionsInner.md +20 -0
  56. data/docs/SendListRequestSectionsInnerRowsInner.md +22 -0
  57. data/docs/SendLocationRequest1.md +30 -0
  58. data/docs/SendLocationRequestRequest.md +20 -0
  59. data/docs/SendMessageRequest.md +24 -0
  60. data/docs/SendOrderDetailsRequest.md +36 -0
  61. data/docs/SendOrderDetailsRequestLanguage.md +20 -0
  62. data/docs/SendOrderDetailsRequestOrder.md +28 -0
  63. data/docs/SendOrderDetailsRequestOrderItemsInner.md +24 -0
  64. data/docs/SendOrderDetailsRequestOrderItemsInnerAmount.md +20 -0
  65. data/docs/SendPaymentRequestRequest.md +26 -0
  66. data/docs/SendReactionRequest.md +22 -0
  67. data/docs/SendStickerRequest.md +26 -0
  68. data/docs/SendTemplateRequest.md +32 -0
  69. data/docs/SendTemplateRequestLanguage.md +20 -0
  70. data/docs/SetWhatsappBusinessEncryptionRequest.md +21 -0
  71. data/docs/SuccessResponse.md +18 -0
  72. data/docs/TemplatesApi.md +301 -0
  73. data/docs/UpdateMeRequest.md +30 -0
  74. data/docs/UsersApi.md +223 -0
  75. data/docs/WebhooksApi.md +155 -0
  76. data/git_push.sh +57 -0
  77. data/lib/one_msg_chat_api/api/calling_api.rb +228 -0
  78. data/lib/one_msg_chat_api/api/catalog_api.rb +161 -0
  79. data/lib/one_msg_chat_api/api/channel_api.rb +225 -0
  80. data/lib/one_msg_chat_api/api/flows_api.rb +788 -0
  81. data/lib/one_msg_chat_api/api/groups_api.rb +486 -0
  82. data/lib/one_msg_chat_api/api/messaging_api.rb +1833 -0
  83. data/lib/one_msg_chat_api/api/profile_api.rb +157 -0
  84. data/lib/one_msg_chat_api/api/templates_api.rb +293 -0
  85. data/lib/one_msg_chat_api/api/users_api.rb +232 -0
  86. data/lib/one_msg_chat_api/api/webhooks_api.rb +157 -0
  87. data/lib/one_msg_chat_api/api_client.rb +441 -0
  88. data/lib/one_msg_chat_api/api_error.rb +58 -0
  89. data/lib/one_msg_chat_api/api_model_base.rb +88 -0
  90. data/lib/one_msg_chat_api/configuration.rb +400 -0
  91. data/lib/one_msg_chat_api/models/add_template_request.rb +176 -0
  92. data/lib/one_msg_chat_api/models/block_user_request.rb +164 -0
  93. data/lib/one_msg_chat_api/models/conversational_automation.rb +210 -0
  94. data/lib/one_msg_chat_api/models/conversational_automation_commands_inner.rb +208 -0
  95. data/lib/one_msg_chat_api/models/create_commerce200_response.rb +147 -0
  96. data/lib/one_msg_chat_api/models/create_commerce_request.rb +164 -0
  97. data/lib/one_msg_chat_api/models/create_commerce_request_params.rb +192 -0
  98. data/lib/one_msg_chat_api/models/create_groups200_response.rb +149 -0
  99. data/lib/one_msg_chat_api/models/create_read_message200_response.rb +147 -0
  100. data/lib/one_msg_chat_api/models/create_read_message401_response.rb +147 -0
  101. data/lib/one_msg_chat_api/models/create_read_message_request.rb +168 -0
  102. data/lib/one_msg_chat_api/models/delete_flows_flow_id200_response.rb +158 -0
  103. data/lib/one_msg_chat_api/models/delete_groups_group_id200_response.rb +158 -0
  104. data/lib/one_msg_chat_api/models/delete_media_legacy_request.rb +165 -0
  105. data/lib/one_msg_chat_api/models/error_response.rb +149 -0
  106. data/lib/one_msg_chat_api/models/get_commerce200_response_inner.rb +168 -0
  107. data/lib/one_msg_chat_api/models/get_mm_lite_status200_response.rb +165 -0
  108. data/lib/one_msg_chat_api/models/get_webhook200_response.rb +147 -0
  109. data/lib/one_msg_chat_api/models/get_whatsapp_business_encryption200_response.rb +202 -0
  110. data/lib/one_msg_chat_api/models/list_blocked_users200_response.rb +149 -0
  111. data/lib/one_msg_chat_api/models/list_flows200_response.rb +189 -0
  112. data/lib/one_msg_chat_api/models/list_messages200_response.rb +158 -0
  113. data/lib/one_msg_chat_api/models/list_templates200_response.rb +169 -0
  114. data/lib/one_msg_chat_api/models/message_sent_response.rb +179 -0
  115. data/lib/one_msg_chat_api/models/patch_flows_flow_id_assets200_response.rb +169 -0
  116. data/lib/one_msg_chat_api/models/profile_info.rb +254 -0
  117. data/lib/one_msg_chat_api/models/retrieve_media200_response.rb +183 -0
  118. data/lib/one_msg_chat_api/models/send_address_message_request.rb +273 -0
  119. data/lib/one_msg_chat_api/models/send_button_request.rb +176 -0
  120. data/lib/one_msg_chat_api/models/send_button_request_sections_inner.rb +156 -0
  121. data/lib/one_msg_chat_api/models/send_button_request_sections_inner_reply.rb +156 -0
  122. data/lib/one_msg_chat_api/models/send_carousel_request1.rb +202 -0
  123. data/lib/one_msg_chat_api/models/send_contact_request.rb +158 -0
  124. data/lib/one_msg_chat_api/models/send_contact_request_contacts_inner.rb +209 -0
  125. data/lib/one_msg_chat_api/models/send_contact_request_contacts_inner_name.rb +192 -0
  126. data/lib/one_msg_chat_api/models/send_contact_request_contacts_inner_org.rb +165 -0
  127. data/lib/one_msg_chat_api/models/send_contact_request_contacts_inner_phones_inner.rb +165 -0
  128. data/lib/one_msg_chat_api/models/send_cta_url_request.rb +264 -0
  129. data/lib/one_msg_chat_api/models/send_file_request.rb +278 -0
  130. data/lib/one_msg_chat_api/models/send_flow_request1.rb +387 -0
  131. data/lib/one_msg_chat_api/models/send_flow_request1_header.rb +104 -0
  132. data/lib/one_msg_chat_api/models/send_flow_request_header.rb +105 -0
  133. data/lib/one_msg_chat_api/models/send_list_request.rb +185 -0
  134. data/lib/one_msg_chat_api/models/send_list_request_sections_inner.rb +158 -0
  135. data/lib/one_msg_chat_api/models/send_list_request_sections_inner_rows_inner.rb +165 -0
  136. data/lib/one_msg_chat_api/models/send_location_request1.rb +235 -0
  137. data/lib/one_msg_chat_api/models/send_location_request_request.rb +156 -0
  138. data/lib/one_msg_chat_api/models/send_message_request.rb +284 -0
  139. data/lib/one_msg_chat_api/models/send_order_details_request.rb +308 -0
  140. data/lib/one_msg_chat_api/models/send_order_details_request_language.rb +176 -0
  141. data/lib/one_msg_chat_api/models/send_order_details_request_order.rb +220 -0
  142. data/lib/one_msg_chat_api/models/send_order_details_request_order_items_inner.rb +174 -0
  143. data/lib/one_msg_chat_api/models/send_order_details_request_order_items_inner_amount.rb +156 -0
  144. data/lib/one_msg_chat_api/models/send_payment_request_request.rb +245 -0
  145. data/lib/one_msg_chat_api/models/send_reaction_request.rb +165 -0
  146. data/lib/one_msg_chat_api/models/send_sticker_request.rb +185 -0
  147. data/lib/one_msg_chat_api/models/send_template_request.rb +215 -0
  148. data/lib/one_msg_chat_api/models/send_template_request_language.rb +156 -0
  149. data/lib/one_msg_chat_api/models/set_whatsapp_business_encryption_request.rb +165 -0
  150. data/lib/one_msg_chat_api/models/success_response.rb +149 -0
  151. data/lib/one_msg_chat_api/models/update_me_request.rb +207 -0
  152. data/lib/one_msg_chat_api/version.rb +15 -0
  153. data/lib/one_msg_chat_api.rb +111 -0
  154. data/one_msg_chat_api.gemspec +41 -0
  155. data/spec/api/calling_api_spec.rb +73 -0
  156. data/spec/api/catalog_api_spec.rb +60 -0
  157. data/spec/api/channel_api_spec.rb +72 -0
  158. data/spec/api/flows_api_spec.rb +175 -0
  159. data/spec/api/groups_api_spec.rb +117 -0
  160. data/spec/api/messaging_api_spec.rb +359 -0
  161. data/spec/api/profile_api_spec.rb +60 -0
  162. data/spec/api/templates_api_spec.rb +83 -0
  163. data/spec/api/users_api_spec.rb +71 -0
  164. data/spec/api/webhooks_api_spec.rb +60 -0
  165. data/spec/models/add_template_request_spec.rb +54 -0
  166. data/spec/models/block_user_request_spec.rb +36 -0
  167. data/spec/models/conversational_automation_commands_inner_spec.rb +42 -0
  168. data/spec/models/conversational_automation_spec.rb +48 -0
  169. data/spec/models/create_commerce200_response_spec.rb +36 -0
  170. data/spec/models/create_commerce_request_params_spec.rb +42 -0
  171. data/spec/models/create_commerce_request_spec.rb +36 -0
  172. data/spec/models/create_groups200_response_spec.rb +36 -0
  173. data/spec/models/create_read_message200_response_spec.rb +36 -0
  174. data/spec/models/create_read_message401_response_spec.rb +36 -0
  175. data/spec/models/create_read_message_request_spec.rb +48 -0
  176. data/spec/models/delete_flows_flow_id200_response_spec.rb +42 -0
  177. data/spec/models/delete_groups_group_id200_response_spec.rb +42 -0
  178. data/spec/models/delete_media_legacy_request_spec.rb +36 -0
  179. data/spec/models/error_response_spec.rb +36 -0
  180. data/spec/models/get_commerce200_response_inner_spec.rb +48 -0
  181. data/spec/models/get_mm_lite_status200_response_spec.rb +48 -0
  182. data/spec/models/get_webhook200_response_spec.rb +36 -0
  183. data/spec/models/get_whatsapp_business_encryption200_response_spec.rb +52 -0
  184. data/spec/models/list_blocked_users200_response_spec.rb +36 -0
  185. data/spec/models/list_flows200_response_spec.rb +60 -0
  186. data/spec/models/list_messages200_response_spec.rb +42 -0
  187. data/spec/models/list_templates200_response_spec.rb +48 -0
  188. data/spec/models/message_sent_response_spec.rb +54 -0
  189. data/spec/models/patch_flows_flow_id_assets200_response_spec.rb +48 -0
  190. data/spec/models/profile_info_spec.rb +82 -0
  191. data/spec/models/retrieve_media200_response_spec.rb +60 -0
  192. data/spec/models/send_address_message_request_spec.rb +82 -0
  193. data/spec/models/send_button_request_sections_inner_reply_spec.rb +42 -0
  194. data/spec/models/send_button_request_sections_inner_spec.rb +42 -0
  195. data/spec/models/send_button_request_spec.rb +54 -0
  196. data/spec/models/send_carousel_request1_spec.rb +60 -0
  197. data/spec/models/send_contact_request_contacts_inner_name_spec.rb +66 -0
  198. data/spec/models/send_contact_request_contacts_inner_org_spec.rb +48 -0
  199. data/spec/models/send_contact_request_contacts_inner_phones_inner_spec.rb +48 -0
  200. data/spec/models/send_contact_request_contacts_inner_spec.rb +72 -0
  201. data/spec/models/send_contact_request_spec.rb +42 -0
  202. data/spec/models/send_cta_url_request_spec.rb +78 -0
  203. data/spec/models/send_file_request_spec.rb +88 -0
  204. data/spec/models/send_flow_request1_header_spec.rb +32 -0
  205. data/spec/models/send_flow_request1_spec.rb +128 -0
  206. data/spec/models/send_flow_request_header_spec.rb +32 -0
  207. data/spec/models/send_list_request_sections_inner_rows_inner_spec.rb +48 -0
  208. data/spec/models/send_list_request_sections_inner_spec.rb +42 -0
  209. data/spec/models/send_list_request_spec.rb +60 -0
  210. data/spec/models/send_location_request1_spec.rb +72 -0
  211. data/spec/models/send_location_request_request_spec.rb +42 -0
  212. data/spec/models/send_message_request_spec.rb +54 -0
  213. data/spec/models/send_order_details_request_language_spec.rb +42 -0
  214. data/spec/models/send_order_details_request_order_items_inner_amount_spec.rb +42 -0
  215. data/spec/models/send_order_details_request_order_items_inner_spec.rb +54 -0
  216. data/spec/models/send_order_details_request_order_spec.rb +66 -0
  217. data/spec/models/send_order_details_request_spec.rb +90 -0
  218. data/spec/models/send_payment_request_request_spec.rb +64 -0
  219. data/spec/models/send_reaction_request_spec.rb +48 -0
  220. data/spec/models/send_sticker_request_spec.rb +60 -0
  221. data/spec/models/send_template_request_language_spec.rb +42 -0
  222. data/spec/models/send_template_request_spec.rb +78 -0
  223. data/spec/models/set_whatsapp_business_encryption_request_spec.rb +36 -0
  224. data/spec/models/success_response_spec.rb +36 -0
  225. data/spec/models/update_me_request_spec.rb +72 -0
  226. data/spec/spec_helper.rb +111 -0
  227. metadata +408 -0
@@ -0,0 +1,22 @@
1
+ # OneMsgChatApi::GetCommerce200ResponseInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Catalog id | [optional] |
8
+ | **is_cart_enabled** | **Boolean** | Whether the cart is enabled | [optional] |
9
+ | **is_catalog_visible** | **Boolean** | Whether the catalog storefront icon is shown | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'one_msg_chat_api'
15
+
16
+ instance = OneMsgChatApi::GetCommerce200ResponseInner.new(
17
+ id: null,
18
+ is_cart_enabled: null,
19
+ is_catalog_visible: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,22 @@
1
+ # OneMsgChatApi::GetMmLiteStatus200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **available** | **Boolean** | | [optional] |
8
+ | **status** | **String** | | [optional] |
9
+ | **message** | **String** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'one_msg_chat_api'
15
+
16
+ instance = OneMsgChatApi::GetMmLiteStatus200Response.new(
17
+ available: null,
18
+ status: null,
19
+ message: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,18 @@
1
+ # OneMsgChatApi::GetWebhook200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **webhook_url** | **String** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'one_msg_chat_api'
13
+
14
+ instance = OneMsgChatApi::GetWebhook200Response.new(
15
+ webhook_url: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,22 @@
1
+ # OneMsgChatApi::GetWhatsappBusinessEncryption200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **business_public_key** | **String** | Stored 2048-bit RSA public key (PEM) | [optional] |
8
+ | **business_public_key_signature_status** | **String** | | [optional] |
9
+ | **data** | **Array<Hash<String, Object>>** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'one_msg_chat_api'
15
+
16
+ instance = OneMsgChatApi::GetWhatsappBusinessEncryption200Response.new(
17
+ business_public_key: null,
18
+ business_public_key_signature_status: null,
19
+ data: null
20
+ )
21
+ ```
22
+
data/docs/GroupsApi.md ADDED
@@ -0,0 +1,507 @@
1
+ # OneMsgChatApi::GroupsApi
2
+
3
+ All URIs are relative to *https://api.1msg.io*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_groups**](GroupsApi.md#create_groups) | **POST** /groups | Create Group |
8
+ | [**create_groups_group_id**](GroupsApi.md#create_groups_group_id) | **POST** /groups/{groupId} | Update Group Info |
9
+ | [**create_groups_group_id_invitelink**](GroupsApi.md#create_groups_group_id_invitelink) | **POST** /groups/{groupId}/inviteLink | Reset Invite Link |
10
+ | [**delete_groups_group_id**](GroupsApi.md#delete_groups_group_id) | **DELETE** /groups/{groupId} | Delete Group |
11
+ | [**get_groups_group_id**](GroupsApi.md#get_groups_group_id) | **GET** /groups/{groupId} | Get Group Info |
12
+ | [**get_groups_group_id_invitelink**](GroupsApi.md#get_groups_group_id_invitelink) | **GET** /groups/{groupId}/inviteLink | Get Invite Link |
13
+ | [**list_groups**](GroupsApi.md#list_groups) | **GET** /groups | Get Groups List |
14
+
15
+
16
+ ## create_groups
17
+
18
+ > <CreateGroups200Response> create_groups(token)
19
+
20
+ Create Group
21
+
22
+ ### Examples
23
+
24
+ ```ruby
25
+ require 'time'
26
+ require 'one_msg_chat_api'
27
+ # setup authorization
28
+ OneMsgChatApi.configure do |config|
29
+ # Configure API key authorization: tokenAuth
30
+ config.api_key['token'] = 'YOUR API KEY'
31
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
32
+ # config.api_key_prefix['token'] = 'Bearer'
33
+ end
34
+
35
+ api_instance = OneMsgChatApi::GroupsApi.new
36
+ token = 'token_example' # String | JWT token or API key for authorization
37
+
38
+ begin
39
+ # Create Group
40
+ result = api_instance.create_groups(token)
41
+ p result
42
+ rescue OneMsgChatApi::ApiError => e
43
+ puts "Error when calling GroupsApi->create_groups: #{e}"
44
+ end
45
+ ```
46
+
47
+ #### Using the create_groups_with_http_info variant
48
+
49
+ This returns an Array which contains the response data, status code and headers.
50
+
51
+ > <Array(<CreateGroups200Response>, Integer, Hash)> create_groups_with_http_info(token)
52
+
53
+ ```ruby
54
+ begin
55
+ # Create Group
56
+ data, status_code, headers = api_instance.create_groups_with_http_info(token)
57
+ p status_code # => 2xx
58
+ p headers # => { ... }
59
+ p data # => <CreateGroups200Response>
60
+ rescue OneMsgChatApi::ApiError => e
61
+ puts "Error when calling GroupsApi->create_groups_with_http_info: #{e}"
62
+ end
63
+ ```
64
+
65
+ ### Parameters
66
+
67
+ | Name | Type | Description | Notes |
68
+ | ---- | ---- | ----------- | ----- |
69
+ | **token** | **String** | JWT token or API key for authorization | |
70
+
71
+ ### Return type
72
+
73
+ [**CreateGroups200Response**](CreateGroups200Response.md)
74
+
75
+ ### Authorization
76
+
77
+ [tokenAuth](../README.md#tokenAuth)
78
+
79
+ ### HTTP request headers
80
+
81
+ - **Content-Type**: Not defined
82
+ - **Accept**: application/json
83
+
84
+
85
+ ## create_groups_group_id
86
+
87
+ > Hash&lt;String, Object&gt; create_groups_group_id(group_id, token)
88
+
89
+ Update Group Info
90
+
91
+ ### Examples
92
+
93
+ ```ruby
94
+ require 'time'
95
+ require 'one_msg_chat_api'
96
+ # setup authorization
97
+ OneMsgChatApi.configure do |config|
98
+ # Configure API key authorization: tokenAuth
99
+ config.api_key['token'] = 'YOUR API KEY'
100
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
101
+ # config.api_key_prefix['token'] = 'Bearer'
102
+ end
103
+
104
+ api_instance = OneMsgChatApi::GroupsApi.new
105
+ group_id = '{{createdGroupId}}' # String |
106
+ token = 'token_example' # String | JWT token or API key for authorization
107
+
108
+ begin
109
+ # Update Group Info
110
+ result = api_instance.create_groups_group_id(group_id, token)
111
+ p result
112
+ rescue OneMsgChatApi::ApiError => e
113
+ puts "Error when calling GroupsApi->create_groups_group_id: #{e}"
114
+ end
115
+ ```
116
+
117
+ #### Using the create_groups_group_id_with_http_info variant
118
+
119
+ This returns an Array which contains the response data, status code and headers.
120
+
121
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_groups_group_id_with_http_info(group_id, token)
122
+
123
+ ```ruby
124
+ begin
125
+ # Update Group Info
126
+ data, status_code, headers = api_instance.create_groups_group_id_with_http_info(group_id, token)
127
+ p status_code # => 2xx
128
+ p headers # => { ... }
129
+ p data # => Hash&lt;String, Object&gt;
130
+ rescue OneMsgChatApi::ApiError => e
131
+ puts "Error when calling GroupsApi->create_groups_group_id_with_http_info: #{e}"
132
+ end
133
+ ```
134
+
135
+ ### Parameters
136
+
137
+ | Name | Type | Description | Notes |
138
+ | ---- | ---- | ----------- | ----- |
139
+ | **group_id** | **String** | | |
140
+ | **token** | **String** | JWT token or API key for authorization | |
141
+
142
+ ### Return type
143
+
144
+ **Hash&lt;String, Object&gt;**
145
+
146
+ ### Authorization
147
+
148
+ [tokenAuth](../README.md#tokenAuth)
149
+
150
+ ### HTTP request headers
151
+
152
+ - **Content-Type**: Not defined
153
+ - **Accept**: application/json
154
+
155
+
156
+ ## create_groups_group_id_invitelink
157
+
158
+ > Hash&lt;String, Object&gt; create_groups_group_id_invitelink(group_id, token)
159
+
160
+ Reset Invite Link
161
+
162
+ ### Examples
163
+
164
+ ```ruby
165
+ require 'time'
166
+ require 'one_msg_chat_api'
167
+ # setup authorization
168
+ OneMsgChatApi.configure do |config|
169
+ # Configure API key authorization: tokenAuth
170
+ config.api_key['token'] = 'YOUR API KEY'
171
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
172
+ # config.api_key_prefix['token'] = 'Bearer'
173
+ end
174
+
175
+ api_instance = OneMsgChatApi::GroupsApi.new
176
+ group_id = '{{createdGroupId}}' # String |
177
+ token = 'token_example' # String | JWT token or API key for authorization
178
+
179
+ begin
180
+ # Reset Invite Link
181
+ result = api_instance.create_groups_group_id_invitelink(group_id, token)
182
+ p result
183
+ rescue OneMsgChatApi::ApiError => e
184
+ puts "Error when calling GroupsApi->create_groups_group_id_invitelink: #{e}"
185
+ end
186
+ ```
187
+
188
+ #### Using the create_groups_group_id_invitelink_with_http_info variant
189
+
190
+ This returns an Array which contains the response data, status code and headers.
191
+
192
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> create_groups_group_id_invitelink_with_http_info(group_id, token)
193
+
194
+ ```ruby
195
+ begin
196
+ # Reset Invite Link
197
+ data, status_code, headers = api_instance.create_groups_group_id_invitelink_with_http_info(group_id, token)
198
+ p status_code # => 2xx
199
+ p headers # => { ... }
200
+ p data # => Hash&lt;String, Object&gt;
201
+ rescue OneMsgChatApi::ApiError => e
202
+ puts "Error when calling GroupsApi->create_groups_group_id_invitelink_with_http_info: #{e}"
203
+ end
204
+ ```
205
+
206
+ ### Parameters
207
+
208
+ | Name | Type | Description | Notes |
209
+ | ---- | ---- | ----------- | ----- |
210
+ | **group_id** | **String** | | |
211
+ | **token** | **String** | JWT token or API key for authorization | |
212
+
213
+ ### Return type
214
+
215
+ **Hash&lt;String, Object&gt;**
216
+
217
+ ### Authorization
218
+
219
+ [tokenAuth](../README.md#tokenAuth)
220
+
221
+ ### HTTP request headers
222
+
223
+ - **Content-Type**: Not defined
224
+ - **Accept**: application/json
225
+
226
+
227
+ ## delete_groups_group_id
228
+
229
+ > <DeleteGroupsGroupId200Response> delete_groups_group_id(group_id, token)
230
+
231
+ Delete Group
232
+
233
+ ### Examples
234
+
235
+ ```ruby
236
+ require 'time'
237
+ require 'one_msg_chat_api'
238
+ # setup authorization
239
+ OneMsgChatApi.configure do |config|
240
+ # Configure API key authorization: tokenAuth
241
+ config.api_key['token'] = 'YOUR API KEY'
242
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
243
+ # config.api_key_prefix['token'] = 'Bearer'
244
+ end
245
+
246
+ api_instance = OneMsgChatApi::GroupsApi.new
247
+ group_id = '{{createdGroupId}}' # String |
248
+ token = 'token_example' # String | JWT token or API key for authorization
249
+
250
+ begin
251
+ # Delete Group
252
+ result = api_instance.delete_groups_group_id(group_id, token)
253
+ p result
254
+ rescue OneMsgChatApi::ApiError => e
255
+ puts "Error when calling GroupsApi->delete_groups_group_id: #{e}"
256
+ end
257
+ ```
258
+
259
+ #### Using the delete_groups_group_id_with_http_info variant
260
+
261
+ This returns an Array which contains the response data, status code and headers.
262
+
263
+ > <Array(<DeleteGroupsGroupId200Response>, Integer, Hash)> delete_groups_group_id_with_http_info(group_id, token)
264
+
265
+ ```ruby
266
+ begin
267
+ # Delete Group
268
+ data, status_code, headers = api_instance.delete_groups_group_id_with_http_info(group_id, token)
269
+ p status_code # => 2xx
270
+ p headers # => { ... }
271
+ p data # => <DeleteGroupsGroupId200Response>
272
+ rescue OneMsgChatApi::ApiError => e
273
+ puts "Error when calling GroupsApi->delete_groups_group_id_with_http_info: #{e}"
274
+ end
275
+ ```
276
+
277
+ ### Parameters
278
+
279
+ | Name | Type | Description | Notes |
280
+ | ---- | ---- | ----------- | ----- |
281
+ | **group_id** | **String** | | |
282
+ | **token** | **String** | JWT token or API key for authorization | |
283
+
284
+ ### Return type
285
+
286
+ [**DeleteGroupsGroupId200Response**](DeleteGroupsGroupId200Response.md)
287
+
288
+ ### Authorization
289
+
290
+ [tokenAuth](../README.md#tokenAuth)
291
+
292
+ ### HTTP request headers
293
+
294
+ - **Content-Type**: Not defined
295
+ - **Accept**: application/json
296
+
297
+
298
+ ## get_groups_group_id
299
+
300
+ > Hash&lt;String, Object&gt; get_groups_group_id(group_id, token)
301
+
302
+ Get Group Info
303
+
304
+ ### Examples
305
+
306
+ ```ruby
307
+ require 'time'
308
+ require 'one_msg_chat_api'
309
+ # setup authorization
310
+ OneMsgChatApi.configure do |config|
311
+ # Configure API key authorization: tokenAuth
312
+ config.api_key['token'] = 'YOUR API KEY'
313
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
314
+ # config.api_key_prefix['token'] = 'Bearer'
315
+ end
316
+
317
+ api_instance = OneMsgChatApi::GroupsApi.new
318
+ group_id = '{{createdGroupId}}' # String |
319
+ token = 'token_example' # String | JWT token or API key for authorization
320
+
321
+ begin
322
+ # Get Group Info
323
+ result = api_instance.get_groups_group_id(group_id, token)
324
+ p result
325
+ rescue OneMsgChatApi::ApiError => e
326
+ puts "Error when calling GroupsApi->get_groups_group_id: #{e}"
327
+ end
328
+ ```
329
+
330
+ #### Using the get_groups_group_id_with_http_info variant
331
+
332
+ This returns an Array which contains the response data, status code and headers.
333
+
334
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_groups_group_id_with_http_info(group_id, token)
335
+
336
+ ```ruby
337
+ begin
338
+ # Get Group Info
339
+ data, status_code, headers = api_instance.get_groups_group_id_with_http_info(group_id, token)
340
+ p status_code # => 2xx
341
+ p headers # => { ... }
342
+ p data # => Hash&lt;String, Object&gt;
343
+ rescue OneMsgChatApi::ApiError => e
344
+ puts "Error when calling GroupsApi->get_groups_group_id_with_http_info: #{e}"
345
+ end
346
+ ```
347
+
348
+ ### Parameters
349
+
350
+ | Name | Type | Description | Notes |
351
+ | ---- | ---- | ----------- | ----- |
352
+ | **group_id** | **String** | | |
353
+ | **token** | **String** | JWT token or API key for authorization | |
354
+
355
+ ### Return type
356
+
357
+ **Hash&lt;String, Object&gt;**
358
+
359
+ ### Authorization
360
+
361
+ [tokenAuth](../README.md#tokenAuth)
362
+
363
+ ### HTTP request headers
364
+
365
+ - **Content-Type**: Not defined
366
+ - **Accept**: application/json
367
+
368
+
369
+ ## get_groups_group_id_invitelink
370
+
371
+ > Hash&lt;String, Object&gt; get_groups_group_id_invitelink(group_id, token)
372
+
373
+ Get Invite Link
374
+
375
+ ### Examples
376
+
377
+ ```ruby
378
+ require 'time'
379
+ require 'one_msg_chat_api'
380
+ # setup authorization
381
+ OneMsgChatApi.configure do |config|
382
+ # Configure API key authorization: tokenAuth
383
+ config.api_key['token'] = 'YOUR API KEY'
384
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
385
+ # config.api_key_prefix['token'] = 'Bearer'
386
+ end
387
+
388
+ api_instance = OneMsgChatApi::GroupsApi.new
389
+ group_id = '{{createdGroupId}}' # String |
390
+ token = 'token_example' # String | JWT token or API key for authorization
391
+
392
+ begin
393
+ # Get Invite Link
394
+ result = api_instance.get_groups_group_id_invitelink(group_id, token)
395
+ p result
396
+ rescue OneMsgChatApi::ApiError => e
397
+ puts "Error when calling GroupsApi->get_groups_group_id_invitelink: #{e}"
398
+ end
399
+ ```
400
+
401
+ #### Using the get_groups_group_id_invitelink_with_http_info variant
402
+
403
+ This returns an Array which contains the response data, status code and headers.
404
+
405
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> get_groups_group_id_invitelink_with_http_info(group_id, token)
406
+
407
+ ```ruby
408
+ begin
409
+ # Get Invite Link
410
+ data, status_code, headers = api_instance.get_groups_group_id_invitelink_with_http_info(group_id, token)
411
+ p status_code # => 2xx
412
+ p headers # => { ... }
413
+ p data # => Hash&lt;String, Object&gt;
414
+ rescue OneMsgChatApi::ApiError => e
415
+ puts "Error when calling GroupsApi->get_groups_group_id_invitelink_with_http_info: #{e}"
416
+ end
417
+ ```
418
+
419
+ ### Parameters
420
+
421
+ | Name | Type | Description | Notes |
422
+ | ---- | ---- | ----------- | ----- |
423
+ | **group_id** | **String** | | |
424
+ | **token** | **String** | JWT token or API key for authorization | |
425
+
426
+ ### Return type
427
+
428
+ **Hash&lt;String, Object&gt;**
429
+
430
+ ### Authorization
431
+
432
+ [tokenAuth](../README.md#tokenAuth)
433
+
434
+ ### HTTP request headers
435
+
436
+ - **Content-Type**: Not defined
437
+ - **Accept**: application/json
438
+
439
+
440
+ ## list_groups
441
+
442
+ > Hash&lt;String, Object&gt; list_groups(token)
443
+
444
+ Get Groups List
445
+
446
+ ### Examples
447
+
448
+ ```ruby
449
+ require 'time'
450
+ require 'one_msg_chat_api'
451
+ # setup authorization
452
+ OneMsgChatApi.configure do |config|
453
+ # Configure API key authorization: tokenAuth
454
+ config.api_key['token'] = 'YOUR API KEY'
455
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
456
+ # config.api_key_prefix['token'] = 'Bearer'
457
+ end
458
+
459
+ api_instance = OneMsgChatApi::GroupsApi.new
460
+ token = 'token_example' # String | JWT token or API key for authorization
461
+
462
+ begin
463
+ # Get Groups List
464
+ result = api_instance.list_groups(token)
465
+ p result
466
+ rescue OneMsgChatApi::ApiError => e
467
+ puts "Error when calling GroupsApi->list_groups: #{e}"
468
+ end
469
+ ```
470
+
471
+ #### Using the list_groups_with_http_info variant
472
+
473
+ This returns an Array which contains the response data, status code and headers.
474
+
475
+ > <Array(Hash&lt;String, Object&gt;, Integer, Hash)> list_groups_with_http_info(token)
476
+
477
+ ```ruby
478
+ begin
479
+ # Get Groups List
480
+ data, status_code, headers = api_instance.list_groups_with_http_info(token)
481
+ p status_code # => 2xx
482
+ p headers # => { ... }
483
+ p data # => Hash&lt;String, Object&gt;
484
+ rescue OneMsgChatApi::ApiError => e
485
+ puts "Error when calling GroupsApi->list_groups_with_http_info: #{e}"
486
+ end
487
+ ```
488
+
489
+ ### Parameters
490
+
491
+ | Name | Type | Description | Notes |
492
+ | ---- | ---- | ----------- | ----- |
493
+ | **token** | **String** | JWT token or API key for authorization | |
494
+
495
+ ### Return type
496
+
497
+ **Hash&lt;String, Object&gt;**
498
+
499
+ ### Authorization
500
+
501
+ [tokenAuth](../README.md#tokenAuth)
502
+
503
+ ### HTTP request headers
504
+
505
+ - **Content-Type**: Not defined
506
+ - **Accept**: application/json
507
+
@@ -0,0 +1,18 @@
1
+ # OneMsgChatApi::ListBlockedUsers200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **blocked_users** | **Array&lt;Hash&lt;String, Object&gt;&gt;** | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'one_msg_chat_api'
13
+
14
+ instance = OneMsgChatApi::ListBlockedUsers200Response.new(
15
+ blocked_users: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,26 @@
1
+ # OneMsgChatApi::ListFlows200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **items** | **Array&lt;Hash&lt;String, Object&gt;&gt;** | | [optional] |
8
+ | **paging** | **Hash&lt;String, Object&gt;** | | [optional] |
9
+ | **count** | **Integer** | | [optional] |
10
+ | **total** | **Integer** | | [optional] |
11
+ | **error** | **Object** | Error details returned by the provider. May be a string or a JSON object. | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'one_msg_chat_api'
17
+
18
+ instance = OneMsgChatApi::ListFlows200Response.new(
19
+ items: null,
20
+ paging: null,
21
+ count: null,
22
+ total: null,
23
+ error: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,20 @@
1
+ # OneMsgChatApi::ListMessages200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **notice** | **String** | | [optional] |
8
+ | **messages** | **Array&lt;Hash&lt;String, Object&gt;&gt;** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'one_msg_chat_api'
14
+
15
+ instance = OneMsgChatApi::ListMessages200Response.new(
16
+ notice: null,
17
+ messages: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,22 @@
1
+ # OneMsgChatApi::ListTemplates200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **total** | **Integer** | | [optional] |
8
+ | **templates** | **Array&lt;Hash&lt;String, Object&gt;&gt;** | | [optional] |
9
+ | **error** | **Hash&lt;String, Object&gt;** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'one_msg_chat_api'
15
+
16
+ instance = OneMsgChatApi::ListTemplates200Response.new(
17
+ total: null,
18
+ templates: null,
19
+ error: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,24 @@
1
+ # OneMsgChatApi::MessageSentResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sent** | **Boolean** | Whether the message was successfully queued for sending | [optional] |
8
+ | **id** | **String** | Message ID | [optional] |
9
+ | **message** | **String** | Status message | [optional] |
10
+ | **description** | **String** | Detailed description | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'one_msg_chat_api'
16
+
17
+ instance = OneMsgChatApi::MessageSentResponse.new(
18
+ sent: null,
19
+ id: null,
20
+ message: null,
21
+ description: null
22
+ )
23
+ ```
24
+