zyphr 0.1.0 → 0.1.2

data/lib/zyphr/api/waa_s_deliveries_api.rb

@@ -0,0 +1,316 @@
+=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 WaaSDeliveriesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get delivery detail
+    # Get full delivery details including request/response data.
+    # @param app_id [String] 
+    # @param delivery_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_waa_s_delivery(app_id, delivery_id, opts = {})
+      get_waa_s_delivery_with_http_info(app_id, delivery_id, opts)
+      nil
+    end
+
+    # Get delivery detail
+    # Get full delivery details including request/response data.
+    # @param app_id [String] 
+    # @param delivery_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_waa_s_delivery_with_http_info(app_id, delivery_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WaaSDeliveriesApi.get_waa_s_delivery ...'
+      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 WaaSDeliveriesApi.get_waa_s_delivery"
+      end
+      # verify the required parameter 'delivery_id' is set
+      if @api_client.config.client_side_validation && delivery_id.nil?
+        fail ArgumentError, "Missing the required parameter 'delivery_id' when calling WaaSDeliveriesApi.get_waa_s_delivery"
+      end
+      # resource path
+      local_var_path = '/v1/waas/applications/{appId}/deliveries/{deliveryId}'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'deliveryId' + '}', CGI.escape(delivery_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 => :"WaaSDeliveriesApi.get_waa_s_delivery",
+        :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: WaaSDeliveriesApi#get_waa_s_delivery\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List deliveries
+    # List delivery records for a WaaS application. Filter by tenant, event type, or status.
+    # @param app_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit  (default to 50)
+    # @option opts [Integer] :offset  (default to 0)
+    # @option opts [String] :tenant_id 
+    # @option opts [String] :event_type 
+    # @option opts [String] :status 
+    # @return [ListWaaSEndpointDeliveries200Response]
+    def list_waa_s_deliveries(app_id, opts = {})
+      data, _status_code, _headers = list_waa_s_deliveries_with_http_info(app_id, opts)
+      data
+    end
+
+    # List deliveries
+    # List delivery records for a WaaS application. Filter by tenant, event type, or status.
+    # @param app_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit  (default to 50)
+    # @option opts [Integer] :offset  (default to 0)
+    # @option opts [String] :tenant_id 
+    # @option opts [String] :event_type 
+    # @option opts [String] :status 
+    # @return [Array<(ListWaaSEndpointDeliveries200Response, Integer, Hash)>] ListWaaSEndpointDeliveries200Response data, response status code and response headers
+    def list_waa_s_deliveries_with_http_info(app_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WaaSDeliveriesApi.list_waa_s_deliveries ...'
+      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 WaaSDeliveriesApi.list_waa_s_deliveries"
+      end
+      allowable_values = ["pending", "delivering", "delivered", "failed", "retrying", "exhausted"]
+      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/{appId}/deliveries'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s))
+
+      # 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[:'tenant_id'] = opts[:'tenant_id'] if !opts[:'tenant_id'].nil?
+      query_params[:'event_type'] = opts[:'event_type'] if !opts[:'event_type'].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] || 'ListWaaSEndpointDeliveries200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WaaSDeliveriesApi.list_waa_s_deliveries",
+        :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: WaaSDeliveriesApi#list_waa_s_deliveries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List endpoint deliveries
+    # List deliveries for a specific endpoint.
+    # @param app_id [String] 
+    # @param endpoint_id [String] 
+    # @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 [ListWaaSEndpointDeliveries200Response]
+    def list_waa_s_endpoint_deliveries(app_id, endpoint_id, opts = {})
+      data, _status_code, _headers = list_waa_s_endpoint_deliveries_with_http_info(app_id, endpoint_id, opts)
+      data
+    end
+
+    # List endpoint deliveries
+    # List deliveries for a specific endpoint.
+    # @param app_id [String] 
+    # @param endpoint_id [String] 
+    # @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<(ListWaaSEndpointDeliveries200Response, Integer, Hash)>] ListWaaSEndpointDeliveries200Response data, response status code and response headers
+    def list_waa_s_endpoint_deliveries_with_http_info(app_id, endpoint_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WaaSDeliveriesApi.list_waa_s_endpoint_deliveries ...'
+      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 WaaSDeliveriesApi.list_waa_s_endpoint_deliveries"
+      end
+      # verify the required parameter 'endpoint_id' is set
+      if @api_client.config.client_side_validation && endpoint_id.nil?
+        fail ArgumentError, "Missing the required parameter 'endpoint_id' when calling WaaSDeliveriesApi.list_waa_s_endpoint_deliveries"
+      end
+      # resource path
+      local_var_path = '/v1/waas/applications/{appId}/endpoints/{endpointId}/deliveries'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'endpointId' + '}', CGI.escape(endpoint_id.to_s))
+
+      # 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] || 'ListWaaSEndpointDeliveries200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WaaSDeliveriesApi.list_waa_s_endpoint_deliveries",
+        :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: WaaSDeliveriesApi#list_waa_s_endpoint_deliveries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retry a delivery
+    # Retry a failed or exhausted delivery. Resets the delivery status and re-queues it.
+    # @param app_id [String] 
+    # @param delivery_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def retry_waa_s_delivery(app_id, delivery_id, opts = {})
+      retry_waa_s_delivery_with_http_info(app_id, delivery_id, opts)
+      nil
+    end
+
+    # Retry a delivery
+    # Retry a failed or exhausted delivery. Resets the delivery status and re-queues it.
+    # @param app_id [String] 
+    # @param delivery_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def retry_waa_s_delivery_with_http_info(app_id, delivery_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WaaSDeliveriesApi.retry_waa_s_delivery ...'
+      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 WaaSDeliveriesApi.retry_waa_s_delivery"
+      end
+      # verify the required parameter 'delivery_id' is set
+      if @api_client.config.client_side_validation && delivery_id.nil?
+        fail ArgumentError, "Missing the required parameter 'delivery_id' when calling WaaSDeliveriesApi.retry_waa_s_delivery"
+      end
+      # resource path
+      local_var_path = '/v1/waas/applications/{appId}/deliveries/{deliveryId}/retry'.sub('{' + 'appId' + '}', CGI.escape(app_id.to_s)).sub('{' + 'deliveryId' + '}', CGI.escape(delivery_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 => :"WaaSDeliveriesApi.retry_waa_s_delivery",
+        :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: WaaSDeliveriesApi#retry_waa_s_delivery\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end