zyphr 0.1.41 → 0.1.43

data/docs/WaaSEventTypesApi.md

@@ -159,7 +159,7 @@ nil (empty response body)
 
 ## deprecate_waa_s_event_type
 
-> deprecate_waa_s_event_type(app_id, event_type_id)
+> <UpdateWaaSEventType200Response> deprecate_waa_s_event_type(app_id, event_type_id)
 
 Deprecate an event type
 
@@ -184,7 +184,8 @@ event_type_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
 
 begin
   # Deprecate an event type
-  api_instance.deprecate_waa_s_event_type(app_id, event_type_id)
+  result = api_instance.deprecate_waa_s_event_type(app_id, event_type_id)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSEventTypesApi->deprecate_waa_s_event_type: #{e}"
 end
@@ -192,9 +193,9 @@ end
 
 #### Using the deprecate_waa_s_event_type_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)> deprecate_waa_s_event_type_with_http_info(app_id, event_type_id)
+> <Array(<UpdateWaaSEventType200Response>, Integer, Hash)> deprecate_waa_s_event_type_with_http_info(app_id, event_type_id)
 
 ```ruby
 begin
@@ -202,7 +203,7 @@ begin
   data, status_code, headers = api_instance.deprecate_waa_s_event_type_with_http_info(app_id, event_type_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <UpdateWaaSEventType200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSEventTypesApi->deprecate_waa_s_event_type_with_http_info: #{e}"
 end
@@ -217,7 +218,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**UpdateWaaSEventType200Response**](UpdateWaaSEventType200Response.md)
 
 ### Authorization
 
@@ -226,7 +227,7 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: Not defined
+- **Accept**: application/json
 
 
 ## get_waa_s_event_type
@@ -383,7 +384,7 @@ end
 
 ## update_waa_s_event_type
 
-> update_waa_s_event_type(app_id, event_type_id, update_waa_s_event_type_request)
+> <UpdateWaaSEventType200Response> update_waa_s_event_type(app_id, event_type_id, update_waa_s_event_type_request)
 
 Update an event type
 
@@ -407,7 +408,8 @@ update_waa_s_event_type_request = Zyphr::UpdateWaaSEventTypeRequest.new # Update
 
 begin
   # Update an event type
-  api_instance.update_waa_s_event_type(app_id, event_type_id, update_waa_s_event_type_request)
+  result = api_instance.update_waa_s_event_type(app_id, event_type_id, update_waa_s_event_type_request)
+  p result
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSEventTypesApi->update_waa_s_event_type: #{e}"
 end
@@ -415,9 +417,9 @@ end
 
 #### Using the update_waa_s_event_type_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)> update_waa_s_event_type_with_http_info(app_id, event_type_id, update_waa_s_event_type_request)
+> <Array(<UpdateWaaSEventType200Response>, Integer, Hash)> update_waa_s_event_type_with_http_info(app_id, event_type_id, update_waa_s_event_type_request)
 
 ```ruby
 begin
@@ -425,7 +427,7 @@ begin
   data, status_code, headers = api_instance.update_waa_s_event_type_with_http_info(app_id, event_type_id, update_waa_s_event_type_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <UpdateWaaSEventType200Response>
 rescue Zyphr::ApiError => e
   puts "Error when calling WaaSEventTypesApi->update_waa_s_event_type_with_http_info: #{e}"
 end
@@ -441,7 +443,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**UpdateWaaSEventType200Response**](UpdateWaaSEventType200Response.md)
 
 ### Authorization
 
@@ -450,5 +452,5 @@ nil (empty response body)
 ### HTTP request headers
 
 - **Content-Type**: application/json
-- **Accept**: Not defined
+- **Accept**: application/json
 

data/lib/zyphr/api/auth_user_directory_api.rb

@@ -84,17 +84,17 @@ module Zyphr
     # Secret-key-scoped lookup of a single end user by email address within the authenticating application. Scoped to the application — never resolves a user from another application. Does not return the password hash. 
     # @param email [String] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [GetEndUserById200Response]
     def get_end_user_by_email(email, opts = {})
