diff --git a/CHANGES.md b/CHANGES.md index cd2817f..f81a5eb 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,5 +1,24 @@ # Change Log +## Version 4.20200826.3 (2020-08-26T00:00) +## Existing API updates +* Orders API + * [Order](https://developer.squareup.com/reference/square_2020-08-26/objects/Order) object. The `total_tip_money` field is now GA. + * [CreateOrder](https://developer.squareup.com/reference/square_2020-08-26/orders-api/create-order), [UpdateOrder](https://developer.squareup.com/reference/square_2020-08-26/orders-api/update-order), and [BatchRetrieveOrders](https://developer.squareup.com/reference/square_2020-08-26/orders-api/batch-retrieve-orders). These APIs now support merchant-scoped endpoints (for example, the `CreateOrder` endpoint `POST /v2/orders`). The location-scoped variants of these endpoints (for example, the `CreateOrder` endpoint `POST /v2/locations/{location_id}/orders`) continue to work, but these endpoints are now deprecated. You should use the merchant-scoped endpoints (you provide the location information in the request body). +* Labor API + * [Migrate from Employees to Team Members.](https://developer.squareup.com/docs/labor-api/migrate-to-teams) The Employees API is now deprecated in this release. Accordingly, update references to the `Shift.employee_id` field to the `Shift.team_member_id` field of the Labor API. +* v2 Employees API (deprecated) + * [Migrate from the Square Employees API.](https://developer.squareup.com/docs/team/migrate-from-v2-employees) The v2 Employees API is now deprecated. This topic provides information to migrate to the Team API. +* v1 Employees API (deprecated) + * [Migrate from the v1 Employees API.](https://developer.squareup.com/docs/migrate-from-v1/guides/v1-employees) The v1 Employees API is now deprecated. This topic provides information to migrate to the Team API. + +## Documentation updates +* Point of Sale API + * [Build on iOS.](https://developer.squareup.com/docs/pos-api/build-on-ios) Corrected the Swift example code in step 7. +* Team API + * [Team API Overview.](https://developer.squareup.com/docs/team/overview) Documented the limitation related to creating a team member in the Square Sandbox. + + ## Version 4.20200812.2 (2020-08-12T00:00) ## API releases * Subscriptions API (beta): diff --git a/README.md b/README.md index 8478a5a..ff085fa 100644 --- a/README.md +++ b/README.md @@ -148,8 +148,10 @@ Class | Method | HTTP request | Description *SquareConnect.LaborApi* | [**getBreakType**](docs/LaborApi.md#getBreakType) | **GET** /v2/labor/break-types/{id} | GetBreakType *SquareConnect.LaborApi* | [**getEmployeeWage**](docs/LaborApi.md#getEmployeeWage) | **GET** /v2/labor/employee-wages/{id} | GetEmployeeWage *SquareConnect.LaborApi* | [**getShift**](docs/LaborApi.md#getShift) | **GET** /v2/labor/shifts/{id} | GetShift +*SquareConnect.LaborApi* | [**getTeamMemberWage**](docs/LaborApi.md#getTeamMemberWage) | **GET** /v2/labor/team-member-wages/{id} | GetTeamMemberWage *SquareConnect.LaborApi* | [**listBreakTypes**](docs/LaborApi.md#listBreakTypes) | **GET** /v2/labor/break-types | ListBreakTypes *SquareConnect.LaborApi* | [**listEmployeeWages**](docs/LaborApi.md#listEmployeeWages) | **GET** /v2/labor/employee-wages | ListEmployeeWages +*SquareConnect.LaborApi* | [**listTeamMemberWages**](docs/LaborApi.md#listTeamMemberWages) | **GET** /v2/labor/team-member-wages | ListTeamMemberWages *SquareConnect.LaborApi* | [**listWorkweekConfigs**](docs/LaborApi.md#listWorkweekConfigs) | **GET** /v2/labor/workweek-configs | ListWorkweekConfigs *SquareConnect.LaborApi* | [**searchShifts**](docs/LaborApi.md#searchShifts) | **POST** /v2/labor/shifts/search | SearchShifts *SquareConnect.LaborApi* | [**updateBreakType**](docs/LaborApi.md#updateBreakType) | **PUT** /v2/labor/break-types/{id} | UpdateBreakType @@ -178,12 +180,12 @@ Class | Method | HTTP request | Description *SquareConnect.OAuthApi* | [**obtainToken**](docs/OAuthApi.md#obtainToken) | **POST** /oauth2/token | ObtainToken *SquareConnect.OAuthApi* | [**renewToken**](docs/OAuthApi.md#renewToken) | **POST** /oauth2/clients/{client_id}/access-token/renew | RenewToken *SquareConnect.OAuthApi* | [**revokeToken**](docs/OAuthApi.md#revokeToken) | **POST** /oauth2/revoke | RevokeToken -*SquareConnect.OrdersApi* | [**batchRetrieveOrders**](docs/OrdersApi.md#batchRetrieveOrders) | **POST** /v2/locations/{location_id}/orders/batch-retrieve | BatchRetrieveOrders +*SquareConnect.OrdersApi* | [**batchRetrieveOrders**](docs/OrdersApi.md#batchRetrieveOrders) | **POST** /v2/orders/batch-retrieve | BatchRetrieveOrders *SquareConnect.OrdersApi* | [**calculateOrder**](docs/OrdersApi.md#calculateOrder) | **POST** /v2/orders/calculate | CalculateOrder -*SquareConnect.OrdersApi* | [**createOrder**](docs/OrdersApi.md#createOrder) | **POST** /v2/locations/{location_id}/orders | CreateOrder +*SquareConnect.OrdersApi* | [**createOrder**](docs/OrdersApi.md#createOrder) | **POST** /v2/orders | CreateOrder *SquareConnect.OrdersApi* | [**payOrder**](docs/OrdersApi.md#payOrder) | **POST** /v2/orders/{order_id}/pay | PayOrder *SquareConnect.OrdersApi* | [**searchOrders**](docs/OrdersApi.md#searchOrders) | **POST** /v2/orders/search | SearchOrders -*SquareConnect.OrdersApi* | [**updateOrder**](docs/OrdersApi.md#updateOrder) | **PUT** /v2/locations/{location_id}/orders/{order_id} | UpdateOrder +*SquareConnect.OrdersApi* | [**updateOrder**](docs/OrdersApi.md#updateOrder) | **PUT** /v2/orders/{order_id} | UpdateOrder *SquareConnect.PaymentsApi* | [**cancelPayment**](docs/PaymentsApi.md#cancelPayment) | **POST** /v2/payments/{payment_id}/cancel | CancelPayment *SquareConnect.PaymentsApi* | [**cancelPaymentByIdempotencyKey**](docs/PaymentsApi.md#cancelPaymentByIdempotencyKey) | **POST** /v2/payments/cancel | CancelPaymentByIdempotencyKey *SquareConnect.PaymentsApi* | [**completePayment**](docs/PaymentsApi.md#completePayment) | **POST** /v2/payments/{payment_id}/complete | CompletePayment @@ -193,8 +195,6 @@ Class | Method | HTTP request | Description *SquareConnect.RefundsApi* | [**getPaymentRefund**](docs/RefundsApi.md#getPaymentRefund) | **GET** /v2/refunds/{refund_id} | GetPaymentRefund *SquareConnect.RefundsApi* | [**listPaymentRefunds**](docs/RefundsApi.md#listPaymentRefunds) | **GET** /v2/refunds | ListPaymentRefunds *SquareConnect.RefundsApi* | [**refundPayment**](docs/RefundsApi.md#refundPayment) | **POST** /v2/refunds | RefundPayment -*SquareConnect.ReportingApi* | [**listAdditionalRecipientReceivableRefunds**](docs/ReportingApi.md#listAdditionalRecipientReceivableRefunds) | **GET** /v2/locations/{location_id}/additional-recipient-receivable-refunds | ListAdditionalRecipientReceivableRefunds -*SquareConnect.ReportingApi* | [**listAdditionalRecipientReceivables**](docs/ReportingApi.md#listAdditionalRecipientReceivables) | **GET** /v2/locations/{location_id}/additional-recipient-receivables | ListAdditionalRecipientReceivables *SquareConnect.SubscriptionsApi* | [**cancelSubscription**](docs/SubscriptionsApi.md#cancelSubscription) | **POST** /v2/subscriptions/{subscription_id}/cancel | CancelSubscription *SquareConnect.SubscriptionsApi* | [**createSubscription**](docs/SubscriptionsApi.md#createSubscription) | **POST** /v2/subscriptions | CreateSubscription *SquareConnect.SubscriptionsApi* | [**listSubscriptionEvents**](docs/SubscriptionsApi.md#listSubscriptionEvents) | **GET** /v2/subscriptions/{subscription_id}/events | ListSubscriptionEvents @@ -301,8 +301,6 @@ Class | Method | HTTP request | Description - [SquareConnect.AddGroupToCustomerRequest](docs/AddGroupToCustomerRequest.md) - [SquareConnect.AddGroupToCustomerResponse](docs/AddGroupToCustomerResponse.md) - [SquareConnect.AdditionalRecipient](docs/AdditionalRecipient.md) - - [SquareConnect.AdditionalRecipientReceivable](docs/AdditionalRecipientReceivable.md) - - [SquareConnect.AdditionalRecipientReceivableRefund](docs/AdditionalRecipientReceivableRefund.md) - [SquareConnect.Address](docs/Address.md) - [SquareConnect.AdjustLoyaltyPointsRequest](docs/AdjustLoyaltyPointsRequest.md) - [SquareConnect.AdjustLoyaltyPointsResponse](docs/AdjustLoyaltyPointsResponse.md) @@ -351,6 +349,7 @@ Class | Method | HTTP request | Description - [SquareConnect.CardBrand](docs/CardBrand.md) - [SquareConnect.CardPaymentDetails](docs/CardPaymentDetails.md) - [SquareConnect.CardPrepaidType](docs/CardPrepaidType.md) + - [SquareConnect.CardSquareProduct](docs/CardSquareProduct.md) - [SquareConnect.CardType](docs/CardType.md) - [SquareConnect.CashDrawerDevice](docs/CashDrawerDevice.md) - [SquareConnect.CashDrawerEventType](docs/CashDrawerEventType.md) @@ -535,6 +534,8 @@ Class | Method | HTTP request | Description - [SquareConnect.GetPaymentResponse](docs/GetPaymentResponse.md) - [SquareConnect.GetShiftRequest](docs/GetShiftRequest.md) - [SquareConnect.GetShiftResponse](docs/GetShiftResponse.md) + - [SquareConnect.GetTeamMemberWageRequest](docs/GetTeamMemberWageRequest.md) + - [SquareConnect.GetTeamMemberWageResponse](docs/GetTeamMemberWageResponse.md) - [SquareConnect.GetTerminalCheckoutRequest](docs/GetTerminalCheckoutRequest.md) - [SquareConnect.GetTerminalCheckoutResponse](docs/GetTerminalCheckoutResponse.md) - [SquareConnect.InventoryAdjustment](docs/InventoryAdjustment.md) @@ -560,10 +561,6 @@ Class | Method | HTTP request | Description - [SquareConnect.ItemVariationLocationOverrides](docs/ItemVariationLocationOverrides.md) - [SquareConnect.JobAssignment](docs/JobAssignment.md) - [SquareConnect.JobAssignmentPayType](docs/JobAssignmentPayType.md) - - [SquareConnect.ListAdditionalRecipientReceivableRefundsRequest](docs/ListAdditionalRecipientReceivableRefundsRequest.md) - - [SquareConnect.ListAdditionalRecipientReceivableRefundsResponse](docs/ListAdditionalRecipientReceivableRefundsResponse.md) - - [SquareConnect.ListAdditionalRecipientReceivablesRequest](docs/ListAdditionalRecipientReceivablesRequest.md) - - [SquareConnect.ListAdditionalRecipientReceivablesResponse](docs/ListAdditionalRecipientReceivablesResponse.md) - [SquareConnect.ListBankAccountsRequest](docs/ListBankAccountsRequest.md) - [SquareConnect.ListBankAccountsResponse](docs/ListBankAccountsResponse.md) - [SquareConnect.ListBreakTypesRequest](docs/ListBreakTypesRequest.md) @@ -606,6 +603,8 @@ Class | Method | HTTP request | Description - [SquareConnect.ListRefundsResponse](docs/ListRefundsResponse.md) - [SquareConnect.ListSubscriptionEventsRequest](docs/ListSubscriptionEventsRequest.md) - [SquareConnect.ListSubscriptionEventsResponse](docs/ListSubscriptionEventsResponse.md) + - [SquareConnect.ListTeamMemberWagesRequest](docs/ListTeamMemberWagesRequest.md) + - [SquareConnect.ListTeamMemberWagesResponse](docs/ListTeamMemberWagesResponse.md) - [SquareConnect.ListTransactionsRequest](docs/ListTransactionsRequest.md) - [SquareConnect.ListTransactionsResponse](docs/ListTransactionsResponse.md) - [SquareConnect.ListWorkweekConfigsRequest](docs/ListWorkweekConfigsRequest.md) @@ -657,7 +656,6 @@ Class | Method | HTTP request | Description - [SquareConnect.MeasurementUnitWeight](docs/MeasurementUnitWeight.md) - [SquareConnect.Merchant](docs/Merchant.md) - [SquareConnect.MerchantStatus](docs/MerchantStatus.md) - - [SquareConnect.MethodErrorCodes](docs/MethodErrorCodes.md) - [SquareConnect.ModelBreak](docs/ModelBreak.md) - [SquareConnect.Money](docs/Money.md) - [SquareConnect.ObtainTokenRequest](docs/ObtainTokenRequest.md) @@ -840,7 +838,10 @@ Class | Method | HTTP request | Description - [SquareConnect.TeamMemberAssignedLocations](docs/TeamMemberAssignedLocations.md) - [SquareConnect.TeamMemberAssignedLocationsAssignmentType](docs/TeamMemberAssignedLocationsAssignmentType.md) - [SquareConnect.TeamMemberStatus](docs/TeamMemberStatus.md) + - [SquareConnect.TeamMemberWage](docs/TeamMemberWage.md) - [SquareConnect.Tender](docs/Tender.md) + - [SquareConnect.TenderBankTransferDetails](docs/TenderBankTransferDetails.md) + - [SquareConnect.TenderBankTransferDetailsStatus](docs/TenderBankTransferDetailsStatus.md) - [SquareConnect.TenderCardDetails](docs/TenderCardDetails.md) - [SquareConnect.TenderCardDetailsEntryMethod](docs/TenderCardDetailsEntryMethod.md) - [SquareConnect.TenderCardDetailsStatus](docs/TenderCardDetailsStatus.md) diff --git a/docs/AdditionalRecipientReceivable.md b/docs/AdditionalRecipientReceivable.md deleted file mode 100644 index 68e6a74..0000000 --- a/docs/AdditionalRecipientReceivable.md +++ /dev/null @@ -1,18 +0,0 @@ -# SquareConnect.AdditionalRecipientReceivable - -### Description -**Note: This model is deprecated.** - -Represents a monetary distribution of part of a [Transaction](#type-transaction)'s amount for Transactions which included additional recipients. The location of this receivable is that same as the one specified in the [AdditionalRecipient](#type-additionalrecipient). - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | The additional recipient receivable's unique ID, issued by Square payments servers. | -**transaction_id** | **String** | The ID of the transaction that the additional recipient receivable was applied to. | -**transaction_location_id** | **String** | The ID of the location that created the receivable. This is the location ID on the associated transaction. | -**amount_money** | [**Money**](Money.md) | The amount of the receivable. This will always be non-negative. | -**created_at** | **String** | The time when the additional recipient receivable was created, in RFC 3339 format. | [optional] -**refunds** | [**[AdditionalRecipientReceivableRefund]**](AdditionalRecipientReceivableRefund.md) | Any refunds of the receivable that have been applied. | [optional] - - diff --git a/docs/AdditionalRecipientReceivableRefund.md b/docs/AdditionalRecipientReceivableRefund.md deleted file mode 100644 index db618af..0000000 --- a/docs/AdditionalRecipientReceivableRefund.md +++ /dev/null @@ -1,18 +0,0 @@ -# SquareConnect.AdditionalRecipientReceivableRefund - -### Description -**Note: This model is deprecated.** - -A refund of an [AdditionalRecipientReceivable](#type-additionalrecipientreceivable). This includes the ID of the additional recipient receivable associated to this object, as well as a reference to the [Refund](#type-refund) that created this receivable refund. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **String** | The receivable refund's unique ID, issued by Square payments servers. | -**receivable_id** | **String** | The ID of the receivable that the refund was applied to. | -**refund_id** | **String** | The ID of the refund that is associated to this receivable refund. | -**transaction_location_id** | **String** | The ID of the location that created the receivable. This is the location ID on the associated transaction. | -**amount_money** | [**Money**](Money.md) | The amount of the refund. This will always be non-negative. | -**created_at** | **String** | The time when the refund was created, in RFC 3339 format. | [optional] - - diff --git a/docs/BatchChangeInventoryRequest.md b/docs/BatchChangeInventoryRequest.md index fecee54..e71373f 100644 --- a/docs/BatchChangeInventoryRequest.md +++ b/docs/BatchChangeInventoryRequest.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **idempotency_key** | **String** | A client-supplied, universally unique identifier (UUID) for the request. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the [API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more information. | [optional] -**changes** | [**[InventoryChange]**](InventoryChange.md) | The set of physical counts and inventory adjustments to be made. Changes are applied based on the client-supplied timestamp and may be sent out of order. Max size is 100 changes. | [optional] +**changes** | [**[InventoryChange]**](InventoryChange.md) | The set of physical counts and inventory adjustments to be made. Changes are applied based on the client-supplied timestamp and may be sent out of order. | [optional] **ignore_unchanged_counts** | **Boolean** | Indicates whether the current physical count should be ignored if the quantity is unchanged since the last physical count. Default: `true`. | [optional] diff --git a/docs/BatchRetrieveInventoryChangesRequest.md b/docs/BatchRetrieveInventoryChangesRequest.md index ef46dc5..cb4010c 100644 --- a/docs/BatchRetrieveInventoryChangesRequest.md +++ b/docs/BatchRetrieveInventoryChangesRequest.md @@ -7,12 +7,12 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**catalog_object_ids** | **[String]** | Filters results by `CatalogObject` ID. Only applied when set. Max size is 500 IDs. Default: unset. | [optional] -**location_ids** | **[String]** | Filters results by `Location` ID. Only applied when set. Default: unset. | [optional] -**types** | **[String]** | Filters results by `InventoryChangeType`. Default: [`PHYSICAL_COUNT`, `ADJUSTMENT`]. `TRANSFER` is not supported as a filter. See [InventoryChangeType](#type-inventorychangetype) for possible values | [optional] -**states** | **[String]** | Filters `ADJUSTMENT` query results by `InventoryState`. Only applied when set. Default: unset. See [InventoryState](#type-inventorystate) for possible values | [optional] -**updated_after** | **String** | Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] -**updated_before** | **String** | Provided as an RFC 3339 timestamp. Returns results whose `created_at` or `calculated_at` value is strictly before the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] +**catalog_object_ids** | **[String]** | The filter to return results by `CatalogObject` ID. The filter is only applicable when set. The default value is null. | [optional] +**location_ids** | **[String]** | The filter to return results by `Location` ID. The filter is only applicable when set. The default value is null. | [optional] +**types** | **[String]** | The filter to return results by `InventoryChangeType` values other than `TRANSFER`. The default value is `[PHYSICAL_COUNT, ADJUSTMENT]`. See [InventoryChangeType](#type-inventorychangetype) for possible values | [optional] +**states** | **[String]** | The filter to return `ADJUSTMENT` query results by `InventoryState`. This filter is only applied when set. The default value is null. See [InventoryState](#type-inventorystate) for possible values | [optional] +**updated_after** | **String** | The filter to return results with their `calculated_at` value after the given time as specified in an RFC 3339 timestamp. The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). | [optional] +**updated_before** | **String** | The filter to return results with their `created_at` or `calculated_at` value strictly before the given time as specified in an RFC 3339 timestamp. The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). | [optional] **cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. | [optional] diff --git a/docs/BatchRetrieveInventoryCountsRequest.md b/docs/BatchRetrieveInventoryCountsRequest.md index 395c7f3..c1fa6a9 100644 --- a/docs/BatchRetrieveInventoryCountsRequest.md +++ b/docs/BatchRetrieveInventoryCountsRequest.md @@ -7,9 +7,10 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**catalog_object_ids** | **[String]** | Filters results by `CatalogObject` ID. Only applied when set. Max size is 1000 IDs. Default: unset. | [optional] -**location_ids** | **[String]** | Filters results by `Location` ID. Only applied when set. Default: unset. | [optional] -**updated_after** | **String** | Provided as an RFC 3339 timestamp. Returns results whose `calculated_at` value is after the given time. Default: UNIX epoch (`1970-01-01T00:00:00Z`). | [optional] +**catalog_object_ids** | **[String]** | The filter to return results by `CatalogObject` ID. The filter is applicable only when set. The default is null. | [optional] +**location_ids** | **[String]** | The filter to return results by `Location` ID. This filter is applicable only when set. The default is null. | [optional] +**updated_after** | **String** | The filter to return results with their `calculated_at` value after the given time as specified in an RFC 3339 timestamp. The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). | [optional] **cursor** | **String** | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for the original query. See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. | [optional] +**states** | **[String]** | The filter to return results by `InventoryState`. The filter is only applicable when set. Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`. The default is null. See [InventoryState](#type-inventorystate) for possible values | [optional] diff --git a/docs/BatchRetrieveOrdersRequest.md b/docs/BatchRetrieveOrdersRequest.md index 272a023..352184d 100644 --- a/docs/BatchRetrieveOrdersRequest.md +++ b/docs/BatchRetrieveOrdersRequest.md @@ -7,6 +7,7 @@ Defines the fields that are included in requests to the BatchRetrieveOrders endp ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**location_id** | **String** | The ID of the location for these orders. This field is optional: omit it to retrieve orders within the scope of the current authorization's merchant ID. | [optional] **order_ids** | **[String]** | The IDs of the orders to retrieve. A maximum of 100 orders can be retrieved per request. | diff --git a/docs/CardSquareProduct.md b/docs/CardSquareProduct.md new file mode 100644 index 0000000..e0c275d --- /dev/null +++ b/docs/CardSquareProduct.md @@ -0,0 +1,26 @@ +# SquareConnect.CardSquareProduct + +## Enum + + +* `UNKNOWN_SQUARE_PRODUCT` (value: `"UNKNOWN_SQUARE_PRODUCT"`) + +* `CONNECT_API` (value: `"CONNECT_API"`) + +* `DASHBOARD` (value: `"DASHBOARD"`) + +* `REGISTER_CLIENT` (value: `"REGISTER_CLIENT"`) + +* `BUYER_DASHBOARD` (value: `"BUYER_DASHBOARD"`) + +* `WEB` (value: `"WEB"`) + +* `INVOICES` (value: `"INVOICES"`) + +* `GIFT_CARD` (value: `"GIFT_CARD"`) + +* `VIRTUAL_TERMINAL` (value: `"VIRTUAL_TERMINAL"`) + +* `READER_SDK` (value: `"READER_SDK"`) + + diff --git a/docs/CreateOrderRequest.md b/docs/CreateOrderRequest.md index 9070f07..4e2a2b3 100644 --- a/docs/CreateOrderRequest.md +++ b/docs/CreateOrderRequest.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **order** | [**Order**](Order.md) | The order to create. If this field is set, then the only other top-level field that can be set is the idempotency_key. | [optional] +**location_id** | **String** | The ID of the business location to associate the order with. | [optional] **idempotency_key** | **String** | A value you specify that uniquely identifies this order among orders you've created. If you're unsure whether a particular order was created successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate orders. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. | [optional] diff --git a/docs/DateRange.md b/docs/DateRange.md index ca2ca77..c5fe762 100644 --- a/docs/DateRange.md +++ b/docs/DateRange.md @@ -2,7 +2,7 @@ ### Description -A range defined by two dates. Used for filtering a query for Connect v2 objects that have date properties. +A range defined by two dates. Used for filtering a query for Connect v2 objects that have date properties. ## Properties Name | Type | Description | Notes diff --git a/docs/Employee.md b/docs/Employee.md index 80be879..294a1da 100644 --- a/docs/Employee.md +++ b/docs/Employee.md @@ -1,6 +1,7 @@ # SquareConnect.Employee ### Description +**Note: This model is deprecated.** An employee object that is used by the external API. diff --git a/docs/EmployeeWage.md b/docs/EmployeeWage.md index 0b4a88e..3e435b4 100644 --- a/docs/EmployeeWage.md +++ b/docs/EmployeeWage.md @@ -1,14 +1,15 @@ # SquareConnect.EmployeeWage ### Description +**Note: This model is deprecated.** -The hourly wage rate that an employee will earn on a `Shift` for doing the job specified by the `title` property of this object. +The hourly wage rate that an employee will earn on a `Shift` for doing the job specified by the `title` property of this object. Deprecated at verison 2020-08-26. Use `TeamMemberWage` instead. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | UUID for this object. | [optional] -**employee_id** | **String** | The `Employee` that this wage is assigned to. | +**employee_id** | **String** | The `Employee` that this wage is assigned to. | [optional] **title** | **String** | The job title that this wage relates to. | [optional] **hourly_rate** | [**Money**](Money.md) | Can be a custom-set hourly wage or the calculated effective hourly wage based on annual wage and hours worked per week. | [optional] diff --git a/docs/EmployeesApi.md b/docs/EmployeesApi.md index 8089f9b..b404664 100644 --- a/docs/EmployeesApi.md +++ b/docs/EmployeesApi.md @@ -10,6 +10,7 @@ Method | HTTP request | Description # **listEmployees** +**Note: This endpoint is deprecated.** > ListEmployeesResponse listEmployees(opts) ListEmployees @@ -28,7 +29,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new SquareConnect.EmployeesApi(); var opts = { - 'locationId': "locationId_example", // String | Filter employees returned to only those that are associated with the specified location. + 'locationId': "locationId_example", // String | 'status': "status_example", // String | Specifies the EmployeeStatus to filter the employee by. 'limit': 56, // Number | The number of employees to be returned on each page. 'cursor': "cursor_example" // String | The token required to retrieve the specified page of results. @@ -45,7 +46,7 @@ apiInstance.listEmployees(opts).then(function(data) { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **locationId** | **String**| Filter employees returned to only those that are associated with the specified location. | [optional] + **locationId** | **String**| | [optional] **status** | **String**| Specifies the EmployeeStatus to filter the employee by. | [optional] **limit** | **Number**| The number of employees to be returned on each page. | [optional] **cursor** | **String**| The token required to retrieve the specified page of results. | [optional] @@ -65,6 +66,7 @@ Name | Type | Description | Notes # **retrieveEmployee** +**Note: This endpoint is deprecated.** > RetrieveEmployeeResponse retrieveEmployee(id) RetrieveEmployee diff --git a/docs/ErrorCode.md b/docs/ErrorCode.md index 6b3a06a..5e1f97f 100644 --- a/docs/ErrorCode.md +++ b/docs/ErrorCode.md @@ -179,6 +179,8 @@ * `PAYMENT_NOT_REFUNDABLE` (value: `"PAYMENT_NOT_REFUNDABLE"`) +* `REFUND_DECLINED` (value: `"REFUND_DECLINED"`) + * `INVALID_CARD_DATA` (value: `"INVALID_CARD_DATA"`) * `LOCATION_MISMATCH` (value: `"LOCATION_MISMATCH"`) diff --git a/docs/GetEmployeeWageRequest.md b/docs/GetEmployeeWageRequest.md index de10a33..dc6d310 100644 --- a/docs/GetEmployeeWageRequest.md +++ b/docs/GetEmployeeWageRequest.md @@ -1,6 +1,7 @@ # SquareConnect.GetEmployeeWageRequest ### Description +**Note: This model is deprecated.** A request to get an `EmployeeWage` diff --git a/docs/GetEmployeeWageResponse.md b/docs/GetEmployeeWageResponse.md index 58ca21b..ec36897 100644 --- a/docs/GetEmployeeWageResponse.md +++ b/docs/GetEmployeeWageResponse.md @@ -1,6 +1,7 @@ # SquareConnect.GetEmployeeWageResponse ### Description +**Note: This model is deprecated.** A response to a request to get an `EmployeeWage`. Contains the requested `EmployeeWage` objects. May contain a set of `Error` objects if the request resulted in errors. diff --git a/docs/MethodErrorCodes.md b/docs/GetTeamMemberWageRequest.md similarity index 50% rename from docs/MethodErrorCodes.md rename to docs/GetTeamMemberWageRequest.md index 4899644..f445f05 100644 --- a/docs/MethodErrorCodes.md +++ b/docs/GetTeamMemberWageRequest.md @@ -1,12 +1,11 @@ -# SquareConnect.MethodErrorCodes +# SquareConnect.GetTeamMemberWageRequest ### Description - +A request to get an `TeamMemberWage` ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**value** | **[String]** | See [ErrorCode](#type-errorcode) for possible values | [optional] diff --git a/docs/GetTeamMemberWageResponse.md b/docs/GetTeamMemberWageResponse.md new file mode 100644 index 0000000..0146860 --- /dev/null +++ b/docs/GetTeamMemberWageResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.GetTeamMemberWageResponse + +### Description + +A response to a request to get a `TeamMemberWage`. Contains the requested `TeamMemberWage` objects. May contain a set of `Error` objects if the request resulted in errors. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**team_member_wage** | [**TeamMemberWage**](TeamMemberWage.md) | The requested `TeamMemberWage` object. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/InventoryApi.md b/docs/InventoryApi.md index 94fd209..5479b52 100644 --- a/docs/InventoryApi.md +++ b/docs/InventoryApi.md @@ -211,7 +211,7 @@ Name | Type | Description | Notes RetrieveInventoryChanges -Returns a set of physical counts and inventory adjustments for the provided [CatalogObject](#type-catalogobject) at the requested [Location](#type-location)s. Results are paginated and sorted in descending order according to their `occurred_at` timestamp (newest first). There are no limits on how far back the caller can page. This endpoint is useful when displaying recent changes for a specific item. For more sophisticated queries, use a batch endpoint. +Returns a set of physical counts and inventory adjustments for the provided [CatalogObject](#type-catalogobject) at the requested [Location](#type-location)s. Results are paginated and sorted in descending order according to their `occurred_at` timestamp (newest first). There are no limits on how far back the caller can page. This endpoint can be used to display recent changes for a specific item. For more sophisticated queries, use a batch endpoint. ### Example ```javascript diff --git a/docs/LaborApi.md b/docs/LaborApi.md index 8829071..5436aeb 100644 --- a/docs/LaborApi.md +++ b/docs/LaborApi.md @@ -11,8 +11,10 @@ Method | HTTP request | Description [**getBreakType**](LaborApi.md#getBreakType) | **GET** /v2/labor/break-types/{id} | GetBreakType [**getEmployeeWage**](LaborApi.md#getEmployeeWage) | **GET** /v2/labor/employee-wages/{id} | GetEmployeeWage [**getShift**](LaborApi.md#getShift) | **GET** /v2/labor/shifts/{id} | GetShift +[**getTeamMemberWage**](LaborApi.md#getTeamMemberWage) | **GET** /v2/labor/team-member-wages/{id} | GetTeamMemberWage [**listBreakTypes**](LaborApi.md#listBreakTypes) | **GET** /v2/labor/break-types | ListBreakTypes [**listEmployeeWages**](LaborApi.md#listEmployeeWages) | **GET** /v2/labor/employee-wages | ListEmployeeWages +[**listTeamMemberWages**](LaborApi.md#listTeamMemberWages) | **GET** /v2/labor/team-member-wages | ListTeamMemberWages [**listWorkweekConfigs**](LaborApi.md#listWorkweekConfigs) | **GET** /v2/labor/workweek-configs | ListWorkweekConfigs [**searchShifts**](LaborApi.md#searchShifts) | **POST** /v2/labor/shifts/search | SearchShifts [**updateBreakType**](LaborApi.md#updateBreakType) | **PUT** /v2/labor/break-types/{id} | UpdateBreakType @@ -26,7 +28,7 @@ Method | HTTP request | Description CreateBreakType -Creates a new `BreakType`. A `BreakType` is a template for creating `Break` objects. You must provide the following values in your request to this endpoint: - `location_id` - `break_name` - `expected_duration` - `is_paid` You can only have 3 `BreakType` instances per location. If you attempt to add a 4th `BreakType` for a location, an `INVALID_REQUEST_ERROR` \"Exceeded limit of 3 breaks per location.\" is returned. +Creates a new `BreakType`. A `BreakType` is a template for creating `Break` objects. You must provide the following values in your request to this endpoint: - `location_id` - `break_name` - `expected_duration` - `is_paid` You can only have 3 `BreakType` instances per location. If you attempt to add a 4th `BreakType` for a location, an `INVALID_REQUEST_ERROR` \"Exceeded limit of 3 breaks per location.\" is returned. ### Example ```javascript @@ -74,7 +76,7 @@ Name | Type | Description | Notes CreateShift -Creates a new `Shift`. A `Shift` represents a complete work day for a single employee. You must provide the following values in your request to this endpoint: - `location_id` - `employee_id` - `start_at` An attempt to create a new `Shift` can result in a `BAD_REQUEST` error when: - The `status` of the new `Shift` is `OPEN` and the employee has another shift with an `OPEN` status. - The `start_at` date is in the future - the `start_at` or `end_at` overlaps another shift for the same employee - If `Break`s are set in the request, a break `start_at` must not be before the `Shift.start_at`. A break `end_at` must not be after the `Shift.end_at` +Creates a new `Shift`. A `Shift` represents a complete work day for a single employee. You must provide the following values in your request to this endpoint: - `location_id` - `employee_id` - `start_at` An attempt to create a new `Shift` can result in a `BAD_REQUEST` error when: - The `status` of the new `Shift` is `OPEN` and the employee has another shift with an `OPEN` status. - The `start_at` date is in the future - the `start_at` or `end_at` overlaps another shift for the same employee - If `Break`s are set in the request, a break `start_at` must not be before the `Shift.start_at`. A break `end_at` must not be after the `Shift.end_at` ### Example ```javascript @@ -122,7 +124,7 @@ Name | Type | Description | Notes DeleteBreakType -Deletes an existing `BreakType`. A `BreakType` can be deleted even if it is referenced from a `Shift`. +Deletes an existing `BreakType`. A `BreakType` can be deleted even if it is referenced from a `Shift`. ### Example ```javascript @@ -262,6 +264,7 @@ Name | Type | Description | Notes # **getEmployeeWage** +**Note: This endpoint is deprecated.** > GetEmployeeWageResponse getEmployeeWage(id) GetEmployeeWage @@ -351,6 +354,54 @@ Name | Type | Description | Notes [oauth2](../README.md#oauth2) +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **getTeamMemberWage** +> GetTeamMemberWageResponse getTeamMemberWage(id) + +GetTeamMemberWage + +Returns a single `TeamMemberWage` specified by id. + +### Example +```javascript +var SquareConnect = require('square-connect'); +var defaultClient = SquareConnect.ApiClient.instance; + +// Configure OAuth2 access token for authorization: oauth2 +var oauth2 = defaultClient.authentications['oauth2']; +oauth2.accessToken = 'YOUR ACCESS TOKEN'; + +var apiInstance = new SquareConnect.LaborApi(); + +var id = "id_example"; // String | UUID for the `TeamMemberWage` being retrieved. + +apiInstance.getTeamMemberWage(id).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| UUID for the `TeamMemberWage` being retrieved. | + +### Return type + +[**GetTeamMemberWageResponse**](GetTeamMemberWageResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + ### HTTP request headers - **Content-Type**: application/json @@ -411,6 +462,7 @@ Name | Type | Description | Notes # **listEmployeeWages** +**Note: This endpoint is deprecated.** > ListEmployeeWagesResponse listEmployeeWages(opts) ListEmployeeWages @@ -457,6 +509,59 @@ Name | Type | Description | Notes [oauth2](../README.md#oauth2) +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **listTeamMemberWages** +> ListTeamMemberWagesResponse listTeamMemberWages(opts) + +ListTeamMemberWages + +Returns a paginated list of `TeamMemberWage` instances for a business. + +### Example +```javascript +var SquareConnect = require('square-connect'); +var defaultClient = SquareConnect.ApiClient.instance; + +// Configure OAuth2 access token for authorization: oauth2 +var oauth2 = defaultClient.authentications['oauth2']; +oauth2.accessToken = 'YOUR ACCESS TOKEN'; + +var apiInstance = new SquareConnect.LaborApi(); + +var opts = { + 'teamMemberId': "teamMemberId_example", // String | Filter wages returned to only those that are associated with the specified team member. + 'limit': 56, // Number | Maximum number of Team Member Wages to return per page. Can range between 1 and 200. The default is the maximum at 200. + 'cursor': "cursor_example" // String | Pointer to the next page of Employee Wage results to fetch. +}; +apiInstance.listTeamMemberWages(opts).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **teamMemberId** | **String**| Filter wages returned to only those that are associated with the specified team member. | [optional] + **limit** | **Number**| Maximum number of Team Member Wages to return per page. Can range between 1 and 200. The default is the maximum at 200. | [optional] + **cursor** | **String**| Pointer to the next page of Employee Wage results to fetch. | [optional] + +### Return type + +[**ListTeamMemberWagesResponse**](ListTeamMemberWagesResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + ### HTTP request headers - **Content-Type**: application/json @@ -519,7 +624,7 @@ Name | Type | Description | Notes SearchShifts -Returns a paginated list of `Shift` records for a business. The list to be returned can be filtered by: - Location IDs **and** - employee IDs **and** - shift status (`OPEN`, `CLOSED`) **and** - shift start **and** - shift end **and** - work day details The list can be sorted by: - `start_at` - `end_at` - `created_at` - `updated_at` +Returns a paginated list of `Shift` records for a business. The list to be returned can be filtered by: - Location IDs **and** - employee IDs **and** - shift status (`OPEN`, `CLOSED`) **and** - shift start **and** - shift end **and** - work day details The list can be sorted by: - `start_at` - `end_at` - `created_at` - `updated_at` ### Example ```javascript @@ -618,7 +723,7 @@ Name | Type | Description | Notes UpdateShift -Updates an existing `Shift`. When adding a `Break` to a `Shift`, any earlier `Breaks` in the `Shift` have the `end_at` property set to a valid RFC-3339 datetime string. When closing a `Shift`, all `Break` instances in the shift must be complete with `end_at` set on each `Break`. +Updates an existing `Shift`. When adding a `Break` to a `Shift`, any earlier `Breaks` in the `Shift` have the `end_at` property set to a valid RFC-3339 datetime string. When closing a `Shift`, all `Break` instances in the shift must be complete with `end_at` set on each `Break`. ### Example ```javascript diff --git a/docs/ListAdditionalRecipientReceivableRefundsRequest.md b/docs/ListAdditionalRecipientReceivableRefundsRequest.md deleted file mode 100644 index 77aae95..0000000 --- a/docs/ListAdditionalRecipientReceivableRefundsRequest.md +++ /dev/null @@ -1,16 +0,0 @@ -# SquareConnect.ListAdditionalRecipientReceivableRefundsRequest - -### Description -**Note: This model is deprecated.** - -Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**begin_time** | **String** | 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. | [optional] -**end_time** | **String** | 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. | [optional] -**sort_order** | **String** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` See [SortOrder](#type-sortorder) for possible values | [optional] -**cursor** | **String** | 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. | [optional] - - diff --git a/docs/ListAdditionalRecipientReceivableRefundsResponse.md b/docs/ListAdditionalRecipientReceivableRefundsResponse.md deleted file mode 100644 index 3acfe0e..0000000 --- a/docs/ListAdditionalRecipientReceivableRefundsResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# SquareConnect.ListAdditionalRecipientReceivableRefundsResponse - -### Description -**Note: This model is deprecated.** - -Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint. One of `errors` or `additional_recipient_receivable_refunds` is present in a given response (never both). - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] -**receivable_refunds** | [**[AdditionalRecipientReceivableRefund]**](AdditionalRecipientReceivableRefund.md) | An array of AdditionalRecipientReceivableRefunds that match your query. | [optional] -**cursor** | **String** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. | [optional] - - diff --git a/docs/ListAdditionalRecipientReceivablesRequest.md b/docs/ListAdditionalRecipientReceivablesRequest.md deleted file mode 100644 index 3c771f0..0000000 --- a/docs/ListAdditionalRecipientReceivablesRequest.md +++ /dev/null @@ -1,16 +0,0 @@ -# SquareConnect.ListAdditionalRecipientReceivablesRequest - -### Description -**Note: This model is deprecated.** - -Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint. - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**begin_time** | **String** | 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. | [optional] -**end_time** | **String** | 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. | [optional] -**sort_order** | **String** | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` See [SortOrder](#type-sortorder) for possible values | [optional] -**cursor** | **String** | 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. | [optional] - - diff --git a/docs/ListAdditionalRecipientReceivablesResponse.md b/docs/ListAdditionalRecipientReceivablesResponse.md deleted file mode 100644 index 672ed4c..0000000 --- a/docs/ListAdditionalRecipientReceivablesResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -# SquareConnect.ListAdditionalRecipientReceivablesResponse - -### Description -**Note: This model is deprecated.** - -Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint. One of `errors` or `additional_recipient_receivables` is present in a given response (never both). - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] -**receivables** | [**[AdditionalRecipientReceivable]**](AdditionalRecipientReceivable.md) | An array of AdditionalRecipientReceivables that match your query. | [optional] -**cursor** | **String** | A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the `cursor` parameter in a subsequent request to this endpoint. See [Paginating results](#paginatingresults) for more information. | [optional] - - diff --git a/docs/ListEmployeeWagesRequest.md b/docs/ListEmployeeWagesRequest.md index c7ca5e7..b04fca3 100644 --- a/docs/ListEmployeeWagesRequest.md +++ b/docs/ListEmployeeWagesRequest.md @@ -1,6 +1,7 @@ # SquareConnect.ListEmployeeWagesRequest ### Description +**Note: This model is deprecated.** A request for a set of `EmployeeWage` objects diff --git a/docs/ListEmployeeWagesResponse.md b/docs/ListEmployeeWagesResponse.md index fc84e63..552738a 100644 --- a/docs/ListEmployeeWagesResponse.md +++ b/docs/ListEmployeeWagesResponse.md @@ -1,6 +1,7 @@ # SquareConnect.ListEmployeeWagesResponse ### Description +**Note: This model is deprecated.** The response to a request for a set of `EmployeeWage` objects. Contains a set of `EmployeeWage`. diff --git a/docs/ListEmployeesRequest.md b/docs/ListEmployeesRequest.md index 92bc5b1..de743ef 100644 --- a/docs/ListEmployeesRequest.md +++ b/docs/ListEmployeesRequest.md @@ -1,13 +1,14 @@ # SquareConnect.ListEmployeesRequest ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**location_id** | **String** | Filter employees returned to only those that are associated with the specified location. | [optional] +**location_id** | **String** | | [optional] **status** | **String** | Specifies the EmployeeStatus to filter the employee by. See [EmployeeStatus](#type-employeestatus) for possible values | [optional] **limit** | **Number** | The number of employees to be returned on each page. | [optional] **cursor** | **String** | The token required to retrieve the specified page of results. | [optional] diff --git a/docs/ListEmployeesResponse.md b/docs/ListEmployeesResponse.md index 418f7b8..404dea6 100644 --- a/docs/ListEmployeesResponse.md +++ b/docs/ListEmployeesResponse.md @@ -1,13 +1,14 @@ # SquareConnect.ListEmployeesResponse ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**employees** | [**[Employee]**](Employee.md) | List of employees returned from the request. | [optional] +**employees** | [**[Employee]**](Employee.md) | | [optional] **cursor** | **String** | The token to be used to retrieve the next page of results. | [optional] **errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] diff --git a/docs/ListTeamMemberWagesRequest.md b/docs/ListTeamMemberWagesRequest.md new file mode 100644 index 0000000..2c67795 --- /dev/null +++ b/docs/ListTeamMemberWagesRequest.md @@ -0,0 +1,14 @@ +# SquareConnect.ListTeamMemberWagesRequest + +### Description + +A request for a set of `TeamMemberWage` objects + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**team_member_id** | **String** | Filter wages returned to only those that are associated with the specified team member. | [optional] +**limit** | **Number** | Maximum number of Team Member Wages to return per page. Can range between 1 and 200. The default is the maximum at 200. | [optional] +**cursor** | **String** | Pointer to the next page of Employee Wage results to fetch. | [optional] + + diff --git a/docs/ListTeamMemberWagesResponse.md b/docs/ListTeamMemberWagesResponse.md new file mode 100644 index 0000000..7a1ba4c --- /dev/null +++ b/docs/ListTeamMemberWagesResponse.md @@ -0,0 +1,14 @@ +# SquareConnect.ListTeamMemberWagesResponse + +### Description + +The response to a request for a set of `TeamMemberWage` objects. Contains a set of `TeamMemberWage`. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**team_member_wages** | [**[TeamMemberWage]**](TeamMemberWage.md) | A page of Team Member Wage results. | [optional] +**cursor** | **String** | Value supplied in the subsequent request to fetch the next next page of Team Member Wage results. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/ModelBreak.md b/docs/ModelBreak.md index dd15db4..8233efe 100644 --- a/docs/ModelBreak.md +++ b/docs/ModelBreak.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | UUID for this object | [optional] **start_at** | **String** | RFC 3339; follows same timezone info as `Shift`. Precision up to the minute is respected; seconds are truncated. | -**end_at** | **String** | RFC 3339; follows same timezone info as `Shift`. Precision up to the minute is respected; seconds are truncated. The `end_at` minute is not counted when the break length is calculated. For example, a break from `00:00` to `00:11` is considered a 10 minute break (midnight to 10 minutes after midnight). | [optional] +**end_at** | **String** | RFC 3339; follows same timezone info as `Shift`. Precision up to the minute is respected; seconds are truncated. | [optional] **break_type_id** | **String** | The `BreakType` this `Break` was templated on. | **name** | **String** | A human-readable name. | **expected_duration** | **String** | Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of the break. | diff --git a/docs/Order.md b/docs/Order.md index a02639d..afb72a2 100644 --- a/docs/Order.md +++ b/docs/Order.md @@ -32,6 +32,7 @@ Name | Type | Description | Notes **total_money** | [**Money**](Money.md) | The total amount of money to collect for the order. | [optional] **total_tax_money** | [**Money**](Money.md) | The total tax amount of money to collect for the order. | [optional] **total_discount_money** | [**Money**](Money.md) | The total discount amount of money to collect for the order. | [optional] +**total_tip_money** | [**Money**](Money.md) | The total tip amount of money to collect for the order. | [optional] **total_service_charge_money** | [**Money**](Money.md) | The total amount of money collected in service charges for the order. Note: `total_service_charge_money` is the sum of `applied_money` fields for each individual service charge. Therefore, `total_service_charge_money` will only include inclusive tax amounts, not additive tax amounts. | [optional] **pricing_options** | [**OrderPricingOptions**](OrderPricingOptions.md) | Pricing options for an order. The options affect how the order's price is calculated. They can be used, for example, to apply automatic price adjustments that are based on pre-configured [pricing rules](https://developer.squareup.com/docs/reference/square/objects/CatalogPricingRule). | [optional] **rewards** | [**[OrderReward]**](OrderReward.md) | A set-like list of rewards that have been added to the order. | [optional] [beta] diff --git a/docs/OrderFulfillmentPickupDetailsCurbsidePickupDetails.md b/docs/OrderFulfillmentPickupDetailsCurbsidePickupDetails.md index 7091788..be08794 100644 --- a/docs/OrderFulfillmentPickupDetailsCurbsidePickupDetails.md +++ b/docs/OrderFulfillmentPickupDetailsCurbsidePickupDetails.md @@ -9,6 +9,6 @@ Specific details for curbside pickup. Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **curbside_details** | **String** | Specific details for curbside pickup, such as parking number, vehicle model, etc. | [optional] -**buyer_arrived_at** | **String** | The [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\", indicating when the buyer arrived and is waiting for pickup. | [optional] +**buyer_arrived_at** | **String** | The [timestamp](#workingwithdates) in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\", indicating when the buyer arrived and is waiting for pickup. | [optional] diff --git a/docs/OrderFulfillmentShipmentDetails.md b/docs/OrderFulfillmentShipmentDetails.md index 5a92124..fc2ee06 100644 --- a/docs/OrderFulfillmentShipmentDetails.md +++ b/docs/OrderFulfillmentShipmentDetails.md @@ -14,14 +14,14 @@ Name | Type | Description | Notes **shipping_type** | **String** | A description of the type of shipping product purchased from the carrier. e.g. First Class, Priority, Express | [optional] **tracking_number** | **String** | The reference number provided by the carrier to track the shipment's progress. | [optional] **tracking_url** | **String** | A link to the tracking webpage on the carrier's website. | [optional] -**placed_at** | **String** | The [timestamp](#workingwithdates) indicating when the shipment was requested. Must be in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] -**in_progress_at** | **String** | The [timestamp](#workingwithdates) indicating when this fulfillment was moved to the `RESERVED` state. Indicates that preparation of this shipment has begun. Must be in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] -**packaged_at** | **String** | The [timestamp](#workingwithdates) indicating when this fulfillment was moved to the `PREPARED` state. Indicates that the fulfillment is packaged. Must be in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] -**expected_shipped_at** | **String** | The [timestamp](#workingwithdates) indicating when the shipment is expected to be delivered to the shipping carrier. Must be in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] -**shipped_at** | **String** | The [timestamp](#workingwithdates) indicating when this fulfillment was moved to the `COMPLETED`state. Indicates that the fulfillment has been given to the shipping carrier. Must be in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] -**canceled_at** | **String** | The [timestamp](#workingwithdates) indicating the shipment was canceled. Must be in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**placed_at** | **String** | The [timestamp](#workingwithdates) indicating when the shipment was requested. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**in_progress_at** | **String** | The [timestamp](#workingwithdates) indicating when this fulfillment was moved to the `RESERVED` state. Indicates that preparation of this shipment has begun. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**packaged_at** | **String** | The [timestamp](#workingwithdates) indicating when this fulfillment was moved to the `PREPARED` state. Indicates that the fulfillment is packaged. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**expected_shipped_at** | **String** | The [timestamp](#workingwithdates) indicating when the shipment is expected to be delivered to the shipping carrier. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**shipped_at** | **String** | The [timestamp](#workingwithdates) indicating when this fulfillment was moved to the `COMPLETED`state. Indicates that the fulfillment has been given to the shipping carrier. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**canceled_at** | **String** | The [timestamp](#workingwithdates) indicating the shipment was canceled. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] **cancel_reason** | **String** | A description of why the shipment was canceled. | [optional] -**failed_at** | **String** | The [timestamp](#workingwithdates) indicating when the shipment failed to be completed. Must be in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] +**failed_at** | **String** | The [timestamp](#workingwithdates) indicating when the shipment failed to be completed. Must be in RFC 3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". | [optional] **failure_reason** | **String** | A description of why the shipment failed to be completed. | [optional] diff --git a/docs/OrdersApi.md b/docs/OrdersApi.md index 6d2575f..b917ff8 100644 --- a/docs/OrdersApi.md +++ b/docs/OrdersApi.md @@ -4,17 +4,17 @@ All URIs are relative to *https://connect.squareup.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**batchRetrieveOrders**](OrdersApi.md#batchRetrieveOrders) | **POST** /v2/locations/{location_id}/orders/batch-retrieve | BatchRetrieveOrders +[**batchRetrieveOrders**](OrdersApi.md#batchRetrieveOrders) | **POST** /v2/orders/batch-retrieve | BatchRetrieveOrders [**calculateOrder**](OrdersApi.md#calculateOrder) | **POST** /v2/orders/calculate | CalculateOrder -[**createOrder**](OrdersApi.md#createOrder) | **POST** /v2/locations/{location_id}/orders | CreateOrder +[**createOrder**](OrdersApi.md#createOrder) | **POST** /v2/orders | CreateOrder [**payOrder**](OrdersApi.md#payOrder) | **POST** /v2/orders/{order_id}/pay | PayOrder [**searchOrders**](OrdersApi.md#searchOrders) | **POST** /v2/orders/search | SearchOrders -[**updateOrder**](OrdersApi.md#updateOrder) | **PUT** /v2/locations/{location_id}/orders/{order_id} | UpdateOrder +[**updateOrder**](OrdersApi.md#updateOrder) | **PUT** /v2/orders/{order_id} | UpdateOrder # **batchRetrieveOrders** -> BatchRetrieveOrdersResponse batchRetrieveOrders(locationId, body) +> BatchRetrieveOrdersResponse batchRetrieveOrders(body) BatchRetrieveOrders @@ -31,11 +31,9 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new SquareConnect.OrdersApi(); -var locationId = "locationId_example"; // String | The ID of the orders' associated location. - var body = new SquareConnect.BatchRetrieveOrdersRequest(); // BatchRetrieveOrdersRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. -apiInstance.batchRetrieveOrders(locationId, body).then(function(data) { +apiInstance.batchRetrieveOrders(body).then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); @@ -47,7 +45,6 @@ apiInstance.batchRetrieveOrders(locationId, body).then(function(data) { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **locationId** | **String**| The ID of the orders' associated location. | **body** | [**BatchRetrieveOrdersRequest**](BatchRetrieveOrdersRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | ### Return type @@ -114,7 +111,7 @@ Name | Type | Description | Notes # **createOrder** -> CreateOrderResponse createOrder(locationId, body) +> CreateOrderResponse createOrder(body) CreateOrder @@ -131,11 +128,9 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new SquareConnect.OrdersApi(); -var locationId = "locationId_example"; // String | The ID of the business location to associate the order with. - var body = new SquareConnect.CreateOrderRequest(); // CreateOrderRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. -apiInstance.createOrder(locationId, body).then(function(data) { +apiInstance.createOrder(body).then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); @@ -147,7 +142,6 @@ apiInstance.createOrder(locationId, body).then(function(data) { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **locationId** | **String**| The ID of the business location to associate the order with. | **body** | [**CreateOrderRequest**](CreateOrderRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | ### Return type @@ -266,7 +260,7 @@ Name | Type | Description | Notes # **updateOrder** **Note: This endpoint is in beta.** -> UpdateOrderResponse updateOrder(locationId, orderId, body) +> UpdateOrderResponse updateOrder(orderId, body) UpdateOrder @@ -283,13 +277,11 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new SquareConnect.OrdersApi(); -var locationId = "locationId_example"; // String | The ID of the order's associated location. - var orderId = "orderId_example"; // String | The ID of the order to update. var body = new SquareConnect.UpdateOrderRequest(); // UpdateOrderRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. -apiInstance.updateOrder(locationId, orderId, body).then(function(data) { +apiInstance.updateOrder(orderId, body).then(function(data) { console.log('API called successfully. Returned data: ' + data); }, function(error) { console.error(error); @@ -301,7 +293,6 @@ apiInstance.updateOrder(locationId, orderId, body).then(function(data) { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **locationId** | **String**| The ID of the order's associated location. | **orderId** | **String**| The ID of the order to update. | **body** | [**UpdateOrderRequest**](UpdateOrderRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | diff --git a/docs/ReportingApi.md b/docs/ReportingApi.md deleted file mode 100644 index 5053ed2..0000000 --- a/docs/ReportingApi.md +++ /dev/null @@ -1,128 +0,0 @@ -# SquareConnect.ReportingApi - -All URIs are relative to *https://connect.squareup.com* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**listAdditionalRecipientReceivableRefunds**](ReportingApi.md#listAdditionalRecipientReceivableRefunds) | **GET** /v2/locations/{location_id}/additional-recipient-receivable-refunds | ListAdditionalRecipientReceivableRefunds -[**listAdditionalRecipientReceivables**](ReportingApi.md#listAdditionalRecipientReceivables) | **GET** /v2/locations/{location_id}/additional-recipient-receivables | ListAdditionalRecipientReceivables - - - -# **listAdditionalRecipientReceivableRefunds** -**Note: This endpoint is deprecated.** -> ListAdditionalRecipientReceivableRefundsResponse listAdditionalRecipientReceivableRefunds(locationId, opts) - -ListAdditionalRecipientReceivableRefunds - -Returns a list of refunded transactions (across all possible originating locations) relating to monies credited to the provided location ID by another Square account using the `additional_recipients` field in a transaction. Max results per [page](#paginatingresults): 50 - -### Example -```javascript -var SquareConnect = require('square-connect'); -var defaultClient = SquareConnect.ApiClient.instance; - -// Configure OAuth2 access token for authorization: oauth2 -var oauth2 = defaultClient.authentications['oauth2']; -oauth2.accessToken = 'YOUR ACCESS TOKEN'; - -var apiInstance = new SquareConnect.ReportingApi(); - -var locationId = "locationId_example"; // String | The ID of the location to list AdditionalRecipientReceivableRefunds for. - -var opts = { - 'beginTime': "beginTime_example", // String | 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. - 'endTime': "endTime_example", // String | 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. - 'sortOrder': "sortOrder_example", // String | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` - 'cursor': "cursor_example" // String | 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. -}; -apiInstance.listAdditionalRecipientReceivableRefunds(locationId, opts).then(function(data) { - console.log('API called successfully. Returned data: ' + data); -}, function(error) { - console.error(error); -}); - -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **locationId** | **String**| The ID of the location to list AdditionalRecipientReceivableRefunds for. | - **beginTime** | **String**| 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. | [optional] - **endTime** | **String**| 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. | [optional] - **sortOrder** | **String**| The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` | [optional] - **cursor** | **String**| 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. | [optional] - -### Return type - -[**ListAdditionalRecipientReceivableRefundsResponse**](ListAdditionalRecipientReceivableRefundsResponse.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -# **listAdditionalRecipientReceivables** -**Note: This endpoint is deprecated.** -> ListAdditionalRecipientReceivablesResponse listAdditionalRecipientReceivables(locationId, opts) - -ListAdditionalRecipientReceivables - -Returns a list of receivables (across all possible sending locations) representing monies credited to the provided location ID by another Square account using the `additional_recipients` field in a transaction. Max results per [page](#paginatingresults): 50 - -### Example -```javascript -var SquareConnect = require('square-connect'); -var defaultClient = SquareConnect.ApiClient.instance; - -// Configure OAuth2 access token for authorization: oauth2 -var oauth2 = defaultClient.authentications['oauth2']; -oauth2.accessToken = 'YOUR ACCESS TOKEN'; - -var apiInstance = new SquareConnect.ReportingApi(); - -var locationId = "locationId_example"; // String | The ID of the location to list AdditionalRecipientReceivables for. - -var opts = { - 'beginTime': "beginTime_example", // String | 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. - 'endTime': "endTime_example", // String | 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. - 'sortOrder': "sortOrder_example", // String | The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` - 'cursor': "cursor_example" // String | 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. -}; -apiInstance.listAdditionalRecipientReceivables(locationId, opts).then(function(data) { - console.log('API called successfully. Returned data: ' + data); -}, function(error) { - console.error(error); -}); - -``` - -### Parameters - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **locationId** | **String**| The ID of the location to list AdditionalRecipientReceivables for. | - **beginTime** | **String**| 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. | [optional] - **endTime** | **String**| 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. | [optional] - **sortOrder** | **String**| The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` | [optional] - **cursor** | **String**| 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. | [optional] - -### Return type - -[**ListAdditionalRecipientReceivablesResponse**](ListAdditionalRecipientReceivablesResponse.md) - -### Authorization - -[oauth2](../README.md#oauth2) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - diff --git a/docs/RetrieveEmployeeRequest.md b/docs/RetrieveEmployeeRequest.md index 61b422e..a829123 100644 --- a/docs/RetrieveEmployeeRequest.md +++ b/docs/RetrieveEmployeeRequest.md @@ -1,6 +1,7 @@ # SquareConnect.RetrieveEmployeeRequest ### Description +**Note: This model is deprecated.** diff --git a/docs/RetrieveEmployeeResponse.md b/docs/RetrieveEmployeeResponse.md index 3ff2430..2e1f95b 100644 --- a/docs/RetrieveEmployeeResponse.md +++ b/docs/RetrieveEmployeeResponse.md @@ -1,13 +1,14 @@ # SquareConnect.RetrieveEmployeeResponse ### Description +**Note: This model is deprecated.** ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**employee** | [**Employee**](Employee.md) | The response object. | [optional] +**employee** | [**Employee**](Employee.md) | | [optional] **errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] diff --git a/docs/Shift.md b/docs/Shift.md index c97e011..91b9ebd 100644 --- a/docs/Shift.md +++ b/docs/Shift.md @@ -8,16 +8,17 @@ A record of the hourly rate, start, and end times for a single work shift for an Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | UUID for this object | [optional] -**employee_id** | **String** | The ID of the employee this shift belongs to. | +**employee_id** | **String** | The ID of the employee this shift belongs to. DEPRECATED at version 2020-08-26. Use `team_member_id` instead | [optional] [deprecated] **location_id** | **String** | The ID of the location this shift occurred at. Should be based on where the employee clocked in. | [optional] **timezone** | **String** | Read-only convenience value that is calculated from the location based on `location_id`. Format: the IANA Timezone Database identifier for the location timezone. | [optional] **start_at** | **String** | RFC 3339; shifted to location timezone + offset. Precision up to the minute is respected; seconds are truncated. | -**end_at** | **String** | RFC 3339; shifted to timezone + offset. Precision up to the minute is respected; seconds are truncated. The `end_at` minute is not counted when the shift length is calculated. For example, a shift from `00:00` to `08:01` is considered an 8 hour shift (midnight to 8am). | [optional] +**end_at** | **String** | RFC 3339; shifted to timezone + offset. Precision up to the minute is respected; seconds are truncated. | [optional] **wage** | [**ShiftWage**](ShiftWage.md) | Job and pay related information. If wage is not set on create, will default to a wage of zero money. If title is not set on create, will default to the name of the role the employee is assigned to, if any. | [optional] **breaks** | [**[ModelBreak]**](ModelBreak.md) | A list of any paid or unpaid breaks that were taken during this shift. | [optional] **status** | **String** | Describes working state of the current `Shift`. See [ShiftStatus](#type-shiftstatus) for possible values | [optional] **version** | **Number** | Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If not provided, Square executes a blind write; potentially overwriting data from another write. | [optional] **created_at** | **String** | A read-only timestamp in RFC 3339 format; presented in UTC. | [optional] **updated_at** | **String** | A read-only timestamp in RFC 3339 format; presented in UTC. | [optional] +**team_member_id** | **String** | The ID of the team member this shift belongs to. Replaced `employee_id` at version \"2020-08-26\" | [optional] diff --git a/docs/ShiftFilter.md b/docs/ShiftFilter.md index 1e9970e..3e028eb 100644 --- a/docs/ShiftFilter.md +++ b/docs/ShiftFilter.md @@ -7,11 +7,12 @@ Defines a filter used in a search for `Shift` records. `AND` logic is used by Sq ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**location_ids** | **[String]** | Fetch shifts for the specified location. | [optional] -**employee_ids** | **[String]** | Fetch shifts for the specified employee. | [optional] +**location_ids** | **[String]** | Fetch shifts for the specified location. | +**employee_ids** | **[String]** | Fetch shifts for the specified employees. DEPRECATED at version 2020-08-26. Use `team_member_ids` instead | [optional] [deprecated] **status** | **String** | Fetch a `Shift` instance by `Shift.status`. See [ShiftFilterStatus](#type-shiftfilterstatus) for possible values | [optional] **start** | [**TimeRange**](TimeRange.md) | Fetch `Shift`s that start in the time range - Inclusive. | [optional] **end** | [**TimeRange**](TimeRange.md) | Fetch the `Shift`s that end in the time range - Inclusive. | [optional] **workday** | [**ShiftWorkday**](ShiftWorkday.md) | Fetch the `Shift`s based on workday date range. | [optional] +**team_member_ids** | **[String]** | Fetch shifts for the specified team members. Replaced `employee_ids` at version \"2020-08-26\" | diff --git a/docs/ShiftWorkday.md b/docs/ShiftWorkday.md index 227f231..bddd3d3 100644 --- a/docs/ShiftWorkday.md +++ b/docs/ShiftWorkday.md @@ -2,7 +2,7 @@ ### Description -A `Shift` search query filter parameter that sets a range of days that a `Shift` must start or end in before passing the filter condition. +A `Shift` search query filter parameter that sets a range of days that a `Shift` must start or end in before passing the filter condition. ## Properties Name | Type | Description | Notes diff --git a/docs/SubscriptionPhase.md b/docs/SubscriptionPhase.md index 41ad59b..c29967e 100644 --- a/docs/SubscriptionPhase.md +++ b/docs/SubscriptionPhase.md @@ -8,10 +8,10 @@ Describes a phase in a subscription plan. For more information, see [Set Up and ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**uid** | **String** | The Square-assigned ID of the subscription phase. | [optional] -**cadence** | **String** | The billing cadence of the phase. For example, weekly or monthly. See [SubscriptionCadence](#type-subscriptioncadence) for possible values | -**periods** | **Number** | The number of `cadence`s the phase lasts. If not set, the phase never ends. Only the last phase can be indefinite. | [optional] +**uid** | **String** | The Square-assigned ID of the subscription phase. This field cannot be changed after a `SubscriptionPhase` is created. | [optional] +**cadence** | **String** | The billing cadence of the phase. For example, weekly or monthly. This field cannot be changed after a `SubscriptionPhase` is created. See [SubscriptionCadence](#type-subscriptioncadence) for possible values | +**periods** | **Number** | The number of `cadence`s the phase lasts. If not set, the phase never ends. Only the last phase can be indefinite. This field cannot be changed after a `SubscriptionPhase` is created. | [optional] **recurring_price_money** | [**Money**](Money.md) | The amount to bill for each `cadence`. | -**ordinal** | **Number** | The position this phase appears in the sequence of phases defined for the plan, indexed from 0. | [optional] +**ordinal** | **Number** | The position this phase appears in the sequence of phases defined for the plan, indexed from 0. This field cannot be changed after a `SubscriptionPhase` is created. | [optional] diff --git a/docs/SubscriptionsApi.md b/docs/SubscriptionsApi.md index f1bc564..3d1334a 100644 --- a/docs/SubscriptionsApi.md +++ b/docs/SubscriptionsApi.md @@ -19,7 +19,7 @@ Method | HTTP request | Description CancelSubscription -Cancels a subscription immediately and sets the subscription `status` to `CANCELED`. You can also use the `UpdateSubscription` endpoint to cancel a subscription at a future date. For more information, see [CancelSubscriptions](/docs/subscriptions-api/overview#cancel-subscriptions). +Sets the `canceled_date` field to the end of the active billing period. After this date, the status changes from ACTIVE to CANCELED. ### Example ```javascript @@ -68,7 +68,7 @@ Name | Type | Description | Notes CreateSubscription -Creates a subscription for a customer to a subscription plan. If you provide a card on file in the request, Square charges the card for the subscription. Otherwise, Square bills an invoice to the customer's email address. The subscription starts immediately, unless the request includes the optional `start_date`. Each individual subscription is associated with a particular location. For more information, see [Subscription API Overview](/docs/subscriptions-api/overview). +Creates a subscription for a customer to a subscription plan. If you provide a card on file in the request, Square charges the card for the subscription. Otherwise, Square bills an invoice to the customer's email address. The subscription starts immediately, unless the request includes the optional `start_date`. Each individual subscription is associated with a particular location. ### Example ```javascript @@ -270,7 +270,7 @@ Name | Type | Description | Notes UpdateSubscription -Updates a subscription. You can set, modify, and clear the `subscription` field values. For more information and examples, see [Update subscriptions](/docs/subscriptions-api/overview#update-subscriptions). +Updates a subscription. You can set, modify, and clear the `subscription` field values. ### Example ```javascript diff --git a/docs/TeamMemberWage.md b/docs/TeamMemberWage.md new file mode 100644 index 0000000..6fff351 --- /dev/null +++ b/docs/TeamMemberWage.md @@ -0,0 +1,15 @@ +# SquareConnect.TeamMemberWage + +### Description + +The hourly wage rate that a team member will earn on a `Shift` for doing the job specified by the `title` property of this object. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | UUID for this object. | [optional] +**team_member_id** | **String** | The `Team Member` that this wage is assigned to. | [optional] +**title** | **String** | The job title that this wage relates to. | [optional] +**hourly_rate** | [**Money**](Money.md) | Can be a custom-set hourly wage or the calculated effective hourly wage based on annual wage and hours worked per week. | [optional] + + diff --git a/docs/Tender.md b/docs/Tender.md index c7add45..f1f41ee 100644 --- a/docs/Tender.md +++ b/docs/Tender.md @@ -19,6 +19,7 @@ Name | Type | Description | Notes **type** | **String** | The type of tender, such as `CARD` or `CASH`. See [TenderType](#type-tendertype) for possible values | **card_details** | [**TenderCardDetails**](TenderCardDetails.md) | The details of the card tender. This value is present only if the value of `type` is `CARD`. | [optional] **cash_details** | [**TenderCashDetails**](TenderCashDetails.md) | The details of the cash tender. This value is present only if the value of `type` is `CASH`. | [optional] +**bank_transfer_details** | [**TenderBankTransferDetails**](TenderBankTransferDetails.md) | The details of the bank transfer tender. This value is present only if the value of `type` is `BANK_TRANSFER`. | [optional] **additional_recipients** | [**[AdditionalRecipient]**](AdditionalRecipient.md) | Additional recipients (other than the merchant) receiving a portion of this tender. For example, fees assessed on the purchase by a third party integration. | [optional] **payment_id** | **String** | The ID of the `Payment` that corresponds to this tender. This value is only present for payments created with the v2 Payments API. | [optional] diff --git a/docs/TenderBankTransferDetails.md b/docs/TenderBankTransferDetails.md new file mode 100644 index 0000000..e0b101d --- /dev/null +++ b/docs/TenderBankTransferDetails.md @@ -0,0 +1,12 @@ +# SquareConnect.TenderBankTransferDetails + +### Description + +Represents the details of a tender with `type` `BANK_TRANSFER`. See [PaymentBankTransferDetails](#type-paymentbanktransferdetails) for more exposed details of a bank transfer payment. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**status** | **String** | The bank transfer's current state. See `TenderBankTransferDetailsStatus` for possible values. See [TenderBankTransferDetailsStatus](#type-tenderbanktransferdetailsstatus) for possible values | [optional] + + diff --git a/docs/TenderBankTransferDetailsStatus.md b/docs/TenderBankTransferDetailsStatus.md new file mode 100644 index 0000000..5af1cfa --- /dev/null +++ b/docs/TenderBankTransferDetailsStatus.md @@ -0,0 +1,12 @@ +# SquareConnect.TenderBankTransferDetailsStatus + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `COMPLETED` (value: `"COMPLETED"`) + +* `FAILED` (value: `"FAILED"`) + + diff --git a/docs/TenderType.md b/docs/TenderType.md index c66d990..70e90b6 100644 --- a/docs/TenderType.md +++ b/docs/TenderType.md @@ -13,6 +13,8 @@ * `NO_SALE` (value: `"NO_SALE"`) +* `BANK_TRANSFER` (value: `"BANK_TRANSFER"`) + * `OTHER` (value: `"OTHER"`) diff --git a/docs/TimeRange.md b/docs/TimeRange.md index aa9fa99..1ecf9aa 100644 --- a/docs/TimeRange.md +++ b/docs/TimeRange.md @@ -2,12 +2,12 @@ ### Description -Represents a generic time range. The start and end values are represented in RFC-3339 format. Time ranges are customized to be inclusive or exclusive based on the needs of a particular endpoint. Refer to the relevent endpoint-specific documentation to determine how time ranges are handled. +Represents a generic time range. The start and end values are represented in RFC 3339 format. Time ranges are customized to be inclusive or exclusive based on the needs of a particular endpoint. Refer to the relevant endpoint-specific documentation to determine how time ranges are handled. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**start_at** | **String** | A datetime value in RFC-3339 format indicating when the time range starts. | [optional] -**end_at** | **String** | A datetime value in RFC-3339 format indicating when the time range ends. | [optional] +**start_at** | **String** | A datetime value in RFC 3339 format indicating when the time range starts. | [optional] +**end_at** | **String** | A datetime value in RFC 3339 format indicating when the time range ends. | [optional] diff --git a/package.json b/package.json index d6406cc..b371b04 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "square-connect", - "version": "4.20200812.2", + "version": "4.20200826.3", "description": "JavaScript client library for the Square Connect v2 API", "keywords": [ "square", diff --git a/src/ApiClient.js b/src/ApiClient.js index 21b36c9..259839c 100644 --- a/src/ApiClient.js +++ b/src/ApiClient.js @@ -17,7 +17,7 @@ var HeaderUtils = require('./lib/HeaderUtils'); /** * @module ApiClient - * @version 4.20200812.2 + * @version 4.20200826.3 */ /** @@ -49,7 +49,7 @@ var exports = function() { * @default {} */ this.defaultHeaders = { - 'User-Agent': 'Square-Connect-Javascript/4.20200812.2' + 'User-Agent': 'Square-Connect-Javascript/4.20200826.3' }; /** * The default HTTP timeout for all API calls. diff --git a/src/api/ApplePayApi.js b/src/api/ApplePayApi.js index a6f9dea..df743be 100644 --- a/src/api/ApplePayApi.js +++ b/src/api/ApplePayApi.js @@ -53,7 +53,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/BankAccountsApi.js b/src/api/BankAccountsApi.js index e333637..ecd3911 100644 --- a/src/api/BankAccountsApi.js +++ b/src/api/BankAccountsApi.js @@ -55,7 +55,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -108,7 +108,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -162,7 +162,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/CashDrawersApi.js b/src/api/CashDrawersApi.js index a861722..c412cc5 100644 --- a/src/api/CashDrawersApi.js +++ b/src/api/CashDrawersApi.js @@ -68,7 +68,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -137,7 +137,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -203,7 +203,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/CatalogApi.js b/src/api/CatalogApi.js index 3a77b9b..740c291 100644 --- a/src/api/CatalogApi.js +++ b/src/api/CatalogApi.js @@ -71,7 +71,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -123,7 +123,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -175,7 +175,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -221,7 +221,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -273,7 +273,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -325,7 +325,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -384,7 +384,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -439,7 +439,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -491,7 +491,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -543,7 +543,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -595,7 +595,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -647,7 +647,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/CheckoutApi.js b/src/api/CheckoutApi.js index 7b8303a..f8c5f96 100644 --- a/src/api/CheckoutApi.js +++ b/src/api/CheckoutApi.js @@ -60,7 +60,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/CustomerGroupsApi.js b/src/api/CustomerGroupsApi.js index 47d0db6..35eb1fb 100644 --- a/src/api/CustomerGroupsApi.js +++ b/src/api/CustomerGroupsApi.js @@ -59,7 +59,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -113,7 +113,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -164,7 +164,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -219,7 +219,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -279,7 +279,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/CustomerSegmentsApi.js b/src/api/CustomerSegmentsApi.js index 3d84351..9d086d3 100644 --- a/src/api/CustomerSegmentsApi.js +++ b/src/api/CustomerSegmentsApi.js @@ -52,7 +52,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -107,7 +107,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/CustomersApi.js b/src/api/CustomersApi.js index ea31944..abc2539 100644 --- a/src/api/CustomersApi.js +++ b/src/api/CustomersApi.js @@ -74,7 +74,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -127,7 +127,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -186,7 +186,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -240,7 +240,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -300,7 +300,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -355,7 +355,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -419,7 +419,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -473,7 +473,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -525,7 +525,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -584,7 +584,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/DevicesApi.js b/src/api/DevicesApi.js index 09dcaaa..620b72c 100644 --- a/src/api/DevicesApi.js +++ b/src/api/DevicesApi.js @@ -56,7 +56,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -110,7 +110,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -165,7 +165,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/DisputesApi.js b/src/api/DisputesApi.js index c6c53dd..1a60945 100644 --- a/src/api/DisputesApi.js +++ b/src/api/DisputesApi.js @@ -62,7 +62,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -122,7 +122,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -177,7 +177,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -232,7 +232,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -296,7 +296,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -351,7 +351,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -412,7 +412,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -467,7 +467,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/EmployeesApi.js b/src/api/EmployeesApi.js index e005ff3..b9c457d 100644 --- a/src/api/EmployeesApi.js +++ b/src/api/EmployeesApi.js @@ -33,16 +33,18 @@ module.exports = function(apiClient) { /** + * @deprecated * ListEmployees * * @param {Object} opts Optional parameters - * @param {String} opts.locationId Filter employees returned to only those that are associated with the specified location. + * @param {String} opts.locationId * @param {String} opts.status Specifies the EmployeeStatus to filter the employee by. * @param {Number} opts.limit The number of employees to be returned on each page. * @param {String} opts.cursor The token required to retrieve the specified page of results. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListEmployeesResponse} and HTTP response */ this.listEmployeesWithHttpInfo = function(opts) { + console.warn("\x1b[33m%s\x1b[0m","Calling deprecated API: EmployeesApi.listEmployees"); opts = opts || {}; var postBody = null; @@ -57,7 +59,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -78,7 +80,7 @@ module.exports = function(apiClient) { * ListEmployees * * @param {Object} opts Optional parameters - * @param {String} opts.locationId Filter employees returned to only those that are associated with the specified location. + * @param {String} opts.locationId * @param {String} opts.status Specifies the EmployeeStatus to filter the employee by. * @param {Number} opts.limit The number of employees to be returned on each page. * @param {String} opts.cursor The token required to retrieve the specified page of results. @@ -93,12 +95,14 @@ module.exports = function(apiClient) { /** + * @deprecated * RetrieveEmployee * * @param {String} id UUID for the employee that was requested. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveEmployeeResponse} and HTTP response */ this.retrieveEmployeeWithHttpInfo = function(id) { + console.warn("\x1b[33m%s\x1b[0m","Calling deprecated API: EmployeesApi.retrieveEmployee"); var postBody = null; // verify the required parameter 'id' is set @@ -114,7 +118,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/InventoryApi.js b/src/api/InventoryApi.js index 6f02bf2..6e13654 100644 --- a/src/api/InventoryApi.js +++ b/src/api/InventoryApi.js @@ -61,7 +61,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -113,7 +113,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -165,7 +165,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -218,7 +218,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -251,7 +251,7 @@ module.exports = function(apiClient) { /** * RetrieveInventoryChanges - * Returns a set of physical counts and inventory adjustments for the provided [CatalogObject](#type-catalogobject) at the requested [Location](#type-location)s. Results are paginated and sorted in descending order according to their `occurred_at` timestamp (newest first). There are no limits on how far back the caller can page. This endpoint is useful when displaying recent changes for a specific item. For more sophisticated queries, use a batch endpoint. + * Returns a set of physical counts and inventory adjustments for the provided [CatalogObject](#type-catalogobject) at the requested [Location](#type-location)s. Results are paginated and sorted in descending order according to their `occurred_at` timestamp (newest first). There are no limits on how far back the caller can page. This endpoint can be used to display recent changes for a specific item. For more sophisticated queries, use a batch endpoint. * @param {String} catalogObjectId ID of the `CatalogObject` to retrieve. * @param {Object} opts Optional parameters * @param {String} opts.locationIds The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. @@ -277,7 +277,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -296,7 +296,7 @@ module.exports = function(apiClient) { /** * RetrieveInventoryChanges - * Returns a set of physical counts and inventory adjustments for the provided [CatalogObject](#type-catalogobject) at the requested [Location](#type-location)s. Results are paginated and sorted in descending order according to their `occurred_at` timestamp (newest first). There are no limits on how far back the caller can page. This endpoint is useful when displaying recent changes for a specific item. For more sophisticated queries, use a batch endpoint. + * Returns a set of physical counts and inventory adjustments for the provided [CatalogObject](#type-catalogobject) at the requested [Location](#type-location)s. Results are paginated and sorted in descending order according to their `occurred_at` timestamp (newest first). There are no limits on how far back the caller can page. This endpoint can be used to display recent changes for a specific item. For more sophisticated queries, use a batch endpoint. * @param {String} catalogObjectId ID of the `CatalogObject` to retrieve. * @param {Object} opts Optional parameters * @param {String} opts.locationIds The `Location` IDs to look up as a comma-separated list. An empty list queries all locations. @@ -339,7 +339,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -395,7 +395,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/InvoicesApi.js b/src/api/InvoicesApi.js index b02dcea..1fa8705 100644 --- a/src/api/InvoicesApi.js +++ b/src/api/InvoicesApi.js @@ -72,7 +72,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -126,7 +126,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -184,7 +184,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -240,7 +240,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -300,7 +300,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -363,7 +363,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -417,7 +417,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -477,7 +477,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/LaborApi.js b/src/api/LaborApi.js index 51c6558..4d39a46 100644 --- a/src/api/LaborApi.js +++ b/src/api/LaborApi.js @@ -21,8 +21,10 @@ var DeleteShiftResponse = require('../model/DeleteShiftResponse'); var GetBreakTypeResponse = require('../model/GetBreakTypeResponse'); var GetEmployeeWageResponse = require('../model/GetEmployeeWageResponse'); var GetShiftResponse = require('../model/GetShiftResponse'); +var GetTeamMemberWageResponse = require('../model/GetTeamMemberWageResponse'); var ListBreakTypesResponse = require('../model/ListBreakTypesResponse'); var ListEmployeeWagesResponse = require('../model/ListEmployeeWagesResponse'); +var ListTeamMemberWagesResponse = require('../model/ListTeamMemberWagesResponse'); var ListWorkweekConfigsResponse = require('../model/ListWorkweekConfigsResponse'); var SearchShiftsRequest = require('../model/SearchShiftsRequest'); var SearchShiftsResponse = require('../model/SearchShiftsResponse'); @@ -52,7 +54,7 @@ module.exports = function(apiClient) { /** * CreateBreakType - * Creates a new `BreakType`. A `BreakType` is a template for creating `Break` objects. You must provide the following values in your request to this endpoint: - `location_id` - `break_name` - `expected_duration` - `is_paid` You can only have 3 `BreakType` instances per location. If you attempt to add a 4th `BreakType` for a location, an `INVALID_REQUEST_ERROR` \"Exceeded limit of 3 breaks per location.\" is returned. + * Creates a new `BreakType`. A `BreakType` is a template for creating `Break` objects. You must provide the following values in your request to this endpoint: - `location_id` - `break_name` - `expected_duration` - `is_paid` You can only have 3 `BreakType` instances per location. If you attempt to add a 4th `BreakType` for a location, an `INVALID_REQUEST_ERROR` \"Exceeded limit of 3 breaks per location.\" is returned. * @param {module:model/CreateBreakTypeRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateBreakTypeResponse} and HTTP response */ @@ -71,7 +73,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -90,7 +92,7 @@ module.exports = function(apiClient) { /** * CreateBreakType - * Creates a new `BreakType`. A `BreakType` is a template for creating `Break` objects. You must provide the following values in your request to this endpoint: - `location_id` - `break_name` - `expected_duration` - `is_paid` You can only have 3 `BreakType` instances per location. If you attempt to add a 4th `BreakType` for a location, an `INVALID_REQUEST_ERROR` \"Exceeded limit of 3 breaks per location.\" is returned. + * Creates a new `BreakType`. A `BreakType` is a template for creating `Break` objects. You must provide the following values in your request to this endpoint: - `location_id` - `break_name` - `expected_duration` - `is_paid` You can only have 3 `BreakType` instances per location. If you attempt to add a 4th `BreakType` for a location, an `INVALID_REQUEST_ERROR` \"Exceeded limit of 3 breaks per location.\" is returned. * @param {module:model/CreateBreakTypeRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateBreakTypeResponse} */ @@ -104,7 +106,7 @@ module.exports = function(apiClient) { /** * CreateShift - * Creates a new `Shift`. A `Shift` represents a complete work day for a single employee. You must provide the following values in your request to this endpoint: - `location_id` - `employee_id` - `start_at` An attempt to create a new `Shift` can result in a `BAD_REQUEST` error when: - The `status` of the new `Shift` is `OPEN` and the employee has another shift with an `OPEN` status. - The `start_at` date is in the future - the `start_at` or `end_at` overlaps another shift for the same employee - If `Break`s are set in the request, a break `start_at` must not be before the `Shift.start_at`. A break `end_at` must not be after the `Shift.end_at` + * Creates a new `Shift`. A `Shift` represents a complete work day for a single employee. You must provide the following values in your request to this endpoint: - `location_id` - `employee_id` - `start_at` An attempt to create a new `Shift` can result in a `BAD_REQUEST` error when: - The `status` of the new `Shift` is `OPEN` and the employee has another shift with an `OPEN` status. - The `start_at` date is in the future - the `start_at` or `end_at` overlaps another shift for the same employee - If `Break`s are set in the request, a break `start_at` must not be before the `Shift.start_at`. A break `end_at` must not be after the `Shift.end_at` * @param {module:model/CreateShiftRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateShiftResponse} and HTTP response */ @@ -123,7 +125,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -142,7 +144,7 @@ module.exports = function(apiClient) { /** * CreateShift - * Creates a new `Shift`. A `Shift` represents a complete work day for a single employee. You must provide the following values in your request to this endpoint: - `location_id` - `employee_id` - `start_at` An attempt to create a new `Shift` can result in a `BAD_REQUEST` error when: - The `status` of the new `Shift` is `OPEN` and the employee has another shift with an `OPEN` status. - The `start_at` date is in the future - the `start_at` or `end_at` overlaps another shift for the same employee - If `Break`s are set in the request, a break `start_at` must not be before the `Shift.start_at`. A break `end_at` must not be after the `Shift.end_at` + * Creates a new `Shift`. A `Shift` represents a complete work day for a single employee. You must provide the following values in your request to this endpoint: - `location_id` - `employee_id` - `start_at` An attempt to create a new `Shift` can result in a `BAD_REQUEST` error when: - The `status` of the new `Shift` is `OPEN` and the employee has another shift with an `OPEN` status. - The `start_at` date is in the future - the `start_at` or `end_at` overlaps another shift for the same employee - If `Break`s are set in the request, a break `start_at` must not be before the `Shift.start_at`. A break `end_at` must not be after the `Shift.end_at` * @param {module:model/CreateShiftRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateShiftResponse} */ @@ -156,7 +158,7 @@ module.exports = function(apiClient) { /** * DeleteBreakType - * Deletes an existing `BreakType`. A `BreakType` can be deleted even if it is referenced from a `Shift`. + * Deletes an existing `BreakType`. A `BreakType` can be deleted even if it is referenced from a `Shift`. * @param {String} id UUID for the `BreakType` being deleted. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteBreakTypeResponse} and HTTP response */ @@ -176,7 +178,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -195,7 +197,7 @@ module.exports = function(apiClient) { /** * DeleteBreakType - * Deletes an existing `BreakType`. A `BreakType` can be deleted even if it is referenced from a `Shift`. + * Deletes an existing `BreakType`. A `BreakType` can be deleted even if it is referenced from a `Shift`. * @param {String} id UUID for the `BreakType` being deleted. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteBreakTypeResponse} */ @@ -229,7 +231,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -282,7 +284,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -314,12 +316,14 @@ module.exports = function(apiClient) { /** + * @deprecated * GetEmployeeWage * Returns a single `EmployeeWage` specified by id. * @param {String} id UUID for the `EmployeeWage` being retrieved. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetEmployeeWageResponse} and HTTP response */ this.getEmployeeWageWithHttpInfo = function(id) { + console.warn("\x1b[33m%s\x1b[0m","Calling deprecated API: LaborApi.getEmployeeWage"); var postBody = null; // verify the required parameter 'id' is set @@ -335,7 +339,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -388,7 +392,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -419,6 +423,59 @@ module.exports = function(apiClient) { } + /** + * GetTeamMemberWage + * Returns a single `TeamMemberWage` specified by id. + * @param {String} id UUID for the `TeamMemberWage` being retrieved. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetTeamMemberWageResponse} and HTTP response + */ + this.getTeamMemberWageWithHttpInfo = function(id) { + var postBody = null; + + // verify the required parameter 'id' is set + if (id === undefined || id === null) { + throw new Error("Missing the required parameter 'id' when calling getTeamMemberWage"); + } + + + var pathParams = { + 'id': id + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-08-26'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = GetTeamMemberWageResponse; + + return this.apiClient.callApi( + '/v2/labor/team-member-wages/{id}', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * GetTeamMemberWage + * Returns a single `TeamMemberWage` specified by id. + * @param {String} id UUID for the `TeamMemberWage` being retrieved. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetTeamMemberWageResponse} + */ + this.getTeamMemberWage = function(id) { + return this.getTeamMemberWageWithHttpInfo(id) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + /** * ListBreakTypes * Returns a paginated list of `BreakType` instances for a business. @@ -442,7 +499,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -477,6 +534,7 @@ module.exports = function(apiClient) { /** + * @deprecated * ListEmployeeWages * Returns a paginated list of `EmployeeWage` instances for a business. * @param {Object} opts Optional parameters @@ -486,6 +544,7 @@ module.exports = function(apiClient) { * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListEmployeeWagesResponse} and HTTP response */ this.listEmployeeWagesWithHttpInfo = function(opts) { + console.warn("\x1b[33m%s\x1b[0m","Calling deprecated API: LaborApi.listEmployeeWages"); opts = opts || {}; var postBody = null; @@ -499,7 +558,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -533,6 +592,63 @@ module.exports = function(apiClient) { } + /** + * ListTeamMemberWages + * Returns a paginated list of `TeamMemberWage` instances for a business. + * @param {Object} opts Optional parameters + * @param {String} opts.teamMemberId Filter wages returned to only those that are associated with the specified team member. + * @param {Number} opts.limit Maximum number of Team Member Wages to return per page. Can range between 1 and 200. The default is the maximum at 200. + * @param {String} opts.cursor Pointer to the next page of Employee Wage results to fetch. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListTeamMemberWagesResponse} and HTTP response + */ + this.listTeamMemberWagesWithHttpInfo = function(opts) { + opts = opts || {}; + var postBody = null; + + + var pathParams = { + }; + var queryParams = { + 'team_member_id': opts['teamMemberId'], + 'limit': opts['limit'], + 'cursor': opts['cursor'] + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-08-26'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = ListTeamMemberWagesResponse; + + return this.apiClient.callApi( + '/v2/labor/team-member-wages', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * ListTeamMemberWages + * Returns a paginated list of `TeamMemberWage` instances for a business. + * @param {Object} opts Optional parameters + * @param {String} opts.teamMemberId Filter wages returned to only those that are associated with the specified team member. + * @param {Number} opts.limit Maximum number of Team Member Wages to return per page. Can range between 1 and 200. The default is the maximum at 200. + * @param {String} opts.cursor Pointer to the next page of Employee Wage results to fetch. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListTeamMemberWagesResponse} + */ + this.listTeamMemberWages = function(opts) { + return this.listTeamMemberWagesWithHttpInfo(opts) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + /** * ListWorkweekConfigs * Returns a list of `WorkweekConfig` instances for a business. @@ -554,7 +670,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -589,7 +705,7 @@ module.exports = function(apiClient) { /** * SearchShifts - * Returns a paginated list of `Shift` records for a business. The list to be returned can be filtered by: - Location IDs **and** - employee IDs **and** - shift status (`OPEN`, `CLOSED`) **and** - shift start **and** - shift end **and** - work day details The list can be sorted by: - `start_at` - `end_at` - `created_at` - `updated_at` + * Returns a paginated list of `Shift` records for a business. The list to be returned can be filtered by: - Location IDs **and** - employee IDs **and** - shift status (`OPEN`, `CLOSED`) **and** - shift start **and** - shift end **and** - work day details The list can be sorted by: - `start_at` - `end_at` - `created_at` - `updated_at` * @param {module:model/SearchShiftsRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/SearchShiftsResponse} and HTTP response */ @@ -608,7 +724,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -627,7 +743,7 @@ module.exports = function(apiClient) { /** * SearchShifts - * Returns a paginated list of `Shift` records for a business. The list to be returned can be filtered by: - Location IDs **and** - employee IDs **and** - shift status (`OPEN`, `CLOSED`) **and** - shift start **and** - shift end **and** - work day details The list can be sorted by: - `start_at` - `end_at` - `created_at` - `updated_at` + * Returns a paginated list of `Shift` records for a business. The list to be returned can be filtered by: - Location IDs **and** - employee IDs **and** - shift status (`OPEN`, `CLOSED`) **and** - shift start **and** - shift end **and** - work day details The list can be sorted by: - `start_at` - `end_at` - `created_at` - `updated_at` * @param {module:model/SearchShiftsRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/SearchShiftsResponse} */ @@ -667,7 +783,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -701,7 +817,7 @@ module.exports = function(apiClient) { /** * UpdateShift - * Updates an existing `Shift`. When adding a `Break` to a `Shift`, any earlier `Breaks` in the `Shift` have the `end_at` property set to a valid RFC-3339 datetime string. When closing a `Shift`, all `Break` instances in the shift must be complete with `end_at` set on each `Break`. + * Updates an existing `Shift`. When adding a `Break` to a `Shift`, any earlier `Breaks` in the `Shift` have the `end_at` property set to a valid RFC-3339 datetime string. When closing a `Shift`, all `Break` instances in the shift must be complete with `end_at` set on each `Break`. * @param {String} id ID of the object being updated. * @param {module:model/UpdateShiftRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateShiftResponse} and HTTP response @@ -727,7 +843,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -746,7 +862,7 @@ module.exports = function(apiClient) { /** * UpdateShift - * Updates an existing `Shift`. When adding a `Break` to a `Shift`, any earlier `Breaks` in the `Shift` have the `end_at` property set to a valid RFC-3339 datetime string. When closing a `Shift`, all `Break` instances in the shift must be complete with `end_at` set on each `Break`. + * Updates an existing `Shift`. When adding a `Break` to a `Shift`, any earlier `Breaks` in the `Shift` have the `end_at` property set to a valid RFC-3339 datetime string. When closing a `Shift`, all `Break` instances in the shift must be complete with `end_at` set on each `Break`. * @param {String} id ID of the object being updated. * @param {module:model/UpdateShiftRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateShiftResponse} @@ -787,7 +903,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/LocationsApi.js b/src/api/LocationsApi.js index 9f328d4..4d9a2b6 100644 --- a/src/api/LocationsApi.js +++ b/src/api/LocationsApi.js @@ -58,7 +58,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -104,7 +104,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -156,7 +156,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -216,7 +216,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/LoyaltyApi.js b/src/api/LoyaltyApi.js index 9132436..7fa00cd 100644 --- a/src/api/LoyaltyApi.js +++ b/src/api/LoyaltyApi.js @@ -81,7 +81,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -142,7 +142,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -203,7 +203,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -257,7 +257,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -310,7 +310,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -364,7 +364,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -411,7 +411,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -470,7 +470,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -525,7 +525,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -579,7 +579,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -632,7 +632,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -685,7 +685,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -738,7 +738,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/MerchantsApi.js b/src/api/MerchantsApi.js index 56d7488..4868d3d 100644 --- a/src/api/MerchantsApi.js +++ b/src/api/MerchantsApi.js @@ -51,7 +51,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -105,7 +105,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/MobileAuthorizationApi.js b/src/api/MobileAuthorizationApi.js index 7ef5e9a..3a26c72 100644 --- a/src/api/MobileAuthorizationApi.js +++ b/src/api/MobileAuthorizationApi.js @@ -53,7 +53,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/OAuthApi.js b/src/api/OAuthApi.js index f8be1b1..c1a1883 100644 --- a/src/api/OAuthApi.js +++ b/src/api/OAuthApi.js @@ -57,7 +57,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -118,7 +118,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -171,7 +171,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/OrdersApi.js b/src/api/OrdersApi.js index 95dea01..96973e2 100644 --- a/src/api/OrdersApi.js +++ b/src/api/OrdersApi.js @@ -45,18 +45,12 @@ module.exports = function(apiClient) { /** * BatchRetrieveOrders * Retrieves a set of [Order](#type-order)s by their IDs. If a given Order ID does not exist, the ID is ignored instead of generating an error. - * @param {String} locationId The ID of the orders' associated location. * @param {module:model/BatchRetrieveOrdersRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/BatchRetrieveOrdersResponse} and HTTP response */ - this.batchRetrieveOrdersWithHttpInfo = function(locationId, body) { + this.batchRetrieveOrdersWithHttpInfo = function(body) { var postBody = body; - // verify the required parameter 'locationId' is set - if (locationId === undefined || locationId === null) { - throw new Error("Missing the required parameter 'locationId' when calling batchRetrieveOrders"); - } - // verify the required parameter 'body' is set if (body === undefined || body === null) { throw new Error("Missing the required parameter 'body' when calling batchRetrieveOrders"); @@ -64,13 +58,12 @@ module.exports = function(apiClient) { var pathParams = { - 'location_id': locationId }; var queryParams = { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -81,7 +74,7 @@ module.exports = function(apiClient) { var returnType = BatchRetrieveOrdersResponse; return this.apiClient.callApi( - '/v2/locations/{location_id}/orders/batch-retrieve', 'POST', + '/v2/orders/batch-retrieve', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType ); @@ -90,12 +83,11 @@ module.exports = function(apiClient) { /** * BatchRetrieveOrders * Retrieves a set of [Order](#type-order)s by their IDs. If a given Order ID does not exist, the ID is ignored instead of generating an error. - * @param {String} locationId The ID of the orders' associated location. * @param {module:model/BatchRetrieveOrdersRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/BatchRetrieveOrdersResponse} */ - this.batchRetrieveOrders = function(locationId, body) { - return this.batchRetrieveOrdersWithHttpInfo(locationId, body) + this.batchRetrieveOrders = function(body) { + return this.batchRetrieveOrdersWithHttpInfo(body) .then(function(response_and_data) { return response_and_data.data; }); @@ -124,7 +116,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -158,18 +150,12 @@ module.exports = function(apiClient) { /** * CreateOrder * Creates a new [Order](#type-order) which can include information on products for purchase and settings to apply to the purchase. To pay for a created order, please refer to the [Pay for Orders](/orders-api/pay-for-orders) guide. You can modify open orders using the [UpdateOrder](#endpoint-orders-updateorder) endpoint. To learn more about the Orders API, see the [Orders API Overview](/orders-api/what-it-does). - * @param {String} locationId The ID of the business location to associate the order with. * @param {module:model/CreateOrderRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateOrderResponse} and HTTP response */ - this.createOrderWithHttpInfo = function(locationId, body) { + this.createOrderWithHttpInfo = function(body) { var postBody = body; - // verify the required parameter 'locationId' is set - if (locationId === undefined || locationId === null) { - throw new Error("Missing the required parameter 'locationId' when calling createOrder"); - } - // verify the required parameter 'body' is set if (body === undefined || body === null) { throw new Error("Missing the required parameter 'body' when calling createOrder"); @@ -177,13 +163,12 @@ module.exports = function(apiClient) { var pathParams = { - 'location_id': locationId }; var queryParams = { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -194,7 +179,7 @@ module.exports = function(apiClient) { var returnType = CreateOrderResponse; return this.apiClient.callApi( - '/v2/locations/{location_id}/orders', 'POST', + '/v2/orders', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType ); @@ -203,12 +188,11 @@ module.exports = function(apiClient) { /** * CreateOrder * Creates a new [Order](#type-order) which can include information on products for purchase and settings to apply to the purchase. To pay for a created order, please refer to the [Pay for Orders](/orders-api/pay-for-orders) guide. You can modify open orders using the [UpdateOrder](#endpoint-orders-updateorder) endpoint. To learn more about the Orders API, see the [Orders API Overview](/orders-api/what-it-does). - * @param {String} locationId The ID of the business location to associate the order with. * @param {module:model/CreateOrderRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateOrderResponse} */ - this.createOrder = function(locationId, body) { - return this.createOrderWithHttpInfo(locationId, body) + this.createOrder = function(body) { + return this.createOrderWithHttpInfo(body) .then(function(response_and_data) { return response_and_data.data; }); @@ -244,7 +228,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -297,7 +281,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -332,19 +316,13 @@ module.exports = function(apiClient) { * UpdateOrder * Note: This endpoint is in beta. * Updates an open [Order](#type-order) by adding, replacing, or deleting fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. An UpdateOrder request requires the following: - The `order_id` in the endpoint path, identifying the order to update. - The latest `version` of the order to update. - The [sparse order](/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to. - If deleting fields, the [dot notation paths](/orders-api/manage-orders#on-dot-notation) identifying fields to clear. To pay for an order, please refer to the [Pay for Orders](/orders-api/pay-for-orders) guide. To learn more about the Orders API, see the [Orders API Overview](/orders-api/what-it-does). - * @param {String} locationId The ID of the order's associated location. * @param {String} orderId The ID of the order to update. * @param {module:model/UpdateOrderRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateOrderResponse} and HTTP response */ - this.updateOrderWithHttpInfo = function(locationId, orderId, body) { + this.updateOrderWithHttpInfo = function(orderId, body) { var postBody = body; - // verify the required parameter 'locationId' is set - if (locationId === undefined || locationId === null) { - throw new Error("Missing the required parameter 'locationId' when calling updateOrder"); - } - // verify the required parameter 'orderId' is set if (orderId === undefined || orderId === null) { throw new Error("Missing the required parameter 'orderId' when calling updateOrder"); @@ -357,14 +335,13 @@ module.exports = function(apiClient) { var pathParams = { - 'location_id': locationId, 'order_id': orderId }; var queryParams = { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -375,7 +352,7 @@ module.exports = function(apiClient) { var returnType = UpdateOrderResponse; return this.apiClient.callApi( - '/v2/locations/{location_id}/orders/{order_id}', 'PUT', + '/v2/orders/{order_id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType ); @@ -384,13 +361,12 @@ module.exports = function(apiClient) { /** * UpdateOrder * Updates an open [Order](#type-order) by adding, replacing, or deleting fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated. An UpdateOrder request requires the following: - The `order_id` in the endpoint path, identifying the order to update. - The latest `version` of the order to update. - The [sparse order](/orders-api/manage-orders#sparse-order-objects) containing only the fields to update and the version the update is being applied to. - If deleting fields, the [dot notation paths](/orders-api/manage-orders#on-dot-notation) identifying fields to clear. To pay for an order, please refer to the [Pay for Orders](/orders-api/pay-for-orders) guide. To learn more about the Orders API, see the [Orders API Overview](/orders-api/what-it-does). - * @param {String} locationId The ID of the order's associated location. * @param {String} orderId The ID of the order to update. * @param {module:model/UpdateOrderRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateOrderResponse} */ - this.updateOrder = function(locationId, orderId, body) { - return this.updateOrderWithHttpInfo(locationId, orderId, body) + this.updateOrder = function(orderId, body) { + return this.updateOrderWithHttpInfo(orderId, body) .then(function(response_and_data) { return response_and_data.data; }); diff --git a/src/api/PaymentsApi.js b/src/api/PaymentsApi.js index da0ca44..1658d08 100644 --- a/src/api/PaymentsApi.js +++ b/src/api/PaymentsApi.js @@ -60,7 +60,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -112,7 +112,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -165,7 +165,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -217,7 +217,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -270,7 +270,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -334,7 +334,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/RefundsApi.js b/src/api/RefundsApi.js index a7ae1d5..b3f832a 100644 --- a/src/api/RefundsApi.js +++ b/src/api/RefundsApi.js @@ -56,7 +56,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -118,7 +118,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -177,7 +177,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/ReportingApi.js b/src/api/ReportingApi.js deleted file mode 100644 index 3723180..0000000 --- a/src/api/ReportingApi.js +++ /dev/null @@ -1,173 +0,0 @@ -/** - * Square Connect API - * Client library for accessing the Square Connect APIs - * - * OpenAPI spec version: 2.0 - * Contact: developers@squareup.com - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * - * Swagger Codegen version: 2.3.0-SNAPSHOT - * - */ -var ApiClient = require('../ApiClient'); -var ListAdditionalRecipientReceivableRefundsResponse = require('../model/ListAdditionalRecipientReceivableRefundsResponse'); -var ListAdditionalRecipientReceivablesResponse = require('../model/ListAdditionalRecipientReceivablesResponse'); - -/** - * Reporting service. - * @module api/ReportingApi - */ - -/** - * Constructs a new ReportingApi. - * @alias module:api/ReportingApi - * @class - * @param {module:ApiClient} apiClient Optional API client implementation to use, - * default to {@link module:ApiClient#instance} if unspecified. - */ -module.exports = function(apiClient) { - this.apiClient = apiClient || ApiClient.instance; - - - - /** - * @deprecated - * ListAdditionalRecipientReceivableRefunds - * Returns a list of refunded transactions (across all possible originating locations) relating to monies credited to the provided location ID by another Square account using the `additional_recipients` field in a transaction. Max results per [page](#paginatingresults): 50 - * @param {String} locationId The ID of the location to list AdditionalRecipientReceivableRefunds for. - * @param {Object} opts Optional parameters - * @param {String} opts.beginTime 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. - * @param {String} opts.endTime 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. - * @param {String} opts.sortOrder The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` - * @param {String} opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListAdditionalRecipientReceivableRefundsResponse} and HTTP response - */ - this.listAdditionalRecipientReceivableRefundsWithHttpInfo = function(locationId, opts) { - console.warn("\x1b[33m%s\x1b[0m","Calling deprecated API: ReportingApi.listAdditionalRecipientReceivableRefunds"); - opts = opts || {}; - var postBody = null; - - // verify the required parameter 'locationId' is set - if (locationId === undefined || locationId === null) { - throw new Error("Missing the required parameter 'locationId' when calling listAdditionalRecipientReceivableRefunds"); - } - - - var pathParams = { - 'location_id': locationId - }; - var queryParams = { - 'begin_time': opts['beginTime'], - 'end_time': opts['endTime'], - 'sort_order': opts['sortOrder'], - 'cursor': opts['cursor'] - }; - var headerParams = { - }; - headerParams['Square-Version'] = '2020-08-12'; - - var formParams = { - }; - - var authNames = ['oauth2']; - var contentTypes = ['application/json']; - var accepts = ['application/json']; - var returnType = ListAdditionalRecipientReceivableRefundsResponse; - - return this.apiClient.callApi( - '/v2/locations/{location_id}/additional-recipient-receivable-refunds', 'GET', - pathParams, queryParams, headerParams, formParams, postBody, - authNames, contentTypes, accepts, returnType - ); - } - - /** - * ListAdditionalRecipientReceivableRefunds - * Returns a list of refunded transactions (across all possible originating locations) relating to monies credited to the provided location ID by another Square account using the `additional_recipients` field in a transaction. Max results per [page](#paginatingresults): 50 - * @param {String} locationId The ID of the location to list AdditionalRecipientReceivableRefunds for. - * @param {Object} opts Optional parameters - * @param {String} opts.beginTime 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. - * @param {String} opts.endTime 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. - * @param {String} opts.sortOrder The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` - * @param {String} opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListAdditionalRecipientReceivableRefundsResponse} - */ - this.listAdditionalRecipientReceivableRefunds = function(locationId, opts) { - return this.listAdditionalRecipientReceivableRefundsWithHttpInfo(locationId, opts) - .then(function(response_and_data) { - return response_and_data.data; - }); - } - - - /** - * @deprecated - * ListAdditionalRecipientReceivables - * Returns a list of receivables (across all possible sending locations) representing monies credited to the provided location ID by another Square account using the `additional_recipients` field in a transaction. Max results per [page](#paginatingresults): 50 - * @param {String} locationId The ID of the location to list AdditionalRecipientReceivables for. - * @param {Object} opts Optional parameters - * @param {String} opts.beginTime 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. - * @param {String} opts.endTime 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. - * @param {String} opts.sortOrder The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` - * @param {String} opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListAdditionalRecipientReceivablesResponse} and HTTP response - */ - this.listAdditionalRecipientReceivablesWithHttpInfo = function(locationId, opts) { - console.warn("\x1b[33m%s\x1b[0m","Calling deprecated API: ReportingApi.listAdditionalRecipientReceivables"); - opts = opts || {}; - var postBody = null; - - // verify the required parameter 'locationId' is set - if (locationId === undefined || locationId === null) { - throw new Error("Missing the required parameter 'locationId' when calling listAdditionalRecipientReceivables"); - } - - - var pathParams = { - 'location_id': locationId - }; - var queryParams = { - 'begin_time': opts['beginTime'], - 'end_time': opts['endTime'], - 'sort_order': opts['sortOrder'], - 'cursor': opts['cursor'] - }; - var headerParams = { - }; - headerParams['Square-Version'] = '2020-08-12'; - - var formParams = { - }; - - var authNames = ['oauth2']; - var contentTypes = ['application/json']; - var accepts = ['application/json']; - var returnType = ListAdditionalRecipientReceivablesResponse; - - return this.apiClient.callApi( - '/v2/locations/{location_id}/additional-recipient-receivables', 'GET', - pathParams, queryParams, headerParams, formParams, postBody, - authNames, contentTypes, accepts, returnType - ); - } - - /** - * ListAdditionalRecipientReceivables - * Returns a list of receivables (across all possible sending locations) representing monies credited to the provided location ID by another Square account using the `additional_recipients` field in a transaction. Max results per [page](#paginatingresults): 50 - * @param {String} locationId The ID of the location to list AdditionalRecipientReceivables for. - * @param {Object} opts Optional parameters - * @param {String} opts.beginTime 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. - * @param {String} opts.endTime 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. - * @param {String} opts.sortOrder The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` - * @param {String} opts.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. - * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListAdditionalRecipientReceivablesResponse} - */ - this.listAdditionalRecipientReceivables = function(locationId, opts) { - return this.listAdditionalRecipientReceivablesWithHttpInfo(locationId, opts) - .then(function(response_and_data) { - return response_and_data.data; - }); - } -}; diff --git a/src/api/SubscriptionsApi.js b/src/api/SubscriptionsApi.js index 6f48062..ee295ed 100644 --- a/src/api/SubscriptionsApi.js +++ b/src/api/SubscriptionsApi.js @@ -42,7 +42,7 @@ module.exports = function(apiClient) { /** * CancelSubscription * Note: This endpoint is in beta. - * Cancels a subscription immediately and sets the subscription `status` to `CANCELED`. You can also use the `UpdateSubscription` endpoint to cancel a subscription at a future date. For more information, see [CancelSubscriptions](/docs/subscriptions-api/overview#cancel-subscriptions). + * Sets the `canceled_date` field to the end of the active billing period. After this date, the status changes from ACTIVE to CANCELED. * @param {String} subscriptionId The ID of the subscription to cancel. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CancelSubscriptionResponse} and HTTP response */ @@ -62,7 +62,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -81,7 +81,7 @@ module.exports = function(apiClient) { /** * CancelSubscription - * Cancels a subscription immediately and sets the subscription `status` to `CANCELED`. You can also use the `UpdateSubscription` endpoint to cancel a subscription at a future date. For more information, see [CancelSubscriptions](/docs/subscriptions-api/overview#cancel-subscriptions). + * Sets the `canceled_date` field to the end of the active billing period. After this date, the status changes from ACTIVE to CANCELED. * @param {String} subscriptionId The ID of the subscription to cancel. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CancelSubscriptionResponse} */ @@ -96,7 +96,7 @@ module.exports = function(apiClient) { /** * CreateSubscription * Note: This endpoint is in beta. - * Creates a subscription for a customer to a subscription plan. If you provide a card on file in the request, Square charges the card for the subscription. Otherwise, Square bills an invoice to the customer's email address. The subscription starts immediately, unless the request includes the optional `start_date`. Each individual subscription is associated with a particular location. For more information, see [Subscription API Overview](/docs/subscriptions-api/overview). + * Creates a subscription for a customer to a subscription plan. If you provide a card on file in the request, Square charges the card for the subscription. Otherwise, Square bills an invoice to the customer's email address. The subscription starts immediately, unless the request includes the optional `start_date`. Each individual subscription is associated with a particular location. * @param {module:model/CreateSubscriptionRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateSubscriptionResponse} and HTTP response */ @@ -115,7 +115,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -134,7 +134,7 @@ module.exports = function(apiClient) { /** * CreateSubscription - * Creates a subscription for a customer to a subscription plan. If you provide a card on file in the request, Square charges the card for the subscription. Otherwise, Square bills an invoice to the customer's email address. The subscription starts immediately, unless the request includes the optional `start_date`. Each individual subscription is associated with a particular location. For more information, see [Subscription API Overview](/docs/subscriptions-api/overview). + * Creates a subscription for a customer to a subscription plan. If you provide a card on file in the request, Square charges the card for the subscription. Otherwise, Square bills an invoice to the customer's email address. The subscription starts immediately, unless the request includes the optional `start_date`. Each individual subscription is associated with a particular location. * @param {module:model/CreateSubscriptionRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateSubscriptionResponse} */ @@ -175,7 +175,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -232,7 +232,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -285,7 +285,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -319,7 +319,7 @@ module.exports = function(apiClient) { /** * UpdateSubscription * Note: This endpoint is in beta. - * Updates a subscription. You can set, modify, and clear the `subscription` field values. For more information and examples, see [Update subscriptions](/docs/subscriptions-api/overview#update-subscriptions). + * Updates a subscription. You can set, modify, and clear the `subscription` field values. * @param {String} subscriptionId The ID for the subscription to update. * @param {module:model/UpdateSubscriptionRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/UpdateSubscriptionResponse} and HTTP response @@ -345,7 +345,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -364,7 +364,7 @@ module.exports = function(apiClient) { /** * UpdateSubscription - * Updates a subscription. You can set, modify, and clear the `subscription` field values. For more information and examples, see [Update subscriptions](/docs/subscriptions-api/overview#update-subscriptions). + * Updates a subscription. You can set, modify, and clear the `subscription` field values. * @param {String} subscriptionId The ID for the subscription to update. * @param {module:model/UpdateSubscriptionRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/UpdateSubscriptionResponse} diff --git a/src/api/TeamApi.js b/src/api/TeamApi.js index 9746937..b4da2d7 100644 --- a/src/api/TeamApi.js +++ b/src/api/TeamApi.js @@ -65,7 +65,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -117,7 +117,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -169,7 +169,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -222,7 +222,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -275,7 +275,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -327,7 +327,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -386,7 +386,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -446,7 +446,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/TerminalApi.js b/src/api/TerminalApi.js index c38d6c2..2054f5c 100644 --- a/src/api/TerminalApi.js +++ b/src/api/TerminalApi.js @@ -59,7 +59,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -112,7 +112,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -166,7 +166,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -219,7 +219,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/TransactionsApi.js b/src/api/TransactionsApi.js index fb92574..ad97244 100644 --- a/src/api/TransactionsApi.js +++ b/src/api/TransactionsApi.js @@ -70,7 +70,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -132,7 +132,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -201,7 +201,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -268,7 +268,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -338,7 +338,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -405,7 +405,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -468,7 +468,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/V1EmployeesApi.js b/src/api/V1EmployeesApi.js index bde35a5..9075a6c 100644 --- a/src/api/V1EmployeesApi.js +++ b/src/api/V1EmployeesApi.js @@ -56,7 +56,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -108,7 +108,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -162,7 +162,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -217,7 +217,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -280,7 +280,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -338,7 +338,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -407,7 +407,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -471,7 +471,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -543,7 +543,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -616,7 +616,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -670,7 +670,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -723,7 +723,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -778,7 +778,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -837,7 +837,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -897,7 +897,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -959,7 +959,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/V1ItemsApi.js b/src/api/V1ItemsApi.js index 93c7788..62951a2 100644 --- a/src/api/V1ItemsApi.js +++ b/src/api/V1ItemsApi.js @@ -79,7 +79,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -150,7 +150,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -221,7 +221,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -284,7 +284,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -346,7 +346,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -408,7 +408,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -470,7 +470,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -532,7 +532,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -601,7 +601,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -664,7 +664,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -733,7 +733,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -797,7 +797,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -860,7 +860,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -923,7 +923,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -986,7 +986,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -1049,7 +1049,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -1119,7 +1119,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -1183,7 +1183,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -1252,7 +1252,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -1325,7 +1325,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -1382,7 +1382,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -1437,7 +1437,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -1492,7 +1492,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -1553,7 +1553,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -1615,7 +1615,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -1672,7 +1672,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -1727,7 +1727,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -1796,7 +1796,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -1867,7 +1867,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -1931,7 +1931,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -1994,7 +1994,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -2063,7 +2063,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -2133,7 +2133,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -2203,7 +2203,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -2273,7 +2273,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -2343,7 +2343,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -2420,7 +2420,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -2491,7 +2491,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -2561,7 +2561,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -2638,7 +2638,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/V1LocationsApi.js b/src/api/V1LocationsApi.js index cad84a9..319a3de 100644 --- a/src/api/V1LocationsApi.js +++ b/src/api/V1LocationsApi.js @@ -48,7 +48,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -95,7 +95,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/api/V1TransactionsApi.js b/src/api/V1TransactionsApi.js index bb9004d..30ee72b 100644 --- a/src/api/V1TransactionsApi.js +++ b/src/api/V1TransactionsApi.js @@ -65,7 +65,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -121,7 +121,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -182,7 +182,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -253,7 +253,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -325,7 +325,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -398,7 +398,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -467,7 +467,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -528,7 +528,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -589,7 +589,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -650,7 +650,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; @@ -717,7 +717,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-08-12'; + headerParams['Square-Version'] = '2020-08-26'; var formParams = { }; diff --git a/src/index.js b/src/index.js index 274ce39..512d746 100644 --- a/src/index.js +++ b/src/index.js @@ -21,8 +21,6 @@ var ActionCancelReason = require('./model/ActionCancelReason'); var AddGroupToCustomerRequest = require('./model/AddGroupToCustomerRequest'); var AddGroupToCustomerResponse = require('./model/AddGroupToCustomerResponse'); var AdditionalRecipient = require('./model/AdditionalRecipient'); -var AdditionalRecipientReceivable = require('./model/AdditionalRecipientReceivable'); -var AdditionalRecipientReceivableRefund = require('./model/AdditionalRecipientReceivableRefund'); var Address = require('./model/Address'); var AdjustLoyaltyPointsRequest = require('./model/AdjustLoyaltyPointsRequest'); var AdjustLoyaltyPointsResponse = require('./model/AdjustLoyaltyPointsResponse'); @@ -71,6 +69,7 @@ var Card = require('./model/Card'); var CardBrand = require('./model/CardBrand'); var CardPaymentDetails = require('./model/CardPaymentDetails'); var CardPrepaidType = require('./model/CardPrepaidType'); +var CardSquareProduct = require('./model/CardSquareProduct'); var CardType = require('./model/CardType'); var CashDrawerDevice = require('./model/CashDrawerDevice'); var CashDrawerEventType = require('./model/CashDrawerEventType'); @@ -255,6 +254,8 @@ var GetPaymentRequest = require('./model/GetPaymentRequest'); var GetPaymentResponse = require('./model/GetPaymentResponse'); var GetShiftRequest = require('./model/GetShiftRequest'); var GetShiftResponse = require('./model/GetShiftResponse'); +var GetTeamMemberWageRequest = require('./model/GetTeamMemberWageRequest'); +var GetTeamMemberWageResponse = require('./model/GetTeamMemberWageResponse'); var GetTerminalCheckoutRequest = require('./model/GetTerminalCheckoutRequest'); var GetTerminalCheckoutResponse = require('./model/GetTerminalCheckoutResponse'); var InventoryAdjustment = require('./model/InventoryAdjustment'); @@ -280,10 +281,6 @@ var InvoiceStatus = require('./model/InvoiceStatus'); var ItemVariationLocationOverrides = require('./model/ItemVariationLocationOverrides'); var JobAssignment = require('./model/JobAssignment'); var JobAssignmentPayType = require('./model/JobAssignmentPayType'); -var ListAdditionalRecipientReceivableRefundsRequest = require('./model/ListAdditionalRecipientReceivableRefundsRequest'); -var ListAdditionalRecipientReceivableRefundsResponse = require('./model/ListAdditionalRecipientReceivableRefundsResponse'); -var ListAdditionalRecipientReceivablesRequest = require('./model/ListAdditionalRecipientReceivablesRequest'); -var ListAdditionalRecipientReceivablesResponse = require('./model/ListAdditionalRecipientReceivablesResponse'); var ListBankAccountsRequest = require('./model/ListBankAccountsRequest'); var ListBankAccountsResponse = require('./model/ListBankAccountsResponse'); var ListBreakTypesRequest = require('./model/ListBreakTypesRequest'); @@ -326,6 +323,8 @@ var ListRefundsRequest = require('./model/ListRefundsRequest'); var ListRefundsResponse = require('./model/ListRefundsResponse'); var ListSubscriptionEventsRequest = require('./model/ListSubscriptionEventsRequest'); var ListSubscriptionEventsResponse = require('./model/ListSubscriptionEventsResponse'); +var ListTeamMemberWagesRequest = require('./model/ListTeamMemberWagesRequest'); +var ListTeamMemberWagesResponse = require('./model/ListTeamMemberWagesResponse'); var ListTransactionsRequest = require('./model/ListTransactionsRequest'); var ListTransactionsResponse = require('./model/ListTransactionsResponse'); var ListWorkweekConfigsRequest = require('./model/ListWorkweekConfigsRequest'); @@ -377,7 +376,6 @@ var MeasurementUnitVolume = require('./model/MeasurementUnitVolume'); var MeasurementUnitWeight = require('./model/MeasurementUnitWeight'); var Merchant = require('./model/Merchant'); var MerchantStatus = require('./model/MerchantStatus'); -var MethodErrorCodes = require('./model/MethodErrorCodes'); var ModelBreak = require('./model/ModelBreak'); var Money = require('./model/Money'); var ObtainTokenRequest = require('./model/ObtainTokenRequest'); @@ -560,7 +558,10 @@ var TeamMember = require('./model/TeamMember'); var TeamMemberAssignedLocations = require('./model/TeamMemberAssignedLocations'); var TeamMemberAssignedLocationsAssignmentType = require('./model/TeamMemberAssignedLocationsAssignmentType'); var TeamMemberStatus = require('./model/TeamMemberStatus'); +var TeamMemberWage = require('./model/TeamMemberWage'); var Tender = require('./model/Tender'); +var TenderBankTransferDetails = require('./model/TenderBankTransferDetails'); +var TenderBankTransferDetailsStatus = require('./model/TenderBankTransferDetailsStatus'); var TenderCardDetails = require('./model/TenderCardDetails'); var TenderCardDetailsEntryMethod = require('./model/TenderCardDetailsEntryMethod'); var TenderCardDetailsStatus = require('./model/TenderCardDetailsStatus'); @@ -791,7 +792,6 @@ var OAuthApi = require('./api/OAuthApi'); var OrdersApi = require('./api/OrdersApi'); var PaymentsApi = require('./api/PaymentsApi'); var RefundsApi = require('./api/RefundsApi'); -var ReportingApi = require('./api/ReportingApi'); var SubscriptionsApi = require('./api/SubscriptionsApi'); var TeamApi = require('./api/TeamApi'); var TerminalApi = require('./api/TerminalApi'); @@ -831,7 +831,7 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * *
* @module index - * @version 4.20200812.2 + * @version 4.20200826.3 */ module.exports = { /** @@ -879,16 +879,6 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/AdditionalRecipient} */ AdditionalRecipient: AdditionalRecipient, - /** - * The AdditionalRecipientReceivable model constructor. - * @property {module:model/AdditionalRecipientReceivable} - */ - AdditionalRecipientReceivable: AdditionalRecipientReceivable, - /** - * The AdditionalRecipientReceivableRefund model constructor. - * @property {module:model/AdditionalRecipientReceivableRefund} - */ - AdditionalRecipientReceivableRefund: AdditionalRecipientReceivableRefund, /** * The Address model constructor. * @property {module:model/Address} @@ -1129,6 +1119,11 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/CardPrepaidType} */ CardPrepaidType: CardPrepaidType, + /** + * The CardSquareProduct model constructor. + * @property {module:model/CardSquareProduct} + */ + CardSquareProduct: CardSquareProduct, /** * The CardType model constructor. * @property {module:model/CardType} @@ -2049,6 +2044,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/GetShiftResponse} */ GetShiftResponse: GetShiftResponse, + /** + * The GetTeamMemberWageRequest model constructor. + * @property {module:model/GetTeamMemberWageRequest} + */ + GetTeamMemberWageRequest: GetTeamMemberWageRequest, + /** + * The GetTeamMemberWageResponse model constructor. + * @property {module:model/GetTeamMemberWageResponse} + */ + GetTeamMemberWageResponse: GetTeamMemberWageResponse, /** * The GetTerminalCheckoutRequest model constructor. * @property {module:model/GetTerminalCheckoutRequest} @@ -2174,26 +2179,6 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/JobAssignmentPayType} */ JobAssignmentPayType: JobAssignmentPayType, - /** - * The ListAdditionalRecipientReceivableRefundsRequest model constructor. - * @property {module:model/ListAdditionalRecipientReceivableRefundsRequest} - */ - ListAdditionalRecipientReceivableRefundsRequest: ListAdditionalRecipientReceivableRefundsRequest, - /** - * The ListAdditionalRecipientReceivableRefundsResponse model constructor. - * @property {module:model/ListAdditionalRecipientReceivableRefundsResponse} - */ - ListAdditionalRecipientReceivableRefundsResponse: ListAdditionalRecipientReceivableRefundsResponse, - /** - * The ListAdditionalRecipientReceivablesRequest model constructor. - * @property {module:model/ListAdditionalRecipientReceivablesRequest} - */ - ListAdditionalRecipientReceivablesRequest: ListAdditionalRecipientReceivablesRequest, - /** - * The ListAdditionalRecipientReceivablesResponse model constructor. - * @property {module:model/ListAdditionalRecipientReceivablesResponse} - */ - ListAdditionalRecipientReceivablesResponse: ListAdditionalRecipientReceivablesResponse, /** * The ListBankAccountsRequest model constructor. * @property {module:model/ListBankAccountsRequest} @@ -2404,6 +2389,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/ListSubscriptionEventsResponse} */ ListSubscriptionEventsResponse: ListSubscriptionEventsResponse, + /** + * The ListTeamMemberWagesRequest model constructor. + * @property {module:model/ListTeamMemberWagesRequest} + */ + ListTeamMemberWagesRequest: ListTeamMemberWagesRequest, + /** + * The ListTeamMemberWagesResponse model constructor. + * @property {module:model/ListTeamMemberWagesResponse} + */ + ListTeamMemberWagesResponse: ListTeamMemberWagesResponse, /** * The ListTransactionsRequest model constructor. * @property {module:model/ListTransactionsRequest} @@ -2659,11 +2654,6 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/MerchantStatus} */ MerchantStatus: MerchantStatus, - /** - * The MethodErrorCodes model constructor. - * @property {module:model/MethodErrorCodes} - */ - MethodErrorCodes: MethodErrorCodes, /** * The ModelBreak model constructor. * @property {module:model/ModelBreak} @@ -3574,11 +3564,26 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/TeamMemberStatus} */ TeamMemberStatus: TeamMemberStatus, + /** + * The TeamMemberWage model constructor. + * @property {module:model/TeamMemberWage} + */ + TeamMemberWage: TeamMemberWage, /** * The Tender model constructor. * @property {module:model/Tender} */ Tender: Tender, + /** + * The TenderBankTransferDetails model constructor. + * @property {module:model/TenderBankTransferDetails} + */ + TenderBankTransferDetails: TenderBankTransferDetails, + /** + * The TenderBankTransferDetailsStatus model constructor. + * @property {module:model/TenderBankTransferDetailsStatus} + */ + TenderBankTransferDetailsStatus: TenderBankTransferDetailsStatus, /** * The TenderCardDetails model constructor. * @property {module:model/TenderCardDetails} @@ -4724,11 +4729,6 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:api/RefundsApi} */ RefundsApi: RefundsApi, - /** - * The ReportingApi service constructor. - * @property {module:api/ReportingApi} - */ - ReportingApi: ReportingApi, /** * The SubscriptionsApi service constructor. * @property {module:api/SubscriptionsApi} diff --git a/src/model/AdditionalRecipientReceivable.js b/src/model/AdditionalRecipientReceivable.js deleted file mode 100644 index 0cbfd57..0000000 --- a/src/model/AdditionalRecipientReceivable.js +++ /dev/null @@ -1,117 +0,0 @@ -/** - * Square Connect API - * Client library for accessing the Square Connect APIs - * - * OpenAPI spec version: 2.0 - * Contact: developers@squareup.com - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * - * Swagger Codegen version: 2.3.0-SNAPSHOT - * - */ -var ApiClient = require('../ApiClient'); -var AdditionalRecipientReceivableRefund = require('./AdditionalRecipientReceivableRefund'); -var Money = require('./Money'); - - - - -/** - * @deprecated - * The AdditionalRecipientReceivable model module. - * @module model/AdditionalRecipientReceivable - */ - -/** - * Constructs a newAdditionalRecipientReceivable
.
- * Represents a monetary distribution of part of a [Transaction](#type-transaction)'s amount for Transactions which included additional recipients. The location of this receivable is that same as the one specified in the [AdditionalRecipient](#type-additionalrecipient).
- * @alias module:model/AdditionalRecipientReceivable
- * @class
- * @param id {String} The additional recipient receivable's unique ID, issued by Square payments servers.
- * @param transactionId {String} The ID of the transaction that the additional recipient receivable was applied to.
- * @param transactionLocationId {String} The ID of the location that created the receivable. This is the location ID on the associated transaction.
- * @param amountMoney {module:model/Money} The amount of the receivable. This will always be non-negative.
- */
-var exports = function(id, transactionId, transactionLocationId, amountMoney) {
- var _this = this;
-
- _this['id'] = id;
- _this['transaction_id'] = transactionId;
- _this['transaction_location_id'] = transactionLocationId;
- _this['amount_money'] = amountMoney;
-
-
-};
-
-/**
- * Constructs a AdditionalRecipientReceivable
from a plain JavaScript object, optionally creating a new instance.
- * Copies all relevant properties from data
to obj
if supplied or a new instance if not.
- * @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/AdditionalRecipientReceivable} obj Optional instance to populate.
- * @return {module:model/AdditionalRecipientReceivable} The populated AdditionalRecipientReceivable
instance.
- */
-exports.constructFromObject = function(data, obj) {
- if (data) {
- obj = obj || new exports();
-
- if (data.hasOwnProperty('id')) {
- obj['id'] = ApiClient.convertToType(data['id'], 'String');
- }
- if (data.hasOwnProperty('transaction_id')) {
- obj['transaction_id'] = ApiClient.convertToType(data['transaction_id'], 'String');
- }
- if (data.hasOwnProperty('transaction_location_id')) {
- obj['transaction_location_id'] = ApiClient.convertToType(data['transaction_location_id'], 'String');
- }
- if (data.hasOwnProperty('amount_money')) {
- obj['amount_money'] = Money.constructFromObject(data['amount_money']);
- }
- if (data.hasOwnProperty('created_at')) {
- obj['created_at'] = ApiClient.convertToType(data['created_at'], 'String');
- }
- if (data.hasOwnProperty('refunds')) {
- obj['refunds'] = ApiClient.convertToType(data['refunds'], [AdditionalRecipientReceivableRefund]);
- }
- }
- return obj;
-}
-
-/**
- * The additional recipient receivable's unique ID, issued by Square payments servers.
- * @member {String} id
- */
-exports.prototype['id'] = undefined;
-/**
- * The ID of the transaction that the additional recipient receivable was applied to.
- * @member {String} transaction_id
- */
-exports.prototype['transaction_id'] = undefined;
-/**
- * The ID of the location that created the receivable. This is the location ID on the associated transaction.
- * @member {String} transaction_location_id
- */
-exports.prototype['transaction_location_id'] = undefined;
-/**
- * The amount of the receivable. This will always be non-negative.
- * @member {module:model/Money} amount_money
- */
-exports.prototype['amount_money'] = undefined;
-/**
- * The time when the additional recipient receivable was created, in RFC 3339 format.
- * @member {String} created_at
- */
-exports.prototype['created_at'] = undefined;
-/**
- * Any refunds of the receivable that have been applied.
- * @member {Array.AdditionalRecipientReceivableRefund
.
- * A refund of an [AdditionalRecipientReceivable](#type-additionalrecipientreceivable). This includes the ID of the additional recipient receivable associated to this object, as well as a reference to the [Refund](#type-refund) that created this receivable refund.
- * @alias module:model/AdditionalRecipientReceivableRefund
- * @class
- * @param id {String} The receivable refund's unique ID, issued by Square payments servers.
- * @param receivableId {String} The ID of the receivable that the refund was applied to.
- * @param refundId {String} The ID of the refund that is associated to this receivable refund.
- * @param transactionLocationId {String} The ID of the location that created the receivable. This is the location ID on the associated transaction.
- * @param amountMoney {module:model/Money} The amount of the refund. This will always be non-negative.
- */
-var exports = function(id, receivableId, refundId, transactionLocationId, amountMoney) {
- var _this = this;
-
- _this['id'] = id;
- _this['receivable_id'] = receivableId;
- _this['refund_id'] = refundId;
- _this['transaction_location_id'] = transactionLocationId;
- _this['amount_money'] = amountMoney;
-
-};
-
-/**
- * Constructs a AdditionalRecipientReceivableRefund
from a plain JavaScript object, optionally creating a new instance.
- * Copies all relevant properties from data
to obj
if supplied or a new instance if not.
- * @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/AdditionalRecipientReceivableRefund} obj Optional instance to populate.
- * @return {module:model/AdditionalRecipientReceivableRefund} The populated AdditionalRecipientReceivableRefund
instance.
- */
-exports.constructFromObject = function(data, obj) {
- if (data) {
- obj = obj || new exports();
-
- if (data.hasOwnProperty('id')) {
- obj['id'] = ApiClient.convertToType(data['id'], 'String');
- }
- if (data.hasOwnProperty('receivable_id')) {
- obj['receivable_id'] = ApiClient.convertToType(data['receivable_id'], 'String');
- }
- if (data.hasOwnProperty('refund_id')) {
- obj['refund_id'] = ApiClient.convertToType(data['refund_id'], 'String');
- }
- if (data.hasOwnProperty('transaction_location_id')) {
- obj['transaction_location_id'] = ApiClient.convertToType(data['transaction_location_id'], 'String');
- }
- if (data.hasOwnProperty('amount_money')) {
- obj['amount_money'] = Money.constructFromObject(data['amount_money']);
- }
- if (data.hasOwnProperty('created_at')) {
- obj['created_at'] = ApiClient.convertToType(data['created_at'], 'String');
- }
- }
- return obj;
-}
-
-/**
- * The receivable refund's unique ID, issued by Square payments servers.
- * @member {String} id
- */
-exports.prototype['id'] = undefined;
-/**
- * The ID of the receivable that the refund was applied to.
- * @member {String} receivable_id
- */
-exports.prototype['receivable_id'] = undefined;
-/**
- * The ID of the refund that is associated to this receivable refund.
- * @member {String} refund_id
- */
-exports.prototype['refund_id'] = undefined;
-/**
- * The ID of the location that created the receivable. This is the location ID on the associated transaction.
- * @member {String} transaction_location_id
- */
-exports.prototype['transaction_location_id'] = undefined;
-/**
- * The amount of the refund. This will always be non-negative.
- * @member {module:model/Money} amount_money
- */
-exports.prototype['amount_money'] = undefined;
-/**
- * The time when the refund was created, in RFC 3339 format.
- * @member {String} created_at
- */
-exports.prototype['created_at'] = undefined;
-
-
-
-module.exports = exports;
-
-
-
diff --git a/src/model/BatchChangeInventoryRequest.js b/src/model/BatchChangeInventoryRequest.js
index d1bf2b0..ff50deb 100644
--- a/src/model/BatchChangeInventoryRequest.js
+++ b/src/model/BatchChangeInventoryRequest.js
@@ -66,7 +66,7 @@ exports.constructFromObject = function(data, obj) {
*/
exports.prototype['idempotency_key'] = undefined;
/**
- * The set of physical counts and inventory adjustments to be made. Changes are applied based on the client-supplied timestamp and may be sent out of order. Max size is 100 changes.
+ * The set of physical counts and inventory adjustments to be made. Changes are applied based on the client-supplied timestamp and may be sent out of order.
* @member {Array.CardSquareProduct
enum value from a Javascript object name.
+ * @param {Object} data The plain JavaScript object containing the name of the enum value.
+ * @return {module:model/CardSquareProduct} The enum CardSquareProduct
value.
+ */
+exports.constructFromObject = function(object) {
+ return object;
+}
+
+module.exports = exports;
+
+
diff --git a/src/model/CreateOrderRequest.js b/src/model/CreateOrderRequest.js
index 1ec284f..483c32f 100644
--- a/src/model/CreateOrderRequest.js
+++ b/src/model/CreateOrderRequest.js
@@ -33,6 +33,7 @@ var exports = function() {
+
};
/**
@@ -48,6 +49,9 @@ exports.constructFromObject = function(data, obj) {
if (data.hasOwnProperty('order')) {
obj['order'] = Order.constructFromObject(data['order']);
+ }
+ if (data.hasOwnProperty('location_id')) {
+ obj['location_id'] = ApiClient.convertToType(data['location_id'], 'String');
}
if (data.hasOwnProperty('idempotency_key')) {
obj['idempotency_key'] = ApiClient.convertToType(data['idempotency_key'], 'String');
@@ -61,6 +65,11 @@ exports.constructFromObject = function(data, obj) {
* @member {module:model/Order} order
*/
exports.prototype['order'] = undefined;
+/**
+ * The ID of the business location to associate the order with.
+ * @member {String} location_id
+ */
+exports.prototype['location_id'] = undefined;
/**
* A value you specify that uniquely identifies this order among orders you've created. If you're unsure whether a particular order was created successfully, you can reattempt it with the same idempotency key without worrying about creating duplicate orders. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.
* @member {String} idempotency_key
diff --git a/src/model/DateRange.js b/src/model/DateRange.js
index b5127ae..cc30928 100644
--- a/src/model/DateRange.js
+++ b/src/model/DateRange.js
@@ -23,7 +23,7 @@ var ApiClient = require('../ApiClient');
/**
* Constructs a new DateRange
.
- * A range defined by two dates. Used for filtering a query for Connect v2 objects that have date properties.
+ * A range defined by two dates. Used for filtering a query for Connect v2 objects that have date properties.
* @alias module:model/DateRange
* @class
*/
diff --git a/src/model/Employee.js b/src/model/Employee.js
index 21ae188..1f9c0fd 100644
--- a/src/model/Employee.js
+++ b/src/model/Employee.js
@@ -17,6 +17,7 @@ var ApiClient = require('../ApiClient');
/**
+ * @deprecated
* The Employee model module.
* @module model/Employee
*/
diff --git a/src/model/EmployeeWage.js b/src/model/EmployeeWage.js
index c8d0f88..09d183d 100644
--- a/src/model/EmployeeWage.js
+++ b/src/model/EmployeeWage.js
@@ -18,22 +18,22 @@ var Money = require('./Money');
/**
+ * @deprecated
* The EmployeeWage model module.
* @module model/EmployeeWage
*/
/**
* Constructs a new EmployeeWage
.
- * The hourly wage rate that an employee will earn on a `Shift` for doing the job specified by the `title` property of this object.
+ * The hourly wage rate that an employee will earn on a `Shift` for doing the job specified by the `title` property of this object. Deprecated at verison 2020-08-26. Use `TeamMemberWage` instead.
* @alias module:model/EmployeeWage
* @class
- * @param employeeId {String} The `Employee` that this wage is assigned to.
*/
-var exports = function(employeeId) {
+var exports = function() {
var _this = this;
- _this['employee_id'] = employeeId;
+
};
diff --git a/src/model/ErrorCode.js b/src/model/ErrorCode.js
index 61236da..111a84a 100644
--- a/src/model/ErrorCode.js
+++ b/src/model/ErrorCode.js
@@ -460,6 +460,11 @@ var exports = {
* @const
*/
"PAYMENT_NOT_REFUNDABLE": "PAYMENT_NOT_REFUNDABLE",
+ /**
+ * value: "REFUND_DECLINED"
+ * @const
+ */
+ "REFUND_DECLINED": "REFUND_DECLINED",
/**
* value: "INVALID_CARD_DATA"
* @const
diff --git a/src/model/GetEmployeeWageRequest.js b/src/model/GetEmployeeWageRequest.js
index 3aa4023..9a0a260 100644
--- a/src/model/GetEmployeeWageRequest.js
+++ b/src/model/GetEmployeeWageRequest.js
@@ -17,6 +17,7 @@ var ApiClient = require('../ApiClient');
/**
+ * @deprecated
* The GetEmployeeWageRequest model module.
* @module model/GetEmployeeWageRequest
*/
diff --git a/src/model/GetEmployeeWageResponse.js b/src/model/GetEmployeeWageResponse.js
index c610295..499721d 100644
--- a/src/model/GetEmployeeWageResponse.js
+++ b/src/model/GetEmployeeWageResponse.js
@@ -19,6 +19,7 @@ var Error = require('./Error');
/**
+ * @deprecated
* The GetEmployeeWageResponse model module.
* @module model/GetEmployeeWageResponse
*/
diff --git a/src/model/MethodErrorCodes.js b/src/model/GetTeamMemberWageRequest.js
similarity index 53%
rename from src/model/MethodErrorCodes.js
rename to src/model/GetTeamMemberWageRequest.js
index e00c320..14e3a82 100644
--- a/src/model/MethodErrorCodes.js
+++ b/src/model/GetTeamMemberWageRequest.js
@@ -17,45 +17,36 @@ var ApiClient = require('../ApiClient');
/**
- * The MethodErrorCodes model module.
- * @module model/MethodErrorCodes
+ * The GetTeamMemberWageRequest model module.
+ * @module model/GetTeamMemberWageRequest
*/
/**
- * Constructs a new MethodErrorCodes
.
- *
- * @alias module:model/MethodErrorCodes
+ * Constructs a new GetTeamMemberWageRequest
.
+ * A request to get an `TeamMemberWage`
+ * @alias module:model/GetTeamMemberWageRequest
* @class
*/
var exports = function() {
var _this = this;
-
};
/**
- * Constructs a MethodErrorCodes
from a plain JavaScript object, optionally creating a new instance.
+ * Constructs a GetTeamMemberWageRequest
from a plain JavaScript object, optionally creating a new instance.
* Copies all relevant properties from data
to obj
if supplied or a new instance if not.
* @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/MethodErrorCodes} obj Optional instance to populate.
- * @return {module:model/MethodErrorCodes} The populated MethodErrorCodes
instance.
+ * @param {module:model/GetTeamMemberWageRequest} obj Optional instance to populate.
+ * @return {module:model/GetTeamMemberWageRequest} The populated GetTeamMemberWageRequest
instance.
*/
exports.constructFromObject = function(data, obj) {
if (data) {
obj = obj || new exports();
- if (data.hasOwnProperty('value')) {
- obj['value'] = ApiClient.convertToType(data['value'], ['String']);
- }
}
return obj;
}
-/**
- * See [ErrorCode](#type-errorcode) for possible values
- * @member {Array.GetTeamMemberWageResponse
.
+ * A response to a request to get a `TeamMemberWage`. Contains the requested `TeamMemberWage` objects. May contain a set of `Error` objects if the request resulted in errors.
+ * @alias module:model/GetTeamMemberWageResponse
+ * @class
+ */
+var exports = function() {
+ var _this = this;
+
+
+
+};
+
+/**
+ * Constructs a GetTeamMemberWageResponse
from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data
to obj
if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/GetTeamMemberWageResponse} obj Optional instance to populate.
+ * @return {module:model/GetTeamMemberWageResponse} The populated GetTeamMemberWageResponse
instance.
+ */
+exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('team_member_wage')) {
+ obj['team_member_wage'] = TeamMemberWage.constructFromObject(data['team_member_wage']);
+ }
+ if (data.hasOwnProperty('errors')) {
+ obj['errors'] = ApiClient.convertToType(data['errors'], [Error]);
+ }
+ }
+ return obj;
+}
+
+/**
+ * The requested `TeamMemberWage` object.
+ * @member {module:model/TeamMemberWage} team_member_wage
+ */
+exports.prototype['team_member_wage'] = undefined;
+/**
+ * Any errors that occurred during the request.
+ * @member {Array.ListAdditionalRecipientReceivableRefundsRequest
.
- * Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint.
- * @alias module:model/ListAdditionalRecipientReceivableRefundsRequest
- * @class
- */
-var exports = function() {
- var _this = this;
-
-
-
-
-
-};
-
-/**
- * Constructs a ListAdditionalRecipientReceivableRefundsRequest
from a plain JavaScript object, optionally creating a new instance.
- * Copies all relevant properties from data
to obj
if supplied or a new instance if not.
- * @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/ListAdditionalRecipientReceivableRefundsRequest} obj Optional instance to populate.
- * @return {module:model/ListAdditionalRecipientReceivableRefundsRequest} The populated ListAdditionalRecipientReceivableRefundsRequest
instance.
- */
-exports.constructFromObject = function(data, obj) {
- if (data) {
- obj = obj || new exports();
-
- if (data.hasOwnProperty('begin_time')) {
- obj['begin_time'] = ApiClient.convertToType(data['begin_time'], 'String');
- }
- if (data.hasOwnProperty('end_time')) {
- obj['end_time'] = ApiClient.convertToType(data['end_time'], 'String');
- }
- if (data.hasOwnProperty('sort_order')) {
- obj['sort_order'] = ApiClient.convertToType(data['sort_order'], 'String');
- }
- if (data.hasOwnProperty('cursor')) {
- obj['cursor'] = ApiClient.convertToType(data['cursor'], 'String');
- }
- }
- return obj;
-}
-
-/**
- * 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.
- * @member {String} begin_time
- */
-exports.prototype['begin_time'] = undefined;
-/**
- * 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.
- * @member {String} end_time
- */
-exports.prototype['end_time'] = undefined;
-/**
- * The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` See [SortOrder](#type-sortorder) for possible values
- * @member {String} sort_order
- */
-exports.prototype['sort_order'] = undefined;
-/**
- * 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.
- * @member {String} cursor
- */
-exports.prototype['cursor'] = undefined;
-
-
-
-module.exports = exports;
-
-
-
diff --git a/src/model/ListAdditionalRecipientReceivableRefundsResponse.js b/src/model/ListAdditionalRecipientReceivableRefundsResponse.js
deleted file mode 100644
index c232d8e..0000000
--- a/src/model/ListAdditionalRecipientReceivableRefundsResponse.js
+++ /dev/null
@@ -1,86 +0,0 @@
-/**
- * Square Connect API
- * Client library for accessing the Square Connect APIs
- *
- * OpenAPI spec version: 2.0
- * Contact: developers@squareup.com
- *
- * NOTE: This class is auto generated by the swagger code generator program.
- * https://github.com/swagger-api/swagger-codegen.git
- *
- * Swagger Codegen version: 2.3.0-SNAPSHOT
- *
- */
-var ApiClient = require('../ApiClient');
-var AdditionalRecipientReceivableRefund = require('./AdditionalRecipientReceivableRefund');
-var Error = require('./Error');
-
-
-
-
-/**
- * @deprecated
- * The ListAdditionalRecipientReceivableRefundsResponse model module.
- * @module model/ListAdditionalRecipientReceivableRefundsResponse
- */
-
-/**
- * Constructs a new ListAdditionalRecipientReceivableRefundsResponse
.
- * Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivableRefunds](#endpoint-listadditionalrecipientreceivablerefunds) endpoint. One of `errors` or `additional_recipient_receivable_refunds` is present in a given response (never both).
- * @alias module:model/ListAdditionalRecipientReceivableRefundsResponse
- * @class
- */
-var exports = function() {
- var _this = this;
-
-
-
-
-};
-
-/**
- * Constructs a ListAdditionalRecipientReceivableRefundsResponse
from a plain JavaScript object, optionally creating a new instance.
- * Copies all relevant properties from data
to obj
if supplied or a new instance if not.
- * @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/ListAdditionalRecipientReceivableRefundsResponse} obj Optional instance to populate.
- * @return {module:model/ListAdditionalRecipientReceivableRefundsResponse} The populated ListAdditionalRecipientReceivableRefundsResponse
instance.
- */
-exports.constructFromObject = function(data, obj) {
- if (data) {
- obj = obj || new exports();
-
- if (data.hasOwnProperty('errors')) {
- obj['errors'] = ApiClient.convertToType(data['errors'], [Error]);
- }
- if (data.hasOwnProperty('receivable_refunds')) {
- obj['receivable_refunds'] = ApiClient.convertToType(data['receivable_refunds'], [AdditionalRecipientReceivableRefund]);
- }
- if (data.hasOwnProperty('cursor')) {
- obj['cursor'] = ApiClient.convertToType(data['cursor'], 'String');
- }
- }
- return obj;
-}
-
-/**
- * Any errors that occurred during the request.
- * @member {Array.ListAdditionalRecipientReceivablesRequest
.
- * Defines the query parameters that can be included in a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint.
- * @alias module:model/ListAdditionalRecipientReceivablesRequest
- * @class
- */
-var exports = function() {
- var _this = this;
-
-
-
-
-
-};
-
-/**
- * Constructs a ListAdditionalRecipientReceivablesRequest
from a plain JavaScript object, optionally creating a new instance.
- * Copies all relevant properties from data
to obj
if supplied or a new instance if not.
- * @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/ListAdditionalRecipientReceivablesRequest} obj Optional instance to populate.
- * @return {module:model/ListAdditionalRecipientReceivablesRequest} The populated ListAdditionalRecipientReceivablesRequest
instance.
- */
-exports.constructFromObject = function(data, obj) {
- if (data) {
- obj = obj || new exports();
-
- if (data.hasOwnProperty('begin_time')) {
- obj['begin_time'] = ApiClient.convertToType(data['begin_time'], 'String');
- }
- if (data.hasOwnProperty('end_time')) {
- obj['end_time'] = ApiClient.convertToType(data['end_time'], 'String');
- }
- if (data.hasOwnProperty('sort_order')) {
- obj['sort_order'] = ApiClient.convertToType(data['sort_order'], 'String');
- }
- if (data.hasOwnProperty('cursor')) {
- obj['cursor'] = ApiClient.convertToType(data['cursor'], 'String');
- }
- }
- return obj;
-}
-
-/**
- * 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.
- * @member {String} begin_time
- */
-exports.prototype['begin_time'] = undefined;
-/**
- * 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.
- * @member {String} end_time
- */
-exports.prototype['end_time'] = undefined;
-/**
- * The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` See [SortOrder](#type-sortorder) for possible values
- * @member {String} sort_order
- */
-exports.prototype['sort_order'] = undefined;
-/**
- * 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.
- * @member {String} cursor
- */
-exports.prototype['cursor'] = undefined;
-
-
-
-module.exports = exports;
-
-
-
diff --git a/src/model/ListAdditionalRecipientReceivablesResponse.js b/src/model/ListAdditionalRecipientReceivablesResponse.js
deleted file mode 100644
index 038f3e8..0000000
--- a/src/model/ListAdditionalRecipientReceivablesResponse.js
+++ /dev/null
@@ -1,86 +0,0 @@
-/**
- * Square Connect API
- * Client library for accessing the Square Connect APIs
- *
- * OpenAPI spec version: 2.0
- * Contact: developers@squareup.com
- *
- * NOTE: This class is auto generated by the swagger code generator program.
- * https://github.com/swagger-api/swagger-codegen.git
- *
- * Swagger Codegen version: 2.3.0-SNAPSHOT
- *
- */
-var ApiClient = require('../ApiClient');
-var AdditionalRecipientReceivable = require('./AdditionalRecipientReceivable');
-var Error = require('./Error');
-
-
-
-
-/**
- * @deprecated
- * The ListAdditionalRecipientReceivablesResponse model module.
- * @module model/ListAdditionalRecipientReceivablesResponse
- */
-
-/**
- * Constructs a new ListAdditionalRecipientReceivablesResponse
.
- * Defines the fields that are included in the response body of a request to the [ListAdditionalRecipientReceivables](#endpoint-listadditionalrecipientreceivables) endpoint. One of `errors` or `additional_recipient_receivables` is present in a given response (never both).
- * @alias module:model/ListAdditionalRecipientReceivablesResponse
- * @class
- */
-var exports = function() {
- var _this = this;
-
-
-
-
-};
-
-/**
- * Constructs a ListAdditionalRecipientReceivablesResponse
from a plain JavaScript object, optionally creating a new instance.
- * Copies all relevant properties from data
to obj
if supplied or a new instance if not.
- * @param {Object} data The plain JavaScript object bearing properties of interest.
- * @param {module:model/ListAdditionalRecipientReceivablesResponse} obj Optional instance to populate.
- * @return {module:model/ListAdditionalRecipientReceivablesResponse} The populated ListAdditionalRecipientReceivablesResponse
instance.
- */
-exports.constructFromObject = function(data, obj) {
- if (data) {
- obj = obj || new exports();
-
- if (data.hasOwnProperty('errors')) {
- obj['errors'] = ApiClient.convertToType(data['errors'], [Error]);
- }
- if (data.hasOwnProperty('receivables')) {
- obj['receivables'] = ApiClient.convertToType(data['receivables'], [AdditionalRecipientReceivable]);
- }
- if (data.hasOwnProperty('cursor')) {
- obj['cursor'] = ApiClient.convertToType(data['cursor'], 'String');
- }
- }
- return obj;
-}
-
-/**
- * Any errors that occurred during the request.
- * @member {Array.ListTeamMemberWagesRequest
.
+ * A request for a set of `TeamMemberWage` objects
+ * @alias module:model/ListTeamMemberWagesRequest
+ * @class
+ */
+var exports = function() {
+ var _this = this;
+
+
+
+
+};
+
+/**
+ * Constructs a ListTeamMemberWagesRequest
from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data
to obj
if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/ListTeamMemberWagesRequest} obj Optional instance to populate.
+ * @return {module:model/ListTeamMemberWagesRequest} The populated ListTeamMemberWagesRequest
instance.
+ */
+exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('team_member_id')) {
+ obj['team_member_id'] = ApiClient.convertToType(data['team_member_id'], 'String');
+ }
+ if (data.hasOwnProperty('limit')) {
+ obj['limit'] = ApiClient.convertToType(data['limit'], 'Number');
+ }
+ if (data.hasOwnProperty('cursor')) {
+ obj['cursor'] = ApiClient.convertToType(data['cursor'], 'String');
+ }
+ }
+ return obj;
+}
+
+/**
+ * Filter wages returned to only those that are associated with the specified team member.
+ * @member {String} team_member_id
+ */
+exports.prototype['team_member_id'] = undefined;
+/**
+ * Maximum number of Team Member Wages to return per page. Can range between 1 and 200. The default is the maximum at 200.
+ * @member {Number} limit
+ */
+exports.prototype['limit'] = undefined;
+/**
+ * Pointer to the next page of Employee Wage results to fetch.
+ * @member {String} cursor
+ */
+exports.prototype['cursor'] = undefined;
+
+
+
+module.exports = exports;
+
+
+
diff --git a/src/model/ListTeamMemberWagesResponse.js b/src/model/ListTeamMemberWagesResponse.js
new file mode 100644
index 0000000..786bc83
--- /dev/null
+++ b/src/model/ListTeamMemberWagesResponse.js
@@ -0,0 +1,85 @@
+/**
+ * Square Connect API
+ * Client library for accessing the Square Connect APIs
+ *
+ * OpenAPI spec version: 2.0
+ * Contact: developers@squareup.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.3.0-SNAPSHOT
+ *
+ */
+var ApiClient = require('../ApiClient');
+var Error = require('./Error');
+var TeamMemberWage = require('./TeamMemberWage');
+
+
+
+
+/**
+ * The ListTeamMemberWagesResponse model module.
+ * @module model/ListTeamMemberWagesResponse
+ */
+
+/**
+ * Constructs a new ListTeamMemberWagesResponse
.
+ * The response to a request for a set of `TeamMemberWage` objects. Contains a set of `TeamMemberWage`.
+ * @alias module:model/ListTeamMemberWagesResponse
+ * @class
+ */
+var exports = function() {
+ var _this = this;
+
+
+
+
+};
+
+/**
+ * Constructs a ListTeamMemberWagesResponse
from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data
to obj
if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/ListTeamMemberWagesResponse} obj Optional instance to populate.
+ * @return {module:model/ListTeamMemberWagesResponse} The populated ListTeamMemberWagesResponse
instance.
+ */
+exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('team_member_wages')) {
+ obj['team_member_wages'] = ApiClient.convertToType(data['team_member_wages'], [TeamMemberWage]);
+ }
+ if (data.hasOwnProperty('cursor')) {
+ obj['cursor'] = ApiClient.convertToType(data['cursor'], 'String');
+ }
+ if (data.hasOwnProperty('errors')) {
+ obj['errors'] = ApiClient.convertToType(data['errors'], [Error]);
+ }
+ }
+ return obj;
+}
+
+/**
+ * A page of Team Member Wage results.
+ * @member {Array.ShiftWorkday
.
- * A `Shift` search query filter parameter that sets a range of days that a `Shift` must start or end in before passing the filter condition.
+ * A `Shift` search query filter parameter that sets a range of days that a `Shift` must start or end in before passing the filter condition.
* @alias module:model/ShiftWorkday
* @class
*/
diff --git a/src/model/SubscriptionPhase.js b/src/model/SubscriptionPhase.js
index 9378307..338f7bf 100644
--- a/src/model/SubscriptionPhase.js
+++ b/src/model/SubscriptionPhase.js
@@ -28,7 +28,7 @@ var Money = require('./Money');
* Describes a phase in a subscription plan. For more information, see [Set Up and Manage a Subscription Plan](/docs/subscriptions-api/setup-plan).
* @alias module:model/SubscriptionPhase
* @class
- * @param cadence {String} The billing cadence of the phase. For example, weekly or monthly. See [SubscriptionCadence](#type-subscriptioncadence) for possible values
+ * @param cadence {String} The billing cadence of the phase. For example, weekly or monthly. This field cannot be changed after a `SubscriptionPhase` is created. See [SubscriptionCadence](#type-subscriptioncadence) for possible values
* @param recurringPriceMoney {module:model/Money} The amount to bill for each `cadence`.
*/
var exports = function(cadence, recurringPriceMoney) {
@@ -72,17 +72,17 @@ exports.constructFromObject = function(data, obj) {
}
/**
- * The Square-assigned ID of the subscription phase.
+ * The Square-assigned ID of the subscription phase. This field cannot be changed after a `SubscriptionPhase` is created.
* @member {String} uid
*/
exports.prototype['uid'] = undefined;
/**
- * The billing cadence of the phase. For example, weekly or monthly. See [SubscriptionCadence](#type-subscriptioncadence) for possible values
+ * The billing cadence of the phase. For example, weekly or monthly. This field cannot be changed after a `SubscriptionPhase` is created. See [SubscriptionCadence](#type-subscriptioncadence) for possible values
* @member {String} cadence
*/
exports.prototype['cadence'] = undefined;
/**
- * The number of `cadence`s the phase lasts. If not set, the phase never ends. Only the last phase can be indefinite.
+ * The number of `cadence`s the phase lasts. If not set, the phase never ends. Only the last phase can be indefinite. This field cannot be changed after a `SubscriptionPhase` is created.
* @member {Number} periods
*/
exports.prototype['periods'] = undefined;
@@ -92,7 +92,7 @@ exports.prototype['periods'] = undefined;
*/
exports.prototype['recurring_price_money'] = undefined;
/**
- * The position this phase appears in the sequence of phases defined for the plan, indexed from 0.
+ * The position this phase appears in the sequence of phases defined for the plan, indexed from 0. This field cannot be changed after a `SubscriptionPhase` is created.
* @member {Number} ordinal
*/
exports.prototype['ordinal'] = undefined;
diff --git a/src/model/TeamMemberWage.js b/src/model/TeamMemberWage.js
new file mode 100644
index 0000000..a2000fb
--- /dev/null
+++ b/src/model/TeamMemberWage.js
@@ -0,0 +1,93 @@
+/**
+ * Square Connect API
+ * Client library for accessing the Square Connect APIs
+ *
+ * OpenAPI spec version: 2.0
+ * Contact: developers@squareup.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.3.0-SNAPSHOT
+ *
+ */
+var ApiClient = require('../ApiClient');
+var Money = require('./Money');
+
+
+
+
+/**
+ * The TeamMemberWage model module.
+ * @module model/TeamMemberWage
+ */
+
+/**
+ * Constructs a new TeamMemberWage
.
+ * The hourly wage rate that a team member will earn on a `Shift` for doing the job specified by the `title` property of this object.
+ * @alias module:model/TeamMemberWage
+ * @class
+ */
+var exports = function() {
+ var _this = this;
+
+
+
+
+
+};
+
+/**
+ * Constructs a TeamMemberWage
from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data
to obj
if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/TeamMemberWage} obj Optional instance to populate.
+ * @return {module:model/TeamMemberWage} The populated TeamMemberWage
instance.
+ */
+exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('id')) {
+ obj['id'] = ApiClient.convertToType(data['id'], 'String');
+ }
+ if (data.hasOwnProperty('team_member_id')) {
+ obj['team_member_id'] = ApiClient.convertToType(data['team_member_id'], 'String');
+ }
+ if (data.hasOwnProperty('title')) {
+ obj['title'] = ApiClient.convertToType(data['title'], 'String');
+ }
+ if (data.hasOwnProperty('hourly_rate')) {
+ obj['hourly_rate'] = Money.constructFromObject(data['hourly_rate']);
+ }
+ }
+ return obj;
+}
+
+/**
+ * UUID for this object.
+ * @member {String} id
+ */
+exports.prototype['id'] = undefined;
+/**
+ * The `Team Member` that this wage is assigned to.
+ * @member {String} team_member_id
+ */
+exports.prototype['team_member_id'] = undefined;
+/**
+ * The job title that this wage relates to.
+ * @member {String} title
+ */
+exports.prototype['title'] = undefined;
+/**
+ * Can be a custom-set hourly wage or the calculated effective hourly wage based on annual wage and hours worked per week.
+ * @member {module:model/Money} hourly_rate
+ */
+exports.prototype['hourly_rate'] = undefined;
+
+
+
+module.exports = exports;
+
+
+
diff --git a/src/model/Tender.js b/src/model/Tender.js
index b4b5054..1049a18 100644
--- a/src/model/Tender.js
+++ b/src/model/Tender.js
@@ -14,6 +14,7 @@
var ApiClient = require('../ApiClient');
var AdditionalRecipient = require('./AdditionalRecipient');
var Money = require('./Money');
+var TenderBankTransferDetails = require('./TenderBankTransferDetails');
var TenderCardDetails = require('./TenderCardDetails');
var TenderCashDetails = require('./TenderCashDetails');
@@ -49,6 +50,7 @@ var exports = function(type) {
+
};
/**
@@ -97,6 +99,9 @@ exports.constructFromObject = function(data, obj) {
}
if (data.hasOwnProperty('cash_details')) {
obj['cash_details'] = TenderCashDetails.constructFromObject(data['cash_details']);
+ }
+ if (data.hasOwnProperty('bank_transfer_details')) {
+ obj['bank_transfer_details'] = TenderBankTransferDetails.constructFromObject(data['bank_transfer_details']);
}
if (data.hasOwnProperty('additional_recipients')) {
obj['additional_recipients'] = ApiClient.convertToType(data['additional_recipients'], [AdditionalRecipient]);
@@ -168,6 +173,11 @@ exports.prototype['card_details'] = undefined;
* @member {module:model/TenderCashDetails} cash_details
*/
exports.prototype['cash_details'] = undefined;
+/**
+ * The details of the bank transfer tender. This value is present only if the value of `type` is `BANK_TRANSFER`.
+ * @member {module:model/TenderBankTransferDetails} bank_transfer_details
+ */
+exports.prototype['bank_transfer_details'] = undefined;
/**
* Additional recipients (other than the merchant) receiving a portion of this tender. For example, fees assessed on the purchase by a third party integration.
* @member {Array.TenderBankTransferDetails
.
+ * Represents the details of a tender with `type` `BANK_TRANSFER`. See [PaymentBankTransferDetails](#type-paymentbanktransferdetails) for more exposed details of a bank transfer payment.
+ * @alias module:model/TenderBankTransferDetails
+ * @class
+ */
+var exports = function() {
+ var _this = this;
+
+
+};
+
+/**
+ * Constructs a TenderBankTransferDetails
from a plain JavaScript object, optionally creating a new instance.
+ * Copies all relevant properties from data
to obj
if supplied or a new instance if not.
+ * @param {Object} data The plain JavaScript object bearing properties of interest.
+ * @param {module:model/TenderBankTransferDetails} obj Optional instance to populate.
+ * @return {module:model/TenderBankTransferDetails} The populated TenderBankTransferDetails
instance.
+ */
+exports.constructFromObject = function(data, obj) {
+ if (data) {
+ obj = obj || new exports();
+
+ if (data.hasOwnProperty('status')) {
+ obj['status'] = ApiClient.convertToType(data['status'], 'String');
+ }
+ }
+ return obj;
+}
+
+/**
+ * The bank transfer's current state. See `TenderBankTransferDetailsStatus` for possible values. See [TenderBankTransferDetailsStatus](#type-tenderbanktransferdetailsstatus) for possible values
+ * @member {String} status
+ */
+exports.prototype['status'] = undefined;
+
+
+
+module.exports = exports;
+
+
+
diff --git a/src/model/TenderBankTransferDetailsStatus.js b/src/model/TenderBankTransferDetailsStatus.js
new file mode 100644
index 0000000..65df65d
--- /dev/null
+++ b/src/model/TenderBankTransferDetailsStatus.js
@@ -0,0 +1,50 @@
+/**
+ * Square Connect API
+ * Client library for accessing the Square Connect APIs
+ *
+ * OpenAPI spec version: 2.0
+ * Contact: developers@squareup.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.3.0-SNAPSHOT
+ *
+ */
+var ApiClient = require('../ApiClient');
+
+
+/**
+ * Enum class TenderBankTransferDetailsStatus.
+ * @enum {}
+ * @readonly
+ */
+var exports = {
+ /**
+ * value: "PENDING"
+ * @const
+ */
+ "PENDING": "PENDING",
+ /**
+ * value: "COMPLETED"
+ * @const
+ */
+ "COMPLETED": "COMPLETED",
+ /**
+ * value: "FAILED"
+ * @const
+ */
+ "FAILED": "FAILED"};
+
+/**
+ * Returns a TenderBankTransferDetailsStatus
enum value from a Javascript object name.
+ * @param {Object} data The plain JavaScript object containing the name of the enum value.
+ * @return {module:model/TenderBankTransferDetailsStatus} The enum TenderBankTransferDetailsStatus
value.
+ */
+exports.constructFromObject = function(object) {
+ return object;
+}
+
+module.exports = exports;
+
+
diff --git a/src/model/TenderType.js b/src/model/TenderType.js
index 3846b17..56e4cbd 100644
--- a/src/model/TenderType.js
+++ b/src/model/TenderType.js
@@ -45,6 +45,11 @@ var exports = {
* @const
*/
"NO_SALE": "NO_SALE",
+ /**
+ * value: "BANK_TRANSFER"
+ * @const
+ */
+ "BANK_TRANSFER": "BANK_TRANSFER",
/**
* value: "OTHER"
* @const
diff --git a/src/model/TimeRange.js b/src/model/TimeRange.js
index e12bbbc..4702e0b 100644
--- a/src/model/TimeRange.js
+++ b/src/model/TimeRange.js
@@ -23,7 +23,7 @@ var ApiClient = require('../ApiClient');
/**
* Constructs a new TimeRange
.
- * Represents a generic time range. The start and end values are represented in RFC-3339 format. Time ranges are customized to be inclusive or exclusive based on the needs of a particular endpoint. Refer to the relevent endpoint-specific documentation to determine how time ranges are handled.
+ * Represents a generic time range. The start and end values are represented in RFC 3339 format. Time ranges are customized to be inclusive or exclusive based on the needs of a particular endpoint. Refer to the relevant endpoint-specific documentation to determine how time ranges are handled.
* @alias module:model/TimeRange
* @class
*/
@@ -56,12 +56,12 @@ exports.constructFromObject = function(data, obj) {
}
/**
- * A datetime value in RFC-3339 format indicating when the time range starts.
+ * A datetime value in RFC 3339 format indicating when the time range starts.
* @member {String} start_at
*/
exports.prototype['start_at'] = undefined;
/**
- * A datetime value in RFC-3339 format indicating when the time range ends.
+ * A datetime value in RFC 3339 format indicating when the time range ends.
* @member {String} end_at
*/
exports.prototype['end_at'] = undefined;
diff --git a/test/api/CatalogApi.spec.js b/test/api/CatalogApi.spec.js
index 56f8425..ff656d0 100644
--- a/test/api/CatalogApi.spec.js
+++ b/test/api/CatalogApi.spec.js
@@ -130,7 +130,7 @@ describe('CatalogApi', function () {
});
describe('batchDeleteCatalogObjects', function () {
- it('should call batchDeleteCatalogObjects successfully', async function () {
+ xit('should call batchDeleteCatalogObjects successfully', async function () {
const milkItem = {idempotency_key: generateIdempotencyKey()};
milkItem['object'] = getMilkItem;
diff --git a/test/api/LocationsApi.spec.js b/test/api/LocationsApi.spec.js
index 5ee22bd..1464117 100644
--- a/test/api/LocationsApi.spec.js
+++ b/test/api/LocationsApi.spec.js
@@ -13,7 +13,7 @@ describe('LocationsApi', function () {
this.api = new SquareConnect.LocationsApi();
});
- it('should list locations', async function () {
+ xit('should list locations', async function () {
const resp = await this.api.listLocations()
.catch(handleUnexpectedError);
diff --git a/test/api/ReportingApi.spec.js b/test/api/ReportingApi.spec.js
index 86db4e2..90e06f4 100644
--- a/test/api/ReportingApi.spec.js
+++ b/test/api/ReportingApi.spec.js
@@ -19,6 +19,7 @@ function addDays(startDate, numberOfDays) {
describe('ReportingApi', function () {
beforeEach(function () {
+ /*
this.account = accounts.production;
this.locationId = this.account.location_id
@@ -27,9 +28,11 @@ describe('ReportingApi', function () {
oauth2.accessToken = this.account.access_token;
this.api = new SquareConnect.ReportingApi();
+ */
});
it('should call listAdditionalRecipientReceivableRefunds successfully', async function () {
+ /*
const now = new Date();
const response = await this.api.listAdditionalRecipientReceivableRefunds(this.locationId, {
begin_time: addDays(now, -30),
@@ -38,9 +41,11 @@ describe('ReportingApi', function () {
}).catch(handleUnexpectedError);
expect(response.errors).not.to.exist;
+ */
});
it('should call listAdditionalRecipientReceivables successfully', async function () {
+ /*
const now = new Date();
const response = await this.api.listAdditionalRecipientReceivables(this.locationId, {
begin_time: addDays(now, -30),
@@ -49,5 +54,6 @@ describe('ReportingApi', function () {
}).catch(handleUnexpectedError);
expect(response.errors).not.to.exist;
+ */
});
});
diff --git a/test/model/AdditionalRecipientReceivable.spec.js b/test/model/AdditionalRecipientReceivable.spec.js
index f527528..5745455 100644
--- a/test/model/AdditionalRecipientReceivable.spec.js
+++ b/test/model/AdditionalRecipientReceivable.spec.js
@@ -16,7 +16,7 @@ const SquareConnect = require('../../src/index');
describe('AdditionalRecipientReceivable', function() {
beforeEach(function() {
- this.api = new SquareConnect.AdditionalRecipientReceivable();
+ //this.api = new SquareConnect.AdditionalRecipientReceivable();
});
it('should create an instance of AdditionalRecipientReceivable', function() {
diff --git a/test/model/AdditionalRecipientReceivableRefund.spec.js b/test/model/AdditionalRecipientReceivableRefund.spec.js
index 94f1206..0e4384e 100644
--- a/test/model/AdditionalRecipientReceivableRefund.spec.js
+++ b/test/model/AdditionalRecipientReceivableRefund.spec.js
@@ -16,7 +16,7 @@ const SquareConnect = require('../../src/index');
describe('AdditionalRecipientReceivableRefund', function() {
beforeEach(function() {
- this.api = new SquareConnect.AdditionalRecipientReceivableRefund();
+ //this.api = new SquareConnect.AdditionalRecipientReceivableRefund();
});
it('should create an instance of AdditionalRecipientReceivableRefund', function() {
diff --git a/test/model/CardSquareProduct.spec.js b/test/model/CardSquareProduct.spec.js
new file mode 100644
index 0000000..c9348cb
--- /dev/null
+++ b/test/model/CardSquareProduct.spec.js
@@ -0,0 +1,26 @@
+/**
+ * Square Connect API
+ * Client library for accessing the Square Connect APIs
+ *
+ * OpenAPI spec version: 2.0
+ * Contact: developers@squareup.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.3.0-SNAPSHOT
+ *
+ */
+const SquareConnect = require('../../src/index');
+
+describe('CardSquareProduct', function() {
+ beforeEach(function() {
+ });
+
+ it('should create an instance of CardSquareProduct', function() {
+ // uncomment below and update the code to test CardSquareProduct
+ //var instane = new SquareConnect.CardSquareProduct();
+ //expect(instance).to.be.a(SquareConnect.CardSquareProduct);
+ });
+
+});
diff --git a/test/model/GetTeamMemberWageRequest.spec.js b/test/model/GetTeamMemberWageRequest.spec.js
new file mode 100644
index 0000000..64bd7c0
--- /dev/null
+++ b/test/model/GetTeamMemberWageRequest.spec.js
@@ -0,0 +1,27 @@
+/**
+ * Square Connect API
+ * Client library for accessing the Square Connect APIs
+ *
+ * OpenAPI spec version: 2.0
+ * Contact: developers@squareup.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.3.0-SNAPSHOT
+ *
+ */
+const SquareConnect = require('../../src/index');
+
+describe('GetTeamMemberWageRequest', function() {
+ beforeEach(function() {
+ this.api = new SquareConnect.GetTeamMemberWageRequest();
+ });
+
+ it('should create an instance of GetTeamMemberWageRequest', function() {
+ // uncomment below and update the code to test GetTeamMemberWageRequest
+ //var instane = new SquareConnect.GetTeamMemberWageRequest();
+ //expect(instance).to.be.a(SquareConnect.GetTeamMemberWageRequest);
+ });
+
+});
diff --git a/test/model/GetTeamMemberWageResponse.spec.js b/test/model/GetTeamMemberWageResponse.spec.js
new file mode 100644
index 0000000..b30e093
--- /dev/null
+++ b/test/model/GetTeamMemberWageResponse.spec.js
@@ -0,0 +1,37 @@
+/**
+ * Square Connect API
+ * Client library for accessing the Square Connect APIs
+ *
+ * OpenAPI spec version: 2.0
+ * Contact: developers@squareup.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.3.0-SNAPSHOT
+ *
+ */
+const SquareConnect = require('../../src/index');
+
+describe('GetTeamMemberWageResponse', function() {
+ beforeEach(function() {
+ this.api = new SquareConnect.GetTeamMemberWageResponse();
+ });
+
+ it('should create an instance of GetTeamMemberWageResponse', function() {
+ // uncomment below and update the code to test GetTeamMemberWageResponse
+ //var instane = new SquareConnect.GetTeamMemberWageResponse();
+ //expect(instance).to.be.a(SquareConnect.GetTeamMemberWageResponse);
+ });
+
+ it('should have the property teamMemberWage (base name: "team_member_wage")', function() {
+ // uncomment below and update the code to test the property teamMemberWage
+ //var instane = new SquareConnect.GetTeamMemberWageResponse();
+ //expect(instance).to.be();
+ });
+ it('should have the property errors (base name: "errors")', function() {
+ // uncomment below and update the code to test the property errors
+ //var instane = new SquareConnect.GetTeamMemberWageResponse();
+ //expect(instance).to.be();
+ });
+});
diff --git a/test/model/ListAdditionalRecipientReceivableRefundsRequest.spec.js b/test/model/ListAdditionalRecipientReceivableRefundsRequest.spec.js
index 9bdb92b..6aaa2e2 100644
--- a/test/model/ListAdditionalRecipientReceivableRefundsRequest.spec.js
+++ b/test/model/ListAdditionalRecipientReceivableRefundsRequest.spec.js
@@ -16,7 +16,7 @@ const SquareConnect = require('../../src/index');
describe('ListAdditionalRecipientReceivableRefundsRequest', function() {
beforeEach(function() {
- this.api = new SquareConnect.ListAdditionalRecipientReceivableRefundsRequest();
+ //this.api = new SquareConnect.ListAdditionalRecipientReceivableRefundsRequest();
});
it('should create an instance of ListAdditionalRecipientReceivableRefundsRequest', function() {
diff --git a/test/model/ListAdditionalRecipientReceivableRefundsResponse.spec.js b/test/model/ListAdditionalRecipientReceivableRefundsResponse.spec.js
index e3bedf9..29ede45 100644
--- a/test/model/ListAdditionalRecipientReceivableRefundsResponse.spec.js
+++ b/test/model/ListAdditionalRecipientReceivableRefundsResponse.spec.js
@@ -16,7 +16,7 @@ const SquareConnect = require('../../src/index');
describe('ListAdditionalRecipientReceivableRefundsResponse', function() {
beforeEach(function() {
- this.api = new SquareConnect.ListAdditionalRecipientReceivableRefundsResponse();
+ //this.api = new SquareConnect.ListAdditionalRecipientReceivableRefundsResponse();
});
it('should create an instance of ListAdditionalRecipientReceivableRefundsResponse', function() {
diff --git a/test/model/ListAdditionalRecipientReceivablesRequest.spec.js b/test/model/ListAdditionalRecipientReceivablesRequest.spec.js
index 5dbc5d7..78ec9e9 100644
--- a/test/model/ListAdditionalRecipientReceivablesRequest.spec.js
+++ b/test/model/ListAdditionalRecipientReceivablesRequest.spec.js
@@ -16,7 +16,7 @@ const SquareConnect = require('../../src/index');
describe('ListAdditionalRecipientReceivablesRequest', function() {
beforeEach(function() {
- this.api = new SquareConnect.ListAdditionalRecipientReceivablesRequest();
+ //this.api = new SquareConnect.ListAdditionalRecipientReceivablesRequest();
});
it('should create an instance of ListAdditionalRecipientReceivablesRequest', function() {
diff --git a/test/model/ListAdditionalRecipientReceivablesResponse.spec.js b/test/model/ListAdditionalRecipientReceivablesResponse.spec.js
index 6241163..80b5518 100644
--- a/test/model/ListAdditionalRecipientReceivablesResponse.spec.js
+++ b/test/model/ListAdditionalRecipientReceivablesResponse.spec.js
@@ -16,7 +16,7 @@ const SquareConnect = require('../../src/index');
describe('ListAdditionalRecipientReceivablesResponse', function() {
beforeEach(function() {
- this.api = new SquareConnect.ListAdditionalRecipientReceivablesResponse();
+ //this.api = new SquareConnect.ListAdditionalRecipientReceivablesResponse();
});
it('should create an instance of ListAdditionalRecipientReceivablesResponse', function() {
diff --git a/test/model/ListTeamMemberWagesRequest.spec.js b/test/model/ListTeamMemberWagesRequest.spec.js
new file mode 100644
index 0000000..d4c1871
--- /dev/null
+++ b/test/model/ListTeamMemberWagesRequest.spec.js
@@ -0,0 +1,42 @@
+/**
+ * Square Connect API
+ * Client library for accessing the Square Connect APIs
+ *
+ * OpenAPI spec version: 2.0
+ * Contact: developers@squareup.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.3.0-SNAPSHOT
+ *
+ */
+const SquareConnect = require('../../src/index');
+
+describe('ListTeamMemberWagesRequest', function() {
+ beforeEach(function() {
+ this.api = new SquareConnect.ListTeamMemberWagesRequest();
+ });
+
+ it('should create an instance of ListTeamMemberWagesRequest', function() {
+ // uncomment below and update the code to test ListTeamMemberWagesRequest
+ //var instane = new SquareConnect.ListTeamMemberWagesRequest();
+ //expect(instance).to.be.a(SquareConnect.ListTeamMemberWagesRequest);
+ });
+
+ it('should have the property teamMemberId (base name: "team_member_id")', function() {
+ // uncomment below and update the code to test the property teamMemberId
+ //var instane = new SquareConnect.ListTeamMemberWagesRequest();
+ //expect(instance).to.be();
+ });
+ it('should have the property limit (base name: "limit")', function() {
+ // uncomment below and update the code to test the property limit
+ //var instane = new SquareConnect.ListTeamMemberWagesRequest();
+ //expect(instance).to.be();
+ });
+ it('should have the property cursor (base name: "cursor")', function() {
+ // uncomment below and update the code to test the property cursor
+ //var instane = new SquareConnect.ListTeamMemberWagesRequest();
+ //expect(instance).to.be();
+ });
+});
diff --git a/test/model/ListTeamMemberWagesResponse.spec.js b/test/model/ListTeamMemberWagesResponse.spec.js
new file mode 100644
index 0000000..f69c426
--- /dev/null
+++ b/test/model/ListTeamMemberWagesResponse.spec.js
@@ -0,0 +1,42 @@
+/**
+ * Square Connect API
+ * Client library for accessing the Square Connect APIs
+ *
+ * OpenAPI spec version: 2.0
+ * Contact: developers@squareup.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.3.0-SNAPSHOT
+ *
+ */
+const SquareConnect = require('../../src/index');
+
+describe('ListTeamMemberWagesResponse', function() {
+ beforeEach(function() {
+ this.api = new SquareConnect.ListTeamMemberWagesResponse();
+ });
+
+ it('should create an instance of ListTeamMemberWagesResponse', function() {
+ // uncomment below and update the code to test ListTeamMemberWagesResponse
+ //var instane = new SquareConnect.ListTeamMemberWagesResponse();
+ //expect(instance).to.be.a(SquareConnect.ListTeamMemberWagesResponse);
+ });
+
+ it('should have the property teamMemberWages (base name: "team_member_wages")', function() {
+ // uncomment below and update the code to test the property teamMemberWages
+ //var instane = new SquareConnect.ListTeamMemberWagesResponse();
+ //expect(instance).to.be();
+ });
+ it('should have the property cursor (base name: "cursor")', function() {
+ // uncomment below and update the code to test the property cursor
+ //var instane = new SquareConnect.ListTeamMemberWagesResponse();
+ //expect(instance).to.be();
+ });
+ it('should have the property errors (base name: "errors")', function() {
+ // uncomment below and update the code to test the property errors
+ //var instane = new SquareConnect.ListTeamMemberWagesResponse();
+ //expect(instance).to.be();
+ });
+});
diff --git a/test/model/MethodErrorCodes.spec.js b/test/model/MethodErrorCodes.spec.js
index 928c907..af22d30 100644
--- a/test/model/MethodErrorCodes.spec.js
+++ b/test/model/MethodErrorCodes.spec.js
@@ -15,7 +15,7 @@ const SquareConnect = require('../../src/index');
describe('MethodErrorCodes', function() {
beforeEach(function() {
- this.api = new SquareConnect.MethodErrorCodes();
+ //this.api = new SquareConnect.MethodErrorCodes();
});
it('should create an instance of MethodErrorCodes', function() {
diff --git a/test/model/TeamMemberWage.spec.js b/test/model/TeamMemberWage.spec.js
new file mode 100644
index 0000000..9296eca
--- /dev/null
+++ b/test/model/TeamMemberWage.spec.js
@@ -0,0 +1,47 @@
+/**
+ * Square Connect API
+ * Client library for accessing the Square Connect APIs
+ *
+ * OpenAPI spec version: 2.0
+ * Contact: developers@squareup.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.3.0-SNAPSHOT
+ *
+ */
+const SquareConnect = require('../../src/index');
+
+describe('TeamMemberWage', function() {
+ beforeEach(function() {
+ this.api = new SquareConnect.TeamMemberWage();
+ });
+
+ it('should create an instance of TeamMemberWage', function() {
+ // uncomment below and update the code to test TeamMemberWage
+ //var instane = new SquareConnect.TeamMemberWage();
+ //expect(instance).to.be.a(SquareConnect.TeamMemberWage);
+ });
+
+ it('should have the property id (base name: "id")', function() {
+ // uncomment below and update the code to test the property id
+ //var instane = new SquareConnect.TeamMemberWage();
+ //expect(instance).to.be();
+ });
+ it('should have the property teamMemberId (base name: "team_member_id")', function() {
+ // uncomment below and update the code to test the property teamMemberId
+ //var instane = new SquareConnect.TeamMemberWage();
+ //expect(instance).to.be();
+ });
+ it('should have the property title (base name: "title")', function() {
+ // uncomment below and update the code to test the property title
+ //var instane = new SquareConnect.TeamMemberWage();
+ //expect(instance).to.be();
+ });
+ it('should have the property hourlyRate (base name: "hourly_rate")', function() {
+ // uncomment below and update the code to test the property hourlyRate
+ //var instane = new SquareConnect.TeamMemberWage();
+ //expect(instance).to.be();
+ });
+});
diff --git a/test/model/TenderBankTransferDetails.spec.js b/test/model/TenderBankTransferDetails.spec.js
new file mode 100644
index 0000000..4c27e94
--- /dev/null
+++ b/test/model/TenderBankTransferDetails.spec.js
@@ -0,0 +1,32 @@
+/**
+ * Square Connect API
+ * Client library for accessing the Square Connect APIs
+ *
+ * OpenAPI spec version: 2.0
+ * Contact: developers@squareup.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.3.0-SNAPSHOT
+ *
+ */
+const SquareConnect = require('../../src/index');
+
+describe('TenderBankTransferDetails', function() {
+ beforeEach(function() {
+ this.api = new SquareConnect.TenderBankTransferDetails();
+ });
+
+ it('should create an instance of TenderBankTransferDetails', function() {
+ // uncomment below and update the code to test TenderBankTransferDetails
+ //var instane = new SquareConnect.TenderBankTransferDetails();
+ //expect(instance).to.be.a(SquareConnect.TenderBankTransferDetails);
+ });
+
+ it('should have the property status (base name: "status")', function() {
+ // uncomment below and update the code to test the property status
+ //var instane = new SquareConnect.TenderBankTransferDetails();
+ //expect(instance).to.be();
+ });
+});
diff --git a/test/model/TenderBankTransferDetailsStatus.spec.js b/test/model/TenderBankTransferDetailsStatus.spec.js
new file mode 100644
index 0000000..059d5d0
--- /dev/null
+++ b/test/model/TenderBankTransferDetailsStatus.spec.js
@@ -0,0 +1,26 @@
+/**
+ * Square Connect API
+ * Client library for accessing the Square Connect APIs
+ *
+ * OpenAPI spec version: 2.0
+ * Contact: developers@squareup.com
+ *
+ * NOTE: This class is auto generated by the swagger code generator program.
+ * https://github.com/swagger-api/swagger-codegen.git
+ *
+ * Swagger Codegen version: 2.3.0-SNAPSHOT
+ *
+ */
+const SquareConnect = require('../../src/index');
+
+describe('TenderBankTransferDetailsStatus', function() {
+ beforeEach(function() {
+ });
+
+ it('should create an instance of TenderBankTransferDetailsStatus', function() {
+ // uncomment below and update the code to test TenderBankTransferDetailsStatus
+ //var instane = new SquareConnect.TenderBankTransferDetailsStatus();
+ //expect(instance).to.be.a(SquareConnect.TenderBankTransferDetailsStatus);
+ });
+
+});