Class: SubskribeSandboxClient::OpportunityApi

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_sandbox/api/opportunity_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OpportunityApi

Returns a new instance of OpportunityApi.



19
20
21
 
# File 'lib/subskribe_sandbox/api/opportunity_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/subskribe_sandbox/api/opportunity_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_opportunity(opts = {}) ⇒ OpportunityJson

Creates a standalone opportunity Returns the details of a specified opportunity

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



27
28
29
30
 
# File 'lib/subskribe_sandbox/api/opportunity_api.rb', line 27

def create_opportunity(opts = {})
  data, _status_code, _headers = create_opportunity_with_http_info(opts)
  data
end

#create_opportunity_with_http_info(opts = {}) ⇒ Array<(OpportunityJson, Fixnum, Hash)>

Creates a standalone opportunity Returns the details of a specified opportunity

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OpportunityJson, Fixnum, Hash)>) —

    OpportunityJson data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/subskribe_sandbox/api/opportunity_api.rb', line 37

def create_opportunity_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OpportunityApi.create_opportunity ...'
  end
  # resource path
  local_var_path = '/opportunity'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OpportunityJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunityApi#create_opportunity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reset_opportunity_closed_state(id, opts = {}) ⇒ OpportunityJson

Opens an opportunity Returns the details of the updated opportunity

Parameters:

  • id —

    crm id or native id of the opportunity

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



75
76
77
78
 
# File 'lib/subskribe_sandbox/api/opportunity_api.rb', line 75

def reset_opportunity_closed_state(id, opts = {})
  data, _status_code, _headers = reset_opportunity_closed_state_with_http_info(id, opts)
  data
end

#reset_opportunity_closed_state_with_http_info(id, opts = {}) ⇒ Array<(OpportunityJson, Fixnum, Hash)>

Opens an opportunity Returns the details of the updated opportunity

Parameters:

  • id —

    crm id or native id of the opportunity

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(OpportunityJson, Fixnum, Hash)>) —

    OpportunityJson data, response status code and response headers



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/subskribe_sandbox/api/opportunity_api.rb', line 85

def reset_opportunity_closed_state_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OpportunityApi.reset_opportunity_closed_state ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OpportunityApi.reset_opportunity_closed_state"
  end
  # resource path
  local_var_path = '/opportunity/{id}/open'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OpportunityJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunityApi#reset_opportunity_closed_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_opportunity(id, opts = {}) ⇒ OpportunityJson

Updates a standalone opportunity Returns the details of the updated opportunity

Parameters:

  • id —

    id of the opportunity

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



128
129
130
131
 
# File 'lib/subskribe_sandbox/api/opportunity_api.rb', line 128

def update_opportunity(id, opts = {})
  data, _status_code, _headers = update_opportunity_with_http_info(id, opts)
  data
end

#update_opportunity_with_http_info(id, opts = {}) ⇒ Array<(OpportunityJson, Fixnum, Hash)>

Updates a standalone opportunity Returns the details of the updated opportunity

Parameters:

  • id —

    id of the opportunity

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(OpportunityJson, Fixnum, Hash)>) —

    OpportunityJson data, response status code and response headers



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/subskribe_sandbox/api/opportunity_api.rb', line 139

def update_opportunity_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OpportunityApi.update_opportunity ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling OpportunityApi.update_opportunity"
  end
  # resource path
  local_var_path = '/opportunity/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OpportunityJson')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: OpportunityApi#update_opportunity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end