zyphr 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a022ec9f8b3d607f6192b0ed816b85bbb963c5c337da8070d12955c6a2620f1f
-  data.tar.gz: 0b2b6688966078447f3626829f5867028bdffbe6f146d23f23af51618fcf2ee2
+  metadata.gz: dc874bcc04f01c43da7844d1d562c5e1e8720a1c791abe5988228eecf2a3486a
+  data.tar.gz: 1daf9d45e70baf4dc6bff9467cf4b4de10cf40f891812f2df5c0ac8840882b91
 SHA512:
-  metadata.gz: 45487669800dbf8dd16999057cbd89a59db932667f886d0a399f64c4311b128decd8e3ffdef57b0ec0c4d97b0e28a372b578e8a994225875d8d9442b663ff77f
-  data.tar.gz: 89b1b3f511bd8239daba3ee8ca253255b1d1afca4a09dd26784fd8f251b0c86201aaf9c9664c046029d5372550380a23202dad2b960ef033d364148f0d89c10c
+  metadata.gz: 885fe09a25de1fe5e69a444e341c844790fbe5b1dcb8b20dfc399647ed06858f726c911cb8eea37984c50db15ba064e1a6ae562a3794dcc7aeacb257bc655aff
+  data.tar.gz: 823f2d417febb7b5983953185586f0facbf80ff56cd7ee1618995486b56faad69afbaae47dd3079caa75d4dc88913c98412600d6520326fcfb89736784882e6a

data/README.md

