zyphr 0.1.8 → 0.1.10

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 (26) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +16 -0
  3. data/docs/GenerateSubscriberToken200Response.md +18 -0
  4. data/docs/GenerateSubscriberToken200ResponseData.md +22 -0
  5. data/docs/GenerateSubscriberTokenRequest.md +20 -0
  6. data/docs/InboxApi.md +724 -33
  7. data/docs/MarkAllSubscriberNotificationsReadRequest.md +18 -0
  8. data/docs/UpdateSubscriberPreferencesRequest.md +18 -0
  9. data/docs/UpdateSubscriberPreferencesRequestPreferencesInner.md +22 -0
  10. data/lib/zyphr/api/inbox_api.rb +616 -0
  11. data/lib/zyphr/models/generate_subscriber_token200_response.rb +220 -0
  12. data/lib/zyphr/models/generate_subscriber_token200_response_data.rb +240 -0
  13. data/lib/zyphr/models/generate_subscriber_token_request.rb +232 -0
  14. data/lib/zyphr/models/mark_all_subscriber_notifications_read_request.rb +221 -0
  15. data/lib/zyphr/models/update_subscriber_preferences_request.rb +257 -0
  16. data/lib/zyphr/models/update_subscriber_preferences_request_preferences_inner.rb +298 -0
  17. data/lib/zyphr.rb +6 -0
  18. data/spec/api/inbox_api_spec.rb +118 -0
  19. data/spec/models/generate_subscriber_token200_response_data_spec.rb +48 -0
  20. data/spec/models/generate_subscriber_token200_response_spec.rb +36 -0
  21. data/spec/models/generate_subscriber_token_request_spec.rb +42 -0
  22. data/spec/models/mark_all_subscriber_notifications_read_request_spec.rb +36 -0
  23. data/spec/models/update_subscriber_preferences_request_preferences_inner_spec.rb +52 -0
  24. data/spec/models/update_subscriber_preferences_request_spec.rb +36 -0
  25. data/zyphr.gemspec +1 -1
  26. metadata +26 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 77b18a9df224842811db8b7f72dfd63d188a951ed7dde4e2c69fa8cb18a8c2f9
4
- data.tar.gz: d97c58c96dd90332935ba0fea677771ffdb33532143f29896c3f3ce1e78fb77f
3
+ metadata.gz: 7f20ac2c64eb37be6c9a926654b72f74ce736f270422a5fc2ade85262f385823
4
+ data.tar.gz: 06bc6b7da62665cdb46cfb2c1663d554dd546c0829a8ec7da55222629db1dab5
5
5
  SHA512:
