Class: DealMakerAPI::CampaignApi

Inherits:
Object
  • Object
show all
Defined in:
lib/DealMakerAPI/api/campaign_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CampaignApi

Returns a new instance of CampaignApi.



19
20
21
 
# File 'lib/DealMakerAPI/api/campaign_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/DealMakerAPI/api/campaign_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_ttw_campaign(id, opts = {}) ⇒ V1EntitiesTtwCampaignResponse

Gets a TTW campaign for a given company Gets a TTW campaign for a given company

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/DealMakerAPI/api/campaign_api.rb', line 27

def get_ttw_campaign(id, opts = {})
  data, _status_code, _headers = get_ttw_campaign_with_http_info(id, opts)
  data
end

#get_ttw_campaign_with_http_info(id, opts = {}) ⇒ Array<(V1EntitiesTtwCampaignResponse, Integer, Hash)>

Gets a TTW campaign for a given company Gets a TTW campaign for a given company

Parameters:

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

    the optional parameters

Returns:



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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/DealMakerAPI/api/campaign_api.rb', line 37

def get_ttw_campaign_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignApi.get_ttw_campaign ...'
  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 CampaignApi.get_ttw_campaign"
  end
  # resource path
  local_var_path = '/ttw/campaigns/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesTtwCampaignResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignApi.get_ttw_campaign",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignApi#get_ttw_campaign\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_ttw_campaigns(company_id, opts = {}) ⇒ V1EntitiesTtwCampaignList

Gets a list TTW campaigns for a given company Gets a list TTW campaigns for a given company

Parameters:

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

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/DealMakerAPI/api/campaign_api.rb', line 90

def get_ttw_campaigns(company_id, opts = {})
  data, _status_code, _headers = get_ttw_campaigns_with_http_info(company_id, opts)
  data
end

#get_ttw_campaigns_with_http_info(company_id, opts = {}) ⇒ Array<(V1EntitiesTtwCampaignList, Integer, Hash)>

Gets a list TTW campaigns for a given company Gets a list TTW campaigns for a given company

Parameters:

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

    the optional parameters

Returns:

  • (Array<(V1EntitiesTtwCampaignList, Integer, Hash)>) —

    V1EntitiesTtwCampaignList data, response status code and response headers



100
101
102
103
104
105
106
107
108
109
110
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
 
# File 'lib/DealMakerAPI/api/campaign_api.rb', line 100

def get_ttw_campaigns_with_http_info(company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignApi.get_ttw_campaigns ...'
  end
  # verify the required parameter 'company_id' is set
  if @api_client.config.client_side_validation && company_id.nil?
    fail ArgumentError, "Missing the required parameter 'company_id' when calling CampaignApi.get_ttw_campaigns"
  end
  # resource path
  local_var_path = '/ttw/companies/{company_id}/campaigns'.sub('{' + 'company_id' + '}', CGI.escape(company_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesTtwCampaignList'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignApi.get_ttw_campaigns",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignApi#get_ttw_campaigns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_ttw_reservation(id, reservation_uuid, opts = {}) ⇒ V1EntitiesTtwReservationGetResponse

Gets User ID for a TTW reservation Gets a TTW reservation

Parameters:

  • id (Integer)
  • reservation_uuid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



154
155
156
157
 
# File 'lib/DealMakerAPI/api/campaign_api.rb', line 154

def get_user_ttw_reservation(id, reservation_uuid, opts = {})
  data, _status_code, _headers = get_user_ttw_reservation_with_http_info(id, reservation_uuid, opts)
  data
end

#get_user_ttw_reservation_with_http_info(id, reservation_uuid, opts = {}) ⇒ Array<(V1EntitiesTtwReservationGetResponse, Integer, Hash)>

Gets User ID for a TTW reservation Gets a TTW reservation

Parameters:

  • id (Integer)
  • reservation_uuid (Integer)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/DealMakerAPI/api/campaign_api.rb', line 165

def get_user_ttw_reservation_with_http_info(id, reservation_uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CampaignApi.get_user_ttw_reservation ...'
  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 CampaignApi.get_user_ttw_reservation"
  end
  # verify the required parameter 'reservation_uuid' is set
  if @api_client.config.client_side_validation && reservation_uuid.nil?
    fail ArgumentError, "Missing the required parameter 'reservation_uuid' when calling CampaignApi.get_user_ttw_reservation"
  end
  # resource path
  local_var_path = '/ttw/campaign/{id}/reservation/{reservation_uuid}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'reservation_uuid' + '}', CGI.escape(reservation_uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'V1EntitiesTtwReservationGetResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"CampaignApi.get_user_ttw_reservation",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CampaignApi#get_user_ttw_reservation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end