zyphr 0.1.3 → 0.1.6

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 (60) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +4 -3
  3. data/docs/Category.md +4 -2
  4. data/docs/Device.md +10 -12
  5. data/docs/DeviceStats.md +3 -1
  6. data/docs/DevicesApi.md +3 -3
  7. data/docs/PushApi.md +3 -3
  8. data/docs/PushMessage.md +13 -7
  9. data/docs/PushMessageDetail.md +17 -15
  10. data/docs/PushMessageDetailAllOfActionButtons.md +24 -0
  11. data/docs/RegisterDeviceRequest.md +4 -14
  12. data/docs/SMSApi.md +4 -4
  13. data/docs/SendPushRequest.md +35 -15
  14. data/docs/SendPushRequestActionButtonsInner.md +24 -0
  15. data/docs/TemplatesApi.md +2 -2
  16. data/docs/TopicsApi.md +2 -2
  17. data/docs/WaaSApplication.md +4 -2
  18. data/docs/WaaSApplicationsApi.md +1 -1
  19. data/docs/{WebhookWorkspaceMetricsResponse.md → WebhookAccountMetricsResponse.md} +3 -3
  20. data/docs/WebhooksApi.md +70 -70
  21. data/lib/zyphr/api/devices_api.rb +4 -4
  22. data/lib/zyphr/api/push_api.rb +4 -4
  23. data/lib/zyphr/api/sms_api.rb +8 -8
  24. data/lib/zyphr/api/templates_api.rb +4 -4
  25. data/lib/zyphr/api/topics_api.rb +4 -4
  26. data/lib/zyphr/api/waa_s_applications_api.rb +2 -2
  27. data/lib/zyphr/api/webhooks_api.rb +59 -59
  28. data/lib/zyphr/models/category.rb +16 -7
  29. data/lib/zyphr/models/device.rb +34 -57
  30. data/lib/zyphr/models/device_stats.rb +13 -4
  31. data/lib/zyphr/models/push_message.rb +67 -36
  32. data/lib/zyphr/models/push_message_detail.rb +88 -75
  33. data/lib/zyphr/models/push_message_detail_all_of_action_buttons.rb +247 -0
  34. data/lib/zyphr/models/register_device_request.rb +43 -59
  35. data/lib/zyphr/models/send_push_request.rb +278 -91
  36. data/lib/zyphr/models/{push_payload.rb → send_push_request_action_buttons_inner.rb} +72 -73
  37. data/lib/zyphr/models/waa_s_application.rb +16 -7
  38. data/lib/zyphr/models/{webhook_workspace_metrics_response.rb → webhook_account_metrics_response.rb} +4 -4
  39. data/lib/zyphr.rb +3 -2
  40. data/spec/api/devices_api_spec.rb +2 -2
  41. data/spec/api/push_api_spec.rb +2 -2
  42. data/spec/api/sms_api_spec.rb +4 -4
  43. data/spec/api/templates_api_spec.rb +2 -2
  44. data/spec/api/topics_api_spec.rb +2 -2
  45. data/spec/api/waa_s_applications_api_spec.rb +1 -1
  46. data/spec/api/webhooks_api_spec.rb +12 -12
  47. data/spec/models/category_spec.rb +7 -1
  48. data/spec/models/device_spec.rb +5 -15
  49. data/spec/models/device_stats_spec.rb +6 -0
  50. data/spec/models/{push_payload_spec.rb → push_message_detail_all_of_action_buttons_spec.rb} +10 -34
  51. data/spec/models/push_message_detail_spec.rb +26 -20
  52. data/spec/models/push_message_spec.rb +26 -8
  53. data/spec/models/register_device_request_spec.rb +2 -32
  54. data/spec/models/send_push_request_action_buttons_inner_spec.rb +54 -0
  55. data/spec/models/send_push_request_spec.rb +67 -11
  56. data/spec/models/waa_s_application_spec.rb +7 -1
  57. data/spec/models/{webhook_workspace_metrics_response_spec.rb → webhook_account_metrics_response_spec.rb} +6 -6
  58. data/zyphr.gemspec +1 -1
  59. metadata +328 -324
  60. data/docs/PushPayload.md +0 -32
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: cb322a370987112eecde7472cc94c1bd7e2a70f85e12ce58cfceb91d276e237c
4
- data.tar.gz: ad3b758dd0e81d3a2d420139097be834087d048224d783d933fdf71ff2096d33
3
+ metadata.gz: b823181930cbf53122e8740c542669b5a33e71ec29077e19f41d48cd78730c9e
4
+ data.tar.gz: b6ea90bdf625440428ef2c99802f2419fe14522bce62a4a9261ff32a6d2ad8d3
5
5
  SHA512:
