square.rb 44.1.0.20250924 → 44.2.0.20251016
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/lib/square/channels/client.rb +84 -0
- data/lib/square/channels/types/bulk_retrieve_channels_request.rb +11 -0
- data/lib/square/channels/types/get_channels_request.rb +11 -0
- data/lib/square/channels/types/list_channels_request.rb +15 -0
- data/lib/square/client.rb +11 -1
- data/lib/square/loyalty/programs/promotions/types/cancel_promotions_request.rb +1 -1
- data/lib/square/loyalty/programs/promotions/types/get_promotions_request.rb +1 -1
- data/lib/square/transfer_orders/client.rb +287 -0
- data/lib/square/transfer_orders/types/cancel_transfer_order_request.rb +13 -0
- data/lib/square/transfer_orders/types/create_transfer_order_request.rb +12 -0
- data/lib/square/transfer_orders/types/delete_transfer_orders_request.rb +12 -0
- data/lib/square/transfer_orders/types/get_transfer_orders_request.rb +11 -0
- data/lib/square/transfer_orders/types/receive_transfer_order_request.rb +14 -0
- data/lib/square/transfer_orders/types/search_transfer_orders_request.rb +13 -0
- data/lib/square/transfer_orders/types/start_transfer_order_request.rb +13 -0
- data/lib/square/transfer_orders/types/update_transfer_order_request.rb +14 -0
- data/lib/square/types/bulk_retrieve_channels_response.rb +14 -0
- data/lib/square/types/cancel_transfer_order_response.rb +11 -0
- data/lib/square/types/channel.rb +16 -0
- data/lib/square/types/channel_status.rb +12 -0
- data/lib/square/types/create_transfer_order_data.rb +20 -0
- data/lib/square/types/create_transfer_order_line_data.rb +12 -0
- data/lib/square/types/create_transfer_order_response.rb +11 -0
- data/lib/square/types/delete_transfer_order_response.rb +10 -0
- data/lib/square/types/list_channels_response.rb +11 -0
- data/lib/square/types/receive_transfer_order_response.rb +11 -0
- data/lib/square/types/reference.rb +10 -0
- data/lib/square/types/reference_type.rb +25 -0
- data/lib/square/types/retrieve_channel_response.rb +10 -0
- data/lib/square/types/retrieve_transfer_order_response.rb +11 -0
- data/lib/square/types/search_transfer_orders_response.rb +14 -0
- data/lib/square/types/start_transfer_order_response.rb +11 -0
- data/lib/square/types/transfer_order.rb +37 -0
- data/lib/square/types/transfer_order_created_event.rb +14 -0
- data/lib/square/types/transfer_order_created_event_data.rb +11 -0
- data/lib/square/types/transfer_order_created_event_object.rb +9 -0
- data/lib/square/types/transfer_order_deleted_event.rb +14 -0
- data/lib/square/types/transfer_order_deleted_event_data.rb +11 -0
- data/lib/square/types/transfer_order_filter.rb +14 -0
- data/lib/square/types/transfer_order_goods_receipt.rb +29 -0
- data/lib/square/types/transfer_order_goods_receipt_line_item.rb +13 -0
- data/lib/square/types/transfer_order_line.rb +18 -0
- data/lib/square/types/transfer_order_query.rb +11 -0
- data/lib/square/types/transfer_order_sort.rb +11 -0
- data/lib/square/types/transfer_order_sort_field.rb +12 -0
- data/lib/square/types/transfer_order_status.rb +15 -0
- data/lib/square/types/transfer_order_updated_event.rb +14 -0
- data/lib/square/types/transfer_order_updated_event_data.rb +11 -0
- data/lib/square/types/transfer_order_updated_event_object.rb +9 -0
- data/lib/square/types/update_transfer_order_data.rb +17 -0
- data/lib/square/types/update_transfer_order_line_data.rb +13 -0
- data/lib/square/types/update_transfer_order_response.rb +11 -0
- data/lib/square/version.rb +1 -1
- data/lib/square.rb +49 -0
- metadata +51 -2
@@ -0,0 +1,20 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Data for creating a new transfer order to move [CatalogItemVariation](entity:CatalogItemVariation)s
|
6
|
+
# between [Location](entity:Location)s. Used with the [CreateTransferOrder](api-endpoint:TransferOrders-CreateTransferOrder)
|
7
|
+
# endpoint.
|
8
|
+
class CreateTransferOrderData < Internal::Types::Model
|
9
|
+
field :source_location_id, -> { String }, optional: false, nullable: false
|
10
|
+
field :destination_location_id, -> { String }, optional: false, nullable: false
|
11
|
+
field :expected_at, -> { String }, optional: true, nullable: false
|
12
|
+
field :notes, -> { String }, optional: true, nullable: false
|
13
|
+
field :tracking_number, -> { String }, optional: true, nullable: false
|
14
|
+
field :created_by_team_member_id, -> { String }, optional: true, nullable: false
|
15
|
+
field :line_items, lambda {
|
16
|
+
Internal::Types::Array[Square::Types::CreateTransferOrderLineData]
|
17
|
+
}, optional: true, nullable: false
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Data for creating a new transfer order line item. Each line item specifies a
|
6
|
+
# [CatalogItemVariation](entity:CatalogItemVariation) and quantity to transfer.
|
7
|
+
class CreateTransferOrderLineData < Internal::Types::Model
|
8
|
+
field :item_variation_id, -> { String }, optional: false, nullable: false
|
9
|
+
field :quantity_ordered, -> { String }, optional: false, nullable: false
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Response for creating a transfer order.
|
6
|
+
class CreateTransferOrderResponse < Internal::Types::Model
|
7
|
+
field :transfer_order, -> { Square::Types::TransferOrder }, optional: true, nullable: false
|
8
|
+
field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Response for deleting a transfer order
|
6
|
+
class DeleteTransferOrderResponse < Internal::Types::Model
|
7
|
+
field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
|
8
|
+
end
|
9
|
+
end
|
10
|
+
end
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
class ListChannelsResponse < Internal::Types::Model
|
6
|
+
field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
|
7
|
+
field :channels, -> { Internal::Types::Array[Square::Types::Channel] }, optional: true, nullable: false
|
8
|
+
field :cursor, -> { String }, optional: true, nullable: false
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Response for receiving items for a transfer order
|
6
|
+
class ReceiveTransferOrderResponse < Internal::Types::Model
|
7
|
+
field :transfer_order, -> { Square::Types::TransferOrder }, optional: true, nullable: false
|
8
|
+
field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
class Reference < Internal::Types::Model
|
6
|
+
field :type, -> { Square::Types::ReferenceType }, optional: true, nullable: false
|
7
|
+
field :id, -> { String }, optional: true, nullable: false
|
8
|
+
end
|
9
|
+
end
|
10
|
+
end
|
@@ -0,0 +1,25 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
module ReferenceType
|
6
|
+
extend Square::Internal::Types::Enum
|
7
|
+
|
8
|
+
UNKNOWN_TYPE = "UNKNOWN_TYPE"
|
9
|
+
LOCATION = "LOCATION"
|
10
|
+
FIRST_PARTY_INTEGRATION = "FIRST_PARTY_INTEGRATION"
|
11
|
+
OAUTH_APPLICATION = "OAUTH_APPLICATION"
|
12
|
+
ONLINE_SITE = "ONLINE_SITE"
|
13
|
+
ONLINE_CHECKOUT = "ONLINE_CHECKOUT"
|
14
|
+
INVOICE = "INVOICE"
|
15
|
+
GIFT_CARD = "GIFT_CARD"
|
16
|
+
GIFT_CARD_MARKETPLACE = "GIFT_CARD_MARKETPLACE"
|
17
|
+
RECURRING_SUBSCRIPTION = "RECURRING_SUBSCRIPTION"
|
18
|
+
ONLINE_BOOKING_FLOW = "ONLINE_BOOKING_FLOW"
|
19
|
+
SQUARE_ASSISTANT = "SQUARE_ASSISTANT"
|
20
|
+
CASH_LOCAL = "CASH_LOCAL"
|
21
|
+
POINT_OF_SALE = "POINT_OF_SALE"
|
22
|
+
KIOSK = "KIOSK"
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
class RetrieveChannelResponse < Internal::Types::Model
|
6
|
+
field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
|
7
|
+
field :channel, -> { Square::Types::Channel }, optional: true, nullable: false
|
8
|
+
end
|
9
|
+
end
|
10
|
+
end
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Response containing the requested transfer order
|
6
|
+
class RetrieveTransferOrderResponse < Internal::Types::Model
|
7
|
+
field :transfer_order, -> { Square::Types::TransferOrder }, optional: true, nullable: false
|
8
|
+
field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Response for searching transfer orders
|
6
|
+
class SearchTransferOrdersResponse < Internal::Types::Model
|
7
|
+
field :transfer_orders, lambda {
|
8
|
+
Internal::Types::Array[Square::Types::TransferOrder]
|
9
|
+
}, optional: true, nullable: false
|
10
|
+
field :cursor, -> { String }, optional: true, nullable: false
|
11
|
+
field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Response for starting a transfer order.
|
6
|
+
class StartTransferOrderResponse < Internal::Types::Model
|
7
|
+
field :transfer_order, -> { Square::Types::TransferOrder }, optional: true, nullable: false
|
8
|
+
field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Represents a transfer order for moving [CatalogItemVariation](entity:CatalogItemVariation)s
|
6
|
+
# between [Location](entity:Location)s. Transfer orders track the entire lifecycle of an inventory
|
7
|
+
# transfer, including:
|
8
|
+
# - What items and quantities are being moved
|
9
|
+
# - Source and destination locations
|
10
|
+
# - Current [TransferOrderStatus](entity:TransferOrderStatus)
|
11
|
+
# - Shipping information and tracking
|
12
|
+
# - Which [TeamMember](entity:TeamMember) initiated the transfer
|
13
|
+
#
|
14
|
+
# This object is commonly used to:
|
15
|
+
# - Track [CatalogItemVariation](entity:CatalogItemVariation) movements between [Location](entity:Location)s
|
16
|
+
# - Reconcile expected vs received quantities
|
17
|
+
# - Monitor transfer progress and shipping status
|
18
|
+
# - Audit inventory movement history
|
19
|
+
class TransferOrder < Internal::Types::Model
|
20
|
+
field :id, -> { String }, optional: true, nullable: false
|
21
|
+
field :source_location_id, -> { String }, optional: true, nullable: false
|
22
|
+
field :destination_location_id, -> { String }, optional: true, nullable: false
|
23
|
+
field :status, -> { Square::Types::TransferOrderStatus }, optional: true, nullable: false
|
24
|
+
field :created_at, -> { String }, optional: true, nullable: false
|
25
|
+
field :updated_at, -> { String }, optional: true, nullable: false
|
26
|
+
field :expected_at, -> { String }, optional: true, nullable: false
|
27
|
+
field :completed_at, -> { String }, optional: true, nullable: false
|
28
|
+
field :notes, -> { String }, optional: true, nullable: false
|
29
|
+
field :tracking_number, -> { String }, optional: true, nullable: false
|
30
|
+
field :created_by_team_member_id, -> { String }, optional: true, nullable: false
|
31
|
+
field :line_items, lambda {
|
32
|
+
Internal::Types::Array[Square::Types::TransferOrderLine]
|
33
|
+
}, optional: true, nullable: false
|
34
|
+
field :version, -> { Integer }, optional: true, nullable: false
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Published when a transfer_order is created.
|
6
|
+
class TransferOrderCreatedEvent < Internal::Types::Model
|
7
|
+
field :merchant_id, -> { String }, optional: true, nullable: false
|
8
|
+
field :type, -> { String }, optional: true, nullable: false
|
9
|
+
field :event_id, -> { String }, optional: true, nullable: false
|
10
|
+
field :created_at, -> { String }, optional: true, nullable: false
|
11
|
+
field :data, -> { Square::Types::TransferOrderCreatedEventData }, optional: true, nullable: false
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
class TransferOrderCreatedEventData < Internal::Types::Model
|
6
|
+
field :type, -> { String }, optional: true, nullable: false
|
7
|
+
field :id, -> { String }, optional: true, nullable: false
|
8
|
+
field :object, -> { Square::Types::TransferOrderCreatedEventObject }, optional: true, nullable: false
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Published when a transfer_order is deleted.
|
6
|
+
class TransferOrderDeletedEvent < Internal::Types::Model
|
7
|
+
field :merchant_id, -> { String }, optional: true, nullable: false
|
8
|
+
field :type, -> { String }, optional: true, nullable: false
|
9
|
+
field :event_id, -> { String }, optional: true, nullable: false
|
10
|
+
field :created_at, -> { String }, optional: true, nullable: false
|
11
|
+
field :data, -> { Square::Types::TransferOrderDeletedEventData }, optional: true, nullable: false
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
class TransferOrderDeletedEventData < Internal::Types::Model
|
6
|
+
field :type, -> { String }, optional: true, nullable: false
|
7
|
+
field :id, -> { String }, optional: true, nullable: false
|
8
|
+
field :deleted, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Filter criteria for searching transfer orders
|
6
|
+
class TransferOrderFilter < Internal::Types::Model
|
7
|
+
field :source_location_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
|
8
|
+
field :destination_location_ids, -> { Internal::Types::Array[String] }, optional: true, nullable: false
|
9
|
+
field :statuses, lambda {
|
10
|
+
Internal::Types::Array[Square::Types::TransferOrderStatus]
|
11
|
+
}, optional: true, nullable: false
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# The goods receipt details for a transfer order. This object represents a single receipt
|
6
|
+
# of goods against a transfer order, tracking:
|
7
|
+
#
|
8
|
+
# - Which [CatalogItemVariation](entity:CatalogItemVariation)s were received
|
9
|
+
# - Quantities received in good condition
|
10
|
+
# - Quantities damaged during transit/handling
|
11
|
+
# - Quantities canceled during receipt
|
12
|
+
#
|
13
|
+
# Multiple goods receipts can be created for a single transfer order to handle:
|
14
|
+
# - Partial deliveries
|
15
|
+
# - Multiple shipments
|
16
|
+
# - Split receipts across different dates
|
17
|
+
# - Cancellations of specific quantities
|
18
|
+
#
|
19
|
+
# Each receipt automatically:
|
20
|
+
# - Updates the transfer order status
|
21
|
+
# - Adjusts received quantities
|
22
|
+
# - Updates inventory levels at both source and destination [Location](entity:Location)s
|
23
|
+
class TransferOrderGoodsReceipt < Internal::Types::Model
|
24
|
+
field :line_items, lambda {
|
25
|
+
Internal::Types::Array[Square::Types::TransferOrderGoodsReceiptLineItem]
|
26
|
+
}, optional: true, nullable: false
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# A simplified line item for goods receipts in transfer orders
|
6
|
+
class TransferOrderGoodsReceiptLineItem < Internal::Types::Model
|
7
|
+
field :transfer_order_line_uid, -> { String }, optional: false, nullable: false
|
8
|
+
field :quantity_received, -> { String }, optional: true, nullable: false
|
9
|
+
field :quantity_damaged, -> { String }, optional: true, nullable: false
|
10
|
+
field :quantity_canceled, -> { String }, optional: true, nullable: false
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Represents a line item in a transfer order. Each line item tracks a specific
|
6
|
+
# [CatalogItemVariation](entity:CatalogItemVariation) being transferred, including ordered quantities
|
7
|
+
# and receipt status.
|
8
|
+
class TransferOrderLine < Internal::Types::Model
|
9
|
+
field :uid, -> { String }, optional: true, nullable: false
|
10
|
+
field :item_variation_id, -> { String }, optional: false, nullable: false
|
11
|
+
field :quantity_ordered, -> { String }, optional: false, nullable: false
|
12
|
+
field :quantity_pending, -> { String }, optional: true, nullable: false
|
13
|
+
field :quantity_received, -> { String }, optional: true, nullable: false
|
14
|
+
field :quantity_damaged, -> { String }, optional: true, nullable: false
|
15
|
+
field :quantity_canceled, -> { String }, optional: true, nullable: false
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Query parameters for searching transfer orders
|
6
|
+
class TransferOrderQuery < Internal::Types::Model
|
7
|
+
field :filter, -> { Square::Types::TransferOrderFilter }, optional: true, nullable: false
|
8
|
+
field :sort, -> { Square::Types::TransferOrderSort }, optional: true, nullable: false
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Sort configuration for search results
|
6
|
+
class TransferOrderSort < Internal::Types::Model
|
7
|
+
field :field, -> { Square::Types::TransferOrderSortField }, optional: true, nullable: false
|
8
|
+
field :order, -> { Square::Types::SortOrder }, optional: true, nullable: false
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
module TransferOrderStatus
|
6
|
+
extend Square::Internal::Types::Enum
|
7
|
+
|
8
|
+
DRAFT = "DRAFT"
|
9
|
+
STARTED = "STARTED"
|
10
|
+
PARTIALLY_RECEIVED = "PARTIALLY_RECEIVED"
|
11
|
+
COMPLETED = "COMPLETED"
|
12
|
+
CANCELED = "CANCELED"
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Published when a transfer_order is updated.
|
6
|
+
class TransferOrderUpdatedEvent < Internal::Types::Model
|
7
|
+
field :merchant_id, -> { String }, optional: true, nullable: false
|
8
|
+
field :type, -> { String }, optional: true, nullable: false
|
9
|
+
field :event_id, -> { String }, optional: true, nullable: false
|
10
|
+
field :created_at, -> { String }, optional: true, nullable: false
|
11
|
+
field :data, -> { Square::Types::TransferOrderUpdatedEventData }, optional: true, nullable: false
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
class TransferOrderUpdatedEventData < Internal::Types::Model
|
6
|
+
field :type, -> { String }, optional: true, nullable: false
|
7
|
+
field :id, -> { String }, optional: true, nullable: false
|
8
|
+
field :object, -> { Square::Types::TransferOrderUpdatedEventObject }, optional: true, nullable: false
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Data model for updating a transfer order. All fields are optional.
|
6
|
+
class UpdateTransferOrderData < Internal::Types::Model
|
7
|
+
field :source_location_id, -> { String }, optional: true, nullable: false
|
8
|
+
field :destination_location_id, -> { String }, optional: true, nullable: false
|
9
|
+
field :expected_at, -> { String }, optional: true, nullable: false
|
10
|
+
field :notes, -> { String }, optional: true, nullable: false
|
11
|
+
field :tracking_number, -> { String }, optional: true, nullable: false
|
12
|
+
field :line_items, lambda {
|
13
|
+
Internal::Types::Array[Square::Types::UpdateTransferOrderLineData]
|
14
|
+
}, optional: true, nullable: false
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Represents a line item update in a transfer order
|
6
|
+
class UpdateTransferOrderLineData < Internal::Types::Model
|
7
|
+
field :uid, -> { String }, optional: true, nullable: false
|
8
|
+
field :item_variation_id, -> { String }, optional: true, nullable: false
|
9
|
+
field :quantity_ordered, -> { String }, optional: true, nullable: false
|
10
|
+
field :remove, -> { Internal::Types::Boolean }, optional: true, nullable: false
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Square
|
4
|
+
module Types
|
5
|
+
# Response for updating a transfer order
|
6
|
+
class UpdateTransferOrderResponse < Internal::Types::Model
|
7
|
+
field :transfer_order, -> { Square::Types::TransferOrder }, optional: true, nullable: false
|
8
|
+
field :errors, -> { Internal::Types::Array[Square::Types::Error] }, optional: true, nullable: false
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
data/lib/square/version.rb
CHANGED
data/lib/square.rb
CHANGED
@@ -335,6 +335,12 @@ require_relative "square/types/publish_scheduled_shift_response"
|
|
335
335
|
require_relative "square/types/bulk_publish_scheduled_shifts_response"
|
336
336
|
require_relative "square/types/get_booking_response"
|
337
337
|
require_relative "square/types/bulk_retrieve_bookings_response"
|
338
|
+
require_relative "square/types/channel_status"
|
339
|
+
require_relative "square/types/reference_type"
|
340
|
+
require_relative "square/types/reference"
|
341
|
+
require_relative "square/types/channel"
|
342
|
+
require_relative "square/types/retrieve_channel_response"
|
343
|
+
require_relative "square/types/bulk_retrieve_channels_response"
|
338
344
|
require_relative "square/types/get_customer_response"
|
339
345
|
require_relative "square/types/bulk_retrieve_customers_response"
|
340
346
|
require_relative "square/types/team_member_booking_profile"
|
@@ -450,6 +456,10 @@ require_relative "square/types/terminal_checkout"
|
|
450
456
|
require_relative "square/types/cancel_terminal_checkout_response"
|
451
457
|
require_relative "square/types/terminal_refund"
|
452
458
|
require_relative "square/types/cancel_terminal_refund_response"
|
459
|
+
require_relative "square/types/transfer_order_line"
|
460
|
+
require_relative "square/types/transfer_order_status"
|
461
|
+
require_relative "square/types/transfer_order"
|
462
|
+
require_relative "square/types/cancel_transfer_order_response"
|
453
463
|
require_relative "square/types/capture_transaction_response"
|
454
464
|
require_relative "square/types/card_automatically_updated_event_object"
|
455
465
|
require_relative "square/types/card_automatically_updated_event_data"
|
@@ -618,6 +628,9 @@ require_relative "square/types/timecard_status"
|
|
618
628
|
require_relative "square/types/timecard_wage"
|
619
629
|
require_relative "square/types/timecard"
|
620
630
|
require_relative "square/types/create_timecard_response"
|
631
|
+
require_relative "square/types/create_transfer_order_line_data"
|
632
|
+
require_relative "square/types/create_transfer_order_data"
|
633
|
+
require_relative "square/types/create_transfer_order_response"
|
621
634
|
require_relative "square/types/webhook_subscription"
|
622
635
|
require_relative "square/types/create_webhook_subscription_response"
|
623
636
|
require_relative "square/types/range"
|
@@ -694,6 +707,7 @@ require_relative "square/types/delete_shift_response"
|
|
694
707
|
require_relative "square/types/delete_snippet_response"
|
695
708
|
require_relative "square/types/delete_subscription_action_response"
|
696
709
|
require_relative "square/types/delete_timecard_response"
|
710
|
+
require_relative "square/types/delete_transfer_order_response"
|
697
711
|
require_relative "square/types/delete_webhook_subscription_response"
|
698
712
|
require_relative "square/types/destination_type"
|
699
713
|
require_relative "square/types/destination"
|
@@ -859,6 +873,7 @@ require_relative "square/types/list_cards_response"
|
|
859
873
|
require_relative "square/types/list_cash_drawer_shift_events_response"
|
860
874
|
require_relative "square/types/list_cash_drawer_shifts_response"
|
861
875
|
require_relative "square/types/list_catalog_response"
|
876
|
+
require_relative "square/types/list_channels_response"
|
862
877
|
require_relative "square/types/list_customer_custom_attribute_definitions_response"
|
863
878
|
require_relative "square/types/list_customer_custom_attributes_response"
|
864
879
|
require_relative "square/types/list_customer_groups_response"
|
@@ -1067,6 +1082,7 @@ require_relative "square/types/payout_sent_event"
|
|
1067
1082
|
require_relative "square/types/phase_input"
|
1068
1083
|
require_relative "square/types/publish_invoice_response"
|
1069
1084
|
require_relative "square/types/quick_pay"
|
1085
|
+
require_relative "square/types/receive_transfer_order_response"
|
1070
1086
|
require_relative "square/types/redeem_loyalty_reward_response"
|
1071
1087
|
require_relative "square/types/refund_created_event_object"
|
1072
1088
|
require_relative "square/types/refund_created_event_data"
|
@@ -1126,6 +1142,7 @@ require_relative "square/types/get_team_member_response"
|
|
1126
1142
|
require_relative "square/types/retrieve_timecard_response"
|
1127
1143
|
require_relative "square/types/retrieve_token_status_response"
|
1128
1144
|
require_relative "square/types/get_transaction_response"
|
1145
|
+
require_relative "square/types/retrieve_transfer_order_response"
|
1129
1146
|
require_relative "square/types/get_wage_setting_response"
|
1130
1147
|
require_relative "square/types/get_webhook_subscription_response"
|
1131
1148
|
require_relative "square/types/revoke_token_response"
|
@@ -1178,6 +1195,7 @@ require_relative "square/types/search_terminal_actions_response"
|
|
1178
1195
|
require_relative "square/types/search_terminal_checkouts_response"
|
1179
1196
|
require_relative "square/types/search_terminal_refunds_response"
|
1180
1197
|
require_relative "square/types/search_timecards_response"
|
1198
|
+
require_relative "square/types/search_transfer_orders_response"
|
1181
1199
|
require_relative "square/types/search_vendors_request_filter"
|
1182
1200
|
require_relative "square/types/search_vendors_request_sort_field"
|
1183
1201
|
require_relative "square/types/search_vendors_request_sort"
|
@@ -1189,6 +1207,7 @@ require_relative "square/types/shift_filter"
|
|
1189
1207
|
require_relative "square/types/shift_sort_field"
|
1190
1208
|
require_relative "square/types/shift_sort"
|
1191
1209
|
require_relative "square/types/shift_query"
|
1210
|
+
require_relative "square/types/start_transfer_order_response"
|
1192
1211
|
require_relative "square/types/submit_evidence_response"
|
1193
1212
|
require_relative "square/types/subscription_created_event_object"
|
1194
1213
|
require_relative "square/types/subscription_created_event_data"
|
@@ -1244,6 +1263,20 @@ require_relative "square/types/timecard_sort_field"
|
|
1244
1263
|
require_relative "square/types/timecard_sort"
|
1245
1264
|
require_relative "square/types/timecard_query"
|
1246
1265
|
require_relative "square/types/transaction_type"
|
1266
|
+
require_relative "square/types/transfer_order_created_event_object"
|
1267
|
+
require_relative "square/types/transfer_order_created_event_data"
|
1268
|
+
require_relative "square/types/transfer_order_created_event"
|
1269
|
+
require_relative "square/types/transfer_order_deleted_event_data"
|
1270
|
+
require_relative "square/types/transfer_order_deleted_event"
|
1271
|
+
require_relative "square/types/transfer_order_filter"
|
1272
|
+
require_relative "square/types/transfer_order_goods_receipt_line_item"
|
1273
|
+
require_relative "square/types/transfer_order_goods_receipt"
|
1274
|
+
require_relative "square/types/transfer_order_sort_field"
|
1275
|
+
require_relative "square/types/transfer_order_sort"
|
1276
|
+
require_relative "square/types/transfer_order_query"
|
1277
|
+
require_relative "square/types/transfer_order_updated_event_object"
|
1278
|
+
require_relative "square/types/transfer_order_updated_event_data"
|
1279
|
+
require_relative "square/types/transfer_order_updated_event"
|
1247
1280
|
require_relative "square/types/unlink_customer_from_gift_card_response"
|
1248
1281
|
require_relative "square/types/update_booking_custom_attribute_definition_response"
|
1249
1282
|
require_relative "square/types/update_booking_response"
|
@@ -1270,6 +1303,9 @@ require_relative "square/types/update_shift_response"
|
|
1270
1303
|
require_relative "square/types/update_subscription_response"
|
1271
1304
|
require_relative "square/types/update_team_member_request"
|
1272
1305
|
require_relative "square/types/update_timecard_response"
|
1306
|
+
require_relative "square/types/update_transfer_order_line_data"
|
1307
|
+
require_relative "square/types/update_transfer_order_data"
|
1308
|
+
require_relative "square/types/update_transfer_order_response"
|
1273
1309
|
require_relative "square/types/update_vendor_request"
|
1274
1310
|
require_relative "square/types/update_wage_setting_response"
|
1275
1311
|
require_relative "square/types/update_webhook_subscription_response"
|
@@ -1339,6 +1375,10 @@ require_relative "square/catalog/types/search_catalog_objects_request"
|
|
1339
1375
|
require_relative "square/catalog/types/search_catalog_items_request"
|
1340
1376
|
require_relative "square/catalog/types/update_item_modifier_lists_request"
|
1341
1377
|
require_relative "square/catalog/types/update_item_taxes_request"
|
1378
|
+
require_relative "square/channels/client"
|
1379
|
+
require_relative "square/channels/types/list_channels_request"
|
1380
|
+
require_relative "square/channels/types/bulk_retrieve_channels_request"
|
1381
|
+
require_relative "square/channels/types/get_channels_request"
|
1342
1382
|
require_relative "square/customers/client"
|
1343
1383
|
require_relative "square/customers/types/list_customers_request"
|
1344
1384
|
require_relative "square/customers/types/create_customer_request"
|
@@ -1476,6 +1516,15 @@ require_relative "square/terminal/client"
|
|
1476
1516
|
require_relative "square/terminal/types/dismiss_terminal_action_request"
|
1477
1517
|
require_relative "square/terminal/types/dismiss_terminal_checkout_request"
|
1478
1518
|
require_relative "square/terminal/types/dismiss_terminal_refund_request"
|
1519
|
+
require_relative "square/transfer_orders/client"
|
1520
|
+
require_relative "square/transfer_orders/types/create_transfer_order_request"
|
1521
|
+
require_relative "square/transfer_orders/types/search_transfer_orders_request"
|
1522
|
+
require_relative "square/transfer_orders/types/get_transfer_orders_request"
|
1523
|
+
require_relative "square/transfer_orders/types/update_transfer_order_request"
|
1524
|
+
require_relative "square/transfer_orders/types/delete_transfer_orders_request"
|
1525
|
+
require_relative "square/transfer_orders/types/cancel_transfer_order_request"
|
1526
|
+
require_relative "square/transfer_orders/types/receive_transfer_order_request"
|
1527
|
+
require_relative "square/transfer_orders/types/start_transfer_order_request"
|
1479
1528
|
require_relative "square/vendors/client"
|
1480
1529
|
require_relative "square/vendors/types/batch_create_vendors_request"
|
1481
1530
|
require_relative "square/vendors/types/batch_get_vendors_request"
|