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
metadata ADDED
@@ -0,0 +1,193 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: mailhub-sdk
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Mailhub
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2026-07-30 00:00:00.000000000 Z
12
+ dependencies: []
13
+ description: The Mailhub Ruby library provides convenient access to the Mailhub API
14
+ from Ruby.
15
+ email:
16
+ executables: []
17
+ extensions: []
18
+ extra_rdoc_files: []
19
+ files:
20
+ - ".fern/metadata.json"
21
+ - ".fernignore"
22
+ - ".rubocop.yml"
23
+ - CONTRIBUTING.md
24
+ - README.md
25
+ - Rakefile
26
+ - custom.gemspec.rb
27
+ - lib/Mailhub.rb
28
+ - lib/Mailhub/campaign/client.rb
29
+ - lib/Mailhub/campaign/types/add_campaign_media_by_code_request.rb
30
+ - lib/Mailhub/campaign/types/cancel_campaign_request.rb
31
+ - lib/Mailhub/campaign/types/catch_up_campaign_request.rb
32
+ - lib/Mailhub/campaign/types/create_campaign_by_code_request.rb
33
+ - lib/Mailhub/campaign/types/delete_campaign_request.rb
34
+ - lib/Mailhub/campaign/types/get_campaign_activity_request.rb
35
+ - lib/Mailhub/campaign/types/get_campaign_analytics_request.rb
36
+ - lib/Mailhub/campaign/types/get_campaign_link_stats_request.rb
37
+ - lib/Mailhub/campaign/types/get_campaign_media_request.rb
38
+ - lib/Mailhub/campaign/types/get_campaign_rendered_preview_by_code_request.rb
39
+ - lib/Mailhub/campaign/types/get_campaign_request.rb
40
+ - lib/Mailhub/campaign/types/get_campaigns_request.rb
41
+ - lib/Mailhub/campaign/types/pause_campaign_request.rb
42
+ - lib/Mailhub/campaign/types/preview_campaign_request.rb
43
+ - lib/Mailhub/campaign/types/remove_campaign_media_request.rb
44
+ - lib/Mailhub/campaign/types/schedule_campaign_request.rb
45
+ - lib/Mailhub/campaign/types/send_campaign_request.rb
46
+ - lib/Mailhub/campaign/types/test_campaign_by_code_request.rb
47
+ - lib/Mailhub/campaign/types/update_campaign_by_code_request.rb
48
+ - lib/Mailhub/client.rb
49
+ - lib/Mailhub/contact/client.rb
50
+ - lib/Mailhub/contact/types/block_contact_request.rb
51
+ - lib/Mailhub/contact/types/block_contacts_by_guid_request.rb
52
+ - lib/Mailhub/contact/types/create_contact_request.rb
53
+ - lib/Mailhub/contact/types/delete_contact_request.rb
54
+ - lib/Mailhub/contact/types/delete_contacts_by_guid_request.rb
55
+ - lib/Mailhub/contact/types/get_contact_request.rb
56
+ - lib/Mailhub/contact/types/get_contacts_request.rb
57
+ - lib/Mailhub/contact/types/get_import_job_request.rb
58
+ - lib/Mailhub/contact/types/import_contacts_request.rb
59
+ - lib/Mailhub/contact/types/update_contact_request.rb
60
+ - lib/Mailhub/custom_field/client.rb
61
+ - lib/Mailhub/custom_field/types/create_custom_field_request.rb
62
+ - lib/Mailhub/custom_field/types/delete_custom_field_request.rb
63
+ - lib/Mailhub/custom_field/types/get_custom_field_request.rb
64
+ - lib/Mailhub/custom_field/types/update_custom_field_request.rb
65
+ - lib/Mailhub/errors/api_error.rb
66
+ - lib/Mailhub/errors/client_error.rb
67
+ - lib/Mailhub/errors/redirect_error.rb
68
+ - lib/Mailhub/errors/response_error.rb
69
+ - lib/Mailhub/errors/server_error.rb
70
+ - lib/Mailhub/errors/timeout_error.rb
71
+ - lib/Mailhub/internal/errors/constraint_error.rb
72
+ - lib/Mailhub/internal/errors/type_error.rb
73
+ - lib/Mailhub/internal/http/base_request.rb
74
+ - lib/Mailhub/internal/http/raw_client.rb
75
+ - lib/Mailhub/internal/iterators/cursor_item_iterator.rb
76
+ - lib/Mailhub/internal/iterators/cursor_page_iterator.rb
77
+ - lib/Mailhub/internal/iterators/item_iterator.rb
78
+ - lib/Mailhub/internal/iterators/offset_item_iterator.rb
79
+ - lib/Mailhub/internal/iterators/offset_page_iterator.rb
80
+ - lib/Mailhub/internal/json/request.rb
81
+ - lib/Mailhub/internal/json/serializable.rb
82
+ - lib/Mailhub/internal/multipart/multipart_encoder.rb
83
+ - lib/Mailhub/internal/multipart/multipart_form_data.rb
84
+ - lib/Mailhub/internal/multipart/multipart_form_data_part.rb
85
+ - lib/Mailhub/internal/multipart/multipart_request.rb
86
+ - lib/Mailhub/internal/types/array.rb
87
+ - lib/Mailhub/internal/types/boolean.rb
88
+ - lib/Mailhub/internal/types/enum.rb
89
+ - lib/Mailhub/internal/types/hash.rb
90
+ - lib/Mailhub/internal/types/model.rb
91
+ - lib/Mailhub/internal/types/model/field.rb
92
+ - lib/Mailhub/internal/types/type.rb
93
+ - lib/Mailhub/internal/types/union.rb
94
+ - lib/Mailhub/internal/types/unknown.rb
95
+ - lib/Mailhub/internal/types/utils.rb
96
+ - lib/Mailhub/media/client.rb
97
+ - lib/Mailhub/media/types/delete_media_request.rb
98
+ - lib/Mailhub/media/types/download_media_request.rb
99
+ - lib/Mailhub/media/types/get_media_request.rb
100
+ - lib/Mailhub/media/types/get_medias_request.rb
101
+ - lib/Mailhub/media/types/update_media_request.rb
102
+ - lib/Mailhub/media/types/upload_media_request.rb
103
+ - lib/Mailhub/message/client.rb
104
+ - lib/Mailhub/message/types/cancel_message_request.rb
105
+ - lib/Mailhub/message/types/get_message_events_request.rb
106
+ - lib/Mailhub/message/types/get_message_request.rb
107
+ - lib/Mailhub/message/types/get_messages_request.rb
108
+ - lib/Mailhub/message/types/send_message_request.rb
109
+ - lib/Mailhub/segment/client.rb
110
+ - lib/Mailhub/segment/types/create_segment_request.rb
111
+ - lib/Mailhub/segment/types/delete_segment_request.rb
112
+ - lib/Mailhub/segment/types/delete_segments_by_code_request.rb
113
+ - lib/Mailhub/segment/types/get_segment_contacts_request.rb
114
+ - lib/Mailhub/segment/types/get_segment_preview_request.rb
115
+ - lib/Mailhub/segment/types/get_segment_request.rb
116
+ - lib/Mailhub/segment/types/get_segments_request.rb
117
+ - lib/Mailhub/segment/types/get_segments_union_preview_by_code_request.rb
118
+ - lib/Mailhub/segment/types/sync_segment_request.rb
119
+ - lib/Mailhub/segment/types/update_segment_request.rb
120
+ - lib/Mailhub/template/client.rb
121
+ - lib/Mailhub/template/types/create_template_request.rb
122
+ - lib/Mailhub/template/types/delete_template_request.rb
123
+ - lib/Mailhub/template/types/get_template_rendered_preview_request.rb
124
+ - lib/Mailhub/template/types/get_template_request.rb
125
+ - lib/Mailhub/template/types/get_templates_request.rb
126
+ - lib/Mailhub/template/types/preview_template_request.rb
127
+ - lib/Mailhub/template/types/update_template_request.rb
128
+ - lib/Mailhub/types/api_error.rb
129
+ - lib/Mailhub/types/api_error_detail.rb
130
+ - lib/Mailhub/types/campaign_activity_point_model.rb
131
+ - lib/Mailhub/types/campaign_analytics_model.rb
132
+ - lib/Mailhub/types/campaign_link_stat_model.rb
133
+ - lib/Mailhub/types/campaign_media_model.rb
134
+ - lib/Mailhub/types/campaign_model.rb
135
+ - lib/Mailhub/types/campaign_model_paged_result.rb
136
+ - lib/Mailhub/types/campaign_segment_model.rb
137
+ - lib/Mailhub/types/campaign_status.rb
138
+ - lib/Mailhub/types/campaign_type.rb
139
+ - lib/Mailhub/types/contact_import_job_model.rb
140
+ - lib/Mailhub/types/contact_import_model.rb
141
+ - lib/Mailhub/types/contact_import_status.rb
142
+ - lib/Mailhub/types/contact_model.rb
143
+ - lib/Mailhub/types/contact_model_cursor_paged_result.rb
144
+ - lib/Mailhub/types/contact_model_paged_result.rb
145
+ - lib/Mailhub/types/contact_segment_model.rb
146
+ - lib/Mailhub/types/contact_status.rb
147
+ - lib/Mailhub/types/custom_field_model.rb
148
+ - lib/Mailhub/types/custom_field_type.rb
149
+ - lib/Mailhub/types/import_contact_error_model.rb
150
+ - lib/Mailhub/types/media_model.rb
151
+ - lib/Mailhub/types/media_model_paged_result.rb
152
+ - lib/Mailhub/types/message_event_model.rb
153
+ - lib/Mailhub/types/message_event_type.rb
154
+ - lib/Mailhub/types/message_model.rb
155
+ - lib/Mailhub/types/message_model_cursor_paged_result.rb
156
+ - lib/Mailhub/types/preview_segment_model.rb
157
+ - lib/Mailhub/types/running_campaign_stats_model.rb
158
+ - lib/Mailhub/types/segment_filter_group_model.rb
159
+ - lib/Mailhub/types/segment_filter_model.rb
160
+ - lib/Mailhub/types/segment_filter_rule_model.rb
161
+ - lib/Mailhub/types/segment_model.rb
162
+ - lib/Mailhub/types/segment_model_paged_result.rb
163
+ - lib/Mailhub/types/segment_sync_status.rb
164
+ - lib/Mailhub/types/template_expression_model.rb
165
+ - lib/Mailhub/types/template_model.rb
166
+ - lib/Mailhub/types/template_model_paged_result.rb
167
+ - lib/Mailhub/version.rb
168
+ - reference.md
169
+ homepage: https://mailhub.co.kr
170
+ licenses:
171
+ - MIT
172
+ metadata:
173
+ rubygems_mfa_required: 'true'
174
+ post_install_message:
175
+ rdoc_options: []
176
+ require_paths:
177
+ - lib
178
+ required_ruby_version: !ruby/object:Gem::Requirement
179
+ requirements:
180
+ - - ">="
181
+ - !ruby/object:Gem::Version
182
+ version: 3.3.0
183
+ required_rubygems_version: !ruby/object:Gem::Requirement
184
+ requirements:
185
+ - - ">="
186
+ - !ruby/object:Gem::Version
187
+ version: '0'
188
+ requirements: []
189
+ rubygems_version: 3.5.22
190
+ signing_key:
191
+ specification_version: 4
192
+ summary: Ruby client library for the Mailhub API
193
+ test_files: []