-      get_end_user_by_email_with_http_info(email, opts)
-      nil
+      data, _status_code, _headers = get_end_user_by_email_with_http_info(email, opts)
+      data
     end
 
     # Look up an end user by email (server-side admin)
     # Secret-key-scoped lookup of a single end user by email address within the authenticating application. Scoped to the application — never resolves a user from another application. Does not return the password hash. 
     # @param email [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(GetEndUserById200Response, Integer, Hash)>] GetEndUserById200Response data, response status code and response headers
     def get_end_user_by_email_with_http_info(email, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AuthUserDirectoryApi.get_end_user_by_email ...'
@@ -112,6 +112,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']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -120,7 +122,7 @@ module Zyphr
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'GetEndUserById200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
@@ -146,17 +148,17 @@ module Zyphr
     # Secret-key-scoped fetch of a single end user by id within the authenticating application. Scoped to the application — a caller can never read a user belonging to another application. 
     # @param user_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [GetEndUserById200Response]
     def get_end_user_by_id(user_id, opts = {})
-      get_end_user_by_id_with_http_info(user_id, opts)
-      nil
+      data, _status_code, _headers = get_end_user_by_id_with_http_info(user_id, opts)
+      data
     end
 
     # Get an end user by id (server-side admin)
     # Secret-key-scoped fetch of a single end user by id within the authenticating application. Scoped to the application — a caller can never read a user belonging to another application. 
     # @param user_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(GetEndUserById200Response, Integer, Hash)>] GetEndUserById200Response data, response status code and response headers
     def get_end_user_by_id_with_http_info(user_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AuthUserDirectoryApi.get_end_user_by_id ...'
@@ -173,6 +175,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']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -181,7 +185,7 @@ module Zyphr
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'GetEndUserById200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
@@ -207,17 +211,17 @@ module Zyphr
     # Secret-key-scoped read of the authoritative custom_claims stored for an end user. These are the TRUSTED claims embedded into the user's JWTs on login/refresh — use them (not the client-writable `metadata` field) for authorization decisions. Returns an empty object when none are set. 
     # @param user_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [GetEndUserClaims200Response]
     def get_end_user_claims(user_id, opts = {})
-      get_end_user_claims_with_http_info(user_id, opts)
-      nil
+      data, _status_code, _headers = get_end_user_claims_with_http_info(user_id, opts)
+      data
     end
 
     # Get an end user&#39;s stored custom claims (server-side admin)
     # Secret-key-scoped read of the authoritative custom_claims stored for an end user. These are the TRUSTED claims embedded into the user&#39;s JWTs on login/refresh — use them (not the client-writable &#x60;metadata&#x60; field) for authorization decisions. Returns an empty object when none are set. 
     # @param user_id [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(GetEndUserClaims200Response, Integer, Hash)>] GetEndUserClaims200Response data, response status code and response headers
     def get_end_user_claims_with_http_info(user_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AuthUserDirectoryApi.get_end_user_claims ...'
@@ -234,6 +238,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']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -242,7 +248,7 @@ module Zyphr
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'GetEndUserClaims200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
@@ -268,17 +274,17 @@ module Zyphr
     # Secret-key-scoped pre-provisioning for an end user. Creates a passwordless user in the authenticating application (idempotent on email — an existing, non-deleted user is reused, not duplicated) and, when `send_link` is set, sends a first-login link so the user can set up their account without self-registration.  - `send_link: \"magic\"` sends a magic-link sign-in email. - `send_link: \"password_reset\"` sends a set-password email. - `send_link: \"none\"` (default) creates the user with no email.  A `redirect_url` is required when `send_link` is \"magic\" or \"password_reset\"; it must match the application's redirect_uris allowlist (custom schemes such as yourapp://path are permitted). 
     # @param invite_end_user_request [InviteEndUserRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [InviteEndUser200Response]
     def invite_end_user(invite_end_user_request, opts = {})
-      invite_end_user_with_http_info(invite_end_user_request, opts)
-      nil
+      data, _status_code, _headers = invite_end_user_with_http_info(invite_end_user_request, opts)
+      data
     end
 
     # Pre-provision (invite) an end user (server-side admin)
     # Secret-key-scoped pre-provisioning for an end user. Creates a passwordless user in the authenticating application (idempotent on email — an existing, non-deleted user is reused, not duplicated) and, when &#x60;send_link&#x60; is set, sends a first-login link so the user can set up their account without self-registration.  - &#x60;send_link: \&quot;magic\&quot;&#x60; sends a magic-link sign-in email. - &#x60;send_link: \&quot;password_reset\&quot;&#x60; sends a set-password email. - &#x60;send_link: \&quot;none\&quot;&#x60; (default) creates the user with no email.  A &#x60;redirect_url&#x60; is required when &#x60;send_link&#x60; is \&quot;magic\&quot; or \&quot;password_reset\&quot;; it must match the application&#39;s redirect_uris allowlist (custom schemes such as yourapp://path are permitted). 
     # @param invite_end_user_request [InviteEndUserRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(InviteEndUser200Response, Integer, Hash)>] InviteEndUser200Response data, response status code and response headers
     def invite_end_user_with_http_info(invite_end_user_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AuthUserDirectoryApi.invite_end_user ...'
@@ -295,6 +301,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?
@@ -308,7 +316,7 @@ module Zyphr
       post_body = opts[:debug_body] || @api_client.object_to_http_body(invite_end_user_request)
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'InviteEndUser200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
@@ -337,10 +345,10 @@ module Zyphr
     # @option opts [Integer] :per_page  (default to 20)
     # @option opts [String] :search Substring match against email, name, or phone number.
     # @option opts [String] :environment 
-    # @return [nil]
+    # @return [ListEndUsers200Response]
     def list_end_users(opts = {})
-      list_end_users_with_http_info(opts)
-      nil
+      data, _status_code, _headers = list_end_users_with_http_info(opts)
+      data
     end
 
     # List / search end users (server-side admin)
@@ -350,7 +358,7 @@ module Zyphr
     # @option opts [Integer] :per_page  (default to 20)
     # @option opts [String] :search Substring match against email, name, or phone number.
     # @option opts [String] :environment 
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(ListEndUsers200Response, Integer, Hash)>] ListEndUsers200Response data, response status code and response headers
     def list_end_users_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AuthUserDirectoryApi.list_end_users ...'
@@ -383,6 +391,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']
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -391,7 +401,7 @@ module Zyphr
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'ListEndUsers200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']
@@ -414,22 +424,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&#39;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&#39;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&#39;s JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected.  Each write bumps a monotonic &#x60;claims_version&#x60; (returned in the response). The change applies seamlessly on the user&#39;s next login or token refresh — a token carrying an older &#x60;claims_version&#x60; 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 +460,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 +475,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']
@@ -490,10 +502,10 @@ module Zyphr
     # @param user_id [String] 
     # @param update_end_user_by_application_request [UpdateEndUserByApplicationRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [GetEndUserById200Response]
     def update_end_user_by_application(user_id, update_end_user_by_application_request, opts = {})
-      update_end_user_by_application_with_http_info(user_id, update_end_user_by_application_request, opts)
-      nil
+      data, _status_code, _headers = update_end_user_by_application_with_http_info(user_id, update_end_user_by_application_request, opts)
+      data
     end
 
     # Update an end user (server-side admin)
@@ -501,7 +513,7 @@ module Zyphr
     # @param user_id [String] 
     # @param update_end_user_by_application_request [UpdateEndUserByApplicationRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(GetEndUserById200Response, Integer, Hash)>] GetEndUserById200Response data, response status code and response headers
     def update_end_user_by_application_with_http_info(user_id, update_end_user_by_application_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AuthUserDirectoryApi.update_end_user_by_application ...'
@@ -522,6 +534,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?
@@ -535,7 +549,7 @@ module Zyphr
       post_body = opts[:debug_body] || @api_client.object_to_http_body(update_end_user_by_application_request)
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'GetEndUserById200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApplicationSecret', 'ApplicationPublicKey']

data/lib/zyphr/api/domains_api.rb

@@ -338,10 +338,10 @@ module Zyphr
     # @param id [String] 
     # @param set_domain_inbound_request [SetDomainInboundRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [GetDomain200Response]
     def set_domain_inbound(id, set_domain_inbound_request, opts = {})
-      set_domain_inbound_with_http_info(id, set_domain_inbound_request, opts)
-      nil
+      data, _status_code, _headers = set_domain_inbound_with_http_info(id, set_domain_inbound_request, opts)
+      data
     end
 
     # Enable or disable inbound email for a domain
@@ -349,7 +349,7 @@ module Zyphr
     # @param id [String] 
     # @param set_domain_inbound_request [SetDomainInboundRequest] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(GetDomain200Response, Integer, Hash)>] GetDomain200Response data, response status code and response headers
     def set_domain_inbound_with_http_info(id, set_domain_inbound_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DomainsApi.set_domain_inbound ...'
@@ -370,6 +370,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?
@@ -383,7 +385,7 @@ module Zyphr
       post_body = opts[:debug_body] || @api_client.object_to_http_body(set_domain_inbound_request)
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'GetDomain200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']