Class: ApolloDeploySignalSdk::Contacts

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

Overview

contacts API domain

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ Contacts

Returns a new instance of Contacts.



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

def transport
  @transport
end

Instance Method Details

#add_contact_to_segment(project_id:, contact_id:, body:) ⇒ nil

Parameters:

  • project_id (String)
  • contact_id (String)
  • body (AddToSegmentBody) —

    request body

Returns:

  • (nil)

Raises:



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/apollo_deploy_signal_sdk/resources/contacts.rb', line 205

def add_contact_to_segment(project_id:, contact_id:, body:)
  path_params = {
    "projectId" => project_id,
    "contactId" => contact_id,
  }

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

#create_contact(project_id:, body:) ⇒ ContactResponse

Parameters:

Returns:

Raises:



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

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

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

#delete_contact(project_id:, contact_id:) ⇒ nil

Parameters:

  • project_id (String)
  • contact_id (String)

Returns:

  • (nil)

Raises:



129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/apollo_deploy_signal_sdk/resources/contacts.rb', line 129

def delete_contact(project_id:, contact_id:)
  path_params = {
    "projectId" => project_id,
    "contactId" => contact_id,
  }

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

#delete_contact_image(project_id:, contact_id:) ⇒ nil

Parameters:

  • project_id (String)
  • contact_id (String)

Returns:

  • (nil)

Raises:



186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/apollo_deploy_signal_sdk/resources/contacts.rb', line 186

def delete_contact_image(project_id:, contact_id:)
  path_params = {
    "projectId" => project_id,
    "contactId" => contact_id,
  }

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

#get_contact(project_id:, contact_id:) ⇒ ContactResponse

Parameters:

  • project_id (String)
  • contact_id (String)

Returns:

Raises:



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

def get_contact(project_id:, contact_id:)
  path_params = {
    "projectId" => project_id,
    "contactId" => contact_id,
  }

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

#get_contact_activity(project_id:, contact_id:) ⇒ GetContactActivityResponse

Parameters:

  • project_id (String)
  • contact_id (String)

Returns:

Raises:



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/apollo_deploy_signal_sdk/resources/contacts.rb', line 266

def get_contact_activity(project_id:, contact_id:)
  path_params = {
    "projectId" => project_id,
    "contactId" => contact_id,
  }

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

#get_contact_email_validation_status(project_id:, contact_id:) ⇒ EmailValidationStatusResponse

Parameters:

  • project_id (String)
  • contact_id (String)

Returns:

Raises:



302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/apollo_deploy_signal_sdk/resources/contacts.rb', line 302

def get_contact_email_validation_status(project_id:, contact_id:)
  path_params = {
    "projectId" => project_id,
    "contactId" => contact_id,
  }

  transport.request(
    method: :get,
    path: "/v1/projects/${projectId}/contacts/${contactId}/email-validation",
    path_params: path_params,
    timeout_ms: nil,
  )
end

#get_contact_engagement_score(project_id:, contact_id:) ⇒ EngagementScoreResponse

Parameters:

  • project_id (String)
  • contact_id (String)

Returns:

Raises:



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/apollo_deploy_signal_sdk/resources/contacts.rb', line 284

def get_contact_engagement_score(project_id:, contact_id:)
  path_params = {
    "projectId" => project_id,
    "contactId" => contact_id,
  }

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

#get_contact_topics(project_id:, contact_id:) ⇒ GetContactTopicsResponse

Parameters:

  • project_id (String)
  • contact_id (String)

Returns:

Raises:



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

def get_contact_topics(project_id:, contact_id:)
  path_params = {
    "projectId" => project_id,
    "contactId" => contact_id,
  }

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

#list_contact_segments(project_id:, contact_id:) ⇒ ListContactSegmentsResponse

Parameters:

  • project_id (String)
  • contact_id (String)

Returns:

Raises:



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

def list_contact_segments(project_id:, contact_id:)
  path_params = {
    "projectId" => project_id,
    "contactId" => contact_id,
  }

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

#list_contacts(project_id:) ⇒ ContactPageResponse

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

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

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

#record_contact_email_validation(project_id:, contact_id:, body:) ⇒ nil

Parameters:

Returns:

  • (nil)

Raises:



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/apollo_deploy_signal_sdk/resources/contacts.rb', line 339

def record_contact_email_validation(project_id:, contact_id:, body:)
  path_params = {
    "projectId" => project_id,
    "contactId" => contact_id,
  }

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

#refresh_contact_engagement_score(project_id:, contact_id:) ⇒ EngagementScoreResponse

Parameters:

  • project_id (String)
  • contact_id (String)

Returns:

Raises:



320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/apollo_deploy_signal_sdk/resources/contacts.rb', line 320

def refresh_contact_engagement_score(project_id:, contact_id:)
  path_params = {
    "projectId" => project_id,
    "contactId" => contact_id,
  }

  transport.request(
    method: :post,
    path: "/v1/projects/${projectId}/contacts/${contactId}/engagement/refresh",
    path_params: path_params,
    timeout_ms: nil,
  )
end

#remove_contact_from_segment(project_id:, contact_id:, segment_id:) ⇒ nil

Parameters:

  • project_id (String)
  • contact_id (String)
  • segment_id (String)

Returns:

  • (nil)

Raises:



226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/apollo_deploy_signal_sdk/resources/contacts.rb', line 226

def remove_contact_from_segment(project_id:, contact_id:, segment_id:)
  path_params = {
    "projectId" => project_id,
    "contactId" => contact_id,
    "segmentId" => segment_id,
  }

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

#set_contact_image_url(project_id:, contact_id:, body:) ⇒ ContactResponse

Parameters:

  • project_id (String)
  • contact_id (String)
  • body (SetImageUrlBody) —

    request body

Returns:

Raises:



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/apollo_deploy_signal_sdk/resources/contacts.rb', line 166

def set_contact_image_url(project_id:, contact_id:, body:)
  path_params = {
    "projectId" => project_id,
    "contactId" => contact_id,
  }

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

#update_contact(project_id:, contact_id:, body:) ⇒ ContactResponse

Parameters:

Returns:

Raises:



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/apollo_deploy_signal_sdk/resources/contacts.rb', line 109

def update_contact(project_id:, contact_id:, body:)
  path_params = {
    "projectId" => project_id,
    "contactId" => contact_id,
  }

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

#update_contact_topics(project_id:, contact_id:, body:) ⇒ nil

Parameters:

  • project_id (String)
  • contact_id (String)
  • body (UpdateTopicsBody) —

    request body

Returns:

  • (nil)

Raises:



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/apollo_deploy_signal_sdk/resources/contacts.rb', line 246

def update_contact_topics(project_id:, contact_id:, body:)
  path_params = {
    "projectId" => project_id,
    "contactId" => contact_id,
  }

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

#upload_contact_image(project_id:, contact_id:) ⇒ ContactResponse

Parameters:

  • project_id (String)
  • contact_id (String)

Returns:

Raises:



147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/apollo_deploy_signal_sdk/resources/contacts.rb', line 147

def upload_contact_image(project_id:, contact_id:)
  path_params = {
    "projectId" => project_id,
    "contactId" => contact_id,
  }

  transport.request(
    method: :post,
    path: "/v1/projects/${projectId}/contacts/${contactId}/image",
    path_params: path_params,
    timeout_ms: nil,
  )
end