Class: CyberSource::InlineResponse20019

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/inline_response_200_19.rb

Overview

Result of a product feed ingestion request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InlineResponse20019

Initializes the object

Parameters:

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

    Model attributes in the form of hash



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 102

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'feed_id')
    self.feed_id = attributes[:'feed_id']
  end

  if attributes.has_key?(:'total_submitted')
    self.total_submitted = attributes[:'total_submitted']
  end

  if attributes.has_key?(:'success_count')
    self.success_count = attributes[:'success_count']
  end

  if attributes.has_key?(:'failed_count')
    self.failed_count = attributes[:'failed_count']
  end

  if attributes.has_key?(:'errors')
    if (value = attributes[:'errors']).is_a?(Array)
      self.errors = value
    end
  end

  if attributes.has_key?(:'ingested_at')
    self.ingested_at = attributes[:'ingested_at']
  end

  if attributes.has_key?(:'forwarded_to_agent')
    self.forwarded_to_agent = attributes[:'forwarded_to_agent']
  end

  if attributes.has_key?(:'agent_endpoint')
    self.agent_endpoint = attributes[:'agent_endpoint']
  end

  if attributes.has_key?(:'forwarded_to_ucp_agent')
    self.forwarded_to_ucp_agent = attributes[:'forwarded_to_ucp_agent']
  end

  if attributes.has_key?(:'google_merchant')
    self.google_merchant = attributes[:'google_merchant']
  end
end

Instance Attribute Details

#agent_endpoint ⇒ Object

The AI agent endpoint URL that the products were forwarded to. Present when forwarded_to_agent is true.



42
43
44
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 42

def agent_endpoint
  @agent_endpoint
end

#errors ⇒ Object

Per-product validation errors for products that failed ingestion. Each entry identifies the product, the specific field that failed, and the reason. null when failed_count is zero.



33
34
35
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 33

def errors
  @errors
end

#failed_count ⇒ Object

Number of products that failed validation and were not saved.



30
31
32
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 30

def failed_count
  @failed_count
end

#feed_id ⇒ Object

Unique identifier for this feed ingestion job. Use this with the Syndication Status endpoint to monitor the asynchronous protocol sync progress (e.g. to Google Merchant Center).



21
22
23
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 21

def feed_id
  @feed_id
end

#forwarded_to_agent ⇒ Object

Indicates whether the ingested products were scheduled for syndication to the configured AI agent endpoint. Set to true when at least one product was successfully saved. Note: syndication is asynchronous — this field confirms the dispatch was initiated, not that the agent received the data.



39
40
41
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 39

def forwarded_to_agent
  @forwarded_to_agent
end

#forwarded_to_ucp_agent ⇒ Object

Indicates whether the ingested products were scheduled for syndication to the UCP (Unified Commerce Platform) agent. Set to true when UCP syndication is enabled and at least one product was successfully saved.



45
46
47
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 45

def forwarded_to_ucp_agent
  @forwarded_to_ucp_agent
end

#google_merchant ⇒ Object

Returns the value of attribute google_merchant.



47
48
49
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 47

def google_merchant
  @google_merchant
end

#ingested_at ⇒ Object

ISO 8601 timestamp when the ingestion completed.



36
37
38
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 36

def ingested_at
  @ingested_at
end

#status ⇒ Object

Overall ingestion result: - success — all products were validated and saved - partial_success — some products failed validation; errors lists the failures - failed — no products were saved; check errors for details Possible values: - success - partial_success - failed



18
19
20
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 18

def status
  @status
end

#success_count ⇒ Object

Number of products that passed validation and were saved to the catalog.



27
28
29
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 27

def success_count
  @success_count
end

#total_submitted ⇒ Object

Total number of product records in the submitted feed.



24
25
26
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 24

def total_submitted
  @total_submitted
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 50

def self.attribute_map
  {
    :'status' => :'status',
    :'feed_id' => :'feed_id',
    :'total_submitted' => :'total_submitted',
    :'success_count' => :'success_count',
    :'failed_count' => :'failed_count',
    :'errors' => :'errors',
    :'ingested_at' => :'ingested_at',
    :'forwarded_to_agent' => :'forwarded_to_agent',
    :'agent_endpoint' => :'agent_endpoint',
    :'forwarded_to_ucp_agent' => :'forwarded_to_ucp_agent',
    :'google_merchant' => :'google_merchant'
  }
end

.json_map ⇒ Object

Attribute mapping from JSON key to ruby-style variable name.



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

def self.json_map
  {
    :'status' => :'status',
    :'feed_id' => :'feed_id',
    :'total_submitted' => :'total_submitted',
    :'success_count' => :'success_count',
    :'failed_count' => :'failed_count',
    :'errors' => :'errors',
    :'ingested_at' => :'ingested_at',
    :'forwarded_to_agent' => :'forwarded_to_agent',
    :'agent_endpoint' => :'agent_endpoint',
    :'forwarded_to_ucp_agent' => :'forwarded_to_ucp_agent',
    :'google_merchant' => :'google_merchant'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 84

def self.swagger_types
  {
    :'status' => :'String',
    :'feed_id' => :'String',
    :'total_submitted' => :'Integer',
    :'success_count' => :'Integer',
    :'failed_count' => :'Integer',
    :'errors' => :'Array<InlineResponse20019Errors>',
    :'ingested_at' => :'DateTime',
    :'forwarded_to_agent' => :'BOOLEAN',
    :'agent_endpoint' => :'String',
    :'forwarded_to_ucp_agent' => :'BOOLEAN',
    :'google_merchant' => :'InlineResponse20019GoogleMerchant'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      status == o.status &&
      feed_id == o.feed_id &&
      total_submitted == o.total_submitted &&
      success_count == o.success_count &&
      failed_count == o.failed_count &&
      errors == o.errors &&
      ingested_at == o.ingested_at &&
      forwarded_to_agent == o.forwarded_to_agent &&
      agent_endpoint == o.agent_endpoint &&
      forwarded_to_ucp_agent == o.forwarded_to_ucp_agent &&
      google_merchant == o.google_merchant
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 222

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = CyberSource.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 288

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

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 201

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[key]}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


188
189
190
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 188

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



194
195
196
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 194

def hash
  [status, feed_id, total_submitted, success_count, failed_count, errors, ingested_at, forwarded_to_agent, agent_endpoint, forwarded_to_ucp_agent, google_merchant].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



157
158
159
160
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 157

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



268
269
270
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 268

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



274
275
276
277
278
279
280
281
282
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 274

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



262
263
264
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 262

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



164
165
166
 
# File 'lib/cybersource_rest_client/models/inline_response_200_19.rb', line 164

def valid?
  true
end