zyphr 0.1.0

data/spec/api/subscribers_api_spec.rb

@@ -0,0 +1,272 @@
+=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::SubscribersApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SubscribersApi' do
+  before do
+    # run before each test
+    @api_instance = Zyphr::SubscribersApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SubscribersApi' do
+    it 'should create an instance of SubscribersApi' do
+      expect(@api_instance).to be_instance_of(Zyphr::SubscribersApi)
+    end
+  end
+
+  # unit tests for create_category
+  # Create a notification category
+  # @param create_category_request 
+  # @param [Hash] opts the optional parameters
+  # @return [CategoryResponse]
+  describe 'create_category 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 create_subscriber
+  # Create or update a subscriber
+  # Upsert a subscriber by external_id. If a subscriber with the given external_id already exists, it will be updated.
+  # @param create_subscriber_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SubscriberResponse]
+  describe 'create_subscriber 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_category
+  # Delete a category
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_category 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_subscriber
+  # Delete a subscriber
+  # Soft-deletes a subscriber by setting status to deleted.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_subscriber 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_category
+  # Get a category by ID or slug
+  # @param id_or_slug 
+  # @param [Hash] opts the optional parameters
+  # @return [CategoryResponse]
+  describe 'get_category 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_subscriber
+  # Get a subscriber by ID
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [SubscriberResponse]
+  describe 'get_subscriber 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_subscriber_by_external_id
+  # Get subscriber by external ID
+  # @param external_id 
+  # @param [Hash] opts the optional parameters
+  # @return [SubscriberResponse]
+  describe 'get_subscriber_by_external_id 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_subscriber_consent
+  # Get subscriber consent status
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [ConsentStatusResponse]
+  describe 'get_subscriber_consent 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_subscriber_consent_history
+  # Get subscriber consent history
+  # Returns paginated consent audit log for a subscriber.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit 
+  # @option opts [Integer] :offset 
+  # @return [ConsentHistoryResponse]
+  describe 'get_subscriber_consent_history 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_subscriber_preferences
+  # Get subscriber preferences
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Boolean] :effective Return effective preferences (merged with category defaults)
+  # @return [PreferenceListResponse]
+  describe 'get_subscriber_preferences 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_subscriber_unsubscribes
+  # Get subscriber unsubscribes
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [UnsubscribeListResponse]
+  describe 'get_subscriber_unsubscribes 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_categories
+  # List notification categories
+  # @param [Hash] opts the optional parameters
+  # @return [CategoryListResponse]
+  describe 'list_categories 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_subscribers
+  # List subscribers
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :status 
+  # @option opts [String] :email 
+  # @option opts [Integer] :limit 
+  # @option opts [Integer] :offset 
+  # @return [SubscriberListResponse]
+  describe 'list_subscribers 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 record_subscriber_consent
+  # Record subscriber consent
+  # @param id 
+  # @param body 
+  # @param [Hash] opts the optional parameters
+  # @return [ConsentRecordResponse]
+  describe 'record_subscriber_consent 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 resubscribe_subscriber
+  # Resubscribe to a channel
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [ResubscribeRequest] :resubscribe_request 
+  # @return [ResubscribeResponse]
+  describe 'resubscribe_subscriber 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 set_subscriber_preferences
+  # Set subscriber preferences
+  # Bulk set notification preferences for a subscriber.
+  # @param id 
+  # @param set_preferences_request 
+  # @param [Hash] opts the optional parameters
+  # @return [PreferenceListResponse]
+  describe 'set_subscriber_preferences 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 unsubscribe_subscriber
+  # Unsubscribe from a channel
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [UnsubscribeRequest] :unsubscribe_request 
+  # @return [UnsubscribeResponse]
+  describe 'unsubscribe_subscriber 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_category
+  # Update a category
+  # @param id 
+  # @param update_category_request 
+  # @param [Hash] opts the optional parameters
+  # @return [CategoryResponse]
+  describe 'update_category 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_subscriber
+  # Update a subscriber
+  # @param id 
+  # @param update_subscriber_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SubscriberResponse]
+  describe 'update_subscriber 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 withdraw_subscriber_consent
+  # Withdraw subscriber consent
+  # Withdraw consent for a subscriber (GDPR right to withdraw).
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [WithdrawSubscriberConsentRequest] :withdraw_subscriber_consent_request 
+  # @return [ConsentWithdrawResponse]
+  describe 'withdraw_subscriber_consent 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/templates_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::TemplatesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TemplatesApi' do
+  before do
+    # run before each test
+    @api_instance = Zyphr::TemplatesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TemplatesApi' do
+    it 'should create an instance of TemplatesApi' do
+      expect(@api_instance).to be_instance_of(Zyphr::TemplatesApi)
+    end
+  end
+
+  # unit tests for create_template
+  # Create template
+  # Create a new email template. Name must be unique within the workspace.
+  # @param create_template_request 
+  # @param [Hash] opts the optional parameters
+  # @return [TemplateResponse]
+  describe 'create_template 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_template
+  # Delete template
+  # Permanently delete a template.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteResult]
+  describe 'delete_template 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_template
+  # Get template
+  # Get a specific template by ID.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [TemplateResponse]
+  describe 'get_template 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_templates
+  # List templates
+  # List templates for the workspace with optional pagination.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit 
+  # @option opts [Integer] :offset 
+  # @return [TemplateListResponse]
+  describe 'list_templates 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 render_template
+  # Render template
+  # Render a template with provided variables to preview the output.
+  # @param id 
+  # @param render_template_request 
+  # @param [Hash] opts the optional parameters
+  # @return [TemplateRenderResponse]
+  describe 'render_template 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_template
+  # Update template
+  # Update an existing template. Only provided fields are changed.
+  # @param id 
+  # @param update_template_request 
+  # @param [Hash] opts the optional parameters
+  # @return [TemplateResponse]
+  describe 'update_template 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/topics_api_spec.rb