@@ -196,6 +196,7 @@ Class | Method | HTTP request | Description
 *Zyphr::InboxApi* | [**get_subscriber_notification**](docs/InboxApi.md#get_subscriber_notification) | **GET** /subscriber-inbox/{id} | Get a notification
 *Zyphr::InboxApi* | [**get_subscriber_unread_count**](docs/InboxApi.md#get_subscriber_unread_count) | **GET** /subscriber-inbox/unread-count | Get unread count
 *Zyphr::InboxApi* | [**get_unread_count**](docs/InboxApi.md#get_unread_count) | **GET** /inbox/unread-count | Get unread notification count
+*Zyphr::InboxApi* | [**list_all_inbox**](docs/InboxApi.md#list_all_inbox) | **GET** /inbox/all | List all project notifications
 *Zyphr::InboxApi* | [**list_inbox**](docs/InboxApi.md#list_inbox) | **GET** /inbox | List inbox notifications
 *Zyphr::InboxApi* | [**list_subscriber_notifications**](docs/InboxApi.md#list_subscriber_notifications) | **GET** /subscriber-inbox | List subscriber notifications
 *Zyphr::InboxApi* | [**mark_all_inbox_read**](docs/InboxApi.md#mark_all_inbox_read) | **POST** /inbox/read-all | Mark all notifications as read

data/docs/InboxApi.md

@@ -14,6 +14,7 @@ All URIs are relative to *https://api.zyphr.dev/v1*
 | [**get_subscriber_notification**](InboxApi.md#get_subscriber_notification) | **GET** /subscriber-inbox/{id} | Get a notification |
 | [**get_subscriber_unread_count**](InboxApi.md#get_subscriber_unread_count) | **GET** /subscriber-inbox/unread-count | Get unread count |
 | [**get_unread_count**](InboxApi.md#get_unread_count) | **GET** /inbox/unread-count | Get unread notification count |
+| [**list_all_inbox**](InboxApi.md#list_all_inbox) | **GET** /inbox/all | List all project notifications |
 | [**list_inbox**](InboxApi.md#list_inbox) | **GET** /inbox | List inbox notifications |
 | [**list_subscriber_notifications**](InboxApi.md#list_subscriber_notifications) | **GET** /subscriber-inbox | List subscriber notifications |
 | [**mark_all_inbox_read**](InboxApi.md#mark_all_inbox_read) | **POST** /inbox/read-all | Mark all notifications as read |
@@ -729,6 +730,88 @@ end
 - **Accept**: application/json
 
 
+## list_all_inbox
+
+> list_all_inbox(opts)
+
+List all project notifications
+
+List all in-app notifications for the current project. Used by the dashboard to display all notifications without requiring a subscriber selection.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['X-API-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-API-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::InboxApi.new
+opts = {
+  subscriber_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | Optional subscriber filter
+  status: 'unread', # String | Filter by notification status
+  category: 'category_example', # String | Filter by category
+  search: 'search_example', # String | Search by title or body
+  limit: 56, # Integer | 
+  offset: 56 # Integer | 
+}
+
+begin
+  # List all project notifications
+  api_instance.list_all_inbox(opts)
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->list_all_inbox: #{e}"
+end
+```
+
+#### Using the list_all_inbox_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> list_all_inbox_with_http_info(opts)
+
+```ruby
+begin
+  # List all project notifications
+  data, status_code, headers = api_instance.list_all_inbox_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Zyphr::ApiError => e
+  puts "Error when calling InboxApi->list_all_inbox_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscriber_id** | **String** | Optional subscriber filter | [optional] |
+| **status** | **String** | Filter by notification status | [optional] |
+| **category** | **String** | Filter by category | [optional] |
+| **search** | **String** | Search by title or body | [optional] |
+| **limit** | **Integer** |  | [optional][default to 50] |
+| **offset** | **Integer** |  | [optional][default to 0] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
 ## list_inbox
 
 > <InboxListResponse> list_inbox(opts)

data/lib/zyphr/api/inbox_api.rb

@@ -645,6 +645,87 @@ module Zyphr
       return data, status_code, headers
     end
 
+    # List all project notifications
+    # List all in-app notifications for the current project. Used by the dashboard to display all notifications without requiring a subscriber selection.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :subscriber_id Optional subscriber filter
+    # @option opts [String] :status Filter by notification status
+    # @option opts [String] :category Filter by category
+    # @option opts [String] :search Search by title or body
+    # @option opts [Integer] :limit  (default to 50)
+    # @option opts [Integer] :offset  (default to 0)
+    # @return [nil]
+    def list_all_inbox(opts = {})
+      list_all_inbox_with_http_info(opts)
+      nil
+    end
+
+    # List all project notifications
+    # List all in-app notifications for the current project. Used by the dashboard to display all notifications without requiring a subscriber selection.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :subscriber_id Optional subscriber filter
+    # @option opts [String] :status Filter by notification status
+    # @option opts [String] :category Filter by category
+    # @option opts [String] :search Search by title or body
+    # @option opts [Integer] :limit  (default to 50)
+    # @option opts [Integer] :offset  (default to 0)
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def list_all_inbox_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InboxApi.list_all_inbox ...'
+      end
+      allowable_values = ["unread", "read", "archived"]
+      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
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InboxApi.list_all_inbox, must be smaller than or equal to 100.'
+      end
+
+      # resource path
+      local_var_path = '/inbox/all'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'subscriber_id'] = opts[:'subscriber_id'] if !opts[:'subscriber_id'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+
+      # 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 => :"InboxApi.list_all_inbox",
+        :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: InboxApi#list_all_inbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List inbox notifications
     # Retrieve in-app notifications for a subscriber. Requires subscriber_id or external_id.
     # @param [Hash] opts the optional parameters

data/spec/api/inbox_api_spec.rb

@@ -154,6 +154,23 @@ describe 'InboxApi' do
     end
   end
 
+  # unit tests for list_all_inbox
+  # List all project notifications
+  # List all in-app notifications for the current project. Used by the dashboard to display all notifications without requiring a subscriber selection.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :subscriber_id Optional subscriber filter
+  # @option opts [String] :status Filter by notification status
+  # @option opts [String] :category Filter by category
+  # @option opts [String] :search Search by title or body
+  # @option opts [Integer] :limit 
+  # @option opts [Integer] :offset 
+  # @return [nil]
+  describe 'list_all_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 list_inbox
   # List inbox notifications
   # Retrieve in-app notifications for a subscriber. Requires subscriber_id or external_id.

data/zyphr.gemspec

@@ -17,7 +17,7 @@ require "zyphr/version"
 
 Gem::Specification.new do |s|
   s.name        = "zyphr"
-  s.version = '0.1.16'
+  s.version = '0.1.17'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Zyphr"]
   s.email       = ["support@zyphr.dev"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zyphr
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - Zyphr
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-08 00:00:00.000000000 Z
+date: 2026-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday