zyphr 0.1.40 → 0.1.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 955eb06e49c1b00cef4b369a618572360989321e4fa6b3e2e263038b39dd533a
-  data.tar.gz: bebb75c0a3bdf78029fac2e47e60893eb74b930a2c3f0ccd2a86d3b33424c520
+  metadata.gz: 6cb0a8537c63656fd45e496b199c8cb2250befd736dda868cea8b281aedf9166
+  data.tar.gz: ac3965efb59990ba1c3ea00e71c34c58b734dad43bcccc018d0c1940be4b340c
 SHA512:
-  metadata.gz: 8fdbcadf17903d8128b8455e0ce94ca7c08f505ef24ef3ea714208927578f7bc045706efe9841a95a2e4e19f8cee1e0b1cf424f8f2fe44a4c80a0f14718f957c
-  data.tar.gz: 60a3fa5fdded26f7097702bab309e7c2493d0ccf583949be3869f7f230d1a2e45f1febfd86f14bf6e67df0e9b2722a4900231a40b6a7300eaecd5628716afdd6
+  metadata.gz: fed4fac9fadfcce07fd077131fab2c7dc95ec623d974157c4bef8c387e3b4629ba3355155c0013637c18b5101c059735f946b22f9ae9902303304420c0835d2d
+  data.tar.gz: 3a5684aff5a94c217b225f1a73113d58f2b777fcf7a9cce393729befc7b855f695b3cdcdcf74abbc1d49e1daaade748b171de886449062efda7e4a97610ee6fe

data/README.md

@@ -672,6 +672,8 @@ Class | Method | HTTP request | Description
  - [Zyphr::SessionListResponseData](docs/SessionListResponseData.md)
  - [Zyphr::SessionListResponseDataSessionInfo](docs/SessionListResponseDataSessionInfo.md)
  - [Zyphr::SetDomainInboundRequest](docs/SetDomainInboundRequest.md)
+ - [Zyphr::SetEndUserClaims200Response](docs/SetEndUserClaims200Response.md)
+ - [Zyphr::SetEndUserClaims200ResponseData](docs/SetEndUserClaims200ResponseData.md)
  - [Zyphr::SetEndUserClaimsRequest](docs/SetEndUserClaimsRequest.md)
  - [Zyphr::SetPreferencesRequest](docs/SetPreferencesRequest.md)
  - [Zyphr::SetPreferencesRequestPreferencesInner](docs/SetPreferencesRequestPreferencesInner.md)

data/docs/AuthUserDirectoryApi.md

@@ -474,11 +474,11 @@ nil (empty response body)
 
 ## set_end_user_claims
 
-> set_end_user_claims(user_id, set_end_user_claims_request)
+> <SetEndUserClaims200Response> set_end_user_claims(user_id, set_end_user_claims_request)
 
 Set an end user's stored custom claims (server-side admin)
 
-Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user's JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  To make a change take effect immediately on already-issued tokens (e.g. revoking admin), call POST /auth/sessions/revoke-all for the user after updating claims — that bumps the revocation epoch so outstanding access tokens stop verifying. 
+Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user's JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  Each write bumps a monotonic `claims_version` (returned in the response). The change applies seamlessly on the user's next login or token refresh — a token carrying an older `claims_version` is rejected on verification and the client silently re-mints with the new claims, without a forced logout. For a hard cut-off (log the user out of all sessions immediately), call POST /auth/sessions/revoke-all after updating claims. 
 
 ### Examples
 
@@ -504,7 +504,8 @@ set_end_user_claims_request = Zyphr::SetEndUserClaimsRequest.new # SetEndUserCla
 
 begin
   # Set an end user's stored custom claims (server-side admin)
-  api_instance.set_end_user_claims(user_id, set_end_user_claims_request)
+  result = api_instance.set_end_user_claims(user_id, set_end_user_claims_request)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling AuthUserDirectoryApi->set_end_user_claims: #{e}"
 end
@@ -512,9 +513,9 @@ end
 
 #### Using the set_end_user_claims_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> set_end_user_claims_with_http_info(user_id, set_end_user_claims_request)
+> <Array(<SetEndUserClaims200Response>, Integer, Hash)> set_end_user_claims_with_http_info(user_id, set_end_user_claims_request)
 
 ```ruby
 begin
@@ -522,7 +523,7 @@ begin
   data, status_code, headers = api_instance.set_end_user_claims_with_http_info(user_id, set_end_user_claims_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <SetEndUserClaims200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling AuthUserDirectoryApi->set_end_user_claims_with_http_info: #{e}"
 end
@@ -537,7 +538,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**SetEndUserClaims200Response**](SetEndUserClaims200Response.md)
 
 ### Authorization
 
@@ -546,7 +547,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## update_end_user_by_application

data/docs/InboxApi.md

@@ -315,7 +315,7 @@ nil (empty response body)
 
 Generate a subscriber token
 
-Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to `@zyphr/inbox-react`'s `<ZyphrProvider subscriberToken=\"...\">` or use it as `Authorization: Bearer <token>` for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
+Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to `@zyphr-dev/inbox-react`'s `<ZyphrProvider subscriberToken=\"...\">` or use it as `Authorization: Bearer <token>` for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
 
 ### Examples
 

data/docs/SetEndUserClaims200Response.md

@@ -0,0 +1,18 @@
+# Zyphr::SetEndUserClaims200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**SetEndUserClaims200ResponseData**](SetEndUserClaims200ResponseData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::SetEndUserClaims200Response.new(
+  data: null
+)
+```
+

data/docs/SetEndUserClaims200ResponseData.md

@@ -0,0 +1,20 @@
+# Zyphr::SetEndUserClaims200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **claims** | **Object** |  | [optional] |
+| **claims_version** | **Integer** | Monotonic version bumped on each write; embedded in issued tokens. | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::SetEndUserClaims200ResponseData.new(
+  claims: null,
+  claims_version: null
+)
+```
+

data/lib/zyphr/api/auth_user_directory_api.rb

@@ -414,22 +414,22 @@ module Zyphr
     end
 
     # Set an end user's stored custom claims (server-side admin)
-    # Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user's JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  To make a change take effect immediately on already-issued tokens (e.g. revoking admin), call POST /auth/sessions/revoke-all for the user after updating claims — that bumps the revocation epoch so outstanding access tokens stop verifying. 
+    # Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user's JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  Each write bumps a monotonic `claims_version` (returned in the response). The change applies seamlessly on the user's next login or token refresh — a token carrying an older `claims_version` is rejected on verification and the client silently re-mints with the new claims, without a forced logout. For a hard cut-off (log the user out of all sessions immediately), call POST /auth/sessions/revoke-all after updating claims. 
     # @param user_id [String] 
     # @param set_end_user_claims_request [SetEndUserClaimsRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [SetEndUserClaims200Response]
     def set_end_user_claims(user_id, set_end_user_claims_request, opts = {})
-      set_end_user_claims_with_http_info(user_id, set_end_user_claims_request, opts)
-      nil
+      data, _status_code, _headers = set_end_user_claims_with_http_info(user_id, set_end_user_claims_request, opts)
+      data
     end
 
     # Set an end user's stored custom claims (server-side admin)
-    # Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user's JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  To make a change take effect immediately on already-issued tokens (e.g. revoking admin), call POST /auth/sessions/revoke-all for the user after updating claims — that bumps the revocation epoch so outstanding access tokens stop verifying. 
+    # Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user's JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  Each write bumps a monotonic `claims_version` (returned in the response). The change applies seamlessly on the user's next login or token refresh — a token carrying an older `claims_version` is rejected on verification and the client silently re-mints with the new claims, without a forced logout. For a hard cut-off (log the user out of all sessions immediately), call POST /auth/sessions/revoke-all after updating claims. 
     # @param user_id [String] 
     # @param set_end_user_claims_request [SetEndUserClaimsRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(SetEndUserClaims200Response, Integer, Hash)>] SetEndUserClaims200Response data, response status code and response headers
     def set_end_user_claims_with_http_info(user_id, set_end_user_claims_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AuthUserDirectoryApi.set_end_user_claims ...'
@@ -450,6 +450,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?
@@ -463,7 +465,7 @@ module Zyphr
       post_body = opts[:debug_body] || @api_client.object_to_http_body(set_end_user_claims_request)
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'SetEndUserClaims200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']

data/lib/zyphr/api/inbox_api.rb

@@ -275,7 +275,7 @@ module Zyphr
     end
 
     # Generate a subscriber token
-    # Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to `@zyphr/inbox-react`'s `<ZyphrProvider subscriberToken=\"...\">` or use it as `Authorization: Bearer <token>` for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
+    # Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to `@zyphr-dev/inbox-react`'s `<ZyphrProvider subscriberToken=\"...\">` or use it as `Authorization: Bearer <token>` for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
     # @param generate_subscriber_token_request [GenerateSubscriberTokenRequest] 
     # @param [Hash] opts the optional parameters
     # @return [GenerateSubscriberToken200Response]
@@ -285,7 +285,7 @@ module Zyphr
     end
 
     # Generate a subscriber token
-    # Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to &#x60;@zyphr/inbox-react&#x60;&#39;s &#x60;&lt;ZyphrProvider subscriberToken&#x3D;\&quot;...\&quot;&gt;&#x60; or use it as &#x60;Authorization: Bearer &lt;token&gt;&#x60; for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
+    # Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to &#x60;@zyphr-dev/inbox-react&#x60;&#39;s &#x60;&lt;ZyphrProvider subscriberToken&#x3D;\&quot;...\&quot;&gt;&#x60; or use it as &#x60;Authorization: Bearer &lt;token&gt;&#x60; for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
     # @param generate_subscriber_token_request [GenerateSubscriberTokenRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(GenerateSubscriberToken200Response, Integer, Hash)>] GenerateSubscriberToken200Response data, response status code and response headers

data/lib/zyphr/models/set_end_user_claims200_response.rb

@@ -0,0 +1,220 @@
+=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 SetEndUserClaims200Response
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    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' => :'SetEndUserClaims200ResponseData'
+      }
+    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::SetEndUserClaims200Response` 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::SetEndUserClaims200Response`. 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
+    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
+    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].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

data/lib/zyphr/models/set_end_user_claims200_response_data.rb

@@ -0,0 +1,230 @@
+=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 SetEndUserClaims200ResponseData
+    attr_accessor :claims
+
+    # Monotonic version bumped on each write; embedded in issued tokens.
+    attr_accessor :claims_version
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'claims' => :'claims',
+        :'claims_version' => :'claims_version'
+      }
+    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
+      {
+        :'claims' => :'Object',
+        :'claims_version' => :'Integer'
+      }
+    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::SetEndUserClaims200ResponseData` 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::SetEndUserClaims200ResponseData`. 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?(:'claims')
+        self.claims = attributes[:'claims']
+      end
+
+      if attributes.key?(:'claims_version')
+        self.claims_version = attributes[:'claims_version']
+      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 &&
+          claims == o.claims &&
+          claims_version == o.claims_version
+    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
+      [claims, claims_version].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

data/lib/zyphr.rb

@@ -306,6 +306,8 @@ require 'zyphr/models/session_list_response'
 require 'zyphr/models/session_list_response_data'
 require 'zyphr/models/session_list_response_data_session_info'
 require 'zyphr/models/set_domain_inbound_request'
+require 'zyphr/models/set_end_user_claims200_response'
+require 'zyphr/models/set_end_user_claims200_response_data'
 require 'zyphr/models/set_end_user_claims_request'
 require 'zyphr/models/set_preferences_request'
 require 'zyphr/models/set_preferences_request_preferences_inner'

data/spec/api/auth_user_directory_api_spec.rb

@@ -109,11 +109,11 @@ describe 'AuthUserDirectoryApi' do
 
   # unit tests for set_end_user_claims
   # Set an end user's stored custom claims (server-side admin)
-  # Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user's JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  To make a change take effect immediately on already-issued tokens (e.g. revoking admin), call POST /auth/sessions/revoke-all for the user after updating claims — that bumps the revocation epoch so outstanding access tokens stop verifying. 
+  # Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user's JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  Each write bumps a monotonic `claims_version` (returned in the response). The change applies seamlessly on the user's next login or token refresh — a token carrying an older `claims_version` is rejected on verification and the client silently re-mints with the new claims, without a forced logout. For a hard cut-off (log the user out of all sessions immediately), call POST /auth/sessions/revoke-all after updating claims. 
   # @param user_id 
   # @param set_end_user_claims_request 
   # @param [Hash] opts the optional parameters
-  # @return [nil]
+  # @return [SetEndUserClaims200Response]
   describe 'set_end_user_claims test' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/api/inbox_api_spec.rb

@@ -83,7 +83,7 @@ describe 'InboxApi' do
 
   # unit tests for generate_subscriber_token
   # Generate a subscriber token