6
- metadata.gz: 3fbf332fb3ab3cabab515e8089f4a72c8790a614127daac30600faeaabdeb1ac37726f4d14ce27c9f9c7e9839e93e9bd2f0ddc1fc5d0dde341b3222ea359122c
7
- data.tar.gz: c6f1368310cd82fac757e2e86eb0c2f8e63c2f7bae6f3c00450a5f25435eac4a6eac9d099cd48a644836802ff5d2388298416f5ed61e62bec2085c9c9f6dfd8e
6
+ metadata.gz: f1209847c55c3b00bda91aea08eab10fdd145afe96febe5d2fafb6be85a9f1cbe2417a3104a6e5ec328de68730f9e62fef7b2b2b4f2ad85c36d87b17badff1ec
7
+ data.tar.gz: 50471d0a92bf1d6f36b9217ec0f3396d4d4a64d8070f7d589aea1856283514b3c1f37f5141d785bdff69b9106e8b73a740c288a960f59e07f49b642eed854e2e
data/README.md CHANGED
@@ -281,6 +281,7 @@ Class | Method | HTTP request | Description
281
281
  *Zyphr::WebhooksApi* | [**close_webhook_circuit**](docs/WebhooksApi.md#close_webhook_circuit) | **POST** /v1/webhooks/{id}/circuit/close | Force close circuit breaker
282
282
  *Zyphr::WebhooksApi* | [**create_webhook**](docs/WebhooksApi.md#create_webhook) | **POST** /v1/webhooks | Create webhook
283
283
  *Zyphr::WebhooksApi* | [**delete_webhook**](docs/WebhooksApi.md#delete_webhook) | **DELETE** /v1/webhooks/{id} | Delete webhook
284
+ *Zyphr::WebhooksApi* | [**get_account_webhook_metrics**](docs/WebhooksApi.md#get_account_webhook_metrics) | **GET** /v1/webhooks/metrics | Get account webhook metrics
284
285
  *Zyphr::WebhooksApi* | [**get_webhook**](docs/WebhooksApi.md#get_webhook) | **GET** /v1/webhooks/{id} | Get webhook
285
286
  *Zyphr::WebhooksApi* | [**get_webhook_circuit_state**](docs/WebhooksApi.md#get_webhook_circuit_state) | **GET** /v1/webhooks/{id}/circuit | Get circuit breaker state
286
287
  *Zyphr::WebhooksApi* | [**get_webhook_delivery**](docs/WebhooksApi.md#get_webhook_delivery) | **GET** /v1/webhooks/{id}/deliveries/{deliveryId} | Get webhook delivery details
@@ -289,7 +290,6 @@ Class | Method | HTTP request | Description
289
290
  *Zyphr::WebhooksApi* | [**get_webhook_metrics**](docs/WebhooksApi.md#get_webhook_metrics) | **GET** /v1/webhooks/{id}/metrics | Get webhook health metrics
290
291
  *Zyphr::WebhooksApi* | [**get_webhook_regions**](docs/WebhooksApi.md#get_webhook_regions) | **GET** /v1/webhooks/regions | Get available webhook regions
291
292
  *Zyphr::WebhooksApi* | [**get_webhook_usage**](docs/WebhooksApi.md#get_webhook_usage) | **GET** /v1/webhooks/usage | Get webhook usage metrics
292
- *Zyphr::WebhooksApi* | [**get_workspace_webhook_metrics**](docs/WebhooksApi.md#get_workspace_webhook_metrics) | **GET** /v1/webhooks/metrics | Get workspace webhook metrics
293
293
  *Zyphr::WebhooksApi* | [**list_webhook_deliveries**](docs/WebhooksApi.md#list_webhook_deliveries) | **GET** /v1/webhooks/{id}/deliveries | List webhook deliveries
294
294
  *Zyphr::WebhooksApi* | [**list_webhook_event_types**](docs/WebhooksApi.md#list_webhook_event_types) | **GET** /v1/webhooks/events | List webhook event types
295
295
  *Zyphr::WebhooksApi* | [**list_webhook_versions**](docs/WebhooksApi.md#list_webhook_versions) | **GET** /v1/webhooks/versions | List webhook API versions
@@ -444,7 +444,7 @@ Class | Method | HTTP request | Description
444
444
  - [Zyphr::PushListResponse](docs/PushListResponse.md)
445
445
  - [Zyphr::PushMessage](docs/PushMessage.md)
446
446
  - [Zyphr::PushMessageDetail](docs/PushMessageDetail.md)
447
- - [Zyphr::PushPayload](docs/PushPayload.md)
447
+ - [Zyphr::PushMessageDetailAllOfActionButtons](docs/PushMessageDetailAllOfActionButtons.md)
448
448
  - [Zyphr::PushStatsData](docs/PushStatsData.md)
449
449
  - [Zyphr::PushStatsResponse](docs/PushStatsResponse.md)
450
450
  - [Zyphr::PushTopicDevice](docs/PushTopicDevice.md)
@@ -490,6 +490,7 @@ Class | Method | HTTP request | Description
490
490
  - [Zyphr::SendInAppRequest](docs/SendInAppRequest.md)
491
491
  - [Zyphr::SendInAppResponse](docs/SendInAppResponse.md)
492
492
  - [Zyphr::SendPushRequest](docs/SendPushRequest.md)
493
+ - [Zyphr::SendPushRequestActionButtonsInner](docs/SendPushRequestActionButtonsInner.md)
493
494
  - [Zyphr::SendPushResponse](docs/SendPushResponse.md)
494
495
  - [Zyphr::SendPushResponseData](docs/SendPushResponseData.md)
495
496
  - [Zyphr::SendPushToTopicData](docs/SendPushToTopicData.md)
@@ -596,6 +597,7 @@ Class | Method | HTTP request | Description
596
597
  - [Zyphr::WebAuthnVerifyRegistrationResponse](docs/WebAuthnVerifyRegistrationResponse.md)
597
598
  - [Zyphr::WebAuthnVerifyRegistrationResponseData](docs/WebAuthnVerifyRegistrationResponseData.md)
598
599
  - [Zyphr::Webhook](docs/Webhook.md)
600
+ - [Zyphr::WebhookAccountMetricsResponse](docs/WebhookAccountMetricsResponse.md)
599
601
  - [Zyphr::WebhookBulkRetryResponse](docs/WebhookBulkRetryResponse.md)
600
602
  - [Zyphr::WebhookCircuitState](docs/WebhookCircuitState.md)
601
603
  - [Zyphr::WebhookCircuitStateResponse](docs/WebhookCircuitStateResponse.md)
@@ -630,7 +632,6 @@ Class | Method | HTTP request | Description
630
632
  - [Zyphr::WebhookVersion](docs/WebhookVersion.md)
631
633
  - [Zyphr::WebhookVersionsResponse](docs/WebhookVersionsResponse.md)
632
634
  - [Zyphr::WebhookVersionsResponseData](docs/WebhookVersionsResponseData.md)
633
- - [Zyphr::WebhookWorkspaceMetricsResponse](docs/WebhookWorkspaceMetricsResponse.md)
634
635
  - [Zyphr::WithdrawSubscriberConsentRequest](docs/WithdrawSubscriberConsentRequest.md)
635
636
 
636
637
 
data/docs/Category.md CHANGED
@@ -5,7 +5,8 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional] |
8
- | **workspace_id** | **String** | | [optional] |
8
+ | **account_id** | **String** | | [optional] |
9
+ | **project_id** | **String** | | [optional] |
9
10
  | **name** | **String** | | [optional] |
10
11
  | **slug** | **String** | | [optional] |
11
12
  | **description** | **String** | | [optional] |
@@ -21,7 +22,8 @@ require 'zyphr'
21
22
 
22
23
  instance = Zyphr::Category.new(
23
24
  id: null,
24
- workspace_id: null,
25
+ account_id: null,
26
+ project_id: null,
25
27
  name: null,
26
28
  slug: null,
27
29
  description: null,
data/docs/Device.md CHANGED
@@ -5,14 +5,13 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional] |
8
- | **subscriber_id** | **String** | | [optional] |
8
+ | **user_id** | **String** | | [optional] |
9
9
  | **platform** | **String** | | [optional] |
10
- | **app_version** | **String** | | [optional] |
11
- | **device_model** | **String** | | [optional] |
12
- | **os_version** | **String** | | [optional] |
13
- | **status** | **String** | | [optional] |
10
+ | **token** | **String** | | [optional] |
11
+ | **metadata** | **Hash<String, Object>** | | [optional] |
12
+ | **last_active_at** | **Time** | | [optional] |
14
13
  | **created_at** | **Time** | | [optional] |
15
- | **last_seen_at** | **Time** | | [optional] |
14
+ | **updated_at** | **Time** | | [optional] |
16
15
 
17
16
  ## Example
18
17
 
@@ -21,14 +20,13 @@ require 'zyphr'
21
20
 
22
21
  instance = Zyphr::Device.new(
23
22
  id: null,
24
- subscriber_id: null,
23
+ user_id: null,
25
24
  platform: null,
26
- app_version: null,
27
- device_model: null,
28
- os_version: null,
29
- status: null,
25
+ token: null,
26
+ metadata: null,
27
+ last_active_at: null,
30
28
  created_at: null,
31
- last_seen_at: null
29
+ updated_at: null
32
30
  )
33
31
  ```
34
32
 
data/docs/DeviceStats.md CHANGED
@@ -6,6 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **total** | **Integer** | | [optional] |
8
8
  | **by_platform** | **Hash<String, Integer>** | | [optional] |
9
+ | **active30_days** | **Integer** | | [optional] |
9
10
 
10
11
  ## Example
11
12
 
@@ -14,7 +15,8 @@ require 'zyphr'
14
15
 
15
16
  instance = Zyphr::DeviceStats.new(
16
17
  total: null,
17
- by_platform: null
18
+ by_platform: null,
19
+ active30_days: null
18
20
  )
19
21
  ```
20
22
 
data/docs/DevicesApi.md CHANGED
@@ -231,7 +231,7 @@ end
231
231
 
232
232
  Get device statistics
233
233
 
234
- Get aggregated device statistics for the workspace.
234
+ Get aggregated device statistics for the account.
235
235
 
236
236
  ### Examples
237
237
 
@@ -299,7 +299,7 @@ This endpoint does not need any parameter.
299
299
 
300
300
  List devices
301
301
 
302
- List registered devices for the workspace with optional filtering.
302
+ List registered devices for the account with optional filtering.
303
303
 
304
304
  ### Examples
305
305
 
@@ -394,7 +394,7 @@ Zyphr.configure do |config|
394
394
  end
395
395
 
396
396
  api_instance = Zyphr::DevicesApi.new
397
- register_device_request = Zyphr::RegisterDeviceRequest.new({platform: 'ios', token: 'token_example'}) # RegisterDeviceRequest |
397
+ register_device_request = Zyphr::RegisterDeviceRequest.new({user_id: 'user_id_example', platform: 'ios', token: 'token_example'}) # RegisterDeviceRequest |
398
398
 
399
399
  begin
400
400
  # Register a device
data/docs/PushApi.md CHANGED
@@ -92,7 +92,7 @@ end
92
92
 
93
93
  Get push notification statistics
94
94
 
95
- Get aggregated push notification statistics for the workspace.
95
+ Get aggregated push notification statistics for the account.
96
96
 
97
97
  ### Examples
98
98
 
@@ -231,7 +231,7 @@ end
231
231
 
232
232
  List push notifications
233
233
 
234
- List push notification messages for the workspace with optional filtering.
234
+ List push notification messages for the account with optional filtering.
235
235
 
236
236
  ### Examples
237
237
 
@@ -405,7 +405,7 @@ Zyphr.configure do |config|
405
405
  end
406
406
 
407
407
  api_instance = Zyphr::PushApi.new
408
- send_push_request = Zyphr::SendPushRequest.new({payload: Zyphr::PushPayload.new({title: 'New Message', body: 'You have a new notification'})}) # SendPushRequest |
408
+ send_push_request = Zyphr::SendPushRequest.new # SendPushRequest |
409
409
 
410
410
  begin
411
411
  # Send a push notification
data/docs/PushMessage.md CHANGED
@@ -6,14 +6,17 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional] |
8
8
  | **device_id** | **String** | | [optional] |
9
- | **subscriber_id** | **String** | | [optional] |
9
+ | **user_id** | **String** | | [optional] |
10
+ | **platform** | **String** | | [optional] |
10
11
  | **title** | **String** | | [optional] |
11
12
  | **body** | **String** | | [optional] |
13
+ | **data** | **Hash<String, Object>** | | [optional] |
12
14
  | **status** | **String** | | [optional] |
13
- | **platform** | **String** | | [optional] |
14
- | **created_at** | **Time** | | [optional] |
15
+ | **tags** | **Array<String>** | | [optional] |
16
+ | **queued_at** | **Time** | | [optional] |
15
17
  | **sent_at** | **Time** | | [optional] |
16
18
  | **delivered_at** | **Time** | | [optional] |
19
+ | **created_at** | **Time** | | [optional] |
17
20
 
18
21
  ## Example
19
22
 
@@ -23,14 +26,17 @@ require 'zyphr'
23
26
  instance = Zyphr::PushMessage.new(
24
27
  id: null,
25
28
  device_id: null,
26
- subscriber_id: null,
29
+ user_id: null,
30
+ platform: null,
27
31
  title: null,
28
32
  body: null,
33
+ data: null,
29
34
  status: null,
30
- platform: null,
31
- created_at: null,
35
+ tags: null,
36
+ queued_at: null,
32
37
  sent_at: null,
33
- delivered_at: null
38
+ delivered_at: null,
39
+ created_at: null
34
40
  )
35
41
  ```
36
42
 
data/docs/PushMessageDetail.md CHANGED
@@ -6,25 +6,26 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional] |
8
8
  | **device_id** | **String** | | [optional] |
9
- | **subscriber_id** | **String** | | [optional] |
9
+ | **user_id** | **String** | | [optional] |
10
+ | **platform** | **String** | | [optional] |
10
11
  | **title** | **String** | | [optional] |
11
12
  | **body** | **String** | | [optional] |
13
+ | **data** | **Hash<String, Object>** | | [optional] |
12
14
  | **status** | **String** | | [optional] |
13
- | **platform** | **String** | | [optional] |
14
- | **created_at** | **Time** | | [optional] |
15
+ | **tags** | **Array<String>** | | [optional] |
16
+ | **queued_at** | **Time** | | [optional] |
15
17
  | **sent_at** | **Time** | | [optional] |
16
18
  | **delivered_at** | **Time** | | [optional] |
19
+ | **created_at** | **Time** | | [optional] |
17
20
  | **batch_id** | **String** | | [optional] |
18
- | **user_id** | **String** | | [optional] |
19
- | **data** | **Hash<String, Object>** | | [optional] |
20
- | **badge** | **String** | | [optional] |
21
+ | **badge** | **Integer** | | [optional] |
21
22
  | **sound** | **String** | | [optional] |
22
23
  | **image_url** | **String** | | [optional] |
24
+ | **content_available** | **Boolean** | | [optional] |
25
+ | **action_buttons** | [**Array<PushMessageDetailAllOfActionButtons>**](PushMessageDetailAllOfActionButtons.md) | | [optional] |
23
26
  | **status_reason** | **String** | | [optional] |
24
27
  | **provider_message_id** | **String** | | [optional] |
25
- | **tags** | **Array<String>** | | [optional] |
26
28
  | **metadata** | **Hash<String, Object>** | | [optional] |
27
- | **queued_at** | **Time** | | [optional] |
28
29
  | **failed_at** | **Time** | | [optional] |
29
30
  | **events** | [**Array<PushEvent>**](PushEvent.md) | | [optional] |
30
31
 
@@ -36,25 +37,26 @@ require 'zyphr'
36
37
  instance = Zyphr::PushMessageDetail.new(
37
38
  id: null,
38
39
  device_id: null,
39
- subscriber_id: null,
40
+ user_id: null,
41
+ platform: null,
40
42
  title: null,
41
43
  body: null,
44
+ data: null,
42
45
  status: null,
43
- platform: null,
44
- created_at: null,
46
+ tags: null,
47
+ queued_at: null,
45
48
  sent_at: null,
46
49
  delivered_at: null,
50
+ created_at: null,
47
51
  batch_id: null,
48
- user_id: null,
49
- data: null,
50
52
  badge: null,
51
53
  sound: null,
52
54
  image_url: null,
55
+ content_available: null,
56
+ action_buttons: null,
53
57
  status_reason: null,
54
58
  provider_message_id: null,
55
- tags: null,
56
59
  metadata: null,
57
- queued_at: null,
58
60
  failed_at: null,
59
61
  events: null
60
62
  )
data/docs/PushMessageDetailAllOfActionButtons.md ADDED
@@ -0,0 +1,24 @@
1
+ # Zyphr::PushMessageDetailAllOfActionButtons
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional] |
8
+ | **title** | **String** | | [optional] |
9
+ | **action** | **String** | | [optional] |
10
+ | **deep_link** | **String** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zyphr'
16
+
17
+ instance = Zyphr::PushMessageDetailAllOfActionButtons.new(
18
+ id: null,
19
+ title: null,
20
+ action: null,
21
+ deep_link: null
22
+ )
23
+ ```
24
+
data/docs/RegisterDeviceRequest.md CHANGED
@@ -4,15 +4,10 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **subscriber_id** | **String** | | [optional] |
8
- | **external_user_id** | **String** | External ID to look up subscriber | [optional] |
7
+ | **user_id** | **String** | User or subscriber ID to associate with the device | |
9
8
  | **platform** | **String** | | |
10
9
  | **token** | **String** | Push notification token from the device | |
11
- | **app_version** | **String** | | [optional] |
12
- | **device_model** | **String** | | [optional] |
13
- | **os_version** | **String** | | [optional] |
14
- | **timezone** | **String** | | [optional] |
15
- | **locale** | **String** | | [optional] |
10
+ | **metadata** | **Hash<String, Object>** | Additional device metadata | [optional] |
16
11
 
17
12
  ## Example
18
13
 
@@ -20,15 +15,10 @@
20
15
  require 'zyphr'
21
16
 
22
17
  instance = Zyphr::RegisterDeviceRequest.new(
23
- subscriber_id: null,
24
- external_user_id: null,
18
+ user_id: null,
25
19
  platform: null,
26
20
  token: null,
27
- app_version: 1.2.3,
28
- device_model: iPhone 14 Pro,
29
- os_version: 16.1,
30
- timezone: null,
31
- locale: null
21
+ metadata: null
32
22
  )
33
23
  ```
34
24
 
data/docs/SMSApi.md CHANGED
@@ -21,7 +21,7 @@ All URIs are relative to *https://api.zyphr.dev/v1*
21
21
 
22
22
  Delete SMS configuration
23
23
 
24
- Remove the SMS provider configuration for the workspace.
24
+ Remove the SMS provider configuration for the account.
25
25
 
26
26
  ### Examples
27
27
 
@@ -160,7 +160,7 @@ end
160
160
 
161
161
  Get SMS configuration
162
162
 
163
- Get the current SMS provider configuration for the workspace.
163
+ Get the current SMS provider configuration for the account.
164
164
 
165
165
  ### Examples
166
166
 
@@ -228,7 +228,7 @@ This endpoint does not need any parameter.
228
228
 
229
229
  List SMS messages
230
230
 
231
- List SMS messages for the workspace with optional filtering and pagination.
231
+ List SMS messages for the account with optional filtering and pagination.
232
232
 
233
233
  ### Examples
234
234
 
@@ -520,7 +520,7 @@ end
520
520
 
521
521
  Create or update SMS configuration
522
522
 
523
- Set up or update the SMS provider configuration (Twilio) for the workspace. Automatically verifies credentials.
523
+ Set up or update the SMS provider configuration (Twilio) for the account. Automatically verifies credentials.
524
524
 
525
525
  ### Examples
526
526
 
data/docs/SendPushRequest.md CHANGED
@@ -4,15 +4,25 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **device_id** | **String** | Send to specific device | [optional] |
8
- | **device_ids** | **Array<String>** | Send to multiple devices | [optional] |
9
- | **subscriber_id** | **String** | Send to all subscriber devices | [optional] |
10
- | **topic** | **String** | Send to topic subscribers | [optional] |
11
- | **payload** | [**PushPayload**](PushPayload.md) | | |
12
- | **priority** | **String** | | [optional][default to 'normal'] |
13
- | **ttl** | **Integer** | Time-to-live in seconds | [optional] |
7
+ | **user_id** | **String** | Send to all devices for a user | [optional] |
8
+ | **device_id** | **String** | Send to a specific device | [optional] |
9
+ | **title** | **String** | Push notification title | [optional] |
10
+ | **body** | **String** | Push notification body text | [optional] |
11
+ | **data** | **Hash<String, Object>** | Custom data payload | [optional] |
12
+ | **badge** | **Integer** | Badge count (iOS) | [optional] |
13
+ | **sound** | **String** | Notification sound | [optional] |
14
+ | **image_url** | **String** | Image URL for rich notifications | [optional] |
15
+ | **content_available** | **Boolean** | Silent/background push notification | [optional] |
16
+ | **action_buttons** | [**Array<SendPushRequestActionButtonsInner>**](SendPushRequestActionButtonsInner.md) | Interactive notification buttons (max 3) | [optional] |
17
+ | **tags** | **Array<String>** | | [optional] |
18
+ | **metadata** | **Hash<String, Object>** | | [optional] |
14
19
  | **collapse_key** | **String** | Replace previous notification with same key | [optional] |
15
- | **scheduled_at** | **Time** | | [optional] |
20
+ | **subscriber_id** | **String** | Subscriber ID for preference checking | [optional] |
21
+ | **subscriber_external_id** | **String** | Subscriber external ID for preference checking | [optional] |
22
+ | **category** | **String** | Notification category for preference checking | [optional] |
23
+ | **force** | **Boolean** | Skip subscriber preference checks | [optional] |
24
+ | **send_at** | **Time** | Schedule for future delivery (ISO 8601) | [optional] |
25
+ | **delay** | **Integer** | Delay in seconds before sending | [optional] |
16
26
 
17
27
  ## Example
18
28
 
@@ -20,15 +30,25 @@
20
30
  require 'zyphr'
21
31
 
22
32
  instance = Zyphr::SendPushRequest.new(
33
+ user_id: null,
23
34
  device_id: null,
24
- device_ids: null,
25
- subscriber_id: null,
26
- topic: null,
27
- payload: null,
28
- priority: null,
29
- ttl: null,
35
+ title: New Message,
36
+ body: You have a new notification,
37
+ data: null,
38
+ badge: null,
39
+ sound: default,
40
+ image_url: null,
41
+ content_available: null,
42
+ action_buttons: null,
43
+ tags: null,
44
+ metadata: null,
30
45
  collapse_key: null,
31
- scheduled_at: null
46
+ subscriber_id: null,
47
+ subscriber_external_id: null,
48
+ category: null,
49
+ force: null,
50
+ send_at: null,
51
+ delay: null
32
52
  )
33
53
  ```
34
54
 
data/docs/SendPushRequestActionButtonsInner.md ADDED
@@ -0,0 +1,24 @@
1
+ # Zyphr::SendPushRequestActionButtonsInner
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | |
8
+ | **title** | **String** | | |
9
+ | **action** | **String** | | [optional] |
10
+ | **deep_link** | **String** | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'zyphr'
16
+
17
+ instance = Zyphr::SendPushRequestActionButtonsInner.new(
18
+ id: null,
19
+ title: null,
20
+ action: null,
21
+ deep_link: null
22
+ )
23
+ ```
24
+
data/docs/TemplatesApi.md CHANGED
@@ -18,7 +18,7 @@ All URIs are relative to *https://api.zyphr.dev/v1*
18
18
 
19
19
  Create template
20
20
 
21
- Create a new email template. Name must be unique within the workspace.
21
+ Create a new email template. Name must be unique within the account.
22
22
 
23
23
  ### Examples
24
24
 
@@ -231,7 +231,7 @@ end
231
231
 
232
232
  List templates
233
233
 
234
- List templates for the workspace with optional pagination.
234
+ List templates for the account with optional pagination.
235
235
 
236
236
  ### Examples
237
237
 
data/docs/TopicsApi.md CHANGED
@@ -307,7 +307,7 @@ end
307
307
 
308
308
  Get topic statistics
309
309
 
310
- Get aggregate statistics for all topics in the workspace.
310
+ Get aggregate statistics for all topics in the account.
311
311
 
312
312
  ### Examples
313
313
 
@@ -452,7 +452,7 @@ end
452
452
 
453
453
  List topics
454
454
 
455
- List all topics for the workspace with pagination and optional search.
455
+ List all topics for the account with pagination and optional search.
456
456
 
457
457
  ### Examples
458
458
 
data/docs/WaaSApplication.md CHANGED
@@ -5,7 +5,8 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **id** | **String** | | [optional] |
8
- | **workspace_id** | **String** | | [optional] |
8
+ | **account_id** | **String** | | [optional] |
9
+ | **project_id** | **String** | | [optional] |
9
10
  | **name** | **String** | | [optional] |
10
11
  | **slug** | **String** | | [optional] |
11
12
  | **description** | **String** | | [optional] |
@@ -20,7 +21,8 @@ require 'zyphr'
20
21
 
21
22
  instance = Zyphr::WaaSApplication.new(
22
23
  id: null,
23
- workspace_id: null,
24
+ account_id: null,
25
+ project_id: null,
24
26
  name: My Platform,
25
27
  slug: my-platform,
26
28
  description: Webhook delivery for My Platform,
data/docs/WaaSApplicationsApi.md CHANGED
@@ -301,7 +301,7 @@ end
301
301
 
302
302
  List WaaS applications
303
303
 
304
- List all Webhooks-as-a-Service applications in the workspace.
304
+ List all Webhooks-as-a-Service applications in the account.
305
305
 
306
306
  ### Examples
307
307
 
data/docs/{WebhookWorkspaceMetricsResponse.md → WebhookAccountMetricsResponse.md} RENAMED
@@ -1,10 +1,10 @@
1
- # Zyphr::WebhookWorkspaceMetricsResponse
1
+ # Zyphr::WebhookAccountMetricsResponse
2
2
 
3
3
  ## Properties
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **data** | **Object** | Aggregate webhook metrics for the workspace | [optional] |
7
+ | **data** | **Object** | Aggregate webhook metrics for the account | [optional] |
8
8
  | **meta** | [**RequestMeta**](RequestMeta.md) | | [optional] |
9
9
 
10
10
  ## Example
@@ -12,7 +12,7 @@
12
12
  ```ruby
13
13
  require 'zyphr'
14
14
 
15
- instance = Zyphr::WebhookWorkspaceMetricsResponse.new(
15
+ instance = Zyphr::WebhookAccountMetricsResponse.new(
16
16
  data: null,
17
17
  meta: null
18
18
  )