Class: Brevo::PaymentsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo/api/payments_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PaymentsApi

Returns a new instance of PaymentsApi.



19
20
21
 
# File 'lib/brevo/api/payments_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/brevo/api/payments_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_payment_request(create_payment_rquest, opts = {}) ⇒ CreatePaymentResponse

Create a payment request

Parameters:

  • create_payment_rquest —

    Create a payment request

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

    the optional parameters

Returns:



36
37
38
39
 
# File 'lib/brevo/api/payments_api.rb', line 36

def create_payment_request(create_payment_rquest, opts = {})
  data, _status_code, _headers = create_payment_request_with_http_info(create_payment_rquest, opts)
  data
end

#create_payment_request_with_http_info(create_payment_rquest, opts = {}) ⇒ Array<(CreatePaymentResponse, Fixnum, Hash)>

Create a payment request

Parameters:

  • create_payment_rquest —

    Create a payment request

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

    the optional parameters

Returns:

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

    CreatePaymentResponse data, response status code and response headers



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/brevo/api/payments_api.rb', line 45

def create_payment_request_with_http_info(create_payment_rquest, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentsApi.create_payment_request ...'
  end
  # verify the required parameter 'create_payment_rquest' is set
  if @api_client.config.client_side_validation && create_payment_rquest.nil?
    fail ArgumentError, "Missing the required parameter 'create_payment_rquest' when calling PaymentsApi.create_payment_request"
  end
  # resource path
  local_var_path = '/payments/requests'

  # 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(create_payment_rquest)
  auth_names = ['api-key', 'partner-key']
  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 => 'CreatePaymentResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentsApi#create_payment_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_payment_request(id, opts = {}) ⇒ nil

Delete a payment request.

Parameters:

  • id —

    ID of the payment request.

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

    the optional parameters

Returns:

  • (nil) 


88
89
90
91
 
# File 'lib/brevo/api/payments_api.rb', line 88

def delete_payment_request(id, opts = {})
  delete_payment_request_with_http_info(id, opts)
  nil
end

#delete_payment_request_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a payment request.

Parameters:

  • id —

    ID of the payment request.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/brevo/api/payments_api.rb', line 97

def delete_payment_request_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentsApi.delete_payment_request ...'
  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 PaymentsApi.delete_payment_request"
  end
  # resource path
  local_var_path = '/payments/requests/{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'])
  # 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 = ['api-key', 'partner-key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentsApi#delete_payment_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payment_request(id, opts = {}) ⇒ GetPaymentRequest

Get payment request details

Parameters:

  • id —

    Id of the payment Request

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

    the optional parameters

Returns:



139
140
141
142
 
# File 'lib/brevo/api/payments_api.rb', line 139

def get_payment_request(id, opts = {})
  data, _status_code, _headers = get_payment_request_with_http_info(id, opts)
  data
end

#get_payment_request_with_http_info(id, opts = {}) ⇒ Array<(GetPaymentRequest, Fixnum, Hash)>

Get payment request details

Parameters:

  • id —

    Id of the payment Request

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

    the optional parameters

Returns:

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

    GetPaymentRequest data, response status code and response headers



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
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/brevo/api/payments_api.rb', line 148

def get_payment_request_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentsApi.get_payment_request ...'
  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 PaymentsApi.get_payment_request"
  end
  # resource path
  local_var_path = '/payments/requests/{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'])
  # 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 = ['api-key', 'partner-key']
  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 => 'GetPaymentRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentsApi#get_payment_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#setUserAgent(user_agent) ⇒ Object

default will still remain Swagger-Codegen/#VERSION/ruby



25
26
27
28
29
30
 
# File 'lib/brevo/api/payments_api.rb', line 25

def setUserAgent(user_agent)
  @user_agent = user_agent
  if user_agent.is_a?(String) && user_agent.downcase.start_with?('brevo_')
    @api_client.default_headers['User-Agent'] = @user_agent
  end
end