zyphr 0.1.0

data/spec/api/devices_api_spec.rb

@@ -0,0 +1,109 @@
+=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::DevicesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'DevicesApi' do
+  before do
+    # run before each test
+    @api_instance = Zyphr::DevicesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DevicesApi' do
+    it 'should create an instance of DevicesApi' do
+      expect(@api_instance).to be_instance_of(Zyphr::DevicesApi)
+    end
+  end
+
+  # unit tests for delete_device
+  # Delete a device
+  # Unregister and delete a specific device.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [DeleteResult]
+  describe 'delete_device 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_user_devices
+  # Delete all devices for a user
+  # Unregister and delete all devices belonging to a specific user.
+  # @param user_id 
+  # @param [Hash] opts the optional parameters
+  # @return [UserDevicesDeleteResponse]
+  describe 'delete_user_devices 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_device
+  # Get device details
+  # Get a specific registered device by ID.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [DeviceResponse]
+  describe 'get_device 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_device_stats
+  # Get device statistics
+  # Get aggregated device statistics for the workspace.
+  # @param [Hash] opts the optional parameters
+  # @return [DeviceStatsResponse]
+  describe 'get_device_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_devices
+  # List devices
+  # List registered devices for the workspace with optional filtering.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :user_id Filter by subscriber/user ID
+  # @option opts [String] :platform 
+  # @option opts [Integer] :limit 
+  # @option opts [Integer] :offset 
+  # @return [DeviceListResponse]
+  describe 'list_devices 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 register_device
+  # Register a device
+  # Register a device for push notifications. If the token already exists, updates it.
+  # @param register_device_request 
+  # @param [Hash] opts the optional parameters
+  # @return [DeviceResponse]
+  describe 'register_device 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/emails_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::EmailsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'EmailsApi' do
+  before do
+    # run before each test
+    @api_instance = Zyphr::EmailsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of EmailsApi' do
+    it 'should create an instance of EmailsApi' do
+      expect(@api_instance).to be_instance_of(Zyphr::EmailsApi)
+    end
+  end
+
+  # unit tests for get_email
+  # Get email details
+  # Retrieve details for a specific email message
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [EmailResponse]
+  describe 'get_email 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_email_events
+  # Get email events
+  # Retrieve delivery events for a specific email
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [EmailEventsResponse]
+  describe 'get_email_events 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_email_tracking
+  # Get email tracking stats
+  # Retrieve open and click tracking statistics
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [EmailTrackingResponse]
+  describe 'get_email_tracking 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_emails
+  # List emails
+  # Retrieve a paginated list of sent emails
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :status 
+  # @option opts [String] :tag 
+  # @option opts [Integer] :limit 
+  # @option opts [Integer] :offset 
+  # @return [EmailListResponse]
+  describe 'list_emails 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 send_batch_email
+  # Send batch emails
+  # Send up to 100 emails in a single request. Each recipient gets their own message record.
+  # @param send_batch_email_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SendBatchEmailResponse]
+  describe 'send_batch_email 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 send_email
+  # Send an email
+  # Queue an email for delivery. The email is processed asynchronously and you'll receive a message ID to track its status.  You can provide content directly via `html`/`text` fields, or use a template by specifying `template_id` and `template_data`. 
+  # @param send_email_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SendEmailResponse]
+  describe 'send_email 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/inbox_api_spec.rb

