zyphr 0.1.70 → 0.1.72

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ec25f83ab94d668fb0e695cea147b873355b441a475342b8ee4ceadc07c5fee0
4
- data.tar.gz: 540ca72ea16878da2e76ea11959a267267e6163fb37251e93bdf60ffc537dd9b
3
+ metadata.gz: bd59671afec98403ff0bfc353066d7bd0bb9199e17b67cd3a78a29a77b07305d
4
+ data.tar.gz: 8c4830adba43b107e584c81bccf76a944b968572f4289969cbc81147cec45c7f
5
5
  SHA512:
6
- metadata.gz: 2a46fb8778200bcd7a06c943d2c35974bcaff35697416728776be4420d28c6f673ea1ef6c346c0b4e657907710eddb03566e545f06104526ac769039103ca2ee
7
- data.tar.gz: 7790e1ccab6c414ca5043e43273517599ded85f20d6b0e354b70b4a90a17392b5c4ec8e3d99b9dfe443f2c4909507fb38892037e2753c176781115182c9d020c
6
+ metadata.gz: 0fb6c1aeced8294e471abe02308ce28ce51914eecbe789690d2e48c60ec649427cb9a477f39587ea4793a02cd936504ae7385b65b93c9ad1eedf5fdb6ac10438
7
+ data.tar.gz: 017cc2735e1f8a2db0dd9f22670e6c593b07dc7db1b93212abf8f9f028f4f30a102b5abda6109e6a26effc5668d45d52c027becceb97715ea457b13fb24dc8fd
data/README.md CHANGED
@@ -235,9 +235,15 @@ Class | Method | HTTP request | Description
235
235
  *Zyphr::ExecutionsApi* | [**cancel_execution**](docs/ExecutionsApi.md#cancel_execution) | **POST** /executions/{id}/cancel | Cancel a running execution
236
236
  *Zyphr::ExecutionsApi* | [**get_execution**](docs/ExecutionsApi.md#get_execution) | **GET** /executions/{id} | Get a workflow execution
237
237
  *Zyphr::ExecutionsApi* | [**retry_execution**](docs/ExecutionsApi.md#retry_execution) | **POST** /executions/{id}/retry | Retry a failed or cancelled execution
238
+ *Zyphr::InboundEmailApi* | [**create_inbox**](docs/InboundEmailApi.md#create_inbox) | **POST** /inboxes | Create an inbox
239
+ *Zyphr::InboundEmailApi* | [**delete_inbox**](docs/InboundEmailApi.md#delete_inbox) | **DELETE** /inboxes/{id} | Delete an inbox
238
240
  *Zyphr::InboundEmailApi* | [**get_inbound_attachment_url**](docs/InboundEmailApi.md#get_inbound_attachment_url) | **GET** /inbound-emails/{id}/attachments/{attachmentId} | Get an attachment download URL
239
241
  *Zyphr::InboundEmailApi* | [**get_inbound_email**](docs/InboundEmailApi.md#get_inbound_email) | **GET** /inbound-emails/{id} | Get a received email
242
+ *Zyphr::InboundEmailApi* | [**get_inbox**](docs/InboundEmailApi.md#get_inbox) | **GET** /inboxes/{id} | Get an inbox
240
243
  *Zyphr::InboundEmailApi* | [**list_inbound_emails**](docs/InboundEmailApi.md#list_inbound_emails) | **GET** /inbound-emails | List received emails
244
+ *Zyphr::InboundEmailApi* | [**list_inboxes**](docs/InboundEmailApi.md#list_inboxes) | **GET** /inboxes | List inboxes
245
+ *Zyphr::InboundEmailApi* | [**reply_to_inbound_email**](docs/InboundEmailApi.md#reply_to_inbound_email) | **POST** /inbound-emails/{id}/reply | Reply to a received email
246
+ *Zyphr::InboundEmailApi* | [**update_inbox**](docs/InboundEmailApi.md#update_inbox) | **PATCH** /inboxes/{id} | Update an inbox
241
247
  *Zyphr::InboxApi* | [**archive_inbox_notification**](docs/InboxApi.md#archive_inbox_notification) | **POST** /inbox/{id}/archive | Archive a notification
242
248
  *Zyphr::InboxApi* | [**archive_subscriber_notification**](docs/InboxApi.md#archive_subscriber_notification) | **POST** /subscriber-inbox/{id}/archive | Archive a notification
243
249
  *Zyphr::InboxApi* | [**delete_inbox_notification**](docs/InboxApi.md#delete_inbox_notification) | **DELETE** /inbox/{id} | Delete a notification
@@ -451,6 +457,7 @@ Class | Method | HTTP request | Description
451
457
  - [Zyphr::ConvertAnonymousUserRequestOneOf1AppleUser](docs/ConvertAnonymousUserRequestOneOf1AppleUser.md)
452
458
  - [Zyphr::ConvertAnonymousUserRequestOneOf1AppleUserName](docs/ConvertAnonymousUserRequestOneOf1AppleUserName.md)
453
459
  - [Zyphr::CreateCategoryRequest](docs/CreateCategoryRequest.md)
460
+ - [Zyphr::CreateInboxRequest](docs/CreateInboxRequest.md)
454
461
  - [Zyphr::CreateOrganizationRequest](docs/CreateOrganizationRequest.md)
455
462
  - [Zyphr::CreateSubscriberRequest](docs/CreateSubscriberRequest.md)
456
463
  - [Zyphr::CreateTemplateRequest](docs/CreateTemplateRequest.md)
@@ -543,9 +550,11 @@ Class | Method | HTTP request | Description
543
550
  - [Zyphr::InboundEmailListResponse](docs/InboundEmailListResponse.md)
544
551
  - [Zyphr::InboundEmailListResponseMeta](docs/InboundEmailListResponseMeta.md)
545
552
  - [Zyphr::InboundEmailResponse](docs/InboundEmailResponse.md)
553
+ - [Zyphr::Inbox](docs/Inbox.md)
546
554
  - [Zyphr::InboxListMeta](docs/InboxListMeta.md)
547
555
  - [Zyphr::InboxListResponse](docs/InboxListResponse.md)
548
556
  - [Zyphr::InboxNotificationResponse](docs/InboxNotificationResponse.md)
557
+ - [Zyphr::InboxResponse](docs/InboxResponse.md)
549
558
  - [Zyphr::InviteEndUser200Response](docs/InviteEndUser200Response.md)
550
559
  - [Zyphr::InviteEndUser200ResponseData](docs/InviteEndUser200ResponseData.md)
551
560
  - [Zyphr::InviteEndUserRequest](docs/InviteEndUserRequest.md)
@@ -664,6 +673,7 @@ Class | Method | HTTP request | Description
664
673
  - [Zyphr::RenderTemplateRequest](docs/RenderTemplateRequest.md)
665
674
  - [Zyphr::ReorderWorkflowStepsRequest](docs/ReorderWorkflowStepsRequest.md)
666
675
  - [Zyphr::ReplayWebhookEventsRequest](docs/ReplayWebhookEventsRequest.md)
676
+ - [Zyphr::ReplyToInboundEmailRequest](docs/ReplyToInboundEmailRequest.md)
667
677
  - [Zyphr::RequestMeta](docs/RequestMeta.md)
668
678
  - [Zyphr::ResendEmailVerificationRequest](docs/ResendEmailVerificationRequest.md)
669
679
  - [Zyphr::ResetPasswordRequest](docs/ResetPasswordRequest.md)
@@ -787,6 +797,7 @@ Class | Method | HTTP request | Description
787
797
  - [Zyphr::UpdateCategoryRequest](docs/UpdateCategoryRequest.md)
788
798
  - [Zyphr::UpdateEndUserByApplicationRequest](docs/UpdateEndUserByApplicationRequest.md)
789
799
  - [Zyphr::UpdateEndUserRequest](docs/UpdateEndUserRequest.md)
800
+ - [Zyphr::UpdateInboxRequest](docs/UpdateInboxRequest.md)
790
801
  - [Zyphr::UpdateOrganizationMemberRoleRequest](docs/UpdateOrganizationMemberRoleRequest.md)
791
802
  - [Zyphr::UpdateOrganizationRequest](docs/UpdateOrganizationRequest.md)
792
803
  - [Zyphr::UpdateSubscriberPreferences200Response](docs/UpdateSubscriberPreferences200Response.md)
@@ -0,0 +1,24 @@
1
+ # Zyphr::CreateInboxRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **domain_id** | **String** | A verified domain with inbound email enabled | |
8
+ | **local_part** | **String** | The part before `@`. Letters, numbers, `.`, `_` and `-`; cannot start or end with `.` or contain `..`. Stored lowercase. `dmarc-reports` is reserved. Mail to `<local_part>+anything@` also reaches the inbox. | |
9
+ | **name** | **String** | | [optional] |
10
+ | **from_name** | **String** | Display name for replies. No control characters and none of `\" \\ , ; @ : < >`. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zyphr'
16
+
17
+ instance = Zyphr::CreateInboxRequest.new(
18
+ domain_id: null,
19
+ local_part: support,
20
+ name: Support,
21
+ from_name: Acme Support
22
+ )
23
+ ```
24
+
data/docs/InboundEmail.md CHANGED
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional] |
8
8
  | **to_email** | **String** | The receiving address the mail was sent to | [optional] |
9
+ | **inbox_id** | **String** | The inbox the mail was addressed to, or null when the domain has no inboxes (or the inbox was deleted) | [optional] |
9
10
  | **from** | [**InboundEmailFrom**](InboundEmailFrom.md) | | [optional] |
10
11
  | **cc** | **Array<String>** | | [optional] |
11
12
  | **subject** | **String** | | [optional] |
@@ -29,6 +30,7 @@ require 'zyphr'
29
30
  instance = Zyphr::InboundEmail.new(
30
31
  id: null,
31
32
  to_email: support@inbound.acme.com,
33
+ inbox_id: null,
32
34
  from: null,
33
35
  cc: null,
34
36
  subject: null,
@@ -4,9 +4,156 @@ All URIs are relative to *https://api.zyphr.dev/v1*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**create_inbox**](InboundEmailApi.md#create_inbox) | **POST** /inboxes | Create an inbox |
8
+ | [**delete_inbox**](InboundEmailApi.md#delete_inbox) | **DELETE** /inboxes/{id} | Delete an inbox |
7
9
  | [**get_inbound_attachment_url**](InboundEmailApi.md#get_inbound_attachment_url) | **GET** /inbound-emails/{id}/attachments/{attachmentId} | Get an attachment download URL |
8
10
  | [**get_inbound_email**](InboundEmailApi.md#get_inbound_email) | **GET** /inbound-emails/{id} | Get a received email |
11
+ | [**get_inbox**](InboundEmailApi.md#get_inbox) | **GET** /inboxes/{id} | Get an inbox |
9
12
  | [**list_inbound_emails**](InboundEmailApi.md#list_inbound_emails) | **GET** /inbound-emails | List received emails |
13
+ | [**list_inboxes**](InboundEmailApi.md#list_inboxes) | **GET** /inboxes | List inboxes |
14
+ | [**reply_to_inbound_email**](InboundEmailApi.md#reply_to_inbound_email) | **POST** /inbound-emails/{id}/reply | Reply to a received email |
15
+ | [**update_inbox**](InboundEmailApi.md#update_inbox) | **PATCH** /inboxes/{id} | Update an inbox |
16
+
17
+
18
+ ## create_inbox
19
+
20
+ > <InboxResponse> create_inbox(create_inbox_request)
21
+
22
+ Create an inbox
23
+
24
+ Create a named receiving address, `<local_part>@inbound.<domain>`, on a domain with inbound email enabled. Test-mode keys cannot create, update or delete inboxes, because inboxes change live mail routing. Once a domain has at least one inbox, mail to any other address on it is dropped; a domain with no inboxes keeps receiving at every address. Requires a plan with inbound email (Starter or higher).
25
+
26
+ ### Examples
27
+
28
+ ```ruby
29
+ require 'time'
30
+ require 'zyphr'
31
+ # setup authorization
32
+ Zyphr.configure do |config|
33
+ # Configure API key authorization: ApiKeyAuth
34
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
35
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
36
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
37
+ end
38
+
39
+ api_instance = Zyphr::InboundEmailApi.new
40
+ create_inbox_request = Zyphr::CreateInboxRequest.new({domain_id: 'domain_id_example', local_part: 'support'}) # CreateInboxRequest |
41
+
42
+ begin
43
+ # Create an inbox
44
+ result = api_instance.create_inbox(create_inbox_request)
45
+ p result
46
+ rescue Zyphr::ApiError => e
47
+ puts "Error when calling InboundEmailApi->create_inbox: #{e}"
48
+ end
49
+ ```
50
+
51
+ #### Using the create_inbox_with_http_info variant
52
+
53
+ This returns an Array which contains the response data, status code and headers.
54
+
55
+ > <Array(<InboxResponse>, Integer, Hash)> create_inbox_with_http_info(create_inbox_request)
56
+
57
+ ```ruby
58
+ begin
59
+ # Create an inbox
60
+ data, status_code, headers = api_instance.create_inbox_with_http_info(create_inbox_request)
61
+ p status_code # => 2xx
62
+ p headers # => { ... }
63
+ p data # => <InboxResponse>
64
+ rescue Zyphr::ApiError => e
65
+ puts "Error when calling InboundEmailApi->create_inbox_with_http_info: #{e}"
66
+ end
67
+ ```
68
+
69
+ ### Parameters
70
+
71
+ | Name | Type | Description | Notes |
72
+ | ---- | ---- | ----------- | ----- |
73
+ | **create_inbox_request** | [**CreateInboxRequest**](CreateInboxRequest.md) | | |
74
+
75
+ ### Return type
76
+
77
+ [**InboxResponse**](InboxResponse.md)
78
+
79
+ ### Authorization
80
+
81
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
82
+
83
+ ### HTTP request headers
84
+
85
+ - **Content-Type**: application/json
86
+ - **Accept**: application/json
87
+
88
+
89
+ ## delete_inbox
90
+
91
+ > delete_inbox(id)
92
+
93
+ Delete an inbox
94
+
95
+ Delete the inbox. Mail it already received is kept (its `inbox_id` becomes null). If it was the domain's last inbox, the domain goes back to receiving at every address.
96
+
97
+ ### Examples
98
+
99
+ ```ruby
100
+ require 'time'
101
+ require 'zyphr'
102
+ # setup authorization
103
+ Zyphr.configure do |config|
104
+ # Configure API key authorization: ApiKeyAuth
105
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
106
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
107
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
108
+ end
109
+
110
+ api_instance = Zyphr::InboundEmailApi.new
111
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
112
+
113
+ begin
114
+ # Delete an inbox
115
+ api_instance.delete_inbox(id)
116
+ rescue Zyphr::ApiError => e
117
+ puts "Error when calling InboundEmailApi->delete_inbox: #{e}"
118
+ end
119
+ ```
120
+
121
+ #### Using the delete_inbox_with_http_info variant
122
+
123
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
124
+
125
+ > <Array(nil, Integer, Hash)> delete_inbox_with_http_info(id)
126
+
127
+ ```ruby
128
+ begin
129
+ # Delete an inbox
130
+ data, status_code, headers = api_instance.delete_inbox_with_http_info(id)
131
+ p status_code # => 2xx
132
+ p headers # => { ... }
133
+ p data # => nil
134
+ rescue Zyphr::ApiError => e
135
+ puts "Error when calling InboundEmailApi->delete_inbox_with_http_info: #{e}"
136
+ end
137
+ ```
138
+
139
+ ### Parameters
140
+
141
+ | Name | Type | Description | Notes |
142
+ | ---- | ---- | ----------- | ----- |
143
+ | **id** | **String** | | |
144
+
145
+ ### Return type
146
+
147
+ nil (empty response body)
148
+
149
+ ### Authorization
150
+
151
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
152
+
153
+ ### HTTP request headers
154
+
155
+ - **Content-Type**: Not defined
156
+ - **Accept**: Not defined
10
157
 
11
158
 
12
159
  ## get_inbound_attachment_url
@@ -153,6 +300,75 @@ end
153
300
  - **Accept**: application/json
154
301
 
155
302
 
303
+ ## get_inbox
304
+
305
+ > <InboxResponse> get_inbox(id)
306
+
307
+ Get an inbox
308
+
309
+ ### Examples
310
+
311
+ ```ruby
312
+ require 'time'
313
+ require 'zyphr'
314
+ # setup authorization
315
+ Zyphr.configure do |config|
316
+ # Configure API key authorization: ApiKeyAuth
317
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
318
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
319
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
320
+ end
321
+
322
+ api_instance = Zyphr::InboundEmailApi.new
323
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
324
+
325
+ begin
326
+ # Get an inbox
327
+ result = api_instance.get_inbox(id)
328
+ p result
329
+ rescue Zyphr::ApiError => e
330
+ puts "Error when calling InboundEmailApi->get_inbox: #{e}"
331
+ end
332
+ ```
333
+
334
+ #### Using the get_inbox_with_http_info variant
335
+
336
+ This returns an Array which contains the response data, status code and headers.
337
+
338
+ > <Array(<InboxResponse>, Integer, Hash)> get_inbox_with_http_info(id)
339
+
340
+ ```ruby
341
+ begin
342
+ # Get an inbox
343
+ data, status_code, headers = api_instance.get_inbox_with_http_info(id)
344
+ p status_code # => 2xx
345
+ p headers # => { ... }
346
+ p data # => <InboxResponse>
347
+ rescue Zyphr::ApiError => e
348
+ puts "Error when calling InboundEmailApi->get_inbox_with_http_info: #{e}"
349
+ end
350
+ ```
351
+
352
+ ### Parameters
353
+
354
+ | Name | Type | Description | Notes |
355
+ | ---- | ---- | ----------- | ----- |
356
+ | **id** | **String** | | |
357
+
358
+ ### Return type
359
+
360
+ [**InboxResponse**](InboxResponse.md)
361
+
362
+ ### Authorization
363
+
364
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
365
+
366
+ ### HTTP request headers
367
+
368
+ - **Content-Type**: Not defined
369
+ - **Accept**: application/json
370
+
371
+
156
372
  ## list_inbound_emails
157
373
 
158
374
  > <InboundEmailListResponse> list_inbound_emails(opts)
@@ -233,3 +449,219 @@ end
233
449
  - **Content-Type**: Not defined
234
450
  - **Accept**: application/json
235
451
 
452
+
453
+ ## list_inboxes
454
+
455
+ > <InboxListResponse> list_inboxes
456
+
457
+ List inboxes
458
+
459
+ ### Examples
460
+
461
+ ```ruby
462
+ require 'time'
463
+ require 'zyphr'
464
+ # setup authorization
465
+ Zyphr.configure do |config|
466
+ # Configure API key authorization: ApiKeyAuth
467
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
468
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
469
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
470
+ end
471
+
472
+ api_instance = Zyphr::InboundEmailApi.new
473
+
474
+ begin
475
+ # List inboxes
476
+ result = api_instance.list_inboxes
477
+ p result
478
+ rescue Zyphr::ApiError => e
479
+ puts "Error when calling InboundEmailApi->list_inboxes: #{e}"
480
+ end
481
+ ```
482
+
483
+ #### Using the list_inboxes_with_http_info variant
484
+
485
+ This returns an Array which contains the response data, status code and headers.
486
+
487
+ > <Array(<InboxListResponse>, Integer, Hash)> list_inboxes_with_http_info
488
+
489
+ ```ruby
490
+ begin
491
+ # List inboxes
492
+ data, status_code, headers = api_instance.list_inboxes_with_http_info
493
+ p status_code # => 2xx
494
+ p headers # => { ... }
495
+ p data # => <InboxListResponse>
496
+ rescue Zyphr::ApiError => e
497
+ puts "Error when calling InboundEmailApi->list_inboxes_with_http_info: #{e}"
498
+ end
499
+ ```
500
+
501
+ ### Parameters
502
+
503
+ This endpoint does not need any parameter.
504
+
505
+ ### Return type
506
+
507
+ [**InboxListResponse**](InboxListResponse.md)
508
+
509
+ ### Authorization
510
+
511
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
512
+
513
+ ### HTTP request headers
514
+
515
+ - **Content-Type**: Not defined
516
+ - **Accept**: application/json
517
+
518
+
519
+ ## reply_to_inbound_email
520
+
521
+ > <SendEmailResponse> reply_to_inbound_email(id, reply_to_inbound_email_request, opts)
522
+
523
+ Reply to a received email
524
+
525
+ Send a reply to a received email that threads under the original in the recipient's mail client. Zyphr sets `to` (the original sender), the `Re:` subject, and the `In-Reply-To` / `References` headers from the received email; any of those fields in the body are ignored. Everything else behaves exactly like `POST /emails` (`html`/`text`, `send_at`/`delay`, quotas, suppression). Templates are not supported, because a template's own subject would break threading. Quarantined or dropped mail cannot be replied to.
526
+
527
+ ### Examples
528
+
529
+ ```ruby
530
+ require 'time'
531
+ require 'zyphr'
532
+ # setup authorization
533
+ Zyphr.configure do |config|
534
+ # Configure API key authorization: ApiKeyAuth
535
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
536
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
537
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
538
+ end
539
+
540
+ api_instance = Zyphr::InboundEmailApi.new
541
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
542
+ reply_to_inbound_email_request = Zyphr::ReplyToInboundEmailRequest.new({from: Zyphr::EmailAddress.new}) # ReplyToInboundEmailRequest |
543
+ opts = {
544
+ idempotency_key: 'idempotency_key_example' # String |
545
+ }
546
+
547
+ begin
548
+ # Reply to a received email
549
+ result = api_instance.reply_to_inbound_email(id, reply_to_inbound_email_request, opts)
550
+ p result
551
+ rescue Zyphr::ApiError => e
552
+ puts "Error when calling InboundEmailApi->reply_to_inbound_email: #{e}"
553
+ end
554
+ ```
555
+
556
+ #### Using the reply_to_inbound_email_with_http_info variant
557
+
558
+ This returns an Array which contains the response data, status code and headers.
559
+
560
+ > <Array(<SendEmailResponse>, Integer, Hash)> reply_to_inbound_email_with_http_info(id, reply_to_inbound_email_request, opts)
561
+
562
+ ```ruby
563
+ begin
564
+ # Reply to a received email
565
+ data, status_code, headers = api_instance.reply_to_inbound_email_with_http_info(id, reply_to_inbound_email_request, opts)
566
+ p status_code # => 2xx
567
+ p headers # => { ... }
568
+ p data # => <SendEmailResponse>
569
+ rescue Zyphr::ApiError => e
570
+ puts "Error when calling InboundEmailApi->reply_to_inbound_email_with_http_info: #{e}"
571
+ end
572
+ ```
573
+
574
+ ### Parameters
575
+
576
+ | Name | Type | Description | Notes |
577
+ | ---- | ---- | ----------- | ----- |
578
+ | **id** | **String** | | |
579
+ | **reply_to_inbound_email_request** | [**ReplyToInboundEmailRequest**](ReplyToInboundEmailRequest.md) | | |
580
+ | **idempotency_key** | **String** | | [optional] |
581
+
582
+ ### Return type
583
+
584
+ [**SendEmailResponse**](SendEmailResponse.md)
585
+
586
+ ### Authorization
587
+
588
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
589
+
590
+ ### HTTP request headers
591
+
592
+ - **Content-Type**: application/json
593
+ - **Accept**: application/json
594
+
595
+
596
+ ## update_inbox
597
+
598
+ > <InboxResponse> update_inbox(id, update_inbox_request)
599
+
600
+ Update an inbox
601
+
602
+ Rename the inbox or change the display name recipients see. The address cannot change.
603
+
604
+ ### Examples
605
+
606
+ ```ruby
607
+ require 'time'
608
+ require 'zyphr'
609
+ # setup authorization
610
+ Zyphr.configure do |config|
611
+ # Configure API key authorization: ApiKeyAuth
612
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
613
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
614
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
615
+ end
616
+
617
+ api_instance = Zyphr::InboundEmailApi.new
618
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
619
+ update_inbox_request = Zyphr::UpdateInboxRequest.new # UpdateInboxRequest |
620
+
621
+ begin
622
+ # Update an inbox
623
+ result = api_instance.update_inbox(id, update_inbox_request)
624
+ p result
625
+ rescue Zyphr::ApiError => e
626
+ puts "Error when calling InboundEmailApi->update_inbox: #{e}"
627
+ end
628
+ ```
629
+
630
+ #### Using the update_inbox_with_http_info variant
631
+
632
+ This returns an Array which contains the response data, status code and headers.
633
+
634
+ > <Array(<InboxResponse>, Integer, Hash)> update_inbox_with_http_info(id, update_inbox_request)
635
+
636
+ ```ruby
637
+ begin
638
+ # Update an inbox
639
+ data, status_code, headers = api_instance.update_inbox_with_http_info(id, update_inbox_request)
640
+ p status_code # => 2xx
641
+ p headers # => { ... }
642
+ p data # => <InboxResponse>
643
+ rescue Zyphr::ApiError => e
644
+ puts "Error when calling InboundEmailApi->update_inbox_with_http_info: #{e}"
645
+ end
646
+ ```
647
+
648
+ ### Parameters
649
+
650
+ | Name | Type | Description | Notes |
651
+ | ---- | ---- | ----------- | ----- |
652
+ | **id** | **String** | | |
653
+ | **update_inbox_request** | [**UpdateInboxRequest**](UpdateInboxRequest.md) | | |
654
+
655
+ ### Return type
656
+
657
+ [**InboxResponse**](InboxResponse.md)
658
+
659
+ ### Authorization
660
+
661
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
662
+
663
+ ### HTTP request headers
664
+
665
+ - **Content-Type**: application/json
666
+ - **Accept**: application/json
667
+
data/docs/Inbox.md ADDED
@@ -0,0 +1,30 @@
1
+ # Zyphr::Inbox
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional] |
8
+ | **email_address** | **String** | The inbox&#39;s receiving address | [optional] |
9
+ | **domain_id** | **String** | | [optional] |
10
+ | **name** | **String** | Internal name (defaults to the address) | [optional] |
11
+ | **from_name** | **String** | Display name recipients see on replies | [optional] |
12
+ | **created_at** | **Time** | | [optional] |
13
+ | **updated_at** | **Time** | | [optional] |
14
+
15
+ ## Example
16
+
17
+ ```ruby
18
+ require 'zyphr'
19
+
20
+ instance = Zyphr::Inbox.new(
21
+ id: null,
22
+ email_address: support@inbound.acme.com,
23
+ domain_id: null,
24
+ name: Support,
25
+ from_name: Acme Support,
26
+ created_at: null,
27
+ updated_at: null
28
+ )
29
+ ```
30
+
@@ -0,0 +1,20 @@
1
+ # Zyphr::InboxResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Inbox**](Inbox.md) | | [optional] |
8
+ | **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::InboxResponse.new(
16
+ data: null,
17
+ meta: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,34 @@
1
+ # Zyphr::ReplyToInboundEmailRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **from** | [**EmailAddress**](EmailAddress.md) | Sender, on one of your verified sending domains. The API also accepts a plain email string for convenience. | |
8
+ | **html** | **String** | | [optional] |
9
+ | **text** | **String** | | [optional] |
10
+ | **reply_to** | **String** | | [optional] |
11
+ | **tags** | **Array&lt;String&gt;** | | [optional] |
12
+ | **metadata** | **Hash&lt;String, Object&gt;** | | [optional] |
13
+ | **classification** | **String** | | [optional] |
14
+ | **send_at** | **Time** | | [optional] |
15
+ | **delay** | **Integer** | Seconds to wait before sending | [optional] |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'zyphr'
21
+
22
+ instance = Zyphr::ReplyToInboundEmailRequest.new(
23
+ from: null,
24
+ html: null,
25
+ text: null,
26
+ reply_to: null,
27
+ tags: null,
28
+ metadata: null,
29
+ classification: null,
30
+ send_at: null,
31
+ delay: null
32
+ )
33
+ ```
34
+
@@ -7,6 +7,8 @@
7
7
  | **to** | [**Array&lt;EmailAddress&gt;**](EmailAddress.md) | Recipient(s). An array of EmailAddress objects. The API also accepts a single email string or an array of email strings for convenience. | |
8
8
  | **from** | [**EmailAddress**](EmailAddress.md) | Sender address. The API also accepts a plain email string for convenience. | [optional] |
9
9
  | **reply_to** | [**EmailAddress**](EmailAddress.md) | Reply-to address. The API also accepts a plain email string for convenience. | [optional] |
10
+ | **in_reply_to** | **String** | RFC 5322 Message-ID of the email this one replies to, e.g. &#x60;&lt;abc@example.com&gt;&#x60;. Sets the &#x60;In-Reply-To&#x60; header so the reply threads in the recipient&#39;s mail client. To reply to a received email, &#x60;POST /inbound-emails/{id}/reply&#x60; sets this for you. | [optional] |
11
+ | **references** | **Array&lt;String&gt;** | RFC 5322 Message-IDs of the thread, oldest first. Sets the &#x60;References&#x60; header. | [optional] |
10
12
  | **cc** | **Array&lt;String&gt;** | CC recipient email address(es). | [optional] |
11
13
  | **bcc** | **Array&lt;String&gt;** | BCC recipient email address(es). | [optional] |
12
14
  | **subject** | **String** | | |
@@ -31,6 +33,8 @@ instance = Zyphr::SendEmailRequest.new(
31
33
  to: [{&quot;email&quot;:&quot;user@example.com&quot;,&quot;name&quot;:&quot;John Doe&quot;}],
32
34
  from: null,
33
35
  reply_to: null,
36
+ in_reply_to: &lt;010f019efa393e0c@us-east-2.amazonses.com&gt;,
37
+ references: null,
34
38
  cc: null,
35
39
  bcc: null,
36
40
  subject: Welcome to Zyphr!,
data/docs/SlackApi.md CHANGED
@@ -167,7 +167,7 @@ end
167
167
 
168
168
  Send a Slack message
169
169
 
170
- Send a message to a Slack channel through a connected Slack workspace. Either `text` or `blocks` must be provided. If `connection_id` is omitted, the project's active Slack connection is used. If `channel` is omitted, the connection's default channel is used.
170
+ Queue a message to a Slack channel through a connected Slack workspace. Either `text` or `blocks` must be provided. If `connection_id` is omitted, the project's active Slack connection is used. If `channel` is omitted, the connection's default channel is used. The message is accepted with status `queued` and delivered asynchronously, with retries on transient Slack errors and rate limits. Poll `GET /slack/messages/{id}` for the outcome: `sent`, with `message_ts`, or `failed`, with the reason.
171
171
 
172
172
  ### Examples
173
173