mailhub-sdk 0.1.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 (151) hide show
  1. checksums.yaml +7 -0
  2. data/.fern/metadata.json +11 -0
  3. data/.fernignore +3 -0
  4. data/.rubocop.yml +103 -0
  5. data/CONTRIBUTING.md +120 -0
  6. data/README.md +159 -0
  7. data/Rakefile +20 -0
  8. data/custom.gemspec.rb +18 -0
  9. data/lib/Mailhub/campaign/client.rb +730 -0
  10. data/lib/Mailhub/campaign/types/add_campaign_media_by_code_request.rb +13 -0
  11. data/lib/Mailhub/campaign/types/cancel_campaign_request.rb +11 -0
  12. data/lib/Mailhub/campaign/types/catch_up_campaign_request.rb +11 -0
  13. data/lib/Mailhub/campaign/types/create_campaign_by_code_request.rb +27 -0
  14. data/lib/Mailhub/campaign/types/delete_campaign_request.rb +11 -0
  15. data/lib/Mailhub/campaign/types/get_campaign_activity_request.rb +11 -0
  16. data/lib/Mailhub/campaign/types/get_campaign_analytics_request.rb +11 -0
  17. data/lib/Mailhub/campaign/types/get_campaign_link_stats_request.rb +11 -0
  18. data/lib/Mailhub/campaign/types/get_campaign_media_request.rb +11 -0
  19. data/lib/Mailhub/campaign/types/get_campaign_rendered_preview_by_code_request.rb +21 -0
  20. data/lib/Mailhub/campaign/types/get_campaign_request.rb +11 -0
  21. data/lib/Mailhub/campaign/types/get_campaigns_request.rb +19 -0
  22. data/lib/Mailhub/campaign/types/pause_campaign_request.rb +11 -0
  23. data/lib/Mailhub/campaign/types/preview_campaign_request.rb +11 -0
  24. data/lib/Mailhub/campaign/types/remove_campaign_media_request.rb +13 -0
  25. data/lib/Mailhub/campaign/types/schedule_campaign_request.rb +11 -0
  26. data/lib/Mailhub/campaign/types/send_campaign_request.rb +11 -0
  27. data/lib/Mailhub/campaign/types/test_campaign_by_code_request.rb +23 -0
  28. data/lib/Mailhub/campaign/types/update_campaign_by_code_request.rb +29 -0
  29. data/lib/Mailhub/client.rb +55 -0
  30. data/lib/Mailhub/contact/client.rb +385 -0
  31. data/lib/Mailhub/contact/types/block_contact_request.rb +11 -0
  32. data/lib/Mailhub/contact/types/block_contacts_by_guid_request.rb +11 -0
  33. data/lib/Mailhub/contact/types/create_contact_request.rb +15 -0
  34. data/lib/Mailhub/contact/types/delete_contact_request.rb +11 -0
  35. data/lib/Mailhub/contact/types/delete_contacts_by_guid_request.rb +11 -0
  36. data/lib/Mailhub/contact/types/get_contact_request.rb +11 -0
  37. data/lib/Mailhub/contact/types/get_contacts_request.rb +21 -0
  38. data/lib/Mailhub/contact/types/get_import_job_request.rb +11 -0
  39. data/lib/Mailhub/contact/types/import_contacts_request.rb +9 -0
  40. data/lib/Mailhub/contact/types/update_contact_request.rb +17 -0
  41. data/lib/Mailhub/custom_field/client.rb +188 -0
  42. data/lib/Mailhub/custom_field/types/create_custom_field_request.rb +15 -0
  43. data/lib/Mailhub/custom_field/types/delete_custom_field_request.rb +11 -0
  44. data/lib/Mailhub/custom_field/types/get_custom_field_request.rb +11 -0
  45. data/lib/Mailhub/custom_field/types/update_custom_field_request.rb +15 -0
  46. data/lib/Mailhub/errors/api_error.rb +8 -0
  47. data/lib/Mailhub/errors/client_error.rb +17 -0
  48. data/lib/Mailhub/errors/redirect_error.rb +8 -0
  49. data/lib/Mailhub/errors/response_error.rb +42 -0
  50. data/lib/Mailhub/errors/server_error.rb +11 -0
  51. data/lib/Mailhub/errors/timeout_error.rb +8 -0
  52. data/lib/Mailhub/internal/errors/constraint_error.rb +10 -0
  53. data/lib/Mailhub/internal/errors/type_error.rb +10 -0
  54. data/lib/Mailhub/internal/http/base_request.rb +51 -0
  55. data/lib/Mailhub/internal/http/raw_client.rb +248 -0
  56. data/lib/Mailhub/internal/iterators/cursor_item_iterator.rb +28 -0
  57. data/lib/Mailhub/internal/iterators/cursor_page_iterator.rb +63 -0
  58. data/lib/Mailhub/internal/iterators/item_iterator.rb +65 -0
  59. data/lib/Mailhub/internal/iterators/offset_item_iterator.rb +30 -0
  60. data/lib/Mailhub/internal/iterators/offset_page_iterator.rb +103 -0
  61. data/lib/Mailhub/internal/json/request.rb +41 -0
  62. data/lib/Mailhub/internal/json/serializable.rb +25 -0
  63. data/lib/Mailhub/internal/multipart/multipart_encoder.rb +141 -0
  64. data/lib/Mailhub/internal/multipart/multipart_form_data.rb +78 -0
  65. data/lib/Mailhub/internal/multipart/multipart_form_data_part.rb +51 -0
  66. data/lib/Mailhub/internal/multipart/multipart_request.rb +40 -0
  67. data/lib/Mailhub/internal/types/array.rb +47 -0
  68. data/lib/Mailhub/internal/types/boolean.rb +34 -0
  69. data/lib/Mailhub/internal/types/enum.rb +56 -0
  70. data/lib/Mailhub/internal/types/hash.rb +36 -0
  71. data/lib/Mailhub/internal/types/model/field.rb +38 -0
  72. data/lib/Mailhub/internal/types/model.rb +208 -0
  73. data/lib/Mailhub/internal/types/type.rb +35 -0
  74. data/lib/Mailhub/internal/types/union.rb +161 -0
  75. data/lib/Mailhub/internal/types/unknown.rb +15 -0
  76. data/lib/Mailhub/internal/types/utils.rb +116 -0
  77. data/lib/Mailhub/media/client.rb +241 -0
  78. data/lib/Mailhub/media/types/delete_media_request.rb +11 -0
  79. data/lib/Mailhub/media/types/download_media_request.rb +11 -0
  80. data/lib/Mailhub/media/types/get_media_request.rb +11 -0
  81. data/lib/Mailhub/media/types/get_medias_request.rb +19 -0
  82. data/lib/Mailhub/media/types/update_media_request.rb +13 -0
  83. data/lib/Mailhub/media/types/upload_media_request.rb +9 -0
  84. data/lib/Mailhub/message/client.rb +201 -0
  85. data/lib/Mailhub/message/types/cancel_message_request.rb +11 -0
  86. data/lib/Mailhub/message/types/get_message_events_request.rb +11 -0
  87. data/lib/Mailhub/message/types/get_message_request.rb +11 -0
  88. data/lib/Mailhub/message/types/get_messages_request.rb +21 -0
  89. data/lib/Mailhub/message/types/send_message_request.rb +23 -0
  90. data/lib/Mailhub/segment/client.rb +377 -0
  91. data/lib/Mailhub/segment/types/create_segment_request.rb +13 -0
  92. data/lib/Mailhub/segment/types/delete_segment_request.rb +11 -0
  93. data/lib/Mailhub/segment/types/delete_segments_by_code_request.rb +13 -0
  94. data/lib/Mailhub/segment/types/get_segment_contacts_request.rb +15 -0
  95. data/lib/Mailhub/segment/types/get_segment_preview_request.rb +11 -0
  96. data/lib/Mailhub/segment/types/get_segment_request.rb +11 -0
  97. data/lib/Mailhub/segment/types/get_segments_request.rb +19 -0
  98. data/lib/Mailhub/segment/types/get_segments_union_preview_by_code_request.rb +11 -0
  99. data/lib/Mailhub/segment/types/sync_segment_request.rb +11 -0
  100. data/lib/Mailhub/segment/types/update_segment_request.rb +15 -0
  101. data/lib/Mailhub/template/client.rb +301 -0
  102. data/lib/Mailhub/template/types/create_template_request.rb +13 -0
  103. data/lib/Mailhub/template/types/delete_template_request.rb +11 -0
  104. data/lib/Mailhub/template/types/get_template_rendered_preview_request.rb +11 -0
  105. data/lib/Mailhub/template/types/get_template_request.rb +11 -0
  106. data/lib/Mailhub/template/types/get_templates_request.rb +19 -0
  107. data/lib/Mailhub/template/types/preview_template_request.rb +11 -0
  108. data/lib/Mailhub/template/types/update_template_request.rb +15 -0
  109. data/lib/Mailhub/types/api_error.rb +16 -0
  110. data/lib/Mailhub/types/api_error_detail.rb +12 -0
  111. data/lib/Mailhub/types/campaign_activity_point_model.rb +18 -0
  112. data/lib/Mailhub/types/campaign_analytics_model.rb +30 -0
  113. data/lib/Mailhub/types/campaign_link_stat_model.rb +14 -0
  114. data/lib/Mailhub/types/campaign_media_model.rb +24 -0
  115. data/lib/Mailhub/types/campaign_model.rb +52 -0
  116. data/lib/Mailhub/types/campaign_model_paged_result.rb +16 -0
  117. data/lib/Mailhub/types/campaign_segment_model.rb +14 -0
  118. data/lib/Mailhub/types/campaign_status.rb +17 -0
  119. data/lib/Mailhub/types/campaign_type.rb +12 -0
  120. data/lib/Mailhub/types/contact_import_job_model.rb +22 -0
  121. data/lib/Mailhub/types/contact_import_model.rb +10 -0
  122. data/lib/Mailhub/types/contact_import_status.rb +14 -0
  123. data/lib/Mailhub/types/contact_model.rb +26 -0
  124. data/lib/Mailhub/types/contact_model_cursor_paged_result.rb +18 -0
  125. data/lib/Mailhub/types/contact_model_paged_result.rb +16 -0
  126. data/lib/Mailhub/types/contact_segment_model.rb +14 -0
  127. data/lib/Mailhub/types/contact_status.rb +13 -0
  128. data/lib/Mailhub/types/custom_field_model.rb +20 -0
  129. data/lib/Mailhub/types/custom_field_type.rb +14 -0
  130. data/lib/Mailhub/types/import_contact_error_model.rb +12 -0
  131. data/lib/Mailhub/types/media_model.rb +28 -0
  132. data/lib/Mailhub/types/media_model_paged_result.rb +16 -0
  133. data/lib/Mailhub/types/message_event_model.rb +16 -0
  134. data/lib/Mailhub/types/message_event_type.rb +18 -0
  135. data/lib/Mailhub/types/message_model.rb +36 -0
  136. data/lib/Mailhub/types/message_model_cursor_paged_result.rb +18 -0
  137. data/lib/Mailhub/types/preview_segment_model.rb +10 -0
  138. data/lib/Mailhub/types/running_campaign_stats_model.rb +32 -0
  139. data/lib/Mailhub/types/segment_filter_group_model.rb +12 -0
  140. data/lib/Mailhub/types/segment_filter_model.rb +10 -0
  141. data/lib/Mailhub/types/segment_filter_rule_model.rb +14 -0
  142. data/lib/Mailhub/types/segment_model.rb +32 -0
  143. data/lib/Mailhub/types/segment_model_paged_result.rb +16 -0
  144. data/lib/Mailhub/types/segment_sync_status.rb +14 -0
  145. data/lib/Mailhub/types/template_expression_model.rb +14 -0
  146. data/lib/Mailhub/types/template_model.rb +20 -0
  147. data/lib/Mailhub/types/template_model_paged_result.rb +16 -0
  148. data/lib/Mailhub/version.rb +5 -0
  149. data/lib/Mailhub.rb +145 -0
  150. data/reference.md +3691 -0
  151. metadata +193 -0