@@ -0,0 +1,157 @@
+=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::InboxApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'InboxApi' do
+  before do
+    # run before each test
+    @api_instance = Zyphr::InboxApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of InboxApi' do
+    it 'should create an instance of InboxApi' do
+      expect(@api_instance).to be_instance_of(Zyphr::InboxApi)
+    end
+  end
+
+  # unit tests for archive_inbox_notification
+  # Archive a notification
+  # Archive a specific in-app notification.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [MarkInboxReadRequest] :mark_inbox_read_request 
+  # @return [InboxNotificationResponse]
+  describe 'archive_inbox_notification 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_inbox_notification
+  # Delete a notification
+  # Permanently delete an in-app notification.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :subscriber_id 
+  # @option opts [String] :external_id 
+  # @return [nil]
+  describe 'delete_inbox_notification 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_inbox_notification
+  # Get a notification
+  # Get a specific in-app notification by ID.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :subscriber_id 
+  # @option opts [String] :external_id 
+  # @return [InboxNotificationResponse]
+  describe 'get_inbox_notification 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_unread_count
+  # Get unread notification count
+  # Get the count of unread in-app notifications for a subscriber.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :subscriber_id 
+  # @option opts [String] :external_id 
+  # @return [UnreadCountResponse]
+  describe 'get_unread_count 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_inbox
+  # List inbox notifications
+  # Retrieve in-app notifications for a subscriber. Requires subscriber_id or external_id.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :subscriber_id Subscriber ID
+  # @option opts [String] :external_id Subscriber external ID
+  # @option opts [String] :category Filter by notification category
+  # @option opts [Boolean] :include_read 
+  # @option opts [Boolean] :include_archived 
+  # @option opts [Integer] :limit 
+  # @option opts [Integer] :offset 
+  # @option opts [String] :cursor Cursor for pagination
+  # @return [InboxListResponse]
+  describe 'list_inbox 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 mark_all_inbox_read
+  # Mark all notifications as read
+  # Mark all unread in-app notifications as read for a subscriber. Optionally filter by category.
+  # @param mark_all_inbox_read_request 
+  # @param [Hash] opts the optional parameters
+  # @return [MarkAllReadResponse]
+  describe 'mark_all_inbox_read 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 mark_inbox_read
+  # Mark notification as read
+  # Mark a specific in-app notification as read.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [MarkInboxReadRequest] :mark_inbox_read_request 
+  # @return [InboxNotificationResponse]
+  describe 'mark_inbox_read 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 send_batch_in_app
+  # Send batch in-app notifications
+  # Send in-app notifications to multiple subscribers in a single request (max 100).
+  # @param send_batch_in_app_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SendBatchInAppResponse]
+  describe 'send_batch_in_app 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 send_in_app
+  # Send an in-app notification
+  # Create and deliver an in-app notification to a subscriber. Checks subscriber preferences before delivery.
+  # @param send_in_app_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SendInAppResponse]
+  describe 'send_in_app 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/push_api_spec.rb

@@ -0,0 +1,151 @@
+=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::PushApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PushApi' do
+  before do
+    # run before each test
+    @api_instance = Zyphr::PushApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PushApi' do
+    it 'should create an instance of PushApi' do
+      expect(@api_instance).to be_instance_of(Zyphr::PushApi)
+    end
+  end
+
+  # unit tests for get_push
+  # Get push notification details
+  # Get a specific push notification message with delivery events.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [PushDetailResponse]
+  describe 'get_push 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_push_stats
+  # Get push notification statistics
+  # Get aggregated push notification statistics for the workspace.
+  # @param [Hash] opts the optional parameters
+  # @return [PushStatsResponse]
+  describe 'get_push_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_device_push_topics
+  # List topics for a device
+  # Get all push notification topics a specific device is subscribed to.
+  # @param id Device ID
+  # @param [Hash] opts the optional parameters
+  # @return [DevicePushTopicListResponse]
+  describe 'list_device_push_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 list_push
+  # List push notifications
+  # List push notification messages for the workspace with optional filtering.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :user_id Filter by subscriber/user ID
+  # @option opts [String] :device_id Filter by device ID
+  # @option opts [String] :status Filter by message status
+  # @option opts [Integer] :limit Maximum number of results
+  # @option opts [Integer] :offset Number of results to skip
+  # @return [PushListResponse]
+  describe 'list_push 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_push_topic_devices
+  # List devices subscribed to a topic
+  # Get all devices subscribed to a push notification topic with pagination.
+  # @param key Topic key
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit Maximum number of results
+  # @option opts [Integer] :offset Number of results to skip
+  # @return [PushTopicDeviceListResponse]
+  describe 'list_push_topic_devices 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 send_push
+  # Send a push notification
+  # Send a push notification to a specific device, multiple devices, all devices for a subscriber, or to a topic. Supports scheduling via `send_at` or `delay`. 
+  # @param send_push_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SendPushResponse]
+  describe 'send_push 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 send_push_to_topic
+  # Send push notification to a topic
+  # Send a push notification to all devices subscribed to a topic.
+  # @param key Topic key
+  # @param send_push_to_topic_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SendPushToTopicResponse]
+  describe 'send_push_to_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 subscribe_push_topic
+  # Subscribe devices to a push topic
+  # Subscribe one or more devices to a push notification topic. Maximum 100 devices per request.
+  # @param key Topic key
+  # @param subscribe_push_topic_request 
+  # @param [Hash] opts the optional parameters
+  # @return [PushTopicSubscribeResponse]
+  describe 'subscribe_push_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 unsubscribe_push_topic
+  # Unsubscribe devices from a push topic
+  # Unsubscribe one or more devices from a push notification topic. Maximum 100 devices per request.
+  # @param key Topic key
+  # @param subscribe_push_topic_request 
+  # @param [Hash] opts the optional parameters
+  # @return [PushTopicUnsubscribeResponse]
+  describe 'unsubscribe_push_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/sms_api_spec.rb

