Class: HighLevel::Configuration

Inherits:
Data
  • Object
show all
Defined in:
lib/high_level/configuration.rb

Overview

Immutable, per-client configuration. Every collaborator a Client needs — credentials, base URL, session storage, instrumenter — is supplied here; there is no global mutable state.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_version: "2021-07-28", base_url: "https://services.leadconnectorhq.com", private_integration_token: nil, agency_access_token: nil, location_access_token: nil, client_id: nil, client_secret: nil, redirect_uri: nil, session_storage: Storage::Memory.new, logger: nil, instrumenter: nil) ⇒ Configuration

Returns a new instance of Configuration.

See Also:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/high_level/configuration.rb', line 46

def initialize(
  api_version: "2021-07-28",
  base_url: "https://services.leadconnectorhq.com",
  private_integration_token: nil,
  agency_access_token: nil,
  location_access_token: nil,
  client_id: nil,
  client_secret: nil,
  redirect_uri: nil,
  session_storage: Storage::Memory.new,
  logger: nil,
  instrumenter: nil
)
  super
end

Instance Attribute Details

#agency_access_token ⇒ Object (readonly)

Returns the value of attribute agency_access_token

Returns:

  • (Object) —

    the current value of agency_access_token



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/high_level/configuration.rb', line 32

Configuration = Data.define(
  :api_version,
  :base_url,
  :private_integration_token,
  :agency_access_token,
  :location_access_token,
  :client_id,
  :client_secret,
  :redirect_uri,
  :session_storage,
  :logger,
  :instrumenter
) do
  # @see Configuration the attribute list for every keyword argument
  def initialize(
    api_version: "2021-07-28",
    base_url: "https://services.leadconnectorhq.com",
    private_integration_token: nil,
    agency_access_token: nil,
    location_access_token: nil,
    client_id: nil,
    client_secret: nil,
    redirect_uri: nil,
    session_storage: Storage::Memory.new,
    logger: nil,
    instrumenter: nil
  )
    super
  end
end

#api_version ⇒ Object (readonly)

Returns the value of attribute api_version

Returns:

  • (Object) —

    the current value of api_version



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/high_level/configuration.rb', line 32

Configuration = Data.define(
  :api_version,
  :base_url,
  :private_integration_token,
  :agency_access_token,
  :location_access_token,
  :client_id,
  :client_secret,
  :redirect_uri,
  :session_storage,
  :logger,
  :instrumenter
) do
  # @see Configuration the attribute list for every keyword argument
  def initialize(
    api_version: "2021-07-28",
    base_url: "https://services.leadconnectorhq.com",
    private_integration_token: nil,
    agency_access_token: nil,
    location_access_token: nil,
    client_id: nil,
    client_secret: nil,
    redirect_uri: nil,
    session_storage: Storage::Memory.new,
    logger: nil,
    instrumenter: nil
  )
    super
  end
end

#base_url ⇒ Object (readonly)

Returns the value of attribute base_url

Returns:

  • (Object) —

    the current value of base_url



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/high_level/configuration.rb', line 32

Configuration = Data.define(
  :api_version,
  :base_url,
  :private_integration_token,
  :agency_access_token,
  :location_access_token,
  :client_id,
  :client_secret,
  :redirect_uri,
  :session_storage,
  :logger,
  :instrumenter
) do
  # @see Configuration the attribute list for every keyword argument
  def initialize(
    api_version: "2021-07-28",
    base_url: "https://services.leadconnectorhq.com",
    private_integration_token: nil,
    agency_access_token: nil,
    location_access_token: nil,
    client_id: nil,
    client_secret: nil,
    redirect_uri: nil,
    session_storage: Storage::Memory.new,
    logger: nil,
    instrumenter: nil
  )
    super
  end
end

#client_id ⇒ Object (readonly)

Returns the value of attribute client_id

Returns:

  • (Object) —

    the current value of client_id



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/high_level/configuration.rb', line 32

Configuration = Data.define(
  :api_version,
  :base_url,
  :private_integration_token,
  :agency_access_token,
  :location_access_token,
  :client_id,
  :client_secret,
  :redirect_uri,
  :session_storage,
  :logger,
  :instrumenter
) do
  # @see Configuration the attribute list for every keyword argument
  def initialize(
    api_version: "2021-07-28",
    base_url: "https://services.leadconnectorhq.com",
    private_integration_token: nil,
    agency_access_token: nil,
    location_access_token: nil,
    client_id: nil,
    client_secret: nil,
    redirect_uri: nil,
    session_storage: Storage::Memory.new,
    logger: nil,
    instrumenter: nil
  )
    super
  end
end

#client_secret ⇒ Object (readonly)

Returns the value of attribute client_secret

Returns:

  • (Object) —

    the current value of client_secret



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/high_level/configuration.rb', line 32

Configuration = Data.define(
  :api_version,
  :base_url,
  :private_integration_token,
  :agency_access_token,
  :location_access_token,
  :client_id,
  :client_secret,
  :redirect_uri,
  :session_storage,
  :logger,
  :instrumenter
) do
  # @see Configuration the attribute list for every keyword argument
  def initialize(
    api_version: "2021-07-28",
    base_url: "https://services.leadconnectorhq.com",
    private_integration_token: nil,
    agency_access_token: nil,
    location_access_token: nil,
    client_id: nil,
    client_secret: nil,
    redirect_uri: nil,
    session_storage: Storage::Memory.new,
    logger: nil,
    instrumenter: nil
  )
    super
  end
