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
data/spec/.DS_Store
ADDED
|
Binary file
|
|
@@ -1,13 +1,10 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
Square Connect API
|
|
3
|
-
|
|
4
|
-
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
2
|
+
#Square Connect API
|
|
5
3
|
|
|
6
4
|
OpenAPI spec version: 2.0
|
|
7
|
-
|
|
5
|
+
Contact: developers@squareup.com
|
|
8
6
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
7
|
|
|
10
|
-
|
|
11
8
|
=end
|
|
12
9
|
|
|
13
10
|
require 'spec_helper'
|
|
@@ -28,25 +25,20 @@ describe 'CheckoutApi' do
|
|
|
28
25
|
|
|
29
26
|
describe 'test an instance of CheckoutApi' do
|
|
30
27
|
it 'should create an instact of CheckoutApi' do
|
|
31
|
-
@instance.
|
|
28
|
+
expect(@instance).to be_instance_of(SquareConnect::CheckoutApi)
|
|
32
29
|
end
|
|
33
30
|
end
|
|
34
31
|
|
|
35
32
|
# unit tests for create_checkout
|
|
36
33
|
# CreateCheckout
|
|
37
34
|
# Creates a [Checkout](#type-checkout) response that links a `checkoutId` and `checkout_page_url` that customers can be directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.
|
|
38
|
-
# @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
|
39
35
|
# @param location_id The ID of the business location to associate the checkout with.
|
|
40
36
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
41
37
|
# @param [Hash] opts the optional parameters
|
|
42
38
|
# @return [CreateCheckoutResponse]
|
|
43
39
|
describe 'create_checkout test' do
|
|
44
40
|
it "should work" do
|
|
45
|
-
# assertion here
|
|
46
|
-
# should be_a()
|
|
47
|
-
# should be_nil
|
|
48
|
-
# should ==
|
|
49
|
-
# should_not ==
|
|
41
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
50
42
|
end
|
|
51
43
|
end
|
|
52
44
|
|
|
@@ -1,120 +1,118 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
Square Connect API
|
|
3
|
-
|
|
4
|
-
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
2
|
+
#Square Connect API
|
|
5
3
|
|
|
6
4
|
OpenAPI spec version: 2.0
|
|
7
|
-
|
|
5
|
+
Contact: developers@squareup.com
|
|
8
6
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
7
|
|
|
10
|
-
|
|
11
8
|
=end
|
|
12
9
|
|
|
13
10
|
require 'spec_helper'
|
|
14
11
|
require 'json'
|
|
15
12
|
|
|
16
|
-
# Unit tests for SquareConnect::
|
|
13
|
+
# Unit tests for SquareConnect::CustomersApi
|
|
17
14
|
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
|
18
15
|
# Please update as you see appropriate
|
|
19
|
-
describe '
|
|
16
|
+
describe 'CustomersApi' do
|
|
20
17
|
before do
|
|
21
18
|
# run before each test
|
|
22
|
-
@instance = SquareConnect::
|
|
19
|
+
@instance = SquareConnect::CustomersApi.new
|
|
23
20
|
end
|
|
24
21
|
|
|
25
22
|
after do
|
|
26
23
|
# run after each test
|
|
27
24
|
end
|
|
28
25
|
|
|
29
|
-
describe 'test an instance of
|
|
30
|
-
it 'should create an instact of
|
|
31
|
-
@instance.
|
|
26
|
+
describe 'test an instance of CustomersApi' do
|
|
27
|
+
it 'should create an instact of CustomersApi' do
|
|
28
|
+
expect(@instance).to be_instance_of(SquareConnect::CustomersApi)
|
|
32
29
|
end
|
|
33
30
|
end
|
|
34
31
|
|
|
35
32
|
# unit tests for create_customer
|
|
36
33
|
# CreateCustomer
|
|
37
34
|
# Creates a new customer for a business, which can have associated cards on file. You must provide __at least one__ of the following values in your request to this endpoint: - `given_name` - `family_name` - `company_name` - `email_address` - `phone_number` This endpoint does not accept an idempotency key. If you accidentally create a duplicate customer, you can delete it with the [DeleteCustomer](#endpoint-deletecustomer) endpoint.
|
|
38
|
-
# @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
|
39
35
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
40
36
|
# @param [Hash] opts the optional parameters
|
|
41
37
|
# @return [CreateCustomerResponse]
|
|
42
38
|
describe 'create_customer test' do
|
|
43
39
|
it "should work" do
|
|
44
|
-
# assertion here
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
40
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
# unit tests for create_customer_card
|
|
45
|
+
# CreateCustomerCard
|
|
46
|
+
# Adds a card on file to an existing customer.
|
|
47
|
+
# @param customer_id The ID of the customer to link the card on file to.
|
|
48
|
+
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
49
|
+
# @param [Hash] opts the optional parameters
|
|
50
|
+
# @return [CreateCustomerCardResponse]
|
|
51
|
+
describe 'create_customer_card test' do
|
|
52
|
+
it "should work" do
|
|
53
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
49
54
|
end
|
|
50
55
|
end
|
|
51
56
|
|
|
52
57
|
# unit tests for delete_customer
|
|
53
58
|
# DeleteCustomer
|
|
54
59
|
# Deletes a customer from a business, along with any linked cards on file.
|
|
55
|
-
# @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
|
56
60
|
# @param customer_id The ID of the customer to delete.
|
|
57
61
|
# @param [Hash] opts the optional parameters
|
|
58
62
|
# @return [DeleteCustomerResponse]
|
|
59
63
|
describe 'delete_customer test' do
|
|
60
64
|
it "should work" do
|
|
61
|
-
# assertion here
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
65
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
66
|
+
end
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
# unit tests for delete_customer_card
|
|
70
|
+
# DeleteCustomerCard
|
|
71
|
+
# Removes a card on file from a customer.
|
|
72
|
+
# @param customer_id The ID of the customer that the card on file belongs to.
|
|
73
|
+
# @param card_id The ID of the card on file to delete.
|
|
74
|
+
# @param [Hash] opts the optional parameters
|
|
75
|
+
# @return [DeleteCustomerCardResponse]
|
|
76
|
+
describe 'delete_customer_card test' do
|
|
77
|
+
it "should work" do
|
|
78
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
66
79
|
end
|
|
67
80
|
end
|
|
68
81
|
|
|
69
82
|
# unit tests for list_customers
|
|
70
83
|
# ListCustomers
|
|
71
84
|
# Lists a business's customers.
|
|
72
|
-
# @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
|
73
85
|
# @param [Hash] opts the optional parameters
|
|
74
86
|
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information.
|
|
75
87
|
# @return [ListCustomersResponse]
|
|
76
88
|
describe 'list_customers test' do
|
|
77
89
|
it "should work" do
|
|
78
|
-
# assertion here
|
|
79
|
-
# should be_a()
|
|
80
|
-
# should be_nil
|
|
81
|
-
# should ==
|
|
82
|
-
# should_not ==
|
|
90
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
83
91
|
end
|
|
84
92
|
end
|
|
85
93
|
|
|
86
94
|
# unit tests for retrieve_customer
|
|
87
95
|
# RetrieveCustomer
|
|
88
96
|
# Returns details for a single customer.
|
|
89
|
-
# @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
|
90
97
|
# @param customer_id The ID of the customer to retrieve.
|
|
91
98
|
# @param [Hash] opts the optional parameters
|
|
92
99
|
# @return [RetrieveCustomerResponse]
|
|
93
100
|
describe 'retrieve_customer test' do
|
|
94
101
|
it "should work" do
|
|
95
|
-
# assertion here
|
|
96
|
-
# should be_a()
|
|
97
|
-
# should be_nil
|
|
98
|
-
# should ==
|
|
99
|
-
# should_not ==
|
|
102
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
100
103
|
end
|
|
101
104
|
end
|
|
102
105
|
|
|
103
106
|
# unit tests for update_customer
|
|
104
107
|
# UpdateCustomer
|
|
105
108
|
# Updates the details of an existing customer. You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint.
|
|
106
|
-
# @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
|
107
109
|
# @param customer_id The ID of the customer to update.
|
|
108
110
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
109
111
|
# @param [Hash] opts the optional parameters
|
|
110
112
|
# @return [UpdateCustomerResponse]
|
|
111
113
|
describe 'update_customer test' do
|
|
112
114
|
it "should work" do
|
|
113
|
-
# assertion here
|
|
114
|
-
# should be_a()
|
|
115
|
-
# should be_nil
|
|
116
|
-
# should ==
|
|
117
|
-
# should_not ==
|
|
115
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
118
116
|
end
|
|
119
117
|
end
|
|
120
118
|
|
|
@@ -16,13 +16,11 @@ require 'json'
|
|
|
16
16
|
# Unit tests for SquareConnect::LocationApi
|
|
17
17
|
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
|
18
18
|
# Please update as you see appropriate
|
|
19
|
-
describe '
|
|
20
|
-
|
|
21
|
-
let(:accounts) { load_accounts() }
|
|
19
|
+
describe 'LocationsApi' do
|
|
22
20
|
|
|
23
21
|
before do
|
|
24
22
|
# run before each test
|
|
25
|
-
@instance = SquareConnect::
|
|
23
|
+
@instance = SquareConnect::LocationsApi.new
|
|
26
24
|
end
|
|
27
25
|
|
|
28
26
|
after do
|
|
@@ -31,7 +29,7 @@ describe 'LocationApi' do
|
|
|
31
29
|
|
|
32
30
|
describe 'test an instance of LocationApi' do
|
|
33
31
|
it 'should create an instact of LocationApi' do
|
|
34
|
-
@instance.
|
|
32
|
+
expect(@instance).to be_an_instance_of(SquareConnect::LocationsApi)
|
|
35
33
|
end
|
|
36
34
|
end
|
|
37
35
|
|
|
@@ -42,16 +40,12 @@ describe 'LocationApi' do
|
|
|
42
40
|
# @param [Hash] opts the optional parameters
|
|
43
41
|
# @return [ListLocationsResponse]
|
|
44
42
|
describe 'list_locations test' do
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
expect(locations.length).to be > 0
|
|
52
|
-
expect(locations[0]).to be_an_instance_of(SquareConnect::Location)
|
|
53
|
-
expect(locations[0].id).to eq("CBASEEffqN8pnVNXwoCL0dSGMVAgAQ")
|
|
54
|
-
end
|
|
43
|
+
it "should work" do
|
|
44
|
+
result = @instance.list_locations()
|
|
45
|
+
locations = result.locations
|
|
46
|
+
expect(locations.length).to be > 0
|
|
47
|
+
expect(locations[0]).to be_an_instance_of(SquareConnect::Location)
|
|
48
|
+
expect(locations[0].id).to eq("CBASEEffqN8pnVNXwoCL0dSGMVAgAQ")
|
|
55
49
|
end
|
|
56
50
|
end
|
|
57
51
|
|
|
@@ -1,77 +1,93 @@
|
|
|
1
1
|
=begin
|
|
2
|
-
Square Connect API
|
|
3
|
-
|
|
4
|
-
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
|
2
|
+
#Square Connect API
|
|
5
3
|
|
|
6
4
|
OpenAPI spec version: 2.0
|
|
7
|
-
|
|
5
|
+
Contact: developers@squareup.com
|
|
8
6
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
9
7
|
|
|
10
|
-
|
|
11
8
|
=end
|
|
12
9
|
|
|
13
10
|
require 'spec_helper'
|
|
14
11
|
require 'json'
|
|
15
12
|
|
|
16
|
-
# Unit tests for SquareConnect::
|
|
13
|
+
# Unit tests for SquareConnect::TransactionsApi
|
|
17
14
|
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
|
18
15
|
# Please update as you see appropriate
|
|
19
|
-
describe '
|
|
16
|
+
describe 'TransactionsApi' do
|
|
20
17
|
before do
|
|
21
18
|
# run before each test
|
|
22
|
-
@instance = SquareConnect::
|
|
19
|
+
@instance = SquareConnect::TransactionsApi.new
|
|
23
20
|
end
|
|
24
21
|
|
|
25
22
|
after do
|
|
26
23
|
# run after each test
|
|
27
24
|
end
|
|
28
25
|
|
|
29
|
-
describe 'test an instance of
|
|
30
|
-
it 'should create an instact of
|
|
31
|
-
@instance.
|
|
26
|
+
describe 'test an instance of TransactionsApi' do
|
|
27
|
+
it 'should create an instact of TransactionsApi' do
|
|
28
|
+
expect(@instance).to be_instance_of(SquareConnect::TransactionsApi)
|
|
32
29
|
end
|
|
33
30
|
end
|
|
34
31
|
|
|
35
32
|
# unit tests for capture_transaction
|
|
36
33
|
# CaptureTransaction
|
|
37
34
|
# Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/articles/delayed-capture-transactions/) for more information.
|
|
38
|
-
# @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
|
39
35
|
# @param location_id
|
|
40
36
|
# @param transaction_id
|
|
41
37
|
# @param [Hash] opts the optional parameters
|
|
42
38
|
# @return [CaptureTransactionResponse]
|
|
43
39
|
describe 'capture_transaction test' do
|
|
44
40
|
it "should work" do
|
|
45
|
-
# assertion here
|
|
46
|
-
# should be_a()
|
|
47
|
-
# should be_nil
|
|
48
|
-
# should ==
|
|
49
|
-
# should_not ==
|
|
41
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
50
42
|
end
|
|
51
43
|
end
|
|
52
44
|
|
|
53
45
|
# unit tests for charge
|
|
54
46
|
# Charge
|
|
55
47
|
# Charges a card represented by a card nonce or a customer's card on file. Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an e-commerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction.
|
|
56
|
-
# @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
|
57
48
|
# @param location_id The ID of the location to associate the created transaction with.
|
|
58
49
|
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
59
50
|
# @param [Hash] opts the optional parameters
|
|
60
51
|
# @return [ChargeResponse]
|
|
61
52
|
describe 'charge test' do
|
|
62
53
|
it "should work" do
|
|
63
|
-
# assertion here
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
54
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
55
|
+
end
|
|
56
|
+
end
|
|
57
|
+
|
|
58
|
+
# unit tests for create_refund
|
|
59
|
+
# CreateRefund
|
|
60
|
+
# Initiates a refund for a previously charged tender.
|
|
61
|
+
# @param location_id The ID of the original transaction's associated location.
|
|
62
|
+
# @param transaction_id The ID of the original transaction that includes the tender to refund.
|
|
63
|
+
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
64
|
+
# @param [Hash] opts the optional parameters
|
|
65
|
+
# @return [CreateRefundResponse]
|
|
66
|
+
describe 'create_refund test' do
|
|
67
|
+
it "should work" do
|
|
68
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
69
|
+
end
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
# unit tests for list_refunds
|
|
73
|
+
# ListRefunds
|
|
74
|
+
# Lists refunds for one of a business's locations. Refunds with a `status` of `PENDING` are not currently included in this endpoint's response. Max results per [page](#paginatingresults): 50
|
|
75
|
+
# @param location_id The ID of the location to list refunds for.
|
|
76
|
+
# @param [Hash] opts the optional parameters
|
|
77
|
+
# @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year.
|
|
78
|
+
# @option opts [String] :end_time The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.
|
|
79
|
+
# @option opts [String] :sort_order The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
|
|
80
|
+
# @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information.
|
|
81
|
+
# @return [ListRefundsResponse]
|
|
82
|
+
describe 'list_refunds test' do
|
|
83
|
+
it "should work" do
|
|
84
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
68
85
|
end
|
|
69
86
|
end
|
|
70
87
|
|
|
71
88
|
# unit tests for list_transactions
|
|
72
89
|
# ListTransactions
|
|
73
90
|
# Lists transactions for a particular location. Max results per [page](#paginatingresults): 50
|
|
74
|
-
# @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
|
75
91
|
# @param location_id The ID of the location to list transactions for.
|
|
76
92
|
# @param [Hash] opts the optional parameters
|
|
77
93
|
# @option opts [String] :begin_time The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year.
|
|
@@ -81,47 +97,33 @@ describe 'TransactionApi' do
|
|
|
81
97
|
# @return [ListTransactionsResponse]
|
|
82
98
|
describe 'list_transactions test' do
|
|
83
99
|
it "should work" do
|
|
84
|
-
# assertion here
|
|
85
|
-
# should be_a()
|
|
86
|
-
# should be_nil
|
|
87
|
-
# should ==
|
|
88
|
-
# should_not ==
|
|
100
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
89
101
|
end
|
|
90
102
|
end
|
|
91
103
|
|
|
92
104
|
# unit tests for retrieve_transaction
|
|
93
105
|
# RetrieveTransaction
|
|
94
106
|
# Retrieves details for a single transaction.
|
|
95
|
-
# @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
|
96
107
|
# @param location_id The ID of the transaction's associated location.
|
|
97
108
|
# @param transaction_id The ID of the transaction to retrieve.
|
|
98
109
|
# @param [Hash] opts the optional parameters
|
|
99
110
|
# @return [RetrieveTransactionResponse]
|
|
100
111
|
describe 'retrieve_transaction test' do
|
|
101
112
|
it "should work" do
|
|
102
|
-
# assertion here
|
|
103
|
-
# should be_a()
|
|
104
|
-
# should be_nil
|
|
105
|
-
# should ==
|
|
106
|
-
# should_not ==
|
|
113
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
107
114
|
end
|
|
108
115
|
end
|
|
109
116
|
|
|
110
117
|
# unit tests for void_transaction
|
|
111
118
|
# VoidTransaction
|
|
112
119
|
# Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/articles/delayed-capture-transactions/) for more information.
|
|
113
|
-
# @param authorization The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.
|
|
114
120
|
# @param location_id
|
|
115
121
|
# @param transaction_id
|
|
116
122
|
# @param [Hash] opts the optional parameters
|
|
117
123
|
# @return [VoidTransactionResponse]
|
|
118
124
|
describe 'void_transaction test' do
|
|
119
125
|
it "should work" do
|
|
120
|
-
# assertion here
|
|
121
|
-
# should be_a()
|
|
122
|
-
# should be_nil
|
|
123
|
-
# should ==
|
|
124
|
-
# should_not ==
|
|
126
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
125
127
|
end
|
|
126
128
|
end
|
|
127
129
|
|
|
@@ -0,0 +1,250 @@
|
|
|
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 'spec_helper'
|
|
11
|
+
require 'json'
|
|
12
|
+
|
|
13
|
+
# Unit tests for SquareConnect::V1EmployeesApi
|
|
14
|
+
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
|
15
|
+
# Please update as you see appropriate
|
|
16
|
+
describe 'V1EmployeesApi' do
|
|
17
|
+
before do
|
|
18
|
+
# run before each test
|
|
19
|
+
@instance = SquareConnect::V1EmployeesApi.new
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
after do
|
|
23
|
+
# run after each test
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
describe 'test an instance of V1EmployeesApi' do
|
|
27
|
+
it 'should create an instact of V1EmployeesApi' do
|
|
28
|
+
expect(@instance).to be_instance_of(SquareConnect::V1EmployeesApi)
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
# unit tests for create_employee
|
|
33
|
+
# Creates an employee for a business.
|
|
34
|
+
# Creates an employee for a business.
|
|
35
|
+
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
36
|
+
# @param [Hash] opts the optional parameters
|
|
37
|
+
# @return [V1Employee]
|
|
38
|
+
describe 'create_employee test' do
|
|
39
|
+
it "should work" do
|
|
40
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
|
|
44
|
+
# unit tests for create_employee_role
|
|
45
|
+
# Creates an employee role you can then assign to employees.
|
|
46
|
+
# Creates an employee role you can then assign to employees.
|
|
47
|
+
# @param employee_role An EmployeeRole object with a name and permissions, and an optional owner flag.
|
|
48
|
+
# @param [Hash] opts the optional parameters
|
|
49
|
+
# @return [V1EmployeeRole]
|
|
50
|
+
describe 'create_employee_role test' do
|
|
51
|
+
it "should work" do
|
|
52
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
|
|
56
|
+
# unit tests for create_timecard
|
|
57
|
+
# Creates a timecard for an employee. Each timecard corresponds to a single shift.
|
|
58
|
+
# Creates a timecard for an employee. Each timecard corresponds to a single shift.
|
|
59
|
+
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
60
|
+
# @param [Hash] opts the optional parameters
|
|
61
|
+
# @return [V1Timecard]
|
|
62
|
+
describe 'create_timecard test' do
|
|
63
|
+
it "should work" do
|
|
64
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
65
|
+
end
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
# unit tests for delete_timecard
|
|
69
|
+
# Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.
|
|
70
|
+
# Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.
|
|
71
|
+
# @param timecard_id The ID of the timecard to delete.
|
|
72
|
+
# @param [Hash] opts the optional parameters
|
|
73
|
+
# @return [Object]
|
|
74
|
+
describe 'delete_timecard test' do
|
|
75
|
+
it "should work" do
|
|
76
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
77
|
+
end
|
|
78
|
+
end
|
|
79
|
+
|
|
80
|
+
# unit tests for list_cash_drawer_shifts
|
|
81
|
+
# Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.
|
|
82
|
+
# Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.
|
|
83
|
+
# @param location_id The ID of the location to list cash drawer shifts for.
|
|
84
|
+
# @param [Hash] opts the optional parameters
|
|
85
|
+
# @option opts [String] :order The order in which cash drawer shifts are listed in the response, based on their created_at field. Default value: ASC
|
|
86
|
+
# @option opts [String] :begin_time The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time minus 90 days.
|
|
87
|
+
# @option opts [String] :end_time The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time.
|
|
88
|
+
# @return [Array<V1CashDrawerShift>]
|
|
89
|
+
describe 'list_cash_drawer_shifts test' do
|
|
90
|
+
it "should work" do
|
|
91
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
92
|
+
end
|
|
93
|
+
end
|
|
94
|
+
|
|
95
|
+
# unit tests for list_employee_roles
|
|
96
|
+
# Provides summary information for all of a business's employee roles.
|
|
97
|
+
# Provides summary information for all of a business's employee roles.
|
|
98
|
+
# @param [Hash] opts the optional parameters
|
|
99
|
+
# @option opts [String] :order The order in which employees are listed in the response, based on their created_at field.Default value: ASC
|
|
100
|
+
# @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
|
|
101
|
+
# @option opts [String] :cursor A pagination cursor to retrieve the next set of results for your original query to the endpoint.
|
|
102
|
+
# @return [Array<V1EmployeeRole>]
|
|
103
|
+
describe 'list_employee_roles test' do
|
|
104
|
+
it "should work" do
|
|
105
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
106
|
+
end
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
# unit tests for list_employees
|
|
110
|
+
# Provides summary information for all of a business's employees.
|
|
111
|
+
# Provides summary information for all of a business's employees.
|
|
112
|
+
# @param [Hash] opts the optional parameters
|
|
113
|
+
# @option opts [String] :order The order in which employees are listed in the response, based on their created_at field. Default value: ASC
|
|
114
|
+
# @option opts [String] :begin_updated_at If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format
|
|
115
|
+
# @option opts [String] :end_updated_at If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format.
|
|
116
|
+
# @option opts [String] :begin_created_at If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format.
|
|
117
|
+
# @option opts [String] :end_created_at If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format.
|
|
118
|
+
# @option opts [String] :status If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE).
|
|
119
|
+
# @option opts [String] :external_id If provided, the endpoint returns only employee entities with the specified external_id.
|
|
120
|
+
# @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
|
|
121
|
+
# @return [Array<V1Employee>]
|
|
122
|
+
describe 'list_employees test' do
|
|
123
|
+
it "should work" do
|
|
124
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
125
|
+
end
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
# unit tests for list_timecard_events
|
|
129
|
+
# Provides summary information for all events associated with a particular timecard.
|
|
130
|
+
# Provides summary information for all events associated with a particular timecard.
|
|
131
|
+
# @param timecard_id The ID of the timecard to list events for.
|
|
132
|
+
# @param [Hash] opts the optional parameters
|
|
133
|
+
# @return [Array<V1TimecardEvent>]
|
|
134
|
+
describe 'list_timecard_events test' do
|
|
135
|
+
it "should work" do
|
|
136
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
137
|
+
end
|
|
138
|
+
end
|
|
139
|
+
|
|
140
|
+
# unit tests for list_timecards
|
|
141
|
+
# Provides summary information for all of a business's employee timecards.
|
|
142
|
+
# Provides summary information for all of a business's employee timecards.
|
|
143
|
+
# @param [Hash] opts the optional parameters
|
|
144
|
+
# @option opts [String] :order The order in which timecards are listed in the response, based on their created_at field.
|
|
145
|
+
# @option opts [String] :employee_id If provided, the endpoint returns only timecards for the employee with the specified ID.
|
|
146
|
+
# @option opts [String] :begin_clockin_time If filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format.
|
|
147
|
+
# @option opts [String] :end_clockin_time If filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format.
|
|
148
|
+
# @option opts [String] :begin_clockout_time If filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format.
|
|
149
|
+
# @option opts [String] :end_clockout_time If filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format.
|
|
150
|
+
# @option opts [String] :begin_updated_at If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format.
|
|
151
|
+
# @option opts [String] :end_updated_at If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.
|
|
152
|
+
# @option opts [BOOLEAN] :deleted If true, only deleted timecards are returned. If false, only valid timecards are returned.If you don't provide this parameter, both valid and deleted timecards are returned.
|
|
153
|
+
# @option opts [Integer] :limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.
|
|
154
|
+
# @option opts [String] :cursor A pagination cursor to retrieve the next set of results for your original query to the endpoint.
|
|
155
|
+
# @return [Array<V1Timecard>]
|
|
156
|
+
describe 'list_timecards test' do
|
|
157
|
+
it "should work" do
|
|
158
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
159
|
+
end
|
|
160
|
+
end
|
|
161
|
+
|
|
162
|
+
# unit tests for retrieve_cash_drawer_shift
|
|
163
|
+
# Provides the details for a single cash drawer shift, including all events that occurred during the shift.
|
|
164
|
+
# Provides the details for a single cash drawer shift, including all events that occurred during the shift.
|
|
165
|
+
# @param location_id The ID of the location to list cash drawer shifts for.
|
|
166
|
+
# @param shift_id The shift's ID.
|
|
167
|
+
# @param [Hash] opts the optional parameters
|
|
168
|
+
# @return [V1CashDrawerShift]
|
|
169
|
+
describe 'retrieve_cash_drawer_shift test' do
|
|
170
|
+
it "should work" do
|
|
171
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
172
|
+
end
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
# unit tests for retrieve_employee
|
|
176
|
+
# Provides the details for a single employee.
|
|
177
|
+
# Provides the details for a single employee.
|
|
178
|
+
# @param employee_id The employee's ID.
|
|
179
|
+
# @param [Hash] opts the optional parameters
|
|
180
|
+
# @return [V1Employee]
|
|
181
|
+
describe 'retrieve_employee test' do
|
|
182
|
+
it "should work" do
|
|
183
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
184
|
+
end
|
|
185
|
+
end
|
|
186
|
+
|
|
187
|
+
# unit tests for retrieve_employee_role
|
|
188
|
+
# Provides the details for a single employee role.
|
|
189
|
+
# Provides the details for a single employee role.
|
|
190
|
+
# @param role_id The role's ID.
|
|
191
|
+
# @param [Hash] opts the optional parameters
|
|
192
|
+
# @return [V1EmployeeRole]
|
|
193
|
+
describe 'retrieve_employee_role test' do
|
|
194
|
+
it "should work" do
|
|
195
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
196
|
+
end
|
|
197
|
+
end
|
|
198
|
+
|
|
199
|
+
# unit tests for retrieve_timecard
|
|
200
|
+
# Provides the details for a single timecard.
|
|
201
|
+
# Provides the details for a single timecard.
|
|
202
|
+
# @param timecard_id The timecard's ID.
|
|
203
|
+
# @param [Hash] opts the optional parameters
|
|
204
|
+
# @return [V1Timecard]
|
|
205
|
+
describe 'retrieve_timecard test' do
|
|
206
|
+
it "should work" do
|
|
207
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
208
|
+
end
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
# unit tests for update_employee
|
|
212
|
+
# V1 UpdateEmployee
|
|
213
|
+
#
|
|
214
|
+
# @param employee_id The ID of the role to modify.
|
|
215
|
+
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
216
|
+
# @param [Hash] opts the optional parameters
|
|
217
|
+
# @return [V1Employee]
|
|
218
|
+
describe 'update_employee test' do
|
|
219
|
+
it "should work" do
|
|
220
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
221
|
+
end
|
|
222
|
+
end
|
|
223
|
+
|
|
224
|
+
# unit tests for update_employee_role
|
|
225
|
+
# Modifies the details of an employee role.
|
|
226
|
+
# Modifies the details of an employee role.
|
|
227
|
+
# @param role_id The ID of the role to modify.
|
|
228
|
+
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
229
|
+
# @param [Hash] opts the optional parameters
|
|
230
|
+
# @return [V1EmployeeRole]
|
|
231
|
+
describe 'update_employee_role test' do
|
|
232
|
+
it "should work" do
|
|
233
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
234
|
+
end
|
|
235
|
+
end
|
|
236
|
+
|
|
237
|
+
# unit tests for update_timecard
|
|
238
|
+
# Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.
|
|
239
|
+
# Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.
|
|
240
|
+
# @param timecard_id TThe ID of the timecard to modify.
|
|
241
|
+
# @param body An object containing the fields to POST for the request. See the corresponding object definition for field details.
|
|
242
|
+
# @param [Hash] opts the optional parameters
|
|
243
|
+
# @return [V1Timecard]
|
|
244
|
+
describe 'update_timecard test' do
|
|
245
|
+
it "should work" do
|
|
246
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
247
|
+
end
|
|
248
|
+
end
|
|
249
|
+
|
|
250
|
+
end
|