zyphr 0.1.0 → 0.1.2

data/lib/zyphr/models/waa_s_usage_response.rb

@@ -0,0 +1,265 @@
+=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 'date'
+require 'time'
+
+module Zyphr
+  class WaaSUsageResponse
+    attr_accessor :applications_count
+
+    attr_accessor :applications_limit
+
+    attr_accessor :endpoints_count
+
+    attr_accessor :endpoints_limit
+
+    attr_accessor :events_this_month
+
+    attr_accessor :events_limit
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'applications_count' => :'applications_count',
+        :'applications_limit' => :'applications_limit',
+        :'endpoints_count' => :'endpoints_count',
+        :'endpoints_limit' => :'endpoints_limit',
+        :'events_this_month' => :'events_this_month',
+        :'events_limit' => :'events_limit'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'applications_count' => :'Integer',
+        :'applications_limit' => :'Integer',
+        :'endpoints_count' => :'Integer',
+        :'endpoints_limit' => :'Integer',
+        :'events_this_month' => :'Integer',
+        :'events_limit' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Zyphr::WaaSUsageResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zyphr::WaaSUsageResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'applications_count')
+        self.applications_count = attributes[:'applications_count']
+      end
+
+      if attributes.key?(:'applications_limit')
+        self.applications_limit = attributes[:'applications_limit']
+      end
+
+      if attributes.key?(:'endpoints_count')
+        self.endpoints_count = attributes[:'endpoints_count']
+      end
+
+      if attributes.key?(:'endpoints_limit')
+        self.endpoints_limit = attributes[:'endpoints_limit']
+      end
+
+      if attributes.key?(:'events_this_month')
+        self.events_this_month = attributes[:'events_this_month']
+      end
+
+      if attributes.key?(:'events_limit')
+        self.events_limit = attributes[:'events_limit']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          applications_count == o.applications_count &&
+          applications_limit == o.applications_limit &&
+          endpoints_count == o.endpoints_count &&
+          endpoints_limit == o.endpoints_limit &&
+          events_this_month == o.events_this_month &&
+          events_limit == o.events_limit
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [applications_count, applications_limit, endpoints_count, endpoints_limit, events_this_month, events_limit].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Zyphr.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/zyphr.rb

@@ -31,6 +31,7 @@ require 'zyphr/models/auth_tokens'
 require 'zyphr/models/auth_user'
 require 'zyphr/models/auth_user_response'
 require 'zyphr/models/auth_user_response_data'
+require 'zyphr/models/batch_publish_waa_s_events201_response'
 require 'zyphr/models/bulk_retry_webhook_deliveries_request'
 require 'zyphr/models/category'
 require 'zyphr/models/category_list_response'
@@ -49,6 +50,13 @@ require 'zyphr/models/create_category_request'
 require 'zyphr/models/create_subscriber_request'
 require 'zyphr/models/create_template_request'
 require 'zyphr/models/create_topic_request'
+require 'zyphr/models/create_waa_s_application201_response'
+require 'zyphr/models/create_waa_s_application_request'
+require 'zyphr/models/create_waa_s_endpoint201_response'
+require 'zyphr/models/create_waa_s_endpoint_request'
+require 'zyphr/models/create_waa_s_endpoint_response'
+require 'zyphr/models/create_waa_s_event_type201_response'
+require 'zyphr/models/create_waa_s_event_type_request'
 require 'zyphr/models/create_webhook_request'
 require 'zyphr/models/delete_result'
 require 'zyphr/models/delete_result_data'
@@ -75,10 +83,17 @@ require 'zyphr/models/email_tracking_response'
 require 'zyphr/models/end_user_delete_response'
 require 'zyphr/models/end_user_delete_response_data'
 require 'zyphr/models/forgot_password_request'
+require 'zyphr/models/generate_waa_s_portal_token201_response'
+require 'zyphr/models/get_waa_s_endpoint200_response'
+require 'zyphr/models/get_waa_s_usage200_response'
 require 'zyphr/models/in_app_notification'
 require 'zyphr/models/inbox_list_meta'
 require 'zyphr/models/inbox_list_response'
 require 'zyphr/models/inbox_notification_response'
+require 'zyphr/models/list_waa_s_applications200_response'
+require 'zyphr/models/list_waa_s_endpoint_deliveries200_response'
+require 'zyphr/models/list_waa_s_endpoints200_response'
+require 'zyphr/models/list_waa_s_event_types200_response'
 require 'zyphr/models/login_request'
 require 'zyphr/models/magic_link_send_request'
 require 'zyphr/models/magic_link_verify_request'
@@ -136,6 +151,7 @@ require 'zyphr/models/phone_otp_sent_response'
 require 'zyphr/models/phone_otp_sent_response_data'
 require 'zyphr/models/phone_register_verify_request'
 require 'zyphr/models/preference_list_response'
+require 'zyphr/models/publish_waa_s_event201_response'
 require 'zyphr/models/push_detail_response'
 require 'zyphr/models/push_event'
 require 'zyphr/models/push_list_response'
@@ -253,6 +269,9 @@ require 'zyphr/models/update_end_user_request'
 require 'zyphr/models/update_subscriber_request'
 require 'zyphr/models/update_template_request'
 require 'zyphr/models/update_topic_request'
+require 'zyphr/models/update_waa_s_application_request'
+require 'zyphr/models/update_waa_s_endpoint_request'
+require 'zyphr/models/update_waa_s_event_type_request'
 require 'zyphr/models/update_webhook_request'
 require 'zyphr/models/upsert_sms_config_request'
 require 'zyphr/models/user_devices_delete_response'
