Class: Auth0::Jobs::Client

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



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

def initialize(client:)
  @client = client
end

Instance Method Details

#errors ⇒ Auth0::Errors::Client

Returns:

  • (Auth0::Errors::Client) 


66
67
68
 
# File 'lib/auth0/jobs/client.rb', line 66

def errors
  @errors ||= Auth0::Jobs::Errors::Client.new(client: @client)
end

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

Retrieves a job. Useful to check its status.

Examples:

client.jobs.get(id: "id")

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)

Options Hash (**params):

  • :id (String)

Returns:



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/auth0/jobs/client.rb', line 28

def get(request_options: {}, **params)
  params = Auth0::Internal::Types::Utils.normalize_keys(params)
  request = Auth0::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "jobs/#{URI.encode_uri_component(params[:id].to_s)}",
    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)
    (response.body.to_s.empty? ? nil : Auth0::Types::GetJobResponseContent.load(response.body))
  else
    error_class = Auth0::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#users_exports ⇒ Auth0::UsersExports::Client

Returns:

  • (Auth0::UsersExports::Client) 


51
52
53
 
# File 'lib/auth0/jobs/client.rb', line 51

def users_exports
  @users_exports ||= Auth0::Jobs::UsersExports::Client.new(client: @client)
end

#users_imports ⇒ Auth0::UsersImports::Client

Returns:

  • (Auth0::UsersImports::Client) 


56
57
58
 
# File 'lib/auth0/jobs/client.rb', line 56

def users_imports
  @users_imports ||= Auth0::Jobs::UsersImports::Client.new(client: @client)
end

#verification_email ⇒ Auth0::VerificationEmail::Client

Returns:

  • (Auth0::VerificationEmail::Client) 


61
62
63
 
# File 'lib/auth0/jobs/client.rb', line 61

def verification_email
  @verification_email ||= Auth0::Jobs::VerificationEmail::Client.new(client: @client)
end