Class: ApolloDeploySignalSdk::Emails

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

Overview

emails API domain

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ Emails

Returns a new instance of Emails.



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

def transport
  @transport
end

Instance Method Details

#batch_send_emails(body:) ⇒ BatchSendResponse

Parameters:

Returns:

Raises:



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/apollo_deploy_signal_sdk/resources/emails.rb', line 48

def batch_send_emails(body:)

  transport.request(
    method: :post,
    path: "/v1/emails/batch",
    body: body,
    content_type: "application/json",
    timeout_ms: nil,
  )
end

#bulk_cancel_emails ⇒ BulkCancelResponse

Returns:

Raises:



77
78
79
80
81
82
83
84
 
# File 'lib/apollo_deploy_signal_sdk/resources/emails.rb', line 77

def bulk_cancel_emails()

  transport.request(
    method: :delete,
    path: "/v1/emails",
    timeout_ms: nil,
  )
end

#cancel_email(email_id:) ⇒ CancelResponse

Parameters:

  • email_id (String)

Returns:

Raises:



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/apollo_deploy_signal_sdk/resources/emails.rb', line 62

def cancel_email(email_id:)
  path_params = {
    "emailId" => email_id,
  }

  transport.request(
    method: :delete,
    path: "/v1/emails/${emailId}",
    path_params: path_params,
    timeout_ms: nil,
  )
end

#get_email(email_id:) ⇒ EmailDetailResponse

Parameters:

  • email_id (String)

Returns:

Raises:



32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/apollo_deploy_signal_sdk/resources/emails.rb', line 32

def get_email(email_id:)
  path_params = {
    "emailId" => email_id,
  }

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

#issue_stream_token(project_id:) ⇒ StreamTokenResponse

Parameters:

  • project_id (String)

Returns:

Raises:



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

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

  transport.request(
    method: :post,
    path: "/v1/emails/${projectId}/stream/token",
    path_params: path_params,
    timeout_ms: nil,
  )
end

#send_email(body:) ⇒ SendEmailResponse

Parameters:

Returns:

Raises:



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

def send_email(body:)

  transport.request(
    method: :post,
    path: "/v1/emails",
    body: body,
    content_type: "application/json",
    timeout_ms: nil,
  )
end

#stream_email_events ⇒ Enumerator<SSEEvent>

Returns:

Raises:



104
105
106
107
108
109
110
111
 
# File 'lib/apollo_deploy_signal_sdk/resources/emails.rb', line 104

def stream_email_events()

  transport.stream(
    method: :get,
    path: "/v1/emails/stream",
    timeout_ms: nil,
  )
end

#validate_links(body:) ⇒ ValidateLinksResponse

Parameters:

Returns:

Raises:



116
117
118
119
120
121
122
123
124
125
 
# File 'lib/apollo_deploy_signal_sdk/resources/emails.rb', line 116

def validate_links(body:)

  transport.request(
    method: :post,
    path: "/v1/emails/validate",
    body: body,
    content_type: "application/json",
    timeout_ms: nil,
  )
end