zyphr 0.1.2 → 0.1.4

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: 22c7b153415ab05c26297e59e6050bffea8f4d0f8106d8ea882d06378568cb45
4
- data.tar.gz: 0b5abc356bb3c831cf0ab3db82406e8c17250553360c1366f0f21014b0487e65
3
+ metadata.gz: 87596d5ffc1c14924ef0e9c02cedb97105ad29ed455925d2858f1eaca247b97d
4
+ data.tar.gz: 6930382672eaca26a1be3fd68542d3bf4eef305cb59dc54e3a000ec0aeddee3c
5
5
  SHA512:
6
- metadata.gz: afed4fb6d231868643ca81dce9684d764a7ece14b1d8bc86fbe36315015dc188dc9c577fc705074ab0d7e011ac00b97d597b6a97fcd2d21c3136117994562ed9
7
- data.tar.gz: 497099a4e728b3652cf742fcdbb49ee2f106afdf10d43facf2eb8e78e632f525740b78261565d8debca19cddb2e7502551f5c184dca94c58f1043a14a4bc3eb6
6
+ metadata.gz: 4ee32b11d8db910e1e9cc701869e971e5f97e5d0c1f2e39d7613a6425b1ad6123baef48c9f3331a478653648b16a36eb7002a875ed68149174b02edc7692a03d
7
+ data.tar.gz: c287d5191ef460c8ca7baaab2cebef9441e62eecad5081526c5d3ecb183018c110fa93a87a284c2294fe51d3680e35ccd4901ee00bb160d2f147c9f0dc6cbc8f
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
@@ -596,6 +596,7 @@ Class | Method | HTTP request | Description
596
596
  - [Zyphr::WebAuthnVerifyRegistrationResponse](docs/WebAuthnVerifyRegistrationResponse.md)
597
597
  - [Zyphr::WebAuthnVerifyRegistrationResponseData](docs/WebAuthnVerifyRegistrationResponseData.md)
598
598
  - [Zyphr::Webhook](docs/Webhook.md)
599
+ - [Zyphr::WebhookAccountMetricsResponse](docs/WebhookAccountMetricsResponse.md)
599
600
  - [Zyphr::WebhookBulkRetryResponse](docs/WebhookBulkRetryResponse.md)
600
601
  - [Zyphr::WebhookCircuitState](docs/WebhookCircuitState.md)
601
602
  - [Zyphr::WebhookCircuitStateResponse](docs/WebhookCircuitStateResponse.md)
@@ -630,7 +631,6 @@ Class | Method | HTTP request | Description
630
631
  - [Zyphr::WebhookVersion](docs/WebhookVersion.md)
631
632
  - [Zyphr::WebhookVersionsResponse](docs/WebhookVersionsResponse.md)
632
633
  - [Zyphr::WebhookVersionsResponseData](docs/WebhookVersionsResponseData.md)
633
- - [Zyphr::WebhookWorkspaceMetricsResponse](docs/WebhookWorkspaceMetricsResponse.md)
634
634
  - [Zyphr::WithdrawSubscriberConsentRequest](docs/WithdrawSubscriberConsentRequest.md)
635
635
 
636
636
 
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/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
 
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
 
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/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
 
@@ -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,
@@ -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
 
@@ -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
  )
