Class: ClickSendClient::PostPostcardApi

Inherits:
Object
  • Object
show all
Defined in:
lib/clicksend_client/api/post_postcard_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PostPostcardApi

Returns a new instance of PostPostcardApi.



19
20
21
 
# File 'lib/clicksend_client/api/post_postcard_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/clicksend_client/api/post_postcard_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#post_postcards_history_export_get(filename, opts = {}) ⇒ String

Export postcard history to a CSV file Export postcard history to a CSV file

Parameters:

  • filename —

    Filename to export to

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

    the optional parameters

Returns:

  • (String) 


27
28
29
30
 
# File 'lib/clicksend_client/api/post_postcard_api.rb', line 27

def post_postcards_history_export_get(filename, opts = {})
  data, _status_code, _headers = post_postcards_history_export_get_with_http_info(filename, opts)
  data
end

#post_postcards_history_export_get_with_http_info(filename, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Export postcard history to a CSV file Export postcard history to a CSV file

Parameters:

  • filename —

    Filename to export to

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

    the optional parameters

Returns:

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

    String 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
70
71
72
73
74
75
76
 
# File 'lib/clicksend_client/api/post_postcard_api.rb', line 37

def post_postcards_history_export_get_with_http_info(filename, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostPostcardApi.post_postcards_history_export_get ...'
  end
  # verify the required parameter 'filename' is set
  if @api_client.config.client_side_validation && filename.nil?
    fail ArgumentError, "Missing the required parameter 'filename' when calling PostPostcardApi.post_postcards_history_export_get"
  end
  # resource path
  local_var_path = '/post/postcards/history/export'

  # query parameters
  query_params = {}
  query_params[:'filename'] = filename

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

  # form parameters
  form_params = {}

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

#post_postcards_history_get(opts = {}) ⇒ String

Retrieve the history of postcards sent or scheduled Retrieve the history of postcards sent or scheduled

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number (default to 1)

  • :limit (Integer) —

    Number of records per page (default to 10)

Returns:

  • (String) 


83
84
85
86
 
# File 'lib/clicksend_client/api/post_postcard_api.rb', line 83

def post_postcards_history_get(opts = {})
  data, _status_code, _headers = post_postcards_history_get_with_http_info(opts)
  data
end

#post_postcards_history_get_with_http_info(opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Retrieve the history of postcards sent or scheduled Retrieve the history of postcards sent or scheduled

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page number

  • :limit (Integer) —

    Number of records per page

Returns:

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

    String data, response status code and response headers



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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/clicksend_client/api/post_postcard_api.rb', line 94

def post_postcards_history_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostPostcardApi.post_postcards_history_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PostPostcardApi.post_postcards_history_get, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling PostPostcardApi.post_postcards_history_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/post/postcards/history'

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

  # form parameters
  form_params = {}

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

#post_postcards_price_post(post_postcards, opts = {}) ⇒ String

Calculate price for sending one or more postcards Calculate price for sending one or more postcards

Parameters:

  • post_postcards —

    PostPostcard model

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

    the optional parameters

Returns:

  • (String) 


144
145
146
147
 
# File 'lib/clicksend_client/api/post_postcard_api.rb', line 144

def post_postcards_price_post(post_postcards, opts = {})
  data, _status_code, _headers = post_postcards_price_post_with_http_info(post_postcards, opts)
  data
end

#post_postcards_price_post_with_http_info(post_postcards, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Calculate price for sending one or more postcards Calculate price for sending one or more postcards

Parameters:

  • post_postcards —

    PostPostcard model

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



154
155
156
157
158
159
160
161
162
163
164
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
 
# File 'lib/clicksend_client/api/post_postcard_api.rb', line 154

def post_postcards_price_post_with_http_info(post_postcards, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostPostcardApi.post_postcards_price_post ...'
  end
  # verify the required parameter 'post_postcards' is set
  if @api_client.config.client_side_validation && post_postcards.nil?
    fail ArgumentError, "Missing the required parameter 'post_postcards' when calling PostPostcardApi.post_postcards_price_post"
  end
  # resource path
  local_var_path = '/post/postcards/price'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(post_postcards)
  auth_names = ['BasicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PostPostcardApi#post_postcards_price_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_postcards_send_post(post_postcards, opts = {}) ⇒ String

Send one or more postcards Send one or more postcards

Parameters:

  • post_postcards —

    PostPostcard model

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

    the optional parameters

Returns:

  • (String) 


198
199
200
201
 
# File 'lib/clicksend_client/api/post_postcard_api.rb', line 198

def post_postcards_send_post(post_postcards, opts = {})
  data, _status_code, _headers = post_postcards_send_post_with_http_info(post_postcards, opts)
  data
end

#post_postcards_send_post_with_http_info(post_postcards, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Send one or more postcards Send one or more postcards

Parameters:

  • post_postcards —

    PostPostcard model

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/clicksend_client/api/post_postcard_api.rb', line 208

def post_postcards_send_post_with_http_info(post_postcards, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PostPostcardApi.post_postcards_send_post ...'
  end
  # verify the required parameter 'post_postcards' is set
  if @api_client.config.client_side_validation && post_postcards.nil?
    fail ArgumentError, "Missing the required parameter 'post_postcards' when calling PostPostcardApi.post_postcards_send_post"
  end
  # resource path
  local_var_path = '/post/postcards/send'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(post_postcards)
  auth_names = ['BasicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PostPostcardApi#post_postcards_send_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end