zyphr 0.1.3 → 0.1.6

data/docs/WebhooksApi.md

@@ -8,6 +8,7 @@ All URIs are relative to *https://api.zyphr.dev/v1*
 | [**close_webhook_circuit**](WebhooksApi.md#close_webhook_circuit) | **POST** /v1/webhooks/{id}/circuit/close | Force close circuit breaker |
 | [**create_webhook**](WebhooksApi.md#create_webhook) | **POST** /v1/webhooks | Create webhook |
 | [**delete_webhook**](WebhooksApi.md#delete_webhook) | **DELETE** /v1/webhooks/{id} | Delete webhook |
+| [**get_account_webhook_metrics**](WebhooksApi.md#get_account_webhook_metrics) | **GET** /v1/webhooks/metrics | Get account webhook metrics |
 | [**get_webhook**](WebhooksApi.md#get_webhook) | **GET** /v1/webhooks/{id} | Get webhook |
 | [**get_webhook_circuit_state**](WebhooksApi.md#get_webhook_circuit_state) | **GET** /v1/webhooks/{id}/circuit | Get circuit breaker state |
 | [**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*
 | [**get_webhook_metrics**](WebhooksApi.md#get_webhook_metrics) | **GET** /v1/webhooks/{id}/metrics | Get webhook health metrics |
 | [**get_webhook_regions**](WebhooksApi.md#get_webhook_regions) | **GET** /v1/webhooks/regions | Get available webhook regions |
 | [**get_webhook_usage**](WebhooksApi.md#get_webhook_usage) | **GET** /v1/webhooks/usage | Get webhook usage metrics |
-| [**get_workspace_webhook_metrics**](WebhooksApi.md#get_workspace_webhook_metrics) | **GET** /v1/webhooks/metrics | Get workspace webhook metrics |
 | [**list_webhook_deliveries**](WebhooksApi.md#list_webhook_deliveries) | **GET** /v1/webhooks/{id}/deliveries | List webhook deliveries |
 | [**list_webhook_event_types**](WebhooksApi.md#list_webhook_event_types) | **GET** /v1/webhooks/events | List webhook event types |
 | [**list_webhook_versions**](WebhooksApi.md#list_webhook_versions) | **GET** /v1/webhooks/versions | List webhook API versions |
@@ -317,6 +317,74 @@ end
 - **Accept**: application/json
 
 
+## get_account_webhook_metrics
+
+> <WebhookAccountMetricsResponse> get_account_webhook_metrics
+
+Get account webhook metrics
+
+Get aggregate webhook health and performance metrics for the entire account.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::WebhooksApi.new
+
+begin
+  # Get account webhook metrics
+  result = api_instance.get_account_webhook_metrics
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling WebhooksApi->get_account_webhook_metrics: #{e}"
+end
+```
+
+#### Using the get_account_webhook_metrics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WebhookAccountMetricsResponse>, Integer, Hash)> get_account_webhook_metrics_with_http_info
+
+```ruby
+begin
+  # Get account webhook metrics
+  data, status_code, headers = api_instance.get_account_webhook_metrics_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WebhookAccountMetricsResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling WebhooksApi->get_account_webhook_metrics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**WebhookAccountMetricsResponse**](WebhookAccountMetricsResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_webhook
 
 > <WebhookResponse> get_webhook(id)
@@ -878,74 +946,6 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
-## get_workspace_webhook_metrics
-
-> <WebhookWorkspaceMetricsResponse> get_workspace_webhook_metrics
-
-Get workspace webhook metrics
-
-Get aggregate webhook health and performance metrics for the entire workspace.
-
-### Examples
-
-```ruby
-require 'time'
-require 'zyphr'
-# setup authorization
-Zyphr.configure do |config|
-  # Configure API key authorization: ApiKeyAuth
-  config.api_key['X-API-Key'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  # config.api_key_prefix['X-API-Key'] = 'Bearer'
-end
-
-api_instance = Zyphr::WebhooksApi.new
-
-begin
-  # Get workspace webhook metrics
-  result = api_instance.get_workspace_webhook_metrics
-  p result
-rescue Zyphr::ApiError => e
-  puts "Error when calling WebhooksApi->get_workspace_webhook_metrics: #{e}"
-end
-```
-
-#### Using the get_workspace_webhook_metrics_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<WebhookWorkspaceMetricsResponse>, Integer, Hash)> get_workspace_webhook_metrics_with_http_info
-
-```ruby
-begin
-  # Get workspace webhook metrics
-  data, status_code, headers = api_instance.get_workspace_webhook_metrics_with_http_info
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <WebhookWorkspaceMetricsResponse>
-rescue Zyphr::ApiError => e
-  puts "Error when calling WebhooksApi->get_workspace_webhook_metrics_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-This endpoint does not need any parameter.
-
-### Return type
-
-[**WebhookWorkspaceMetricsResponse**](WebhookWorkspaceMetricsResponse.md)
-
-### Authorization
-
-[ApiKeyAuth](../README.md#ApiKeyAuth)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-
-
 ## list_webhook_deliveries
 
 > <WebhookDeliveryListResponse> list_webhook_deliveries(id, opts)
@@ -1180,7 +1180,7 @@ This endpoint does not need any parameter.
 
 List webhooks
 
-List all webhooks for the workspace with pagination.
+List all webhooks for the account with pagination.
 
 ### Examples
 

data/lib/zyphr/api/devices_api.rb

@@ -209,7 +209,7 @@ module Zyphr
     end
 
     # Get device statistics
-    # Get aggregated device statistics for the workspace.
+    # Get aggregated device statistics for the account.
     # @param [Hash] opts the optional parameters
     # @return [DeviceStatsResponse]
     def get_device_stats(opts = {})
@@ -218,7 +218,7 @@ module Zyphr
     end
 
     # Get device statistics
-    # Get aggregated device statistics for the workspace.
+    # Get aggregated device statistics for the account.
     # @param [Hash] opts the optional parameters
     # @return [Array<(DeviceStatsResponse, Integer, Hash)>] DeviceStatsResponse data, response status code and response headers
     def get_device_stats_with_http_info(opts = {})
@@ -266,7 +266,7 @@ module Zyphr
     end
 
     # List devices
-    # List registered devices for the workspace with optional filtering.
+    # List registered devices for the account with optional filtering.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :user_id Filter by subscriber/user ID
     # @option opts [String] :platform 
@@ -279,7 +279,7 @@ module Zyphr
     end
 
     # List devices
-    # List registered devices for the workspace with optional filtering.
+    # List registered devices for the account with optional filtering.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :user_id Filter by subscriber/user ID
     # @option opts [String] :platform 

data/lib/zyphr/api/push_api.rb

@@ -83,7 +83,7 @@ module Zyphr
     end
 
     # Get push notification statistics
-    # Get aggregated push notification statistics for the workspace.
+    # Get aggregated push notification statistics for the account.
     # @param [Hash] opts the optional parameters
     # @return [PushStatsResponse]
     def get_push_stats(opts = {})
@@ -92,7 +92,7 @@ module Zyphr
     end
 
     # Get push notification statistics
-    # Get aggregated push notification statistics for the workspace.
+    # Get aggregated push notification statistics for the account.
     # @param [Hash] opts the optional parameters
     # @return [Array<(PushStatsResponse, Integer, Hash)>] PushStatsResponse data, response status code and response headers
     def get_push_stats_with_http_info(opts = {})
@@ -203,7 +203,7 @@ module Zyphr
     end
 
     # List push notifications
-    # List push notification messages for the workspace with optional filtering.
+    # List push notification messages for the account with optional filtering.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :user_id Filter by subscriber/user ID
     # @option opts [String] :device_id Filter by device ID
@@ -217,7 +217,7 @@ module Zyphr
     end
 
     # List push notifications
-    # List push notification messages for the workspace with optional filtering.
+    # List push notification messages for the account with optional filtering.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :user_id Filter by subscriber/user ID
     # @option opts [String] :device_id Filter by device ID

data/lib/zyphr/api/sms_api.rb

@@ -20,7 +20,7 @@ module Zyphr
       @api_client = api_client
     end
     # Delete SMS configuration
-    # Remove the SMS provider configuration for the workspace.
+    # Remove the SMS provider configuration for the account.
     # @param [Hash] opts the optional parameters
     # @return [SmsConfigDeleteResponse]
     def delete_sms_config(opts = {})
@@ -29,7 +29,7 @@ module Zyphr
     end
 
     # Delete SMS configuration
-    # Remove the SMS provider configuration for the workspace.
+    # Remove the SMS provider configuration for the account.
     # @param [Hash] opts the optional parameters
     # @return [Array<(SmsConfigDeleteResponse, Integer, Hash)>] SmsConfigDeleteResponse data, response status code and response headers
     def delete_sms_config_with_http_info(opts = {})
@@ -140,7 +140,7 @@ module Zyphr
     end
 
     # Get SMS configuration
-    # Get the current SMS provider configuration for the workspace.
+    # Get the current SMS provider configuration for the account.
     # @param [Hash] opts the optional parameters
     # @return [SmsConfigResponse]
     def get_sms_config(opts = {})
@@ -149,7 +149,7 @@ module Zyphr
     end
 
     # Get SMS configuration
-    # Get the current SMS provider configuration for the workspace.
+    # Get the current SMS provider configuration for the account.
     # @param [Hash] opts the optional parameters
     # @return [Array<(SmsConfigResponse, Integer, Hash)>] SmsConfigResponse data, response status code and response headers
     def get_sms_config_with_http_info(opts = {})
@@ -197,7 +197,7 @@ module Zyphr
     end
 
     # List SMS messages
-    # List SMS messages for the workspace with optional filtering and pagination.
+    # List SMS messages for the account with optional filtering and pagination.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page  (default to 1)
     # @option opts [Integer] :per_page  (default to 25)
@@ -210,7 +210,7 @@ module Zyphr
     end
 
     # List SMS messages
-    # List SMS messages for the workspace with optional filtering and pagination.
+    # List SMS messages for the account with optional filtering and pagination.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page  (default to 1)
     # @option opts [Integer] :per_page  (default to 25)
@@ -478,7 +478,7 @@ module Zyphr
     end
 
     # Create or update SMS configuration
-    # Set up or update the SMS provider configuration (Twilio) for the workspace. Automatically verifies credentials.
+    # Set up or update the SMS provider configuration (Twilio) for the account. Automatically verifies credentials.
     # @param upsert_sms_config_request [UpsertSmsConfigRequest] 
     # @param [Hash] opts the optional parameters
     # @return [SmsConfigResponse]
@@ -488,7 +488,7 @@ module Zyphr
     end
 
     # Create or update SMS configuration
-    # Set up or update the SMS provider configuration (Twilio) for the workspace. Automatically verifies credentials.
+    # Set up or update the SMS provider configuration (Twilio) for the account. Automatically verifies credentials.
     # @param upsert_sms_config_request [UpsertSmsConfigRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(SmsConfigResponse, Integer, Hash)>] SmsConfigResponse data, response status code and response headers

data/lib/zyphr/api/templates_api.rb

@@ -20,7 +20,7 @@ module Zyphr
       @api_client = api_client
     end
     # Create template
-    # Create a new email template. Name must be unique within the workspace.
+    # Create a new email template. Name must be unique within the account.
     # @param create_template_request [CreateTemplateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [TemplateResponse]
@@ -30,7 +30,7 @@ module Zyphr
     end
 
     # Create template
-    # Create a new email template. Name must be unique within the workspace.
+    # Create a new email template. Name must be unique within the account.
     # @param create_template_request [CreateTemplateRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(TemplateResponse, Integer, Hash)>] TemplateResponse data, response status code and response headers
@@ -214,7 +214,7 @@ module Zyphr
     end
 
     # List templates
-    # List templates for the workspace with optional pagination.
+    # List templates for the account with optional pagination.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit  (default to 50)
     # @option opts [Integer] :offset  (default to 0)
@@ -225,7 +225,7 @@ module Zyphr
     end
 
     # List templates
-    # List templates for the workspace with optional pagination.
+    # List templates for the account with optional pagination.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit  (default to 50)
     # @option opts [Integer] :offset  (default to 0)

data/lib/zyphr/api/topics_api.rb

@@ -288,7 +288,7 @@ module Zyphr
     end
 
     # Get topic statistics
-    # Get aggregate statistics for all topics in the workspace.
+    # Get aggregate statistics for all topics in the account.
     # @param [Hash] opts the optional parameters
     # @return [TopicStatsResponse]
     def get_topic_stats(opts = {})
@@ -297,7 +297,7 @@ module Zyphr
     end
 
     # Get topic statistics
-    # Get aggregate statistics for all topics in the workspace.
+    # Get aggregate statistics for all topics in the account.
     # @param [Hash] opts the optional parameters
     # @return [Array<(TopicStatsResponse, Integer, Hash)>] TopicStatsResponse data, response status code and response headers
     def get_topic_stats_with_http_info(opts = {})
@@ -414,7 +414,7 @@ module Zyphr
     end
 
     # List topics
-    # List all topics for the workspace with pagination and optional search.
+    # List all topics for the account with pagination and optional search.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Page number (default to 1)
     # @option opts [Integer] :per_page Items per page (max 100) (default to 25)
@@ -426,7 +426,7 @@ module Zyphr
     end
 
     # List topics
-    # List all topics for the workspace with pagination and optional search.
+    # List all topics for the account with pagination and optional search.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Page number (default to 1)
     # @option opts [Integer] :per_page Items per page (max 100) (default to 25)

data/lib/zyphr/api/waa_s_applications_api.rb

@@ -275,7 +275,7 @@ module Zyphr
     end
 
     # List WaaS applications
-    # List all Webhooks-as-a-Service applications in the workspace.
+    # List all Webhooks-as-a-Service applications in the account.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit  (default to 50)
     # @option opts [Integer] :offset  (default to 0)
@@ -287,7 +287,7 @@ module Zyphr
     end
 
     # List WaaS applications
-    # List all Webhooks-as-a-Service applications in the workspace.
+    # List all Webhooks-as-a-Service applications in the account.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit  (default to 50)
     # @option opts [Integer] :offset  (default to 0)

data/lib/zyphr/api/webhooks_api.rb

@@ -283,6 +283,63 @@ module Zyphr
       return data, status_code, headers
     end
 
+    # Get account webhook metrics
+    # Get aggregate webhook health and performance metrics for the entire account.
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookAccountMetricsResponse]
+    def get_account_webhook_metrics(opts = {})
+      data, _status_code, _headers = get_account_webhook_metrics_with_http_info(opts)
+      data
+    end
+
+    # Get account webhook metrics
+    # Get aggregate webhook health and performance metrics for the entire account.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookAccountMetricsResponse, Integer, Hash)>] WebhookAccountMetricsResponse data, response status code and response headers
+    def get_account_webhook_metrics_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhooksApi.get_account_webhook_metrics ...'
+      end
+      # resource path
+      local_var_path = '/v1/webhooks/metrics'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'WebhookAccountMetricsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhooksApi.get_account_webhook_metrics",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebhooksApi#get_account_webhook_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get webhook
     # Get a specific webhook by ID.
     # @param id [String] Webhook ID
@@ -775,63 +832,6 @@ module Zyphr
       return data, status_code, headers
     end
 
-    # Get workspace webhook metrics
-    # Get aggregate webhook health and performance metrics for the entire workspace.
-    # @param [Hash] opts the optional parameters
-    # @return [WebhookWorkspaceMetricsResponse]
-    def get_workspace_webhook_metrics(opts = {})
-      data, _status_code, _headers = get_workspace_webhook_metrics_with_http_info(opts)
-      data
-    end
-
-    # Get workspace webhook metrics
-    # Get aggregate webhook health and performance metrics for the entire workspace.
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(WebhookWorkspaceMetricsResponse, Integer, Hash)>] WebhookWorkspaceMetricsResponse data, response status code and response headers
-    def get_workspace_webhook_metrics_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: WebhooksApi.get_workspace_webhook_metrics ...'
-      end
-      # resource path
-      local_var_path = '/v1/webhooks/metrics'
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-
-      # header parameters
-      header_params = opts[:header_params] || {}
-      # HTTP header 'Accept' (if needed)
-      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:debug_body]
-
-      # return_type
-      return_type = opts[:debug_return_type] || 'WebhookWorkspaceMetricsResponse'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
-
-      new_options = opts.merge(
-        :operation => :"WebhooksApi.get_workspace_webhook_metrics",
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => return_type
-      )
-
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: WebhooksApi#get_workspace_webhook_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # List webhook deliveries
     # List delivery attempts for a webhook with filtering and pagination.
     # @param id [String] Webhook ID
@@ -1038,7 +1038,7 @@ module Zyphr
     end
 
     # List webhooks
-    # List all webhooks for the workspace with pagination.
+    # List all webhooks for the account with pagination.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Maximum number of webhooks to return (default to 50)
     # @option opts [Integer] :offset Number of webhooks to skip (default to 0)
@@ -1049,7 +1049,7 @@ module Zyphr
     end
 
     # List webhooks
-    # List all webhooks for the workspace with pagination.
+    # List all webhooks for the account with pagination.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Maximum number of webhooks to return (default to 50)
     # @option opts [Integer] :offset Number of webhooks to skip (default to 0)

data/lib/zyphr/models/category.rb

@@ -17,7 +17,9 @@ module Zyphr
   class Category
     attr_accessor :id
 
-    attr_accessor :workspace_id
+    attr_accessor :account_id
+
+    attr_accessor :project_id
 
     attr_accessor :name
 
@@ -37,7 +39,8 @@ module Zyphr
     def self.attribute_map
       {
         :'id' => :'id',
-        :'workspace_id' => :'workspace_id',
+        :'account_id' => :'account_id',
+        :'project_id' => :'project_id',
         :'name' => :'name',
         :'slug' => :'slug',
         :'description' => :'description',
@@ -62,7 +65,8 @@ module Zyphr
     def self.openapi_types
       {
         :'id' => :'String',
-        :'workspace_id' => :'String',
+        :'account_id' => :'String',
+        :'project_id' => :'String',
         :'name' => :'String',
         :'slug' => :'String',
         :'description' => :'String',
@@ -100,8 +104,12 @@ module Zyphr
         self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'workspace_id')
-        self.workspace_id = attributes[:'workspace_id']
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
       end
 
       if attributes.key?(:'name')
@@ -156,7 +164,8 @@ module Zyphr
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          workspace_id == o.workspace_id &&
+          account_id == o.account_id &&
+          project_id == o.project_id &&
           name == o.name &&
           slug == o.slug &&
           description == o.description &&
@@ -175,7 +184,7 @@ module Zyphr
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, workspace_id, name, slug, description, channels, is_default, created_at, updated_at].hash
+      [id, account_id, project_id, name, slug, description, channels, is_default, created_at, updated_at].hash
     end
 
     # Builds the object from hash