Class: Auth0::Branding::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/auth0/branding/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



9
10
11
 
# File 'lib/auth0/branding/client.rb', line 9

def initialize(client:)
  @client = client
end

Instance Method Details

#get(request_options: {}, **params) ⇒ Auth0::Types::GetBrandingResponseContent

Retrieve branding settings.

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/auth0/branding/client.rb', line 24

def get(request_options: {}, **params)
  Auth0::Internal::Types::Utils.normalize_keys(params)
  request = Auth0::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "branding",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Auth0::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Auth0::Types::GetBrandingResponseContent.load(response.body)
  else
    error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#phone ⇒ Auth0::Phone::Client

Returns:

  • (Auth0::Phone::Client) 


91
92
93
 
# File 'lib/auth0/branding/client.rb', line 91

def phone
  @phone ||= Auth0::Branding::Phone::Client.new(client: @client)
end

#templates ⇒ Auth0::Templates::Client

Returns:

  • (Auth0::Templates::Client) 


81
82
83
 
# File 'lib/auth0/branding/client.rb', line 81

def templates
  @templates ||= Auth0::Branding::Templates::Client.new(client: @client)
end

#themes ⇒ Auth0::Themes::Client

Returns:

  • (Auth0::Themes::Client) 


86
87
88
 
# File 'lib/auth0/branding/client.rb', line 86

def themes
  @themes ||= Auth0::Branding::Themes::Client.new(client: @client)
end

#update(request_options: {}, **params) ⇒ Auth0::Types::UpdateBrandingResponseContent

Update branding settings.

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/auth0/branding/client.rb', line 57

def update(request_options: {}, **params)
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
  request = Auth0::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "PATCH",
    path: "branding",
    body: Auth0::Branding::Types::UpdateBrandingRequestContent.new(params).to_h,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise Auth0::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    Auth0::Types::UpdateBrandingResponseContent.load(response.body)
  else
    error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end