auth0 6.2.0 → 6.3.0

data/lib/auth0/branding/templates/client.rb

@@ -19,6 +19,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.branding.templates.get_universal_login
+        #
         # @return [Auth0::Types::GetUniversalLoginTemplateResponseContent]
         def get_universal_login(request_options: {}, **_params)
           request = Auth0::Internal::JSON::Request.new(
@@ -34,7 +37,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::GetUniversalLoginTemplateResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::GetUniversalLoginTemplateResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -76,6 +79,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.branding.templates.update_universal_login(request: "string")
+        #
         # @return [untyped]
         def update_universal_login(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -106,6 +112,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.branding.templates.delete_universal_login
+        #
         # @return [untyped]
         def delete_universal_login(request_options: {}, **_params)
           request = Auth0::Internal::JSON::Request.new(

data/lib/auth0/branding/themes/client.rb

@@ -21,6 +21,80 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.branding.themes.create(
+        #     borders: {
+        #       button_border_radius: 1.1,
+        #       button_border_weight: 1.1,
+        #       buttons_style: "pill",
+        #       input_border_radius: 1.1,
+        #       input_border_weight: 1.1,
+        #       inputs_style: "pill",
+        #       show_widget_shadow: true,
+        #       widget_border_weight: 1.1,
+        #       widget_corner_radius: 1.1
+        #     },
+        #     colors: {
+        #       body_text: "body_text",
+        #       error: "error",
+        #       header: "header",
+        #       icons: "icons",
+        #       input_background: "input_background",
+        #       input_border: "input_border",
+        #       input_filled_text: "input_filled_text",
+        #       input_labels_placeholders: "input_labels_placeholders",
+        #       links_focused_components: "links_focused_components",
+        #       primary_button: "primary_button",
+        #       primary_button_label: "primary_button_label",
+        #       secondary_button_border: "secondary_button_border",
+        #       secondary_button_label: "secondary_button_label",
+        #       success: "success",
+        #       widget_background: "widget_background",
+        #       widget_border: "widget_border"
+        #     },
+        #     fonts: {
+        #       body_text: {
+        #         bold: true,
+        #         size: 1.1
+        #       },
+        #       buttons_text: {
+        #         bold: true,
+        #         size: 1.1
+        #       },
+        #       font_url: "font_url",
+        #       input_labels: {
+        #         bold: true,
+        #         size: 1.1
+        #       },
+        #       links: {
+        #         bold: true,
+        #         size: 1.1
+        #       },
+        #       links_style: "normal",
+        #       reference_text_size: 1.1,
+        #       subtitle: {
+        #         bold: true,
+        #         size: 1.1
+        #       },
+        #       title: {
+        #         bold: true,
+        #         size: 1.1
+        #       }
+        #     },
+        #     page_background: {
+        #       background_color: "background_color",
+        #       background_image_url: "background_image_url",
+        #       page_layout: "center"
+        #     },
+        #     widget: {
+        #       header_text_alignment: "center",
+        #       logo_height: 1.1,
+        #       logo_position: "center",
+        #       logo_url: "logo_url",
+        #       social_buttons_layout: "bottom"
+        #     }
+        #   )
+        #
         # @return [Auth0::Types::CreateBrandingThemeResponseContent]
         def create(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -38,7 +112,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::CreateBrandingThemeResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::CreateBrandingThemeResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -55,6 +129,9 @@ module Auth0
         # @option request_options [Hash{String => Object}] :additional_body_parameters
         # @option request_options [Integer] :timeout_in_seconds
         #
+        # @example
+        #   client.branding.themes.get_default
+        #
         # @return [Auth0::Types::GetBrandingDefaultThemeResponseContent]
         def get_default(request_options: {}, **_params)
           request = Auth0::Internal::JSON::Request.new(
@@ -70,7 +147,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::GetBrandingDefaultThemeResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::GetBrandingDefaultThemeResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -88,6 +165,9 @@ module Auth0
         # @option request_options [Integer] :timeout_in_seconds
         # @option params [String] :theme_id
         #
+        # @example
+        #   client.branding.themes.get(theme_id: "themeId")
+        #
         # @return [Auth0::Types::GetBrandingThemeResponseContent]
         def get(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -104,7 +184,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::GetBrandingThemeResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::GetBrandingThemeResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)
@@ -122,6 +202,9 @@ module Auth0
         # @option request_options [Integer] :timeout_in_seconds
         # @option params [String] :theme_id
         #
+        # @example
+        #   client.branding.themes.delete(theme_id: "themeId")
+        #
         # @return [untyped]
         def delete(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -154,6 +237,81 @@ module Auth0
         # @option request_options [Integer] :timeout_in_seconds
         # @option params [String] :theme_id
         #
+        # @example
+        #   client.branding.themes.update(
+        #     theme_id: "themeId",
+        #     borders: {
+        #       button_border_radius: 1.1,
+        #       button_border_weight: 1.1,
+        #       buttons_style: "pill",
+        #       input_border_radius: 1.1,
+        #       input_border_weight: 1.1,
+        #       inputs_style: "pill",
+        #       show_widget_shadow: true,
+        #       widget_border_weight: 1.1,
+        #       widget_corner_radius: 1.1
+        #     },
+        #     colors: {
+        #       body_text: "body_text",
+        #       error: "error",
+        #       header: "header",
+        #       icons: "icons",
+        #       input_background: "input_background",
+        #       input_border: "input_border",
+        #       input_filled_text: "input_filled_text",
+        #       input_labels_placeholders: "input_labels_placeholders",
+        #       links_focused_components: "links_focused_components",
+        #       primary_button: "primary_button",
+        #       primary_button_label: "primary_button_label",
+        #       secondary_button_border: "secondary_button_border",
+        #       secondary_button_label: "secondary_button_label",
+        #       success: "success",
+        #       widget_background: "widget_background",
+        #       widget_border: "widget_border"
+        #     },
+        #     fonts: {
+        #       body_text: {
+        #         bold: true,
+        #         size: 1.1
+        #       },
+        #       buttons_text: {
+        #         bold: true,
+        #         size: 1.1
+        #       },
+        #       font_url: "font_url",
+        #       input_labels: {
+        #         bold: true,
+        #         size: 1.1
+        #       },
+        #       links: {
+        #         bold: true,
+        #         size: 1.1
+        #       },
+        #       links_style: "normal",
+        #       reference_text_size: 1.1,
+        #       subtitle: {
+        #         bold: true,
+        #         size: 1.1
+        #       },
+        #       title: {
+        #         bold: true,
+        #         size: 1.1
+        #       }
+        #     },
+        #     page_background: {
+        #       background_color: "background_color",
+        #       background_image_url: "background_image_url",
+        #       page_layout: "center"
+        #     },
+        #     widget: {
+        #       header_text_alignment: "center",
+        #       logo_height: 1.1,
+        #       logo_position: "center",
+        #       logo_url: "logo_url",
+        #       social_buttons_layout: "bottom"
+        #     }
+        #   )
+        #
         # @return [Auth0::Types::UpdateBrandingThemeResponseContent]
         def update(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -175,7 +333,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            Auth0::Types::UpdateBrandingThemeResponseContent.load(response.body)
+            (response.body.to_s.empty? ? nil : Auth0::Types::UpdateBrandingThemeResponseContent.load(response.body))
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
             raise error_class.new(response.body, code: code)

data/lib/auth0/client.rb

@@ -103,6 +103,11 @@ module Auth0
       @groups ||= Auth0::Groups::Client.new(client: @raw_client)
     end
 
+    # @return [Auth0::Guardian::Client]
+    def guardian
+      @guardian ||= Auth0::Guardian::Client.new(client: @raw_client)
+    end
+
     # @return [Auth0::Hooks::Client]
     def hooks
       @hooks ||= Auth0::Hooks::Client.new(client: @raw_client)
@@ -128,11 +133,6 @@ module Auth0
       @network_acls ||= Auth0::NetworkACLs::Client.new(client: @raw_client)
     end
 
-    # @return [Auth0::OrganizationTemplates::Client]
-    def organization_templates
-      @organization_templates ||= Auth0::OrganizationTemplates::Client.new(client: @raw_client)
-    end
-
     # @return [Auth0::Organizations::Client]
     def organizations
       @organizations ||= Auth0::Organizations::Client.new(client: @raw_client)
@@ -233,9 +233,9 @@ module Auth0
       @emails ||= Auth0::Emails::Client.new(client: @raw_client)
     end
 
-    # @return [Auth0::Guardian::Client]
-    def guardian
-      @guardian ||= Auth0::Guardian::Client.new(client: @raw_client)
+    # @return [Auth0::Experimentation::Client]
+    def experimentation
+      @experimentation ||= Auth0::Experimentation::Client.new(client: @raw_client)
     end
 
     # @return [Auth0::Keys::Client]

data/lib/auth0/client_grants/client.rb

@@ -30,6 +30,18 @@ module Auth0
       # @option params [Auth0::Types::ClientGrantSubjectTypeEnum, nil] :subject_type
       # @option params [Auth0::Types::ClientGrantDefaultForEnum, nil] :default_for
       #
+      # @example
+      #   client.client_grants.list(
+      #     include_totals: true,
+      #     from: "from",
+      #     take: 1,
+      #     audience: "audience",
+      #     client_id: "client_id",
+      #     allow_any_organization: true,
+      #     subject_type: "client",
+      #     default_for: "third_party_clients"
+      #   )
+      #
       # @return [Auth0::Types::ListClientGrantPaginatedResponseContent]
       def list(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -63,7 +75,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            parsed_response = Auth0::Types::ListClientGrantPaginatedResponseContent.load(response.body)
+            parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListClientGrantPaginatedResponseContent.load(response.body))
             [parsed_response, response]
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -83,6 +95,9 @@ module Auth0
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       #
+      # @example
+      #   client.client_grants.create(audience: "audience")
+      #
       # @return [Auth0::Types::CreateClientGrantResponseContent]
       def create(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -100,7 +115,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::CreateClientGrantResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::CreateClientGrantResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
@@ -120,6 +135,9 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.client_grants.get(id: "id")
+      #
       # @return [Auth0::Types::GetClientGrantResponseContent]
       def get(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -136,7 +154,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::GetClientGrantResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::GetClientGrantResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
@@ -156,6 +174,9 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.client_grants.delete(id: "id")
+      #
       # @return [untyped]
       def delete(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -188,6 +209,9 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.client_grants.update(id: "id")
+      #
       # @return [Auth0::Types::UpdateClientGrantResponseContent]
       def update(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -209,7 +233,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::UpdateClientGrantResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::UpdateClientGrantResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)

data/lib/auth0/client_grants/organizations/client.rb

@@ -23,6 +23,14 @@ module Auth0
         # @option params [String, nil] :from
         # @option params [Integer, nil] :take
         #
+        # @example
+        #   client.client_grants.organizations.list(
+        #     id: "id",
+        #     include_totals: true,
+        #     from: "from",
+        #     take: 1
+        #   )
+        #
         # @return [Auth0::Types::ListClientGrantOrganizationsPaginatedResponseContent]
         def list(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -51,7 +59,7 @@ module Auth0
             end
             code = response.code.to_i
             if code.between?(200, 299)
-              parsed_response = Auth0::Types::ListClientGrantOrganizationsPaginatedResponseContent.load(response.body)
+              parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListClientGrantOrganizationsPaginatedResponseContent.load(response.body))
               [parsed_response, response]
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)

data/lib/auth0/clients/client.rb

@@ -56,6 +56,20 @@ module Auth0
       # @option params [String, nil] :external_client_id
       # @option params [String, nil] :q
       #
+      # @example
+      #   client.clients.list(
+      #     fields: "fields",
+      #     include_fields: true,
+      #     page: 1,
+      #     per_page: 1,
+      #     include_totals: true,
+      #     is_global: true,
+      #     is_first_party: true,
+      #     app_type: "app_type",
+      #     external_client_id: "external_client_id",
+      #     q: "q"
+      #   )
+      #
       # @return [Auth0::Types::ListClientsOffsetPaginatedResponseContent]
       def list(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -92,7 +106,7 @@ module Auth0
           end
           code = response.code.to_i
           if code.between?(200, 299)
-            parsed_response = Auth0::Types::ListClientsOffsetPaginatedResponseContent.load(response.body)
+            parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListClientsOffsetPaginatedResponseContent.load(response.body))
             [parsed_response, response]
           else
             error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
@@ -128,6 +142,9 @@ module Auth0
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       #
+      # @example
+      #   client.clients.create(name: "name")
+      #
       # @return [Auth0::Types::CreateClientResponseContent]
       def create(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -145,7 +162,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::CreateClientResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::CreateClientResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
@@ -166,6 +183,9 @@ module Auth0
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       #
+      # @example
+      #   client.clients.preview_cimd_metadata(external_client_id: "external_client_id")
+      #
       # @return [Auth0::Types::PreviewCimdMetadataResponseContent]
       def preview_cimd_metadata(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -183,7 +203,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::PreviewCimdMetadataResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::PreviewCimdMetadataResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
@@ -210,6 +230,9 @@ module Auth0
       # @option request_options [Hash{String => Object}] :additional_body_parameters
       # @option request_options [Integer] :timeout_in_seconds
       #
+      # @example
+      #   client.clients.register_cimd_client(external_client_id: "external_client_id")
+      #
       # @return [Auth0::Types::RegisterCimdClientResponseContent]
       def register_cimd_client(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -227,7 +250,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::RegisterCimdClientResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::RegisterCimdClientResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
@@ -273,6 +296,13 @@ module Auth0
       # @option params [String, nil] :fields
       # @option params [Boolean, nil] :include_fields
       #
+      # @example
+      #   client.clients.get(
+      #     id: "id",
+      #     fields: "fields",
+      #     include_fields: true
+      #   )
+      #
       # @return [Auth0::Types::GetClientResponseContent]
       def get(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -294,7 +324,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::GetClientResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::GetClientResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
@@ -312,6 +342,9 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.clients.delete(id: "id")
+      #
       # @return [untyped]
       def delete(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -359,6 +392,9 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.clients.update(id: "id")
+      #
       # @return [Auth0::Types::UpdateClientResponseContent]
       def update(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -380,7 +416,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::UpdateClientResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::UpdateClientResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)
@@ -404,6 +440,9 @@ module Auth0
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String] :id
       #
+      # @example
+      #   client.clients.rotate_secret(id: "id")
+      #
       # @return [Auth0::Types::RotateClientSecretResponseContent]
       def rotate_secret(request_options: {}, **params)
         params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -420,7 +459,7 @@ module Auth0
         end
         code = response.code.to_i
         if code.between?(200, 299)
-          Auth0::Types::RotateClientSecretResponseContent.load(response.body)
+          (response.body.to_s.empty? ? nil : Auth0::Types::RotateClientSecretResponseContent.load(response.body))
         else
           error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
           raise error_class.new(response.body, code: code)

data/lib/auth0/clients/connections/client.rb

@@ -34,6 +34,16 @@ module Auth0
         # @option params [String, nil] :fields
         # @option params [Boolean, nil] :include_fields
         #
+        # @example
+        #   client.clients.connections.get(
+        #     id: "id",
+        #     strategy: ["ad"],
+        #     from: "from",
+        #     take: 1,
+        #     fields: "fields",
+        #     include_fields: true
+        #   )
+        #
         # @return [Auth0::Types::ListClientConnectionsResponseContent]
         def get(request_options: {}, **params)
           params = Auth0::Internal::Types::Utils.normalize_keys(params)
@@ -64,7 +74,7 @@ module Auth0
             end
             code = response.code.to_i
             if code.between?(200, 299)
-              parsed_response = Auth0::Types::ListClientConnectionsResponseContent.load(response.body)
+              parsed_response = (response.body.to_s.empty? ? nil : Auth0::Types::ListClientConnectionsResponseContent.load(response.body))
               [parsed_response, response]
             else
               error_class = Auth0::Errors::ResponseError.subclass_for_code(code)