Class: DevDraftAI::PaymentLinksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/devdraft/api/payment_links_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PaymentLinksApi

Returns a new instance of PaymentLinksApi.



16
17
18
 
# File 'lib/devdraft/api/payment_links_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/devdraft/api/payment_links_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

Create a new payment link Creates a new payment link with the provided details. Supports both simple one-time payments and complex product bundles.

Parameters:

  • body —

    Payment link creation data

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

    the optional parameters

Returns:

  • (nil) 


24
25
26
27
 
# File 'lib/devdraft/api/payment_links_api.rb', line 24

def payment_links_controller_create(body, opts = {})
  payment_links_controller_create_with_http_info(body, opts)
  nil
end

#payment_links_controller_create_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Create a new payment link Creates a new payment link with the provided details. Supports both simple one-time payments and complex product bundles.

Parameters:

  • body —

    Payment link creation data

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



34
35
36
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
 
# File 'lib/devdraft/api/payment_links_api.rb', line 34

def payment_links_controller_create_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentLinksApi.payment_links_controller_create ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling PaymentLinksApi.payment_links_controller_create"
  end
  # resource path
  local_var_path = '/api/v0/payment-links'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['x-client-key', 'x-client-secret']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentLinksApi#payment_links_controller_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_links_controller_find_all(opts = {}) ⇒ nil

Get all payment links

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :skip (String) —

    Number of records to skip (must be non-negative)

  • :take (String) —

    Number of records to take (must be positive)

Returns:

  • (nil) 


80
81
82
83
 
# File 'lib/devdraft/api/payment_links_api.rb', line 80

def payment_links_controller_find_all(opts = {})
  payment_links_controller_find_all_with_http_info(opts)
  nil
end

#payment_links_controller_find_all_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get all payment links

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :skip (String) —

    Number of records to skip (must be non-negative)

  • :take (String) —

    Number of records to take (must be positive)

Returns:

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

    nil, response status code and response headers



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
122
123
124
125
126
 
# File 'lib/devdraft/api/payment_links_api.rb', line 90

def payment_links_controller_find_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentLinksApi.payment_links_controller_find_all ...'
  end
  # resource path
  local_var_path = '/api/v0/payment-links'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'skip'] = opts[:'skip'] if !opts[:'skip'].nil?
  query_params[:'take'] = opts[:'take'] if !opts[:'take'].nil?

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['x-client-key', 'x-client-secret']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentLinksApi#payment_links_controller_find_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a payment link by ID

Parameters:

  • id —

    Payment Link ID

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

    the optional parameters

Returns:

  • (nil) 


131
132
133
134
 
# File 'lib/devdraft/api/payment_links_api.rb', line 131

def payment_links_controller_find_one(id, opts = {})
  payment_links_controller_find_one_with_http_info(id, opts)
  nil
end

#payment_links_controller_find_one_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get a payment link by ID

Parameters:

  • id —

    Payment Link ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
176
177
178
 
# File 'lib/devdraft/api/payment_links_api.rb', line 140

def payment_links_controller_find_one_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentLinksApi.payment_links_controller_find_one ...'
  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 PaymentLinksApi.payment_links_controller_find_one"
  end
  # resource path
  local_var_path = '/api/v0/payment-links/{id}'.sub('{' + 'id' + '}', id.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['x-client-key', 'x-client-secret']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentLinksApi#payment_links_controller_find_one\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#payment_links_controller_update(body, id, opts = {}) ⇒ nil

Update a payment link

Parameters:

  • body
  • id —

    Payment Link ID

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

    the optional parameters

Returns:

  • (nil) 


184
185
186
187
 
# File 'lib/devdraft/api/payment_links_api.rb', line 184

def payment_links_controller_update(body, id, opts = {})
  payment_links_controller_update_with_http_info(body, id, opts)
  nil
end

#payment_links_controller_update_with_http_info(body, id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Update a payment link

Parameters:

  • body
  • id —

    Payment Link ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



194
195
196
197
198
199
200
201
202
203
204
205
206
207
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
 
# File 'lib/devdraft/api/payment_links_api.rb', line 194

def payment_links_controller_update_with_http_info(body, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PaymentLinksApi.payment_links_controller_update ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling PaymentLinksApi.payment_links_controller_update"
  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 PaymentLinksApi.payment_links_controller_update"
  end
  # resource path
  local_var_path = '/api/v0/payment-links/{id}'.sub('{' + 'id' + '}', id.to_s)

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

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || ['x-client-key', 'x-client-secret']
  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 => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PaymentLinksApi#payment_links_controller_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end