Class: ClickSendClient::DeliveryIssuesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DeliveryIssuesApi

Returns a new instance of DeliveryIssuesApi.



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

def api_client
  @api_client
end

Instance Method Details

#delivery_issues_get(opts = {}) ⇒ String

Get all delivery issues Get all delivery issues

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) 


28
29
30
31
 
# File 'lib/clicksend_client/api/delivery_issues_api.rb', line 28

def delivery_issues_get(opts = {})
  data, _status_code, _headers = delivery_issues_get_with_http_info(opts)
  data
end

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

Get all delivery issues Get all delivery issues

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



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/clicksend_client/api/delivery_issues_api.rb', line 39

def delivery_issues_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryIssuesApi.delivery_issues_get ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling DeliveryIssuesApi.delivery_issues_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 DeliveryIssuesApi.delivery_issues_get, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/delivery-issues'

  # 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: DeliveryIssuesApi#delivery_issues_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delivery_issues_post(delivery_issue, opts = {}) ⇒ String

Create delivery Issue Create delivery Issue

Parameters:

  • delivery_issue —

    DeliveryIssue model

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

    the optional parameters

Returns:

  • (String) 


89
90
91
92
 
# File 'lib/clicksend_client/api/delivery_issues_api.rb', line 89

def delivery_issues_post(delivery_issue, opts = {})
  data, _status_code, _headers = delivery_issues_post_with_http_info(delivery_issue, opts)
  data
end

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

Create delivery Issue Create delivery Issue

Parameters:

  • delivery_issue —

    DeliveryIssue model

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
 
# File 'lib/clicksend_client/api/delivery_issues_api.rb', line 99

def delivery_issues_post_with_http_info(delivery_issue, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DeliveryIssuesApi.delivery_issues_post ...'
  end
  # verify the required parameter 'delivery_issue' is set
  if @api_client.config.client_side_validation && delivery_issue.nil?
    fail ArgumentError, "Missing the required parameter 'delivery_issue' when calling DeliveryIssuesApi.delivery_issues_post"
  end
  # resource path
  local_var_path = '/delivery-issues'

  # 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(delivery_issue)
  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: DeliveryIssuesApi#delivery_issues_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end