Class: SquareConnect::BatchUpsertCatalogObjectsRequest
- Inherits:
-
Object
- Object
- SquareConnect::BatchUpsertCatalogObjectsRequest
- Defined in:
- lib/square_connect/models/batch_upsert_catalog_objects_request.rb
Instance Attribute Summary collapse
-
#batches ⇒ Object
A batch of [CatalogObject](#type-catalogobject)s to be inserted/updated atomically.
-
#idempotency_key ⇒ Object
A value you specify that uniquely identifies this request among all your requests.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ BatchUpsertCatalogObjectsRequest
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ BatchUpsertCatalogObjectsRequest
Initializes the object
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/square_connect/models/batch_upsert_catalog_objects_request.rb', line 40 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?(:'idempotency_key') self.idempotency_key = attributes[:'idempotency_key'] end if attributes.has_key?(:'batches') if (value = attributes[:'batches']).is_a?(Array) self.batches = value end end end |
Instance Attribute Details
#batches ⇒ Object
A batch of [CatalogObject](#type-catalogobject)s to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request. For each object, its ‘updated_at` field is ignored and replaced with a current [timestamp](#workingwithdates), and its `is_deleted` field must not be set to `true`. To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a [CatalogItem](#type-catalogitem) with ID `#ABC` and a [CatalogItemVariation](#type-catalogitemvariation) with its `item_id` attribute set to `#ABC` in order to associate the [CatalogItemVariation](#type-catalogitemvariation) with its parent [CatalogItem](#type-catalogitem). Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated.
19 20 21 |
# File 'lib/square_connect/models/batch_upsert_catalog_objects_request.rb', line 19 def batches @batches end |
#idempotency_key ⇒ Object
A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you’re unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency keys](#idempotencykeys) for more information.
16 17 18 |
# File 'lib/square_connect/models/batch_upsert_catalog_objects_request.rb', line 16 def idempotency_key @idempotency_key end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
23 24 25 26 27 28 |
# File 'lib/square_connect/models/batch_upsert_catalog_objects_request.rb', line 23 def self.attribute_map { :'idempotency_key' => :'idempotency_key', :'batches' => :'batches' } end |
.swagger_types ⇒ Object
Attribute type mapping.
31 32 33 34 35 36 |
# File 'lib/square_connect/models/batch_upsert_catalog_objects_request.rb', line 31 def self.swagger_types { :'idempotency_key' => :'String', :'batches' => :'Array<CatalogObjectBatch>' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
97 98 99 100 101 102 |
# File 'lib/square_connect/models/batch_upsert_catalog_objects_request.rb', line 97 def ==(o) return true if self.equal?(o) self.class == o.class && idempotency_key == o.idempotency_key && batches == o.batches end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 |
# File 'lib/square_connect/models/batch_upsert_catalog_objects_request.rb', line 140 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
206 207 208 209 210 211 212 213 214 215 216 217 218 |
# File 'lib/square_connect/models/batch_upsert_catalog_objects_request.rb', line 206 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
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
# File 'lib/square_connect/models/batch_upsert_catalog_objects_request.rb', line 119 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
106 107 108 |
# File 'lib/square_connect/models/batch_upsert_catalog_objects_request.rb', line 106 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
112 113 114 |
# File 'lib/square_connect/models/batch_upsert_catalog_objects_request.rb', line 112 def hash [idempotency_key, batches].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
60 61 62 63 64 65 66 67 68 69 70 71 |
# File 'lib/square_connect/models/batch_upsert_catalog_objects_request.rb', line 60 def list_invalid_properties invalid_properties = Array.new if @idempotency_key.nil? invalid_properties.push("invalid value for 'idempotency_key', idempotency_key cannot be nil.") end if @idempotency_key.to_s.length < 1 invalid_properties.push("invalid value for 'idempotency_key', the character length must be great than or equal to 1.") end return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
186 187 188 |
# File 'lib/square_connect/models/batch_upsert_catalog_objects_request.rb', line 186 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
192 193 194 195 196 197 198 199 200 |
# File 'lib/square_connect/models/batch_upsert_catalog_objects_request.rb', line 192 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
180 181 182 |
# File 'lib/square_connect/models/batch_upsert_catalog_objects_request.rb', line 180 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
75 76 77 78 79 |
# File 'lib/square_connect/models/batch_upsert_catalog_objects_request.rb', line 75 def valid? return false if @idempotency_key.nil? return false if @idempotency_key.to_s.length < 1 return true end |