data/docs/WebhooksApi.md CHANGED
@@ -8,6 +8,7 @@ All URIs are relative to *https://api.zyphr.dev/v1*
8
8
  | [**close_webhook_circuit**](WebhooksApi.md#close_webhook_circuit) | **POST** /v1/webhooks/{id}/circuit/close | Force close circuit breaker |
9
9
  | [**create_webhook**](WebhooksApi.md#create_webhook) | **POST** /v1/webhooks | Create webhook |
10
10
  | [**delete_webhook**](WebhooksApi.md#delete_webhook) | **DELETE** /v1/webhooks/{id} | Delete webhook |
11
+ | [**get_account_webhook_metrics**](WebhooksApi.md#get_account_webhook_metrics) | **GET** /v1/webhooks/metrics | Get account webhook metrics |
11
12
  | [**get_webhook**](WebhooksApi.md#get_webhook) | **GET** /v1/webhooks/{id} | Get webhook |
12
13
  | [**get_webhook_circuit_state**](WebhooksApi.md#get_webhook_circuit_state) | **GET** /v1/webhooks/{id}/circuit | Get circuit breaker state |
13
14
  | [**get_webhook_delivery**](WebhooksApi.md#get_webhook_delivery) | **GET** /v1/webhooks/{id}/deliveries/{deliveryId} | Get webhook delivery details |
@@ -16,7 +17,6 @@ All URIs are relative to *https://api.zyphr.dev/v1*
16
17
  | [**get_webhook_metrics**](WebhooksApi.md#get_webhook_metrics) | **GET** /v1/webhooks/{id}/metrics | Get webhook health metrics |
17
18
  | [**get_webhook_regions**](WebhooksApi.md#get_webhook_regions) | **GET** /v1/webhooks/regions | Get available webhook regions |
18
19
  | [**get_webhook_usage**](WebhooksApi.md#get_webhook_usage) | **GET** /v1/webhooks/usage | Get webhook usage metrics |
19
- | [**get_workspace_webhook_metrics**](WebhooksApi.md#get_workspace_webhook_metrics) | **GET** /v1/webhooks/metrics | Get workspace webhook metrics |
20
20
  | [**list_webhook_deliveries**](WebhooksApi.md#list_webhook_deliveries) | **GET** /v1/webhooks/{id}/deliveries | List webhook deliveries |
21
21
  | [**list_webhook_event_types**](WebhooksApi.md#list_webhook_event_types) | **GET** /v1/webhooks/events | List webhook event types |
22
22
  | [**list_webhook_versions**](WebhooksApi.md#list_webhook_versions) | **GET** /v1/webhooks/versions | List webhook API versions |
@@ -317,6 +317,74 @@ end
317
317
  - **Accept**: application/json
318
318
 
319
319
 
320
+ ## get_account_webhook_metrics
321
+
322
+ > <WebhookAccountMetricsResponse> get_account_webhook_metrics
323
+
324
+ Get account webhook metrics
325
+
326
+ Get aggregate webhook health and performance metrics for the entire account.
327
+
328
+ ### Examples
329
+
330
+ ```ruby
331
+ require 'time'
332
+ require 'zyphr'
333
+ # setup authorization
334
+ Zyphr.configure do |config|
335
+ # Configure API key authorization: ApiKeyAuth
336
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
337
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
338
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
339
+ end
340
+
341
+ api_instance = Zyphr::WebhooksApi.new
342
+
343
+ begin
344
+ # Get account webhook metrics
345
+ result = api_instance.get_account_webhook_metrics
346
+ p result
347
+ rescue Zyphr::ApiError => e
348
+ puts "Error when calling WebhooksApi->get_account_webhook_metrics: #{e}"
349
+ end
350
+ ```
351
+
352
+ #### Using the get_account_webhook_metrics_with_http_info variant
353
+
354
+ This returns an Array which contains the response data, status code and headers.
355
+
356
+ > <Array(<WebhookAccountMetricsResponse>, Integer, Hash)> get_account_webhook_metrics_with_http_info
357
+
358
+ ```ruby
359
+ begin
360
+ # Get account webhook metrics
361
+ data, status_code, headers = api_instance.get_account_webhook_metrics_with_http_info
362
+ p status_code # => 2xx
363
+ p headers # => { ... }
364
+ p data # => <WebhookAccountMetricsResponse>
365
+ rescue Zyphr::ApiError => e
366
+ puts "Error when calling WebhooksApi->get_account_webhook_metrics_with_http_info: #{e}"
367
+ end
368
+ ```
369
+
370
+ ### Parameters
371
+
372
+ This endpoint does not need any parameter.
373
+
374
+ ### Return type
375
+
376
+ [**WebhookAccountMetricsResponse**](WebhookAccountMetricsResponse.md)
377
+
378
+ ### Authorization
379
+
380
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
381
+
382
+ ### HTTP request headers
383
+
384
+ - **Content-Type**: Not defined
385
+ - **Accept**: application/json
386
+
387
+
320
388
  ## get_webhook
321
389
 
322
390
  > <WebhookResponse> get_webhook(id)
@@ -878,74 +946,6 @@ This endpoint does not need any parameter.
878
946
  - **Accept**: application/json
879
947
 
880
948
 
881
- ## get_workspace_webhook_metrics
882
-
883
- > <WebhookWorkspaceMetricsResponse> get_workspace_webhook_metrics
884
-
885
- Get workspace webhook metrics
886
-
887
- Get aggregate webhook health and performance metrics for the entire workspace.
888
-
889
- ### Examples
890
-
891
- ```ruby
892
- require 'time'
893
- require 'zyphr'
894
- # setup authorization
895
- Zyphr.configure do |config|
896
- # Configure API key authorization: ApiKeyAuth
897
- config.api_key['X-API-Key'] = 'YOUR API KEY'
898
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
899
- # config.api_key_prefix['X-API-Key'] = 'Bearer'
900
- end
901
-
902
- api_instance = Zyphr::WebhooksApi.new
903
-
904
- begin
905
- # Get workspace webhook metrics
906
- result = api_instance.get_workspace_webhook_metrics
907
- p result
908
- rescue Zyphr::ApiError => e
909
- puts "Error when calling WebhooksApi->get_workspace_webhook_metrics: #{e}"
910
- end
911
- ```
912
-
913
- #### Using the get_workspace_webhook_metrics_with_http_info variant
914
-
915
- This returns an Array which contains the response data, status code and headers.
916
-
917
- > <Array(<WebhookWorkspaceMetricsResponse>, Integer, Hash)> get_workspace_webhook_metrics_with_http_info
918
-
919
- ```ruby
920
- begin
921
- # Get workspace webhook metrics
922
- data, status_code, headers = api_instance.get_workspace_webhook_metrics_with_http_info
923
- p status_code # => 2xx
924
- p headers # => { ... }
925
- p data # => <WebhookWorkspaceMetricsResponse>
926
- rescue Zyphr::ApiError => e
927
- puts "Error when calling WebhooksApi->get_workspace_webhook_metrics_with_http_info: #{e}"
928
- end
929
- ```
930
-
931
- ### Parameters
932
-
933
- This endpoint does not need any parameter.
934
-
935
- ### Return type
936
-
937
- [**WebhookWorkspaceMetricsResponse**](WebhookWorkspaceMetricsResponse.md)
938
-
939
- ### Authorization
940
-
941
- [ApiKeyAuth](../README.md#ApiKeyAuth)
942
-
943
- ### HTTP request headers
944
-
945
- - **Content-Type**: Not defined
946
- - **Accept**: application/json
947
-
948
-
949
949
  ## list_webhook_deliveries
950
950
 
951
951
  > <WebhookDeliveryListResponse> list_webhook_deliveries(id, opts)
@@ -1180,7 +1180,7 @@ This endpoint does not need any parameter.
1180
1180
 
1181
1181
  List webhooks
1182
1182
 
1183
- List all webhooks for the workspace with pagination.
1183
+ List all webhooks for the account with pagination.
1184
1184
 
1185
1185
  ### Examples
1186
1186
 
@@ -209,7 +209,7 @@ module Zyphr
209
209
  end
210
210
 
211
211
  # Get device statistics
212
- # Get aggregated device statistics for the workspace.
212
+ # Get aggregated device statistics for the account.
213
213
  # @param [Hash] opts the optional parameters
214
214
  # @return [DeviceStatsResponse]
215
215
  def get_device_stats(opts = {})
@@ -218,7 +218,7 @@ module Zyphr
218
218
  end
219
219
 
220
220
  # Get device statistics
221
- # Get aggregated device statistics for the workspace.
221
+ # Get aggregated device statistics for the account.
222
222
  # @param [Hash] opts the optional parameters
223
223
  # @return [Array<(DeviceStatsResponse, Integer, Hash)>] DeviceStatsResponse data, response status code and response headers
224
224
  def get_device_stats_with_http_info(opts = {})
@@ -266,7 +266,7 @@ module Zyphr
266
266
  end
267
267
 
268
268
  # List devices
269
- # List registered devices for the workspace with optional filtering.
269
+ # List registered devices for the account with optional filtering.
270
270
  # @param [Hash] opts the optional parameters
271
271
  # @option opts [String] :user_id Filter by subscriber/user ID
272
272
  # @option opts [String] :platform
@@ -279,7 +279,7 @@ module Zyphr
279
279
  end
280
280
 
281
281
  # List devices
282
- # List registered devices for the workspace with optional filtering.
282
+ # List registered devices for the account with optional filtering.
283
283
  # @param [Hash] opts the optional parameters
284
284
  # @option opts [String] :user_id Filter by subscriber/user ID
285
285
  # @option opts [String] :platform
@@ -83,7 +83,7 @@ module Zyphr
83
83
  end
84
84
 
85
85
  # Get push notification statistics
86
- # Get aggregated push notification statistics for the workspace.
86
+ # Get aggregated push notification statistics for the account.
87
87
  # @param [Hash] opts the optional parameters
88
88
  # @return [PushStatsResponse]
89
89
  def get_push_stats(opts = {})
@@ -92,7 +92,7 @@ module Zyphr
92
92
  end
93
93
 
94
94
  # Get push notification statistics
95
- # Get aggregated push notification statistics for the workspace.
95
+ # Get aggregated push notification statistics for the account.
96
96
  # @param [Hash] opts the optional parameters
97
97
  # @return [Array<(PushStatsResponse, Integer, Hash)>] PushStatsResponse data, response status code and response headers
98
98
  def get_push_stats_with_http_info(opts = {})
@@ -203,7 +203,7 @@ module Zyphr
203
203
  end
204
204
 
205
205
  # List push notifications
206
- # List push notification messages for the workspace with optional filtering.
206
+ # List push notification messages for the account with optional filtering.
207
207
  # @param [Hash] opts the optional parameters
208
208
  # @option opts [String] :user_id Filter by subscriber/user ID
209
209
  # @option opts [String] :device_id Filter by device ID
@@ -217,7 +217,7 @@ module Zyphr
217
217
  end
218
218
 
219
219
  # List push notifications
220
- # List push notification messages for the workspace with optional filtering.
220
+ # List push notification messages for the account with optional filtering.
221
221
  # @param [Hash] opts the optional parameters
222
222
  # @option opts [String] :user_id Filter by subscriber/user ID
223
223
  # @option opts [String] :device_id Filter by device ID
@@ -20,7 +20,7 @@ module Zyphr
20
20
  @api_client = api_client
21
21
  end
22
22
  # Delete SMS configuration
23
- # Remove the SMS provider configuration for the workspace.
23
+ # Remove the SMS provider configuration for the account.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @return [SmsConfigDeleteResponse]
26
26
  def delete_sms_config(opts = {})
@@ -29,7 +29,7 @@ module Zyphr
29
29
  end
30
30
 
31
31
  # Delete SMS configuration
32
- # Remove the SMS provider configuration for the workspace.
32
+ # Remove the SMS provider configuration for the account.
33
33
  # @param [Hash] opts the optional parameters
34
34
  # @return [Array<(SmsConfigDeleteResponse, Integer, Hash)>] SmsConfigDeleteResponse data, response status code and response headers
35
35
  def delete_sms_config_with_http_info(opts = {})
@@ -140,7 +140,7 @@ module Zyphr
140
140
  end
141
141
 
142
142
  # Get SMS configuration
143
- # Get the current SMS provider configuration for the workspace.
143
+ # Get the current SMS provider configuration for the account.
144
144
  # @param [Hash] opts the optional parameters
145
145
  # @return [SmsConfigResponse]
146
146
  def get_sms_config(opts = {})
@@ -149,7 +149,7 @@ module Zyphr
149
149
  end
150
150
 
151
151
  # Get SMS configuration
152
- # Get the current SMS provider configuration for the workspace.
152
+ # Get the current SMS provider configuration for the account.
153
153
  # @param [Hash] opts the optional parameters
154
154
  # @return [Array<(SmsConfigResponse, Integer, Hash)>] SmsConfigResponse data, response status code and response headers
155
155
  def get_sms_config_with_http_info(opts = {})
@@ -197,7 +197,7 @@ module Zyphr
197
197
  end
198
198
 
199
199
  # List SMS messages
200
- # List SMS messages for the workspace with optional filtering and pagination.
200
+ # List SMS messages for the account with optional filtering and pagination.
201
201
  # @param [Hash] opts the optional parameters
202
202
  # @option opts [Integer] :page (default to 1)
203
203
  # @option opts [Integer] :per_page (default to 25)
@@ -210,7 +210,7 @@ module Zyphr
210
210
  end
211
211
 
212
212
  # List SMS messages
213
- # List SMS messages for the workspace with optional filtering and pagination.
213
+ # List SMS messages for the account with optional filtering and pagination.
214
214
  # @param [Hash] opts the optional parameters
215
215
  # @option opts [Integer] :page (default to 1)
216
216
  # @option opts [Integer] :per_page (default to 25)
@@ -478,7 +478,7 @@ module Zyphr
478
478
  end
479
479
 
480
480
  # Create or update SMS configuration
481
- # Set up or update the SMS provider configuration (Twilio) for the workspace. Automatically verifies credentials.
481
+ # Set up or update the SMS provider configuration (Twilio) for the account. Automatically verifies credentials.
482
482
  # @param upsert_sms_config_request [UpsertSmsConfigRequest]
483
483
  # @param [Hash] opts the optional parameters
484
484
  # @return [SmsConfigResponse]
@@ -488,7 +488,7 @@ module Zyphr
488
488
  end
489
489
 
490
490
  # Create or update SMS configuration
491
- # Set up or update the SMS provider configuration (Twilio) for the workspace. Automatically verifies credentials.
491
+ # Set up or update the SMS provider configuration (Twilio) for the account. Automatically verifies credentials.
492
492
  # @param upsert_sms_config_request [UpsertSmsConfigRequest]
493
493
  # @param [Hash] opts the optional parameters
494
494
  # @return [Array<(SmsConfigResponse, Integer, Hash)>] SmsConfigResponse data, response status code and response headers
@@ -20,7 +20,7 @@ module Zyphr
20
20
  @api_client = api_client
21
21
  end
22
22
  # Create template
23
- # Create a new email template. Name must be unique within the workspace.
23
+ # Create a new email template. Name must be unique within the account.
24
24
  # @param create_template_request [CreateTemplateRequest]
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [TemplateResponse]
@@ -30,7 +30,7 @@ module Zyphr
30
30
  end
31
31
 
32
32
  # Create template
33
- # Create a new email template. Name must be unique within the workspace.
33
+ # Create a new email template. Name must be unique within the account.
34
34
  # @param create_template_request [CreateTemplateRequest]
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(TemplateResponse, Integer, Hash)>] TemplateResponse data, response status code and response headers
@@ -214,7 +214,7 @@ module Zyphr
214
214
  end
215
215
 
216
216
  # List templates
217
- # List templates for the workspace with optional pagination.
217
+ # List templates for the account with optional pagination.
218
218
  # @param [Hash] opts the optional parameters
219
219
  # @option opts [Integer] :limit (default to 50)
220
220
  # @option opts [Integer] :offset (default to 0)
@@ -225,7 +225,7 @@ module Zyphr
225
225
  end
226
226
 
227
227
  # List templates
228
- # List templates for the workspace with optional pagination.
228
+ # List templates for the account with optional pagination.
229
229
  # @param [Hash] opts the optional parameters
230
230
  # @option opts [Integer] :limit (default to 50)
231
231
  # @option opts [Integer] :offset (default to 0)
@@ -288,7 +288,7 @@ module Zyphr
288
288
  end
289
289
 
290
290
  # Get topic statistics
291
- # Get aggregate statistics for all topics in the workspace.
291
+ # Get aggregate statistics for all topics in the account.
292
292
  # @param [Hash] opts the optional parameters
293
293
  # @return [TopicStatsResponse]
294
294
  def get_topic_stats(opts = {})
@@ -297,7 +297,7 @@ module Zyphr
297
297
  end
298
298
 
299
299
  # Get topic statistics
300
- # Get aggregate statistics for all topics in the workspace.
300
+ # Get aggregate statistics for all topics in the account.
301
301
  # @param [Hash] opts the optional parameters
302
302
  # @return [Array<(TopicStatsResponse, Integer, Hash)>] TopicStatsResponse data, response status code and response headers
303
303
  def get_topic_stats_with_http_info(opts = {})
@@ -414,7 +414,7 @@ module Zyphr
414
414
  end
415
415
 
416
416
  # List topics
417
- # List all topics for the workspace with pagination and optional search.
417
+ # List all topics for the account with pagination and optional search.
418
418
  # @param [Hash] opts the optional parameters
419
419
  # @option opts [Integer] :page Page number (default to 1)
420
420
  # @option opts [Integer] :per_page Items per page (max 100) (default to 25)
@@ -426,7 +426,7 @@ module Zyphr
426
426
  end
427
427
 
428
428
  # List topics
429
- # List all topics for the workspace with pagination and optional search.
429
+ # List all topics for the account with pagination and optional search.
430
430
  # @param [Hash] opts the optional parameters
431
431
  # @option opts [Integer] :page Page number (default to 1)
432
432
  # @option opts [Integer] :per_page Items per page (max 100) (default to 25)
@@ -275,7 +275,7 @@ module Zyphr
275
275
  end
276
276
 
277
277
  # List WaaS applications
278
- # List all Webhooks-as-a-Service applications in the workspace.
278
+ # List all Webhooks-as-a-Service applications in the account.
279
279
  # @param [Hash] opts the optional parameters
280
280
  # @option opts [Integer] :limit (default to 50)
281
281
  # @option opts [Integer] :offset (default to 0)
@@ -287,7 +287,7 @@ module Zyphr
287
287
  end
288
288
 
289
289
  # List WaaS applications
290
- # List all Webhooks-as-a-Service applications in the workspace.
290
+ # List all Webhooks-as-a-Service applications in the account.
291
291
  # @param [Hash] opts the optional parameters
292
292
  # @option opts [Integer] :limit (default to 50)
293
293
  # @option opts [Integer] :offset (default to 0)
@@ -283,6 +283,63 @@ module Zyphr
283
283
  return data, status_code, headers
284
284
  end
285
285
 
286
+ # Get account webhook metrics
287
+ # Get aggregate webhook health and performance metrics for the entire account.
288
+ # @param [Hash] opts the optional parameters
289
+ # @return [WebhookAccountMetricsResponse]
290
+ def get_account_webhook_metrics(opts = {})
291
+ data, _status_code, _headers = get_account_webhook_metrics_with_http_info(opts)
292
+ data
293
+ end
294
+
295
+ # Get account webhook metrics
296
+ # Get aggregate webhook health and performance metrics for the entire account.
297
+ # @param [Hash] opts the optional parameters
298
+ # @return [Array<(WebhookAccountMetricsResponse, Integer, Hash)>] WebhookAccountMetricsResponse data, response status code and response headers
299
+ def get_account_webhook_metrics_with_http_info(opts = {})
300
+ if @api_client.config.debugging
301
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.get_account_webhook_metrics ...'
302
+ end
303
+ # resource path
304
+ local_var_path = '/v1/webhooks/metrics'
305
+
306
+ # query parameters
307
+ query_params = opts[:query_params] || {}
308
+
309
+ # header parameters
310
+ header_params = opts[:header_params] || {}
311
+ # HTTP header 'Accept' (if needed)
312
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
313
+
314
+ # form parameters
315
+ form_params = opts[:form_params] || {}
316
+
317
+ # http body (model)
318
+ post_body = opts[:debug_body]
319
+
320
+ # return_type
321
+ return_type = opts[:debug_return_type] || 'WebhookAccountMetricsResponse'
322
+
323
+ # auth_names
324
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
325
+
326
+ new_options = opts.merge(
327
+ :operation => :"WebhooksApi.get_account_webhook_metrics",
328
+ :header_params => header_params,
329
+ :query_params => query_params,
330
+ :form_params => form_params,
331
+ :body => post_body,
332
+ :auth_names => auth_names,
333
+ :return_type => return_type
334
+ )
335
+
336
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
337
+ if @api_client.config.debugging
338
+ @api_client.config.logger.debug "API called: WebhooksApi#get_account_webhook_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
339
+ end
340
+ return data, status_code, headers
341
+ end
342
+
286
343
  # Get webhook
287
344
  # Get a specific webhook by ID.
288
345
  # @param id [String] Webhook ID
@@ -775,63 +832,6 @@ module Zyphr
775
832
  return data, status_code, headers
776
833
  end
777
834
 
778
- # Get workspace webhook metrics
779
- # Get aggregate webhook health and performance metrics for the entire workspace.
780
- # @param [Hash] opts the optional parameters
781
- # @return [WebhookWorkspaceMetricsResponse]
782
- def get_workspace_webhook_metrics(opts = {})
783
- data, _status_code, _headers = get_workspace_webhook_metrics_with_http_info(opts)
784
- data
785
- end
786
-
787
- # Get workspace webhook metrics
788
- # Get aggregate webhook health and performance metrics for the entire workspace.
789
- # @param [Hash] opts the optional parameters
790
- # @return [Array<(WebhookWorkspaceMetricsResponse, Integer, Hash)>] WebhookWorkspaceMetricsResponse data, response status code and response headers
791
- def get_workspace_webhook_metrics_with_http_info(opts = {})
792
- if @api_client.config.debugging
793
- @api_client.config.logger.debug 'Calling API: WebhooksApi.get_workspace_webhook_metrics ...'
794
- end
795
- # resource path
796
- local_var_path = '/v1/webhooks/metrics'
797
-
798
- # query parameters
799
- query_params = opts[:query_params] || {}
800
-
801
- # header parameters
802
- header_params = opts[:header_params] || {}
803
- # HTTP header 'Accept' (if needed)
804
- header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
805
-
806
- # form parameters
807
- form_params = opts[:form_params] || {}
808
-
809
- # http body (model)
810
- post_body = opts[:debug_body]
811
-
812
- # return_type
813
- return_type = opts[:debug_return_type] || 'WebhookWorkspaceMetricsResponse'
814
-
815
- # auth_names
816
- auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
817
-
818
- new_options = opts.merge(
819
- :operation => :"WebhooksApi.get_workspace_webhook_metrics",
820
- :header_params => header_params,
821
- :query_params => query_params,
822
- :form_params => form_params,
823
- :body => post_body,
824
- :auth_names => auth_names,
825
- :return_type => return_type
826
- )
827
-
828
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
829
- if @api_client.config.debugging
830
- @api_client.config.logger.debug "API called: WebhooksApi#get_workspace_webhook_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
831
- end
832
- return data, status_code, headers
833
- end
834
-
835
835
  # List webhook deliveries
836
836
  # List delivery attempts for a webhook with filtering and pagination.
837
837
  # @param id [String] Webhook ID
@@ -1038,7 +1038,7 @@ module Zyphr
1038
1038
  end
1039
1039
 
1040
1040
  # List webhooks
1041
- # List all webhooks for the workspace with pagination.
1041
+ # List all webhooks for the account with pagination.
1042
1042
  # @param [Hash] opts the optional parameters
1043
1043
  # @option opts [Integer] :limit Maximum number of webhooks to return (default to 50)
1044
1044
  # @option opts [Integer] :offset Number of webhooks to skip (default to 0)
@@ -1049,7 +1049,7 @@ module Zyphr
1049
1049
  end
1050
1050
 
1051
1051
  # List webhooks
1052
- # List all webhooks for the workspace with pagination.
1052
+ # List all webhooks for the account with pagination.
1053
1053
  # @param [Hash] opts the optional parameters
1054
1054
  # @option opts [Integer] :limit Maximum number of webhooks to return (default to 50)
1055
1055
  # @option opts [Integer] :offset Number of webhooks to skip (default to 0)
@@ -17,7 +17,9 @@ module Zyphr
17
17
  class Category
18
18
  attr_accessor :id
19
19
 
20
- attr_accessor :workspace_id
20
+ attr_accessor :account_id
21
+
22
+ attr_accessor :project_id
21
23
 
22
24
  attr_accessor :name
23
25
 
@@ -37,7 +39,8 @@ module Zyphr
37
39
  def self.attribute_map
38
40
  {
39
41
  :'id' => :'id',
40
- :'workspace_id' => :'workspace_id',
42
+ :'account_id' => :'account_id',
43
+ :'project_id' => :'project_id',
41
44
  :'name' => :'name',
42
45
  :'slug' => :'slug',
43
46
  :'description' => :'description',
@@ -62,7 +65,8 @@ module Zyphr
62
65
  def self.openapi_types
63
66
  {
64
67
  :'id' => :'String',
65
- :'workspace_id' => :'String',
68
+ :'account_id' => :'String',
69
+ :'project_id' => :'String',
66
70
  :'name' => :'String',
67
71
  :'slug' => :'String',
68
72
  :'description' => :'String',
@@ -100,8 +104,12 @@ module Zyphr
100
104
  self.id = attributes[:'id']
101
105
  end
102
106
 
103
- if attributes.key?(:'workspace_id')
104
- self.workspace_id = attributes[:'workspace_id']
107
+ if attributes.key?(:'account_id')
108
+ self.account_id = attributes[:'account_id']
109
+ end
110
+
111
+ if attributes.key?(:'project_id')
112
+ self.project_id = attributes[:'project_id']
105
113
  end
106
114
 
107
115
  if attributes.key?(:'name')
@@ -156,7 +164,8 @@ module Zyphr
156
164
  return true if self.equal?(o)
157
165
  self.class == o.class &&
158
166
  id == o.id &&
159
- workspace_id == o.workspace_id &&
167
+ account_id == o.account_id &&
168
+ project_id == o.project_id &&
160
169
  name == o.name &&
161
170
  slug == o.slug &&
162
171
  description == o.description &&
@@ -175,7 +184,7 @@ module Zyphr
175
184
  # Calculates hash code according to all attributes.
176
185
  # @return [Integer] Hash code
177
186
  def hash
178
- [id, workspace_id, name, slug, description, channels, is_default, created_at, updated_at].hash
187
+ [id, account_id, project_id, name, slug, description, channels, is_default, created_at, updated_at].hash
179
188
  end
180
189
 
181
190
  # Builds the object from hash
@@ -17,7 +17,9 @@ module Zyphr
17
17
  class WaaSApplication
18
18
  attr_accessor :id
19
19
 
20
- attr_accessor :workspace_id
20
+ attr_accessor :account_id
21
+
22
+ attr_accessor :project_id
21
23
 
22
24
  attr_accessor :name
23
25
 
@@ -57,7 +59,8 @@ module Zyphr
57
59
  def self.attribute_map
58
60
  {
59
61
  :'id' => :'id',
60
- :'workspace_id' => :'workspace_id',
62
+ :'account_id' => :'account_id',
63
+ :'project_id' => :'project_id',
61
64
  :'name' => :'name',
62
65
  :'slug' => :'slug',
63
66
  :'description' => :'description',
@@ -81,7 +84,8 @@ module Zyphr
81
84
  def self.openapi_types
82
85
  {
83
86
  :'id' => :'String',
84
- :'workspace_id' => :'String',
87
+ :'account_id' => :'String',
88
+ :'project_id' => :'String',
85
89
  :'name' => :'String',
86
90
  :'slug' => :'String',
87
91
  :'description' => :'String',
@@ -117,8 +121,12 @@ module Zyphr
117
121
  self.id = attributes[:'id']
118
122
  end
119
123
 
120
- if attributes.key?(:'workspace_id')
121
- self.workspace_id = attributes[:'workspace_id']
124
+ if attributes.key?(:'account_id')
125
+ self.account_id = attributes[:'account_id']
126
+ end
127
+
128
+ if attributes.key?(:'project_id')
129
+ self.project_id = attributes[:'project_id']
122
130
  end
123
131
 
124
132
  if attributes.key?(:'name')
@@ -179,7 +187,8 @@ module Zyphr
179
187
  return true if self.equal?(o)
180
188
  self.class == o.class &&
181
189
  id == o.id &&
182
- workspace_id == o.workspace_id &&
190
+ account_id == o.account_id &&
191
+ project_id == o.project_id &&
183
192
  name == o.name &&
184
193
  slug == o.slug &&
185
194
  description == o.description &&
@@ -197,7 +206,7 @@ module Zyphr
197
206
  # Calculates hash code according to all attributes.
198
207
  # @return [Integer] Hash code
199
208
  def hash
200
- [id, workspace_id, name, slug, description, status, created_at, updated_at].hash
209
+ [id, account_id, project_id, name, slug, description, status, created_at, updated_at].hash
201
210
  end
202
211
 
203
212
  # Builds the object from hash
@@ -14,8 +14,8 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module Zyphr
17
- class WebhookWorkspaceMetricsResponse
18
- # Aggregate webhook metrics for the workspace
17
+ class WebhookAccountMetricsResponse
18
+ # Aggregate webhook metrics for the account
19
19
  attr_accessor :data
20
20
 
21
21
  attr_accessor :meta
@@ -56,14 +56,14 @@ module Zyphr
56
56
  # @param [Hash] attributes Model attributes in the form of hash
57
57
  def initialize(attributes = {})
58
58
  if (!attributes.is_a?(Hash))
59
- fail ArgumentError, "The input argument (attributes) must be a hash in `Zyphr::WebhookWorkspaceMetricsResponse` initialize method"
59
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Zyphr::WebhookAccountMetricsResponse` initialize method"
60
60
  end
61
61
 
62
62
  # check to see if the attribute exists and convert string to symbol for hash key
63
63
  acceptable_attribute_map = self.class.acceptable_attribute_map
64
64
  attributes = attributes.each_with_object({}) { |(k, v), h|
65
65
  if (!acceptable_attribute_map.key?(k.to_sym))
66
- fail ArgumentError, "`#{k}` is not a valid attribute in `Zyphr::WebhookWorkspaceMetricsResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
66
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Zyphr::WebhookAccountMetricsResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
67
67
  end
68
68
  h[k.to_sym] = v
69
69
  }
data/lib/zyphr.rb CHANGED
@@ -309,6 +309,7 @@ require 'zyphr/models/web_authn_verify_registration_request'
309
309
  require 'zyphr/models/web_authn_verify_registration_response'
310
310
  require 'zyphr/models/web_authn_verify_registration_response_data'
311
311
  require 'zyphr/models/webhook'
312
+ require 'zyphr/models/webhook_account_metrics_response'
312
313
  require 'zyphr/models/webhook_bulk_retry_response'
313
314
  require 'zyphr/models/webhook_circuit_state'
314
315
  require 'zyphr/models/webhook_circuit_state_response'
@@ -343,7 +344,6 @@ require 'zyphr/models/webhook_usage_response'
343
344
  require 'zyphr/models/webhook_version'
344
345
  require 'zyphr/models/webhook_versions_response'
345
346
  require 'zyphr/models/webhook_versions_response_data'
346
- require 'zyphr/models/webhook_workspace_metrics_response'
347
347
  require 'zyphr/models/withdraw_subscriber_consent_request'
348
348
 
349
349
  # APIs
@@ -70,7 +70,7 @@ describe 'DevicesApi' do
70
70
 
71
71
  # unit tests for get_device_stats
72
72
  # Get device statistics
73
- # Get aggregated device statistics for the workspace.
73
+ # Get aggregated device statistics for the account.
74
74
  # @param [Hash] opts the optional parameters
75
75
  # @return [DeviceStatsResponse]
76
76
  describe 'get_device_stats test' do
@@ -81,7 +81,7 @@ describe 'DevicesApi' do
81
81
 
82
82
  # unit tests for list_devices
83
83
  # List devices
84
- # List registered devices for the workspace with optional filtering.
84
+ # List registered devices for the account with optional filtering.
85
85
  # @param [Hash] opts the optional parameters
86
86
  # @option opts [String] :user_id Filter by subscriber/user ID
87
87
  # @option opts [String] :platform
@@ -46,7 +46,7 @@ describe 'PushApi' do
46
46
 
47
47
  # unit tests for get_push_stats
48
48
  # Get push notification statistics
49
- # Get aggregated push notification statistics for the workspace.
49
+ # Get aggregated push notification statistics for the account.
50
50
  # @param [Hash] opts the optional parameters
51
51
  # @return [PushStatsResponse]
52
52
  describe 'get_push_stats test' do
@@ -69,7 +69,7 @@ describe 'PushApi' do
69
69
 
70
70
  # unit tests for list_push
71
71
  # List push notifications
72
- # List push notification messages for the workspace with optional filtering.
72
+ # List push notification messages for the account with optional filtering.
73
73
  # @param [Hash] opts the optional parameters
74
74
  # @option opts [String] :user_id Filter by subscriber/user ID
75
75
  # @option opts [String] :device_id Filter by device ID
@@ -34,7 +34,7 @@ describe 'SMSApi' do
34
34
 
35
35
  # unit tests for delete_sms_config
36
36
  # Delete SMS configuration
37
- # Remove the SMS provider configuration for the workspace.
37
+ # Remove the SMS provider configuration for the account.
38
38
  # @param [Hash] opts the optional parameters
39
39
  # @return [SmsConfigDeleteResponse]
40
40
  describe 'delete_sms_config test' do
@@ -57,7 +57,7 @@ describe 'SMSApi' do
57
57
 
58
58
  # unit tests for get_sms_config
59
59
  # Get SMS configuration
60
- # Get the current SMS provider configuration for the workspace.
60
+ # Get the current SMS provider configuration for the account.
61
61
  # @param [Hash] opts the optional parameters
62
62
  # @return [SmsConfigResponse]
63
63
  describe 'get_sms_config test' do
@@ -68,7 +68,7 @@ describe 'SMSApi' do
68
68
 
69
69
  # unit tests for list_sms
70
70
  # List SMS messages
71
- # List SMS messages for the workspace with optional filtering and pagination.
71
+ # List SMS messages for the account with optional filtering and pagination.
72
72
  # @param [Hash] opts the optional parameters
73
73
  # @option opts [Integer] :page
74
74
  # @option opts [Integer] :per_page
@@ -119,7 +119,7 @@ describe 'SMSApi' do
119
119
 
120
120
  # unit tests for upsert_sms_config
121
121
  # Create or update SMS configuration
122
- # Set up or update the SMS provider configuration (Twilio) for the workspace. Automatically verifies credentials.
122
+ # Set up or update the SMS provider configuration (Twilio) for the account. Automatically verifies credentials.
123
123
  # @param upsert_sms_config_request
124
124
  # @param [Hash] opts the optional parameters
125
125
  # @return [SmsConfigResponse]
@@ -34,7 +34,7 @@ describe 'TemplatesApi' do
34
34
 
35
35
  # unit tests for create_template
36
36
  # Create template
37
- # Create a new email template. Name must be unique within the workspace.
37
+ # Create a new email template. Name must be unique within the account.
38
38
  # @param create_template_request
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [TemplateResponse]
@@ -70,7 +70,7 @@ describe 'TemplatesApi' do
70
70
 
71
71
  # unit tests for list_templates
72
72
  # List templates
73
- # List templates for the workspace with optional pagination.
73
+ # List templates for the account with optional pagination.
74
74
  # @param [Hash] opts the optional parameters
75
75
  # @option opts [Integer] :limit
76
76
  # @option opts [Integer] :offset
@@ -83,7 +83,7 @@ describe 'TopicsApi' do
83
83
 
84
84
  # unit tests for get_topic_stats
85
85
  # Get topic statistics
86
- # Get aggregate statistics for all topics in the workspace.
86
+ # Get aggregate statistics for all topics in the account.
87
87
  # @param [Hash] opts the optional parameters
88
88
  # @return [TopicStatsResponse]
89
89
  describe 'get_topic_stats test' do
@@ -108,7 +108,7 @@ describe 'TopicsApi' do
108
108
 
109
109
  # unit tests for list_topics
110
110
  # List topics
111
- # List all topics for the workspace with pagination and optional search.
111
+ # List all topics for the account with pagination and optional search.
112
112
  # @param [Hash] opts the optional parameters
113
113
  # @option opts [Integer] :page Page number
114
114
  # @option opts [Integer] :per_page Items per page (max 100)
@@ -82,7 +82,7 @@ describe 'WaaSApplicationsApi' do
82
82
 
83
83
  # unit tests for list_waa_s_applications
84
84
  # List WaaS applications
85
- # List all Webhooks-as-a-Service applications in the workspace.
85
+ # List all Webhooks-as-a-Service applications in the account.
86
86
  # @param [Hash] opts the optional parameters
87
87
  # @option opts [Integer] :limit
88
88
  # @option opts [Integer] :offset
@@ -81,6 +81,17 @@ describe 'WebhooksApi' do
81
81
  end
82
82
  end
83
83
 
84
+ # unit tests for get_account_webhook_metrics
85
+ # Get account webhook metrics
86
+ # Get aggregate webhook health and performance metrics for the entire account.
87
+ # @param [Hash] opts the optional parameters
88
+ # @return [WebhookAccountMetricsResponse]
89
+ describe 'get_account_webhook_metrics test' do
90
+ it 'should work' do
91
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
92
+ end
93
+ end
94
+
84
95
  # unit tests for get_webhook
85
96
  # Get webhook
86
97
  # Get a specific webhook by ID.
@@ -175,17 +186,6 @@ describe 'WebhooksApi' do
175
186
  end
176
187
  end
177
188
 
178
- # unit tests for get_workspace_webhook_metrics
179
- # Get workspace webhook metrics
180
- # Get aggregate webhook health and performance metrics for the entire workspace.
181
- # @param [Hash] opts the optional parameters
182
- # @return [WebhookWorkspaceMetricsResponse]
183
- describe 'get_workspace_webhook_metrics test' do
184
- it 'should work' do
185
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
186
- end
187
- end
188
-
189
189
  # unit tests for list_webhook_deliveries
190
190
  # List webhook deliveries
191
191
  # List delivery attempts for a webhook with filtering and pagination.
@@ -230,7 +230,7 @@ describe 'WebhooksApi' do
230
230
 
231
231
  # unit tests for list_webhooks
232
232
  # List webhooks
233
- # List all webhooks for the workspace with pagination.
233
+ # List all webhooks for the account with pagination.
234
234
  # @param [Hash] opts the optional parameters
235
235
  # @option opts [Integer] :limit Maximum number of webhooks to return
236
236
  # @option opts [Integer] :offset Number of webhooks to skip
@@ -33,7 +33,13 @@ describe Zyphr::Category do
33
33
  end
34
34
  end
35
35
 
36
- describe 'test attribute "workspace_id"' do
36
+ describe 'test attribute "account_id"' do
37
+ it 'should work' do
38
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
+ end
40
+ end
41
+
42
+ describe 'test attribute "project_id"' do
37
43
  it 'should work' do
38
44
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
45
  end
@@ -33,7 +33,13 @@ describe Zyphr::WaaSApplication do
33
33
  end
34
34
  end
35
35
 
36
- describe 'test attribute "workspace_id"' do
36
+ describe 'test attribute "account_id"' do
37
+ it 'should work' do
38
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
+ end
40
+ end
41
+
42
+ describe 'test attribute "project_id"' do
37
43
  it 'should work' do
38
44
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
45
  end
@@ -14,16 +14,16 @@ require 'spec_helper'
14
14
  require 'json'
15
15
  require 'date'
16
16
 
17
- # Unit tests for Zyphr::WebhookWorkspaceMetricsResponse
17
+ # Unit tests for Zyphr::WebhookAccountMetricsResponse
18
18
  # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
19
  # Please update as you see appropriate
20
- describe Zyphr::WebhookWorkspaceMetricsResponse do
21
- let(:instance) { Zyphr::WebhookWorkspaceMetricsResponse.new }
20
+ describe Zyphr::WebhookAccountMetricsResponse do
21
+ let(:instance) { Zyphr::WebhookAccountMetricsResponse.new }
22
22
 
23
- describe 'test an instance of WebhookWorkspaceMetricsResponse' do
24
- it 'should create an instance of WebhookWorkspaceMetricsResponse' do
23
+ describe 'test an instance of WebhookAccountMetricsResponse' do
24
+ it 'should create an instance of WebhookAccountMetricsResponse' do
25
25
  # uncomment below to test the instance creation
26
- #expect(instance).to be_instance_of(Zyphr::WebhookWorkspaceMetricsResponse)
26
+ #expect(instance).to be_instance_of(Zyphr::WebhookAccountMetricsResponse)
27
27
  end
28
28
  end
29
29
 
data/zyphr.gemspec CHANGED
@@ -17,7 +17,7 @@ require "zyphr/version"
17
17
 
18
18
  Gem::Specification.new do |s|
19
19
  s.name = "zyphr"
20
- s.version = '0.1.2'
20
+ s.version = '0.1.4'
21
21
  s.platform = Gem::Platform::RUBY
22
22
  s.authors = ["Zyphr"]
23
23
  s.email = ["support@zyphr.dev"]
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: zyphr
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.2
4
+ version: 0.1.4
5
5
  platform: ruby
6
6
  authors:
7
7
  - Zyphr
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-03-15 00:00:00.000000000 Z
11
+ date: 2026-03-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -406,6 +406,7 @@ files:
406
406
  - docs/WebAuthnVerifyRegistrationResponse.md
407
407
  - docs/WebAuthnVerifyRegistrationResponseData.md
408
408
  - docs/Webhook.md
409
+ - docs/WebhookAccountMetricsResponse.md
409
410
  - docs/WebhookBulkRetryResponse.md
410
411
  - docs/WebhookCircuitState.md
411
412
  - docs/WebhookCircuitStateResponse.md
@@ -440,7 +441,6 @@ files:
440
441
  - docs/WebhookVersion.md
441
442
  - docs/WebhookVersionsResponse.md
442
443
  - docs/WebhookVersionsResponseData.md
443
- - docs/WebhookWorkspaceMetricsResponse.md
444
444
  - docs/WebhooksApi.md
445
445
  - docs/WithdrawSubscriberConsentRequest.md
446
446
  - git_push.sh
@@ -767,6 +767,7 @@ files:
767
767
  - lib/zyphr/models/web_authn_verify_registration_response.rb
768
768
  - lib/zyphr/models/web_authn_verify_registration_response_data.rb
769
769
  - lib/zyphr/models/webhook.rb
770
+ - lib/zyphr/models/webhook_account_metrics_response.rb
770
771
  - lib/zyphr/models/webhook_bulk_retry_response.rb
771
772
  - lib/zyphr/models/webhook_circuit_state.rb
772
773
  - lib/zyphr/models/webhook_circuit_state_response.rb
@@ -801,7 +802,6 @@ files:
801
802
  - lib/zyphr/models/webhook_version.rb
802
803
  - lib/zyphr/models/webhook_versions_response.rb
803
804
  - lib/zyphr/models/webhook_versions_response_data.rb
804
- - lib/zyphr/models/webhook_workspace_metrics_response.rb
805
805
  - lib/zyphr/models/withdraw_subscriber_consent_request.rb
806
806
  - lib/zyphr/version.rb
807
807
  - spec/api/auth_email_verification_api_spec.rb
@@ -1122,6 +1122,7 @@ files:
1122
1122
  - spec/models/web_authn_verify_registration_request_spec.rb
1123
1123
  - spec/models/web_authn_verify_registration_response_data_spec.rb
1124
1124
  - spec/models/web_authn_verify_registration_response_spec.rb
1125
+ - spec/models/webhook_account_metrics_response_spec.rb
1125
1126
  - spec/models/webhook_bulk_retry_response_spec.rb
1126
1127
  - spec/models/webhook_circuit_state_response_spec.rb
1127
1128
  - spec/models/webhook_circuit_state_spec.rb
@@ -1157,7 +1158,6 @@ files:
1157
1158
  - spec/models/webhook_version_spec.rb
1158
1159
  - spec/models/webhook_versions_response_data_spec.rb
1159
1160
  - spec/models/webhook_versions_response_spec.rb
1160
- - spec/models/webhook_workspace_metrics_response_spec.rb
1161
1161
  - spec/models/withdraw_subscriber_consent_request_spec.rb
1162
1162
  - spec/spec_helper.rb
1163
1163
  - zyphr.gemspec
@@ -1465,6 +1465,7 @@ test_files:
1465
1465
  - spec/models/webhook_delivery_response_spec.rb
1466
1466
  - spec/models/mark_all_read_response_spec.rb
1467
1467
  - spec/models/resubscribe_response_spec.rb
1468
+ - spec/models/webhook_account_metrics_response_spec.rb
1468
1469
  - spec/models/batch_publish_waa_s_events201_response_spec.rb
1469
1470
  - spec/models/webhook_circuit_state_response_spec.rb
1470
1471
  - spec/models/update_waa_s_endpoint_request_spec.rb
@@ -1499,7 +1500,6 @@ test_files:
1499
1500
  - spec/models/phone_otp_sent_response_spec.rb
1500
1501
  - spec/models/magic_link_verify_response_spec.rb
1501
1502
  - spec/models/web_authn_verify_registration_request_spec.rb
1502
- - spec/models/webhook_workspace_metrics_response_spec.rb
1503
1503
  - spec/models/validate_reset_token_request_spec.rb
1504
1504
  - spec/models/send_batch_in_app_meta_spec.rb
1505
1505
  - spec/models/add_topic_subscribers_request_spec.rb