Class: ApolloDeploySignalSdkRails::Projects

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

Overview

projects API domain

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ Projects

Returns a new instance of Projects.



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

def transport
  @transport
end

Instance Method Details

#get_email_timeline(project_id:, email_id:) ⇒ EmailTimelineResponse

Parameters:

  • project_id (String)
  • email_id (String)

Returns:

Raises:



99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/projects.rb', line 99

def get_email_timeline(project_id:, email_id:)
  path_params = {
    "projectId" => project_id,
    "emailId" => email_id,
  }

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

#get_project(project_id:) ⇒ ProjectResponse

Parameters:

  • project_id (String)

Returns:

Raises:



29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/projects.rb', line 29

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

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

#get_project_email(project_id:, email_id:) ⇒ EmailDetailResponse

Parameters:

  • project_id (String)
  • email_id (String)

Returns:

Raises:



81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/projects.rb', line 81

def get_project_email(project_id:, email_id:)
  path_params = {
    "projectId" => project_id,
    "emailId" => email_id,
  }

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

#list_emails(project_id:) ⇒ EmailPageResponse

Parameters:

  • project_id (String)

Returns:

Raises:



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/projects.rb', line 64

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

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

#list_projects ⇒ ProjectPageResponse

Returns:

Raises:



17
18
19
20
21
22
23
24
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/projects.rb', line 17

def list_projects()

  transport.request(
    method: :get,
    path: "/v1/projects",
    timeout_ms: nil,
  )
end

#update_project(project_id:, body:) ⇒ ProjectResponse

Parameters:

Returns:

Raises:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/projects.rb', line 46

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

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