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/reference.md ADDED
@@ -0,0 +1,3691 @@
1
+ # Reference
2
+ ## Campaign
3
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">get_campaigns</a>() -> Mailhub::Types::CampaignModelPagedResult</code></summary>
4
+ <dl>
5
+ <dd>
6
+
7
+ #### 🔌 Usage
8
+
9
+ <dl>
10
+ <dd>
11
+
12
+ <dl>
13
+ <dd>
14
+
15
+ ```ruby
16
+ client.campaign.get_campaigns
17
+ ```
18
+ </dd>
19
+ </dl>
20
+ </dd>
21
+ </dl>
22
+
23
+ #### ⚙️ Parameters
24
+
25
+ <dl>
26
+ <dd>
27
+
28
+ <dl>
29
+ <dd>
30
+
31
+ **search:** `String` — 이름, 제목 등으로 검색할 키워드
32
+
33
+ </dd>
34
+ </dl>
35
+
36
+ <dl>
37
+ <dd>
38
+
39
+ **sort_by:** `String` — 정렬 기준 필드명
40
+
41
+ </dd>
42
+ </dl>
43
+
44
+ <dl>
45
+ <dd>
46
+
47
+ **sort_direction:** `String` — 정렬 방향 (asc, desc)
48
+
49
+ </dd>
50
+ </dl>
51
+
52
+ <dl>
53
+ <dd>
54
+
55
+ **page_size:** `Integer` — 페이지 크기 (기본값 10)
56
+
57
+ </dd>
58
+ </dl>
59
+
60
+ <dl>
61
+ <dd>
62
+
63
+ **page_index:** `Integer` — 페이지 번호 (1부터 시작, 기본값 1)
64
+
65
+ </dd>
66
+ </dl>
67
+
68
+ <dl>
69
+ <dd>
70
+
71
+ **request_options:** `Mailhub::Campaign::RequestOptions`
72
+
73
+ </dd>
74
+ </dl>
75
+ </dd>
76
+ </dl>
77
+
78
+
79
+ </dd>
80
+ </dl>
81
+ </details>
82
+
83
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">create_campaign</a>(request) -> Mailhub::Types::CampaignModel</code></summary>
84
+ <dl>
85
+ <dd>
86
+
87
+ #### 🔌 Usage
88
+
89
+ <dl>
90
+ <dd>
91
+
92
+ <dl>
93
+ <dd>
94
+
95
+ ```ruby
96
+ client.campaign.create_campaign
97
+ ```
98
+ </dd>
99
+ </dl>
100
+ </dd>
101
+ </dl>
102
+
103
+ #### ⚙️ Parameters
104
+
105
+ <dl>
106
+ <dd>
107
+
108
+ <dl>
109
+ <dd>
110
+
111
+ **name:** `String` — 캠페인 이름
112
+
113
+ </dd>
114
+ </dl>
115
+
116
+ <dl>
117
+ <dd>
118
+
119
+ **subject:** `String` — 메일 제목
120
+
121
+ </dd>
122
+ </dl>
123
+
124
+ <dl>
125
+ <dd>
126
+
127
+ **type:** `Mailhub::Types::CampaignType`
128
+
129
+ </dd>
130
+ </dl>
131
+
132
+ <dl>
133
+ <dd>
134
+
135
+ **from_email:** `String` — 발신 이메일 주소
136
+
137
+ </dd>
138
+ </dl>
139
+
140
+ <dl>
141
+ <dd>
142
+
143
+ **segment_codes:** `Internal::Types::Array[String]` — 대상 세그먼트 Code 목록
144
+
145
+ </dd>
146
+ </dl>
147
+
148
+ <dl>
149
+ <dd>
150
+
151
+ **media_codes:** `Internal::Types::Array[String]` — 첨부할 미디어 Code 목록
152
+
153
+ </dd>
154
+ </dl>
155
+
156
+ <dl>
157
+ <dd>
158
+
159
+ **template_code:** `String` — 사용할 템플릿 Code
160
+
161
+ </dd>
162
+ </dl>
163
+
164
+ <dl>
165
+ <dd>
166
+
167
+ **body:** `String` — 메일 본문
168
+
169
+ </dd>
170
+ </dl>
171
+
172
+ <dl>
173
+ <dd>
174
+
175
+ **send_at:** `String` — 발송 예약 일시
176
+
177
+ </dd>
178
+ </dl>
179
+
180
+ <dl>
181
+ <dd>
182
+
183
+ **request_options:** `Mailhub::Campaign::RequestOptions`
184
+
185
+ </dd>
186
+ </dl>
187
+ </dd>
188
+ </dl>
189
+
190
+
191
+ </dd>
192
+ </dl>
193
+ </details>
194
+
195
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">get_campaign</a>(code:) -> Mailhub::Types::CampaignModel</code></summary>
196
+ <dl>
197
+ <dd>
198
+
199
+ #### 🔌 Usage
200
+
201
+ <dl>
202
+ <dd>
203
+
204
+ <dl>
205
+ <dd>
206
+
207
+ ```ruby
208
+ client.campaign.get_campaign(code: "code")
209
+ ```
210
+ </dd>
211
+ </dl>
212
+ </dd>
213
+ </dl>
214
+
215
+ #### ⚙️ Parameters
216
+
217
+ <dl>
218
+ <dd>
219
+
220
+ <dl>
221
+ <dd>
222
+
223
+ **code:** `String`
224
+
225
+ </dd>
226
+ </dl>
227
+
228
+ <dl>
229
+ <dd>
230
+
231
+ **request_options:** `Mailhub::Campaign::RequestOptions`
232
+
233
+ </dd>
234
+ </dl>
235
+ </dd>
236
+ </dl>
237
+
238
+
239
+ </dd>
240
+ </dl>
241
+ </details>
242
+
243
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">update_campaign</a>(code:, request) -> Mailhub::Types::CampaignModel</code></summary>
244
+ <dl>
245
+ <dd>
246
+
247
+ #### 🔌 Usage
248
+
249
+ <dl>
250
+ <dd>
251
+
252
+ <dl>
253
+ <dd>
254
+
255
+ ```ruby
256
+ client.campaign.update_campaign(code: "code")
257
+ ```
258
+ </dd>
259
+ </dl>
260
+ </dd>
261
+ </dl>
262
+
263
+ #### ⚙️ Parameters
264
+
265
+ <dl>
266
+ <dd>
267
+
268
+ <dl>
269
+ <dd>
270
+
271
+ **code:** `String`
272
+
273
+ </dd>
274
+ </dl>
275
+
276
+ <dl>
277
+ <dd>
278
+
279
+ **name:** `String` — 캠페인 이름
280
+
281
+ </dd>
282
+ </dl>
283
+
284
+ <dl>
285
+ <dd>
286
+
287
+ **subject:** `String` — 메일 제목
288
+
289
+ </dd>
290
+ </dl>
291
+
292
+ <dl>
293
+ <dd>
294
+
295
+ **type:** `Mailhub::Types::CampaignType`
296
+
297
+ </dd>
298
+ </dl>
299
+
300
+ <dl>
301
+ <dd>
302
+
303
+ **from_email:** `String` — 발신 이메일 주소
304
+
305
+ </dd>
306
+ </dl>
307
+
308
+ <dl>
309
+ <dd>
310
+
311
+ **segment_codes:** `Internal::Types::Array[String]` — 대상 세그먼트 Code 목록
312
+
313
+ </dd>
314
+ </dl>
315
+
316
+ <dl>
317
+ <dd>
318
+
319
+ **media_codes:** `Internal::Types::Array[String]` — 첨부할 미디어 Code 목록
320
+
321
+ </dd>
322
+ </dl>
323
+
324
+ <dl>
325
+ <dd>
326
+
327
+ **template_code:** `String` — 사용할 템플릿 Code
328
+
329
+ </dd>
330
+ </dl>
331
+
332
+ <dl>
333
+ <dd>
334
+
335
+ **body:** `String` — 메일 본문
336
+
337
+ </dd>
338
+ </dl>
339
+
340
+ <dl>
341
+ <dd>
342
+
343
+ **send_at:** `String` — 발송 예약 일시
344
+
345
+ </dd>
346
+ </dl>
347
+
348
+ <dl>
349
+ <dd>
350
+
351
+ **request_options:** `Mailhub::Campaign::RequestOptions`
352
+
353
+ </dd>
354
+ </dl>
355
+ </dd>
356
+ </dl>
357
+
358
+
359
+ </dd>
360
+ </dl>
361
+ </details>
362
+
363
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">delete_campaign</a>(code:) -> </code></summary>
364
+ <dl>
365
+ <dd>
366
+
367
+ #### 🔌 Usage
368
+
369
+ <dl>
370
+ <dd>
371
+
372
+ <dl>
373
+ <dd>
374
+
375
+ ```ruby
376
+ client.campaign.delete_campaign(code: "code")
377
+ ```
378
+ </dd>
379
+ </dl>
380
+ </dd>
381
+ </dl>
382
+
383
+ #### ⚙️ Parameters
384
+
385
+ <dl>
386
+ <dd>
387
+
388
+ <dl>
389
+ <dd>
390
+
391
+ **code:** `String`
392
+
393
+ </dd>
394
+ </dl>
395
+
396
+ <dl>
397
+ <dd>
398
+
399
+ **request_options:** `Mailhub::Campaign::RequestOptions`
400
+
401
+ </dd>
402
+ </dl>
403
+ </dd>
404
+ </dl>
405
+
406
+
407
+ </dd>
408
+ </dl>
409
+ </details>
410
+
411
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">preview_campaign</a>(code:) -> String</code></summary>
412
+ <dl>
413
+ <dd>
414
+
415
+ #### 🔌 Usage
416
+
417
+ <dl>
418
+ <dd>
419
+
420
+ <dl>
421
+ <dd>
422
+
423
+ ```ruby
424
+ client.campaign.preview_campaign(code: "code")
425
+ ```
426
+ </dd>
427
+ </dl>
428
+ </dd>
429
+ </dl>
430
+
431
+ #### ⚙️ Parameters
432
+
433
+ <dl>
434
+ <dd>
435
+
436
+ <dl>
437
+ <dd>
438
+
439
+ **code:** `String`
440
+
441
+ </dd>
442
+ </dl>
443
+
444
+ <dl>
445
+ <dd>
446
+
447
+ **request_options:** `Mailhub::Campaign::RequestOptions`
448
+
449
+ </dd>
450
+ </dl>
451
+ </dd>
452
+ </dl>
453
+
454
+
455
+ </dd>
456
+ </dl>
457
+ </details>
458
+
459
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">render_campaign_preview</a>(code:, request) -> String</code></summary>
460
+ <dl>
461
+ <dd>
462
+
463
+ #### 🔌 Usage
464
+
465
+ <dl>
466
+ <dd>
467
+
468
+ <dl>
469
+ <dd>
470
+
471
+ ```ruby
472
+ client.campaign.render_campaign_preview(code: "code")
473
+ ```
474
+ </dd>
475
+ </dl>
476
+ </dd>
477
+ </dl>
478
+
479
+ #### ⚙️ Parameters
480
+
481
+ <dl>
482
+ <dd>
483
+
484
+ <dl>
485
+ <dd>
486
+
487
+ **code:** `String`
488
+
489
+ </dd>
490
+ </dl>
491
+
492
+ <dl>
493
+ <dd>
494
+
495
+ **name:** `String` — 캠페인 이름
496
+
497
+ </dd>
498
+ </dl>
499
+
500
+ <dl>
501
+ <dd>
502
+
503
+ **subject:** `String` — 메일 제목
504
+
505
+ </dd>
506
+ </dl>
507
+
508
+ <dl>
509
+ <dd>
510
+
511
+ **from_email:** `String` — 발신 이메일 주소
512
+
513
+ </dd>
514
+ </dl>
515
+
516
+ <dl>
517
+ <dd>
518
+
519
+ **template_code:** `String` — 사용할 템플릿 Code
520
+
521
+ </dd>
522
+ </dl>
523
+
524
+ <dl>
525
+ <dd>
526
+
527
+ **body:** `String` — 메일 본문
528
+
529
+ </dd>
530
+ </dl>
531
+
532
+ <dl>
533
+ <dd>
534
+
535
+ **request_options:** `Mailhub::Campaign::RequestOptions`
536
+
537
+ </dd>
538
+ </dl>
539
+ </dd>
540
+ </dl>
541
+
542
+
543
+ </dd>
544
+ </dl>
545
+ </details>
546
+
547
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">test_campaign</a>(code:, request) -> Internal::Types::Boolean</code></summary>
548
+ <dl>
549
+ <dd>
550
+
551
+ #### 🔌 Usage
552
+
553
+ <dl>
554
+ <dd>
555
+
556
+ <dl>
557
+ <dd>
558
+
559
+ ```ruby
560
+ client.campaign.test_campaign(code: "code")
561
+ ```
562
+ </dd>
563
+ </dl>
564
+ </dd>
565
+ </dl>
566
+
567
+ #### ⚙️ Parameters
568
+
569
+ <dl>
570
+ <dd>
571
+
572
+ <dl>
573
+ <dd>
574
+
575
+ **code:** `String`
576
+
577
+ </dd>
578
+ </dl>
579
+
580
+ <dl>
581
+ <dd>
582
+
583
+ **name:** `String` — 캠페인 이름
584
+
585
+ </dd>
586
+ </dl>
587
+
588
+ <dl>
589
+ <dd>
590
+
591
+ **subject:** `String` — 메일 제목
592
+
593
+ </dd>
594
+ </dl>
595
+
596
+ <dl>
597
+ <dd>
598
+
599
+ **from_email:** `String` — 발신 이메일 주소
600
+
601
+ </dd>
602
+ </dl>
603
+
604
+ <dl>
605
+ <dd>
606
+
607
+ **body:** `String` — 메일 본문
608
+
609
+ </dd>
610
+ </dl>
611
+
612
+ <dl>
613
+ <dd>
614
+
615
+ **template_code:** `String` — 사용할 템플릿 Code
616
+
617
+ </dd>
618
+ </dl>
619
+
620
+ <dl>
621
+ <dd>
622
+
623
+ **contacts:** `Internal::Types::Array[String]` — 테스트 발송 대상 이메일 목록
624
+
625
+ </dd>
626
+ </dl>
627
+
628
+ <dl>
629
+ <dd>
630
+
631
+ **request_options:** `Mailhub::Campaign::RequestOptions`
632
+
633
+ </dd>
634
+ </dl>
635
+ </dd>
636
+ </dl>
637
+
638
+
639
+ </dd>
640
+ </dl>
641
+ </details>
642
+
643
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">get_running_campaign_stats</a>() -> Internal::Types::Array[Mailhub::Types::RunningCampaignStatsModel]</code></summary>
644
+ <dl>
645
+ <dd>
646
+
647
+ #### 🔌 Usage
648
+
649
+ <dl>
650
+ <dd>
651
+
652
+ <dl>
653
+ <dd>
654
+
655
+ ```ruby
656
+ client.campaign.get_running_campaign_stats
657
+ ```
658
+ </dd>
659
+ </dl>
660
+ </dd>
661
+ </dl>
662
+
663
+ #### ⚙️ Parameters
664
+
665
+ <dl>
666
+ <dd>
667
+
668
+ <dl>
669
+ <dd>
670
+
671
+ **request_options:** `Mailhub::Campaign::RequestOptions`
672
+
673
+ </dd>
674
+ </dl>
675
+ </dd>
676
+ </dl>
677
+
678
+
679
+ </dd>
680
+ </dl>
681
+ </details>
682
+
683
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">get_campaign_analytics</a>(code:) -> Mailhub::Types::CampaignAnalyticsModel</code></summary>
684
+ <dl>
685
+ <dd>
686
+
687
+ #### 🔌 Usage
688
+
689
+ <dl>
690
+ <dd>
691
+
692
+ <dl>
693
+ <dd>
694
+
695
+ ```ruby
696
+ client.campaign.get_campaign_analytics(code: "code")
697
+ ```
698
+ </dd>
699
+ </dl>
700
+ </dd>
701
+ </dl>
702
+
703
+ #### ⚙️ Parameters
704
+
705
+ <dl>
706
+ <dd>
707
+
708
+ <dl>
709
+ <dd>
710
+
711
+ **code:** `String`
712
+
713
+ </dd>
714
+ </dl>
715
+
716
+ <dl>
717
+ <dd>
718
+
719
+ **request_options:** `Mailhub::Campaign::RequestOptions`
720
+
721
+ </dd>
722
+ </dl>
723
+ </dd>
724
+ </dl>
725
+
726
+
727
+ </dd>
728
+ </dl>
729
+ </details>
730
+
731
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">get_campaign_activity</a>(code:) -> Internal::Types::Array[Mailhub::Types::CampaignActivityPointModel]</code></summary>
732
+ <dl>
733
+ <dd>
734
+
735
+ #### 🔌 Usage
736
+
737
+ <dl>
738
+ <dd>
739
+
740
+ <dl>
741
+ <dd>
742
+
743
+ ```ruby
744
+ client.campaign.get_campaign_activity(code: "code")
745
+ ```
746
+ </dd>
747
+ </dl>
748
+ </dd>
749
+ </dl>
750
+
751
+ #### ⚙️ Parameters
752
+
753
+ <dl>
754
+ <dd>
755
+
756
+ <dl>
757
+ <dd>
758
+
759
+ **code:** `String`
760
+
761
+ </dd>
762
+ </dl>
763
+
764
+ <dl>
765
+ <dd>
766
+
767
+ **request_options:** `Mailhub::Campaign::RequestOptions`
768
+
769
+ </dd>
770
+ </dl>
771
+ </dd>
772
+ </dl>
773
+
774
+
775
+ </dd>
776
+ </dl>
777
+ </details>
778
+
779
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">get_campaign_link_stats</a>(code:) -> Internal::Types::Array[Mailhub::Types::CampaignLinkStatModel]</code></summary>
780
+ <dl>
781
+ <dd>
782
+
783
+ #### 🔌 Usage
784
+
785
+ <dl>
786
+ <dd>
787
+
788
+ <dl>
789
+ <dd>
790
+
791
+ ```ruby
792
+ client.campaign.get_campaign_link_stats(code: "code")
793
+ ```
794
+ </dd>
795
+ </dl>
796
+ </dd>
797
+ </dl>
798
+
799
+ #### ⚙️ Parameters
800
+
801
+ <dl>
802
+ <dd>
803
+
804
+ <dl>
805
+ <dd>
806
+
807
+ **code:** `String`
808
+
809
+ </dd>
810
+ </dl>
811
+
812
+ <dl>
813
+ <dd>
814
+
815
+ **request_options:** `Mailhub::Campaign::RequestOptions`
816
+
817
+ </dd>
818
+ </dl>
819
+ </dd>
820
+ </dl>
821
+
822
+
823
+ </dd>
824
+ </dl>
825
+ </details>
826
+
827
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">get_campaign_media</a>(code:) -> Internal::Types::Array[Mailhub::Types::CampaignMediaModel]</code></summary>
828
+ <dl>
829
+ <dd>
830
+
831
+ #### 🔌 Usage
832
+
833
+ <dl>
834
+ <dd>
835
+
836
+ <dl>
837
+ <dd>
838
+
839
+ ```ruby
840
+ client.campaign.get_campaign_media(code: "code")
841
+ ```
842
+ </dd>
843
+ </dl>
844
+ </dd>
845
+ </dl>
846
+
847
+ #### ⚙️ Parameters
848
+
849
+ <dl>
850
+ <dd>
851
+
852
+ <dl>
853
+ <dd>
854
+
855
+ **code:** `String`
856
+
857
+ </dd>
858
+ </dl>
859
+
860
+ <dl>
861
+ <dd>
862
+
863
+ **request_options:** `Mailhub::Campaign::RequestOptions`
864
+
865
+ </dd>
866
+ </dl>
867
+ </dd>
868
+ </dl>
869
+
870
+
871
+ </dd>
872
+ </dl>
873
+ </details>
874
+
875
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">add_campaign_media</a>(code:, request) -> Mailhub::Types::CampaignMediaModel</code></summary>
876
+ <dl>
877
+ <dd>
878
+
879
+ #### 🔌 Usage
880
+
881
+ <dl>
882
+ <dd>
883
+
884
+ <dl>
885
+ <dd>
886
+
887
+ ```ruby
888
+ client.campaign.add_campaign_media(code: "code")
889
+ ```
890
+ </dd>
891
+ </dl>
892
+ </dd>
893
+ </dl>
894
+
895
+ #### ⚙️ Parameters
896
+
897
+ <dl>
898
+ <dd>
899
+
900
+ <dl>
901
+ <dd>
902
+
903
+ **code:** `String`
904
+
905
+ </dd>
906
+ </dl>
907
+
908
+ <dl>
909
+ <dd>
910
+
911
+ **media_code:** `String` — 첨부할 미디어 Code
912
+
913
+ </dd>
914
+ </dl>
915
+
916
+ <dl>
917
+ <dd>
918
+
919
+ **request_options:** `Mailhub::Campaign::RequestOptions`
920
+
921
+ </dd>
922
+ </dl>
923
+ </dd>
924
+ </dl>
925
+
926
+
927
+ </dd>
928
+ </dl>
929
+ </details>
930
+
931
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">remove_campaign_media</a>(code:, media_code:) -> </code></summary>
932
+ <dl>
933
+ <dd>
934
+
935
+ #### 🔌 Usage
936
+
937
+ <dl>
938
+ <dd>
939
+
940
+ <dl>
941
+ <dd>
942
+
943
+ ```ruby
944
+ client.campaign.remove_campaign_media(
945
+ code: "code",
946
+ media_code: "mediaCode"
947
+ )
948
+ ```
949
+ </dd>
950
+ </dl>
951
+ </dd>
952
+ </dl>
953
+
954
+ #### ⚙️ Parameters
955
+
956
+ <dl>
957
+ <dd>
958
+
959
+ <dl>
960
+ <dd>
961
+
962
+ **code:** `String`
963
+
964
+ </dd>
965
+ </dl>
966
+
967
+ <dl>
968
+ <dd>
969
+
970
+ **media_code:** `String`
971
+
972
+ </dd>
973
+ </dl>
974
+
975
+ <dl>
976
+ <dd>
977
+
978
+ **request_options:** `Mailhub::Campaign::RequestOptions`
979
+
980
+ </dd>
981
+ </dl>
982
+ </dd>
983
+ </dl>
984
+
985
+
986
+ </dd>
987
+ </dl>
988
+ </details>
989
+
990
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">schedule_campaign</a>(code:) -> Mailhub::Types::CampaignModel</code></summary>
991
+ <dl>
992
+ <dd>
993
+
994
+ #### 🔌 Usage
995
+
996
+ <dl>
997
+ <dd>
998
+
999
+ <dl>
1000
+ <dd>
1001
+
1002
+ ```ruby
1003
+ client.campaign.schedule_campaign(code: "code")
1004
+ ```
1005
+ </dd>
1006
+ </dl>
1007
+ </dd>
1008
+ </dl>
1009
+
1010
+ #### ⚙️ Parameters
1011
+
1012
+ <dl>
1013
+ <dd>
1014
+
1015
+ <dl>
1016
+ <dd>
1017
+
1018
+ **code:** `String`
1019
+
1020
+ </dd>
1021
+ </dl>
1022
+
1023
+ <dl>
1024
+ <dd>
1025
+
1026
+ **request_options:** `Mailhub::Campaign::RequestOptions`
1027
+
1028
+ </dd>
1029
+ </dl>
1030
+ </dd>
1031
+ </dl>
1032
+
1033
+
1034
+ </dd>
1035
+ </dl>
1036
+ </details>
1037
+
1038
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">send_campaign</a>(code:) -> Mailhub::Types::CampaignModel</code></summary>
1039
+ <dl>
1040
+ <dd>
1041
+
1042
+ #### 🔌 Usage
1043
+
1044
+ <dl>
1045
+ <dd>
1046
+
1047
+ <dl>
1048
+ <dd>
1049
+
1050
+ ```ruby
1051
+ client.campaign.send_campaign(code: "code")
1052
+ ```
1053
+ </dd>
1054
+ </dl>
1055
+ </dd>
1056
+ </dl>
1057
+
1058
+ #### ⚙️ Parameters
1059
+
1060
+ <dl>
1061
+ <dd>
1062
+
1063
+ <dl>
1064
+ <dd>
1065
+
1066
+ **code:** `String`
1067
+
1068
+ </dd>
1069
+ </dl>
1070
+
1071
+ <dl>
1072
+ <dd>
1073
+
1074
+ **request_options:** `Mailhub::Campaign::RequestOptions`
1075
+
1076
+ </dd>
1077
+ </dl>
1078
+ </dd>
1079
+ </dl>
1080
+
1081
+
1082
+ </dd>
1083
+ </dl>
1084
+ </details>
1085
+
1086
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">pause_campaign</a>(code:) -> Mailhub::Types::CampaignModel</code></summary>
1087
+ <dl>
1088
+ <dd>
1089
+
1090
+ #### 🔌 Usage
1091
+
1092
+ <dl>
1093
+ <dd>
1094
+
1095
+ <dl>
1096
+ <dd>
1097
+
1098
+ ```ruby
1099
+ client.campaign.pause_campaign(code: "code")
1100
+ ```
1101
+ </dd>
1102
+ </dl>
1103
+ </dd>
1104
+ </dl>
1105
+
1106
+ #### ⚙️ Parameters
1107
+
1108
+ <dl>
1109
+ <dd>
1110
+
1111
+ <dl>
1112
+ <dd>
1113
+
1114
+ **code:** `String`
1115
+
1116
+ </dd>
1117
+ </dl>
1118
+
1119
+ <dl>
1120
+ <dd>
1121
+
1122
+ **request_options:** `Mailhub::Campaign::RequestOptions`
1123
+
1124
+ </dd>
1125
+ </dl>
1126
+ </dd>
1127
+ </dl>
1128
+
1129
+
1130
+ </dd>
1131
+ </dl>
1132
+ </details>
1133
+
1134
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">cancel_campaign</a>(code:) -> Mailhub::Types::CampaignModel</code></summary>
1135
+ <dl>
1136
+ <dd>
1137
+
1138
+ #### 🔌 Usage
1139
+
1140
+ <dl>
1141
+ <dd>
1142
+
1143
+ <dl>
1144
+ <dd>
1145
+
1146
+ ```ruby
1147
+ client.campaign.cancel_campaign(code: "code")
1148
+ ```
1149
+ </dd>
1150
+ </dl>
1151
+ </dd>
1152
+ </dl>
1153
+
1154
+ #### ⚙️ Parameters
1155
+
1156
+ <dl>
1157
+ <dd>
1158
+
1159
+ <dl>
1160
+ <dd>
1161
+
1162
+ **code:** `String`
1163
+
1164
+ </dd>
1165
+ </dl>
1166
+
1167
+ <dl>
1168
+ <dd>
1169
+
1170
+ **request_options:** `Mailhub::Campaign::RequestOptions`
1171
+
1172
+ </dd>
1173
+ </dl>
1174
+ </dd>
1175
+ </dl>
1176
+
1177
+
1178
+ </dd>
1179
+ </dl>
1180
+ </details>
1181
+
1182
+ <details><summary><code>client.campaign.<a href="/lib/Mailhub/campaign/client.rb">catch_up_campaign</a>(code:) -> Mailhub::Types::CampaignModel</code></summary>
1183
+ <dl>
1184
+ <dd>
1185
+
1186
+ #### 🔌 Usage
1187
+
1188
+ <dl>
1189
+ <dd>
1190
+
1191
+ <dl>
1192
+ <dd>
1193
+
1194
+ ```ruby
1195
+ client.campaign.catch_up_campaign(code: "code")
1196
+ ```
1197
+ </dd>
1198
+ </dl>
1199
+ </dd>
1200
+ </dl>
1201
+
1202
+ #### ⚙️ Parameters
1203
+
1204
+ <dl>
1205
+ <dd>
1206
+
1207
+ <dl>
1208
+ <dd>
1209
+
1210
+ **code:** `String`
1211
+
1212
+ </dd>
1213
+ </dl>
1214
+
1215
+ <dl>
1216
+ <dd>
1217
+
1218
+ **request_options:** `Mailhub::Campaign::RequestOptions`
1219
+
1220
+ </dd>
1221
+ </dl>
1222
+ </dd>
1223
+ </dl>
1224
+
1225
+
1226
+ </dd>
1227
+ </dl>
1228
+ </details>
1229
+
1230
+ ## Contact
1231
+ <details><summary><code>client.contact.<a href="/lib/Mailhub/contact/client.rb">get_contacts</a>() -> Mailhub::Types::ContactModelCursorPagedResult</code></summary>
1232
+ <dl>
1233
+ <dd>
1234
+
1235
+ #### 🔌 Usage
1236
+
1237
+ <dl>
1238
+ <dd>
1239
+
1240
+ <dl>
1241
+ <dd>
1242
+
1243
+ ```ruby
1244
+ client.contact.get_contacts
1245
+ ```
1246
+ </dd>
1247
+ </dl>
1248
+ </dd>
1249
+ </dl>
1250
+
1251
+ #### ⚙️ Parameters
1252
+
1253
+ <dl>
1254
+ <dd>
1255
+
1256
+ <dl>
1257
+ <dd>
1258
+
1259
+ **search:** `String` — 이메일, 이름 등으로 검색할 키워드
1260
+
1261
+ </dd>
1262
+ </dl>
1263
+
1264
+ <dl>
1265
+ <dd>
1266
+
1267
+ **segment_id:** `Integer` — 특정 세그먼트에 속한 연락처만 조회
1268
+
1269
+ </dd>
1270
+ </dl>
1271
+
1272
+ <dl>
1273
+ <dd>
1274
+
1275
+ **sort_by:** `String` — 정렬 기준 필드명
1276
+
1277
+ </dd>
1278
+ </dl>
1279
+
1280
+ <dl>
1281
+ <dd>
1282
+
1283
+ **sort_direction:** `String` — 정렬 방향 (asc, desc)
1284
+
1285
+ </dd>
1286
+ </dl>
1287
+
1288
+ <dl>
1289
+ <dd>
1290
+
1291
+ **page_size:** `Integer` — 페이지 크기 (기본값 10)
1292
+
1293
+ </dd>
1294
+ </dl>
1295
+
1296
+ <dl>
1297
+ <dd>
1298
+
1299
+ **cursor:** `String` — 이전 응답의 NextCursor 값 (비어있으면 첫 페이지)
1300
+
1301
+ </dd>
1302
+ </dl>
1303
+
1304
+ <dl>
1305
+ <dd>
1306
+
1307
+ **request_options:** `Mailhub::Contact::RequestOptions`
1308
+
1309
+ </dd>
1310
+ </dl>
1311
+ </dd>
1312
+ </dl>
1313
+
1314
+
1315
+ </dd>
1316
+ </dl>
1317
+ </details>
1318
+
1319
+ <details><summary><code>client.contact.<a href="/lib/Mailhub/contact/client.rb">create_contact</a>(request) -> Mailhub::Types::ContactModel</code></summary>
1320
+ <dl>
1321
+ <dd>
1322
+
1323
+ #### 🔌 Usage
1324
+
1325
+ <dl>
1326
+ <dd>
1327
+
1328
+ <dl>
1329
+ <dd>
1330
+
1331
+ ```ruby
1332
+ client.contact.create_contact
1333
+ ```
1334
+ </dd>
1335
+ </dl>
1336
+ </dd>
1337
+ </dl>
1338
+
1339
+ #### ⚙️ Parameters
1340
+
1341
+ <dl>
1342
+ <dd>
1343
+
1344
+ <dl>
1345
+ <dd>
1346
+
1347
+ **email:** `String` — 이메일 주소
1348
+
1349
+ </dd>
1350
+ </dl>
1351
+
1352
+ <dl>
1353
+ <dd>
1354
+
1355
+ **name:** `String` — 이름
1356
+
1357
+ </dd>
1358
+ </dl>
1359
+
1360
+ <dl>
1361
+ <dd>
1362
+
1363
+ **fields:** `Internal::Types::Hash[String, Object]` — 커스텀 필드 값 모음
1364
+
1365
+ </dd>
1366
+ </dl>
1367
+
1368
+ <dl>
1369
+ <dd>
1370
+
1371
+ **request_options:** `Mailhub::Contact::RequestOptions`
1372
+
1373
+ </dd>
1374
+ </dl>
1375
+ </dd>
1376
+ </dl>
1377
+
1378
+
1379
+ </dd>
1380
+ </dl>
1381
+ </details>
1382
+
1383
+ <details><summary><code>client.contact.<a href="/lib/Mailhub/contact/client.rb">get_contact</a>(guid:) -> Mailhub::Types::ContactModel</code></summary>
1384
+ <dl>
1385
+ <dd>
1386
+
1387
+ #### 🔌 Usage
1388
+
1389
+ <dl>
1390
+ <dd>
1391
+
1392
+ <dl>
1393
+ <dd>
1394
+
1395
+ ```ruby
1396
+ client.contact.get_contact(guid: "guid")
1397
+ ```
1398
+ </dd>
1399
+ </dl>
1400
+ </dd>
1401
+ </dl>
1402
+
1403
+ #### ⚙️ Parameters
1404
+
1405
+ <dl>
1406
+ <dd>
1407
+
1408
+ <dl>
1409
+ <dd>
1410
+
1411
+ **guid:** `String`
1412
+
1413
+ </dd>
1414
+ </dl>
1415
+
1416
+ <dl>
1417
+ <dd>
1418
+
1419
+ **request_options:** `Mailhub::Contact::RequestOptions`
1420
+
1421
+ </dd>
1422
+ </dl>
1423
+ </dd>
1424
+ </dl>
1425
+
1426
+
1427
+ </dd>
1428
+ </dl>
1429
+ </details>
1430
+
1431
+ <details><summary><code>client.contact.<a href="/lib/Mailhub/contact/client.rb">update_contact</a>(guid:, request) -> Mailhub::Types::ContactModel</code></summary>
1432
+ <dl>
1433
+ <dd>
1434
+
1435
+ #### 🔌 Usage
1436
+
1437
+ <dl>
1438
+ <dd>
1439
+
1440
+ <dl>
1441
+ <dd>
1442
+
1443
+ ```ruby
1444
+ client.contact.update_contact(guid: "guid")
1445
+ ```
1446
+ </dd>
1447
+ </dl>
1448
+ </dd>
1449
+ </dl>
1450
+
1451
+ #### ⚙️ Parameters
1452
+
1453
+ <dl>
1454
+ <dd>
1455
+
1456
+ <dl>
1457
+ <dd>
1458
+
1459
+ **guid:** `String`
1460
+
1461
+ </dd>
1462
+ </dl>
1463
+
1464
+ <dl>
1465
+ <dd>
1466
+
1467
+ **email:** `String` — 이메일 주소
1468
+
1469
+ </dd>
1470
+ </dl>
1471
+
1472
+ <dl>
1473
+ <dd>
1474
+
1475
+ **name:** `String` — 이름
1476
+
1477
+ </dd>
1478
+ </dl>
1479
+
1480
+ <dl>
1481
+ <dd>
1482
+
1483
+ **fields:** `Internal::Types::Hash[String, Object]` — 커스텀 필드 값 모음
1484
+
1485
+ </dd>
1486
+ </dl>
1487
+
1488
+ <dl>
1489
+ <dd>
1490
+
1491
+ **request_options:** `Mailhub::Contact::RequestOptions`
1492
+
1493
+ </dd>
1494
+ </dl>
1495
+ </dd>
1496
+ </dl>
1497
+
1498
+
1499
+ </dd>
1500
+ </dl>
1501
+ </details>
1502
+
1503
+ <details><summary><code>client.contact.<a href="/lib/Mailhub/contact/client.rb">delete_contact</a>(guid:) -> </code></summary>
1504
+ <dl>
1505
+ <dd>
1506
+
1507
+ #### 🔌 Usage
1508
+
1509
+ <dl>
1510
+ <dd>
1511
+
1512
+ <dl>
1513
+ <dd>
1514
+
1515
+ ```ruby
1516
+ client.contact.delete_contact(guid: "guid")
1517
+ ```
1518
+ </dd>
1519
+ </dl>
1520
+ </dd>
1521
+ </dl>
1522
+
1523
+ #### ⚙️ Parameters
1524
+
1525
+ <dl>
1526
+ <dd>
1527
+
1528
+ <dl>
1529
+ <dd>
1530
+
1531
+ **guid:** `String`
1532
+
1533
+ </dd>
1534
+ </dl>
1535
+
1536
+ <dl>
1537
+ <dd>
1538
+
1539
+ **request_options:** `Mailhub::Contact::RequestOptions`
1540
+
1541
+ </dd>
1542
+ </dl>
1543
+ </dd>
1544
+ </dl>
1545
+
1546
+
1547
+ </dd>
1548
+ </dl>
1549
+ </details>
1550
+
1551
+ <details><summary><code>client.contact.<a href="/lib/Mailhub/contact/client.rb">block_contact</a>(guid:) -> </code></summary>
1552
+ <dl>
1553
+ <dd>
1554
+
1555
+ #### 🔌 Usage
1556
+
1557
+ <dl>
1558
+ <dd>
1559
+
1560
+ <dl>
1561
+ <dd>
1562
+
1563
+ ```ruby
1564
+ client.contact.block_contact(guid: "guid")
1565
+ ```
1566
+ </dd>
1567
+ </dl>
1568
+ </dd>
1569
+ </dl>
1570
+
1571
+ #### ⚙️ Parameters
1572
+
1573
+ <dl>
1574
+ <dd>
1575
+
1576
+ <dl>
1577
+ <dd>
1578
+
1579
+ **guid:** `String`
1580
+
1581
+ </dd>
1582
+ </dl>
1583
+
1584
+ <dl>
1585
+ <dd>
1586
+
1587
+ **request_options:** `Mailhub::Contact::RequestOptions`
1588
+
1589
+ </dd>
1590
+ </dl>
1591
+ </dd>
1592
+ </dl>
1593
+
1594
+
1595
+ </dd>
1596
+ </dl>
1597
+ </details>
1598
+
1599
+ <details><summary><code>client.contact.<a href="/lib/Mailhub/contact/client.rb">block_contacts</a>(request) -> </code></summary>
1600
+ <dl>
1601
+ <dd>
1602
+
1603
+ #### 🔌 Usage
1604
+
1605
+ <dl>
1606
+ <dd>
1607
+
1608
+ <dl>
1609
+ <dd>
1610
+
1611
+ ```ruby
1612
+ client.contact.block_contacts
1613
+ ```
1614
+ </dd>
1615
+ </dl>
1616
+ </dd>
1617
+ </dl>
1618
+
1619
+ #### ⚙️ Parameters
1620
+
1621
+ <dl>
1622
+ <dd>
1623
+
1624
+ <dl>
1625
+ <dd>
1626
+
1627
+ **guids:** `Internal::Types::Array[String]` — 차단할 연락처 GUID 목록
1628
+
1629
+ </dd>
1630
+ </dl>
1631
+
1632
+ <dl>
1633
+ <dd>
1634
+
1635
+ **request_options:** `Mailhub::Contact::RequestOptions`
1636
+
1637
+ </dd>
1638
+ </dl>
1639
+ </dd>
1640
+ </dl>
1641
+
1642
+
1643
+ </dd>
1644
+ </dl>
1645
+ </details>
1646
+
1647
+ <details><summary><code>client.contact.<a href="/lib/Mailhub/contact/client.rb">delete_contacts</a>(request) -> </code></summary>
1648
+ <dl>
1649
+ <dd>
1650
+
1651
+ #### 🔌 Usage
1652
+
1653
+ <dl>
1654
+ <dd>
1655
+
1656
+ <dl>
1657
+ <dd>
1658
+
1659
+ ```ruby
1660
+ client.contact.delete_contacts
1661
+ ```
1662
+ </dd>
1663
+ </dl>
1664
+ </dd>
1665
+ </dl>
1666
+
1667
+ #### ⚙️ Parameters
1668
+
1669
+ <dl>
1670
+ <dd>
1671
+
1672
+ <dl>
1673
+ <dd>
1674
+
1675
+ **guids:** `Internal::Types::Array[String]` — 삭제할 연락처 GUID 목록
1676
+
1677
+ </dd>
1678
+ </dl>
1679
+
1680
+ <dl>
1681
+ <dd>
1682
+
1683
+ **request_options:** `Mailhub::Contact::RequestOptions`
1684
+
1685
+ </dd>
1686
+ </dl>
1687
+ </dd>
1688
+ </dl>
1689
+
1690
+
1691
+ </dd>
1692
+ </dl>
1693
+ </details>
1694
+
1695
+ <details><summary><code>client.contact.<a href="/lib/Mailhub/contact/client.rb">import_contacts</a>(request) -> Mailhub::Types::ContactImportModel</code></summary>
1696
+ <dl>
1697
+ <dd>
1698
+
1699
+ #### 🔌 Usage
1700
+
1701
+ <dl>
1702
+ <dd>
1703
+
1704
+ <dl>
1705
+ <dd>
1706
+
1707
+ ```ruby
1708
+ client.contact.import_contacts
1709
+ ```
1710
+ </dd>
1711
+ </dl>
1712
+ </dd>
1713
+ </dl>
1714
+
1715
+ #### ⚙️ Parameters
1716
+
1717
+ <dl>
1718
+ <dd>
1719
+
1720
+ <dl>
1721
+ <dd>
1722
+
1723
+ **request_options:** `Mailhub::Contact::RequestOptions`
1724
+
1725
+ </dd>
1726
+ </dl>
1727
+ </dd>
1728
+ </dl>
1729
+
1730
+
1731
+ </dd>
1732
+ </dl>
1733
+ </details>
1734
+
1735
+ <details><summary><code>client.contact.<a href="/lib/Mailhub/contact/client.rb">get_import_job</a>(job_id:) -> Mailhub::Types::ContactImportJobModel</code></summary>
1736
+ <dl>
1737
+ <dd>
1738
+
1739
+ #### 🔌 Usage
1740
+
1741
+ <dl>
1742
+ <dd>
1743
+
1744
+ <dl>
1745
+ <dd>
1746
+
1747
+ ```ruby
1748
+ client.contact.get_import_job(job_id: "jobId")
1749
+ ```
1750
+ </dd>
1751
+ </dl>
1752
+ </dd>
1753
+ </dl>
1754
+
1755
+ #### ⚙️ Parameters
1756
+
1757
+ <dl>
1758
+ <dd>
1759
+
1760
+ <dl>
1761
+ <dd>
1762
+
1763
+ **job_id:** `String`
1764
+
1765
+ </dd>
1766
+ </dl>
1767
+
1768
+ <dl>
1769
+ <dd>
1770
+
1771
+ **request_options:** `Mailhub::Contact::RequestOptions`
1772
+
1773
+ </dd>
1774
+ </dl>
1775
+ </dd>
1776
+ </dl>
1777
+
1778
+
1779
+ </dd>
1780
+ </dl>
1781
+ </details>
1782
+
1783
+ ## CustomField
1784
+ <details><summary><code>client.custom_field.<a href="/lib/Mailhub/custom_field/client.rb">get_custom_fields</a>() -> Internal::Types::Array[Mailhub::Types::CustomFieldModel]</code></summary>
1785
+ <dl>
1786
+ <dd>
1787
+
1788
+ #### 🔌 Usage
1789
+
1790
+ <dl>
1791
+ <dd>
1792
+
1793
+ <dl>
1794
+ <dd>
1795
+
1796
+ ```ruby
1797
+ client.custom_field.get_custom_fields
1798
+ ```
1799
+ </dd>
1800
+ </dl>
1801
+ </dd>
1802
+ </dl>
1803
+
1804
+ #### ⚙️ Parameters
1805
+
1806
+ <dl>
1807
+ <dd>
1808
+
1809
+ <dl>
1810
+ <dd>
1811
+
1812
+ **request_options:** `Mailhub::CustomField::RequestOptions`
1813
+
1814
+ </dd>
1815
+ </dl>
1816
+ </dd>
1817
+ </dl>
1818
+
1819
+
1820
+ </dd>
1821
+ </dl>
1822
+ </details>
1823
+
1824
+ <details><summary><code>client.custom_field.<a href="/lib/Mailhub/custom_field/client.rb">create_custom_field</a>(request) -> Mailhub::Types::CustomFieldModel</code></summary>
1825
+ <dl>
1826
+ <dd>
1827
+
1828
+ #### 🔌 Usage
1829
+
1830
+ <dl>
1831
+ <dd>
1832
+
1833
+ <dl>
1834
+ <dd>
1835
+
1836
+ ```ruby
1837
+ client.custom_field.create_custom_field
1838
+ ```
1839
+ </dd>
1840
+ </dl>
1841
+ </dd>
1842
+ </dl>
1843
+
1844
+ #### ⚙️ Parameters
1845
+
1846
+ <dl>
1847
+ <dd>
1848
+
1849
+ <dl>
1850
+ <dd>
1851
+
1852
+ **key:** `String` — 필드 키
1853
+
1854
+ </dd>
1855
+ </dl>
1856
+
1857
+ <dl>
1858
+ <dd>
1859
+
1860
+ **name:** `String` — 필드 이름
1861
+
1862
+ </dd>
1863
+ </dl>
1864
+
1865
+ <dl>
1866
+ <dd>
1867
+
1868
+ **type:** `Mailhub::Types::CustomFieldType`
1869
+
1870
+ </dd>
1871
+ </dl>
1872
+
1873
+ <dl>
1874
+ <dd>
1875
+
1876
+ **request_options:** `Mailhub::CustomField::RequestOptions`
1877
+
1878
+ </dd>
1879
+ </dl>
1880
+ </dd>
1881
+ </dl>
1882
+
1883
+
1884
+ </dd>
1885
+ </dl>
1886
+ </details>
1887
+
1888
+ <details><summary><code>client.custom_field.<a href="/lib/Mailhub/custom_field/client.rb">get_custom_field</a>(key:) -> Mailhub::Types::CustomFieldModel</code></summary>
1889
+ <dl>
1890
+ <dd>
1891
+
1892
+ #### 🔌 Usage
1893
+
1894
+ <dl>
1895
+ <dd>
1896
+
1897
+ <dl>
1898
+ <dd>
1899
+
1900
+ ```ruby
1901
+ client.custom_field.get_custom_field(key: "key")
1902
+ ```
1903
+ </dd>
1904
+ </dl>
1905
+ </dd>
1906
+ </dl>
1907
+
1908
+ #### ⚙️ Parameters
1909
+
1910
+ <dl>
1911
+ <dd>
1912
+
1913
+ <dl>
1914
+ <dd>
1915
+
1916
+ **key:** `String`
1917
+
1918
+ </dd>
1919
+ </dl>
1920
+
1921
+ <dl>
1922
+ <dd>
1923
+
1924
+ **request_options:** `Mailhub::CustomField::RequestOptions`
1925
+
1926
+ </dd>
1927
+ </dl>
1928
+ </dd>
1929
+ </dl>
1930
+
1931
+
1932
+ </dd>
1933
+ </dl>
1934
+ </details>
1935
+
1936
+ <details><summary><code>client.custom_field.<a href="/lib/Mailhub/custom_field/client.rb">update_custom_field</a>(key:, request) -> Mailhub::Types::CustomFieldModel</code></summary>
1937
+ <dl>
1938
+ <dd>
1939
+
1940
+ #### 🔌 Usage
1941
+
1942
+ <dl>
1943
+ <dd>
1944
+
1945
+ <dl>
1946
+ <dd>
1947
+
1948
+ ```ruby
1949
+ client.custom_field.update_custom_field(key: "key")
1950
+ ```
1951
+ </dd>
1952
+ </dl>
1953
+ </dd>
1954
+ </dl>
1955
+
1956
+ #### ⚙️ Parameters
1957
+
1958
+ <dl>
1959
+ <dd>
1960
+
1961
+ <dl>
1962
+ <dd>
1963
+
1964
+ **key:** `String`
1965
+
1966
+ </dd>
1967
+ </dl>
1968
+
1969
+ <dl>
1970
+ <dd>
1971
+
1972
+ **name:** `String` — 필드 이름
1973
+
1974
+ </dd>
1975
+ </dl>
1976
+
1977
+ <dl>
1978
+ <dd>
1979
+
1980
+ **type:** `Mailhub::Types::CustomFieldType`
1981
+
1982
+ </dd>
1983
+ </dl>
1984
+
1985
+ <dl>
1986
+ <dd>
1987
+
1988
+ **request_options:** `Mailhub::CustomField::RequestOptions`
1989
+
1990
+ </dd>
1991
+ </dl>
1992
+ </dd>
1993
+ </dl>
1994
+
1995
+
1996
+ </dd>
1997
+ </dl>
1998
+ </details>
1999
+
2000
+ <details><summary><code>client.custom_field.<a href="/lib/Mailhub/custom_field/client.rb">delete_custom_field</a>(key:) -> </code></summary>
2001
+ <dl>
2002
+ <dd>
2003
+
2004
+ #### 🔌 Usage
2005
+
2006
+ <dl>
2007
+ <dd>
2008
+
2009
+ <dl>
2010
+ <dd>
2011
+
2012
+ ```ruby
2013
+ client.custom_field.delete_custom_field(key: "key")
2014
+ ```
2015
+ </dd>
2016
+ </dl>
2017
+ </dd>
2018
+ </dl>
2019
+
2020
+ #### ⚙️ Parameters
2021
+
2022
+ <dl>
2023
+ <dd>
2024
+
2025
+ <dl>
2026
+ <dd>
2027
+
2028
+ **key:** `String`
2029
+
2030
+ </dd>
2031
+ </dl>
2032
+
2033
+ <dl>
2034
+ <dd>
2035
+
2036
+ **request_options:** `Mailhub::CustomField::RequestOptions`
2037
+
2038
+ </dd>
2039
+ </dl>
2040
+ </dd>
2041
+ </dl>
2042
+
2043
+
2044
+ </dd>
2045
+ </dl>
2046
+ </details>
2047
+
2048
+ ## Media
2049
+ <details><summary><code>client.media.<a href="/lib/Mailhub/media/client.rb">get_medias</a>() -> Mailhub::Types::MediaModelPagedResult</code></summary>
2050
+ <dl>
2051
+ <dd>
2052
+
2053
+ #### 🔌 Usage
2054
+
2055
+ <dl>
2056
+ <dd>
2057
+
2058
+ <dl>
2059
+ <dd>
2060
+
2061
+ ```ruby
2062
+ client.media.get_medias
2063
+ ```
2064
+ </dd>
2065
+ </dl>
2066
+ </dd>
2067
+ </dl>
2068
+
2069
+ #### ⚙️ Parameters
2070
+
2071
+ <dl>
2072
+ <dd>
2073
+
2074
+ <dl>
2075
+ <dd>
2076
+
2077
+ **search:** `String` — 파일명 등으로 검색할 키워드
2078
+
2079
+ </dd>
2080
+ </dl>
2081
+
2082
+ <dl>
2083
+ <dd>
2084
+
2085
+ **sort_by:** `String` — 정렬 기준 필드명
2086
+
2087
+ </dd>
2088
+ </dl>
2089
+
2090
+ <dl>
2091
+ <dd>
2092
+
2093
+ **sort_direction:** `String` — 정렬 방향 (asc, desc)
2094
+
2095
+ </dd>
2096
+ </dl>
2097
+
2098
+ <dl>
2099
+ <dd>
2100
+
2101
+ **page_size:** `Integer` — 페이지 크기 (기본값 10)
2102
+
2103
+ </dd>
2104
+ </dl>
2105
+
2106
+ <dl>
2107
+ <dd>
2108
+
2109
+ **page_index:** `Integer` — 페이지 번호 (1부터 시작, 기본값 1)
2110
+
2111
+ </dd>
2112
+ </dl>
2113
+
2114
+ <dl>
2115
+ <dd>
2116
+
2117
+ **request_options:** `Mailhub::Media::RequestOptions`
2118
+
2119
+ </dd>
2120
+ </dl>
2121
+ </dd>
2122
+ </dl>
2123
+
2124
+
2125
+ </dd>
2126
+ </dl>
2127
+ </details>
2128
+
2129
+ <details><summary><code>client.media.<a href="/lib/Mailhub/media/client.rb">upload_media</a>(request) -> Mailhub::Types::MediaModel</code></summary>
2130
+ <dl>
2131
+ <dd>
2132
+
2133
+ #### 🔌 Usage
2134
+
2135
+ <dl>
2136
+ <dd>
2137
+
2138
+ <dl>
2139
+ <dd>
2140
+
2141
+ ```ruby
2142
+ client.media.upload_media
2143
+ ```
2144
+ </dd>
2145
+ </dl>
2146
+ </dd>
2147
+ </dl>
2148
+
2149
+ #### ⚙️ Parameters
2150
+
2151
+ <dl>
2152
+ <dd>
2153
+
2154
+ <dl>
2155
+ <dd>
2156
+
2157
+ **request_options:** `Mailhub::Media::RequestOptions`
2158
+
2159
+ </dd>
2160
+ </dl>
2161
+ </dd>
2162
+ </dl>
2163
+
2164
+
2165
+ </dd>
2166
+ </dl>
2167
+ </details>
2168
+
2169
+ <details><summary><code>client.media.<a href="/lib/Mailhub/media/client.rb">get_media</a>(code:) -> Mailhub::Types::MediaModel</code></summary>
2170
+ <dl>
2171
+ <dd>
2172
+
2173
+ #### 🔌 Usage
2174
+
2175
+ <dl>
2176
+ <dd>
2177
+
2178
+ <dl>
2179
+ <dd>
2180
+
2181
+ ```ruby
2182
+ client.media.get_media(code: "code")
2183
+ ```
2184
+ </dd>
2185
+ </dl>
2186
+ </dd>
2187
+ </dl>
2188
+
2189
+ #### ⚙️ Parameters
2190
+
2191
+ <dl>
2192
+ <dd>
2193
+
2194
+ <dl>
2195
+ <dd>
2196
+
2197
+ **code:** `String`
2198
+
2199
+ </dd>
2200
+ </dl>
2201
+
2202
+ <dl>
2203
+ <dd>
2204
+
2205
+ **request_options:** `Mailhub::Media::RequestOptions`
2206
+
2207
+ </dd>
2208
+ </dl>
2209
+ </dd>
2210
+ </dl>
2211
+
2212
+
2213
+ </dd>
2214
+ </dl>
2215
+ </details>
2216
+
2217
+ <details><summary><code>client.media.<a href="/lib/Mailhub/media/client.rb">update_media</a>(code:, request) -> Mailhub::Types::MediaModel</code></summary>
2218
+ <dl>
2219
+ <dd>
2220
+
2221
+ #### 🔌 Usage
2222
+
2223
+ <dl>
2224
+ <dd>
2225
+
2226
+ <dl>
2227
+ <dd>
2228
+
2229
+ ```ruby
2230
+ client.media.update_media(code: "code")
2231
+ ```
2232
+ </dd>
2233
+ </dl>
2234
+ </dd>
2235
+ </dl>
2236
+
2237
+ #### ⚙️ Parameters
2238
+
2239
+ <dl>
2240
+ <dd>
2241
+
2242
+ <dl>
2243
+ <dd>
2244
+
2245
+ **code:** `String`
2246
+
2247
+ </dd>
2248
+ </dl>
2249
+
2250
+ <dl>
2251
+ <dd>
2252
+
2253
+ **original_file_name:** `String` — 파일명
2254
+
2255
+ </dd>
2256
+ </dl>
2257
+
2258
+ <dl>
2259
+ <dd>
2260
+
2261
+ **request_options:** `Mailhub::Media::RequestOptions`
2262
+
2263
+ </dd>
2264
+ </dl>
2265
+ </dd>
2266
+ </dl>
2267
+
2268
+
2269
+ </dd>
2270
+ </dl>
2271
+ </details>
2272
+
2273
+ <details><summary><code>client.media.<a href="/lib/Mailhub/media/client.rb">delete_media</a>(code:) -> </code></summary>
2274
+ <dl>
2275
+ <dd>
2276
+
2277
+ #### 🔌 Usage
2278
+
2279
+ <dl>
2280
+ <dd>
2281
+
2282
+ <dl>
2283
+ <dd>
2284
+
2285
+ ```ruby
2286
+ client.media.delete_media(code: "code")
2287
+ ```
2288
+ </dd>
2289
+ </dl>
2290
+ </dd>
2291
+ </dl>
2292
+
2293
+ #### ⚙️ Parameters
2294
+
2295
+ <dl>
2296
+ <dd>
2297
+
2298
+ <dl>
2299
+ <dd>
2300
+
2301
+ **code:** `String`
2302
+
2303
+ </dd>
2304
+ </dl>
2305
+
2306
+ <dl>
2307
+ <dd>
2308
+
2309
+ **request_options:** `Mailhub::Media::RequestOptions`
2310
+
2311
+ </dd>
2312
+ </dl>
2313
+ </dd>
2314
+ </dl>
2315
+
2316
+
2317
+ </dd>
2318
+ </dl>
2319
+ </details>
2320
+
2321
+ <details><summary><code>client.media.<a href="/lib/Mailhub/media/client.rb">download_media</a>(code:) -> </code></summary>
2322
+ <dl>
2323
+ <dd>
2324
+
2325
+ #### 🔌 Usage
2326
+
2327
+ <dl>
2328
+ <dd>
2329
+
2330
+ <dl>
2331
+ <dd>
2332
+
2333
+ ```ruby
2334
+ client.media.download_media(code: "code")
2335
+ ```
2336
+ </dd>
2337
+ </dl>
2338
+ </dd>
2339
+ </dl>
2340
+
2341
+ #### ⚙️ Parameters
2342
+
2343
+ <dl>
2344
+ <dd>
2345
+
2346
+ <dl>
2347
+ <dd>
2348
+
2349
+ **code:** `String`
2350
+
2351
+ </dd>
2352
+ </dl>
2353
+
2354
+ <dl>
2355
+ <dd>
2356
+
2357
+ **request_options:** `Mailhub::Media::RequestOptions`
2358
+
2359
+ </dd>
2360
+ </dl>
2361
+ </dd>
2362
+ </dl>
2363
+
2364
+
2365
+ </dd>
2366
+ </dl>
2367
+ </details>
2368
+
2369
+ ## Message
2370
+ <details><summary><code>client.message.<a href="/lib/Mailhub/message/client.rb">get_messages</a>() -> Mailhub::Types::MessageModelCursorPagedResult</code></summary>
2371
+ <dl>
2372
+ <dd>
2373
+
2374
+ #### 🔌 Usage
2375
+
2376
+ <dl>
2377
+ <dd>
2378
+
2379
+ <dl>
2380
+ <dd>
2381
+
2382
+ ```ruby
2383
+ client.message.get_messages
2384
+ ```
2385
+ </dd>
2386
+ </dl>
2387
+ </dd>
2388
+ </dl>
2389
+
2390
+ #### ⚙️ Parameters
2391
+
2392
+ <dl>
2393
+ <dd>
2394
+
2395
+ <dl>
2396
+ <dd>
2397
+
2398
+ **search:** `String` — 수신 이메일, 제목 등으로 검색할 키워드
2399
+
2400
+ </dd>
2401
+ </dl>
2402
+
2403
+ <dl>
2404
+ <dd>
2405
+
2406
+ **status:** `String` — 발송 상태 필터
2407
+
2408
+ </dd>
2409
+ </dl>
2410
+
2411
+ <dl>
2412
+ <dd>
2413
+
2414
+ **sort_by:** `String` — 정렬 기준 필드명
2415
+
2416
+ </dd>
2417
+ </dl>
2418
+
2419
+ <dl>
2420
+ <dd>
2421
+
2422
+ **sort_direction:** `String` — 정렬 방향 (asc, desc)
2423
+
2424
+ </dd>
2425
+ </dl>
2426
+
2427
+ <dl>
2428
+ <dd>
2429
+
2430
+ **page_size:** `Integer` — 페이지 크기 (기본값 10)
2431
+
2432
+ </dd>
2433
+ </dl>
2434
+
2435
+ <dl>
2436
+ <dd>
2437
+
2438
+ **cursor:** `String` — 이전 응답의 NextCursor 값 (비어있으면 첫 페이지)
2439
+
2440
+ </dd>
2441
+ </dl>
2442
+
2443
+ <dl>
2444
+ <dd>
2445
+
2446
+ **request_options:** `Mailhub::Message::RequestOptions`
2447
+
2448
+ </dd>
2449
+ </dl>
2450
+ </dd>
2451
+ </dl>
2452
+
2453
+
2454
+ </dd>
2455
+ </dl>
2456
+ </details>
2457
+
2458
+ <details><summary><code>client.message.<a href="/lib/Mailhub/message/client.rb">get_message</a>(guid:) -> Mailhub::Types::MessageModel</code></summary>
2459
+ <dl>
2460
+ <dd>
2461
+
2462
+ #### 🔌 Usage
2463
+
2464
+ <dl>
2465
+ <dd>
2466
+
2467
+ <dl>
2468
+ <dd>
2469
+
2470
+ ```ruby
2471
+ client.message.get_message(guid: "guid")
2472
+ ```
2473
+ </dd>
2474
+ </dl>
2475
+ </dd>
2476
+ </dl>
2477
+
2478
+ #### ⚙️ Parameters
2479
+
2480
+ <dl>
2481
+ <dd>
2482
+
2483
+ <dl>
2484
+ <dd>
2485
+
2486
+ **guid:** `String`
2487
+
2488
+ </dd>
2489
+ </dl>
2490
+
2491
+ <dl>
2492
+ <dd>
2493
+
2494
+ **request_options:** `Mailhub::Message::RequestOptions`
2495
+
2496
+ </dd>
2497
+ </dl>
2498
+ </dd>
2499
+ </dl>
2500
+
2501
+
2502
+ </dd>
2503
+ </dl>
2504
+ </details>
2505
+
2506
+ <details><summary><code>client.message.<a href="/lib/Mailhub/message/client.rb">get_message_events</a>(guid:) -> Internal::Types::Array[Mailhub::Types::MessageEventModel]</code></summary>
2507
+ <dl>
2508
+ <dd>
2509
+
2510
+ #### 🔌 Usage
2511
+
2512
+ <dl>
2513
+ <dd>
2514
+
2515
+ <dl>
2516
+ <dd>
2517
+
2518
+ ```ruby
2519
+ client.message.get_message_events(guid: "guid")
2520
+ ```
2521
+ </dd>
2522
+ </dl>
2523
+ </dd>
2524
+ </dl>
2525
+
2526
+ #### ⚙️ Parameters
2527
+
2528
+ <dl>
2529
+ <dd>
2530
+
2531
+ <dl>
2532
+ <dd>
2533
+
2534
+ **guid:** `String`
2535
+
2536
+ </dd>
2537
+ </dl>
2538
+
2539
+ <dl>
2540
+ <dd>
2541
+
2542
+ **request_options:** `Mailhub::Message::RequestOptions`
2543
+
2544
+ </dd>
2545
+ </dl>
2546
+ </dd>
2547
+ </dl>
2548
+
2549
+
2550
+ </dd>
2551
+ </dl>
2552
+ </details>
2553
+
2554
+ <details><summary><code>client.message.<a href="/lib/Mailhub/message/client.rb">send_message</a>(request) -> Mailhub::Types::MessageModel</code></summary>
2555
+ <dl>
2556
+ <dd>
2557
+
2558
+ #### 🔌 Usage
2559
+
2560
+ <dl>
2561
+ <dd>
2562
+
2563
+ <dl>
2564
+ <dd>
2565
+
2566
+ ```ruby
2567
+ client.message.send_message
2568
+ ```
2569
+ </dd>
2570
+ </dl>
2571
+ </dd>
2572
+ </dl>
2573
+
2574
+ #### ⚙️ Parameters
2575
+
2576
+ <dl>
2577
+ <dd>
2578
+
2579
+ <dl>
2580
+ <dd>
2581
+
2582
+ **to_email:** `String` — 수신 이메일 주소
2583
+
2584
+ </dd>
2585
+ </dl>
2586
+
2587
+ <dl>
2588
+ <dd>
2589
+
2590
+ **from_email:** `String` — 발신 이메일 주소
2591
+
2592
+ </dd>
2593
+ </dl>
2594
+
2595
+ <dl>
2596
+ <dd>
2597
+
2598
+ **subject:** `String` — 메일 제목
2599
+
2600
+ </dd>
2601
+ </dl>
2602
+
2603
+ <dl>
2604
+ <dd>
2605
+
2606
+ **body:** `String` — 원본 HTML 본문 (templateCode 미지정 시 사용)
2607
+
2608
+ </dd>
2609
+ </dl>
2610
+
2611
+ <dl>
2612
+ <dd>
2613
+
2614
+ **template_code:** `String` — 사용할 템플릿 코드 (지정 시 body는 무시됨)
2615
+
2616
+ </dd>
2617
+ </dl>
2618
+
2619
+ <dl>
2620
+ <dd>
2621
+
2622
+ **template_data:** `Internal::Types::Hash[String, Object]` — 템플릿/본문 내 {{ key }} 치환에 사용할 데이터
2623
+
2624
+ </dd>
2625
+ </dl>
2626
+
2627
+ <dl>
2628
+ <dd>
2629
+
2630
+ **send_at:** `String` — 예약 발송 일시 (미지정 시 즉시 발송)
2631
+
2632
+ </dd>
2633
+ </dl>
2634
+
2635
+ <dl>
2636
+ <dd>
2637
+
2638
+ **request_options:** `Mailhub::Message::RequestOptions`
2639
+
2640
+ </dd>
2641
+ </dl>
2642
+ </dd>
2643
+ </dl>
2644
+
2645
+
2646
+ </dd>
2647
+ </dl>
2648
+ </details>
2649
+
2650
+ <details><summary><code>client.message.<a href="/lib/Mailhub/message/client.rb">cancel_message</a>(guid:) -> Mailhub::Types::MessageModel</code></summary>
2651
+ <dl>
2652
+ <dd>
2653
+
2654
+ #### 🔌 Usage
2655
+
2656
+ <dl>
2657
+ <dd>
2658
+
2659
+ <dl>
2660
+ <dd>
2661
+
2662
+ ```ruby
2663
+ client.message.cancel_message(guid: "guid")
2664
+ ```
2665
+ </dd>
2666
+ </dl>
2667
+ </dd>
2668
+ </dl>
2669
+
2670
+ #### ⚙️ Parameters
2671
+
2672
+ <dl>
2673
+ <dd>
2674
+
2675
+ <dl>
2676
+ <dd>
2677
+
2678
+ **guid:** `String`
2679
+
2680
+ </dd>
2681
+ </dl>
2682
+
2683
+ <dl>
2684
+ <dd>
2685
+
2686
+ **request_options:** `Mailhub::Message::RequestOptions`
2687
+
2688
+ </dd>
2689
+ </dl>
2690
+ </dd>
2691
+ </dl>
2692
+
2693
+
2694
+ </dd>
2695
+ </dl>
2696
+ </details>
2697
+
2698
+ ## Segment
2699
+ <details><summary><code>client.segment.<a href="/lib/Mailhub/segment/client.rb">get_segments</a>() -> Mailhub::Types::SegmentModelPagedResult</code></summary>
2700
+ <dl>
2701
+ <dd>
2702
+
2703
+ #### 🔌 Usage
2704
+
2705
+ <dl>
2706
+ <dd>
2707
+
2708
+ <dl>
2709
+ <dd>
2710
+
2711
+ ```ruby
2712
+ client.segment.get_segments
2713
+ ```
2714
+ </dd>
2715
+ </dl>
2716
+ </dd>
2717
+ </dl>
2718
+
2719
+ #### ⚙️ Parameters
2720
+
2721
+ <dl>
2722
+ <dd>
2723
+
2724
+ <dl>
2725
+ <dd>
2726
+
2727
+ **search:** `String` — 이름 등으로 검색할 키워드
2728
+
2729
+ </dd>
2730
+ </dl>
2731
+
2732
+ <dl>
2733
+ <dd>
2734
+
2735
+ **sort_by:** `String` — 정렬 기준 필드명
2736
+
2737
+ </dd>
2738
+ </dl>
2739
+
2740
+ <dl>
2741
+ <dd>
2742
+
2743
+ **sort_direction:** `String` — 정렬 방향 (asc, desc)
2744
+
2745
+ </dd>
2746
+ </dl>
2747
+
2748
+ <dl>
2749
+ <dd>
2750
+
2751
+ **page_size:** `Integer` — 페이지 크기 (기본값 10)
2752
+
2753
+ </dd>
2754
+ </dl>
2755
+
2756
+ <dl>
2757
+ <dd>
2758
+
2759
+ **page_index:** `Integer` — 페이지 번호 (1부터 시작, 기본값 1)
2760
+
2761
+ </dd>
2762
+ </dl>
2763
+
2764
+ <dl>
2765
+ <dd>
2766
+
2767
+ **request_options:** `Mailhub::Segment::RequestOptions`
2768
+
2769
+ </dd>
2770
+ </dl>
2771
+ </dd>
2772
+ </dl>
2773
+
2774
+
2775
+ </dd>
2776
+ </dl>
2777
+ </details>
2778
+
2779
+ <details><summary><code>client.segment.<a href="/lib/Mailhub/segment/client.rb">create_segment</a>(request) -> Mailhub::Types::SegmentModel</code></summary>
2780
+ <dl>
2781
+ <dd>
2782
+
2783
+ #### 🔌 Usage
2784
+
2785
+ <dl>
2786
+ <dd>
2787
+
2788
+ <dl>
2789
+ <dd>
2790
+
2791
+ ```ruby
2792
+ client.segment.create_segment
2793
+ ```
2794
+ </dd>
2795
+ </dl>
2796
+ </dd>
2797
+ </dl>
2798
+
2799
+ #### ⚙️ Parameters
2800
+
2801
+ <dl>
2802
+ <dd>
2803
+
2804
+ <dl>
2805
+ <dd>
2806
+
2807
+ **name:** `String` — 세그먼트 이름
2808
+
2809
+ </dd>
2810
+ </dl>
2811
+
2812
+ <dl>
2813
+ <dd>
2814
+
2815
+ **filter:** `Mailhub::Types::SegmentFilterModel`
2816
+
2817
+ </dd>
2818
+ </dl>
2819
+
2820
+ <dl>
2821
+ <dd>
2822
+
2823
+ **request_options:** `Mailhub::Segment::RequestOptions`
2824
+
2825
+ </dd>
2826
+ </dl>
2827
+ </dd>
2828
+ </dl>
2829
+
2830
+
2831
+ </dd>
2832
+ </dl>
2833
+ </details>
2834
+
2835
+ <details><summary><code>client.segment.<a href="/lib/Mailhub/segment/client.rb">get_segment</a>(code:) -> Mailhub::Types::SegmentModel</code></summary>
2836
+ <dl>
2837
+ <dd>
2838
+
2839
+ #### 🔌 Usage
2840
+
2841
+ <dl>
2842
+ <dd>
2843
+
2844
+ <dl>
2845
+ <dd>
2846
+
2847
+ ```ruby
2848
+ client.segment.get_segment(code: "code")
2849
+ ```
2850
+ </dd>
2851
+ </dl>
2852
+ </dd>
2853
+ </dl>
2854
+
2855
+ #### ⚙️ Parameters
2856
+
2857
+ <dl>
2858
+ <dd>
2859
+
2860
+ <dl>
2861
+ <dd>
2862
+
2863
+ **code:** `String`
2864
+
2865
+ </dd>
2866
+ </dl>
2867
+
2868
+ <dl>
2869
+ <dd>
2870
+
2871
+ **request_options:** `Mailhub::Segment::RequestOptions`
2872
+
2873
+ </dd>
2874
+ </dl>
2875
+ </dd>
2876
+ </dl>
2877
+
2878
+
2879
+ </dd>
2880
+ </dl>
2881
+ </details>
2882
+
2883
+ <details><summary><code>client.segment.<a href="/lib/Mailhub/segment/client.rb">update_segment</a>(code:, request) -> Mailhub::Types::SegmentModel</code></summary>
2884
+ <dl>
2885
+ <dd>
2886
+
2887
+ #### 🔌 Usage
2888
+
2889
+ <dl>
2890
+ <dd>
2891
+
2892
+ <dl>
2893
+ <dd>
2894
+
2895
+ ```ruby
2896
+ client.segment.update_segment(code: "code")
2897
+ ```
2898
+ </dd>
2899
+ </dl>
2900
+ </dd>
2901
+ </dl>
2902
+
2903
+ #### ⚙️ Parameters
2904
+
2905
+ <dl>
2906
+ <dd>
2907
+
2908
+ <dl>
2909
+ <dd>
2910
+
2911
+ **code:** `String`
2912
+
2913
+ </dd>
2914
+ </dl>
2915
+
2916
+ <dl>
2917
+ <dd>
2918
+
2919
+ **name:** `String` — 세그먼트 이름
2920
+
2921
+ </dd>
2922
+ </dl>
2923
+
2924
+ <dl>
2925
+ <dd>
2926
+
2927
+ **filter:** `Mailhub::Types::SegmentFilterModel`
2928
+
2929
+ </dd>
2930
+ </dl>
2931
+
2932
+ <dl>
2933
+ <dd>
2934
+
2935
+ **request_options:** `Mailhub::Segment::RequestOptions`
2936
+
2937
+ </dd>
2938
+ </dl>
2939
+ </dd>
2940
+ </dl>
2941
+
2942
+
2943
+ </dd>
2944
+ </dl>
2945
+ </details>
2946
+
2947
+ <details><summary><code>client.segment.<a href="/lib/Mailhub/segment/client.rb">delete_segment</a>(code:) -> </code></summary>
2948
+ <dl>
2949
+ <dd>
2950
+
2951
+ #### 🔌 Usage
2952
+
2953
+ <dl>
2954
+ <dd>
2955
+
2956
+ <dl>
2957
+ <dd>
2958
+
2959
+ ```ruby
2960
+ client.segment.delete_segment(code: "code")
2961
+ ```
2962
+ </dd>
2963
+ </dl>
2964
+ </dd>
2965
+ </dl>
2966
+
2967
+ #### ⚙️ Parameters
2968
+
2969
+ <dl>
2970
+ <dd>
2971
+
2972
+ <dl>
2973
+ <dd>
2974
+
2975
+ **code:** `String`
2976
+
2977
+ </dd>
2978
+ </dl>
2979
+
2980
+ <dl>
2981
+ <dd>
2982
+
2983
+ **request_options:** `Mailhub::Segment::RequestOptions`
2984
+
2985
+ </dd>
2986
+ </dl>
2987
+ </dd>
2988
+ </dl>
2989
+
2990
+
2991
+ </dd>
2992
+ </dl>
2993
+ </details>
2994
+
2995
+ <details><summary><code>client.segment.<a href="/lib/Mailhub/segment/client.rb">delete_segments</a>(request) -> </code></summary>
2996
+ <dl>
2997
+ <dd>
2998
+
2999
+ #### 🔌 Usage
3000
+
3001
+ <dl>
3002
+ <dd>
3003
+
3004
+ <dl>
3005
+ <dd>
3006
+
3007
+ ```ruby
3008
+ client.segment.delete_segments
3009
+ ```
3010
+ </dd>
3011
+ </dl>
3012
+ </dd>
3013
+ </dl>
3014
+
3015
+ #### ⚙️ Parameters
3016
+
3017
+ <dl>
3018
+ <dd>
3019
+
3020
+ <dl>
3021
+ <dd>
3022
+
3023
+ **all:** `Internal::Types::Boolean` — 전체 삭제 여부 (true이면 Codes는 무시)
3024
+
3025
+ </dd>
3026
+ </dl>
3027
+
3028
+ <dl>
3029
+ <dd>
3030
+
3031
+ **codes:** `Internal::Types::Array[String]` — 삭제할 세그먼트 Code 목록
3032
+
3033
+ </dd>
3034
+ </dl>
3035
+
3036
+ <dl>
3037
+ <dd>
3038
+
3039
+ **request_options:** `Mailhub::Segment::RequestOptions`
3040
+
3041
+ </dd>
3042
+ </dl>
3043
+ </dd>
3044
+ </dl>
3045
+
3046
+
3047
+ </dd>
3048
+ </dl>
3049
+ </details>
3050
+
3051
+ <details><summary><code>client.segment.<a href="/lib/Mailhub/segment/client.rb">preview_segment</a>(request) -> Mailhub::Types::PreviewSegmentModel</code></summary>
3052
+ <dl>
3053
+ <dd>
3054
+
3055
+ #### 🔌 Usage
3056
+
3057
+ <dl>
3058
+ <dd>
3059
+
3060
+ <dl>
3061
+ <dd>
3062
+
3063
+ ```ruby
3064
+ client.segment.preview_segment
3065
+ ```
3066
+ </dd>
3067
+ </dl>
3068
+ </dd>
3069
+ </dl>
3070
+
3071
+ #### ⚙️ Parameters
3072
+
3073
+ <dl>
3074
+ <dd>
3075
+
3076
+ <dl>
3077
+ <dd>
3078
+
3079
+ **filter:** `Mailhub::Types::SegmentFilterModel`
3080
+
3081
+ </dd>
3082
+ </dl>
3083
+
3084
+ <dl>
3085
+ <dd>
3086
+
3087
+ **request_options:** `Mailhub::Segment::RequestOptions`
3088
+
3089
+ </dd>
3090
+ </dl>
3091
+ </dd>
3092
+ </dl>
3093
+
3094
+
3095
+ </dd>
3096
+ </dl>
3097
+ </details>
3098
+
3099
+ <details><summary><code>client.segment.<a href="/lib/Mailhub/segment/client.rb">preview_segments_union</a>(request) -> Mailhub::Types::PreviewSegmentModel</code></summary>
3100
+ <dl>
3101
+ <dd>
3102
+
3103
+ #### 🔌 Usage
3104
+
3105
+ <dl>
3106
+ <dd>
3107
+
3108
+ <dl>
3109
+ <dd>
3110
+
3111
+ ```ruby
3112
+ client.segment.preview_segments_union
3113
+ ```
3114
+ </dd>
3115
+ </dl>
3116
+ </dd>
3117
+ </dl>
3118
+
3119
+ #### ⚙️ Parameters
3120
+
3121
+ <dl>
3122
+ <dd>
3123
+
3124
+ <dl>
3125
+ <dd>
3126
+
3127
+ **segment_codes:** `Internal::Types::Array[String]` — 합칠 세그먼트 Code 목록
3128
+
3129
+ </dd>
3130
+ </dl>
3131
+
3132
+ <dl>
3133
+ <dd>
3134
+
3135
+ **request_options:** `Mailhub::Segment::RequestOptions`
3136
+
3137
+ </dd>
3138
+ </dl>
3139
+ </dd>
3140
+ </dl>
3141
+
3142
+
3143
+ </dd>
3144
+ </dl>
3145
+ </details>
3146
+
3147
+ <details><summary><code>client.segment.<a href="/lib/Mailhub/segment/client.rb">query_segment_contacts</a>(request) -> Mailhub::Types::ContactModelPagedResult</code></summary>
3148
+ <dl>
3149
+ <dd>
3150
+
3151
+ #### 🔌 Usage
3152
+
3153
+ <dl>
3154
+ <dd>
3155
+
3156
+ <dl>
3157
+ <dd>
3158
+
3159
+ ```ruby
3160
+ client.segment.query_segment_contacts
3161
+ ```
3162
+ </dd>
3163
+ </dl>
3164
+ </dd>
3165
+ </dl>
3166
+
3167
+ #### ⚙️ Parameters
3168
+
3169
+ <dl>
3170
+ <dd>
3171
+
3172
+ <dl>
3173
+ <dd>
3174
+
3175
+ **filter:** `Mailhub::Types::SegmentFilterModel`
3176
+
3177
+ </dd>
3178
+ </dl>
3179
+
3180
+ <dl>
3181
+ <dd>
3182
+
3183
+ **page_index:** `Integer` — 페이지 번호 (1부터 시작, 기본값 1)
3184
+
3185
+ </dd>
3186
+ </dl>
3187
+
3188
+ <dl>
3189
+ <dd>
3190
+
3191
+ **page_size:** `Integer` — 페이지 크기 (기본값 20)
3192
+
3193
+ </dd>
3194
+ </dl>
3195
+
3196
+ <dl>
3197
+ <dd>
3198
+
3199
+ **request_options:** `Mailhub::Segment::RequestOptions`
3200
+
3201
+ </dd>
3202
+ </dl>
3203
+ </dd>
3204
+ </dl>
3205
+
3206
+
3207
+ </dd>
3208
+ </dl>
3209
+ </details>
3210
+
3211
+ <details><summary><code>client.segment.<a href="/lib/Mailhub/segment/client.rb">sync_segment</a>(code:) -> Mailhub::Types::SegmentModel</code></summary>
3212
+ <dl>
3213
+ <dd>
3214
+
3215
+ #### 🔌 Usage
3216
+
3217
+ <dl>
3218
+ <dd>
3219
+
3220
+ <dl>
3221
+ <dd>
3222
+
3223
+ ```ruby
3224
+ client.segment.sync_segment(code: "code")
3225
+ ```
3226
+ </dd>
3227
+ </dl>
3228
+ </dd>
3229
+ </dl>
3230
+
3231
+ #### ⚙️ Parameters
3232
+
3233
+ <dl>
3234
+ <dd>
3235
+
3236
+ <dl>
3237
+ <dd>
3238
+
3239
+ **code:** `String`
3240
+
3241
+ </dd>
3242
+ </dl>
3243
+
3244
+ <dl>
3245
+ <dd>
3246
+
3247
+ **request_options:** `Mailhub::Segment::RequestOptions`
3248
+
3249
+ </dd>
3250
+ </dl>
3251
+ </dd>
3252
+ </dl>
3253
+
3254
+
3255
+ </dd>
3256
+ </dl>
3257
+ </details>
3258
+
3259
+ ## Template
3260
+ <details><summary><code>client.template.<a href="/lib/Mailhub/template/client.rb">get_templates</a>() -> Mailhub::Types::TemplateModelPagedResult</code></summary>
3261
+ <dl>
3262
+ <dd>
3263
+
3264
+ #### 🔌 Usage
3265
+
3266
+ <dl>
3267
+ <dd>
3268
+
3269
+ <dl>
3270
+ <dd>
3271
+
3272
+ ```ruby
3273
+ client.template.get_templates
3274
+ ```
3275
+ </dd>
3276
+ </dl>
3277
+ </dd>
3278
+ </dl>
3279
+
3280
+ #### ⚙️ Parameters
3281
+
3282
+ <dl>
3283
+ <dd>
3284
+
3285
+ <dl>
3286
+ <dd>
3287
+
3288
+ **search:** `String` — 이름 등으로 검색할 키워드
3289
+
3290
+ </dd>
3291
+ </dl>
3292
+
3293
+ <dl>
3294
+ <dd>
3295
+
3296
+ **sort_by:** `String` — 정렬 기준 필드명
3297
+
3298
+ </dd>
3299
+ </dl>
3300
+
3301
+ <dl>
3302
+ <dd>
3303
+
3304
+ **sort_direction:** `String` — 정렬 방향 (asc, desc)
3305
+
3306
+ </dd>
3307
+ </dl>
3308
+
3309
+ <dl>
3310
+ <dd>
3311
+
3312
+ **page_size:** `Integer` — 페이지 크기 (기본값 10)
3313
+
3314
+ </dd>
3315
+ </dl>
3316
+
3317
+ <dl>
3318
+ <dd>
3319
+
3320
+ **page_index:** `Integer` — 페이지 번호 (1부터 시작, 기본값 1)
3321
+
3322
+ </dd>
3323
+ </dl>
3324
+
3325
+ <dl>
3326
+ <dd>
3327
+
3328
+ **request_options:** `Mailhub::Template::RequestOptions`
3329
+
3330
+ </dd>
3331
+ </dl>
3332
+ </dd>
3333
+ </dl>
3334
+
3335
+
3336
+ </dd>
3337
+ </dl>
3338
+ </details>
3339
+
3340
+ <details><summary><code>client.template.<a href="/lib/Mailhub/template/client.rb">create_template</a>(request) -> Mailhub::Types::TemplateModel</code></summary>
3341
+ <dl>
3342
+ <dd>
3343
+
3344
+ #### 🔌 Usage
3345
+
3346
+ <dl>
3347
+ <dd>
3348
+
3349
+ <dl>
3350
+ <dd>
3351
+
3352
+ ```ruby
3353
+ client.template.create_template
3354
+ ```
3355
+ </dd>
3356
+ </dl>
3357
+ </dd>
3358
+ </dl>
3359
+
3360
+ #### ⚙️ Parameters
3361
+
3362
+ <dl>
3363
+ <dd>
3364
+
3365
+ <dl>
3366
+ <dd>
3367
+
3368
+ **name:** `String` — 템플릿 이름
3369
+
3370
+ </dd>
3371
+ </dl>
3372
+
3373
+ <dl>
3374
+ <dd>
3375
+
3376
+ **body:** `String` — 템플릿 본문
3377
+
3378
+ </dd>
3379
+ </dl>
3380
+
3381
+ <dl>
3382
+ <dd>
3383
+
3384
+ **request_options:** `Mailhub::Template::RequestOptions`
3385
+
3386
+ </dd>
3387
+ </dl>
3388
+ </dd>
3389
+ </dl>
3390
+
3391
+
3392
+ </dd>
3393
+ </dl>
3394
+ </details>
3395
+
3396
+ <details><summary><code>client.template.<a href="/lib/Mailhub/template/client.rb">get_template_expressions</a>() -> Internal::Types::Array[Mailhub::Types::TemplateExpressionModel]</code></summary>
3397
+ <dl>
3398
+ <dd>
3399
+
3400
+ #### 🔌 Usage
3401
+
3402
+ <dl>
3403
+ <dd>
3404
+
3405
+ <dl>
3406
+ <dd>
3407
+
3408
+ ```ruby
3409
+ client.template.get_template_expressions
3410
+ ```
3411
+ </dd>
3412
+ </dl>
3413
+ </dd>
3414
+ </dl>
3415
+
3416
+ #### ⚙️ Parameters
3417
+
3418
+ <dl>
3419
+ <dd>
3420
+
3421
+ <dl>
3422
+ <dd>
3423
+
3424
+ **request_options:** `Mailhub::Template::RequestOptions`
3425
+
3426
+ </dd>
3427
+ </dl>
3428
+ </dd>
3429
+ </dl>
3430
+
3431
+
3432
+ </dd>
3433
+ </dl>
3434
+ </details>
3435
+
3436
+ <details><summary><code>client.template.<a href="/lib/Mailhub/template/client.rb">get_template</a>(code:) -> Mailhub::Types::TemplateModel</code></summary>
3437
+ <dl>
3438
+ <dd>
3439
+
3440
+ #### 🔌 Usage
3441
+
3442
+ <dl>
3443
+ <dd>
3444
+
3445
+ <dl>
3446
+ <dd>
3447
+
3448
+ ```ruby
3449
+ client.template.get_template(code: "code")
3450
+ ```
3451
+ </dd>
3452
+ </dl>
3453
+ </dd>
3454
+ </dl>
3455
+
3456
+ #### ⚙️ Parameters
3457
+
3458
+ <dl>
3459
+ <dd>
3460
+
3461
+ <dl>
3462
+ <dd>
3463
+
3464
+ **code:** `String`
3465
+
3466
+ </dd>
3467
+ </dl>
3468
+
3469
+ <dl>
3470
+ <dd>
3471
+
3472
+ **request_options:** `Mailhub::Template::RequestOptions`
3473
+
3474
+ </dd>
3475
+ </dl>
3476
+ </dd>
3477
+ </dl>
3478
+
3479
+
3480
+ </dd>
3481
+ </dl>
3482
+ </details>
3483
+
3484
+ <details><summary><code>client.template.<a href="/lib/Mailhub/template/client.rb">update_template</a>(code:, request) -> Mailhub::Types::TemplateModel</code></summary>
3485
+ <dl>
3486
+ <dd>
3487
+
3488
+ #### 🔌 Usage
3489
+
3490
+ <dl>
3491
+ <dd>
3492
+
3493
+ <dl>
3494
+ <dd>
3495
+
3496
+ ```ruby
3497
+ client.template.update_template(code: "code")
3498
+ ```
3499
+ </dd>
3500
+ </dl>
3501
+ </dd>
3502
+ </dl>
3503
+
3504
+ #### ⚙️ Parameters
3505
+
3506
+ <dl>
3507
+ <dd>
3508
+
3509
+ <dl>
3510
+ <dd>
3511
+
3512
+ **code:** `String`
3513
+
3514
+ </dd>
3515
+ </dl>
3516
+
3517
+ <dl>
3518
+ <dd>
3519
+
3520
+ **name:** `String` — 템플릿 이름
3521
+
3522
+ </dd>
3523
+ </dl>
3524
+
3525
+ <dl>
3526
+ <dd>
3527
+
3528
+ **body:** `String` — 템플릿 본문
3529
+
3530
+ </dd>
3531
+ </dl>
3532
+
3533
+ <dl>
3534
+ <dd>
3535
+
3536
+ **request_options:** `Mailhub::Template::RequestOptions`
3537
+
3538
+ </dd>
3539
+ </dl>
3540
+ </dd>
3541
+ </dl>
3542
+
3543
+
3544
+ </dd>
3545
+ </dl>
3546
+ </details>
3547
+
3548
+ <details><summary><code>client.template.<a href="/lib/Mailhub/template/client.rb">delete_template</a>(code:) -> </code></summary>
3549
+ <dl>
3550
+ <dd>
3551
+
3552
+ #### 🔌 Usage
3553
+
3554
+ <dl>
3555
+ <dd>
3556
+
3557
+ <dl>
3558
+ <dd>
3559
+
3560
+ ```ruby
3561
+ client.template.delete_template(code: "code")
3562
+ ```
3563
+ </dd>
3564
+ </dl>
3565
+ </dd>
3566
+ </dl>
3567
+
3568
+ #### ⚙️ Parameters
3569
+
3570
+ <dl>
3571
+ <dd>
3572
+
3573
+ <dl>
3574
+ <dd>
3575
+
3576
+ **code:** `String`
3577
+
3578
+ </dd>
3579
+ </dl>
3580
+
3581
+ <dl>
3582
+ <dd>
3583
+
3584
+ **request_options:** `Mailhub::Template::RequestOptions`
3585
+
3586
+ </dd>
3587
+ </dl>
3588
+ </dd>
3589
+ </dl>
3590
+
3591
+
3592
+ </dd>
3593
+ </dl>
3594
+ </details>
3595
+
3596
+ <details><summary><code>client.template.<a href="/lib/Mailhub/template/client.rb">preview_template</a>(code:) -> String</code></summary>
3597
+ <dl>
3598
+ <dd>
3599
+
3600
+ #### 🔌 Usage
3601
+
3602
+ <dl>
3603
+ <dd>
3604
+
3605
+ <dl>
3606
+ <dd>
3607
+
3608
+ ```ruby
3609
+ client.template.preview_template(code: "code")
3610
+ ```
3611
+ </dd>
3612
+ </dl>
3613
+ </dd>
3614
+ </dl>
3615
+
3616
+ #### ⚙️ Parameters
3617
+
3618
+ <dl>
3619
+ <dd>
3620
+
3621
+ <dl>
3622
+ <dd>
3623
+
3624
+ **code:** `String`
3625
+
3626
+ </dd>
3627
+ </dl>
3628
+
3629
+ <dl>
3630
+ <dd>
3631
+
3632
+ **request_options:** `Mailhub::Template::RequestOptions`
3633
+
3634
+ </dd>
3635
+ </dl>
3636
+ </dd>
3637
+ </dl>
3638
+
3639
+
3640
+ </dd>
3641
+ </dl>
3642
+ </details>
3643
+
3644
+ <details><summary><code>client.template.<a href="/lib/Mailhub/template/client.rb">render_template_preview</a>(request) -> String</code></summary>
3645
+ <dl>
3646
+ <dd>
3647
+
3648
+ #### 🔌 Usage
3649
+
3650
+ <dl>
3651
+ <dd>
3652
+
3653
+ <dl>
3654
+ <dd>
3655
+
3656
+ ```ruby
3657
+ client.template.render_template_preview
3658
+ ```
3659
+ </dd>
3660
+ </dl>
3661
+ </dd>
3662
+ </dl>
3663
+
3664
+ #### ⚙️ Parameters
3665
+
3666
+ <dl>
3667
+ <dd>
3668
+
3669
+ <dl>
3670
+ <dd>
3671
+
3672
+ **body:** `String` — 미리보기할 템플릿 본문
3673
+
3674
+ </dd>
3675
+ </dl>
3676
+
3677
+ <dl>
3678
+ <dd>
3679
+
3680
+ **request_options:** `Mailhub::Template::RequestOptions`
3681
+
3682
+ </dd>
3683
+ </dl>
3684
+ </dd>
3685
+ </dl>
3686
+
3687
+
3688
+ </dd>
3689
+ </dl>
3690
+ </details>
3691
+