mailslurp_client 7.0.8 → 7.2.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (230) hide show
  1. checksums.yaml +4 -4
  2. data/lib/mailslurp_client.rb +12 -3
  3. metadata +11 -372
  4. data/Gemfile +0 -9
  5. data/LICENSE +0 -22
  6. data/Makefile +0 -3
  7. data/README.md +0 -239
  8. data/Rakefile +0 -10
  9. data/docs/AliasControllerApi.md +0 -337
  10. data/docs/AttachmentControllerApi.md +0 -126
  11. data/docs/AttachmentMetaData.md +0 -23
  12. data/docs/BasicAuthOptions.md +0 -19
  13. data/docs/BulkActionsControllerApi.md +0 -165
  14. data/docs/BulkSendEmailOptions.md +0 -19
  15. data/docs/CommonActionsControllerApi.md +0 -218
  16. data/docs/ContactControllerApi.md +0 -274
  17. data/docs/ContactDto.md +0 -31
  18. data/docs/ContactProjection.md +0 -27
  19. data/docs/CreateAnonymousAliasOptions.md +0 -17
  20. data/docs/CreateContactOptions.md +0 -31
  21. data/docs/CreateDomainOptions.md +0 -17
  22. data/docs/CreateGroupOptions.md +0 -19
  23. data/docs/CreateOwnedAliasOptions.md +0 -23
  24. data/docs/CreateTemplateOptions.md +0 -19
  25. data/docs/CreateWebhookOptions.md +0 -21
  26. data/docs/DomainControllerApi.md +0 -223
  27. data/docs/DomainDto.md +0 -29
  28. data/docs/DomainPreview.md +0 -21
  29. data/docs/Email.md +0 -49
  30. data/docs/EmailAnalysis.md +0 -25
  31. data/docs/EmailControllerApi.md +0 -740
  32. data/docs/EmailPreview.md +0 -31
  33. data/docs/EmailProjection.md +0 -33
  34. data/docs/FormControllerApi.md +0 -79
  35. data/docs/ForwardEmailOptions.md +0 -23
  36. data/docs/GroupContactsDto.md +0 -19
  37. data/docs/GroupControllerApi.md +0 -437
  38. data/docs/GroupDto.md +0 -23
  39. data/docs/GroupProjection.md +0 -23
  40. data/docs/HTMLValidationResult.md +0 -21
  41. data/docs/Inbox.md +0 -33
  42. data/docs/InboxControllerApi.md +0 -705
  43. data/docs/InboxProjection.md +0 -29
  44. data/docs/JsonNode.md +0 -59
  45. data/docs/MatchOption.md +0 -21
  46. data/docs/MatchOptions.md +0 -17
  47. data/docs/ModelAlias.md +0 -31
  48. data/docs/PageAlias.md +0 -37
  49. data/docs/PageContactProjection.md +0 -37
  50. data/docs/PageEmailPreview.md +0 -37
  51. data/docs/PageEmailProjection.md +0 -37
  52. data/docs/PageGroupProjection.md +0 -37
  53. data/docs/PageInboxProjection.md +0 -37
  54. data/docs/PageTemplateProjection.md +0 -37
  55. data/docs/PageWebhookProjection.md +0 -37
  56. data/docs/Pageable.md +0 -27
  57. data/docs/RawEmailJson.md +0 -17
  58. data/docs/SendEmailOptions.md +0 -45
  59. data/docs/SetInboxFavouritedOptions.md +0 -17
  60. data/docs/SimpleSendEmailOptions.md +0 -23
  61. data/docs/Sort.md +0 -21
  62. data/docs/TemplateControllerApi.md +0 -274
  63. data/docs/TemplateDto.md +0 -25
  64. data/docs/TemplateProjection.md +0 -25
  65. data/docs/TemplateVariable.md +0 -19
  66. data/docs/UnreadCount.md +0 -17
  67. data/docs/UpdateGroupContacts.md +0 -17
  68. data/docs/UpdateInboxOptions.md +0 -25
  69. data/docs/UploadAttachmentOptions.md +0 -21
  70. data/docs/ValidationDto.md +0 -19
  71. data/docs/ValidationMessage.md +0 -19
  72. data/docs/WaitForConditions.md +0 -29
  73. data/docs/WaitForControllerApi.md +0 -317
  74. data/docs/WebhookControllerApi.md +0 -339
  75. data/docs/WebhookDto.md +0 -33
  76. data/docs/WebhookProjection.md +0 -27
  77. data/docs/WebhookTestRequest.md +0 -23
  78. data/docs/WebhookTestResponse.md +0 -19
  79. data/docs/WebhookTestResult.md +0 -21
  80. data/git_push.sh +0 -58
  81. data/lib/mailslurp_client/api/alias_controller_api.rb +0 -405
  82. data/lib/mailslurp_client/api/attachment_controller_api.rb +0 -160
  83. data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +0 -203
  84. data/lib/mailslurp_client/api/common_actions_controller_api.rb +0 -257
  85. data/lib/mailslurp_client/api/contact_controller_api.rb +0 -323
  86. data/lib/mailslurp_client/api/domain_controller_api.rb +0 -264
  87. data/lib/mailslurp_client/api/email_controller_api.rb +0 -852
  88. data/lib/mailslurp_client/api/form_controller_api.rb +0 -104
  89. data/lib/mailslurp_client/api/group_controller_api.rb +0 -519
  90. data/lib/mailslurp_client/api/inbox_controller_api.rb +0 -822
  91. data/lib/mailslurp_client/api/template_controller_api.rb +0 -323
  92. data/lib/mailslurp_client/api/wait_for_controller_api.rb +0 -359
  93. data/lib/mailslurp_client/api/webhook_controller_api.rb +0 -405
  94. data/lib/mailslurp_client/api_client.rb +0 -386
  95. data/lib/mailslurp_client/api_error.rb +0 -57
  96. data/lib/mailslurp_client/configuration.rb +0 -248
  97. data/lib/mailslurp_client/models/attachment_meta_data.rb +0 -238
  98. data/lib/mailslurp_client/models/basic_auth_options.rb +0 -226
  99. data/lib/mailslurp_client/models/bulk_send_email_options.rb +0 -219
  100. data/lib/mailslurp_client/models/contact_dto.rb +0 -288
  101. data/lib/mailslurp_client/models/contact_projection.rb +0 -261
  102. data/lib/mailslurp_client/models/create_anonymous_alias_options.rb +0 -208
  103. data/lib/mailslurp_client/models/create_contact_options.rb +0 -277
  104. data/lib/mailslurp_client/models/create_domain_options.rb +0 -208
  105. data/lib/mailslurp_client/models/create_group_options.rb +0 -220
  106. data/lib/mailslurp_client/models/create_owned_alias_options.rb +0 -238
  107. data/lib/mailslurp_client/models/create_template_options.rb +0 -225
  108. data/lib/mailslurp_client/models/create_webhook_options.rb +0 -227
  109. data/lib/mailslurp_client/models/domain_dto.rb +0 -296
  110. data/lib/mailslurp_client/models/domain_preview.rb +0 -240
  111. data/lib/mailslurp_client/models/email.rb +0 -376
  112. data/lib/mailslurp_client/models/email_analysis.rb +0 -248
  113. data/lib/mailslurp_client/models/email_preview.rb +0 -286
  114. data/lib/mailslurp_client/models/email_projection.rb +0 -307
  115. data/lib/mailslurp_client/models/forward_email_options.rb +0 -244
  116. data/lib/mailslurp_client/models/group_contacts_dto.rb +0 -227
  117. data/lib/mailslurp_client/models/group_dto.rb +0 -248
  118. data/lib/mailslurp_client/models/group_projection.rb +0 -248
  119. data/lib/mailslurp_client/models/html_validation_result.rb +0 -243
  120. data/lib/mailslurp_client/models/inbox.rb +0 -290
  121. data/lib/mailslurp_client/models/inbox_projection.rb +0 -272
  122. data/lib/mailslurp_client/models/json_node.rb +0 -429
  123. data/lib/mailslurp_client/models/match_option.rb +0 -274
  124. data/lib/mailslurp_client/models/match_options.rb +0 -210
  125. data/lib/mailslurp_client/models/model_alias.rb +0 -284
  126. data/lib/mailslurp_client/models/page_alias.rb +0 -298
  127. data/lib/mailslurp_client/models/page_contact_projection.rb +0 -298
  128. data/lib/mailslurp_client/models/page_email_preview.rb +0 -298
  129. data/lib/mailslurp_client/models/page_email_projection.rb +0 -298
  130. data/lib/mailslurp_client/models/page_group_projection.rb +0 -298
  131. data/lib/mailslurp_client/models/page_inbox_projection.rb +0 -298
  132. data/lib/mailslurp_client/models/page_template_projection.rb +0 -298
  133. data/lib/mailslurp_client/models/page_webhook_projection.rb +0 -298
  134. data/lib/mailslurp_client/models/pageable.rb +0 -251
  135. data/lib/mailslurp_client/models/raw_email_json.rb +0 -211
  136. data/lib/mailslurp_client/models/send_email_options.rb +0 -392
  137. data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +0 -208
  138. data/lib/mailslurp_client/models/simple_send_email_options.rb +0 -237
  139. data/lib/mailslurp_client/models/sort.rb +0 -224
  140. data/lib/mailslurp_client/models/template_dto.rb +0 -269
  141. data/lib/mailslurp_client/models/template_projection.rb +0 -269
  142. data/lib/mailslurp_client/models/template_variable.rb +0 -259
  143. data/lib/mailslurp_client/models/unread_count.rb +0 -211
  144. data/lib/mailslurp_client/models/update_group_contacts.rb +0 -213
  145. data/lib/mailslurp_client/models/update_inbox_options.rb +0 -250
  146. data/lib/mailslurp_client/models/upload_attachment_options.rb +0 -228
  147. data/lib/mailslurp_client/models/validation_dto.rb +0 -217
  148. data/lib/mailslurp_client/models/validation_message.rb +0 -220
  149. data/lib/mailslurp_client/models/wait_for_conditions.rb +0 -316
  150. data/lib/mailslurp_client/models/webhook_dto.rb +0 -326
  151. data/lib/mailslurp_client/models/webhook_projection.rb +0 -277
  152. data/lib/mailslurp_client/models/webhook_test_request.rb +0 -284
  153. data/lib/mailslurp_client/models/webhook_test_response.rb +0 -215
  154. data/lib/mailslurp_client/models/webhook_test_result.rb +0 -235
  155. data/lib/mailslurp_client/version.rb +0 -15
  156. data/mailslurp_client.gemspec +0 -39
  157. data/spec/api/alias_controller_api_spec.rb +0 -107
  158. data/spec/api/attachment_controller_api_spec.rb +0 -61
  159. data/spec/api/bulk_actions_controller_api_spec.rb +0 -68
  160. data/spec/api/common_actions_controller_api_spec.rb +0 -129
  161. data/spec/api/contact_controller_api_spec.rb +0 -91
  162. data/spec/api/domain_controller_api_spec.rb +0 -82
  163. data/spec/api/email_controller_api_spec.rb +0 -162
  164. data/spec/api/form_controller_api_spec.rb +0 -54
  165. data/spec/api/group_controller_api_spec.rb +0 -126
  166. data/spec/api/inbox_controller_api_spec.rb +0 -172
  167. data/spec/api/template_controller_api_spec.rb +0 -91
  168. data/spec/api/wait_for_controller_api_spec.rb +0 -107
  169. data/spec/api/webhook_controller_api_spec.rb +0 -107
  170. data/spec/api_client_spec.rb +0 -226
  171. data/spec/configuration_spec.rb +0 -42
  172. data/spec/models/attachment_meta_data_spec.rb +0 -59
  173. data/spec/models/basic_auth_options_spec.rb +0 -47
  174. data/spec/models/bulk_send_email_options_spec.rb +0 -47
  175. data/spec/models/contact_dto_spec.rb +0 -83
  176. data/spec/models/contact_projection_spec.rb +0 -71
  177. data/spec/models/create_anonymous_alias_options_spec.rb +0 -41
  178. data/spec/models/create_contact_options_spec.rb +0 -83
  179. data/spec/models/create_domain_options_spec.rb +0 -41
  180. data/spec/models/create_group_options_spec.rb +0 -47
  181. data/spec/models/create_owned_alias_options_spec.rb +0 -59
  182. data/spec/models/create_template_options_spec.rb +0 -47
  183. data/spec/models/create_webhook_options_spec.rb +0 -53
  184. data/spec/models/domain_dto_spec.rb +0 -77
  185. data/spec/models/domain_preview_spec.rb +0 -53
  186. data/spec/models/email_analysis_spec.rb +0 -65
  187. data/spec/models/email_preview_spec.rb +0 -83
  188. data/spec/models/email_projection_spec.rb +0 -89
  189. data/spec/models/email_spec.rb +0 -137
  190. data/spec/models/forward_email_options_spec.rb +0 -59
  191. data/spec/models/group_contacts_dto_spec.rb +0 -47
  192. data/spec/models/group_dto_spec.rb +0 -59
  193. data/spec/models/group_projection_spec.rb +0 -59
  194. data/spec/models/html_validation_result_spec.rb +0 -53
  195. data/spec/models/inbox_projection_spec.rb +0 -77
  196. data/spec/models/inbox_spec.rb +0 -89
  197. data/spec/models/json_node_spec.rb +0 -171
  198. data/spec/models/match_option_spec.rb +0 -61
  199. data/spec/models/match_options_spec.rb +0 -41
  200. data/spec/models/model_alias_spec.rb +0 -83
  201. data/spec/models/page_alias_spec.rb +0 -101
  202. data/spec/models/page_contact_projection_spec.rb +0 -101
  203. data/spec/models/page_email_preview_spec.rb +0 -101
  204. data/spec/models/page_email_projection_spec.rb +0 -101
  205. data/spec/models/page_group_projection_spec.rb +0 -101
  206. data/spec/models/page_inbox_projection_spec.rb +0 -101
  207. data/spec/models/page_template_projection_spec.rb +0 -101
  208. data/spec/models/page_webhook_projection_spec.rb +0 -101
  209. data/spec/models/pageable_spec.rb +0 -71
  210. data/spec/models/raw_email_json_spec.rb +0 -41
  211. data/spec/models/send_email_options_spec.rb +0 -129
  212. data/spec/models/set_inbox_favourited_options_spec.rb +0 -41
  213. data/spec/models/simple_send_email_options_spec.rb +0 -59
  214. data/spec/models/sort_spec.rb +0 -53
  215. data/spec/models/template_dto_spec.rb +0 -65
  216. data/spec/models/template_projection_spec.rb +0 -65
  217. data/spec/models/template_variable_spec.rb +0 -51
  218. data/spec/models/unread_count_spec.rb +0 -41
  219. data/spec/models/update_group_contacts_spec.rb +0 -41
  220. data/spec/models/update_inbox_options_spec.rb +0 -65
  221. data/spec/models/upload_attachment_options_spec.rb +0 -53
  222. data/spec/models/validation_dto_spec.rb +0 -47
  223. data/spec/models/validation_message_spec.rb +0 -47
  224. data/spec/models/wait_for_conditions_spec.rb +0 -85
  225. data/spec/models/webhook_dto_spec.rb +0 -93
  226. data/spec/models/webhook_projection_spec.rb +0 -71
  227. data/spec/models/webhook_test_request_spec.rb +0 -63
  228. data/spec/models/webhook_test_response_spec.rb +0 -47
  229. data/spec/models/webhook_test_result_spec.rb +0 -53
  230. data/spec/spec_helper.rb +0 -111
