Class: SquareConnect::OrderFulfillmentPickupDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/square_connect/models/order_fulfillment_pickup_details.rb

Overview

Contains details necessary to fulfill a pickup order.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OrderFulfillmentPickupDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 131

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?(:'recipient')
    self.recipient = attributes[:'recipient']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#accepted_at ⇒ Object

The [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment was accepted by the merchant.



43
44
45
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 43

def accepted_at
  @accepted_at
end

#auto_complete_duration ⇒ Object

The auto completion duration in RFC3339 duration format, e.g., "P1W3D". If set, an open and accepted pickup fulfillment will automatically move to the ‘COMPLETED` state after this period of time. If not set, this pickup fulfillment will remain accepted until it is canceled or completed.



22
23
24
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 22

def auto_complete_duration
  @auto_complete_duration
end

#cancel_reason ⇒ Object

A description of why the pickup was canceled. Max length is 100 characters.



61
62
63
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 61

def cancel_reason
  @cancel_reason
end

#canceled_at ⇒ Object

The [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment was canceled by the merchant or buyer.



58
59
60
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 58

def canceled_at
  @canceled_at
end

#expired_at ⇒ Object

The [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment expired.



52
53
54
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 52

def expired_at
  @expired_at
end

#expires_at ⇒ Object

The expiry [timestamp](#workingwithdates) in RFC 3339 format, e.g., "2016-09-04T23:59:33.123Z". This timestamp indicates when the pickup fulfillment will expire if it is not accepted by the merchant. Expiration time can only be set up to 7 days in the future. If not set, this pickup fulfillment will be automatically accepted when placed.



19
20
21
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 19

def expires_at
  @expires_at
end

#note ⇒ Object

A general note about the pickup fulfillment. Notes are useful for providing additional instructions and are displayed in Square apps.



37
38
39
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 37

def note
  @note
end

#picked_up_at ⇒ Object

The [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment was picked up by the recipient.



55
56
57
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 55

def picked_up_at
  @picked_up_at
end

#pickup_at ⇒ Object

The pickup [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". For fulfillments with the schedule type ‘ASAP`, this is automatically set to the current time plus the expected duration to prepare the fulfillment. This represents the start of the pickup window.



28
29
30
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 28

def pickup_at
  @pickup_at
end

#pickup_window_duration ⇒ Object

The pickup window duration in RFC3339 duration format, e.g., "P1W3D". This duration represents the window of time for which the order should be picked up after the ‘pickup_at` time. Can be used as an informational guideline for merchants.



31
32
33
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 31

def pickup_window_duration
  @pickup_window_duration
end

#placed_at ⇒ Object

The [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment was placed.



40
41
42
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 40

def placed_at
  @placed_at
end

#prep_time_duration ⇒ Object

The preparation time duration in RFC3339 duration format, e.g., "P1W3D". This duration indicates how long it takes the merchant to prepare this fulfillment.



34
35
36
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 34

def prep_time_duration
  @prep_time_duration
end

#ready_at ⇒ Object

The [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the merchant set the fulfillment as ready for pickup.



49
50
51
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 49

def ready_at
  @ready_at
end

#recipient ⇒ Object

The recipient of this pickup fulfillment.



16
17
18
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 16

def recipient
  @recipient
end

#rejected_at ⇒ Object

The [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z", indicating when the fulfillment was rejected.



46
47
48
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 46

def rejected_at
  @rejected_at
end

#schedule_type ⇒ Object

The schedule type of the pickup fulfillment. Defaults to ‘SCHEDULED`.



25
26
27
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 25

def schedule_type
  @schedule_type
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 86

def self.attribute_map
  {
    :'recipient' => :'recipient',
    :'expires_at' => :'expires_at',
    :'auto_complete_duration' => :'auto_complete_duration',
    :'schedule_type' => :'schedule_type',
    :'pickup_at' => :'pickup_at',
    :'pickup_window_duration' => :'pickup_window_duration',
    :'prep_time_duration' => :'prep_time_duration',
    :'note' => :'note',
    :'placed_at' => :'placed_at',
    :'accepted_at' => :'accepted_at',
    :'rejected_at' => :'rejected_at',
    :'ready_at' => :'ready_at',
    :'expired_at' => :'expired_at',
    :'picked_up_at' => :'picked_up_at',
    :'canceled_at' => :'canceled_at',
    :'cancel_reason' => :'cancel_reason'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 108

def self.swagger_types
  {
    :'recipient' => :'OrderFulfillmentRecipient',
    :'expires_at' => :'String',
    :'auto_complete_duration' => :'String',
    :'schedule_type' => :'String',
    :'pickup_at' => :'String',
    :'pickup_window_duration' => :'String',
    :'prep_time_duration' => :'String',
    :'note' => :'String',
    :'placed_at' => :'String',
    :'accepted_at' => :'String',
    :'rejected_at' => :'String',
    :'ready_at' => :'String',
    :'expired_at' => :'String',
    :'picked_up_at' => :'String',
    :'canceled_at' => :'String',
    :'cancel_reason' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 262

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      recipient == o.recipient &&
      expires_at == o.expires_at &&
      auto_complete_duration == o.auto_complete_duration &&
      schedule_type == o.schedule_type &&
      pickup_at == o.pickup_at &&
      pickup_window_duration == o.pickup_window_duration &&
      prep_time_duration == o.prep_time_duration &&
      note == o.note &&
      placed_at == o.placed_at &&
      accepted_at == o.accepted_at &&
      rejected_at == o.rejected_at &&
      ready_at == o.ready_at &&
      expired_at == o.expired_at &&
      picked_up_at == o.picked_up_at &&
      canceled_at == o.canceled_at &&
      cancel_reason == o.cancel_reason
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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 319

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 = SquareConnect.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



385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 385

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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 298

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("#{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 # 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


285
286
287
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 285

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



291
292
293
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 291

def hash
  [recipient, expires_at, auto_complete_duration, schedule_type, pickup_at, pickup_window_duration, prep_time_duration, note, placed_at, accepted_at, rejected_at, ready_at, expired_at, picked_up_at, canceled_at, cancel_reason].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 205

def list_invalid_properties
  invalid_properties = Array.new
  if !@note.nil? && @note.to_s.length > 500
    invalid_properties.push("invalid value for 'note', the character length must be smaller than or equal to 500.")
  end

  if !@cancel_reason.nil? && @cancel_reason.to_s.length > 100
    invalid_properties.push("invalid value for 'cancel_reason', the character length must be smaller than or equal to 100.")
  end

  return 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



365
366
367
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 365

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



371
372
373
374
375
376
377
378
379
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 371

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



359
360
361
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 359

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



220
221
222
223
224
225
226
 
# File 'lib/square_connect/models/order_fulfillment_pickup_details.rb', line 220

def valid?
  schedule_type_validator = EnumAttributeValidator.new('String', ["SCHEDULED", "ASAP"])
  return false unless schedule_type_validator.valid?(@schedule_type)
  return false if !@note.nil? && @note.to_s.length > 500
  return false if !@cancel_reason.nil? && @cancel_reason.to_s.length > 100
  return true
end