@@ -0,0 +1,143 @@
+=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::SMSApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SMSApi' do
+  before do
+    # run before each test
+    @api_instance = Zyphr::SMSApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SMSApi' do
+    it 'should create an instance of SMSApi' do
+      expect(@api_instance).to be_instance_of(Zyphr::SMSApi)
+    end
+  end
+
+  # unit tests for delete_sms_config
+  # Delete SMS configuration
+  # Remove the SMS provider configuration for the workspace.
+  # @param [Hash] opts the optional parameters
+  # @return [SmsConfigDeleteResponse]
+  describe 'delete_sms_config 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_sms
+  # Get SMS message details
+  # Get detailed information about a specific SMS message.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [SmsDetailResponse]
+  describe 'get_sms 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_sms_config
+  # Get SMS configuration
+  # Get the current SMS provider configuration for the workspace.
+  # @param [Hash] opts the optional parameters
+  # @return [SmsConfigResponse]
+  describe 'get_sms_config 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_sms
+  # List SMS messages
+  # List SMS messages for the workspace with optional filtering and pagination.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page 
+  # @option opts [Integer] :per_page 
+  # @option opts [String] :status 
+  # @option opts [String] :search Search by phone number or message body
+  # @return [SmsListResponse]
+  describe 'list_sms 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 send_batch_sms
+  # Send batch SMS messages
+  # Send SMS messages to multiple recipients (up to 100) in a single request.
+  # @param send_batch_sms_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SendBatchSmsResponse]
+  describe 'send_batch_sms 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 send_sms
+  # Send an SMS message
+  # Send a single SMS text message. Supports subscriber preference checks and scheduling.
+  # @param send_sms_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SendSmsResponse]
+  describe 'send_sms 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 send_test_sms
+  # Send a test SMS
+  # Send a test SMS message to verify the provider configuration is working.
+  # @param send_test_sms_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SendTestSmsResponse]
+  describe 'send_test_sms 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 upsert_sms_config
+  # Create or update SMS configuration
+  # Set up or update the SMS provider configuration (Twilio) for the workspace. Automatically verifies credentials.
+  # @param upsert_sms_config_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SmsConfigResponse]
+  describe 'upsert_sms_config 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 verify_sms_config
+  # Verify SMS configuration
+  # Verify the SMS provider credentials are valid and working.
+  # @param [Hash] opts the optional parameters
+  # @return [VerifySmsConfigResponse]
+  describe 'verify_sms_config test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end