Class: ApolloDeploySignalSdk::Segments

Inherits:
Object
  • Object
show all
Defined in:
lib/apollo_deploy_signal_sdk/resources/segments.rb

Overview

segments API domain

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ Segments

Returns a new instance of Segments.



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

def transport
  @transport
end

Instance Method Details

#create_segment(project_id:, body:) ⇒ SegmentResponse

Parameters:

Returns:

Raises:



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/apollo_deploy_signal_sdk/resources/segments.rb', line 71

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

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

#delete_segment(project_id:, segment_id:) ⇒ nil

Parameters:

  • project_id (String)
  • segment_id (String)

Returns:

  • (nil)

Raises:



90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/apollo_deploy_signal_sdk/resources/segments.rb', line 90

def delete_segment(project_id:, segment_id:)
  path_params = {
    "projectId" => project_id,
    "segmentId" => segment_id,
  }

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

#get_segment(project_id:, segment_id:) ⇒ SegmentResponse

Parameters:

  • project_id (String)
  • segment_id (String)

Returns:

Raises:



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/apollo_deploy_signal_sdk/resources/segments.rb', line 35

def get_segment(project_id:, segment_id:)
  path_params = {
    "projectId" => project_id,
    "segmentId" => segment_id,
  }

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

#list_contacts_in_segment(project_id:, segment_id:) ⇒ CursorPage

Parameters:

  • project_id (String)
  • segment_id (String)

Returns:

Raises:



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/apollo_deploy_signal_sdk/resources/segments.rb', line 53

def list_contacts_in_segment(project_id:, segment_id:)
  path_params = {
    "projectId" => project_id,
    "segmentId" => segment_id,
  }

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

#list_segments(project_id:) ⇒ SegmentPageResponse

Parameters:

  • project_id (String)

Returns:

Raises:



18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/apollo_deploy_signal_sdk/resources/segments.rb', line 18

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

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