rcs 1.0.17 → 2.0.0.pre.rc.1

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 (321) hide show
  1. checksums.yaml +4 -4
  2. data/lib/environment.rb +1 -1
  3. data/lib/rcs/brands/client.rb +631 -0
  4. data/lib/rcs/brands/types/autofill_brand_schema_options.rb +61 -0
  5. data/lib/rcs/brands/types/brand_contact.rb +84 -0
  6. data/lib/rcs/campaigns/client.rb +44 -0
  7. data/lib/rcs/campaigns/dlc/client.rb +480 -0
  8. data/lib/rcs/campaigns/dlc/types/upsert_dlc_schema_keywords.rb +99 -0
  9. data/lib/rcs/campaigns/dlc/types/upsert_dlc_schema_keywords_help.rb +74 -0
  10. data/lib/rcs/campaigns/dlc/types/upsert_dlc_schema_keywords_opt_in.rb +74 -0
  11. data/lib/rcs/campaigns/dlc/types/upsert_dlc_schema_keywords_opt_out.rb +74 -0
  12. data/lib/rcs/campaigns/dlc/types/upsert_dlc_schema_links.rb +74 -0
  13. data/lib/rcs/campaigns/dlc/types/upsert_dlc_schema_options.rb +110 -0
  14. data/lib/rcs/campaigns/dlc/types/upsert_dlc_schema_use_case.rb +76 -0
  15. data/lib/rcs/campaigns/rcs/client.rb +457 -0
  16. data/lib/rcs/campaigns/rcs/types/rcs_autofill_response.rb +155 -0
  17. data/lib/rcs/campaigns/rcs/types/upsert_rcs_schema_agent.rb +140 -0
  18. data/lib/rcs/campaigns/rcs/types/upsert_rcs_schema_agent_emails_item.rb +73 -0
  19. data/lib/rcs/campaigns/rcs/types/upsert_rcs_schema_agent_phones_item.rb +73 -0
  20. data/lib/rcs/campaigns/rcs/types/upsert_rcs_schema_agent_websites_item.rb +73 -0
  21. data/lib/rcs/campaigns/rcs/types/upsert_rcs_schema_links.rb +74 -0
  22. data/lib/rcs/campaigns/rcs/types/upsert_rcs_schema_opt_in.rb +75 -0
  23. data/lib/rcs/campaigns/rcs/types/upsert_rcs_schema_opt_out.rb +76 -0
  24. data/lib/rcs/campaigns/rcs/types/upsert_rcs_schema_use_case.rb +75 -0
  25. data/lib/rcs/campaigns/toll_free/client.rb +429 -0
  26. data/lib/rcs/campaigns/toll_free/types/toll_free_autofill_response.rb +130 -0
  27. data/lib/rcs/campaigns/toll_free/types/upsert_toll_free_schema_opt_in.rb +86 -0
  28. data/lib/rcs/campaigns/toll_free/types/upsert_toll_free_schema_use_case.rb +75 -0
  29. data/lib/rcs/contacts/client.rb +275 -0
  30. data/lib/rcs/conversations/client.rb +273 -0
  31. data/lib/rcs/message/client.rb +30 -0
  32. data/lib/rcs/message/sms/client.rb +96 -0
  33. data/lib/rcs/messages/client.rb +185 -0
  34. data/lib/rcs/messages/mms/client.rb +98 -0
  35. data/lib/rcs/messages/rcs/client.rb +94 -0
  36. data/lib/rcs/messages/send/client.rb +318 -0
  37. data/lib/rcs/messages/send/types/send_mms_response.rb +60 -0
  38. data/lib/rcs/messages/send/types/send_mms_schema_options.rb +108 -0
  39. data/lib/rcs/messages/send/types/send_rcs_response.rb +60 -0
  40. data/lib/rcs/messages/send/types/send_sms_response.rb +60 -0
  41. data/lib/rcs/messages/send/types/send_sms_schema_options.rb +81 -0
  42. data/lib/rcs/messages/types/message_reaction_schema_options.rb +71 -0
  43. data/lib/rcs/phone_numbers/campaign/client.rb +179 -0
  44. data/lib/rcs/phone_numbers/client.rb +345 -0
  45. data/lib/rcs/phone_numbers/types/phone_details_schema_level.rb +16 -0
  46. data/lib/rcs/phone_numbers/types/phone_details_schema_options.rb +93 -0
  47. data/lib/rcs/phone_numbers/types/phone_details_schema_options_enhanced_contact_info.rb +64 -0
  48. data/lib/rcs/phone_numbers/types/phone_numbers_get_response.rb +58 -0
  49. data/lib/rcs/phone_numbers/types/search_schema_location.rb +96 -0
  50. data/lib/rcs/phone_numbers/types/search_schema_number.rb +81 -0
  51. data/lib/rcs/phone_numbers/types/search_schema_options.rb +62 -0
  52. data/lib/rcs/phone_numbers/webhook/client.rb +191 -0
  53. data/lib/rcs/status/client.rb +30 -0
  54. data/lib/rcs/status/get/client.rb +367 -0
  55. data/lib/rcs/tools/client.rb +32 -199
  56. data/lib/rcs/tools/contact_card/client.rb +285 -0
  57. data/lib/rcs/tools/contact_card/types/get_v_card_schema_options.rb +67 -0
  58. data/lib/rcs/tools/file/client.rb +138 -0
  59. data/lib/rcs/tools/file/types/file_upload_schema_options.rb +70 -0
  60. data/lib/rcs/tools/file/types/file_upload_schema_options_download.rb +66 -0
  61. data/lib/rcs/tools/url/client.rb +245 -0
  62. data/lib/rcs/types/advanced_phone_information.rb +147 -0
  63. data/lib/rcs/types/advanced_phone_information_carrier.rb +90 -0
  64. data/lib/rcs/types/advanced_phone_information_contact.rb +146 -0
  65. data/lib/rcs/types/advanced_phone_information_location.rb +142 -0
  66. data/lib/rcs/types/advanced_phone_information_location_coordinates.rb +73 -0
  67. data/lib/rcs/types/advanced_phone_information_location_country.rb +77 -0
  68. data/lib/rcs/types/advanced_phone_information_type.rb +97 -0
  69. data/lib/rcs/types/advanced_phone_information_type_recommendation.rb +15 -0
  70. data/lib/rcs/types/agent.rb +68 -0
  71. data/lib/rcs/types/attach_webhook_params.rb +60 -0
  72. data/lib/rcs/types/attach_webhook_response_webhook.rb +86 -0
  73. data/lib/rcs/types/attach_webhook_schema_name.rb +88 -0
  74. data/lib/rcs/types/attach_webhook_schema_webhook_id.rb +77 -0
  75. data/lib/rcs/types/attached_phone_number_result.rb +75 -0
  76. data/lib/rcs/types/autofill_campaign_params.rb +69 -0
  77. data/lib/rcs/types/autofill_dlc_campaign_response.rb +169 -0
  78. data/lib/rcs/types/autofill_dlc_response_keywords.rb +95 -0
  79. data/lib/rcs/types/autofill_dlc_response_keywords_help.rb +70 -0
  80. data/lib/rcs/{send/types/send_sms_response.rb → types/autofill_dlc_response_keywords_opt_in.rb} +18 -17
  81. data/lib/rcs/types/autofill_dlc_response_keywords_opt_out.rb +70 -0
  82. data/lib/rcs/types/autofill_dlc_response_links.rb +70 -0
  83. data/lib/rcs/types/autofill_dlc_response_options.rb +106 -0
  84. data/lib/rcs/types/autofill_dlc_response_use_case.rb +72 -0
  85. data/lib/rcs/types/bad_request_error_body.rb +44 -45
  86. data/lib/rcs/types/basic_phone_information.rb +127 -0
  87. data/lib/rcs/{company/types/company_register_response_brand.rb → types/basic_phone_information_contact.rb} +12 -21
  88. data/lib/rcs/types/basic_phone_information_location.rb +74 -0
  89. data/lib/rcs/types/basic_phone_information_location_country.rb +75 -0
  90. data/lib/rcs/types/brand_status.rb +92 -0
  91. data/lib/rcs/types/brand_status_enum.rb +21 -0
  92. data/lib/rcs/types/buy_response_capabilities.rb +77 -0
  93. data/lib/rcs/types/campaign_enum.rb +15 -0
  94. data/lib/rcs/types/campaign_query.rb +69 -0
  95. data/lib/rcs/{company/types/company_register_request_company_id.rb → types/campaign_submission_result.rb} +15 -16
  96. data/lib/rcs/types/campaign_validation_response_errors_item.rb +76 -0
  97. data/lib/rcs/types/campaign_validation_result.rb +71 -0
  98. data/lib/rcs/types/click_action.rb +73 -0
  99. data/lib/rcs/types/click_action_data.rb +56 -0
  100. data/lib/rcs/types/click_action_data_metadata.rb +69 -0
  101. data/lib/rcs/types/company_sector_enum.rb +26 -0
  102. data/lib/rcs/types/company_type_enum.rb +14 -0
  103. data/lib/rcs/types/configured_webhook.rb +85 -0
  104. data/lib/rcs/types/contact.rb +105 -0
  105. data/lib/rcs/types/contact_id.rb +57 -0
  106. data/lib/rcs/types/conversation.rb +146 -0
  107. data/lib/rcs/types/conversation_contact.rb +68 -0
  108. data/lib/rcs/types/conversation_list.rb +79 -0
  109. data/lib/rcs/types/conversation_sender.rb +60 -0
  110. data/lib/rcs/types/create_url_options.rb +61 -0
  111. data/lib/rcs/types/detached_phone_number_result.rb +75 -0
  112. data/lib/rcs/types/detached_webhook_info.rb +74 -0
  113. data/lib/rcs/types/detailed_phone_number_enum.rb +25 -0
  114. data/lib/rcs/types/dlc_assignment_status_enum.rb +19 -0
  115. data/lib/rcs/types/dlc_campaign_status.rb +107 -0
  116. data/lib/rcs/types/dlc_campaign_use_case_enum.rb +35 -0
  117. data/lib/rcs/types/dlc_campaign_with_extended_brand_and_status.rb +194 -0
  118. data/lib/rcs/types/dlc_with_extended_brand_and_status_keywords.rb +94 -0
  119. data/lib/rcs/types/dlc_with_extended_brand_and_status_keywords_help.rb +72 -0
  120. data/lib/rcs/{send/types/send_mms_response.rb → types/dlc_with_extended_brand_and_status_keywords_opt_in.rb} +20 -17
  121. data/lib/rcs/{send/types/send_rcs_response.rb → types/dlc_with_extended_brand_and_status_keywords_opt_out.rb} +20 -17
  122. data/lib/rcs/types/dlc_with_extended_brand_and_status_links.rb +70 -0
  123. data/lib/rcs/types/dlc_with_extended_brand_and_status_options.rb +106 -0
  124. data/lib/rcs/types/dlc_with_extended_brand_and_status_use_case.rb +72 -0
  125. data/lib/rcs/types/enhanced_contact.rb +9 -0
  126. data/lib/rcs/types/enhanced_contact_item.rb +104 -0
  127. data/lib/rcs/types/error.rb +61 -0
  128. data/lib/rcs/types/extended_brand.rb +194 -0
  129. data/lib/rcs/types/extended_brand_with_vetting.rb +226 -0
  130. data/lib/rcs/types/extended_rcs_campaign.rb +173 -0
  131. data/lib/rcs/{company/types/company_register_request.rb → types/get_conversation_params.rb} +13 -12
  132. data/lib/rcs/types/get_conversation_request_id.rb +58 -0
  133. data/lib/rcs/types/get_conversation_request_recipient.rb +72 -0
  134. data/lib/rcs/types/get_dlc_campaign_status_response_updates.rb +96 -0
  135. data/lib/rcs/types/get_toll_free_campaign_status_response_updates.rb +92 -0
  136. data/lib/rcs/types/inbound_button.rb +56 -0
  137. data/lib/rcs/types/link_click_event.rb +465 -0
  138. data/lib/rcs/{company/types/company_update_response.rb → types/location_share_action.rb} +19 -19
  139. data/lib/rcs/types/location_share_action_data.rb +89 -0
  140. data/lib/rcs/types/message.rb +174 -0
  141. data/lib/rcs/types/message_content.rb +85 -0
  142. data/lib/rcs/types/message_method_enum.rb +12 -0
  143. data/lib/rcs/types/message_protocol_enum.rb +12 -0
  144. data/lib/rcs/types/message_schedule.rb +94 -0
  145. data/lib/rcs/types/message_status_enum.rb +16 -0
  146. data/lib/rcs/types/message_volume_enum.rb +20 -0
  147. data/lib/rcs/types/messaging_profile_enum.rb +11 -0
  148. data/lib/rcs/types/mms_content.rb +74 -0
  149. data/lib/rcs/types/mms_validation_response_segments.rb +85 -0
  150. data/lib/rcs/types/mms_validation_response_segments_value_item.rb +75 -0
  151. data/lib/rcs/types/mms_validation_result.rb +82 -0
  152. data/lib/rcs/types/nullable_contact.rb +84 -0
  153. data/lib/rcs/types/number_format.rb +79 -0
  154. data/lib/rcs/types/opt_in_method_enum.rb +13 -0
  155. data/lib/rcs/types/optional_brand_info.rb +145 -0
  156. data/lib/rcs/types/optional_contact.rb +83 -0
  157. data/lib/rcs/types/optional_contacts.rb +84 -0
  158. data/lib/rcs/types/phone.rb +101 -0
  159. data/lib/rcs/types/phone_capabilities.rb +75 -0
  160. data/lib/rcs/types/phone_enum.rb +13 -0
  161. data/lib/rcs/types/phone_feature_enum.rb +18 -0
  162. data/lib/rcs/types/phone_number_campaign_attach_failed_item.rb +67 -0
  163. data/lib/rcs/types/phone_number_campaign_attach_phone_numbers_item.rb +75 -0
  164. data/lib/rcs/types/phone_number_campaign_attach_phone_numbers_item_campaign.rb +78 -0
  165. data/lib/rcs/types/phone_number_campaign_detach_failed_item.rb +67 -0
  166. data/lib/rcs/types/phone_number_campaign_detach_phone_numbers_item.rb +75 -0
  167. data/lib/rcs/types/phone_number_campaign_detach_phone_numbers_item_campaign.rb +78 -0
  168. data/lib/rcs/types/phone_number_cost.rb +75 -0
  169. data/lib/rcs/types/phone_number_details.rb +110 -0
  170. data/lib/rcs/types/phone_number_enum.rb +18 -0
  171. data/lib/rcs/types/phone_number_region.rb +91 -0
  172. data/lib/rcs/types/phone_number_status.rb +90 -0
  173. data/lib/rcs/types/phone_number_status_enum.rb +16 -0
  174. data/lib/rcs/types/pinnacle_file_upload_metadata.rb +84 -0
  175. data/lib/rcs/types/pinnacle_url_config.rb +71 -0
  176. data/lib/rcs/types/profile_status_enum.rb +17 -0
  177. data/lib/rcs/types/purchased_number.rb +75 -0
  178. data/lib/rcs/types/rcs.rb +70 -0
  179. data/lib/rcs/types/rcs_base.rb +82 -0
  180. data/lib/rcs/types/rcs_base_options.rb +100 -0
  181. data/lib/rcs/types/rcs_button_call.rb +68 -0
  182. data/lib/rcs/types/rcs_button_content.rb +148 -0
  183. data/lib/rcs/types/rcs_button_open_url.rb +68 -0
  184. data/lib/rcs/types/rcs_button_request_user_location.rb +58 -0
  185. data/lib/rcs/types/rcs_button_schedule_event.rb +98 -0
  186. data/lib/rcs/types/rcs_button_send_location.rb +74 -0
  187. data/lib/rcs/types/rcs_button_send_location_lat_long.rb +68 -0
  188. data/lib/rcs/types/rcs_button_trigger.rb +78 -0
  189. data/lib/rcs/types/rcs_campaign.rb +143 -0
  190. data/lib/rcs/types/rcs_campaign_opt_in_method_enum.rb +15 -0
  191. data/lib/rcs/types/rcs_campaign_schema_agent.rb +134 -0
  192. data/lib/rcs/types/rcs_campaign_schema_agent_emails_item.rb +69 -0
  193. data/lib/rcs/types/rcs_campaign_schema_agent_phones_item.rb +69 -0
  194. data/lib/rcs/types/rcs_campaign_schema_agent_websites_item.rb +69 -0
  195. data/lib/rcs/types/rcs_campaign_schema_extra_agent.rb +134 -0
  196. data/lib/rcs/types/rcs_campaign_schema_extra_agent_emails_item.rb +70 -0
  197. data/lib/rcs/types/rcs_campaign_schema_extra_agent_phones_item.rb +70 -0
  198. data/lib/rcs/types/rcs_campaign_schema_extra_agent_websites_item.rb +71 -0
  199. data/lib/rcs/types/rcs_campaign_schema_extra_links.rb +70 -0
  200. data/lib/rcs/types/rcs_campaign_schema_extra_opt_in.rb +71 -0
  201. data/lib/rcs/types/rcs_campaign_schema_extra_opt_out.rb +70 -0
  202. data/lib/rcs/types/rcs_campaign_schema_extra_use_case.rb +71 -0
  203. data/lib/rcs/types/rcs_campaign_schema_links.rb +70 -0
  204. data/lib/rcs/types/rcs_campaign_schema_opt_in.rb +71 -0
  205. data/lib/rcs/types/rcs_campaign_schema_opt_out.rb +70 -0
  206. data/lib/rcs/types/rcs_campaign_schema_use_case.rb +71 -0
  207. data/lib/rcs/types/rcs_campaign_status.rb +86 -0
  208. data/lib/rcs/types/rcs_campaign_use_case_enum.rb +23 -0
  209. data/lib/rcs/types/rcs_card.rb +110 -0
  210. data/lib/rcs/types/rcs_cards.rb +79 -0
  211. data/lib/rcs/types/rcs_cards_cards_item.rb +88 -0
  212. data/lib/rcs/types/rcs_cards_content.rb +79 -0
  213. data/lib/rcs/types/rcs_cards_content_cards_item.rb +94 -0
  214. data/lib/rcs/types/rcs_content.rb +72 -0
  215. data/lib/rcs/types/rcs_media.rb +110 -0
  216. data/lib/rcs/types/rcs_media_content.rb +81 -0
  217. data/lib/rcs/types/rcs_media_details_content.rb +77 -0
  218. data/lib/rcs/types/rcs_text.rb +106 -0
  219. data/lib/rcs/types/rcs_text_content.rb +72 -0
  220. data/lib/rcs/types/rcs_validate_content.rb +70 -0
  221. data/lib/rcs/{company/types/company_register_response.rb → types/rcs_validate_content_media.rb} +19 -21
  222. data/lib/rcs/types/rcs_validation_result.rb +76 -0
  223. data/lib/rcs/types/reaction_result.rb +67 -0
  224. data/lib/rcs/types/scheduled_messaage.rb +73 -0
  225. data/lib/rcs/types/scheduled_send_response_config.rb +89 -0
  226. data/lib/rcs/types/send_sms_response_segments.rb +69 -0
  227. data/lib/rcs/types/send_sms_response_segments_encoding.rb +11 -0
  228. data/lib/rcs/types/sent_mms_details.rb +102 -0
  229. data/lib/rcs/types/sent_rcs_details.rb +105 -0
  230. data/lib/rcs/types/sent_sms_details.rb +108 -0
  231. data/lib/rcs/types/shortened_url.rb +77 -0
  232. data/lib/rcs/types/shortened_url_with_click_data.rb +90 -0
  233. data/lib/rcs/types/sms_content.rb +58 -0
  234. data/lib/rcs/types/sms_validation_response_segments.rb +80 -0
  235. data/lib/rcs/types/sms_validation_response_segments_gsm_7.rb +75 -0
  236. data/lib/rcs/types/sms_validation_response_segments_utf_16.rb +68 -0
  237. data/lib/rcs/types/sms_validation_response_total.rb +75 -0
  238. data/lib/rcs/types/sms_validation_result.rb +102 -0
  239. data/lib/rcs/types/sub_use_case_enum.rb +19 -0
  240. data/lib/rcs/types/submission_results.rb +57 -0
  241. data/lib/rcs/types/successful_conversation_update.rb +58 -0
  242. data/lib/rcs/types/toll_free_campaign.rb +118 -0
  243. data/lib/rcs/types/toll_free_campaign_schema_opt_in.rb +78 -0
  244. data/lib/rcs/types/toll_free_campaign_schema_use_case.rb +71 -0
  245. data/lib/rcs/types/toll_free_campaign_status.rb +91 -0
  246. data/lib/rcs/types/toll_free_campaign_use_case_enum.rb +52 -0
  247. data/lib/rcs/types/toll_free_campaign_with_extended_brand_and_status.rb +155 -0
  248. data/lib/rcs/types/toll_free_status_enum.rb +20 -0
  249. data/lib/rcs/types/tracking.rb +17 -0
  250. data/lib/rcs/types/updated_contact_id.rb +57 -0
  251. data/lib/rcs/types/upload_results.rb +80 -0
  252. data/lib/rcs/types/v_card_address_schema_type_item.rb +15 -0
  253. data/lib/rcs/types/v_card_data.rb +237 -0
  254. data/lib/rcs/types/v_card_data_file.rb +74 -0
  255. data/lib/rcs/types/v_card_data_file_metadata.rb +62 -0
  256. data/lib/rcs/types/v_card_email_schema_type_item.rb +21 -0
  257. data/lib/rcs/types/v_card_geo.rb +70 -0
  258. data/lib/rcs/types/v_card_name.rb +98 -0
  259. data/lib/rcs/types/v_card_organization.rb +70 -0
  260. data/lib/rcs/types/v_card_phone_schema_type_item.rb +21 -0
  261. data/lib/rcs/types/validate_campaign_params.rb +69 -0
  262. data/lib/rcs/types/validation_error_details.rb +76 -0
  263. data/lib/rcs/types/validation_results.rb +71 -0
  264. data/lib/rcs/types/vcard.rb +215 -0
  265. data/lib/rcs/types/vcard_address.rb +130 -0
  266. data/lib/rcs/types/vcard_content.rb +223 -0
  267. data/lib/rcs/types/vcard_email.rb +70 -0
  268. data/lib/rcs/types/vcard_phone.rb +70 -0
  269. data/lib/rcs/types/vcard_resource.rb +71 -0
  270. data/lib/rcs/types/vetting_feedback.rb +81 -0
  271. data/lib/rcs/types/vetting_history.rb +98 -0
  272. data/lib/rcs/types/vetting_history_vetting_status.rb +13 -0
  273. data/lib/rcs/types/vetting_results.rb +57 -0
  274. data/lib/rcs/types/webhook_event_enum.rb +13 -0
  275. data/lib/rcs/types/webhook_result.rb +64 -0
  276. data/lib/rcs/{company/types/company_update_response_brand.rb → types/webhooks.rb} +25 -17
  277. data/lib/rcs/types/zod_error.rb +73 -0
  278. data/lib/rcs/webhooks/client.rb +93 -0
  279. data/lib/rcs.rb +67 -83
  280. data/lib/requests.rb +4 -4
  281. data/lib/types_export.rb +252 -46
  282. metadata +278 -52
  283. data/lib/rcs/company/client.rb +0 -375
  284. data/lib/rcs/company/types/company_register_request_company.rb +0 -128
  285. data/lib/rcs/send/client.rb +0 -382
  286. data/lib/rcs/send/types/rcs_fallback.rb +0 -84
  287. data/lib/rcs/tools/types/tools_shorten_url_response.rb +0 -70
  288. data/lib/rcs/tools/types/tools_upload_url_response.rb +0 -69
  289. data/lib/rcs/types/action.rb +0 -154
  290. data/lib/rcs/types/action_lat_long.rb +0 -68
  291. data/lib/rcs/types/action_type.rb +0 -16
  292. data/lib/rcs/types/additional_email.rb +0 -65
  293. data/lib/rcs/types/additional_phone_number.rb +0 -65
  294. data/lib/rcs/types/additional_website.rb +0 -65
  295. data/lib/rcs/types/card.rb +0 -90
  296. data/lib/rcs/types/company.rb +0 -319
  297. data/lib/rcs/types/company_additional_emails_item.rb +0 -67
  298. data/lib/rcs/types/company_additional_phone_numbers_item.rb +0 -67
  299. data/lib/rcs/types/company_additional_websites_item.rb +0 -67
  300. data/lib/rcs/types/company_category.rb +0 -20
  301. data/lib/rcs/types/company_contact.rb +0 -117
  302. data/lib/rcs/types/company_details.rb +0 -120
  303. data/lib/rcs/types/forbidden_error_body.rb +0 -57
  304. data/lib/rcs/types/inbound_action_message.rb +0 -117
  305. data/lib/rcs/types/inbound_location_message.rb +0 -106
  306. data/lib/rcs/types/inbound_location_message_coordinates.rb +0 -65
  307. data/lib/rcs/types/inbound_media_message.rb +0 -112
  308. data/lib/rcs/types/inbound_message.rb +0 -88
  309. data/lib/rcs/types/inbound_message_message_type.rb +0 -10
  310. data/lib/rcs/types/inbound_message_metadata.rb +0 -79
  311. data/lib/rcs/types/inbound_text_message.rb +0 -100
  312. data/lib/rcs/types/internal_server_error_body.rb +0 -57
  313. data/lib/rcs/types/media_payload.rb +0 -65
  314. data/lib/rcs/types/message_metadata.rb +0 -56
  315. data/lib/rcs/types/messaging.rb +0 -95
  316. data/lib/rcs/types/optionals.rb +0 -99
  317. data/lib/rcs/types/payment_required_error_body.rb +0 -57
  318. data/lib/rcs/types/point_of_contact.rb +0 -72
  319. data/lib/rcs/types/rcs_functionalities.rb +0 -117
  320. data/lib/rcs/types/sender_metadata.rb +0 -74
  321. data/lib/rcs/types/unauthorized_error_body.rb +0 -57
