Class: ApolloDeploySignalSdkRails::Suppressions

Inherits:
Object
  • Object
show all
Defined in:
lib/apollo_deploy_signal_sdk_rails/resources/suppressions.rb

Overview

suppressions API domain

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ Suppressions

Returns a new instance of Suppressions.



11
12
13
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/suppressions.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/suppressions.rb', line 9

def transport
  @transport
end

Instance Method Details

#add_suppression(project_id:, body:) ⇒ SuppressionResponse

Parameters:

Returns:

Raises:



51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/suppressions.rb', line 51

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

  transport.request(
    method: :post,
    path: "/v1/projects/${projectId}/suppressions",
    path_params: path_params,
    body: body,
    content_type: "application/json",
    timeout_ms: nil,
  )
end

#export_suppressions(project_id:) ⇒ nil

Parameters:

  • project_id (String)

Returns:

  • (nil)

Raises:



34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/suppressions.rb', line 34

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

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

#import_suppressions(project_id:, body:) ⇒ SuppressionImportResponse

Parameters:

Returns:

Raises:



88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/suppressions.rb', line 88

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

  transport.request(
    method: :post,
    path: "/v1/projects/${projectId}/suppressions/import",
    path_params: path_params,
    body: body,
    content_type: "application/json",
    timeout_ms: nil,
  )
end

#list_suppressions(project_id:) ⇒ SuppressionPageResponse

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/suppressions.rb', line 18

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

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

#remove_suppression(project_id:, email:) ⇒ nil

Parameters:

  • project_id (String)
  • email (String)

Returns:

  • (nil)

Raises:



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/suppressions.rb', line 70

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

  transport.request(
    method: :delete,
    path: "/v1/projects/${projectId}/suppressions/${email}",
    path_params: path_params,
    timeout_ms: nil,
  )
end