zyphr 0.1.0 → 0.1.2

data/docs/WaaSPortalTokenRequestTheme.md

@@ -0,0 +1,20 @@
+# Zyphr::WaaSPortalTokenRequestTheme
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** |  | [optional] |
+| **accent** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::WaaSPortalTokenRequestTheme.new(
+  mode: null,
+  accent: null
+)
+```
+

data/docs/WaaSPortalTokenResponse.md

@@ -0,0 +1,20 @@
+# Zyphr::WaaSPortalTokenResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** |  | [optional] |
+| **expires_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::WaaSPortalTokenResponse.new(
+  token: null,
+  expires_at: null
+)
+```
+

data/docs/WaaSPublishEventRequest.md

@@ -0,0 +1,24 @@
+# Zyphr::WaaSPublishEventRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_type** | **String** | Event type to publish |  |
+| **tenant_id** | **String** | Target tenant |  |
+| **data** | **Object** | Event payload |  |
+| **idempotency_key** | **String** | Deduplication key | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::WaaSPublishEventRequest.new(
+  event_type: order.created,
+  tenant_id: tenant_abc,
+  data: null,
+  idempotency_key: null
+)
+```
+

data/docs/WaaSPublishEventResponse.md

@@ -0,0 +1,26 @@
+# Zyphr::WaaSPublishEventResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** |  | [optional] |
+| **event_type** | **String** |  | [optional] |
+| **tenant_id** | **String** |  | [optional] |
+| **endpoints_matched** | **Integer** |  | [optional] |
+| **deliveries_created** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::WaaSPublishEventResponse.new(
+  event_id: null,
+  event_type: null,
+  tenant_id: null,
+  endpoints_matched: null,
+  deliveries_created: null
+)
+```
+

data/docs/WaaSUsageResponse.md