end

#instrumenter ⇒ Object (readonly)

Returns the value of attribute instrumenter

Returns:

  • (Object) —

    the current value of instrumenter



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/high_level/configuration.rb', line 32

Configuration = Data.define(
  :api_version,
  :base_url,
  :private_integration_token,
  :agency_access_token,
  :location_access_token,
  :client_id,
  :client_secret,
  :redirect_uri,
  :session_storage,
  :logger,
  :instrumenter
) do
  # @see Configuration the attribute list for every keyword argument
  def initialize(
    api_version: "2021-07-28",
    base_url: "https://services.leadconnectorhq.com",
    private_integration_token: nil,
    agency_access_token: nil,
    location_access_token: nil,
    client_id: nil,
    client_secret: nil,
    redirect_uri: nil,
    session_storage: Storage::Memory.new,
    logger: nil,
    instrumenter: nil
  )
    super
  end
end

#location_access_token ⇒ Object (readonly)

Returns the value of attribute location_access_token

Returns:

  • (Object) —

    the current value of location_access_token



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/high_level/configuration.rb', line 32

Configuration = Data.define(
  :api_version,
  :base_url,
  :private_integration_token,
  :agency_access_token,
  :location_access_token,
  :client_id,
  :client_secret,
  :redirect_uri,
  :session_storage,
  :logger,
  :instrumenter
) do
  # @see Configuration the attribute list for every keyword argument
  def initialize(
    api_version: "2021-07-28",
    base_url: "https://services.leadconnectorhq.com",
    private_integration_token: nil,
    agency_access_token: nil,
    location_access_token: nil,
    client_id: nil,
    client_secret: nil,
    redirect_uri: nil,
    session_storage: Storage::Memory.new,
    logger: nil,
    instrumenter: nil
  )
    super
  end
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger

Returns:

  • (Object) —

    the current value of logger



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/high_level/configuration.rb', line 32

Configuration = Data.define(
  :api_version,
  :base_url,
  :private_integration_token,
  :agency_access_token,
  :location_access_token,
  :client_id,
  :client_secret,
  :redirect_uri,
  :session_storage,
  :logger,
  :instrumenter
) do
  # @see Configuration the attribute list for every keyword argument
  def initialize(
    api_version: "2021-07-28",
    base_url: "https://services.leadconnectorhq.com",
    private_integration_token: nil,
    agency_access_token: nil,
    location_access_token: nil,
    client_id: nil,
    client_secret: nil,
    redirect_uri: nil,
    session_storage: Storage::Memory.new,
    logger: nil,
    instrumenter: nil
  )
    super
  end
end

#private_integration_token ⇒ Object (readonly)

Returns the value of attribute private_integration_token

Returns:

  • (Object) —

    the current value of private_integration_token



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/high_level/configuration.rb', line 32

Configuration = Data.define(
  :api_version,
  :base_url,
  :private_integration_token,
  :agency_access_token,
  :location_access_token,
  :client_id,
  :client_secret,
  :redirect_uri,
  :session_storage,
  :logger,
  :instrumenter
) do
  # @see Configuration the attribute list for every keyword argument
  def initialize(
    api_version: "2021-07-28",
    base_url: "https://services.leadconnectorhq.com",
    private_integration_token: nil,
    agency_access_token: nil,
    location_access_token: nil,
    client_id: nil,
    client_secret: nil,
    redirect_uri: nil,
    session_storage: Storage::Memory.new,
    logger: nil,
    instrumenter: nil
  )
    super
  end
end

#redirect_uri ⇒ Object (readonly)

Returns the value of attribute redirect_uri

Returns:

  • (Object) —

    the current value of redirect_uri



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/high_level/configuration.rb', line 32

Configuration = Data.define(
  :api_version,
  :base_url,
  :private_integration_token,
  :agency_access_token,
  :location_access_token,
  :client_id,
  :client_secret,
  :redirect_uri,
  :session_storage,
  :logger,
  :instrumenter
) do
  # @see Configuration the attribute list for every keyword argument
  def initialize(
    api_version: "2021-07-28",
    base_url: "https://services.leadconnectorhq.com",
    private_integration_token: nil,
    agency_access_token: nil,
    location_access_token: nil,
    client_id: nil,
    client_secret: nil,
    redirect_uri: nil,
    session_storage: Storage::Memory.new,
    logger: nil,
    instrumenter: nil
  )
    super
  end
end

#session_storage ⇒ Object (readonly)

Returns the value of attribute session_storage

Returns:

  • (Object) —

    the current value of session_storage



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/high_level/configuration.rb', line 32

Configuration = Data.define(
  :api_version,
  :base_url,
  :private_integration_token,
  :agency_access_token,
  :location_access_token,
  :client_id,
  :client_secret,
  :redirect_uri,
  :session_storage,
  :logger,
  :instrumenter
) do
  # @see Configuration the attribute list for every keyword argument
  def initialize(
    api_version: "2021-07-28",
    base_url: "https://services.leadconnectorhq.com",
    private_integration_token: nil,
    agency_access_token: nil,
    location_access_token: nil,
    client_id: nil,
    client_secret: nil,
    redirect_uri: nil,
    session_storage: Storage::Memory.new,
    logger: nil,
    instrumenter: nil
  )
    super
  end
end