Class: ThePlaidApi::TransferPlatformOriginatorCreateRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/the_plaid_api/models/transfer_platform_originator_create_request.rb

Overview

Defines the request schema for ‘/transfer/platform/originator/create`

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(originator_client_id:, tos_acceptance_metadata:, originator_reviewed_at:, client_id: SKIP, secret: SKIP, webhook: SKIP, additional_properties: nil) ⇒ TransferPlatformOriginatorCreateRequest

Returns a new instance of TransferPlatformOriginatorCreateRequest.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/the_plaid_api/models/transfer_platform_originator_create_request.rb', line 68

def initialize(originator_client_id:, tos_acceptance_metadata:,
               originator_reviewed_at:, client_id: SKIP, secret: SKIP,
               webhook: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @client_id = client_id unless client_id == SKIP
  @secret = secret unless secret == SKIP
  @originator_client_id = originator_client_id
  @tos_acceptance_metadata = tos_acceptance_metadata
  @originator_reviewed_at = originator_reviewed_at
  @webhook = webhook unless webhook == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#client_id ⇒ String

Your Plaid API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.

Returns:

  • (String) 


17
18
19
 
# File 'lib/the_plaid_api/models/transfer_platform_originator_create_request.rb', line 17

def client_id
  @client_id
end

#originator_client_id ⇒ String

The client ID of the originator

Returns:

  • (String) 


26
27
28
 
# File 'lib/the_plaid_api/models/transfer_platform_originator_create_request.rb', line 26

def originator_client_id
  @originator_client_id
end

#originator_reviewed_at ⇒ DateTime

ISO8601 timestamp indicating the most recent time the platform collected onboarding data from the originator

Returns:

  • (DateTime) 


35
36
37
 
# File 'lib/the_plaid_api/models/transfer_platform_originator_create_request.rb', line 35

def originator_reviewed_at
  @originator_reviewed_at
end

#secret ⇒ String

Your Plaid API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

Returns:

  • (String) 


22
23
24
 
# File 'lib/the_plaid_api/models/transfer_platform_originator_create_request.rb', line 22

def secret
  @secret
end

#tos_acceptance_metadata ⇒ TosAcceptanceMetadata

Metadata related to the acceptance of Terms of Service

Returns:



30
31
32
 
# File 'lib/the_plaid_api/models/transfer_platform_originator_create_request.rb', line 30

def tos_acceptance_metadata
  @tos_acceptance_metadata
end

#webhook ⇒ String

The webhook URL to which a ‘PLATFORM_ONBOARDING_UPDATE` webhook should be sent.

Returns:

  • (String) 


40
41
42
 
# File 'lib/the_plaid_api/models/transfer_platform_originator_create_request.rb', line 40

def webhook
  @webhook
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



84
85
86
87
88
89
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
 
# File 'lib/the_plaid_api/models/transfer_platform_originator_create_request.rb', line 84

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  originator_client_id =
    hash.key?('originator_client_id') ? hash['originator_client_id'] : nil
  tos_acceptance_metadata = TosAcceptanceMetadata.from_hash(hash['tos_acceptance_metadata']) if
    hash['tos_acceptance_metadata']
  originator_reviewed_at = if hash.key?('originator_reviewed_at')
                             (DateTimeHelper.from_rfc3339(hash['originator_reviewed_at']) if hash['originator_reviewed_at'])
                           end
  client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
  secret = hash.key?('secret') ? hash['secret'] : SKIP
  webhook = hash.key?('webhook') ? hash['webhook'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  TransferPlatformOriginatorCreateRequest.new(originator_client_id: originator_client_id,
                                              tos_acceptance_metadata: tos_acceptance_metadata,
                                              originator_reviewed_at: originator_reviewed_at,
                                              client_id: client_id,
                                              secret: secret,
                                              webhook: webhook,
                                              additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/the_plaid_api/models/transfer_platform_originator_create_request.rb', line 43

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['client_id'] = 'client_id'
  @_hash['secret'] = 'secret'
  @_hash['originator_client_id'] = 'originator_client_id'
  @_hash['tos_acceptance_metadata'] = 'tos_acceptance_metadata'
  @_hash['originator_reviewed_at'] = 'originator_reviewed_at'
  @_hash['webhook'] = 'webhook'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



64
65
66
 
# File 'lib/the_plaid_api/models/transfer_platform_originator_create_request.rb', line 64

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



55
56
57
58
59
60
61
 
# File 'lib/the_plaid_api/models/transfer_platform_originator_create_request.rb', line 55

def self.optionals
  %w[
    client_id
    secret
    webhook
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



130
131
132
133
134
135
136
137
 
# File 'lib/the_plaid_api/models/transfer_platform_originator_create_request.rb', line 130

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} client_id: #{@client_id.inspect}, secret: #{@secret.inspect},"\
  " originator_client_id: #{@originator_client_id.inspect}, tos_acceptance_metadata:"\
  " #{@tos_acceptance_metadata.inspect}, originator_reviewed_at:"\
  " #{@originator_reviewed_at.inspect}, webhook: #{@webhook.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_custom_originator_reviewed_at ⇒ Object 



116
117
118
 
# File 'lib/the_plaid_api/models/transfer_platform_originator_create_request.rb', line 116

def to_custom_originator_reviewed_at
  DateTimeHelper.to_rfc3339(originator_reviewed_at)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



121
122
123
124
125
126
127
 
# File 'lib/the_plaid_api/models/transfer_platform_originator_create_request.rb', line 121

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} client_id: #{@client_id}, secret: #{@secret}, originator_client_id:"\
  " #{@originator_client_id}, tos_acceptance_metadata: #{@tos_acceptance_metadata},"\
  " originator_reviewed_at: #{@originator_reviewed_at}, webhook: #{@webhook},"\
  " additional_properties: #{@additional_properties}>"
end