@@ -0,0 +1,149 @@
+=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::TopicsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TopicsApi' do
+  before do
+    # run before each test
+    @api_instance = Zyphr::TopicsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TopicsApi' do
+    it 'should create an instance of TopicsApi' do
+      expect(@api_instance).to be_instance_of(Zyphr::TopicsApi)
+    end
+  end
+
+  # unit tests for add_topic_subscribers
+  # Add subscribers to a topic
+  # Add one or more subscribers to a topic. Maximum 1000 subscriber IDs per request.
+  # @param key The unique topic key
+  # @param add_topic_subscribers_request 
+  # @param [Hash] opts the optional parameters
+  # @return [TopicSubscribersAddResponse]
+  describe 'add_topic_subscribers 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 create_topic
+  # Create a new topic
+  # Create a new notification topic for broadcasting to groups of subscribers.
+  # @param create_topic_request 
+  # @param [Hash] opts the optional parameters
+  # @return [TopicResponse]
+  describe 'create_topic 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_topic
+  # Delete a topic
+  # Delete a topic by its unique key. This cascades to all subscriptions.
+  # @param key The unique topic key
+  # @param [Hash] opts the optional parameters
+  # @return [TopicDeleteResponse]
+  describe 'delete_topic 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_topic
+  # Get a topic
+  # Retrieve a specific topic by its unique key.
+  # @param key The unique topic key
+  # @param [Hash] opts the optional parameters
+  # @return [TopicResponse]
+  describe 'get_topic 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_topic_stats
+  # Get topic statistics
+  # Get aggregate statistics for all topics in the workspace.
+  # @param [Hash] opts the optional parameters
+  # @return [TopicStatsResponse]
+  describe 'get_topic_stats 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_topic_subscribers
+  # List topic subscribers
+  # List all subscribers for a specific topic with pagination.
+  # @param key The unique topic key
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number
+  # @option opts [Integer] :per_page Items per page (max 1000)
+  # @return [TopicSubscriberListResponse]
+  describe 'list_topic_subscribers 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_topics
+  # List topics
+  # List all topics for the workspace with pagination and optional search.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number
+  # @option opts [Integer] :per_page Items per page (max 100)
+  # @option opts [String] :search Search topics by name or key
+  # @return [TopicListResponse]
+  describe 'list_topics 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 remove_topic_subscribers
+  # Remove subscribers from a topic
+  # Remove one or more subscribers from a topic. Maximum 1000 subscriber IDs per request.
+  # @param key The unique topic key
+  # @param remove_topic_subscribers_request 
+  # @param [Hash] opts the optional parameters
+  # @return [TopicSubscribersRemoveResponse]
+  describe 'remove_topic_subscribers 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_topic
+  # Update a topic
+  # Update a topic's name or description by its unique key.
+  # @param key The unique topic key
+  # @param update_topic_request 
+  # @param [Hash] opts the optional parameters
+  # @return [TopicResponse]
+  describe 'update_topic 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/utility_api_spec.rb

@@ -0,0 +1,46 @@
+=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::UtilityApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'UtilityApi' do
+  before do
+    # run before each test
+    @api_instance = Zyphr::UtilityApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of UtilityApi' do
+    it 'should create an instance of UtilityApi' do
+      expect(@api_instance).to be_instance_of(Zyphr::UtilityApi)
+    end
+  end
+
+  # unit tests for get_password_requirements
+  # Get password requirements
+  # Get password requirements for the application. Useful for client-side validation before registration.
+  # @param [Hash] opts the optional parameters
+  # @return [PasswordRequirementsResponse]
+  describe 'get_password_requirements test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end