square_connect 2.0.2.69 → 2.1.0.beta
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +133 -21
- data/docs/ChargeRequest.md +1 -1
- data/docs/CheckoutApi.md +8 -6
- data/docs/CustomersApi.md +389 -0
- data/docs/Device.md +11 -0
- data/docs/LocationsApi.md +55 -0
- data/docs/TransactionsApi.md +417 -0
- data/docs/V1AdjustInventoryRequest.md +12 -0
- data/docs/V1BankAccount.md +17 -0
- data/docs/V1CashDrawerEvent.md +15 -0
- data/docs/V1CashDrawerShift.md +28 -0
- data/docs/V1Category.md +11 -0
- data/docs/V1CreateRefundRequest.md +14 -0
- data/docs/V1Discount.md +16 -0
- data/docs/V1Employee.md +21 -0
- data/docs/V1EmployeeRole.md +15 -0
- data/docs/V1EmployeesApi.md +915 -0
- data/docs/V1Fee.md +18 -0
- data/docs/V1InventoryEntry.md +11 -0
- data/docs/V1Item.md +23 -0
- data/docs/V1ItemImage.md +11 -0
- data/docs/V1ItemsApi.md +2297 -0
- data/docs/V1LocationApi.md +102 -0
- data/docs/V1LocationsApi.md +102 -0
- data/docs/V1Merchant.md +26 -0
- data/docs/V1MerchantLocationDetails.md +12 -0
- data/docs/V1ModifierList.md +13 -0
- data/docs/V1ModifierOption.md +15 -0
- data/docs/V1Money.md +13 -0
- data/docs/V1Order.md +34 -0
- data/docs/V1OrderHistoryEntry.md +11 -0
- data/docs/V1Page.md +13 -0
- data/docs/V1PageCell.md +15 -0
- data/docs/V1Payment.md +33 -0
- data/docs/V1PaymentDiscount.md +12 -0
- data/docs/V1PaymentItemDetail.md +13 -0
- data/docs/V1PaymentItemization.md +23 -0
- data/docs/V1PaymentModifier.md +12 -0
- data/docs/V1PaymentTax.md +15 -0
- data/docs/V1PhoneNumber.md +13 -0
- data/docs/V1Refund.md +16 -0
- data/docs/V1Settlement.md +15 -0
- data/docs/V1SettlementEntry.md +13 -0
- data/docs/V1Tender.md +22 -0
- data/docs/V1Timecard.md +20 -0
- data/docs/V1TimecardEvent.md +14 -0
- data/docs/V1TransactionsApi.md +650 -0
- data/docs/V1UpdateModifierListRequest.md +11 -0
- data/docs/V1UpdateOrderRequest.md +14 -0
- data/docs/V1Variation.md +20 -0
- data/lib/.DS_Store +0 -0
- data/lib/square_connect.rb +46 -5
- data/lib/square_connect/.DS_Store +0 -0
- data/lib/square_connect/api/checkout_api.rb +4 -9
- data/lib/square_connect/api/{customer_api.rb → customers_api.rb} +150 -61
- data/lib/square_connect/api/{location_api.rb → locations_api.rb} +7 -12
- data/lib/square_connect/api/{transaction_api.rb → transactions_api.rb} +169 -65
- data/lib/square_connect/api/v1_employees_api.rb +974 -0
- data/lib/square_connect/api/v1_items_api.rb +2365 -0
- data/lib/square_connect/api/v1_locations_api.rb +118 -0
- data/lib/square_connect/api/v1_transactions_api.rb +707 -0
- data/lib/square_connect/api_client.rb +1 -1
- data/lib/square_connect/models/charge_request.rb +1 -1
- data/lib/square_connect/models/device.rb +196 -0
- data/lib/square_connect/models/v1_adjust_inventory_request.rb +206 -0
- data/lib/square_connect/models/v1_bank_account.rb +289 -0
- data/lib/square_connect/models/v1_cash_drawer_event.rb +269 -0
- data/lib/square_connect/models/v1_cash_drawer_shift.rb +403 -0
- data/lib/square_connect/models/v1_category.rb +196 -0
- data/lib/square_connect/models/v1_create_refund_request.rb +274 -0
- data/lib/square_connect/models/v1_discount.rb +291 -0
- data/lib/square_connect/models/v1_employee.rb +323 -0
- data/lib/square_connect/models/v1_employee_role.rb +269 -0
- data/lib/square_connect/models/v1_fee.rb +335 -0
- data/lib/square_connect/models/v1_inventory_entry.rb +196 -0
- data/lib/square_connect/models/v1_item.rb +379 -0
- data/lib/square_connect/models/v1_item_image.rb +196 -0
- data/lib/square_connect/models/v1_merchant.rb +372 -0
- data/lib/square_connect/models/v1_merchant_location_details.rb +186 -0
- data/lib/square_connect/models/v1_modifier_list.rb +251 -0
- data/lib/square_connect/models/v1_modifier_option.rb +236 -0
- data/lib/square_connect/models/v1_money.rb +229 -0
- data/lib/square_connect/models/v1_order.rb +463 -0
- data/lib/square_connect/models/v1_order_history_entry.rb +229 -0
- data/lib/square_connect/models/v1_page.rb +218 -0
- data/lib/square_connect/models/v1_page_cell.rb +261 -0
- data/lib/square_connect/models/v1_payment.rb +423 -0
- data/lib/square_connect/models/v1_payment_discount.rb +206 -0
- data/lib/square_connect/models/v1_payment_item_detail.rb +216 -0
- data/lib/square_connect/models/v1_payment_itemization.rb +355 -0
- data/lib/square_connect/models/v1_payment_modifier.rb +206 -0
- data/lib/square_connect/models/v1_payment_tax.rb +271 -0
- data/lib/square_connect/models/v1_phone_number.rb +206 -0
- data/lib/square_connect/models/v1_refund.rb +279 -0
- data/lib/square_connect/models/v1_settlement.rb +271 -0
- data/lib/square_connect/models/v1_settlement_entry.rb +249 -0
- data/lib/square_connect/models/v1_tender.rb +363 -0
- data/lib/square_connect/models/v1_timecard.rb +271 -0
- data/lib/square_connect/models/v1_timecard_event.rb +259 -0
- data/lib/square_connect/models/v1_update_modifier_list_request.rb +229 -0
- data/lib/square_connect/models/v1_update_order_request.rb +264 -0
- data/lib/square_connect/models/v1_variation.rb +331 -0
- data/lib/square_connect/version.rb +1 -1
- data/spec/.DS_Store +0 -0
- data/spec/api/checkout_api_spec.rb +4 -12
- data/spec/api/{customer_api_spec.rb → customers_api_spec.rb} +39 -41
- data/spec/api/{location_api_spec.rb → locations_api_spec.rb} +9 -15
- data/spec/api/{transaction_api_spec.rb → transactions_api_spec.rb} +43 -41
- data/spec/api/v1_employees_api_spec.rb +250 -0
- data/spec/api/v1_items_api_spec.rb +568 -0
- data/spec/api/v1_locations_api_spec.rb +54 -0
- data/spec/api/v1_transactions_api_spec.rb +186 -0
- data/spec/models/address_spec.rb +22 -81
- data/spec/models/capture_transaction_request_spec.rb +3 -6
- data/spec/models/capture_transaction_response_spec.rb +4 -11
- data/spec/models/card_brand_spec.rb +3 -6
- data/spec/models/card_spec.rb +14 -41
- data/spec/models/charge_request_spec.rb +14 -61
- data/spec/models/charge_response_spec.rb +5 -16
- data/spec/models/checkout_spec.rb +12 -51
- data/spec/models/country_spec.rb +3 -6
- data/spec/models/create_checkout_request_spec.rb +10 -41
- data/spec/models/create_checkout_response_spec.rb +5 -16
- data/spec/models/create_customer_card_request_spec.rb +6 -21
- data/spec/models/create_customer_card_response_spec.rb +5 -16
- data/spec/models/create_customer_request_spec.rb +12 -51
- data/spec/models/create_customer_response_spec.rb +5 -16
- data/spec/models/create_order_request_line_item_spec.rb +6 -21
- data/spec/models/create_order_request_order_spec.rb +5 -16
- data/spec/models/create_order_request_spec.rb +5 -16
- data/spec/models/create_refund_request_spec.rb +7 -26
- data/spec/models/create_refund_response_spec.rb +5 -16
- data/spec/models/currency_spec.rb +3 -6
- data/spec/models/customer_group_info_spec.rb +5 -16
- data/spec/models/customer_preferences_spec.rb +4 -11
- data/spec/models/customer_spec.rb +18 -81
- data/spec/models/delete_customer_card_request_spec.rb +3 -6
- data/spec/models/delete_customer_card_response_spec.rb +4 -11
- data/spec/models/delete_customer_request_spec.rb +3 -6
- data/spec/models/delete_customer_response_spec.rb +4 -11
- data/spec/models/device_spec.rb +45 -0
- data/spec/models/error_category_spec.rb +3 -6
- data/spec/models/error_code_spec.rb +3 -6
- data/spec/models/error_spec.rb +15 -26
- data/spec/models/list_customers_request_spec.rb +4 -11
- data/spec/models/list_customers_response_spec.rb +6 -21
- data/spec/models/list_locations_request_spec.rb +3 -6
- data/spec/models/list_locations_response_spec.rb +5 -16
- data/spec/models/list_refunds_request_spec.rb +11 -26
- data/spec/models/list_refunds_response_spec.rb +6 -21
- data/spec/models/list_transactions_request_spec.rb +11 -26
- data/spec/models/list_transactions_response_spec.rb +6 -21
- data/spec/models/location_capability_spec.rb +3 -6
- data/spec/models/location_spec.rb +12 -31
- data/spec/models/money_spec.rb +9 -16
- data/spec/models/order_line_item_spec.rb +8 -31
- data/spec/models/order_spec.rb +8 -31
- data/spec/models/refund_spec.rb +16 -51
- data/spec/models/refund_status_spec.rb +3 -6
- data/spec/models/retrieve_customer_request_spec.rb +3 -6
- data/spec/models/retrieve_customer_response_spec.rb +5 -16
- data/spec/models/retrieve_transaction_request_spec.rb +3 -6
- data/spec/models/retrieve_transaction_response_spec.rb +5 -16
- data/spec/models/sort_order_spec.rb +3 -6
- data/spec/models/tender_card_details_entry_method_spec.rb +3 -6
- data/spec/models/tender_card_details_spec.rb +14 -21
- data/spec/models/tender_card_details_status_spec.rb +3 -6
- data/spec/models/tender_cash_details_spec.rb +5 -16
- data/spec/models/tender_spec.rb +18 -61
- data/spec/models/tender_type_spec.rb +3 -6
- data/spec/models/transaction_product_spec.rb +3 -6
- data/spec/models/transaction_spec.rb +17 -56
- data/spec/models/update_customer_request_spec.rb +12 -51
- data/spec/models/update_customer_response_spec.rb +5 -16
- data/spec/models/v1_adjust_inventory_request_spec.rb +51 -0
- data/spec/models/v1_bank_account_spec.rb +85 -0
- data/spec/models/v1_cash_drawer_event_spec.rb +73 -0
- data/spec/models/v1_cash_drawer_shift_spec.rb +151 -0
- data/spec/models/v1_category_spec.rb +45 -0
- data/spec/models/v1_create_refund_request_spec.rb +67 -0
- data/spec/models/v1_discount_spec.rb +83 -0
- data/spec/models/v1_employee_role_spec.rb +73 -0
- data/spec/models/v1_employee_spec.rb +97 -0
- data/spec/models/v1_fee_spec.rb +103 -0
- data/spec/models/v1_inventory_entry_spec.rb +45 -0
- data/spec/models/v1_item_image_spec.rb +45 -0
- data/spec/models/v1_item_spec.rb +129 -0
- data/spec/models/v1_merchant_location_details_spec.rb +39 -0
- data/spec/models/v1_merchant_spec.rb +131 -0
- data/spec/models/v1_modifier_list_spec.rb +61 -0
- data/spec/models/v1_modifier_option_spec.rb +69 -0
- data/spec/models/v1_money_spec.rb +49 -0
- data/spec/models/v1_order_history_entry_spec.rb +49 -0
- data/spec/models/v1_order_spec.rb +187 -0
- data/spec/models/v1_page_cell_spec.rb +77 -0
- data/spec/models/v1_page_spec.rb +57 -0
- data/spec/models/v1_payment_discount_spec.rb +51 -0
- data/spec/models/v1_payment_item_detail_spec.rb +57 -0
- data/spec/models/v1_payment_itemization_spec.rb +121 -0
- data/spec/models/v1_payment_modifier_spec.rb +51 -0
- data/spec/models/v1_payment_spec.rb +177 -0
- data/spec/models/v1_payment_tax_spec.rb +73 -0
- data/spec/models/v1_phone_number_spec.rb +45 -0
- data/spec/models/v1_refund_spec.rb +79 -0
- data/spec/models/v1_settlement_entry_spec.rb +61 -0
- data/spec/models/v1_settlement_spec.rb +73 -0
- data/spec/models/v1_tender_spec.rb +123 -0
- data/spec/models/v1_timecard_event_spec.rb +67 -0
- data/spec/models/v1_timecard_spec.rb +87 -0
- data/spec/models/v1_update_modifier_list_request_spec.rb +49 -0
- data/spec/models/v1_update_order_request_spec.rb +67 -0
- data/spec/models/v1_variation_spec.rb +107 -0
- data/spec/models/void_transaction_request_spec.rb +3 -6
- data/spec/models/void_transaction_response_spec.rb +4 -11
- data/spec/spec_helper.rb +10 -0
- data/square_connect-2.0.2.gem +0 -0
- data/square_connect-2.1.0.gem +0 -0
- data/square_connect-2.1.0beta.gem +0 -0
- data/square_connect.gemspec +1 -1
- data/travis-ci/accounts.enc +0 -0
- metadata +197 -26
- data/docs/CustomerApi.md +0 -267
- data/docs/CustomerCardApi.md +0 -116
- data/docs/LocationApi.md +0 -56
- data/docs/RefundApi.md +0 -126
- data/docs/TransactionApi.md +0 -285
- data/lib/square_connect/api/customer_card_api.rb +0 -144
- data/lib/square_connect/api/refund_api.rb +0 -159
- data/spec/api/customer_card_api_spec.rb +0 -71
- data/spec/api/refund_api_spec.rb +0 -75
|
@@ -0,0 +1,196 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Square Connect API
|
|
3
|
+
|
|
4
|
+
OpenAPI spec version: 2.0
|
|
5
|
+
Contact: developers@squareup.com
|
|
6
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
7
|
+
|
|
8
|
+
=end
|
|
9
|
+
|
|
10
|
+
require 'date'
|
|
11
|
+
|
|
12
|
+
module SquareConnect
|
|
13
|
+
|
|
14
|
+
class V1InventoryEntry
|
|
15
|
+
# The variation that the entry corresponds to.
|
|
16
|
+
attr_accessor :variation_id
|
|
17
|
+
|
|
18
|
+
# The current available quantity of the item variation.
|
|
19
|
+
attr_accessor :quantity_on_hand
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
23
|
+
def self.attribute_map
|
|
24
|
+
{
|
|
25
|
+
:'variation_id' => :'variation_id',
|
|
26
|
+
:'quantity_on_hand' => :'quantity_on_hand'
|
|
27
|
+
}
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
# Attribute type mapping.
|
|
31
|
+
def self.swagger_types
|
|
32
|
+
{
|
|
33
|
+
:'variation_id' => :'String',
|
|
34
|
+
:'quantity_on_hand' => :'Float'
|
|
35
|
+
}
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
# Initializes the object
|
|
39
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
40
|
+
def initialize(attributes = {})
|
|
41
|
+
return unless attributes.is_a?(Hash)
|
|
42
|
+
|
|
43
|
+
# convert string to symbol for hash key
|
|
44
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
|
45
|
+
|
|
46
|
+
if attributes.has_key?(:'variation_id')
|
|
47
|
+
self.variation_id = attributes[:'variation_id']
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
if attributes.has_key?(:'quantity_on_hand')
|
|
51
|
+
self.quantity_on_hand = attributes[:'quantity_on_hand']
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
57
|
+
# @return Array for valid properies with the reasons
|
|
58
|
+
def list_invalid_properties
|
|
59
|
+
invalid_properties = Array.new
|
|
60
|
+
return invalid_properties
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
# Check to see if the all the properties in the model are valid
|
|
64
|
+
# @return true if the model is valid
|
|
65
|
+
def valid?
|
|
66
|
+
return true
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
# Checks equality by comparing each attribute.
|
|
70
|
+
# @param [Object] Object to be compared
|
|
71
|
+
def ==(o)
|
|
72
|
+
return true if self.equal?(o)
|
|
73
|
+
self.class == o.class &&
|
|
74
|
+
variation_id == o.variation_id &&
|
|
75
|
+
quantity_on_hand == o.quantity_on_hand
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
# @see the `==` method
|
|
79
|
+
# @param [Object] Object to be compared
|
|
80
|
+
def eql?(o)
|
|
81
|
+
self == o
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
# Calculates hash code according to all attributes.
|
|
85
|
+
# @return [Fixnum] Hash code
|
|
86
|
+
def hash
|
|
87
|
+
[variation_id, quantity_on_hand].hash
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
# Builds the object from hash
|
|
91
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
92
|
+
# @return [Object] Returns the model itself
|
|
93
|
+
def build_from_hash(attributes)
|
|
94
|
+
return nil unless attributes.is_a?(Hash)
|
|
95
|
+
self.class.swagger_types.each_pair do |key, type|
|
|
96
|
+
if type =~ /\AArray<(.*)>/i
|
|
97
|
+
# check to ensure the input is an array given that the the attribute
|
|
98
|
+
# is documented as an array but the input is not
|
|
99
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
100
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
|
101
|
+
end
|
|
102
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
103
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
104
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
self
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Deserializes the data based on type
|
|
111
|
+
# @param string type Data type
|
|
112
|
+
# @param string value Value to be deserialized
|
|
113
|
+
# @return [Object] Deserialized data
|
|
114
|
+
def _deserialize(type, value)
|
|
115
|
+
case type.to_sym
|
|
116
|
+
when :DateTime
|
|
117
|
+
DateTime.parse(value)
|
|
118
|
+
when :Date
|
|
119
|
+
Date.parse(value)
|
|
120
|
+
when :String
|
|
121
|
+
value.to_s
|
|
122
|
+
when :Integer
|
|
123
|
+
value.to_i
|
|
124
|
+
when :Float
|
|
125
|
+
value.to_f
|
|
126
|
+
when :BOOLEAN
|
|
127
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
128
|
+
true
|
|
129
|
+
else
|
|
130
|
+
false
|
|
131
|
+
end
|
|
132
|
+
when :Object
|
|
133
|
+
# generic object (usually a Hash), return directly
|
|
134
|
+
value
|
|
135
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
136
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
137
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
138
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
139
|
+
k_type = Regexp.last_match[:k_type]
|
|
140
|
+
v_type = Regexp.last_match[:v_type]
|
|
141
|
+
{}.tap do |hash|
|
|
142
|
+
value.each do |k, v|
|
|
143
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
144
|
+
end
|
|
145
|
+
end
|
|
146
|
+
else # model
|
|
147
|
+
temp_model = SquareConnect.const_get(type).new
|
|
148
|
+
temp_model.build_from_hash(value)
|
|
149
|
+
end
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
# Returns the string representation of the object
|
|
153
|
+
# @return [String] String presentation of the object
|
|
154
|
+
def to_s
|
|
155
|
+
to_hash.to_s
|
|
156
|
+
end
|
|
157
|
+
|
|
158
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
159
|
+
# @return [Hash] Returns the object in the form of hash
|
|
160
|
+
def to_body
|
|
161
|
+
to_hash
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
# Returns the object in the form of hash
|
|
165
|
+
# @return [Hash] Returns the object in the form of hash
|
|
166
|
+
def to_hash
|
|
167
|
+
hash = {}
|
|
168
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
169
|
+
value = self.send(attr)
|
|
170
|
+
next if value.nil?
|
|
171
|
+
hash[param] = _to_hash(value)
|
|
172
|
+
end
|
|
173
|
+
hash
|
|
174
|
+
end
|
|
175
|
+
|
|
176
|
+
# Outputs non-array value in the form of hash
|
|
177
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
178
|
+
# @param [Object] value Any valid value
|
|
179
|
+
# @return [Hash] Returns the value in the form of hash
|
|
180
|
+
def _to_hash(value)
|
|
181
|
+
if value.is_a?(Array)
|
|
182
|
+
value.compact.map{ |v| _to_hash(v) }
|
|
183
|
+
elsif value.is_a?(Hash)
|
|
184
|
+
{}.tap do |hash|
|
|
185
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
186
|
+
end
|
|
187
|
+
elsif value.respond_to? :to_hash
|
|
188
|
+
value.to_hash
|
|
189
|
+
else
|
|
190
|
+
value
|
|
191
|
+
end
|
|
192
|
+
end
|
|
193
|
+
|
|
194
|
+
end
|
|
195
|
+
|
|
196
|
+
end
|
|
@@ -0,0 +1,379 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Square Connect API
|
|
3
|
+
|
|
4
|
+
OpenAPI spec version: 2.0
|
|
5
|
+
Contact: developers@squareup.com
|
|
6
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
7
|
+
|
|
8
|
+
=end
|
|
9
|
+
|
|
10
|
+
require 'date'
|
|
11
|
+
|
|
12
|
+
module SquareConnect
|
|
13
|
+
|
|
14
|
+
class V1Item
|
|
15
|
+
# The item's ID. Must be unique among all entity IDs ever provided on behalf of the merchant. You can never reuse an ID. This value can include alphanumeric characters, dashes (-), and underscores (_).
|
|
16
|
+
attr_accessor :id
|
|
17
|
+
|
|
18
|
+
# The item's name.
|
|
19
|
+
attr_accessor :name
|
|
20
|
+
|
|
21
|
+
# The item's description.
|
|
22
|
+
attr_accessor :description
|
|
23
|
+
|
|
24
|
+
# The item's type. This value is NORMAL for almost all items.
|
|
25
|
+
attr_accessor :type
|
|
26
|
+
|
|
27
|
+
# The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6.
|
|
28
|
+
attr_accessor :color
|
|
29
|
+
|
|
30
|
+
# The text of the item's display label in Square Register. Only up to the first five characters of the string are used.
|
|
31
|
+
attr_accessor :abbreviation
|
|
32
|
+
|
|
33
|
+
# Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE.
|
|
34
|
+
attr_accessor :visibility
|
|
35
|
+
|
|
36
|
+
# If true, the item can be added to shipping orders from the merchant's online store.
|
|
37
|
+
attr_accessor :available_online
|
|
38
|
+
|
|
39
|
+
# The item's master image, if any.
|
|
40
|
+
attr_accessor :master_image
|
|
41
|
+
|
|
42
|
+
# The category the item belongs to, if any.
|
|
43
|
+
attr_accessor :category
|
|
44
|
+
|
|
45
|
+
# The item's variations. You must specify at least one variation.
|
|
46
|
+
attr_accessor :variations
|
|
47
|
+
|
|
48
|
+
# The modifier lists that apply to the item, if any.
|
|
49
|
+
attr_accessor :modifier_lists
|
|
50
|
+
|
|
51
|
+
# The fees that apply to the item, if any.
|
|
52
|
+
attr_accessor :fees
|
|
53
|
+
|
|
54
|
+
# Deprecated. This field is not used.
|
|
55
|
+
attr_accessor :taxable
|
|
56
|
+
|
|
57
|
+
class EnumAttributeValidator
|
|
58
|
+
attr_reader :datatype
|
|
59
|
+
attr_reader :allowable_values
|
|
60
|
+
|
|
61
|
+
def initialize(datatype, allowable_values)
|
|
62
|
+
@allowable_values = allowable_values.map do |value|
|
|
63
|
+
case datatype.to_s
|
|
64
|
+
when /Integer/i
|
|
65
|
+
value.to_i
|
|
66
|
+
when /Float/i
|
|
67
|
+
value.to_f
|
|
68
|
+
else
|
|
69
|
+
value
|
|
70
|
+
end
|
|
71
|
+
end
|
|
72
|
+
end
|
|
73
|
+
|
|
74
|
+
def valid?(value)
|
|
75
|
+
!value || allowable_values.include?(value)
|
|
76
|
+
end
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
80
|
+
def self.attribute_map
|
|
81
|
+
{
|
|
82
|
+
:'id' => :'id',
|
|
83
|
+
:'name' => :'name',
|
|
84
|
+
:'description' => :'description',
|
|
85
|
+
:'type' => :'type',
|
|
86
|
+
:'color' => :'color',
|
|
87
|
+
:'abbreviation' => :'abbreviation',
|
|
88
|
+
:'visibility' => :'visibility',
|
|
89
|
+
:'available_online' => :'available_online',
|
|
90
|
+
:'master_image' => :'master_image',
|
|
91
|
+
:'category' => :'category',
|
|
92
|
+
:'variations' => :'variations',
|
|
93
|
+
:'modifier_lists' => :'modifier_lists',
|
|
94
|
+
:'fees' => :'fees',
|
|
95
|
+
:'taxable' => :'taxable'
|
|
96
|
+
}
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
# Attribute type mapping.
|
|
100
|
+
def self.swagger_types
|
|
101
|
+
{
|
|
102
|
+
:'id' => :'String',
|
|
103
|
+
:'name' => :'String',
|
|
104
|
+
:'description' => :'String',
|
|
105
|
+
:'type' => :'String',
|
|
106
|
+
:'color' => :'String',
|
|
107
|
+
:'abbreviation' => :'String',
|
|
108
|
+
:'visibility' => :'String',
|
|
109
|
+
:'available_online' => :'String',
|
|
110
|
+
:'master_image' => :'V1ItemImage',
|
|
111
|
+
:'category' => :'V1Category',
|
|
112
|
+
:'variations' => :'Array<V1Variation>',
|
|
113
|
+
:'modifier_lists' => :'Array<V1Variation>',
|
|
114
|
+
:'fees' => :'Array<V1Fee>',
|
|
115
|
+
:'taxable' => :'BOOLEAN'
|
|
116
|
+
}
|
|
117
|
+
end
|
|
118
|
+
|
|
119
|
+
# Initializes the object
|
|
120
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
121
|
+
def initialize(attributes = {})
|
|
122
|
+
return unless attributes.is_a?(Hash)
|
|
123
|
+
|
|
124
|
+
# convert string to symbol for hash key
|
|
125
|
+
attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
|
|
126
|
+
|
|
127
|
+
if attributes.has_key?(:'id')
|
|
128
|
+
self.id = attributes[:'id']
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
if attributes.has_key?(:'name')
|
|
132
|
+
self.name = attributes[:'name']
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
if attributes.has_key?(:'description')
|
|
136
|
+
self.description = attributes[:'description']
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
if attributes.has_key?(:'type')
|
|
140
|
+
self.type = attributes[:'type']
|
|
141
|
+
end
|
|
142
|
+
|
|
143
|
+
if attributes.has_key?(:'color')
|
|
144
|
+
self.color = attributes[:'color']
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
if attributes.has_key?(:'abbreviation')
|
|
148
|
+
self.abbreviation = attributes[:'abbreviation']
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
if attributes.has_key?(:'visibility')
|
|
152
|
+
self.visibility = attributes[:'visibility']
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
if attributes.has_key?(:'available_online')
|
|
156
|
+
self.available_online = attributes[:'available_online']
|
|
157
|
+
end
|
|
158
|
+
|
|
159
|
+
if attributes.has_key?(:'master_image')
|
|
160
|
+
self.master_image = attributes[:'master_image']
|
|
161
|
+
end
|
|
162
|
+
|
|
163
|
+
if attributes.has_key?(:'category')
|
|
164
|
+
self.category = attributes[:'category']
|
|
165
|
+
end
|
|
166
|
+
|
|
167
|
+
if attributes.has_key?(:'variations')
|
|
168
|
+
if (value = attributes[:'variations']).is_a?(Array)
|
|
169
|
+
self.variations = value
|
|
170
|
+
end
|
|
171
|
+
end
|
|
172
|
+
|
|
173
|
+
if attributes.has_key?(:'modifier_lists')
|
|
174
|
+
if (value = attributes[:'modifier_lists']).is_a?(Array)
|
|
175
|
+
self.modifier_lists = value
|
|
176
|
+
end
|
|
177
|
+
end
|
|
178
|
+
|
|
179
|
+
if attributes.has_key?(:'fees')
|
|
180
|
+
if (value = attributes[:'fees']).is_a?(Array)
|
|
181
|
+
self.fees = value
|
|
182
|
+
end
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
if attributes.has_key?(:'taxable')
|
|
186
|
+
self.taxable = attributes[:'taxable']
|
|
187
|
+
end
|
|
188
|
+
|
|
189
|
+
end
|
|
190
|
+
|
|
191
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
192
|
+
# @return Array for valid properies with the reasons
|
|
193
|
+
def list_invalid_properties
|
|
194
|
+
invalid_properties = Array.new
|
|
195
|
+
return invalid_properties
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
# Check to see if the all the properties in the model are valid
|
|
199
|
+
# @return true if the model is valid
|
|
200
|
+
def valid?
|
|
201
|
+
type_validator = EnumAttributeValidator.new('String', ["NORMAL", "GIFT_CARD", "OTHER"])
|
|
202
|
+
return false unless type_validator.valid?(@type)
|
|
203
|
+
color_validator = EnumAttributeValidator.new('String', ["9da2a6", "4ab200", "0b8000", "2952cc", "a82ee5", "e5457a", "b21212", "593c00", "e5BF00"])
|
|
204
|
+
return false unless color_validator.valid?(@color)
|
|
205
|
+
visibility_validator = EnumAttributeValidator.new('String', ["PUBLIC", "PRIVATE"])
|
|
206
|
+
return false unless visibility_validator.valid?(@visibility)
|
|
207
|
+
return true
|
|
208
|
+
end
|
|
209
|
+
|
|
210
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
211
|
+
# @param [Object] type Object to be assigned
|
|
212
|
+
def type=(type)
|
|
213
|
+
validator = EnumAttributeValidator.new('String', ["NORMAL", "GIFT_CARD", "OTHER"])
|
|
214
|
+
unless validator.valid?(type)
|
|
215
|
+
fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
|
|
216
|
+
end
|
|
217
|
+
@type = type
|
|
218
|
+
end
|
|
219
|
+
|
|
220
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
221
|
+
# @param [Object] color Object to be assigned
|
|
222
|
+
def color=(color)
|
|
223
|
+
validator = EnumAttributeValidator.new('String', ["9da2a6", "4ab200", "0b8000", "2952cc", "a82ee5", "e5457a", "b21212", "593c00", "e5BF00"])
|
|
224
|
+
unless validator.valid?(color)
|
|
225
|
+
fail ArgumentError, "invalid value for 'color', must be one of #{validator.allowable_values}."
|
|
226
|
+
end
|
|
227
|
+
@color = color
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
231
|
+
# @param [Object] visibility Object to be assigned
|
|
232
|
+
def visibility=(visibility)
|
|
233
|
+
validator = EnumAttributeValidator.new('String', ["PUBLIC", "PRIVATE"])
|
|
234
|
+
unless validator.valid?(visibility)
|
|
235
|
+
fail ArgumentError, "invalid value for 'visibility', must be one of #{validator.allowable_values}."
|
|
236
|
+
end
|
|
237
|
+
@visibility = visibility
|
|
238
|
+
end
|
|
239
|
+
|
|
240
|
+
# Checks equality by comparing each attribute.
|
|
241
|
+
# @param [Object] Object to be compared
|
|
242
|
+
def ==(o)
|
|
243
|
+
return true if self.equal?(o)
|
|
244
|
+
self.class == o.class &&
|
|
245
|
+
id == o.id &&
|
|
246
|
+
name == o.name &&
|
|
247
|
+
description == o.description &&
|
|
248
|
+
type == o.type &&
|
|
249
|
+
color == o.color &&
|
|
250
|
+
abbreviation == o.abbreviation &&
|
|
251
|
+
visibility == o.visibility &&
|
|
252
|
+
available_online == o.available_online &&
|
|
253
|
+
master_image == o.master_image &&
|
|
254
|
+
category == o.category &&
|
|
255
|
+
variations == o.variations &&
|
|
256
|
+
modifier_lists == o.modifier_lists &&
|
|
257
|
+
fees == o.fees &&
|
|
258
|
+
taxable == o.taxable
|
|
259
|
+
end
|
|
260
|
+
|
|
261
|
+
# @see the `==` method
|
|
262
|
+
# @param [Object] Object to be compared
|
|
263
|
+
def eql?(o)
|
|
264
|
+
self == o
|
|
265
|
+
end
|
|
266
|
+
|
|
267
|
+
# Calculates hash code according to all attributes.
|
|
268
|
+
# @return [Fixnum] Hash code
|
|
269
|
+
def hash
|
|
270
|
+
[id, name, description, type, color, abbreviation, visibility, available_online, master_image, category, variations, modifier_lists, fees, taxable].hash
|
|
271
|
+
end
|
|
272
|
+
|
|
273
|
+
# Builds the object from hash
|
|
274
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
275
|
+
# @return [Object] Returns the model itself
|
|
276
|
+
def build_from_hash(attributes)
|
|
277
|
+
return nil unless attributes.is_a?(Hash)
|
|
278
|
+
self.class.swagger_types.each_pair do |key, type|
|
|
279
|
+
if type =~ /\AArray<(.*)>/i
|
|
280
|
+
# check to ensure the input is an array given that the the attribute
|
|
281
|
+
# is documented as an array but the input is not
|
|
282
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
|
283
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
|
|
284
|
+
end
|
|
285
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
|
286
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
|
287
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
|
288
|
+
end
|
|
289
|
+
|
|
290
|
+
self
|
|
291
|
+
end
|
|
292
|
+
|
|
293
|
+
# Deserializes the data based on type
|
|
294
|
+
# @param string type Data type
|
|
295
|
+
# @param string value Value to be deserialized
|
|
296
|
+
# @return [Object] Deserialized data
|
|
297
|
+
def _deserialize(type, value)
|
|
298
|
+
case type.to_sym
|
|
299
|
+
when :DateTime
|
|
300
|
+
DateTime.parse(value)
|
|
301
|
+
when :Date
|
|
302
|
+
Date.parse(value)
|
|
303
|
+
when :String
|
|
304
|
+
value.to_s
|
|
305
|
+
when :Integer
|
|
306
|
+
value.to_i
|
|
307
|
+
when :Float
|
|
308
|
+
value.to_f
|
|
309
|
+
when :BOOLEAN
|
|
310
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
|
311
|
+
true
|
|
312
|
+
else
|
|
313
|
+
false
|
|
314
|
+
end
|
|
315
|
+
when :Object
|
|
316
|
+
# generic object (usually a Hash), return directly
|
|
317
|
+
value
|
|
318
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
|
319
|
+
inner_type = Regexp.last_match[:inner_type]
|
|
320
|
+
value.map { |v| _deserialize(inner_type, v) }
|
|
321
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
|
322
|
+
k_type = Regexp.last_match[:k_type]
|
|
323
|
+
v_type = Regexp.last_match[:v_type]
|
|
324
|
+
{}.tap do |hash|
|
|
325
|
+
value.each do |k, v|
|
|
326
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
|
327
|
+
end
|
|
328
|
+
end
|
|
329
|
+
else # model
|
|
330
|
+
temp_model = SquareConnect.const_get(type).new
|
|
331
|
+
temp_model.build_from_hash(value)
|
|
332
|
+
end
|
|
333
|
+
end
|
|
334
|
+
|
|
335
|
+
# Returns the string representation of the object
|
|
336
|
+
# @return [String] String presentation of the object
|
|
337
|
+
def to_s
|
|
338
|
+
to_hash.to_s
|
|
339
|
+
end
|
|
340
|
+
|
|
341
|
+
# to_body is an alias to to_hash (backward compatibility)
|
|
342
|
+
# @return [Hash] Returns the object in the form of hash
|
|
343
|
+
def to_body
|
|
344
|
+
to_hash
|
|
345
|
+
end
|
|
346
|
+
|
|
347
|
+
# Returns the object in the form of hash
|
|
348
|
+
# @return [Hash] Returns the object in the form of hash
|
|
349
|
+
def to_hash
|
|
350
|
+
hash = {}
|
|
351
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
352
|
+
value = self.send(attr)
|
|
353
|
+
next if value.nil?
|
|
354
|
+
hash[param] = _to_hash(value)
|
|
355
|
+
end
|
|
356
|
+
hash
|
|
357
|
+
end
|
|
358
|
+
|
|
359
|
+
# Outputs non-array value in the form of hash
|
|
360
|
+
# For object, use to_hash. Otherwise, just return the value
|
|
361
|
+
# @param [Object] value Any valid value
|
|
362
|
+
# @return [Hash] Returns the value in the form of hash
|
|
363
|
+
def _to_hash(value)
|
|
364
|
+
if value.is_a?(Array)
|
|
365
|
+
value.compact.map{ |v| _to_hash(v) }
|
|
366
|
+
elsif value.is_a?(Hash)
|
|
367
|
+
{}.tap do |hash|
|
|
368
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
|
369
|
+
end
|
|
370
|
+
elsif value.respond_to? :to_hash
|
|
371
|
+
value.to_hash
|
|
372
|
+
else
|
|
373
|
+
value
|
|
374
|
+
end
|
|
375
|
+
end
|
|
376
|
+
|
|
377
|
+
end
|
|
378
|
+
|
|
379
|
+
end
|