class Plaid::TransactionsSyncRequest
TransactionsSyncRequest
defines the request schema for ‘/transactions/sync`
Attributes
The access token associated with the Item
data is being requested for.
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.
The number of transaction updates to fetch.
The cursor value represents the last update requested. Providing it will cause the response to only return changes after this update. If omitted, the entire history of updates will be returned, starting with the first-added transactions on the Item
. The cursor also accepts the special value of ‘"now"`, which can be used to fast-forward the cursor as part of migrating an existing Item
from `/transactions/get` to `/transactions/sync`. For more information, see the [Transactions sync migration guide](plaid.com/docs/transactions/sync-migration/). Note that using the `"now"` value is not supported for any use case other than migrating existing Items from `/transactions/get`. The upper-bound length of this cursor is 256 characters of base64.
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.
Public Class Methods
Source
# File lib/plaid/models/transactions_sync_request.rb, line 49 def self.acceptable_attributes attribute_map.values end
Returns all the JSON keys this model knows about
Source
# File lib/plaid/models/transactions_sync_request.rb, line 37 def self.attribute_map { :'client_id' => :'client_id', :'access_token' => :'access_token', :'secret' => :'secret', :'cursor' => :'cursor', :'count' => :'count', :'options' => :'options' } end
Attribute mapping from ruby-style variable name to JSON key.
Source
# File lib/plaid/models/transactions_sync_request.rb, line 185 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/transactions_sync_request.rb, line 73 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::TransactionsSyncRequest` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::TransactionsSyncRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } if attributes.key?(:'client_id') self.client_id = attributes[:'client_id'] end if attributes.key?(:'access_token') self.access_token = attributes[:'access_token'] end if attributes.key?(:'secret') self.secret = attributes[:'secret'] end if attributes.key?(:'cursor') self.cursor = attributes[:'cursor'] end if attributes.key?(:'count') self.count = attributes[:'count'] else self.count = 100 end if attributes.key?(:'options') self.options = attributes[:'options'] end end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
Source
# File lib/plaid/models/transactions_sync_request.rb, line 66 def self.openapi_nullable Set.new([ ]) end
List of attributes with nullable: true
Source
# File lib/plaid/models/transactions_sync_request.rb, line 54 def self.openapi_types { :'client_id' => :'String', :'access_token' => :'String', :'secret' => :'String', :'cursor' => :'String', :'count' => :'Integer', :'options' => :'TransactionsSyncRequestOptions' } end
Attribute type mapping.
Public Instance Methods
Source
# File lib/plaid/models/transactions_sync_request.rb, line 159 def ==(o) return true if self.equal?(o) self.class == o.class && client_id == o.client_id && access_token == o.access_token && secret == o.secret && cursor == o.cursor && count == o.count && options == o.options end
Checks equality by comparing each attribute. @param [Object] Object to be compared
Source
# File lib/plaid/models/transactions_sync_request.rb, line 216 def _deserialize(type, value) case type.to_sym when :Time Time.parse(value) when :Date Date.parse(value) when :String value.to_s when :Integer value.to_i when :Float value.to_f when :Boolean if value.to_s =~ /\A(true|t|yes|y|1)\z/i true else false end when :Object # generic object (usually a Hash), return directly value when /\AArray<(?<inner_type>.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/ k_type = Regexp.last_match[:k_type] v_type = Regexp.last_match[:v_type] {}.tap do |hash| value.each do |k, v| hash[_deserialize(k_type, k)] = _deserialize(v_type, v) end end else # model # models (e.g. Pet) or oneOf klass = Plaid.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
Source
# File lib/plaid/models/transactions_sync_request.rb, line 287 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
Source
# File lib/plaid/models/transactions_sync_request.rb, line 192 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) self.class.openapi_types.each_pair do |key, type| if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key) self.send("#{key}=", nil) elsif type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) end elsif !attributes[self.class.attribute_map[key]].nil? self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) end end self end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
Source
# File lib/plaid/models/transactions_sync_request.rb, line 144 def count=(count) if !count.nil? && count > 500 fail ArgumentError, 'invalid value for "count", must be smaller than or equal to 500.' end if !count.nil? && count < 1 fail ArgumentError, 'invalid value for "count", must be greater than or equal to 1.' end @count = count end
Custom attribute writer method with validation @param [Object] count Value to be assigned
Source
# File lib/plaid/models/transactions_sync_request.rb, line 172 def eql?(o) self == o end
@see the ‘==` method @param [Object] Object to be compared
Source
# File lib/plaid/models/transactions_sync_request.rb, line 178 def hash [client_id, access_token, secret, cursor, count, options].hash end
Calculates hash code according to all attributes. @return [Integer] Hash code
Source
# File lib/plaid/models/transactions_sync_request.rb, line 115 def list_invalid_properties invalid_properties = Array.new if @access_token.nil? invalid_properties.push('invalid value for "access_token", access_token cannot be nil.') end if !@count.nil? && @count > 500 invalid_properties.push('invalid value for "count", must be smaller than or equal to 500.') end if !@count.nil? && @count < 1 invalid_properties.push('invalid value for "count", must be greater than or equal to 1.') end invalid_properties end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
Source
Source
# File lib/plaid/models/transactions_sync_request.rb, line 269 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
Source
# File lib/plaid/models/transactions_sync_request.rb, line 257 def to_s to_hash.to_s end
Returns the string representation of the object @return [String] String presentation of the object
Source
# File lib/plaid/models/transactions_sync_request.rb, line 135 def valid? return false if @access_token.nil? return false if !@count.nil? && @count > 500 return false if !@count.nil? && @count < 1 true end
Check to see if the all the properties in the model are valid @return true if the model is valid