Class: Increase::Resources::ProofOfAuthorizationRequestSubmissions

Inherits:
Object
  • Object
show all
Defined in:
lib/increase/resources/proof_of_authorization_request_submissions.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ ProofOfAuthorizationRequestSubmissions

Returns a new instance of ProofOfAuthorizationRequestSubmissions.



6
7
8
 
# File 'lib/increase/resources/proof_of_authorization_request_submissions.rb', line 6

def initialize(client:)
  @client = client
end

Instance Method Details

#create(params = {}, opts = {}) ⇒ Increase::Models::ProofOfAuthorizationRequestSubmission

Submit Proof of Authorization

Parameters:

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

    Attributes to send in this request.

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

    Options to specify HTTP behaviour for this request.

Options Hash (params):

  • :authorization_terms (String) —

    Terms of authorization.

  • :authorized_at (String) —

    Time of authorization.

  • :authorizer_email (String) —

    Email of the authorizer.

  • :authorizer_name (String) —

    Name of the authorizer.

  • :customer_has_been_offboarded (Boolean) —

    Whether the customer has been offboarded or suspended.

  • :proof_of_authorization_request_id (String) —

    ID of the proof of authorization request.

  • :validated_account_ownership_via_credential (Boolean) —

    Whether the account ownership was validated via credential (e.g. Plaid).

  • :validated_account_ownership_with_account_statement (Boolean) —

    Whether the account ownership was validated with an account statement.

  • :validated_account_ownership_with_microdeposit (Boolean) —

    Whether the account ownership was validated with a microdeposit.

  • :authorizer_company (String) —

    Company of the authorizer.

  • :authorizer_ip_address (String) —

    IP address of the authorizer.

Returns:



28
29
30
31
32
33
34
35
 
# File 'lib/increase/resources/proof_of_authorization_request_submissions.rb', line 28

def create(params = {}, opts = {})
  req = {}
  req[:method] = :post
  req[:path] = "/proof_of_authorization_request_submissions"
  req[:body] = params
  req[:model] = Increase::Models::ProofOfAuthorizationRequestSubmission
  @client.request(req, opts)
end

#list(params = {}, opts = {}) ⇒ Increase::Page<Increase::Models::ProofOfAuthorizationRequestSubmission>

List Proof of Authorization Request Submissions

Parameters:

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

    Attributes to send in this request.

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

    Options to specify HTTP behaviour for this request.

Options Hash (params):

  • :cursor (String) —

    Return the page of entries after this one.

  • :idempotency_key (String) —

    Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

  • :limit (Integer) —

    Limit the size of the list that is returned. The default (and maximum) is 100 objects.

  • :proof_of_authorization_request_id (String) —

    ID of the proof of authorization request.

Returns:



66
67
68
69
70
71
72
73
74
 
# File 'lib/increase/resources/proof_of_authorization_request_submissions.rb', line 66

def list(params = {}, opts = {})
  req = {}
  req[:method] = :get
  req[:path] = "/proof_of_authorization_request_submissions"
  req[:query] = params
  req[:page] = Increase::Page
  req[:model] = Increase::Models::ProofOfAuthorizationRequestSubmission
  @client.request(req, opts)
end

#retrieve(proof_of_authorization_request_submission_id, opts = {}) ⇒ Increase::Models::ProofOfAuthorizationRequestSubmission

Retrieve a Proof of Authorization Request Submission

Parameters:

  • proof_of_authorization_request_submission_id (String) —

    The identifier of the Proof of Authorization Request Submission.

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

    Options to specify HTTP behaviour for this request.

Returns:



43
44
45
46
47
48
49
 
# File 'lib/increase/resources/proof_of_authorization_request_submissions.rb', line 43

def retrieve(proof_of_authorization_request_submission_id, opts = {})
  req = {}
  req[:method] = :get
  req[:path] = "/proof_of_authorization_request_submissions/#{proof_of_authorization_request_submission_id}"
  req[:model] = Increase::Models::ProofOfAuthorizationRequestSubmission
  @client.request(req, opts)
end