class VeloPayments::PayeeInvitationApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/velopayments/api/payee_invitation_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

get_payees_invitation_status_v1(payor_id, opts = {}) click to toggle source

Get Payee Invitation Status <p>Returns a list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p> @param payor_id [String] The account owner Payor ID @param [Hash] opts the optional parameters @return [InvitationStatusResponse]

# File lib/velopayments/api/payee_invitation_api.rb, line 27
def get_payees_invitation_status_v1(payor_id, opts = {})
  data, _status_code, _headers = get_payees_invitation_status_v1_with_http_info(payor_id, opts)
  data
end
get_payees_invitation_status_v1_with_http_info(payor_id, opts = {}) click to toggle source

Get Payee Invitation Status &lt;p&gt;Returns a list of payees associated with a payor, along with invitation status and grace period end date.&lt;/p&gt; &lt;p&gt;Please use V3 instead&lt;/p&gt; @param payor_id [String] The account owner Payor ID @param [Hash] opts the optional parameters @return [Array<(InvitationStatusResponse, Integer, Hash)>] InvitationStatusResponse data, response status code and response headers

# File lib/velopayments/api/payee_invitation_api.rb, line 37
def get_payees_invitation_status_v1_with_http_info(payor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeeInvitationApi.get_payees_invitation_status_v1 ...'
  end
  # verify the required parameter 'payor_id' is set
  if @api_client.config.client_side_validation && payor_id.nil?
    fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.get_payees_invitation_status_v1"
  end
  # resource path
  local_var_path = '/v1/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_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'])

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

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

  # return_type
  return_type = opts[:return_type] || 'InvitationStatusResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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: PayeeInvitationApi#get_payees_invitation_status_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_payees_invitation_status_v2(payor_id, opts = {}) click to toggle source

Get Payee Invitation Status <p>Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.</p> <p>Please use V3 instead</p> @param payor_id [String] The account owner Payor ID @param [Hash] opts the optional parameters @option opts [String] :payee_id The UUID of the payee. @option opts [InvitationStatus] :invitation_status The invitation status of the payees. @option opts [Integer] :page Page number. Default is 1. (default to 1) @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25) @return [PagedPayeeInvitationStatusResponse]

# File lib/velopayments/api/payee_invitation_api.rb, line 93
def get_payees_invitation_status_v2(payor_id, opts = {})
  data, _status_code, _headers = get_payees_invitation_status_v2_with_http_info(payor_id, opts)
  data
end
get_payees_invitation_status_v2_with_http_info(payor_id, opts = {}) click to toggle source

Get Payee Invitation Status &lt;p&gt;Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date.&lt;/p&gt; &lt;p&gt;Please use V3 instead&lt;/p&gt; @param payor_id [String] The account owner Payor ID @param [Hash] opts the optional parameters @option opts [String] :payee_id The UUID of the payee. @option opts [InvitationStatus] :invitation_status The invitation status of the payees. @option opts [Integer] :page Page number. Default is 1. @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. @return [Array<(PagedPayeeInvitationStatusResponse, Integer, Hash)>] PagedPayeeInvitationStatusResponse data, response status code and response headers