@@ -0,0 +1,107 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "profile_status_enum"
4
+ require_relative "get_dlc_campaign_status_response_updates"
5
+ require "ostruct"
6
+ require "json"
7
+
8
+ module Pinnacle
9
+ module Types
10
+ # Response for get DLC campaign status.
11
+ class DlcCampaignStatus
12
+ # @return [String] Summary of errors related to the verification process. <br>
13
+ # These errors may request additional information or point out erroneous and/or
14
+ # missing fields.
15
+ attr_reader :error
16
+ # @return [Integer] Id of the DLC campaign.
17
+ attr_reader :id
18
+ # @return [Pinnacle::Types::ProfileStatusEnum] Current review status of the DLC campaign. <br>
19
+ # `INCOMPLETE`: Not submitted.<br>
20
+ # `IN REVIEW`: Being reviewed by carriers.<br>
21
+ # `VERIFIED`: Approved and ready to send messages.<br>
22
+ # `FAILED`: Issues and errors related to the campaign's details. See
23
+ # [error](dlc-campaign#response.body.error) for these potential issues.
24
+ attr_reader :status
25
+ # @return [Pinnacle::Types::GetDlcCampaignStatusResponseUpdates] Status of toll free numbers that are being attached to this campaign. <br>
26
+ # Note that phone numbers can only be attached to `VERIFIED` campaigns via the
27
+ # [attach campaign endpoint](../phone-numbers/attach-campaign).
28
+ attr_reader :updates
29
+ # @return [OpenStruct] Additional properties unmapped to the current class definition
30
+ attr_reader :additional_properties
31
+ # @return [Object]
32
+ attr_reader :_field_set
33
+ protected :_field_set
34
+
35
+ OMIT = Object.new
36
+
37
+ # @param error [String] Summary of errors related to the verification process. <br>
38
+ # These errors may request additional information or point out erroneous and/or
39
+ # missing fields.
40
+ # @param id [Integer] Id of the DLC campaign.
41
+ # @param status [Pinnacle::Types::ProfileStatusEnum] Current review status of the DLC campaign. <br>
42
+ # `INCOMPLETE`: Not submitted.<br>
43
+ # `IN REVIEW`: Being reviewed by carriers.<br>
44
+ # `VERIFIED`: Approved and ready to send messages.<br>
45
+ # `FAILED`: Issues and errors related to the campaign's details. See
46
+ # [error](dlc-campaign#response.body.error) for these potential issues.
47
+ # @param updates [Pinnacle::Types::GetDlcCampaignStatusResponseUpdates] Status of toll free numbers that are being attached to this campaign. <br>
48
+ # Note that phone numbers can only be attached to `VERIFIED` campaigns via the
49
+ # [attach campaign endpoint](../phone-numbers/attach-campaign).
50
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
51
+ # @return [Pinnacle::Types::DlcCampaignStatus]
52
+ def initialize(error:, id:, status:, updates:, additional_properties: nil)
53
+ @error = error
54
+ @id = id
55
+ @status = status
56
+ @updates = updates
57
+ @additional_properties = additional_properties
58
+ @_field_set = { "error": error, "id": id, "status": status, "updates": updates }
59
+ end
60
+
61
+ # Deserialize a JSON object to an instance of DlcCampaignStatus
62
+ #
63
+ # @param json_object [String]
64
+ # @return [Pinnacle::Types::DlcCampaignStatus]
65
+ def self.from_json(json_object:)
66
+ struct = JSON.parse(json_object, object_class: OpenStruct)
67
+ parsed_json = JSON.parse(json_object)
68
+ error = parsed_json["error"]
69
+ id = parsed_json["id"]
70
+ status = parsed_json["status"]
71
+ if parsed_json["updates"].nil?
72
+ updates = nil
73
+ else
74
+ updates = parsed_json["updates"].to_json
75
+ updates = Pinnacle::Types::GetDlcCampaignStatusResponseUpdates.from_json(json_object: updates)
76
+ end
77
+ new(
78
+ error: error,
79
+ id: id,
80
+ status: status,
81
+ updates: updates,
82
+ additional_properties: struct
83
+ )
84
+ end
85
+
86
+ # Serialize an instance of DlcCampaignStatus to a JSON object
87
+ #
88
+ # @return [String]
89
+ def to_json(*_args)
90
+ @_field_set&.to_json
91
+ end
92
+
93
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given
94
+ # hash and check each fields type against the current object's property
95
+ # definitions.
96
+ #
97
+ # @param obj [Object]
98
+ # @return [Void]
99
+ def self.validate_raw(obj:)
100
+ obj.error.is_a?(String) != false || raise("Passed value for field obj.error is not the expected type, validation failed.")
101
+ obj.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
102
+ obj.status.is_a?(Pinnacle::Types::ProfileStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
103
+ Pinnacle::Types::GetDlcCampaignStatusResponseUpdates.validate_raw(obj: obj.updates)
104
+ end
105
+ end
106
+ end
107
+ end
@@ -0,0 +1,35 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Pinnacle
4
+ module Types
5
+ # The primary use case classification for this campaign.
6
+ class DlcCampaignUseCaseEnum
7
+ ACCOUNT_NOTIFICATION = "ACCOUNT_NOTIFICATION"
8
+ AGENTS_FRANCHISES = "AGENTS_FRANCHISES"
9
+ CARRIER_EXEMPT = "CARRIER_EXEMPT"
10
+ CHARITY = "CHARITY"
11
+ CUSTOMER_CARE = "CUSTOMER_CARE"
12
+ DELIVERY_NOTIFICATION = "DELIVERY_NOTIFICATION"
13
+ EMERGENCY = "EMERGENCY"
14
+ FRAUD_ALERT = "FRAUD_ALERT"
15
+ HIGHER_EDUCATION = "HIGHER_EDUCATION"
16
+ K_12_EDUCATION = "K12_EDUCATION"
17
+ LOW_VOLUME = "LOW_VOLUME"
18
+ M_2_M = "M2M"
19
+ MARKETING = "MARKETING"
20
+ MIXED = "MIXED"
21
+ POLITICAL = "POLITICAL"
22
+ POLLING_VOTING = "POLLING_VOTING"
23
+ PROXY = "PROXY"
24
+ PUBLIC_SERVICE_ANNOUNCEMENT = "PUBLIC_SERVICE_ANNOUNCEMENT"
25
+ SECURITY_ALERT = "SECURITY_ALERT"
26
+ SOCIAL = "SOCIAL"
27
+ SOLE_PROPRIETOR = "SOLE_PROPRIETOR"
28
+ SWEEPSTAKE = "SWEEPSTAKE"
29
+ TRIAL = "TRIAL"
30
+ TWO_FA = "TWO_FA"
31
+ UCAAS_HIGH = "UCAAS_HIGH"
32
+ UCAAS_LOW = "UCAAS_LOW"
33
+ end
34
+ end
35
+ end
@@ -0,0 +1,194 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "extended_brand"
4
+ require_relative "dlc_with_extended_brand_and_status_keywords"
5
+ require_relative "dlc_with_extended_brand_and_status_links"
6
+ require_relative "dlc_with_extended_brand_and_status_options"
7
+ require_relative "profile_status_enum"
8
+ require_relative "dlc_with_extended_brand_and_status_use_case"
9
+ require "ostruct"
10
+ require "json"
11
+
12
+ module Pinnacle
13
+ module Types
14
+ # Dlc campaign schema that includes extended brand and status.
15
+ class DlcCampaignWithExtendedBrandAndStatus
16
+ # @return [Boolean] Whether the campaign renews automatically.
17
+ attr_reader :auto_renew
18
+ # @return [Pinnacle::Types::ExtendedBrand] Brand associated with this campaign.
19
+ attr_reader :brand
20
+ # @return [Integer] Unique identifier for the campaign.
21
+ attr_reader :campaign_id
22
+ # @return [String] Description of the campaign.
23
+ attr_reader :description
24
+ # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywords] Keyword response configuration.
25
+ attr_reader :keywords
26
+ # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusLinks] Legal documentation links.
27
+ attr_reader :links
28
+ # @return [String] Describe the flow of how users will opt in to this campaign.
29
+ attr_reader :message_flow
30
+ # @return [String] Display name of the campaign.
31
+ attr_reader :name
32
+ # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusOptions] Campaign configuration options.
33
+ attr_reader :options
34
+ # @return [Array<String>] Example messages for the campaign.
35
+ attr_reader :sample_messages
36
+ # @return [Pinnacle::Types::ProfileStatusEnum] Current review status of the campaign.<br>
37
+ # `INCOMPLETE`: Not submitted.<br>
38
+ # `IN REVIEW`: Being reviewed by carriers.<br>
39
+ # `VERIFIED`: Approved and ready to send messages.<br>
40
+ # `FAILED`: Issues and errors related to the campaign's details.<br>
41
+ attr_reader :status
42
+ # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusUseCase] Use case for the campaign.
43
+ attr_reader :use_case
44
+ # @return [OpenStruct] Additional properties unmapped to the current class definition
45
+ attr_reader :additional_properties
46
+ # @return [Object]
47
+ attr_reader :_field_set
48
+ protected :_field_set
49
+
50
+ OMIT = Object.new
51
+
52
+ # @param auto_renew [Boolean] Whether the campaign renews automatically.
53
+ # @param brand [Pinnacle::Types::ExtendedBrand] Brand associated with this campaign.
54
+ # @param campaign_id [Integer] Unique identifier for the campaign.
55
+ # @param description [String] Description of the campaign.
56
+ # @param keywords [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywords] Keyword response configuration.
57
+ # @param links [Pinnacle::Types::DlcWithExtendedBrandAndStatusLinks] Legal documentation links.
58
+ # @param message_flow [String] Describe the flow of how users will opt in to this campaign.
59
+ # @param name [String] Display name of the campaign.
60
+ # @param options [Pinnacle::Types::DlcWithExtendedBrandAndStatusOptions] Campaign configuration options.
61
+ # @param sample_messages [Array<String>] Example messages for the campaign.
62
+ # @param status [Pinnacle::Types::ProfileStatusEnum] Current review status of the campaign.<br>
63
+ # `INCOMPLETE`: Not submitted.<br>
64
+ # `IN REVIEW`: Being reviewed by carriers.<br>
65
+ # `VERIFIED`: Approved and ready to send messages.<br>
66
+ # `FAILED`: Issues and errors related to the campaign's details.<br>
67
+ # @param use_case [Pinnacle::Types::DlcWithExtendedBrandAndStatusUseCase] Use case for the campaign.
68
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
69
+ # @return [Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus]
70
+ def initialize(auto_renew:, brand:, status:, campaign_id: OMIT, description: OMIT, keywords: OMIT, links: OMIT,
71
+ message_flow: OMIT, name: OMIT, options: OMIT, sample_messages: OMIT, use_case: OMIT, additional_properties: nil)
72
+ @auto_renew = auto_renew
73
+ @brand = brand
74
+ @campaign_id = campaign_id if campaign_id != OMIT
75
+ @description = description if description != OMIT
76
+ @keywords = keywords if keywords != OMIT
77
+ @links = links if links != OMIT
78
+ @message_flow = message_flow if message_flow != OMIT
79
+ @name = name if name != OMIT
80
+ @options = options if options != OMIT
81
+ @sample_messages = sample_messages if sample_messages != OMIT
82
+ @status = status
83
+ @use_case = use_case if use_case != OMIT
84
+ @additional_properties = additional_properties
85
+ @_field_set = {
86
+ "autoRenew": auto_renew,
87
+ "brand": brand,
88
+ "campaignId": campaign_id,
89
+ "description": description,
90
+ "keywords": keywords,
91
+ "links": links,
92
+ "messageFlow": message_flow,
93
+ "name": name,
94
+ "options": options,
95
+ "sampleMessages": sample_messages,
96
+ "status": status,
97
+ "useCase": use_case
98
+ }.reject do |_k, v|
99
+ v == OMIT
100
+ end
101
+ end
102
+
103
+ # Deserialize a JSON object to an instance of
104
+ # DlcCampaignWithExtendedBrandAndStatus
105
+ #
106
+ # @param json_object [String]
107
+ # @return [Pinnacle::Types::DlcCampaignWithExtendedBrandAndStatus]
108
+ def self.from_json(json_object:)
109
+ struct = JSON.parse(json_object, object_class: OpenStruct)
110
+ parsed_json = JSON.parse(json_object)
111
+ auto_renew = parsed_json["autoRenew"]
112
+ if parsed_json["brand"].nil?
113
+ brand = nil
114
+ else
115
+ brand = parsed_json["brand"].to_json
116
+ brand = Pinnacle::Types::ExtendedBrand.from_json(json_object: brand)
117
+ end
118
+ campaign_id = parsed_json["campaignId"]
119
+ description = parsed_json["description"]
120
+ if parsed_json["keywords"].nil?
121
+ keywords = nil
122
+ else
123
+ keywords = parsed_json["keywords"].to_json
124
+ keywords = Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywords.from_json(json_object: keywords)
125
+ end
126
+ if parsed_json["links"].nil?
127
+ links = nil
128
+ else
129
+ links = parsed_json["links"].to_json
130
+ links = Pinnacle::Types::DlcWithExtendedBrandAndStatusLinks.from_json(json_object: links)
131
+ end
132
+ message_flow = parsed_json["messageFlow"]
133
+ name = parsed_json["name"]
134
+ if parsed_json["options"].nil?
135
+ options = nil
136
+ else
137
+ options = parsed_json["options"].to_json
138
+ options = Pinnacle::Types::DlcWithExtendedBrandAndStatusOptions.from_json(json_object: options)
139
+ end
140
+ sample_messages = parsed_json["sampleMessages"]
141
+ status = parsed_json["status"]
142
+ if parsed_json["useCase"].nil?
143
+ use_case = nil
144
+ else
145
+ use_case = parsed_json["useCase"].to_json
146
+ use_case = Pinnacle::Types::DlcWithExtendedBrandAndStatusUseCase.from_json(json_object: use_case)
147
+ end
148
+ new(
149
+ auto_renew: auto_renew,
150
+ brand: brand,
151
+ campaign_id: campaign_id,
152
+ description: description,
153
+ keywords: keywords,
154
+ links: links,
155
+ message_flow: message_flow,
156
+ name: name,
157
+ options: options,
158
+ sample_messages: sample_messages,
159
+ status: status,
160
+ use_case: use_case,
161
+ additional_properties: struct
162
+ )
163
+ end
164
+
165
+ # Serialize an instance of DlcCampaignWithExtendedBrandAndStatus to a JSON object
166
+ #
167
+ # @return [String]
168
+ def to_json(*_args)
169
+ @_field_set&.to_json
170
+ end
171
+
172
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given
173
+ # hash and check each fields type against the current object's property
174
+ # definitions.
175
+ #
176
+ # @param obj [Object]
177
+ # @return [Void]
178
+ def self.validate_raw(obj:)
179
+ obj.auto_renew.is_a?(Boolean) != false || raise("Passed value for field obj.auto_renew is not the expected type, validation failed.")
180
+ Pinnacle::Types::ExtendedBrand.validate_raw(obj: obj.brand)
181
+ obj.campaign_id&.is_a?(Integer) != false || raise("Passed value for field obj.campaign_id is not the expected type, validation failed.")
182
+ obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
183
+ obj.keywords.nil? || Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywords.validate_raw(obj: obj.keywords)
184
+ obj.links.nil? || Pinnacle::Types::DlcWithExtendedBrandAndStatusLinks.validate_raw(obj: obj.links)
185
+ obj.message_flow&.is_a?(String) != false || raise("Passed value for field obj.message_flow is not the expected type, validation failed.")
186
+ obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
187
+ obj.options.nil? || Pinnacle::Types::DlcWithExtendedBrandAndStatusOptions.validate_raw(obj: obj.options)
188
+ obj.sample_messages&.is_a?(Array) != false || raise("Passed value for field obj.sample_messages is not the expected type, validation failed.")
189
+ obj.status.is_a?(Pinnacle::Types::ProfileStatusEnum) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
190
+ obj.use_case.nil? || Pinnacle::Types::DlcWithExtendedBrandAndStatusUseCase.validate_raw(obj: obj.use_case)
191
+ end
192
+ end
193
+ end
194
+ end
@@ -0,0 +1,94 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "dlc_with_extended_brand_and_status_keywords_help"
4
+ require_relative "dlc_with_extended_brand_and_status_keywords_opt_in"
5
+ require_relative "dlc_with_extended_brand_and_status_keywords_opt_out"
6
+ require "ostruct"
7
+ require "json"
8
+
9
+ module Pinnacle
10
+ module Types
11
+ # Keyword response configuration.
12
+ class DlcWithExtendedBrandAndStatusKeywords
13
+ # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsHelp] Help keyword settings.
14
+ attr_reader :help
15
+ # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsOptIn] Opt-in keyword settings.
16
+ attr_reader :opt_in
17
+ # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsOptOut] Opt-out keyword settings.
18
+ attr_reader :opt_out
19
+ # @return [OpenStruct] Additional properties unmapped to the current class definition
20
+ attr_reader :additional_properties
21
+ # @return [Object]
22
+ attr_reader :_field_set
23
+ protected :_field_set
24
+
25
+ OMIT = Object.new
26
+
27
+ # @param help [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsHelp] Help keyword settings.
28
+ # @param opt_in [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsOptIn] Opt-in keyword settings.
29
+ # @param opt_out [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsOptOut] Opt-out keyword settings.
30
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
31
+ # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywords]
32
+ def initialize(help:, opt_in:, opt_out:, additional_properties: nil)
33
+ @help = help
34
+ @opt_in = opt_in
35
+ @opt_out = opt_out
36
+ @additional_properties = additional_properties
37
+ @_field_set = { "HELP": help, "OPT_IN": opt_in, "OPT_OUT": opt_out }
38
+ end
39
+
40
+ # Deserialize a JSON object to an instance of
41
+ # DlcWithExtendedBrandAndStatusKeywords
42
+ #
43
+ # @param json_object [String]
44
+ # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywords]
45
+ def self.from_json(json_object:)
46
+ struct = JSON.parse(json_object, object_class: OpenStruct)
47
+ parsed_json = JSON.parse(json_object)
48
+ if parsed_json["HELP"].nil?
49
+ help = nil
50
+ else
51
+ help = parsed_json["HELP"].to_json
52
+ help = Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsHelp.from_json(json_object: help)
53
+ end
54
+ if parsed_json["OPT_IN"].nil?
55
+ opt_in = nil
56
+ else
57
+ opt_in = parsed_json["OPT_IN"].to_json
58
+ opt_in = Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsOptIn.from_json(json_object: opt_in)
59
+ end
60
+ if parsed_json["OPT_OUT"].nil?
61
+ opt_out = nil
62
+ else
63
+ opt_out = parsed_json["OPT_OUT"].to_json
64
+ opt_out = Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsOptOut.from_json(json_object: opt_out)
65
+ end
66
+ new(
67
+ help: help,
68
+ opt_in: opt_in,
69
+ opt_out: opt_out,
70
+ additional_properties: struct
71
+ )
72
+ end
73
+
74
+ # Serialize an instance of DlcWithExtendedBrandAndStatusKeywords to a JSON object
75
+ #
76
+ # @return [String]
77
+ def to_json(*_args)
78
+ @_field_set&.to_json
79
+ end
80
+
81
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given
82
+ # hash and check each fields type against the current object's property
83
+ # definitions.
84
+ #
85
+ # @param obj [Object]
86
+ # @return [Void]
87
+ def self.validate_raw(obj:)
88
+ Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsHelp.validate_raw(obj: obj.help)
89
+ Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsOptIn.validate_raw(obj: obj.opt_in)
90
+ Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsOptOut.validate_raw(obj: obj.opt_out)
91
+ end
92
+ end
93
+ end
94
+ end
@@ -0,0 +1,72 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "ostruct"
4
+ require "json"
5
+
6
+ module Pinnacle
7
+ module Types
8
+ # Help keyword settings.
9
+ class DlcWithExtendedBrandAndStatusKeywordsHelp
10
+ # @return [String] Response message for help keywords.
11
+ attr_reader :message
12
+ # @return [Array<String>] Keywords that trigger help response.
13
+ attr_reader :values
14
+ # @return [OpenStruct] Additional properties unmapped to the current class definition
15
+ attr_reader :additional_properties
16
+ # @return [Object]
17
+ attr_reader :_field_set
18
+ protected :_field_set
19
+
20
+ OMIT = Object.new
21
+
22
+ # @param message [String] Response message for help keywords.
23
+ # @param values [Array<String>] Keywords that trigger help response.
24
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
25
+ # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsHelp]
26
+ def initialize(message: OMIT, values: OMIT, additional_properties: nil)
27
+ @message = message if message != OMIT
28
+ @values = values if values != OMIT
29
+ @additional_properties = additional_properties
30
+ @_field_set = { "message": message, "values": values }.reject do |_k, v|
31
+ v == OMIT
32
+ end
33
+ end
34
+
35
+ # Deserialize a JSON object to an instance of
36
+ # DlcWithExtendedBrandAndStatusKeywordsHelp
37
+ #
38
+ # @param json_object [String]
39
+ # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsHelp]
40
+ def self.from_json(json_object:)
41
+ struct = JSON.parse(json_object, object_class: OpenStruct)
42
+ parsed_json = JSON.parse(json_object)
43
+ message = parsed_json["message"]
44
+ values = parsed_json["values"]
45
+ new(
46
+ message: message,
47
+ values: values,
48
+ additional_properties: struct
49
+ )
50
+ end
51
+
52
+ # Serialize an instance of DlcWithExtendedBrandAndStatusKeywordsHelp to a JSON
53
+ # object
54
+ #
55
+ # @return [String]
56
+ def to_json(*_args)
57
+ @_field_set&.to_json
58
+ end
59
+
60
+ # Leveraged for Union-type generation, validate_raw attempts to parse the given
61
+ # hash and check each fields type against the current object's property
62
+ # definitions.
63
+ #
64
+ # @param obj [Object]
65
+ # @return [Void]
66
+ def self.validate_raw(obj:)
67
+ obj.message&.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
68
+ obj.values&.is_a?(Array) != false || raise("Passed value for field obj.values is not the expected type, validation failed.")
69
+ end
70
+ end
71
+ end
72
+ end
@@ -4,12 +4,13 @@ require "ostruct"
4
4
  require "json"
5
5
 
6
6
  module Pinnacle
7
- class Send
8
- class SendMmsResponse
9
- # @return [String] The unique ID of the sent message.
10
- attr_reader :message_id
11
- # @return [String] A message indicating the status of the sent message.
7
+ module Types
8
+ # Opt-in keyword settings.
9
+ class DlcWithExtendedBrandAndStatusKeywordsOptIn
10
+ # @return [String] Response message for opt-in keywords.
12
11
  attr_reader :message
12
+ # @return [Array<String>] Keywords that trigger opt-in.
13
+ attr_reader :values
13
14
  # @return [OpenStruct] Additional properties unmapped to the current class definition
14
15
  attr_reader :additional_properties
15
16
  # @return [Object]
@@ -18,34 +19,36 @@ module Pinnacle
18
19
 
19
20
  OMIT = Object.new
20
21
 
21
- # @param message_id [String] The unique ID of the sent message.
22
- # @param message [String] A message indicating the status of the sent message.
22
+ # @param message [String] Response message for opt-in keywords.
23
+ # @param values [Array<String>] Keywords that trigger opt-in.
23
24
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
24
- # @return [Pinnacle::Send::SendMmsResponse]
25
- def initialize(message_id:, message:, additional_properties: nil)
26
- @message_id = message_id
25
+ # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsOptIn]
26
+ def initialize(message:, values:, additional_properties: nil)
27
27
  @message = message
28
+ @values = values
28
29
  @additional_properties = additional_properties
29
- @_field_set = { "messageId": message_id, "message": message }
30
+ @_field_set = { "message": message, "values": values }
30
31
  end
31
32
 
32
- # Deserialize a JSON object to an instance of SendMmsResponse
33
+ # Deserialize a JSON object to an instance of
34
+ # DlcWithExtendedBrandAndStatusKeywordsOptIn
33
35
  #
34
36
  # @param json_object [String]
35
- # @return [Pinnacle::Send::SendMmsResponse]
37
+ # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsOptIn]
36
38
  def self.from_json(json_object:)
37
39
  struct = JSON.parse(json_object, object_class: OpenStruct)
38
40
  parsed_json = JSON.parse(json_object)
39
- message_id = parsed_json["messageId"]
40
41
  message = parsed_json["message"]
42
+ values = parsed_json["values"]
41
43
  new(
42
- message_id: message_id,
43
44
  message: message,
45
+ values: values,
44
46
  additional_properties: struct
45
47
  )
46
48
  end
47
49
 
48
- # Serialize an instance of SendMmsResponse to a JSON object
50
+ # Serialize an instance of DlcWithExtendedBrandAndStatusKeywordsOptIn to a JSON
51
+ # object
49
52
  #
50
53
  # @return [String]
51
54
  def to_json(*_args)
@@ -59,8 +62,8 @@ module Pinnacle
59
62
  # @param obj [Object]
60
63
  # @return [Void]
61
64
  def self.validate_raw(obj:)
62
- obj.message_id.is_a?(String) != false || raise("Passed value for field obj.message_id is not the expected type, validation failed.")
63
65
  obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
66
+ obj.values.is_a?(Array) != false || raise("Passed value for field obj.values is not the expected type, validation failed.")
64
67
  end
65
68
  end
66
69
  end
@@ -4,12 +4,13 @@ require "ostruct"
4
4
  require "json"
5
5
 
6
6
  module Pinnacle
7
- class Send
8
- class SendRcsResponse
9
- # @return [String] The unique ID of the sent message.
10
- attr_reader :message_id
11
- # @return [String] A message indicating the status of the sent message.
7
+ module Types
8
+ # Opt-out keyword settings.
9
+ class DlcWithExtendedBrandAndStatusKeywordsOptOut
10
+ # @return [String] Response message for opt-out keywords.
12
11
  attr_reader :message
12
+ # @return [Array<String>] Keywords that trigger opt-out.
13
+ attr_reader :values
13
14
  # @return [OpenStruct] Additional properties unmapped to the current class definition
14
15
  attr_reader :additional_properties
15
16
  # @return [Object]
@@ -18,34 +19,36 @@ module Pinnacle
18
19
 
19
20
  OMIT = Object.new
20
21
 
21
- # @param message_id [String] The unique ID of the sent message.
22
- # @param message [String] A message indicating the status of the sent message.
22
+ # @param message [String] Response message for opt-out keywords.
23
+ # @param values [Array<String>] Keywords that trigger opt-out.
23
24
  # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
24
- # @return [Pinnacle::Send::SendRcsResponse]
25
- def initialize(message_id:, message:, additional_properties: nil)
26
- @message_id = message_id
25
+ # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsOptOut]
26
+ def initialize(message:, values:, additional_properties: nil)
27
27
  @message = message
28
+ @values = values
28
29
  @additional_properties = additional_properties
29
- @_field_set = { "messageId": message_id, "message": message }
30
+ @_field_set = { "message": message, "values": values }
30
31
  end
31
32
 
32
- # Deserialize a JSON object to an instance of SendRcsResponse
33
+ # Deserialize a JSON object to an instance of
34
+ # DlcWithExtendedBrandAndStatusKeywordsOptOut
33
35
  #
34
36
  # @param json_object [String]
35
- # @return [Pinnacle::Send::SendRcsResponse]
37
+ # @return [Pinnacle::Types::DlcWithExtendedBrandAndStatusKeywordsOptOut]
36
38
  def self.from_json(json_object:)
37
39
  struct = JSON.parse(json_object, object_class: OpenStruct)
38
40
  parsed_json = JSON.parse(json_object)
39
- message_id = parsed_json["messageId"]
40
41
  message = parsed_json["message"]
42
+ values = parsed_json["values"]
41
43
  new(
42
- message_id: message_id,
43
44
  message: message,
45
+ values: values,
44
46
  additional_properties: struct
45
47
  )
46
48
  end
47
49
 
48
- # Serialize an instance of SendRcsResponse to a JSON object
50
+ # Serialize an instance of DlcWithExtendedBrandAndStatusKeywordsOptOut to a JSON
51
+ # object
49
52
  #
50
53
  # @return [String]
51
54
  def to_json(*_args)
@@ -59,8 +62,8 @@ module Pinnacle
59
62
  # @param obj [Object]
60
63
  # @return [Void]
61
64
  def self.validate_raw(obj:)
62
- obj.message_id.is_a?(String) != false || raise("Passed value for field obj.message_id is not the expected type, validation failed.")
63
65
  obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
66
+ obj.values.is_a?(Array) != false || raise("Passed value for field obj.values is not the expected type, validation failed.")
64
67
  end
65
68
  end
66
69
  end