square.rb 46.0.1.20260715 → 46.1.0.20260819
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/.fern/metadata.json +2 -2
- data/.fern/replay.lock +13 -1
- data/lib/square/catalog/types/batch_get_catalog_objects_request.rb +1 -0
- data/lib/square/catalog/types/search_catalog_items_request.rb +1 -0
- data/lib/square/catalog/types/search_catalog_objects_request.rb +1 -0
- data/lib/square/client.rb +1 -1
- data/lib/square/orders/client.rb +3 -2
- data/lib/square/types/batch_get_catalog_objects_response.rb +1 -0
- data/lib/square/types/card_brand.rb +4 -0
- data/lib/square/types/catalog_modifier.rb +1 -0
- data/lib/square/types/catalog_query.rb +1 -0
- data/lib/square/types/catalog_query_modifiers_for_child_list.rb +11 -0
- data/lib/square/types/error_code.rb +9 -0
- data/lib/square/types/include_options.rb +11 -0
- data/lib/square/types/include_type.rb +12 -0
- data/lib/square/types/included_resources.rb +11 -0
- data/lib/square/types/location.rb +2 -0
- data/lib/square/types/search_catalog_items_response.rb +1 -0
- data/lib/square/types/search_catalog_objects_response.rb +1 -0
- data/lib/square/version.rb +1 -1
- data/lib/square.rb +4 -0
- data/reference.md +27 -2
- data/wiremock/wiremock-mappings.json +1 -1
- metadata +6 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 63616f911fd171cb18a87cf222ed8229ba6a655d5d23f0de8c75f2b9d6192779
|
|
4
|
+
data.tar.gz: 485a88f53955ace6b9d56496f22d195b79d2c6199bb3299e44e609d81f96a9eb
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 035613f93744bfa5901c3e00418fc266f50b620839ad6eba5a29726d6a3998b5ef63770e27f2d5912daa52bc2bc9883534f57f54b4f2bd791b63898641c5da00
|
|
7
|
+
data.tar.gz: 6bbd2437912b11bebf662a52101fd3657917d3f3e0aa04c51e741cdc8d2f3ca426b5359dbe60b88b58ee9205f5dc615125c52e55ef744f4e801418d4a1599c95
|
data/.fern/metadata.json
CHANGED
data/.fern/replay.lock
CHANGED
|
@@ -12,5 +12,17 @@ generations:
|
|
|
12
12
|
cli_version: unknown
|
|
13
13
|
generator_versions:
|
|
14
14
|
fernapi/fern-ruby-sdk: 1.0.0-rc84
|
|
15
|
-
|
|
15
|
+
- commit_sha: b0712bf25b1ee3e2ec220e59c3c61688c2b75c6f
|
|
16
|
+
tree_hash: 4a2f9cd8e383c435dcd1ba76069c1ae9d761aa67
|
|
17
|
+
timestamp: 2026-08-18T17:49:33.834Z
|
|
18
|
+
cli_version: unknown
|
|
19
|
+
generator_versions:
|
|
20
|
+
fernapi/fern-ruby-sdk: 1.0.0-rc84
|
|
21
|
+
- commit_sha: 2b507b58f33418df2cef553d5c1a2abbab7f3960
|
|
22
|
+
tree_hash: a5aa4a24276c8810c55ba372f9ab4180165faf92
|
|
23
|
+
timestamp: 2026-08-18T20:55:11.217Z
|
|
24
|
+
cli_version: unknown
|
|
25
|
+
generator_versions:
|
|
26
|
+
fernapi/fern-ruby-sdk: 1.0.0-rc84
|
|
27
|
+
current_generation: 2b507b58f33418df2cef553d5c1a2abbab7f3960
|
|
16
28
|
patches: []
|
|
@@ -9,6 +9,7 @@ module Square
|
|
|
9
9
|
field :catalog_version, -> { Integer }, optional: true, nullable: false
|
|
10
10
|
field :include_deleted_objects, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
11
11
|
field :include_category_path_to_root, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
12
|
+
field :include_options, -> { Square::Types::IncludeOptions }, optional: true, nullable: false
|
|
12
13
|
end
|
|
13
14
|
end
|
|
14
15
|
end
|
|
@@ -14,6 +14,7 @@ module Square
|
|
|
14
14
|
field :product_types, -> { Internal::Types::Array[Square::Types::CatalogItemProductType] }, optional: true, nullable: false
|
|
15
15
|
field :custom_attribute_filters, -> { Internal::Types::Array[Square::Types::CustomAttributeFilter] }, optional: true, nullable: false
|
|
16
16
|
field :archived_state, -> { Square::Types::ArchivedState }, optional: true, nullable: false
|
|
17
|
+
field :include_options, -> { Square::Types::IncludeOptions }, optional: true, nullable: false
|
|
17
18
|
end
|
|
18
19
|
end
|
|
19
20
|
end
|
|
@@ -12,6 +12,7 @@ module Square
|
|
|
12
12
|
field :query, -> { Square::Types::CatalogQuery }, optional: true, nullable: false
|
|
13
13
|
field :limit, -> { Integer }, optional: true, nullable: false
|
|
14
14
|
field :include_category_path_to_root, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
15
|
+
field :include_options, -> { Square::Types::IncludeOptions }, optional: true, nullable: false
|
|
15
16
|
end
|
|
16
17
|
end
|
|
17
18
|
end
|
data/lib/square/client.rb
CHANGED
|
@@ -10,7 +10,7 @@ module Square
|
|
|
10
10
|
@raw_client = Square::Internal::Http::RawClient.new(
|
|
11
11
|
base_url: base_url || Square::Environment::PRODUCTION,
|
|
12
12
|
headers: {
|
|
13
|
-
"User-Agent" => "square.rb/46.0.
|
|
13
|
+
"User-Agent" => "square.rb/46.1.0.20260819",
|
|
14
14
|
"X-Fern-Language" => "Ruby",
|
|
15
15
|
Authorization: "Bearer #{token}"
|
|
16
16
|
}
|
data/lib/square/orders/client.rb
CHANGED
|
@@ -170,8 +170,9 @@ module Square
|
|
|
170
170
|
#
|
|
171
171
|
# Note that details for orders processed with Square Point of Sale while in
|
|
172
172
|
# offline mode might not be transmitted to Square for up to 72 hours. Offline
|
|
173
|
-
# orders have a `created_at` value that reflects the time the order was
|
|
174
|
-
# not the time
|
|
173
|
+
# orders have a `created_at` value that reflects the time the order was
|
|
174
|
+
# transmitted to Square and created server-side, not the time the order was
|
|
175
|
+
# created on the Point of Sale device.
|
|
175
176
|
#
|
|
176
177
|
# @param request_options [Hash]
|
|
177
178
|
# @param params [Square::Orders::Types::SearchOrdersRequest]
|
|
@@ -6,6 +6,7 @@ module Square
|
|
|
6
6
|
field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
|
|
7
7
|
field :objects, -> { Internal::Types::Array[Square::Types::CatalogObject] }, optional: true, nullable: false
|
|
8
8
|
field :related_objects, -> { Internal::Types::Array[Square::Types::CatalogObject] }, optional: true, nullable: false
|
|
9
|
+
field :included_resources, -> { Square::Types::IncludedResources }, optional: true, nullable: false
|
|
9
10
|
end
|
|
10
11
|
end
|
|
11
12
|
end
|
|
@@ -14,6 +14,7 @@ module Square
|
|
|
14
14
|
field :kitchen_name, -> { String }, optional: true, nullable: false
|
|
15
15
|
field :image_id, -> { String }, optional: true, nullable: false
|
|
16
16
|
field :hidden_online, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
|
17
|
+
field :child_modifier_list_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
|
|
17
18
|
end
|
|
18
19
|
end
|
|
19
20
|
end
|
|
@@ -43,6 +43,7 @@ module Square
|
|
|
43
43
|
field :items_for_modifier_list_query, -> { Square::Types::CatalogQueryItemsForModifierList }, optional: true, nullable: false
|
|
44
44
|
field :items_for_item_options_query, -> { Square::Types::CatalogQueryItemsForItemOptions }, optional: true, nullable: false
|
|
45
45
|
field :item_variations_for_item_option_values_query, -> { Square::Types::CatalogQueryItemVariationsForItemOptionValues }, optional: true, nullable: false
|
|
46
|
+
field :modifiers_for_child_list_query, -> { Square::Types::CatalogQueryModifiersForChildList }, optional: true, nullable: false
|
|
46
47
|
end
|
|
47
48
|
end
|
|
48
49
|
end
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Square
|
|
4
|
+
module Types
|
|
5
|
+
# Query to find `CatalogModifier` objects that reference a given `CatalogModifierList` in their
|
|
6
|
+
# `child_modifier_list_ids` field.
|
|
7
|
+
class CatalogQueryModifiersForChildList < Internal::Types::Model
|
|
8
|
+
field :child_modifier_list_ids, -> { Internal::Types::Array[String] }, optional: false, nullable: false
|
|
9
|
+
end
|
|
10
|
+
end
|
|
11
|
+
end
|
|
@@ -103,6 +103,7 @@ module Square
|
|
|
103
103
|
CARD_TOKEN_EXPIRED = "CARD_TOKEN_EXPIRED"
|
|
104
104
|
CARD_TOKEN_USED = "CARD_TOKEN_USED"
|
|
105
105
|
AMOUNT_TOO_HIGH = "AMOUNT_TOO_HIGH"
|
|
106
|
+
AMOUNT_TOO_LOW = "AMOUNT_TOO_LOW"
|
|
106
107
|
UNSUPPORTED_INSTRUMENT_TYPE = "UNSUPPORTED_INSTRUMENT_TYPE"
|
|
107
108
|
REFUND_AMOUNT_INVALID = "REFUND_AMOUNT_INVALID"
|
|
108
109
|
REFUND_ALREADY_PENDING = "REFUND_ALREADY_PENDING"
|
|
@@ -133,6 +134,13 @@ module Square
|
|
|
133
134
|
PLAID_ERROR = "PLAID_ERROR"
|
|
134
135
|
PLAID_ERROR_ITEM_LOGIN_REQUIRED = "PLAID_ERROR_ITEM_LOGIN_REQUIRED"
|
|
135
136
|
PLAID_ERROR_RATE_LIMIT = "PLAID_ERROR_RATE_LIMIT"
|
|
137
|
+
PLAID_ERROR_INVALID_ACCESS_TOKEN = "PLAID_ERROR_INVALID_ACCESS_TOKEN"
|
|
138
|
+
PLAID_ERROR_INVALID_ACCOUNT_ID = "PLAID_ERROR_INVALID_ACCOUNT_ID"
|
|
139
|
+
PLAID_ERROR_NO_ACCOUNTS = "PLAID_ERROR_NO_ACCOUNTS"
|
|
140
|
+
PLAID_ERROR_ITEM_NOT_FOUND = "PLAID_ERROR_ITEM_NOT_FOUND"
|
|
141
|
+
PLAID_ERROR_INSUFFICIENT_CREDENTIALS = "PLAID_ERROR_INSUFFICIENT_CREDENTIALS"
|
|
142
|
+
PLAID_ERROR_ITEM_NOT_SUPPORTED = "PLAID_ERROR_ITEM_NOT_SUPPORTED"
|
|
143
|
+
PLAID_ERROR_PRODUCT_NOT_READY = "PLAID_ERROR_PRODUCT_NOT_READY"
|
|
136
144
|
PAYMENT_SOURCE_NOT_ENABLED_FOR_TARGET = "PAYMENT_SOURCE_NOT_ENABLED_FOR_TARGET"
|
|
137
145
|
CARD_DECLINED = "CARD_DECLINED"
|
|
138
146
|
VERIFY_CVV_FAILURE = "VERIFY_CVV_FAILURE"
|
|
@@ -144,6 +152,7 @@ module Square
|
|
|
144
152
|
ALLOWABLE_PIN_TRIES_EXCEEDED = "ALLOWABLE_PIN_TRIES_EXCEEDED"
|
|
145
153
|
RESERVATION_DECLINED = "RESERVATION_DECLINED"
|
|
146
154
|
UNKNOWN_BODY_PARAMETER = "UNKNOWN_BODY_PARAMETER"
|
|
155
|
+
CART_INELIGIBLE_FOR_EBT = "CART_INELIGIBLE_FOR_EBT"
|
|
147
156
|
NOT_FOUND = "NOT_FOUND"
|
|
148
157
|
APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND = "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND"
|
|
149
158
|
METHOD_NOT_ALLOWED = "METHOD_NOT_ALLOWED"
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Square
|
|
4
|
+
module Types
|
|
5
|
+
# Options to include related resources of the requested `CatalogObject`s. Related resources will be included in
|
|
6
|
+
# `IncludedResources` in the response.
|
|
7
|
+
class IncludeOptions < Internal::Types::Model
|
|
8
|
+
field :include, -> { Internal::Types::Array[Square::Types::IncludeType] }, optional: true, nullable: false
|
|
9
|
+
end
|
|
10
|
+
end
|
|
11
|
+
end
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Square
|
|
4
|
+
module Types
|
|
5
|
+
module IncludeType
|
|
6
|
+
extend Square::Internal::Types::Enum
|
|
7
|
+
|
|
8
|
+
INCLUDE_NESTED_MODIFIERS = "INCLUDE_NESTED_MODIFIERS"
|
|
9
|
+
INCLUDE_ANCESTOR_MODIFIERS = "INCLUDE_ANCESTOR_MODIFIERS"
|
|
10
|
+
end
|
|
11
|
+
end
|
|
12
|
+
end
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Square
|
|
4
|
+
module Types
|
|
5
|
+
# Related resources of the response `CatalogObject`s requested using `IncludeOptions`
|
|
6
|
+
class IncludedResources < Internal::Types::Model
|
|
7
|
+
field :nested_modifiers, -> { Internal::Types::Array[Square::Types::CatalogObject] }, optional: true, nullable: false
|
|
8
|
+
field :ancestor_modifiers, -> { Internal::Types::Array[Square::Types::CatalogObject] }, optional: true, nullable: false
|
|
9
|
+
end
|
|
10
|
+
end
|
|
11
|
+
end
|
|
@@ -31,6 +31,8 @@ module Square
|
|
|
31
31
|
field :mcc, -> { String }, optional: true, nullable: false
|
|
32
32
|
field :full_format_logo_url, -> { String }, optional: true, nullable: false
|
|
33
33
|
field :tax_ids, -> { Square::Types::TaxIds }, optional: true, nullable: false
|
|
34
|
+
field :custom_receipt_text, -> { String }, optional: true, nullable: false
|
|
35
|
+
field :return_policy, -> { String }, optional: true, nullable: false
|
|
34
36
|
end
|
|
35
37
|
end
|
|
36
38
|
end
|
|
@@ -9,6 +9,7 @@ module Square
|
|
|
9
9
|
field :items, -> { Internal::Types::Array[Square::Types::CatalogObject] }, optional: true, nullable: false
|
|
10
10
|
field :cursor, -> { String }, optional: true, nullable: false
|
|
11
11
|
field :matched_variation_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
|
|
12
|
+
field :included_resources, -> { Square::Types::IncludedResources }, optional: true, nullable: false
|
|
12
13
|
end
|
|
13
14
|
end
|
|
14
15
|
end
|
|
@@ -8,6 +8,7 @@ module Square
|
|
|
8
8
|
field :objects, -> { Internal::Types::Array[Square::Types::CatalogObject] }, optional: true, nullable: false
|
|
9
9
|
field :related_objects, -> { Internal::Types::Array[Square::Types::CatalogObject] }, optional: true, nullable: false
|
|
10
10
|
field :latest_time, -> { String }, optional: true, nullable: false
|
|
11
|
+
field :included_resources, -> { Square::Types::IncludedResources }, optional: true, nullable: false
|
|
11
12
|
end
|
|
12
13
|
end
|
|
13
14
|
end
|
data/lib/square/version.rb
CHANGED
data/lib/square.rb
CHANGED
|
@@ -196,6 +196,7 @@ require_relative "square/types/catalog_object"
|
|
|
196
196
|
require_relative "square/types/catalog_modifier_list"
|
|
197
197
|
require_relative "square/types/catalog_item_option"
|
|
198
198
|
require_relative "square/types/catalog_item"
|
|
199
|
+
require_relative "square/types/included_resources"
|
|
199
200
|
require_relative "square/types/batch_get_catalog_objects_response"
|
|
200
201
|
require_relative "square/types/batch_retrieve_inventory_changes_sort_field"
|
|
201
202
|
require_relative "square/types/sort_order"
|
|
@@ -516,6 +517,7 @@ require_relative "square/types/catalog_query_item_variations_for_item_option_val
|
|
|
516
517
|
require_relative "square/types/catalog_query_items_for_item_options"
|
|
517
518
|
require_relative "square/types/catalog_query_items_for_modifier_list"
|
|
518
519
|
require_relative "square/types/catalog_query_items_for_tax"
|
|
520
|
+
require_relative "square/types/catalog_query_modifiers_for_child_list"
|
|
519
521
|
require_relative "square/types/catalog_query_prefix"
|
|
520
522
|
require_relative "square/types/catalog_query_range"
|
|
521
523
|
require_relative "square/types/catalog_query_set"
|
|
@@ -830,6 +832,8 @@ require_relative "square/types/gift_card_customer_unlinked_event"
|
|
|
830
832
|
require_relative "square/types/gift_card_updated_event_object"
|
|
831
833
|
require_relative "square/types/gift_card_updated_event_data"
|
|
832
834
|
require_relative "square/types/gift_card_updated_event"
|
|
835
|
+
require_relative "square/types/include_type"
|
|
836
|
+
require_relative "square/types/include_options"
|
|
833
837
|
require_relative "square/types/inventory_count_updated_event_object"
|
|
834
838
|
require_relative "square/types/inventory_count_updated_event_data"
|
|
835
839
|
require_relative "square/types/inventory_count_updated_event"
|
data/reference.md
CHANGED
|
@@ -2501,6 +2501,14 @@ in the response payload.
|
|
|
2501
2501
|
<dl>
|
|
2502
2502
|
<dd>
|
|
2503
2503
|
|
|
2504
|
+
**include_options:** `Square::Types::IncludeOptions` — Options to include related resources in the response.
|
|
2505
|
+
|
|
2506
|
+
</dd>
|
|
2507
|
+
</dl>
|
|
2508
|
+
|
|
2509
|
+
<dl>
|
|
2510
|
+
<dd>
|
|
2511
|
+
|
|
2504
2512
|
**request_options:** `Square::Catalog::RequestOptions`
|
|
2505
2513
|
|
|
2506
2514
|
</dd>
|
|
@@ -2978,6 +2986,14 @@ is higher than the maximum limit of 1,000, it will be ignored.
|
|
|
2978
2986
|
<dl>
|
|
2979
2987
|
<dd>
|
|
2980
2988
|
|
|
2989
|
+
**include_options:** `Square::Types::IncludeOptions` — Options to include related resources in the response.
|
|
2990
|
+
|
|
2991
|
+
</dd>
|
|
2992
|
+
</dl>
|
|
2993
|
+
|
|
2994
|
+
<dl>
|
|
2995
|
+
<dd>
|
|
2996
|
+
|
|
2981
2997
|
**request_options:** `Square::Catalog::RequestOptions`
|
|
2982
2998
|
|
|
2983
2999
|
</dd>
|
|
@@ -3158,6 +3174,14 @@ a single call to the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItem
|
|
|
3158
3174
|
<dl>
|
|
3159
3175
|
<dd>
|
|
3160
3176
|
|
|
3177
|
+
**include_options:** `Square::Types::IncludeOptions` — Options to include related resources in the response.
|
|
3178
|
+
|
|
3179
|
+
</dd>
|
|
3180
|
+
</dl>
|
|
3181
|
+
|
|
3182
|
+
<dl>
|
|
3183
|
+
<dd>
|
|
3184
|
+
|
|
3161
3185
|
**request_options:** `Square::Catalog::RequestOptions`
|
|
3162
3186
|
|
|
3163
3187
|
</dd>
|
|
@@ -11227,8 +11251,9 @@ how to sort or filter the results. Your `SearchOrdersQuery` can:
|
|
|
11227
11251
|
|
|
11228
11252
|
Note that details for orders processed with Square Point of Sale while in
|
|
11229
11253
|
offline mode might not be transmitted to Square for up to 72 hours. Offline
|
|
11230
|
-
orders have a `created_at` value that reflects the time the order was
|
|
11231
|
-
not the time
|
|
11254
|
+
orders have a `created_at` value that reflects the time the order was
|
|
11255
|
+
transmitted to Square and created server-side, not the time the order was
|
|
11256
|
+
created on the Point of Sale device.
|
|
11232
11257
|
</dd>
|
|
11233
11258
|
</dl>
|
|
11234
11259
|
</dd>
|