# File lib/velopayments/api/payee_invitation_api.rb, line 107
def get_payees_invitation_status_v2_with_http_info(payor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeeInvitationApi.get_payees_invitation_status_v2 ...'
  end
  # verify the required parameter 'payor_id' is set
  if @api_client.config.client_side_validation && payor_id.nil?
    fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.get_payees_invitation_status_v2"
  end
  # resource path
  local_var_path = '/v2/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'payeeId'] = opts[:'payee_id'] if !opts[:'payee_id'].nil?
  query_params[:'invitationStatus'] = opts[:'invitation_status'] if !opts[:'invitation_status'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'PagedPayeeInvitationStatusResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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: PayeeInvitationApi#get_payees_invitation_status_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
get_payees_invitation_status_v3(payor_id, opts = {}) click to toggle source

Get Payee Invitation Status Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date. @param payor_id [String] The account owner Payor ID @param [Hash] opts the optional parameters @option opts [String] :payee_id The UUID of the payee. @option opts [InvitationStatus] :invitation_status The invitation status of the payees. @option opts [Integer] :page Page number. Default is 1. (default to 1) @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25) @return [PagedPayeeInvitationStatusResponse2]

# File lib/velopayments/api/payee_invitation_api.rb, line 167
def get_payees_invitation_status_v3(payor_id, opts = {})
  data, _status_code, _headers = get_payees_invitation_status_v3_with_http_info(payor_id, opts)
  data
end
get_payees_invitation_status_v3_with_http_info(payor_id, opts = {}) click to toggle source

Get Payee Invitation Status Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date. @param payor_id [String] The account owner Payor ID @param [Hash] opts the optional parameters @option opts [String] :payee_id The UUID of the payee. @option opts [InvitationStatus] :invitation_status The invitation status of the payees. @option opts [Integer] :page Page number. Default is 1. @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. @return [Array<(PagedPayeeInvitationStatusResponse2, Integer, Hash)>] PagedPayeeInvitationStatusResponse2 data, response status code and response headers

# File lib/velopayments/api/payee_invitation_api.rb, line 181
def get_payees_invitation_status_v3_with_http_info(payor_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeeInvitationApi.get_payees_invitation_status_v3 ...'
  end
  # verify the required parameter 'payor_id' is set
  if @api_client.config.client_side_validation && payor_id.nil?
    fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.get_payees_invitation_status_v3"
  end
  # resource path
  local_var_path = '/v3/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'payeeId'] = opts[:'payee_id'] if !opts[:'payee_id'].nil?
  query_params[:'invitationStatus'] = opts[:'invitation_status'] if !opts[:'invitation_status'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

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

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

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

  # return_type
  return_type = opts[:return_type] || 'PagedPayeeInvitationStatusResponse2' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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: PayeeInvitationApi#get_payees_invitation_status_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
query_batch_status_v2(batch_id, opts = {}) click to toggle source

Query Batch Status <p>Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).</p> <p>Please use V3 instead</p> @param batch_id [String] Batch Id @param [Hash] opts the optional parameters @return [QueryBatchResponse]

# File lib/velopayments/api/payee_invitation_api.rb, line 237
def query_batch_status_v2(batch_id, opts = {})
  data, _status_code, _headers = query_batch_status_v2_with_http_info(batch_id, opts)
  data
end
query_batch_status_v2_with_http_info(batch_id, opts = {}) click to toggle source

Query Batch Status &lt;p&gt;Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).&lt;/p&gt; &lt;p&gt;Please use V3 instead&lt;/p&gt; @param batch_id [String] Batch Id @param [Hash] opts the optional parameters @return [Array<(QueryBatchResponse, Integer, Hash)>] QueryBatchResponse data, response status code and response headers

# File lib/velopayments/api/payee_invitation_api.rb, line 247
def query_batch_status_v2_with_http_info(batch_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeeInvitationApi.query_batch_status_v2 ...'
  end
  # verify the required parameter 'batch_id' is set
  if @api_client.config.client_side_validation && batch_id.nil?
    fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.query_batch_status_v2"
  end
  # resource path
  local_var_path = '/v2/payees/batch/{batchId}'.sub('{' + 'batchId' + '}', CGI.escape(batch_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'])

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

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

  # return_type
  return_type = opts[:return_type] || 'QueryBatchResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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: PayeeInvitationApi#query_batch_status_v2\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
query_batch_status_v3(batch_id, opts = {}) click to toggle source

Query Batch Status Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ). @param batch_id [String] Batch Id @param [Hash] opts the optional parameters @return [QueryBatchResponse2]

# File lib/velopayments/api/payee_invitation_api.rb, line 299
def query_batch_status_v3(batch_id, opts = {})
  data, _status_code, _headers = query_batch_status_v3_with_http_info(batch_id, opts)
  data
end
query_batch_status_v3_with_http_info(batch_id, opts = {}) click to toggle source

Query Batch Status Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ). @param batch_id [String] Batch Id @param [Hash] opts the optional parameters @return [Array<(QueryBatchResponse2, Integer, Hash)>] QueryBatchResponse2 data, response status code and response headers

# File lib/velopayments/api/payee_invitation_api.rb, line 309
def query_batch_status_v3_with_http_info(batch_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeeInvitationApi.query_batch_status_v3 ...'
  end
  # verify the required parameter 'batch_id' is set
  if @api_client.config.client_side_validation && batch_id.nil?
    fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.query_batch_status_v3"
  end
  # resource path
  local_var_path = '/v3/payees/batch/{batchId}'.sub('{' + 'batchId' + '}', CGI.escape(batch_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'])

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

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

  # return_type
  return_type = opts[:return_type] || 'QueryBatchResponse2' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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: PayeeInvitationApi#query_batch_status_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
resend_payee_invite_v1(payee_id, invite_payee_request, opts = {}) click to toggle source

Resend Payee Invite <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p> <p>Deprecated. Please use v3 instead</p> @param payee_id [String] The UUID of the payee. @param invite_payee_request [InvitePayeeRequest] Provide Payor Id in body of request @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/payee_invitation_api.rb, line 362
def resend_payee_invite_v1(payee_id, invite_payee_request, opts = {})
  resend_payee_invite_v1_with_http_info(payee_id, invite_payee_request, opts)
  nil
end
resend_payee_invite_v1_with_http_info(payee_id, invite_payee_request, opts = {}) click to toggle source

Resend Payee Invite &lt;p&gt;Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined&lt;/p&gt; &lt;p&gt;Any previous invites to the payee by this Payor will be invalidated&lt;/p&gt; &lt;p&gt;Deprecated. Please use v3 instead&lt;/p&gt; @param payee_id [String] The UUID of the payee. @param invite_payee_request [InvitePayeeRequest] Provide Payor Id in body of request @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/payee_invitation_api.rb, line 373
def resend_payee_invite_v1_with_http_info(payee_id, invite_payee_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeeInvitationApi.resend_payee_invite_v1 ...'
  end
  # verify the required parameter 'payee_id' is set
  if @api_client.config.client_side_validation && payee_id.nil?
    fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeeInvitationApi.resend_payee_invite_v1"
  end
  # verify the required parameter 'invite_payee_request' is set
  if @api_client.config.client_side_validation && invite_payee_request.nil?
    fail ArgumentError, "Missing the required parameter 'invite_payee_request' when calling PayeeInvitationApi.resend_payee_invite_v1"
  end
  # resource path
  local_var_path = '/v1/payees/{payeeId}/invite'.sub('{' + 'payeeId' + '}', CGI.escape(payee_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'])
  # 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(invite_payee_request) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayeeInvitationApi#resend_payee_invite_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
resend_payee_invite_v3(payee_id, invite_payee_request2, opts = {}) click to toggle source

Resend Payee Invite <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p> @param payee_id [String] The UUID of the payee. @param invite_payee_request2 [InvitePayeeRequest2] Provide Payor Id in body of request @param [Hash] opts the optional parameters @return [nil]

# File lib/velopayments/api/payee_invitation_api.rb, line 432
def resend_payee_invite_v3(payee_id, invite_payee_request2, opts = {})
  resend_payee_invite_v3_with_http_info(payee_id, invite_payee_request2, opts)
  nil
end
resend_payee_invite_v3_with_http_info(payee_id, invite_payee_request2, opts = {}) click to toggle source

Resend Payee Invite &lt;p&gt;Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined&lt;/p&gt; &lt;p&gt;Any previous invites to the payee by this Payor will be invalidated&lt;/p&gt; @param payee_id [String] The UUID of the payee. @param invite_payee_request2 [InvitePayeeRequest2] Provide Payor Id in body of request @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/velopayments/api/payee_invitation_api.rb, line 443
def resend_payee_invite_v3_with_http_info(payee_id, invite_payee_request2, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeeInvitationApi.resend_payee_invite_v3 ...'
  end
  # verify the required parameter 'payee_id' is set
  if @api_client.config.client_side_validation && payee_id.nil?
    fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeeInvitationApi.resend_payee_invite_v3"
  end
  # verify the required parameter 'invite_payee_request2' is set
  if @api_client.config.client_side_validation && invite_payee_request2.nil?
    fail ArgumentError, "Missing the required parameter 'invite_payee_request2' when calling PayeeInvitationApi.resend_payee_invite_v3"
  end
  # resource path
  local_var_path = '/v3/payees/{payeeId}/invite'.sub('{' + 'payeeId' + '}', CGI.escape(payee_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'])
  # 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(invite_payee_request2) 

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayeeInvitationApi#resend_payee_invite_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
v2_create_payee(opts = {}) click to toggle source

Initiate Payee Creation Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch). @param [Hash] opts the optional parameters @option opts [CreatePayeesRequest] :create_payees_request Post payees to create. @return [CreatePayeesCSVResponse]

# File lib/velopayments/api/payee_invitation_api.rb, line 501
def v2_create_payee(opts = {})
  data, _status_code, _headers = v2_create_payee_with_http_info(opts)
  data
end
v2_create_payee_with_http_info(opts = {}) click to toggle source

Initiate Payee Creation Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch). @param [Hash] opts the optional parameters @option opts [CreatePayeesRequest] :create_payees_request Post payees to create. @return [Array<(CreatePayeesCSVResponse, Integer, Hash)>] CreatePayeesCSVResponse data, response status code and response headers

# File lib/velopayments/api/payee_invitation_api.rb, line 511
def v2_create_payee_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeeInvitationApi.v2_create_payee ...'
  end
  # resource path
  local_var_path = '/v2/payees'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

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

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

  # return_type
  return_type = opts[:return_type] || 'CreatePayeesCSVResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayeeInvitationApi#v2_create_payee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
v3_create_payee(opts = {}) click to toggle source

Initiate Payee Creation Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch). @param [Hash] opts the optional parameters @option opts [CreatePayeesRequest2] :create_payees_request2 Post payees to create. @return [CreatePayeesCSVResponse2]

# File lib/velopayments/api/payee_invitation_api.rb, line 561
def v3_create_payee(opts = {})
  data, _status_code, _headers = v3_create_payee_with_http_info(opts)
  data
end
v3_create_payee_with_http_info(opts = {}) click to toggle source

Initiate Payee Creation Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch). @param [Hash] opts the optional parameters @option opts [CreatePayeesRequest2] :create_payees_request2 Post payees to create. @return [Array<(CreatePayeesCSVResponse2, Integer, Hash)>] CreatePayeesCSVResponse2 data, response status code and response headers

# File lib/velopayments/api/payee_invitation_api.rb, line 571
def v3_create_payee_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PayeeInvitationApi.v3_create_payee ...'
  end
  # resource path
  local_var_path = '/v3/payees'

  # 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])

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

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

  # return_type
  return_type = opts[:return_type] || 'CreatePayeesCSVResponse2' 

  # auth_names
  auth_names = opts[:auth_names] || ['OAuth2']

  new_options = opts.merge(
    :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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PayeeInvitationApi#v3_create_payee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end