6
- metadata.gz: 7d77df0a6c198f664078c9a2d513ce833ee58d7f8452da4bf92f852e82d8a768b6ed1f3969baa1568e51130a8c6e7be79c6a559f10b3af90f99717f08d0e903a
7
- data.tar.gz: e03d2403270db2aec8b11f6fb17f010aec220d9c06170a98d2cfb40f915f37d98e1ab27ebc27bb5ada6d3953e53b30ad8bbf7dda03b97d63006ff5063f71c63c
6
+ metadata.gz: 7f8f097e1b0d041b5e38d7cf875b65ba7da4f50ba91b0e04f9ca4c3e7a3e84b3349f399cce5b7e1e6f044e3538a9b818adeb73bfd3aa5a8ed50f7312f959b5aa
7
+ data.tar.gz: 9425fad896e2418f26aa2864f39bb9b0e900e3ad48d24f1ae280ace3541ec9eca4073fe1081acd46228be3314050b72bc3bcff5b090f5735be884655ec11e825
data/README.md CHANGED
@@ -187,14 +187,24 @@ Class | Method | HTTP request | Description
187
187
  *Zyphr::EmailsApi* | [**send_batch_email**](docs/EmailsApi.md#send_batch_email) | **POST** /emails/batch | Send batch emails
188
188
  *Zyphr::EmailsApi* | [**send_email**](docs/EmailsApi.md#send_email) | **POST** /emails | Send an email
189
189
  *Zyphr::InboxApi* | [**archive_inbox_notification**](docs/InboxApi.md#archive_inbox_notification) | **POST** /inbox/{id}/archive | Archive a notification
190
+ *Zyphr::InboxApi* | [**archive_subscriber_notification**](docs/InboxApi.md#archive_subscriber_notification) | **POST** /subscriber-inbox/{id}/archive | Archive a notification
190
191
  *Zyphr::InboxApi* | [**delete_inbox_notification**](docs/InboxApi.md#delete_inbox_notification) | **DELETE** /inbox/{id} | Delete a notification
192
+ *Zyphr::InboxApi* | [**delete_subscriber_notification**](docs/InboxApi.md#delete_subscriber_notification) | **DELETE** /subscriber-inbox/{id} | Delete a notification
193
+ *Zyphr::InboxApi* | [**generate_subscriber_token**](docs/InboxApi.md#generate_subscriber_token) | **POST** /subscriber-inbox/token | Generate a subscriber token
191
194
  *Zyphr::InboxApi* | [**get_inbox_notification**](docs/InboxApi.md#get_inbox_notification) | **GET** /inbox/{id} | Get a notification
195
+ *Zyphr::InboxApi* | [**get_subscriber_inbox_preferences**](docs/InboxApi.md#get_subscriber_inbox_preferences) | **GET** /subscriber-inbox/preferences | Get subscriber preferences
196
+ *Zyphr::InboxApi* | [**get_subscriber_notification**](docs/InboxApi.md#get_subscriber_notification) | **GET** /subscriber-inbox/{id} | Get a notification
197
+ *Zyphr::InboxApi* | [**get_subscriber_unread_count**](docs/InboxApi.md#get_subscriber_unread_count) | **GET** /subscriber-inbox/unread-count | Get unread count
192
198
  *Zyphr::InboxApi* | [**get_unread_count**](docs/InboxApi.md#get_unread_count) | **GET** /inbox/unread-count | Get unread notification count
193
199
  *Zyphr::InboxApi* | [**list_inbox**](docs/InboxApi.md#list_inbox) | **GET** /inbox | List inbox notifications
200
+ *Zyphr::InboxApi* | [**list_subscriber_notifications**](docs/InboxApi.md#list_subscriber_notifications) | **GET** /subscriber-inbox | List subscriber notifications
194
201
  *Zyphr::InboxApi* | [**mark_all_inbox_read**](docs/InboxApi.md#mark_all_inbox_read) | **POST** /inbox/read-all | Mark all notifications as read
202
+ *Zyphr::InboxApi* | [**mark_all_subscriber_notifications_read**](docs/InboxApi.md#mark_all_subscriber_notifications_read) | **POST** /subscriber-inbox/read-all | Mark all notifications as read
195
203
  *Zyphr::InboxApi* | [**mark_inbox_read**](docs/InboxApi.md#mark_inbox_read) | **POST** /inbox/{id}/read | Mark notification as read
204
+ *Zyphr::InboxApi* | [**mark_subscriber_notification_read**](docs/InboxApi.md#mark_subscriber_notification_read) | **POST** /subscriber-inbox/{id}/read | Mark notification as read
196
205
  *Zyphr::InboxApi* | [**send_batch_in_app**](docs/InboxApi.md#send_batch_in_app) | **POST** /inbox/send/batch | Send batch in-app notifications
197
206
  *Zyphr::InboxApi* | [**send_in_app**](docs/InboxApi.md#send_in_app) | **POST** /inbox/send | Send an in-app notification
207
+ *Zyphr::InboxApi* | [**update_subscriber_preferences**](docs/InboxApi.md#update_subscriber_preferences) | **PUT** /subscriber-inbox/preferences | Update subscriber preferences
198
208
  *Zyphr::PushApi* | [**get_push**](docs/PushApi.md#get_push) | **GET** /push/{id} | Get push notification details
199
209
  *Zyphr::PushApi* | [**get_push_stats**](docs/PushApi.md#get_push_stats) | **GET** /push/stats | Get push notification statistics
200
210
  *Zyphr::PushApi* | [**list_device_push_topics**](docs/PushApi.md#list_device_push_topics) | **GET** /push/devices/{id}/topics | List topics for a device
@@ -370,6 +380,9 @@ Class | Method | HTTP request | Description
370
380
  - [Zyphr::EndUserDeleteResponse](docs/EndUserDeleteResponse.md)
371
381
  - [Zyphr::EndUserDeleteResponseData](docs/EndUserDeleteResponseData.md)
372
382
  - [Zyphr::ForgotPasswordRequest](docs/ForgotPasswordRequest.md)
383
+ - [Zyphr::GenerateSubscriberToken200Response](docs/GenerateSubscriberToken200Response.md)
384
+ - [Zyphr::GenerateSubscriberToken200ResponseData](docs/GenerateSubscriberToken200ResponseData.md)
385
+ - [Zyphr::GenerateSubscriberTokenRequest](docs/GenerateSubscriberTokenRequest.md)
373
386
  - [Zyphr::GenerateWaaSPortalToken201Response](docs/GenerateWaaSPortalToken201Response.md)
374
387
  - [Zyphr::GetWaaSEndpoint200Response](docs/GetWaaSEndpoint200Response.md)
375
388
  - [Zyphr::GetWaaSUsage200Response](docs/GetWaaSUsage200Response.md)
@@ -389,6 +402,7 @@ Class | Method | HTTP request | Description
389
402
  - [Zyphr::MarkAllInboxReadRequest](docs/MarkAllInboxReadRequest.md)
390
403
  - [Zyphr::MarkAllReadData](docs/MarkAllReadData.md)
391
404
  - [Zyphr::MarkAllReadResponse](docs/MarkAllReadResponse.md)
405
+ - [Zyphr::MarkAllSubscriberNotificationsReadRequest](docs/MarkAllSubscriberNotificationsReadRequest.md)
392
406
  - [Zyphr::MarkInboxReadRequest](docs/MarkInboxReadRequest.md)
393
407
  - [Zyphr::MfaBackupCodesResponse](docs/MfaBackupCodesResponse.md)
394
408
  - [Zyphr::MfaBackupCodesResponseData](docs/MfaBackupCodesResponseData.md)
@@ -554,6 +568,8 @@ Class | Method | HTTP request | Description
554
568
  - [Zyphr::UnsubscribeResponse](docs/UnsubscribeResponse.md)
555
569
  - [Zyphr::UpdateCategoryRequest](docs/UpdateCategoryRequest.md)
556
570
  - [Zyphr::UpdateEndUserRequest](docs/UpdateEndUserRequest.md)
571
+ - [Zyphr::UpdateSubscriberPreferencesRequest](docs/UpdateSubscriberPreferencesRequest.md)
572
+ - [Zyphr::UpdateSubscriberPreferencesRequestPreferencesInner](docs/UpdateSubscriberPreferencesRequestPreferencesInner.md)
557
573
  - [Zyphr::UpdateSubscriberRequest](docs/UpdateSubscriberRequest.md)
558
574
  - [Zyphr::UpdateTemplateRequest](docs/UpdateTemplateRequest.md)
559
575
  - [Zyphr::UpdateTopicRequest](docs/UpdateTopicRequest.md)
data/docs/GenerateSubscriberToken200Response.md ADDED
@@ -0,0 +1,18 @@
1
+ # Zyphr::GenerateSubscriberToken200Response
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**GenerateSubscriberToken200ResponseData**](GenerateSubscriberToken200ResponseData.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'zyphr'
13
+
14
+ instance = Zyphr::GenerateSubscriberToken200Response.new(
15
+ data: null
16
+ )
17
+ ```
18
+
data/docs/GenerateSubscriberToken200ResponseData.md ADDED
@@ -0,0 +1,22 @@
1
+ # Zyphr::GenerateSubscriberToken200ResponseData
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **token** | **String** | JWT subscriber token for client-side authentication | [optional] |
8
+ | **subscriber_id** | **String** | | [optional] |
9
+ | **expires_in** | **Integer** | Token lifetime in seconds | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'zyphr'
15
+
16
+ instance = Zyphr::GenerateSubscriberToken200ResponseData.new(
17
+ token: null,
18
+ subscriber_id: null,
19
+ expires_in: 604800
20
+ )
21
+ ```
22
+
data/docs/GenerateSubscriberTokenRequest.md ADDED
@@ -0,0 +1,20 @@
1
+ # Zyphr::GenerateSubscriberTokenRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **subscriber_id** | **String** | Internal subscriber ID | [optional] |
8
+ | **external_id** | **String** | Your external subscriber ID | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'zyphr'
14
+
15
+ instance = Zyphr::GenerateSubscriberTokenRequest.new(
16
+ subscriber_id: null,
17
+ external_id: null
18
+ )
19
+ ```
20
+