zyphr 0.1.41 → 0.1.43

data/lib/zyphr/api/waa_s_endpoints_api.rb

@@ -24,10 +24,10 @@ module Zyphr
     # @param app_id [String] 
     # @param endpoint_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [CloseWaaSEndpointCircuit200Response]
     def close_waa_s_endpoint_circuit(app_id, endpoint_id, opts = {})
-      close_waa_s_endpoint_circuit_with_http_info(app_id, endpoint_id, opts)
-      nil
+      data, _status_code, _headers = close_waa_s_endpoint_circuit_with_http_info(app_id, endpoint_id, opts)
+      data
     end
 
     # Force-close circuit breaker
@@ -35,7 +35,7 @@ module Zyphr
     # @param app_id [String] 
     # @param endpoint_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(CloseWaaSEndpointCircuit200Response, Integer, Hash)>] CloseWaaSEndpointCircuit200Response data, response status code and response headers
     def close_waa_s_endpoint_circuit_with_http_info(app_id, endpoint_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: WaaSEndpointsApi.close_waa_s_endpoint_circuit ...'
@@ -56,6 +56,8 @@ module Zyphr
 
       # 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] || {}
@@ -64,7 +66,7 @@ module Zyphr
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'CloseWaaSEndpointCircuit200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
@@ -299,10 +301,10 @@ module Zyphr
     # @param app_id [String] 
     # @param endpoint_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [GetWaaSEndpointCircuit200Response]
     def get_waa_s_endpoint_circuit(app_id, endpoint_id, opts = {})
-      get_waa_s_endpoint_circuit_with_http_info(app_id, endpoint_id, opts)
-      nil
+      data, _status_code, _headers = get_waa_s_endpoint_circuit_with_http_info(app_id, endpoint_id, opts)
+      data
     end
 
     # Get circuit breaker state
@@ -310,7 +312,7 @@ module Zyphr
     # @param app_id [String] 
     # @param endpoint_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(GetWaaSEndpointCircuit200Response, Integer, Hash)>] GetWaaSEndpointCircuit200Response data, response status code and response headers
     def get_waa_s_endpoint_circuit_with_http_info(app_id, endpoint_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: WaaSEndpointsApi.get_waa_s_endpoint_circuit ...'
@@ -331,6 +333,8 @@ module Zyphr
 
       # 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] || {}
@@ -339,7 +343,7 @@ module Zyphr
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'GetWaaSEndpointCircuit200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
@@ -366,10 +370,10 @@ module Zyphr
     # @param app_id [String] 
     # @param endpoint_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [GetWaaSEndpointMetrics200Response]
     def get_waa_s_endpoint_metrics(app_id, endpoint_id, opts = {})
-      get_waa_s_endpoint_metrics_with_http_info(app_id, endpoint_id, opts)
-      nil
+      data, _status_code, _headers = get_waa_s_endpoint_metrics_with_http_info(app_id, endpoint_id, opts)
+      data
     end
 
     # Get endpoint metrics
@@ -377,7 +381,7 @@ module Zyphr
     # @param app_id [String] 
     # @param endpoint_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(GetWaaSEndpointMetrics200Response, Integer, Hash)>] GetWaaSEndpointMetrics200Response data, response status code and response headers
     def get_waa_s_endpoint_metrics_with_http_info(app_id, endpoint_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: WaaSEndpointsApi.get_waa_s_endpoint_metrics ...'
@@ -398,6 +402,8 @@ module Zyphr
 
       # 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] || {}
@@ -406,7 +412,7 @@ module Zyphr
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'GetWaaSEndpointMetrics200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
@@ -512,10 +518,10 @@ module Zyphr
     # @param app_id [String] 
     # @param endpoint_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [RotateWaaSEndpointSecret200Response]
     def rotate_waa_s_endpoint_secret(app_id, endpoint_id, opts = {})
-      rotate_waa_s_endpoint_secret_with_http_info(app_id, endpoint_id, opts)
-      nil
+      data, _status_code, _headers = rotate_waa_s_endpoint_secret_with_http_info(app_id, endpoint_id, opts)
+      data
     end
 
     # Rotate endpoint secret
@@ -523,7 +529,7 @@ module Zyphr
     # @param app_id [String] 
     # @param endpoint_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(RotateWaaSEndpointSecret200Response, Integer, Hash)>] RotateWaaSEndpointSecret200Response data, response status code and response headers
     def rotate_waa_s_endpoint_secret_with_http_info(app_id, endpoint_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: WaaSEndpointsApi.rotate_waa_s_endpoint_secret ...'
@@ -544,6 +550,8 @@ module Zyphr
 
       # 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] || {}
@@ -552,7 +560,7 @@ module Zyphr
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'RotateWaaSEndpointSecret200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
@@ -579,10 +587,10 @@ module Zyphr
     # @param endpoint_id [String] 
     # @param update_waa_s_endpoint_request [UpdateWaaSEndpointRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [UpdateWaaSEndpoint200Response]
     def update_waa_s_endpoint(app_id, endpoint_id, update_waa_s_endpoint_request, opts = {})
-      update_waa_s_endpoint_with_http_info(app_id, endpoint_id, update_waa_s_endpoint_request, opts)
-      nil
+      data, _status_code, _headers = update_waa_s_endpoint_with_http_info(app_id, endpoint_id, update_waa_s_endpoint_request, opts)
+      data
     end
 
     # Update an endpoint
@@ -590,7 +598,7 @@ module Zyphr
     # @param endpoint_id [String] 
     # @param update_waa_s_endpoint_request [UpdateWaaSEndpointRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(UpdateWaaSEndpoint200Response, Integer, Hash)>] UpdateWaaSEndpoint200Response data, response status code and response headers
     def update_waa_s_endpoint_with_http_info(app_id, endpoint_id, update_waa_s_endpoint_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: WaaSEndpointsApi.update_waa_s_endpoint ...'
@@ -615,6 +623,8 @@ module Zyphr
 
       # 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?
@@ -628,7 +638,7 @@ module Zyphr
       post_body = opts[:debug_body] || @api_client.object_to_http_body(update_waa_s_endpoint_request)
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'UpdateWaaSEndpoint200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

data/lib/zyphr/api/waa_s_event_types_api.rb

@@ -165,10 +165,10 @@ module Zyphr
     # @param app_id [String] 
     # @param event_type_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [UpdateWaaSEventType200Response]
     def deprecate_waa_s_event_type(app_id, event_type_id, opts = {})
-      deprecate_waa_s_event_type_with_http_info(app_id, event_type_id, opts)
-      nil
+      data, _status_code, _headers = deprecate_waa_s_event_type_with_http_info(app_id, event_type_id, opts)
+      data
     end
 
     # Deprecate an event type
@@ -176,7 +176,7 @@ module Zyphr
     # @param app_id [String] 
     # @param event_type_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(UpdateWaaSEventType200Response, Integer, Hash)>] UpdateWaaSEventType200Response data, response status code and response headers
     def deprecate_waa_s_event_type_with_http_info(app_id, event_type_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: WaaSEventTypesApi.deprecate_waa_s_event_type ...'
@@ -197,6 +197,8 @@ module Zyphr
 
       # 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] || {}
@@ -205,7 +207,7 @@ module Zyphr
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'UpdateWaaSEventType200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
@@ -378,10 +380,10 @@ module Zyphr
     # @param event_type_id [String] 
     # @param update_waa_s_event_type_request [UpdateWaaSEventTypeRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [UpdateWaaSEventType200Response]
     def update_waa_s_event_type(app_id, event_type_id, update_waa_s_event_type_request, opts = {})
-      update_waa_s_event_type_with_http_info(app_id, event_type_id, update_waa_s_event_type_request, opts)
-      nil
+      data, _status_code, _headers = update_waa_s_event_type_with_http_info(app_id, event_type_id, update_waa_s_event_type_request, opts)
+      data
     end
 
     # Update an event type
@@ -389,7 +391,7 @@ module Zyphr
     # @param event_type_id [String] 
     # @param update_waa_s_event_type_request [UpdateWaaSEventTypeRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(UpdateWaaSEventType200Response, Integer, Hash)>] UpdateWaaSEventType200Response data, response status code and response headers
     def update_waa_s_event_type_with_http_info(app_id, event_type_id, update_waa_s_event_type_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: WaaSEventTypesApi.update_waa_s_event_type ...'
@@ -414,6 +416,8 @@ module Zyphr
 
       # 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?
@@ -427,7 +431,7 @@ module Zyphr
       post_body = opts[:debug_body] || @api_client.object_to_http_body(update_waa_s_event_type_request)
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'UpdateWaaSEventType200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']

data/lib/zyphr/models/close_waa_s_endpoint_circuit200_response.rb

@@ -0,0 +1,229 @@
+=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  ## Account Sending Status  Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call:  - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`)  This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message.  ## 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 CloseWaaSEndpointCircuit200Response
+    attr_accessor :data
+
+    attr_accessor :meta
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'meta' => :'meta'
+      }
+    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
+      {
+        :'data' => :'CloseWaaSEndpointCircuit200ResponseData',
+        :'meta' => :'GetDomain200ResponseMeta'
+      }
+    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::CloseWaaSEndpointCircuit200Response` 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::CloseWaaSEndpointCircuit200Response`. 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?(:'data')
+        self.data = attributes[:'data']
+      end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      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 &&
+          data == o.data &&
+          meta == o.meta
+    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
+      [data, meta].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