@@ -262,6 +281,18 @@ require 'zyphr/models/validate_reset_token_response'
 require 'zyphr/models/validate_reset_token_response_data'
 require 'zyphr/models/verify_sms_config_data'
 require 'zyphr/models/verify_sms_config_response'
+require 'zyphr/models/waa_s_application'
+require 'zyphr/models/waa_s_batch_publish_request'
+require 'zyphr/models/waa_s_batch_publish_response'
+require 'zyphr/models/waa_s_delivery'
+require 'zyphr/models/waa_s_endpoint'
+require 'zyphr/models/waa_s_event_type'
+require 'zyphr/models/waa_s_portal_token_request'
+require 'zyphr/models/waa_s_portal_token_request_theme'
+require 'zyphr/models/waa_s_portal_token_response'
+require 'zyphr/models/waa_s_publish_event_request'
+require 'zyphr/models/waa_s_publish_event_response'
+require 'zyphr/models/waa_s_usage_response'
 require 'zyphr/models/web_authn_challenge_options'
 require 'zyphr/models/web_authn_credential'
 require 'zyphr/models/web_authn_credential_list_response'
@@ -336,6 +367,12 @@ require 'zyphr/api/subscribers_api'
 require 'zyphr/api/templates_api'
 require 'zyphr/api/topics_api'
 require 'zyphr/api/utility_api'
+require 'zyphr/api/waa_s_applications_api'
+require 'zyphr/api/waa_s_deliveries_api'
+require 'zyphr/api/waa_s_endpoints_api'
+require 'zyphr/api/waa_s_event_types_api'
+require 'zyphr/api/waa_s_events_api'
+require 'zyphr/api/waa_s_portal_api'
 require 'zyphr/api/webhooks_api'
 
 module Zyphr

data/spec/api/waa_s_applications_api_spec.rb

@@ -0,0 +1,110 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for Zyphr::WaaSApplicationsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'WaaSApplicationsApi' do
+  before do
+    # run before each test
+    @api_instance = Zyphr::WaaSApplicationsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of WaaSApplicationsApi' do
+    it 'should create an instance of WaaSApplicationsApi' do
+      expect(@api_instance).to be_instance_of(Zyphr::WaaSApplicationsApi)
+    end
+  end
+
+  # unit tests for create_waa_s_application
+  # Create a WaaS application
+  # Create a new Webhooks-as-a-Service application.
+  # @param create_waa_s_application_request 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateWaaSApplication201Response]
+  describe 'create_waa_s_application test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_waa_s_application
+  # Delete a WaaS application
+  # Delete a WaaS application and all associated event types, endpoints, and delivery logs.
+  # @param app_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_waa_s_application test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_waa_s_application
+  # Get a WaaS application
+  # Get a specific Webhooks-as-a-Service application by ID.
+  # @param app_id 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateWaaSApplication201Response]
+  describe 'get_waa_s_application test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_waa_s_usage
+  # Get WaaS usage
+  # Get current usage counts and plan limits for WaaS resources.
+  # @param app_id 
+  # @param [Hash] opts the optional parameters
+  # @return [GetWaaSUsage200Response]
+  describe 'get_waa_s_usage test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_waa_s_applications
+  # List WaaS applications
+  # List all Webhooks-as-a-Service applications in the workspace.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit 
+  # @option opts [Integer] :offset 
+  # @option opts [String] :status 
+  # @return [ListWaaSApplications200Response]
+  describe 'list_waa_s_applications test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_waa_s_application
+  # Update a WaaS application
+  # Update the name, description, or status of a WaaS application.
+  # @param app_id 
+  # @param update_waa_s_application_request 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateWaaSApplication201Response]
+  describe 'update_waa_s_application test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/waa_s_deliveries_api_spec.rb

@@ -0,0 +1,94 @@
+=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 'spec_helper'
+require 'json'
+
+# Unit tests for Zyphr::WaaSDeliveriesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'WaaSDeliveriesApi' do
+  before do
+    # run before each test
+    @api_instance = Zyphr::WaaSDeliveriesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of WaaSDeliveriesApi' do
+    it 'should create an instance of WaaSDeliveriesApi' do
+      expect(@api_instance).to be_instance_of(Zyphr::WaaSDeliveriesApi)
+    end
+  end
+
+  # unit tests for get_waa_s_delivery
+  # Get delivery detail
+  # Get full delivery details including request/response data.
+  # @param app_id 
+  # @param delivery_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'get_waa_s_delivery test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_waa_s_deliveries
+  # List deliveries
+  # List delivery records for a WaaS application. Filter by tenant, event type, or status.
+  # @param app_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit 
+  # @option opts [Integer] :offset 
+  # @option opts [String] :tenant_id 
+  # @option opts [String] :event_type 
+  # @option opts [String] :status 
+  # @return [ListWaaSEndpointDeliveries200Response]
+  describe 'list_waa_s_deliveries test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_waa_s_endpoint_deliveries
+  # List endpoint deliveries
+  # List deliveries for a specific endpoint.
+  # @param app_id 
+  # @param endpoint_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit 
+  # @option opts [Integer] :offset 
+  # @option opts [String] :status 
+  # @return [ListWaaSEndpointDeliveries200Response]
+  describe 'list_waa_s_endpoint_deliveries test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for retry_waa_s_delivery
+  # Retry a delivery
+  # Retry a failed or exhausted delivery. Resets the delivery status and re-queues it.
+  # @param app_id 
+  # @param delivery_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'retry_waa_s_delivery test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end