Class: ApolloDeploySignalSdkRails::ApiKeys

Inherits:
Object
  • Object
show all
Defined in:
lib/apollo_deploy_signal_sdk_rails/resources/api-keys.rb

Overview

apiKeys API domain

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ ApiKeys

Returns a new instance of ApiKeys.



11
12
13
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/api-keys.rb', line 11

def initialize(transport)
  @transport = transport
end

Instance Attribute Details

#transport ⇒ Object (readonly)

Returns the value of attribute transport.



9
10
11
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/api-keys.rb', line 9

def transport
  @transport
end

Instance Method Details

#export_api_key_usage(project_id:, key_id:) ⇒ nil

Parameters:

  • project_id (String)
  • key_id (String)

Returns:

  • (nil)

Raises:



71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/api-keys.rb', line 71

def export_api_key_usage(project_id:, key_id:)
  path_params = {
    "projectId" => project_id,
    "keyId" => key_id,
  }

  transport.request(
    method: :get,
    path: "/v1/projects/${projectId}/api-keys/${keyId}/usage/export",
    path_params: path_params,
    timeout_ms: nil,
  )
end

#get_api_key(project_id:, key_id:) ⇒ ApiKey

Parameters:

  • project_id (String)
  • key_id (String)

Returns:

Raises:



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/api-keys.rb', line 35

def get_api_key(project_id:, key_id:)
  path_params = {
    "projectId" => project_id,
    "keyId" => key_id,
  }

  transport.request(
    method: :get,
    path: "/v1/projects/${projectId}/api-keys/${keyId}",
    path_params: path_params,
    timeout_ms: nil,
  )
end

#get_api_key_usage(project_id:, key_id:) ⇒ ApiKeyUsageResponse

Parameters:

  • project_id (String)
  • key_id (String)

Returns:

Raises:



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/api-keys.rb', line 53

def get_api_key_usage(project_id:, key_id:)
  path_params = {
    "projectId" => project_id,
    "keyId" => key_id,
  }

  transport.request(
    method: :get,
    path: "/v1/projects/${projectId}/api-keys/${keyId}/usage",
    path_params: path_params,
    timeout_ms: nil,
  )
end

#list_api_keys(project_id:) ⇒ ListApiKeysResponse

Parameters:

  • project_id (String)

Returns:

Raises:



18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/api-keys.rb', line 18

def list_api_keys(project_id:)
  path_params = {
    "projectId" => project_id,
  }

  transport.request(
    method: :get,
    path: "/v1/projects/${projectId}/api-keys",
    path_params: path_params,
    timeout_ms: nil,
  )
end