Class: ApolloDeploySignalSdkRails::ContactProperties

Inherits:
Object
  • Object
show all
Defined in:
lib/apollo_deploy_signal_sdk_rails/resources/contact-properties.rb

Overview

contactProperties API domain

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ ContactProperties

Returns a new instance of ContactProperties.



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

def transport
  @transport
end

Instance Method Details

#create_contact_property(project_id:, body:) ⇒ ContactPropertyResponse

Parameters:

Returns:

Raises:



53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/contact-properties.rb', line 53

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

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

#delete_contact_property(project_id:, property_id:) ⇒ nil

Parameters:

  • project_id (String)
  • property_id (String)

Returns:

  • (nil)

Raises:



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/contact-properties.rb', line 93

def delete_contact_property(project_id:, property_id:)
  path_params = {
    "projectId" => project_id,
    "propertyId" => property_id,
  }

  transport.request(
    method: :delete,
    path: "/v1/projects/${projectId}/contact-properties/${propertyId}",
    path_params: path_params,
    timeout_ms: nil,
  )
end

#get_contact_property(project_id:, property_id:) ⇒ ContactPropertyResponse

Parameters:

  • project_id (String)
  • property_id (String)

Returns:

Raises:



35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/contact-properties.rb', line 35

def get_contact_property(project_id:, property_id:)
  path_params = {
    "projectId" => project_id,
    "propertyId" => property_id,
  }

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

#list_contact_properties(project_id:) ⇒ ContactPropertyPageResponse

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

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

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

#update_contact_property(project_id:, property_id:, body:) ⇒ ContactPropertyResponse

Parameters:

Returns:

Raises:



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/apollo_deploy_signal_sdk_rails/resources/contact-properties.rb', line 73

def update_contact_property(project_id:, property_id:, body:)
  path_params = {
    "projectId" => project_id,
    "propertyId" => property_id,
  }

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