@@ -1,27 +0,0 @@
1
- # MailSlurpClient::Pageable
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **offset** | **Integer** | | [optional]
8
- **page_number** | **Integer** | | [optional]
9
- **page_size** | **Integer** | | [optional]
10
- **paged** | **Boolean** | | [optional]
11
- **sort** | [**Sort**](Sort.md) | | [optional]
12
- **unpaged** | **Boolean** | | [optional]
13
-
14
- ## Code Sample
15
-
16
- ```ruby
17
- require 'MailSlurpClient'
18
-
19
- instance = MailSlurpClient::Pageable.new(offset: null,
20
- page_number: null,
21
- page_size: null,
22
- paged: null,
23
- sort: null,
24
- unpaged: null)
25
- ```
26
-
27
-
@@ -1,17 +0,0 @@
1
- # MailSlurpClient::RawEmailJson
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **content** | **String** | |
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'MailSlurpClient'
13
-
14
- instance = MailSlurpClient::RawEmailJson.new(content: null)
15
- ```
16
-
17
-
@@ -1,45 +0,0 @@
1
- # MailSlurpClient::SendEmailOptions
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **attachments** | **Array<String>** | Optional list of attachment IDs to send with this email. You must first upload each attachment separately in order to obtain attachment IDs. This way you can reuse attachments with different emails once uploaded. | [optional]
8
- **bcc** | **Array<String>** | Optional list of bcc destination email addresses | [optional]
9
- **body** | **String** | Optional contents of email. If body contains HTML then set `isHTML` to true to ensure that email clients render it correctly. You can use moustache template syntax in the email body in conjunction with `toGroup` contact variables or `templateVariables` data. If you need more templating control consider creating a template and using the `template` property instead of the body. | [optional]
10
- **cc** | **Array<String>** | Optional list of cc destination email addresses | [optional]
11
- **charset** | **String** | Optional charset | [optional]
12
- **from** | **String** | Optional from address. If not set the source inbox address will be used for this field. Beware of potential spam penalties when setting this field to an address not used by the inbox. For custom email addresses use a custom domain. | [optional]
13
- **is_html** | **Boolean** | Optional HTML flag. If true the `content-type` of the email will be `text/html`. Set to true when sending HTML to ensure proper rending on email clients | [optional]
14
- **reply_to** | **String** | Optional replyTo header | [optional]
15
- **send_strategy** | **String** | Optional strategy to use when sending the email | [optional]
16
- **subject** | **String** | Optional email subject line | [optional]
17
- **template** | **String** | Optional template ID to use for body. Will override body if provided. When using a template make sure you pass the corresponding map of `templateVariables`. You can find which variables are needed by fetching the template itself or viewing it in the dashboard. | [optional]
18
- **template_variables** | [**Object**](.md) | Optional map of template variables. Will replace moustache syntax variables in subject and body or template with the associated values if found. | [optional]
19
- **to** | **Array<String>** | List of destination email addresses. Even single recipients must be in array form. Maximum recipients per email depends on your plan. If you need to send many emails try using contacts or contact groups or use a non standard sendStrategy to ensure that spam filters are not triggered (many recipients in one email can affect your spam rating). | [optional]
20
- **to_contacts** | **Array<String>** | Optional list of contact IDs to send email to. Manage your contacts via the API or dashboard. When contacts are used the email is sent to each contact separately so they will not see other recipients. | [optional]
21
- **to_group** | **String** | Optional contact group ID to send email to. You can create contacts and contact groups in the API or dashboard and use them for email campaigns. When contact groups are used the email is sent to each contact separately so they will not see other recipients | [optional]
22
-
23
- ## Code Sample
24
-
25
- ```ruby
26
- require 'MailSlurpClient'
27
-
28
- instance = MailSlurpClient::SendEmailOptions.new(attachments: null,
29
- bcc: null,
30
- body: null,
31
- cc: null,
32
- charset: null,
33
- from: null,
34
- is_html: null,
35
- reply_to: null,
36
- send_strategy: null,
37
- subject: null,
38
- template: null,
39
- template_variables: null,
40
- to: null,
41
- to_contacts: null,
42
- to_group: null)
43
- ```
44
-
45
-
@@ -1,17 +0,0 @@
1
- # MailSlurpClient::SetInboxFavouritedOptions
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **state** | **Boolean** | Should the inbox be favourited? | [optional]
8
-
9
- ## Code Sample
10
-
11
- ```ruby
12
- require 'MailSlurpClient'
13
-
14
- instance = MailSlurpClient::SetInboxFavouritedOptions.new(state: null)
15
- ```
16
-
17
-
@@ -1,23 +0,0 @@
1
- # MailSlurpClient::SimpleSendEmailOptions
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **body** | **String** | Body of the email message. Supports HTML | [optional]
8
- **sender_id** | **String** | ID of inbox to send from | [optional]
9
- **subject** | **String** | Subject line of the email | [optional]
10
- **to** | **String** | Email address to send to | [optional]
11
-
12
- ## Code Sample
13
-
14
- ```ruby
15
- require 'MailSlurpClient'
16
-
17
- instance = MailSlurpClient::SimpleSendEmailOptions.new(body: null,
18
- sender_id: null,
19
- subject: null,
20
- to: null)
21
- ```
22
-
23
-
@@ -1,21 +0,0 @@
1
- # MailSlurpClient::Sort
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **empty** | **Boolean** | | [optional]
8
- **sorted** | **Boolean** | | [optional]
9
- **unsorted** | **Boolean** | | [optional]
10
-
11
- ## Code Sample
12
-
13
- ```ruby
14
- require 'MailSlurpClient'
15
-
16
- instance = MailSlurpClient::Sort.new(empty: null,
17
- sorted: null,
18
- unsorted: null)
19
- ```
20
-
21
-
@@ -1,274 +0,0 @@
1
- # MailSlurpClient::TemplateControllerApi
2
-
3
- All URIs are relative to *https://api.mailslurp.com*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_template**](TemplateControllerApi.md#create_template) | **POST** /templates | Create a Template
8
- [**delete_template**](TemplateControllerApi.md#delete_template) | **DELETE** /templates/{TemplateId} | Delete Template
9
- [**get_all_templates**](TemplateControllerApi.md#get_all_templates) | **GET** /templates/paginated | Get all Templates in paginated format
10
- [**get_template**](TemplateControllerApi.md#get_template) | **GET** /templates/{TemplateId} | Get Template
11
- [**get_templates**](TemplateControllerApi.md#get_templates) | **GET** /templates | Get all Templates
12
-
13
-
14
-
15
- ## create_template
16
-
17
- > TemplateDto create_template(create_template_options)
18
-
19
- Create a Template
20
-
21
- ### Example
22
-
23
- ```ruby
24
- # load the gem
25
- require 'mailslurp_client'
26
- # setup authorization
27
- MailSlurpClient.configure do |config|
28
- # Configure API key authorization: API_KEY
29
- config.api_key['x-api-key'] = 'YOUR API KEY'
30
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
31
- #config.api_key_prefix['x-api-key'] = 'Bearer'
32
- end
33
-
34
- api_instance = MailSlurpClient::TemplateControllerApi.new
35
- create_template_options = MailSlurpClient::CreateTemplateOptions.new # CreateTemplateOptions | createTemplateOptions
36
-
37
- begin
38
- #Create a Template
39
- result = api_instance.create_template(create_template_options)
40
- p result
41
- rescue MailSlurpClient::ApiError => e
42
- puts "Exception when calling TemplateControllerApi->create_template: #{e}"
43
- end
44
- ```
45
-
46
- ### Parameters
47
-
48
-
49
- Name | Type | Description | Notes
50
- ------------- | ------------- | ------------- | -------------
51
- **create_template_options** | [**CreateTemplateOptions**](CreateTemplateOptions.md)| createTemplateOptions |
52
-
53
- ### Return type
54
-
55
- [**TemplateDto**](TemplateDto.md)
56
-
57
- ### Authorization
58
-
59
- [API_KEY](../README.md#API_KEY)
60
-
61
- ### HTTP request headers
62
-
63
- - **Content-Type**: application/json
64
- - **Accept**: application/json
65
-
66
-
67
- ## delete_template
68
-
69
- > delete_template(template_id)
70
-
71
- Delete Template
72
-
73
- ### Example
74
-
75
- ```ruby
76
- # load the gem
77
- require 'mailslurp_client'
78
- # setup authorization
79
- MailSlurpClient.configure do |config|
80
- # Configure API key authorization: API_KEY
81
- config.api_key['x-api-key'] = 'YOUR API KEY'
82
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
83
- #config.api_key_prefix['x-api-key'] = 'Bearer'
84
- end
85
-
86
- api_instance = MailSlurpClient::TemplateControllerApi.new
87
- template_id = 'template_id_example' # String | TemplateId
88
-
89
- begin
90
- #Delete Template
91
- api_instance.delete_template(template_id)
92
- rescue MailSlurpClient::ApiError => e
93
- puts "Exception when calling TemplateControllerApi->delete_template: #{e}"
94
- end
95
- ```
96
-
97
- ### Parameters
98
-
99
-
100
- Name | Type | Description | Notes
101
- ------------- | ------------- | ------------- | -------------
102
- **template_id** | [**String**](.md)| TemplateId |
103
-
104
- ### Return type
105
-
106
- nil (empty response body)
107
-
108
- ### Authorization
109
-
110
- [API_KEY](../README.md#API_KEY)
111
-
112
- ### HTTP request headers
113
-
114
- - **Content-Type**: Not defined
115
- - **Accept**: Not defined
116
-
117
-
118
- ## get_all_templates
119
-
120
- > PageTemplateProjection get_all_templates(opts)
121
-
122
- Get all Templates in paginated format
123
-
124
- ### Example
125
-
126
- ```ruby
127
- # load the gem
128
- require 'mailslurp_client'
129
- # setup authorization
130
- MailSlurpClient.configure do |config|
131
- # Configure API key authorization: API_KEY
132
- config.api_key['x-api-key'] = 'YOUR API KEY'
133
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
134
- #config.api_key_prefix['x-api-key'] = 'Bearer'
135
- end
136
-
137
- api_instance = MailSlurpClient::TemplateControllerApi.new
138
- opts = {
139
- page: 0, # Integer | Optional page index in inbox list pagination
140
- size: 20, # Integer | Optional page size in inbox list pagination
141
- sort: 'ASC' # String | Optional createdAt sort direction ASC or DESC
142
- }
143
-
144
- begin
145
- #Get all Templates in paginated format
146
- result = api_instance.get_all_templates(opts)
147
- p result
148
- rescue MailSlurpClient::ApiError => e
149
- puts "Exception when calling TemplateControllerApi->get_all_templates: #{e}"
150
- end
151
- ```
152
-
153
- ### Parameters
154
-
155
-
156
- Name | Type | Description | Notes
157
- ------------- | ------------- | ------------- | -------------
158
- **page** | **Integer**| Optional page index in inbox list pagination | [optional] [default to 0]
159
- **size** | **Integer**| Optional page size in inbox list pagination | [optional] [default to 20]
160
- **sort** | **String**| Optional createdAt sort direction ASC or DESC | [optional] [default to 'ASC']
161
-
162
- ### Return type
163
-
164
- [**PageTemplateProjection**](PageTemplateProjection.md)
165
-
166
- ### Authorization
167
-
168
- [API_KEY](../README.md#API_KEY)
169
-
170
- ### HTTP request headers
171
-
172
- - **Content-Type**: Not defined
173
- - **Accept**: application/json
174
-
175
-
176
- ## get_template
177
-
178
- > TemplateDto get_template(template_id)
179
-
180
- Get Template
181
-
182
- ### Example
183
-
184
- ```ruby
185
- # load the gem
186
- require 'mailslurp_client'
187
- # setup authorization
188
- MailSlurpClient.configure do |config|
189
- # Configure API key authorization: API_KEY
190
- config.api_key['x-api-key'] = 'YOUR API KEY'
191
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
192
- #config.api_key_prefix['x-api-key'] = 'Bearer'
193
- end
194
-
195
- api_instance = MailSlurpClient::TemplateControllerApi.new
196
- template_id = 'template_id_example' # String | TemplateId
197
-
198
- begin
199
- #Get Template
200
- result = api_instance.get_template(template_id)
201
- p result
202
- rescue MailSlurpClient::ApiError => e
203
- puts "Exception when calling TemplateControllerApi->get_template: #{e}"
204
- end
205
- ```
206
-
207
- ### Parameters
208
-
209
-
210
- Name | Type | Description | Notes
211
- ------------- | ------------- | ------------- | -------------
212
- **template_id** | [**String**](.md)| TemplateId |
213
-
214
- ### Return type
215
-
216
- [**TemplateDto**](TemplateDto.md)
217
-
218
- ### Authorization
219
-
220
- [API_KEY](../README.md#API_KEY)
221
-
222
- ### HTTP request headers
223
-
224
- - **Content-Type**: Not defined
225
- - **Accept**: application/json
226
-
227
-
228
- ## get_templates
229
-
230
- > Array<TemplateProjection> get_templates
231
-
232
- Get all Templates
233
-
234
- ### Example
235
-
236
- ```ruby
237
- # load the gem
238
- require 'mailslurp_client'
239
- # setup authorization
240
- MailSlurpClient.configure do |config|
241
- # Configure API key authorization: API_KEY
242
- config.api_key['x-api-key'] = 'YOUR API KEY'
243
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
244
- #config.api_key_prefix['x-api-key'] = 'Bearer'
245
- end
246
-
247
- api_instance = MailSlurpClient::TemplateControllerApi.new
248
-
249
- begin
250
- #Get all Templates
251
- result = api_instance.get_templates
252
- p result
253
- rescue MailSlurpClient::ApiError => e
254
- puts "Exception when calling TemplateControllerApi->get_templates: #{e}"
255
- end
256
- ```
257
-
258
- ### Parameters
259
-
260
- This endpoint does not need any parameter.
261
-
262
- ### Return type
263
-
264
- [**Array<TemplateProjection>**](TemplateProjection.md)
265
-
266
- ### Authorization
267
-
268
- [API_KEY](../README.md#API_KEY)
269
-
270
- ### HTTP request headers
271
-
272
- - **Content-Type**: Not defined
273
- - **Accept**: application/json
274
-
@@ -1,25 +0,0 @@
1
- # MailSlurpClient::TemplateDto
2
-
3
- ## Properties
4
-
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **content** | **String** | |
8
- **created_at** | **DateTime** | |
9
- **id** | **String** | |
10
- **name** | **String** | |
11
- **variables** | [**Array<TemplateVariable>**](TemplateVariable.md) | |
12
-
13
- ## Code Sample
14
-
15
- ```ruby
16
- require 'MailSlurpClient'
17
-
18
- instance = MailSlurpClient::TemplateDto.new(content: null,
19
- created_at: null,
20
- id: null,
21
- name: null,
22
- variables: null)
23
- ```
24
-
25
-