-  # Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to `@zyphr/inbox-react`'s `<ZyphrProvider subscriberToken=\"...\">` or use it as `Authorization: Bearer <token>` for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
+  # Generate a JWT token for client-side inbox authentication. This is a server-side call that requires your API key. Pass the returned token to `@zyphr-dev/inbox-react`'s `<ZyphrProvider subscriberToken=\"...\">` or use it as `Authorization: Bearer <token>` for client-side inbox API calls and WebSocket connections.  The token expires in 7 days. 
   # @param generate_subscriber_token_request 
   # @param [Hash] opts the optional parameters
   # @return [GenerateSubscriberToken200Response]

data/spec/models/set_end_user_claims200_response_data_spec.rb

@@ -0,0 +1,42 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Zyphr::SetEndUserClaims200ResponseData
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Zyphr::SetEndUserClaims200ResponseData do
+  let(:instance) { Zyphr::SetEndUserClaims200ResponseData.new }
+
+  describe 'test an instance of SetEndUserClaims200ResponseData' do
+    it 'should create an instance of SetEndUserClaims200ResponseData' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(Zyphr::SetEndUserClaims200ResponseData)
+    end
+  end
+
+  describe 'test attribute "claims"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "claims_version"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/set_end_user_claims200_response_spec.rb

@@ -0,0 +1,36 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Zyphr::SetEndUserClaims200Response
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Zyphr::SetEndUserClaims200Response do
+  let(:instance) { Zyphr::SetEndUserClaims200Response.new }
+
+  describe 'test an instance of SetEndUserClaims200Response' do
+    it 'should create an instance of SetEndUserClaims200Response' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(Zyphr::SetEndUserClaims200Response)
+    end
+  end
+
+  describe 'test attribute "data"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/zyphr.gemspec

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zyphr
 version: !ruby/object:Gem::Version
-  version: 0.1.40
+  version: 0.1.42
 platform: ruby
 authors:
 - Zyphr
@@ -400,6 +400,8 @@ files:
 - docs/SessionListResponseData.md
 - docs/SessionListResponseDataSessionInfo.md
 - docs/SetDomainInboundRequest.md
+- docs/SetEndUserClaims200Response.md
+- docs/SetEndUserClaims200ResponseData.md
 - docs/SetEndUserClaimsRequest.md
 - docs/SetPreferencesRequest.md
 - docs/SetPreferencesRequestPreferencesInner.md
@@ -908,6 +910,8 @@ files:
 - lib/zyphr/models/session_list_response_data.rb
 - lib/zyphr/models/session_list_response_data_session_info.rb
 - lib/zyphr/models/set_domain_inbound_request.rb
+- lib/zyphr/models/set_end_user_claims200_response.rb
+- lib/zyphr/models/set_end_user_claims200_response_data.rb
 - lib/zyphr/models/set_end_user_claims_request.rb
 - lib/zyphr/models/set_preferences_request.rb
 - lib/zyphr/models/set_preferences_request_preferences_inner.rb
@@ -1399,6 +1403,8 @@ files:
 - spec/models/session_list_response_data_spec.rb
 - spec/models/session_list_response_spec.rb
 - spec/models/set_domain_inbound_request_spec.rb
+- spec/models/set_end_user_claims200_response_data_spec.rb
+- spec/models/set_end_user_claims200_response_spec.rb
 - spec/models/set_end_user_claims_request_spec.rb
 - spec/models/set_preferences_request_preferences_inner_spec.rb
 - spec/models/set_preferences_request_spec.rb
@@ -1739,6 +1745,7 @@ test_files:
 - spec/models/refresh_session_request_spec.rb
 - spec/models/topic_subscribers_add_response_spec.rb
 - spec/models/webhook_versions_response_spec.rb
+- spec/models/set_end_user_claims200_response_spec.rb
 - spec/models/api_error_error_spec.rb
 - spec/models/webhook_metrics_response_spec.rb
 - spec/models/waa_s_publish_event_response_spec.rb
@@ -1911,6 +1918,7 @@ test_files:
 - spec/models/slack_message_status_spec.rb
 - spec/models/workflow_status_spec.rb
 - spec/models/o_auth_tokens_response_spec.rb
+- spec/models/set_end_user_claims200_response_data_spec.rb
 - spec/models/switch_organization_response_data_tokens_spec.rb
 - spec/models/validate_reset_token_response_spec.rb
 - spec/models/payload_too_large_error_spec.rb