data/lib/Mailhub.rb ADDED
@@ -0,0 +1,145 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "json"
4
+ require "net/http"
5
+ require "securerandom"
6
+
7
+ require_relative "Mailhub/internal/json/serializable"
8
+ require_relative "Mailhub/internal/types/type"
9
+ require_relative "Mailhub/internal/types/utils"
10
+ require_relative "Mailhub/internal/types/union"
11
+ require_relative "Mailhub/internal/errors/constraint_error"
12
+ require_relative "Mailhub/internal/errors/type_error"
13
+ require_relative "Mailhub/internal/http/base_request"
14
+ require_relative "Mailhub/internal/json/request"
15
+ require_relative "Mailhub/internal/http/raw_client"
16
+ require_relative "Mailhub/internal/multipart/multipart_encoder"
17
+ require_relative "Mailhub/internal/multipart/multipart_form_data_part"
18
+ require_relative "Mailhub/internal/multipart/multipart_form_data"
19
+ require_relative "Mailhub/internal/multipart/multipart_request"
20
+ require_relative "Mailhub/internal/types/model/field"
21
+ require_relative "Mailhub/internal/types/model"
22
+ require_relative "Mailhub/internal/types/array"
23
+ require_relative "Mailhub/internal/types/boolean"
24
+ require_relative "Mailhub/internal/types/enum"
25
+ require_relative "Mailhub/internal/types/hash"
26
+ require_relative "Mailhub/internal/types/unknown"
27
+ require_relative "Mailhub/errors/api_error"
28
+ require_relative "Mailhub/errors/response_error"
29
+ require_relative "Mailhub/errors/client_error"
30
+ require_relative "Mailhub/errors/redirect_error"
31
+ require_relative "Mailhub/errors/server_error"
32
+ require_relative "Mailhub/errors/timeout_error"
33
+ require_relative "Mailhub/internal/iterators/item_iterator"
34
+ require_relative "Mailhub/internal/iterators/cursor_item_iterator"
35
+ require_relative "Mailhub/internal/iterators/offset_item_iterator"
36
+ require_relative "Mailhub/internal/iterators/cursor_page_iterator"
37
+ require_relative "Mailhub/internal/iterators/offset_page_iterator"
38
+ require_relative "Mailhub/types/api_error_detail"
39
+ require_relative "Mailhub/types/api_error"
40
+ require_relative "Mailhub/types/campaign_activity_point_model"
41
+ require_relative "Mailhub/types/campaign_analytics_model"
42
+ require_relative "Mailhub/types/campaign_link_stat_model"
43
+ require_relative "Mailhub/types/campaign_media_model"
44
+ require_relative "Mailhub/types/campaign_segment_model"
45
+ require_relative "Mailhub/types/campaign_status"
46
+ require_relative "Mailhub/types/campaign_type"
47
+ require_relative "Mailhub/types/campaign_model"
48
+ require_relative "Mailhub/types/campaign_model_paged_result"
49
+ require_relative "Mailhub/types/contact_import_status"
50
+ require_relative "Mailhub/types/import_contact_error_model"
51
+ require_relative "Mailhub/types/contact_import_job_model"
52
+ require_relative "Mailhub/types/contact_import_model"
53
+ require_relative "Mailhub/types/contact_segment_model"
54
+ require_relative "Mailhub/types/contact_status"
55
+ require_relative "Mailhub/types/contact_model"
56
+ require_relative "Mailhub/types/contact_model_cursor_paged_result"
57
+ require_relative "Mailhub/types/contact_model_paged_result"
58
+ require_relative "Mailhub/types/custom_field_type"
59
+ require_relative "Mailhub/types/custom_field_model"
60
+ require_relative "Mailhub/types/media_model"
61
+ require_relative "Mailhub/types/media_model_paged_result"
62
+ require_relative "Mailhub/types/message_event_type"
63
+ require_relative "Mailhub/types/message_event_model"
64
+ require_relative "Mailhub/types/message_model"
65
+ require_relative "Mailhub/types/message_model_cursor_paged_result"
66
+ require_relative "Mailhub/types/preview_segment_model"
67
+ require_relative "Mailhub/types/running_campaign_stats_model"
68
+ require_relative "Mailhub/types/segment_filter_rule_model"
69
+ require_relative "Mailhub/types/segment_filter_group_model"
70
+ require_relative "Mailhub/types/segment_filter_model"
71
+ require_relative "Mailhub/types/segment_sync_status"
72
+ require_relative "Mailhub/types/segment_model"
73
+ require_relative "Mailhub/types/segment_model_paged_result"
74
+ require_relative "Mailhub/types/template_expression_model"
75
+ require_relative "Mailhub/types/template_model"
76
+ require_relative "Mailhub/types/template_model_paged_result"
77
+ require_relative "Mailhub/client"
78
+ require_relative "Mailhub/campaign/client"
79
+ require_relative "Mailhub/campaign/types/get_campaigns_request"
80
+ require_relative "Mailhub/campaign/types/create_campaign_by_code_request"
81
+ require_relative "Mailhub/campaign/types/get_campaign_request"
82
+ require_relative "Mailhub/campaign/types/update_campaign_by_code_request"
83
+ require_relative "Mailhub/campaign/types/delete_campaign_request"
84
+ require_relative "Mailhub/campaign/types/preview_campaign_request"
85
+ require_relative "Mailhub/campaign/types/get_campaign_rendered_preview_by_code_request"
86
+ require_relative "Mailhub/campaign/types/test_campaign_by_code_request"
87
+ require_relative "Mailhub/campaign/types/get_campaign_analytics_request"
88
+ require_relative "Mailhub/campaign/types/get_campaign_activity_request"
89
+ require_relative "Mailhub/campaign/types/get_campaign_link_stats_request"
90
+ require_relative "Mailhub/campaign/types/get_campaign_media_request"
91
+ require_relative "Mailhub/campaign/types/add_campaign_media_by_code_request"
92
+ require_relative "Mailhub/campaign/types/remove_campaign_media_request"
93
+ require_relative "Mailhub/campaign/types/schedule_campaign_request"
94
+ require_relative "Mailhub/campaign/types/send_campaign_request"
95
+ require_relative "Mailhub/campaign/types/pause_campaign_request"
96
+ require_relative "Mailhub/campaign/types/cancel_campaign_request"
97
+ require_relative "Mailhub/campaign/types/catch_up_campaign_request"
98
+ require_relative "Mailhub/contact/client"
99
+ require_relative "Mailhub/contact/types/get_contacts_request"
100
+ require_relative "Mailhub/contact/types/create_contact_request"
101
+ require_relative "Mailhub/contact/types/get_contact_request"
102
+ require_relative "Mailhub/contact/types/update_contact_request"
103
+ require_relative "Mailhub/contact/types/delete_contact_request"
104
+ require_relative "Mailhub/contact/types/block_contact_request"
105
+ require_relative "Mailhub/contact/types/block_contacts_by_guid_request"
106
+ require_relative "Mailhub/contact/types/delete_contacts_by_guid_request"
107
+ require_relative "Mailhub/contact/types/import_contacts_request"
108
+ require_relative "Mailhub/contact/types/get_import_job_request"
109
+ require_relative "Mailhub/custom_field/client"
110
+ require_relative "Mailhub/custom_field/types/create_custom_field_request"
111
+ require_relative "Mailhub/custom_field/types/get_custom_field_request"
112
+ require_relative "Mailhub/custom_field/types/update_custom_field_request"
113
+ require_relative "Mailhub/custom_field/types/delete_custom_field_request"
114
+ require_relative "Mailhub/media/client"
115
+ require_relative "Mailhub/media/types/get_medias_request"
116
+ require_relative "Mailhub/media/types/upload_media_request"
117
+ require_relative "Mailhub/media/types/get_media_request"
118
+ require_relative "Mailhub/media/types/update_media_request"
119
+ require_relative "Mailhub/media/types/delete_media_request"
120
+ require_relative "Mailhub/media/types/download_media_request"
121
+ require_relative "Mailhub/message/client"
122
+ require_relative "Mailhub/message/types/get_messages_request"
123
+ require_relative "Mailhub/message/types/get_message_request"
124
+ require_relative "Mailhub/message/types/get_message_events_request"
125
+ require_relative "Mailhub/message/types/send_message_request"
126
+ require_relative "Mailhub/message/types/cancel_message_request"
127
+ require_relative "Mailhub/segment/client"
128
+ require_relative "Mailhub/segment/types/get_segments_request"
129
+ require_relative "Mailhub/segment/types/create_segment_request"
130
+ require_relative "Mailhub/segment/types/get_segment_request"
131
+ require_relative "Mailhub/segment/types/update_segment_request"
132
+ require_relative "Mailhub/segment/types/delete_segment_request"
133
+ require_relative "Mailhub/segment/types/delete_segments_by_code_request"
134
+ require_relative "Mailhub/segment/types/get_segment_preview_request"
135
+ require_relative "Mailhub/segment/types/get_segments_union_preview_by_code_request"
136
+ require_relative "Mailhub/segment/types/get_segment_contacts_request"
137
+ require_relative "Mailhub/segment/types/sync_segment_request"
138
+ require_relative "Mailhub/template/client"
139
+ require_relative "Mailhub/template/types/get_templates_request"
140
+ require_relative "Mailhub/template/types/create_template_request"
141
+ require_relative "Mailhub/template/types/get_template_request"
142
+ require_relative "Mailhub/template/types/update_template_request"
143
+ require_relative "Mailhub/template/types/delete_template_request"
144
+ require_relative "Mailhub/template/types/preview_template_request"
145
+ require_relative "Mailhub/template/types/get_template_rendered_preview_request"