Class: OpenApiSDK::CrmEngagements

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Defined in:
lib/open_api_sdk/crm_engagements.rb

Instance Method Summary collapse

Constructor Details

#initialize(sdk_config) ⇒ CrmEngagements

Returns a new instance of CrmEngagements.



17
18
19
 
# File 'lib/open_api_sdk/crm_engagements.rb', line 17

def initialize(sdk_config)
  @sdk_configuration = sdk_config
end

Instance Method Details

#create(x_connection_token, unified_crm_engagement_input, remote_data = nil) ⇒ Object

Raises:

  • (StandardError) 


62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/open_api_sdk/crm_engagements.rb', line 62

def create(x_connection_token, unified_crm_engagement_input, remote_data = nil)
  # create - Create Engagements
  # Create Engagements in any supported Crm software
  request = ::OpenApiSDK::Operations::CreateCrmEngagementRequest.new(
    
    x_connection_token: x_connection_token,
    unified_crm_engagement_input: unified_crm_engagement_input,
    remote_data: remote_data
  )
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = "#{base_url}/crm/engagements"
  headers = Utils.get_headers(request)
  req_content_type, data, form = Utils.serialize_request_body(request, :unified_crm_engagement_input, :json)
  headers['content-type'] = req_content_type
  raise StandardError, 'request body is required' if data.nil? && form.nil?
  query_params = Utils.get_query_params(::OpenApiSDK::Operations::CreateCrmEngagementRequest, request)
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent

  r = @sdk_configuration.client.post(url) do |req|
    req.headers = headers
    req.params = query_params
    Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
    if form
      req.body = Utils.encode_form(form)
    elsif Utils.match_content_type(req_content_type, 'application/x-www-form-urlencoded')
      req.body = URI.encode_www_form(data)
    else
      req.body = data
    end
  end

  content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

  res = ::OpenApiSDK::Operations::CreateCrmEngagementResponse.new(
    status_code: r.status, content_type: content_type, raw_response: r
  )
  if r.status == 201
    if Utils.match_content_type(content_type, 'application/json')
      out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::UnifiedCrmEngagementOutput)
      res.unified_crm_engagement_output = out
    end
  end
  res
end

#list(x_connection_token, remote_data = nil, limit = nil, cursor = nil) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/open_api_sdk/crm_engagements.rb', line 23

def list(x_connection_token, remote_data = nil, limit = nil, cursor = nil)
  # list - List Engagements
  request = ::OpenApiSDK::Operations::ListCrmEngagementsRequest.new(
    
    x_connection_token: x_connection_token,
    remote_data: remote_data,
    limit: limit,
    cursor: cursor
  )
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = "#{base_url}/crm/engagements"
  headers = Utils.get_headers(request)
  query_params = Utils.get_query_params(::OpenApiSDK::Operations::ListCrmEngagementsRequest, request)
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent

  r = @sdk_configuration.client.get(url) do |req|
    req.headers = headers
    req.params = query_params
    Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
  end

  content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

  res = ::OpenApiSDK::Operations::ListCrmEngagementsResponse.new(
    status_code: r.status, content_type: content_type, raw_response: r
  )
  if r.status == 200
    if Utils.match_content_type(content_type, 'application/json')
      out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Operations::ListCrmEngagementsResponseBody)
      res.object = out
    end
  end
  res
end

#retrieve(x_connection_token, id, remote_data = nil) ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/open_api_sdk/crm_engagements.rb', line 111

def retrieve(x_connection_token, id, remote_data = nil)
  # retrieve - Retrieve Engagements
  # Retrieve Engagements from any connected Crm software
  request = ::OpenApiSDK::Operations::RetrieveCrmEngagementRequest.new(
    
    x_connection_token: x_connection_token,
    id: id,
    remote_data: remote_data
  )
  url, params = @sdk_configuration.get_server_details
  base_url = Utils.template_url(url, params)
  url = Utils.generate_url(
    ::OpenApiSDK::Operations::RetrieveCrmEngagementRequest,
    base_url,
    '/crm/engagements/{id}',
    request
  )
  headers = Utils.get_headers(request)
  query_params = Utils.get_query_params(::OpenApiSDK::Operations::RetrieveCrmEngagementRequest, request)
  headers['Accept'] = 'application/json'
  headers['user-agent'] = @sdk_configuration.user_agent

  r = @sdk_configuration.client.get(url) do |req|
    req.headers = headers
    req.params = query_params
    Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
  end

  content_type = r.headers.fetch('Content-Type', 'application/octet-stream')

  res = ::OpenApiSDK::Operations::RetrieveCrmEngagementResponse.new(
    status_code: r.status, content_type: content_type, raw_response: r
  )
  if r.status == 200
    if Utils.match_content_type(content_type, 'application/json')
      out = Utils.unmarshal_complex(r.env.response_body, ::OpenApiSDK::Shared::UnifiedCrmEngagementOutput)
      res.unified_crm_engagement_output = out
    end
  end
  res
end