Class: Frame::CustomerIdentityVerification

Inherits:
APIResource show all
Extended by:
APIOperations::Create, APIOperations::List
Defined in:
lib/frame/resources/customer_identity_verification.rb

Constant Summary collapse

OBJECT_NAME = 
"customer_identity_verification"
DEPRECATED_METHODS =

Methods deprecated for removal at v2. list has no backing route (the monolith exposes customer_identity_verifications only as [:create, :show]; there is no index action / public list endpoint), so it is a no-op that 404s — kept only so existing callers don't NoMethodError before v2.

%i[list].freeze

Instance Attribute Summary

Attributes inherited from FrameObject

#id, #original_values

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::Create

create

Methods included from APIOperations::List

list

Methods inherited from APIResource

class_name, #refresh, resource_url, #resource_url

Methods included from APIOperations::Request

included

Methods inherited from FrameObject

#[], #[]=, construct_from, #each, #initialize, #initialize_from, #inspect, #keys, #serialize_params, #to_hash, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Frame::FrameObject

Class Method Details

.create(params = {}, opts = {}) ⇒ Object 



20
21
22
23
24
25
26
27
 
# File 'lib/frame/resources/customer_identity_verification.rb', line 20

def self.create(params = {}, opts = {})
  request_object(
    :post,
    "/v1/customer_identity_verifications",
    params,
    opts
  )
end

.create_for_customer(customer_id, opts = {}) ⇒ Object

Create an identity verification for an existing customer. POST /v1/customer_identity_verifications/customer_id (monolith customer_identity_verifications#create_from_customer). The documented route takes only the customer_id path param — no request body — so no params argument is exposed.



34
35
36
37
38
39
40
41
42
 
# File 'lib/frame/resources/customer_identity_verification.rb', line 34

def self.create_for_customer(customer_id, opts = {})
  customer_id = Util.normalize_id(customer_id)
  request_object(
    :post,
    "/v1/customer_identity_verifications/#{CGI.escape(customer_id)}",
    {},
    opts
  )
end

.list(params = {}, opts = {}) ⇒ Object

Deprecated.

No public list endpoint exists for this resource; this 404s. Removed at v2. See DEPRECATED_METHODS.



46
47
48
49
50
51
52
53
 
# File 'lib/frame/resources/customer_identity_verification.rb', line 46

def self.list(params = {}, opts = {})
  request_object(
    :get,
    "/v1/customer_identity_verifications",
    params,
    opts
  )
end

.object_name ⇒ Object 



10
11
12
 
# File 'lib/frame/resources/customer_identity_verification.rb', line 10

def self.object_name
  OBJECT_NAME
end

.retrieve(id, opts = {}) ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'lib/frame/resources/customer_identity_verification.rb', line 55

def self.retrieve(id, opts = {})
  id = Util.normalize_id(id)
  request_object(
    :get,
    "/v1/customer_identity_verifications/#{CGI.escape(id)}",
    {},
    opts
  )
end

.upload_documents(id, params = {}, opts = {}) ⇒ Object 



74
75
76
77
78
79
80
81
 
# File 'lib/frame/resources/customer_identity_verification.rb', line 74

def self.upload_documents(id, params = {}, opts = {})
  request_object(
    :post,
    "/v1/customer_identity_verifications/#{CGI.escape(id)}/upload_documents",
    params,
    opts
  )
end

Instance Method Details

#upload_documents(params = {}, opts = {}) ⇒ Object 



65
66
67
68
69
70
71
72
 
# File 'lib/frame/resources/customer_identity_verification.rb', line 65

def upload_documents(params = {}, opts = {})
  request_object(
    :post,
    "/v1/customer_identity_verifications/#{CGI.escape(self["id"])}/upload_documents",
    params,
    opts
  )
end