@@ -0,0 +1,28 @@
+# Zyphr::WaaSUsageResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **applications_count** | **Integer** |  | [optional] |
+| **applications_limit** | **Integer** |  | [optional] |
+| **endpoints_count** | **Integer** |  | [optional] |
+| **endpoints_limit** | **Integer** |  | [optional] |
+| **events_this_month** | **Integer** |  | [optional] |
+| **events_limit** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::WaaSUsageResponse.new(
+  applications_count: null,
+  applications_limit: null,
+  endpoints_count: null,
+  endpoints_limit: null,
+  events_this_month: null,
+  events_limit: null
+)
+```
+

data/lib/zyphr/api/waa_s_applications_api.rb

@@ -0,0 +1,425 @@
+=begin
+#Zyphr API
+
+#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API.  ## Authentication  All API requests require authentication using an API key. Include your API key in the `X-API-Key` header:  ``` X-API-Key: zy_live_xxxxxxxxxxxx ```  API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production.  ## Rate Limiting  The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:  - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets  ## Errors  All errors follow a consistent format:  ```json {   \"error\": {     \"code\": \"error_code\",     \"message\": \"Human readable message\",     \"details\": {}   },   \"meta\": {     \"request_id\": \"req_xxxx\"   } } ```
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@zyphr.dev
+Generated by: https://openapi-generator.tech
+Generator version: 7.12.0
+
+=end
+
+require 'cgi'
+
+module Zyphr
+  class WaaSApplicationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a WaaS application
+    # Create a new Webhooks-as-a-Service application.
+    # @param create_waa_s_application_request [CreateWaaSApplicationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateWaaSApplication201Response]
+    def create_waa_s_application(create_waa_s_application_request, opts = {})
+      data, _status_code, _headers = create_waa_s_application_with_http_info(create_waa_s_application_request, opts)
+      data
+    end
+
+    # Create a WaaS application
+    # Create a new Webhooks-as-a-Service application.
+    # @param create_waa_s_application_request [CreateWaaSApplicationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateWaaSApplication201Response, Integer, Hash)>] CreateWaaSApplication201Response data, response status code and response headers
+    def create_waa_s_application_with_http_info(create_waa_s_application_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WaaSApplicationsApi.create_waa_s_application ...'
+      end
+      # verify the required parameter 'create_waa_s_application_request' is set
+      if @api_client.config.client_side_validation && create_waa_s_application_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_waa_s_application_request' when calling WaaSApplicationsApi.create_waa_s_application"
+      end
+      # resource path
+      local_var_path = '/v1/waas/applications'
+
+      # 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']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_waa_s_application_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateWaaSApplication201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WaaSApplicationsApi.create_waa_s_application",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WaaSApplicationsApi#create_waa_s_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a WaaS application
+    # Delete a WaaS application and all associated event types, endpoints, and delivery logs.
+    # @param app_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_waa_s_application(app_id, opts = {})
+      delete_waa_s_application_with_http_info(app_id, opts)
+      nil
+    end
+
+    # Delete a WaaS application
+    # Delete a WaaS application and all associated event types, endpoints, and delivery logs.
+    # @param app_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_waa_s_application_with_http_info(app_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WaaSApplicationsApi.delete_waa_s_application ...'
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling WaaSApplicationsApi.delete_waa_s_application"
+      end
+      # resource path
+      local_var_path = '/v1/waas/applications/{appId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WaaSApplicationsApi.delete_waa_s_application",
+        :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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WaaSApplicationsApi#delete_waa_s_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a WaaS application
+    # Get a specific Webhooks-as-a-Service application by ID.
+    # @param app_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateWaaSApplication201Response]
+    def get_waa_s_application(app_id, opts = {})
+      data, _status_code, _headers = get_waa_s_application_with_http_info(app_id, opts)
+      data
+    end
+
+    # Get a WaaS application
+    # Get a specific Webhooks-as-a-Service application by ID.
+    # @param app_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateWaaSApplication201Response, Integer, Hash)>] CreateWaaSApplication201Response data, response status code and response headers
+    def get_waa_s_application_with_http_info(app_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WaaSApplicationsApi.get_waa_s_application ...'
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling WaaSApplicationsApi.get_waa_s_application"
+      end
+      # resource path
+      local_var_path = '/v1/waas/applications/{appId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))
+
+      # 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] || 'CreateWaaSApplication201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WaaSApplicationsApi.get_waa_s_application",
+        :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: WaaSApplicationsApi#get_waa_s_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get WaaS usage
+    # Get current usage counts and plan limits for WaaS resources.
+    # @param app_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetWaaSUsage200Response]
+    def get_waa_s_usage(app_id, opts = {})
+      data, _status_code, _headers = get_waa_s_usage_with_http_info(app_id, opts)
+      data
+    end
+
+    # Get WaaS usage
+    # Get current usage counts and plan limits for WaaS resources.
+    # @param app_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetWaaSUsage200Response, Integer, Hash)>] GetWaaSUsage200Response data, response status code and response headers
+    def get_waa_s_usage_with_http_info(app_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WaaSApplicationsApi.get_waa_s_usage ...'
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling WaaSApplicationsApi.get_waa_s_usage"
+      end
+      # resource path
+      local_var_path = '/v1/waas/applications/{appId}/usage'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))
+
+      # 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] || 'GetWaaSUsage200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WaaSApplicationsApi.get_waa_s_usage",
+        :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: WaaSApplicationsApi#get_waa_s_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List WaaS applications
+    # List all Webhooks-as-a-Service applications in the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit  (default to 50)
+    # @option opts [Integer] :offset  (default to 0)
+    # @option opts [String] :status 
+    # @return [ListWaaSApplications200Response]
+    def list_waa_s_applications(opts = {})
+      data, _status_code, _headers = list_waa_s_applications_with_http_info(opts)
+      data
+    end
+
+    # List WaaS applications
+    # List all Webhooks-as-a-Service applications in the workspace.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit  (default to 50)
+    # @option opts [Integer] :offset  (default to 0)
+    # @option opts [String] :status 
+    # @return [Array<(ListWaaSApplications200Response, Integer, Hash)>] ListWaaSApplications200Response data, response status code and response headers
+    def list_waa_s_applications_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WaaSApplicationsApi.list_waa_s_applications ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling WaaSApplicationsApi.list_waa_s_applications, must be smaller than or equal to 100.'
+      end
+
+      allowable_values = ["active", "paused", "disabled"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
+        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/v1/waas/applications'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+
+      # 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] || 'ListWaaSApplications200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WaaSApplicationsApi.list_waa_s_applications",
+        :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: WaaSApplicationsApi#list_waa_s_applications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a WaaS application
+    # Update the name, description, or status of a WaaS application.
+    # @param app_id [String] 
+    # @param update_waa_s_application_request [UpdateWaaSApplicationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateWaaSApplication201Response]
+    def update_waa_s_application(app_id, update_waa_s_application_request, opts = {})
+      data, _status_code, _headers = update_waa_s_application_with_http_info(app_id, update_waa_s_application_request, opts)
+      data
+    end
+
+    # Update a WaaS application
+    # Update the name, description, or status of a WaaS application.
+    # @param app_id [String] 
+    # @param update_waa_s_application_request [UpdateWaaSApplicationRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateWaaSApplication201Response, Integer, Hash)>] CreateWaaSApplication201Response data, response status code and response headers
+    def update_waa_s_application_with_http_info(app_id, update_waa_s_application_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WaaSApplicationsApi.update_waa_s_application ...'
+      end
+      # verify the required parameter 'app_id' is set
+      if @api_client.config.client_side_validation && app_id.nil?
+        fail ArgumentError, "Missing the required parameter 'app_id' when calling WaaSApplicationsApi.update_waa_s_application"
+      end
+      # verify the required parameter 'update_waa_s_application_request' is set
+      if @api_client.config.client_side_validation && update_waa_s_application_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_waa_s_application_request' when calling WaaSApplicationsApi.update_waa_s_application"
+      end
+      # resource path
+      local_var_path = '/v1/waas/applications/{appId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))
+
+      # 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']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_waa_s_application_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateWaaSApplication201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WaaSApplicationsApi.update_waa_s_application",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WaaSApplicationsApi#update_waa_s_application\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end