diff --git a/CHANGES.md b/CHANGES.md index 71771d8..074e393 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,5 +1,29 @@ # Change Log +## Version 2.20190313.0 (2019-03-13) + +## New API: Labor API + +The Labor API now includes functionality +that gives a Square account the ability to track and retrieve employee labor hours +including multiple hourly wage rates per employee, work shift break tracking, and +standardized break templates. + +See the Connect v2 Technical Reference. + +## New API: Employees API + +The Employees API includes the ability to list employees for a Square +account and retrieve a single employee by ID. + +See the Connect v2 Technical Reference. + +## Improvement: Simplified OAuth access token renewal + +The RenewToken endpoint is now deprecated and replaced with new functionality in ObtainToken. +ObtainToken now returns a refresh token along with an access token. Refresh +tokens are used to renew expired OAuth access tokens. + ## Version 2.20190213.0 (2019-02-13) ## New feature: Order fulfillment BETA diff --git a/README.md b/README.md index 7729d5c..9326570 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,8 @@ Class | Method | HTTP request | Description *SquareConnect.CustomersApi* | [**retrieveCustomer**](docs/CustomersApi.md#retrieveCustomer) | **GET** /v2/customers/{customer_id} | RetrieveCustomer *SquareConnect.CustomersApi* | [**searchCustomers**](docs/CustomersApi.md#searchCustomers) | **POST** /v2/customers/search | SearchCustomers *SquareConnect.CustomersApi* | [**updateCustomer**](docs/CustomersApi.md#updateCustomer) | **PUT** /v2/customers/{customer_id} | UpdateCustomer +*SquareConnect.EmployeesApi* | [**listEmployees**](docs/EmployeesApi.md#listEmployees) | **GET** /v2/employees | ListEmployees +*SquareConnect.EmployeesApi* | [**retrieveEmployee**](docs/EmployeesApi.md#retrieveEmployee) | **GET** /v2/employees/{id} | RetrieveEmployee *SquareConnect.InventoryApi* | [**batchChangeInventory**](docs/InventoryApi.md#batchChangeInventory) | **POST** /v2/inventory/batch-change | BatchChangeInventory *SquareConnect.InventoryApi* | [**batchRetrieveInventoryChanges**](docs/InventoryApi.md#batchRetrieveInventoryChanges) | **POST** /v2/inventory/batch-retrieve-changes | BatchRetrieveInventoryChanges *SquareConnect.InventoryApi* | [**batchRetrieveInventoryCounts**](docs/InventoryApi.md#batchRetrieveInventoryCounts) | **POST** /v2/inventory/batch-retrieve-counts | BatchRetrieveInventoryCounts @@ -72,6 +74,20 @@ Class | Method | HTTP request | Description *SquareConnect.InventoryApi* | [**retrieveInventoryChanges**](docs/InventoryApi.md#retrieveInventoryChanges) | **GET** /v2/inventory/{catalog_object_id}/changes | RetrieveInventoryChanges *SquareConnect.InventoryApi* | [**retrieveInventoryCount**](docs/InventoryApi.md#retrieveInventoryCount) | **GET** /v2/inventory/{catalog_object_id} | RetrieveInventoryCount *SquareConnect.InventoryApi* | [**retrieveInventoryPhysicalCount**](docs/InventoryApi.md#retrieveInventoryPhysicalCount) | **GET** /v2/inventory/physical-count/{physical_count_id} | RetrieveInventoryPhysicalCount +*SquareConnect.LaborApi* | [**createBreakType**](docs/LaborApi.md#createBreakType) | **POST** /v2/labor/break-types | CreateBreakType +*SquareConnect.LaborApi* | [**createShift**](docs/LaborApi.md#createShift) | **POST** /v2/labor/shifts | CreateShift +*SquareConnect.LaborApi* | [**deleteBreakType**](docs/LaborApi.md#deleteBreakType) | **DELETE** /v2/labor/break-types/{id} | DeleteBreakType +*SquareConnect.LaborApi* | [**deleteShift**](docs/LaborApi.md#deleteShift) | **DELETE** /v2/labor/shifts/{id} | DeleteShift +*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* | [**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* | [**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 +*SquareConnect.LaborApi* | [**updateShift**](docs/LaborApi.md#updateShift) | **PUT** /v2/labor/shifts/{id} | UpdateShift +*SquareConnect.LaborApi* | [**updateWorkweekConfig**](docs/LaborApi.md#updateWorkweekConfig) | **PUT** /v2/labor/workweek-configs/{id} | UpdateWorkweekConfig *SquareConnect.LocationsApi* | [**listLocations**](docs/LocationsApi.md#listLocations) | **GET** /v2/locations | ListLocations *SquareConnect.MobileAuthorizationApi* | [**createMobileAuthorizationCode**](docs/MobileAuthorizationApi.md#createMobileAuthorizationCode) | **POST** /mobile/authorization-code | CreateMobileAuthorizationCode *SquareConnect.OAuthApi* | [**obtainToken**](docs/OAuthApi.md#obtainToken) | **POST** /oauth2/token | ObtainToken @@ -88,75 +104,75 @@ Class | Method | HTTP request | Description *SquareConnect.TransactionsApi* | [**listTransactions**](docs/TransactionsApi.md#listTransactions) | **GET** /v2/locations/{location_id}/transactions | ListTransactions *SquareConnect.TransactionsApi* | [**retrieveTransaction**](docs/TransactionsApi.md#retrieveTransaction) | **GET** /v2/locations/{location_id}/transactions/{transaction_id} | RetrieveTransaction *SquareConnect.TransactionsApi* | [**voidTransaction**](docs/TransactionsApi.md#voidTransaction) | **POST** /v2/locations/{location_id}/transactions/{transaction_id}/void | VoidTransaction -*SquareConnect.V1EmployeesApi* | [**createEmployee**](docs/V1EmployeesApi.md#createEmployee) | **POST** /v1/me/employees | Creates an employee for a business. -*SquareConnect.V1EmployeesApi* | [**createEmployeeRole**](docs/V1EmployeesApi.md#createEmployeeRole) | **POST** /v1/me/roles | Creates an employee role you can then assign to employees. -*SquareConnect.V1EmployeesApi* | [**createTimecard**](docs/V1EmployeesApi.md#createTimecard) | **POST** /v1/me/timecards | Creates a timecard for an employee. Each timecard corresponds to a single shift. -*SquareConnect.V1EmployeesApi* | [**deleteTimecard**](docs/V1EmployeesApi.md#deleteTimecard) | **DELETE** /v1/me/timecards/{timecard_id} | Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. -*SquareConnect.V1EmployeesApi* | [**listCashDrawerShifts**](docs/V1EmployeesApi.md#listCashDrawerShifts) | **GET** /v1/{location_id}/cash-drawer-shifts | Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. -*SquareConnect.V1EmployeesApi* | [**listEmployeeRoles**](docs/V1EmployeesApi.md#listEmployeeRoles) | **GET** /v1/me/roles | Provides summary information for all of a business's employee roles. -*SquareConnect.V1EmployeesApi* | [**listEmployees**](docs/V1EmployeesApi.md#listEmployees) | **GET** /v1/me/employees | Provides summary information for all of a business's employees. -*SquareConnect.V1EmployeesApi* | [**listTimecardEvents**](docs/V1EmployeesApi.md#listTimecardEvents) | **GET** /v1/me/timecards/{timecard_id}/events | Provides summary information for all events associated with a particular timecard. -*SquareConnect.V1EmployeesApi* | [**listTimecards**](docs/V1EmployeesApi.md#listTimecards) | **GET** /v1/me/timecards | Provides summary information for all of a business's employee timecards. -*SquareConnect.V1EmployeesApi* | [**retrieveCashDrawerShift**](docs/V1EmployeesApi.md#retrieveCashDrawerShift) | **GET** /v1/{location_id}/cash-drawer-shifts/{shift_id} | Provides the details for a single cash drawer shift, including all events that occurred during the shift. -*SquareConnect.V1EmployeesApi* | [**retrieveEmployee**](docs/V1EmployeesApi.md#retrieveEmployee) | **GET** /v1/me/employees/{employee_id} | Provides the details for a single employee. -*SquareConnect.V1EmployeesApi* | [**retrieveEmployeeRole**](docs/V1EmployeesApi.md#retrieveEmployeeRole) | **GET** /v1/me/roles/{role_id} | Provides the details for a single employee role. -*SquareConnect.V1EmployeesApi* | [**retrieveTimecard**](docs/V1EmployeesApi.md#retrieveTimecard) | **GET** /v1/me/timecards/{timecard_id} | Provides the details for a single timecard. -*SquareConnect.V1EmployeesApi* | [**updateEmployee**](docs/V1EmployeesApi.md#updateEmployee) | **PUT** /v1/me/employees/{employee_id} | V1 UpdateEmployee -*SquareConnect.V1EmployeesApi* | [**updateEmployeeRole**](docs/V1EmployeesApi.md#updateEmployeeRole) | **PUT** /v1/me/roles/{role_id} | Modifies the details of an employee role. -*SquareConnect.V1EmployeesApi* | [**updateTimecard**](docs/V1EmployeesApi.md#updateTimecard) | **PUT** /v1/me/timecards/{timecard_id} | Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. -*SquareConnect.V1ItemsApi* | [**adjustInventory**](docs/V1ItemsApi.md#adjustInventory) | **POST** /v1/{location_id}/inventory/{variation_id} | Adjusts an item variation's current available inventory. -*SquareConnect.V1ItemsApi* | [**applyFee**](docs/V1ItemsApi.md#applyFee) | **PUT** /v1/{location_id}/items/{item_id}/fees/{fee_id} | Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. -*SquareConnect.V1ItemsApi* | [**applyModifierList**](docs/V1ItemsApi.md#applyModifierList) | **PUT** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. -*SquareConnect.V1ItemsApi* | [**createCategory**](docs/V1ItemsApi.md#createCategory) | **POST** /v1/{location_id}/categories | Creates an item category. -*SquareConnect.V1ItemsApi* | [**createDiscount**](docs/V1ItemsApi.md#createDiscount) | **POST** /v1/{location_id}/discounts | Creates a discount. -*SquareConnect.V1ItemsApi* | [**createFee**](docs/V1ItemsApi.md#createFee) | **POST** /v1/{location_id}/fees | Creates a fee (tax). -*SquareConnect.V1ItemsApi* | [**createItem**](docs/V1ItemsApi.md#createItem) | **POST** /v1/{location_id}/items | Creates an item and at least one variation for it. -*SquareConnect.V1ItemsApi* | [**createModifierList**](docs/V1ItemsApi.md#createModifierList) | **POST** /v1/{location_id}/modifier-lists | Creates an item modifier list and at least one modifier option for it. -*SquareConnect.V1ItemsApi* | [**createModifierOption**](docs/V1ItemsApi.md#createModifierOption) | **POST** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options | Creates an item modifier option and adds it to a modifier list. -*SquareConnect.V1ItemsApi* | [**createPage**](docs/V1ItemsApi.md#createPage) | **POST** /v1/{location_id}/pages | Creates a Favorites page in Square Register. -*SquareConnect.V1ItemsApi* | [**createVariation**](docs/V1ItemsApi.md#createVariation) | **POST** /v1/{location_id}/items/{item_id}/variations | Creates an item variation for an existing item. -*SquareConnect.V1ItemsApi* | [**deleteCategory**](docs/V1ItemsApi.md#deleteCategory) | **DELETE** /v1/{location_id}/categories/{category_id} | Deletes an existing item category. -*SquareConnect.V1ItemsApi* | [**deleteDiscount**](docs/V1ItemsApi.md#deleteDiscount) | **DELETE** /v1/{location_id}/discounts/{discount_id} | Deletes an existing discount. -*SquareConnect.V1ItemsApi* | [**deleteFee**](docs/V1ItemsApi.md#deleteFee) | **DELETE** /v1/{location_id}/fees/{fee_id} | Deletes an existing fee (tax). -*SquareConnect.V1ItemsApi* | [**deleteItem**](docs/V1ItemsApi.md#deleteItem) | **DELETE** /v1/{location_id}/items/{item_id} | Deletes an existing item and all item variations associated with it. -*SquareConnect.V1ItemsApi* | [**deleteModifierList**](docs/V1ItemsApi.md#deleteModifierList) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id} | Deletes an existing item modifier list and all modifier options associated with it. -*SquareConnect.V1ItemsApi* | [**deleteModifierOption**](docs/V1ItemsApi.md#deleteModifierOption) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | Deletes an existing item modifier option from a modifier list. -*SquareConnect.V1ItemsApi* | [**deletePage**](docs/V1ItemsApi.md#deletePage) | **DELETE** /v1/{location_id}/pages/{page_id} | Deletes an existing Favorites page and all of its cells. -*SquareConnect.V1ItemsApi* | [**deletePageCell**](docs/V1ItemsApi.md#deletePageCell) | **DELETE** /v1/{location_id}/pages/{page_id}/cells | Deletes a cell from a Favorites page in Square Register. -*SquareConnect.V1ItemsApi* | [**deleteVariation**](docs/V1ItemsApi.md#deleteVariation) | **DELETE** /v1/{location_id}/items/{item_id}/variations/{variation_id} | Deletes an existing item variation from an item. -*SquareConnect.V1ItemsApi* | [**listCategories**](docs/V1ItemsApi.md#listCategories) | **GET** /v1/{location_id}/categories | Lists all of a location's item categories. -*SquareConnect.V1ItemsApi* | [**listDiscounts**](docs/V1ItemsApi.md#listDiscounts) | **GET** /v1/{location_id}/discounts | Lists all of a location's discounts. -*SquareConnect.V1ItemsApi* | [**listFees**](docs/V1ItemsApi.md#listFees) | **GET** /v1/{location_id}/fees | Lists all of a location's fees (taxes). -*SquareConnect.V1ItemsApi* | [**listInventory**](docs/V1ItemsApi.md#listInventory) | **GET** /v1/{location_id}/inventory | Provides inventory information for all of a merchant's inventory-enabled item variations. -*SquareConnect.V1ItemsApi* | [**listItems**](docs/V1ItemsApi.md#listItems) | **GET** /v1/{location_id}/items | Provides summary information for all of a location's items. -*SquareConnect.V1ItemsApi* | [**listModifierLists**](docs/V1ItemsApi.md#listModifierLists) | **GET** /v1/{location_id}/modifier-lists | Lists all of a location's modifier lists. -*SquareConnect.V1ItemsApi* | [**listPages**](docs/V1ItemsApi.md#listPages) | **GET** /v1/{location_id}/pages | Lists all of a location's Favorites pages in Square Register. -*SquareConnect.V1ItemsApi* | [**removeFee**](docs/V1ItemsApi.md#removeFee) | **DELETE** /v1/{location_id}/items/{item_id}/fees/{fee_id} | Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. -*SquareConnect.V1ItemsApi* | [**removeModifierList**](docs/V1ItemsApi.md#removeModifierList) | **DELETE** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. -*SquareConnect.V1ItemsApi* | [**retrieveItem**](docs/V1ItemsApi.md#retrieveItem) | **GET** /v1/{location_id}/items/{item_id} | Provides the details for a single item, including associated modifier lists and fees. -*SquareConnect.V1ItemsApi* | [**retrieveModifierList**](docs/V1ItemsApi.md#retrieveModifierList) | **GET** /v1/{location_id}/modifier-lists/{modifier_list_id} | Provides the details for a single modifier list. -*SquareConnect.V1ItemsApi* | [**updateCategory**](docs/V1ItemsApi.md#updateCategory) | **PUT** /v1/{location_id}/categories/{category_id} | Modifies the details of an existing item category. -*SquareConnect.V1ItemsApi* | [**updateDiscount**](docs/V1ItemsApi.md#updateDiscount) | **PUT** /v1/{location_id}/discounts/{discount_id} | Modifies the details of an existing discount. -*SquareConnect.V1ItemsApi* | [**updateFee**](docs/V1ItemsApi.md#updateFee) | **PUT** /v1/{location_id}/fees/{fee_id} | Modifies the details of an existing fee (tax). -*SquareConnect.V1ItemsApi* | [**updateItem**](docs/V1ItemsApi.md#updateItem) | **PUT** /v1/{location_id}/items/{item_id} | Modifies the core details of an existing item. -*SquareConnect.V1ItemsApi* | [**updateModifierList**](docs/V1ItemsApi.md#updateModifierList) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id} | Modifies the details of an existing item modifier list. -*SquareConnect.V1ItemsApi* | [**updateModifierOption**](docs/V1ItemsApi.md#updateModifierOption) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | Modifies the details of an existing item modifier option. -*SquareConnect.V1ItemsApi* | [**updatePage**](docs/V1ItemsApi.md#updatePage) | **PUT** /v1/{location_id}/pages/{page_id} | Modifies the details of a Favorites page in Square Register. -*SquareConnect.V1ItemsApi* | [**updatePageCell**](docs/V1ItemsApi.md#updatePageCell) | **PUT** /v1/{location_id}/pages/{page_id}/cells | Modifies a cell of a Favorites page in Square Register. -*SquareConnect.V1ItemsApi* | [**updateVariation**](docs/V1ItemsApi.md#updateVariation) | **PUT** /v1/{location_id}/items/{item_id}/variations/{variation_id} | Modifies the details of an existing item variation. -*SquareConnect.V1LocationsApi* | [**listLocations**](docs/V1LocationsApi.md#listLocations) | **GET** /v1/me/locations | Provides details for a business's locations, including their IDs. -*SquareConnect.V1LocationsApi* | [**retrieveBusiness**](docs/V1LocationsApi.md#retrieveBusiness) | **GET** /v1/me | Get a business's information. -*SquareConnect.V1TransactionsApi* | [**createRefund**](docs/V1TransactionsApi.md#createRefund) | **POST** /v1/{location_id}/refunds | Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. -*SquareConnect.V1TransactionsApi* | [**listBankAccounts**](docs/V1TransactionsApi.md#listBankAccounts) | **GET** /v1/{location_id}/bank-accounts | Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. -*SquareConnect.V1TransactionsApi* | [**listOrders**](docs/V1TransactionsApi.md#listOrders) | **GET** /v1/{location_id}/orders | Provides summary information for a merchant's online store orders. -*SquareConnect.V1TransactionsApi* | [**listPayments**](docs/V1TransactionsApi.md#listPayments) | **GET** /v1/{location_id}/payments | Provides summary information for all payments taken by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. See Date ranges for details of inclusive and exclusive dates. -*SquareConnect.V1TransactionsApi* | [**listRefunds**](docs/V1TransactionsApi.md#listRefunds) | **GET** /v1/{location_id}/refunds | Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. -*SquareConnect.V1TransactionsApi* | [**listSettlements**](docs/V1TransactionsApi.md#listSettlements) | **GET** /v1/{location_id}/settlements | Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length. -*SquareConnect.V1TransactionsApi* | [**retrieveBankAccount**](docs/V1TransactionsApi.md#retrieveBankAccount) | **GET** /v1/{location_id}/bank-accounts/{bank_account_id} | Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. -*SquareConnect.V1TransactionsApi* | [**retrieveOrder**](docs/V1TransactionsApi.md#retrieveOrder) | **GET** /v1/{location_id}/orders/{order_id} | Provides comprehensive information for a single online store order, including the order's history. -*SquareConnect.V1TransactionsApi* | [**retrievePayment**](docs/V1TransactionsApi.md#retrievePayment) | **GET** /v1/{location_id}/payments/{payment_id} | Provides comprehensive information for a single payment. -*SquareConnect.V1TransactionsApi* | [**retrieveSettlement**](docs/V1TransactionsApi.md#retrieveSettlement) | **GET** /v1/{location_id}/settlements/{settlement_id} | Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total. -*SquareConnect.V1TransactionsApi* | [**updateOrder**](docs/V1TransactionsApi.md#updateOrder) | **PUT** /v1/{location_id}/orders/{order_id} | Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions: +*SquareConnect.V1EmployeesApi* | [**createEmployee**](docs/V1EmployeesApi.md#createEmployee) | **POST** /v1/me/employees | CreateEmployee +*SquareConnect.V1EmployeesApi* | [**createEmployeeRole**](docs/V1EmployeesApi.md#createEmployeeRole) | **POST** /v1/me/roles | CreateEmployeeRole +*SquareConnect.V1EmployeesApi* | [**createTimecard**](docs/V1EmployeesApi.md#createTimecard) | **POST** /v1/me/timecards | CreateTimecard +*SquareConnect.V1EmployeesApi* | [**deleteTimecard**](docs/V1EmployeesApi.md#deleteTimecard) | **DELETE** /v1/me/timecards/{timecard_id} | DeleteTimecard +*SquareConnect.V1EmployeesApi* | [**listCashDrawerShifts**](docs/V1EmployeesApi.md#listCashDrawerShifts) | **GET** /v1/{location_id}/cash-drawer-shifts | ListCashDrawerShifts +*SquareConnect.V1EmployeesApi* | [**listEmployeeRoles**](docs/V1EmployeesApi.md#listEmployeeRoles) | **GET** /v1/me/roles | ListEmployeeRoles +*SquareConnect.V1EmployeesApi* | [**listEmployees**](docs/V1EmployeesApi.md#listEmployees) | **GET** /v1/me/employees | ListEmployees +*SquareConnect.V1EmployeesApi* | [**listTimecardEvents**](docs/V1EmployeesApi.md#listTimecardEvents) | **GET** /v1/me/timecards/{timecard_id}/events | ListTimecardEvents +*SquareConnect.V1EmployeesApi* | [**listTimecards**](docs/V1EmployeesApi.md#listTimecards) | **GET** /v1/me/timecards | ListTimecards +*SquareConnect.V1EmployeesApi* | [**retrieveCashDrawerShift**](docs/V1EmployeesApi.md#retrieveCashDrawerShift) | **GET** /v1/{location_id}/cash-drawer-shifts/{shift_id} | RetrieveCashDrawerShift +*SquareConnect.V1EmployeesApi* | [**retrieveEmployee**](docs/V1EmployeesApi.md#retrieveEmployee) | **GET** /v1/me/employees/{employee_id} | RetrieveEmployee +*SquareConnect.V1EmployeesApi* | [**retrieveEmployeeRole**](docs/V1EmployeesApi.md#retrieveEmployeeRole) | **GET** /v1/me/roles/{role_id} | RetrieveEmployeeRole +*SquareConnect.V1EmployeesApi* | [**retrieveTimecard**](docs/V1EmployeesApi.md#retrieveTimecard) | **GET** /v1/me/timecards/{timecard_id} | RetrieveTimecard +*SquareConnect.V1EmployeesApi* | [**updateEmployee**](docs/V1EmployeesApi.md#updateEmployee) | **PUT** /v1/me/employees/{employee_id} | UpdateEmployee +*SquareConnect.V1EmployeesApi* | [**updateEmployeeRole**](docs/V1EmployeesApi.md#updateEmployeeRole) | **PUT** /v1/me/roles/{role_id} | UpdateEmployeeRole +*SquareConnect.V1EmployeesApi* | [**updateTimecard**](docs/V1EmployeesApi.md#updateTimecard) | **PUT** /v1/me/timecards/{timecard_id} | UpdateTimecard +*SquareConnect.V1ItemsApi* | [**adjustInventory**](docs/V1ItemsApi.md#adjustInventory) | **POST** /v1/{location_id}/inventory/{variation_id} | AdjustInventory +*SquareConnect.V1ItemsApi* | [**applyFee**](docs/V1ItemsApi.md#applyFee) | **PUT** /v1/{location_id}/items/{item_id}/fees/{fee_id} | ApplyFee +*SquareConnect.V1ItemsApi* | [**applyModifierList**](docs/V1ItemsApi.md#applyModifierList) | **PUT** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | ApplyModifierList +*SquareConnect.V1ItemsApi* | [**createCategory**](docs/V1ItemsApi.md#createCategory) | **POST** /v1/{location_id}/categories | CreateCategory +*SquareConnect.V1ItemsApi* | [**createDiscount**](docs/V1ItemsApi.md#createDiscount) | **POST** /v1/{location_id}/discounts | CreateDiscount +*SquareConnect.V1ItemsApi* | [**createFee**](docs/V1ItemsApi.md#createFee) | **POST** /v1/{location_id}/fees | CreateFee +*SquareConnect.V1ItemsApi* | [**createItem**](docs/V1ItemsApi.md#createItem) | **POST** /v1/{location_id}/items | CreateItem +*SquareConnect.V1ItemsApi* | [**createModifierList**](docs/V1ItemsApi.md#createModifierList) | **POST** /v1/{location_id}/modifier-lists | CreateModifierList +*SquareConnect.V1ItemsApi* | [**createModifierOption**](docs/V1ItemsApi.md#createModifierOption) | **POST** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options | CreateModifierOption +*SquareConnect.V1ItemsApi* | [**createPage**](docs/V1ItemsApi.md#createPage) | **POST** /v1/{location_id}/pages | CreatePage +*SquareConnect.V1ItemsApi* | [**createVariation**](docs/V1ItemsApi.md#createVariation) | **POST** /v1/{location_id}/items/{item_id}/variations | CreateVariation +*SquareConnect.V1ItemsApi* | [**deleteCategory**](docs/V1ItemsApi.md#deleteCategory) | **DELETE** /v1/{location_id}/categories/{category_id} | DeleteCategory +*SquareConnect.V1ItemsApi* | [**deleteDiscount**](docs/V1ItemsApi.md#deleteDiscount) | **DELETE** /v1/{location_id}/discounts/{discount_id} | DeleteDiscount +*SquareConnect.V1ItemsApi* | [**deleteFee**](docs/V1ItemsApi.md#deleteFee) | **DELETE** /v1/{location_id}/fees/{fee_id} | DeleteFee +*SquareConnect.V1ItemsApi* | [**deleteItem**](docs/V1ItemsApi.md#deleteItem) | **DELETE** /v1/{location_id}/items/{item_id} | DeleteItem +*SquareConnect.V1ItemsApi* | [**deleteModifierList**](docs/V1ItemsApi.md#deleteModifierList) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id} | DeleteModifierList +*SquareConnect.V1ItemsApi* | [**deleteModifierOption**](docs/V1ItemsApi.md#deleteModifierOption) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | DeleteModifierOption +*SquareConnect.V1ItemsApi* | [**deletePage**](docs/V1ItemsApi.md#deletePage) | **DELETE** /v1/{location_id}/pages/{page_id} | DeletePage +*SquareConnect.V1ItemsApi* | [**deletePageCell**](docs/V1ItemsApi.md#deletePageCell) | **DELETE** /v1/{location_id}/pages/{page_id}/cells | DeletePageCell +*SquareConnect.V1ItemsApi* | [**deleteVariation**](docs/V1ItemsApi.md#deleteVariation) | **DELETE** /v1/{location_id}/items/{item_id}/variations/{variation_id} | DeleteVariation +*SquareConnect.V1ItemsApi* | [**listCategories**](docs/V1ItemsApi.md#listCategories) | **GET** /v1/{location_id}/categories | ListCategories +*SquareConnect.V1ItemsApi* | [**listDiscounts**](docs/V1ItemsApi.md#listDiscounts) | **GET** /v1/{location_id}/discounts | ListDiscounts +*SquareConnect.V1ItemsApi* | [**listFees**](docs/V1ItemsApi.md#listFees) | **GET** /v1/{location_id}/fees | ListFees +*SquareConnect.V1ItemsApi* | [**listInventory**](docs/V1ItemsApi.md#listInventory) | **GET** /v1/{location_id}/inventory | ListInventory +*SquareConnect.V1ItemsApi* | [**listItems**](docs/V1ItemsApi.md#listItems) | **GET** /v1/{location_id}/items | ListItems +*SquareConnect.V1ItemsApi* | [**listModifierLists**](docs/V1ItemsApi.md#listModifierLists) | **GET** /v1/{location_id}/modifier-lists | ListModifierLists +*SquareConnect.V1ItemsApi* | [**listPages**](docs/V1ItemsApi.md#listPages) | **GET** /v1/{location_id}/pages | ListPages +*SquareConnect.V1ItemsApi* | [**removeFee**](docs/V1ItemsApi.md#removeFee) | **DELETE** /v1/{location_id}/items/{item_id}/fees/{fee_id} | RemoveFee +*SquareConnect.V1ItemsApi* | [**removeModifierList**](docs/V1ItemsApi.md#removeModifierList) | **DELETE** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | RemoveModifierList +*SquareConnect.V1ItemsApi* | [**retrieveItem**](docs/V1ItemsApi.md#retrieveItem) | **GET** /v1/{location_id}/items/{item_id} | RetrieveItem +*SquareConnect.V1ItemsApi* | [**retrieveModifierList**](docs/V1ItemsApi.md#retrieveModifierList) | **GET** /v1/{location_id}/modifier-lists/{modifier_list_id} | RetrieveModifierList +*SquareConnect.V1ItemsApi* | [**updateCategory**](docs/V1ItemsApi.md#updateCategory) | **PUT** /v1/{location_id}/categories/{category_id} | UpdateCategory +*SquareConnect.V1ItemsApi* | [**updateDiscount**](docs/V1ItemsApi.md#updateDiscount) | **PUT** /v1/{location_id}/discounts/{discount_id} | UpdateDiscount +*SquareConnect.V1ItemsApi* | [**updateFee**](docs/V1ItemsApi.md#updateFee) | **PUT** /v1/{location_id}/fees/{fee_id} | UpdateFee +*SquareConnect.V1ItemsApi* | [**updateItem**](docs/V1ItemsApi.md#updateItem) | **PUT** /v1/{location_id}/items/{item_id} | UpdateItem +*SquareConnect.V1ItemsApi* | [**updateModifierList**](docs/V1ItemsApi.md#updateModifierList) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id} | UpdateModifierList +*SquareConnect.V1ItemsApi* | [**updateModifierOption**](docs/V1ItemsApi.md#updateModifierOption) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | UpdateModifierOption +*SquareConnect.V1ItemsApi* | [**updatePage**](docs/V1ItemsApi.md#updatePage) | **PUT** /v1/{location_id}/pages/{page_id} | UpdatePage +*SquareConnect.V1ItemsApi* | [**updatePageCell**](docs/V1ItemsApi.md#updatePageCell) | **PUT** /v1/{location_id}/pages/{page_id}/cells | UpdatePageCell +*SquareConnect.V1ItemsApi* | [**updateVariation**](docs/V1ItemsApi.md#updateVariation) | **PUT** /v1/{location_id}/items/{item_id}/variations/{variation_id} | UpdateVariation +*SquareConnect.V1LocationsApi* | [**listLocations**](docs/V1LocationsApi.md#listLocations) | **GET** /v1/me/locations | ListLocations +*SquareConnect.V1LocationsApi* | [**retrieveBusiness**](docs/V1LocationsApi.md#retrieveBusiness) | **GET** /v1/me | RetrieveBusiness +*SquareConnect.V1TransactionsApi* | [**createRefund**](docs/V1TransactionsApi.md#createRefund) | **POST** /v1/{location_id}/refunds | CreateRefund +*SquareConnect.V1TransactionsApi* | [**listBankAccounts**](docs/V1TransactionsApi.md#listBankAccounts) | **GET** /v1/{location_id}/bank-accounts | ListBankAccounts +*SquareConnect.V1TransactionsApi* | [**listOrders**](docs/V1TransactionsApi.md#listOrders) | **GET** /v1/{location_id}/orders | ListOrders +*SquareConnect.V1TransactionsApi* | [**listPayments**](docs/V1TransactionsApi.md#listPayments) | **GET** /v1/{location_id}/payments | ListPayments +*SquareConnect.V1TransactionsApi* | [**listRefunds**](docs/V1TransactionsApi.md#listRefunds) | **GET** /v1/{location_id}/refunds | ListRefunds +*SquareConnect.V1TransactionsApi* | [**listSettlements**](docs/V1TransactionsApi.md#listSettlements) | **GET** /v1/{location_id}/settlements | ListSettlements +*SquareConnect.V1TransactionsApi* | [**retrieveBankAccount**](docs/V1TransactionsApi.md#retrieveBankAccount) | **GET** /v1/{location_id}/bank-accounts/{bank_account_id} | RetrieveBankAccount +*SquareConnect.V1TransactionsApi* | [**retrieveOrder**](docs/V1TransactionsApi.md#retrieveOrder) | **GET** /v1/{location_id}/orders/{order_id} | RetrieveOrder +*SquareConnect.V1TransactionsApi* | [**retrievePayment**](docs/V1TransactionsApi.md#retrievePayment) | **GET** /v1/{location_id}/payments/{payment_id} | RetrievePayment +*SquareConnect.V1TransactionsApi* | [**retrieveSettlement**](docs/V1TransactionsApi.md#retrieveSettlement) | **GET** /v1/{location_id}/settlements/{settlement_id} | RetrieveSettlement +*SquareConnect.V1TransactionsApi* | [**updateOrder**](docs/V1TransactionsApi.md#updateOrder) | **PUT** /v1/{location_id}/orders/{order_id} | UpdateOrder ## Documentation for Models @@ -179,6 +195,7 @@ Class | Method | HTTP request | Description - [SquareConnect.BatchRetrieveOrdersResponse](docs/BatchRetrieveOrdersResponse.md) - [SquareConnect.BatchUpsertCatalogObjectsRequest](docs/BatchUpsertCatalogObjectsRequest.md) - [SquareConnect.BatchUpsertCatalogObjectsResponse](docs/BatchUpsertCatalogObjectsResponse.md) + - [SquareConnect.BreakType](docs/BreakType.md) - [SquareConnect.CaptureTransactionRequest](docs/CaptureTransactionRequest.md) - [SquareConnect.CaptureTransactionResponse](docs/CaptureTransactionResponse.md) - [SquareConnect.Card](docs/Card.md) @@ -217,6 +234,8 @@ Class | Method | HTTP request | Description - [SquareConnect.ChargeResponse](docs/ChargeResponse.md) - [SquareConnect.Checkout](docs/Checkout.md) - [SquareConnect.Country](docs/Country.md) + - [SquareConnect.CreateBreakTypeRequest](docs/CreateBreakTypeRequest.md) + - [SquareConnect.CreateBreakTypeResponse](docs/CreateBreakTypeResponse.md) - [SquareConnect.CreateCheckoutRequest](docs/CreateCheckoutRequest.md) - [SquareConnect.CreateCheckoutResponse](docs/CreateCheckoutResponse.md) - [SquareConnect.CreateCustomerCardRequest](docs/CreateCustomerCardRequest.md) @@ -233,6 +252,8 @@ Class | Method | HTTP request | Description - [SquareConnect.CreateOrderResponse](docs/CreateOrderResponse.md) - [SquareConnect.CreateRefundRequest](docs/CreateRefundRequest.md) - [SquareConnect.CreateRefundResponse](docs/CreateRefundResponse.md) + - [SquareConnect.CreateShiftRequest](docs/CreateShiftRequest.md) + - [SquareConnect.CreateShiftResponse](docs/CreateShiftResponse.md) - [SquareConnect.Currency](docs/Currency.md) - [SquareConnect.Customer](docs/Customer.md) - [SquareConnect.CustomerCreationSource](docs/CustomerCreationSource.md) @@ -244,16 +265,30 @@ Class | Method | HTTP request | Description - [SquareConnect.CustomerQuery](docs/CustomerQuery.md) - [SquareConnect.CustomerSort](docs/CustomerSort.md) - [SquareConnect.CustomerSortField](docs/CustomerSortField.md) + - [SquareConnect.DateRange](docs/DateRange.md) + - [SquareConnect.DeleteBreakTypeRequest](docs/DeleteBreakTypeRequest.md) + - [SquareConnect.DeleteBreakTypeResponse](docs/DeleteBreakTypeResponse.md) - [SquareConnect.DeleteCatalogObjectRequest](docs/DeleteCatalogObjectRequest.md) - [SquareConnect.DeleteCatalogObjectResponse](docs/DeleteCatalogObjectResponse.md) - [SquareConnect.DeleteCustomerCardRequest](docs/DeleteCustomerCardRequest.md) - [SquareConnect.DeleteCustomerCardResponse](docs/DeleteCustomerCardResponse.md) - [SquareConnect.DeleteCustomerRequest](docs/DeleteCustomerRequest.md) - [SquareConnect.DeleteCustomerResponse](docs/DeleteCustomerResponse.md) + - [SquareConnect.DeleteShiftRequest](docs/DeleteShiftRequest.md) + - [SquareConnect.DeleteShiftResponse](docs/DeleteShiftResponse.md) - [SquareConnect.Device](docs/Device.md) + - [SquareConnect.Employee](docs/Employee.md) + - [SquareConnect.EmployeeStatus](docs/EmployeeStatus.md) + - [SquareConnect.EmployeeWage](docs/EmployeeWage.md) - [SquareConnect.Error](docs/Error.md) - [SquareConnect.ErrorCategory](docs/ErrorCategory.md) - [SquareConnect.ErrorCode](docs/ErrorCode.md) + - [SquareConnect.GetBreakTypeRequest](docs/GetBreakTypeRequest.md) + - [SquareConnect.GetBreakTypeResponse](docs/GetBreakTypeResponse.md) + - [SquareConnect.GetEmployeeWageRequest](docs/GetEmployeeWageRequest.md) + - [SquareConnect.GetEmployeeWageResponse](docs/GetEmployeeWageResponse.md) + - [SquareConnect.GetShiftRequest](docs/GetShiftRequest.md) + - [SquareConnect.GetShiftResponse](docs/GetShiftResponse.md) - [SquareConnect.InventoryAdjustment](docs/InventoryAdjustment.md) - [SquareConnect.InventoryAlertType](docs/InventoryAlertType.md) - [SquareConnect.InventoryChange](docs/InventoryChange.md) @@ -267,20 +302,29 @@ Class | Method | HTTP request | Description - [SquareConnect.ListAdditionalRecipientReceivableRefundsResponse](docs/ListAdditionalRecipientReceivableRefundsResponse.md) - [SquareConnect.ListAdditionalRecipientReceivablesRequest](docs/ListAdditionalRecipientReceivablesRequest.md) - [SquareConnect.ListAdditionalRecipientReceivablesResponse](docs/ListAdditionalRecipientReceivablesResponse.md) + - [SquareConnect.ListBreakTypesRequest](docs/ListBreakTypesRequest.md) + - [SquareConnect.ListBreakTypesResponse](docs/ListBreakTypesResponse.md) - [SquareConnect.ListCatalogRequest](docs/ListCatalogRequest.md) - [SquareConnect.ListCatalogResponse](docs/ListCatalogResponse.md) - [SquareConnect.ListCustomersRequest](docs/ListCustomersRequest.md) - [SquareConnect.ListCustomersResponse](docs/ListCustomersResponse.md) + - [SquareConnect.ListEmployeeWagesRequest](docs/ListEmployeeWagesRequest.md) + - [SquareConnect.ListEmployeeWagesResponse](docs/ListEmployeeWagesResponse.md) + - [SquareConnect.ListEmployeesRequest](docs/ListEmployeesRequest.md) + - [SquareConnect.ListEmployeesResponse](docs/ListEmployeesResponse.md) - [SquareConnect.ListLocationsRequest](docs/ListLocationsRequest.md) - [SquareConnect.ListLocationsResponse](docs/ListLocationsResponse.md) - [SquareConnect.ListRefundsRequest](docs/ListRefundsRequest.md) - [SquareConnect.ListRefundsResponse](docs/ListRefundsResponse.md) - [SquareConnect.ListTransactionsRequest](docs/ListTransactionsRequest.md) - [SquareConnect.ListTransactionsResponse](docs/ListTransactionsResponse.md) + - [SquareConnect.ListWorkweekConfigsRequest](docs/ListWorkweekConfigsRequest.md) + - [SquareConnect.ListWorkweekConfigsResponse](docs/ListWorkweekConfigsResponse.md) - [SquareConnect.Location](docs/Location.md) - [SquareConnect.LocationCapability](docs/LocationCapability.md) - [SquareConnect.LocationStatus](docs/LocationStatus.md) - [SquareConnect.LocationType](docs/LocationType.md) + - [SquareConnect.ModelBreak](docs/ModelBreak.md) - [SquareConnect.Money](docs/Money.md) - [SquareConnect.ObtainTokenRequest](docs/ObtainTokenRequest.md) - [SquareConnect.ObtainTokenResponse](docs/ObtainTokenResponse.md) @@ -311,6 +355,8 @@ Class | Method | HTTP request | Description - [SquareConnect.RetrieveCatalogObjectResponse](docs/RetrieveCatalogObjectResponse.md) - [SquareConnect.RetrieveCustomerRequest](docs/RetrieveCustomerRequest.md) - [SquareConnect.RetrieveCustomerResponse](docs/RetrieveCustomerResponse.md) + - [SquareConnect.RetrieveEmployeeRequest](docs/RetrieveEmployeeRequest.md) + - [SquareConnect.RetrieveEmployeeResponse](docs/RetrieveEmployeeResponse.md) - [SquareConnect.RetrieveInventoryAdjustmentRequest](docs/RetrieveInventoryAdjustmentRequest.md) - [SquareConnect.RetrieveInventoryAdjustmentResponse](docs/RetrieveInventoryAdjustmentResponse.md) - [SquareConnect.RetrieveInventoryChangesRequest](docs/RetrieveInventoryChangesRequest.md) @@ -327,6 +373,18 @@ Class | Method | HTTP request | Description - [SquareConnect.SearchCatalogObjectsResponse](docs/SearchCatalogObjectsResponse.md) - [SquareConnect.SearchCustomersRequest](docs/SearchCustomersRequest.md) - [SquareConnect.SearchCustomersResponse](docs/SearchCustomersResponse.md) + - [SquareConnect.SearchShiftsRequest](docs/SearchShiftsRequest.md) + - [SquareConnect.SearchShiftsResponse](docs/SearchShiftsResponse.md) + - [SquareConnect.Shift](docs/Shift.md) + - [SquareConnect.ShiftFilter](docs/ShiftFilter.md) + - [SquareConnect.ShiftFilterStatus](docs/ShiftFilterStatus.md) + - [SquareConnect.ShiftQuery](docs/ShiftQuery.md) + - [SquareConnect.ShiftSort](docs/ShiftSort.md) + - [SquareConnect.ShiftSortField](docs/ShiftSortField.md) + - [SquareConnect.ShiftStatus](docs/ShiftStatus.md) + - [SquareConnect.ShiftWage](docs/ShiftWage.md) + - [SquareConnect.ShiftWorkday](docs/ShiftWorkday.md) + - [SquareConnect.ShiftWorkdayMatcher](docs/ShiftWorkdayMatcher.md) - [SquareConnect.SortOrder](docs/SortOrder.md) - [SquareConnect.SourceApplication](docs/SourceApplication.md) - [SquareConnect.TaxCalculationPhase](docs/TaxCalculationPhase.md) @@ -340,55 +398,183 @@ Class | Method | HTTP request | Description - [SquareConnect.TimeRange](docs/TimeRange.md) - [SquareConnect.Transaction](docs/Transaction.md) - [SquareConnect.TransactionProduct](docs/TransactionProduct.md) + - [SquareConnect.UpdateBreakTypeRequest](docs/UpdateBreakTypeRequest.md) + - [SquareConnect.UpdateBreakTypeResponse](docs/UpdateBreakTypeResponse.md) - [SquareConnect.UpdateCustomerRequest](docs/UpdateCustomerRequest.md) - [SquareConnect.UpdateCustomerResponse](docs/UpdateCustomerResponse.md) - [SquareConnect.UpdateItemModifierListsRequest](docs/UpdateItemModifierListsRequest.md) - [SquareConnect.UpdateItemModifierListsResponse](docs/UpdateItemModifierListsResponse.md) - [SquareConnect.UpdateItemTaxesRequest](docs/UpdateItemTaxesRequest.md) - [SquareConnect.UpdateItemTaxesResponse](docs/UpdateItemTaxesResponse.md) + - [SquareConnect.UpdateShiftRequest](docs/UpdateShiftRequest.md) + - [SquareConnect.UpdateShiftResponse](docs/UpdateShiftResponse.md) + - [SquareConnect.UpdateWorkweekConfigRequest](docs/UpdateWorkweekConfigRequest.md) + - [SquareConnect.UpdateWorkweekConfigResponse](docs/UpdateWorkweekConfigResponse.md) - [SquareConnect.UpsertCatalogObjectRequest](docs/UpsertCatalogObjectRequest.md) - [SquareConnect.UpsertCatalogObjectResponse](docs/UpsertCatalogObjectResponse.md) - [SquareConnect.V1AdjustInventoryRequest](docs/V1AdjustInventoryRequest.md) + - [SquareConnect.V1AdjustInventoryRequestAdjustmentType](docs/V1AdjustInventoryRequestAdjustmentType.md) + - [SquareConnect.V1ApplyFeeRequest](docs/V1ApplyFeeRequest.md) + - [SquareConnect.V1ApplyModifierListRequest](docs/V1ApplyModifierListRequest.md) - [SquareConnect.V1BankAccount](docs/V1BankAccount.md) + - [SquareConnect.V1BankAccountType](docs/V1BankAccountType.md) - [SquareConnect.V1CashDrawerEvent](docs/V1CashDrawerEvent.md) + - [SquareConnect.V1CashDrawerEventEventType](docs/V1CashDrawerEventEventType.md) - [SquareConnect.V1CashDrawerShift](docs/V1CashDrawerShift.md) + - [SquareConnect.V1CashDrawerShiftEventType](docs/V1CashDrawerShiftEventType.md) - [SquareConnect.V1Category](docs/V1Category.md) + - [SquareConnect.V1CreateCategoryRequest](docs/V1CreateCategoryRequest.md) + - [SquareConnect.V1CreateDiscountRequest](docs/V1CreateDiscountRequest.md) + - [SquareConnect.V1CreateEmployeeRoleRequest](docs/V1CreateEmployeeRoleRequest.md) + - [SquareConnect.V1CreateFeeRequest](docs/V1CreateFeeRequest.md) + - [SquareConnect.V1CreateItemRequest](docs/V1CreateItemRequest.md) + - [SquareConnect.V1CreateModifierListRequest](docs/V1CreateModifierListRequest.md) + - [SquareConnect.V1CreateModifierOptionRequest](docs/V1CreateModifierOptionRequest.md) + - [SquareConnect.V1CreatePageRequest](docs/V1CreatePageRequest.md) - [SquareConnect.V1CreateRefundRequest](docs/V1CreateRefundRequest.md) + - [SquareConnect.V1CreateRefundRequestType](docs/V1CreateRefundRequestType.md) + - [SquareConnect.V1CreateVariationRequest](docs/V1CreateVariationRequest.md) + - [SquareConnect.V1DeleteCategoryRequest](docs/V1DeleteCategoryRequest.md) + - [SquareConnect.V1DeleteDiscountRequest](docs/V1DeleteDiscountRequest.md) + - [SquareConnect.V1DeleteFeeRequest](docs/V1DeleteFeeRequest.md) + - [SquareConnect.V1DeleteItemRequest](docs/V1DeleteItemRequest.md) + - [SquareConnect.V1DeleteModifierListRequest](docs/V1DeleteModifierListRequest.md) + - [SquareConnect.V1DeleteModifierOptionRequest](docs/V1DeleteModifierOptionRequest.md) + - [SquareConnect.V1DeletePageCellRequest](docs/V1DeletePageCellRequest.md) + - [SquareConnect.V1DeletePageRequest](docs/V1DeletePageRequest.md) + - [SquareConnect.V1DeleteTimecardRequest](docs/V1DeleteTimecardRequest.md) + - [SquareConnect.V1DeleteTimecardResponse](docs/V1DeleteTimecardResponse.md) + - [SquareConnect.V1DeleteVariationRequest](docs/V1DeleteVariationRequest.md) - [SquareConnect.V1Discount](docs/V1Discount.md) + - [SquareConnect.V1DiscountColor](docs/V1DiscountColor.md) + - [SquareConnect.V1DiscountDiscountType](docs/V1DiscountDiscountType.md) - [SquareConnect.V1Employee](docs/V1Employee.md) - [SquareConnect.V1EmployeeRole](docs/V1EmployeeRole.md) + - [SquareConnect.V1EmployeeRolePermissions](docs/V1EmployeeRolePermissions.md) + - [SquareConnect.V1EmployeeStatus](docs/V1EmployeeStatus.md) - [SquareConnect.V1Fee](docs/V1Fee.md) + - [SquareConnect.V1FeeAdjustmentType](docs/V1FeeAdjustmentType.md) + - [SquareConnect.V1FeeCalculationPhase](docs/V1FeeCalculationPhase.md) + - [SquareConnect.V1FeeInclusionType](docs/V1FeeInclusionType.md) + - [SquareConnect.V1FeeType](docs/V1FeeType.md) - [SquareConnect.V1InventoryEntry](docs/V1InventoryEntry.md) - [SquareConnect.V1Item](docs/V1Item.md) + - [SquareConnect.V1ItemColor](docs/V1ItemColor.md) - [SquareConnect.V1ItemImage](docs/V1ItemImage.md) + - [SquareConnect.V1ItemType](docs/V1ItemType.md) + - [SquareConnect.V1ItemVisibility](docs/V1ItemVisibility.md) + - [SquareConnect.V1ListBankAccountsRequest](docs/V1ListBankAccountsRequest.md) + - [SquareConnect.V1ListBankAccountsResponse](docs/V1ListBankAccountsResponse.md) + - [SquareConnect.V1ListCashDrawerShiftsRequest](docs/V1ListCashDrawerShiftsRequest.md) + - [SquareConnect.V1ListCashDrawerShiftsResponse](docs/V1ListCashDrawerShiftsResponse.md) + - [SquareConnect.V1ListCategoriesRequest](docs/V1ListCategoriesRequest.md) + - [SquareConnect.V1ListCategoriesResponse](docs/V1ListCategoriesResponse.md) + - [SquareConnect.V1ListDiscountsRequest](docs/V1ListDiscountsRequest.md) + - [SquareConnect.V1ListDiscountsResponse](docs/V1ListDiscountsResponse.md) + - [SquareConnect.V1ListEmployeeRolesRequest](docs/V1ListEmployeeRolesRequest.md) + - [SquareConnect.V1ListEmployeeRolesResponse](docs/V1ListEmployeeRolesResponse.md) + - [SquareConnect.V1ListEmployeesRequest](docs/V1ListEmployeesRequest.md) + - [SquareConnect.V1ListEmployeesRequestStatus](docs/V1ListEmployeesRequestStatus.md) + - [SquareConnect.V1ListEmployeesResponse](docs/V1ListEmployeesResponse.md) + - [SquareConnect.V1ListFeesRequest](docs/V1ListFeesRequest.md) + - [SquareConnect.V1ListFeesResponse](docs/V1ListFeesResponse.md) + - [SquareConnect.V1ListInventoryRequest](docs/V1ListInventoryRequest.md) + - [SquareConnect.V1ListInventoryResponse](docs/V1ListInventoryResponse.md) + - [SquareConnect.V1ListItemsRequest](docs/V1ListItemsRequest.md) + - [SquareConnect.V1ListItemsResponse](docs/V1ListItemsResponse.md) + - [SquareConnect.V1ListLocationsRequest](docs/V1ListLocationsRequest.md) + - [SquareConnect.V1ListLocationsResponse](docs/V1ListLocationsResponse.md) + - [SquareConnect.V1ListModifierListsRequest](docs/V1ListModifierListsRequest.md) + - [SquareConnect.V1ListModifierListsResponse](docs/V1ListModifierListsResponse.md) + - [SquareConnect.V1ListOrdersRequest](docs/V1ListOrdersRequest.md) + - [SquareConnect.V1ListOrdersResponse](docs/V1ListOrdersResponse.md) + - [SquareConnect.V1ListPagesRequest](docs/V1ListPagesRequest.md) + - [SquareConnect.V1ListPagesResponse](docs/V1ListPagesResponse.md) + - [SquareConnect.V1ListPaymentsRequest](docs/V1ListPaymentsRequest.md) + - [SquareConnect.V1ListPaymentsResponse](docs/V1ListPaymentsResponse.md) + - [SquareConnect.V1ListRefundsRequest](docs/V1ListRefundsRequest.md) + - [SquareConnect.V1ListRefundsResponse](docs/V1ListRefundsResponse.md) + - [SquareConnect.V1ListSettlementsRequest](docs/V1ListSettlementsRequest.md) + - [SquareConnect.V1ListSettlementsRequestStatus](docs/V1ListSettlementsRequestStatus.md) + - [SquareConnect.V1ListSettlementsResponse](docs/V1ListSettlementsResponse.md) + - [SquareConnect.V1ListTimecardEventsRequest](docs/V1ListTimecardEventsRequest.md) + - [SquareConnect.V1ListTimecardEventsResponse](docs/V1ListTimecardEventsResponse.md) + - [SquareConnect.V1ListTimecardsRequest](docs/V1ListTimecardsRequest.md) + - [SquareConnect.V1ListTimecardsResponse](docs/V1ListTimecardsResponse.md) - [SquareConnect.V1Merchant](docs/V1Merchant.md) + - [SquareConnect.V1MerchantAccountType](docs/V1MerchantAccountType.md) + - [SquareConnect.V1MerchantBusinessType](docs/V1MerchantBusinessType.md) - [SquareConnect.V1MerchantLocationDetails](docs/V1MerchantLocationDetails.md) - [SquareConnect.V1ModifierList](docs/V1ModifierList.md) + - [SquareConnect.V1ModifierListSelectionType](docs/V1ModifierListSelectionType.md) - [SquareConnect.V1ModifierOption](docs/V1ModifierOption.md) - [SquareConnect.V1Money](docs/V1Money.md) - [SquareConnect.V1Order](docs/V1Order.md) - [SquareConnect.V1OrderHistoryEntry](docs/V1OrderHistoryEntry.md) + - [SquareConnect.V1OrderHistoryEntryAction](docs/V1OrderHistoryEntryAction.md) + - [SquareConnect.V1OrderState](docs/V1OrderState.md) - [SquareConnect.V1Page](docs/V1Page.md) - [SquareConnect.V1PageCell](docs/V1PageCell.md) + - [SquareConnect.V1PageCellObjectType](docs/V1PageCellObjectType.md) + - [SquareConnect.V1PageCellPlaceholderType](docs/V1PageCellPlaceholderType.md) - [SquareConnect.V1Payment](docs/V1Payment.md) - [SquareConnect.V1PaymentDiscount](docs/V1PaymentDiscount.md) - [SquareConnect.V1PaymentItemDetail](docs/V1PaymentItemDetail.md) - [SquareConnect.V1PaymentItemization](docs/V1PaymentItemization.md) + - [SquareConnect.V1PaymentItemizationItemizationType](docs/V1PaymentItemizationItemizationType.md) - [SquareConnect.V1PaymentModifier](docs/V1PaymentModifier.md) - [SquareConnect.V1PaymentSurcharge](docs/V1PaymentSurcharge.md) + - [SquareConnect.V1PaymentSurchargeType](docs/V1PaymentSurchargeType.md) - [SquareConnect.V1PaymentTax](docs/V1PaymentTax.md) + - [SquareConnect.V1PaymentTaxInclusionType](docs/V1PaymentTaxInclusionType.md) - [SquareConnect.V1PhoneNumber](docs/V1PhoneNumber.md) - [SquareConnect.V1Refund](docs/V1Refund.md) + - [SquareConnect.V1RefundType](docs/V1RefundType.md) + - [SquareConnect.V1RemoveFeeRequest](docs/V1RemoveFeeRequest.md) + - [SquareConnect.V1RemoveModifierListRequest](docs/V1RemoveModifierListRequest.md) + - [SquareConnect.V1RetrieveBankAccountRequest](docs/V1RetrieveBankAccountRequest.md) + - [SquareConnect.V1RetrieveBusinessRequest](docs/V1RetrieveBusinessRequest.md) + - [SquareConnect.V1RetrieveCashDrawerShiftRequest](docs/V1RetrieveCashDrawerShiftRequest.md) + - [SquareConnect.V1RetrieveEmployeeRequest](docs/V1RetrieveEmployeeRequest.md) + - [SquareConnect.V1RetrieveEmployeeRoleRequest](docs/V1RetrieveEmployeeRoleRequest.md) + - [SquareConnect.V1RetrieveItemRequest](docs/V1RetrieveItemRequest.md) + - [SquareConnect.V1RetrieveModifierListRequest](docs/V1RetrieveModifierListRequest.md) + - [SquareConnect.V1RetrieveOrderRequest](docs/V1RetrieveOrderRequest.md) + - [SquareConnect.V1RetrievePaymentRequest](docs/V1RetrievePaymentRequest.md) + - [SquareConnect.V1RetrieveSettlementRequest](docs/V1RetrieveSettlementRequest.md) + - [SquareConnect.V1RetrieveTimecardRequest](docs/V1RetrieveTimecardRequest.md) - [SquareConnect.V1Settlement](docs/V1Settlement.md) - [SquareConnect.V1SettlementEntry](docs/V1SettlementEntry.md) + - [SquareConnect.V1SettlementEntryType](docs/V1SettlementEntryType.md) + - [SquareConnect.V1SettlementStatus](docs/V1SettlementStatus.md) - [SquareConnect.V1Tender](docs/V1Tender.md) + - [SquareConnect.V1TenderEntryMethod](docs/V1TenderEntryMethod.md) + - [SquareConnect.V1TenderType](docs/V1TenderType.md) - [SquareConnect.V1Timecard](docs/V1Timecard.md) - [SquareConnect.V1TimecardEvent](docs/V1TimecardEvent.md) + - [SquareConnect.V1TimecardEventEventType](docs/V1TimecardEventEventType.md) + - [SquareConnect.V1UpdateCategoryRequest](docs/V1UpdateCategoryRequest.md) + - [SquareConnect.V1UpdateDiscountRequest](docs/V1UpdateDiscountRequest.md) + - [SquareConnect.V1UpdateEmployeeRequest](docs/V1UpdateEmployeeRequest.md) + - [SquareConnect.V1UpdateEmployeeRoleRequest](docs/V1UpdateEmployeeRoleRequest.md) + - [SquareConnect.V1UpdateFeeRequest](docs/V1UpdateFeeRequest.md) + - [SquareConnect.V1UpdateItemRequest](docs/V1UpdateItemRequest.md) - [SquareConnect.V1UpdateModifierListRequest](docs/V1UpdateModifierListRequest.md) + - [SquareConnect.V1UpdateModifierListRequestSelectionType](docs/V1UpdateModifierListRequestSelectionType.md) + - [SquareConnect.V1UpdateModifierOptionRequest](docs/V1UpdateModifierOptionRequest.md) - [SquareConnect.V1UpdateOrderRequest](docs/V1UpdateOrderRequest.md) + - [SquareConnect.V1UpdateOrderRequestAction](docs/V1UpdateOrderRequestAction.md) + - [SquareConnect.V1UpdatePageCellRequest](docs/V1UpdatePageCellRequest.md) + - [SquareConnect.V1UpdatePageRequest](docs/V1UpdatePageRequest.md) + - [SquareConnect.V1UpdateTimecardRequest](docs/V1UpdateTimecardRequest.md) + - [SquareConnect.V1UpdateVariationRequest](docs/V1UpdateVariationRequest.md) - [SquareConnect.V1Variation](docs/V1Variation.md) + - [SquareConnect.V1VariationInventoryAlertType](docs/V1VariationInventoryAlertType.md) + - [SquareConnect.V1VariationPricingType](docs/V1VariationPricingType.md) - [SquareConnect.VoidTransactionRequest](docs/VoidTransactionRequest.md) - [SquareConnect.VoidTransactionResponse](docs/VoidTransactionResponse.md) + - [SquareConnect.Weekday](docs/Weekday.md) + - [SquareConnect.WorkweekConfig](docs/WorkweekConfig.md) ## Documentation for Authorization diff --git a/docs/AdditionalRecipient.md b/docs/AdditionalRecipient.md index af0777f..578eafe 100644 --- a/docs/AdditionalRecipient.md +++ b/docs/AdditionalRecipient.md @@ -1,5 +1,9 @@ # SquareConnect.AdditionalRecipient +### Description + +Represents an additional recipient (other than the merchant) receiving a portion of this tender. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/AdditionalRecipientReceivable.md b/docs/AdditionalRecipientReceivable.md index c9e4674..a236ae6 100644 --- a/docs/AdditionalRecipientReceivable.md +++ b/docs/AdditionalRecipientReceivable.md @@ -1,5 +1,9 @@ # SquareConnect.AdditionalRecipientReceivable +### Description + +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 ------------ | ------------- | ------------- | ------------- diff --git a/docs/AdditionalRecipientReceivableRefund.md b/docs/AdditionalRecipientReceivableRefund.md index 5571d01..6d1e677 100644 --- a/docs/AdditionalRecipientReceivableRefund.md +++ b/docs/AdditionalRecipientReceivableRefund.md @@ -1,5 +1,9 @@ # SquareConnect.AdditionalRecipientReceivableRefund +### Description + +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 ------------ | ------------- | ------------- | ------------- diff --git a/docs/Address.md b/docs/Address.md index ee36932..f051e26 100644 --- a/docs/Address.md +++ b/docs/Address.md @@ -1,5 +1,9 @@ # SquareConnect.Address +### Description + +Represents a physical address. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/BatchChangeInventoryRequest.md b/docs/BatchChangeInventoryRequest.md index ceb7c23..66cfbcc 100644 --- a/docs/BatchChangeInventoryRequest.md +++ b/docs/BatchChangeInventoryRequest.md @@ -1,5 +1,9 @@ # SquareConnect.BatchChangeInventoryRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/BatchChangeInventoryResponse.md b/docs/BatchChangeInventoryResponse.md index 2e48d47..8798a4d 100644 --- a/docs/BatchChangeInventoryResponse.md +++ b/docs/BatchChangeInventoryResponse.md @@ -1,5 +1,9 @@ # SquareConnect.BatchChangeInventoryResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/BatchDeleteCatalogObjectsRequest.md b/docs/BatchDeleteCatalogObjectsRequest.md index 397c0c6..9752d76 100644 --- a/docs/BatchDeleteCatalogObjectsRequest.md +++ b/docs/BatchDeleteCatalogObjectsRequest.md @@ -1,5 +1,9 @@ # SquareConnect.BatchDeleteCatalogObjectsRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/BatchDeleteCatalogObjectsResponse.md b/docs/BatchDeleteCatalogObjectsResponse.md index 7286619..4b36a97 100644 --- a/docs/BatchDeleteCatalogObjectsResponse.md +++ b/docs/BatchDeleteCatalogObjectsResponse.md @@ -1,5 +1,9 @@ # SquareConnect.BatchDeleteCatalogObjectsResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/BatchRetrieveCatalogObjectsRequest.md b/docs/BatchRetrieveCatalogObjectsRequest.md index 67639c3..baa726c 100644 --- a/docs/BatchRetrieveCatalogObjectsRequest.md +++ b/docs/BatchRetrieveCatalogObjectsRequest.md @@ -1,5 +1,9 @@ # SquareConnect.BatchRetrieveCatalogObjectsRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/BatchRetrieveCatalogObjectsResponse.md b/docs/BatchRetrieveCatalogObjectsResponse.md index 4684c65..93e78f3 100644 --- a/docs/BatchRetrieveCatalogObjectsResponse.md +++ b/docs/BatchRetrieveCatalogObjectsResponse.md @@ -1,5 +1,9 @@ # SquareConnect.BatchRetrieveCatalogObjectsResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/BatchRetrieveInventoryChangesRequest.md b/docs/BatchRetrieveInventoryChangesRequest.md index 984d691..5e4da4e 100644 --- a/docs/BatchRetrieveInventoryChangesRequest.md +++ b/docs/BatchRetrieveInventoryChangesRequest.md @@ -1,5 +1,9 @@ # SquareConnect.BatchRetrieveInventoryChangesRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -9,7 +13,7 @@ Name | Type | Description | Notes **states** | **[String]** | Filters `ADJUSTMENT` query results by [InventoryState](#type-inventorystate). Only applied when set. Default: unset. | [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] -**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 [Paginating results](#paginatingresults) for more information. | [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 [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/BatchRetrieveInventoryChangesResponse.md b/docs/BatchRetrieveInventoryChangesResponse.md index cdd8267..2d83aaa 100644 --- a/docs/BatchRetrieveInventoryChangesResponse.md +++ b/docs/BatchRetrieveInventoryChangesResponse.md @@ -1,10 +1,14 @@ # SquareConnect.BatchRetrieveInventoryChangesResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] **changes** | [**[InventoryChange]**](InventoryChange.md) | The current calculated inventory changes for the requested objects and locations. | [optional] -**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Paginating results](#paginatingresults) for more information. | [optional] +**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/BatchRetrieveInventoryCountsRequest.md b/docs/BatchRetrieveInventoryCountsRequest.md index 5dee1b6..19f8a92 100644 --- a/docs/BatchRetrieveInventoryCountsRequest.md +++ b/docs/BatchRetrieveInventoryCountsRequest.md @@ -1,11 +1,15 @@ # SquareConnect.BatchRetrieveInventoryCountsRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **catalog_object_ids** | **[String]** | Filters results by [CatalogObject](#type-catalogobject) ID. Only applied when set. Default: unset. | [optional] **location_ids** | **[String]** | Filters results by [Location](#type-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] -**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 [Paginating results](#paginatingresults) for more information. | [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 [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/BatchRetrieveInventoryCountsResponse.md b/docs/BatchRetrieveInventoryCountsResponse.md index 3ab8a19..5015600 100644 --- a/docs/BatchRetrieveInventoryCountsResponse.md +++ b/docs/BatchRetrieveInventoryCountsResponse.md @@ -1,10 +1,14 @@ # SquareConnect.BatchRetrieveInventoryCountsResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] **counts** | [**[InventoryCount]**](InventoryCount.md) | The current calculated inventory counts for the requested objects and locations. | [optional] -**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Paginating results](#paginatingresults) for more information. | [optional] +**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/BatchRetrieveOrdersRequest.md b/docs/BatchRetrieveOrdersRequest.md index 89a7d7e..78b3661 100644 --- a/docs/BatchRetrieveOrdersRequest.md +++ b/docs/BatchRetrieveOrdersRequest.md @@ -1,5 +1,9 @@ # SquareConnect.BatchRetrieveOrdersRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/BatchRetrieveOrdersResponse.md b/docs/BatchRetrieveOrdersResponse.md index d8594f1..5ac5ca1 100644 --- a/docs/BatchRetrieveOrdersResponse.md +++ b/docs/BatchRetrieveOrdersResponse.md @@ -1,5 +1,9 @@ # SquareConnect.BatchRetrieveOrdersResponse +### Description + +Defines the fields that are included in the response body of a request to the [BatchRetrieveOrders](#endpoint-batchretrieveorders) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/BatchUpsertCatalogObjectsRequest.md b/docs/BatchUpsertCatalogObjectsRequest.md index c68d6fb..fea5224 100644 --- a/docs/BatchUpsertCatalogObjectsRequest.md +++ b/docs/BatchUpsertCatalogObjectsRequest.md @@ -1,9 +1,13 @@ # SquareConnect.BatchUpsertCatalogObjectsRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**idempotency_key** | **String** | A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency keys](#idempotencykeys) for more information. | +**idempotency_key** | **String** | A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency](/basics/api101/idempotency) for more information. | **batches** | [**[CatalogObjectBatch]**](CatalogObjectBatch.md) | A batch of [CatalogObject](#type-catalogobject)s to be inserted/updated atomically. The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error in one batch will not affect other batches within the same request. For each object, its `updated_at` field is ignored and replaced with a current [timestamp](#workingwithdates), and its `is_deleted` field must not be set to `true`. To modify an existing object, supply its ID. To create a new object, use an ID starting with `#`. These IDs may be used to create relationships between an object and attributes of other objects that reference it. For example, you can create a [CatalogItem](#type-catalogitem) with ID `#ABC` and a [CatalogItemVariation](#type-catalogitemvariation) with its `item_id` attribute set to `#ABC` in order to associate the [CatalogItemVariation](#type-catalogitemvariation) with its parent [CatalogItem](#type-catalogitem). Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs. Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will be inserted or updated. | [optional] diff --git a/docs/BatchUpsertCatalogObjectsResponse.md b/docs/BatchUpsertCatalogObjectsResponse.md index e75337c..067d594 100644 --- a/docs/BatchUpsertCatalogObjectsResponse.md +++ b/docs/BatchUpsertCatalogObjectsResponse.md @@ -1,5 +1,9 @@ # SquareConnect.BatchUpsertCatalogObjectsResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/BreakType.md b/docs/BreakType.md new file mode 100644 index 0000000..96fbfcc --- /dev/null +++ b/docs/BreakType.md @@ -0,0 +1,19 @@ +# SquareConnect.BreakType + +### Description + +A defined break template that sets an expectation for possible `Break` instances on a `Shift`. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | UUID for this object. | [optional] +**location_id** | **String** | The ID of the business location this type of break applies to. | +**break_name** | **String** | A human-readable name for this type of break. Will be displayed to employees in Square products. | +**expected_duration** | **String** | Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of this break. Precision below minutes is truncated. | +**is_paid** | **Boolean** | Whether this break counts towards time worked for compensation purposes. | +**version** | **Number** | Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If a value is not provided, Square's servers execute a \"blind\" write; potentially overwriting another writer's data. | [optional] +**created_at** | **String** | A read-only timestamp in RFC 3339 format. | [optional] +**updated_at** | **String** | A read-only timestamp in RFC 3339 format. | [optional] + + diff --git a/docs/CaptureTransactionRequest.md b/docs/CaptureTransactionRequest.md index f02dcc4..7eee70b 100644 --- a/docs/CaptureTransactionRequest.md +++ b/docs/CaptureTransactionRequest.md @@ -1,5 +1,9 @@ # SquareConnect.CaptureTransactionRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CaptureTransactionResponse.md b/docs/CaptureTransactionResponse.md index 97c185e..d0da8ae 100644 --- a/docs/CaptureTransactionResponse.md +++ b/docs/CaptureTransactionResponse.md @@ -1,5 +1,9 @@ # SquareConnect.CaptureTransactionResponse +### Description + +Defines the fields that are included in the response body of a request to the [CaptureTransaction](#endpoint-capturetransaction) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Card.md b/docs/Card.md index a4a9a09..9193d7f 100644 --- a/docs/Card.md +++ b/docs/Card.md @@ -1,5 +1,9 @@ # SquareConnect.Card +### Description + +Represents the payment details of a card to be used for payments. These details are determined by the `card_nonce` generated by `SqPaymentForm`. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -10,7 +14,7 @@ Name | Type | Description | Notes **exp_year** | **Number** | The four-digit year of the card's expiration date. | [optional] **cardholder_name** | **String** | The name of the cardholder. | [optional] **billing_address** | [**Address**](Address.md) | The billing address for this card. | [optional] -**fingerprint** | **String** | __Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application. | [optional] +**fingerprint** | **String** | __Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application. | [optional] diff --git a/docs/CatalogApi.md b/docs/CatalogApi.md index 0941383..3cee9a3 100644 --- a/docs/CatalogApi.md +++ b/docs/CatalogApi.md @@ -271,7 +271,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new SquareConnect.CatalogApi(); var opts = { - 'cursor': "cursor_example", // String | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information. + 'cursor': "cursor_example", // String | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information. 'types': "types_example" // String | An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY`. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. }; apiInstance.listCatalog(opts).then(function(data) { @@ -286,7 +286,7 @@ apiInstance.listCatalog(opts).then(function(data) { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **cursor** | **String**| The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information. | [optional] + **cursor** | **String**| The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information. | [optional] **types** | **String**| An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY`. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. | [optional] ### Return type diff --git a/docs/CatalogCategory.md b/docs/CatalogCategory.md index 0465fde..129a0c1 100644 --- a/docs/CatalogCategory.md +++ b/docs/CatalogCategory.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogCategory +### Description + +A category to which an [CatalogItem](#type-catalogitem) belongs in the Catalog object model. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogDiscount.md b/docs/CatalogDiscount.md index f152a32..d68d065 100644 --- a/docs/CatalogDiscount.md +++ b/docs/CatalogDiscount.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogDiscount +### Description + +A discount in the Catalog object model. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogIdMapping.md b/docs/CatalogIdMapping.md index 8b93c78..03d2f92 100644 --- a/docs/CatalogIdMapping.md +++ b/docs/CatalogIdMapping.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogIdMapping +### Description + +A mapping between a client-supplied temporary ID and a permanent server ID. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogInfoRequest.md b/docs/CatalogInfoRequest.md index 46d8f63..c136c53 100644 --- a/docs/CatalogInfoRequest.md +++ b/docs/CatalogInfoRequest.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogInfoRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogInfoResponse.md b/docs/CatalogInfoResponse.md index 07a4455..46c5d83 100644 --- a/docs/CatalogInfoResponse.md +++ b/docs/CatalogInfoResponse.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogInfoResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogInfoResponseLimits.md b/docs/CatalogInfoResponseLimits.md index 9805368..3e98264 100644 --- a/docs/CatalogInfoResponseLimits.md +++ b/docs/CatalogInfoResponseLimits.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogInfoResponseLimits +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogItem.md b/docs/CatalogItem.md index 88e6f87..8c62372 100644 --- a/docs/CatalogItem.md +++ b/docs/CatalogItem.md @@ -1,11 +1,15 @@ # SquareConnect.CatalogItem +### Description + +An item (i.e., product family) in the Catalog object model. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The item's name. Searchable. This field must not be empty. This field has max length of 512 Unicode code points. | [optional] **description** | **String** | The item's description. Searchable. This field has max length of 4096 Unicode code points. | [optional] -**abbreviation** | **String** | The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used. Searchable. This field has max length of 24 Unicode code points. | [optional] +**abbreviation** | **String** | The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used. Searchable. This field has max length of 24 Unicode code points. | [optional] **label_color** | **String** | The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code. | [optional] **available_online** | **Boolean** | If `true`, the item can be added to shipping orders from the merchant's online store. | [optional] **available_for_pickup** | **Boolean** | If `true`, the item can be added to pickup orders from the merchant's online store. | [optional] diff --git a/docs/CatalogItemModifierListInfo.md b/docs/CatalogItemModifierListInfo.md index a30d428..52bbb81 100644 --- a/docs/CatalogItemModifierListInfo.md +++ b/docs/CatalogItemModifierListInfo.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogItemModifierListInfo +### Description + +Controls the properties of a [CatalogModifierList](#type-catalogmodifierlist) as it applies to this [CatalogItem](#type-catalogitem). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogItemVariation.md b/docs/CatalogItemVariation.md index c1fd8c8..96a345a 100644 --- a/docs/CatalogItemVariation.md +++ b/docs/CatalogItemVariation.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogItemVariation +### Description + +An item variation (i.e., product) in the Catalog object model. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -14,7 +18,7 @@ Name | Type | Description | Notes **track_inventory** | **Boolean** | If `true`, inventory tracking is active for the variation. | [optional] **inventory_alert_type** | **String** | Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for all possible values. | [optional] **inventory_alert_threshold** | **Number** | If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. This value is always an integer. | [optional] -**user_data** | **String** | Arbitrary user metadata to associate with the item variation. Searchable. This field has max length of 255 Unicode code points. | [optional] +**user_data** | **String** | Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable. | [optional] **service_duration** | **Number** | If the [CatalogItem](#type-catalogitem) that owns this item variation is of type `APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For example, a 30 minute appointment would have the value `1800000`, which is equal to 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second). | [optional] diff --git a/docs/CatalogModifier.md b/docs/CatalogModifier.md index 144523e..e22da7b 100644 --- a/docs/CatalogModifier.md +++ b/docs/CatalogModifier.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogModifier +### Description + +A modifier in the Catalog object model. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogModifierList.md b/docs/CatalogModifierList.md index f70f65a..f20961b 100644 --- a/docs/CatalogModifierList.md +++ b/docs/CatalogModifierList.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogModifierList +### Description + +A modifier list in the Catalog object model. A [CatalogModifierList](#type-catalogmodifierlist) contains [Modifier](#type-catalogmodifier)s that can be applied to a [CatalogItem](#type-catalogitem) at the time of sale. For example, a modifier list \"Condiments\" that would apply to a \"Hot Dog\" [CatalogItem](#type-catalogitem) might contain [CatalogModifier](#type-catalogmodifier)s \"Ketchup\", \"Mustard\", and \"Relish\". The `selection_type` field specifies whether or not multiple selections from the modifier list are allowed. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogModifierOverride.md b/docs/CatalogModifierOverride.md index d45ef3b..b2bae25 100644 --- a/docs/CatalogModifierOverride.md +++ b/docs/CatalogModifierOverride.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogModifierOverride +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogObject.md b/docs/CatalogObject.md index ff9787a..a3dc6e7 100644 --- a/docs/CatalogObject.md +++ b/docs/CatalogObject.md @@ -1,12 +1,16 @@ # SquareConnect.CatalogObject +### Description + +The wrapper object for object types in the Catalog data model. The type of a particular `CatalogObject` is determined by the value of `type` and only the corresponding data field may be set. - if type = `ITEM`, only `item_data` will be populated and it will contain a valid [CatalogItem](#type-catalogitem) object. - if type = `ITEM_VARIATION`, only `item_variation_data` will be populated and it will contain a valid [CatalogItemVariation](#type-catalogitemvariation) object. - if type = `MODIFIER`, only `modifier_data` will be populated and it will contain a valid [CatalogModifier](#type-catalogmodifier) object. - if type = `MODIFIER_LIST`, only `modifier_list_data` will be populated and it will contain a valid [CatalogModifierList](#type-catalogmodifierlist) object. - if type = `CATEGORY`, only `category_data` will be populated and it will contain a valid [CatalogCategory](#type-catalogcategory) object. - if type = `DISCOUNT`, only `discount_data` will be populated and it will contain a valid [CatalogDiscount](#type-catalogdiscount) object. - if type = `TAX`, only `tax_data` will be populated and it will contain a valid [CatalogTax](#type-catalogtax) object. For a more detailed discussion of the Catalog data model, please see the [Catalog Overview](/products/catalog/overview). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **type** | **String** | The type of this object. Each object type has expected properties expressed in a structured format within its corresponding `*_data` field below. See [CatalogObjectType](#type-catalogobjecttype) for all possible values. | **id** | **String** | An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. | **updated_at** | **String** | Last modification [timestamp](#workingwithdates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. | [optional] -**version** | **Number** | The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting. | [optional] +**version** | **Number** | The version of the object. When updating an object, the version supplied by the must match the version in the database, otherwise the write will be rejected as conflicting. | [optional] **is_deleted** | **Boolean** | If `true`, the object has been deleted from the database. Must be `false` for new objects being inserted. When deleted, the `updated_at` field will equal the deletion time. | [optional] **catalog_v1_ids** | [**[CatalogV1Id]**](CatalogV1Id.md) | The Connect V1 IDs for this object at each [location](#type-location) where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. | [optional] **present_at_all_locations** | **Boolean** | If `true`, this object is present at all locations (including future locations), except where specified in the `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations), except where specified in the `present_at_location_ids` field. If not specified, defaults to `true`. | [optional] diff --git a/docs/CatalogObjectBatch.md b/docs/CatalogObjectBatch.md index 228233d..3a8dd3f 100644 --- a/docs/CatalogObjectBatch.md +++ b/docs/CatalogObjectBatch.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogObjectBatch +### Description + +A batch of [CatalogObject](#type-catalogobject)s. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogQuery.md b/docs/CatalogQuery.md index 7edc7d3..a8a4d69 100644 --- a/docs/CatalogQuery.md +++ b/docs/CatalogQuery.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogQuery +### Description + +A query to be applied to a SearchCatalogObjects request. Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) ([CatalogItem](#type-catalogitem), [CatalogItemVariation](#type-catalogitemvariation), [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax), [CatalogDiscount](#type-catalogdiscount), [CatalogModifierList](#type-catalogmodifierlist), [CatalogModifier](#type-catalogmodifier)). For example, a query that should return Items may specify attribute names from any of the searchable fields of the [CatalogItem](#type-catalogitem) data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogQueryExact.md b/docs/CatalogQueryExact.md index ec27cae..a792aec 100644 --- a/docs/CatalogQueryExact.md +++ b/docs/CatalogQueryExact.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogQueryExact +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogQueryItemsForModifierList.md b/docs/CatalogQueryItemsForModifierList.md index d12c5bb..092ee0d 100644 --- a/docs/CatalogQueryItemsForModifierList.md +++ b/docs/CatalogQueryItemsForModifierList.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogQueryItemsForModifierList +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogQueryItemsForTax.md b/docs/CatalogQueryItemsForTax.md index aec27ef..aad6018 100644 --- a/docs/CatalogQueryItemsForTax.md +++ b/docs/CatalogQueryItemsForTax.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogQueryItemsForTax +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogQueryPrefix.md b/docs/CatalogQueryPrefix.md index fdef537..c113964 100644 --- a/docs/CatalogQueryPrefix.md +++ b/docs/CatalogQueryPrefix.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogQueryPrefix +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogQueryRange.md b/docs/CatalogQueryRange.md index 59d34d9..ffa2ac9 100644 --- a/docs/CatalogQueryRange.md +++ b/docs/CatalogQueryRange.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogQueryRange +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogQuerySortedAttribute.md b/docs/CatalogQuerySortedAttribute.md index 671440b..7f6bf3b 100644 --- a/docs/CatalogQuerySortedAttribute.md +++ b/docs/CatalogQuerySortedAttribute.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogQuerySortedAttribute +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogQueryText.md b/docs/CatalogQueryText.md index b01f802..ad11da0 100644 --- a/docs/CatalogQueryText.md +++ b/docs/CatalogQueryText.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogQueryText +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogTax.md b/docs/CatalogTax.md index e3915e1..b846ccd 100644 --- a/docs/CatalogTax.md +++ b/docs/CatalogTax.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogTax +### Description + +A tax in the Catalog object model. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CatalogV1Id.md b/docs/CatalogV1Id.md index 32314d5..37faa65 100644 --- a/docs/CatalogV1Id.md +++ b/docs/CatalogV1Id.md @@ -1,5 +1,9 @@ # SquareConnect.CatalogV1Id +### Description + +An Items Connect V1 object ID along with its associated [location](#type-location) ID. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ChargeRequest.md b/docs/ChargeRequest.md index eee1ca7..af46892 100644 --- a/docs/ChargeRequest.md +++ b/docs/ChargeRequest.md @@ -1,9 +1,13 @@ # SquareConnect.ChargeRequest +### Description + +Defines the parameters that can be included in the body of a request to the [Charge](#endpoint-charge) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**idempotency_key** | **String** | A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency keys](#idempotencykeys) for more information. | +**idempotency_key** | **String** | A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency](/basics/api101/idempotency) for more information. | **amount_money** | [**Money**](Money.md) | The amount of money to charge. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](#workingwithmonetaryamounts) for details. The value of `currency` must match the currency associated with the business that is charging the card. | **card_nonce** | **String** | A nonce generated from the `SqPaymentForm` that represents the card to charge. The application that provides a nonce to this endpoint must be the _same application_ that generated the nonce with the `SqPaymentForm`. Otherwise, the nonce is invalid. Do not provide a value for this field if you provide a value for `customer_card_id`. | [optional] **customer_card_id** | **String** | The ID of the customer card on file to charge. Do not provide a value for this field if you provide a value for `card_nonce`. If you provide this value, you _must_ also provide a value for `customer_id`. | [optional] diff --git a/docs/ChargeRequestAdditionalRecipient.md b/docs/ChargeRequestAdditionalRecipient.md index 09645aa..e6bf6c1 100644 --- a/docs/ChargeRequestAdditionalRecipient.md +++ b/docs/ChargeRequestAdditionalRecipient.md @@ -1,5 +1,9 @@ # SquareConnect.ChargeRequestAdditionalRecipient +### Description + +Represents an additional recipient (other than the merchant) entitled to a portion of the tender. Support is currently limited to USD, CAD and GBP currencies + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ChargeResponse.md b/docs/ChargeResponse.md index 74bf88e..d0b98fc 100644 --- a/docs/ChargeResponse.md +++ b/docs/ChargeResponse.md @@ -1,5 +1,9 @@ # SquareConnect.ChargeResponse +### Description + +Defines the fields that are included in the response body of a request to the [Charge](#endpoint-charge) endpoint. One of `errors` or `transaction` is present in a given response (never both). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Checkout.md b/docs/Checkout.md index b609a37..395024a 100644 --- a/docs/Checkout.md +++ b/docs/Checkout.md @@ -1,5 +1,9 @@ # SquareConnect.Checkout +### Description + +Square Checkout lets merchants accept online payments for supported payment types using a checkout workflow hosted on squareup.com. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CreateBreakTypeRequest.md b/docs/CreateBreakTypeRequest.md new file mode 100644 index 0000000..029d09a --- /dev/null +++ b/docs/CreateBreakTypeRequest.md @@ -0,0 +1,13 @@ +# SquareConnect.CreateBreakTypeRequest + +### Description + +A request to create a new `BreakType` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**idempotency_key** | **String** | Unique string value to insure idempotency of the operation | [optional] +**break_type** | [**BreakType**](BreakType.md) | The `BreakType` to be created. | + + diff --git a/docs/CreateBreakTypeResponse.md b/docs/CreateBreakTypeResponse.md new file mode 100644 index 0000000..a9db403 --- /dev/null +++ b/docs/CreateBreakTypeResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.CreateBreakTypeResponse + +### Description + +The response to the request to create a `BreakType`. Contains the created `BreakType` object. May contain a set of `Error` objects if the request resulted in errors. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**break_type** | [**BreakType**](BreakType.md) | The `BreakType` that was created by the request. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/CreateCheckoutRequest.md b/docs/CreateCheckoutRequest.md index 29b7390..37bd1a2 100644 --- a/docs/CreateCheckoutRequest.md +++ b/docs/CreateCheckoutRequest.md @@ -1,9 +1,13 @@ # SquareConnect.CreateCheckoutRequest +### Description + +Defines the parameters that can be included in the body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**idempotency_key** | **String** | A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency keys](#idempotencykeys) for more information. | +**idempotency_key** | **String** | A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency](/basics/api101/idempotency) for more information. | **order** | [**CreateOrderRequest**](CreateOrderRequest.md) | The order including line items to be checked out. | **ask_for_shipping_address** | **Boolean** | If `true`, Square Checkout will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard. Default: `false`. | [optional] **merchant_support_email** | **String** | The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the merchant. If this value is not set, the confirmation page and email will display the primary email address associated with the merchant's Square account. Default: none; only exists if explicitly set. | [optional] diff --git a/docs/CreateCheckoutResponse.md b/docs/CreateCheckoutResponse.md index 441239f..5634e3a 100644 --- a/docs/CreateCheckoutResponse.md +++ b/docs/CreateCheckoutResponse.md @@ -1,5 +1,9 @@ # SquareConnect.CreateCheckoutResponse +### Description + +Defines the fields that are included in the response body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CreateCustomerCardRequest.md b/docs/CreateCustomerCardRequest.md index 12fc8ba..0bf7273 100644 --- a/docs/CreateCustomerCardRequest.md +++ b/docs/CreateCustomerCardRequest.md @@ -1,5 +1,9 @@ # SquareConnect.CreateCustomerCardRequest +### Description + +Defines the fields that are included in the request body of a request to the [CreateCustomerCard](#endpoint-createcustomercard) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CreateCustomerCardResponse.md b/docs/CreateCustomerCardResponse.md index 23ccad7..1f81880 100644 --- a/docs/CreateCustomerCardResponse.md +++ b/docs/CreateCustomerCardResponse.md @@ -1,5 +1,9 @@ # SquareConnect.CreateCustomerCardResponse +### Description + +Defines the fields that are included in the response body of a request to the [CreateCustomerCard](#endpoint-createcustomercard) endpoint. One of `errors` or `card` is present in a given response (never both). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CreateCustomerRequest.md b/docs/CreateCustomerRequest.md index 4ce6322..36e388d 100644 --- a/docs/CreateCustomerRequest.md +++ b/docs/CreateCustomerRequest.md @@ -1,5 +1,9 @@ # SquareConnect.CreateCustomerRequest +### Description + +Defines the body parameters that can be provided in a request to the [CreateCustomer](#endpoint-createcustomer) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CreateCustomerResponse.md b/docs/CreateCustomerResponse.md index d2972f8..f4fec77 100644 --- a/docs/CreateCustomerResponse.md +++ b/docs/CreateCustomerResponse.md @@ -1,5 +1,9 @@ # SquareConnect.CreateCustomerResponse +### Description + +Defines the fields that are included in the response body of a request to the [CreateCustomer](#endpoint-createcustomer) endpoint. One of `errors` or `customer` is present in a given response (never both). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CreateMobileAuthorizationCodeRequest.md b/docs/CreateMobileAuthorizationCodeRequest.md index d6142a4..08a9d36 100644 --- a/docs/CreateMobileAuthorizationCodeRequest.md +++ b/docs/CreateMobileAuthorizationCodeRequest.md @@ -1,5 +1,9 @@ # SquareConnect.CreateMobileAuthorizationCodeRequest +### Description + +Defines the body parameters that can be provided in a request to the [CreateMobileAuthorizationCode](#endpoint-createmobileauthorizationcode) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CreateMobileAuthorizationCodeResponse.md b/docs/CreateMobileAuthorizationCodeResponse.md index 1d4530a..b9b1488 100644 --- a/docs/CreateMobileAuthorizationCodeResponse.md +++ b/docs/CreateMobileAuthorizationCodeResponse.md @@ -1,5 +1,9 @@ # SquareConnect.CreateMobileAuthorizationCodeResponse +### Description + +Defines the fields that are included in the response body of a request to the [CreateMobileAuthorizationCode](#endpoint-createmobileauthorizationcode) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CreateOrderRequest.md b/docs/CreateOrderRequest.md index 465de11..e070eea 100644 --- a/docs/CreateOrderRequest.md +++ b/docs/CreateOrderRequest.md @@ -1,10 +1,14 @@ # SquareConnect.CreateOrderRequest +### Description + + + ## Properties 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] -**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 keys](#idempotencykeys) for more information. | [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](/basics/api101/idempotency) for more information. | [optional] **reference_id** | **String** | __Deprecated__: Please set the reference_id on the nested [order](#type-order) field instead. An optional ID you can associate with the order for your own purposes (such as to associate the order with an entity ID in your own database). This value cannot exceed 40 characters. | [optional] **line_items** | [**[CreateOrderRequestLineItem]**](CreateOrderRequestLineItem.md) | __Deprecated__: Please set the line_items on the nested [order](#type-order) field instead. The line items to associate with this order. Each line item represents a different product to include in a purchase. | [optional] **taxes** | [**[CreateOrderRequestTax]**](CreateOrderRequestTax.md) | __Deprecated__: Please set the taxes on the nested [order](#type-order) field instead. The taxes to include on the order. | [optional] diff --git a/docs/CreateOrderRequestDiscount.md b/docs/CreateOrderRequestDiscount.md index d93059c..bb19d99 100644 --- a/docs/CreateOrderRequestDiscount.md +++ b/docs/CreateOrderRequestDiscount.md @@ -1,5 +1,9 @@ # SquareConnect.CreateOrderRequestDiscount +### Description + +__Deprecated__: Please use the [OrderLineItemDiscount](#type-orderlineitemdiscount) type in the order field of [CreateOrderRequest](#type-createorderrequest) instead. Represents a discount that can apply to either a single line item or an entire order. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CreateOrderRequestLineItem.md b/docs/CreateOrderRequestLineItem.md index c2d07ca..2048072 100644 --- a/docs/CreateOrderRequestLineItem.md +++ b/docs/CreateOrderRequestLineItem.md @@ -1,5 +1,9 @@ # SquareConnect.CreateOrderRequestLineItem +### Description + +__Deprecated__: Please use the [OrderLineItem](#type-orderlineitem) type in the order field of [CreateOrderRequest](#type-createorderrequest) instead. Represents a line item to include in an order. Each line item describes a different product to purchase, with its own quantity and price details. Line items can either reference objects from the merchant's catalog, or can alternatively specify a name and price instead. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CreateOrderRequestModifier.md b/docs/CreateOrderRequestModifier.md index 19b9298..a45ed71 100644 --- a/docs/CreateOrderRequestModifier.md +++ b/docs/CreateOrderRequestModifier.md @@ -1,5 +1,9 @@ # SquareConnect.CreateOrderRequestModifier +### Description + +__Deprecated__: Please use the [OrderLineItemModifier](#type-orderlineitemmodifier) type instead. Represents a modifier applied to a single line item. Modifiers can reference existing objects in a merchant catalog or be constructed ad hoc at the time of purchase by providing a name and price. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CreateOrderRequestTax.md b/docs/CreateOrderRequestTax.md index a9a7242..a25486f 100644 --- a/docs/CreateOrderRequestTax.md +++ b/docs/CreateOrderRequestTax.md @@ -1,5 +1,9 @@ # SquareConnect.CreateOrderRequestTax +### Description + +__Deprecated__: Please use the [OrderLineItemTax](#type-orderlineitemtax) type in the order field of [CreateOrderRequest](#type-createorderrequest) instead. Represents a tax that can apply to either a single line item or an entire order. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CreateOrderResponse.md b/docs/CreateOrderResponse.md index e90294c..461427b 100644 --- a/docs/CreateOrderResponse.md +++ b/docs/CreateOrderResponse.md @@ -1,5 +1,9 @@ # SquareConnect.CreateOrderResponse +### Description + +Defines the fields that are included in the response body of a request to the [CreateOrder](#endpoint-createorder) endpoint. One of `errors` or `order` is present in a given response (never both). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CreateRefundRequest.md b/docs/CreateRefundRequest.md index f289d2b..497eccc 100644 --- a/docs/CreateRefundRequest.md +++ b/docs/CreateRefundRequest.md @@ -1,9 +1,13 @@ # SquareConnect.CreateRefundRequest +### Description + +Defines the body parameters that can be included in a request to the [CreateRefund](#endpoint-createrefund) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**idempotency_key** | **String** | A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency keys](#idempotencykeys) for more information. | +**idempotency_key** | **String** | A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency](/basics/api101/idempotency) for more information. | **tender_id** | **String** | The ID of the tender to refund. A [`Transaction`](#type-transaction) has one or more `tenders` (i.e., methods of payment) associated with it, and you refund each tender separately with the Connect API. | **reason** | **String** | A description of the reason for the refund. Default value: `Refund via API` | [optional] **amount_money** | [**Money**](Money.md) | The amount of money to refund. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](#workingwithmonetaryamounts) for details. This amount cannot exceed the amount that was originally charged to the tender that corresponds to `tender_id`. | diff --git a/docs/CreateRefundResponse.md b/docs/CreateRefundResponse.md index 844bf82..6bbd4b3 100644 --- a/docs/CreateRefundResponse.md +++ b/docs/CreateRefundResponse.md @@ -1,5 +1,9 @@ # SquareConnect.CreateRefundResponse +### Description + +Defines the fields that are included in the response body of a request to the [CreateRefund](#endpoint-createrefund) endpoint. One of `errors` or `refund` is present in a given response (never both). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CreateShiftRequest.md b/docs/CreateShiftRequest.md new file mode 100644 index 0000000..75bce4c --- /dev/null +++ b/docs/CreateShiftRequest.md @@ -0,0 +1,13 @@ +# SquareConnect.CreateShiftRequest + +### Description + +Represents a request to create a `Shift` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**idempotency_key** | **String** | Unique string value to insure the idempotency of the operation. | [optional] +**shift** | [**Shift**](Shift.md) | The `Shift` to be created | + + diff --git a/docs/CreateShiftResponse.md b/docs/CreateShiftResponse.md new file mode 100644 index 0000000..766f340 --- /dev/null +++ b/docs/CreateShiftResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.CreateShiftResponse + +### Description + +The response to the request to create a `Shift`. Contains the created `Shift` object. May contain a set of `Error` objects if the request resulted in errors. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shift** | [**Shift**](Shift.md) | The `Shift` that was created on the request. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/Customer.md b/docs/Customer.md index 31d586e..638797a 100644 --- a/docs/Customer.md +++ b/docs/Customer.md @@ -1,5 +1,9 @@ # SquareConnect.Customer +### Description + +Represents one of a business's customers, which can have one or more cards on file associated with it. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CustomerCreationSourceFilter.md b/docs/CustomerCreationSourceFilter.md index 7244ea9..4d0cff8 100644 --- a/docs/CustomerCreationSourceFilter.md +++ b/docs/CustomerCreationSourceFilter.md @@ -1,5 +1,9 @@ # SquareConnect.CustomerCreationSourceFilter +### Description + +Creation source filter. If one or more creation sources are set, customer profiles are included in, or excluded from, the result if they match at least one of the filter criteria. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CustomerFilter.md b/docs/CustomerFilter.md index 372cc5b..e926c15 100644 --- a/docs/CustomerFilter.md +++ b/docs/CustomerFilter.md @@ -1,5 +1,9 @@ # SquareConnect.CustomerFilter +### Description + +Represents a set of [`CustomerQuery`](#type-customerquery) filters used to limit the set of Customers returned by [`SearchCustomers`](#endpoint-seachcustomers). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CustomerGroupInfo.md b/docs/CustomerGroupInfo.md index 8edc891..801b2b9 100644 --- a/docs/CustomerGroupInfo.md +++ b/docs/CustomerGroupInfo.md @@ -1,5 +1,9 @@ # SquareConnect.CustomerGroupInfo +### Description + +Contains some brief information about a customer group with its identifier included. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CustomerPreferences.md b/docs/CustomerPreferences.md index 0b0624c..ef5b4c6 100644 --- a/docs/CustomerPreferences.md +++ b/docs/CustomerPreferences.md @@ -1,5 +1,9 @@ # SquareConnect.CustomerPreferences +### Description + +Represents a particular customer's preferences. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CustomerQuery.md b/docs/CustomerQuery.md index 9e33a93..0044d66 100644 --- a/docs/CustomerQuery.md +++ b/docs/CustomerQuery.md @@ -1,5 +1,9 @@ # SquareConnect.CustomerQuery +### Description + +Represents a query (filtering and sorting criteria) used to search for customer profiles. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CustomerSort.md b/docs/CustomerSort.md index 6f43839..5f80a24 100644 --- a/docs/CustomerSort.md +++ b/docs/CustomerSort.md @@ -1,5 +1,9 @@ # SquareConnect.CustomerSort +### Description + +Indicates the field to use for sorting customer profiles. For example, by total money spent with the merchant or the date of their first purchase. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/CustomersApi.md b/docs/CustomersApi.md index 726dab2..0b0d1e9 100644 --- a/docs/CustomersApi.md +++ b/docs/CustomersApi.md @@ -232,7 +232,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new SquareConnect.CustomersApi(); var opts = { - '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. + '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 [Pagination](/basics/api101/pagination) for more information. 'sortField': "sortField_example", // String | Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values. 'sortOrder': "sortOrder_example" // String | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values. }; @@ -248,7 +248,7 @@ apiInstance.listCustomers(opts).then(function(data) { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **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] + **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 [Pagination](/basics/api101/pagination) for more information. | [optional] **sortField** | **String**| Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values. | [optional] **sortOrder** | **String**| Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values. | [optional] diff --git a/docs/DateRange.md b/docs/DateRange.md new file mode 100644 index 0000000..ca2ca77 --- /dev/null +++ b/docs/DateRange.md @@ -0,0 +1,13 @@ +# SquareConnect.DateRange + +### Description + +A range defined by two dates. Used for filtering a query for Connect v2 objects that have date properties. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**start_date** | **String** | String in `YYYY-MM-DD` format, e.g. `2017-10-31` per the ISO 8601 extended format for calendar dates. The beginning of a date range (inclusive) | [optional] +**end_date** | **String** | String in `YYYY-MM-DD` format, e.g. `2017-10-31` per the ISO 8601 extended format for calendar dates. The end of a date range (inclusive) | [optional] + + diff --git a/docs/DeleteBreakTypeRequest.md b/docs/DeleteBreakTypeRequest.md new file mode 100644 index 0000000..d24a633 --- /dev/null +++ b/docs/DeleteBreakTypeRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.DeleteBreakTypeRequest + +### Description + +A request to delete a `BreakType` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/DeleteBreakTypeResponse.md b/docs/DeleteBreakTypeResponse.md new file mode 100644 index 0000000..bcea5dd --- /dev/null +++ b/docs/DeleteBreakTypeResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.DeleteBreakTypeResponse + +### Description + +The response to a request to delete a `BreakType`. May contain a set of `Error` objects if the request resulted in errors. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/DeleteCatalogObjectRequest.md b/docs/DeleteCatalogObjectRequest.md index 6ff9397..8d5eb57 100644 --- a/docs/DeleteCatalogObjectRequest.md +++ b/docs/DeleteCatalogObjectRequest.md @@ -1,5 +1,9 @@ # SquareConnect.DeleteCatalogObjectRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/DeleteCatalogObjectResponse.md b/docs/DeleteCatalogObjectResponse.md index 1b1daca..04a42d3 100644 --- a/docs/DeleteCatalogObjectResponse.md +++ b/docs/DeleteCatalogObjectResponse.md @@ -1,5 +1,9 @@ # SquareConnect.DeleteCatalogObjectResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/DeleteCustomerCardRequest.md b/docs/DeleteCustomerCardRequest.md index c8f0e2a..95bfccb 100644 --- a/docs/DeleteCustomerCardRequest.md +++ b/docs/DeleteCustomerCardRequest.md @@ -1,5 +1,9 @@ # SquareConnect.DeleteCustomerCardRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/DeleteCustomerCardResponse.md b/docs/DeleteCustomerCardResponse.md index 2625f2a..fe4efb7 100644 --- a/docs/DeleteCustomerCardResponse.md +++ b/docs/DeleteCustomerCardResponse.md @@ -1,5 +1,9 @@ # SquareConnect.DeleteCustomerCardResponse +### Description + +Defines the fields that are included in the response body of a request to the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/DeleteCustomerRequest.md b/docs/DeleteCustomerRequest.md index 525195a..4a09e36 100644 --- a/docs/DeleteCustomerRequest.md +++ b/docs/DeleteCustomerRequest.md @@ -1,5 +1,9 @@ # SquareConnect.DeleteCustomerRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/DeleteCustomerResponse.md b/docs/DeleteCustomerResponse.md index 425e242..e667914 100644 --- a/docs/DeleteCustomerResponse.md +++ b/docs/DeleteCustomerResponse.md @@ -1,5 +1,9 @@ # SquareConnect.DeleteCustomerResponse +### Description + +Defines the fields that are included in the response body of a request to the [DeleteCustomer](#endpoint-deletecustomer) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/DeleteShiftRequest.md b/docs/DeleteShiftRequest.md new file mode 100644 index 0000000..4c3e145 --- /dev/null +++ b/docs/DeleteShiftRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.DeleteShiftRequest + +### Description + +A request to delete a `Shift` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/DeleteShiftResponse.md b/docs/DeleteShiftResponse.md new file mode 100644 index 0000000..2a66e69 --- /dev/null +++ b/docs/DeleteShiftResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.DeleteShiftResponse + +### Description + +The response to a request to delete a `Shift`. May contain a set of `Error` objects if the request resulted in errors. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/Device.md b/docs/Device.md index 930169c..307bd51 100644 --- a/docs/Device.md +++ b/docs/Device.md @@ -1,5 +1,9 @@ # SquareConnect.Device +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Employee.md b/docs/Employee.md new file mode 100644 index 0000000..de90042 --- /dev/null +++ b/docs/Employee.md @@ -0,0 +1,29 @@ +# SquareConnect.Employee + +### Description + +An employee created in the **Square Dashboard** account of a business. Used by the Labor API. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | UUID for this `Employee`. | [optional] +**first_name** | **String** | Given (first) name of the employee. | [optional] +**last_name** | **String** | Family (last) name of the employee | [optional] +**location_ids** | **[String]** | A list of location IDs where this employee has access. | [optional] +**status** | **String** | Specifies the status of the employee being fetched. | [optional] +**created_at** | **String** | A read-only timestamp in RFC 3339 format. | [optional] +**updated_at** | **String** | A read-only timestamp in RFC 3339 format. | [optional] + + + +## Enum: StatusEnum + + +* `ACTIVE` (value: `"ACTIVE"`) + +* `INACTIVE` (value: `"INACTIVE"`) + + + + diff --git a/docs/EmployeeStatus.md b/docs/EmployeeStatus.md new file mode 100644 index 0000000..f273c4e --- /dev/null +++ b/docs/EmployeeStatus.md @@ -0,0 +1,10 @@ +# SquareConnect.EmployeeStatus + +## Enum + + +* `ACTIVE` (value: `"ACTIVE"`) + +* `INACTIVE` (value: `"INACTIVE"`) + + diff --git a/docs/EmployeeWage.md b/docs/EmployeeWage.md new file mode 100644 index 0000000..0b4a88e --- /dev/null +++ b/docs/EmployeeWage.md @@ -0,0 +1,15 @@ +# SquareConnect.EmployeeWage + +### Description + +The hourly wage rate that an employee 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] +**employee_id** | **String** | The `Employee` that this wage is assigned to. | +**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 new file mode 100644 index 0000000..ffb590c --- /dev/null +++ b/docs/EmployeesApi.md @@ -0,0 +1,113 @@ +# SquareConnect.EmployeesApi + +All URIs are relative to *https://connect.squareup.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**listEmployees**](EmployeesApi.md#listEmployees) | **GET** /v2/employees | ListEmployees +[**retrieveEmployee**](EmployeesApi.md#retrieveEmployee) | **GET** /v2/employees/{id} | RetrieveEmployee + + + +# **listEmployees** +> ListEmployeesResponse listEmployees(opts) + +ListEmployees + +Gets a list of `Employee` objects 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.EmployeesApi(); + +var opts = { + 'locationId': "locationId_example", // String | Filter employees returned to only those that are associated with the specified location. + '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. +}; +apiInstance.listEmployees(opts).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **locationId** | **String**| Filter employees returned to only those that are associated with the specified location. | [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] + +### Return type + +[**ListEmployeesResponse**](ListEmployeesResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **retrieveEmployee** +> RetrieveEmployeeResponse retrieveEmployee(id) + +RetrieveEmployee + +Gets an `Employee` by Square-assigned employee `ID` (UUID) + +### 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.EmployeesApi(); + +var id = "id_example"; // String | UUID for the employee that was requested. + +apiInstance.retrieveEmployee(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 employee that was requested. | + +### Return type + +[**RetrieveEmployeeResponse**](RetrieveEmployeeResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + diff --git a/docs/Error.md b/docs/Error.md index cb13268..bc6168d 100644 --- a/docs/Error.md +++ b/docs/Error.md @@ -1,5 +1,9 @@ # SquareConnect.Error +### Description + +Represents an error encountered during a request to the Connect API. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/GetBreakTypeRequest.md b/docs/GetBreakTypeRequest.md new file mode 100644 index 0000000..6ced01a --- /dev/null +++ b/docs/GetBreakTypeRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.GetBreakTypeRequest + +### Description + +A request to GET a `BreakType` by ID + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/GetBreakTypeResponse.md b/docs/GetBreakTypeResponse.md new file mode 100644 index 0000000..1fa369a --- /dev/null +++ b/docs/GetBreakTypeResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.GetBreakTypeResponse + +### Description + +The response to a request to get a `BreakType`. Contains the requested `BreakType` objects. May contain a set of `Error` objects if the request resulted in errors. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**break_type** | [**BreakType**](BreakType.md) | The response object. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/GetEmployeeWageRequest.md b/docs/GetEmployeeWageRequest.md new file mode 100644 index 0000000..de10a33 --- /dev/null +++ b/docs/GetEmployeeWageRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.GetEmployeeWageRequest + +### Description + +A request to get an `EmployeeWage` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/GetEmployeeWageResponse.md b/docs/GetEmployeeWageResponse.md new file mode 100644 index 0000000..58ca21b --- /dev/null +++ b/docs/GetEmployeeWageResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.GetEmployeeWageResponse + +### Description + +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. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee_wage** | [**EmployeeWage**](EmployeeWage.md) | The requested `EmployeeWage` object. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/GetShiftRequest.md b/docs/GetShiftRequest.md new file mode 100644 index 0000000..3ff6566 --- /dev/null +++ b/docs/GetShiftRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.GetShiftRequest + +### Description + +A request to get a `Shift` by ID + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/GetShiftResponse.md b/docs/GetShiftResponse.md new file mode 100644 index 0000000..2a6bbe3 --- /dev/null +++ b/docs/GetShiftResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.GetShiftResponse + +### Description + +A response to request to get a `Shift`. Contains the requested `Shift` object. May contain a set of `Error` objects if the request resulted in errors. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shift** | [**Shift**](Shift.md) | The requested `Shift`. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/InventoryAdjustment.md b/docs/InventoryAdjustment.md index 4648fb4..21a6ed7 100644 --- a/docs/InventoryAdjustment.md +++ b/docs/InventoryAdjustment.md @@ -1,5 +1,9 @@ # SquareConnect.InventoryAdjustment +### Description + +Represents a change in state or quantity of product inventory at a particular time and location. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/InventoryApi.md b/docs/InventoryApi.md index 231adf1..8ac3c48 100644 --- a/docs/InventoryApi.md +++ b/docs/InventoryApi.md @@ -228,7 +228,7 @@ var catalogObjectId = "catalogObjectId_example"; // String | ID of the [CatalogO var opts = { 'locationIds': "locationIds_example", // String | The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. - '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 the original query. See [Paginating results](#paginatingresults) for more information. + '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 the original query. See [Pagination](/basics/api101/pagination) for more information. }; apiInstance.retrieveInventoryChanges(catalogObjectId, opts).then(function(data) { console.log('API called successfully. Returned data: ' + data); @@ -244,7 +244,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **catalogObjectId** | **String**| ID of the [CatalogObject](#type-catalogobject) to retrieve. | **locationIds** | **String**| The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. | [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 [Paginating results](#paginatingresults) for more information. | [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 [Pagination](/basics/api101/pagination) for more information. | [optional] ### Return type @@ -282,7 +282,7 @@ var catalogObjectId = "catalogObjectId_example"; // String | ID of the [CatalogO var opts = { 'locationIds': "locationIds_example", // String | The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. - '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 the original query. See [Paginating results](#paginatingresults) for more information. + '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 the original query. See [Pagination](/basics/api101/pagination) for more information. }; apiInstance.retrieveInventoryCount(catalogObjectId, opts).then(function(data) { console.log('API called successfully. Returned data: ' + data); @@ -298,7 +298,7 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **catalogObjectId** | **String**| ID of the [CatalogObject](#type-catalogobject) to retrieve. | **locationIds** | **String**| The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. | [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 [Paginating results](#paginatingresults) for more information. | [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 [Pagination](/basics/api101/pagination) for more information. | [optional] ### Return type diff --git a/docs/InventoryChange.md b/docs/InventoryChange.md index 9b72f96..7255f0f 100644 --- a/docs/InventoryChange.md +++ b/docs/InventoryChange.md @@ -1,5 +1,9 @@ # SquareConnect.InventoryChange +### Description + +Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular [CatalogObject](#type-catalogobject). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/InventoryCount.md b/docs/InventoryCount.md index 04337db..5a83bfa 100644 --- a/docs/InventoryCount.md +++ b/docs/InventoryCount.md @@ -1,5 +1,9 @@ # SquareConnect.InventoryCount +### Description + +Represents the estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/InventoryPhysicalCount.md b/docs/InventoryPhysicalCount.md index 73f7d3d..98c683f 100644 --- a/docs/InventoryPhysicalCount.md +++ b/docs/InventoryPhysicalCount.md @@ -1,5 +1,9 @@ # SquareConnect.InventoryPhysicalCount +### Description + +Represents a verified (re)count of items in a given state at a specific location. For example, the quantity of items currently on hand at a physical store). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/InventoryTransfer.md b/docs/InventoryTransfer.md index e8b91ec..a3093d6 100644 --- a/docs/InventoryTransfer.md +++ b/docs/InventoryTransfer.md @@ -1,5 +1,9 @@ # SquareConnect.InventoryTransfer +### Description + +Represents the transfer of a quantity of product inventory at a particular time from one location to another. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ItemVariationLocationOverrides.md b/docs/ItemVariationLocationOverrides.md index d57bf0c..7ed816c 100644 --- a/docs/ItemVariationLocationOverrides.md +++ b/docs/ItemVariationLocationOverrides.md @@ -1,5 +1,9 @@ # SquareConnect.ItemVariationLocationOverrides +### Description + +Price and inventory alerting overrides for a [CatalogItemVariation](#type-catalogitemvariation) at a specific [location](#type-location). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/LaborApi.md b/docs/LaborApi.md new file mode 100644 index 0000000..8829071 --- /dev/null +++ b/docs/LaborApi.md @@ -0,0 +1,716 @@ +# SquareConnect.LaborApi + +All URIs are relative to *https://connect.squareup.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createBreakType**](LaborApi.md#createBreakType) | **POST** /v2/labor/break-types | CreateBreakType +[**createShift**](LaborApi.md#createShift) | **POST** /v2/labor/shifts | CreateShift +[**deleteBreakType**](LaborApi.md#deleteBreakType) | **DELETE** /v2/labor/break-types/{id} | DeleteBreakType +[**deleteShift**](LaborApi.md#deleteShift) | **DELETE** /v2/labor/shifts/{id} | DeleteShift +[**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 +[**listBreakTypes**](LaborApi.md#listBreakTypes) | **GET** /v2/labor/break-types | ListBreakTypes +[**listEmployeeWages**](LaborApi.md#listEmployeeWages) | **GET** /v2/labor/employee-wages | ListEmployeeWages +[**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 +[**updateShift**](LaborApi.md#updateShift) | **PUT** /v2/labor/shifts/{id} | UpdateShift +[**updateWorkweekConfig**](LaborApi.md#updateWorkweekConfig) | **PUT** /v2/labor/workweek-configs/{id} | UpdateWorkweekConfig + + + +# **createBreakType** +> CreateBreakTypeResponse createBreakType(body) + +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. + +### 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 body = new SquareConnect.CreateBreakTypeRequest(); // CreateBreakTypeRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. + +apiInstance.createBreakType(body).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateBreakTypeRequest**](CreateBreakTypeRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**CreateBreakTypeResponse**](CreateBreakTypeResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **createShift** +> CreateShiftResponse createShift(body) + +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` + +### 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 body = new SquareConnect.CreateShiftRequest(); // CreateShiftRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. + +apiInstance.createShift(body).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateShiftRequest**](CreateShiftRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**CreateShiftResponse**](CreateShiftResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **deleteBreakType** +> DeleteBreakTypeResponse deleteBreakType(id) + +DeleteBreakType + +Deletes an existing `BreakType`. A `BreakType` can be deleted even if it is referenced from a `Shift`. + +### 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 `BreakType` being deleted. + +apiInstance.deleteBreakType(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 `BreakType` being deleted. | + +### Return type + +[**DeleteBreakTypeResponse**](DeleteBreakTypeResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **deleteShift** +> DeleteShiftResponse deleteShift(id) + +DeleteShift + +Deletes a `Shift`. + +### 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 `Shift` being deleted. + +apiInstance.deleteShift(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 `Shift` being deleted. | + +### Return type + +[**DeleteShiftResponse**](DeleteShiftResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **getBreakType** +> GetBreakTypeResponse getBreakType(id) + +GetBreakType + +Returns a single `BreakType` 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 `BreakType` being retrieved. + +apiInstance.getBreakType(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 `BreakType` being retrieved. | + +### Return type + +[**GetBreakTypeResponse**](GetBreakTypeResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **getEmployeeWage** +> GetEmployeeWageResponse getEmployeeWage(id) + +GetEmployeeWage + +Returns a single `EmployeeWage` 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 `EmployeeWage` being retrieved. + +apiInstance.getEmployeeWage(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 `EmployeeWage` being retrieved. | + +### Return type + +[**GetEmployeeWageResponse**](GetEmployeeWageResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **getShift** +> GetShiftResponse getShift(id) + +GetShift + +Returns a single `Shift` 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 `Shift` being retrieved. + +apiInstance.getShift(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 `Shift` being retrieved. | + +### Return type + +[**GetShiftResponse**](GetShiftResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **listBreakTypes** +> ListBreakTypesResponse listBreakTypes(opts) + +ListBreakTypes + +Returns a paginated list of `BreakType` 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 = { + 'locationId': "locationId_example", // String | Filter Break Types returned to only those that are associated with the specified location. + 'limit': 56, // Number | Maximum number of Break Types 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 Break Type results to fetch. +}; +apiInstance.listBreakTypes(opts).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **locationId** | **String**| Filter Break Types returned to only those that are associated with the specified location. | [optional] + **limit** | **Number**| Maximum number of Break Types 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 Break Type results to fetch. | [optional] + +### Return type + +[**ListBreakTypesResponse**](ListBreakTypesResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **listEmployeeWages** +> ListEmployeeWagesResponse listEmployeeWages(opts) + +ListEmployeeWages + +Returns a paginated list of `EmployeeWage` 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 = { + 'employeeId': "employeeId_example", // String | Filter wages returned to only those that are associated with the specified employee. + 'limit': 56, // Number | Maximum number of Employee 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.listEmployeeWages(opts).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **employeeId** | **String**| Filter wages returned to only those that are associated with the specified employee. | [optional] + **limit** | **Number**| Maximum number of Employee 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 + +[**ListEmployeeWagesResponse**](ListEmployeeWagesResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **listWorkweekConfigs** +> ListWorkweekConfigsResponse listWorkweekConfigs(opts) + +ListWorkweekConfigs + +Returns a list of `WorkweekConfig` 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 = { + 'limit': 56, // Number | Maximum number of Workweek Configs to return per page. + 'cursor': "cursor_example" // String | Pointer to the next page of Workweek Config results to fetch. +}; +apiInstance.listWorkweekConfigs(opts).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **limit** | **Number**| Maximum number of Workweek Configs to return per page. | [optional] + **cursor** | **String**| Pointer to the next page of Workweek Config results to fetch. | [optional] + +### Return type + +[**ListWorkweekConfigsResponse**](ListWorkweekConfigsResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **searchShifts** +> SearchShiftsResponse searchShifts(body) + +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` + +### 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 body = new SquareConnect.SearchShiftsRequest(); // SearchShiftsRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. + +apiInstance.searchShifts(body).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**SearchShiftsRequest**](SearchShiftsRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**SearchShiftsResponse**](SearchShiftsResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **updateBreakType** +> UpdateBreakTypeResponse updateBreakType(id, body) + +UpdateBreakType + +Updates an existing `BreakType`. + +### 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 `BreakType` being updated. + +var body = new SquareConnect.UpdateBreakTypeRequest(); // UpdateBreakTypeRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. + +apiInstance.updateBreakType(id, body).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 `BreakType` being updated. | + **body** | [**UpdateBreakTypeRequest**](UpdateBreakTypeRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**UpdateBreakTypeResponse**](UpdateBreakTypeResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **updateShift** +> UpdateShiftResponse updateShift(id, body) + +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`. + +### 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 | ID of the object being updated. + +var body = new SquareConnect.UpdateShiftRequest(); // UpdateShiftRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. + +apiInstance.updateShift(id, body).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **id** | **String**| ID of the object being updated. | + **body** | [**UpdateShiftRequest**](UpdateShiftRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**UpdateShiftResponse**](UpdateShiftResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **updateWorkweekConfig** +> UpdateWorkweekConfigResponse updateWorkweekConfig(id, body) + +UpdateWorkweekConfig + +Updates a `WorkweekConfig`. + +### 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 `WorkweekConfig` object being updated. + +var body = new SquareConnect.UpdateWorkweekConfigRequest(); // UpdateWorkweekConfigRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. + +apiInstance.updateWorkweekConfig(id, body).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 `WorkweekConfig` object being updated. | + **body** | [**UpdateWorkweekConfigRequest**](UpdateWorkweekConfigRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**UpdateWorkweekConfigResponse**](UpdateWorkweekConfigResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + diff --git a/docs/ListAdditionalRecipientReceivableRefundsRequest.md b/docs/ListAdditionalRecipientReceivableRefundsRequest.md index 3768100..ce16bb2 100644 --- a/docs/ListAdditionalRecipientReceivableRefundsRequest.md +++ b/docs/ListAdditionalRecipientReceivableRefundsRequest.md @@ -1,12 +1,16 @@ # SquareConnect.ListAdditionalRecipientReceivableRefundsRequest +### Description + +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` | [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] +**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 [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListAdditionalRecipientReceivableRefundsResponse.md b/docs/ListAdditionalRecipientReceivableRefundsResponse.md index b7e44fd..97023f4 100644 --- a/docs/ListAdditionalRecipientReceivableRefundsResponse.md +++ b/docs/ListAdditionalRecipientReceivableRefundsResponse.md @@ -1,10 +1,14 @@ # SquareConnect.ListAdditionalRecipientReceivableRefundsResponse +### Description + +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] +**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 [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListAdditionalRecipientReceivablesRequest.md b/docs/ListAdditionalRecipientReceivablesRequest.md index 1bd2ca4..b650415 100644 --- a/docs/ListAdditionalRecipientReceivablesRequest.md +++ b/docs/ListAdditionalRecipientReceivablesRequest.md @@ -1,12 +1,16 @@ # SquareConnect.ListAdditionalRecipientReceivablesRequest +### Description + +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` | [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] +**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 [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListAdditionalRecipientReceivablesResponse.md b/docs/ListAdditionalRecipientReceivablesResponse.md index da8a2db..3094641 100644 --- a/docs/ListAdditionalRecipientReceivablesResponse.md +++ b/docs/ListAdditionalRecipientReceivablesResponse.md @@ -1,10 +1,14 @@ # SquareConnect.ListAdditionalRecipientReceivablesResponse +### Description + +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] +**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 [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListBreakTypesRequest.md b/docs/ListBreakTypesRequest.md new file mode 100644 index 0000000..3d2d527 --- /dev/null +++ b/docs/ListBreakTypesRequest.md @@ -0,0 +1,14 @@ +# SquareConnect.ListBreakTypesRequest + +### Description + +A request for a filtered set of `BreakType` objects + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**location_id** | **String** | Filter Break Types returned to only those that are associated with the specified location. | [optional] +**limit** | **Number** | Maximum number of Break Types 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 Break Type results to fetch. | [optional] + + diff --git a/docs/ListBreakTypesResponse.md b/docs/ListBreakTypesResponse.md new file mode 100644 index 0000000..d119c71 --- /dev/null +++ b/docs/ListBreakTypesResponse.md @@ -0,0 +1,14 @@ +# SquareConnect.ListBreakTypesResponse + +### Description + +The response to a request for a set of `BreakTypes`. Contains the requested `BreakType` objects. May contain a set of `Error` objects if the request resulted in errors. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**break_types** | [**[BreakType]**](BreakType.md) | A page of `BreakType` results. | [optional] +**cursor** | **String** | Value supplied in the subsequent request to fetch the next next page of Break Type results. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/ListCatalogRequest.md b/docs/ListCatalogRequest.md index 9c8bf3f..a286efb 100644 --- a/docs/ListCatalogRequest.md +++ b/docs/ListCatalogRequest.md @@ -1,9 +1,13 @@ # SquareConnect.ListCatalogRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**cursor** | **String** | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information. | [optional] +**cursor** | **String** | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information. | [optional] **types** | **String** | An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY`. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. | [optional] diff --git a/docs/ListCatalogResponse.md b/docs/ListCatalogResponse.md index 8d3da09..a7c3ea3 100644 --- a/docs/ListCatalogResponse.md +++ b/docs/ListCatalogResponse.md @@ -1,10 +1,14 @@ # SquareConnect.ListCatalogResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**[Error]**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] -**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Paginating results](#paginatingresults) for more information. | [optional] +**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] **objects** | [**[CatalogObject]**](CatalogObject.md) | The [CatalogObject](#type-catalogobject)s returned. | [optional] diff --git a/docs/ListCustomersRequest.md b/docs/ListCustomersRequest.md index 8c4dfcc..c7a6fb1 100644 --- a/docs/ListCustomersRequest.md +++ b/docs/ListCustomersRequest.md @@ -1,9 +1,13 @@ # SquareConnect.ListCustomersRequest +### Description + +Defines the query parameters that can be provided in a request to the [ListCustomers](#endpoint-listcustomers) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**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] +**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 [Pagination](/basics/api101/pagination) for more information. | [optional] **sort_field** | **String** | Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values. | [optional] **sort_order** | **String** | Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values. | [optional] diff --git a/docs/ListCustomersResponse.md b/docs/ListCustomersResponse.md index 042b1b2..c7106c1 100644 --- a/docs/ListCustomersResponse.md +++ b/docs/ListCustomersResponse.md @@ -1,10 +1,14 @@ # SquareConnect.ListCustomersResponse +### Description + +Defines the fields that are included in the response body of a request to the [ListCustomers](#endpoint-listcustomers) endpoint. One of `errors` or `customers` 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] **customers** | [**[Customer]**](Customer.md) | An array of `Customer` objects that match your query. | [optional] -**cursor** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. This value is present only if the request succeeded and additional results are available. See [Paginating results](#paginatingresults) for more information. | [optional] +**cursor** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. This value is present only if the request succeeded and additional results are available. See [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListEmployeeWagesRequest.md b/docs/ListEmployeeWagesRequest.md new file mode 100644 index 0000000..c7ca5e7 --- /dev/null +++ b/docs/ListEmployeeWagesRequest.md @@ -0,0 +1,14 @@ +# SquareConnect.ListEmployeeWagesRequest + +### Description + +A request for a set of `EmployeeWage` objects + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee_id** | **String** | Filter wages returned to only those that are associated with the specified employee. | [optional] +**limit** | **Number** | Maximum number of Employee 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/ListEmployeeWagesResponse.md b/docs/ListEmployeeWagesResponse.md new file mode 100644 index 0000000..fc84e63 --- /dev/null +++ b/docs/ListEmployeeWagesResponse.md @@ -0,0 +1,14 @@ +# SquareConnect.ListEmployeeWagesResponse + +### Description + +The response to a request for a set of `EmployeeWage` objects. Contains a set of `EmployeeWage`. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee_wages** | [**[EmployeeWage]**](EmployeeWage.md) | A page of Employee Wage results. | [optional] +**cursor** | **String** | Value supplied in the subsequent request to fetch the next next page of Employee Wage results. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/ListEmployeesRequest.md b/docs/ListEmployeesRequest.md new file mode 100644 index 0000000..b490c8d --- /dev/null +++ b/docs/ListEmployeesRequest.md @@ -0,0 +1,26 @@ +# SquareConnect.ListEmployeesRequest + +### Description + +Retrieve a paged-list of employees for a Square account + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**location_id** | **String** | Filter employees returned to only those that are associated with the specified location. | [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] + + + +## Enum: StatusEnum + + +* `ACTIVE` (value: `"ACTIVE"`) + +* `INACTIVE` (value: `"INACTIVE"`) + + + + diff --git a/docs/ListEmployeesResponse.md b/docs/ListEmployeesResponse.md new file mode 100644 index 0000000..4f90ec1 --- /dev/null +++ b/docs/ListEmployeesResponse.md @@ -0,0 +1,14 @@ +# SquareConnect.ListEmployeesResponse + +### Description + +Defines the fields that are included in the response body of a request to the [ListEmployees](#endpoint-listemployees) endpoint. One of `errors` or `employees` is present in a given response (never both). + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employees** | [**[Employee]**](Employee.md) | List of employees returned from the request. | [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/ListLocationsRequest.md b/docs/ListLocationsRequest.md index a98401a..29ea56b 100644 --- a/docs/ListLocationsRequest.md +++ b/docs/ListLocationsRequest.md @@ -1,5 +1,9 @@ # SquareConnect.ListLocationsRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ListLocationsResponse.md b/docs/ListLocationsResponse.md index 5bd0298..9bba065 100644 --- a/docs/ListLocationsResponse.md +++ b/docs/ListLocationsResponse.md @@ -1,5 +1,9 @@ # SquareConnect.ListLocationsResponse +### Description + +Defines the fields that are included in the response body of a request to the [ListLocations](#endpoint-listlocations) endpoint. One of `errors` or `locations` is present in a given response (never both). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ListRefundsRequest.md b/docs/ListRefundsRequest.md index 30b894c..c4ddded 100644 --- a/docs/ListRefundsRequest.md +++ b/docs/ListRefundsRequest.md @@ -1,12 +1,16 @@ # SquareConnect.ListRefundsRequest +### Description + +Defines the query parameters that can be included in a request to the [ListRefunds](#endpoint-listrefunds) 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` | [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] +**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 [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListRefundsResponse.md b/docs/ListRefundsResponse.md index 75a3fce..c750644 100644 --- a/docs/ListRefundsResponse.md +++ b/docs/ListRefundsResponse.md @@ -1,10 +1,14 @@ # SquareConnect.ListRefundsResponse +### Description + +Defines the fields that are included in the response body of a request to the [ListRefunds](#endpoint-listrefunds) endpoint. One of `errors` or `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] **refunds** | [**[Refund]**](Refund.md) | An array of refunds 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] +**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 [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListTransactionsRequest.md b/docs/ListTransactionsRequest.md index 6496225..ebe2e6e 100644 --- a/docs/ListTransactionsRequest.md +++ b/docs/ListTransactionsRequest.md @@ -1,12 +1,16 @@ # SquareConnect.ListTransactionsRequest +### Description + +Defines the query parameters that can be included in a request to the [ListTransactions](#endpoint-listtransactions) 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` | [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] +**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 [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListTransactionsResponse.md b/docs/ListTransactionsResponse.md index ebefa77..7540e66 100644 --- a/docs/ListTransactionsResponse.md +++ b/docs/ListTransactionsResponse.md @@ -1,10 +1,14 @@ # SquareConnect.ListTransactionsResponse +### Description + +Defines the fields that are included in the response body of a request to the [ListTransactions](#endpoint-listtransactions) endpoint. One of `errors` or `transactions` 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] **transactions** | [**[Transaction]**](Transaction.md) | An array of transactions 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] +**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 [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/ListWorkweekConfigsRequest.md b/docs/ListWorkweekConfigsRequest.md new file mode 100644 index 0000000..142c265 --- /dev/null +++ b/docs/ListWorkweekConfigsRequest.md @@ -0,0 +1,13 @@ +# SquareConnect.ListWorkweekConfigsRequest + +### Description + +A request for a set of `WorkweekConfig` objects + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**limit** | **Number** | Maximum number of Workweek Configs to return per page. | [optional] +**cursor** | **String** | Pointer to the next page of Workweek Config results to fetch. | [optional] + + diff --git a/docs/ListWorkweekConfigsResponse.md b/docs/ListWorkweekConfigsResponse.md new file mode 100644 index 0000000..cb6fcae --- /dev/null +++ b/docs/ListWorkweekConfigsResponse.md @@ -0,0 +1,14 @@ +# SquareConnect.ListWorkweekConfigsResponse + +### Description + +The response to a request for a set of `WorkweekConfig` objects. Contains the requested `WorkweekConfig` objects. May contain a set of `Error` objects if the request resulted in errors. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**workweek_configs** | [**[WorkweekConfig]**](WorkweekConfig.md) | A page of Employee Wage results. | [optional] +**cursor** | **String** | Value supplied in the subsequent request to fetch the next page of Employee Wage results. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/Location.md b/docs/Location.md index 7274c30..832639f 100644 --- a/docs/Location.md +++ b/docs/Location.md @@ -1,5 +1,9 @@ # SquareConnect.Location +### Description + +Represents one of a business's locations. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ModelBreak.md b/docs/ModelBreak.md new file mode 100644 index 0000000..dd15db4 --- /dev/null +++ b/docs/ModelBreak.md @@ -0,0 +1,18 @@ +# SquareConnect.ModelBreak + +### Description + +A record of an employee's break during a shift. + +## Properties +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] +**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. | +**is_paid** | **Boolean** | Whether this break counts towards time worked for compensation purposes. | + + diff --git a/docs/Money.md b/docs/Money.md index 1f948a5..76035df 100644 --- a/docs/Money.md +++ b/docs/Money.md @@ -1,5 +1,9 @@ # SquareConnect.Money +### Description + +Represents an amount of money. __Important:__ Unlike version 1 of the Connect API, __all monetary amounts returned by v2 endpoints are positive.__ (In v1, monetary amounts are negative if they represent money being paid _by_ a merchant, instead of money being paid _to_ a merchant.) + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/OAuthApi.md b/docs/OAuthApi.md index e9895a1..6a4ed69 100644 --- a/docs/OAuthApi.md +++ b/docs/OAuthApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description ObtainToken -Exchanges the authorization code for an access token. After a merchant authorizes your application with the permissions form, an authorization code is sent to the application's redirect URL (See [Implementing OAuth](https://docs.connect.squareup.com/api/oauth#implementingoauth) for information about how to set up the redirect URL). +Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. By default, the OAuth API lets up to 500 Square accounts authorize your application. Please [contact support](https://squareup.com/help/us/en/contact?prefill=developer_api) if you are developing an application for a larger audience. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. ### Example ```javascript @@ -58,7 +58,7 @@ No authorization required RenewToken -Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated merchant must complete the [OAuth flow](https://docs.connect.squareup.com/api/oauth#implementingoauth) from the beginning. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with your application's secret, available from the [application dashboard](https://connect.squareup.com/apps). +`RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](/authz/oauth/cookbook/oauth-renew). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). ### Example ```javascript @@ -67,7 +67,7 @@ var defaultClient = SquareConnect.ApiClient.instance; // Configure API key authorization: oauth2ClientSecret var oauth2ClientSecret = defaultClient.authentications['oauth2ClientSecret']; -oauth2ClientSecret.apiKey = 'YOUR API KEY'; +oauth2ClientSecret.apiKey = 'APPLICATION SECRET'; oauth2ClientSecret.apiKeyPrefix = 'Client'; var apiInstance = new SquareConnect.OAuthApi(); @@ -110,7 +110,7 @@ Name | Type | Description | Notes RevokeToken -Revokes an access token generated with the OAuth flow. If a merchant has more than one access token for your application, this endpoint revokes all of them, regardless of which token you specify. If you revoke a merchant's access token, all of the merchant's active subscriptions associated with your application are canceled immediately. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with your application's secret, available from the [application dashboard](https://connect.squareup.com/apps). +Revokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). ### Example ```javascript @@ -119,7 +119,7 @@ var defaultClient = SquareConnect.ApiClient.instance; // Configure API key authorization: oauth2ClientSecret var oauth2ClientSecret = defaultClient.authentications['oauth2ClientSecret']; -oauth2ClientSecret.apiKey = 'YOUR API KEY'; +oauth2ClientSecret.apiKey = 'APPLICATION SECRET'; oauth2ClientSecret.apiKeyPrefix = 'Client'; var apiInstance = new SquareConnect.OAuthApi(); diff --git a/docs/ObtainTokenRequest.md b/docs/ObtainTokenRequest.md index 1effdfe..c95e02f 100644 --- a/docs/ObtainTokenRequest.md +++ b/docs/ObtainTokenRequest.md @@ -1,11 +1,18 @@ # SquareConnect.ObtainTokenRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**client_id** | **String** | Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). | [optional] -**client_secret** | **String** | Your application's secret, available from the [application dashboard](https://connect.squareup.com/apps). | [optional] -**code** | **String** | The authorization code to exchange. | [optional] +**client_id** | **String** | The Square-issued ID of your application, available from the [application dashboard](https://connect.squareup.com/apps). | [optional] +**client_secret** | **String** | The Square-issued application secret for your application, available from the [application dashboard](https://connect.squareup.com/apps). | [optional] +**code** | **String** | The authorization code to exchange. This is required if `grant_type` is set to `authorization_code`, to indicate that the application wants to exchange an authorization code for an OAuth access token. | [optional] **redirect_uri** | **String** | The redirect URL assigned in the [application dashboard](https://connect.squareup.com/apps). | [optional] +**grant_type** | **String** | Specifies the method to request an OAuth access token. Valid values are: `authorization_code`, `refresh_token`, and `migration_token` | [optional] +**refresh_token** | **String** | A valid refresh token for generating a new OAuth access token. A valid refresh token is required if `grant_type` is set to `refresh_token` , to indicate the application wants a replacement for an expired OAuth access token. | [optional] +**migration_token** | **String** | Legacy OAuth access token obtained using a Connect API version prior to 2019-03-13. This parameter is required if `grant_type` is set to `migration_token` to indicate that the application wants to get a replacement OAuth access token. The response also returns a refresh token. For more information, see [Migrate to Using Refresh Tokens](/authz/oauth/migration). | [optional] diff --git a/docs/ObtainTokenResponse.md b/docs/ObtainTokenResponse.md index f93b6ac..f1eb621 100644 --- a/docs/ObtainTokenResponse.md +++ b/docs/ObtainTokenResponse.md @@ -1,14 +1,19 @@ # SquareConnect.ObtainTokenResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**access_token** | **String** | Your application's access token. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://docs.connect.squareup.com/api/connect/v2/#requestandresponseheaders) for the format of this header. | [optional] +**access_token** | **String** | A valid OAuth access token. Provide the access token in a header with every request to Connect API endpoints. See the [Build with OAuth](/authz/oauth/build-with-the-api) guide for more information. | [optional] **token_type** | **String** | This value is always _bearer_. | [optional] **expires_at** | **String** | The date when access_token expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format. | [optional] **merchant_id** | **String** | The ID of the authorizing merchant's business. | [optional] -**subscription_id** | **String** | The ID of the merchant [subscription](https://docs.connect.squareup.com/api/connect/v1/#navsection-subscriptionmanagement) associated with the authorization. Only present if the merchant signed up for a subscription during authorization. | [optional] +**subscription_id** | **String** | __Legacy field__. The ID of a subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] **plan_id** | **String** | The ID of the [subscription](https://docs.connect.squareup.com/api/connect/v1/#navsection-subscriptionmanagement) plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. | [optional] **id_token** | **String** | Then OpenID token belonging to this this person. Only present if the OPENID scope is included in the authorize request. | [optional] +**refresh_token** | **String** | A refresh token. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). | [optional] diff --git a/docs/Order.md b/docs/Order.md index f15418c..51df812 100644 --- a/docs/Order.md +++ b/docs/Order.md @@ -1,5 +1,9 @@ # SquareConnect.Order +### Description + +Contains all information related to a single order to process with Square, including line items that specify the products to purchase + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/OrderFulfillment.md b/docs/OrderFulfillment.md index 5441e88..1d89611 100644 --- a/docs/OrderFulfillment.md +++ b/docs/OrderFulfillment.md @@ -1,5 +1,9 @@ # SquareConnect.OrderFulfillment +### Description + +Contains details on how to fulfill this order. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/OrderFulfillmentPickupDetails.md b/docs/OrderFulfillmentPickupDetails.md index e292e5d..df37f1a 100644 --- a/docs/OrderFulfillmentPickupDetails.md +++ b/docs/OrderFulfillmentPickupDetails.md @@ -1,5 +1,9 @@ # SquareConnect.OrderFulfillmentPickupDetails +### Description + +Contains details necessary to fulfill a pickup order. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/OrderFulfillmentRecipient.md b/docs/OrderFulfillmentRecipient.md index 2d5baea..3b71887 100644 --- a/docs/OrderFulfillmentRecipient.md +++ b/docs/OrderFulfillmentRecipient.md @@ -1,5 +1,9 @@ # SquareConnect.OrderFulfillmentRecipient +### Description + +The recipient of a fulfillment. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/OrderLineItem.md b/docs/OrderLineItem.md index 933c85f..a0033ee 100644 --- a/docs/OrderLineItem.md +++ b/docs/OrderLineItem.md @@ -1,5 +1,9 @@ # SquareConnect.OrderLineItem +### Description + +Represents a line item in an order. Each line item describes a different product to purchase, with its own quantity and price details. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/OrderLineItemDiscount.md b/docs/OrderLineItemDiscount.md index cb76cb9..bb31477 100644 --- a/docs/OrderLineItemDiscount.md +++ b/docs/OrderLineItemDiscount.md @@ -1,5 +1,9 @@ # SquareConnect.OrderLineItemDiscount +### Description + +Represents a discount that applies to one or more line items in an order. Fixed-amount, order-level discounts are distributed across all non-zero line item totals. The amount distributed to each line item is relative to that item’s contribution to the order subtotal. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/OrderLineItemModifier.md b/docs/OrderLineItemModifier.md index c1cf3d9..4091236 100644 --- a/docs/OrderLineItemModifier.md +++ b/docs/OrderLineItemModifier.md @@ -1,5 +1,9 @@ # SquareConnect.OrderLineItemModifier +### Description + +A [CatalogModifier](#type-catalogmodifier). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/OrderLineItemTax.md b/docs/OrderLineItemTax.md index e1c13a0..8fb849b 100644 --- a/docs/OrderLineItemTax.md +++ b/docs/OrderLineItemTax.md @@ -1,5 +1,9 @@ # SquareConnect.OrderLineItemTax +### Description + +Represents a tax that applies to one or more line items in an order. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Refund.md b/docs/Refund.md index 737cddb..8118582 100644 --- a/docs/Refund.md +++ b/docs/Refund.md @@ -1,5 +1,9 @@ # SquareConnect.Refund +### Description + +Represents a refund processed for a Square transaction. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RegisterDomainRequest.md b/docs/RegisterDomainRequest.md index fa54216..9ffe6b4 100644 --- a/docs/RegisterDomainRequest.md +++ b/docs/RegisterDomainRequest.md @@ -1,5 +1,9 @@ # SquareConnect.RegisterDomainRequest +### Description + +Defines the parameters that can be included in the body of a request to the [RegisterDomain](#endpoint-registerdomain) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RegisterDomainResponse.md b/docs/RegisterDomainResponse.md index 23a5c0c..369bcf9 100644 --- a/docs/RegisterDomainResponse.md +++ b/docs/RegisterDomainResponse.md @@ -1,5 +1,9 @@ # SquareConnect.RegisterDomainResponse +### Description + +Defines the fields that are included in the response body of a request to the [RegisterDomain](#endpoint-registerdomain) endpoint. Either `errors` or `status` will be present in a given response (never both). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RenewTokenRequest.md b/docs/RenewTokenRequest.md index c4c22b0..d41839f 100644 --- a/docs/RenewTokenRequest.md +++ b/docs/RenewTokenRequest.md @@ -1,5 +1,9 @@ # SquareConnect.RenewTokenRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RenewTokenResponse.md b/docs/RenewTokenResponse.md index b730321..92dba02 100644 --- a/docs/RenewTokenResponse.md +++ b/docs/RenewTokenResponse.md @@ -1,5 +1,9 @@ # SquareConnect.RenewTokenResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/ReportingApi.md b/docs/ReportingApi.md index db5bd46..a126d3b 100644 --- a/docs/ReportingApi.md +++ b/docs/ReportingApi.md @@ -33,7 +33,7 @@ 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. + '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 [Pagination](/basics/api101/pagination) for more information. }; apiInstance.listAdditionalRecipientReceivableRefunds(locationId, opts).then(function(data) { console.log('API called successfully. Returned data: ' + data); @@ -51,7 +51,7 @@ Name | Type | Description | Notes **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] + **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 [Pagination](/basics/api101/pagination) for more information. | [optional] ### Return type @@ -91,7 +91,7 @@ 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. + '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 [Pagination](/basics/api101/pagination) for more information. }; apiInstance.listAdditionalRecipientReceivables(locationId, opts).then(function(data) { console.log('API called successfully. Returned data: ' + data); @@ -109,7 +109,7 @@ Name | Type | Description | Notes **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] + **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 [Pagination](/basics/api101/pagination) for more information. | [optional] ### Return type diff --git a/docs/RetrieveCatalogObjectRequest.md b/docs/RetrieveCatalogObjectRequest.md index 4883451..3ba96ec 100644 --- a/docs/RetrieveCatalogObjectRequest.md +++ b/docs/RetrieveCatalogObjectRequest.md @@ -1,5 +1,9 @@ # SquareConnect.RetrieveCatalogObjectRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RetrieveCatalogObjectResponse.md b/docs/RetrieveCatalogObjectResponse.md index c23c1f0..5524fed 100644 --- a/docs/RetrieveCatalogObjectResponse.md +++ b/docs/RetrieveCatalogObjectResponse.md @@ -1,5 +1,9 @@ # SquareConnect.RetrieveCatalogObjectResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RetrieveCustomerRequest.md b/docs/RetrieveCustomerRequest.md index e9f6cf7..663d415 100644 --- a/docs/RetrieveCustomerRequest.md +++ b/docs/RetrieveCustomerRequest.md @@ -1,5 +1,9 @@ # SquareConnect.RetrieveCustomerRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RetrieveCustomerResponse.md b/docs/RetrieveCustomerResponse.md index c6f75be..b5cb1d9 100644 --- a/docs/RetrieveCustomerResponse.md +++ b/docs/RetrieveCustomerResponse.md @@ -1,5 +1,9 @@ # SquareConnect.RetrieveCustomerResponse +### Description + +Defines the fields that are included in the response body of a request to the [RetrieveCustomer](#endpoint-retrievecustomer) endpoint. One of `errors` or `customer` is present in a given response (never both). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RetrieveEmployeeRequest.md b/docs/RetrieveEmployeeRequest.md new file mode 100644 index 0000000..583615a --- /dev/null +++ b/docs/RetrieveEmployeeRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.RetrieveEmployeeRequest + +### Description + +Retrieve an employee by `Employee.id` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/RetrieveEmployeeResponse.md b/docs/RetrieveEmployeeResponse.md new file mode 100644 index 0000000..44d51a3 --- /dev/null +++ b/docs/RetrieveEmployeeResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.RetrieveEmployeeResponse + +### Description + +Defines the fields that are included in the response body of a request to the [RetrieveEmployee](#endpoint-retrieveemployee) endpoint. One of `errors` or `employee` is present in a given response (never both). + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee** | [**Employee**](Employee.md) | The response object. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/RetrieveInventoryAdjustmentRequest.md b/docs/RetrieveInventoryAdjustmentRequest.md index d763499..4ee37ce 100644 --- a/docs/RetrieveInventoryAdjustmentRequest.md +++ b/docs/RetrieveInventoryAdjustmentRequest.md @@ -1,5 +1,9 @@ # SquareConnect.RetrieveInventoryAdjustmentRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RetrieveInventoryAdjustmentResponse.md b/docs/RetrieveInventoryAdjustmentResponse.md index d1a6d5d..93ee25f 100644 --- a/docs/RetrieveInventoryAdjustmentResponse.md +++ b/docs/RetrieveInventoryAdjustmentResponse.md @@ -1,5 +1,9 @@ # SquareConnect.RetrieveInventoryAdjustmentResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RetrieveInventoryChangesRequest.md b/docs/RetrieveInventoryChangesRequest.md index db40bfa..2fc7c26 100644 --- a/docs/RetrieveInventoryChangesRequest.md +++ b/docs/RetrieveInventoryChangesRequest.md @@ -1,9 +1,13 @@ # SquareConnect.RetrieveInventoryChangesRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **location_ids** | **String** | The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. | [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 [Paginating results](#paginatingresults) for more information. | [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 [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/RetrieveInventoryChangesResponse.md b/docs/RetrieveInventoryChangesResponse.md index 0314995..dd15904 100644 --- a/docs/RetrieveInventoryChangesResponse.md +++ b/docs/RetrieveInventoryChangesResponse.md @@ -1,10 +1,14 @@ # SquareConnect.RetrieveInventoryChangesResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] **changes** | [**[InventoryChange]**](InventoryChange.md) | The set of inventory changes for the requested object and locations. | [optional] -**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Paginating results](#paginatingresults) for more information. | [optional] +**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/RetrieveInventoryCountRequest.md b/docs/RetrieveInventoryCountRequest.md index a0191d3..b362339 100644 --- a/docs/RetrieveInventoryCountRequest.md +++ b/docs/RetrieveInventoryCountRequest.md @@ -1,9 +1,13 @@ # SquareConnect.RetrieveInventoryCountRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **location_ids** | **String** | The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. | [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 [Paginating results](#paginatingresults) for more information. | [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 [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/RetrieveInventoryCountResponse.md b/docs/RetrieveInventoryCountResponse.md index 300158b..e08c7d5 100644 --- a/docs/RetrieveInventoryCountResponse.md +++ b/docs/RetrieveInventoryCountResponse.md @@ -1,10 +1,14 @@ # SquareConnect.RetrieveInventoryCountResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] **counts** | [**[InventoryCount]**](InventoryCount.md) | The current calculated inventory counts for the requested object and locations. | [optional] -**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Paginating results](#paginatingresults) for more information. | [optional] +**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/RetrieveInventoryPhysicalCountRequest.md b/docs/RetrieveInventoryPhysicalCountRequest.md index dbd8961..9a48d50 100644 --- a/docs/RetrieveInventoryPhysicalCountRequest.md +++ b/docs/RetrieveInventoryPhysicalCountRequest.md @@ -1,5 +1,9 @@ # SquareConnect.RetrieveInventoryPhysicalCountRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RetrieveInventoryPhysicalCountResponse.md b/docs/RetrieveInventoryPhysicalCountResponse.md index 99fc176..67e4046 100644 --- a/docs/RetrieveInventoryPhysicalCountResponse.md +++ b/docs/RetrieveInventoryPhysicalCountResponse.md @@ -1,5 +1,9 @@ # SquareConnect.RetrieveInventoryPhysicalCountResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RetrieveTransactionRequest.md b/docs/RetrieveTransactionRequest.md index d8b5f1f..d830026 100644 --- a/docs/RetrieveTransactionRequest.md +++ b/docs/RetrieveTransactionRequest.md @@ -1,5 +1,9 @@ # SquareConnect.RetrieveTransactionRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RetrieveTransactionResponse.md b/docs/RetrieveTransactionResponse.md index f52dfac..b5e3c8d 100644 --- a/docs/RetrieveTransactionResponse.md +++ b/docs/RetrieveTransactionResponse.md @@ -1,5 +1,9 @@ # SquareConnect.RetrieveTransactionResponse +### Description + +Defines the fields that are included in the response body of a request to the [RetrieveTransaction](#endpont-retrievetransaction) endpoint. One of `errors` or `transaction` is present in a given response (never both). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RevokeTokenRequest.md b/docs/RevokeTokenRequest.md index 8967ed2..94f4c4d 100644 --- a/docs/RevokeTokenRequest.md +++ b/docs/RevokeTokenRequest.md @@ -1,5 +1,9 @@ # SquareConnect.RevokeTokenRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/RevokeTokenResponse.md b/docs/RevokeTokenResponse.md index c4ae800..a80ad62 100644 --- a/docs/RevokeTokenResponse.md +++ b/docs/RevokeTokenResponse.md @@ -1,5 +1,9 @@ # SquareConnect.RevokeTokenResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/SearchCatalogObjectsRequest.md b/docs/SearchCatalogObjectsRequest.md index fbb070a..ca94eb2 100644 --- a/docs/SearchCatalogObjectsRequest.md +++ b/docs/SearchCatalogObjectsRequest.md @@ -1,9 +1,13 @@ # SquareConnect.SearchCatalogObjectsRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**cursor** | **String** | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information. | [optional] +**cursor** | **String** | The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information. | [optional] **object_types** | **[String]** | The desired set of object types to appear in the search results. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. | [optional] **include_deleted_objects** | **Boolean** | If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`. | [optional] **include_related_objects** | **Boolean** | If `true`, the response will include additional objects that are related to the requested object, as follows: If a [CatalogItem](#type-catalogitem) is returned in the object field of the response, its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be included in the `related_objects` field of the response. If a [CatalogItemVariation](#type-catalogitemvariation) is returned in the object field of the response, its parent [CatalogItem](#type-catalogitem) will be included in the `related_objects` field of the response. | [optional] diff --git a/docs/SearchCatalogObjectsResponse.md b/docs/SearchCatalogObjectsResponse.md index cc7b621..0e189ce 100644 --- a/docs/SearchCatalogObjectsResponse.md +++ b/docs/SearchCatalogObjectsResponse.md @@ -1,10 +1,14 @@ # SquareConnect.SearchCatalogObjectsResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **errors** | [**[Error]**](Error.md) | The set of [Error](#type-error)s encountered. | [optional] -**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Paginating results](#paginatingresults) for more information. | [optional] +**cursor** | **String** | The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. | [optional] **objects** | [**[CatalogObject]**](CatalogObject.md) | The [CatalogObject](#type-catalogobject)s returned. | [optional] **related_objects** | [**[CatalogObject]**](CatalogObject.md) | A list of [CatalogObject](#type-catalogobject)s referenced by the objects in the `objects` field. | [optional] diff --git a/docs/SearchCustomersRequest.md b/docs/SearchCustomersRequest.md index f41ffaf..45941ff 100644 --- a/docs/SearchCustomersRequest.md +++ b/docs/SearchCustomersRequest.md @@ -1,9 +1,13 @@ # SquareConnect.SearchCustomersRequest +### Description + +Defines the fields included in the request body for the [SearchCustomers](#endpoint-searchcustomer) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**cursor** | **String** | Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See [Paginating results](#paginatingresults) for more information. | [optional] +**cursor** | **String** | Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See [Pagination](/basics/api101/pagination) for more information. | [optional] **limit** | **Number** | A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored. | [optional] **query** | [**CustomerQuery**](CustomerQuery.md) | Query customers based on the given conditions and sort order. Calling SearchCustomers without an explicit query parameter will return all customers ordered alphabetically based on `given_name` and `family_name`. | [optional] diff --git a/docs/SearchCustomersResponse.md b/docs/SearchCustomersResponse.md index 515aba4..296dce1 100644 --- a/docs/SearchCustomersResponse.md +++ b/docs/SearchCustomersResponse.md @@ -1,10 +1,14 @@ # SquareConnect.SearchCustomersResponse +### Description + +Defines the fields that are included in the response body of a request to the [SearchCustomers](#endpoint-searchcustomers) endpoint. One of `errors` or `customers` 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] **customers** | [**[Customer]**](Customer.md) | An array of `Customer` objects that match a query. | [optional] -**cursor** | **String** | A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See [Paginating results](#paginatingresults) for more information. | [optional] +**cursor** | **String** | A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See [Pagination](/basics/api101/pagination) for more information. | [optional] diff --git a/docs/SearchShiftsRequest.md b/docs/SearchShiftsRequest.md new file mode 100644 index 0000000..5fdff4b --- /dev/null +++ b/docs/SearchShiftsRequest.md @@ -0,0 +1,14 @@ +# SquareConnect.SearchShiftsRequest + +### Description + +A request for a filtered and sorted set of `Shift` objects. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | [**ShiftQuery**](ShiftQuery.md) | Query filters. | [optional] +**limit** | **Number** | number of resources in a page (200 by default). | [optional] +**cursor** | **String** | opaque cursor for fetching the next page. | [optional] + + diff --git a/docs/SearchShiftsResponse.md b/docs/SearchShiftsResponse.md new file mode 100644 index 0000000..665d79c --- /dev/null +++ b/docs/SearchShiftsResponse.md @@ -0,0 +1,14 @@ +# SquareConnect.SearchShiftsResponse + +### Description + +The response to a request for `Shift` objects. Contains the requested `Shift` objects. May contain a set of `Error` objects if the request resulted in errors. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shifts** | [**[Shift]**](Shift.md) | Shifts | [optional] +**cursor** | **String** | Opaque cursor for fetching the next page. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/Shift.md b/docs/Shift.md new file mode 100644 index 0000000..9df99f5 --- /dev/null +++ b/docs/Shift.md @@ -0,0 +1,34 @@ +# SquareConnect.Shift + +### Description + +A record of the hourly rate, start, and end times for a single work shift for an employee. May include a record of the start and end times for breaks taken during the shift. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | UUID for this object | [optional] +**employee_id** | **String** | The ID of the employee this shift belongs to. | +**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] +**wage** | [**ShiftWage**](ShiftWage.md) | Job and pay related information. | [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`. | [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] + + + +## Enum: StatusEnum + + +* `OPEN` (value: `"OPEN"`) + +* `CLOSED` (value: `"CLOSED"`) + + + + diff --git a/docs/ShiftFilter.md b/docs/ShiftFilter.md new file mode 100644 index 0000000..5ba41c1 --- /dev/null +++ b/docs/ShiftFilter.md @@ -0,0 +1,28 @@ +# SquareConnect.ShiftFilter + +### Description + +Defines a filter used in a search for `Shift` records. `AND` logic is used by Square's servers to apply each filter property specified. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**location_id** | **[String]** | Fetch shifts for the specified location. | [optional] +**employee_id** | **[String]** | Fetch shifts for the specified employee. | [optional] +**status** | **String** | Fetch a `Shift` instance by `Shift.status`. | [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] + + + +## Enum: StatusEnum + + +* `OPEN` (value: `"OPEN"`) + +* `CLOSED` (value: `"CLOSED"`) + + + + diff --git a/docs/ShiftFilterStatus.md b/docs/ShiftFilterStatus.md new file mode 100644 index 0000000..330235a --- /dev/null +++ b/docs/ShiftFilterStatus.md @@ -0,0 +1,10 @@ +# SquareConnect.ShiftFilterStatus + +## Enum + + +* `OPEN` (value: `"OPEN"`) + +* `CLOSED` (value: `"CLOSED"`) + + diff --git a/docs/ShiftQuery.md b/docs/ShiftQuery.md new file mode 100644 index 0000000..7ec1aa9 --- /dev/null +++ b/docs/ShiftQuery.md @@ -0,0 +1,13 @@ +# SquareConnect.ShiftQuery + +### Description + +The parameters of a `Shift` search query. Includes filter and sort options. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filter** | [**ShiftFilter**](ShiftFilter.md) | Query filter options | [optional] +**sort** | [**ShiftSort**](ShiftSort.md) | Sort order details | [optional] + + diff --git a/docs/ShiftSort.md b/docs/ShiftSort.md new file mode 100644 index 0000000..f6277cb --- /dev/null +++ b/docs/ShiftSort.md @@ -0,0 +1,39 @@ +# SquareConnect.ShiftSort + +### Description + +Sets the sort order of search results. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**field** | **String** | The field to sort on. | [optional] +**order** | **String** | The order in which results are returned. Defaults to DESC. | [optional] + + + +## Enum: FieldEnum + + +* `START_AT` (value: `"START_AT"`) + +* `END_AT` (value: `"END_AT"`) + +* `CREATED_AT` (value: `"CREATED_AT"`) + +* `UPDATED_AT` (value: `"UPDATED_AT"`) + + + + + +## Enum: OrderEnum + + +* `DESC` (value: `"DESC"`) + +* `ASC` (value: `"ASC"`) + + + + diff --git a/docs/ShiftSortField.md b/docs/ShiftSortField.md new file mode 100644 index 0000000..abb3886 --- /dev/null +++ b/docs/ShiftSortField.md @@ -0,0 +1,14 @@ +# SquareConnect.ShiftSortField + +## Enum + + +* `START_AT` (value: `"START_AT"`) + +* `END_AT` (value: `"END_AT"`) + +* `CREATED_AT` (value: `"CREATED_AT"`) + +* `UPDATED_AT` (value: `"UPDATED_AT"`) + + diff --git a/docs/ShiftStatus.md b/docs/ShiftStatus.md new file mode 100644 index 0000000..f13f21a --- /dev/null +++ b/docs/ShiftStatus.md @@ -0,0 +1,10 @@ +# SquareConnect.ShiftStatus + +## Enum + + +* `OPEN` (value: `"OPEN"`) + +* `CLOSED` (value: `"CLOSED"`) + + diff --git a/docs/ShiftWage.md b/docs/ShiftWage.md new file mode 100644 index 0000000..fb03730 --- /dev/null +++ b/docs/ShiftWage.md @@ -0,0 +1,13 @@ +# SquareConnect.ShiftWage + +### Description + +The hourly wage rate used to compensate an employee for this shift. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**title** | **String** | The name of the job performed during this shift. Square labor-reporting UIs may group shifts together by title. | [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/ShiftWorkday.md b/docs/ShiftWorkday.md new file mode 100644 index 0000000..c149f3e --- /dev/null +++ b/docs/ShiftWorkday.md @@ -0,0 +1,27 @@ +# SquareConnect.ShiftWorkday + +### 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. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**date_range** | [**DateRange**](DateRange.md) | Dates for fetching the shifts | [optional] +**match_shifts_by** | **String** | The strategy on which the dates are applied. | [optional] +**default_timezone** | **String** | Location-specific timezones convert workdays to datetime filters. Every location included in the query must have a timezone, or this field must be provided as a fallback. Format: the IANA timezone database identifier for the relevant timezone. | [optional] + + + +## Enum: MatchShiftsByEnum + + +* `START_AT` (value: `"START_AT"`) + +* `END_AT` (value: `"END_AT"`) + +* `INTERSECTION` (value: `"INTERSECTION"`) + + + + diff --git a/docs/ShiftWorkdayMatcher.md b/docs/ShiftWorkdayMatcher.md new file mode 100644 index 0000000..30426ba --- /dev/null +++ b/docs/ShiftWorkdayMatcher.md @@ -0,0 +1,12 @@ +# SquareConnect.ShiftWorkdayMatcher + +## Enum + + +* `START_AT` (value: `"START_AT"`) + +* `END_AT` (value: `"END_AT"`) + +* `INTERSECTION` (value: `"INTERSECTION"`) + + diff --git a/docs/SourceApplication.md b/docs/SourceApplication.md index cdf8115..4ecd44b 100644 --- a/docs/SourceApplication.md +++ b/docs/SourceApplication.md @@ -1,5 +1,9 @@ # SquareConnect.SourceApplication +### Description + +Provides information about the application used to generate an inventory change. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Tender.md b/docs/Tender.md index 5225414..79bb03e 100644 --- a/docs/Tender.md +++ b/docs/Tender.md @@ -1,5 +1,9 @@ # SquareConnect.Tender +### Description + +Represents a tender (i.e., a method of payment) used in a Square transaction. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TenderCardDetails.md b/docs/TenderCardDetails.md index 2146556..787a56e 100644 --- a/docs/TenderCardDetails.md +++ b/docs/TenderCardDetails.md @@ -1,5 +1,9 @@ # SquareConnect.TenderCardDetails +### Description + +Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD` + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TenderCashDetails.md b/docs/TenderCashDetails.md index 4d6321d..ecb7c8e 100644 --- a/docs/TenderCashDetails.md +++ b/docs/TenderCashDetails.md @@ -1,5 +1,9 @@ # SquareConnect.TenderCashDetails +### Description + +Represents the details of a tender with `type` `CASH`. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TimeRange.md b/docs/TimeRange.md index 8acbd4b..aa9fa99 100644 --- a/docs/TimeRange.md +++ b/docs/TimeRange.md @@ -1,5 +1,9 @@ # SquareConnect.TimeRange +### 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. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Transaction.md b/docs/Transaction.md index c82ed9a..f4e4db0 100644 --- a/docs/Transaction.md +++ b/docs/Transaction.md @@ -1,5 +1,9 @@ # SquareConnect.Transaction +### Description + +Represents a transaction processed with Square, either with the Connect API or with Square Point of Sale. The `tenders` field of this object lists all methods of payment used to pay in the transaction. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/TransactionsApi.md b/docs/TransactionsApi.md index 2f95703..f68a62c 100644 --- a/docs/TransactionsApi.md +++ b/docs/TransactionsApi.md @@ -194,7 +194,7 @@ 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. + '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 [Pagination](/basics/api101/pagination) for more information. }; apiInstance.listRefunds(locationId, opts).then(function(data) { console.log('API called successfully. Returned data: ' + data); @@ -212,7 +212,7 @@ Name | Type | Description | Notes **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] + **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 [Pagination](/basics/api101/pagination) for more information. | [optional] ### Return type @@ -252,7 +252,7 @@ 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. + '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 [Pagination](/basics/api101/pagination) for more information. }; apiInstance.listTransactions(locationId, opts).then(function(data) { console.log('API called successfully. Returned data: ' + data); @@ -270,7 +270,7 @@ Name | Type | Description | Notes **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] + **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 [Pagination](/basics/api101/pagination) for more information. | [optional] ### Return type diff --git a/docs/UpdateBreakTypeRequest.md b/docs/UpdateBreakTypeRequest.md new file mode 100644 index 0000000..1a35c96 --- /dev/null +++ b/docs/UpdateBreakTypeRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.UpdateBreakTypeRequest + +### Description + +A request to update a `BreakType` + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**break_type** | [**BreakType**](BreakType.md) | The updated `BreakType`. | [optional] + + diff --git a/docs/UpdateBreakTypeResponse.md b/docs/UpdateBreakTypeResponse.md new file mode 100644 index 0000000..54331c3 --- /dev/null +++ b/docs/UpdateBreakTypeResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.UpdateBreakTypeResponse + +### Description + +A response to a request to update a `BreakType`. Contains the requested `BreakType` objects. May contain a set of `Error` objects if the request resulted in errors. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**break_type** | [**BreakType**](BreakType.md) | The response object. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/UpdateCustomerRequest.md b/docs/UpdateCustomerRequest.md index 9fe38b3..bbc0e8c 100644 --- a/docs/UpdateCustomerRequest.md +++ b/docs/UpdateCustomerRequest.md @@ -1,5 +1,9 @@ # SquareConnect.UpdateCustomerRequest +### Description + +Defines the body parameters that can be provided in a request to the [UpdateCustomer](#endpoint-updatecustomer) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/UpdateCustomerResponse.md b/docs/UpdateCustomerResponse.md index 681b9e9..04868cd 100644 --- a/docs/UpdateCustomerResponse.md +++ b/docs/UpdateCustomerResponse.md @@ -1,5 +1,9 @@ # SquareConnect.UpdateCustomerResponse +### Description + +Defines the fields that are included in the response body of a request to the [UpdateCustomer](#endpoint-updatecustomer) endpoint. One of `errors` or `customer` is present in a given response (never both). + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/UpdateItemModifierListsRequest.md b/docs/UpdateItemModifierListsRequest.md index c021d26..542a218 100644 --- a/docs/UpdateItemModifierListsRequest.md +++ b/docs/UpdateItemModifierListsRequest.md @@ -1,5 +1,9 @@ # SquareConnect.UpdateItemModifierListsRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/UpdateItemModifierListsResponse.md b/docs/UpdateItemModifierListsResponse.md index af3d66a..5be9786 100644 --- a/docs/UpdateItemModifierListsResponse.md +++ b/docs/UpdateItemModifierListsResponse.md @@ -1,5 +1,9 @@ # SquareConnect.UpdateItemModifierListsResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/UpdateItemTaxesRequest.md b/docs/UpdateItemTaxesRequest.md index 4f713fc..2fd191b 100644 --- a/docs/UpdateItemTaxesRequest.md +++ b/docs/UpdateItemTaxesRequest.md @@ -1,5 +1,9 @@ # SquareConnect.UpdateItemTaxesRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/UpdateItemTaxesResponse.md b/docs/UpdateItemTaxesResponse.md index a2ef275..a1d9016 100644 --- a/docs/UpdateItemTaxesResponse.md +++ b/docs/UpdateItemTaxesResponse.md @@ -1,5 +1,9 @@ # SquareConnect.UpdateItemTaxesResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/UpdateShiftRequest.md b/docs/UpdateShiftRequest.md new file mode 100644 index 0000000..1f7d952 --- /dev/null +++ b/docs/UpdateShiftRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.UpdateShiftRequest + +### Description + +A request to update a `Shift` object. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shift** | [**Shift**](Shift.md) | The updated `Shift` object. | + + diff --git a/docs/UpdateShiftResponse.md b/docs/UpdateShiftResponse.md new file mode 100644 index 0000000..3918361 --- /dev/null +++ b/docs/UpdateShiftResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.UpdateShiftResponse + +### Description + +The response to a request to update a `Shift`. Contains the updated `Shift` object. May contain a set of `Error` objects if the request resulted in errors. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shift** | [**Shift**](Shift.md) | The updated `Shift`. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/UpdateWorkweekConfigRequest.md b/docs/UpdateWorkweekConfigRequest.md new file mode 100644 index 0000000..6b0a2ff --- /dev/null +++ b/docs/UpdateWorkweekConfigRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.UpdateWorkweekConfigRequest + +### Description + +A request to update a `WorkweekConfig` object + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**workweek_config** | [**WorkweekConfig**](WorkweekConfig.md) | The updated `WorkweekConfig` object. | [optional] + + diff --git a/docs/UpdateWorkweekConfigResponse.md b/docs/UpdateWorkweekConfigResponse.md new file mode 100644 index 0000000..ded0c52 --- /dev/null +++ b/docs/UpdateWorkweekConfigResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.UpdateWorkweekConfigResponse + +### Description + +The response to a request to update a `WorkweekConfig` object. Contains the updated `WorkweekConfig` object. May contain a set of `Error` objects if the request resulted in errors. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**workweek_config** | [**WorkweekConfig**](WorkweekConfig.md) | The response object. | [optional] +**errors** | [**[Error]**](Error.md) | Any errors that occurred during the request. | [optional] + + diff --git a/docs/UpsertCatalogObjectRequest.md b/docs/UpsertCatalogObjectRequest.md index ea2ecb5..3357692 100644 --- a/docs/UpsertCatalogObjectRequest.md +++ b/docs/UpsertCatalogObjectRequest.md @@ -1,9 +1,13 @@ # SquareConnect.UpsertCatalogObjectRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**idempotency_key** | **String** | A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency keys](#idempotencykeys) for more information. | +**idempotency_key** | **String** | A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency](/basics/api101/idempotency) for more information. | **object** | [**CatalogObject**](CatalogObject.md) | A [CatalogObject](#type-catalogobject) to be created or updated. The object's `is_deleted` field must not be set to `true`. When creating a new object, the object's ID must either start with a `#` character or be left blank. In either case it will be replaced with a server-generated ID. | diff --git a/docs/UpsertCatalogObjectResponse.md b/docs/UpsertCatalogObjectResponse.md index 91b0f50..b29fdae 100644 --- a/docs/UpsertCatalogObjectResponse.md +++ b/docs/UpsertCatalogObjectResponse.md @@ -1,5 +1,9 @@ # SquareConnect.UpsertCatalogObjectResponse +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/V1AdjustInventoryRequest.md b/docs/V1AdjustInventoryRequest.md index d1b6100..9316250 100644 --- a/docs/V1AdjustInventoryRequest.md +++ b/docs/V1AdjustInventoryRequest.md @@ -1,10 +1,14 @@ # SquareConnect.V1AdjustInventoryRequest +### Description + +V1AdjustInventoryRequest + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **quantity_delta** | **Number** | The number to adjust the variation's quantity by. | [optional] -**adjustment_type** | **String** | The reason for the inventory adjustment. | [optional] +**adjustment_type** | **String** | The reason for the inventory adjustment. See [V1AdjustInventoryRequestAdjustmentType](#type-v1adjustinventoryrequestadjustmenttype) for possible values | [optional] **memo** | **String** | A note about the inventory adjustment. | [optional] diff --git a/docs/V1AdjustInventoryRequestAdjustmentType.md b/docs/V1AdjustInventoryRequestAdjustmentType.md new file mode 100644 index 0000000..d3980e3 --- /dev/null +++ b/docs/V1AdjustInventoryRequestAdjustmentType.md @@ -0,0 +1,12 @@ +# SquareConnect.V1AdjustInventoryRequestAdjustmentType + +## Enum + + +* `SALE` (value: `"SALE"`) + +* `RECEIVE_STOCK` (value: `"RECEIVE_STOCK"`) + +* `MANUAL_ADJUST` (value: `"MANUAL_ADJUST"`) + + diff --git a/docs/V1ApplyFeeRequest.md b/docs/V1ApplyFeeRequest.md new file mode 100644 index 0000000..abe667b --- /dev/null +++ b/docs/V1ApplyFeeRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1ApplyFeeRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1ApplyModifierListRequest.md b/docs/V1ApplyModifierListRequest.md new file mode 100644 index 0000000..8dbf20b --- /dev/null +++ b/docs/V1ApplyModifierListRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1ApplyModifierListRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1BankAccount.md b/docs/V1BankAccount.md index fe16feb..31134e2 100644 --- a/docs/V1BankAccount.md +++ b/docs/V1BankAccount.md @@ -1,5 +1,9 @@ # SquareConnect.V1BankAccount +### Description + +V1BankAccount + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -10,7 +14,7 @@ Name | Type | Description | Notes **routing_number** | **String** | The bank account's routing number. | [optional] **account_number_suffix** | **String** | The last few digits of the bank account number. | [optional] **currency_code** | **String** | The currency code of the currency associated with the bank account, in ISO 4217 format. For example, the currency code for US dollars is USD. | [optional] -**type** | **String** | The bank account's type (for example, savings or checking). | [optional] +**type** | **String** | The bank account's type (for example, savings or checking). See [V1BankAccountType](#type-v1bankaccounttype) for possible values | [optional] diff --git a/docs/V1BankAccountType.md b/docs/V1BankAccountType.md new file mode 100644 index 0000000..dd237c9 --- /dev/null +++ b/docs/V1BankAccountType.md @@ -0,0 +1,18 @@ +# SquareConnect.V1BankAccountType + +## Enum + + +* `BUSINESS_CHECKING` (value: `"BUSINESS_CHECKING"`) + +* `CHECKING` (value: `"CHECKING"`) + +* `INVESTMENT` (value: `"INVESTMENT"`) + +* `LOAN` (value: `"LOAN"`) + +* `SAVINGS` (value: `"SAVINGS"`) + +* `OTHER` (value: `"OTHER"`) + + diff --git a/docs/V1CashDrawerEvent.md b/docs/V1CashDrawerEvent.md index 71b1a0a..c021928 100644 --- a/docs/V1CashDrawerEvent.md +++ b/docs/V1CashDrawerEvent.md @@ -1,11 +1,15 @@ # SquareConnect.V1CashDrawerEvent +### Description + +V1CashDrawerEvent + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The event's unique ID. | [optional] **employee_id** | **String** | The ID of the employee that created the event. | [optional] -**event_type** | **String** | The type of event that occurred. | [optional] +**event_type** | **String** | The type of event that occurred. See [V1CashDrawerEventEventType](#type-v1cashdrawereventeventtype) for possible values | [optional] **event_money** | [**V1Money**](V1Money.md) | The amount of money that was added to or removed from the cash drawer because of the event. This value can be positive (for added money) or negative (for removed money). | [optional] **created_at** | **String** | The time when the event occurred, in ISO 8601 format. | [optional] **description** | **String** | An optional description of the event, entered by the employee that created it. | [optional] diff --git a/docs/V1CashDrawerEventEventType.md b/docs/V1CashDrawerEventEventType.md new file mode 100644 index 0000000..5eabbb8 --- /dev/null +++ b/docs/V1CashDrawerEventEventType.md @@ -0,0 +1,24 @@ +# SquareConnect.V1CashDrawerEventEventType + +## Enum + + +* `NO_SALE` (value: `"NO_SALE"`) + +* `CASH_TENDER_PAYMENT` (value: `"CASH_TENDER_PAYMENT"`) + +* `OTHER_TENDER_PAYMENT` (value: `"OTHER_TENDER_PAYMENT"`) + +* `CASH_TENDER_CANCELED_PAYMENT` (value: `"CASH_TENDER_CANCELED_PAYMENT"`) + +* `OTHER_TENDER_CANCELED_PAYMENT` (value: `"OTHER_TENDER_CANCELED_PAYMENT"`) + +* `CASH_TENDER_REFUND` (value: `"CASH_TENDER_REFUND"`) + +* `OTHER_TENDER_REFUND` (value: `"OTHER_TENDER_REFUND"`) + +* `PAID_IN` (value: `"PAID_IN"`) + +* `PAID_OUT` (value: `"PAID_OUT"`) + + diff --git a/docs/V1CashDrawerShift.md b/docs/V1CashDrawerShift.md index 5661384..7cefe00 100644 --- a/docs/V1CashDrawerShift.md +++ b/docs/V1CashDrawerShift.md @@ -1,10 +1,14 @@ # SquareConnect.V1CashDrawerShift +### Description + +V1CashDrawerShift + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The shift's unique ID. | [optional] -**event_type** | **String** | The shift's current state. | [optional] +**event_type** | **String** | The shift's current state. See [V1CashDrawerShiftEventType](#type-v1cashdrawershifteventtype) for possible values | [optional] **opened_at** | **String** | The time when the shift began, in ISO 8601 format. | [optional] **ended_at** | **Boolean** | The time when the shift ended, in ISO 8601 format. | [optional] **closed_at** | **String** | The time when the shift was closed, in ISO 8601 format. | [optional] diff --git a/docs/V1CashDrawerShiftEventType.md b/docs/V1CashDrawerShiftEventType.md new file mode 100644 index 0000000..b438568 --- /dev/null +++ b/docs/V1CashDrawerShiftEventType.md @@ -0,0 +1,12 @@ +# SquareConnect.V1CashDrawerShiftEventType + +## Enum + + +* `OPEN` (value: `"OPEN"`) + +* `ENDED` (value: `"ENDED"`) + +* `CLOSED` (value: `"CLOSED"`) + + diff --git a/docs/V1Category.md b/docs/V1Category.md index 8c17bfe..3c60485 100644 --- a/docs/V1Category.md +++ b/docs/V1Category.md @@ -1,5 +1,9 @@ # SquareConnect.V1Category +### Description + +V1Category + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/V1CreateCategoryRequest.md b/docs/V1CreateCategoryRequest.md new file mode 100644 index 0000000..64a505b --- /dev/null +++ b/docs/V1CreateCategoryRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1CreateCategoryRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1Category**](V1Category.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] + + diff --git a/docs/V1CreateDiscountRequest.md b/docs/V1CreateDiscountRequest.md new file mode 100644 index 0000000..8102dd0 --- /dev/null +++ b/docs/V1CreateDiscountRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1CreateDiscountRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1Discount**](V1Discount.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] + + diff --git a/docs/V1CreateEmployeeRoleRequest.md b/docs/V1CreateEmployeeRoleRequest.md new file mode 100644 index 0000000..1452f24 --- /dev/null +++ b/docs/V1CreateEmployeeRoleRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1CreateEmployeeRoleRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**employee_role** | [**V1EmployeeRole**](V1EmployeeRole.md) | An EmployeeRole object with a name and permissions, and an optional owner flag. | [optional] + + diff --git a/docs/V1CreateFeeRequest.md b/docs/V1CreateFeeRequest.md new file mode 100644 index 0000000..bc123e0 --- /dev/null +++ b/docs/V1CreateFeeRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1CreateFeeRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1Fee**](V1Fee.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] + + diff --git a/docs/V1CreateItemRequest.md b/docs/V1CreateItemRequest.md new file mode 100644 index 0000000..f8fb21f --- /dev/null +++ b/docs/V1CreateItemRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1CreateItemRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1Item**](V1Item.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] + + diff --git a/docs/V1CreateModifierListRequest.md b/docs/V1CreateModifierListRequest.md new file mode 100644 index 0000000..7ba6595 --- /dev/null +++ b/docs/V1CreateModifierListRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1CreateModifierListRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1ModifierList**](V1ModifierList.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] + + diff --git a/docs/V1CreateModifierOptionRequest.md b/docs/V1CreateModifierOptionRequest.md new file mode 100644 index 0000000..1333495 --- /dev/null +++ b/docs/V1CreateModifierOptionRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1CreateModifierOptionRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1ModifierOption**](V1ModifierOption.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] + + diff --git a/docs/V1CreatePageRequest.md b/docs/V1CreatePageRequest.md new file mode 100644 index 0000000..2a3a3e4 --- /dev/null +++ b/docs/V1CreatePageRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1CreatePageRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1Page**](V1Page.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] + + diff --git a/docs/V1CreateRefundRequest.md b/docs/V1CreateRefundRequest.md index d6657c3..5cdee4d 100644 --- a/docs/V1CreateRefundRequest.md +++ b/docs/V1CreateRefundRequest.md @@ -1,10 +1,14 @@ # SquareConnect.V1CreateRefundRequest +### Description + +V1CreateRefundRequest + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**payment_id** | **String** | The ID of the payment to refund. If you're creating a PARTIAL refund for a split tender payment, instead provide the id of the particular tender you want to refund. See Split Tender Payments for details. | -**type** | **String** | TThe type of refund (FULL or PARTIAL). | +**payment_id** | **String** | The ID of the payment to refund. If you are creating a `PARTIAL` refund for a split tender payment, instead provide the id of the particular tender you want to refund. | +**type** | **String** | TThe type of refund (FULL or PARTIAL). See [V1CreateRefundRequestType](#type-v1createrefundrequesttype) for possible values | **reason** | **String** | The reason for the refund. | **refunded_money** | [**V1Money**](V1Money.md) | The amount of money to refund. Required only for PARTIAL refunds. | [optional] **request_idempotence_key** | **String** | An optional key to ensure idempotence if you issue the same PARTIAL refund request more than once. | [optional] diff --git a/docs/V1CreateRefundRequestType.md b/docs/V1CreateRefundRequestType.md new file mode 100644 index 0000000..94d7f73 --- /dev/null +++ b/docs/V1CreateRefundRequestType.md @@ -0,0 +1,10 @@ +# SquareConnect.V1CreateRefundRequestType + +## Enum + + +* `FULL` (value: `"FULL"`) + +* `PARTIAL` (value: `"PARTIAL"`) + + diff --git a/docs/V1CreateVariationRequest.md b/docs/V1CreateVariationRequest.md new file mode 100644 index 0000000..6a7210d --- /dev/null +++ b/docs/V1CreateVariationRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1CreateVariationRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1Variation**](V1Variation.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | [optional] + + diff --git a/docs/V1DeleteCategoryRequest.md b/docs/V1DeleteCategoryRequest.md new file mode 100644 index 0000000..1ff2ffd --- /dev/null +++ b/docs/V1DeleteCategoryRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1DeleteCategoryRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1DeleteDiscountRequest.md b/docs/V1DeleteDiscountRequest.md new file mode 100644 index 0000000..5698f64 --- /dev/null +++ b/docs/V1DeleteDiscountRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1DeleteDiscountRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1DeleteFeeRequest.md b/docs/V1DeleteFeeRequest.md new file mode 100644 index 0000000..f183c0f --- /dev/null +++ b/docs/V1DeleteFeeRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1DeleteFeeRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1DeleteItemRequest.md b/docs/V1DeleteItemRequest.md new file mode 100644 index 0000000..0a14b68 --- /dev/null +++ b/docs/V1DeleteItemRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1DeleteItemRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1DeleteModifierListRequest.md b/docs/V1DeleteModifierListRequest.md new file mode 100644 index 0000000..9f6976e --- /dev/null +++ b/docs/V1DeleteModifierListRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1DeleteModifierListRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1DeleteModifierOptionRequest.md b/docs/V1DeleteModifierOptionRequest.md new file mode 100644 index 0000000..c5ca7a7 --- /dev/null +++ b/docs/V1DeleteModifierOptionRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1DeleteModifierOptionRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1DeletePageCellRequest.md b/docs/V1DeletePageCellRequest.md new file mode 100644 index 0000000..540dbae --- /dev/null +++ b/docs/V1DeletePageCellRequest.md @@ -0,0 +1,13 @@ +# SquareConnect.V1DeletePageCellRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**row** | **String** | The row of the cell to clear. Always an integer between 0 and 4, inclusive. Row 0 is the top row. | [optional] +**column** | **String** | The column of the cell to clear. Always an integer between 0 and 4, inclusive. Column 0 is the leftmost column. | [optional] + + diff --git a/docs/V1DeletePageRequest.md b/docs/V1DeletePageRequest.md new file mode 100644 index 0000000..35bcbf8 --- /dev/null +++ b/docs/V1DeletePageRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1DeletePageRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1DeleteTimecardRequest.md b/docs/V1DeleteTimecardRequest.md new file mode 100644 index 0000000..30fd79b --- /dev/null +++ b/docs/V1DeleteTimecardRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1DeleteTimecardRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1DeleteTimecardResponse.md b/docs/V1DeleteTimecardResponse.md new file mode 100644 index 0000000..a278dcf --- /dev/null +++ b/docs/V1DeleteTimecardResponse.md @@ -0,0 +1,11 @@ +# SquareConnect.V1DeleteTimecardResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1DeleteVariationRequest.md b/docs/V1DeleteVariationRequest.md new file mode 100644 index 0000000..7ad0f5b --- /dev/null +++ b/docs/V1DeleteVariationRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1DeleteVariationRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1Discount.md b/docs/V1Discount.md index 90819fb..786fa6f 100644 --- a/docs/V1Discount.md +++ b/docs/V1Discount.md @@ -1,5 +1,9 @@ # SquareConnect.V1Discount +### Description + +V1Discount + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -7,9 +11,9 @@ Name | Type | Description | Notes **name** | **String** | The discount's name. | [optional] **rate** | **String** | The rate of the discount, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. This rate is 0 if discount_type is VARIABLE_PERCENTAGE. | [optional] **amount_money** | [**V1Money**](V1Money.md) | The amount of the discount. This amount is 0 if discount_type is VARIABLE_AMOUNT. This field is not included for rate-based discounts. | [optional] -**discount_type** | **String** | Indicates whether the discount is a FIXED value or entered at the time of sale. | [optional] +**discount_type** | **String** | Indicates whether the discount is a FIXED value or entered at the time of sale. See [V1DiscountDiscountType](#type-v1discountdiscounttype) for possible values | [optional] **pin_required** | **Boolean** | Indicates whether a mobile staff member needs to enter their PIN to apply the discount to a payment. | [optional] -**color** | **String** | The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. | [optional] +**color** | **String** | The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values | [optional] diff --git a/docs/V1DiscountColor.md b/docs/V1DiscountColor.md new file mode 100644 index 0000000..0c1c010 --- /dev/null +++ b/docs/V1DiscountColor.md @@ -0,0 +1,24 @@ +# SquareConnect.V1DiscountColor + +## Enum + + +* `9da2a6` (value: `"9da2a6"`) + +* `4ab200` (value: `"4ab200"`) + +* `0b8000` (value: `"0b8000"`) + +* `2952cc` (value: `"2952cc"`) + +* `a82ee5` (value: `"a82ee5"`) + +* `e5457a` (value: `"e5457a"`) + +* `b21212` (value: `"b21212"`) + +* `593c00` (value: `"593c00"`) + +* `e5BF00` (value: `"e5BF00"`) + + diff --git a/docs/V1DiscountDiscountType.md b/docs/V1DiscountDiscountType.md new file mode 100644 index 0000000..b385e2c --- /dev/null +++ b/docs/V1DiscountDiscountType.md @@ -0,0 +1,12 @@ +# SquareConnect.V1DiscountDiscountType + +## Enum + + +* `FIXED` (value: `"FIXED"`) + +* `VARIABLE_PERCENTAGE` (value: `"VARIABLE_PERCENTAGE"`) + +* `VARIABLE_AMOUNT` (value: `"VARIABLE_AMOUNT"`) + + diff --git a/docs/V1Employee.md b/docs/V1Employee.md index 492e48d..14abb43 100644 --- a/docs/V1Employee.md +++ b/docs/V1Employee.md @@ -1,5 +1,9 @@ # SquareConnect.V1Employee +### Description + +Represents one of a business's employees. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -9,7 +13,7 @@ Name | Type | Description | Notes **role_ids** | **[String]** | The ids of the employee's associated roles. Currently, you can specify only one or zero roles per employee. | [optional] **authorized_location_ids** | **[String]** | The IDs of the locations the employee is allowed to clock in at. | [optional] **email** | **String** | The employee's email address. | [optional] -**status** | **String** | CWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard. | [optional] +**status** | **String** | CWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard. See [V1EmployeeStatus](#type-v1employeestatus) for possible values | [optional] **external_id** | **String** | An ID the merchant can set to associate the employee with an entity in another system. | [optional] **created_at** | **String** | The time when the employee entity was created, in ISO 8601 format. | [optional] **updated_at** | **String** | The time when the employee entity was most recently updated, in ISO 8601 format. | [optional] diff --git a/docs/V1EmployeeRole.md b/docs/V1EmployeeRole.md index c66b152..9de8127 100644 --- a/docs/V1EmployeeRole.md +++ b/docs/V1EmployeeRole.md @@ -1,11 +1,15 @@ # SquareConnect.V1EmployeeRole +### Description + +V1EmployeeRole + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The role's unique ID, Can only be set by Square. | [optional] **name** | **String** | The role's merchant-defined name. | -**permissions** | **[String]** | The role's permissions. | +**permissions** | **[String]** | The role's permissions. See [V1EmployeeRolePermissions](#type-v1employeerolepermissions) for possible values | **is_owner** | **Boolean** | If true, employees with this role have all permissions, regardless of the values indicated in permissions. | [optional] **created_at** | **String** | The time when the employee entity was created, in ISO 8601 format. Is set by Square when the Role is created. | [optional] **updated_at** | **String** | The time when the employee entity was most recently updated, in ISO 8601 format. Is set by Square when the Role updated. | [optional] diff --git a/docs/V1EmployeeRolePermissions.md b/docs/V1EmployeeRolePermissions.md new file mode 100644 index 0000000..8a1e30a --- /dev/null +++ b/docs/V1EmployeeRolePermissions.md @@ -0,0 +1,20 @@ +# SquareConnect.V1EmployeeRolePermissions + +## Enum + + +* `ACCESS_SALES_HISTORY` (value: `"REGISTER_ACCESS_SALES_HISTORY"`) + +* `APPLY_RESTRICTED_DISCOUNTS` (value: `"REGISTER_APPLY_RESTRICTED_DISCOUNTS"`) + +* `CHANGE_SETTINGS` (value: `"REGISTER_CHANGE_SETTINGS"`) + +* `EDIT_ITEM` (value: `"REGISTER_EDIT_ITEM"`) + +* `ISSUE_REFUNDS` (value: `"REGISTER_ISSUE_REFUNDS"`) + +* `OPEN_CASH_DRAWER_OUTSIDE_SALE` (value: `"REGISTER_OPEN_CASH_DRAWER_OUTSIDE_SALE"`) + +* `VIEW_SUMMARY_REPORTS` (value: `"REGISTER_VIEW_SUMMARY_REPORTS"`) + + diff --git a/docs/V1EmployeeStatus.md b/docs/V1EmployeeStatus.md new file mode 100644 index 0000000..3f58092 --- /dev/null +++ b/docs/V1EmployeeStatus.md @@ -0,0 +1,10 @@ +# SquareConnect.V1EmployeeStatus + +## Enum + + +* `ACTIVE` (value: `"ACTIVE"`) + +* `INACTIVE` (value: `"INACTIVE"`) + + diff --git a/docs/V1EmployeesApi.md b/docs/V1EmployeesApi.md index 893989c..7afbbf2 100644 --- a/docs/V1EmployeesApi.md +++ b/docs/V1EmployeesApi.md @@ -4,31 +4,31 @@ All URIs are relative to *https://connect.squareup.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**createEmployee**](V1EmployeesApi.md#createEmployee) | **POST** /v1/me/employees | Creates an employee for a business. -[**createEmployeeRole**](V1EmployeesApi.md#createEmployeeRole) | **POST** /v1/me/roles | Creates an employee role you can then assign to employees. -[**createTimecard**](V1EmployeesApi.md#createTimecard) | **POST** /v1/me/timecards | Creates a timecard for an employee. Each timecard corresponds to a single shift. -[**deleteTimecard**](V1EmployeesApi.md#deleteTimecard) | **DELETE** /v1/me/timecards/{timecard_id} | Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. -[**listCashDrawerShifts**](V1EmployeesApi.md#listCashDrawerShifts) | **GET** /v1/{location_id}/cash-drawer-shifts | Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. -[**listEmployeeRoles**](V1EmployeesApi.md#listEmployeeRoles) | **GET** /v1/me/roles | Provides summary information for all of a business's employee roles. -[**listEmployees**](V1EmployeesApi.md#listEmployees) | **GET** /v1/me/employees | Provides summary information for all of a business's employees. -[**listTimecardEvents**](V1EmployeesApi.md#listTimecardEvents) | **GET** /v1/me/timecards/{timecard_id}/events | Provides summary information for all events associated with a particular timecard. -[**listTimecards**](V1EmployeesApi.md#listTimecards) | **GET** /v1/me/timecards | Provides summary information for all of a business's employee timecards. -[**retrieveCashDrawerShift**](V1EmployeesApi.md#retrieveCashDrawerShift) | **GET** /v1/{location_id}/cash-drawer-shifts/{shift_id} | Provides the details for a single cash drawer shift, including all events that occurred during the shift. -[**retrieveEmployee**](V1EmployeesApi.md#retrieveEmployee) | **GET** /v1/me/employees/{employee_id} | Provides the details for a single employee. -[**retrieveEmployeeRole**](V1EmployeesApi.md#retrieveEmployeeRole) | **GET** /v1/me/roles/{role_id} | Provides the details for a single employee role. -[**retrieveTimecard**](V1EmployeesApi.md#retrieveTimecard) | **GET** /v1/me/timecards/{timecard_id} | Provides the details for a single timecard. -[**updateEmployee**](V1EmployeesApi.md#updateEmployee) | **PUT** /v1/me/employees/{employee_id} | V1 UpdateEmployee -[**updateEmployeeRole**](V1EmployeesApi.md#updateEmployeeRole) | **PUT** /v1/me/roles/{role_id} | Modifies the details of an employee role. -[**updateTimecard**](V1EmployeesApi.md#updateTimecard) | **PUT** /v1/me/timecards/{timecard_id} | Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. +[**createEmployee**](V1EmployeesApi.md#createEmployee) | **POST** /v1/me/employees | CreateEmployee +[**createEmployeeRole**](V1EmployeesApi.md#createEmployeeRole) | **POST** /v1/me/roles | CreateEmployeeRole +[**createTimecard**](V1EmployeesApi.md#createTimecard) | **POST** /v1/me/timecards | CreateTimecard +[**deleteTimecard**](V1EmployeesApi.md#deleteTimecard) | **DELETE** /v1/me/timecards/{timecard_id} | DeleteTimecard +[**listCashDrawerShifts**](V1EmployeesApi.md#listCashDrawerShifts) | **GET** /v1/{location_id}/cash-drawer-shifts | ListCashDrawerShifts +[**listEmployeeRoles**](V1EmployeesApi.md#listEmployeeRoles) | **GET** /v1/me/roles | ListEmployeeRoles +[**listEmployees**](V1EmployeesApi.md#listEmployees) | **GET** /v1/me/employees | ListEmployees +[**listTimecardEvents**](V1EmployeesApi.md#listTimecardEvents) | **GET** /v1/me/timecards/{timecard_id}/events | ListTimecardEvents +[**listTimecards**](V1EmployeesApi.md#listTimecards) | **GET** /v1/me/timecards | ListTimecards +[**retrieveCashDrawerShift**](V1EmployeesApi.md#retrieveCashDrawerShift) | **GET** /v1/{location_id}/cash-drawer-shifts/{shift_id} | RetrieveCashDrawerShift +[**retrieveEmployee**](V1EmployeesApi.md#retrieveEmployee) | **GET** /v1/me/employees/{employee_id} | RetrieveEmployee +[**retrieveEmployeeRole**](V1EmployeesApi.md#retrieveEmployeeRole) | **GET** /v1/me/roles/{role_id} | RetrieveEmployeeRole +[**retrieveTimecard**](V1EmployeesApi.md#retrieveTimecard) | **GET** /v1/me/timecards/{timecard_id} | RetrieveTimecard +[**updateEmployee**](V1EmployeesApi.md#updateEmployee) | **PUT** /v1/me/employees/{employee_id} | UpdateEmployee +[**updateEmployeeRole**](V1EmployeesApi.md#updateEmployeeRole) | **PUT** /v1/me/roles/{role_id} | UpdateEmployeeRole +[**updateTimecard**](V1EmployeesApi.md#updateTimecard) | **PUT** /v1/me/timecards/{timecard_id} | UpdateTimecard # **createEmployee** > V1Employee createEmployee(body) -Creates an employee for a business. +CreateEmployee -Creates an employee for a business. + Use the CreateEmployee endpoint to add an employee to a Square account. Employees created with the Connect API have an initial status of `INACTIVE`. Inactive employees cannot sign in to Square Point of Sale until they are activated from the Square Dashboard. Employee status cannot be changed with the Connect API. <aside class=\"important\"> Employee entities cannot be deleted. To disable employee profiles, set the employee's status to <code>INACTIVE</code> </aside> ### Example ```javascript @@ -74,9 +74,9 @@ Name | Type | Description | Notes # **createEmployeeRole** > V1EmployeeRole createEmployeeRole(employeeRole) -Creates an employee role you can then assign to employees. +CreateEmployeeRole -Creates an employee role you can then assign to employees. +Creates an employee role you can then assign to employees. Square accounts can include any number of roles that can be assigned to employees. These roles define the actions and permissions granted to an employee with that role. For example, an employee with a \"Shift Manager\" role might be able to issue refunds in Square Point of Sale, whereas an employee with a \"Clerk\" role might not. Roles are assigned with the [V1UpdateEmployee](#endpoint-v1updateemployee) endpoint. An employee can have only one role at a time. If an employee has no role, they have none of the permissions associated with roles. All employees can accept payments with Square Point of Sale. ### Example ```javascript @@ -122,9 +122,9 @@ Name | Type | Description | Notes # **createTimecard** > V1Timecard createTimecard(body) -Creates a timecard for an employee. Each timecard corresponds to a single shift. +CreateTimecard -Creates a timecard for an employee. Each timecard corresponds to a single shift. +Creates a timecard for an employee and clocks them in with an `API_CREATE` event and a `clockin_time` set to the current time unless the request provides a different value. To import timecards from another system (rather than clocking someone in). Specify the `clockin_time` and* `clockout_time` in the request. Timecards correspond to exactly one shift for a given employee, bounded by the `clockin_time` and `clockout_time` fields. An employee is considered clocked in if they have a timecard that doesn't have a `clockout_time` set. An employee that is currently clocked in cannot be clocked in a second time. ### Example ```javascript @@ -170,9 +170,9 @@ Name | Type | Description | Notes # **deleteTimecard** > Object deleteTimecard(timecardId) -Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. +DeleteTimecard -Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. +Deletes a timecard. Timecards can also be deleted through the Square Dashboard. Deleted timecards are still accessible through Connect API endpoints, but cannot be modified. The `deleted` field of the `Timecard` object indicates whether the timecard has been deleted. *Note**: By default, deleted timecards appear alongside valid timecards in results returned by the [ListTimecards](#endpoint-v1employees-listtimecards) endpoint. To filter deleted timecards, include the `deleted` query parameter in the list request. <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside> ### Example ```javascript @@ -218,7 +218,7 @@ Name | Type | Description | Notes # **listCashDrawerShifts** > [V1CashDrawerShift] listCashDrawerShifts(locationId, opts) -Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. +ListCashDrawerShifts Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. @@ -274,7 +274,7 @@ Name | Type | Description | Notes # **listEmployeeRoles** > [V1EmployeeRole] listEmployeeRoles(opts) -Provides summary information for all of a business's employee roles. +ListEmployeeRoles Provides summary information for all of a business's employee roles. @@ -290,7 +290,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new SquareConnect.V1EmployeesApi(); var opts = { - 'order': "order_example", // String | The order in which employees are listed in the response, based on their created_at field.Default value: ASC + 'order': "order_example", // String | The order in which employees are listed in the response, based on their created_at field.Default value: ASC 'limit': 56, // Number | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. 'batchToken': "batchToken_example" // String | A pagination cursor to retrieve the next set of results for your original query to the endpoint. }; @@ -306,7 +306,7 @@ apiInstance.listEmployeeRoles(opts).then(function(data) { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **order** | **String**| The order in which employees are listed in the response, based on their created_at field.Default value: ASC | [optional] + **order** | **String**| The order in which employees are listed in the response, based on their created_at field.Default value: ASC | [optional] **limit** | **Number**| The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional] **batchToken** | **String**| A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] @@ -327,7 +327,7 @@ Name | Type | Description | Notes # **listEmployees** > [V1Employee] listEmployees(opts) -Provides summary information for all of a business's employees. +ListEmployees Provides summary information for all of a business's employees. @@ -343,7 +343,7 @@ oauth2.accessToken = 'YOUR ACCESS TOKEN'; var apiInstance = new SquareConnect.V1EmployeesApi(); var opts = { - 'order': "order_example", // String | The order in which employees are listed in the response, based on their created_at field. Default value: ASC + 'order': "order_example", // String | The order in which employees are listed in the response, based on their created_at field. Default value: ASC 'beginUpdatedAt': "beginUpdatedAt_example", // String | If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format 'endUpdatedAt': "endUpdatedAt_example", // String | If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format. 'beginCreatedAt': "beginCreatedAt_example", // String | If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format. @@ -365,7 +365,7 @@ apiInstance.listEmployees(opts).then(function(data) { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **order** | **String**| The order in which employees are listed in the response, based on their created_at field. Default value: ASC | [optional] + **order** | **String**| The order in which employees are listed in the response, based on their created_at field. Default value: ASC | [optional] **beginUpdatedAt** | **String**| If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format | [optional] **endUpdatedAt** | **String**| If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format. | [optional] **beginCreatedAt** | **String**| If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format. | [optional] @@ -392,9 +392,9 @@ Name | Type | Description | Notes # **listTimecardEvents** > [V1TimecardEvent] listTimecardEvents(timecardId) -Provides summary information for all events associated with a particular timecard. +ListTimecardEvents -Provides summary information for all events associated with a particular timecard. +Provides summary information for all events associated with a particular timecard. <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside> ### Example ```javascript @@ -440,7 +440,7 @@ Name | Type | Description | Notes # **listTimecards** > [V1Timecard] listTimecards(opts) -Provides summary information for all of a business's employee timecards. +ListTimecards Provides summary information for all of a business's employee timecards. @@ -509,7 +509,7 @@ Name | Type | Description | Notes # **retrieveCashDrawerShift** > V1CashDrawerShift retrieveCashDrawerShift(locationId, shiftId) -Provides the details for a single cash drawer shift, including all events that occurred during the shift. +RetrieveCashDrawerShift Provides the details for a single cash drawer shift, including all events that occurred during the shift. @@ -560,7 +560,7 @@ Name | Type | Description | Notes # **retrieveEmployee** > V1Employee retrieveEmployee(employeeId) -Provides the details for a single employee. +RetrieveEmployee Provides the details for a single employee. @@ -608,7 +608,7 @@ Name | Type | Description | Notes # **retrieveEmployeeRole** > V1EmployeeRole retrieveEmployeeRole(roleId) -Provides the details for a single employee role. +RetrieveEmployeeRole Provides the details for a single employee role. @@ -656,9 +656,9 @@ Name | Type | Description | Notes # **retrieveTimecard** > V1Timecard retrieveTimecard(timecardId) -Provides the details for a single timecard. +RetrieveTimecard -Provides the details for a single timecard. +Provides the details for a single timecard. <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside> ### Example ```javascript @@ -704,7 +704,9 @@ Name | Type | Description | Notes # **updateEmployee** > V1Employee updateEmployee(employeeId, body) -V1 UpdateEmployee +UpdateEmployee + + ### Example ```javascript @@ -753,7 +755,7 @@ Name | Type | Description | Notes # **updateEmployeeRole** > V1EmployeeRole updateEmployeeRole(roleId, body) -Modifies the details of an employee role. +UpdateEmployeeRole Modifies the details of an employee role. @@ -804,9 +806,9 @@ Name | Type | Description | Notes # **updateTimecard** > V1Timecard updateTimecard(timecardId, body) -Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. +UpdateTimecard -Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. +Modifies the details of a timecard with an `API_EDIT` event for the timecard. Updating an active timecard with a `clockout_time` clocks the employee out. ### Example ```javascript @@ -821,7 +823,7 @@ var apiInstance = new SquareConnect.V1EmployeesApi(); var timecardId = "timecardId_example"; // String | TThe ID of the timecard to modify. -var body = new SquareConnect.V1Timecard(); // V1Timecard | An object containing the fields to POST for the request. See the corresponding object definition for field details. +var body = new SquareConnect.V1Timecard(); // V1Timecard | An object containing the fields to POST for the request. See the corresponding object definition for field details. apiInstance.updateTimecard(timecardId, body).then(function(data) { console.log('API called successfully. Returned data: ' + data); @@ -836,7 +838,7 @@ apiInstance.updateTimecard(timecardId, body).then(function(data) { Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **timecardId** | **String**| TThe ID of the timecard to modify. | - **body** | [**V1Timecard**](V1Timecard.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + **body** | [**V1Timecard**](V1Timecard.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | ### Return type diff --git a/docs/V1Fee.md b/docs/V1Fee.md index 1da3aec..35b76a8 100644 --- a/docs/V1Fee.md +++ b/docs/V1Fee.md @@ -1,17 +1,21 @@ # SquareConnect.V1Fee +### Description + +V1Fee + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The fee's unique ID. | [optional] **name** | **String** | The fee's name. | [optional] **rate** | **String** | The rate of the fee, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. | [optional] -**calculation_phase** | **String** | Forthcoming | [optional] -**adjustment_type** | **String** | The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. | [optional] +**calculation_phase** | **String** | Forthcoming See [V1FeeCalculationPhase](#type-v1feecalculationphase) for possible values | [optional] +**adjustment_type** | **String** | The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. See [V1FeeAdjustmentType](#type-v1feeadjustmenttype) for possible values | [optional] **applies_to_custom_amounts** | **Boolean** | If true, the fee applies to custom amounts entered into Square Register that are not associated with a particular item. | [optional] **enabled** | **Boolean** | If true, the fee is applied to all appropriate items. If false, the fee is not applied at all. | [optional] -**inclusion_type** | **String** | Whether the fee is ADDITIVE or INCLUSIVE. | [optional] -**type** | **String** | In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. | [optional] +**inclusion_type** | **String** | Whether the fee is ADDITIVE or INCLUSIVE. See [V1FeeInclusionType](#type-v1feeinclusiontype) for possible values | [optional] +**type** | **String** | In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. See [V1FeeType](#type-v1feetype) for possible values | [optional] diff --git a/docs/V1FeeAdjustmentType.md b/docs/V1FeeAdjustmentType.md new file mode 100644 index 0000000..822dd4b --- /dev/null +++ b/docs/V1FeeAdjustmentType.md @@ -0,0 +1,8 @@ +# SquareConnect.V1FeeAdjustmentType + +## Enum + + +* `TAX` (value: `"TAX"`) + + diff --git a/docs/V1FeeCalculationPhase.md b/docs/V1FeeCalculationPhase.md new file mode 100644 index 0000000..b078a58 --- /dev/null +++ b/docs/V1FeeCalculationPhase.md @@ -0,0 +1,12 @@ +# SquareConnect.V1FeeCalculationPhase + +## Enum + + +* `FEE_SUBTOTAL_PHASE` (value: `"FEE_SUBTOTAL_PHASE"`) + +* `OTHER` (value: `"OTHER"`) + +* `FEE_TOTAL_PHASE` (value: `"FEE_TOTAL_PHASE"`) + + diff --git a/docs/V1FeeInclusionType.md b/docs/V1FeeInclusionType.md new file mode 100644 index 0000000..6c4d18b --- /dev/null +++ b/docs/V1FeeInclusionType.md @@ -0,0 +1,10 @@ +# SquareConnect.V1FeeInclusionType + +## Enum + + +* `ADDITIVE` (value: `"ADDITIVE"`) + +* `INCLUSIVE` (value: `"INCLUSIVE"`) + + diff --git a/docs/V1FeeType.md b/docs/V1FeeType.md new file mode 100644 index 0000000..e79a141 --- /dev/null +++ b/docs/V1FeeType.md @@ -0,0 +1,22 @@ +# SquareConnect.V1FeeType + +## Enum + + +* `CA_GST` (value: `"CA_GST"`) + +* `CA_HST` (value: `"CA_HST"`) + +* `CA_PST` (value: `"CA_PST"`) + +* `CA_QST` (value: `"CA_QST"`) + +* `JP_CONSUMPTION_TAX` (value: `"JP_CONSUMPTION_TAX"`) + +* `CA_PEI_PST` (value: `"CA_PEI_PST"`) + +* `US_SALES_TAX` (value: `"US_SALES_TAX"`) + +* `OTHER` (value: `"OTHER"`) + + diff --git a/docs/V1InventoryEntry.md b/docs/V1InventoryEntry.md index ab73115..a80a263 100644 --- a/docs/V1InventoryEntry.md +++ b/docs/V1InventoryEntry.md @@ -1,5 +1,9 @@ # SquareConnect.V1InventoryEntry +### Description + +V1InventoryEntry + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/V1Item.md b/docs/V1Item.md index e81af37..b51d3d6 100644 --- a/docs/V1Item.md +++ b/docs/V1Item.md @@ -1,15 +1,19 @@ # SquareConnect.V1Item +### Description + +V1Item + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The item's ID. Must be unique among all entity IDs ever provided on behalf of the merchant. You can never reuse an ID. This value can include alphanumeric characters, dashes (-), and underscores (_). | [optional] **name** | **String** | The item's name. | [optional] **description** | **String** | The item's description. | [optional] -**type** | **String** | The item's type. This value is NORMAL for almost all items. | [optional] -**color** | **String** | The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. | [optional] +**type** | **String** | The item's type. This value is NORMAL for almost all items. See [V1ItemType](#type-v1itemtype) for possible values | [optional] +**color** | **String** | The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values | [optional] **abbreviation** | **String** | The text of the item's display label in Square Register. Only up to the first five characters of the string are used. | [optional] -**visibility** | **String** | Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. | [optional] +**visibility** | **String** | Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. See [V1ItemVisibility](#type-v1itemvisibility) for possible values | [optional] **available_online** | **Boolean** | If true, the item can be added to shipping orders from the merchant's online store. | [optional] **master_image** | [**V1ItemImage**](V1ItemImage.md) | The item's master image, if any. | [optional] **category** | [**V1Category**](V1Category.md) | The category the item belongs to, if any. | [optional] diff --git a/docs/V1ItemColor.md b/docs/V1ItemColor.md new file mode 100644 index 0000000..32eb41d --- /dev/null +++ b/docs/V1ItemColor.md @@ -0,0 +1,24 @@ +# SquareConnect.V1ItemColor + +## Enum + + +* `9da2a6` (value: `"9da2a6"`) + +* `4ab200` (value: `"4ab200"`) + +* `0b8000` (value: `"0b8000"`) + +* `2952cc` (value: `"2952cc"`) + +* `a82ee5` (value: `"a82ee5"`) + +* `e5457a` (value: `"e5457a"`) + +* `b21212` (value: `"b21212"`) + +* `593c00` (value: `"593c00"`) + +* `e5BF00` (value: `"e5BF00"`) + + diff --git a/docs/V1ItemImage.md b/docs/V1ItemImage.md index 12de50e..7cc2177 100644 --- a/docs/V1ItemImage.md +++ b/docs/V1ItemImage.md @@ -1,5 +1,9 @@ # SquareConnect.V1ItemImage +### Description + +V1ItemImage + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/V1ItemType.md b/docs/V1ItemType.md new file mode 100644 index 0000000..97a2a60 --- /dev/null +++ b/docs/V1ItemType.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ItemType + +## Enum + + +* `NORMAL` (value: `"NORMAL"`) + +* `GIFT_CARD` (value: `"GIFT_CARD"`) + +* `OTHER` (value: `"OTHER"`) + + diff --git a/docs/V1ItemVisibility.md b/docs/V1ItemVisibility.md new file mode 100644 index 0000000..9f29dbe --- /dev/null +++ b/docs/V1ItemVisibility.md @@ -0,0 +1,10 @@ +# SquareConnect.V1ItemVisibility + +## Enum + + +* `PUBLIC` (value: `"PUBLIC"`) + +* `PRIVATE` (value: `"PRIVATE"`) + + diff --git a/docs/V1ItemsApi.md b/docs/V1ItemsApi.md index 959f767..8aaa2ab 100644 --- a/docs/V1ItemsApi.md +++ b/docs/V1ItemsApi.md @@ -4,53 +4,53 @@ All URIs are relative to *https://connect.squareup.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**adjustInventory**](V1ItemsApi.md#adjustInventory) | **POST** /v1/{location_id}/inventory/{variation_id} | Adjusts an item variation's current available inventory. -[**applyFee**](V1ItemsApi.md#applyFee) | **PUT** /v1/{location_id}/items/{item_id}/fees/{fee_id} | Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. -[**applyModifierList**](V1ItemsApi.md#applyModifierList) | **PUT** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. -[**createCategory**](V1ItemsApi.md#createCategory) | **POST** /v1/{location_id}/categories | Creates an item category. -[**createDiscount**](V1ItemsApi.md#createDiscount) | **POST** /v1/{location_id}/discounts | Creates a discount. -[**createFee**](V1ItemsApi.md#createFee) | **POST** /v1/{location_id}/fees | Creates a fee (tax). -[**createItem**](V1ItemsApi.md#createItem) | **POST** /v1/{location_id}/items | Creates an item and at least one variation for it. -[**createModifierList**](V1ItemsApi.md#createModifierList) | **POST** /v1/{location_id}/modifier-lists | Creates an item modifier list and at least one modifier option for it. -[**createModifierOption**](V1ItemsApi.md#createModifierOption) | **POST** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options | Creates an item modifier option and adds it to a modifier list. -[**createPage**](V1ItemsApi.md#createPage) | **POST** /v1/{location_id}/pages | Creates a Favorites page in Square Register. -[**createVariation**](V1ItemsApi.md#createVariation) | **POST** /v1/{location_id}/items/{item_id}/variations | Creates an item variation for an existing item. -[**deleteCategory**](V1ItemsApi.md#deleteCategory) | **DELETE** /v1/{location_id}/categories/{category_id} | Deletes an existing item category. -[**deleteDiscount**](V1ItemsApi.md#deleteDiscount) | **DELETE** /v1/{location_id}/discounts/{discount_id} | Deletes an existing discount. -[**deleteFee**](V1ItemsApi.md#deleteFee) | **DELETE** /v1/{location_id}/fees/{fee_id} | Deletes an existing fee (tax). -[**deleteItem**](V1ItemsApi.md#deleteItem) | **DELETE** /v1/{location_id}/items/{item_id} | Deletes an existing item and all item variations associated with it. -[**deleteModifierList**](V1ItemsApi.md#deleteModifierList) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id} | Deletes an existing item modifier list and all modifier options associated with it. -[**deleteModifierOption**](V1ItemsApi.md#deleteModifierOption) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | Deletes an existing item modifier option from a modifier list. -[**deletePage**](V1ItemsApi.md#deletePage) | **DELETE** /v1/{location_id}/pages/{page_id} | Deletes an existing Favorites page and all of its cells. -[**deletePageCell**](V1ItemsApi.md#deletePageCell) | **DELETE** /v1/{location_id}/pages/{page_id}/cells | Deletes a cell from a Favorites page in Square Register. -[**deleteVariation**](V1ItemsApi.md#deleteVariation) | **DELETE** /v1/{location_id}/items/{item_id}/variations/{variation_id} | Deletes an existing item variation from an item. -[**listCategories**](V1ItemsApi.md#listCategories) | **GET** /v1/{location_id}/categories | Lists all of a location's item categories. -[**listDiscounts**](V1ItemsApi.md#listDiscounts) | **GET** /v1/{location_id}/discounts | Lists all of a location's discounts. -[**listFees**](V1ItemsApi.md#listFees) | **GET** /v1/{location_id}/fees | Lists all of a location's fees (taxes). -[**listInventory**](V1ItemsApi.md#listInventory) | **GET** /v1/{location_id}/inventory | Provides inventory information for all of a merchant's inventory-enabled item variations. -[**listItems**](V1ItemsApi.md#listItems) | **GET** /v1/{location_id}/items | Provides summary information for all of a location's items. -[**listModifierLists**](V1ItemsApi.md#listModifierLists) | **GET** /v1/{location_id}/modifier-lists | Lists all of a location's modifier lists. -[**listPages**](V1ItemsApi.md#listPages) | **GET** /v1/{location_id}/pages | Lists all of a location's Favorites pages in Square Register. -[**removeFee**](V1ItemsApi.md#removeFee) | **DELETE** /v1/{location_id}/items/{item_id}/fees/{fee_id} | Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. -[**removeModifierList**](V1ItemsApi.md#removeModifierList) | **DELETE** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. -[**retrieveItem**](V1ItemsApi.md#retrieveItem) | **GET** /v1/{location_id}/items/{item_id} | Provides the details for a single item, including associated modifier lists and fees. -[**retrieveModifierList**](V1ItemsApi.md#retrieveModifierList) | **GET** /v1/{location_id}/modifier-lists/{modifier_list_id} | Provides the details for a single modifier list. -[**updateCategory**](V1ItemsApi.md#updateCategory) | **PUT** /v1/{location_id}/categories/{category_id} | Modifies the details of an existing item category. -[**updateDiscount**](V1ItemsApi.md#updateDiscount) | **PUT** /v1/{location_id}/discounts/{discount_id} | Modifies the details of an existing discount. -[**updateFee**](V1ItemsApi.md#updateFee) | **PUT** /v1/{location_id}/fees/{fee_id} | Modifies the details of an existing fee (tax). -[**updateItem**](V1ItemsApi.md#updateItem) | **PUT** /v1/{location_id}/items/{item_id} | Modifies the core details of an existing item. -[**updateModifierList**](V1ItemsApi.md#updateModifierList) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id} | Modifies the details of an existing item modifier list. -[**updateModifierOption**](V1ItemsApi.md#updateModifierOption) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | Modifies the details of an existing item modifier option. -[**updatePage**](V1ItemsApi.md#updatePage) | **PUT** /v1/{location_id}/pages/{page_id} | Modifies the details of a Favorites page in Square Register. -[**updatePageCell**](V1ItemsApi.md#updatePageCell) | **PUT** /v1/{location_id}/pages/{page_id}/cells | Modifies a cell of a Favorites page in Square Register. -[**updateVariation**](V1ItemsApi.md#updateVariation) | **PUT** /v1/{location_id}/items/{item_id}/variations/{variation_id} | Modifies the details of an existing item variation. +[**adjustInventory**](V1ItemsApi.md#adjustInventory) | **POST** /v1/{location_id}/inventory/{variation_id} | AdjustInventory +[**applyFee**](V1ItemsApi.md#applyFee) | **PUT** /v1/{location_id}/items/{item_id}/fees/{fee_id} | ApplyFee +[**applyModifierList**](V1ItemsApi.md#applyModifierList) | **PUT** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | ApplyModifierList +[**createCategory**](V1ItemsApi.md#createCategory) | **POST** /v1/{location_id}/categories | CreateCategory +[**createDiscount**](V1ItemsApi.md#createDiscount) | **POST** /v1/{location_id}/discounts | CreateDiscount +[**createFee**](V1ItemsApi.md#createFee) | **POST** /v1/{location_id}/fees | CreateFee +[**createItem**](V1ItemsApi.md#createItem) | **POST** /v1/{location_id}/items | CreateItem +[**createModifierList**](V1ItemsApi.md#createModifierList) | **POST** /v1/{location_id}/modifier-lists | CreateModifierList +[**createModifierOption**](V1ItemsApi.md#createModifierOption) | **POST** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options | CreateModifierOption +[**createPage**](V1ItemsApi.md#createPage) | **POST** /v1/{location_id}/pages | CreatePage +[**createVariation**](V1ItemsApi.md#createVariation) | **POST** /v1/{location_id}/items/{item_id}/variations | CreateVariation +[**deleteCategory**](V1ItemsApi.md#deleteCategory) | **DELETE** /v1/{location_id}/categories/{category_id} | DeleteCategory +[**deleteDiscount**](V1ItemsApi.md#deleteDiscount) | **DELETE** /v1/{location_id}/discounts/{discount_id} | DeleteDiscount +[**deleteFee**](V1ItemsApi.md#deleteFee) | **DELETE** /v1/{location_id}/fees/{fee_id} | DeleteFee +[**deleteItem**](V1ItemsApi.md#deleteItem) | **DELETE** /v1/{location_id}/items/{item_id} | DeleteItem +[**deleteModifierList**](V1ItemsApi.md#deleteModifierList) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id} | DeleteModifierList +[**deleteModifierOption**](V1ItemsApi.md#deleteModifierOption) | **DELETE** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | DeleteModifierOption +[**deletePage**](V1ItemsApi.md#deletePage) | **DELETE** /v1/{location_id}/pages/{page_id} | DeletePage +[**deletePageCell**](V1ItemsApi.md#deletePageCell) | **DELETE** /v1/{location_id}/pages/{page_id}/cells | DeletePageCell +[**deleteVariation**](V1ItemsApi.md#deleteVariation) | **DELETE** /v1/{location_id}/items/{item_id}/variations/{variation_id} | DeleteVariation +[**listCategories**](V1ItemsApi.md#listCategories) | **GET** /v1/{location_id}/categories | ListCategories +[**listDiscounts**](V1ItemsApi.md#listDiscounts) | **GET** /v1/{location_id}/discounts | ListDiscounts +[**listFees**](V1ItemsApi.md#listFees) | **GET** /v1/{location_id}/fees | ListFees +[**listInventory**](V1ItemsApi.md#listInventory) | **GET** /v1/{location_id}/inventory | ListInventory +[**listItems**](V1ItemsApi.md#listItems) | **GET** /v1/{location_id}/items | ListItems +[**listModifierLists**](V1ItemsApi.md#listModifierLists) | **GET** /v1/{location_id}/modifier-lists | ListModifierLists +[**listPages**](V1ItemsApi.md#listPages) | **GET** /v1/{location_id}/pages | ListPages +[**removeFee**](V1ItemsApi.md#removeFee) | **DELETE** /v1/{location_id}/items/{item_id}/fees/{fee_id} | RemoveFee +[**removeModifierList**](V1ItemsApi.md#removeModifierList) | **DELETE** /v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id} | RemoveModifierList +[**retrieveItem**](V1ItemsApi.md#retrieveItem) | **GET** /v1/{location_id}/items/{item_id} | RetrieveItem +[**retrieveModifierList**](V1ItemsApi.md#retrieveModifierList) | **GET** /v1/{location_id}/modifier-lists/{modifier_list_id} | RetrieveModifierList +[**updateCategory**](V1ItemsApi.md#updateCategory) | **PUT** /v1/{location_id}/categories/{category_id} | UpdateCategory +[**updateDiscount**](V1ItemsApi.md#updateDiscount) | **PUT** /v1/{location_id}/discounts/{discount_id} | UpdateDiscount +[**updateFee**](V1ItemsApi.md#updateFee) | **PUT** /v1/{location_id}/fees/{fee_id} | UpdateFee +[**updateItem**](V1ItemsApi.md#updateItem) | **PUT** /v1/{location_id}/items/{item_id} | UpdateItem +[**updateModifierList**](V1ItemsApi.md#updateModifierList) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id} | UpdateModifierList +[**updateModifierOption**](V1ItemsApi.md#updateModifierOption) | **PUT** /v1/{location_id}/modifier-lists/{modifier_list_id}/modifier-options/{modifier_option_id} | UpdateModifierOption +[**updatePage**](V1ItemsApi.md#updatePage) | **PUT** /v1/{location_id}/pages/{page_id} | UpdatePage +[**updatePageCell**](V1ItemsApi.md#updatePageCell) | **PUT** /v1/{location_id}/pages/{page_id}/cells | UpdatePageCell +[**updateVariation**](V1ItemsApi.md#updateVariation) | **PUT** /v1/{location_id}/items/{item_id}/variations/{variation_id} | UpdateVariation # **adjustInventory** > V1InventoryEntry adjustInventory(locationId, variationId, body) -Adjusts an item variation's current available inventory. +AdjustInventory Adjusts an item variation's current available inventory. @@ -104,7 +104,7 @@ Name | Type | Description | Notes # **applyFee** > V1Item applyFee(locationId, itemId, feeId) -Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. +ApplyFee Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. @@ -158,7 +158,7 @@ Name | Type | Description | Notes # **applyModifierList** > V1Item applyModifierList(locationId, modifierListId, itemId) -Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. +ApplyModifierList Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. @@ -212,7 +212,7 @@ Name | Type | Description | Notes # **createCategory** > V1Category createCategory(locationId, body) -Creates an item category. +CreateCategory Creates an item category. @@ -263,7 +263,7 @@ Name | Type | Description | Notes # **createDiscount** > V1Discount createDiscount(locationId, body) -Creates a discount. +CreateDiscount Creates a discount. @@ -314,7 +314,7 @@ Name | Type | Description | Notes # **createFee** > V1Fee createFee(locationId, body) -Creates a fee (tax). +CreateFee Creates a fee (tax). @@ -365,9 +365,9 @@ Name | Type | Description | Notes # **createItem** > V1Item createItem(locationId, body) -Creates an item and at least one variation for it. +CreateItem -Creates an item and at least one variation for it. +Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify its `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. ### Example ```javascript @@ -416,7 +416,7 @@ Name | Type | Description | Notes # **createModifierList** > V1ModifierList createModifierList(locationId, body) -Creates an item modifier list and at least one modifier option for it. +CreateModifierList Creates an item modifier list and at least one modifier option for it. @@ -467,7 +467,7 @@ Name | Type | Description | Notes # **createModifierOption** > V1ModifierOption createModifierOption(locationId, modifierListId, body) -Creates an item modifier option and adds it to a modifier list. +CreateModifierOption Creates an item modifier option and adds it to a modifier list. @@ -521,7 +521,7 @@ Name | Type | Description | Notes # **createPage** > V1Page createPage(locationId, body) -Creates a Favorites page in Square Register. +CreatePage Creates a Favorites page in Square Register. @@ -572,7 +572,7 @@ Name | Type | Description | Notes # **createVariation** > V1Variation createVariation(locationId, itemId, body) -Creates an item variation for an existing item. +CreateVariation Creates an item variation for an existing item. @@ -626,9 +626,9 @@ Name | Type | Description | Notes # **deleteCategory** > V1Category deleteCategory(locationId, categoryId) -Deletes an existing item category. +DeleteCategory -Deletes an existing item category. +Deletes an existing item category. *Note**: DeleteCategory returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. ### Example ```javascript @@ -677,9 +677,9 @@ Name | Type | Description | Notes # **deleteDiscount** > V1Discount deleteDiscount(locationId, discountId) -Deletes an existing discount. +DeleteDiscount -Deletes an existing discount. +Deletes an existing discount. *Note**: DeleteDiscount returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. ### Example ```javascript @@ -728,9 +728,9 @@ Name | Type | Description | Notes # **deleteFee** > V1Fee deleteFee(locationId, feeId) -Deletes an existing fee (tax). +DeleteFee -Deletes an existing fee (tax). +Deletes an existing fee (tax). *Note**: DeleteFee returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. ### Example ```javascript @@ -779,9 +779,9 @@ Name | Type | Description | Notes # **deleteItem** > V1Item deleteItem(locationId, itemId) -Deletes an existing item and all item variations associated with it. +DeleteItem -Deletes an existing item and all item variations associated with it. +Deletes an existing item and all item variations associated with it. *Note**: DeleteItem returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. ### Example ```javascript @@ -830,9 +830,9 @@ Name | Type | Description | Notes # **deleteModifierList** > V1ModifierList deleteModifierList(locationId, modifierListId) -Deletes an existing item modifier list and all modifier options associated with it. +DeleteModifierList -Deletes an existing item modifier list and all modifier options associated with it. +Deletes an existing item modifier list and all modifier options associated with it. *Note**: DeleteModifierList returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. ### Example ```javascript @@ -881,9 +881,9 @@ Name | Type | Description | Notes # **deleteModifierOption** > V1ModifierOption deleteModifierOption(locationId, modifierListId, modifierOptionId) -Deletes an existing item modifier option from a modifier list. +DeleteModifierOption -Deletes an existing item modifier option from a modifier list. +Deletes an existing item modifier option from a modifier list. *Note**: DeleteModifierOption returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object as documented below. ### Example ```javascript @@ -935,9 +935,9 @@ Name | Type | Description | Notes # **deletePage** > V1Page deletePage(locationId, pageId) -Deletes an existing Favorites page and all of its cells. +DeletePage -Deletes an existing Favorites page and all of its cells. +Deletes an existing Favorites page and all of its cells. *Note**: DeletePage returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object as documented below. ### Example ```javascript @@ -986,9 +986,9 @@ Name | Type | Description | Notes # **deletePageCell** > V1Page deletePageCell(locationId, pageId, opts) -Deletes a cell from a Favorites page in Square Register. +DeletePageCell -Deletes a cell from a Favorites page in Square Register. +Deletes a cell from a Favorites page in Square Register. *Note**: DeletePageCell returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. ### Example ```javascript @@ -1043,9 +1043,9 @@ Name | Type | Description | Notes # **deleteVariation** > V1Variation deleteVariation(locationId, itemId, variationId) -Deletes an existing item variation from an item. +DeleteVariation -Deletes an existing item variation from an item. +Deletes an existing item variation from an item. *Note**: DeleteVariation returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. ### Example ```javascript @@ -1097,7 +1097,7 @@ Name | Type | Description | Notes # **listCategories** > [V1Category] listCategories(locationId) -Lists all of a location's item categories. +ListCategories Lists all of a location's item categories. @@ -1145,7 +1145,7 @@ Name | Type | Description | Notes # **listDiscounts** > [V1Discount] listDiscounts(locationId) -Lists all of a location's discounts. +ListDiscounts Lists all of a location's discounts. @@ -1193,7 +1193,7 @@ Name | Type | Description | Notes # **listFees** > [V1Fee] listFees(locationId) -Lists all of a location's fees (taxes). +ListFees Lists all of a location's fees (taxes). @@ -1241,7 +1241,7 @@ Name | Type | Description | Notes # **listInventory** > [V1InventoryEntry] listInventory(locationId, opts) -Provides inventory information for all of a merchant's inventory-enabled item variations. +ListInventory Provides inventory information for all of a merchant's inventory-enabled item variations. @@ -1295,7 +1295,7 @@ Name | Type | Description | Notes # **listItems** > [V1Item] listItems(locationId, opts) -Provides summary information for all of a location's items. +ListItems Provides summary information for all of a location's items. @@ -1347,7 +1347,7 @@ Name | Type | Description | Notes # **listModifierLists** > [V1ModifierList] listModifierLists(locationId) -Lists all of a location's modifier lists. +ListModifierLists Lists all of a location's modifier lists. @@ -1395,7 +1395,7 @@ Name | Type | Description | Notes # **listPages** > [V1Page] listPages(locationId) -Lists all of a location's Favorites pages in Square Register. +ListPages Lists all of a location's Favorites pages in Square Register. @@ -1443,7 +1443,7 @@ Name | Type | Description | Notes # **removeFee** > V1Item removeFee(locationId, itemId, feeId) -Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. +RemoveFee Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. @@ -1497,7 +1497,7 @@ Name | Type | Description | Notes # **removeModifierList** > V1Item removeModifierList(locationId, modifierListId, itemId) -Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. +RemoveModifierList Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. @@ -1551,7 +1551,7 @@ Name | Type | Description | Notes # **retrieveItem** > V1Item retrieveItem(locationId, itemId) -Provides the details for a single item, including associated modifier lists and fees. +RetrieveItem Provides the details for a single item, including associated modifier lists and fees. @@ -1602,7 +1602,7 @@ Name | Type | Description | Notes # **retrieveModifierList** > V1ModifierList retrieveModifierList(locationId, modifierListId) -Provides the details for a single modifier list. +RetrieveModifierList Provides the details for a single modifier list. @@ -1653,7 +1653,7 @@ Name | Type | Description | Notes # **updateCategory** > V1Category updateCategory(locationId, categoryId, body) -Modifies the details of an existing item category. +UpdateCategory Modifies the details of an existing item category. @@ -1707,7 +1707,7 @@ Name | Type | Description | Notes # **updateDiscount** > V1Discount updateDiscount(locationId, discountId, body) -Modifies the details of an existing discount. +UpdateDiscount Modifies the details of an existing discount. @@ -1761,7 +1761,7 @@ Name | Type | Description | Notes # **updateFee** > V1Fee updateFee(locationId, feeId, body) -Modifies the details of an existing fee (tax). +UpdateFee Modifies the details of an existing fee (tax). @@ -1815,7 +1815,7 @@ Name | Type | Description | Notes # **updateItem** > V1Item updateItem(locationId, itemId, body) -Modifies the core details of an existing item. +UpdateItem Modifies the core details of an existing item. @@ -1869,7 +1869,7 @@ Name | Type | Description | Notes # **updateModifierList** > V1ModifierList updateModifierList(locationId, modifierListId, body) -Modifies the details of an existing item modifier list. +UpdateModifierList Modifies the details of an existing item modifier list. @@ -1923,7 +1923,7 @@ Name | Type | Description | Notes # **updateModifierOption** > V1ModifierOption updateModifierOption(locationId, modifierListId, modifierOptionId, body) -Modifies the details of an existing item modifier option. +UpdateModifierOption Modifies the details of an existing item modifier option. @@ -1980,7 +1980,7 @@ Name | Type | Description | Notes # **updatePage** > V1Page updatePage(locationId, pageId, body) -Modifies the details of a Favorites page in Square Register. +UpdatePage Modifies the details of a Favorites page in Square Register. @@ -2034,7 +2034,7 @@ Name | Type | Description | Notes # **updatePageCell** > V1Page updatePageCell(locationId, pageId, body) -Modifies a cell of a Favorites page in Square Register. +UpdatePageCell Modifies a cell of a Favorites page in Square Register. @@ -2088,7 +2088,7 @@ Name | Type | Description | Notes # **updateVariation** > V1Variation updateVariation(locationId, itemId, variationId, body) -Modifies the details of an existing item variation. +UpdateVariation Modifies the details of an existing item variation. diff --git a/docs/V1ListBankAccountsRequest.md b/docs/V1ListBankAccountsRequest.md new file mode 100644 index 0000000..c804671 --- /dev/null +++ b/docs/V1ListBankAccountsRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1ListBankAccountsRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1ListBankAccountsResponse.md b/docs/V1ListBankAccountsResponse.md new file mode 100644 index 0000000..f2a4d95 --- /dev/null +++ b/docs/V1ListBankAccountsResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListBankAccountsResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1BankAccount]**](V1BankAccount.md) | | [optional] + + diff --git a/docs/V1ListCashDrawerShiftsRequest.md b/docs/V1ListCashDrawerShiftsRequest.md new file mode 100644 index 0000000..55a4061 --- /dev/null +++ b/docs/V1ListCashDrawerShiftsRequest.md @@ -0,0 +1,25 @@ +# SquareConnect.V1ListCashDrawerShiftsRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**order** | **String** | The order in which cash drawer shifts are listed in the response, based on their created_at field. Default value: ASC See [SortOrder](#type-sortorder) for possible values | [optional] +**begin_time** | **String** | The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time minus 90 days. | [optional] +**end_time** | **String** | The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time. | [optional] + + + +## Enum: OrderEnum + + +* `DESC` (value: `"DESC"`) + +* `ASC` (value: `"ASC"`) + + + + diff --git a/docs/V1ListCashDrawerShiftsResponse.md b/docs/V1ListCashDrawerShiftsResponse.md new file mode 100644 index 0000000..130c2b6 --- /dev/null +++ b/docs/V1ListCashDrawerShiftsResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListCashDrawerShiftsResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1CashDrawerShift]**](V1CashDrawerShift.md) | | [optional] + + diff --git a/docs/V1ListCategoriesRequest.md b/docs/V1ListCategoriesRequest.md new file mode 100644 index 0000000..d5f03ac --- /dev/null +++ b/docs/V1ListCategoriesRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1ListCategoriesRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1ListCategoriesResponse.md b/docs/V1ListCategoriesResponse.md new file mode 100644 index 0000000..52dbb7b --- /dev/null +++ b/docs/V1ListCategoriesResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListCategoriesResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1Category]**](V1Category.md) | | [optional] + + diff --git a/docs/V1ListDiscountsRequest.md b/docs/V1ListDiscountsRequest.md new file mode 100644 index 0000000..83386ff --- /dev/null +++ b/docs/V1ListDiscountsRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1ListDiscountsRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1ListDiscountsResponse.md b/docs/V1ListDiscountsResponse.md new file mode 100644 index 0000000..e221668 --- /dev/null +++ b/docs/V1ListDiscountsResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListDiscountsResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1Discount]**](V1Discount.md) | | [optional] + + diff --git a/docs/V1ListEmployeeRolesRequest.md b/docs/V1ListEmployeeRolesRequest.md new file mode 100644 index 0000000..37ba1c9 --- /dev/null +++ b/docs/V1ListEmployeeRolesRequest.md @@ -0,0 +1,25 @@ +# SquareConnect.V1ListEmployeeRolesRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**order** | **String** | The order in which employees are listed in the response, based on their created_at field.Default value: ASC See [SortOrder](#type-sortorder) for possible values | [optional] +**limit** | **Number** | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional] +**batch_token** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] + + + +## Enum: OrderEnum + + +* `DESC` (value: `"DESC"`) + +* `ASC` (value: `"ASC"`) + + + + diff --git a/docs/V1ListEmployeeRolesResponse.md b/docs/V1ListEmployeeRolesResponse.md new file mode 100644 index 0000000..d4b9e84 --- /dev/null +++ b/docs/V1ListEmployeeRolesResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListEmployeeRolesResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1EmployeeRole]**](V1EmployeeRole.md) | | [optional] + + diff --git a/docs/V1ListEmployeesRequest.md b/docs/V1ListEmployeesRequest.md new file mode 100644 index 0000000..624a1e3 --- /dev/null +++ b/docs/V1ListEmployeesRequest.md @@ -0,0 +1,42 @@ +# SquareConnect.V1ListEmployeesRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**order** | **String** | The order in which employees are listed in the response, based on their created_at field. Default value: ASC See [SortOrder](#type-sortorder) for possible values | [optional] +**begin_updated_at** | **String** | If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format | [optional] +**end_updated_at** | **String** | If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format. | [optional] +**begin_created_at** | **String** | If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format. | [optional] +**end_created_at** | **String** | If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format. | [optional] +**status** | **String** | If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE). See [V1ListEmployeesRequestStatus](#type-v1listemployeesrequeststatus) for possible values | [optional] +**external_id** | **String** | If provided, the endpoint returns only employee entities with the specified external_id. | [optional] +**limit** | **Number** | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional] +**batch_token** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] + + + +## Enum: OrderEnum + + +* `DESC` (value: `"DESC"`) + +* `ASC` (value: `"ASC"`) + + + + + +## Enum: StatusEnum + + +* `ACTIVE` (value: `"ACTIVE"`) + +* `INACTIVE` (value: `"INACTIVE"`) + + + + diff --git a/docs/V1ListEmployeesRequestStatus.md b/docs/V1ListEmployeesRequestStatus.md new file mode 100644 index 0000000..e723bab --- /dev/null +++ b/docs/V1ListEmployeesRequestStatus.md @@ -0,0 +1,10 @@ +# SquareConnect.V1ListEmployeesRequestStatus + +## Enum + + +* `ACTIVE` (value: `"ACTIVE"`) + +* `INACTIVE` (value: `"INACTIVE"`) + + diff --git a/docs/V1ListEmployeesResponse.md b/docs/V1ListEmployeesResponse.md new file mode 100644 index 0000000..09e2849 --- /dev/null +++ b/docs/V1ListEmployeesResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListEmployeesResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1Employee]**](V1Employee.md) | | [optional] + + diff --git a/docs/V1ListFeesRequest.md b/docs/V1ListFeesRequest.md new file mode 100644 index 0000000..3120c4c --- /dev/null +++ b/docs/V1ListFeesRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1ListFeesRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1ListFeesResponse.md b/docs/V1ListFeesResponse.md new file mode 100644 index 0000000..6eaecef --- /dev/null +++ b/docs/V1ListFeesResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListFeesResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1Fee]**](V1Fee.md) | | [optional] + + diff --git a/docs/V1ListInventoryRequest.md b/docs/V1ListInventoryRequest.md new file mode 100644 index 0000000..229e534 --- /dev/null +++ b/docs/V1ListInventoryRequest.md @@ -0,0 +1,13 @@ +# SquareConnect.V1ListInventoryRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**limit** | **Number** | The maximum number of inventory entries to return in a single response. This value cannot exceed 1000. | [optional] +**batch_token** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] + + diff --git a/docs/V1ListInventoryResponse.md b/docs/V1ListInventoryResponse.md new file mode 100644 index 0000000..aa062eb --- /dev/null +++ b/docs/V1ListInventoryResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListInventoryResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1InventoryEntry]**](V1InventoryEntry.md) | | [optional] + + diff --git a/docs/V1ListItemsRequest.md b/docs/V1ListItemsRequest.md new file mode 100644 index 0000000..e9c5a0d --- /dev/null +++ b/docs/V1ListItemsRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListItemsRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**batch_token** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] + + diff --git a/docs/V1ListItemsResponse.md b/docs/V1ListItemsResponse.md new file mode 100644 index 0000000..969ad84 --- /dev/null +++ b/docs/V1ListItemsResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListItemsResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1Item]**](V1Item.md) | | [optional] + + diff --git a/docs/V1ListLocationsRequest.md b/docs/V1ListLocationsRequest.md new file mode 100644 index 0000000..2aefe75 --- /dev/null +++ b/docs/V1ListLocationsRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1ListLocationsRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1ListLocationsResponse.md b/docs/V1ListLocationsResponse.md new file mode 100644 index 0000000..c5715ae --- /dev/null +++ b/docs/V1ListLocationsResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListLocationsResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1Merchant]**](V1Merchant.md) | | [optional] + + diff --git a/docs/V1ListModifierListsRequest.md b/docs/V1ListModifierListsRequest.md new file mode 100644 index 0000000..1618d90 --- /dev/null +++ b/docs/V1ListModifierListsRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1ListModifierListsRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1ListModifierListsResponse.md b/docs/V1ListModifierListsResponse.md new file mode 100644 index 0000000..7d768af --- /dev/null +++ b/docs/V1ListModifierListsResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListModifierListsResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1ModifierList]**](V1ModifierList.md) | | [optional] + + diff --git a/docs/V1ListOrdersRequest.md b/docs/V1ListOrdersRequest.md new file mode 100644 index 0000000..a5c1369 --- /dev/null +++ b/docs/V1ListOrdersRequest.md @@ -0,0 +1,25 @@ +# SquareConnect.V1ListOrdersRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**order** | **String** | TThe order in which payments are listed in the response. See [SortOrder](#type-sortorder) for possible values | [optional] +**limit** | **Number** | The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional] +**batch_token** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] + + + +## Enum: OrderEnum + + +* `DESC` (value: `"DESC"`) + +* `ASC` (value: `"ASC"`) + + + + diff --git a/docs/V1ListOrdersResponse.md b/docs/V1ListOrdersResponse.md new file mode 100644 index 0000000..cac62a7 --- /dev/null +++ b/docs/V1ListOrdersResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListOrdersResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1Order]**](V1Order.md) | | [optional] + + diff --git a/docs/V1ListPagesRequest.md b/docs/V1ListPagesRequest.md new file mode 100644 index 0000000..83fade5 --- /dev/null +++ b/docs/V1ListPagesRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1ListPagesRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1ListPagesResponse.md b/docs/V1ListPagesResponse.md new file mode 100644 index 0000000..9631d06 --- /dev/null +++ b/docs/V1ListPagesResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListPagesResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1Page]**](V1Page.md) | | [optional] + + diff --git a/docs/V1ListPaymentsRequest.md b/docs/V1ListPaymentsRequest.md new file mode 100644 index 0000000..fc4b3e8 --- /dev/null +++ b/docs/V1ListPaymentsRequest.md @@ -0,0 +1,28 @@ +# SquareConnect.V1ListPaymentsRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**order** | **String** | The order in which payments are listed in the response. See [SortOrder](#type-sortorder) for possible values | [optional] +**begin_time** | **String** | The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year. | [optional] +**end_time** | **String** | The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. | [optional] +**limit** | **Number** | The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional] +**batch_token** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] +**include_partial** | **Boolean** | Indicates whether or not to include partial payments in the response. Partial payments will have the tenders collected so far, but the itemizations will be empty until the payment is completed. | [optional] + + + +## Enum: OrderEnum + + +* `DESC` (value: `"DESC"`) + +* `ASC` (value: `"ASC"`) + + + + diff --git a/docs/V1ListPaymentsResponse.md b/docs/V1ListPaymentsResponse.md new file mode 100644 index 0000000..40f803f --- /dev/null +++ b/docs/V1ListPaymentsResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListPaymentsResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1Payment]**](V1Payment.md) | | [optional] + + diff --git a/docs/V1ListRefundsRequest.md b/docs/V1ListRefundsRequest.md new file mode 100644 index 0000000..efab579 --- /dev/null +++ b/docs/V1ListRefundsRequest.md @@ -0,0 +1,27 @@ +# SquareConnect.V1ListRefundsRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**order** | **String** | TThe order in which payments are listed in the response. See [SortOrder](#type-sortorder) for possible values | [optional] +**begin_time** | **String** | The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year. | [optional] +**end_time** | **String** | The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. | [optional] +**limit** | **Number** | The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods. | [optional] +**batch_token** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] + + + +## Enum: OrderEnum + + +* `DESC` (value: `"DESC"`) + +* `ASC` (value: `"ASC"`) + + + + diff --git a/docs/V1ListRefundsResponse.md b/docs/V1ListRefundsResponse.md new file mode 100644 index 0000000..9c17dba --- /dev/null +++ b/docs/V1ListRefundsResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListRefundsResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1Refund]**](V1Refund.md) | | [optional] + + diff --git a/docs/V1ListSettlementsRequest.md b/docs/V1ListSettlementsRequest.md new file mode 100644 index 0000000..37b42f2 --- /dev/null +++ b/docs/V1ListSettlementsRequest.md @@ -0,0 +1,39 @@ +# SquareConnect.V1ListSettlementsRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**order** | **String** | TThe order in which payments are listed in the response. See [SortOrder](#type-sortorder) for possible values | [optional] +**begin_time** | **String** | The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. Default value: The current time minus one year. | [optional] +**end_time** | **String** | The end of the requested reporting period, in ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. | [optional] +**limit** | **Number** | The maximum number of payments to return in a single response. This value cannot exceed 200. | [optional] +**status** | **String** | Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED). See [V1ListSettlementsRequestStatus](#type-v1listsettlementsrequeststatus) for possible values | [optional] +**batch_token** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] + + + +## Enum: OrderEnum + + +* `DESC` (value: `"DESC"`) + +* `ASC` (value: `"ASC"`) + + + + + +## Enum: StatusEnum + + +* `SENT` (value: `"SENT"`) + +* `FAILED` (value: `"FAILED"`) + + + + diff --git a/docs/V1ListSettlementsRequestStatus.md b/docs/V1ListSettlementsRequestStatus.md new file mode 100644 index 0000000..43cfe96 --- /dev/null +++ b/docs/V1ListSettlementsRequestStatus.md @@ -0,0 +1,10 @@ +# SquareConnect.V1ListSettlementsRequestStatus + +## Enum + + +* `SENT` (value: `"SENT"`) + +* `FAILED` (value: `"FAILED"`) + + diff --git a/docs/V1ListSettlementsResponse.md b/docs/V1ListSettlementsResponse.md new file mode 100644 index 0000000..c31da5e --- /dev/null +++ b/docs/V1ListSettlementsResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListSettlementsResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1Settlement]**](V1Settlement.md) | | [optional] + + diff --git a/docs/V1ListTimecardEventsRequest.md b/docs/V1ListTimecardEventsRequest.md new file mode 100644 index 0000000..8c575a2 --- /dev/null +++ b/docs/V1ListTimecardEventsRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListTimecardEventsRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**timecard_id** | **String** | The ID of the timecard to list events for. | + + diff --git a/docs/V1ListTimecardEventsResponse.md b/docs/V1ListTimecardEventsResponse.md new file mode 100644 index 0000000..333a832 --- /dev/null +++ b/docs/V1ListTimecardEventsResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListTimecardEventsResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1TimecardEvent]**](V1TimecardEvent.md) | | [optional] + + diff --git a/docs/V1ListTimecardsRequest.md b/docs/V1ListTimecardsRequest.md new file mode 100644 index 0000000..09d845c --- /dev/null +++ b/docs/V1ListTimecardsRequest.md @@ -0,0 +1,33 @@ +# SquareConnect.V1ListTimecardsRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**order** | **String** | The order in which timecards are listed in the response, based on their created_at field. See [SortOrder](#type-sortorder) for possible values | [optional] +**employee_id** | **String** | If provided, the endpoint returns only timecards for the employee with the specified ID. | [optional] +**begin_clockin_time** | **String** | If filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format. | [optional] +**end_clockin_time** | **String** | If filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format. | [optional] +**begin_clockout_time** | **String** | If filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format. | [optional] +**end_clockout_time** | **String** | If filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format. | [optional] +**begin_updated_at** | **String** | If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format. | [optional] +**end_updated_at** | **String** | If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format. | [optional] +**deleted** | **Boolean** | If true, only deleted timecards are returned. If false, only valid timecards are returned.If you don't provide this parameter, both valid and deleted timecards are returned. | [optional] +**limit** | **Number** | The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. | [optional] +**batch_token** | **String** | A pagination cursor to retrieve the next set of results for your original query to the endpoint. | [optional] + + + +## Enum: OrderEnum + + +* `DESC` (value: `"DESC"`) + +* `ASC` (value: `"ASC"`) + + + + diff --git a/docs/V1ListTimecardsResponse.md b/docs/V1ListTimecardsResponse.md new file mode 100644 index 0000000..4ef0ba2 --- /dev/null +++ b/docs/V1ListTimecardsResponse.md @@ -0,0 +1,12 @@ +# SquareConnect.V1ListTimecardsResponse + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**items** | [**[V1Timecard]**](V1Timecard.md) | | [optional] + + diff --git a/docs/V1LocationsApi.md b/docs/V1LocationsApi.md index fdadb2c..07e8ff8 100644 --- a/docs/V1LocationsApi.md +++ b/docs/V1LocationsApi.md @@ -4,15 +4,15 @@ All URIs are relative to *https://connect.squareup.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**listLocations**](V1LocationsApi.md#listLocations) | **GET** /v1/me/locations | Provides details for a business's locations, including their IDs. -[**retrieveBusiness**](V1LocationsApi.md#retrieveBusiness) | **GET** /v1/me | Get a business's information. +[**listLocations**](V1LocationsApi.md#listLocations) | **GET** /v1/me/locations | ListLocations +[**retrieveBusiness**](V1LocationsApi.md#retrieveBusiness) | **GET** /v1/me | RetrieveBusiness # **listLocations** > [V1Merchant] listLocations() -Provides details for a business's locations, including their IDs. +ListLocations Provides details for a business's locations, including their IDs. @@ -54,7 +54,7 @@ This endpoint does not need any parameter. # **retrieveBusiness** > V1Merchant retrieveBusiness() -Get a business's information. +RetrieveBusiness Get a business's information. diff --git a/docs/V1Merchant.md b/docs/V1Merchant.md index 2d9f8d5..fe24050 100644 --- a/docs/V1Merchant.md +++ b/docs/V1Merchant.md @@ -1,12 +1,16 @@ # SquareConnect.V1Merchant +### Description + +Defines the fields that are included in the response body of a request to the **RetrieveBusiness** endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The merchant account's unique identifier. | [optional] **name** | **String** | The name associated with the merchant account. | [optional] **email** | **String** | The email address associated with the merchant account. | [optional] -**account_type** | **String** | Indicates whether the merchant account corresponds to a single-location account (LOCATION) or a business account (BUSINESS). This value is almost always LOCATION. | [optional] +**account_type** | **String** | Indicates whether the merchant account corresponds to a single-location account (LOCATION) or a business account (BUSINESS). This value is almost always LOCATION. See [V1MerchantAccountType](#type-v1merchantaccounttype) for possible values | [optional] **account_capabilities** | **[String]** | Capabilities that are enabled for the merchant's Square account. Capabilities that are not listed in this array are not enabled for the account. | [optional] **country_code** | **String** | The country associated with the merchant account, in ISO 3166-1-alpha-2 format. | [optional] **language_code** | **String** | The language associated with the merchant account, in BCP 47 format. | [optional] @@ -14,9 +18,9 @@ Name | Type | Description | Notes **business_name** | **String** | The name of the merchant's business. | [optional] **business_address** | [**Address**](Address.md) | The address of the merchant's business. | [optional] **business_phone** | [**V1PhoneNumber**](V1PhoneNumber.md) | The phone number of the merchant's business. | [optional] -**business_type** | **String** | The type of business operated by the merchant. | [optional] -**shipping_address ** | [**Address**](Address.md) | The merchant's shipping address. | [optional] -**location_details** | [**V1MerchantLocationDetails**](V1MerchantLocationDetails.md) | | [optional] +**business_type** | **String** | The type of business operated by the merchant. See [V1MerchantBusinessType](#type-v1merchantbusinesstype) for possible values | [optional] +**shipping_address** | [**Address**](Address.md) | The merchant's shipping address. | [optional] +**location_details** | [**V1MerchantLocationDetails**](V1MerchantLocationDetails.md) | Additional information for a single-location account specified by its associated business account, if it has one. | [optional] **market_url** | **String** | The URL of the merchant's online store. | [optional] diff --git a/docs/V1MerchantAccountType.md b/docs/V1MerchantAccountType.md new file mode 100644 index 0000000..94f3253 --- /dev/null +++ b/docs/V1MerchantAccountType.md @@ -0,0 +1,10 @@ +# SquareConnect.V1MerchantAccountType + +## Enum + + +* `LOCATION` (value: `"LOCATION"`) + +* `BUSINESS` (value: `"BUSINESS"`) + + diff --git a/docs/V1MerchantBusinessType.md b/docs/V1MerchantBusinessType.md new file mode 100644 index 0000000..c5fe91a --- /dev/null +++ b/docs/V1MerchantBusinessType.md @@ -0,0 +1,106 @@ +# SquareConnect.V1MerchantBusinessType + +## Enum + + +* `ACCOUNTING` (value: `"ACCOUNTING"`) + +* `APPAREL_AND_ACCESSORY_SHOPS` (value: `"APPAREL_AND_ACCESSORY_SHOPS"`) + +* `ART_DEALERS_GALLERIES` (value: `"ART_DEALERS_GALLERIES"`) + +* `ART_DESIGN_AND_PHOTOGRAPHY` (value: `"ART_DESIGN_AND_PHOTOGRAPHY"`) + +* `BAR_CLUB_LOUNGE` (value: `"BAR_CLUB_LOUNGE"`) + +* `BEAUTY_AND_BARBER_SHOPS` (value: `"BEAUTY_AND_BARBER_SHOPS"`) + +* `BOOK_STORES` (value: `"BOOK_STORES"`) + +* `BUSINESS_SERVICES` (value: `"BUSINESS_SERVICES"`) + +* `CATERING` (value: `"CATERING"`) + +* `CHARITABLE_SOCIAL_SERVICE_ORGANIZATIONS` (value: `"CHARITABLE_SOCIAL_SERVICE_ORGANIZATIONS"`) + +* `CHARITIBLE_ORGS` (value: `"CHARITIBLE_ORGS"`) + +* `CLEANING_SERVICES` (value: `"CLEANING_SERVICES"`) + +* `COMPUTER_EQUIPMENT_SOFTWARE_MAINTENANCE_REPAIR_SERVICES` (value: `"COMPUTER_EQUIPMENT_SOFTWARE_MAINTENANCE_REPAIR_SERVICES"`) + +* `CONSULTANT` (value: `"CONSULTANT"`) + +* `CONTRACTORS` (value: `"CONTRACTORS"`) + +* `DELIVERY_SERVICES` (value: `"DELIVERY_SERVICES"`) + +* `DENTISTRY` (value: `"DENTISTRY"`) + +* `EDUCATION` (value: `"EDUCATION"`) + +* `FOOD_STORES_CONVENIENCE_STORES_AND_SPECIALTY_MARKETS` (value: `"FOOD_STORES_CONVENIENCE_STORES_AND_SPECIALTY_MARKETS"`) + +* `FOOD_TRUCK_CART` (value: `"FOOD_TRUCK_CART"`) + +* `FURNITURE_HOME_AND_OFFICE_EQUIPMENT` (value: `"FURNITURE_HOME_AND_OFFICE_EQUIPMENT"`) + +* `FURNITURE_HOME_GOODS` (value: `"FURNITURE_HOME_GOODS"`) + +* `HOTELS_AND_LODGING` (value: `"HOTELS_AND_LODGING"`) + +* `INDIVIDUAL_USE` (value: `"INDIVIDUAL_USE"`) + +* `JEWELRY_AND_WATCHES` (value: `"JEWELRY_AND_WATCHES"`) + +* `LANDSCAPING_AND_HORTICULTURAL_SERVICES` (value: `"LANDSCAPING_AND_HORTICULTURAL_SERVICES"`) + +* `LANGUAGE_SCHOOLS` (value: `"LANGUAGE_SCHOOLS"`) + +* `LEGAL_SERVICES` (value: `"LEGAL_SERVICES"`) + +* `MEDICAL_PRACTITIONERS` (value: `"MEDICAL_PRACTITIONERS"`) + +* `MEDICAL_SERVICES_AND_HEALTH_PRACTITIONERS` (value: `"MEDICAL_SERVICES_AND_HEALTH_PRACTITIONERS"`) + +* `MEMBERSHIP_ORGANIZATIONS` (value: `"MEMBERSHIP_ORGANIZATIONS"`) + +* `MUSIC_AND_ENTERTAINMENT` (value: `"MUSIC_AND_ENTERTAINMENT"`) + +* `OTHER` (value: `"OTHER"`) + +* `OUTDOOR_MARKETS` (value: `"OUTDOOR_MARKETS"`) + +* `PERSONAL_SERVICES` (value: `"PERSONAL_SERVICES"`) + +* `POLITICAL_ORGANIZATIONS` (value: `"POLITICAL_ORGANIZATIONS"`) + +* `PROFESSIONAL_SERVICES` (value: `"PROFESSIONAL_SERVICES"`) + +* `REAL_ESTATE` (value: `"REAL_ESTATE"`) + +* `RECREATION_SERVICES` (value: `"RECREATION_SERVICES"`) + +* `REPAIR_SHOPS_AND_RELATED_SERVICES` (value: `"REPAIR_SHOPS_AND_RELATED_SERVICES"`) + +* `RESTAURANTS` (value: `"RESTAURANTS"`) + +* `RETAIL_SHOPS` (value: `"RETAIL_SHOPS"`) + +* `SCHOOLS_AND_EDUCATIONAL_SERVICES` (value: `"SCHOOLS_AND_EDUCATIONAL_SERVICES"`) + +* `SPORTING_GOODS` (value: `"SPORTING_GOODS"`) + +* `TAXICABS_AND_LIMOUSINES` (value: `"TAXICABS_AND_LIMOUSINES"`) + +* `TICKET_SALES` (value: `"TICKET_SALES"`) + +* `TOURISM` (value: `"TOURISM"`) + +* `TRAVEL_TOURISM` (value: `"TRAVEL_TOURISM"`) + +* `VETERINARY_SERVICES` (value: `"VETERINARY_SERVICES"`) + +* `WEB_DEV_DESIGN` (value: `"WEB_DEV_DESIGN"`) + + diff --git a/docs/V1MerchantLocationDetails.md b/docs/V1MerchantLocationDetails.md index f3d2a93..8077dfe 100644 --- a/docs/V1MerchantLocationDetails.md +++ b/docs/V1MerchantLocationDetails.md @@ -1,5 +1,9 @@ # SquareConnect.V1MerchantLocationDetails +### Description + +Additional information for a single-location account specified by its associated business account, if it has one. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/V1ModifierList.md b/docs/V1ModifierList.md index 01ee82d..20a16e0 100644 --- a/docs/V1ModifierList.md +++ b/docs/V1ModifierList.md @@ -1,11 +1,15 @@ # SquareConnect.V1ModifierList +### Description + +V1ModifierList + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The modifier list's unique ID. | [optional] **name** | **String** | The modifier list's name. | [optional] -**selection_type** | **String** | Indicates whether MULTIPLE options or a SINGLE option from the modifier list can be applied to a single item. | [optional] +**selection_type** | **String** | Indicates whether MULTIPLE options or a SINGLE option from the modifier list can be applied to a single item. See [V1ModifierListSelectionType](#type-v1modifierlistselectiontype) for possible values | [optional] **modifier_options** | [**[V1ModifierOption]**](V1ModifierOption.md) | The options included in the modifier list. | [optional] diff --git a/docs/V1ModifierListSelectionType.md b/docs/V1ModifierListSelectionType.md new file mode 100644 index 0000000..0f381ab --- /dev/null +++ b/docs/V1ModifierListSelectionType.md @@ -0,0 +1,10 @@ +# SquareConnect.V1ModifierListSelectionType + +## Enum + + +* `SINGLE` (value: `"SINGLE"`) + +* `MULTIPLE` (value: `"MULTIPLE"`) + + diff --git a/docs/V1ModifierOption.md b/docs/V1ModifierOption.md index fcb7c1a..e144960 100644 --- a/docs/V1ModifierOption.md +++ b/docs/V1ModifierOption.md @@ -1,5 +1,9 @@ # SquareConnect.V1ModifierOption +### Description + +V1ModifierOption + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/V1Money.md b/docs/V1Money.md index 28e4d4a..0885ead 100644 --- a/docs/V1Money.md +++ b/docs/V1Money.md @@ -1,16 +1,22 @@ # SquareConnect.V1Money +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **amount** | **Number** | Amount in the lowest denominated value of this Currency. E.g. in USD these are cents, in JPY they are Yen (which do not have a 'cent' concept). | [optional] -**currency_code** | **String** | | [optional] +**currency_code** | **String** | See [Currency](#type-currency) for possible values | [optional] ## Enum: CurrencyCodeEnum +* `UNKNOWN_CURRENCY` (value: `"UNKNOWN_CURRENCY"`) + * `AED` (value: `"AED"`) * `AFN` (value: `"AFN"`) diff --git a/docs/V1Order.md b/docs/V1Order.md index dd248ca..0ba3a41 100644 --- a/docs/V1Order.md +++ b/docs/V1Order.md @@ -1,5 +1,9 @@ # SquareConnect.V1Order +### Description + +V1Order + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -8,7 +12,7 @@ Name | Type | Description | Notes **buyer_email** | **String** | The email address of the order's buyer. | [optional] **recipient_name** | **String** | The name of the order's buyer. | [optional] **recipient_phone_number** | **String** | The phone number to use for the order's delivery. | [optional] -**state** | **String** | Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. | [optional] +**state** | **String** | Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. See [V1OrderState](#type-v1orderstate) for possible values | [optional] **shipping_address** | [**Address**](Address.md) | The address to ship the order to. | [optional] **subtotal_money** | [**V1Money**](V1Money.md) | The amount of all items purchased in the order, before taxes and shipping. | [optional] **total_shipping_money** | [**V1Money**](V1Money.md) | The shipping cost for the order. | [optional] diff --git a/docs/V1OrderHistoryEntry.md b/docs/V1OrderHistoryEntry.md index de3000b..c3f299e 100644 --- a/docs/V1OrderHistoryEntry.md +++ b/docs/V1OrderHistoryEntry.md @@ -1,9 +1,13 @@ # SquareConnect.V1OrderHistoryEntry +### Description + +V1OrderHistoryEntry + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**action** | **String** | The type of action performed on the order. | [optional] +**action** | **String** | The type of action performed on the order. See [V1OrderHistoryEntryAction](#type-v1orderhistoryentryaction) for possible values | [optional] **created_at** | **String** | The time when the action was performed, in ISO 8601 format. | [optional] diff --git a/docs/V1OrderHistoryEntryAction.md b/docs/V1OrderHistoryEntryAction.md new file mode 100644 index 0000000..1fb2aca --- /dev/null +++ b/docs/V1OrderHistoryEntryAction.md @@ -0,0 +1,20 @@ +# SquareConnect.V1OrderHistoryEntryAction + +## Enum + + +* `ORDER_PLACED` (value: `"ORDER_PLACED"`) + +* `DECLINED` (value: `"DECLINED"`) + +* `PAYMENT_RECEIVED` (value: `"PAYMENT_RECEIVED"`) + +* `CANCELED` (value: `"CANCELED"`) + +* `COMPLETED` (value: `"COMPLETED"`) + +* `REFUNDED` (value: `"REFUNDED"`) + +* `EXPIRED` (value: `"EXPIRED"`) + + diff --git a/docs/V1OrderState.md b/docs/V1OrderState.md new file mode 100644 index 0000000..ebe41df --- /dev/null +++ b/docs/V1OrderState.md @@ -0,0 +1,18 @@ +# SquareConnect.V1OrderState + +## Enum + + +* `PENDING` (value: `"PENDING"`) + +* `OPEN` (value: `"OPEN"`) + +* `COMPLETED` (value: `"COMPLETED"`) + +* `CANCELED` (value: `"CANCELED"`) + +* `REFUNDED` (value: `"REFUNDED"`) + +* `REJECTED` (value: `"REJECTED"`) + + diff --git a/docs/V1Page.md b/docs/V1Page.md index 71bcc99..60a527e 100644 --- a/docs/V1Page.md +++ b/docs/V1Page.md @@ -1,5 +1,9 @@ # SquareConnect.V1Page +### Description + +V1Page + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/V1PageCell.md b/docs/V1PageCell.md index cd14ea5..220866a 100644 --- a/docs/V1PageCell.md +++ b/docs/V1PageCell.md @@ -1,14 +1,18 @@ # SquareConnect.V1PageCell +### Description + +V1PageCell + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **page_id** | **String** | The unique identifier of the page the cell is included on. | [optional] **row** | **Number** | The row of the cell. Always an integer between 0 and 4, inclusive. | [optional] **column** | **Number** | The column of the cell. Always an integer between 0 and 4, inclusive. | [optional] -**object_type** | **String** | The type of entity represented in the cell (ITEM, DISCOUNT, CATEGORY, or PLACEHOLDER). | [optional] +**object_type** | **String** | The type of entity represented in the cell (ITEM, DISCOUNT, CATEGORY, or PLACEHOLDER). See [V1PageCellObjectType](#type-v1pagecellobjecttype) for possible values | [optional] **object_id** | **String** | The unique identifier of the entity represented in the cell. Not present for cells with an object_type of PLACEHOLDER. | [optional] -**placeholder_type** | **String** | For a cell with an object_type of PLACEHOLDER, this value indicates the cell's special behavior. | [optional] +**placeholder_type** | **String** | For a cell with an object_type of PLACEHOLDER, this value indicates the cell's special behavior. See [V1PageCellPlaceholderType](#type-v1pagecellplaceholdertype) for possible values | [optional] diff --git a/docs/V1PageCellObjectType.md b/docs/V1PageCellObjectType.md new file mode 100644 index 0000000..2444263 --- /dev/null +++ b/docs/V1PageCellObjectType.md @@ -0,0 +1,14 @@ +# SquareConnect.V1PageCellObjectType + +## Enum + + +* `ITEM` (value: `"ITEM"`) + +* `DISCOUNT` (value: `"DISCOUNT"`) + +* `CATEGORY` (value: `"CATEGORY"`) + +* `PLACEHOLDER` (value: `"PLACEHOLDER"`) + + diff --git a/docs/V1PageCellPlaceholderType.md b/docs/V1PageCellPlaceholderType.md new file mode 100644 index 0000000..cc5d814 --- /dev/null +++ b/docs/V1PageCellPlaceholderType.md @@ -0,0 +1,12 @@ +# SquareConnect.V1PageCellPlaceholderType + +## Enum + + +* `ALL_ITEMS` (value: `"ALL_ITEMS"`) + +* `DISCOUNTS_CATEGORY` (value: `"DISCOUNTS_CATEGORY"`) + +* `REWARDS_FINDER` (value: `"REWARDS_FINDER"`) + + diff --git a/docs/V1Payment.md b/docs/V1Payment.md index 0a6d42f..cb98b7b 100644 --- a/docs/V1Payment.md +++ b/docs/V1Payment.md @@ -1,5 +1,9 @@ # SquareConnect.V1Payment +### Description + +A payment represents a paid transaction between a Square merchant and a customer. Payment details are usually available from Connect API endpoints within a few minutes after the transaction completes. Each Payment object includes several fields that end in `_money`. These fields describe the various amounts of money that contribute to the payment total: + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/V1PaymentDiscount.md b/docs/V1PaymentDiscount.md index bb0c484..3343813 100644 --- a/docs/V1PaymentDiscount.md +++ b/docs/V1PaymentDiscount.md @@ -1,5 +1,9 @@ # SquareConnect.V1PaymentDiscount +### Description + +V1PaymentDiscount + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/V1PaymentItemDetail.md b/docs/V1PaymentItemDetail.md index 75e8f6d..89ce1b3 100644 --- a/docs/V1PaymentItemDetail.md +++ b/docs/V1PaymentItemDetail.md @@ -1,5 +1,9 @@ # SquareConnect.V1PaymentItemDetail +### Description + +V1PaymentItemDetail + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/V1PaymentItemization.md b/docs/V1PaymentItemization.md index b2827a2..9c06faf 100644 --- a/docs/V1PaymentItemization.md +++ b/docs/V1PaymentItemization.md @@ -1,11 +1,15 @@ # SquareConnect.V1PaymentItemization +### Description + +Payment include an` itemizations` field that lists the items purchased, along with associated fees, modifiers, and discounts. Each itemization has an `itemization_type` field that indicates which of the following the itemization represents: *Note**: itemization information included in a `Payment` object reflects details collected **at the time of the payment**. Details such as the name or price of items might have changed since the payment was processed. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The item's name. | [optional] **quantity** | **Number** | The quantity of the item purchased. This can be a decimal value. | [optional] -**itemization_type** | **String** | The type of purchase that the itemization represents, such as an ITEM or CUSTOM_AMOUNT | [optional] +**itemization_type** | **String** | The type of purchase that the itemization represents, such as an ITEM or CUSTOM_AMOUNT See [V1PaymentItemizationItemizationType](#type-v1paymentitemizationitemizationtype) for possible values | [optional] **item_detail** | [**V1PaymentItemDetail**](V1PaymentItemDetail.md) | Details of the item, including its unique identifier and the identifier of the item variation purchased. | [optional] **notes** | **String** | Notes entered by the merchant about the item at the time of payment, if any. | [optional] **item_variation_name** | **String** | The name of the item variation purchased, if any. | [optional] diff --git a/docs/V1PaymentItemizationItemizationType.md b/docs/V1PaymentItemizationItemizationType.md new file mode 100644 index 0000000..242f630 --- /dev/null +++ b/docs/V1PaymentItemizationItemizationType.md @@ -0,0 +1,18 @@ +# SquareConnect.V1PaymentItemizationItemizationType + +## Enum + + +* `ITEM` (value: `"ITEM"`) + +* `CUSTOM_AMOUNT` (value: `"CUSTOM_AMOUNT"`) + +* `GIFT_CARD_ACTIVATION` (value: `"GIFT_CARD_ACTIVATION"`) + +* `GIFT_CARD_RELOAD` (value: `"GIFT_CARD_RELOAD"`) + +* `GIFT_CARD_UNKNOWN` (value: `"GIFT_CARD_UNKNOWN"`) + +* `OTHER` (value: `"OTHER"`) + + diff --git a/docs/V1PaymentModifier.md b/docs/V1PaymentModifier.md index 46708fc..f727487 100644 --- a/docs/V1PaymentModifier.md +++ b/docs/V1PaymentModifier.md @@ -1,5 +1,9 @@ # SquareConnect.V1PaymentModifier +### Description + +V1PaymentModifier + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/V1PaymentSurcharge.md b/docs/V1PaymentSurcharge.md index dcfae48..12f4058 100644 --- a/docs/V1PaymentSurcharge.md +++ b/docs/V1PaymentSurcharge.md @@ -1,5 +1,9 @@ # SquareConnect.V1PaymentSurcharge +### Description + +V1PaymentSurcharge + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -7,7 +11,7 @@ Name | Type | Description | Notes **applied_money** | [**V1Money**](V1Money.md) | The amount of money applied to the order as a result of the surcharge. | [optional] **rate** | **String** | The amount of the surcharge as a percentage. The percentage is provided as a string representing the decimal equivalent of the percentage. For example, \"0.7\" corresponds to a 7% surcharge. Exactly one of rate or amount_money should be set. | [optional] **amount_money** | [**V1Money**](V1Money.md) | The amount of the surcharge as a Money object. Exactly one of rate or amount_money should be set. | [optional] -**type** | **String** | Indicates the source of the surcharge. For example, if it was applied as an automatic gratuity for a large group. | [optional] +**type** | **String** | Indicates the source of the surcharge. For example, if it was applied as an automatic gratuity for a large group. See [V1PaymentSurchargeType](#type-v1paymentsurchargetype) for possible values | [optional] **taxable** | **Boolean** | Indicates whether the surcharge is taxable. | [optional] **taxes** | [**[V1PaymentTax]**](V1PaymentTax.md) | The list of taxes that should be applied to the surcharge. | [optional] **surcharge_id** | **String** | A Square-issued unique identifier associated with the surcharge. | [optional] diff --git a/docs/V1PaymentSurchargeType.md b/docs/V1PaymentSurchargeType.md new file mode 100644 index 0000000..feb0207 --- /dev/null +++ b/docs/V1PaymentSurchargeType.md @@ -0,0 +1,12 @@ +# SquareConnect.V1PaymentSurchargeType + +## Enum + + +* `UNKNOWN` (value: `"UNKNOWN"`) + +* `AUTO_GRATUITY` (value: `"AUTO_GRATUITY"`) + +* `CUSTOM` (value: `"CUSTOM"`) + + diff --git a/docs/V1PaymentTax.md b/docs/V1PaymentTax.md index 2a2ea72..64c941e 100644 --- a/docs/V1PaymentTax.md +++ b/docs/V1PaymentTax.md @@ -1,5 +1,9 @@ # SquareConnect.V1PaymentTax +### Description + +V1PaymentTax + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -7,7 +11,7 @@ Name | Type | Description | Notes **name** | **String** | The merchant-defined name of the tax. | [optional] **applied_money** | [**V1Money**](V1Money.md) | The amount of money that this tax adds to the payment. | [optional] **rate** | **String** | The rate of the tax, as a string representation of a decimal number. A value of 0.07 corresponds to a rate of 7%. | [optional] -**inclusion_type** | **String** | Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. | [optional] +**inclusion_type** | **String** | Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. See [V1PaymentTaxInclusionType](#type-v1paymenttaxinclusiontype) for possible values | [optional] **fee_id** | **String** | The ID of the tax, if available. Taxes applied in older versions of Square Register might not have an ID. | [optional] diff --git a/docs/V1PaymentTaxInclusionType.md b/docs/V1PaymentTaxInclusionType.md new file mode 100644 index 0000000..a320ab0 --- /dev/null +++ b/docs/V1PaymentTaxInclusionType.md @@ -0,0 +1,10 @@ +# SquareConnect.V1PaymentTaxInclusionType + +## Enum + + +* `ADDITIVE` (value: `"ADDITIVE"`) + +* `INCLUSIVE` (value: `"INCLUSIVE"`) + + diff --git a/docs/V1PhoneNumber.md b/docs/V1PhoneNumber.md index c93bf6d..2a74f1b 100644 --- a/docs/V1PhoneNumber.md +++ b/docs/V1PhoneNumber.md @@ -1,5 +1,9 @@ # SquareConnect.V1PhoneNumber +### Description + +Represents a phone number. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/V1Refund.md b/docs/V1Refund.md index 209446e..357984a 100644 --- a/docs/V1Refund.md +++ b/docs/V1Refund.md @@ -1,9 +1,13 @@ # SquareConnect.V1Refund +### Description + +V1Refund + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**type** | **String** | The type of refund | [optional] +**type** | **String** | The type of refund See [V1RefundType](#type-v1refundtype) for possible values | [optional] **reason** | **String** | The merchant-specified reason for the refund. | [optional] **refunded_money** | [**V1Money**](V1Money.md) | The amount of money refunded. This amount is always negative. | [optional] **refunded_processing_fee_money** | [**V1Money**](V1Money.md) | The amount of processing fee money refunded. This amount is always positive. | [optional] diff --git a/docs/V1RefundType.md b/docs/V1RefundType.md new file mode 100644 index 0000000..1d6f68b --- /dev/null +++ b/docs/V1RefundType.md @@ -0,0 +1,10 @@ +# SquareConnect.V1RefundType + +## Enum + + +* `FULL` (value: `"FULL"`) + +* `PARTIAL` (value: `"PARTIAL"`) + + diff --git a/docs/V1RemoveFeeRequest.md b/docs/V1RemoveFeeRequest.md new file mode 100644 index 0000000..27a2833 --- /dev/null +++ b/docs/V1RemoveFeeRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1RemoveFeeRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1RemoveModifierListRequest.md b/docs/V1RemoveModifierListRequest.md new file mode 100644 index 0000000..138bc0b --- /dev/null +++ b/docs/V1RemoveModifierListRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1RemoveModifierListRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1RetrieveBankAccountRequest.md b/docs/V1RetrieveBankAccountRequest.md new file mode 100644 index 0000000..ff0c6d4 --- /dev/null +++ b/docs/V1RetrieveBankAccountRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1RetrieveBankAccountRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1RetrieveBusinessRequest.md b/docs/V1RetrieveBusinessRequest.md new file mode 100644 index 0000000..1b5f749 --- /dev/null +++ b/docs/V1RetrieveBusinessRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1RetrieveBusinessRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1RetrieveCashDrawerShiftRequest.md b/docs/V1RetrieveCashDrawerShiftRequest.md new file mode 100644 index 0000000..c611736 --- /dev/null +++ b/docs/V1RetrieveCashDrawerShiftRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1RetrieveCashDrawerShiftRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1RetrieveEmployeeRequest.md b/docs/V1RetrieveEmployeeRequest.md new file mode 100644 index 0000000..ac62ec9 --- /dev/null +++ b/docs/V1RetrieveEmployeeRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1RetrieveEmployeeRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1RetrieveEmployeeRoleRequest.md b/docs/V1RetrieveEmployeeRoleRequest.md new file mode 100644 index 0000000..f58a9d5 --- /dev/null +++ b/docs/V1RetrieveEmployeeRoleRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1RetrieveEmployeeRoleRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1RetrieveItemRequest.md b/docs/V1RetrieveItemRequest.md new file mode 100644 index 0000000..6491c55 --- /dev/null +++ b/docs/V1RetrieveItemRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1RetrieveItemRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1RetrieveModifierListRequest.md b/docs/V1RetrieveModifierListRequest.md new file mode 100644 index 0000000..de33153 --- /dev/null +++ b/docs/V1RetrieveModifierListRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1RetrieveModifierListRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1RetrieveOrderRequest.md b/docs/V1RetrieveOrderRequest.md new file mode 100644 index 0000000..37be461 --- /dev/null +++ b/docs/V1RetrieveOrderRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1RetrieveOrderRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1RetrievePaymentRequest.md b/docs/V1RetrievePaymentRequest.md new file mode 100644 index 0000000..829cde8 --- /dev/null +++ b/docs/V1RetrievePaymentRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1RetrievePaymentRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1RetrieveSettlementRequest.md b/docs/V1RetrieveSettlementRequest.md new file mode 100644 index 0000000..cd6c139 --- /dev/null +++ b/docs/V1RetrieveSettlementRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1RetrieveSettlementRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1RetrieveTimecardRequest.md b/docs/V1RetrieveTimecardRequest.md new file mode 100644 index 0000000..7906c46 --- /dev/null +++ b/docs/V1RetrieveTimecardRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.V1RetrieveTimecardRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/V1Settlement.md b/docs/V1Settlement.md index 9a2fa3c..49b4def 100644 --- a/docs/V1Settlement.md +++ b/docs/V1Settlement.md @@ -1,10 +1,14 @@ # SquareConnect.V1Settlement +### Description + +V1Settlement + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The settlement's unique identifier. | [optional] -**status** | **String** | The settlement's current status. | [optional] +**status** | **String** | The settlement's current status. See [V1SettlementStatus](#type-v1settlementstatus) for possible values | [optional] **total_money** | [**V1Money**](V1Money.md) | The amount of money involved in the settlement. A positive amount indicates a deposit, and a negative amount indicates a withdrawal. This amount is never zero. | [optional] **initiated_at** | **String** | The time when the settlement was submitted for deposit or withdrawal, in ISO 8601 format. | [optional] **bank_account_id** | **String** | The Square-issued unique identifier for the bank account associated with the settlement. | [optional] diff --git a/docs/V1SettlementEntry.md b/docs/V1SettlementEntry.md index d7b3bc7..74178dc 100644 --- a/docs/V1SettlementEntry.md +++ b/docs/V1SettlementEntry.md @@ -1,10 +1,14 @@ # SquareConnect.V1SettlementEntry +### Description + +V1SettlementEntry + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **payment_id** | **String** | The settlement's unique identifier. | [optional] -**type** | **String** | The settlement's current status. | [optional] +**type** | **String** | The settlement's current status. See [V1SettlementEntryType](#type-v1settlemententrytype) for possible values | [optional] **amount_money** | [**V1Money**](V1Money.md) | The total amount of money this entry contributes to the total settlement amount. | [optional] **fee_money** | [**V1Money**](V1Money.md) | The amount of all Square fees associated with this settlement entry. This value is always negative or zero. | [optional] @@ -53,6 +57,8 @@ Name | Type | Description | Notes * `SQUARE_275` (value: `"SQUARE_275"`) +* `SQUARE_CARD` (value: `"SQUARE_CARD"`) + diff --git a/docs/V1SettlementEntryType.md b/docs/V1SettlementEntryType.md new file mode 100644 index 0000000..2654a1f --- /dev/null +++ b/docs/V1SettlementEntryType.md @@ -0,0 +1,48 @@ +# SquareConnect.V1SettlementEntryType + +## Enum + + +* `ADJUSTMENT` (value: `"ADJUSTMENT"`) + +* `BALANCE_CHARGE` (value: `"BALANCE_CHARGE"`) + +* `CHARGE` (value: `"CHARGE"`) + +* `FREE_PROCESSING` (value: `"FREE_PROCESSING"`) + +* `HOLD_ADJUSTMENT` (value: `"HOLD_ADJUSTMENT"`) + +* `PAID_SERVICE_FEE` (value: `"PAID_SERVICE_FEE"`) + +* `PAID_SERVICE_FEE_REFUND` (value: `"PAID_SERVICE_FEE_REFUND"`) + +* `REDEMPTION_CODE` (value: `"REDEMPTION_CODE"`) + +* `REFUND` (value: `"REFUND"`) + +* `RETURNED_PAYOUT` (value: `"RETURNED_PAYOUT"`) + +* `SQUARE_CAPITAL_ADVANCE` (value: `"SQUARE_CAPITAL_ADVANCE"`) + +* `SQUARE_CAPITAL_PAYMENT` (value: `"SQUARE_CAPITAL_PAYMENT"`) + +* `SQUARE_CAPITAL_REVERSED_PAYMENT` (value: `"SQUARE_CAPITAL_REVERSED_PAYMENT"`) + +* `SUBSCRIPTION_FEE` (value: `"SUBSCRIPTION_FEE"`) + +* `SUBSCRIPTION_FEE_REFUND` (value: `"SUBSCRIPTION_FEE_REFUND"`) + +* `OTHER` (value: `"OTHER"`) + +* `INCENTED_PAYMENT` (value: `"INCENTED_PAYMENT"`) + +* `RETURNED_ACH_ENTRY` (value: `"RETURNED_ACH_ENTRY"`) + +* `RETURNED_SQUARE_275` (value: `"RETURNED_SQUARE_275"`) + +* `SQUARE_275` (value: `"SQUARE_275"`) + +* `SQUARE_CARD` (value: `"SQUARE_CARD"`) + + diff --git a/docs/V1SettlementStatus.md b/docs/V1SettlementStatus.md new file mode 100644 index 0000000..4475af2 --- /dev/null +++ b/docs/V1SettlementStatus.md @@ -0,0 +1,10 @@ +# SquareConnect.V1SettlementStatus + +## Enum + + +* `FAILED` (value: `"FAILED"`) + +* `SENT` (value: `"SENT"`) + + diff --git a/docs/V1Tender.md b/docs/V1Tender.md index 6747aaa..668d26c 100644 --- a/docs/V1Tender.md +++ b/docs/V1Tender.md @@ -1,16 +1,20 @@ # SquareConnect.V1Tender +### Description + +A tender represents a discrete monetary exchange. Square represents this exchange as a money object with a specific currency and amount, where the amount is given in the smallest denomination of the given currency. Square POS can accept more than one form of tender for a single payment (such as by splitting a bill between a credit card and a gift card). The `tender` field of the Payment object lists all forms of tender used for the payment. Split tender payments behave slightly differently from single tender payments: The receipt_url for a split tender corresponds only to the first tender listed in the tender field. To get the receipt URLs for the remaining tenders, use the receipt_url fields of the corresponding Tender objects. *A note on gift cards**: when a customer purchases a Square gift card from a merchant, the merchant receives the full amount of the gift card in the associated payment. When that gift card is used as a tender, the balance of the gift card is reduced and the merchant receives no funds. A `Tender` object with a type of `SQUARE_GIFT_CARD` indicates a gift card was used for some or all of the associated payment. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The tender's unique ID. | [optional] -**type** | **String** | The type of tender. | [optional] +**type** | **String** | The type of tender. See [V1TenderType](#type-v1tendertype) for possible values | [optional] **name** | **String** | A human-readable description of the tender. | [optional] **employee_id** | **String** | The ID of the employee that processed the tender. | [optional] **receipt_url** | **String** | The URL of the receipt for the tender. | [optional] -**card_brand** | **String** | The brand of credit card provided. | [optional] +**card_brand** | **String** | The brand of credit card provided. See [CardBrand](#type-cardbrand) for possible values | [optional] **pan_suffix** | **String** | The last four digits of the provided credit card's account number. | [optional] -**entry_method** | **String** | The tender's unique ID. | [optional] +**entry_method** | **String** | The tender's unique ID. See [V1TenderEntryMethod](#type-v1tenderentrymethod) for possible values | [optional] **payment_note** | **String** | Notes entered by the merchant about the tender at the time of payment, if any. Typically only present for tender with the type: OTHER. | [optional] **total_money** | [**V1Money**](V1Money.md) | The total amount of money provided in this form of tender. | [optional] **tendered_money** | [**V1Money**](V1Money.md) | The amount of total_money applied to the payment. | [optional] @@ -52,7 +56,7 @@ Name | Type | Description | Notes * `VISA` (value: `"VISA"`) -* `MASTER_CARD` (value: `"MASTER_CARD"`) +* `MASTERCARD` (value: `"MASTERCARD"`) * `AMERICAN_EXPRESS` (value: `"AMERICAN_EXPRESS"`) diff --git a/docs/V1TenderEntryMethod.md b/docs/V1TenderEntryMethod.md new file mode 100644 index 0000000..76c287f --- /dev/null +++ b/docs/V1TenderEntryMethod.md @@ -0,0 +1,20 @@ +# SquareConnect.V1TenderEntryMethod + +## Enum + + +* `MANUAL` (value: `"MANUAL"`) + +* `SCANNED` (value: `"SCANNED"`) + +* `SQUARE_CASH` (value: `"SQUARE_CASH"`) + +* `SQUARE_WALLET` (value: `"SQUARE_WALLET"`) + +* `SWIPED` (value: `"SWIPED"`) + +* `WEB_FORM` (value: `"WEB_FORM"`) + +* `OTHER` (value: `"OTHER"`) + + diff --git a/docs/V1TenderType.md b/docs/V1TenderType.md new file mode 100644 index 0000000..8f55cfd --- /dev/null +++ b/docs/V1TenderType.md @@ -0,0 +1,22 @@ +# SquareConnect.V1TenderType + +## Enum + + +* `CREDIT_CARD` (value: `"CREDIT_CARD"`) + +* `CASH` (value: `"CASH"`) + +* `THIRD_PARTY_CARD` (value: `"THIRD_PARTY_CARD"`) + +* `NO_SALE` (value: `"NO_SALE"`) + +* `SQUARE_WALLET` (value: `"SQUARE_WALLET"`) + +* `SQUARE_GIFT_CARD` (value: `"SQUARE_GIFT_CARD"`) + +* `UNKNOWN` (value: `"UNKNOWN"`) + +* `OTHER` (value: `"OTHER"`) + + diff --git a/docs/V1Timecard.md b/docs/V1Timecard.md index dbf22ee..34a54c4 100644 --- a/docs/V1Timecard.md +++ b/docs/V1Timecard.md @@ -1,5 +1,9 @@ # SquareConnect.V1Timecard +### Description + +Represents a timecard for an employee. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -8,7 +12,7 @@ Name | Type | Description | Notes **deleted** | **Boolean** | If true, the timecard was deleted by the merchant, and it is no longer valid. | [optional] **clockin_time** | **String** | The clock-in time for the timecard, in ISO 8601 format. | [optional] **clockout_time** | **String** | The clock-out time for the timecard, in ISO 8601 format. Provide this value only if importing timecard information from another system. | [optional] -**clockin_location_id** | **String** | The ID of the location the employee clocked in from. We strongly reccomend providing a clockin_location_id. Square uses the clockin_location_id to determine a timecard���s timezone and overtime rules. | [optional] +**clockin_location_id** | **String** | The ID of the location the employee clocked in from. We strongly reccomend providing a clockin_location_id. Square uses the clockin_location_id to determine a timecard’s timezone and overtime rules. | [optional] **clockout_location_id** | **String** | The ID of the location the employee clocked out from. Provide this value only if importing timecard information from another system. | [optional] **created_at** | **String** | The time when the timecard was created, in ISO 8601 format. | [optional] **updated_at** | **String** | The time when the timecard was most recently updated, in ISO 8601 format. | [optional] diff --git a/docs/V1TimecardEvent.md b/docs/V1TimecardEvent.md index 6d79961..5646e6e 100644 --- a/docs/V1TimecardEvent.md +++ b/docs/V1TimecardEvent.md @@ -1,10 +1,14 @@ # SquareConnect.V1TimecardEvent +### Description + +V1TimecardEvent + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The event's unique ID. | [optional] -**event_type** | **String** | The ID of the timecard to list events for. | [optional] +**event_type** | **String** | The ID of the timecard to list events for. See [V1TimecardEventEventType](#type-v1timecardeventeventtype) for possible values | [optional] **clockin_time** | **String** | The time the employee clocked in, in ISO 8601 format. | [optional] **clockout_time** | **String** | The time the employee clocked out, in ISO 8601 format. | [optional] **created_at** | **String** | The time when the event was created, in ISO 8601 format. | [optional] diff --git a/docs/V1TimecardEventEventType.md b/docs/V1TimecardEventEventType.md new file mode 100644 index 0000000..a8bcd9d --- /dev/null +++ b/docs/V1TimecardEventEventType.md @@ -0,0 +1,22 @@ +# SquareConnect.V1TimecardEventEventType + +## Enum + + +* `API_CREATE` (value: `"API_CREATE"`) + +* `API_EDIT` (value: `"API_EDIT"`) + +* `API_DELETE` (value: `"API_DELETE"`) + +* `REGISTER_CLOCKIN` (value: `"REGISTER_CLOCKIN"`) + +* `REGISTER_CLOCKOUT` (value: `"REGISTER_CLOCKOUT"`) + +* `DASHBOARD_SUPERVISOR_CLOSE` (value: `"DASHBOARD_SUPERVISOR_CLOSE"`) + +* `DASHBOARD_EDIT` (value: `"DASHBOARD_EDIT"`) + +* `DASHBOARD_DELETE` (value: `"DASHBOARD_DELETE"`) + + diff --git a/docs/V1TransactionsApi.md b/docs/V1TransactionsApi.md index b0e7334..b800d07 100644 --- a/docs/V1TransactionsApi.md +++ b/docs/V1TransactionsApi.md @@ -4,26 +4,26 @@ All URIs are relative to *https://connect.squareup.com* Method | HTTP request | Description ------------- | ------------- | ------------- -[**createRefund**](V1TransactionsApi.md#createRefund) | **POST** /v1/{location_id}/refunds | Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. -[**listBankAccounts**](V1TransactionsApi.md#listBankAccounts) | **GET** /v1/{location_id}/bank-accounts | Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. -[**listOrders**](V1TransactionsApi.md#listOrders) | **GET** /v1/{location_id}/orders | Provides summary information for a merchant's online store orders. -[**listPayments**](V1TransactionsApi.md#listPayments) | **GET** /v1/{location_id}/payments | Provides summary information for all payments taken by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. See Date ranges for details of inclusive and exclusive dates. -[**listRefunds**](V1TransactionsApi.md#listRefunds) | **GET** /v1/{location_id}/refunds | Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. -[**listSettlements**](V1TransactionsApi.md#listSettlements) | **GET** /v1/{location_id}/settlements | Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length. -[**retrieveBankAccount**](V1TransactionsApi.md#retrieveBankAccount) | **GET** /v1/{location_id}/bank-accounts/{bank_account_id} | Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. -[**retrieveOrder**](V1TransactionsApi.md#retrieveOrder) | **GET** /v1/{location_id}/orders/{order_id} | Provides comprehensive information for a single online store order, including the order's history. -[**retrievePayment**](V1TransactionsApi.md#retrievePayment) | **GET** /v1/{location_id}/payments/{payment_id} | Provides comprehensive information for a single payment. -[**retrieveSettlement**](V1TransactionsApi.md#retrieveSettlement) | **GET** /v1/{location_id}/settlements/{settlement_id} | Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total. -[**updateOrder**](V1TransactionsApi.md#updateOrder) | **PUT** /v1/{location_id}/orders/{order_id} | Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions: +[**createRefund**](V1TransactionsApi.md#createRefund) | **POST** /v1/{location_id}/refunds | CreateRefund +[**listBankAccounts**](V1TransactionsApi.md#listBankAccounts) | **GET** /v1/{location_id}/bank-accounts | ListBankAccounts +[**listOrders**](V1TransactionsApi.md#listOrders) | **GET** /v1/{location_id}/orders | ListOrders +[**listPayments**](V1TransactionsApi.md#listPayments) | **GET** /v1/{location_id}/payments | ListPayments +[**listRefunds**](V1TransactionsApi.md#listRefunds) | **GET** /v1/{location_id}/refunds | ListRefunds +[**listSettlements**](V1TransactionsApi.md#listSettlements) | **GET** /v1/{location_id}/settlements | ListSettlements +[**retrieveBankAccount**](V1TransactionsApi.md#retrieveBankAccount) | **GET** /v1/{location_id}/bank-accounts/{bank_account_id} | RetrieveBankAccount +[**retrieveOrder**](V1TransactionsApi.md#retrieveOrder) | **GET** /v1/{location_id}/orders/{order_id} | RetrieveOrder +[**retrievePayment**](V1TransactionsApi.md#retrievePayment) | **GET** /v1/{location_id}/payments/{payment_id} | RetrievePayment +[**retrieveSettlement**](V1TransactionsApi.md#retrieveSettlement) | **GET** /v1/{location_id}/settlements/{settlement_id} | RetrieveSettlement +[**updateOrder**](V1TransactionsApi.md#updateOrder) | **PUT** /v1/{location_id}/orders/{order_id} | UpdateOrder # **createRefund** > V1Refund createRefund(locationId, body) -Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. +CreateRefund -Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. +Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. You cannot issue a partial refund for a split tender payment. You must instead issue a full or partial refund for a particular tender, by providing the applicable tender id to the V1CreateRefund endpoint. Issuing a full refund for a split tender payment refunds all tenders associated with the payment. Issuing a refund for a card payment is not reversible. For development purposes, you can create fake cash payments in Square Point of Sale and refund them. ### Example ```javascript @@ -72,7 +72,7 @@ Name | Type | Description | Notes # **listBankAccounts** > [V1BankAccount] listBankAccounts(locationId) -Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. +ListBankAccounts Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. @@ -120,7 +120,7 @@ Name | Type | Description | Notes # **listOrders** > [V1Order] listOrders(locationId, opts) -Provides summary information for a merchant's online store orders. +ListOrders Provides summary information for a merchant's online store orders. @@ -176,9 +176,9 @@ Name | Type | Description | Notes # **listPayments** > [V1Payment] listPayments(locationId, opts) -Provides summary information for all payments taken by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. See Date ranges for details of inclusive and exclusive dates. +ListPayments -Provides summary information for all payments taken by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. See Date ranges for details of inclusive and exclusive dates. +Provides summary information for all payments taken for a given Square account during a date range. Date ranges cannot exceed 1 year in length. See Date ranges for details of inclusive and exclusive dates. *Note**: Details for payments processed with Square Point of Sale while in offline mode may not be transmitted to Square for up to 72 hours. Offline payments have a `created_at` value that reflects the time the payment was originally processed, not the time it was subsequently transmitted to Square. Consequently, the ListPayments endpoint might list an offline payment chronologically between online payments that were seen in a previous request. ### Example ```javascript @@ -238,7 +238,7 @@ Name | Type | Description | Notes # **listRefunds** > [V1Refund] listRefunds(locationId, opts) -Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. +ListRefunds Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. @@ -298,9 +298,9 @@ Name | Type | Description | Notes # **listSettlements** > [V1Settlement] listSettlements(locationId, opts) -Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length. +ListSettlements -Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length. +Provides summary information for all deposits and withdrawals initiated by Square to a linked bank account during a date range. Date ranges cannot exceed one year in length. *Note**: the ListSettlements endpoint does not provide entry information. ### Example ```javascript @@ -360,7 +360,7 @@ Name | Type | Description | Notes # **retrieveBankAccount** > V1BankAccount retrieveBankAccount(locationId, bankAccountId) -Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. +RetrieveBankAccount Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. @@ -411,7 +411,7 @@ Name | Type | Description | Notes # **retrieveOrder** > V1Order retrieveOrder(locationId, orderId) -Provides comprehensive information for a single online store order, including the order's history. +RetrieveOrder Provides comprehensive information for a single online store order, including the order's history. @@ -462,7 +462,7 @@ Name | Type | Description | Notes # **retrievePayment** > V1Payment retrievePayment(locationId, paymentId) -Provides comprehensive information for a single payment. +RetrievePayment Provides comprehensive information for a single payment. @@ -513,9 +513,9 @@ Name | Type | Description | Notes # **retrieveSettlement** > V1Settlement retrieveSettlement(locationId, settlementId) -Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total. +RetrieveSettlement -Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total. +Provides comprehensive information for a single settlement. The returned `Settlement` objects include an `entries` field that lists the transactions that contribute to the settlement total. Most settlement entries correspond to a payment payout, but settlement entries are also generated for less common events, like refunds, manual adjustments, or chargeback holds. Square initiates its regular deposits as indicated in the [Deposit Options with Square](https://squareup.com/help/us/en/article/3807) help article. Details for a regular deposit are usually not available from Connect API endpoints before 10 p.m. PST the same day. Square does not know when an initiated settlement **completes**, only whether it has failed. A completed settlement is typically reflected in a bank account within 3 business days, but in exceptional cases it may take longer. ### Example ```javascript @@ -564,7 +564,7 @@ Name | Type | Description | Notes # **updateOrder** > V1Order updateOrder(locationId, orderId, body) -Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions: +UpdateOrder Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions: diff --git a/docs/V1UpdateCategoryRequest.md b/docs/V1UpdateCategoryRequest.md new file mode 100644 index 0000000..8531264 --- /dev/null +++ b/docs/V1UpdateCategoryRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1UpdateCategoryRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1Category**](V1Category.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | + + diff --git a/docs/V1UpdateDiscountRequest.md b/docs/V1UpdateDiscountRequest.md new file mode 100644 index 0000000..07f9e09 --- /dev/null +++ b/docs/V1UpdateDiscountRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1UpdateDiscountRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1Discount**](V1Discount.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | + + diff --git a/docs/V1UpdateEmployeeRequest.md b/docs/V1UpdateEmployeeRequest.md new file mode 100644 index 0000000..c9aed7d --- /dev/null +++ b/docs/V1UpdateEmployeeRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1UpdateEmployeeRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1Employee**](V1Employee.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | + + diff --git a/docs/V1UpdateEmployeeRoleRequest.md b/docs/V1UpdateEmployeeRoleRequest.md new file mode 100644 index 0000000..ef5f717 --- /dev/null +++ b/docs/V1UpdateEmployeeRoleRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1UpdateEmployeeRoleRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1EmployeeRole**](V1EmployeeRole.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | + + diff --git a/docs/V1UpdateFeeRequest.md b/docs/V1UpdateFeeRequest.md new file mode 100644 index 0000000..aaac667 --- /dev/null +++ b/docs/V1UpdateFeeRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1UpdateFeeRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1Fee**](V1Fee.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | + + diff --git a/docs/V1UpdateItemRequest.md b/docs/V1UpdateItemRequest.md new file mode 100644 index 0000000..c4d6506 --- /dev/null +++ b/docs/V1UpdateItemRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1UpdateItemRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1Item**](V1Item.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | + + diff --git a/docs/V1UpdateModifierListRequest.md b/docs/V1UpdateModifierListRequest.md index 3797452..8f98196 100644 --- a/docs/V1UpdateModifierListRequest.md +++ b/docs/V1UpdateModifierListRequest.md @@ -1,10 +1,14 @@ # SquareConnect.V1UpdateModifierListRequest +### Description + +V1UpdateModifierListRequest + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | The modifier list's name. | [optional] -**selection_type** | **String** | Indicates whether multiple options from the modifier list can be applied to a single item. | [optional] +**selection_type** | **String** | Indicates whether multiple options from the modifier list can be applied to a single item. See [V1UpdateModifierListRequestSelectionType](#type-v1updatemodifierlistrequestselectiontype) for possible values | [optional] diff --git a/docs/V1UpdateModifierListRequestSelectionType.md b/docs/V1UpdateModifierListRequestSelectionType.md new file mode 100644 index 0000000..4450626 --- /dev/null +++ b/docs/V1UpdateModifierListRequestSelectionType.md @@ -0,0 +1,10 @@ +# SquareConnect.V1UpdateModifierListRequestSelectionType + +## Enum + + +* `SINGLE` (value: `"SINGLE"`) + +* `MULTIPLE` (value: `"MULTIPLE"`) + + diff --git a/docs/V1UpdateModifierOptionRequest.md b/docs/V1UpdateModifierOptionRequest.md new file mode 100644 index 0000000..a23b7b0 --- /dev/null +++ b/docs/V1UpdateModifierOptionRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1UpdateModifierOptionRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1ModifierOption**](V1ModifierOption.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | + + diff --git a/docs/V1UpdateOrderRequest.md b/docs/V1UpdateOrderRequest.md index a2f2414..16fc540 100644 --- a/docs/V1UpdateOrderRequest.md +++ b/docs/V1UpdateOrderRequest.md @@ -1,9 +1,13 @@ # SquareConnect.V1UpdateOrderRequest +### Description + +V1UpdateOrderRequest + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**action** | **String** | The action to perform on the order (COMPLETE, CANCEL, or REFUND). | +**action** | **String** | The action to perform on the order (COMPLETE, CANCEL, or REFUND). See [V1UpdateOrderRequestAction](#type-v1updateorderrequestaction) for possible values | **shipped_tracking_number** | **String** | The tracking number of the shipment associated with the order. Only valid if action is COMPLETE. | [optional] **completed_note** | **String** | A merchant-specified note about the completion of the order. Only valid if action is COMPLETE. | [optional] **refunded_note** | **String** | A merchant-specified note about the refunding of the order. Only valid if action is REFUND. | [optional] diff --git a/docs/V1UpdateOrderRequestAction.md b/docs/V1UpdateOrderRequestAction.md new file mode 100644 index 0000000..eb36b30 --- /dev/null +++ b/docs/V1UpdateOrderRequestAction.md @@ -0,0 +1,12 @@ +# SquareConnect.V1UpdateOrderRequestAction + +## Enum + + +* `COMPLETE` (value: `"COMPLETE"`) + +* `CANCEL` (value: `"CANCEL"`) + +* `REFUND` (value: `"REFUND"`) + + diff --git a/docs/V1UpdatePageCellRequest.md b/docs/V1UpdatePageCellRequest.md new file mode 100644 index 0000000..9d81433 --- /dev/null +++ b/docs/V1UpdatePageCellRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1UpdatePageCellRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1PageCell**](V1PageCell.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | + + diff --git a/docs/V1UpdatePageRequest.md b/docs/V1UpdatePageRequest.md new file mode 100644 index 0000000..79a8a28 --- /dev/null +++ b/docs/V1UpdatePageRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1UpdatePageRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1Page**](V1Page.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | + + diff --git a/docs/V1UpdateTimecardRequest.md b/docs/V1UpdateTimecardRequest.md new file mode 100644 index 0000000..fe3d63d --- /dev/null +++ b/docs/V1UpdateTimecardRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1UpdateTimecardRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1Timecard**](V1Timecard.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | + + diff --git a/docs/V1UpdateVariationRequest.md b/docs/V1UpdateVariationRequest.md new file mode 100644 index 0000000..ebc7bdb --- /dev/null +++ b/docs/V1UpdateVariationRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.V1UpdateVariationRequest + +### Description + + + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**body** | [**V1Variation**](V1Variation.md) | An object containing the fields to POST for the request. See the corresponding object definition for field details. | + + diff --git a/docs/V1Variation.md b/docs/V1Variation.md index 630a020..dadd0aa 100644 --- a/docs/V1Variation.md +++ b/docs/V1Variation.md @@ -1,5 +1,9 @@ # SquareConnect.V1Variation +### Description + +V1Variation + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- @@ -7,11 +11,11 @@ Name | Type | Description | Notes **name** | **String** | The item variation's name. | [optional] **item_id** | **String** | The ID of the variation's associated item. | [optional] **ordinal** | **Number** | Indicates the variation's list position when displayed in Square Register and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order | [optional] -**pricing_type** | **String** | Indicates whether the item variation's price is fixed or determined at the time of sale. | [optional] +**pricing_type** | **String** | Indicates whether the item variation's price is fixed or determined at the time of sale. See [V1VariationPricingType](#type-v1variationpricingtype) for possible values | [optional] **price_money** | [**V1Money**](V1Money.md) | The item variation's price, if any. | [optional] **sku** | **String** | The item variation's SKU, if any. | [optional] **track_inventory** | **Boolean** | If true, inventory tracking is active for the variation. | [optional] -**inventory_alert_type** | **String** | Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its inventory_alert_threshold. | [optional] +**inventory_alert_type** | **String** | Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its inventory_alert_threshold. See [V1VariationInventoryAlertType](#type-v1variationinventoryalerttype) for possible values | [optional] **inventory_alert_threshold** | **Number** | If the inventory quantity for the variation is less than or equal to this value and inventory_alert_type is LOW_QUANTITY, the variation displays an alert in the merchant dashboard. | [optional] **user_data** | **String** | Arbitrary metadata associated with the variation. Cannot exceed 255 characters. | [optional] diff --git a/docs/V1VariationInventoryAlertType.md b/docs/V1VariationInventoryAlertType.md new file mode 100644 index 0000000..8aa4db2 --- /dev/null +++ b/docs/V1VariationInventoryAlertType.md @@ -0,0 +1,18 @@ +# SquareConnect.V1VariationInventoryAlertType + +## Enum + + +* `LOW_QUANTITY` (value: `"LOW_QUANTITY"`) + +* `NONE` (value: `"NONE"`) + +* `INVESTMENT` (value: `"INVESTMENT"`) + +* `LOAN` (value: `"LOAN"`) + +* `SAVINGS` (value: `"SAVINGS"`) + +* `OTHER` (value: `"OTHER"`) + + diff --git a/docs/V1VariationPricingType.md b/docs/V1VariationPricingType.md new file mode 100644 index 0000000..e8492dc --- /dev/null +++ b/docs/V1VariationPricingType.md @@ -0,0 +1,10 @@ +# SquareConnect.V1VariationPricingType + +## Enum + + +* `FIXED_PRICING` (value: `"FIXED_PRICING"`) + +* `VARIABLE_PRICING` (value: `"VARIABLE_PRICING"`) + + diff --git a/docs/VoidTransactionRequest.md b/docs/VoidTransactionRequest.md index 53a0744..02592ae 100644 --- a/docs/VoidTransactionRequest.md +++ b/docs/VoidTransactionRequest.md @@ -1,5 +1,9 @@ # SquareConnect.VoidTransactionRequest +### Description + + + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/VoidTransactionResponse.md b/docs/VoidTransactionResponse.md index 9bce553..b129667 100644 --- a/docs/VoidTransactionResponse.md +++ b/docs/VoidTransactionResponse.md @@ -1,5 +1,9 @@ # SquareConnect.VoidTransactionResponse +### Description + +Defines the fields that are included in the response body of a request to the [VoidTransaction](#endpoint-voidtransaction) endpoint. + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/docs/Weekday.md b/docs/Weekday.md new file mode 100644 index 0000000..324f5a3 --- /dev/null +++ b/docs/Weekday.md @@ -0,0 +1,20 @@ +# SquareConnect.Weekday + +## Enum + + +* `MON` (value: `"MON"`) + +* `TUE` (value: `"TUE"`) + +* `WED` (value: `"WED"`) + +* `THU` (value: `"THU"`) + +* `FRI` (value: `"FRI"`) + +* `SAT` (value: `"SAT"`) + +* `SUN` (value: `"SUN"`) + + diff --git a/docs/WorkweekConfig.md b/docs/WorkweekConfig.md new file mode 100644 index 0000000..3ea682e --- /dev/null +++ b/docs/WorkweekConfig.md @@ -0,0 +1,38 @@ +# SquareConnect.WorkweekConfig + +### Description + +Sets the Day of the week and hour of the day that a business starts a work week. Used for the calculation of overtime pay. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | UUID for this object | [optional] +**start_of_week** | **String** | The day of the week on which a business week cuts over for compensation purposes. | +**start_of_day_local_time** | **String** | The local time at which a business week cuts over. Represented as a string in `HH:MM` format (`HH:MM:SS` is also accepted, but seconds are truncated). | +**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] + + + +## Enum: StartOfWeekEnum + + +* `MON` (value: `"MON"`) + +* `TUE` (value: `"TUE"`) + +* `WED` (value: `"WED"`) + +* `THU` (value: `"THU"`) + +* `FRI` (value: `"FRI"`) + +* `SAT` (value: `"SAT"`) + +* `SUN` (value: `"SUN"`) + + + + diff --git a/package.json b/package.json index f8e9760..78ccc08 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "square-connect", - "version": "2.20190213.0", + "version": "2.20190313.0", "description": "JavaScript client library for the Square Connect v2 API", "keywords": [ "square", diff --git a/src/ApiClient.js b/src/ApiClient.js index 6d92f78..3a17884 100644 --- a/src/ApiClient.js +++ b/src/ApiClient.js @@ -16,7 +16,7 @@ var querystring = require('querystring'); /** * @module ApiClient - * @version 2.20190213.0 + * @version 2.20190313.0 */ /** @@ -48,7 +48,7 @@ var exports = function() { * @default {} */ this.defaultHeaders = { - 'User-Agent': 'Square-Connect-Javascript/2.20190213.0' + 'User-Agent': 'Square-Connect-Javascript/2.20190313.0' }; /** * The default HTTP timeout for all API calls. diff --git a/src/api/ApplePayApi.js b/src/api/ApplePayApi.js index fdbfe51..027bc9c 100644 --- a/src/api/ApplePayApi.js +++ b/src/api/ApplePayApi.js @@ -53,7 +53,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; diff --git a/src/api/CatalogApi.js b/src/api/CatalogApi.js index 918f129..8c55e73 100644 --- a/src/api/CatalogApi.js +++ b/src/api/CatalogApi.js @@ -69,7 +69,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -121,7 +121,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -173,7 +173,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -219,7 +219,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -271,7 +271,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -306,7 +306,7 @@ module.exports = function(apiClient) { * ListCatalog * Returns a list of [CatalogObject](#type-catalogobject)s that includes all objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem) and [CatalogTax](#type-catalogtax) objects) in the catalog. The types parameter is specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types: `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`. * @param {Object} opts Optional parameters - * @param {String} opts.cursor The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information. + * @param {String} opts.cursor The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information. * @param {String} opts.types An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY`. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListCatalogResponse} and HTTP response */ @@ -323,7 +323,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -344,7 +344,7 @@ module.exports = function(apiClient) { * ListCatalog * Returns a list of [CatalogObject](#type-catalogobject)s that includes all objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem) and [CatalogTax](#type-catalogtax) objects) in the catalog. The types parameter is specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types: `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`. * @param {Object} opts Optional parameters - * @param {String} opts.cursor The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information. + * @param {String} opts.cursor The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information. * @param {String} opts.types An optional case-insensitive, comma-separated list of object types to retrieve, for example `ITEM,ITEM_VARIATION,CATEGORY`. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListCatalogResponse} */ @@ -382,7 +382,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -436,7 +436,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -488,7 +488,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -540,7 +540,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -592,7 +592,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; diff --git a/src/api/CheckoutApi.js b/src/api/CheckoutApi.js index 9b8a253..ca28e68 100644 --- a/src/api/CheckoutApi.js +++ b/src/api/CheckoutApi.js @@ -60,7 +60,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; diff --git a/src/api/CustomersApi.js b/src/api/CustomersApi.js index 45c2318..ec7e81b 100644 --- a/src/api/CustomersApi.js +++ b/src/api/CustomersApi.js @@ -63,7 +63,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -122,7 +122,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -176,7 +176,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -236,7 +236,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -272,7 +272,7 @@ module.exports = function(apiClient) { * ListCustomers * Lists a business's customers. * @param {Object} opts Optional parameters - * @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. + * @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 [Pagination](/basics/api101/pagination) for more information. * @param {module:model/String} opts.sortField Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values. * @param {module:model/String} opts.sortOrder Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListCustomersResponse} and HTTP response @@ -291,7 +291,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -312,7 +312,7 @@ module.exports = function(apiClient) { * ListCustomers * Lists a business's customers. * @param {Object} opts Optional parameters - * @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. + * @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 [Pagination](/basics/api101/pagination) for more information. * @param {module:model/String} opts.sortField Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values. * @param {module:model/String} opts.sortOrder Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListCustomersResponse} @@ -347,7 +347,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -399,7 +399,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -458,7 +458,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; diff --git a/src/api/EmployeesApi.js b/src/api/EmployeesApi.js new file mode 100644 index 0000000..0307168 --- /dev/null +++ b/src/api/EmployeesApi.js @@ -0,0 +1,146 @@ +/** + * 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 ListEmployeesResponse = require('../model/ListEmployeesResponse'); +var RetrieveEmployeeResponse = require('../model/RetrieveEmployeeResponse'); + +/** + * Employees service. + * @module api/EmployeesApi + */ + +/** + * Constructs a new EmployeesApi. + * @alias module:api/EmployeesApi + * @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; + + + + /** + * ListEmployees + * Gets a list of `Employee` objects for a business. + * @param {Object} opts Optional parameters + * @param {String} opts.locationId Filter employees returned to only those that are associated with the specified location. + * @param {module:model/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) { + opts = opts || {}; + var postBody = null; + + + var pathParams = { + }; + var queryParams = { + 'location_id': opts['locationId'], + 'status': opts['status'], + 'limit': opts['limit'], + 'cursor': opts['cursor'] + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2019-03-13'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = ListEmployeesResponse; + + return this.apiClient.callApi( + '/v2/employees', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * ListEmployees + * Gets a list of `Employee` objects for a business. + * @param {Object} opts Optional parameters + * @param {String} opts.locationId Filter employees returned to only those that are associated with the specified location. + * @param {module:model/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 data of type {@link module:model/ListEmployeesResponse} + */ + this.listEmployees = function(opts) { + return this.listEmployeesWithHttpInfo(opts) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * RetrieveEmployee + * Gets an `Employee` by Square-assigned employee `ID` (UUID) + * @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) { + 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 retrieveEmployee"); + } + + + var pathParams = { + 'id': id + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2019-03-13'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = RetrieveEmployeeResponse; + + return this.apiClient.callApi( + '/v2/employees/{id}', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * RetrieveEmployee + * Gets an `Employee` by Square-assigned employee `ID` (UUID) + * @param {String} id UUID for the employee that was requested. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveEmployeeResponse} + */ + this.retrieveEmployee = function(id) { + return this.retrieveEmployeeWithHttpInfo(id) + .then(function(response_and_data) { + return response_and_data.data; + }); + } +}; diff --git a/src/api/InventoryApi.js b/src/api/InventoryApi.js index 2e75ee2..cf5b86c 100644 --- a/src/api/InventoryApi.js +++ b/src/api/InventoryApi.js @@ -61,7 +61,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -113,7 +113,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -165,7 +165,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -218,7 +218,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -255,7 +255,7 @@ module.exports = function(apiClient) { * @param {String} catalogObjectId ID of the [CatalogObject](#type-catalogobject) to retrieve. * @param {Object} opts Optional parameters * @param {String} opts.locationIds The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. - * @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 the original query. See [Paginating results](#paginatingresults) for more information. + * @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 the original query. See [Pagination](/basics/api101/pagination) for more information. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveInventoryChangesResponse} and HTTP response */ this.retrieveInventoryChangesWithHttpInfo = function(catalogObjectId, opts) { @@ -277,7 +277,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -300,7 +300,7 @@ module.exports = function(apiClient) { * @param {String} catalogObjectId ID of the [CatalogObject](#type-catalogobject) to retrieve. * @param {Object} opts Optional parameters * @param {String} opts.locationIds The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. - * @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 the original query. See [Paginating results](#paginatingresults) for more information. + * @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 the original query. See [Pagination](/basics/api101/pagination) for more information. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveInventoryChangesResponse} */ this.retrieveInventoryChanges = function(catalogObjectId, opts) { @@ -317,7 +317,7 @@ module.exports = function(apiClient) { * @param {String} catalogObjectId ID of the [CatalogObject](#type-catalogobject) to retrieve. * @param {Object} opts Optional parameters * @param {String} opts.locationIds The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. - * @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 the original query. See [Paginating results](#paginatingresults) for more information. + * @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 the original query. See [Pagination](/basics/api101/pagination) for more information. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveInventoryCountResponse} and HTTP response */ this.retrieveInventoryCountWithHttpInfo = function(catalogObjectId, opts) { @@ -339,7 +339,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -362,7 +362,7 @@ module.exports = function(apiClient) { * @param {String} catalogObjectId ID of the [CatalogObject](#type-catalogobject) to retrieve. * @param {Object} opts Optional parameters * @param {String} opts.locationIds The [Location](#type-location) IDs to look up as a comma-separated list. An empty list queries all locations. - * @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 the original query. See [Paginating results](#paginatingresults) for more information. + * @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 the original query. See [Pagination](/basics/api101/pagination) for more information. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveInventoryCountResponse} */ this.retrieveInventoryCount = function(catalogObjectId, opts) { @@ -395,7 +395,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; diff --git a/src/api/LaborApi.js b/src/api/LaborApi.js new file mode 100644 index 0000000..3123bd1 --- /dev/null +++ b/src/api/LaborApi.js @@ -0,0 +1,820 @@ +/** + * 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 CreateBreakTypeRequest = require('../model/CreateBreakTypeRequest'); +var CreateBreakTypeResponse = require('../model/CreateBreakTypeResponse'); +var CreateShiftRequest = require('../model/CreateShiftRequest'); +var CreateShiftResponse = require('../model/CreateShiftResponse'); +var DeleteBreakTypeResponse = require('../model/DeleteBreakTypeResponse'); +var DeleteShiftResponse = require('../model/DeleteShiftResponse'); +var GetBreakTypeResponse = require('../model/GetBreakTypeResponse'); +var GetEmployeeWageResponse = require('../model/GetEmployeeWageResponse'); +var GetShiftResponse = require('../model/GetShiftResponse'); +var ListBreakTypesResponse = require('../model/ListBreakTypesResponse'); +var ListEmployeeWagesResponse = require('../model/ListEmployeeWagesResponse'); +var ListWorkweekConfigsResponse = require('../model/ListWorkweekConfigsResponse'); +var SearchShiftsRequest = require('../model/SearchShiftsRequest'); +var SearchShiftsResponse = require('../model/SearchShiftsResponse'); +var UpdateBreakTypeRequest = require('../model/UpdateBreakTypeRequest'); +var UpdateBreakTypeResponse = require('../model/UpdateBreakTypeResponse'); +var UpdateShiftRequest = require('../model/UpdateShiftRequest'); +var UpdateShiftResponse = require('../model/UpdateShiftResponse'); +var UpdateWorkweekConfigRequest = require('../model/UpdateWorkweekConfigRequest'); +var UpdateWorkweekConfigResponse = require('../model/UpdateWorkweekConfigResponse'); + +/** + * Labor service. + * @module api/LaborApi + */ + +/** + * Constructs a new LaborApi. + * @alias module:api/LaborApi + * @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; + + + + /** + * 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. + * @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 + */ + this.createBreakTypeWithHttpInfo = function(body) { + var postBody = body; + + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw new Error("Missing the required parameter 'body' when calling createBreakType"); + } + + + var pathParams = { + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2019-03-13'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = CreateBreakTypeResponse; + + return this.apiClient.callApi( + '/v2/labor/break-types', 'POST', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * 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. + * @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} + */ + this.createBreakType = function(body) { + return this.createBreakTypeWithHttpInfo(body) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * 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` + * @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 + */ + this.createShiftWithHttpInfo = function(body) { + var postBody = body; + + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw new Error("Missing the required parameter 'body' when calling createShift"); + } + + + var pathParams = { + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2019-03-13'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = CreateShiftResponse; + + return this.apiClient.callApi( + '/v2/labor/shifts', 'POST', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * 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` + * @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} + */ + this.createShift = function(body) { + return this.createShiftWithHttpInfo(body) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * DeleteBreakType + * 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 + */ + this.deleteBreakTypeWithHttpInfo = 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 deleteBreakType"); + } + + + var pathParams = { + 'id': id + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2019-03-13'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = DeleteBreakTypeResponse; + + return this.apiClient.callApi( + '/v2/labor/break-types/{id}', 'DELETE', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * DeleteBreakType + * 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} + */ + this.deleteBreakType = function(id) { + return this.deleteBreakTypeWithHttpInfo(id) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * DeleteShift + * Deletes a `Shift`. + * @param {String} id UUID for the `Shift` being deleted. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteShiftResponse} and HTTP response + */ + this.deleteShiftWithHttpInfo = 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 deleteShift"); + } + + + var pathParams = { + 'id': id + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2019-03-13'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = DeleteShiftResponse; + + return this.apiClient.callApi( + '/v2/labor/shifts/{id}', 'DELETE', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * DeleteShift + * Deletes a `Shift`. + * @param {String} id UUID for the `Shift` being deleted. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteShiftResponse} + */ + this.deleteShift = function(id) { + return this.deleteShiftWithHttpInfo(id) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * GetBreakType + * Returns a single `BreakType` specified by id. + * @param {String} id UUID for the `BreakType` being retrieved. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetBreakTypeResponse} and HTTP response + */ + this.getBreakTypeWithHttpInfo = 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 getBreakType"); + } + + + var pathParams = { + 'id': id + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2019-03-13'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = GetBreakTypeResponse; + + return this.apiClient.callApi( + '/v2/labor/break-types/{id}', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * GetBreakType + * Returns a single `BreakType` specified by id. + * @param {String} id UUID for the `BreakType` being retrieved. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetBreakTypeResponse} + */ + this.getBreakType = function(id) { + return this.getBreakTypeWithHttpInfo(id) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * 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) { + 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 getEmployeeWage"); + } + + + var pathParams = { + 'id': id + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2019-03-13'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = GetEmployeeWageResponse; + + return this.apiClient.callApi( + '/v2/labor/employee-wages/{id}', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * 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 data of type {@link module:model/GetEmployeeWageResponse} + */ + this.getEmployeeWage = function(id) { + return this.getEmployeeWageWithHttpInfo(id) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * GetShift + * Returns a single `Shift` specified by id. + * @param {String} id UUID for the `Shift` being retrieved. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetShiftResponse} and HTTP response + */ + this.getShiftWithHttpInfo = 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 getShift"); + } + + + var pathParams = { + 'id': id + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2019-03-13'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = GetShiftResponse; + + return this.apiClient.callApi( + '/v2/labor/shifts/{id}', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * GetShift + * Returns a single `Shift` specified by id. + * @param {String} id UUID for the `Shift` being retrieved. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetShiftResponse} + */ + this.getShift = function(id) { + return this.getShiftWithHttpInfo(id) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * ListBreakTypes + * Returns a paginated list of `BreakType` instances for a business. + * @param {Object} opts Optional parameters + * @param {String} opts.locationId Filter Break Types returned to only those that are associated with the specified location. + * @param {Number} opts.limit Maximum number of Break Types 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 Break Type results to fetch. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListBreakTypesResponse} and HTTP response + */ + this.listBreakTypesWithHttpInfo = function(opts) { + opts = opts || {}; + var postBody = null; + + + var pathParams = { + }; + var queryParams = { + 'location_id': opts['locationId'], + 'limit': opts['limit'], + 'cursor': opts['cursor'] + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2019-03-13'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = ListBreakTypesResponse; + + return this.apiClient.callApi( + '/v2/labor/break-types', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * ListBreakTypes + * Returns a paginated list of `BreakType` instances for a business. + * @param {Object} opts Optional parameters + * @param {String} opts.locationId Filter Break Types returned to only those that are associated with the specified location. + * @param {Number} opts.limit Maximum number of Break Types 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 Break Type results to fetch. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListBreakTypesResponse} + */ + this.listBreakTypes = function(opts) { + return this.listBreakTypesWithHttpInfo(opts) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * ListEmployeeWages + * Returns a paginated list of `EmployeeWage` instances for a business. + * @param {Object} opts Optional parameters + * @param {String} opts.employeeId Filter wages returned to only those that are associated with the specified employee. + * @param {Number} opts.limit Maximum number of Employee 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/ListEmployeeWagesResponse} and HTTP response + */ + this.listEmployeeWagesWithHttpInfo = function(opts) { + opts = opts || {}; + var postBody = null; + + + var pathParams = { + }; + var queryParams = { + 'employee_id': opts['employeeId'], + 'limit': opts['limit'], + 'cursor': opts['cursor'] + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2019-03-13'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = ListEmployeeWagesResponse; + + return this.apiClient.callApi( + '/v2/labor/employee-wages', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * ListEmployeeWages + * Returns a paginated list of `EmployeeWage` instances for a business. + * @param {Object} opts Optional parameters + * @param {String} opts.employeeId Filter wages returned to only those that are associated with the specified employee. + * @param {Number} opts.limit Maximum number of Employee 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/ListEmployeeWagesResponse} + */ + this.listEmployeeWages = function(opts) { + return this.listEmployeeWagesWithHttpInfo(opts) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * ListWorkweekConfigs + * Returns a list of `WorkweekConfig` instances for a business. + * @param {Object} opts Optional parameters + * @param {Number} opts.limit Maximum number of Workweek Configs to return per page. + * @param {String} opts.cursor Pointer to the next page of Workweek Config results to fetch. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListWorkweekConfigsResponse} and HTTP response + */ + this.listWorkweekConfigsWithHttpInfo = function(opts) { + opts = opts || {}; + var postBody = null; + + + var pathParams = { + }; + var queryParams = { + 'limit': opts['limit'], + 'cursor': opts['cursor'] + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2019-03-13'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = ListWorkweekConfigsResponse; + + return this.apiClient.callApi( + '/v2/labor/workweek-configs', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * ListWorkweekConfigs + * Returns a list of `WorkweekConfig` instances for a business. + * @param {Object} opts Optional parameters + * @param {Number} opts.limit Maximum number of Workweek Configs to return per page. + * @param {String} opts.cursor Pointer to the next page of Workweek Config results to fetch. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListWorkweekConfigsResponse} + */ + this.listWorkweekConfigs = function(opts) { + return this.listWorkweekConfigsWithHttpInfo(opts) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * 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` + * @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 + */ + this.searchShiftsWithHttpInfo = function(body) { + var postBody = body; + + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw new Error("Missing the required parameter 'body' when calling searchShifts"); + } + + + var pathParams = { + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2019-03-13'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = SearchShiftsResponse; + + return this.apiClient.callApi( + '/v2/labor/shifts/search', 'POST', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * 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` + * @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} + */ + this.searchShifts = function(body) { + return this.searchShiftsWithHttpInfo(body) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * UpdateBreakType + * Updates an existing `BreakType`. + * @param {String} id UUID for the `BreakType` being updated. + * @param {module:model/UpdateBreakTypeRequest} 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/UpdateBreakTypeResponse} and HTTP response + */ + this.updateBreakTypeWithHttpInfo = function(id, body) { + var postBody = body; + + // verify the required parameter 'id' is set + if (id === undefined || id === null) { + throw new Error("Missing the required parameter 'id' when calling updateBreakType"); + } + + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw new Error("Missing the required parameter 'body' when calling updateBreakType"); + } + + + var pathParams = { + 'id': id + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2019-03-13'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = UpdateBreakTypeResponse; + + return this.apiClient.callApi( + '/v2/labor/break-types/{id}', 'PUT', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * UpdateBreakType + * Updates an existing `BreakType`. + * @param {String} id UUID for the `BreakType` being updated. + * @param {module:model/UpdateBreakTypeRequest} 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/UpdateBreakTypeResponse} + */ + this.updateBreakType = function(id, body) { + return this.updateBreakTypeWithHttpInfo(id, body) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * 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`. + * @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 + */ + this.updateShiftWithHttpInfo = function(id, body) { + var postBody = body; + + // verify the required parameter 'id' is set + if (id === undefined || id === null) { + throw new Error("Missing the required parameter 'id' when calling updateShift"); + } + + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw new Error("Missing the required parameter 'body' when calling updateShift"); + } + + + var pathParams = { + 'id': id + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2019-03-13'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = UpdateShiftResponse; + + return this.apiClient.callApi( + '/v2/labor/shifts/{id}', 'PUT', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * 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`. + * @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} + */ + this.updateShift = function(id, body) { + return this.updateShiftWithHttpInfo(id, body) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * UpdateWorkweekConfig + * Updates a `WorkweekConfig`. + * @param {String} id UUID for the `WorkweekConfig` object being updated. + * @param {module:model/UpdateWorkweekConfigRequest} 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/UpdateWorkweekConfigResponse} and HTTP response + */ + this.updateWorkweekConfigWithHttpInfo = function(id, body) { + var postBody = body; + + // verify the required parameter 'id' is set + if (id === undefined || id === null) { + throw new Error("Missing the required parameter 'id' when calling updateWorkweekConfig"); + } + + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw new Error("Missing the required parameter 'body' when calling updateWorkweekConfig"); + } + + + var pathParams = { + 'id': id + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2019-03-13'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = UpdateWorkweekConfigResponse; + + return this.apiClient.callApi( + '/v2/labor/workweek-configs/{id}', 'PUT', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * UpdateWorkweekConfig + * Updates a `WorkweekConfig`. + * @param {String} id UUID for the `WorkweekConfig` object being updated. + * @param {module:model/UpdateWorkweekConfigRequest} 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/UpdateWorkweekConfigResponse} + */ + this.updateWorkweekConfig = function(id, body) { + return this.updateWorkweekConfigWithHttpInfo(id, body) + .then(function(response_and_data) { + return response_and_data.data; + }); + } +}; diff --git a/src/api/LocationsApi.js b/src/api/LocationsApi.js index 2464378..7c887c1 100644 --- a/src/api/LocationsApi.js +++ b/src/api/LocationsApi.js @@ -46,7 +46,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; diff --git a/src/api/MobileAuthorizationApi.js b/src/api/MobileAuthorizationApi.js index a206ac4..d1eb877 100644 --- a/src/api/MobileAuthorizationApi.js +++ b/src/api/MobileAuthorizationApi.js @@ -53,7 +53,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; diff --git a/src/api/OAuthApi.js b/src/api/OAuthApi.js index 627974f..fdcea21 100644 --- a/src/api/OAuthApi.js +++ b/src/api/OAuthApi.js @@ -38,7 +38,7 @@ module.exports = function(apiClient) { /** * ObtainToken - * Exchanges the authorization code for an access token. After a merchant authorizes your application with the permissions form, an authorization code is sent to the application's redirect URL (See [Implementing OAuth](https://docs.connect.squareup.com/api/oauth#implementingoauth) for information about how to set up the redirect URL). + * Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. By default, the OAuth API lets up to 500 Square accounts authorize your application. Please [contact support](https://squareup.com/help/us/en/contact?prefill=developer_api) if you are developing an application for a larger audience. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. * @param {module:model/ObtainTokenRequest} 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/ObtainTokenResponse} and HTTP response */ @@ -57,7 +57,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -76,7 +76,7 @@ module.exports = function(apiClient) { /** * ObtainToken - * Exchanges the authorization code for an access token. After a merchant authorizes your application with the permissions form, an authorization code is sent to the application's redirect URL (See [Implementing OAuth](https://docs.connect.squareup.com/api/oauth#implementingoauth) for information about how to set up the redirect URL). + * Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. By default, the OAuth API lets up to 500 Square accounts authorize your application. Please [contact support](https://squareup.com/help/us/en/contact?prefill=developer_api) if you are developing an application for a larger audience. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. * @param {module:model/ObtainTokenRequest} 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/ObtainTokenResponse} */ @@ -90,7 +90,7 @@ module.exports = function(apiClient) { /** * RenewToken - * Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated merchant must complete the [OAuth flow](https://docs.connect.squareup.com/api/oauth#implementingoauth) from the beginning. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with your application's secret, available from the [application dashboard](https://connect.squareup.com/apps). + * `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](/authz/oauth/cookbook/oauth-renew). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). * @param {String} clientId Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). * @param {module:model/RenewTokenRequest} 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/RenewTokenResponse} and HTTP response @@ -116,7 +116,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -135,7 +135,7 @@ module.exports = function(apiClient) { /** * RenewToken - * Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated merchant must complete the [OAuth flow](https://docs.connect.squareup.com/api/oauth#implementingoauth) from the beginning. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with your application's secret, available from the [application dashboard](https://connect.squareup.com/apps). + * `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](/authz/oauth/cookbook/oauth-renew). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). * @param {String} clientId Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). * @param {module:model/RenewTokenRequest} 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/RenewTokenResponse} @@ -150,7 +150,7 @@ module.exports = function(apiClient) { /** * RevokeToken - * Revokes an access token generated with the OAuth flow. If a merchant has more than one access token for your application, this endpoint revokes all of them, regardless of which token you specify. If you revoke a merchant's access token, all of the merchant's active subscriptions associated with your application are canceled immediately. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with your application's secret, available from the [application dashboard](https://connect.squareup.com/apps). + * Revokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). * @param {module:model/RevokeTokenRequest} 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/RevokeTokenResponse} and HTTP response */ @@ -169,7 +169,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -188,7 +188,7 @@ module.exports = function(apiClient) { /** * RevokeToken - * Revokes an access token generated with the OAuth flow. If a merchant has more than one access token for your application, this endpoint revokes all of them, regardless of which token you specify. If you revoke a merchant's access token, all of the merchant's active subscriptions associated with your application are canceled immediately. __Important:__ The `Authorization` header you provide to this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with your application's secret, available from the [application dashboard](https://connect.squareup.com/apps). + * Revokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). * @param {module:model/RevokeTokenRequest} 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/RevokeTokenResponse} */ diff --git a/src/api/OrdersApi.js b/src/api/OrdersApi.js index fe4709b..bbc3b07 100644 --- a/src/api/OrdersApi.js +++ b/src/api/OrdersApi.js @@ -62,7 +62,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -122,7 +122,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; diff --git a/src/api/ReportingApi.js b/src/api/ReportingApi.js index 261837b..6a76c0e 100644 --- a/src/api/ReportingApi.js +++ b/src/api/ReportingApi.js @@ -40,7 +40,7 @@ module.exports = function(apiClient) { * @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 {module:model/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. + * @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 [Pagination](/basics/api101/pagination) 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) { @@ -64,7 +64,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -89,7 +89,7 @@ module.exports = function(apiClient) { * @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 {module:model/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. + * @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 [Pagination](/basics/api101/pagination) 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) { @@ -108,7 +108,7 @@ module.exports = function(apiClient) { * @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 {module:model/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. + * @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 [Pagination](/basics/api101/pagination) 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) { @@ -132,7 +132,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -157,7 +157,7 @@ module.exports = function(apiClient) { * @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 {module:model/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. + * @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 [Pagination](/basics/api101/pagination) 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) { diff --git a/src/api/TransactionsApi.js b/src/api/TransactionsApi.js index a77acb9..fa83ce6 100644 --- a/src/api/TransactionsApi.js +++ b/src/api/TransactionsApi.js @@ -68,7 +68,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -128,7 +128,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -195,7 +195,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -236,7 +236,7 @@ module.exports = function(apiClient) { * @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 {module:model/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. + * @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 [Pagination](/basics/api101/pagination) for more information. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListRefundsResponse} and HTTP response */ this.listRefundsWithHttpInfo = function(locationId, opts) { @@ -260,7 +260,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -285,7 +285,7 @@ module.exports = function(apiClient) { * @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 {module:model/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. + * @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 [Pagination](/basics/api101/pagination) for more information. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListRefundsResponse} */ this.listRefunds = function(locationId, opts) { @@ -304,7 +304,7 @@ module.exports = function(apiClient) { * @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 {module:model/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. + * @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 [Pagination](/basics/api101/pagination) for more information. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListTransactionsResponse} and HTTP response */ this.listTransactionsWithHttpInfo = function(locationId, opts) { @@ -328,7 +328,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -353,7 +353,7 @@ module.exports = function(apiClient) { * @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 {module:model/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. + * @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 [Pagination](/basics/api101/pagination) for more information. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListTransactionsResponse} */ this.listTransactions = function(locationId, opts) { @@ -393,7 +393,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -454,7 +454,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2019-02-13'; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; diff --git a/src/api/V1EmployeesApi.js b/src/api/V1EmployeesApi.js index 324a52e..eff2131 100644 --- a/src/api/V1EmployeesApi.js +++ b/src/api/V1EmployeesApi.js @@ -36,8 +36,8 @@ module.exports = function(apiClient) { /** - * Creates an employee for a business. - * Creates an employee for a business. + * CreateEmployee + * Use the CreateEmployee endpoint to add an employee to a Square account. Employees created with the Connect API have an initial status of `INACTIVE`. Inactive employees cannot sign in to Square Point of Sale until they are activated from the Square Dashboard. Employee status cannot be changed with the Connect API. <aside class=\"important\"> Employee entities cannot be deleted. To disable employee profiles, set the employee's status to <code>INACTIVE</code> </aside> * @param {module:model/V1Employee} 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/V1Employee} and HTTP response */ @@ -56,6 +56,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -73,8 +74,8 @@ module.exports = function(apiClient) { } /** - * Creates an employee for a business. - * Creates an employee for a business. + * CreateEmployee + * Use the CreateEmployee endpoint to add an employee to a Square account. Employees created with the Connect API have an initial status of `INACTIVE`. Inactive employees cannot sign in to Square Point of Sale until they are activated from the Square Dashboard. Employee status cannot be changed with the Connect API. <aside class=\"important\"> Employee entities cannot be deleted. To disable employee profiles, set the employee's status to <code>INACTIVE</code> </aside> * @param {module:model/V1Employee} 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/V1Employee} */ @@ -87,8 +88,8 @@ module.exports = function(apiClient) { /** - * Creates an employee role you can then assign to employees. - * Creates an employee role you can then assign to employees. + * CreateEmployeeRole + * Creates an employee role you can then assign to employees. Square accounts can include any number of roles that can be assigned to employees. These roles define the actions and permissions granted to an employee with that role. For example, an employee with a \"Shift Manager\" role might be able to issue refunds in Square Point of Sale, whereas an employee with a \"Clerk\" role might not. Roles are assigned with the [V1UpdateEmployee](#endpoint-v1updateemployee) endpoint. An employee can have only one role at a time. If an employee has no role, they have none of the permissions associated with roles. All employees can accept payments with Square Point of Sale. * @param {module:model/V1EmployeeRole} employeeRole An EmployeeRole object with a name and permissions, and an optional owner flag. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1EmployeeRole} and HTTP response */ @@ -107,6 +108,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -124,8 +126,8 @@ module.exports = function(apiClient) { } /** - * Creates an employee role you can then assign to employees. - * Creates an employee role you can then assign to employees. + * CreateEmployeeRole + * Creates an employee role you can then assign to employees. Square accounts can include any number of roles that can be assigned to employees. These roles define the actions and permissions granted to an employee with that role. For example, an employee with a \"Shift Manager\" role might be able to issue refunds in Square Point of Sale, whereas an employee with a \"Clerk\" role might not. Roles are assigned with the [V1UpdateEmployee](#endpoint-v1updateemployee) endpoint. An employee can have only one role at a time. If an employee has no role, they have none of the permissions associated with roles. All employees can accept payments with Square Point of Sale. * @param {module:model/V1EmployeeRole} employeeRole An EmployeeRole object with a name and permissions, and an optional owner flag. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1EmployeeRole} */ @@ -138,8 +140,8 @@ module.exports = function(apiClient) { /** - * Creates a timecard for an employee. Each timecard corresponds to a single shift. - * Creates a timecard for an employee. Each timecard corresponds to a single shift. + * CreateTimecard + * Creates a timecard for an employee and clocks them in with an `API_CREATE` event and a `clockin_time` set to the current time unless the request provides a different value. To import timecards from another system (rather than clocking someone in). Specify the `clockin_time` and* `clockout_time` in the request. Timecards correspond to exactly one shift for a given employee, bounded by the `clockin_time` and `clockout_time` fields. An employee is considered clocked in if they have a timecard that doesn't have a `clockout_time` set. An employee that is currently clocked in cannot be clocked in a second time. * @param {module:model/V1Timecard} 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/V1Timecard} and HTTP response */ @@ -158,6 +160,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -175,8 +178,8 @@ module.exports = function(apiClient) { } /** - * Creates a timecard for an employee. Each timecard corresponds to a single shift. - * Creates a timecard for an employee. Each timecard corresponds to a single shift. + * CreateTimecard + * Creates a timecard for an employee and clocks them in with an `API_CREATE` event and a `clockin_time` set to the current time unless the request provides a different value. To import timecards from another system (rather than clocking someone in). Specify the `clockin_time` and* `clockout_time` in the request. Timecards correspond to exactly one shift for a given employee, bounded by the `clockin_time` and `clockout_time` fields. An employee is considered clocked in if they have a timecard that doesn't have a `clockout_time` set. An employee that is currently clocked in cannot be clocked in a second time. * @param {module:model/V1Timecard} 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/V1Timecard} */ @@ -189,8 +192,8 @@ module.exports = function(apiClient) { /** - * Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. - * Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. + * DeleteTimecard + * Deletes a timecard. Timecards can also be deleted through the Square Dashboard. Deleted timecards are still accessible through Connect API endpoints, but cannot be modified. The `deleted` field of the `Timecard` object indicates whether the timecard has been deleted. *Note**: By default, deleted timecards appear alongside valid timecards in results returned by the [ListTimecards](#endpoint-v1employees-listtimecards) endpoint. To filter deleted timecards, include the `deleted` query parameter in the list request. <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside> * @param {String} timecardId The ID of the timecard to delete. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Object} and HTTP response */ @@ -210,6 +213,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -227,8 +231,8 @@ module.exports = function(apiClient) { } /** - * Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. - * Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information. + * DeleteTimecard + * Deletes a timecard. Timecards can also be deleted through the Square Dashboard. Deleted timecards are still accessible through Connect API endpoints, but cannot be modified. The `deleted` field of the `Timecard` object indicates whether the timecard has been deleted. *Note**: By default, deleted timecards appear alongside valid timecards in results returned by the [ListTimecards](#endpoint-v1employees-listtimecards) endpoint. To filter deleted timecards, include the `deleted` query parameter in the list request. <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside> * @param {String} timecardId The ID of the timecard to delete. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Object} */ @@ -241,7 +245,7 @@ module.exports = function(apiClient) { /** - * Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. + * ListCashDrawerShifts * Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. * @param {String} locationId The ID of the location to list cash drawer shifts for. * @param {Object} opts Optional parameters @@ -270,6 +274,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -287,7 +292,7 @@ module.exports = function(apiClient) { } /** - * Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. + * ListCashDrawerShifts * Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days. * @param {String} locationId The ID of the location to list cash drawer shifts for. * @param {Object} opts Optional parameters @@ -305,10 +310,10 @@ module.exports = function(apiClient) { /** - * Provides summary information for all of a business's employee roles. + * ListEmployeeRoles * Provides summary information for all of a business's employee roles. * @param {Object} opts Optional parameters - * @param {module:model/String} opts.order The order in which employees are listed in the response, based on their created_at field.Default value: ASC + * @param {module:model/String} opts.order The order in which employees are listed in the response, based on their created_at field.Default value: ASC * @param {Number} opts.limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. * @param {String} opts.batchToken A pagination cursor to retrieve the next set of results for your original query to the endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response @@ -327,6 +332,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -344,10 +350,10 @@ module.exports = function(apiClient) { } /** - * Provides summary information for all of a business's employee roles. + * ListEmployeeRoles * Provides summary information for all of a business's employee roles. * @param {Object} opts Optional parameters - * @param {module:model/String} opts.order The order in which employees are listed in the response, based on their created_at field.Default value: ASC + * @param {module:model/String} opts.order The order in which employees are listed in the response, based on their created_at field.Default value: ASC * @param {Number} opts.limit The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. * @param {String} opts.batchToken A pagination cursor to retrieve the next set of results for your original query to the endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} @@ -361,10 +367,10 @@ module.exports = function(apiClient) { /** - * Provides summary information for all of a business's employees. + * ListEmployees * Provides summary information for all of a business's employees. * @param {Object} opts Optional parameters - * @param {module:model/String} opts.order The order in which employees are listed in the response, based on their created_at field. Default value: ASC + * @param {module:model/String} opts.order The order in which employees are listed in the response, based on their created_at field. Default value: ASC * @param {String} opts.beginUpdatedAt If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format * @param {String} opts.endUpdatedAt If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format. * @param {String} opts.beginCreatedAt If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format. @@ -395,6 +401,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -412,10 +419,10 @@ module.exports = function(apiClient) { } /** - * Provides summary information for all of a business's employees. + * ListEmployees * Provides summary information for all of a business's employees. * @param {Object} opts Optional parameters - * @param {module:model/String} opts.order The order in which employees are listed in the response, based on their created_at field. Default value: ASC + * @param {module:model/String} opts.order The order in which employees are listed in the response, based on their created_at field. Default value: ASC * @param {String} opts.beginUpdatedAt If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format * @param {String} opts.endUpdatedAt If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format. * @param {String} opts.beginCreatedAt If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format. @@ -435,8 +442,8 @@ module.exports = function(apiClient) { /** - * Provides summary information for all events associated with a particular timecard. - * Provides summary information for all events associated with a particular timecard. + * ListTimecardEvents + * Provides summary information for all events associated with a particular timecard. <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside> * @param {String} timecardId The ID of the timecard to list events for. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ @@ -450,12 +457,13 @@ module.exports = function(apiClient) { var pathParams = { - 'timecard_id': timecardId }; var queryParams = { + 'timecard_id': timecardId }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -473,8 +481,8 @@ module.exports = function(apiClient) { } /** - * Provides summary information for all events associated with a particular timecard. - * Provides summary information for all events associated with a particular timecard. + * ListTimecardEvents + * Provides summary information for all events associated with a particular timecard. <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside> * @param {String} timecardId The ID of the timecard to list events for. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ @@ -487,7 +495,7 @@ module.exports = function(apiClient) { /** - * Provides summary information for all of a business's employee timecards. + * ListTimecards * Provides summary information for all of a business's employee timecards. * @param {Object} opts Optional parameters * @param {module:model/String} opts.order The order in which timecards are listed in the response, based on their created_at field. @@ -525,6 +533,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -542,7 +551,7 @@ module.exports = function(apiClient) { } /** - * Provides summary information for all of a business's employee timecards. + * ListTimecards * Provides summary information for all of a business's employee timecards. * @param {Object} opts Optional parameters * @param {module:model/String} opts.order The order in which timecards are listed in the response, based on their created_at field. @@ -567,7 +576,7 @@ module.exports = function(apiClient) { /** - * Provides the details for a single cash drawer shift, including all events that occurred during the shift. + * RetrieveCashDrawerShift * Provides the details for a single cash drawer shift, including all events that occurred during the shift. * @param {String} locationId The ID of the location to list cash drawer shifts for. * @param {String} shiftId The shift's ID. @@ -595,6 +604,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -612,7 +622,7 @@ module.exports = function(apiClient) { } /** - * Provides the details for a single cash drawer shift, including all events that occurred during the shift. + * RetrieveCashDrawerShift * Provides the details for a single cash drawer shift, including all events that occurred during the shift. * @param {String} locationId The ID of the location to list cash drawer shifts for. * @param {String} shiftId The shift's ID. @@ -627,7 +637,7 @@ module.exports = function(apiClient) { /** - * Provides the details for a single employee. + * RetrieveEmployee * Provides the details for a single employee. * @param {String} employeeId The employee's ID. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1Employee} and HTTP response @@ -648,6 +658,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -665,7 +676,7 @@ module.exports = function(apiClient) { } /** - * Provides the details for a single employee. + * RetrieveEmployee * Provides the details for a single employee. * @param {String} employeeId The employee's ID. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1Employee} @@ -679,7 +690,7 @@ module.exports = function(apiClient) { /** - * Provides the details for a single employee role. + * RetrieveEmployeeRole * Provides the details for a single employee role. * @param {String} roleId The role's ID. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1EmployeeRole} and HTTP response @@ -700,6 +711,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -717,7 +729,7 @@ module.exports = function(apiClient) { } /** - * Provides the details for a single employee role. + * RetrieveEmployeeRole * Provides the details for a single employee role. * @param {String} roleId The role's ID. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1EmployeeRole} @@ -731,8 +743,8 @@ module.exports = function(apiClient) { /** - * Provides the details for a single timecard. - * Provides the details for a single timecard. + * RetrieveTimecard + * Provides the details for a single timecard. <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside> * @param {String} timecardId The timecard's ID. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1Timecard} and HTTP response */ @@ -752,6 +764,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -769,8 +782,8 @@ module.exports = function(apiClient) { } /** - * Provides the details for a single timecard. - * Provides the details for a single timecard. + * RetrieveTimecard + * Provides the details for a single timecard. <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside> * @param {String} timecardId The timecard's ID. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1Timecard} */ @@ -783,7 +796,8 @@ module.exports = function(apiClient) { /** - * V1 UpdateEmployee + * UpdateEmployee + * * @param {String} employeeId The ID of the role to modify. * @param {module:model/V1Employee} 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/V1Employee} and HTTP response @@ -809,6 +823,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -826,7 +841,8 @@ module.exports = function(apiClient) { } /** - * V1 UpdateEmployee + * UpdateEmployee + * * @param {String} employeeId The ID of the role to modify. * @param {module:model/V1Employee} 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/V1Employee} @@ -840,7 +856,7 @@ module.exports = function(apiClient) { /** - * Modifies the details of an employee role. + * UpdateEmployeeRole * Modifies the details of an employee role. * @param {String} roleId The ID of the role to modify. * @param {module:model/V1EmployeeRole} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -867,6 +883,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -884,7 +901,7 @@ module.exports = function(apiClient) { } /** - * Modifies the details of an employee role. + * UpdateEmployeeRole * Modifies the details of an employee role. * @param {String} roleId The ID of the role to modify. * @param {module:model/V1EmployeeRole} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -899,10 +916,10 @@ module.exports = function(apiClient) { /** - * Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. - * Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. + * UpdateTimecard + * Modifies the details of a timecard with an `API_EDIT` event for the timecard. Updating an active timecard with a `clockout_time` clocks the employee out. * @param {String} timecardId TThe ID of the timecard to modify. - * @param {module:model/V1Timecard} body An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @param {module:model/V1Timecard} 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/V1Timecard} and HTTP response */ this.updateTimecardWithHttpInfo = function(timecardId, body) { @@ -926,6 +943,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -943,10 +961,10 @@ module.exports = function(apiClient) { } /** - * Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. - * Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint. + * UpdateTimecard + * Modifies the details of a timecard with an `API_EDIT` event for the timecard. Updating an active timecard with a `clockout_time` clocks the employee out. * @param {String} timecardId TThe ID of the timecard to modify. - * @param {module:model/V1Timecard} body An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @param {module:model/V1Timecard} 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/V1Timecard} */ this.updateTimecard = function(timecardId, body) { diff --git a/src/api/V1ItemsApi.js b/src/api/V1ItemsApi.js index ecb8059..e9a9443 100644 --- a/src/api/V1ItemsApi.js +++ b/src/api/V1ItemsApi.js @@ -43,7 +43,7 @@ module.exports = function(apiClient) { /** - * Adjusts an item variation's current available inventory. + * AdjustInventory * Adjusts an item variation's current available inventory. * @param {String} locationId The ID of the item's associated location. * @param {String} variationId The ID of the variation to adjust inventory information for. @@ -77,6 +77,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -94,7 +95,7 @@ module.exports = function(apiClient) { } /** - * Adjusts an item variation's current available inventory. + * AdjustInventory * Adjusts an item variation's current available inventory. * @param {String} locationId The ID of the item's associated location. * @param {String} variationId The ID of the variation to adjust inventory information for. @@ -110,7 +111,7 @@ module.exports = function(apiClient) { /** - * Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. + * ApplyFee * Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. * @param {String} locationId The ID of the fee's associated location. * @param {String} itemId The ID of the item to add the fee to. @@ -145,6 +146,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -162,7 +164,7 @@ module.exports = function(apiClient) { } /** - * Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. + * ApplyFee * Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register. * @param {String} locationId The ID of the fee's associated location. * @param {String} itemId The ID of the item to add the fee to. @@ -178,7 +180,7 @@ module.exports = function(apiClient) { /** - * Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. + * ApplyModifierList * Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. * @param {String} locationId The ID of the item's associated location. * @param {String} modifierListId The ID of the modifier list to apply. @@ -213,6 +215,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -230,7 +233,7 @@ module.exports = function(apiClient) { } /** - * Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. + * ApplyModifierList * Associates a modifier list with an item, meaning modifier options from the list can be applied to the item. * @param {String} locationId The ID of the item's associated location. * @param {String} modifierListId The ID of the modifier list to apply. @@ -246,7 +249,7 @@ module.exports = function(apiClient) { /** - * Creates an item category. + * CreateCategory * Creates an item category. * @param {String} locationId The ID of the location to create an item for. * @param {module:model/V1Category} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -273,6 +276,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -290,7 +294,7 @@ module.exports = function(apiClient) { } /** - * Creates an item category. + * CreateCategory * Creates an item category. * @param {String} locationId The ID of the location to create an item for. * @param {module:model/V1Category} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -305,7 +309,7 @@ module.exports = function(apiClient) { /** - * Creates a discount. + * CreateDiscount * Creates a discount. * @param {String} locationId The ID of the location to create an item for. * @param {module:model/V1Discount} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -332,6 +336,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -349,7 +354,7 @@ module.exports = function(apiClient) { } /** - * Creates a discount. + * CreateDiscount * Creates a discount. * @param {String} locationId The ID of the location to create an item for. * @param {module:model/V1Discount} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -364,7 +369,7 @@ module.exports = function(apiClient) { /** - * Creates a fee (tax). + * CreateFee * Creates a fee (tax). * @param {String} locationId The ID of the location to create a fee for. * @param {module:model/V1Fee} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -391,6 +396,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -408,7 +414,7 @@ module.exports = function(apiClient) { } /** - * Creates a fee (tax). + * CreateFee * Creates a fee (tax). * @param {String} locationId The ID of the location to create a fee for. * @param {module:model/V1Fee} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -423,8 +429,8 @@ module.exports = function(apiClient) { /** - * Creates an item and at least one variation for it. - * Creates an item and at least one variation for it. + * CreateItem + * Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify its `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. * @param {String} locationId The ID of the location to create an item for. * @param {module:model/V1Item} 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/V1Item} and HTTP response @@ -450,6 +456,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -467,8 +474,8 @@ module.exports = function(apiClient) { } /** - * Creates an item and at least one variation for it. - * Creates an item and at least one variation for it. + * CreateItem + * Creates an item and at least one variation for it. Item-related entities include fields you can use to associate them with entities in a non-Square system. When you create an item-related entity, you can optionally specify its `id`. This value must be unique among all IDs ever specified for the account, including those specified by other applications. You can never reuse an entity ID. If you do not specify an ID, Square generates one for the entity. Item variations have a `user_data` string that lets you associate arbitrary metadata with the variation. The string cannot exceed 255 characters. * @param {String} locationId The ID of the location to create an item for. * @param {module:model/V1Item} 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/V1Item} @@ -482,7 +489,7 @@ module.exports = function(apiClient) { /** - * Creates an item modifier list and at least one modifier option for it. + * CreateModifierList * Creates an item modifier list and at least one modifier option for it. * @param {String} locationId The ID of the location to create a modifier list for. * @param {module:model/V1ModifierList} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -509,6 +516,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -526,7 +534,7 @@ module.exports = function(apiClient) { } /** - * Creates an item modifier list and at least one modifier option for it. + * CreateModifierList * Creates an item modifier list and at least one modifier option for it. * @param {String} locationId The ID of the location to create a modifier list for. * @param {module:model/V1ModifierList} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -541,7 +549,7 @@ module.exports = function(apiClient) { /** - * Creates an item modifier option and adds it to a modifier list. + * CreateModifierOption * Creates an item modifier option and adds it to a modifier list. * @param {String} locationId The ID of the item's associated location. * @param {String} modifierListId The ID of the modifier list to edit. @@ -575,6 +583,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -592,7 +601,7 @@ module.exports = function(apiClient) { } /** - * Creates an item modifier option and adds it to a modifier list. + * CreateModifierOption * Creates an item modifier option and adds it to a modifier list. * @param {String} locationId The ID of the item's associated location. * @param {String} modifierListId The ID of the modifier list to edit. @@ -608,7 +617,7 @@ module.exports = function(apiClient) { /** - * Creates a Favorites page in Square Register. + * CreatePage * Creates a Favorites page in Square Register. * @param {String} locationId The ID of the location to create an item for. * @param {module:model/V1Page} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -635,6 +644,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -652,7 +662,7 @@ module.exports = function(apiClient) { } /** - * Creates a Favorites page in Square Register. + * CreatePage * Creates a Favorites page in Square Register. * @param {String} locationId The ID of the location to create an item for. * @param {module:model/V1Page} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -667,7 +677,7 @@ module.exports = function(apiClient) { /** - * Creates an item variation for an existing item. + * CreateVariation * Creates an item variation for an existing item. * @param {String} locationId The ID of the item's associated location. * @param {String} itemId The item's ID. @@ -701,6 +711,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -718,7 +729,7 @@ module.exports = function(apiClient) { } /** - * Creates an item variation for an existing item. + * CreateVariation * Creates an item variation for an existing item. * @param {String} locationId The ID of the item's associated location. * @param {String} itemId The item's ID. @@ -734,8 +745,8 @@ module.exports = function(apiClient) { /** - * Deletes an existing item category. - * Deletes an existing item category. + * DeleteCategory + * Deletes an existing item category. *Note**: DeleteCategory returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. * @param {String} locationId The ID of the item's associated location. * @param {String} categoryId The ID of the category to delete. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1Category} and HTTP response @@ -762,6 +773,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -779,8 +791,8 @@ module.exports = function(apiClient) { } /** - * Deletes an existing item category. - * Deletes an existing item category. + * DeleteCategory + * Deletes an existing item category. *Note**: DeleteCategory returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. * @param {String} locationId The ID of the item's associated location. * @param {String} categoryId The ID of the category to delete. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1Category} @@ -794,8 +806,8 @@ module.exports = function(apiClient) { /** - * Deletes an existing discount. - * Deletes an existing discount. + * DeleteDiscount + * Deletes an existing discount. *Note**: DeleteDiscount returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. * @param {String} locationId The ID of the item's associated location. * @param {String} discountId The ID of the discount to delete. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1Discount} and HTTP response @@ -822,6 +834,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -839,8 +852,8 @@ module.exports = function(apiClient) { } /** - * Deletes an existing discount. - * Deletes an existing discount. + * DeleteDiscount + * Deletes an existing discount. *Note**: DeleteDiscount returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. * @param {String} locationId The ID of the item's associated location. * @param {String} discountId The ID of the discount to delete. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1Discount} @@ -854,8 +867,8 @@ module.exports = function(apiClient) { /** - * Deletes an existing fee (tax). - * Deletes an existing fee (tax). + * DeleteFee + * Deletes an existing fee (tax). *Note**: DeleteFee returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. * @param {String} locationId The ID of the fee's associated location. * @param {String} feeId The ID of the fee to delete. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1Fee} and HTTP response @@ -882,6 +895,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -899,8 +913,8 @@ module.exports = function(apiClient) { } /** - * Deletes an existing fee (tax). - * Deletes an existing fee (tax). + * DeleteFee + * Deletes an existing fee (tax). *Note**: DeleteFee returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. * @param {String} locationId The ID of the fee's associated location. * @param {String} feeId The ID of the fee to delete. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1Fee} @@ -914,8 +928,8 @@ module.exports = function(apiClient) { /** - * Deletes an existing item and all item variations associated with it. - * Deletes an existing item and all item variations associated with it. + * DeleteItem + * Deletes an existing item and all item variations associated with it. *Note**: DeleteItem returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. * @param {String} locationId The ID of the item's associated location. * @param {String} itemId The ID of the item to modify. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1Item} and HTTP response @@ -942,6 +956,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -959,8 +974,8 @@ module.exports = function(apiClient) { } /** - * Deletes an existing item and all item variations associated with it. - * Deletes an existing item and all item variations associated with it. + * DeleteItem + * Deletes an existing item and all item variations associated with it. *Note**: DeleteItem returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. * @param {String} locationId The ID of the item's associated location. * @param {String} itemId The ID of the item to modify. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1Item} @@ -974,8 +989,8 @@ module.exports = function(apiClient) { /** - * Deletes an existing item modifier list and all modifier options associated with it. - * Deletes an existing item modifier list and all modifier options associated with it. + * DeleteModifierList + * Deletes an existing item modifier list and all modifier options associated with it. *Note**: DeleteModifierList returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. * @param {String} locationId The ID of the item's associated location. * @param {String} modifierListId The ID of the modifier list to delete. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1ModifierList} and HTTP response @@ -1002,6 +1017,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1019,8 +1035,8 @@ module.exports = function(apiClient) { } /** - * Deletes an existing item modifier list and all modifier options associated with it. - * Deletes an existing item modifier list and all modifier options associated with it. + * DeleteModifierList + * Deletes an existing item modifier list and all modifier options associated with it. *Note**: DeleteModifierList returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. * @param {String} locationId The ID of the item's associated location. * @param {String} modifierListId The ID of the modifier list to delete. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1ModifierList} @@ -1034,8 +1050,8 @@ module.exports = function(apiClient) { /** - * Deletes an existing item modifier option from a modifier list. - * Deletes an existing item modifier option from a modifier list. + * DeleteModifierOption + * Deletes an existing item modifier option from a modifier list. *Note**: DeleteModifierOption returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object as documented below. * @param {String} locationId The ID of the item's associated location. * @param {String} modifierListId The ID of the modifier list to delete. * @param {String} modifierOptionId The ID of the modifier list to edit. @@ -1069,6 +1085,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1086,8 +1103,8 @@ module.exports = function(apiClient) { } /** - * Deletes an existing item modifier option from a modifier list. - * Deletes an existing item modifier option from a modifier list. + * DeleteModifierOption + * Deletes an existing item modifier option from a modifier list. *Note**: DeleteModifierOption returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object as documented below. * @param {String} locationId The ID of the item's associated location. * @param {String} modifierListId The ID of the modifier list to delete. * @param {String} modifierOptionId The ID of the modifier list to edit. @@ -1102,8 +1119,8 @@ module.exports = function(apiClient) { /** - * Deletes an existing Favorites page and all of its cells. - * Deletes an existing Favorites page and all of its cells. + * DeletePage + * Deletes an existing Favorites page and all of its cells. *Note**: DeletePage returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object as documented below. * @param {String} locationId The ID of the Favorites page's associated location. * @param {String} pageId The ID of the page to delete. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1Page} and HTTP response @@ -1130,6 +1147,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1147,8 +1165,8 @@ module.exports = function(apiClient) { } /** - * Deletes an existing Favorites page and all of its cells. - * Deletes an existing Favorites page and all of its cells. + * DeletePage + * Deletes an existing Favorites page and all of its cells. *Note**: DeletePage returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object as documented below. * @param {String} locationId The ID of the Favorites page's associated location. * @param {String} pageId The ID of the page to delete. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1Page} @@ -1162,8 +1180,8 @@ module.exports = function(apiClient) { /** - * Deletes a cell from a Favorites page in Square Register. - * Deletes a cell from a Favorites page in Square Register. + * DeletePageCell + * Deletes a cell from a Favorites page in Square Register. *Note**: DeletePageCell returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. * @param {String} locationId The ID of the Favorites page's associated location. * @param {String} pageId The ID of the page to delete. * @param {Object} opts Optional parameters @@ -1196,6 +1214,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1213,8 +1232,8 @@ module.exports = function(apiClient) { } /** - * Deletes a cell from a Favorites page in Square Register. - * Deletes a cell from a Favorites page in Square Register. + * DeletePageCell + * Deletes a cell from a Favorites page in Square Register. *Note**: DeletePageCell returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. * @param {String} locationId The ID of the Favorites page's associated location. * @param {String} pageId The ID of the page to delete. * @param {Object} opts Optional parameters @@ -1231,8 +1250,8 @@ module.exports = function(apiClient) { /** - * Deletes an existing item variation from an item. - * Deletes an existing item variation from an item. + * DeleteVariation + * Deletes an existing item variation from an item. *Note**: DeleteVariation returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. * @param {String} locationId The ID of the item's associated location. * @param {String} itemId The ID of the item to delete. * @param {String} variationId The ID of the variation to delete. @@ -1266,6 +1285,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1283,8 +1303,8 @@ module.exports = function(apiClient) { } /** - * Deletes an existing item variation from an item. - * Deletes an existing item variation from an item. + * DeleteVariation + * Deletes an existing item variation from an item. *Note**: DeleteVariation returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. * @param {String} locationId The ID of the item's associated location. * @param {String} itemId The ID of the item to delete. * @param {String} variationId The ID of the variation to delete. @@ -1299,7 +1319,7 @@ module.exports = function(apiClient) { /** - * Lists all of a location's item categories. + * ListCategories * Lists all of a location's item categories. * @param {String} locationId The ID of the location to list categories for. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response @@ -1320,6 +1340,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1337,7 +1358,7 @@ module.exports = function(apiClient) { } /** - * Lists all of a location's item categories. + * ListCategories * Lists all of a location's item categories. * @param {String} locationId The ID of the location to list categories for. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} @@ -1351,7 +1372,7 @@ module.exports = function(apiClient) { /** - * Lists all of a location's discounts. + * ListDiscounts * Lists all of a location's discounts. * @param {String} locationId The ID of the location to list categories for. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response @@ -1372,6 +1393,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1389,7 +1411,7 @@ module.exports = function(apiClient) { } /** - * Lists all of a location's discounts. + * ListDiscounts * Lists all of a location's discounts. * @param {String} locationId The ID of the location to list categories for. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} @@ -1403,7 +1425,7 @@ module.exports = function(apiClient) { /** - * Lists all of a location's fees (taxes). + * ListFees * Lists all of a location's fees (taxes). * @param {String} locationId The ID of the location to list fees for. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response @@ -1424,6 +1446,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1441,7 +1464,7 @@ module.exports = function(apiClient) { } /** - * Lists all of a location's fees (taxes). + * ListFees * Lists all of a location's fees (taxes). * @param {String} locationId The ID of the location to list fees for. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} @@ -1455,7 +1478,7 @@ module.exports = function(apiClient) { /** - * Provides inventory information for all of a merchant's inventory-enabled item variations. + * ListInventory * Provides inventory information for all of a merchant's inventory-enabled item variations. * @param {String} locationId The ID of the item's associated location. * @param {Object} opts Optional parameters @@ -1482,6 +1505,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1499,7 +1523,7 @@ module.exports = function(apiClient) { } /** - * Provides inventory information for all of a merchant's inventory-enabled item variations. + * ListInventory * Provides inventory information for all of a merchant's inventory-enabled item variations. * @param {String} locationId The ID of the item's associated location. * @param {Object} opts Optional parameters @@ -1516,7 +1540,7 @@ module.exports = function(apiClient) { /** - * Provides summary information for all of a location's items. + * ListItems * Provides summary information for all of a location's items. * @param {String} locationId The ID of the location to list items for. * @param {Object} opts Optional parameters @@ -1541,6 +1565,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1558,7 +1583,7 @@ module.exports = function(apiClient) { } /** - * Provides summary information for all of a location's items. + * ListItems * Provides summary information for all of a location's items. * @param {String} locationId The ID of the location to list items for. * @param {Object} opts Optional parameters @@ -1574,7 +1599,7 @@ module.exports = function(apiClient) { /** - * Lists all of a location's modifier lists. + * ListModifierLists * Lists all of a location's modifier lists. * @param {String} locationId The ID of the location to list modifier lists for. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response @@ -1595,6 +1620,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1612,7 +1638,7 @@ module.exports = function(apiClient) { } /** - * Lists all of a location's modifier lists. + * ListModifierLists * Lists all of a location's modifier lists. * @param {String} locationId The ID of the location to list modifier lists for. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} @@ -1626,7 +1652,7 @@ module.exports = function(apiClient) { /** - * Lists all of a location's Favorites pages in Square Register. + * ListPages * Lists all of a location's Favorites pages in Square Register. * @param {String} locationId The ID of the location to list Favorites pages for. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response @@ -1647,6 +1673,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1664,7 +1691,7 @@ module.exports = function(apiClient) { } /** - * Lists all of a location's Favorites pages in Square Register. + * ListPages * Lists all of a location's Favorites pages in Square Register. * @param {String} locationId The ID of the location to list Favorites pages for. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} @@ -1678,7 +1705,7 @@ module.exports = function(apiClient) { /** - * Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. + * RemoveFee * Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. * @param {String} locationId The ID of the fee's associated location. * @param {String} itemId The ID of the item to add the fee to. @@ -1713,6 +1740,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1730,7 +1758,7 @@ module.exports = function(apiClient) { } /** - * Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. + * RemoveFee * Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register. * @param {String} locationId The ID of the fee's associated location. * @param {String} itemId The ID of the item to add the fee to. @@ -1746,7 +1774,7 @@ module.exports = function(apiClient) { /** - * Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. + * RemoveModifierList * Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. * @param {String} locationId The ID of the item's associated location. * @param {String} modifierListId The ID of the modifier list to remove. @@ -1781,6 +1809,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1798,7 +1827,7 @@ module.exports = function(apiClient) { } /** - * Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. + * RemoveModifierList * Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item. * @param {String} locationId The ID of the item's associated location. * @param {String} modifierListId The ID of the modifier list to remove. @@ -1814,7 +1843,7 @@ module.exports = function(apiClient) { /** - * Provides the details for a single item, including associated modifier lists and fees. + * RetrieveItem * Provides the details for a single item, including associated modifier lists and fees. * @param {String} locationId The ID of the item's associated location. * @param {String} itemId The item's ID. @@ -1842,6 +1871,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1859,7 +1889,7 @@ module.exports = function(apiClient) { } /** - * Provides the details for a single item, including associated modifier lists and fees. + * RetrieveItem * Provides the details for a single item, including associated modifier lists and fees. * @param {String} locationId The ID of the item's associated location. * @param {String} itemId The item's ID. @@ -1874,7 +1904,7 @@ module.exports = function(apiClient) { /** - * Provides the details for a single modifier list. + * RetrieveModifierList * Provides the details for a single modifier list. * @param {String} locationId The ID of the item's associated location. * @param {String} modifierListId The modifier list's ID. @@ -1902,6 +1932,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1919,7 +1950,7 @@ module.exports = function(apiClient) { } /** - * Provides the details for a single modifier list. + * RetrieveModifierList * Provides the details for a single modifier list. * @param {String} locationId The ID of the item's associated location. * @param {String} modifierListId The modifier list's ID. @@ -1934,7 +1965,7 @@ module.exports = function(apiClient) { /** - * Modifies the details of an existing item category. + * UpdateCategory * Modifies the details of an existing item category. * @param {String} locationId The ID of the category's associated location. * @param {String} categoryId The ID of the category to edit. @@ -1968,6 +1999,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -1985,7 +2017,7 @@ module.exports = function(apiClient) { } /** - * Modifies the details of an existing item category. + * UpdateCategory * Modifies the details of an existing item category. * @param {String} locationId The ID of the category's associated location. * @param {String} categoryId The ID of the category to edit. @@ -2001,7 +2033,7 @@ module.exports = function(apiClient) { /** - * Modifies the details of an existing discount. + * UpdateDiscount * Modifies the details of an existing discount. * @param {String} locationId The ID of the category's associated location. * @param {String} discountId The ID of the discount to edit. @@ -2035,6 +2067,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -2052,7 +2085,7 @@ module.exports = function(apiClient) { } /** - * Modifies the details of an existing discount. + * UpdateDiscount * Modifies the details of an existing discount. * @param {String} locationId The ID of the category's associated location. * @param {String} discountId The ID of the discount to edit. @@ -2068,7 +2101,7 @@ module.exports = function(apiClient) { /** - * Modifies the details of an existing fee (tax). + * UpdateFee * Modifies the details of an existing fee (tax). * @param {String} locationId The ID of the fee's associated location. * @param {String} feeId The ID of the fee to edit. @@ -2102,6 +2135,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -2119,7 +2153,7 @@ module.exports = function(apiClient) { } /** - * Modifies the details of an existing fee (tax). + * UpdateFee * Modifies the details of an existing fee (tax). * @param {String} locationId The ID of the fee's associated location. * @param {String} feeId The ID of the fee to edit. @@ -2135,7 +2169,7 @@ module.exports = function(apiClient) { /** - * Modifies the core details of an existing item. + * UpdateItem * Modifies the core details of an existing item. * @param {String} locationId The ID of the item's associated location. * @param {String} itemId The ID of the item to modify. @@ -2169,6 +2203,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -2186,7 +2221,7 @@ module.exports = function(apiClient) { } /** - * Modifies the core details of an existing item. + * UpdateItem * Modifies the core details of an existing item. * @param {String} locationId The ID of the item's associated location. * @param {String} itemId The ID of the item to modify. @@ -2202,7 +2237,7 @@ module.exports = function(apiClient) { /** - * Modifies the details of an existing item modifier list. + * UpdateModifierList * Modifies the details of an existing item modifier list. * @param {String} locationId The ID of the item's associated location. * @param {String} modifierListId The ID of the modifier list to edit. @@ -2236,6 +2271,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -2253,7 +2289,7 @@ module.exports = function(apiClient) { } /** - * Modifies the details of an existing item modifier list. + * UpdateModifierList * Modifies the details of an existing item modifier list. * @param {String} locationId The ID of the item's associated location. * @param {String} modifierListId The ID of the modifier list to edit. @@ -2269,7 +2305,7 @@ module.exports = function(apiClient) { /** - * Modifies the details of an existing item modifier option. + * UpdateModifierOption * Modifies the details of an existing item modifier option. * @param {String} locationId The ID of the item's associated location. * @param {String} modifierListId The ID of the modifier list to edit. @@ -2310,6 +2346,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -2327,7 +2364,7 @@ module.exports = function(apiClient) { } /** - * Modifies the details of an existing item modifier option. + * UpdateModifierOption * Modifies the details of an existing item modifier option. * @param {String} locationId The ID of the item's associated location. * @param {String} modifierListId The ID of the modifier list to edit. @@ -2344,7 +2381,7 @@ module.exports = function(apiClient) { /** - * Modifies the details of a Favorites page in Square Register. + * UpdatePage * Modifies the details of a Favorites page in Square Register. * @param {String} locationId The ID of the Favorites page's associated location * @param {String} pageId The ID of the page to modify. @@ -2378,6 +2415,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -2395,7 +2433,7 @@ module.exports = function(apiClient) { } /** - * Modifies the details of a Favorites page in Square Register. + * UpdatePage * Modifies the details of a Favorites page in Square Register. * @param {String} locationId The ID of the Favorites page's associated location * @param {String} pageId The ID of the page to modify. @@ -2411,7 +2449,7 @@ module.exports = function(apiClient) { /** - * Modifies a cell of a Favorites page in Square Register. + * UpdatePageCell * Modifies a cell of a Favorites page in Square Register. * @param {String} locationId The ID of the Favorites page's associated location. * @param {String} pageId The ID of the page the cell belongs to. @@ -2445,6 +2483,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -2462,7 +2501,7 @@ module.exports = function(apiClient) { } /** - * Modifies a cell of a Favorites page in Square Register. + * UpdatePageCell * Modifies a cell of a Favorites page in Square Register. * @param {String} locationId The ID of the Favorites page's associated location. * @param {String} pageId The ID of the page the cell belongs to. @@ -2478,7 +2517,7 @@ module.exports = function(apiClient) { /** - * Modifies the details of an existing item variation. + * UpdateVariation * Modifies the details of an existing item variation. * @param {String} locationId The ID of the item's associated location. * @param {String} itemId The ID of the item to modify. @@ -2519,6 +2558,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -2536,7 +2576,7 @@ module.exports = function(apiClient) { } /** - * Modifies the details of an existing item variation. + * UpdateVariation * Modifies the details of an existing item variation. * @param {String} locationId The ID of the item's associated location. * @param {String} itemId The ID of the item to modify. diff --git a/src/api/V1LocationsApi.js b/src/api/V1LocationsApi.js index 6d1e84c..fbcdac1 100644 --- a/src/api/V1LocationsApi.js +++ b/src/api/V1LocationsApi.js @@ -32,7 +32,7 @@ module.exports = function(apiClient) { /** - * Provides details for a business's locations, including their IDs. + * ListLocations * Provides details for a business's locations, including their IDs. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ @@ -46,6 +46,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -63,7 +64,7 @@ module.exports = function(apiClient) { } /** - * Provides details for a business's locations, including their IDs. + * ListLocations * Provides details for a business's locations, including their IDs. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ @@ -76,7 +77,7 @@ module.exports = function(apiClient) { /** - * Get a business's information. + * RetrieveBusiness * Get a business's information. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1Merchant} and HTTP response */ @@ -90,6 +91,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -107,7 +109,7 @@ module.exports = function(apiClient) { } /** - * Get a business's information. + * RetrieveBusiness * Get a business's information. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1Merchant} */ diff --git a/src/api/V1TransactionsApi.js b/src/api/V1TransactionsApi.js index 7fac9d2..2f0592e 100644 --- a/src/api/V1TransactionsApi.js +++ b/src/api/V1TransactionsApi.js @@ -38,8 +38,8 @@ module.exports = function(apiClient) { /** - * Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. - * Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. + * CreateRefund + * Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. You cannot issue a partial refund for a split tender payment. You must instead issue a full or partial refund for a particular tender, by providing the applicable tender id to the V1CreateRefund endpoint. Issuing a full refund for a split tender payment refunds all tenders associated with the payment. Issuing a refund for a card payment is not reversible. For development purposes, you can create fake cash payments in Square Point of Sale and refund them. * @param {String} locationId The ID of the original payment's associated location. * @param {module:model/V1CreateRefundRequest} 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/V1Refund} and HTTP response @@ -65,6 +65,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -82,8 +83,8 @@ module.exports = function(apiClient) { } /** - * Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. - * Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. + * CreateRefund + * Issues a refund for a previously processed payment. You must issue a refund within 60 days of the associated payment. You cannot issue a partial refund for a split tender payment. You must instead issue a full or partial refund for a particular tender, by providing the applicable tender id to the V1CreateRefund endpoint. Issuing a full refund for a split tender payment refunds all tenders associated with the payment. Issuing a refund for a card payment is not reversible. For development purposes, you can create fake cash payments in Square Point of Sale and refund them. * @param {String} locationId The ID of the original payment's associated location. * @param {module:model/V1CreateRefundRequest} 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/V1Refund} @@ -97,7 +98,7 @@ module.exports = function(apiClient) { /** - * Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. + * ListBankAccounts * Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. * @param {String} locationId The ID of the location to list bank accounts for. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response @@ -118,6 +119,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -135,7 +137,7 @@ module.exports = function(apiClient) { } /** - * Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. + * ListBankAccounts * Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. * @param {String} locationId The ID of the location to list bank accounts for. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} @@ -149,7 +151,7 @@ module.exports = function(apiClient) { /** - * Provides summary information for a merchant's online store orders. + * ListOrders * Provides summary information for a merchant's online store orders. * @param {String} locationId The ID of the location to list online store orders for. * @param {Object} opts Optional parameters @@ -178,6 +180,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -195,7 +198,7 @@ module.exports = function(apiClient) { } /** - * Provides summary information for a merchant's online store orders. + * ListOrders * Provides summary information for a merchant's online store orders. * @param {String} locationId The ID of the location to list online store orders for. * @param {Object} opts Optional parameters @@ -213,8 +216,8 @@ module.exports = function(apiClient) { /** - * Provides summary information for all payments taken by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. See Date ranges for details of inclusive and exclusive dates. - * Provides summary information for all payments taken by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. See Date ranges for details of inclusive and exclusive dates. + * ListPayments + * Provides summary information for all payments taken for a given Square account during a date range. Date ranges cannot exceed 1 year in length. See Date ranges for details of inclusive and exclusive dates. *Note**: Details for payments processed with Square Point of Sale while in offline mode may not be transmitted to Square for up to 72 hours. Offline payments have a `created_at` value that reflects the time the payment was originally processed, not the time it was subsequently transmitted to Square. Consequently, the ListPayments endpoint might list an offline payment chronologically between online payments that were seen in a previous request. * @param {String} locationId The ID of the location to list payments for. If you specify me, this endpoint returns payments aggregated from all of the business's locations. * @param {Object} opts Optional parameters * @param {module:model/String} opts.order The order in which payments are listed in the response. @@ -248,6 +251,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -265,8 +269,8 @@ module.exports = function(apiClient) { } /** - * Provides summary information for all payments taken by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. See Date ranges for details of inclusive and exclusive dates. - * Provides summary information for all payments taken by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. See Date ranges for details of inclusive and exclusive dates. + * ListPayments + * Provides summary information for all payments taken for a given Square account during a date range. Date ranges cannot exceed 1 year in length. See Date ranges for details of inclusive and exclusive dates. *Note**: Details for payments processed with Square Point of Sale while in offline mode may not be transmitted to Square for up to 72 hours. Offline payments have a `created_at` value that reflects the time the payment was originally processed, not the time it was subsequently transmitted to Square. Consequently, the ListPayments endpoint might list an offline payment chronologically between online payments that were seen in a previous request. * @param {String} locationId The ID of the location to list payments for. If you specify me, this endpoint returns payments aggregated from all of the business's locations. * @param {Object} opts Optional parameters * @param {module:model/String} opts.order The order in which payments are listed in the response. @@ -286,7 +290,7 @@ module.exports = function(apiClient) { /** - * Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. + * ListRefunds * Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. * @param {String} locationId The ID of the location to list refunds for. * @param {Object} opts Optional parameters @@ -319,6 +323,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -336,7 +341,7 @@ module.exports = function(apiClient) { } /** - * Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. + * ListRefunds * Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range. Date ranges cannot exceed one year in length. * @param {String} locationId The ID of the location to list refunds for. * @param {Object} opts Optional parameters @@ -356,8 +361,8 @@ module.exports = function(apiClient) { /** - * Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length. - * Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length. + * ListSettlements + * Provides summary information for all deposits and withdrawals initiated by Square to a linked bank account during a date range. Date ranges cannot exceed one year in length. *Note**: the ListSettlements endpoint does not provide entry information. * @param {String} locationId The ID of the location to list settlements for. If you specify me, this endpoint returns payments aggregated from all of the business's locations. * @param {Object} opts Optional parameters * @param {module:model/String} opts.order TThe order in which payments are listed in the response. @@ -391,6 +396,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -408,8 +414,8 @@ module.exports = function(apiClient) { } /** - * Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length. - * Provides summary information for all deposits and withdrawals initiated by Square to a merchant's bank account during a date range. Date ranges cannot exceed one year in length. + * ListSettlements + * Provides summary information for all deposits and withdrawals initiated by Square to a linked bank account during a date range. Date ranges cannot exceed one year in length. *Note**: the ListSettlements endpoint does not provide entry information. * @param {String} locationId The ID of the location to list settlements for. If you specify me, this endpoint returns payments aggregated from all of the business's locations. * @param {Object} opts Optional parameters * @param {module:model/String} opts.order TThe order in which payments are listed in the response. @@ -429,7 +435,7 @@ module.exports = function(apiClient) { /** - * Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. + * RetrieveBankAccount * Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. * @param {String} locationId The ID of the bank account's associated location. * @param {String} bankAccountId The bank account's Square-issued ID. You obtain this value from Settlement objects returned. @@ -457,6 +463,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -474,7 +481,7 @@ module.exports = function(apiClient) { } /** - * Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. + * RetrieveBankAccount * Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API. * @param {String} locationId The ID of the bank account's associated location. * @param {String} bankAccountId The bank account's Square-issued ID. You obtain this value from Settlement objects returned. @@ -489,7 +496,7 @@ module.exports = function(apiClient) { /** - * Provides comprehensive information for a single online store order, including the order's history. + * RetrieveOrder * Provides comprehensive information for a single online store order, including the order's history. * @param {String} locationId The ID of the order's associated location. * @param {String} orderId The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint @@ -517,6 +524,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -534,7 +542,7 @@ module.exports = function(apiClient) { } /** - * Provides comprehensive information for a single online store order, including the order's history. + * RetrieveOrder * Provides comprehensive information for a single online store order, including the order's history. * @param {String} locationId The ID of the order's associated location. * @param {String} orderId The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint @@ -549,7 +557,7 @@ module.exports = function(apiClient) { /** - * Provides comprehensive information for a single payment. + * RetrievePayment * Provides comprehensive information for a single payment. * @param {String} locationId The ID of the payment's associated location. * @param {String} paymentId The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint. @@ -577,6 +585,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -594,7 +603,7 @@ module.exports = function(apiClient) { } /** - * Provides comprehensive information for a single payment. + * RetrievePayment * Provides comprehensive information for a single payment. * @param {String} locationId The ID of the payment's associated location. * @param {String} paymentId The Square-issued payment ID. payment_id comes from Payment objects returned by the List Payments endpoint, Settlement objects returned by the List Settlements endpoint, or Refund objects returned by the List Refunds endpoint. @@ -609,8 +618,8 @@ module.exports = function(apiClient) { /** - * Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total. - * Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total. + * RetrieveSettlement + * Provides comprehensive information for a single settlement. The returned `Settlement` objects include an `entries` field that lists the transactions that contribute to the settlement total. Most settlement entries correspond to a payment payout, but settlement entries are also generated for less common events, like refunds, manual adjustments, or chargeback holds. Square initiates its regular deposits as indicated in the [Deposit Options with Square](https://squareup.com/help/us/en/article/3807) help article. Details for a regular deposit are usually not available from Connect API endpoints before 10 p.m. PST the same day. Square does not know when an initiated settlement **completes**, only whether it has failed. A completed settlement is typically reflected in a bank account within 3 business days, but in exceptional cases it may take longer. * @param {String} locationId The ID of the settlements's associated location. * @param {String} settlementId The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1Settlement} and HTTP response @@ -637,6 +646,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -654,8 +664,8 @@ module.exports = function(apiClient) { } /** - * Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total. - * Provides comprehensive information for a single settlement, including the entries that contribute to the settlement's total. + * RetrieveSettlement + * Provides comprehensive information for a single settlement. The returned `Settlement` objects include an `entries` field that lists the transactions that contribute to the settlement total. Most settlement entries correspond to a payment payout, but settlement entries are also generated for less common events, like refunds, manual adjustments, or chargeback holds. Square initiates its regular deposits as indicated in the [Deposit Options with Square](https://squareup.com/help/us/en/article/3807) help article. Details for a regular deposit are usually not available from Connect API endpoints before 10 p.m. PST the same day. Square does not know when an initiated settlement **completes**, only whether it has failed. A completed settlement is typically reflected in a bank account within 3 business days, but in exceptional cases it may take longer. * @param {String} locationId The ID of the settlements's associated location. * @param {String} settlementId The settlement's Square-issued ID. You obtain this value from Settlement objects returned by the List Settlements endpoint. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1Settlement} @@ -669,7 +679,7 @@ module.exports = function(apiClient) { /** - * Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions: + * UpdateOrder * Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions: * @param {String} locationId The ID of the order's associated location. * @param {String} orderId The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint @@ -703,6 +713,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; + headerParams['Square-Version'] = '2019-03-13'; var formParams = { }; @@ -720,7 +731,7 @@ module.exports = function(apiClient) { } /** - * Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions: + * UpdateOrder * Updates the details of an online store order. Every update you perform on an order corresponds to one of three actions: * @param {String} locationId The ID of the order's associated location. * @param {String} orderId The order's Square-issued ID. You obtain this value from Order objects returned by the List Orders endpoint diff --git a/src/index.js b/src/index.js index a2aad11..067f6a1 100644 --- a/src/index.js +++ b/src/index.js @@ -31,6 +31,7 @@ var BatchRetrieveOrdersRequest = require('./model/BatchRetrieveOrdersRequest'); var BatchRetrieveOrdersResponse = require('./model/BatchRetrieveOrdersResponse'); var BatchUpsertCatalogObjectsRequest = require('./model/BatchUpsertCatalogObjectsRequest'); var BatchUpsertCatalogObjectsResponse = require('./model/BatchUpsertCatalogObjectsResponse'); +var BreakType = require('./model/BreakType'); var CaptureTransactionRequest = require('./model/CaptureTransactionRequest'); var CaptureTransactionResponse = require('./model/CaptureTransactionResponse'); var Card = require('./model/Card'); @@ -69,6 +70,8 @@ var ChargeRequestAdditionalRecipient = require('./model/ChargeRequestAdditionalR var ChargeResponse = require('./model/ChargeResponse'); var Checkout = require('./model/Checkout'); var Country = require('./model/Country'); +var CreateBreakTypeRequest = require('./model/CreateBreakTypeRequest'); +var CreateBreakTypeResponse = require('./model/CreateBreakTypeResponse'); var CreateCheckoutRequest = require('./model/CreateCheckoutRequest'); var CreateCheckoutResponse = require('./model/CreateCheckoutResponse'); var CreateCustomerCardRequest = require('./model/CreateCustomerCardRequest'); @@ -85,6 +88,8 @@ var CreateOrderRequestTax = require('./model/CreateOrderRequestTax'); var CreateOrderResponse = require('./model/CreateOrderResponse'); var CreateRefundRequest = require('./model/CreateRefundRequest'); var CreateRefundResponse = require('./model/CreateRefundResponse'); +var CreateShiftRequest = require('./model/CreateShiftRequest'); +var CreateShiftResponse = require('./model/CreateShiftResponse'); var Currency = require('./model/Currency'); var Customer = require('./model/Customer'); var CustomerCreationSource = require('./model/CustomerCreationSource'); @@ -96,16 +101,30 @@ var CustomerPreferences = require('./model/CustomerPreferences'); var CustomerQuery = require('./model/CustomerQuery'); var CustomerSort = require('./model/CustomerSort'); var CustomerSortField = require('./model/CustomerSortField'); +var DateRange = require('./model/DateRange'); +var DeleteBreakTypeRequest = require('./model/DeleteBreakTypeRequest'); +var DeleteBreakTypeResponse = require('./model/DeleteBreakTypeResponse'); var DeleteCatalogObjectRequest = require('./model/DeleteCatalogObjectRequest'); var DeleteCatalogObjectResponse = require('./model/DeleteCatalogObjectResponse'); var DeleteCustomerCardRequest = require('./model/DeleteCustomerCardRequest'); var DeleteCustomerCardResponse = require('./model/DeleteCustomerCardResponse'); var DeleteCustomerRequest = require('./model/DeleteCustomerRequest'); var DeleteCustomerResponse = require('./model/DeleteCustomerResponse'); +var DeleteShiftRequest = require('./model/DeleteShiftRequest'); +var DeleteShiftResponse = require('./model/DeleteShiftResponse'); var Device = require('./model/Device'); +var Employee = require('./model/Employee'); +var EmployeeStatus = require('./model/EmployeeStatus'); +var EmployeeWage = require('./model/EmployeeWage'); var Error = require('./model/Error'); var ErrorCategory = require('./model/ErrorCategory'); var ErrorCode = require('./model/ErrorCode'); +var GetBreakTypeRequest = require('./model/GetBreakTypeRequest'); +var GetBreakTypeResponse = require('./model/GetBreakTypeResponse'); +var GetEmployeeWageRequest = require('./model/GetEmployeeWageRequest'); +var GetEmployeeWageResponse = require('./model/GetEmployeeWageResponse'); +var GetShiftRequest = require('./model/GetShiftRequest'); +var GetShiftResponse = require('./model/GetShiftResponse'); var InventoryAdjustment = require('./model/InventoryAdjustment'); var InventoryAlertType = require('./model/InventoryAlertType'); var InventoryChange = require('./model/InventoryChange'); @@ -119,20 +138,29 @@ var ListAdditionalRecipientReceivableRefundsRequest = require('./model/ListAddit var ListAdditionalRecipientReceivableRefundsResponse = require('./model/ListAdditionalRecipientReceivableRefundsResponse'); var ListAdditionalRecipientReceivablesRequest = require('./model/ListAdditionalRecipientReceivablesRequest'); var ListAdditionalRecipientReceivablesResponse = require('./model/ListAdditionalRecipientReceivablesResponse'); +var ListBreakTypesRequest = require('./model/ListBreakTypesRequest'); +var ListBreakTypesResponse = require('./model/ListBreakTypesResponse'); var ListCatalogRequest = require('./model/ListCatalogRequest'); var ListCatalogResponse = require('./model/ListCatalogResponse'); var ListCustomersRequest = require('./model/ListCustomersRequest'); var ListCustomersResponse = require('./model/ListCustomersResponse'); +var ListEmployeeWagesRequest = require('./model/ListEmployeeWagesRequest'); +var ListEmployeeWagesResponse = require('./model/ListEmployeeWagesResponse'); +var ListEmployeesRequest = require('./model/ListEmployeesRequest'); +var ListEmployeesResponse = require('./model/ListEmployeesResponse'); var ListLocationsRequest = require('./model/ListLocationsRequest'); var ListLocationsResponse = require('./model/ListLocationsResponse'); var ListRefundsRequest = require('./model/ListRefundsRequest'); var ListRefundsResponse = require('./model/ListRefundsResponse'); var ListTransactionsRequest = require('./model/ListTransactionsRequest'); var ListTransactionsResponse = require('./model/ListTransactionsResponse'); +var ListWorkweekConfigsRequest = require('./model/ListWorkweekConfigsRequest'); +var ListWorkweekConfigsResponse = require('./model/ListWorkweekConfigsResponse'); var Location = require('./model/Location'); var LocationCapability = require('./model/LocationCapability'); var LocationStatus = require('./model/LocationStatus'); var LocationType = require('./model/LocationType'); +var ModelBreak = require('./model/ModelBreak'); var Money = require('./model/Money'); var ObtainTokenRequest = require('./model/ObtainTokenRequest'); var ObtainTokenResponse = require('./model/ObtainTokenResponse'); @@ -163,6 +191,8 @@ var RetrieveCatalogObjectRequest = require('./model/RetrieveCatalogObjectRequest var RetrieveCatalogObjectResponse = require('./model/RetrieveCatalogObjectResponse'); var RetrieveCustomerRequest = require('./model/RetrieveCustomerRequest'); var RetrieveCustomerResponse = require('./model/RetrieveCustomerResponse'); +var RetrieveEmployeeRequest = require('./model/RetrieveEmployeeRequest'); +var RetrieveEmployeeResponse = require('./model/RetrieveEmployeeResponse'); var RetrieveInventoryAdjustmentRequest = require('./model/RetrieveInventoryAdjustmentRequest'); var RetrieveInventoryAdjustmentResponse = require('./model/RetrieveInventoryAdjustmentResponse'); var RetrieveInventoryChangesRequest = require('./model/RetrieveInventoryChangesRequest'); @@ -179,6 +209,18 @@ var SearchCatalogObjectsRequest = require('./model/SearchCatalogObjectsRequest') var SearchCatalogObjectsResponse = require('./model/SearchCatalogObjectsResponse'); var SearchCustomersRequest = require('./model/SearchCustomersRequest'); var SearchCustomersResponse = require('./model/SearchCustomersResponse'); +var SearchShiftsRequest = require('./model/SearchShiftsRequest'); +var SearchShiftsResponse = require('./model/SearchShiftsResponse'); +var Shift = require('./model/Shift'); +var ShiftFilter = require('./model/ShiftFilter'); +var ShiftFilterStatus = require('./model/ShiftFilterStatus'); +var ShiftQuery = require('./model/ShiftQuery'); +var ShiftSort = require('./model/ShiftSort'); +var ShiftSortField = require('./model/ShiftSortField'); +var ShiftStatus = require('./model/ShiftStatus'); +var ShiftWage = require('./model/ShiftWage'); +var ShiftWorkday = require('./model/ShiftWorkday'); +var ShiftWorkdayMatcher = require('./model/ShiftWorkdayMatcher'); var SortOrder = require('./model/SortOrder'); var SourceApplication = require('./model/SourceApplication'); var TaxCalculationPhase = require('./model/TaxCalculationPhase'); @@ -192,61 +234,191 @@ var TenderType = require('./model/TenderType'); var TimeRange = require('./model/TimeRange'); var Transaction = require('./model/Transaction'); var TransactionProduct = require('./model/TransactionProduct'); +var UpdateBreakTypeRequest = require('./model/UpdateBreakTypeRequest'); +var UpdateBreakTypeResponse = require('./model/UpdateBreakTypeResponse'); var UpdateCustomerRequest = require('./model/UpdateCustomerRequest'); var UpdateCustomerResponse = require('./model/UpdateCustomerResponse'); var UpdateItemModifierListsRequest = require('./model/UpdateItemModifierListsRequest'); var UpdateItemModifierListsResponse = require('./model/UpdateItemModifierListsResponse'); var UpdateItemTaxesRequest = require('./model/UpdateItemTaxesRequest'); var UpdateItemTaxesResponse = require('./model/UpdateItemTaxesResponse'); +var UpdateShiftRequest = require('./model/UpdateShiftRequest'); +var UpdateShiftResponse = require('./model/UpdateShiftResponse'); +var UpdateWorkweekConfigRequest = require('./model/UpdateWorkweekConfigRequest'); +var UpdateWorkweekConfigResponse = require('./model/UpdateWorkweekConfigResponse'); var UpsertCatalogObjectRequest = require('./model/UpsertCatalogObjectRequest'); var UpsertCatalogObjectResponse = require('./model/UpsertCatalogObjectResponse'); var V1AdjustInventoryRequest = require('./model/V1AdjustInventoryRequest'); +var V1AdjustInventoryRequestAdjustmentType = require('./model/V1AdjustInventoryRequestAdjustmentType'); +var V1ApplyFeeRequest = require('./model/V1ApplyFeeRequest'); +var V1ApplyModifierListRequest = require('./model/V1ApplyModifierListRequest'); var V1BankAccount = require('./model/V1BankAccount'); +var V1BankAccountType = require('./model/V1BankAccountType'); var V1CashDrawerEvent = require('./model/V1CashDrawerEvent'); +var V1CashDrawerEventEventType = require('./model/V1CashDrawerEventEventType'); var V1CashDrawerShift = require('./model/V1CashDrawerShift'); +var V1CashDrawerShiftEventType = require('./model/V1CashDrawerShiftEventType'); var V1Category = require('./model/V1Category'); +var V1CreateCategoryRequest = require('./model/V1CreateCategoryRequest'); +var V1CreateDiscountRequest = require('./model/V1CreateDiscountRequest'); +var V1CreateEmployeeRoleRequest = require('./model/V1CreateEmployeeRoleRequest'); +var V1CreateFeeRequest = require('./model/V1CreateFeeRequest'); +var V1CreateItemRequest = require('./model/V1CreateItemRequest'); +var V1CreateModifierListRequest = require('./model/V1CreateModifierListRequest'); +var V1CreateModifierOptionRequest = require('./model/V1CreateModifierOptionRequest'); +var V1CreatePageRequest = require('./model/V1CreatePageRequest'); var V1CreateRefundRequest = require('./model/V1CreateRefundRequest'); +var V1CreateRefundRequestType = require('./model/V1CreateRefundRequestType'); +var V1CreateVariationRequest = require('./model/V1CreateVariationRequest'); +var V1DeleteCategoryRequest = require('./model/V1DeleteCategoryRequest'); +var V1DeleteDiscountRequest = require('./model/V1DeleteDiscountRequest'); +var V1DeleteFeeRequest = require('./model/V1DeleteFeeRequest'); +var V1DeleteItemRequest = require('./model/V1DeleteItemRequest'); +var V1DeleteModifierListRequest = require('./model/V1DeleteModifierListRequest'); +var V1DeleteModifierOptionRequest = require('./model/V1DeleteModifierOptionRequest'); +var V1DeletePageCellRequest = require('./model/V1DeletePageCellRequest'); +var V1DeletePageRequest = require('./model/V1DeletePageRequest'); +var V1DeleteTimecardRequest = require('./model/V1DeleteTimecardRequest'); +var V1DeleteTimecardResponse = require('./model/V1DeleteTimecardResponse'); +var V1DeleteVariationRequest = require('./model/V1DeleteVariationRequest'); var V1Discount = require('./model/V1Discount'); +var V1DiscountColor = require('./model/V1DiscountColor'); +var V1DiscountDiscountType = require('./model/V1DiscountDiscountType'); var V1Employee = require('./model/V1Employee'); var V1EmployeeRole = require('./model/V1EmployeeRole'); +var V1EmployeeRolePermissions = require('./model/V1EmployeeRolePermissions'); +var V1EmployeeStatus = require('./model/V1EmployeeStatus'); var V1Fee = require('./model/V1Fee'); +var V1FeeAdjustmentType = require('./model/V1FeeAdjustmentType'); +var V1FeeCalculationPhase = require('./model/V1FeeCalculationPhase'); +var V1FeeInclusionType = require('./model/V1FeeInclusionType'); +var V1FeeType = require('./model/V1FeeType'); var V1InventoryEntry = require('./model/V1InventoryEntry'); var V1Item = require('./model/V1Item'); +var V1ItemColor = require('./model/V1ItemColor'); var V1ItemImage = require('./model/V1ItemImage'); +var V1ItemType = require('./model/V1ItemType'); +var V1ItemVisibility = require('./model/V1ItemVisibility'); +var V1ListBankAccountsRequest = require('./model/V1ListBankAccountsRequest'); +var V1ListBankAccountsResponse = require('./model/V1ListBankAccountsResponse'); +var V1ListCashDrawerShiftsRequest = require('./model/V1ListCashDrawerShiftsRequest'); +var V1ListCashDrawerShiftsResponse = require('./model/V1ListCashDrawerShiftsResponse'); +var V1ListCategoriesRequest = require('./model/V1ListCategoriesRequest'); +var V1ListCategoriesResponse = require('./model/V1ListCategoriesResponse'); +var V1ListDiscountsRequest = require('./model/V1ListDiscountsRequest'); +var V1ListDiscountsResponse = require('./model/V1ListDiscountsResponse'); +var V1ListEmployeeRolesRequest = require('./model/V1ListEmployeeRolesRequest'); +var V1ListEmployeeRolesResponse = require('./model/V1ListEmployeeRolesResponse'); +var V1ListEmployeesRequest = require('./model/V1ListEmployeesRequest'); +var V1ListEmployeesRequestStatus = require('./model/V1ListEmployeesRequestStatus'); +var V1ListEmployeesResponse = require('./model/V1ListEmployeesResponse'); +var V1ListFeesRequest = require('./model/V1ListFeesRequest'); +var V1ListFeesResponse = require('./model/V1ListFeesResponse'); +var V1ListInventoryRequest = require('./model/V1ListInventoryRequest'); +var V1ListInventoryResponse = require('./model/V1ListInventoryResponse'); +var V1ListItemsRequest = require('./model/V1ListItemsRequest'); +var V1ListItemsResponse = require('./model/V1ListItemsResponse'); +var V1ListLocationsRequest = require('./model/V1ListLocationsRequest'); +var V1ListLocationsResponse = require('./model/V1ListLocationsResponse'); +var V1ListModifierListsRequest = require('./model/V1ListModifierListsRequest'); +var V1ListModifierListsResponse = require('./model/V1ListModifierListsResponse'); +var V1ListOrdersRequest = require('./model/V1ListOrdersRequest'); +var V1ListOrdersResponse = require('./model/V1ListOrdersResponse'); +var V1ListPagesRequest = require('./model/V1ListPagesRequest'); +var V1ListPagesResponse = require('./model/V1ListPagesResponse'); +var V1ListPaymentsRequest = require('./model/V1ListPaymentsRequest'); +var V1ListPaymentsResponse = require('./model/V1ListPaymentsResponse'); +var V1ListRefundsRequest = require('./model/V1ListRefundsRequest'); +var V1ListRefundsResponse = require('./model/V1ListRefundsResponse'); +var V1ListSettlementsRequest = require('./model/V1ListSettlementsRequest'); +var V1ListSettlementsRequestStatus = require('./model/V1ListSettlementsRequestStatus'); +var V1ListSettlementsResponse = require('./model/V1ListSettlementsResponse'); +var V1ListTimecardEventsRequest = require('./model/V1ListTimecardEventsRequest'); +var V1ListTimecardEventsResponse = require('./model/V1ListTimecardEventsResponse'); +var V1ListTimecardsRequest = require('./model/V1ListTimecardsRequest'); +var V1ListTimecardsResponse = require('./model/V1ListTimecardsResponse'); var V1Merchant = require('./model/V1Merchant'); +var V1MerchantAccountType = require('./model/V1MerchantAccountType'); +var V1MerchantBusinessType = require('./model/V1MerchantBusinessType'); var V1MerchantLocationDetails = require('./model/V1MerchantLocationDetails'); var V1ModifierList = require('./model/V1ModifierList'); +var V1ModifierListSelectionType = require('./model/V1ModifierListSelectionType'); var V1ModifierOption = require('./model/V1ModifierOption'); var V1Money = require('./model/V1Money'); var V1Order = require('./model/V1Order'); var V1OrderHistoryEntry = require('./model/V1OrderHistoryEntry'); +var V1OrderHistoryEntryAction = require('./model/V1OrderHistoryEntryAction'); +var V1OrderState = require('./model/V1OrderState'); var V1Page = require('./model/V1Page'); var V1PageCell = require('./model/V1PageCell'); +var V1PageCellObjectType = require('./model/V1PageCellObjectType'); +var V1PageCellPlaceholderType = require('./model/V1PageCellPlaceholderType'); var V1Payment = require('./model/V1Payment'); var V1PaymentDiscount = require('./model/V1PaymentDiscount'); var V1PaymentItemDetail = require('./model/V1PaymentItemDetail'); var V1PaymentItemization = require('./model/V1PaymentItemization'); +var V1PaymentItemizationItemizationType = require('./model/V1PaymentItemizationItemizationType'); var V1PaymentModifier = require('./model/V1PaymentModifier'); var V1PaymentSurcharge = require('./model/V1PaymentSurcharge'); +var V1PaymentSurchargeType = require('./model/V1PaymentSurchargeType'); var V1PaymentTax = require('./model/V1PaymentTax'); +var V1PaymentTaxInclusionType = require('./model/V1PaymentTaxInclusionType'); var V1PhoneNumber = require('./model/V1PhoneNumber'); var V1Refund = require('./model/V1Refund'); +var V1RefundType = require('./model/V1RefundType'); +var V1RemoveFeeRequest = require('./model/V1RemoveFeeRequest'); +var V1RemoveModifierListRequest = require('./model/V1RemoveModifierListRequest'); +var V1RetrieveBankAccountRequest = require('./model/V1RetrieveBankAccountRequest'); +var V1RetrieveBusinessRequest = require('./model/V1RetrieveBusinessRequest'); +var V1RetrieveCashDrawerShiftRequest = require('./model/V1RetrieveCashDrawerShiftRequest'); +var V1RetrieveEmployeeRequest = require('./model/V1RetrieveEmployeeRequest'); +var V1RetrieveEmployeeRoleRequest = require('./model/V1RetrieveEmployeeRoleRequest'); +var V1RetrieveItemRequest = require('./model/V1RetrieveItemRequest'); +var V1RetrieveModifierListRequest = require('./model/V1RetrieveModifierListRequest'); +var V1RetrieveOrderRequest = require('./model/V1RetrieveOrderRequest'); +var V1RetrievePaymentRequest = require('./model/V1RetrievePaymentRequest'); +var V1RetrieveSettlementRequest = require('./model/V1RetrieveSettlementRequest'); +var V1RetrieveTimecardRequest = require('./model/V1RetrieveTimecardRequest'); var V1Settlement = require('./model/V1Settlement'); var V1SettlementEntry = require('./model/V1SettlementEntry'); +var V1SettlementEntryType = require('./model/V1SettlementEntryType'); +var V1SettlementStatus = require('./model/V1SettlementStatus'); var V1Tender = require('./model/V1Tender'); +var V1TenderEntryMethod = require('./model/V1TenderEntryMethod'); +var V1TenderType = require('./model/V1TenderType'); var V1Timecard = require('./model/V1Timecard'); var V1TimecardEvent = require('./model/V1TimecardEvent'); +var V1TimecardEventEventType = require('./model/V1TimecardEventEventType'); +var V1UpdateCategoryRequest = require('./model/V1UpdateCategoryRequest'); +var V1UpdateDiscountRequest = require('./model/V1UpdateDiscountRequest'); +var V1UpdateEmployeeRequest = require('./model/V1UpdateEmployeeRequest'); +var V1UpdateEmployeeRoleRequest = require('./model/V1UpdateEmployeeRoleRequest'); +var V1UpdateFeeRequest = require('./model/V1UpdateFeeRequest'); +var V1UpdateItemRequest = require('./model/V1UpdateItemRequest'); var V1UpdateModifierListRequest = require('./model/V1UpdateModifierListRequest'); +var V1UpdateModifierListRequestSelectionType = require('./model/V1UpdateModifierListRequestSelectionType'); +var V1UpdateModifierOptionRequest = require('./model/V1UpdateModifierOptionRequest'); var V1UpdateOrderRequest = require('./model/V1UpdateOrderRequest'); +var V1UpdateOrderRequestAction = require('./model/V1UpdateOrderRequestAction'); +var V1UpdatePageCellRequest = require('./model/V1UpdatePageCellRequest'); +var V1UpdatePageRequest = require('./model/V1UpdatePageRequest'); +var V1UpdateTimecardRequest = require('./model/V1UpdateTimecardRequest'); +var V1UpdateVariationRequest = require('./model/V1UpdateVariationRequest'); var V1Variation = require('./model/V1Variation'); +var V1VariationInventoryAlertType = require('./model/V1VariationInventoryAlertType'); +var V1VariationPricingType = require('./model/V1VariationPricingType'); var VoidTransactionRequest = require('./model/VoidTransactionRequest'); var VoidTransactionResponse = require('./model/VoidTransactionResponse'); +var Weekday = require('./model/Weekday'); +var WorkweekConfig = require('./model/WorkweekConfig'); var ApplePayApi = require('./api/ApplePayApi'); var CatalogApi = require('./api/CatalogApi'); var CheckoutApi = require('./api/CheckoutApi'); var CustomersApi = require('./api/CustomersApi'); +var EmployeesApi = require('./api/EmployeesApi'); var InventoryApi = require('./api/InventoryApi'); +var LaborApi = require('./api/LaborApi'); var LocationsApi = require('./api/LocationsApi'); var MobileAuthorizationApi = require('./api/MobileAuthorizationApi'); var OAuthApi = require('./api/OAuthApi'); @@ -288,7 +460,7 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * *

* @module index - * @version 2.20190213.0 + * @version 2.20190313.0 */ module.exports = { /** @@ -386,6 +558,11 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/BatchUpsertCatalogObjectsResponse} */ BatchUpsertCatalogObjectsResponse: BatchUpsertCatalogObjectsResponse, + /** + * The BreakType model constructor. + * @property {module:model/BreakType} + */ + BreakType: BreakType, /** * The CaptureTransactionRequest model constructor. * @property {module:model/CaptureTransactionRequest} @@ -576,6 +753,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/Country} */ Country: Country, + /** + * The CreateBreakTypeRequest model constructor. + * @property {module:model/CreateBreakTypeRequest} + */ + CreateBreakTypeRequest: CreateBreakTypeRequest, + /** + * The CreateBreakTypeResponse model constructor. + * @property {module:model/CreateBreakTypeResponse} + */ + CreateBreakTypeResponse: CreateBreakTypeResponse, /** * The CreateCheckoutRequest model constructor. * @property {module:model/CreateCheckoutRequest} @@ -656,6 +843,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/CreateRefundResponse} */ CreateRefundResponse: CreateRefundResponse, + /** + * The CreateShiftRequest model constructor. + * @property {module:model/CreateShiftRequest} + */ + CreateShiftRequest: CreateShiftRequest, + /** + * The CreateShiftResponse model constructor. + * @property {module:model/CreateShiftResponse} + */ + CreateShiftResponse: CreateShiftResponse, /** * The Currency model constructor. * @property {module:model/Currency} @@ -711,6 +908,21 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/CustomerSortField} */ CustomerSortField: CustomerSortField, + /** + * The DateRange model constructor. + * @property {module:model/DateRange} + */ + DateRange: DateRange, + /** + * The DeleteBreakTypeRequest model constructor. + * @property {module:model/DeleteBreakTypeRequest} + */ + DeleteBreakTypeRequest: DeleteBreakTypeRequest, + /** + * The DeleteBreakTypeResponse model constructor. + * @property {module:model/DeleteBreakTypeResponse} + */ + DeleteBreakTypeResponse: DeleteBreakTypeResponse, /** * The DeleteCatalogObjectRequest model constructor. * @property {module:model/DeleteCatalogObjectRequest} @@ -741,11 +953,36 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/DeleteCustomerResponse} */ DeleteCustomerResponse: DeleteCustomerResponse, + /** + * The DeleteShiftRequest model constructor. + * @property {module:model/DeleteShiftRequest} + */ + DeleteShiftRequest: DeleteShiftRequest, + /** + * The DeleteShiftResponse model constructor. + * @property {module:model/DeleteShiftResponse} + */ + DeleteShiftResponse: DeleteShiftResponse, /** * The Device model constructor. * @property {module:model/Device} */ Device: Device, + /** + * The Employee model constructor. + * @property {module:model/Employee} + */ + Employee: Employee, + /** + * The EmployeeStatus model constructor. + * @property {module:model/EmployeeStatus} + */ + EmployeeStatus: EmployeeStatus, + /** + * The EmployeeWage model constructor. + * @property {module:model/EmployeeWage} + */ + EmployeeWage: EmployeeWage, /** * The Error model constructor. * @property {module:model/Error} @@ -761,6 +998,36 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/ErrorCode} */ ErrorCode: ErrorCode, + /** + * The GetBreakTypeRequest model constructor. + * @property {module:model/GetBreakTypeRequest} + */ + GetBreakTypeRequest: GetBreakTypeRequest, + /** + * The GetBreakTypeResponse model constructor. + * @property {module:model/GetBreakTypeResponse} + */ + GetBreakTypeResponse: GetBreakTypeResponse, + /** + * The GetEmployeeWageRequest model constructor. + * @property {module:model/GetEmployeeWageRequest} + */ + GetEmployeeWageRequest: GetEmployeeWageRequest, + /** + * The GetEmployeeWageResponse model constructor. + * @property {module:model/GetEmployeeWageResponse} + */ + GetEmployeeWageResponse: GetEmployeeWageResponse, + /** + * The GetShiftRequest model constructor. + * @property {module:model/GetShiftRequest} + */ + GetShiftRequest: GetShiftRequest, + /** + * The GetShiftResponse model constructor. + * @property {module:model/GetShiftResponse} + */ + GetShiftResponse: GetShiftResponse, /** * The InventoryAdjustment model constructor. * @property {module:model/InventoryAdjustment} @@ -826,6 +1093,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/ListAdditionalRecipientReceivablesResponse} */ ListAdditionalRecipientReceivablesResponse: ListAdditionalRecipientReceivablesResponse, + /** + * The ListBreakTypesRequest model constructor. + * @property {module:model/ListBreakTypesRequest} + */ + ListBreakTypesRequest: ListBreakTypesRequest, + /** + * The ListBreakTypesResponse model constructor. + * @property {module:model/ListBreakTypesResponse} + */ + ListBreakTypesResponse: ListBreakTypesResponse, /** * The ListCatalogRequest model constructor. * @property {module:model/ListCatalogRequest} @@ -846,6 +1123,26 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/ListCustomersResponse} */ ListCustomersResponse: ListCustomersResponse, + /** + * The ListEmployeeWagesRequest model constructor. + * @property {module:model/ListEmployeeWagesRequest} + */ + ListEmployeeWagesRequest: ListEmployeeWagesRequest, + /** + * The ListEmployeeWagesResponse model constructor. + * @property {module:model/ListEmployeeWagesResponse} + */ + ListEmployeeWagesResponse: ListEmployeeWagesResponse, + /** + * The ListEmployeesRequest model constructor. + * @property {module:model/ListEmployeesRequest} + */ + ListEmployeesRequest: ListEmployeesRequest, + /** + * The ListEmployeesResponse model constructor. + * @property {module:model/ListEmployeesResponse} + */ + ListEmployeesResponse: ListEmployeesResponse, /** * The ListLocationsRequest model constructor. * @property {module:model/ListLocationsRequest} @@ -876,6 +1173,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/ListTransactionsResponse} */ ListTransactionsResponse: ListTransactionsResponse, + /** + * The ListWorkweekConfigsRequest model constructor. + * @property {module:model/ListWorkweekConfigsRequest} + */ + ListWorkweekConfigsRequest: ListWorkweekConfigsRequest, + /** + * The ListWorkweekConfigsResponse model constructor. + * @property {module:model/ListWorkweekConfigsResponse} + */ + ListWorkweekConfigsResponse: ListWorkweekConfigsResponse, /** * The Location model constructor. * @property {module:model/Location} @@ -896,6 +1203,11 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/LocationType} */ LocationType: LocationType, + /** + * The ModelBreak model constructor. + * @property {module:model/ModelBreak} + */ + ModelBreak: ModelBreak, /** * The Money model constructor. * @property {module:model/Money} @@ -1046,6 +1358,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/RetrieveCustomerResponse} */ RetrieveCustomerResponse: RetrieveCustomerResponse, + /** + * The RetrieveEmployeeRequest model constructor. + * @property {module:model/RetrieveEmployeeRequest} + */ + RetrieveEmployeeRequest: RetrieveEmployeeRequest, + /** + * The RetrieveEmployeeResponse model constructor. + * @property {module:model/RetrieveEmployeeResponse} + */ + RetrieveEmployeeResponse: RetrieveEmployeeResponse, /** * The RetrieveInventoryAdjustmentRequest model constructor. * @property {module:model/RetrieveInventoryAdjustmentRequest} @@ -1126,6 +1448,66 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/SearchCustomersResponse} */ SearchCustomersResponse: SearchCustomersResponse, + /** + * The SearchShiftsRequest model constructor. + * @property {module:model/SearchShiftsRequest} + */ + SearchShiftsRequest: SearchShiftsRequest, + /** + * The SearchShiftsResponse model constructor. + * @property {module:model/SearchShiftsResponse} + */ + SearchShiftsResponse: SearchShiftsResponse, + /** + * The Shift model constructor. + * @property {module:model/Shift} + */ + Shift: Shift, + /** + * The ShiftFilter model constructor. + * @property {module:model/ShiftFilter} + */ + ShiftFilter: ShiftFilter, + /** + * The ShiftFilterStatus model constructor. + * @property {module:model/ShiftFilterStatus} + */ + ShiftFilterStatus: ShiftFilterStatus, + /** + * The ShiftQuery model constructor. + * @property {module:model/ShiftQuery} + */ + ShiftQuery: ShiftQuery, + /** + * The ShiftSort model constructor. + * @property {module:model/ShiftSort} + */ + ShiftSort: ShiftSort, + /** + * The ShiftSortField model constructor. + * @property {module:model/ShiftSortField} + */ + ShiftSortField: ShiftSortField, + /** + * The ShiftStatus model constructor. + * @property {module:model/ShiftStatus} + */ + ShiftStatus: ShiftStatus, + /** + * The ShiftWage model constructor. + * @property {module:model/ShiftWage} + */ + ShiftWage: ShiftWage, + /** + * The ShiftWorkday model constructor. + * @property {module:model/ShiftWorkday} + */ + ShiftWorkday: ShiftWorkday, + /** + * The ShiftWorkdayMatcher model constructor. + * @property {module:model/ShiftWorkdayMatcher} + */ + ShiftWorkdayMatcher: ShiftWorkdayMatcher, /** * The SortOrder model constructor. * @property {module:model/SortOrder} @@ -1191,6 +1573,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/TransactionProduct} */ TransactionProduct: TransactionProduct, + /** + * The UpdateBreakTypeRequest model constructor. + * @property {module:model/UpdateBreakTypeRequest} + */ + UpdateBreakTypeRequest: UpdateBreakTypeRequest, + /** + * The UpdateBreakTypeResponse model constructor. + * @property {module:model/UpdateBreakTypeResponse} + */ + UpdateBreakTypeResponse: UpdateBreakTypeResponse, /** * The UpdateCustomerRequest model constructor. * @property {module:model/UpdateCustomerRequest} @@ -1221,6 +1613,26 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/UpdateItemTaxesResponse} */ UpdateItemTaxesResponse: UpdateItemTaxesResponse, + /** + * The UpdateShiftRequest model constructor. + * @property {module:model/UpdateShiftRequest} + */ + UpdateShiftRequest: UpdateShiftRequest, + /** + * The UpdateShiftResponse model constructor. + * @property {module:model/UpdateShiftResponse} + */ + UpdateShiftResponse: UpdateShiftResponse, + /** + * The UpdateWorkweekConfigRequest model constructor. + * @property {module:model/UpdateWorkweekConfigRequest} + */ + UpdateWorkweekConfigRequest: UpdateWorkweekConfigRequest, + /** + * The UpdateWorkweekConfigResponse model constructor. + * @property {module:model/UpdateWorkweekConfigResponse} + */ + UpdateWorkweekConfigResponse: UpdateWorkweekConfigResponse, /** * The UpsertCatalogObjectRequest model constructor. * @property {module:model/UpsertCatalogObjectRequest} @@ -1236,36 +1648,181 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/V1AdjustInventoryRequest} */ V1AdjustInventoryRequest: V1AdjustInventoryRequest, + /** + * The V1AdjustInventoryRequestAdjustmentType model constructor. + * @property {module:model/V1AdjustInventoryRequestAdjustmentType} + */ + V1AdjustInventoryRequestAdjustmentType: V1AdjustInventoryRequestAdjustmentType, + /** + * The V1ApplyFeeRequest model constructor. + * @property {module:model/V1ApplyFeeRequest} + */ + V1ApplyFeeRequest: V1ApplyFeeRequest, + /** + * The V1ApplyModifierListRequest model constructor. + * @property {module:model/V1ApplyModifierListRequest} + */ + V1ApplyModifierListRequest: V1ApplyModifierListRequest, /** * The V1BankAccount model constructor. * @property {module:model/V1BankAccount} */ V1BankAccount: V1BankAccount, + /** + * The V1BankAccountType model constructor. + * @property {module:model/V1BankAccountType} + */ + V1BankAccountType: V1BankAccountType, /** * The V1CashDrawerEvent model constructor. * @property {module:model/V1CashDrawerEvent} */ V1CashDrawerEvent: V1CashDrawerEvent, + /** + * The V1CashDrawerEventEventType model constructor. + * @property {module:model/V1CashDrawerEventEventType} + */ + V1CashDrawerEventEventType: V1CashDrawerEventEventType, /** * The V1CashDrawerShift model constructor. * @property {module:model/V1CashDrawerShift} */ V1CashDrawerShift: V1CashDrawerShift, + /** + * The V1CashDrawerShiftEventType model constructor. + * @property {module:model/V1CashDrawerShiftEventType} + */ + V1CashDrawerShiftEventType: V1CashDrawerShiftEventType, /** * The V1Category model constructor. * @property {module:model/V1Category} */ V1Category: V1Category, + /** + * The V1CreateCategoryRequest model constructor. + * @property {module:model/V1CreateCategoryRequest} + */ + V1CreateCategoryRequest: V1CreateCategoryRequest, + /** + * The V1CreateDiscountRequest model constructor. + * @property {module:model/V1CreateDiscountRequest} + */ + V1CreateDiscountRequest: V1CreateDiscountRequest, + /** + * The V1CreateEmployeeRoleRequest model constructor. + * @property {module:model/V1CreateEmployeeRoleRequest} + */ + V1CreateEmployeeRoleRequest: V1CreateEmployeeRoleRequest, + /** + * The V1CreateFeeRequest model constructor. + * @property {module:model/V1CreateFeeRequest} + */ + V1CreateFeeRequest: V1CreateFeeRequest, + /** + * The V1CreateItemRequest model constructor. + * @property {module:model/V1CreateItemRequest} + */ + V1CreateItemRequest: V1CreateItemRequest, + /** + * The V1CreateModifierListRequest model constructor. + * @property {module:model/V1CreateModifierListRequest} + */ + V1CreateModifierListRequest: V1CreateModifierListRequest, + /** + * The V1CreateModifierOptionRequest model constructor. + * @property {module:model/V1CreateModifierOptionRequest} + */ + V1CreateModifierOptionRequest: V1CreateModifierOptionRequest, + /** + * The V1CreatePageRequest model constructor. + * @property {module:model/V1CreatePageRequest} + */ + V1CreatePageRequest: V1CreatePageRequest, /** * The V1CreateRefundRequest model constructor. * @property {module:model/V1CreateRefundRequest} */ V1CreateRefundRequest: V1CreateRefundRequest, + /** + * The V1CreateRefundRequestType model constructor. + * @property {module:model/V1CreateRefundRequestType} + */ + V1CreateRefundRequestType: V1CreateRefundRequestType, + /** + * The V1CreateVariationRequest model constructor. + * @property {module:model/V1CreateVariationRequest} + */ + V1CreateVariationRequest: V1CreateVariationRequest, + /** + * The V1DeleteCategoryRequest model constructor. + * @property {module:model/V1DeleteCategoryRequest} + */ + V1DeleteCategoryRequest: V1DeleteCategoryRequest, + /** + * The V1DeleteDiscountRequest model constructor. + * @property {module:model/V1DeleteDiscountRequest} + */ + V1DeleteDiscountRequest: V1DeleteDiscountRequest, + /** + * The V1DeleteFeeRequest model constructor. + * @property {module:model/V1DeleteFeeRequest} + */ + V1DeleteFeeRequest: V1DeleteFeeRequest, + /** + * The V1DeleteItemRequest model constructor. + * @property {module:model/V1DeleteItemRequest} + */ + V1DeleteItemRequest: V1DeleteItemRequest, + /** + * The V1DeleteModifierListRequest model constructor. + * @property {module:model/V1DeleteModifierListRequest} + */ + V1DeleteModifierListRequest: V1DeleteModifierListRequest, + /** + * The V1DeleteModifierOptionRequest model constructor. + * @property {module:model/V1DeleteModifierOptionRequest} + */ + V1DeleteModifierOptionRequest: V1DeleteModifierOptionRequest, + /** + * The V1DeletePageCellRequest model constructor. + * @property {module:model/V1DeletePageCellRequest} + */ + V1DeletePageCellRequest: V1DeletePageCellRequest, + /** + * The V1DeletePageRequest model constructor. + * @property {module:model/V1DeletePageRequest} + */ + V1DeletePageRequest: V1DeletePageRequest, + /** + * The V1DeleteTimecardRequest model constructor. + * @property {module:model/V1DeleteTimecardRequest} + */ + V1DeleteTimecardRequest: V1DeleteTimecardRequest, + /** + * The V1DeleteTimecardResponse model constructor. + * @property {module:model/V1DeleteTimecardResponse} + */ + V1DeleteTimecardResponse: V1DeleteTimecardResponse, + /** + * The V1DeleteVariationRequest model constructor. + * @property {module:model/V1DeleteVariationRequest} + */ + V1DeleteVariationRequest: V1DeleteVariationRequest, /** * The V1Discount model constructor. * @property {module:model/V1Discount} */ V1Discount: V1Discount, + /** + * The V1DiscountColor model constructor. + * @property {module:model/V1DiscountColor} + */ + V1DiscountColor: V1DiscountColor, + /** + * The V1DiscountDiscountType model constructor. + * @property {module:model/V1DiscountDiscountType} + */ + V1DiscountDiscountType: V1DiscountDiscountType, /** * The V1Employee model constructor. * @property {module:model/V1Employee} @@ -1276,11 +1833,41 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/V1EmployeeRole} */ V1EmployeeRole: V1EmployeeRole, + /** + * The V1EmployeeRolePermissions model constructor. + * @property {module:model/V1EmployeeRolePermissions} + */ + V1EmployeeRolePermissions: V1EmployeeRolePermissions, + /** + * The V1EmployeeStatus model constructor. + * @property {module:model/V1EmployeeStatus} + */ + V1EmployeeStatus: V1EmployeeStatus, /** * The V1Fee model constructor. * @property {module:model/V1Fee} */ V1Fee: V1Fee, + /** + * The V1FeeAdjustmentType model constructor. + * @property {module:model/V1FeeAdjustmentType} + */ + V1FeeAdjustmentType: V1FeeAdjustmentType, + /** + * The V1FeeCalculationPhase model constructor. + * @property {module:model/V1FeeCalculationPhase} + */ + V1FeeCalculationPhase: V1FeeCalculationPhase, + /** + * The V1FeeInclusionType model constructor. + * @property {module:model/V1FeeInclusionType} + */ + V1FeeInclusionType: V1FeeInclusionType, + /** + * The V1FeeType model constructor. + * @property {module:model/V1FeeType} + */ + V1FeeType: V1FeeType, /** * The V1InventoryEntry model constructor. * @property {module:model/V1InventoryEntry} @@ -1291,16 +1878,231 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/V1Item} */ V1Item: V1Item, + /** + * The V1ItemColor model constructor. + * @property {module:model/V1ItemColor} + */ + V1ItemColor: V1ItemColor, /** * The V1ItemImage model constructor. * @property {module:model/V1ItemImage} */ V1ItemImage: V1ItemImage, + /** + * The V1ItemType model constructor. + * @property {module:model/V1ItemType} + */ + V1ItemType: V1ItemType, + /** + * The V1ItemVisibility model constructor. + * @property {module:model/V1ItemVisibility} + */ + V1ItemVisibility: V1ItemVisibility, + /** + * The V1ListBankAccountsRequest model constructor. + * @property {module:model/V1ListBankAccountsRequest} + */ + V1ListBankAccountsRequest: V1ListBankAccountsRequest, + /** + * The V1ListBankAccountsResponse model constructor. + * @property {module:model/V1ListBankAccountsResponse} + */ + V1ListBankAccountsResponse: V1ListBankAccountsResponse, + /** + * The V1ListCashDrawerShiftsRequest model constructor. + * @property {module:model/V1ListCashDrawerShiftsRequest} + */ + V1ListCashDrawerShiftsRequest: V1ListCashDrawerShiftsRequest, + /** + * The V1ListCashDrawerShiftsResponse model constructor. + * @property {module:model/V1ListCashDrawerShiftsResponse} + */ + V1ListCashDrawerShiftsResponse: V1ListCashDrawerShiftsResponse, + /** + * The V1ListCategoriesRequest model constructor. + * @property {module:model/V1ListCategoriesRequest} + */ + V1ListCategoriesRequest: V1ListCategoriesRequest, + /** + * The V1ListCategoriesResponse model constructor. + * @property {module:model/V1ListCategoriesResponse} + */ + V1ListCategoriesResponse: V1ListCategoriesResponse, + /** + * The V1ListDiscountsRequest model constructor. + * @property {module:model/V1ListDiscountsRequest} + */ + V1ListDiscountsRequest: V1ListDiscountsRequest, + /** + * The V1ListDiscountsResponse model constructor. + * @property {module:model/V1ListDiscountsResponse} + */ + V1ListDiscountsResponse: V1ListDiscountsResponse, + /** + * The V1ListEmployeeRolesRequest model constructor. + * @property {module:model/V1ListEmployeeRolesRequest} + */ + V1ListEmployeeRolesRequest: V1ListEmployeeRolesRequest, + /** + * The V1ListEmployeeRolesResponse model constructor. + * @property {module:model/V1ListEmployeeRolesResponse} + */ + V1ListEmployeeRolesResponse: V1ListEmployeeRolesResponse, + /** + * The V1ListEmployeesRequest model constructor. + * @property {module:model/V1ListEmployeesRequest} + */ + V1ListEmployeesRequest: V1ListEmployeesRequest, + /** + * The V1ListEmployeesRequestStatus model constructor. + * @property {module:model/V1ListEmployeesRequestStatus} + */ + V1ListEmployeesRequestStatus: V1ListEmployeesRequestStatus, + /** + * The V1ListEmployeesResponse model constructor. + * @property {module:model/V1ListEmployeesResponse} + */ + V1ListEmployeesResponse: V1ListEmployeesResponse, + /** + * The V1ListFeesRequest model constructor. + * @property {module:model/V1ListFeesRequest} + */ + V1ListFeesRequest: V1ListFeesRequest, + /** + * The V1ListFeesResponse model constructor. + * @property {module:model/V1ListFeesResponse} + */ + V1ListFeesResponse: V1ListFeesResponse, + /** + * The V1ListInventoryRequest model constructor. + * @property {module:model/V1ListInventoryRequest} + */ + V1ListInventoryRequest: V1ListInventoryRequest, + /** + * The V1ListInventoryResponse model constructor. + * @property {module:model/V1ListInventoryResponse} + */ + V1ListInventoryResponse: V1ListInventoryResponse, + /** + * The V1ListItemsRequest model constructor. + * @property {module:model/V1ListItemsRequest} + */ + V1ListItemsRequest: V1ListItemsRequest, + /** + * The V1ListItemsResponse model constructor. + * @property {module:model/V1ListItemsResponse} + */ + V1ListItemsResponse: V1ListItemsResponse, + /** + * The V1ListLocationsRequest model constructor. + * @property {module:model/V1ListLocationsRequest} + */ + V1ListLocationsRequest: V1ListLocationsRequest, + /** + * The V1ListLocationsResponse model constructor. + * @property {module:model/V1ListLocationsResponse} + */ + V1ListLocationsResponse: V1ListLocationsResponse, + /** + * The V1ListModifierListsRequest model constructor. + * @property {module:model/V1ListModifierListsRequest} + */ + V1ListModifierListsRequest: V1ListModifierListsRequest, + /** + * The V1ListModifierListsResponse model constructor. + * @property {module:model/V1ListModifierListsResponse} + */ + V1ListModifierListsResponse: V1ListModifierListsResponse, + /** + * The V1ListOrdersRequest model constructor. + * @property {module:model/V1ListOrdersRequest} + */ + V1ListOrdersRequest: V1ListOrdersRequest, + /** + * The V1ListOrdersResponse model constructor. + * @property {module:model/V1ListOrdersResponse} + */ + V1ListOrdersResponse: V1ListOrdersResponse, + /** + * The V1ListPagesRequest model constructor. + * @property {module:model/V1ListPagesRequest} + */ + V1ListPagesRequest: V1ListPagesRequest, + /** + * The V1ListPagesResponse model constructor. + * @property {module:model/V1ListPagesResponse} + */ + V1ListPagesResponse: V1ListPagesResponse, + /** + * The V1ListPaymentsRequest model constructor. + * @property {module:model/V1ListPaymentsRequest} + */ + V1ListPaymentsRequest: V1ListPaymentsRequest, + /** + * The V1ListPaymentsResponse model constructor. + * @property {module:model/V1ListPaymentsResponse} + */ + V1ListPaymentsResponse: V1ListPaymentsResponse, + /** + * The V1ListRefundsRequest model constructor. + * @property {module:model/V1ListRefundsRequest} + */ + V1ListRefundsRequest: V1ListRefundsRequest, + /** + * The V1ListRefundsResponse model constructor. + * @property {module:model/V1ListRefundsResponse} + */ + V1ListRefundsResponse: V1ListRefundsResponse, + /** + * The V1ListSettlementsRequest model constructor. + * @property {module:model/V1ListSettlementsRequest} + */ + V1ListSettlementsRequest: V1ListSettlementsRequest, + /** + * The V1ListSettlementsRequestStatus model constructor. + * @property {module:model/V1ListSettlementsRequestStatus} + */ + V1ListSettlementsRequestStatus: V1ListSettlementsRequestStatus, + /** + * The V1ListSettlementsResponse model constructor. + * @property {module:model/V1ListSettlementsResponse} + */ + V1ListSettlementsResponse: V1ListSettlementsResponse, + /** + * The V1ListTimecardEventsRequest model constructor. + * @property {module:model/V1ListTimecardEventsRequest} + */ + V1ListTimecardEventsRequest: V1ListTimecardEventsRequest, + /** + * The V1ListTimecardEventsResponse model constructor. + * @property {module:model/V1ListTimecardEventsResponse} + */ + V1ListTimecardEventsResponse: V1ListTimecardEventsResponse, + /** + * The V1ListTimecardsRequest model constructor. + * @property {module:model/V1ListTimecardsRequest} + */ + V1ListTimecardsRequest: V1ListTimecardsRequest, + /** + * The V1ListTimecardsResponse model constructor. + * @property {module:model/V1ListTimecardsResponse} + */ + V1ListTimecardsResponse: V1ListTimecardsResponse, /** * The V1Merchant model constructor. * @property {module:model/V1Merchant} */ V1Merchant: V1Merchant, + /** + * The V1MerchantAccountType model constructor. + * @property {module:model/V1MerchantAccountType} + */ + V1MerchantAccountType: V1MerchantAccountType, + /** + * The V1MerchantBusinessType model constructor. + * @property {module:model/V1MerchantBusinessType} + */ + V1MerchantBusinessType: V1MerchantBusinessType, /** * The V1MerchantLocationDetails model constructor. * @property {module:model/V1MerchantLocationDetails} @@ -1311,6 +2113,11 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/V1ModifierList} */ V1ModifierList: V1ModifierList, + /** + * The V1ModifierListSelectionType model constructor. + * @property {module:model/V1ModifierListSelectionType} + */ + V1ModifierListSelectionType: V1ModifierListSelectionType, /** * The V1ModifierOption model constructor. * @property {module:model/V1ModifierOption} @@ -1331,6 +2138,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/V1OrderHistoryEntry} */ V1OrderHistoryEntry: V1OrderHistoryEntry, + /** + * The V1OrderHistoryEntryAction model constructor. + * @property {module:model/V1OrderHistoryEntryAction} + */ + V1OrderHistoryEntryAction: V1OrderHistoryEntryAction, + /** + * The V1OrderState model constructor. + * @property {module:model/V1OrderState} + */ + V1OrderState: V1OrderState, /** * The V1Page model constructor. * @property {module:model/V1Page} @@ -1341,6 +2158,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/V1PageCell} */ V1PageCell: V1PageCell, + /** + * The V1PageCellObjectType model constructor. + * @property {module:model/V1PageCellObjectType} + */ + V1PageCellObjectType: V1PageCellObjectType, + /** + * The V1PageCellPlaceholderType model constructor. + * @property {module:model/V1PageCellPlaceholderType} + */ + V1PageCellPlaceholderType: V1PageCellPlaceholderType, /** * The V1Payment model constructor. * @property {module:model/V1Payment} @@ -1361,6 +2188,11 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/V1PaymentItemization} */ V1PaymentItemization: V1PaymentItemization, + /** + * The V1PaymentItemizationItemizationType model constructor. + * @property {module:model/V1PaymentItemizationItemizationType} + */ + V1PaymentItemizationItemizationType: V1PaymentItemizationItemizationType, /** * The V1PaymentModifier model constructor. * @property {module:model/V1PaymentModifier} @@ -1371,11 +2203,21 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/V1PaymentSurcharge} */ V1PaymentSurcharge: V1PaymentSurcharge, + /** + * The V1PaymentSurchargeType model constructor. + * @property {module:model/V1PaymentSurchargeType} + */ + V1PaymentSurchargeType: V1PaymentSurchargeType, /** * The V1PaymentTax model constructor. * @property {module:model/V1PaymentTax} */ V1PaymentTax: V1PaymentTax, + /** + * The V1PaymentTaxInclusionType model constructor. + * @property {module:model/V1PaymentTaxInclusionType} + */ + V1PaymentTaxInclusionType: V1PaymentTaxInclusionType, /** * The V1PhoneNumber model constructor. * @property {module:model/V1PhoneNumber} @@ -1386,6 +2228,76 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/V1Refund} */ V1Refund: V1Refund, + /** + * The V1RefundType model constructor. + * @property {module:model/V1RefundType} + */ + V1RefundType: V1RefundType, + /** + * The V1RemoveFeeRequest model constructor. + * @property {module:model/V1RemoveFeeRequest} + */ + V1RemoveFeeRequest: V1RemoveFeeRequest, + /** + * The V1RemoveModifierListRequest model constructor. + * @property {module:model/V1RemoveModifierListRequest} + */ + V1RemoveModifierListRequest: V1RemoveModifierListRequest, + /** + * The V1RetrieveBankAccountRequest model constructor. + * @property {module:model/V1RetrieveBankAccountRequest} + */ + V1RetrieveBankAccountRequest: V1RetrieveBankAccountRequest, + /** + * The V1RetrieveBusinessRequest model constructor. + * @property {module:model/V1RetrieveBusinessRequest} + */ + V1RetrieveBusinessRequest: V1RetrieveBusinessRequest, + /** + * The V1RetrieveCashDrawerShiftRequest model constructor. + * @property {module:model/V1RetrieveCashDrawerShiftRequest} + */ + V1RetrieveCashDrawerShiftRequest: V1RetrieveCashDrawerShiftRequest, + /** + * The V1RetrieveEmployeeRequest model constructor. + * @property {module:model/V1RetrieveEmployeeRequest} + */ + V1RetrieveEmployeeRequest: V1RetrieveEmployeeRequest, + /** + * The V1RetrieveEmployeeRoleRequest model constructor. + * @property {module:model/V1RetrieveEmployeeRoleRequest} + */ + V1RetrieveEmployeeRoleRequest: V1RetrieveEmployeeRoleRequest, + /** + * The V1RetrieveItemRequest model constructor. + * @property {module:model/V1RetrieveItemRequest} + */ + V1RetrieveItemRequest: V1RetrieveItemRequest, + /** + * The V1RetrieveModifierListRequest model constructor. + * @property {module:model/V1RetrieveModifierListRequest} + */ + V1RetrieveModifierListRequest: V1RetrieveModifierListRequest, + /** + * The V1RetrieveOrderRequest model constructor. + * @property {module:model/V1RetrieveOrderRequest} + */ + V1RetrieveOrderRequest: V1RetrieveOrderRequest, + /** + * The V1RetrievePaymentRequest model constructor. + * @property {module:model/V1RetrievePaymentRequest} + */ + V1RetrievePaymentRequest: V1RetrievePaymentRequest, + /** + * The V1RetrieveSettlementRequest model constructor. + * @property {module:model/V1RetrieveSettlementRequest} + */ + V1RetrieveSettlementRequest: V1RetrieveSettlementRequest, + /** + * The V1RetrieveTimecardRequest model constructor. + * @property {module:model/V1RetrieveTimecardRequest} + */ + V1RetrieveTimecardRequest: V1RetrieveTimecardRequest, /** * The V1Settlement model constructor. * @property {module:model/V1Settlement} @@ -1396,11 +2308,31 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/V1SettlementEntry} */ V1SettlementEntry: V1SettlementEntry, + /** + * The V1SettlementEntryType model constructor. + * @property {module:model/V1SettlementEntryType} + */ + V1SettlementEntryType: V1SettlementEntryType, + /** + * The V1SettlementStatus model constructor. + * @property {module:model/V1SettlementStatus} + */ + V1SettlementStatus: V1SettlementStatus, /** * The V1Tender model constructor. * @property {module:model/V1Tender} */ V1Tender: V1Tender, + /** + * The V1TenderEntryMethod model constructor. + * @property {module:model/V1TenderEntryMethod} + */ + V1TenderEntryMethod: V1TenderEntryMethod, + /** + * The V1TenderType model constructor. + * @property {module:model/V1TenderType} + */ + V1TenderType: V1TenderType, /** * The V1Timecard model constructor. * @property {module:model/V1Timecard} @@ -1411,21 +2343,101 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/V1TimecardEvent} */ V1TimecardEvent: V1TimecardEvent, + /** + * The V1TimecardEventEventType model constructor. + * @property {module:model/V1TimecardEventEventType} + */ + V1TimecardEventEventType: V1TimecardEventEventType, + /** + * The V1UpdateCategoryRequest model constructor. + * @property {module:model/V1UpdateCategoryRequest} + */ + V1UpdateCategoryRequest: V1UpdateCategoryRequest, + /** + * The V1UpdateDiscountRequest model constructor. + * @property {module:model/V1UpdateDiscountRequest} + */ + V1UpdateDiscountRequest: V1UpdateDiscountRequest, + /** + * The V1UpdateEmployeeRequest model constructor. + * @property {module:model/V1UpdateEmployeeRequest} + */ + V1UpdateEmployeeRequest: V1UpdateEmployeeRequest, + /** + * The V1UpdateEmployeeRoleRequest model constructor. + * @property {module:model/V1UpdateEmployeeRoleRequest} + */ + V1UpdateEmployeeRoleRequest: V1UpdateEmployeeRoleRequest, + /** + * The V1UpdateFeeRequest model constructor. + * @property {module:model/V1UpdateFeeRequest} + */ + V1UpdateFeeRequest: V1UpdateFeeRequest, + /** + * The V1UpdateItemRequest model constructor. + * @property {module:model/V1UpdateItemRequest} + */ + V1UpdateItemRequest: V1UpdateItemRequest, /** * The V1UpdateModifierListRequest model constructor. * @property {module:model/V1UpdateModifierListRequest} */ V1UpdateModifierListRequest: V1UpdateModifierListRequest, + /** + * The V1UpdateModifierListRequestSelectionType model constructor. + * @property {module:model/V1UpdateModifierListRequestSelectionType} + */ + V1UpdateModifierListRequestSelectionType: V1UpdateModifierListRequestSelectionType, + /** + * The V1UpdateModifierOptionRequest model constructor. + * @property {module:model/V1UpdateModifierOptionRequest} + */ + V1UpdateModifierOptionRequest: V1UpdateModifierOptionRequest, /** * The V1UpdateOrderRequest model constructor. * @property {module:model/V1UpdateOrderRequest} */ V1UpdateOrderRequest: V1UpdateOrderRequest, + /** + * The V1UpdateOrderRequestAction model constructor. + * @property {module:model/V1UpdateOrderRequestAction} + */ + V1UpdateOrderRequestAction: V1UpdateOrderRequestAction, + /** + * The V1UpdatePageCellRequest model constructor. + * @property {module:model/V1UpdatePageCellRequest} + */ + V1UpdatePageCellRequest: V1UpdatePageCellRequest, + /** + * The V1UpdatePageRequest model constructor. + * @property {module:model/V1UpdatePageRequest} + */ + V1UpdatePageRequest: V1UpdatePageRequest, + /** + * The V1UpdateTimecardRequest model constructor. + * @property {module:model/V1UpdateTimecardRequest} + */ + V1UpdateTimecardRequest: V1UpdateTimecardRequest, + /** + * The V1UpdateVariationRequest model constructor. + * @property {module:model/V1UpdateVariationRequest} + */ + V1UpdateVariationRequest: V1UpdateVariationRequest, /** * The V1Variation model constructor. * @property {module:model/V1Variation} */ V1Variation: V1Variation, + /** + * The V1VariationInventoryAlertType model constructor. + * @property {module:model/V1VariationInventoryAlertType} + */ + V1VariationInventoryAlertType: V1VariationInventoryAlertType, + /** + * The V1VariationPricingType model constructor. + * @property {module:model/V1VariationPricingType} + */ + V1VariationPricingType: V1VariationPricingType, /** * The VoidTransactionRequest model constructor. * @property {module:model/VoidTransactionRequest} @@ -1436,6 +2448,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/VoidTransactionResponse} */ VoidTransactionResponse: VoidTransactionResponse, + /** + * The Weekday model constructor. + * @property {module:model/Weekday} + */ + Weekday: Weekday, + /** + * The WorkweekConfig model constructor. + * @property {module:model/WorkweekConfig} + */ + WorkweekConfig: WorkweekConfig, /** * The ApplePayApi service constructor. * @property {module:api/ApplePayApi} @@ -1456,11 +2478,21 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:api/CustomersApi} */ CustomersApi: CustomersApi, + /** + * The EmployeesApi service constructor. + * @property {module:api/EmployeesApi} + */ + EmployeesApi: EmployeesApi, /** * The InventoryApi service constructor. * @property {module:api/InventoryApi} */ InventoryApi: InventoryApi, + /** + * The LaborApi service constructor. + * @property {module:api/LaborApi} + */ + LaborApi: LaborApi, /** * The LocationsApi service constructor. * @property {module:api/LocationsApi} diff --git a/src/model/BatchRetrieveInventoryChangesRequest.js b/src/model/BatchRetrieveInventoryChangesRequest.js index f8425ed..908e275 100644 --- a/src/model/BatchRetrieveInventoryChangesRequest.js +++ b/src/model/BatchRetrieveInventoryChangesRequest.js @@ -106,7 +106,7 @@ exports.prototype['updated_after'] = undefined; */ exports.prototype['updated_before'] = undefined; /** - * 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 [Paginating results](#paginatingresults) for more information. + * 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 [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/BatchRetrieveInventoryChangesResponse.js b/src/model/BatchRetrieveInventoryChangesResponse.js index af94729..dfb1ac5 100644 --- a/src/model/BatchRetrieveInventoryChangesResponse.js +++ b/src/model/BatchRetrieveInventoryChangesResponse.js @@ -72,7 +72,7 @@ exports.prototype['errors'] = undefined; */ exports.prototype['changes'] = undefined; /** - * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Paginating results](#paginatingresults) for more information. + * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/BatchRetrieveInventoryCountsRequest.js b/src/model/BatchRetrieveInventoryCountsRequest.js index a17b9f7..b35eeaf 100644 --- a/src/model/BatchRetrieveInventoryCountsRequest.js +++ b/src/model/BatchRetrieveInventoryCountsRequest.js @@ -79,7 +79,7 @@ exports.prototype['location_ids'] = undefined; */ exports.prototype['updated_after'] = undefined; /** - * 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 [Paginating results](#paginatingresults) for more information. + * 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 [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/BatchRetrieveInventoryCountsResponse.js b/src/model/BatchRetrieveInventoryCountsResponse.js index a4655a4..9052cd8 100644 --- a/src/model/BatchRetrieveInventoryCountsResponse.js +++ b/src/model/BatchRetrieveInventoryCountsResponse.js @@ -72,7 +72,7 @@ exports.prototype['errors'] = undefined; */ exports.prototype['counts'] = undefined; /** - * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Paginating results](#paginatingresults) for more information. + * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/BatchUpsertCatalogObjectsRequest.js b/src/model/BatchUpsertCatalogObjectsRequest.js index d8df521..a5a8396 100644 --- a/src/model/BatchUpsertCatalogObjectsRequest.js +++ b/src/model/BatchUpsertCatalogObjectsRequest.js @@ -27,7 +27,7 @@ var CatalogObjectBatch = require('./CatalogObjectBatch'); * * @alias module:model/BatchUpsertCatalogObjectsRequest * @class - * @param idempotencyKey {String} A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency keys](#idempotencykeys) for more information. + * @param idempotencyKey {String} A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency](/basics/api101/idempotency) for more information. */ var exports = function(idempotencyKey) { var _this = this; @@ -58,7 +58,7 @@ exports.constructFromObject = function(data, obj) { } /** - * A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency keys](#idempotencykeys) for more information. + * A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency](/basics/api101/idempotency) for more information. * @member {String} idempotency_key */ exports.prototype['idempotency_key'] = undefined; diff --git a/src/model/BreakType.js b/src/model/BreakType.js new file mode 100644 index 0000000..c14e1a6 --- /dev/null +++ b/src/model/BreakType.js @@ -0,0 +1,132 @@ +/** + * 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'); + + + + +/** + * The BreakType model module. + * @module model/BreakType + */ + +/** + * Constructs a new BreakType. + * A defined break template that sets an expectation for possible `Break` instances on a `Shift`. + * @alias module:model/BreakType + * @class + * @param locationId {String} The ID of the business location this type of break applies to. + * @param breakName {String} A human-readable name for this type of break. Will be displayed to employees in Square products. + * @param expectedDuration {String} Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of this break. Precision below minutes is truncated. + * @param isPaid {Boolean} Whether this break counts towards time worked for compensation purposes. + */ +var exports = function(locationId, breakName, expectedDuration, isPaid) { + var _this = this; + + + _this['location_id'] = locationId; + _this['break_name'] = breakName; + _this['expected_duration'] = expectedDuration; + _this['is_paid'] = isPaid; + + + +}; + +/** + * Constructs a BreakType 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/BreakType} obj Optional instance to populate. + * @return {module:model/BreakType} The populated BreakType 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('location_id')) { + obj['location_id'] = ApiClient.convertToType(data['location_id'], 'String'); + } + if (data.hasOwnProperty('break_name')) { + obj['break_name'] = ApiClient.convertToType(data['break_name'], 'String'); + } + if (data.hasOwnProperty('expected_duration')) { + obj['expected_duration'] = ApiClient.convertToType(data['expected_duration'], 'String'); + } + if (data.hasOwnProperty('is_paid')) { + obj['is_paid'] = ApiClient.convertToType(data['is_paid'], 'Boolean'); + } + if (data.hasOwnProperty('version')) { + obj['version'] = ApiClient.convertToType(data['version'], 'Number'); + } + if (data.hasOwnProperty('created_at')) { + obj['created_at'] = ApiClient.convertToType(data['created_at'], 'String'); + } + if (data.hasOwnProperty('updated_at')) { + obj['updated_at'] = ApiClient.convertToType(data['updated_at'], 'String'); + } + } + return obj; +} + +/** + * UUID for this object. + * @member {String} id + */ +exports.prototype['id'] = undefined; +/** + * The ID of the business location this type of break applies to. + * @member {String} location_id + */ +exports.prototype['location_id'] = undefined; +/** + * A human-readable name for this type of break. Will be displayed to employees in Square products. + * @member {String} break_name + */ +exports.prototype['break_name'] = undefined; +/** + * Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of this break. Precision below minutes is truncated. + * @member {String} expected_duration + */ +exports.prototype['expected_duration'] = undefined; +/** + * Whether this break counts towards time worked for compensation purposes. + * @member {Boolean} is_paid + */ +exports.prototype['is_paid'] = undefined; +/** + * Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If a value is not provided, Square's servers execute a \"blind\" write; potentially overwriting another writer's data. + * @member {Number} version + */ +exports.prototype['version'] = undefined; +/** + * A read-only timestamp in RFC 3339 format. + * @member {String} created_at + */ +exports.prototype['created_at'] = undefined; +/** + * A read-only timestamp in RFC 3339 format. + * @member {String} updated_at + */ +exports.prototype['updated_at'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/Card.js b/src/model/Card.js index ddef249..723d094 100644 --- a/src/model/Card.js +++ b/src/model/Card.js @@ -116,7 +116,7 @@ exports.prototype['cardholder_name'] = undefined; */ exports.prototype['billing_address'] = undefined; /** - * __Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application. + * __Not currently set.__ Intended as a Square-assigned identifier, based on the card number, to identify the card across multiple locations within a single application. * @member {String} fingerprint */ exports.prototype['fingerprint'] = undefined; diff --git a/src/model/CatalogItem.js b/src/model/CatalogItem.js index 79cfa74..3465601 100644 --- a/src/model/CatalogItem.js +++ b/src/model/CatalogItem.js @@ -116,7 +116,7 @@ exports.prototype['name'] = undefined; */ exports.prototype['description'] = undefined; /** - * The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used. Searchable. This field has max length of 24 Unicode code points. + * The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used. Searchable. This field has max length of 24 Unicode code points. * @member {String} abbreviation */ exports.prototype['abbreviation'] = undefined; diff --git a/src/model/CatalogItemVariation.js b/src/model/CatalogItemVariation.js index 69d0876..40f4315 100644 --- a/src/model/CatalogItemVariation.js +++ b/src/model/CatalogItemVariation.js @@ -157,7 +157,7 @@ exports.prototype['inventory_alert_type'] = undefined; */ exports.prototype['inventory_alert_threshold'] = undefined; /** - * Arbitrary user metadata to associate with the item variation. Searchable. This field has max length of 255 Unicode code points. + * Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable. * @member {String} user_data */ exports.prototype['user_data'] = undefined; diff --git a/src/model/CatalogObject.js b/src/model/CatalogObject.js index 0ee65ef..daa2ae0 100644 --- a/src/model/CatalogObject.js +++ b/src/model/CatalogObject.js @@ -137,7 +137,7 @@ exports.prototype['id'] = undefined; */ exports.prototype['updated_at'] = undefined; /** - * The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting. + * The version of the object. When updating an object, the version supplied by the must match the version in the database, otherwise the write will be rejected as conflicting. * @member {Number} version */ exports.prototype['version'] = undefined; diff --git a/src/model/CatalogQuery.js b/src/model/CatalogQuery.js index 6716bc6..addb1cf 100644 --- a/src/model/CatalogQuery.js +++ b/src/model/CatalogQuery.js @@ -30,7 +30,7 @@ var CatalogQueryText = require('./CatalogQueryText'); /** * Constructs a new CatalogQuery. - * A query to be applied to a [SearchCatalogObjectsRequest](#type-searchcatalogobjectsrequest). Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) ([CatalogItem](#type-catalogitem), [CatalogItemVariation](#type-catalogitemvariation), [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax), [CatalogDiscount](#type-catalogdiscount), [CatalogModifierList](#type-catalogmodifierlist), [CatalogModifier](#type-catalogmodifier)). For example, a query that should return Items may specify attribute names from any of the searchable fields of the [CatalogItem](#type-catalogitem) data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`. + * A query to be applied to a SearchCatalogObjects request. Only one query field may be present. Where an attribute name is required, it should be specified as the name of any field marked \"searchable\" from the structured data types for the desired result object type(s) ([CatalogItem](#type-catalogitem), [CatalogItemVariation](#type-catalogitemvariation), [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax), [CatalogDiscount](#type-catalogdiscount), [CatalogModifierList](#type-catalogmodifierlist), [CatalogModifier](#type-catalogmodifier)). For example, a query that should return Items may specify attribute names from any of the searchable fields of the [CatalogItem](#type-catalogitem) data type, namely `\"name\"`, `\"description\"`, and `\"abbreviation\"`. * @alias module:model/CatalogQuery * @class */ diff --git a/src/model/ChargeRequest.js b/src/model/ChargeRequest.js index 0410d11..32a345f 100644 --- a/src/model/ChargeRequest.js +++ b/src/model/ChargeRequest.js @@ -29,7 +29,7 @@ var Money = require('./Money'); * Defines the parameters that can be included in the body of a request to the [Charge](#endpoint-charge) endpoint. * @alias module:model/ChargeRequest * @class - * @param idempotencyKey {String} A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency keys](#idempotencykeys) for more information. + * @param idempotencyKey {String} A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency](/basics/api101/idempotency) for more information. * @param amountMoney {module:model/Money} The amount of money to charge. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](#workingwithmonetaryamounts) for details. The value of `currency` must match the currency associated with the business that is charging the card. */ var exports = function(idempotencyKey, amountMoney) { @@ -105,7 +105,7 @@ exports.constructFromObject = function(data, obj) { } /** - * A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency keys](#idempotencykeys) for more information. + * A value you specify that uniquely identifies this transaction among transactions you've created. If you're unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency](/basics/api101/idempotency) for more information. * @member {String} idempotency_key */ exports.prototype['idempotency_key'] = undefined; diff --git a/src/model/CreateBreakTypeRequest.js b/src/model/CreateBreakTypeRequest.js new file mode 100644 index 0000000..90a60b8 --- /dev/null +++ b/src/model/CreateBreakTypeRequest.js @@ -0,0 +1,76 @@ +/** + * 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 BreakType = require('./BreakType'); + + + + +/** + * The CreateBreakTypeRequest model module. + * @module model/CreateBreakTypeRequest + */ + +/** + * Constructs a new CreateBreakTypeRequest. + * A request to create a new `BreakType` + * @alias module:model/CreateBreakTypeRequest + * @class + * @param breakType {module:model/BreakType} The `BreakType` to be created. + */ +var exports = function(breakType) { + var _this = this; + + + _this['break_type'] = breakType; +}; + +/** + * Constructs a CreateBreakTypeRequest 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/CreateBreakTypeRequest} obj Optional instance to populate. + * @return {module:model/CreateBreakTypeRequest} The populated CreateBreakTypeRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('idempotency_key')) { + obj['idempotency_key'] = ApiClient.convertToType(data['idempotency_key'], 'String'); + } + if (data.hasOwnProperty('break_type')) { + obj['break_type'] = BreakType.constructFromObject(data['break_type']); + } + } + return obj; +} + +/** + * Unique string value to insure idempotency of the operation + * @member {String} idempotency_key + */ +exports.prototype['idempotency_key'] = undefined; +/** + * The `BreakType` to be created. + * @member {module:model/BreakType} break_type + */ +exports.prototype['break_type'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/CreateBreakTypeResponse.js b/src/model/CreateBreakTypeResponse.js new file mode 100644 index 0000000..a343695 --- /dev/null +++ b/src/model/CreateBreakTypeResponse.js @@ -0,0 +1,76 @@ +/** + * 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 BreakType = require('./BreakType'); +var Error = require('./Error'); + + + + +/** + * The CreateBreakTypeResponse model module. + * @module model/CreateBreakTypeResponse + */ + +/** + * Constructs a new CreateBreakTypeResponse. + * The response to the request to create a `BreakType`. Contains the created `BreakType` object. May contain a set of `Error` objects if the request resulted in errors. + * @alias module:model/CreateBreakTypeResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a CreateBreakTypeResponse 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/CreateBreakTypeResponse} obj Optional instance to populate. + * @return {module:model/CreateBreakTypeResponse} The populated CreateBreakTypeResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('break_type')) { + obj['break_type'] = BreakType.constructFromObject(data['break_type']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The `BreakType` that was created by the request. + * @member {module:model/BreakType} break_type + */ +exports.prototype['break_type'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/CreateCheckoutRequest.js b/src/model/CreateCheckoutRequest.js index 84ca0cc..a7a8cd4 100644 --- a/src/model/CreateCheckoutRequest.js +++ b/src/model/CreateCheckoutRequest.js @@ -29,7 +29,7 @@ var CreateOrderRequest = require('./CreateOrderRequest'); * Defines the parameters that can be included in the body of a request to the [CreateCheckout](#endpoint-createcheckout) endpoint. * @alias module:model/CreateCheckoutRequest * @class - * @param idempotencyKey {String} A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency keys](#idempotencykeys) for more information. + * @param idempotencyKey {String} A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency](/basics/api101/idempotency) for more information. * @param order {module:model/CreateOrderRequest} The order including line items to be checked out. */ var exports = function(idempotencyKey, order) { @@ -89,7 +89,7 @@ exports.constructFromObject = function(data, obj) { } /** - * A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency keys](#idempotencykeys) for more information. + * A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency](/basics/api101/idempotency) for more information. * @member {String} idempotency_key */ exports.prototype['idempotency_key'] = undefined; diff --git a/src/model/CreateOrderRequest.js b/src/model/CreateOrderRequest.js index 9908370..4ec6182 100644 --- a/src/model/CreateOrderRequest.js +++ b/src/model/CreateOrderRequest.js @@ -81,7 +81,7 @@ exports.constructFromObject = function(data, obj) { */ exports.prototype['order'] = 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 keys](#idempotencykeys) for more information. + * 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](/basics/api101/idempotency) for more information. * @member {String} idempotency_key */ exports.prototype['idempotency_key'] = undefined; diff --git a/src/model/CreateRefundRequest.js b/src/model/CreateRefundRequest.js index f0ac74a..141c2ca 100644 --- a/src/model/CreateRefundRequest.js +++ b/src/model/CreateRefundRequest.js @@ -27,7 +27,7 @@ var Money = require('./Money'); * Defines the body parameters that can be included in a request to the [CreateRefund](#endpoint-createrefund) endpoint. * @alias module:model/CreateRefundRequest * @class - * @param idempotencyKey {String} A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency keys](#idempotencykeys) for more information. + * @param idempotencyKey {String} A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency](/basics/api101/idempotency) for more information. * @param tenderId {String} The ID of the tender to refund. A [`Transaction`](#type-transaction) has one or more `tenders` (i.e., methods of payment) associated with it, and you refund each tender separately with the Connect API. * @param amountMoney {module:model/Money} The amount of money to refund. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](#workingwithmonetaryamounts) for details. This amount cannot exceed the amount that was originally charged to the tender that corresponds to `tender_id`. */ @@ -68,7 +68,7 @@ exports.constructFromObject = function(data, obj) { } /** - * A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency keys](#idempotencykeys) for more information. + * A value you specify that uniquely identifies this refund among refunds you've created for the tender. If you're unsure whether a particular refund succeeded, you can reattempt it with the same idempotency key without worrying about duplicating the refund. See [Idempotency](/basics/api101/idempotency) for more information. * @member {String} idempotency_key */ exports.prototype['idempotency_key'] = undefined; diff --git a/src/model/CreateShiftRequest.js b/src/model/CreateShiftRequest.js new file mode 100644 index 0000000..7c4ac43 --- /dev/null +++ b/src/model/CreateShiftRequest.js @@ -0,0 +1,76 @@ +/** + * 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 Shift = require('./Shift'); + + + + +/** + * The CreateShiftRequest model module. + * @module model/CreateShiftRequest + */ + +/** + * Constructs a new CreateShiftRequest. + * Represents a request to create a `Shift` + * @alias module:model/CreateShiftRequest + * @class + * @param shift {module:model/Shift} The `Shift` to be created + */ +var exports = function(shift) { + var _this = this; + + + _this['shift'] = shift; +}; + +/** + * Constructs a CreateShiftRequest 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/CreateShiftRequest} obj Optional instance to populate. + * @return {module:model/CreateShiftRequest} The populated CreateShiftRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('idempotency_key')) { + obj['idempotency_key'] = ApiClient.convertToType(data['idempotency_key'], 'String'); + } + if (data.hasOwnProperty('shift')) { + obj['shift'] = Shift.constructFromObject(data['shift']); + } + } + return obj; +} + +/** + * Unique string value to insure the idempotency of the operation. + * @member {String} idempotency_key + */ +exports.prototype['idempotency_key'] = undefined; +/** + * The `Shift` to be created + * @member {module:model/Shift} shift + */ +exports.prototype['shift'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/CreateShiftResponse.js b/src/model/CreateShiftResponse.js new file mode 100644 index 0000000..c61573c --- /dev/null +++ b/src/model/CreateShiftResponse.js @@ -0,0 +1,76 @@ +/** + * 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 Shift = require('./Shift'); + + + + +/** + * The CreateShiftResponse model module. + * @module model/CreateShiftResponse + */ + +/** + * Constructs a new CreateShiftResponse. + * The response to the request to create a `Shift`. Contains the created `Shift` object. May contain a set of `Error` objects if the request resulted in errors. + * @alias module:model/CreateShiftResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a CreateShiftResponse 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/CreateShiftResponse} obj Optional instance to populate. + * @return {module:model/CreateShiftResponse} The populated CreateShiftResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('shift')) { + obj['shift'] = Shift.constructFromObject(data['shift']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The `Shift` that was created on the request. + * @member {module:model/Shift} shift + */ +exports.prototype['shift'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/DateRange.js b/src/model/DateRange.js new file mode 100644 index 0000000..b5127ae --- /dev/null +++ b/src/model/DateRange.js @@ -0,0 +1,74 @@ +/** + * 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'); + + + + +/** + * The DateRange model module. + * @module model/DateRange + */ + +/** + * Constructs a new DateRange. + * A range defined by two dates. Used for filtering a query for Connect v2 objects that have date properties. + * @alias module:model/DateRange + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a DateRange 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/DateRange} obj Optional instance to populate. + * @return {module:model/DateRange} The populated DateRange instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('start_date')) { + obj['start_date'] = ApiClient.convertToType(data['start_date'], 'String'); + } + if (data.hasOwnProperty('end_date')) { + obj['end_date'] = ApiClient.convertToType(data['end_date'], 'String'); + } + } + return obj; +} + +/** + * String in `YYYY-MM-DD` format, e.g. `2017-10-31` per the ISO 8601 extended format for calendar dates. The beginning of a date range (inclusive) + * @member {String} start_date + */ +exports.prototype['start_date'] = undefined; +/** + * String in `YYYY-MM-DD` format, e.g. `2017-10-31` per the ISO 8601 extended format for calendar dates. The end of a date range (inclusive) + * @member {String} end_date + */ +exports.prototype['end_date'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/DeleteBreakTypeRequest.js b/src/model/DeleteBreakTypeRequest.js new file mode 100644 index 0000000..e0e9719 --- /dev/null +++ b/src/model/DeleteBreakTypeRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The DeleteBreakTypeRequest model module. + * @module model/DeleteBreakTypeRequest + */ + +/** + * Constructs a new DeleteBreakTypeRequest. + * A request to delete a `BreakType` + * @alias module:model/DeleteBreakTypeRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a DeleteBreakTypeRequest 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/DeleteBreakTypeRequest} obj Optional instance to populate. + * @return {module:model/DeleteBreakTypeRequest} The populated DeleteBreakTypeRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/DeleteBreakTypeResponse.js b/src/model/DeleteBreakTypeResponse.js new file mode 100644 index 0000000..e65790c --- /dev/null +++ b/src/model/DeleteBreakTypeResponse.js @@ -0,0 +1,66 @@ +/** + * 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'); + + + + +/** + * The DeleteBreakTypeResponse model module. + * @module model/DeleteBreakTypeResponse + */ + +/** + * Constructs a new DeleteBreakTypeResponse. + * The response to a request to delete a `BreakType`. May contain a set of `Error` objects if the request resulted in errors. + * @alias module:model/DeleteBreakTypeResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a DeleteBreakTypeResponse 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/DeleteBreakTypeResponse} obj Optional instance to populate. + * @return {module:model/DeleteBreakTypeResponse} The populated DeleteBreakTypeResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/DeleteShiftRequest.js b/src/model/DeleteShiftRequest.js new file mode 100644 index 0000000..ac15a66 --- /dev/null +++ b/src/model/DeleteShiftRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The DeleteShiftRequest model module. + * @module model/DeleteShiftRequest + */ + +/** + * Constructs a new DeleteShiftRequest. + * A request to delete a `Shift` + * @alias module:model/DeleteShiftRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a DeleteShiftRequest 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/DeleteShiftRequest} obj Optional instance to populate. + * @return {module:model/DeleteShiftRequest} The populated DeleteShiftRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/DeleteShiftResponse.js b/src/model/DeleteShiftResponse.js new file mode 100644 index 0000000..5cb0823 --- /dev/null +++ b/src/model/DeleteShiftResponse.js @@ -0,0 +1,66 @@ +/** + * 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'); + + + + +/** + * The DeleteShiftResponse model module. + * @module model/DeleteShiftResponse + */ + +/** + * Constructs a new DeleteShiftResponse. + * The response to a request to delete a `Shift`. May contain a set of `Error` objects if the request resulted in errors. + * @alias module:model/DeleteShiftResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a DeleteShiftResponse 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/DeleteShiftResponse} obj Optional instance to populate. + * @return {module:model/DeleteShiftResponse} The populated DeleteShiftResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/Device.js b/src/model/Device.js index fa32ab9..6088373 100644 --- a/src/model/Device.js +++ b/src/model/Device.js @@ -23,6 +23,7 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new Device. + * * @alias module:model/Device * @class */ diff --git a/src/model/Employee.js b/src/model/Employee.js new file mode 100644 index 0000000..98fe3dc --- /dev/null +++ b/src/model/Employee.js @@ -0,0 +1,136 @@ +/** + * 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'); + + + + +/** + * The Employee model module. + * @module model/Employee + */ + +/** + * Constructs a new Employee. + * An employee created in the **Square Dashboard** account of a business. Used by the Labor API. + * @alias module:model/Employee + * @class + */ +var exports = function() { + var _this = this; + + + + + + + + +}; + +/** + * Constructs a Employee 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/Employee} obj Optional instance to populate. + * @return {module:model/Employee} The populated Employee 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('first_name')) { + obj['first_name'] = ApiClient.convertToType(data['first_name'], 'String'); + } + if (data.hasOwnProperty('last_name')) { + obj['last_name'] = ApiClient.convertToType(data['last_name'], 'String'); + } + if (data.hasOwnProperty('location_ids')) { + obj['location_ids'] = ApiClient.convertToType(data['location_ids'], ['String']); + } + if (data.hasOwnProperty('status')) { + obj['status'] = ApiClient.convertToType(data['status'], 'String'); + } + if (data.hasOwnProperty('created_at')) { + obj['created_at'] = ApiClient.convertToType(data['created_at'], 'String'); + } + if (data.hasOwnProperty('updated_at')) { + obj['updated_at'] = ApiClient.convertToType(data['updated_at'], 'String'); + } + } + return obj; +} + +/** + * UUID for this `Employee`. + * @member {String} id + */ +exports.prototype['id'] = undefined; +/** + * Given (first) name of the employee. + * @member {String} first_name + */ +exports.prototype['first_name'] = undefined; +/** + * Family (last) name of the employee + * @member {String} last_name + */ +exports.prototype['last_name'] = undefined; +/** + * A list of location IDs where this employee has access. + * @member {Array.} location_ids + */ +exports.prototype['location_ids'] = undefined; +/** + * Specifies the status of the employee being fetched. + * @member {module:model/Employee.StatusEnum} status + */ +exports.prototype['status'] = undefined; +/** + * A read-only timestamp in RFC 3339 format. + * @member {String} created_at + */ +exports.prototype['created_at'] = undefined; +/** + * A read-only timestamp in RFC 3339 format. + * @member {String} updated_at + */ +exports.prototype['updated_at'] = undefined; + + + /** + * Allowed values for the status property. + * @enum {String} + * @readonly + */ + exports.StatusEnum = { + /** + * value: "ACTIVE" + * @const + */ + "ACTIVE": "ACTIVE", + /** + * value: "INACTIVE" + * @const + */ + "INACTIVE": "INACTIVE" }; + + +module.exports = exports; + + + diff --git a/src/model/EmployeeStatus.js b/src/model/EmployeeStatus.js new file mode 100644 index 0000000..ed91588 --- /dev/null +++ b/src/model/EmployeeStatus.js @@ -0,0 +1,45 @@ +/** + * 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 EmployeeStatus. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "ACTIVE" + * @const + */ + "ACTIVE": "ACTIVE", + /** + * value: "INACTIVE" + * @const + */ + "INACTIVE": "INACTIVE"}; + +/** + * Returns a EmployeeStatus enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/EmployeeStatus} The enum EmployeeStatus value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/EmployeeWage.js b/src/model/EmployeeWage.js new file mode 100644 index 0000000..c8d0f88 --- /dev/null +++ b/src/model/EmployeeWage.js @@ -0,0 +1,94 @@ +/** + * 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 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. + * @alias module:model/EmployeeWage + * @class + * @param employeeId {String} The `Employee` that this wage is assigned to. + */ +var exports = function(employeeId) { + var _this = this; + + + _this['employee_id'] = employeeId; + + +}; + +/** + * Constructs a EmployeeWage 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/EmployeeWage} obj Optional instance to populate. + * @return {module:model/EmployeeWage} The populated EmployeeWage 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('employee_id')) { + obj['employee_id'] = ApiClient.convertToType(data['employee_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 `Employee` that this wage is assigned to. + * @member {String} employee_id + */ +exports.prototype['employee_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/Error.js b/src/model/Error.js index ada6c51..7e022b4 100644 --- a/src/model/Error.js +++ b/src/model/Error.js @@ -23,7 +23,7 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new Error. - * Represents an error encountered during a request to the Connect API. See [Handling errors](#handlingerrors) for more information. + * Represents an error encountered during a request to the Connect API. * @alias module:model/Error * @class * @param category {module:model/Error.CategoryEnum} The error's high-level category. See [ErrorCategory](#type-errorcategory) for possible values. diff --git a/src/model/GetBreakTypeRequest.js b/src/model/GetBreakTypeRequest.js new file mode 100644 index 0000000..01e3db0 --- /dev/null +++ b/src/model/GetBreakTypeRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The GetBreakTypeRequest model module. + * @module model/GetBreakTypeRequest + */ + +/** + * Constructs a new GetBreakTypeRequest. + * A request to GET a `BreakType` by ID + * @alias module:model/GetBreakTypeRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a GetBreakTypeRequest 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/GetBreakTypeRequest} obj Optional instance to populate. + * @return {module:model/GetBreakTypeRequest} The populated GetBreakTypeRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/GetBreakTypeResponse.js b/src/model/GetBreakTypeResponse.js new file mode 100644 index 0000000..f7f88d4 --- /dev/null +++ b/src/model/GetBreakTypeResponse.js @@ -0,0 +1,76 @@ +/** + * 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 BreakType = require('./BreakType'); +var Error = require('./Error'); + + + + +/** + * The GetBreakTypeResponse model module. + * @module model/GetBreakTypeResponse + */ + +/** + * Constructs a new GetBreakTypeResponse. + * The response to a request to get a `BreakType`. Contains the requested `BreakType` objects. May contain a set of `Error` objects if the request resulted in errors. + * @alias module:model/GetBreakTypeResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a GetBreakTypeResponse 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/GetBreakTypeResponse} obj Optional instance to populate. + * @return {module:model/GetBreakTypeResponse} The populated GetBreakTypeResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('break_type')) { + obj['break_type'] = BreakType.constructFromObject(data['break_type']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The response object. + * @member {module:model/BreakType} break_type + */ +exports.prototype['break_type'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/GetEmployeeWageRequest.js b/src/model/GetEmployeeWageRequest.js new file mode 100644 index 0000000..3aa4023 --- /dev/null +++ b/src/model/GetEmployeeWageRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The GetEmployeeWageRequest model module. + * @module model/GetEmployeeWageRequest + */ + +/** + * Constructs a new GetEmployeeWageRequest. + * A request to get an `EmployeeWage` + * @alias module:model/GetEmployeeWageRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a GetEmployeeWageRequest 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/GetEmployeeWageRequest} obj Optional instance to populate. + * @return {module:model/GetEmployeeWageRequest} The populated GetEmployeeWageRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/GetEmployeeWageResponse.js b/src/model/GetEmployeeWageResponse.js new file mode 100644 index 0000000..c610295 --- /dev/null +++ b/src/model/GetEmployeeWageResponse.js @@ -0,0 +1,76 @@ +/** + * 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 EmployeeWage = require('./EmployeeWage'); +var Error = require('./Error'); + + + + +/** + * The GetEmployeeWageResponse model module. + * @module model/GetEmployeeWageResponse + */ + +/** + * Constructs a new GetEmployeeWageResponse. + * 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. + * @alias module:model/GetEmployeeWageResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a GetEmployeeWageResponse 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/GetEmployeeWageResponse} obj Optional instance to populate. + * @return {module:model/GetEmployeeWageResponse} The populated GetEmployeeWageResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('employee_wage')) { + obj['employee_wage'] = EmployeeWage.constructFromObject(data['employee_wage']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The requested `EmployeeWage` object. + * @member {module:model/EmployeeWage} employee_wage + */ +exports.prototype['employee_wage'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/GetShiftRequest.js b/src/model/GetShiftRequest.js new file mode 100644 index 0000000..1834708 --- /dev/null +++ b/src/model/GetShiftRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The GetShiftRequest model module. + * @module model/GetShiftRequest + */ + +/** + * Constructs a new GetShiftRequest. + * A request to get a `Shift` by ID + * @alias module:model/GetShiftRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a GetShiftRequest 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/GetShiftRequest} obj Optional instance to populate. + * @return {module:model/GetShiftRequest} The populated GetShiftRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/GetShiftResponse.js b/src/model/GetShiftResponse.js new file mode 100644 index 0000000..3de9274 --- /dev/null +++ b/src/model/GetShiftResponse.js @@ -0,0 +1,76 @@ +/** + * 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 Shift = require('./Shift'); + + + + +/** + * The GetShiftResponse model module. + * @module model/GetShiftResponse + */ + +/** + * Constructs a new GetShiftResponse. + * A response to request to get a `Shift`. Contains the requested `Shift` object. May contain a set of `Error` objects if the request resulted in errors. + * @alias module:model/GetShiftResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a GetShiftResponse 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/GetShiftResponse} obj Optional instance to populate. + * @return {module:model/GetShiftResponse} The populated GetShiftResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('shift')) { + obj['shift'] = Shift.constructFromObject(data['shift']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The requested `Shift`. + * @member {module:model/Shift} shift + */ +exports.prototype['shift'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/ListAdditionalRecipientReceivableRefundsRequest.js b/src/model/ListAdditionalRecipientReceivableRefundsRequest.js index 1ee388f..5b5d668 100644 --- a/src/model/ListAdditionalRecipientReceivableRefundsRequest.js +++ b/src/model/ListAdditionalRecipientReceivableRefundsRequest.js @@ -79,7 +79,7 @@ exports.prototype['end_time'] = undefined; */ 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. + * 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 [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/ListAdditionalRecipientReceivableRefundsResponse.js b/src/model/ListAdditionalRecipientReceivableRefundsResponse.js index dce9569..c53c468 100644 --- a/src/model/ListAdditionalRecipientReceivableRefundsResponse.js +++ b/src/model/ListAdditionalRecipientReceivableRefundsResponse.js @@ -72,7 +72,7 @@ exports.prototype['errors'] = undefined; */ exports.prototype['receivable_refunds'] = undefined; /** - * 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. + * 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 [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/ListAdditionalRecipientReceivablesRequest.js b/src/model/ListAdditionalRecipientReceivablesRequest.js index 46f9662..28f8373 100644 --- a/src/model/ListAdditionalRecipientReceivablesRequest.js +++ b/src/model/ListAdditionalRecipientReceivablesRequest.js @@ -79,7 +79,7 @@ exports.prototype['end_time'] = undefined; */ 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. + * 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 [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/ListAdditionalRecipientReceivablesResponse.js b/src/model/ListAdditionalRecipientReceivablesResponse.js index 4185df1..edc19b5 100644 --- a/src/model/ListAdditionalRecipientReceivablesResponse.js +++ b/src/model/ListAdditionalRecipientReceivablesResponse.js @@ -72,7 +72,7 @@ exports.prototype['errors'] = undefined; */ exports.prototype['receivables'] = undefined; /** - * 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. + * 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 [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/ListBreakTypesRequest.js b/src/model/ListBreakTypesRequest.js new file mode 100644 index 0000000..4889362 --- /dev/null +++ b/src/model/ListBreakTypesRequest.js @@ -0,0 +1,83 @@ +/** + * 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'); + + + + +/** + * The ListBreakTypesRequest model module. + * @module model/ListBreakTypesRequest + */ + +/** + * Constructs a new ListBreakTypesRequest. + * A request for a filtered set of `BreakType` objects + * @alias module:model/ListBreakTypesRequest + * @class + */ +var exports = function() { + var _this = this; + + + + +}; + +/** + * Constructs a ListBreakTypesRequest 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/ListBreakTypesRequest} obj Optional instance to populate. + * @return {module:model/ListBreakTypesRequest} The populated ListBreakTypesRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('location_id')) { + obj['location_id'] = ApiClient.convertToType(data['location_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 Break Types returned to only those that are associated with the specified location. + * @member {String} location_id + */ +exports.prototype['location_id'] = undefined; +/** + * Maximum number of Break Types 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 Break Type results to fetch. + * @member {String} cursor + */ +exports.prototype['cursor'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/ListBreakTypesResponse.js b/src/model/ListBreakTypesResponse.js new file mode 100644 index 0000000..feed02d --- /dev/null +++ b/src/model/ListBreakTypesResponse.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 BreakType = require('./BreakType'); +var Error = require('./Error'); + + + + +/** + * The ListBreakTypesResponse model module. + * @module model/ListBreakTypesResponse + */ + +/** + * Constructs a new ListBreakTypesResponse. + * The response to a request for a set of `BreakTypes`. Contains the requested `BreakType` objects. May contain a set of `Error` objects if the request resulted in errors. + * @alias module:model/ListBreakTypesResponse + * @class + */ +var exports = function() { + var _this = this; + + + + +}; + +/** + * Constructs a ListBreakTypesResponse 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/ListBreakTypesResponse} obj Optional instance to populate. + * @return {module:model/ListBreakTypesResponse} The populated ListBreakTypesResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('break_types')) { + obj['break_types'] = ApiClient.convertToType(data['break_types'], [BreakType]); + } + 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 `BreakType` results. + * @member {Array.} break_types + */ +exports.prototype['break_types'] = undefined; +/** + * Value supplied in the subsequent request to fetch the next next page of Break Type results. + * @member {String} cursor + */ +exports.prototype['cursor'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/ListCatalogRequest.js b/src/model/ListCatalogRequest.js index 2de8471..993b9d7 100644 --- a/src/model/ListCatalogRequest.js +++ b/src/model/ListCatalogRequest.js @@ -56,7 +56,7 @@ exports.constructFromObject = function(data, obj) { } /** - * The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information. + * The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/ListCatalogResponse.js b/src/model/ListCatalogResponse.js index dafa8be..daed025 100644 --- a/src/model/ListCatalogResponse.js +++ b/src/model/ListCatalogResponse.js @@ -67,7 +67,7 @@ exports.constructFromObject = function(data, obj) { */ exports.prototype['errors'] = undefined; /** - * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Paginating results](#paginatingresults) for more information. + * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/ListCustomersRequest.js b/src/model/ListCustomersRequest.js index cb3f822..429079f 100644 --- a/src/model/ListCustomersRequest.js +++ b/src/model/ListCustomersRequest.js @@ -60,7 +60,7 @@ exports.constructFromObject = function(data, obj) { } /** - * 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. + * 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 [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/ListCustomersResponse.js b/src/model/ListCustomersResponse.js index 5da5cf8..c447623 100644 --- a/src/model/ListCustomersResponse.js +++ b/src/model/ListCustomersResponse.js @@ -72,7 +72,7 @@ exports.prototype['errors'] = undefined; */ exports.prototype['customers'] = undefined; /** - * A pagination cursor to retrieve the next set of results for your original query to the endpoint. This value is present only if the request succeeded and additional results are available. See [Paginating results](#paginatingresults) for more information. + * A pagination cursor to retrieve the next set of results for your original query to the endpoint. This value is present only if the request succeeded and additional results are available. See [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/ListEmployeeWagesRequest.js b/src/model/ListEmployeeWagesRequest.js new file mode 100644 index 0000000..49f13bb --- /dev/null +++ b/src/model/ListEmployeeWagesRequest.js @@ -0,0 +1,83 @@ +/** + * 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'); + + + + +/** + * The ListEmployeeWagesRequest model module. + * @module model/ListEmployeeWagesRequest + */ + +/** + * Constructs a new ListEmployeeWagesRequest. + * A request for a set of `EmployeeWage` objects + * @alias module:model/ListEmployeeWagesRequest + * @class + */ +var exports = function() { + var _this = this; + + + + +}; + +/** + * Constructs a ListEmployeeWagesRequest 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/ListEmployeeWagesRequest} obj Optional instance to populate. + * @return {module:model/ListEmployeeWagesRequest} The populated ListEmployeeWagesRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('employee_id')) { + obj['employee_id'] = ApiClient.convertToType(data['employee_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 employee. + * @member {String} employee_id + */ +exports.prototype['employee_id'] = undefined; +/** + * Maximum number of Employee 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/ListEmployeeWagesResponse.js b/src/model/ListEmployeeWagesResponse.js new file mode 100644 index 0000000..c991508 --- /dev/null +++ b/src/model/ListEmployeeWagesResponse.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 EmployeeWage = require('./EmployeeWage'); +var Error = require('./Error'); + + + + +/** + * The ListEmployeeWagesResponse model module. + * @module model/ListEmployeeWagesResponse + */ + +/** + * Constructs a new ListEmployeeWagesResponse. + * The response to a request for a set of `EmployeeWage` objects. Contains a set of `EmployeeWage`. + * @alias module:model/ListEmployeeWagesResponse + * @class + */ +var exports = function() { + var _this = this; + + + + +}; + +/** + * Constructs a ListEmployeeWagesResponse 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/ListEmployeeWagesResponse} obj Optional instance to populate. + * @return {module:model/ListEmployeeWagesResponse} The populated ListEmployeeWagesResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('employee_wages')) { + obj['employee_wages'] = ApiClient.convertToType(data['employee_wages'], [EmployeeWage]); + } + 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 Employee Wage results. + * @member {Array.} employee_wages + */ +exports.prototype['employee_wages'] = undefined; +/** + * Value supplied in the subsequent request to fetch the next next page of Employee Wage results. + * @member {String} cursor + */ +exports.prototype['cursor'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/ListEmployeesRequest.js b/src/model/ListEmployeesRequest.js new file mode 100644 index 0000000..5f9c496 --- /dev/null +++ b/src/model/ListEmployeesRequest.js @@ -0,0 +1,109 @@ +/** + * 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'); + + + + +/** + * The ListEmployeesRequest model module. + * @module model/ListEmployeesRequest + */ + +/** + * Constructs a new ListEmployeesRequest. + * Retrieve a paged-list of employees for a Square account + * @alias module:model/ListEmployeesRequest + * @class + */ +var exports = function() { + var _this = this; + + + + + +}; + +/** + * Constructs a ListEmployeesRequest 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/ListEmployeesRequest} obj Optional instance to populate. + * @return {module:model/ListEmployeesRequest} The populated ListEmployeesRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('location_id')) { + obj['location_id'] = ApiClient.convertToType(data['location_id'], 'String'); + } + if (data.hasOwnProperty('status')) { + obj['status'] = ApiClient.convertToType(data['status'], '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 employees returned to only those that are associated with the specified location. + * @member {String} location_id + */ +exports.prototype['location_id'] = undefined; +/** + * Specifies the EmployeeStatus to filter the employee by. + * @member {module:model/ListEmployeesRequest.StatusEnum} status + */ +exports.prototype['status'] = undefined; +/** + * The number of employees to be returned on each page. + * @member {Number} limit + */ +exports.prototype['limit'] = undefined; +/** + * The token required to retrieve the specified page of results. + * @member {String} cursor + */ +exports.prototype['cursor'] = undefined; + + + /** + * Allowed values for the status property. + * @enum {String} + * @readonly + */ + exports.StatusEnum = { + /** + * value: "ACTIVE" + * @const + */ + "ACTIVE": "ACTIVE", + /** + * value: "INACTIVE" + * @const + */ + "INACTIVE": "INACTIVE" }; + + +module.exports = exports; + + + diff --git a/src/model/ListEmployeesResponse.js b/src/model/ListEmployeesResponse.js new file mode 100644 index 0000000..d73255c --- /dev/null +++ b/src/model/ListEmployeesResponse.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 Employee = require('./Employee'); +var Error = require('./Error'); + + + + +/** + * The ListEmployeesResponse model module. + * @module model/ListEmployeesResponse + */ + +/** + * Constructs a new ListEmployeesResponse. + * Defines the fields that are included in the response body of a request to the [ListEmployees](#endpoint-listemployees) endpoint. One of `errors` or `employees` is present in a given response (never both). + * @alias module:model/ListEmployeesResponse + * @class + */ +var exports = function() { + var _this = this; + + + + +}; + +/** + * Constructs a ListEmployeesResponse 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/ListEmployeesResponse} obj Optional instance to populate. + * @return {module:model/ListEmployeesResponse} The populated ListEmployeesResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('employees')) { + obj['employees'] = ApiClient.convertToType(data['employees'], [Employee]); + } + if (data.hasOwnProperty('cursor')) { + obj['cursor'] = ApiClient.convertToType(data['cursor'], 'String'); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * List of employees returned from the request. + * @member {Array.} employees + */ +exports.prototype['employees'] = undefined; +/** + * The token to be used to retrieve the next page of results. + * @member {String} cursor + */ +exports.prototype['cursor'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/ListRefundsRequest.js b/src/model/ListRefundsRequest.js index e70bf29..e681130 100644 --- a/src/model/ListRefundsRequest.js +++ b/src/model/ListRefundsRequest.js @@ -79,7 +79,7 @@ exports.prototype['end_time'] = undefined; */ 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. + * 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 [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/ListRefundsResponse.js b/src/model/ListRefundsResponse.js index 068cb13..b81d834 100644 --- a/src/model/ListRefundsResponse.js +++ b/src/model/ListRefundsResponse.js @@ -72,7 +72,7 @@ exports.prototype['errors'] = undefined; */ exports.prototype['refunds'] = undefined; /** - * 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. + * 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 [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/ListTransactionsRequest.js b/src/model/ListTransactionsRequest.js index 5db1dc8..fecdc70 100644 --- a/src/model/ListTransactionsRequest.js +++ b/src/model/ListTransactionsRequest.js @@ -79,7 +79,7 @@ exports.prototype['end_time'] = undefined; */ 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. + * 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 [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/ListTransactionsResponse.js b/src/model/ListTransactionsResponse.js index 1eed566..192a4a4 100644 --- a/src/model/ListTransactionsResponse.js +++ b/src/model/ListTransactionsResponse.js @@ -72,7 +72,7 @@ exports.prototype['errors'] = undefined; */ exports.prototype['transactions'] = undefined; /** - * 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. + * 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 [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/ListWorkweekConfigsRequest.js b/src/model/ListWorkweekConfigsRequest.js new file mode 100644 index 0000000..e9ed693 --- /dev/null +++ b/src/model/ListWorkweekConfigsRequest.js @@ -0,0 +1,74 @@ +/** + * 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'); + + + + +/** + * The ListWorkweekConfigsRequest model module. + * @module model/ListWorkweekConfigsRequest + */ + +/** + * Constructs a new ListWorkweekConfigsRequest. + * A request for a set of `WorkweekConfig` objects + * @alias module:model/ListWorkweekConfigsRequest + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a ListWorkweekConfigsRequest 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/ListWorkweekConfigsRequest} obj Optional instance to populate. + * @return {module:model/ListWorkweekConfigsRequest} The populated ListWorkweekConfigsRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('limit')) { + obj['limit'] = ApiClient.convertToType(data['limit'], 'Number'); + } + if (data.hasOwnProperty('cursor')) { + obj['cursor'] = ApiClient.convertToType(data['cursor'], 'String'); + } + } + return obj; +} + +/** + * Maximum number of Workweek Configs to return per page. + * @member {Number} limit + */ +exports.prototype['limit'] = undefined; +/** + * Pointer to the next page of Workweek Config results to fetch. + * @member {String} cursor + */ +exports.prototype['cursor'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/ListWorkweekConfigsResponse.js b/src/model/ListWorkweekConfigsResponse.js new file mode 100644 index 0000000..a5c94d0 --- /dev/null +++ b/src/model/ListWorkweekConfigsResponse.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 WorkweekConfig = require('./WorkweekConfig'); + + + + +/** + * The ListWorkweekConfigsResponse model module. + * @module model/ListWorkweekConfigsResponse + */ + +/** + * Constructs a new ListWorkweekConfigsResponse. + * The response to a request for a set of `WorkweekConfig` objects. Contains the requested `WorkweekConfig` objects. May contain a set of `Error` objects if the request resulted in errors. + * @alias module:model/ListWorkweekConfigsResponse + * @class + */ +var exports = function() { + var _this = this; + + + + +}; + +/** + * Constructs a ListWorkweekConfigsResponse 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/ListWorkweekConfigsResponse} obj Optional instance to populate. + * @return {module:model/ListWorkweekConfigsResponse} The populated ListWorkweekConfigsResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('workweek_configs')) { + obj['workweek_configs'] = ApiClient.convertToType(data['workweek_configs'], [WorkweekConfig]); + } + 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 Employee Wage results. + * @member {Array.} workweek_configs + */ +exports.prototype['workweek_configs'] = undefined; +/** + * Value supplied in the subsequent request to fetch the next page of Employee Wage results. + * @member {String} cursor + */ +exports.prototype['cursor'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/ModelBreak.js b/src/model/ModelBreak.js new file mode 100644 index 0000000..2d83a68 --- /dev/null +++ b/src/model/ModelBreak.js @@ -0,0 +1,124 @@ +/** + * 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'); + + + + +/** + * The ModelBreak model module. + * @module model/ModelBreak + */ + +/** + * Constructs a new ModelBreak. + * A record of an employee's break during a shift. + * @alias module:model/ModelBreak + * @class + * @param startAt {String} RFC 3339; follows same timezone info as `Shift`. Precision up to the minute is respected; seconds are truncated. + * @param breakTypeId {String} The `BreakType` this `Break` was templated on. + * @param name {String} A human-readable name. + * @param expectedDuration {String} Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of the break. + * @param isPaid {Boolean} Whether this break counts towards time worked for compensation purposes. + */ +var exports = function(startAt, breakTypeId, name, expectedDuration, isPaid) { + var _this = this; + + + _this['start_at'] = startAt; + + _this['break_type_id'] = breakTypeId; + _this['name'] = name; + _this['expected_duration'] = expectedDuration; + _this['is_paid'] = isPaid; +}; + +/** + * Constructs a ModelBreak 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/ModelBreak} obj Optional instance to populate. + * @return {module:model/ModelBreak} The populated ModelBreak 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('start_at')) { + obj['start_at'] = ApiClient.convertToType(data['start_at'], 'String'); + } + if (data.hasOwnProperty('end_at')) { + obj['end_at'] = ApiClient.convertToType(data['end_at'], 'String'); + } + if (data.hasOwnProperty('break_type_id')) { + obj['break_type_id'] = ApiClient.convertToType(data['break_type_id'], 'String'); + } + if (data.hasOwnProperty('name')) { + obj['name'] = ApiClient.convertToType(data['name'], 'String'); + } + if (data.hasOwnProperty('expected_duration')) { + obj['expected_duration'] = ApiClient.convertToType(data['expected_duration'], 'String'); + } + if (data.hasOwnProperty('is_paid')) { + obj['is_paid'] = ApiClient.convertToType(data['is_paid'], 'Boolean'); + } + } + return obj; +} + +/** + * UUID for this object + * @member {String} id + */ +exports.prototype['id'] = undefined; +/** + * RFC 3339; follows same timezone info as `Shift`. Precision up to the minute is respected; seconds are truncated. + * @member {String} start_at + */ +exports.prototype['start_at'] = undefined; +/** + * 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). + * @member {String} end_at + */ +exports.prototype['end_at'] = undefined; +/** + * The `BreakType` this `Break` was templated on. + * @member {String} break_type_id + */ +exports.prototype['break_type_id'] = undefined; +/** + * A human-readable name. + * @member {String} name + */ +exports.prototype['name'] = undefined; +/** + * Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of the break. + * @member {String} expected_duration + */ +exports.prototype['expected_duration'] = undefined; +/** + * Whether this break counts towards time worked for compensation purposes. + * @member {Boolean} is_paid + */ +exports.prototype['is_paid'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/ObtainTokenRequest.js b/src/model/ObtainTokenRequest.js index 41c8f92..1dffc44 100644 --- a/src/model/ObtainTokenRequest.js +++ b/src/model/ObtainTokenRequest.js @@ -34,6 +34,9 @@ var exports = function() { + + + }; /** @@ -58,23 +61,32 @@ exports.constructFromObject = function(data, obj) { } if (data.hasOwnProperty('redirect_uri')) { obj['redirect_uri'] = ApiClient.convertToType(data['redirect_uri'], 'String'); + } + if (data.hasOwnProperty('grant_type')) { + obj['grant_type'] = ApiClient.convertToType(data['grant_type'], 'String'); + } + if (data.hasOwnProperty('refresh_token')) { + obj['refresh_token'] = ApiClient.convertToType(data['refresh_token'], 'String'); + } + if (data.hasOwnProperty('migration_token')) { + obj['migration_token'] = ApiClient.convertToType(data['migration_token'], 'String'); } } return obj; } /** - * Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). + * The Square-issued ID of your application, available from the [application dashboard](https://connect.squareup.com/apps). * @member {String} client_id */ exports.prototype['client_id'] = undefined; /** - * Your application's secret, available from the [application dashboard](https://connect.squareup.com/apps). + * The Square-issued application secret for your application, available from the [application dashboard](https://connect.squareup.com/apps). * @member {String} client_secret */ exports.prototype['client_secret'] = undefined; /** - * The authorization code to exchange. + * The authorization code to exchange. This is required if `grant_type` is set to `authorization_code`, to indicate that the application wants to exchange an authorization code for an OAuth access token. * @member {String} code */ exports.prototype['code'] = undefined; @@ -83,6 +95,21 @@ exports.prototype['code'] = undefined; * @member {String} redirect_uri */ exports.prototype['redirect_uri'] = undefined; +/** + * Specifies the method to request an OAuth access token. Valid values are: `authorization_code`, `refresh_token`, and `migration_token` + * @member {String} grant_type + */ +exports.prototype['grant_type'] = undefined; +/** + * A valid refresh token for generating a new OAuth access token. A valid refresh token is required if `grant_type` is set to `refresh_token` , to indicate the application wants a replacement for an expired OAuth access token. + * @member {String} refresh_token + */ +exports.prototype['refresh_token'] = undefined; +/** + * Legacy OAuth access token obtained using a Connect API version prior to 2019-03-13. This parameter is required if `grant_type` is set to `migration_token` to indicate that the application wants to get a replacement OAuth access token. The response also returns a refresh token. For more information, see [Migrate to Using Refresh Tokens](/authz/oauth/migration). + * @member {String} migration_token + */ +exports.prototype['migration_token'] = undefined; diff --git a/src/model/ObtainTokenResponse.js b/src/model/ObtainTokenResponse.js index 8c0115c..98d8645 100644 --- a/src/model/ObtainTokenResponse.js +++ b/src/model/ObtainTokenResponse.js @@ -37,6 +37,7 @@ var exports = function() { + }; /** @@ -70,13 +71,16 @@ exports.constructFromObject = function(data, obj) { } if (data.hasOwnProperty('id_token')) { obj['id_token'] = ApiClient.convertToType(data['id_token'], 'String'); + } + if (data.hasOwnProperty('refresh_token')) { + obj['refresh_token'] = ApiClient.convertToType(data['refresh_token'], 'String'); } } return obj; } /** - * Your application's access token. You provide this token in a header with every request to Connect API endpoints. See [Request and response headers](https://docs.connect.squareup.com/api/connect/v2/#requestandresponseheaders) for the format of this header. + * A valid OAuth access token. Provide the access token in a header with every request to Connect API endpoints. See the [Build with OAuth](/authz/oauth/build-with-the-api) guide for more information. * @member {String} access_token */ exports.prototype['access_token'] = undefined; @@ -96,7 +100,7 @@ exports.prototype['expires_at'] = undefined; */ exports.prototype['merchant_id'] = undefined; /** - * The ID of the merchant [subscription](https://docs.connect.squareup.com/api/connect/v1/#navsection-subscriptionmanagement) associated with the authorization. Only present if the merchant signed up for a subscription during authorization. + * __Legacy field__. The ID of a subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization. * @member {String} subscription_id */ exports.prototype['subscription_id'] = undefined; @@ -110,6 +114,11 @@ exports.prototype['plan_id'] = undefined; * @member {String} id_token */ exports.prototype['id_token'] = undefined; +/** + * A refresh token. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). + * @member {String} refresh_token + */ +exports.prototype['refresh_token'] = undefined; diff --git a/src/model/RetrieveEmployeeRequest.js b/src/model/RetrieveEmployeeRequest.js new file mode 100644 index 0000000..74ad914 --- /dev/null +++ b/src/model/RetrieveEmployeeRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The RetrieveEmployeeRequest model module. + * @module model/RetrieveEmployeeRequest + */ + +/** + * Constructs a new RetrieveEmployeeRequest. + * Retrieve an employee by `Employee.id` + * @alias module:model/RetrieveEmployeeRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a RetrieveEmployeeRequest 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/RetrieveEmployeeRequest} obj Optional instance to populate. + * @return {module:model/RetrieveEmployeeRequest} The populated RetrieveEmployeeRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/RetrieveEmployeeResponse.js b/src/model/RetrieveEmployeeResponse.js new file mode 100644 index 0000000..3c39b92 --- /dev/null +++ b/src/model/RetrieveEmployeeResponse.js @@ -0,0 +1,76 @@ +/** + * 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 Employee = require('./Employee'); +var Error = require('./Error'); + + + + +/** + * The RetrieveEmployeeResponse model module. + * @module model/RetrieveEmployeeResponse + */ + +/** + * Constructs a new RetrieveEmployeeResponse. + * Defines the fields that are included in the response body of a request to the [RetrieveEmployee](#endpoint-retrieveemployee) endpoint. One of `errors` or `employee` is present in a given response (never both). + * @alias module:model/RetrieveEmployeeResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a RetrieveEmployeeResponse 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/RetrieveEmployeeResponse} obj Optional instance to populate. + * @return {module:model/RetrieveEmployeeResponse} The populated RetrieveEmployeeResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('employee')) { + obj['employee'] = Employee.constructFromObject(data['employee']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The response object. + * @member {module:model/Employee} employee + */ +exports.prototype['employee'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/RetrieveInventoryChangesRequest.js b/src/model/RetrieveInventoryChangesRequest.js index a2d9a6b..b185400 100644 --- a/src/model/RetrieveInventoryChangesRequest.js +++ b/src/model/RetrieveInventoryChangesRequest.js @@ -61,7 +61,7 @@ exports.constructFromObject = function(data, obj) { */ exports.prototype['location_ids'] = undefined; /** - * 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 [Paginating results](#paginatingresults) for more information. + * 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 [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/RetrieveInventoryChangesResponse.js b/src/model/RetrieveInventoryChangesResponse.js index 1889bb1..c57860d 100644 --- a/src/model/RetrieveInventoryChangesResponse.js +++ b/src/model/RetrieveInventoryChangesResponse.js @@ -72,7 +72,7 @@ exports.prototype['errors'] = undefined; */ exports.prototype['changes'] = undefined; /** - * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Paginating results](#paginatingresults) for more information. + * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/RetrieveInventoryCountRequest.js b/src/model/RetrieveInventoryCountRequest.js index c7c09d9..65f1614 100644 --- a/src/model/RetrieveInventoryCountRequest.js +++ b/src/model/RetrieveInventoryCountRequest.js @@ -61,7 +61,7 @@ exports.constructFromObject = function(data, obj) { */ exports.prototype['location_ids'] = undefined; /** - * 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 [Paginating results](#paginatingresults) for more information. + * 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 [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/RetrieveInventoryCountResponse.js b/src/model/RetrieveInventoryCountResponse.js index ff912a0..4357543 100644 --- a/src/model/RetrieveInventoryCountResponse.js +++ b/src/model/RetrieveInventoryCountResponse.js @@ -72,7 +72,7 @@ exports.prototype['errors'] = undefined; */ exports.prototype['counts'] = undefined; /** - * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Paginating results](#paginatingresults) for more information. + * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/SearchCatalogObjectsRequest.js b/src/model/SearchCatalogObjectsRequest.js index 056fddf..4580d56 100644 --- a/src/model/SearchCatalogObjectsRequest.js +++ b/src/model/SearchCatalogObjectsRequest.js @@ -77,7 +77,7 @@ exports.constructFromObject = function(data, obj) { } /** - * The pagination cursor returned in the previous response. Leave unset for an initial request. See [Paginating results](#paginatingresults) for more information. + * The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/SearchCatalogObjectsResponse.js b/src/model/SearchCatalogObjectsResponse.js index 77523e2..de1ff10 100644 --- a/src/model/SearchCatalogObjectsResponse.js +++ b/src/model/SearchCatalogObjectsResponse.js @@ -71,7 +71,7 @@ exports.constructFromObject = function(data, obj) { */ exports.prototype['errors'] = undefined; /** - * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Paginating results](#paginatingresults) for more information. + * The pagination cursor to be used in a subsequent request. If unset, this is the final response. See [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/SearchCustomersRequest.js b/src/model/SearchCustomersRequest.js index 9390d1c..3ffbba2 100644 --- a/src/model/SearchCustomersRequest.js +++ b/src/model/SearchCustomersRequest.js @@ -61,7 +61,7 @@ exports.constructFromObject = function(data, obj) { } /** - * Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See [Paginating results](#paginatingresults) for more information. + * Include the pagination cursor in subsequent calls to this endpoint to retrieve the next set of results associated with the original query. See [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/SearchCustomersResponse.js b/src/model/SearchCustomersResponse.js index 4358775..8f924e0 100644 --- a/src/model/SearchCustomersResponse.js +++ b/src/model/SearchCustomersResponse.js @@ -72,7 +72,7 @@ exports.prototype['errors'] = undefined; */ exports.prototype['customers'] = undefined; /** - * A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See [Paginating results](#paginatingresults) for more information. + * A pagination cursor that can be used during subsequent calls to SearchCustomers to retrieve the next set of results associated with the original query. Pagination cursors are only present when a request succeeds and additional results are available. See [Pagination](/basics/api101/pagination) for more information. * @member {String} cursor */ exports.prototype['cursor'] = undefined; diff --git a/src/model/SearchShiftsRequest.js b/src/model/SearchShiftsRequest.js new file mode 100644 index 0000000..e5745f0 --- /dev/null +++ b/src/model/SearchShiftsRequest.js @@ -0,0 +1,84 @@ +/** + * 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 ShiftQuery = require('./ShiftQuery'); + + + + +/** + * The SearchShiftsRequest model module. + * @module model/SearchShiftsRequest + */ + +/** + * Constructs a new SearchShiftsRequest. + * A request for a filtered and sorted set of `Shift` objects. + * @alias module:model/SearchShiftsRequest + * @class + */ +var exports = function() { + var _this = this; + + + + +}; + +/** + * Constructs a SearchShiftsRequest 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/SearchShiftsRequest} obj Optional instance to populate. + * @return {module:model/SearchShiftsRequest} The populated SearchShiftsRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('query')) { + obj['query'] = ShiftQuery.constructFromObject(data['query']); + } + if (data.hasOwnProperty('limit')) { + obj['limit'] = ApiClient.convertToType(data['limit'], 'Number'); + } + if (data.hasOwnProperty('cursor')) { + obj['cursor'] = ApiClient.convertToType(data['cursor'], 'String'); + } + } + return obj; +} + +/** + * Query filters. + * @member {module:model/ShiftQuery} query + */ +exports.prototype['query'] = undefined; +/** + * number of resources in a page (200 by default). + * @member {Number} limit + */ +exports.prototype['limit'] = undefined; +/** + * opaque cursor for fetching the next page. + * @member {String} cursor + */ +exports.prototype['cursor'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/SearchShiftsResponse.js b/src/model/SearchShiftsResponse.js new file mode 100644 index 0000000..2c13ecc --- /dev/null +++ b/src/model/SearchShiftsResponse.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 Shift = require('./Shift'); + + + + +/** + * The SearchShiftsResponse model module. + * @module model/SearchShiftsResponse + */ + +/** + * Constructs a new SearchShiftsResponse. + * The response to a request for `Shift` objects. Contains the requested `Shift` objects. May contain a set of `Error` objects if the request resulted in errors. + * @alias module:model/SearchShiftsResponse + * @class + */ +var exports = function() { + var _this = this; + + + + +}; + +/** + * Constructs a SearchShiftsResponse 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/SearchShiftsResponse} obj Optional instance to populate. + * @return {module:model/SearchShiftsResponse} The populated SearchShiftsResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('shifts')) { + obj['shifts'] = ApiClient.convertToType(data['shifts'], [Shift]); + } + if (data.hasOwnProperty('cursor')) { + obj['cursor'] = ApiClient.convertToType(data['cursor'], 'String'); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * Shifts + * @member {Array.} shifts + */ +exports.prototype['shifts'] = undefined; +/** + * Opaque cursor for fetching the next page. + * @member {String} cursor + */ +exports.prototype['cursor'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/Shift.js b/src/model/Shift.js new file mode 100644 index 0000000..9a8d52b --- /dev/null +++ b/src/model/Shift.js @@ -0,0 +1,185 @@ +/** + * 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 ModelBreak = require('./ModelBreak'); +var ShiftWage = require('./ShiftWage'); + + + + +/** + * The Shift model module. + * @module model/Shift + */ + +/** + * Constructs a new Shift. + * A record of the hourly rate, start, and end times for a single work shift for an employee. May include a record of the start and end times for breaks taken during the shift. + * @alias module:model/Shift + * @class + * @param employeeId {String} The ID of the employee this shift belongs to. + * @param startAt {String} RFC 3339; shifted to location timezone + offset. Precision up to the minute is respected; seconds are truncated. + */ +var exports = function(employeeId, startAt) { + var _this = this; + + + _this['employee_id'] = employeeId; + + + _this['start_at'] = startAt; + + + + + + + +}; + +/** + * Constructs a Shift 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/Shift} obj Optional instance to populate. + * @return {module:model/Shift} The populated Shift 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('employee_id')) { + obj['employee_id'] = ApiClient.convertToType(data['employee_id'], 'String'); + } + if (data.hasOwnProperty('location_id')) { + obj['location_id'] = ApiClient.convertToType(data['location_id'], 'String'); + } + if (data.hasOwnProperty('timezone')) { + obj['timezone'] = ApiClient.convertToType(data['timezone'], 'String'); + } + if (data.hasOwnProperty('start_at')) { + obj['start_at'] = ApiClient.convertToType(data['start_at'], 'String'); + } + if (data.hasOwnProperty('end_at')) { + obj['end_at'] = ApiClient.convertToType(data['end_at'], 'String'); + } + if (data.hasOwnProperty('wage')) { + obj['wage'] = ShiftWage.constructFromObject(data['wage']); + } + if (data.hasOwnProperty('breaks')) { + obj['breaks'] = ApiClient.convertToType(data['breaks'], [ModelBreak]); + } + if (data.hasOwnProperty('status')) { + obj['status'] = ApiClient.convertToType(data['status'], 'String'); + } + if (data.hasOwnProperty('version')) { + obj['version'] = ApiClient.convertToType(data['version'], 'Number'); + } + if (data.hasOwnProperty('created_at')) { + obj['created_at'] = ApiClient.convertToType(data['created_at'], 'String'); + } + if (data.hasOwnProperty('updated_at')) { + obj['updated_at'] = ApiClient.convertToType(data['updated_at'], 'String'); + } + } + return obj; +} + +/** + * UUID for this object + * @member {String} id + */ +exports.prototype['id'] = undefined; +/** + * The ID of the employee this shift belongs to. + * @member {String} employee_id + */ +exports.prototype['employee_id'] = undefined; +/** + * The ID of the location this shift occurred at. Should be based on where the employee clocked in. + * @member {String} location_id + */ +exports.prototype['location_id'] = undefined; +/** + * Read-only convenience value that is calculated from the location based on `location_id`. Format: the IANA Timezone Database identifier for the location timezone. + * @member {String} timezone + */ +exports.prototype['timezone'] = undefined; +/** + * RFC 3339; shifted to location timezone + offset. Precision up to the minute is respected; seconds are truncated. + * @member {String} start_at + */ +exports.prototype['start_at'] = undefined; +/** + * 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). + * @member {String} end_at + */ +exports.prototype['end_at'] = undefined; +/** + * Job and pay related information. + * @member {module:model/ShiftWage} wage + */ +exports.prototype['wage'] = undefined; +/** + * A list of any paid or unpaid breaks that were taken during this shift. + * @member {Array.} breaks + */ +exports.prototype['breaks'] = undefined; +/** + * Describes working state of the current `Shift`. + * @member {module:model/Shift.StatusEnum} status + */ +exports.prototype['status'] = undefined; +/** + * 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. + * @member {Number} version + */ +exports.prototype['version'] = undefined; +/** + * A read-only timestamp in RFC 3339 format; presented in UTC. + * @member {String} created_at + */ +exports.prototype['created_at'] = undefined; +/** + * A read-only timestamp in RFC 3339 format; presented in UTC. + * @member {String} updated_at + */ +exports.prototype['updated_at'] = undefined; + + + /** + * Allowed values for the status property. + * @enum {String} + * @readonly + */ + exports.StatusEnum = { + /** + * value: "OPEN" + * @const + */ + "OPEN": "OPEN", + /** + * value: "CLOSED" + * @const + */ + "CLOSED": "CLOSED" }; + + +module.exports = exports; + + + diff --git a/src/model/ShiftFilter.js b/src/model/ShiftFilter.js new file mode 100644 index 0000000..7c29c06 --- /dev/null +++ b/src/model/ShiftFilter.js @@ -0,0 +1,129 @@ +/** + * 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 ShiftWorkday = require('./ShiftWorkday'); +var TimeRange = require('./TimeRange'); + + + + +/** + * The ShiftFilter model module. + * @module model/ShiftFilter + */ + +/** + * Constructs a new ShiftFilter. + * Defines a filter used in a search for `Shift` records. `AND` logic is used by Square's servers to apply each filter property specified. + * @alias module:model/ShiftFilter + * @class + */ +var exports = function() { + var _this = this; + + + + + + + +}; + +/** + * Constructs a ShiftFilter 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/ShiftFilter} obj Optional instance to populate. + * @return {module:model/ShiftFilter} The populated ShiftFilter instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('location_id')) { + obj['location_id'] = ApiClient.convertToType(data['location_id'], ['String']); + } + if (data.hasOwnProperty('employee_id')) { + obj['employee_id'] = ApiClient.convertToType(data['employee_id'], ['String']); + } + if (data.hasOwnProperty('status')) { + obj['status'] = ApiClient.convertToType(data['status'], 'String'); + } + if (data.hasOwnProperty('start')) { + obj['start'] = TimeRange.constructFromObject(data['start']); + } + if (data.hasOwnProperty('end')) { + obj['end'] = TimeRange.constructFromObject(data['end']); + } + if (data.hasOwnProperty('workday')) { + obj['workday'] = ShiftWorkday.constructFromObject(data['workday']); + } + } + return obj; +} + +/** + * Fetch shifts for the specified location. + * @member {Array.} location_id + */ +exports.prototype['location_id'] = undefined; +/** + * Fetch shifts for the specified employee. + * @member {Array.} employee_id + */ +exports.prototype['employee_id'] = undefined; +/** + * Fetch a `Shift` instance by `Shift.status`. + * @member {module:model/ShiftFilter.StatusEnum} status + */ +exports.prototype['status'] = undefined; +/** + * Fetch `Shift`s that start in the time range - Inclusive. + * @member {module:model/TimeRange} start + */ +exports.prototype['start'] = undefined; +/** + * Fetch the `Shift`s that end in the time range - Inclusive. + * @member {module:model/TimeRange} end + */ +exports.prototype['end'] = undefined; +/** + * Fetch the `Shift`s based on workday date range. + * @member {module:model/ShiftWorkday} workday + */ +exports.prototype['workday'] = undefined; + + + /** + * Allowed values for the status property. + * @enum {String} + * @readonly + */ + exports.StatusEnum = { + /** + * value: "OPEN" + * @const + */ + "OPEN": "OPEN", + /** + * value: "CLOSED" + * @const + */ + "CLOSED": "CLOSED" }; + + +module.exports = exports; + + + diff --git a/src/model/ShiftFilterStatus.js b/src/model/ShiftFilterStatus.js new file mode 100644 index 0000000..a7cad0b --- /dev/null +++ b/src/model/ShiftFilterStatus.js @@ -0,0 +1,45 @@ +/** + * 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 ShiftFilterStatus. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "OPEN" + * @const + */ + "OPEN": "OPEN", + /** + * value: "CLOSED" + * @const + */ + "CLOSED": "CLOSED"}; + +/** + * Returns a ShiftFilterStatus enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/ShiftFilterStatus} The enum ShiftFilterStatus value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/ShiftQuery.js b/src/model/ShiftQuery.js new file mode 100644 index 0000000..2c5b1d9 --- /dev/null +++ b/src/model/ShiftQuery.js @@ -0,0 +1,76 @@ +/** + * 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 ShiftFilter = require('./ShiftFilter'); +var ShiftSort = require('./ShiftSort'); + + + + +/** + * The ShiftQuery model module. + * @module model/ShiftQuery + */ + +/** + * Constructs a new ShiftQuery. + * The parameters of a `Shift` search query. Includes filter and sort options. + * @alias module:model/ShiftQuery + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a ShiftQuery 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/ShiftQuery} obj Optional instance to populate. + * @return {module:model/ShiftQuery} The populated ShiftQuery instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('filter')) { + obj['filter'] = ShiftFilter.constructFromObject(data['filter']); + } + if (data.hasOwnProperty('sort')) { + obj['sort'] = ShiftSort.constructFromObject(data['sort']); + } + } + return obj; +} + +/** + * Query filter options + * @member {module:model/ShiftFilter} filter + */ +exports.prototype['filter'] = undefined; +/** + * Sort order details + * @member {module:model/ShiftSort} sort + */ +exports.prototype['sort'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/ShiftSort.js b/src/model/ShiftSort.js new file mode 100644 index 0000000..5441f81 --- /dev/null +++ b/src/model/ShiftSort.js @@ -0,0 +1,118 @@ +/** + * 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'); + + + + +/** + * The ShiftSort model module. + * @module model/ShiftSort + */ + +/** + * Constructs a new ShiftSort. + * Sets the sort order of search results. + * @alias module:model/ShiftSort + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a ShiftSort 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/ShiftSort} obj Optional instance to populate. + * @return {module:model/ShiftSort} The populated ShiftSort instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('field')) { + obj['field'] = ApiClient.convertToType(data['field'], 'String'); + } + if (data.hasOwnProperty('order')) { + obj['order'] = ApiClient.convertToType(data['order'], 'String'); + } + } + return obj; +} + +/** + * The field to sort on. + * @member {module:model/ShiftSort.FieldEnum} field + */ +exports.prototype['field'] = undefined; +/** + * The order in which results are returned. Defaults to DESC. + * @member {module:model/ShiftSort.OrderEnum} order + */ +exports.prototype['order'] = undefined; + + + /** + * Allowed values for the field property. + * @enum {String} + * @readonly + */ + exports.FieldEnum = { + /** + * value: "START_AT" + * @const + */ + "START_AT": "START_AT", + /** + * value: "END_AT" + * @const + */ + "END_AT": "END_AT", + /** + * value: "CREATED_AT" + * @const + */ + "CREATED_AT": "CREATED_AT", + /** + * value: "UPDATED_AT" + * @const + */ + "UPDATED_AT": "UPDATED_AT" }; + + /** + * Allowed values for the order property. + * @enum {String} + * @readonly + */ + exports.OrderEnum = { + /** + * value: "DESC" + * @const + */ + "DESC": "DESC", + /** + * value: "ASC" + * @const + */ + "ASC": "ASC" }; + + +module.exports = exports; + + + diff --git a/src/model/ShiftSortField.js b/src/model/ShiftSortField.js new file mode 100644 index 0000000..748fa63 --- /dev/null +++ b/src/model/ShiftSortField.js @@ -0,0 +1,55 @@ +/** + * 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 ShiftSortField. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "START_AT" + * @const + */ + "START_AT": "START_AT", + /** + * value: "END_AT" + * @const + */ + "END_AT": "END_AT", + /** + * value: "CREATED_AT" + * @const + */ + "CREATED_AT": "CREATED_AT", + /** + * value: "UPDATED_AT" + * @const + */ + "UPDATED_AT": "UPDATED_AT"}; + +/** + * Returns a ShiftSortField enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/ShiftSortField} The enum ShiftSortField value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/ShiftStatus.js b/src/model/ShiftStatus.js new file mode 100644 index 0000000..5873636 --- /dev/null +++ b/src/model/ShiftStatus.js @@ -0,0 +1,45 @@ +/** + * 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 ShiftStatus. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "OPEN" + * @const + */ + "OPEN": "OPEN", + /** + * value: "CLOSED" + * @const + */ + "CLOSED": "CLOSED"}; + +/** + * Returns a ShiftStatus enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/ShiftStatus} The enum ShiftStatus value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/ShiftWage.js b/src/model/ShiftWage.js new file mode 100644 index 0000000..1279766 --- /dev/null +++ b/src/model/ShiftWage.js @@ -0,0 +1,75 @@ +/** + * 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 ShiftWage model module. + * @module model/ShiftWage + */ + +/** + * Constructs a new ShiftWage. + * The hourly wage rate used to compensate an employee for this shift. + * @alias module:model/ShiftWage + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a ShiftWage 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/ShiftWage} obj Optional instance to populate. + * @return {module:model/ShiftWage} The populated ShiftWage instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + 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; +} + +/** + * The name of the job performed during this shift. Square labor-reporting UIs may group shifts together by title. + * @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/ShiftWorkday.js b/src/model/ShiftWorkday.js new file mode 100644 index 0000000..2aa0aaa --- /dev/null +++ b/src/model/ShiftWorkday.js @@ -0,0 +1,106 @@ +/** + * 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 DateRange = require('./DateRange'); + + + + +/** + * The ShiftWorkday model module. + * @module model/ShiftWorkday + */ + +/** + * Constructs a new 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. + * @alias module:model/ShiftWorkday + * @class + */ +var exports = function() { + var _this = this; + + + + +}; + +/** + * Constructs a ShiftWorkday 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/ShiftWorkday} obj Optional instance to populate. + * @return {module:model/ShiftWorkday} The populated ShiftWorkday instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('date_range')) { + obj['date_range'] = DateRange.constructFromObject(data['date_range']); + } + if (data.hasOwnProperty('match_shifts_by')) { + obj['match_shifts_by'] = ApiClient.convertToType(data['match_shifts_by'], 'String'); + } + if (data.hasOwnProperty('default_timezone')) { + obj['default_timezone'] = ApiClient.convertToType(data['default_timezone'], 'String'); + } + } + return obj; +} + +/** + * Dates for fetching the shifts + * @member {module:model/DateRange} date_range + */ +exports.prototype['date_range'] = undefined; +/** + * The strategy on which the dates are applied. + * @member {module:model/ShiftWorkday.MatchShiftsByEnum} match_shifts_by + */ +exports.prototype['match_shifts_by'] = undefined; +/** + * Location-specific timezones convert workdays to datetime filters. Every location included in the query must have a timezone, or this field must be provided as a fallback. Format: the IANA timezone database identifier for the relevant timezone. + * @member {String} default_timezone + */ +exports.prototype['default_timezone'] = undefined; + + + /** + * Allowed values for the match_shifts_by property. + * @enum {String} + * @readonly + */ + exports.MatchShiftsByEnum = { + /** + * value: "START_AT" + * @const + */ + "START_AT": "START_AT", + /** + * value: "END_AT" + * @const + */ + "END_AT": "END_AT", + /** + * value: "INTERSECTION" + * @const + */ + "INTERSECTION": "INTERSECTION" }; + + +module.exports = exports; + + + diff --git a/src/model/ShiftWorkdayMatcher.js b/src/model/ShiftWorkdayMatcher.js new file mode 100644 index 0000000..079aae6 --- /dev/null +++ b/src/model/ShiftWorkdayMatcher.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 ShiftWorkdayMatcher. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "START_AT" + * @const + */ + "START_AT": "START_AT", + /** + * value: "END_AT" + * @const + */ + "END_AT": "END_AT", + /** + * value: "INTERSECTION" + * @const + */ + "INTERSECTION": "INTERSECTION"}; + +/** + * Returns a ShiftWorkdayMatcher enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/ShiftWorkdayMatcher} The enum ShiftWorkdayMatcher value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/UpdateBreakTypeRequest.js b/src/model/UpdateBreakTypeRequest.js new file mode 100644 index 0000000..2f9df2e --- /dev/null +++ b/src/model/UpdateBreakTypeRequest.js @@ -0,0 +1,66 @@ +/** + * 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 BreakType = require('./BreakType'); + + + + +/** + * The UpdateBreakTypeRequest model module. + * @module model/UpdateBreakTypeRequest + */ + +/** + * Constructs a new UpdateBreakTypeRequest. + * A request to update a `BreakType` + * @alias module:model/UpdateBreakTypeRequest + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a UpdateBreakTypeRequest 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/UpdateBreakTypeRequest} obj Optional instance to populate. + * @return {module:model/UpdateBreakTypeRequest} The populated UpdateBreakTypeRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('break_type')) { + obj['break_type'] = BreakType.constructFromObject(data['break_type']); + } + } + return obj; +} + +/** + * The updated `BreakType`. + * @member {module:model/BreakType} break_type + */ +exports.prototype['break_type'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/UpdateBreakTypeResponse.js b/src/model/UpdateBreakTypeResponse.js new file mode 100644 index 0000000..271d99b --- /dev/null +++ b/src/model/UpdateBreakTypeResponse.js @@ -0,0 +1,76 @@ +/** + * 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 BreakType = require('./BreakType'); +var Error = require('./Error'); + + + + +/** + * The UpdateBreakTypeResponse model module. + * @module model/UpdateBreakTypeResponse + */ + +/** + * Constructs a new UpdateBreakTypeResponse. + * A response to a request to update a `BreakType`. Contains the requested `BreakType` objects. May contain a set of `Error` objects if the request resulted in errors. + * @alias module:model/UpdateBreakTypeResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a UpdateBreakTypeResponse 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/UpdateBreakTypeResponse} obj Optional instance to populate. + * @return {module:model/UpdateBreakTypeResponse} The populated UpdateBreakTypeResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('break_type')) { + obj['break_type'] = BreakType.constructFromObject(data['break_type']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The response object. + * @member {module:model/BreakType} break_type + */ +exports.prototype['break_type'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/UpdateShiftRequest.js b/src/model/UpdateShiftRequest.js new file mode 100644 index 0000000..cb05ab4 --- /dev/null +++ b/src/model/UpdateShiftRequest.js @@ -0,0 +1,67 @@ +/** + * 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 Shift = require('./Shift'); + + + + +/** + * The UpdateShiftRequest model module. + * @module model/UpdateShiftRequest + */ + +/** + * Constructs a new UpdateShiftRequest. + * A request to update a `Shift` object. + * @alias module:model/UpdateShiftRequest + * @class + * @param shift {module:model/Shift} The updated `Shift` object. + */ +var exports = function(shift) { + var _this = this; + + _this['shift'] = shift; +}; + +/** + * Constructs a UpdateShiftRequest 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/UpdateShiftRequest} obj Optional instance to populate. + * @return {module:model/UpdateShiftRequest} The populated UpdateShiftRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('shift')) { + obj['shift'] = Shift.constructFromObject(data['shift']); + } + } + return obj; +} + +/** + * The updated `Shift` object. + * @member {module:model/Shift} shift + */ +exports.prototype['shift'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/UpdateShiftResponse.js b/src/model/UpdateShiftResponse.js new file mode 100644 index 0000000..cba3568 --- /dev/null +++ b/src/model/UpdateShiftResponse.js @@ -0,0 +1,76 @@ +/** + * 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 Shift = require('./Shift'); + + + + +/** + * The UpdateShiftResponse model module. + * @module model/UpdateShiftResponse + */ + +/** + * Constructs a new UpdateShiftResponse. + * The response to a request to update a `Shift`. Contains the updated `Shift` object. May contain a set of `Error` objects if the request resulted in errors. + * @alias module:model/UpdateShiftResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a UpdateShiftResponse 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/UpdateShiftResponse} obj Optional instance to populate. + * @return {module:model/UpdateShiftResponse} The populated UpdateShiftResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('shift')) { + obj['shift'] = Shift.constructFromObject(data['shift']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The updated `Shift`. + * @member {module:model/Shift} shift + */ +exports.prototype['shift'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/UpdateWorkweekConfigRequest.js b/src/model/UpdateWorkweekConfigRequest.js new file mode 100644 index 0000000..30621d9 --- /dev/null +++ b/src/model/UpdateWorkweekConfigRequest.js @@ -0,0 +1,66 @@ +/** + * 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 WorkweekConfig = require('./WorkweekConfig'); + + + + +/** + * The UpdateWorkweekConfigRequest model module. + * @module model/UpdateWorkweekConfigRequest + */ + +/** + * Constructs a new UpdateWorkweekConfigRequest. + * A request to update a `WorkweekConfig` object + * @alias module:model/UpdateWorkweekConfigRequest + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a UpdateWorkweekConfigRequest 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/UpdateWorkweekConfigRequest} obj Optional instance to populate. + * @return {module:model/UpdateWorkweekConfigRequest} The populated UpdateWorkweekConfigRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('workweek_config')) { + obj['workweek_config'] = WorkweekConfig.constructFromObject(data['workweek_config']); + } + } + return obj; +} + +/** + * The updated `WorkweekConfig` object. + * @member {module:model/WorkweekConfig} workweek_config + */ +exports.prototype['workweek_config'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/UpdateWorkweekConfigResponse.js b/src/model/UpdateWorkweekConfigResponse.js new file mode 100644 index 0000000..04ad50e --- /dev/null +++ b/src/model/UpdateWorkweekConfigResponse.js @@ -0,0 +1,76 @@ +/** + * 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 WorkweekConfig = require('./WorkweekConfig'); + + + + +/** + * The UpdateWorkweekConfigResponse model module. + * @module model/UpdateWorkweekConfigResponse + */ + +/** + * Constructs a new UpdateWorkweekConfigResponse. + * The response to a request to update a `WorkweekConfig` object. Contains the updated `WorkweekConfig` object. May contain a set of `Error` objects if the request resulted in errors. + * @alias module:model/UpdateWorkweekConfigResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a UpdateWorkweekConfigResponse 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/UpdateWorkweekConfigResponse} obj Optional instance to populate. + * @return {module:model/UpdateWorkweekConfigResponse} The populated UpdateWorkweekConfigResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('workweek_config')) { + obj['workweek_config'] = WorkweekConfig.constructFromObject(data['workweek_config']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The response object. + * @member {module:model/WorkweekConfig} workweek_config + */ +exports.prototype['workweek_config'] = undefined; +/** + * Any errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/UpsertCatalogObjectRequest.js b/src/model/UpsertCatalogObjectRequest.js index 0296ac0..a2399c6 100644 --- a/src/model/UpsertCatalogObjectRequest.js +++ b/src/model/UpsertCatalogObjectRequest.js @@ -27,7 +27,7 @@ var CatalogObject = require('./CatalogObject'); * * @alias module:model/UpsertCatalogObjectRequest * @class - * @param idempotencyKey {String} A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency keys](#idempotencykeys) for more information. + * @param idempotencyKey {String} A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency](/basics/api101/idempotency) for more information. * @param _object {module:model/CatalogObject} A [CatalogObject](#type-catalogobject) to be created or updated. The object's `is_deleted` field must not be set to `true`. When creating a new object, the object's ID must either start with a `#` character or be left blank. In either case it will be replaced with a server-generated ID. */ var exports = function(idempotencyKey, _object) { @@ -59,7 +59,7 @@ exports.constructFromObject = function(data, obj) { } /** - * A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency keys](#idempotencykeys) for more information. + * A value you specify that uniquely identifies this request among all your requests. A common way to create a valid idempotency key is to use a Universally unique identifier (UUID). If you're unsure whether a particular request was successful, you can reattempt it with the same idempotency key without worrying about creating duplicate objects. See [Idempotency](/basics/api101/idempotency) for more information. * @member {String} idempotency_key */ exports.prototype['idempotency_key'] = undefined; diff --git a/src/model/V1AdjustInventoryRequest.js b/src/model/V1AdjustInventoryRequest.js index ea9989f..c395b4f 100644 --- a/src/model/V1AdjustInventoryRequest.js +++ b/src/model/V1AdjustInventoryRequest.js @@ -23,6 +23,7 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new V1AdjustInventoryRequest. + * V1AdjustInventoryRequest * @alias module:model/V1AdjustInventoryRequest * @class */ @@ -64,7 +65,7 @@ exports.constructFromObject = function(data, obj) { */ exports.prototype['quantity_delta'] = undefined; /** - * The reason for the inventory adjustment. + * The reason for the inventory adjustment. See [V1AdjustInventoryRequestAdjustmentType](#type-v1adjustinventoryrequestadjustmenttype) for possible values * @member {module:model/V1AdjustInventoryRequest.AdjustmentTypeEnum} adjustment_type */ exports.prototype['adjustment_type'] = undefined; diff --git a/src/model/V1AdjustInventoryRequestAdjustmentType.js b/src/model/V1AdjustInventoryRequestAdjustmentType.js new file mode 100644 index 0000000..244bb8b --- /dev/null +++ b/src/model/V1AdjustInventoryRequestAdjustmentType.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 V1AdjustInventoryRequestAdjustmentType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "SALE" + * @const + */ + "SALE": "SALE", + /** + * value: "RECEIVE_STOCK" + * @const + */ + "RECEIVE_STOCK": "RECEIVE_STOCK", + /** + * value: "MANUAL_ADJUST" + * @const + */ + "MANUAL_ADJUST": "MANUAL_ADJUST"}; + +/** + * Returns a V1AdjustInventoryRequestAdjustmentType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1AdjustInventoryRequestAdjustmentType} The enum V1AdjustInventoryRequestAdjustmentType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1ApplyFeeRequest.js b/src/model/V1ApplyFeeRequest.js new file mode 100644 index 0000000..ff1ea81 --- /dev/null +++ b/src/model/V1ApplyFeeRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1ApplyFeeRequest model module. + * @module model/V1ApplyFeeRequest + */ + +/** + * Constructs a new V1ApplyFeeRequest. + * + * @alias module:model/V1ApplyFeeRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1ApplyFeeRequest 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/V1ApplyFeeRequest} obj Optional instance to populate. + * @return {module:model/V1ApplyFeeRequest} The populated V1ApplyFeeRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1ApplyModifierListRequest.js b/src/model/V1ApplyModifierListRequest.js new file mode 100644 index 0000000..4cc7ca6 --- /dev/null +++ b/src/model/V1ApplyModifierListRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1ApplyModifierListRequest model module. + * @module model/V1ApplyModifierListRequest + */ + +/** + * Constructs a new V1ApplyModifierListRequest. + * + * @alias module:model/V1ApplyModifierListRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1ApplyModifierListRequest 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/V1ApplyModifierListRequest} obj Optional instance to populate. + * @return {module:model/V1ApplyModifierListRequest} The populated V1ApplyModifierListRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1BankAccount.js b/src/model/V1BankAccount.js index e885ffa..4d0ce41 100644 --- a/src/model/V1BankAccount.js +++ b/src/model/V1BankAccount.js @@ -23,6 +23,7 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new V1BankAccount. + * V1BankAccount * @alias module:model/V1BankAccount * @class */ @@ -114,7 +115,7 @@ exports.prototype['account_number_suffix'] = undefined; */ exports.prototype['currency_code'] = undefined; /** - * The bank account's type (for example, savings or checking). + * The bank account's type (for example, savings or checking). See [V1BankAccountType](#type-v1bankaccounttype) for possible values * @member {module:model/V1BankAccount.TypeEnum} type */ exports.prototype['type'] = undefined; diff --git a/src/model/V1BankAccountType.js b/src/model/V1BankAccountType.js new file mode 100644 index 0000000..d108123 --- /dev/null +++ b/src/model/V1BankAccountType.js @@ -0,0 +1,65 @@ +/** + * 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 V1BankAccountType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "BUSINESS_CHECKING" + * @const + */ + "BUSINESS_CHECKING": "BUSINESS_CHECKING", + /** + * value: "CHECKING" + * @const + */ + "CHECKING": "CHECKING", + /** + * value: "INVESTMENT" + * @const + */ + "INVESTMENT": "INVESTMENT", + /** + * value: "LOAN" + * @const + */ + "LOAN": "LOAN", + /** + * value: "SAVINGS" + * @const + */ + "SAVINGS": "SAVINGS", + /** + * value: "OTHER" + * @const + */ + "OTHER": "OTHER"}; + +/** + * Returns a V1BankAccountType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1BankAccountType} The enum V1BankAccountType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1CashDrawerEvent.js b/src/model/V1CashDrawerEvent.js index 245b7a9..6621fce 100644 --- a/src/model/V1CashDrawerEvent.js +++ b/src/model/V1CashDrawerEvent.js @@ -24,6 +24,7 @@ var V1Money = require('./V1Money'); /** * Constructs a new V1CashDrawerEvent. + * V1CashDrawerEvent * @alias module:model/V1CashDrawerEvent * @class */ @@ -82,7 +83,7 @@ exports.prototype['id'] = undefined; */ exports.prototype['employee_id'] = undefined; /** - * The type of event that occurred. + * The type of event that occurred. See [V1CashDrawerEventEventType](#type-v1cashdrawereventeventtype) for possible values * @member {module:model/V1CashDrawerEvent.EventTypeEnum} event_type */ exports.prototype['event_type'] = undefined; diff --git a/src/model/V1CashDrawerEventEventType.js b/src/model/V1CashDrawerEventEventType.js new file mode 100644 index 0000000..4e5d633 --- /dev/null +++ b/src/model/V1CashDrawerEventEventType.js @@ -0,0 +1,80 @@ +/** + * 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 V1CashDrawerEventEventType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "NO_SALE" + * @const + */ + "NO_SALE": "NO_SALE", + /** + * value: "CASH_TENDER_PAYMENT" + * @const + */ + "CASH_TENDER_PAYMENT": "CASH_TENDER_PAYMENT", + /** + * value: "OTHER_TENDER_PAYMENT" + * @const + */ + "OTHER_TENDER_PAYMENT": "OTHER_TENDER_PAYMENT", + /** + * value: "CASH_TENDER_CANCELED_PAYMENT" + * @const + */ + "CASH_TENDER_CANCELED_PAYMENT": "CASH_TENDER_CANCELED_PAYMENT", + /** + * value: "OTHER_TENDER_CANCELED_PAYMENT" + * @const + */ + "OTHER_TENDER_CANCELED_PAYMENT": "OTHER_TENDER_CANCELED_PAYMENT", + /** + * value: "CASH_TENDER_REFUND" + * @const + */ + "CASH_TENDER_REFUND": "CASH_TENDER_REFUND", + /** + * value: "OTHER_TENDER_REFUND" + * @const + */ + "OTHER_TENDER_REFUND": "OTHER_TENDER_REFUND", + /** + * value: "PAID_IN" + * @const + */ + "PAID_IN": "PAID_IN", + /** + * value: "PAID_OUT" + * @const + */ + "PAID_OUT": "PAID_OUT"}; + +/** + * Returns a V1CashDrawerEventEventType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1CashDrawerEventEventType} The enum V1CashDrawerEventEventType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1CashDrawerShift.js b/src/model/V1CashDrawerShift.js index 7fce66d..c851f02 100644 --- a/src/model/V1CashDrawerShift.js +++ b/src/model/V1CashDrawerShift.js @@ -26,6 +26,7 @@ var V1Money = require('./V1Money'); /** * Constructs a new V1CashDrawerShift. + * V1CashDrawerShift * @alias module:model/V1CashDrawerShift * @class */ @@ -131,7 +132,7 @@ exports.constructFromObject = function(data, obj) { */ exports.prototype['id'] = undefined; /** - * The shift's current state. + * The shift's current state. See [V1CashDrawerShiftEventType](#type-v1cashdrawershifteventtype) for possible values * @member {module:model/V1CashDrawerShift.EventTypeEnum} event_type */ exports.prototype['event_type'] = undefined; diff --git a/src/model/V1CashDrawerShiftEventType.js b/src/model/V1CashDrawerShiftEventType.js new file mode 100644 index 0000000..c6277a0 --- /dev/null +++ b/src/model/V1CashDrawerShiftEventType.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 V1CashDrawerShiftEventType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "OPEN" + * @const + */ + "OPEN": "OPEN", + /** + * value: "ENDED" + * @const + */ + "ENDED": "ENDED", + /** + * value: "CLOSED" + * @const + */ + "CLOSED": "CLOSED"}; + +/** + * Returns a V1CashDrawerShiftEventType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1CashDrawerShiftEventType} The enum V1CashDrawerShiftEventType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1Category.js b/src/model/V1Category.js index aea8f5d..10689ae 100644 --- a/src/model/V1Category.js +++ b/src/model/V1Category.js @@ -23,6 +23,7 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new V1Category. + * V1Category * @alias module:model/V1Category * @class */ diff --git a/src/model/V1CreateCategoryRequest.js b/src/model/V1CreateCategoryRequest.js new file mode 100644 index 0000000..3c3f889 --- /dev/null +++ b/src/model/V1CreateCategoryRequest.js @@ -0,0 +1,66 @@ +/** + * 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 V1Category = require('./V1Category'); + + + + +/** + * The V1CreateCategoryRequest model module. + * @module model/V1CreateCategoryRequest + */ + +/** + * Constructs a new V1CreateCategoryRequest. + * + * @alias module:model/V1CreateCategoryRequest + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1CreateCategoryRequest 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/V1CreateCategoryRequest} obj Optional instance to populate. + * @return {module:model/V1CreateCategoryRequest} The populated V1CreateCategoryRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1Category.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1Category} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1CreateDiscountRequest.js b/src/model/V1CreateDiscountRequest.js new file mode 100644 index 0000000..c51b86a --- /dev/null +++ b/src/model/V1CreateDiscountRequest.js @@ -0,0 +1,66 @@ +/** + * 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 V1Discount = require('./V1Discount'); + + + + +/** + * The V1CreateDiscountRequest model module. + * @module model/V1CreateDiscountRequest + */ + +/** + * Constructs a new V1CreateDiscountRequest. + * + * @alias module:model/V1CreateDiscountRequest + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1CreateDiscountRequest 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/V1CreateDiscountRequest} obj Optional instance to populate. + * @return {module:model/V1CreateDiscountRequest} The populated V1CreateDiscountRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1Discount.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1Discount} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1CreateEmployeeRoleRequest.js b/src/model/V1CreateEmployeeRoleRequest.js new file mode 100644 index 0000000..93868f1 --- /dev/null +++ b/src/model/V1CreateEmployeeRoleRequest.js @@ -0,0 +1,66 @@ +/** + * 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 V1EmployeeRole = require('./V1EmployeeRole'); + + + + +/** + * The V1CreateEmployeeRoleRequest model module. + * @module model/V1CreateEmployeeRoleRequest + */ + +/** + * Constructs a new V1CreateEmployeeRoleRequest. + * + * @alias module:model/V1CreateEmployeeRoleRequest + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1CreateEmployeeRoleRequest 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/V1CreateEmployeeRoleRequest} obj Optional instance to populate. + * @return {module:model/V1CreateEmployeeRoleRequest} The populated V1CreateEmployeeRoleRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('employee_role')) { + obj['employee_role'] = V1EmployeeRole.constructFromObject(data['employee_role']); + } + } + return obj; +} + +/** + * An EmployeeRole object with a name and permissions, and an optional owner flag. + * @member {module:model/V1EmployeeRole} employee_role + */ +exports.prototype['employee_role'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1CreateFeeRequest.js b/src/model/V1CreateFeeRequest.js new file mode 100644 index 0000000..7c5f740 --- /dev/null +++ b/src/model/V1CreateFeeRequest.js @@ -0,0 +1,66 @@ +/** + * 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 V1Fee = require('./V1Fee'); + + + + +/** + * The V1CreateFeeRequest model module. + * @module model/V1CreateFeeRequest + */ + +/** + * Constructs a new V1CreateFeeRequest. + * + * @alias module:model/V1CreateFeeRequest + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1CreateFeeRequest 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/V1CreateFeeRequest} obj Optional instance to populate. + * @return {module:model/V1CreateFeeRequest} The populated V1CreateFeeRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1Fee.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1Fee} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1CreateItemRequest.js b/src/model/V1CreateItemRequest.js new file mode 100644 index 0000000..5e17172 --- /dev/null +++ b/src/model/V1CreateItemRequest.js @@ -0,0 +1,66 @@ +/** + * 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 V1Item = require('./V1Item'); + + + + +/** + * The V1CreateItemRequest model module. + * @module model/V1CreateItemRequest + */ + +/** + * Constructs a new V1CreateItemRequest. + * + * @alias module:model/V1CreateItemRequest + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1CreateItemRequest 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/V1CreateItemRequest} obj Optional instance to populate. + * @return {module:model/V1CreateItemRequest} The populated V1CreateItemRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1Item.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1Item} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1CreateModifierListRequest.js b/src/model/V1CreateModifierListRequest.js new file mode 100644 index 0000000..4ab8a03 --- /dev/null +++ b/src/model/V1CreateModifierListRequest.js @@ -0,0 +1,66 @@ +/** + * 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 V1ModifierList = require('./V1ModifierList'); + + + + +/** + * The V1CreateModifierListRequest model module. + * @module model/V1CreateModifierListRequest + */ + +/** + * Constructs a new V1CreateModifierListRequest. + * + * @alias module:model/V1CreateModifierListRequest + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1CreateModifierListRequest 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/V1CreateModifierListRequest} obj Optional instance to populate. + * @return {module:model/V1CreateModifierListRequest} The populated V1CreateModifierListRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1ModifierList.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1ModifierList} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1CreateModifierOptionRequest.js b/src/model/V1CreateModifierOptionRequest.js new file mode 100644 index 0000000..f94527c --- /dev/null +++ b/src/model/V1CreateModifierOptionRequest.js @@ -0,0 +1,66 @@ +/** + * 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 V1ModifierOption = require('./V1ModifierOption'); + + + + +/** + * The V1CreateModifierOptionRequest model module. + * @module model/V1CreateModifierOptionRequest + */ + +/** + * Constructs a new V1CreateModifierOptionRequest. + * + * @alias module:model/V1CreateModifierOptionRequest + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1CreateModifierOptionRequest 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/V1CreateModifierOptionRequest} obj Optional instance to populate. + * @return {module:model/V1CreateModifierOptionRequest} The populated V1CreateModifierOptionRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1ModifierOption.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1ModifierOption} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1CreatePageRequest.js b/src/model/V1CreatePageRequest.js new file mode 100644 index 0000000..8557a7f --- /dev/null +++ b/src/model/V1CreatePageRequest.js @@ -0,0 +1,66 @@ +/** + * 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 V1Page = require('./V1Page'); + + + + +/** + * The V1CreatePageRequest model module. + * @module model/V1CreatePageRequest + */ + +/** + * Constructs a new V1CreatePageRequest. + * + * @alias module:model/V1CreatePageRequest + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1CreatePageRequest 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/V1CreatePageRequest} obj Optional instance to populate. + * @return {module:model/V1CreatePageRequest} The populated V1CreatePageRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1Page.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1Page} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1CreateRefundRequest.js b/src/model/V1CreateRefundRequest.js index 783af2b..988cda4 100644 --- a/src/model/V1CreateRefundRequest.js +++ b/src/model/V1CreateRefundRequest.js @@ -24,10 +24,11 @@ var V1Money = require('./V1Money'); /** * Constructs a new V1CreateRefundRequest. + * V1CreateRefundRequest * @alias module:model/V1CreateRefundRequest * @class - * @param paymentId {String} The ID of the payment to refund. If you're creating a PARTIAL refund for a split tender payment, instead provide the id of the particular tender you want to refund. See Split Tender Payments for details. - * @param type {module:model/V1CreateRefundRequest.TypeEnum} TThe type of refund (FULL or PARTIAL). + * @param paymentId {String} The ID of the payment to refund. If you are creating a `PARTIAL` refund for a split tender payment, instead provide the id of the particular tender you want to refund. + * @param type {module:model/V1CreateRefundRequest.TypeEnum} TThe type of refund (FULL or PARTIAL). See [V1CreateRefundRequestType](#type-v1createrefundrequesttype) for possible values * @param reason {String} The reason for the refund. */ var exports = function(paymentId, type, reason) { @@ -71,12 +72,12 @@ exports.constructFromObject = function(data, obj) { } /** - * The ID of the payment to refund. If you're creating a PARTIAL refund for a split tender payment, instead provide the id of the particular tender you want to refund. See Split Tender Payments for details. + * The ID of the payment to refund. If you are creating a `PARTIAL` refund for a split tender payment, instead provide the id of the particular tender you want to refund. * @member {String} payment_id */ exports.prototype['payment_id'] = undefined; /** - * TThe type of refund (FULL or PARTIAL). + * TThe type of refund (FULL or PARTIAL). See [V1CreateRefundRequestType](#type-v1createrefundrequesttype) for possible values * @member {module:model/V1CreateRefundRequest.TypeEnum} type */ exports.prototype['type'] = undefined; diff --git a/src/model/V1CreateRefundRequestType.js b/src/model/V1CreateRefundRequestType.js new file mode 100644 index 0000000..cda879e --- /dev/null +++ b/src/model/V1CreateRefundRequestType.js @@ -0,0 +1,45 @@ +/** + * 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 V1CreateRefundRequestType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "FULL" + * @const + */ + "FULL": "FULL", + /** + * value: "PARTIAL" + * @const + */ + "PARTIAL": "PARTIAL"}; + +/** + * Returns a V1CreateRefundRequestType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1CreateRefundRequestType} The enum V1CreateRefundRequestType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1CreateVariationRequest.js b/src/model/V1CreateVariationRequest.js new file mode 100644 index 0000000..d7c2b30 --- /dev/null +++ b/src/model/V1CreateVariationRequest.js @@ -0,0 +1,66 @@ +/** + * 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 V1Variation = require('./V1Variation'); + + + + +/** + * The V1CreateVariationRequest model module. + * @module model/V1CreateVariationRequest + */ + +/** + * Constructs a new V1CreateVariationRequest. + * + * @alias module:model/V1CreateVariationRequest + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1CreateVariationRequest 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/V1CreateVariationRequest} obj Optional instance to populate. + * @return {module:model/V1CreateVariationRequest} The populated V1CreateVariationRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1Variation.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1Variation} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1DeleteCategoryRequest.js b/src/model/V1DeleteCategoryRequest.js new file mode 100644 index 0000000..b33c0b0 --- /dev/null +++ b/src/model/V1DeleteCategoryRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1DeleteCategoryRequest model module. + * @module model/V1DeleteCategoryRequest + */ + +/** + * Constructs a new V1DeleteCategoryRequest. + * + * @alias module:model/V1DeleteCategoryRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1DeleteCategoryRequest 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/V1DeleteCategoryRequest} obj Optional instance to populate. + * @return {module:model/V1DeleteCategoryRequest} The populated V1DeleteCategoryRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1DeleteDiscountRequest.js b/src/model/V1DeleteDiscountRequest.js new file mode 100644 index 0000000..3b42f21 --- /dev/null +++ b/src/model/V1DeleteDiscountRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1DeleteDiscountRequest model module. + * @module model/V1DeleteDiscountRequest + */ + +/** + * Constructs a new V1DeleteDiscountRequest. + * + * @alias module:model/V1DeleteDiscountRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1DeleteDiscountRequest 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/V1DeleteDiscountRequest} obj Optional instance to populate. + * @return {module:model/V1DeleteDiscountRequest} The populated V1DeleteDiscountRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1DeleteFeeRequest.js b/src/model/V1DeleteFeeRequest.js new file mode 100644 index 0000000..249f044 --- /dev/null +++ b/src/model/V1DeleteFeeRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1DeleteFeeRequest model module. + * @module model/V1DeleteFeeRequest + */ + +/** + * Constructs a new V1DeleteFeeRequest. + * + * @alias module:model/V1DeleteFeeRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1DeleteFeeRequest 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/V1DeleteFeeRequest} obj Optional instance to populate. + * @return {module:model/V1DeleteFeeRequest} The populated V1DeleteFeeRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1DeleteItemRequest.js b/src/model/V1DeleteItemRequest.js new file mode 100644 index 0000000..9534632 --- /dev/null +++ b/src/model/V1DeleteItemRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1DeleteItemRequest model module. + * @module model/V1DeleteItemRequest + */ + +/** + * Constructs a new V1DeleteItemRequest. + * + * @alias module:model/V1DeleteItemRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1DeleteItemRequest 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/V1DeleteItemRequest} obj Optional instance to populate. + * @return {module:model/V1DeleteItemRequest} The populated V1DeleteItemRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1DeleteModifierListRequest.js b/src/model/V1DeleteModifierListRequest.js new file mode 100644 index 0000000..96031cb --- /dev/null +++ b/src/model/V1DeleteModifierListRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1DeleteModifierListRequest model module. + * @module model/V1DeleteModifierListRequest + */ + +/** + * Constructs a new V1DeleteModifierListRequest. + * + * @alias module:model/V1DeleteModifierListRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1DeleteModifierListRequest 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/V1DeleteModifierListRequest} obj Optional instance to populate. + * @return {module:model/V1DeleteModifierListRequest} The populated V1DeleteModifierListRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1DeleteModifierOptionRequest.js b/src/model/V1DeleteModifierOptionRequest.js new file mode 100644 index 0000000..116f0a2 --- /dev/null +++ b/src/model/V1DeleteModifierOptionRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1DeleteModifierOptionRequest model module. + * @module model/V1DeleteModifierOptionRequest + */ + +/** + * Constructs a new V1DeleteModifierOptionRequest. + * + * @alias module:model/V1DeleteModifierOptionRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1DeleteModifierOptionRequest 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/V1DeleteModifierOptionRequest} obj Optional instance to populate. + * @return {module:model/V1DeleteModifierOptionRequest} The populated V1DeleteModifierOptionRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1DeletePageCellRequest.js b/src/model/V1DeletePageCellRequest.js new file mode 100644 index 0000000..6208a2b --- /dev/null +++ b/src/model/V1DeletePageCellRequest.js @@ -0,0 +1,74 @@ +/** + * 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'); + + + + +/** + * The V1DeletePageCellRequest model module. + * @module model/V1DeletePageCellRequest + */ + +/** + * Constructs a new V1DeletePageCellRequest. + * + * @alias module:model/V1DeletePageCellRequest + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a V1DeletePageCellRequest 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/V1DeletePageCellRequest} obj Optional instance to populate. + * @return {module:model/V1DeletePageCellRequest} The populated V1DeletePageCellRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('row')) { + obj['row'] = ApiClient.convertToType(data['row'], 'String'); + } + if (data.hasOwnProperty('column')) { + obj['column'] = ApiClient.convertToType(data['column'], 'String'); + } + } + return obj; +} + +/** + * The row of the cell to clear. Always an integer between 0 and 4, inclusive. Row 0 is the top row. + * @member {String} row + */ +exports.prototype['row'] = undefined; +/** + * The column of the cell to clear. Always an integer between 0 and 4, inclusive. Column 0 is the leftmost column. + * @member {String} column + */ +exports.prototype['column'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1DeletePageRequest.js b/src/model/V1DeletePageRequest.js new file mode 100644 index 0000000..32c2220 --- /dev/null +++ b/src/model/V1DeletePageRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1DeletePageRequest model module. + * @module model/V1DeletePageRequest + */ + +/** + * Constructs a new V1DeletePageRequest. + * + * @alias module:model/V1DeletePageRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1DeletePageRequest 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/V1DeletePageRequest} obj Optional instance to populate. + * @return {module:model/V1DeletePageRequest} The populated V1DeletePageRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1DeleteTimecardRequest.js b/src/model/V1DeleteTimecardRequest.js new file mode 100644 index 0000000..b187332 --- /dev/null +++ b/src/model/V1DeleteTimecardRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1DeleteTimecardRequest model module. + * @module model/V1DeleteTimecardRequest + */ + +/** + * Constructs a new V1DeleteTimecardRequest. + * + * @alias module:model/V1DeleteTimecardRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1DeleteTimecardRequest 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/V1DeleteTimecardRequest} obj Optional instance to populate. + * @return {module:model/V1DeleteTimecardRequest} The populated V1DeleteTimecardRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1DeleteTimecardResponse.js b/src/model/V1DeleteTimecardResponse.js new file mode 100644 index 0000000..2fa1a87 --- /dev/null +++ b/src/model/V1DeleteTimecardResponse.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1DeleteTimecardResponse model module. + * @module model/V1DeleteTimecardResponse + */ + +/** + * Constructs a new V1DeleteTimecardResponse. + * + * @alias module:model/V1DeleteTimecardResponse + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1DeleteTimecardResponse 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/V1DeleteTimecardResponse} obj Optional instance to populate. + * @return {module:model/V1DeleteTimecardResponse} The populated V1DeleteTimecardResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1DeleteVariationRequest.js b/src/model/V1DeleteVariationRequest.js new file mode 100644 index 0000000..66c8224 --- /dev/null +++ b/src/model/V1DeleteVariationRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1DeleteVariationRequest model module. + * @module model/V1DeleteVariationRequest + */ + +/** + * Constructs a new V1DeleteVariationRequest. + * + * @alias module:model/V1DeleteVariationRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1DeleteVariationRequest 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/V1DeleteVariationRequest} obj Optional instance to populate. + * @return {module:model/V1DeleteVariationRequest} The populated V1DeleteVariationRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1Discount.js b/src/model/V1Discount.js index ab0b911..cad4db6 100644 --- a/src/model/V1Discount.js +++ b/src/model/V1Discount.js @@ -24,6 +24,7 @@ var V1Money = require('./V1Money'); /** * Constructs a new V1Discount. + * V1Discount * @alias module:model/V1Discount * @class */ @@ -96,7 +97,7 @@ exports.prototype['rate'] = undefined; */ exports.prototype['amount_money'] = undefined; /** - * Indicates whether the discount is a FIXED value or entered at the time of sale. + * Indicates whether the discount is a FIXED value or entered at the time of sale. See [V1DiscountDiscountType](#type-v1discountdiscounttype) for possible values * @member {module:model/V1Discount.DiscountTypeEnum} discount_type */ exports.prototype['discount_type'] = undefined; @@ -106,7 +107,7 @@ exports.prototype['discount_type'] = undefined; */ exports.prototype['pin_required'] = undefined; /** - * The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. + * The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1DiscountColor](#type-v1discountcolor) for possible values * @member {module:model/V1Discount.ColorEnum} color */ exports.prototype['color'] = undefined; diff --git a/src/model/V1DiscountColor.js b/src/model/V1DiscountColor.js new file mode 100644 index 0000000..c10a739 --- /dev/null +++ b/src/model/V1DiscountColor.js @@ -0,0 +1,80 @@ +/** + * 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 V1DiscountColor. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "9da2a6" + * @const + */ + "9da2a6": "9da2a6", + /** + * value: "4ab200" + * @const + */ + "4ab200": "4ab200", + /** + * value: "0b8000" + * @const + */ + "0b8000": "0b8000", + /** + * value: "2952cc" + * @const + */ + "2952cc": "2952cc", + /** + * value: "a82ee5" + * @const + */ + "a82ee5": "a82ee5", + /** + * value: "e5457a" + * @const + */ + "e5457a": "e5457a", + /** + * value: "b21212" + * @const + */ + "b21212": "b21212", + /** + * value: "593c00" + * @const + */ + "593c00": "593c00", + /** + * value: "e5BF00" + * @const + */ + "e5BF00": "e5BF00"}; + +/** + * Returns a V1DiscountColor enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1DiscountColor} The enum V1DiscountColor value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1DiscountDiscountType.js b/src/model/V1DiscountDiscountType.js new file mode 100644 index 0000000..e1ca9a2 --- /dev/null +++ b/src/model/V1DiscountDiscountType.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 V1DiscountDiscountType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "FIXED" + * @const + */ + "FIXED": "FIXED", + /** + * value: "VARIABLE_PERCENTAGE" + * @const + */ + "VARIABLE_PERCENTAGE": "VARIABLE_PERCENTAGE", + /** + * value: "VARIABLE_AMOUNT" + * @const + */ + "VARIABLE_AMOUNT": "VARIABLE_AMOUNT"}; + +/** + * Returns a V1DiscountDiscountType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1DiscountDiscountType} The enum V1DiscountDiscountType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1Employee.js b/src/model/V1Employee.js index 96a391e..a08a9a5 100644 --- a/src/model/V1Employee.js +++ b/src/model/V1Employee.js @@ -120,7 +120,7 @@ exports.prototype['authorized_location_ids'] = undefined; */ exports.prototype['email'] = undefined; /** - * CWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard. + * CWhether the employee is ACTIVE or INACTIVE. Inactive employees cannot sign in to Square Register.Merchants update this field from the Square Dashboard. See [V1EmployeeStatus](#type-v1employeestatus) for possible values * @member {module:model/V1Employee.StatusEnum} status */ exports.prototype['status'] = undefined; diff --git a/src/model/V1EmployeeRole.js b/src/model/V1EmployeeRole.js index 244ccc6..a88ad96 100644 --- a/src/model/V1EmployeeRole.js +++ b/src/model/V1EmployeeRole.js @@ -23,10 +23,11 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new V1EmployeeRole. + * V1EmployeeRole * @alias module:model/V1EmployeeRole * @class * @param name {String} The role's merchant-defined name. - * @param permissions {Array.} The role's permissions. + * @param permissions {Array.} The role's permissions. See [V1EmployeeRolePermissions](#type-v1employeerolepermissions) for possible values */ var exports = function(name, permissions) { var _this = this; @@ -83,7 +84,7 @@ exports.prototype['id'] = undefined; */ exports.prototype['name'] = undefined; /** - * The role's permissions. + * The role's permissions. See [V1EmployeeRolePermissions](#type-v1employeerolepermissions) for possible values * @member {Array.} permissions */ exports.prototype['permissions'] = undefined; diff --git a/src/model/V1EmployeeRolePermissions.js b/src/model/V1EmployeeRolePermissions.js new file mode 100644 index 0000000..7e8ac2f --- /dev/null +++ b/src/model/V1EmployeeRolePermissions.js @@ -0,0 +1,70 @@ +/** + * 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 V1EmployeeRolePermissions. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "REGISTER_ACCESS_SALES_HISTORY" + * @const + */ + "ACCESS_SALES_HISTORY": "REGISTER_ACCESS_SALES_HISTORY", + /** + * value: "REGISTER_APPLY_RESTRICTED_DISCOUNTS" + * @const + */ + "APPLY_RESTRICTED_DISCOUNTS": "REGISTER_APPLY_RESTRICTED_DISCOUNTS", + /** + * value: "REGISTER_CHANGE_SETTINGS" + * @const + */ + "CHANGE_SETTINGS": "REGISTER_CHANGE_SETTINGS", + /** + * value: "REGISTER_EDIT_ITEM" + * @const + */ + "EDIT_ITEM": "REGISTER_EDIT_ITEM", + /** + * value: "REGISTER_ISSUE_REFUNDS" + * @const + */ + "ISSUE_REFUNDS": "REGISTER_ISSUE_REFUNDS", + /** + * value: "REGISTER_OPEN_CASH_DRAWER_OUTSIDE_SALE" + * @const + */ + "OPEN_CASH_DRAWER_OUTSIDE_SALE": "REGISTER_OPEN_CASH_DRAWER_OUTSIDE_SALE", + /** + * value: "REGISTER_VIEW_SUMMARY_REPORTS" + * @const + */ + "VIEW_SUMMARY_REPORTS": "REGISTER_VIEW_SUMMARY_REPORTS"}; + +/** + * Returns a V1EmployeeRolePermissions enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1EmployeeRolePermissions} The enum V1EmployeeRolePermissions value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1EmployeeStatus.js b/src/model/V1EmployeeStatus.js new file mode 100644 index 0000000..d025b23 --- /dev/null +++ b/src/model/V1EmployeeStatus.js @@ -0,0 +1,45 @@ +/** + * 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 V1EmployeeStatus. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "ACTIVE" + * @const + */ + "ACTIVE": "ACTIVE", + /** + * value: "INACTIVE" + * @const + */ + "INACTIVE": "INACTIVE"}; + +/** + * Returns a V1EmployeeStatus enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1EmployeeStatus} The enum V1EmployeeStatus value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1Fee.js b/src/model/V1Fee.js index a88dbea..9fcc69b 100644 --- a/src/model/V1Fee.js +++ b/src/model/V1Fee.js @@ -23,6 +23,7 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new V1Fee. + * V1Fee * @alias module:model/V1Fee * @class */ @@ -98,12 +99,12 @@ exports.prototype['name'] = undefined; */ exports.prototype['rate'] = undefined; /** - * Forthcoming + * Forthcoming See [V1FeeCalculationPhase](#type-v1feecalculationphase) for possible values * @member {module:model/V1Fee.CalculationPhaseEnum} calculation_phase */ exports.prototype['calculation_phase'] = undefined; /** - * The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. + * The type of adjustment the fee applies to a payment. Currently, this value is TAX for all fees. See [V1FeeAdjustmentType](#type-v1feeadjustmenttype) for possible values * @member {module:model/V1Fee.AdjustmentTypeEnum} adjustment_type */ exports.prototype['adjustment_type'] = undefined; @@ -118,12 +119,12 @@ exports.prototype['applies_to_custom_amounts'] = undefined; */ exports.prototype['enabled'] = undefined; /** - * Whether the fee is ADDITIVE or INCLUSIVE. + * Whether the fee is ADDITIVE or INCLUSIVE. See [V1FeeInclusionType](#type-v1feeinclusiontype) for possible values * @member {module:model/V1Fee.InclusionTypeEnum} inclusion_type */ exports.prototype['inclusion_type'] = undefined; /** - * In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. + * In countries with multiple classifications for sales taxes, indicates which classification the fee falls under. Currently relevant only to Canadian merchants. See [V1FeeType](#type-v1feetype) for possible values * @member {module:model/V1Fee.TypeEnum} type */ exports.prototype['type'] = undefined; diff --git a/src/model/V1FeeAdjustmentType.js b/src/model/V1FeeAdjustmentType.js new file mode 100644 index 0000000..db44da9 --- /dev/null +++ b/src/model/V1FeeAdjustmentType.js @@ -0,0 +1,40 @@ +/** + * 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 V1FeeAdjustmentType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "TAX" + * @const + */ + "TAX": "TAX"}; + +/** + * Returns a V1FeeAdjustmentType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1FeeAdjustmentType} The enum V1FeeAdjustmentType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1FeeCalculationPhase.js b/src/model/V1FeeCalculationPhase.js new file mode 100644 index 0000000..1738a21 --- /dev/null +++ b/src/model/V1FeeCalculationPhase.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 V1FeeCalculationPhase. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "FEE_SUBTOTAL_PHASE" + * @const + */ + "FEE_SUBTOTAL_PHASE": "FEE_SUBTOTAL_PHASE", + /** + * value: "OTHER" + * @const + */ + "OTHER": "OTHER", + /** + * value: "FEE_TOTAL_PHASE" + * @const + */ + "FEE_TOTAL_PHASE": "FEE_TOTAL_PHASE"}; + +/** + * Returns a V1FeeCalculationPhase enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1FeeCalculationPhase} The enum V1FeeCalculationPhase value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1FeeInclusionType.js b/src/model/V1FeeInclusionType.js new file mode 100644 index 0000000..43ce9e5 --- /dev/null +++ b/src/model/V1FeeInclusionType.js @@ -0,0 +1,45 @@ +/** + * 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 V1FeeInclusionType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "ADDITIVE" + * @const + */ + "ADDITIVE": "ADDITIVE", + /** + * value: "INCLUSIVE" + * @const + */ + "INCLUSIVE": "INCLUSIVE"}; + +/** + * Returns a V1FeeInclusionType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1FeeInclusionType} The enum V1FeeInclusionType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1FeeType.js b/src/model/V1FeeType.js new file mode 100644 index 0000000..e0a4b0e --- /dev/null +++ b/src/model/V1FeeType.js @@ -0,0 +1,75 @@ +/** + * 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 V1FeeType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "CA_GST" + * @const + */ + "CA_GST": "CA_GST", + /** + * value: "CA_HST" + * @const + */ + "CA_HST": "CA_HST", + /** + * value: "CA_PST" + * @const + */ + "CA_PST": "CA_PST", + /** + * value: "CA_QST" + * @const + */ + "CA_QST": "CA_QST", + /** + * value: "JP_CONSUMPTION_TAX" + * @const + */ + "JP_CONSUMPTION_TAX": "JP_CONSUMPTION_TAX", + /** + * value: "CA_PEI_PST" + * @const + */ + "CA_PEI_PST": "CA_PEI_PST", + /** + * value: "US_SALES_TAX" + * @const + */ + "US_SALES_TAX": "US_SALES_TAX", + /** + * value: "OTHER" + * @const + */ + "OTHER": "OTHER"}; + +/** + * Returns a V1FeeType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1FeeType} The enum V1FeeType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1InventoryEntry.js b/src/model/V1InventoryEntry.js index 8dd99a4..b1b2af2 100644 --- a/src/model/V1InventoryEntry.js +++ b/src/model/V1InventoryEntry.js @@ -23,6 +23,7 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new V1InventoryEntry. + * V1InventoryEntry * @alias module:model/V1InventoryEntry * @class */ diff --git a/src/model/V1Item.js b/src/model/V1Item.js index f7906d8..87af025 100644 --- a/src/model/V1Item.js +++ b/src/model/V1Item.js @@ -27,6 +27,7 @@ var V1Variation = require('./V1Variation'); /** * Constructs a new V1Item. + * V1Item * @alias module:model/V1Item * @class */ @@ -130,12 +131,12 @@ exports.prototype['name'] = undefined; */ exports.prototype['description'] = undefined; /** - * The item's type. This value is NORMAL for almost all items. + * The item's type. This value is NORMAL for almost all items. See [V1ItemType](#type-v1itemtype) for possible values * @member {module:model/V1Item.TypeEnum} type */ exports.prototype['type'] = undefined; /** - * The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. + * The color of the discount's display label in Square Register, if not the default color. The default color is 9da2a6. See [V1ItemColor](#type-v1itemcolor) for possible values * @member {module:model/V1Item.ColorEnum} color */ exports.prototype['color'] = undefined; @@ -145,7 +146,7 @@ exports.prototype['color'] = undefined; */ exports.prototype['abbreviation'] = undefined; /** - * Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. + * Indicates whether the item is viewable from the merchant's online store (PUBLIC) or PRIVATE. See [V1ItemVisibility](#type-v1itemvisibility) for possible values * @member {module:model/V1Item.VisibilityEnum} visibility */ exports.prototype['visibility'] = undefined; diff --git a/src/model/V1ItemColor.js b/src/model/V1ItemColor.js new file mode 100644 index 0000000..2f5e8ac --- /dev/null +++ b/src/model/V1ItemColor.js @@ -0,0 +1,80 @@ +/** + * 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 V1ItemColor. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "9da2a6" + * @const + */ + "9da2a6": "9da2a6", + /** + * value: "4ab200" + * @const + */ + "4ab200": "4ab200", + /** + * value: "0b8000" + * @const + */ + "0b8000": "0b8000", + /** + * value: "2952cc" + * @const + */ + "2952cc": "2952cc", + /** + * value: "a82ee5" + * @const + */ + "a82ee5": "a82ee5", + /** + * value: "e5457a" + * @const + */ + "e5457a": "e5457a", + /** + * value: "b21212" + * @const + */ + "b21212": "b21212", + /** + * value: "593c00" + * @const + */ + "593c00": "593c00", + /** + * value: "e5BF00" + * @const + */ + "e5BF00": "e5BF00"}; + +/** + * Returns a V1ItemColor enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1ItemColor} The enum V1ItemColor value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1ItemImage.js b/src/model/V1ItemImage.js index f1860bc..04bc7d7 100644 --- a/src/model/V1ItemImage.js +++ b/src/model/V1ItemImage.js @@ -23,6 +23,7 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new V1ItemImage. + * V1ItemImage * @alias module:model/V1ItemImage * @class */ diff --git a/src/model/V1ItemType.js b/src/model/V1ItemType.js new file mode 100644 index 0000000..247ea09 --- /dev/null +++ b/src/model/V1ItemType.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 V1ItemType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "NORMAL" + * @const + */ + "NORMAL": "NORMAL", + /** + * value: "GIFT_CARD" + * @const + */ + "GIFT_CARD": "GIFT_CARD", + /** + * value: "OTHER" + * @const + */ + "OTHER": "OTHER"}; + +/** + * Returns a V1ItemType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1ItemType} The enum V1ItemType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1ItemVisibility.js b/src/model/V1ItemVisibility.js new file mode 100644 index 0000000..09f23a1 --- /dev/null +++ b/src/model/V1ItemVisibility.js @@ -0,0 +1,45 @@ +/** + * 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 V1ItemVisibility. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "PUBLIC" + * @const + */ + "PUBLIC": "PUBLIC", + /** + * value: "PRIVATE" + * @const + */ + "PRIVATE": "PRIVATE"}; + +/** + * Returns a V1ItemVisibility enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1ItemVisibility} The enum V1ItemVisibility value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1ListBankAccountsRequest.js b/src/model/V1ListBankAccountsRequest.js new file mode 100644 index 0000000..8d464d2 --- /dev/null +++ b/src/model/V1ListBankAccountsRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1ListBankAccountsRequest model module. + * @module model/V1ListBankAccountsRequest + */ + +/** + * Constructs a new V1ListBankAccountsRequest. + * + * @alias module:model/V1ListBankAccountsRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1ListBankAccountsRequest 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/V1ListBankAccountsRequest} obj Optional instance to populate. + * @return {module:model/V1ListBankAccountsRequest} The populated V1ListBankAccountsRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1ListBankAccountsResponse.js b/src/model/V1ListBankAccountsResponse.js new file mode 100644 index 0000000..5e72982 --- /dev/null +++ b/src/model/V1ListBankAccountsResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1BankAccount = require('./V1BankAccount'); + + + + +/** + * The V1ListBankAccountsResponse model module. + * @module model/V1ListBankAccountsResponse + */ + +/** + * Constructs a new V1ListBankAccountsResponse. + * + * @alias module:model/V1ListBankAccountsResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListBankAccountsResponse 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/V1ListBankAccountsResponse} obj Optional instance to populate. + * @return {module:model/V1ListBankAccountsResponse} The populated V1ListBankAccountsResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1BankAccount]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListCashDrawerShiftsRequest.js b/src/model/V1ListCashDrawerShiftsRequest.js new file mode 100644 index 0000000..0469bf8 --- /dev/null +++ b/src/model/V1ListCashDrawerShiftsRequest.js @@ -0,0 +1,100 @@ +/** + * 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'); + + + + +/** + * The V1ListCashDrawerShiftsRequest model module. + * @module model/V1ListCashDrawerShiftsRequest + */ + +/** + * Constructs a new V1ListCashDrawerShiftsRequest. + * + * @alias module:model/V1ListCashDrawerShiftsRequest + * @class + */ +var exports = function() { + var _this = this; + + + + +}; + +/** + * Constructs a V1ListCashDrawerShiftsRequest 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/V1ListCashDrawerShiftsRequest} obj Optional instance to populate. + * @return {module:model/V1ListCashDrawerShiftsRequest} The populated V1ListCashDrawerShiftsRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('order')) { + obj['order'] = ApiClient.convertToType(data['order'], 'String'); + } + 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'); + } + } + return obj; +} + +/** + * The order in which cash drawer shifts are listed in the response, based on their created_at field. Default value: ASC See [SortOrder](#type-sortorder) for possible values + * @member {module:model/V1ListCashDrawerShiftsRequest.OrderEnum} order + */ +exports.prototype['order'] = undefined; +/** + * The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time minus 90 days. + * @member {String} begin_time + */ +exports.prototype['begin_time'] = undefined; +/** + * The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time. + * @member {String} end_time + */ +exports.prototype['end_time'] = undefined; + + + /** + * Allowed values for the order property. + * @enum {String} + * @readonly + */ + exports.OrderEnum = { + /** + * value: "DESC" + * @const + */ + "DESC": "DESC", + /** + * value: "ASC" + * @const + */ + "ASC": "ASC" }; + + +module.exports = exports; + + + diff --git a/src/model/V1ListCashDrawerShiftsResponse.js b/src/model/V1ListCashDrawerShiftsResponse.js new file mode 100644 index 0000000..18bd7e7 --- /dev/null +++ b/src/model/V1ListCashDrawerShiftsResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1CashDrawerShift = require('./V1CashDrawerShift'); + + + + +/** + * The V1ListCashDrawerShiftsResponse model module. + * @module model/V1ListCashDrawerShiftsResponse + */ + +/** + * Constructs a new V1ListCashDrawerShiftsResponse. + * + * @alias module:model/V1ListCashDrawerShiftsResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListCashDrawerShiftsResponse 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/V1ListCashDrawerShiftsResponse} obj Optional instance to populate. + * @return {module:model/V1ListCashDrawerShiftsResponse} The populated V1ListCashDrawerShiftsResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1CashDrawerShift]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListCategoriesRequest.js b/src/model/V1ListCategoriesRequest.js new file mode 100644 index 0000000..73b6f58 --- /dev/null +++ b/src/model/V1ListCategoriesRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1ListCategoriesRequest model module. + * @module model/V1ListCategoriesRequest + */ + +/** + * Constructs a new V1ListCategoriesRequest. + * + * @alias module:model/V1ListCategoriesRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1ListCategoriesRequest 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/V1ListCategoriesRequest} obj Optional instance to populate. + * @return {module:model/V1ListCategoriesRequest} The populated V1ListCategoriesRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1ListCategoriesResponse.js b/src/model/V1ListCategoriesResponse.js new file mode 100644 index 0000000..9081a1b --- /dev/null +++ b/src/model/V1ListCategoriesResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1Category = require('./V1Category'); + + + + +/** + * The V1ListCategoriesResponse model module. + * @module model/V1ListCategoriesResponse + */ + +/** + * Constructs a new V1ListCategoriesResponse. + * + * @alias module:model/V1ListCategoriesResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListCategoriesResponse 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/V1ListCategoriesResponse} obj Optional instance to populate. + * @return {module:model/V1ListCategoriesResponse} The populated V1ListCategoriesResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1Category]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListDiscountsRequest.js b/src/model/V1ListDiscountsRequest.js new file mode 100644 index 0000000..43a71f6 --- /dev/null +++ b/src/model/V1ListDiscountsRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1ListDiscountsRequest model module. + * @module model/V1ListDiscountsRequest + */ + +/** + * Constructs a new V1ListDiscountsRequest. + * + * @alias module:model/V1ListDiscountsRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1ListDiscountsRequest 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/V1ListDiscountsRequest} obj Optional instance to populate. + * @return {module:model/V1ListDiscountsRequest} The populated V1ListDiscountsRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1ListDiscountsResponse.js b/src/model/V1ListDiscountsResponse.js new file mode 100644 index 0000000..4179704 --- /dev/null +++ b/src/model/V1ListDiscountsResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1Discount = require('./V1Discount'); + + + + +/** + * The V1ListDiscountsResponse model module. + * @module model/V1ListDiscountsResponse + */ + +/** + * Constructs a new V1ListDiscountsResponse. + * + * @alias module:model/V1ListDiscountsResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListDiscountsResponse 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/V1ListDiscountsResponse} obj Optional instance to populate. + * @return {module:model/V1ListDiscountsResponse} The populated V1ListDiscountsResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1Discount]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListEmployeeRolesRequest.js b/src/model/V1ListEmployeeRolesRequest.js new file mode 100644 index 0000000..70e4c81 --- /dev/null +++ b/src/model/V1ListEmployeeRolesRequest.js @@ -0,0 +1,100 @@ +/** + * 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'); + + + + +/** + * The V1ListEmployeeRolesRequest model module. + * @module model/V1ListEmployeeRolesRequest + */ + +/** + * Constructs a new V1ListEmployeeRolesRequest. + * + * @alias module:model/V1ListEmployeeRolesRequest + * @class + */ +var exports = function() { + var _this = this; + + + + +}; + +/** + * Constructs a V1ListEmployeeRolesRequest 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/V1ListEmployeeRolesRequest} obj Optional instance to populate. + * @return {module:model/V1ListEmployeeRolesRequest} The populated V1ListEmployeeRolesRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('order')) { + obj['order'] = ApiClient.convertToType(data['order'], 'String'); + } + if (data.hasOwnProperty('limit')) { + obj['limit'] = ApiClient.convertToType(data['limit'], 'Number'); + } + if (data.hasOwnProperty('batch_token')) { + obj['batch_token'] = ApiClient.convertToType(data['batch_token'], 'String'); + } + } + return obj; +} + +/** + * The order in which employees are listed in the response, based on their created_at field.Default value: ASC See [SortOrder](#type-sortorder) for possible values + * @member {module:model/V1ListEmployeeRolesRequest.OrderEnum} order + */ +exports.prototype['order'] = undefined; +/** + * The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. + * @member {Number} limit + */ +exports.prototype['limit'] = undefined; +/** + * A pagination cursor to retrieve the next set of results for your original query to the endpoint. + * @member {String} batch_token + */ +exports.prototype['batch_token'] = undefined; + + + /** + * Allowed values for the order property. + * @enum {String} + * @readonly + */ + exports.OrderEnum = { + /** + * value: "DESC" + * @const + */ + "DESC": "DESC", + /** + * value: "ASC" + * @const + */ + "ASC": "ASC" }; + + +module.exports = exports; + + + diff --git a/src/model/V1ListEmployeeRolesResponse.js b/src/model/V1ListEmployeeRolesResponse.js new file mode 100644 index 0000000..d8e9982 --- /dev/null +++ b/src/model/V1ListEmployeeRolesResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1EmployeeRole = require('./V1EmployeeRole'); + + + + +/** + * The V1ListEmployeeRolesResponse model module. + * @module model/V1ListEmployeeRolesResponse + */ + +/** + * Constructs a new V1ListEmployeeRolesResponse. + * + * @alias module:model/V1ListEmployeeRolesResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListEmployeeRolesResponse 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/V1ListEmployeeRolesResponse} obj Optional instance to populate. + * @return {module:model/V1ListEmployeeRolesResponse} The populated V1ListEmployeeRolesResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1EmployeeRole]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListEmployeesRequest.js b/src/model/V1ListEmployeesRequest.js new file mode 100644 index 0000000..f0e287f --- /dev/null +++ b/src/model/V1ListEmployeesRequest.js @@ -0,0 +1,171 @@ +/** + * 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'); + + + + +/** + * The V1ListEmployeesRequest model module. + * @module model/V1ListEmployeesRequest + */ + +/** + * Constructs a new V1ListEmployeesRequest. + * + * @alias module:model/V1ListEmployeesRequest + * @class + */ +var exports = function() { + var _this = this; + + + + + + + + + + +}; + +/** + * Constructs a V1ListEmployeesRequest 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/V1ListEmployeesRequest} obj Optional instance to populate. + * @return {module:model/V1ListEmployeesRequest} The populated V1ListEmployeesRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('order')) { + obj['order'] = ApiClient.convertToType(data['order'], 'String'); + } + if (data.hasOwnProperty('begin_updated_at')) { + obj['begin_updated_at'] = ApiClient.convertToType(data['begin_updated_at'], 'String'); + } + if (data.hasOwnProperty('end_updated_at')) { + obj['end_updated_at'] = ApiClient.convertToType(data['end_updated_at'], 'String'); + } + if (data.hasOwnProperty('begin_created_at')) { + obj['begin_created_at'] = ApiClient.convertToType(data['begin_created_at'], 'String'); + } + if (data.hasOwnProperty('end_created_at')) { + obj['end_created_at'] = ApiClient.convertToType(data['end_created_at'], 'String'); + } + if (data.hasOwnProperty('status')) { + obj['status'] = ApiClient.convertToType(data['status'], 'String'); + } + if (data.hasOwnProperty('external_id')) { + obj['external_id'] = ApiClient.convertToType(data['external_id'], 'String'); + } + if (data.hasOwnProperty('limit')) { + obj['limit'] = ApiClient.convertToType(data['limit'], 'Number'); + } + if (data.hasOwnProperty('batch_token')) { + obj['batch_token'] = ApiClient.convertToType(data['batch_token'], 'String'); + } + } + return obj; +} + +/** + * The order in which employees are listed in the response, based on their created_at field. Default value: ASC See [SortOrder](#type-sortorder) for possible values + * @member {module:model/V1ListEmployeesRequest.OrderEnum} order + */ +exports.prototype['order'] = undefined; +/** + * If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format + * @member {String} begin_updated_at + */ +exports.prototype['begin_updated_at'] = undefined; +/** + * If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format. + * @member {String} end_updated_at + */ +exports.prototype['end_updated_at'] = undefined; +/** + * If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format. + * @member {String} begin_created_at + */ +exports.prototype['begin_created_at'] = undefined; +/** + * If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format. + * @member {String} end_created_at + */ +exports.prototype['end_created_at'] = undefined; +/** + * If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE). See [V1ListEmployeesRequestStatus](#type-v1listemployeesrequeststatus) for possible values + * @member {module:model/V1ListEmployeesRequest.StatusEnum} status + */ +exports.prototype['status'] = undefined; +/** + * If provided, the endpoint returns only employee entities with the specified external_id. + * @member {String} external_id + */ +exports.prototype['external_id'] = undefined; +/** + * The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. + * @member {Number} limit + */ +exports.prototype['limit'] = undefined; +/** + * A pagination cursor to retrieve the next set of results for your original query to the endpoint. + * @member {String} batch_token + */ +exports.prototype['batch_token'] = undefined; + + + /** + * Allowed values for the order property. + * @enum {String} + * @readonly + */ + exports.OrderEnum = { + /** + * value: "DESC" + * @const + */ + "DESC": "DESC", + /** + * value: "ASC" + * @const + */ + "ASC": "ASC" }; + + /** + * Allowed values for the status property. + * @enum {String} + * @readonly + */ + exports.StatusEnum = { + /** + * value: "ACTIVE" + * @const + */ + "ACTIVE": "ACTIVE", + /** + * value: "INACTIVE" + * @const + */ + "INACTIVE": "INACTIVE" }; + + +module.exports = exports; + + + diff --git a/src/model/V1ListEmployeesRequestStatus.js b/src/model/V1ListEmployeesRequestStatus.js new file mode 100644 index 0000000..7cb6244 --- /dev/null +++ b/src/model/V1ListEmployeesRequestStatus.js @@ -0,0 +1,45 @@ +/** + * 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 V1ListEmployeesRequestStatus. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "ACTIVE" + * @const + */ + "ACTIVE": "ACTIVE", + /** + * value: "INACTIVE" + * @const + */ + "INACTIVE": "INACTIVE"}; + +/** + * Returns a V1ListEmployeesRequestStatus enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1ListEmployeesRequestStatus} The enum V1ListEmployeesRequestStatus value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1ListEmployeesResponse.js b/src/model/V1ListEmployeesResponse.js new file mode 100644 index 0000000..bb090c4 --- /dev/null +++ b/src/model/V1ListEmployeesResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1Employee = require('./V1Employee'); + + + + +/** + * The V1ListEmployeesResponse model module. + * @module model/V1ListEmployeesResponse + */ + +/** + * Constructs a new V1ListEmployeesResponse. + * + * @alias module:model/V1ListEmployeesResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListEmployeesResponse 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/V1ListEmployeesResponse} obj Optional instance to populate. + * @return {module:model/V1ListEmployeesResponse} The populated V1ListEmployeesResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1Employee]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListFeesRequest.js b/src/model/V1ListFeesRequest.js new file mode 100644 index 0000000..e45d0fa --- /dev/null +++ b/src/model/V1ListFeesRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1ListFeesRequest model module. + * @module model/V1ListFeesRequest + */ + +/** + * Constructs a new V1ListFeesRequest. + * + * @alias module:model/V1ListFeesRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1ListFeesRequest 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/V1ListFeesRequest} obj Optional instance to populate. + * @return {module:model/V1ListFeesRequest} The populated V1ListFeesRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1ListFeesResponse.js b/src/model/V1ListFeesResponse.js new file mode 100644 index 0000000..fca1c02 --- /dev/null +++ b/src/model/V1ListFeesResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1Fee = require('./V1Fee'); + + + + +/** + * The V1ListFeesResponse model module. + * @module model/V1ListFeesResponse + */ + +/** + * Constructs a new V1ListFeesResponse. + * + * @alias module:model/V1ListFeesResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListFeesResponse 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/V1ListFeesResponse} obj Optional instance to populate. + * @return {module:model/V1ListFeesResponse} The populated V1ListFeesResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1Fee]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListInventoryRequest.js b/src/model/V1ListInventoryRequest.js new file mode 100644 index 0000000..f337625 --- /dev/null +++ b/src/model/V1ListInventoryRequest.js @@ -0,0 +1,74 @@ +/** + * 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'); + + + + +/** + * The V1ListInventoryRequest model module. + * @module model/V1ListInventoryRequest + */ + +/** + * Constructs a new V1ListInventoryRequest. + * + * @alias module:model/V1ListInventoryRequest + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a V1ListInventoryRequest 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/V1ListInventoryRequest} obj Optional instance to populate. + * @return {module:model/V1ListInventoryRequest} The populated V1ListInventoryRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('limit')) { + obj['limit'] = ApiClient.convertToType(data['limit'], 'Number'); + } + if (data.hasOwnProperty('batch_token')) { + obj['batch_token'] = ApiClient.convertToType(data['batch_token'], 'String'); + } + } + return obj; +} + +/** + * The maximum number of inventory entries to return in a single response. This value cannot exceed 1000. + * @member {Number} limit + */ +exports.prototype['limit'] = undefined; +/** + * A pagination cursor to retrieve the next set of results for your original query to the endpoint. + * @member {String} batch_token + */ +exports.prototype['batch_token'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListInventoryResponse.js b/src/model/V1ListInventoryResponse.js new file mode 100644 index 0000000..2635da0 --- /dev/null +++ b/src/model/V1ListInventoryResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1InventoryEntry = require('./V1InventoryEntry'); + + + + +/** + * The V1ListInventoryResponse model module. + * @module model/V1ListInventoryResponse + */ + +/** + * Constructs a new V1ListInventoryResponse. + * + * @alias module:model/V1ListInventoryResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListInventoryResponse 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/V1ListInventoryResponse} obj Optional instance to populate. + * @return {module:model/V1ListInventoryResponse} The populated V1ListInventoryResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1InventoryEntry]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListItemsRequest.js b/src/model/V1ListItemsRequest.js new file mode 100644 index 0000000..e2ca217 --- /dev/null +++ b/src/model/V1ListItemsRequest.js @@ -0,0 +1,65 @@ +/** + * 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'); + + + + +/** + * The V1ListItemsRequest model module. + * @module model/V1ListItemsRequest + */ + +/** + * Constructs a new V1ListItemsRequest. + * + * @alias module:model/V1ListItemsRequest + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListItemsRequest 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/V1ListItemsRequest} obj Optional instance to populate. + * @return {module:model/V1ListItemsRequest} The populated V1ListItemsRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('batch_token')) { + obj['batch_token'] = ApiClient.convertToType(data['batch_token'], 'String'); + } + } + return obj; +} + +/** + * A pagination cursor to retrieve the next set of results for your original query to the endpoint. + * @member {String} batch_token + */ +exports.prototype['batch_token'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListItemsResponse.js b/src/model/V1ListItemsResponse.js new file mode 100644 index 0000000..d6ac303 --- /dev/null +++ b/src/model/V1ListItemsResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1Item = require('./V1Item'); + + + + +/** + * The V1ListItemsResponse model module. + * @module model/V1ListItemsResponse + */ + +/** + * Constructs a new V1ListItemsResponse. + * + * @alias module:model/V1ListItemsResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListItemsResponse 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/V1ListItemsResponse} obj Optional instance to populate. + * @return {module:model/V1ListItemsResponse} The populated V1ListItemsResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1Item]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListLocationsRequest.js b/src/model/V1ListLocationsRequest.js new file mode 100644 index 0000000..e4f3636 --- /dev/null +++ b/src/model/V1ListLocationsRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1ListLocationsRequest model module. + * @module model/V1ListLocationsRequest + */ + +/** + * Constructs a new V1ListLocationsRequest. + * + * @alias module:model/V1ListLocationsRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1ListLocationsRequest 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/V1ListLocationsRequest} obj Optional instance to populate. + * @return {module:model/V1ListLocationsRequest} The populated V1ListLocationsRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1ListLocationsResponse.js b/src/model/V1ListLocationsResponse.js new file mode 100644 index 0000000..ddf86b5 --- /dev/null +++ b/src/model/V1ListLocationsResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1Merchant = require('./V1Merchant'); + + + + +/** + * The V1ListLocationsResponse model module. + * @module model/V1ListLocationsResponse + */ + +/** + * Constructs a new V1ListLocationsResponse. + * + * @alias module:model/V1ListLocationsResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListLocationsResponse 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/V1ListLocationsResponse} obj Optional instance to populate. + * @return {module:model/V1ListLocationsResponse} The populated V1ListLocationsResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1Merchant]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListModifierListsRequest.js b/src/model/V1ListModifierListsRequest.js new file mode 100644 index 0000000..09debc3 --- /dev/null +++ b/src/model/V1ListModifierListsRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1ListModifierListsRequest model module. + * @module model/V1ListModifierListsRequest + */ + +/** + * Constructs a new V1ListModifierListsRequest. + * + * @alias module:model/V1ListModifierListsRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1ListModifierListsRequest 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/V1ListModifierListsRequest} obj Optional instance to populate. + * @return {module:model/V1ListModifierListsRequest} The populated V1ListModifierListsRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1ListModifierListsResponse.js b/src/model/V1ListModifierListsResponse.js new file mode 100644 index 0000000..af3e4ef --- /dev/null +++ b/src/model/V1ListModifierListsResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1ModifierList = require('./V1ModifierList'); + + + + +/** + * The V1ListModifierListsResponse model module. + * @module model/V1ListModifierListsResponse + */ + +/** + * Constructs a new V1ListModifierListsResponse. + * + * @alias module:model/V1ListModifierListsResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListModifierListsResponse 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/V1ListModifierListsResponse} obj Optional instance to populate. + * @return {module:model/V1ListModifierListsResponse} The populated V1ListModifierListsResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1ModifierList]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListOrdersRequest.js b/src/model/V1ListOrdersRequest.js new file mode 100644 index 0000000..f069c69 --- /dev/null +++ b/src/model/V1ListOrdersRequest.js @@ -0,0 +1,100 @@ +/** + * 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'); + + + + +/** + * The V1ListOrdersRequest model module. + * @module model/V1ListOrdersRequest + */ + +/** + * Constructs a new V1ListOrdersRequest. + * + * @alias module:model/V1ListOrdersRequest + * @class + */ +var exports = function() { + var _this = this; + + + + +}; + +/** + * Constructs a V1ListOrdersRequest 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/V1ListOrdersRequest} obj Optional instance to populate. + * @return {module:model/V1ListOrdersRequest} The populated V1ListOrdersRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('order')) { + obj['order'] = ApiClient.convertToType(data['order'], 'String'); + } + if (data.hasOwnProperty('limit')) { + obj['limit'] = ApiClient.convertToType(data['limit'], 'Number'); + } + if (data.hasOwnProperty('batch_token')) { + obj['batch_token'] = ApiClient.convertToType(data['batch_token'], 'String'); + } + } + return obj; +} + +/** + * TThe order in which payments are listed in the response. See [SortOrder](#type-sortorder) for possible values + * @member {module:model/V1ListOrdersRequest.OrderEnum} order + */ +exports.prototype['order'] = undefined; +/** + * The maximum number of payments to return in a single response. This value cannot exceed 200. + * @member {Number} limit + */ +exports.prototype['limit'] = undefined; +/** + * A pagination cursor to retrieve the next set of results for your original query to the endpoint. + * @member {String} batch_token + */ +exports.prototype['batch_token'] = undefined; + + + /** + * Allowed values for the order property. + * @enum {String} + * @readonly + */ + exports.OrderEnum = { + /** + * value: "DESC" + * @const + */ + "DESC": "DESC", + /** + * value: "ASC" + * @const + */ + "ASC": "ASC" }; + + +module.exports = exports; + + + diff --git a/src/model/V1ListOrdersResponse.js b/src/model/V1ListOrdersResponse.js new file mode 100644 index 0000000..c2426e6 --- /dev/null +++ b/src/model/V1ListOrdersResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1Order = require('./V1Order'); + + + + +/** + * The V1ListOrdersResponse model module. + * @module model/V1ListOrdersResponse + */ + +/** + * Constructs a new V1ListOrdersResponse. + * + * @alias module:model/V1ListOrdersResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListOrdersResponse 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/V1ListOrdersResponse} obj Optional instance to populate. + * @return {module:model/V1ListOrdersResponse} The populated V1ListOrdersResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1Order]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListPagesRequest.js b/src/model/V1ListPagesRequest.js new file mode 100644 index 0000000..c869e23 --- /dev/null +++ b/src/model/V1ListPagesRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1ListPagesRequest model module. + * @module model/V1ListPagesRequest + */ + +/** + * Constructs a new V1ListPagesRequest. + * + * @alias module:model/V1ListPagesRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1ListPagesRequest 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/V1ListPagesRequest} obj Optional instance to populate. + * @return {module:model/V1ListPagesRequest} The populated V1ListPagesRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1ListPagesResponse.js b/src/model/V1ListPagesResponse.js new file mode 100644 index 0000000..fd1f6bc --- /dev/null +++ b/src/model/V1ListPagesResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1Page = require('./V1Page'); + + + + +/** + * The V1ListPagesResponse model module. + * @module model/V1ListPagesResponse + */ + +/** + * Constructs a new V1ListPagesResponse. + * + * @alias module:model/V1ListPagesResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListPagesResponse 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/V1ListPagesResponse} obj Optional instance to populate. + * @return {module:model/V1ListPagesResponse} The populated V1ListPagesResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1Page]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListPaymentsRequest.js b/src/model/V1ListPaymentsRequest.js new file mode 100644 index 0000000..01ab419 --- /dev/null +++ b/src/model/V1ListPaymentsRequest.js @@ -0,0 +1,127 @@ +/** + * 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'); + + + + +/** + * The V1ListPaymentsRequest model module. + * @module model/V1ListPaymentsRequest + */ + +/** + * Constructs a new V1ListPaymentsRequest. + * + * @alias module:model/V1ListPaymentsRequest + * @class + */ +var exports = function() { + var _this = this; + + + + + + + +}; + +/** + * Constructs a V1ListPaymentsRequest 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/V1ListPaymentsRequest} obj Optional instance to populate. + * @return {module:model/V1ListPaymentsRequest} The populated V1ListPaymentsRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('order')) { + obj['order'] = ApiClient.convertToType(data['order'], 'String'); + } + 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('limit')) { + obj['limit'] = ApiClient.convertToType(data['limit'], 'Number'); + } + if (data.hasOwnProperty('batch_token')) { + obj['batch_token'] = ApiClient.convertToType(data['batch_token'], 'String'); + } + if (data.hasOwnProperty('include_partial')) { + obj['include_partial'] = ApiClient.convertToType(data['include_partial'], 'Boolean'); + } + } + return obj; +} + +/** + * The order in which payments are listed in the response. See [SortOrder](#type-sortorder) for possible values + * @member {module:model/V1ListPaymentsRequest.OrderEnum} order + */ +exports.prototype['order'] = undefined; +/** + * The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. 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 ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. + * @member {String} end_time + */ +exports.prototype['end_time'] = undefined; +/** + * The maximum number of payments to return in a single response. This value cannot exceed 200. + * @member {Number} limit + */ +exports.prototype['limit'] = undefined; +/** + * A pagination cursor to retrieve the next set of results for your original query to the endpoint. + * @member {String} batch_token + */ +exports.prototype['batch_token'] = undefined; +/** + * Indicates whether or not to include partial payments in the response. Partial payments will have the tenders collected so far, but the itemizations will be empty until the payment is completed. + * @member {Boolean} include_partial + */ +exports.prototype['include_partial'] = undefined; + + + /** + * Allowed values for the order property. + * @enum {String} + * @readonly + */ + exports.OrderEnum = { + /** + * value: "DESC" + * @const + */ + "DESC": "DESC", + /** + * value: "ASC" + * @const + */ + "ASC": "ASC" }; + + +module.exports = exports; + + + diff --git a/src/model/V1ListPaymentsResponse.js b/src/model/V1ListPaymentsResponse.js new file mode 100644 index 0000000..9a6676b --- /dev/null +++ b/src/model/V1ListPaymentsResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1Payment = require('./V1Payment'); + + + + +/** + * The V1ListPaymentsResponse model module. + * @module model/V1ListPaymentsResponse + */ + +/** + * Constructs a new V1ListPaymentsResponse. + * + * @alias module:model/V1ListPaymentsResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListPaymentsResponse 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/V1ListPaymentsResponse} obj Optional instance to populate. + * @return {module:model/V1ListPaymentsResponse} The populated V1ListPaymentsResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1Payment]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListRefundsRequest.js b/src/model/V1ListRefundsRequest.js new file mode 100644 index 0000000..1549e63 --- /dev/null +++ b/src/model/V1ListRefundsRequest.js @@ -0,0 +1,118 @@ +/** + * 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'); + + + + +/** + * The V1ListRefundsRequest model module. + * @module model/V1ListRefundsRequest + */ + +/** + * Constructs a new V1ListRefundsRequest. + * + * @alias module:model/V1ListRefundsRequest + * @class + */ +var exports = function() { + var _this = this; + + + + + + +}; + +/** + * Constructs a V1ListRefundsRequest 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/V1ListRefundsRequest} obj Optional instance to populate. + * @return {module:model/V1ListRefundsRequest} The populated V1ListRefundsRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('order')) { + obj['order'] = ApiClient.convertToType(data['order'], 'String'); + } + 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('limit')) { + obj['limit'] = ApiClient.convertToType(data['limit'], 'Number'); + } + if (data.hasOwnProperty('batch_token')) { + obj['batch_token'] = ApiClient.convertToType(data['batch_token'], 'String'); + } + } + return obj; +} + +/** + * TThe order in which payments are listed in the response. See [SortOrder](#type-sortorder) for possible values + * @member {module:model/V1ListRefundsRequest.OrderEnum} order + */ +exports.prototype['order'] = undefined; +/** + * The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. 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 ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. + * @member {String} end_time + */ +exports.prototype['end_time'] = undefined; +/** + * The approximate number of refunds to return in a single response. Default: 100. Max: 200. Response may contain more results than the prescribed limit when refunds are made simultaneously to multiple tenders in a payment or when refunds are generated in an exchange to account for the value of returned goods. + * @member {Number} limit + */ +exports.prototype['limit'] = undefined; +/** + * A pagination cursor to retrieve the next set of results for your original query to the endpoint. + * @member {String} batch_token + */ +exports.prototype['batch_token'] = undefined; + + + /** + * Allowed values for the order property. + * @enum {String} + * @readonly + */ + exports.OrderEnum = { + /** + * value: "DESC" + * @const + */ + "DESC": "DESC", + /** + * value: "ASC" + * @const + */ + "ASC": "ASC" }; + + +module.exports = exports; + + + diff --git a/src/model/V1ListRefundsResponse.js b/src/model/V1ListRefundsResponse.js new file mode 100644 index 0000000..4cbba38 --- /dev/null +++ b/src/model/V1ListRefundsResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1Refund = require('./V1Refund'); + + + + +/** + * The V1ListRefundsResponse model module. + * @module model/V1ListRefundsResponse + */ + +/** + * Constructs a new V1ListRefundsResponse. + * + * @alias module:model/V1ListRefundsResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListRefundsResponse 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/V1ListRefundsResponse} obj Optional instance to populate. + * @return {module:model/V1ListRefundsResponse} The populated V1ListRefundsResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1Refund]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListSettlementsRequest.js b/src/model/V1ListSettlementsRequest.js new file mode 100644 index 0000000..10187a2 --- /dev/null +++ b/src/model/V1ListSettlementsRequest.js @@ -0,0 +1,144 @@ +/** + * 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'); + + + + +/** + * The V1ListSettlementsRequest model module. + * @module model/V1ListSettlementsRequest + */ + +/** + * Constructs a new V1ListSettlementsRequest. + * + * @alias module:model/V1ListSettlementsRequest + * @class + */ +var exports = function() { + var _this = this; + + + + + + + +}; + +/** + * Constructs a V1ListSettlementsRequest 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/V1ListSettlementsRequest} obj Optional instance to populate. + * @return {module:model/V1ListSettlementsRequest} The populated V1ListSettlementsRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('order')) { + obj['order'] = ApiClient.convertToType(data['order'], 'String'); + } + 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('limit')) { + obj['limit'] = ApiClient.convertToType(data['limit'], 'Number'); + } + if (data.hasOwnProperty('status')) { + obj['status'] = ApiClient.convertToType(data['status'], 'String'); + } + if (data.hasOwnProperty('batch_token')) { + obj['batch_token'] = ApiClient.convertToType(data['batch_token'], 'String'); + } + } + return obj; +} + +/** + * TThe order in which payments are listed in the response. See [SortOrder](#type-sortorder) for possible values + * @member {module:model/V1ListSettlementsRequest.OrderEnum} order + */ +exports.prototype['order'] = undefined; +/** + * The beginning of the requested reporting period, in ISO 8601 format. If this value is before January 1, 2013 (2013-01-01T00:00:00Z), this endpoint returns an error. 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 ISO 8601 format. If this value is more than one year greater than begin_time, this endpoint returns an error. Default value: The current time. + * @member {String} end_time + */ +exports.prototype['end_time'] = undefined; +/** + * The maximum number of payments to return in a single response. This value cannot exceed 200. + * @member {Number} limit + */ +exports.prototype['limit'] = undefined; +/** + * Provide this parameter to retrieve only settlements with a particular status (SENT or FAILED). See [V1ListSettlementsRequestStatus](#type-v1listsettlementsrequeststatus) for possible values + * @member {module:model/V1ListSettlementsRequest.StatusEnum} status + */ +exports.prototype['status'] = undefined; +/** + * A pagination cursor to retrieve the next set of results for your original query to the endpoint. + * @member {String} batch_token + */ +exports.prototype['batch_token'] = undefined; + + + /** + * Allowed values for the order property. + * @enum {String} + * @readonly + */ + exports.OrderEnum = { + /** + * value: "DESC" + * @const + */ + "DESC": "DESC", + /** + * value: "ASC" + * @const + */ + "ASC": "ASC" }; + + /** + * Allowed values for the status property. + * @enum {String} + * @readonly + */ + exports.StatusEnum = { + /** + * value: "SENT" + * @const + */ + "SENT": "SENT", + /** + * value: "FAILED" + * @const + */ + "FAILED": "FAILED" }; + + +module.exports = exports; + + + diff --git a/src/model/V1ListSettlementsRequestStatus.js b/src/model/V1ListSettlementsRequestStatus.js new file mode 100644 index 0000000..5de8021 --- /dev/null +++ b/src/model/V1ListSettlementsRequestStatus.js @@ -0,0 +1,45 @@ +/** + * 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 V1ListSettlementsRequestStatus. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "SENT" + * @const + */ + "SENT": "SENT", + /** + * value: "FAILED" + * @const + */ + "FAILED": "FAILED"}; + +/** + * Returns a V1ListSettlementsRequestStatus enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1ListSettlementsRequestStatus} The enum V1ListSettlementsRequestStatus value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1ListSettlementsResponse.js b/src/model/V1ListSettlementsResponse.js new file mode 100644 index 0000000..1394525 --- /dev/null +++ b/src/model/V1ListSettlementsResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1Settlement = require('./V1Settlement'); + + + + +/** + * The V1ListSettlementsResponse model module. + * @module model/V1ListSettlementsResponse + */ + +/** + * Constructs a new V1ListSettlementsResponse. + * + * @alias module:model/V1ListSettlementsResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListSettlementsResponse 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/V1ListSettlementsResponse} obj Optional instance to populate. + * @return {module:model/V1ListSettlementsResponse} The populated V1ListSettlementsResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1Settlement]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListTimecardEventsRequest.js b/src/model/V1ListTimecardEventsRequest.js new file mode 100644 index 0000000..35cae49 --- /dev/null +++ b/src/model/V1ListTimecardEventsRequest.js @@ -0,0 +1,66 @@ +/** + * 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'); + + + + +/** + * The V1ListTimecardEventsRequest model module. + * @module model/V1ListTimecardEventsRequest + */ + +/** + * Constructs a new V1ListTimecardEventsRequest. + * + * @alias module:model/V1ListTimecardEventsRequest + * @class + * @param timecardId {String} The ID of the timecard to list events for. + */ +var exports = function(timecardId) { + var _this = this; + + _this['timecard_id'] = timecardId; +}; + +/** + * Constructs a V1ListTimecardEventsRequest 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/V1ListTimecardEventsRequest} obj Optional instance to populate. + * @return {module:model/V1ListTimecardEventsRequest} The populated V1ListTimecardEventsRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('timecard_id')) { + obj['timecard_id'] = ApiClient.convertToType(data['timecard_id'], 'String'); + } + } + return obj; +} + +/** + * The ID of the timecard to list events for. + * @member {String} timecard_id + */ +exports.prototype['timecard_id'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListTimecardEventsResponse.js b/src/model/V1ListTimecardEventsResponse.js new file mode 100644 index 0000000..73fc37e --- /dev/null +++ b/src/model/V1ListTimecardEventsResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1TimecardEvent = require('./V1TimecardEvent'); + + + + +/** + * The V1ListTimecardEventsResponse model module. + * @module model/V1ListTimecardEventsResponse + */ + +/** + * Constructs a new V1ListTimecardEventsResponse. + * + * @alias module:model/V1ListTimecardEventsResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListTimecardEventsResponse 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/V1ListTimecardEventsResponse} obj Optional instance to populate. + * @return {module:model/V1ListTimecardEventsResponse} The populated V1ListTimecardEventsResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1TimecardEvent]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1ListTimecardsRequest.js b/src/model/V1ListTimecardsRequest.js new file mode 100644 index 0000000..1a0a38a --- /dev/null +++ b/src/model/V1ListTimecardsRequest.js @@ -0,0 +1,172 @@ +/** + * 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'); + + + + +/** + * The V1ListTimecardsRequest model module. + * @module model/V1ListTimecardsRequest + */ + +/** + * Constructs a new V1ListTimecardsRequest. + * + * @alias module:model/V1ListTimecardsRequest + * @class + */ +var exports = function() { + var _this = this; + + + + + + + + + + + + +}; + +/** + * Constructs a V1ListTimecardsRequest 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/V1ListTimecardsRequest} obj Optional instance to populate. + * @return {module:model/V1ListTimecardsRequest} The populated V1ListTimecardsRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('order')) { + obj['order'] = ApiClient.convertToType(data['order'], 'String'); + } + if (data.hasOwnProperty('employee_id')) { + obj['employee_id'] = ApiClient.convertToType(data['employee_id'], 'String'); + } + if (data.hasOwnProperty('begin_clockin_time')) { + obj['begin_clockin_time'] = ApiClient.convertToType(data['begin_clockin_time'], 'String'); + } + if (data.hasOwnProperty('end_clockin_time')) { + obj['end_clockin_time'] = ApiClient.convertToType(data['end_clockin_time'], 'String'); + } + if (data.hasOwnProperty('begin_clockout_time')) { + obj['begin_clockout_time'] = ApiClient.convertToType(data['begin_clockout_time'], 'String'); + } + if (data.hasOwnProperty('end_clockout_time')) { + obj['end_clockout_time'] = ApiClient.convertToType(data['end_clockout_time'], 'String'); + } + if (data.hasOwnProperty('begin_updated_at')) { + obj['begin_updated_at'] = ApiClient.convertToType(data['begin_updated_at'], 'String'); + } + if (data.hasOwnProperty('end_updated_at')) { + obj['end_updated_at'] = ApiClient.convertToType(data['end_updated_at'], 'String'); + } + if (data.hasOwnProperty('deleted')) { + obj['deleted'] = ApiClient.convertToType(data['deleted'], 'Boolean'); + } + if (data.hasOwnProperty('limit')) { + obj['limit'] = ApiClient.convertToType(data['limit'], 'Number'); + } + if (data.hasOwnProperty('batch_token')) { + obj['batch_token'] = ApiClient.convertToType(data['batch_token'], 'String'); + } + } + return obj; +} + +/** + * The order in which timecards are listed in the response, based on their created_at field. See [SortOrder](#type-sortorder) for possible values + * @member {module:model/V1ListTimecardsRequest.OrderEnum} order + */ +exports.prototype['order'] = undefined; +/** + * If provided, the endpoint returns only timecards for the employee with the specified ID. + * @member {String} employee_id + */ +exports.prototype['employee_id'] = undefined; +/** + * If filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format. + * @member {String} begin_clockin_time + */ +exports.prototype['begin_clockin_time'] = undefined; +/** + * If filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format. + * @member {String} end_clockin_time + */ +exports.prototype['end_clockin_time'] = undefined; +/** + * If filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format. + * @member {String} begin_clockout_time + */ +exports.prototype['begin_clockout_time'] = undefined; +/** + * If filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format. + * @member {String} end_clockout_time + */ +exports.prototype['end_clockout_time'] = undefined; +/** + * If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format. + * @member {String} begin_updated_at + */ +exports.prototype['begin_updated_at'] = undefined; +/** + * If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format. + * @member {String} end_updated_at + */ +exports.prototype['end_updated_at'] = undefined; +/** + * If true, only deleted timecards are returned. If false, only valid timecards are returned.If you don't provide this parameter, both valid and deleted timecards are returned. + * @member {Boolean} deleted + */ +exports.prototype['deleted'] = undefined; +/** + * The maximum integer number of employee entities to return in a single response. Default 100, maximum 200. + * @member {Number} limit + */ +exports.prototype['limit'] = undefined; +/** + * A pagination cursor to retrieve the next set of results for your original query to the endpoint. + * @member {String} batch_token + */ +exports.prototype['batch_token'] = undefined; + + + /** + * Allowed values for the order property. + * @enum {String} + * @readonly + */ + exports.OrderEnum = { + /** + * value: "DESC" + * @const + */ + "DESC": "DESC", + /** + * value: "ASC" + * @const + */ + "ASC": "ASC" }; + + +module.exports = exports; + + + diff --git a/src/model/V1ListTimecardsResponse.js b/src/model/V1ListTimecardsResponse.js new file mode 100644 index 0000000..16728c0 --- /dev/null +++ b/src/model/V1ListTimecardsResponse.js @@ -0,0 +1,66 @@ +/** + * 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 V1Timecard = require('./V1Timecard'); + + + + +/** + * The V1ListTimecardsResponse model module. + * @module model/V1ListTimecardsResponse + */ + +/** + * Constructs a new V1ListTimecardsResponse. + * + * @alias module:model/V1ListTimecardsResponse + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a V1ListTimecardsResponse 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/V1ListTimecardsResponse} obj Optional instance to populate. + * @return {module:model/V1ListTimecardsResponse} The populated V1ListTimecardsResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('items')) { + obj['items'] = ApiClient.convertToType(data['items'], [V1Timecard]); + } + } + return obj; +} + +/** + * + * @member {Array.} items + */ +exports.prototype['items'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1Merchant.js b/src/model/V1Merchant.js index cabc473..fbb9c66 100644 --- a/src/model/V1Merchant.js +++ b/src/model/V1Merchant.js @@ -97,8 +97,8 @@ exports.constructFromObject = function(data, obj) { if (data.hasOwnProperty('business_type')) { obj['business_type'] = ApiClient.convertToType(data['business_type'], 'String'); } - if (data.hasOwnProperty('shipping_address ')) { - obj['shipping_address '] = Address.constructFromObject(data['shipping_address ']); + if (data.hasOwnProperty('shipping_address')) { + obj['shipping_address'] = Address.constructFromObject(data['shipping_address']); } if (data.hasOwnProperty('location_details')) { obj['location_details'] = V1MerchantLocationDetails.constructFromObject(data['location_details']); @@ -126,7 +126,7 @@ exports.prototype['name'] = undefined; */ exports.prototype['email'] = undefined; /** - * Indicates whether the merchant account corresponds to a single-location account (LOCATION) or a business account (BUSINESS). This value is almost always LOCATION. + * Indicates whether the merchant account corresponds to a single-location account (LOCATION) or a business account (BUSINESS). This value is almost always LOCATION. See [V1MerchantAccountType](#type-v1merchantaccounttype) for possible values * @member {module:model/V1Merchant.AccountTypeEnum} account_type */ exports.prototype['account_type'] = undefined; @@ -166,16 +166,17 @@ exports.prototype['business_address'] = undefined; */ exports.prototype['business_phone'] = undefined; /** - * The type of business operated by the merchant. + * The type of business operated by the merchant. See [V1MerchantBusinessType](#type-v1merchantbusinesstype) for possible values * @member {module:model/V1Merchant.BusinessTypeEnum} business_type */ exports.prototype['business_type'] = undefined; /** * The merchant's shipping address. - * @member {module:model/Address} shipping_address + * @member {module:model/Address} shipping_address */ -exports.prototype['shipping_address '] = undefined; +exports.prototype['shipping_address'] = undefined; /** + * Additional information for a single-location account specified by its associated business account, if it has one. * @member {module:model/V1MerchantLocationDetails} location_details */ exports.prototype['location_details'] = undefined; diff --git a/src/model/V1MerchantAccountType.js b/src/model/V1MerchantAccountType.js new file mode 100644 index 0000000..aba257b --- /dev/null +++ b/src/model/V1MerchantAccountType.js @@ -0,0 +1,45 @@ +/** + * 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 V1MerchantAccountType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "LOCATION" + * @const + */ + "LOCATION": "LOCATION", + /** + * value: "BUSINESS" + * @const + */ + "BUSINESS": "BUSINESS"}; + +/** + * Returns a V1MerchantAccountType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1MerchantAccountType} The enum V1MerchantAccountType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1MerchantBusinessType.js b/src/model/V1MerchantBusinessType.js new file mode 100644 index 0000000..2c65756 --- /dev/null +++ b/src/model/V1MerchantBusinessType.js @@ -0,0 +1,285 @@ +/** + * 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 V1MerchantBusinessType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "ACCOUNTING" + * @const + */ + "ACCOUNTING": "ACCOUNTING", + /** + * value: "APPAREL_AND_ACCESSORY_SHOPS" + * @const + */ + "APPAREL_AND_ACCESSORY_SHOPS": "APPAREL_AND_ACCESSORY_SHOPS", + /** + * value: "ART_DEALERS_GALLERIES" + * @const + */ + "ART_DEALERS_GALLERIES": "ART_DEALERS_GALLERIES", + /** + * value: "ART_DESIGN_AND_PHOTOGRAPHY" + * @const + */ + "ART_DESIGN_AND_PHOTOGRAPHY": "ART_DESIGN_AND_PHOTOGRAPHY", + /** + * value: "BAR_CLUB_LOUNGE" + * @const + */ + "BAR_CLUB_LOUNGE": "BAR_CLUB_LOUNGE", + /** + * value: "BEAUTY_AND_BARBER_SHOPS" + * @const + */ + "BEAUTY_AND_BARBER_SHOPS": "BEAUTY_AND_BARBER_SHOPS", + /** + * value: "BOOK_STORES" + * @const + */ + "BOOK_STORES": "BOOK_STORES", + /** + * value: "BUSINESS_SERVICES" + * @const + */ + "BUSINESS_SERVICES": "BUSINESS_SERVICES", + /** + * value: "CATERING" + * @const + */ + "CATERING": "CATERING", + /** + * value: "CHARITABLE_SOCIAL_SERVICE_ORGANIZATIONS" + * @const + */ + "CHARITABLE_SOCIAL_SERVICE_ORGANIZATIONS": "CHARITABLE_SOCIAL_SERVICE_ORGANIZATIONS", + /** + * value: "CHARITIBLE_ORGS" + * @const + */ + "CHARITIBLE_ORGS": "CHARITIBLE_ORGS", + /** + * value: "CLEANING_SERVICES" + * @const + */ + "CLEANING_SERVICES": "CLEANING_SERVICES", + /** + * value: "COMPUTER_EQUIPMENT_SOFTWARE_MAINTENANCE_REPAIR_SERVICES" + * @const + */ + "COMPUTER_EQUIPMENT_SOFTWARE_MAINTENANCE_REPAIR_SERVICES": "COMPUTER_EQUIPMENT_SOFTWARE_MAINTENANCE_REPAIR_SERVICES", + /** + * value: "CONSULTANT" + * @const + */ + "CONSULTANT": "CONSULTANT", + /** + * value: "CONTRACTORS" + * @const + */ + "CONTRACTORS": "CONTRACTORS", + /** + * value: "DELIVERY_SERVICES" + * @const + */ + "DELIVERY_SERVICES": "DELIVERY_SERVICES", + /** + * value: "DENTISTRY" + * @const + */ + "DENTISTRY": "DENTISTRY", + /** + * value: "EDUCATION" + * @const + */ + "EDUCATION": "EDUCATION", + /** + * value: "FOOD_STORES_CONVENIENCE_STORES_AND_SPECIALTY_MARKETS" + * @const + */ + "FOOD_STORES_CONVENIENCE_STORES_AND_SPECIALTY_MARKETS": "FOOD_STORES_CONVENIENCE_STORES_AND_SPECIALTY_MARKETS", + /** + * value: "FOOD_TRUCK_CART" + * @const + */ + "FOOD_TRUCK_CART": "FOOD_TRUCK_CART", + /** + * value: "FURNITURE_HOME_AND_OFFICE_EQUIPMENT" + * @const + */ + "FURNITURE_HOME_AND_OFFICE_EQUIPMENT": "FURNITURE_HOME_AND_OFFICE_EQUIPMENT", + /** + * value: "FURNITURE_HOME_GOODS" + * @const + */ + "FURNITURE_HOME_GOODS": "FURNITURE_HOME_GOODS", + /** + * value: "HOTELS_AND_LODGING" + * @const + */ + "HOTELS_AND_LODGING": "HOTELS_AND_LODGING", + /** + * value: "INDIVIDUAL_USE" + * @const + */ + "INDIVIDUAL_USE": "INDIVIDUAL_USE", + /** + * value: "JEWELRY_AND_WATCHES" + * @const + */ + "JEWELRY_AND_WATCHES": "JEWELRY_AND_WATCHES", + /** + * value: "LANDSCAPING_AND_HORTICULTURAL_SERVICES" + * @const + */ + "LANDSCAPING_AND_HORTICULTURAL_SERVICES": "LANDSCAPING_AND_HORTICULTURAL_SERVICES", + /** + * value: "LANGUAGE_SCHOOLS" + * @const + */ + "LANGUAGE_SCHOOLS": "LANGUAGE_SCHOOLS", + /** + * value: "LEGAL_SERVICES" + * @const + */ + "LEGAL_SERVICES": "LEGAL_SERVICES", + /** + * value: "MEDICAL_PRACTITIONERS" + * @const + */ + "MEDICAL_PRACTITIONERS": "MEDICAL_PRACTITIONERS", + /** + * value: "MEDICAL_SERVICES_AND_HEALTH_PRACTITIONERS" + * @const + */ + "MEDICAL_SERVICES_AND_HEALTH_PRACTITIONERS": "MEDICAL_SERVICES_AND_HEALTH_PRACTITIONERS", + /** + * value: "MEMBERSHIP_ORGANIZATIONS" + * @const + */ + "MEMBERSHIP_ORGANIZATIONS": "MEMBERSHIP_ORGANIZATIONS", + /** + * value: "MUSIC_AND_ENTERTAINMENT" + * @const + */ + "MUSIC_AND_ENTERTAINMENT": "MUSIC_AND_ENTERTAINMENT", + /** + * value: "OTHER" + * @const + */ + "OTHER": "OTHER", + /** + * value: "OUTDOOR_MARKETS" + * @const + */ + "OUTDOOR_MARKETS": "OUTDOOR_MARKETS", + /** + * value: "PERSONAL_SERVICES" + * @const + */ + "PERSONAL_SERVICES": "PERSONAL_SERVICES", + /** + * value: "POLITICAL_ORGANIZATIONS" + * @const + */ + "POLITICAL_ORGANIZATIONS": "POLITICAL_ORGANIZATIONS", + /** + * value: "PROFESSIONAL_SERVICES" + * @const + */ + "PROFESSIONAL_SERVICES": "PROFESSIONAL_SERVICES", + /** + * value: "REAL_ESTATE" + * @const + */ + "REAL_ESTATE": "REAL_ESTATE", + /** + * value: "RECREATION_SERVICES" + * @const + */ + "RECREATION_SERVICES": "RECREATION_SERVICES", + /** + * value: "REPAIR_SHOPS_AND_RELATED_SERVICES" + * @const + */ + "REPAIR_SHOPS_AND_RELATED_SERVICES": "REPAIR_SHOPS_AND_RELATED_SERVICES", + /** + * value: "RESTAURANTS" + * @const + */ + "RESTAURANTS": "RESTAURANTS", + /** + * value: "RETAIL_SHOPS" + * @const + */ + "RETAIL_SHOPS": "RETAIL_SHOPS", + /** + * value: "SCHOOLS_AND_EDUCATIONAL_SERVICES" + * @const + */ + "SCHOOLS_AND_EDUCATIONAL_SERVICES": "SCHOOLS_AND_EDUCATIONAL_SERVICES", + /** + * value: "SPORTING_GOODS" + * @const + */ + "SPORTING_GOODS": "SPORTING_GOODS", + /** + * value: "TAXICABS_AND_LIMOUSINES" + * @const + */ + "TAXICABS_AND_LIMOUSINES": "TAXICABS_AND_LIMOUSINES", + /** + * value: "TICKET_SALES" + * @const + */ + "TICKET_SALES": "TICKET_SALES", + /** + * value: "TOURISM" + * @const + */ + "TOURISM": "TOURISM", + /** + * value: "TRAVEL_TOURISM" + * @const + */ + "TRAVEL_TOURISM": "TRAVEL_TOURISM", + /** + * value: "VETERINARY_SERVICES" + * @const + */ + "VETERINARY_SERVICES": "VETERINARY_SERVICES", + /** + * value: "WEB_DEV_DESIGN" + * @const + */ + "WEB_DEV_DESIGN": "WEB_DEV_DESIGN"}; + +/** + * Returns a V1MerchantBusinessType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1MerchantBusinessType} The enum V1MerchantBusinessType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1ModifierList.js b/src/model/V1ModifierList.js index 5829089..43cbcdf 100644 --- a/src/model/V1ModifierList.js +++ b/src/model/V1ModifierList.js @@ -24,6 +24,7 @@ var V1ModifierOption = require('./V1ModifierOption'); /** * Constructs a new V1ModifierList. + * V1ModifierList * @alias module:model/V1ModifierList * @class */ @@ -74,7 +75,7 @@ exports.prototype['id'] = undefined; */ exports.prototype['name'] = undefined; /** - * Indicates whether MULTIPLE options or a SINGLE option from the modifier list can be applied to a single item. + * Indicates whether MULTIPLE options or a SINGLE option from the modifier list can be applied to a single item. See [V1ModifierListSelectionType](#type-v1modifierlistselectiontype) for possible values * @member {module:model/V1ModifierList.SelectionTypeEnum} selection_type */ exports.prototype['selection_type'] = undefined; diff --git a/src/model/V1ModifierListSelectionType.js b/src/model/V1ModifierListSelectionType.js new file mode 100644 index 0000000..d0c0bd4 --- /dev/null +++ b/src/model/V1ModifierListSelectionType.js @@ -0,0 +1,45 @@ +/** + * 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 V1ModifierListSelectionType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "SINGLE" + * @const + */ + "SINGLE": "SINGLE", + /** + * value: "MULTIPLE" + * @const + */ + "MULTIPLE": "MULTIPLE"}; + +/** + * Returns a V1ModifierListSelectionType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1ModifierListSelectionType} The enum V1ModifierListSelectionType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1ModifierOption.js b/src/model/V1ModifierOption.js index bf0aebf..c3ee3ba 100644 --- a/src/model/V1ModifierOption.js +++ b/src/model/V1ModifierOption.js @@ -24,6 +24,7 @@ var V1Money = require('./V1Money'); /** * Constructs a new V1ModifierOption. + * V1ModifierOption * @alias module:model/V1ModifierOption * @class */ diff --git a/src/model/V1Money.js b/src/model/V1Money.js index 0ee6426..ea5e35e 100644 --- a/src/model/V1Money.js +++ b/src/model/V1Money.js @@ -61,7 +61,7 @@ exports.constructFromObject = function(data, obj) { */ exports.prototype['amount'] = undefined; /** - * + * See [Currency](#type-currency) for possible values * @member {module:model/V1Money.CurrencyCodeEnum} currency_code */ exports.prototype['currency_code'] = undefined; @@ -73,6 +73,11 @@ exports.prototype['currency_code'] = undefined; * @readonly */ exports.CurrencyCodeEnum = { + /** + * value: "UNKNOWN_CURRENCY" + * @const + */ + "UNKNOWN_CURRENCY": "UNKNOWN_CURRENCY", /** * value: "AED" * @const diff --git a/src/model/V1Order.js b/src/model/V1Order.js index 6fc63ab..f3f62d2 100644 --- a/src/model/V1Order.js +++ b/src/model/V1Order.js @@ -28,6 +28,7 @@ var V1Tender = require('./V1Tender'); /** * Constructs a new V1Order. + * V1Order * @alias module:model/V1Order * @class */ @@ -177,7 +178,7 @@ exports.prototype['recipient_name'] = undefined; */ exports.prototype['recipient_phone_number'] = undefined; /** - * Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. + * Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. See [V1OrderState](#type-v1orderstate) for possible values * @member {module:model/V1Order.StateEnum} state */ exports.prototype['state'] = undefined; diff --git a/src/model/V1OrderHistoryEntry.js b/src/model/V1OrderHistoryEntry.js index b89ed84..7e33ca1 100644 --- a/src/model/V1OrderHistoryEntry.js +++ b/src/model/V1OrderHistoryEntry.js @@ -23,6 +23,7 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new V1OrderHistoryEntry. + * V1OrderHistoryEntry * @alias module:model/V1OrderHistoryEntry * @class */ @@ -55,7 +56,7 @@ exports.constructFromObject = function(data, obj) { } /** - * The type of action performed on the order. + * The type of action performed on the order. See [V1OrderHistoryEntryAction](#type-v1orderhistoryentryaction) for possible values * @member {module:model/V1OrderHistoryEntry.ActionEnum} action */ exports.prototype['action'] = undefined; diff --git a/src/model/V1OrderHistoryEntryAction.js b/src/model/V1OrderHistoryEntryAction.js new file mode 100644 index 0000000..f3f02bd --- /dev/null +++ b/src/model/V1OrderHistoryEntryAction.js @@ -0,0 +1,70 @@ +/** + * 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 V1OrderHistoryEntryAction. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "ORDER_PLACED" + * @const + */ + "ORDER_PLACED": "ORDER_PLACED", + /** + * value: "DECLINED" + * @const + */ + "DECLINED": "DECLINED", + /** + * value: "PAYMENT_RECEIVED" + * @const + */ + "PAYMENT_RECEIVED": "PAYMENT_RECEIVED", + /** + * value: "CANCELED" + * @const + */ + "CANCELED": "CANCELED", + /** + * value: "COMPLETED" + * @const + */ + "COMPLETED": "COMPLETED", + /** + * value: "REFUNDED" + * @const + */ + "REFUNDED": "REFUNDED", + /** + * value: "EXPIRED" + * @const + */ + "EXPIRED": "EXPIRED"}; + +/** + * Returns a V1OrderHistoryEntryAction enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1OrderHistoryEntryAction} The enum V1OrderHistoryEntryAction value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1OrderState.js b/src/model/V1OrderState.js new file mode 100644 index 0000000..cbf9c0c --- /dev/null +++ b/src/model/V1OrderState.js @@ -0,0 +1,65 @@ +/** + * 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 V1OrderState. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "PENDING" + * @const + */ + "PENDING": "PENDING", + /** + * value: "OPEN" + * @const + */ + "OPEN": "OPEN", + /** + * value: "COMPLETED" + * @const + */ + "COMPLETED": "COMPLETED", + /** + * value: "CANCELED" + * @const + */ + "CANCELED": "CANCELED", + /** + * value: "REFUNDED" + * @const + */ + "REFUNDED": "REFUNDED", + /** + * value: "REJECTED" + * @const + */ + "REJECTED": "REJECTED"}; + +/** + * Returns a V1OrderState enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1OrderState} The enum V1OrderState value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1Page.js b/src/model/V1Page.js index a76c461..a2ace86 100644 --- a/src/model/V1Page.js +++ b/src/model/V1Page.js @@ -24,6 +24,7 @@ var V1PageCell = require('./V1PageCell'); /** * Constructs a new V1Page. + * V1Page * @alias module:model/V1Page * @class */ diff --git a/src/model/V1PageCell.js b/src/model/V1PageCell.js index 93fe732..a23887b 100644 --- a/src/model/V1PageCell.js +++ b/src/model/V1PageCell.js @@ -23,6 +23,7 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new V1PageCell. + * V1PageCell * @alias module:model/V1PageCell * @class */ @@ -86,7 +87,7 @@ exports.prototype['row'] = undefined; */ exports.prototype['column'] = undefined; /** - * The type of entity represented in the cell (ITEM, DISCOUNT, CATEGORY, or PLACEHOLDER). + * The type of entity represented in the cell (ITEM, DISCOUNT, CATEGORY, or PLACEHOLDER). See [V1PageCellObjectType](#type-v1pagecellobjecttype) for possible values * @member {module:model/V1PageCell.ObjectTypeEnum} object_type */ exports.prototype['object_type'] = undefined; @@ -96,7 +97,7 @@ exports.prototype['object_type'] = undefined; */ exports.prototype['object_id'] = undefined; /** - * For a cell with an object_type of PLACEHOLDER, this value indicates the cell's special behavior. + * For a cell with an object_type of PLACEHOLDER, this value indicates the cell's special behavior. See [V1PageCellPlaceholderType](#type-v1pagecellplaceholdertype) for possible values * @member {module:model/V1PageCell.PlaceholderTypeEnum} placeholder_type */ exports.prototype['placeholder_type'] = undefined; diff --git a/src/model/V1PageCellObjectType.js b/src/model/V1PageCellObjectType.js new file mode 100644 index 0000000..366fa7f --- /dev/null +++ b/src/model/V1PageCellObjectType.js @@ -0,0 +1,55 @@ +/** + * 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 V1PageCellObjectType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "ITEM" + * @const + */ + "ITEM": "ITEM", + /** + * value: "DISCOUNT" + * @const + */ + "DISCOUNT": "DISCOUNT", + /** + * value: "CATEGORY" + * @const + */ + "CATEGORY": "CATEGORY", + /** + * value: "PLACEHOLDER" + * @const + */ + "PLACEHOLDER": "PLACEHOLDER"}; + +/** + * Returns a V1PageCellObjectType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1PageCellObjectType} The enum V1PageCellObjectType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1PageCellPlaceholderType.js b/src/model/V1PageCellPlaceholderType.js new file mode 100644 index 0000000..be4d1e3 --- /dev/null +++ b/src/model/V1PageCellPlaceholderType.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 V1PageCellPlaceholderType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "ALL_ITEMS" + * @const + */ + "ALL_ITEMS": "ALL_ITEMS", + /** + * value: "DISCOUNTS_CATEGORY" + * @const + */ + "DISCOUNTS_CATEGORY": "DISCOUNTS_CATEGORY", + /** + * value: "REWARDS_FINDER" + * @const + */ + "REWARDS_FINDER": "REWARDS_FINDER"}; + +/** + * Returns a V1PageCellPlaceholderType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1PageCellPlaceholderType} The enum V1PageCellPlaceholderType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1Payment.js b/src/model/V1Payment.js index a3439ac..8b0988b 100644 --- a/src/model/V1Payment.js +++ b/src/model/V1Payment.js @@ -30,6 +30,7 @@ var V1Tender = require('./V1Tender'); /** * Constructs a new V1Payment. + * A payment represents a paid transaction between a Square merchant and a customer. Payment details are usually available from Connect API endpoints within a few minutes after the transaction completes. Each Payment object includes several fields that end in `_money`. These fields describe the various amounts of money that contribute to the payment total: <ul> <li> Monetary values are <b>positive</b> if they represent an <em>increase</em> in the amount of money the merchant receives (e.g., <code>tax_money</code>, <code>tip_money</code>). </li> <li> Monetary values are <b>negative</b> if they represent an <em>decrease</em> in the amount of money the merchant receives (e.g., <code>discount_money</code>, <code>refunded_money</code>). </li> </ul> * @alias module:model/V1Payment * @class */ diff --git a/src/model/V1PaymentDiscount.js b/src/model/V1PaymentDiscount.js index 83ff64e..0ef497f 100644 --- a/src/model/V1PaymentDiscount.js +++ b/src/model/V1PaymentDiscount.js @@ -24,6 +24,7 @@ var V1Money = require('./V1Money'); /** * Constructs a new V1PaymentDiscount. + * V1PaymentDiscount * @alias module:model/V1PaymentDiscount * @class */ diff --git a/src/model/V1PaymentItemDetail.js b/src/model/V1PaymentItemDetail.js index 2f5aa5b..68a3266 100644 --- a/src/model/V1PaymentItemDetail.js +++ b/src/model/V1PaymentItemDetail.js @@ -23,6 +23,7 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new V1PaymentItemDetail. + * V1PaymentItemDetail * @alias module:model/V1PaymentItemDetail * @class */ diff --git a/src/model/V1PaymentItemization.js b/src/model/V1PaymentItemization.js index e7962a5..58a2408 100644 --- a/src/model/V1PaymentItemization.js +++ b/src/model/V1PaymentItemization.js @@ -28,6 +28,7 @@ var V1PaymentTax = require('./V1PaymentTax'); /** * Constructs a new V1PaymentItemization. + * Payment include an` itemizations` field that lists the items purchased, along with associated fees, modifiers, and discounts. Each itemization has an `itemization_type` field that indicates which of the following the itemization represents: <ul> <li>An item variation from the merchant's item library</li> <li>A custom monetary amount</li> <li> An action performed on a Square gift card, such as activating or reloading it. </li> </ul> *Note**: itemization information included in a `Payment` object reflects details collected **at the time of the payment**. Details such as the name or price of items might have changed since the payment was processed. * @alias module:model/V1PaymentItemization * @class */ @@ -118,7 +119,7 @@ exports.prototype['name'] = undefined; */ exports.prototype['quantity'] = undefined; /** - * The type of purchase that the itemization represents, such as an ITEM or CUSTOM_AMOUNT + * The type of purchase that the itemization represents, such as an ITEM or CUSTOM_AMOUNT See [V1PaymentItemizationItemizationType](#type-v1paymentitemizationitemizationtype) for possible values * @member {module:model/V1PaymentItemization.ItemizationTypeEnum} itemization_type */ exports.prototype['itemization_type'] = undefined; diff --git a/src/model/V1PaymentItemizationItemizationType.js b/src/model/V1PaymentItemizationItemizationType.js new file mode 100644 index 0000000..ddd3e8d --- /dev/null +++ b/src/model/V1PaymentItemizationItemizationType.js @@ -0,0 +1,65 @@ +/** + * 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 V1PaymentItemizationItemizationType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "ITEM" + * @const + */ + "ITEM": "ITEM", + /** + * value: "CUSTOM_AMOUNT" + * @const + */ + "CUSTOM_AMOUNT": "CUSTOM_AMOUNT", + /** + * value: "GIFT_CARD_ACTIVATION" + * @const + */ + "GIFT_CARD_ACTIVATION": "GIFT_CARD_ACTIVATION", + /** + * value: "GIFT_CARD_RELOAD" + * @const + */ + "GIFT_CARD_RELOAD": "GIFT_CARD_RELOAD", + /** + * value: "GIFT_CARD_UNKNOWN" + * @const + */ + "GIFT_CARD_UNKNOWN": "GIFT_CARD_UNKNOWN", + /** + * value: "OTHER" + * @const + */ + "OTHER": "OTHER"}; + +/** + * Returns a V1PaymentItemizationItemizationType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1PaymentItemizationItemizationType} The enum V1PaymentItemizationItemizationType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1PaymentModifier.js b/src/model/V1PaymentModifier.js index 807582b..56df644 100644 --- a/src/model/V1PaymentModifier.js +++ b/src/model/V1PaymentModifier.js @@ -24,6 +24,7 @@ var V1Money = require('./V1Money'); /** * Constructs a new V1PaymentModifier. + * V1PaymentModifier * @alias module:model/V1PaymentModifier * @class */ diff --git a/src/model/V1PaymentSurcharge.js b/src/model/V1PaymentSurcharge.js index 51e44cf..4747a27 100644 --- a/src/model/V1PaymentSurcharge.js +++ b/src/model/V1PaymentSurcharge.js @@ -25,6 +25,7 @@ var V1PaymentTax = require('./V1PaymentTax'); /** * Constructs a new V1PaymentSurcharge. + * V1PaymentSurcharge * @alias module:model/V1PaymentSurcharge * @class */ @@ -101,7 +102,7 @@ exports.prototype['rate'] = undefined; */ exports.prototype['amount_money'] = undefined; /** - * Indicates the source of the surcharge. For example, if it was applied as an automatic gratuity for a large group. + * Indicates the source of the surcharge. For example, if it was applied as an automatic gratuity for a large group. See [V1PaymentSurchargeType](#type-v1paymentsurchargetype) for possible values * @member {module:model/V1PaymentSurcharge.TypeEnum} type */ exports.prototype['type'] = undefined; diff --git a/src/model/V1PaymentSurchargeType.js b/src/model/V1PaymentSurchargeType.js new file mode 100644 index 0000000..26472f5 --- /dev/null +++ b/src/model/V1PaymentSurchargeType.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 V1PaymentSurchargeType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "UNKNOWN" + * @const + */ + "UNKNOWN": "UNKNOWN", + /** + * value: "AUTO_GRATUITY" + * @const + */ + "AUTO_GRATUITY": "AUTO_GRATUITY", + /** + * value: "CUSTOM" + * @const + */ + "CUSTOM": "CUSTOM"}; + +/** + * Returns a V1PaymentSurchargeType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1PaymentSurchargeType} The enum V1PaymentSurchargeType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1PaymentTax.js b/src/model/V1PaymentTax.js index 2794a38..93ba571 100644 --- a/src/model/V1PaymentTax.js +++ b/src/model/V1PaymentTax.js @@ -25,6 +25,7 @@ var V1Money = require('./V1Money'); /** * Constructs a new V1PaymentTax. + * V1PaymentTax * @alias module:model/V1PaymentTax * @class */ @@ -93,7 +94,7 @@ exports.prototype['applied_money'] = undefined; */ exports.prototype['rate'] = undefined; /** - * Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. + * Whether the tax is an ADDITIVE tax or an INCLUSIVE tax. See [V1PaymentTaxInclusionType](#type-v1paymenttaxinclusiontype) for possible values * @member {module:model/V1PaymentTax.InclusionTypeEnum} inclusion_type */ exports.prototype['inclusion_type'] = undefined; diff --git a/src/model/V1PaymentTaxInclusionType.js b/src/model/V1PaymentTaxInclusionType.js new file mode 100644 index 0000000..26297a5 --- /dev/null +++ b/src/model/V1PaymentTaxInclusionType.js @@ -0,0 +1,45 @@ +/** + * 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 V1PaymentTaxInclusionType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "ADDITIVE" + * @const + */ + "ADDITIVE": "ADDITIVE", + /** + * value: "INCLUSIVE" + * @const + */ + "INCLUSIVE": "INCLUSIVE"}; + +/** + * Returns a V1PaymentTaxInclusionType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1PaymentTaxInclusionType} The enum V1PaymentTaxInclusionType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1Refund.js b/src/model/V1Refund.js index 6aaa841..5de7a59 100644 --- a/src/model/V1Refund.js +++ b/src/model/V1Refund.js @@ -26,6 +26,7 @@ var V1PaymentTax = require('./V1PaymentTax'); /** * Constructs a new V1Refund. + * V1Refund * @alias module:model/V1Refund * @class */ @@ -122,7 +123,7 @@ exports.constructFromObject = function(data, obj) { } /** - * The type of refund + * The type of refund See [V1RefundType](#type-v1refundtype) for possible values * @member {module:model/V1Refund.TypeEnum} type */ exports.prototype['type'] = undefined; diff --git a/src/model/V1RefundType.js b/src/model/V1RefundType.js new file mode 100644 index 0000000..6d8e707 --- /dev/null +++ b/src/model/V1RefundType.js @@ -0,0 +1,45 @@ +/** + * 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 V1RefundType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "FULL" + * @const + */ + "FULL": "FULL", + /** + * value: "PARTIAL" + * @const + */ + "PARTIAL": "PARTIAL"}; + +/** + * Returns a V1RefundType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1RefundType} The enum V1RefundType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1RemoveFeeRequest.js b/src/model/V1RemoveFeeRequest.js new file mode 100644 index 0000000..1d52c9c --- /dev/null +++ b/src/model/V1RemoveFeeRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1RemoveFeeRequest model module. + * @module model/V1RemoveFeeRequest + */ + +/** + * Constructs a new V1RemoveFeeRequest. + * + * @alias module:model/V1RemoveFeeRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1RemoveFeeRequest 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/V1RemoveFeeRequest} obj Optional instance to populate. + * @return {module:model/V1RemoveFeeRequest} The populated V1RemoveFeeRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1RemoveModifierListRequest.js b/src/model/V1RemoveModifierListRequest.js new file mode 100644 index 0000000..7ed86d9 --- /dev/null +++ b/src/model/V1RemoveModifierListRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1RemoveModifierListRequest model module. + * @module model/V1RemoveModifierListRequest + */ + +/** + * Constructs a new V1RemoveModifierListRequest. + * + * @alias module:model/V1RemoveModifierListRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1RemoveModifierListRequest 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/V1RemoveModifierListRequest} obj Optional instance to populate. + * @return {module:model/V1RemoveModifierListRequest} The populated V1RemoveModifierListRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1RetrieveBankAccountRequest.js b/src/model/V1RetrieveBankAccountRequest.js new file mode 100644 index 0000000..b96431a --- /dev/null +++ b/src/model/V1RetrieveBankAccountRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1RetrieveBankAccountRequest model module. + * @module model/V1RetrieveBankAccountRequest + */ + +/** + * Constructs a new V1RetrieveBankAccountRequest. + * + * @alias module:model/V1RetrieveBankAccountRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1RetrieveBankAccountRequest 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/V1RetrieveBankAccountRequest} obj Optional instance to populate. + * @return {module:model/V1RetrieveBankAccountRequest} The populated V1RetrieveBankAccountRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1RetrieveBusinessRequest.js b/src/model/V1RetrieveBusinessRequest.js new file mode 100644 index 0000000..91a0859 --- /dev/null +++ b/src/model/V1RetrieveBusinessRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1RetrieveBusinessRequest model module. + * @module model/V1RetrieveBusinessRequest + */ + +/** + * Constructs a new V1RetrieveBusinessRequest. + * + * @alias module:model/V1RetrieveBusinessRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1RetrieveBusinessRequest 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/V1RetrieveBusinessRequest} obj Optional instance to populate. + * @return {module:model/V1RetrieveBusinessRequest} The populated V1RetrieveBusinessRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1RetrieveCashDrawerShiftRequest.js b/src/model/V1RetrieveCashDrawerShiftRequest.js new file mode 100644 index 0000000..e762041 --- /dev/null +++ b/src/model/V1RetrieveCashDrawerShiftRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1RetrieveCashDrawerShiftRequest model module. + * @module model/V1RetrieveCashDrawerShiftRequest + */ + +/** + * Constructs a new V1RetrieveCashDrawerShiftRequest. + * + * @alias module:model/V1RetrieveCashDrawerShiftRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1RetrieveCashDrawerShiftRequest 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/V1RetrieveCashDrawerShiftRequest} obj Optional instance to populate. + * @return {module:model/V1RetrieveCashDrawerShiftRequest} The populated V1RetrieveCashDrawerShiftRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1RetrieveEmployeeRequest.js b/src/model/V1RetrieveEmployeeRequest.js new file mode 100644 index 0000000..f58349c --- /dev/null +++ b/src/model/V1RetrieveEmployeeRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1RetrieveEmployeeRequest model module. + * @module model/V1RetrieveEmployeeRequest + */ + +/** + * Constructs a new V1RetrieveEmployeeRequest. + * + * @alias module:model/V1RetrieveEmployeeRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1RetrieveEmployeeRequest 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/V1RetrieveEmployeeRequest} obj Optional instance to populate. + * @return {module:model/V1RetrieveEmployeeRequest} The populated V1RetrieveEmployeeRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1RetrieveEmployeeRoleRequest.js b/src/model/V1RetrieveEmployeeRoleRequest.js new file mode 100644 index 0000000..52f9ea7 --- /dev/null +++ b/src/model/V1RetrieveEmployeeRoleRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1RetrieveEmployeeRoleRequest model module. + * @module model/V1RetrieveEmployeeRoleRequest + */ + +/** + * Constructs a new V1RetrieveEmployeeRoleRequest. + * + * @alias module:model/V1RetrieveEmployeeRoleRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1RetrieveEmployeeRoleRequest 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/V1RetrieveEmployeeRoleRequest} obj Optional instance to populate. + * @return {module:model/V1RetrieveEmployeeRoleRequest} The populated V1RetrieveEmployeeRoleRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1RetrieveItemRequest.js b/src/model/V1RetrieveItemRequest.js new file mode 100644 index 0000000..c84d693 --- /dev/null +++ b/src/model/V1RetrieveItemRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1RetrieveItemRequest model module. + * @module model/V1RetrieveItemRequest + */ + +/** + * Constructs a new V1RetrieveItemRequest. + * + * @alias module:model/V1RetrieveItemRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1RetrieveItemRequest 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/V1RetrieveItemRequest} obj Optional instance to populate. + * @return {module:model/V1RetrieveItemRequest} The populated V1RetrieveItemRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1RetrieveModifierListRequest.js b/src/model/V1RetrieveModifierListRequest.js new file mode 100644 index 0000000..cf1721d --- /dev/null +++ b/src/model/V1RetrieveModifierListRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1RetrieveModifierListRequest model module. + * @module model/V1RetrieveModifierListRequest + */ + +/** + * Constructs a new V1RetrieveModifierListRequest. + * + * @alias module:model/V1RetrieveModifierListRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1RetrieveModifierListRequest 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/V1RetrieveModifierListRequest} obj Optional instance to populate. + * @return {module:model/V1RetrieveModifierListRequest} The populated V1RetrieveModifierListRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1RetrieveOrderRequest.js b/src/model/V1RetrieveOrderRequest.js new file mode 100644 index 0000000..beab8fa --- /dev/null +++ b/src/model/V1RetrieveOrderRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1RetrieveOrderRequest model module. + * @module model/V1RetrieveOrderRequest + */ + +/** + * Constructs a new V1RetrieveOrderRequest. + * + * @alias module:model/V1RetrieveOrderRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1RetrieveOrderRequest 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/V1RetrieveOrderRequest} obj Optional instance to populate. + * @return {module:model/V1RetrieveOrderRequest} The populated V1RetrieveOrderRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1RetrievePaymentRequest.js b/src/model/V1RetrievePaymentRequest.js new file mode 100644 index 0000000..6f2bdd2 --- /dev/null +++ b/src/model/V1RetrievePaymentRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1RetrievePaymentRequest model module. + * @module model/V1RetrievePaymentRequest + */ + +/** + * Constructs a new V1RetrievePaymentRequest. + * + * @alias module:model/V1RetrievePaymentRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1RetrievePaymentRequest 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/V1RetrievePaymentRequest} obj Optional instance to populate. + * @return {module:model/V1RetrievePaymentRequest} The populated V1RetrievePaymentRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1RetrieveSettlementRequest.js b/src/model/V1RetrieveSettlementRequest.js new file mode 100644 index 0000000..1a4e179 --- /dev/null +++ b/src/model/V1RetrieveSettlementRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1RetrieveSettlementRequest model module. + * @module model/V1RetrieveSettlementRequest + */ + +/** + * Constructs a new V1RetrieveSettlementRequest. + * + * @alias module:model/V1RetrieveSettlementRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1RetrieveSettlementRequest 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/V1RetrieveSettlementRequest} obj Optional instance to populate. + * @return {module:model/V1RetrieveSettlementRequest} The populated V1RetrieveSettlementRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1RetrieveTimecardRequest.js b/src/model/V1RetrieveTimecardRequest.js new file mode 100644 index 0000000..8aa91b1 --- /dev/null +++ b/src/model/V1RetrieveTimecardRequest.js @@ -0,0 +1,56 @@ +/** + * 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'); + + + + +/** + * The V1RetrieveTimecardRequest model module. + * @module model/V1RetrieveTimecardRequest + */ + +/** + * Constructs a new V1RetrieveTimecardRequest. + * + * @alias module:model/V1RetrieveTimecardRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a V1RetrieveTimecardRequest 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/V1RetrieveTimecardRequest} obj Optional instance to populate. + * @return {module:model/V1RetrieveTimecardRequest} The populated V1RetrieveTimecardRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/V1Settlement.js b/src/model/V1Settlement.js index 014e324..b97401b 100644 --- a/src/model/V1Settlement.js +++ b/src/model/V1Settlement.js @@ -25,6 +25,7 @@ var V1SettlementEntry = require('./V1SettlementEntry'); /** * Constructs a new V1Settlement. + * V1Settlement * @alias module:model/V1Settlement * @class */ @@ -78,7 +79,7 @@ exports.constructFromObject = function(data, obj) { */ exports.prototype['id'] = undefined; /** - * The settlement's current status. + * The settlement's current status. See [V1SettlementStatus](#type-v1settlementstatus) for possible values * @member {module:model/V1Settlement.StatusEnum} status */ exports.prototype['status'] = undefined; diff --git a/src/model/V1SettlementEntry.js b/src/model/V1SettlementEntry.js index 9a9f6cc..32d208f 100644 --- a/src/model/V1SettlementEntry.js +++ b/src/model/V1SettlementEntry.js @@ -24,6 +24,7 @@ var V1Money = require('./V1Money'); /** * Constructs a new V1SettlementEntry. + * V1SettlementEntry * @alias module:model/V1SettlementEntry * @class */ @@ -69,7 +70,7 @@ exports.constructFromObject = function(data, obj) { */ exports.prototype['payment_id'] = undefined; /** - * The settlement's current status. + * The settlement's current status. See [V1SettlementEntryType](#type-v1settlemententrytype) for possible values * @member {module:model/V1SettlementEntry.TypeEnum} type */ exports.prototype['type'] = undefined; @@ -190,7 +191,12 @@ exports.prototype['fee_money'] = undefined; * value: "SQUARE_275" * @const */ - "SQUARE_275": "SQUARE_275" }; + "SQUARE_275": "SQUARE_275", + /** + * value: "SQUARE_CARD" + * @const + */ + "SQUARE_CARD": "SQUARE_CARD" }; module.exports = exports; diff --git a/src/model/V1SettlementEntryType.js b/src/model/V1SettlementEntryType.js new file mode 100644 index 0000000..57d7ed4 --- /dev/null +++ b/src/model/V1SettlementEntryType.js @@ -0,0 +1,140 @@ +/** + * 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 V1SettlementEntryType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "ADJUSTMENT" + * @const + */ + "ADJUSTMENT": "ADJUSTMENT", + /** + * value: "BALANCE_CHARGE" + * @const + */ + "BALANCE_CHARGE": "BALANCE_CHARGE", + /** + * value: "CHARGE" + * @const + */ + "CHARGE": "CHARGE", + /** + * value: "FREE_PROCESSING" + * @const + */ + "FREE_PROCESSING": "FREE_PROCESSING", + /** + * value: "HOLD_ADJUSTMENT" + * @const + */ + "HOLD_ADJUSTMENT": "HOLD_ADJUSTMENT", + /** + * value: "PAID_SERVICE_FEE" + * @const + */ + "PAID_SERVICE_FEE": "PAID_SERVICE_FEE", + /** + * value: "PAID_SERVICE_FEE_REFUND" + * @const + */ + "PAID_SERVICE_FEE_REFUND": "PAID_SERVICE_FEE_REFUND", + /** + * value: "REDEMPTION_CODE" + * @const + */ + "REDEMPTION_CODE": "REDEMPTION_CODE", + /** + * value: "REFUND" + * @const + */ + "REFUND": "REFUND", + /** + * value: "RETURNED_PAYOUT" + * @const + */ + "RETURNED_PAYOUT": "RETURNED_PAYOUT", + /** + * value: "SQUARE_CAPITAL_ADVANCE" + * @const + */ + "SQUARE_CAPITAL_ADVANCE": "SQUARE_CAPITAL_ADVANCE", + /** + * value: "SQUARE_CAPITAL_PAYMENT" + * @const + */ + "SQUARE_CAPITAL_PAYMENT": "SQUARE_CAPITAL_PAYMENT", + /** + * value: "SQUARE_CAPITAL_REVERSED_PAYMENT" + * @const + */ + "SQUARE_CAPITAL_REVERSED_PAYMENT": "SQUARE_CAPITAL_REVERSED_PAYMENT", + /** + * value: "SUBSCRIPTION_FEE" + * @const + */ + "SUBSCRIPTION_FEE": "SUBSCRIPTION_FEE", + /** + * value: "SUBSCRIPTION_FEE_REFUND" + * @const + */ + "SUBSCRIPTION_FEE_REFUND": "SUBSCRIPTION_FEE_REFUND", + /** + * value: "OTHER" + * @const + */ + "OTHER": "OTHER", + /** + * value: "INCENTED_PAYMENT" + * @const + */ + "INCENTED_PAYMENT": "INCENTED_PAYMENT", + /** + * value: "RETURNED_ACH_ENTRY" + * @const + */ + "RETURNED_ACH_ENTRY": "RETURNED_ACH_ENTRY", + /** + * value: "RETURNED_SQUARE_275" + * @const + */ + "RETURNED_SQUARE_275": "RETURNED_SQUARE_275", + /** + * value: "SQUARE_275" + * @const + */ + "SQUARE_275": "SQUARE_275", + /** + * value: "SQUARE_CARD" + * @const + */ + "SQUARE_CARD": "SQUARE_CARD"}; + +/** + * Returns a V1SettlementEntryType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1SettlementEntryType} The enum V1SettlementEntryType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1SettlementStatus.js b/src/model/V1SettlementStatus.js new file mode 100644 index 0000000..e29cb8a --- /dev/null +++ b/src/model/V1SettlementStatus.js @@ -0,0 +1,45 @@ +/** + * 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 V1SettlementStatus. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "FAILED" + * @const + */ + "FAILED": "FAILED", + /** + * value: "SENT" + * @const + */ + "SENT": "SENT"}; + +/** + * Returns a V1SettlementStatus enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1SettlementStatus} The enum V1SettlementStatus value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1Tender.js b/src/model/V1Tender.js index 799ebfc..76a9d1c 100644 --- a/src/model/V1Tender.js +++ b/src/model/V1Tender.js @@ -24,6 +24,7 @@ var V1Money = require('./V1Money'); /** * Constructs a new V1Tender. + * A tender represents a discrete monetary exchange. Square represents this exchange as a money object with a specific currency and amount, where the amount is given in the smallest denomination of the given currency. Square POS can accept more than one form of tender for a single payment (such as by splitting a bill between a credit card and a gift card). The `tender` field of the Payment object lists all forms of tender used for the payment. Split tender payments behave slightly differently from single tender payments: The receipt_url for a split tender corresponds only to the first tender listed in the tender field. To get the receipt URLs for the remaining tenders, use the receipt_url fields of the corresponding Tender objects. *A note on gift cards**: when a customer purchases a Square gift card from a merchant, the merchant receives the full amount of the gift card in the associated payment. When that gift card is used as a tender, the balance of the gift card is reduced and the merchant receives no funds. A `Tender` object with a type of `SQUARE_GIFT_CARD` indicates a gift card was used for some or all of the associated payment. * @alias module:model/V1Tender * @class */ @@ -117,7 +118,7 @@ exports.constructFromObject = function(data, obj) { */ exports.prototype['id'] = undefined; /** - * The type of tender. + * The type of tender. See [V1TenderType](#type-v1tendertype) for possible values * @member {module:model/V1Tender.TypeEnum} type */ exports.prototype['type'] = undefined; @@ -137,7 +138,7 @@ exports.prototype['employee_id'] = undefined; */ exports.prototype['receipt_url'] = undefined; /** - * The brand of credit card provided. + * The brand of credit card provided. See [CardBrand](#type-cardbrand) for possible values * @member {module:model/V1Tender.CardBrandEnum} card_brand */ exports.prototype['card_brand'] = undefined; @@ -147,7 +148,7 @@ exports.prototype['card_brand'] = undefined; */ exports.prototype['pan_suffix'] = undefined; /** - * The tender's unique ID. + * The tender's unique ID. See [V1TenderEntryMethod](#type-v1tenderentrymethod) for possible values * @member {module:model/V1Tender.EntryMethodEnum} entry_method */ exports.prototype['entry_method'] = undefined; @@ -257,10 +258,10 @@ exports.prototype['is_exchange'] = undefined; */ "VISA": "VISA", /** - * value: "MASTER_CARD" + * value: "MASTERCARD" * @const */ - "MASTER_CARD": "MASTER_CARD", + "MASTERCARD": "MASTERCARD", /** * value: "AMERICAN_EXPRESS" * @const diff --git a/src/model/V1TenderEntryMethod.js b/src/model/V1TenderEntryMethod.js new file mode 100644 index 0000000..9925b9a --- /dev/null +++ b/src/model/V1TenderEntryMethod.js @@ -0,0 +1,70 @@ +/** + * 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 V1TenderEntryMethod. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "MANUAL" + * @const + */ + "MANUAL": "MANUAL", + /** + * value: "SCANNED" + * @const + */ + "SCANNED": "SCANNED", + /** + * value: "SQUARE_CASH" + * @const + */ + "SQUARE_CASH": "SQUARE_CASH", + /** + * value: "SQUARE_WALLET" + * @const + */ + "SQUARE_WALLET": "SQUARE_WALLET", + /** + * value: "SWIPED" + * @const + */ + "SWIPED": "SWIPED", + /** + * value: "WEB_FORM" + * @const + */ + "WEB_FORM": "WEB_FORM", + /** + * value: "OTHER" + * @const + */ + "OTHER": "OTHER"}; + +/** + * Returns a V1TenderEntryMethod enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1TenderEntryMethod} The enum V1TenderEntryMethod value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1TenderType.js b/src/model/V1TenderType.js new file mode 100644 index 0000000..8c7b35c --- /dev/null +++ b/src/model/V1TenderType.js @@ -0,0 +1,75 @@ +/** + * 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 V1TenderType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "CREDIT_CARD" + * @const + */ + "CREDIT_CARD": "CREDIT_CARD", + /** + * value: "CASH" + * @const + */ + "CASH": "CASH", + /** + * value: "THIRD_PARTY_CARD" + * @const + */ + "THIRD_PARTY_CARD": "THIRD_PARTY_CARD", + /** + * value: "NO_SALE" + * @const + */ + "NO_SALE": "NO_SALE", + /** + * value: "SQUARE_WALLET" + * @const + */ + "SQUARE_WALLET": "SQUARE_WALLET", + /** + * value: "SQUARE_GIFT_CARD" + * @const + */ + "SQUARE_GIFT_CARD": "SQUARE_GIFT_CARD", + /** + * value: "UNKNOWN" + * @const + */ + "UNKNOWN": "UNKNOWN", + /** + * value: "OTHER" + * @const + */ + "OTHER": "OTHER"}; + +/** + * Returns a V1TenderType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1TenderType} The enum V1TenderType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1Timecard.js b/src/model/V1Timecard.js index 5ef89b0..8e59161 100644 --- a/src/model/V1Timecard.js +++ b/src/model/V1Timecard.js @@ -122,7 +122,7 @@ exports.prototype['clockin_time'] = undefined; */ exports.prototype['clockout_time'] = undefined; /** - * The ID of the location the employee clocked in from. We strongly reccomend providing a clockin_location_id. Square uses the clockin_location_id to determine a timecard���s timezone and overtime rules. + * The ID of the location the employee clocked in from. We strongly reccomend providing a clockin_location_id. Square uses the clockin_location_id to determine a timecard’s timezone and overtime rules. * @member {String} clockin_location_id */ exports.prototype['clockin_location_id'] = undefined; diff --git a/src/model/V1TimecardEvent.js b/src/model/V1TimecardEvent.js index 068a799..3284926 100644 --- a/src/model/V1TimecardEvent.js +++ b/src/model/V1TimecardEvent.js @@ -23,6 +23,7 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new V1TimecardEvent. + * V1TimecardEvent * @alias module:model/V1TimecardEvent * @class */ @@ -72,7 +73,7 @@ exports.constructFromObject = function(data, obj) { */ exports.prototype['id'] = undefined; /** - * The ID of the timecard to list events for. + * The ID of the timecard to list events for. See [V1TimecardEventEventType](#type-v1timecardeventeventtype) for possible values * @member {module:model/V1TimecardEvent.EventTypeEnum} event_type */ exports.prototype['event_type'] = undefined; diff --git a/src/model/V1TimecardEventEventType.js b/src/model/V1TimecardEventEventType.js new file mode 100644 index 0000000..0e0f6ef --- /dev/null +++ b/src/model/V1TimecardEventEventType.js @@ -0,0 +1,75 @@ +/** + * 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 V1TimecardEventEventType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "API_CREATE" + * @const + */ + "API_CREATE": "API_CREATE", + /** + * value: "API_EDIT" + * @const + */ + "API_EDIT": "API_EDIT", + /** + * value: "API_DELETE" + * @const + */ + "API_DELETE": "API_DELETE", + /** + * value: "REGISTER_CLOCKIN" + * @const + */ + "REGISTER_CLOCKIN": "REGISTER_CLOCKIN", + /** + * value: "REGISTER_CLOCKOUT" + * @const + */ + "REGISTER_CLOCKOUT": "REGISTER_CLOCKOUT", + /** + * value: "DASHBOARD_SUPERVISOR_CLOSE" + * @const + */ + "DASHBOARD_SUPERVISOR_CLOSE": "DASHBOARD_SUPERVISOR_CLOSE", + /** + * value: "DASHBOARD_EDIT" + * @const + */ + "DASHBOARD_EDIT": "DASHBOARD_EDIT", + /** + * value: "DASHBOARD_DELETE" + * @const + */ + "DASHBOARD_DELETE": "DASHBOARD_DELETE"}; + +/** + * Returns a V1TimecardEventEventType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1TimecardEventEventType} The enum V1TimecardEventEventType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1UpdateCategoryRequest.js b/src/model/V1UpdateCategoryRequest.js new file mode 100644 index 0000000..4b89ade --- /dev/null +++ b/src/model/V1UpdateCategoryRequest.js @@ -0,0 +1,67 @@ +/** + * 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 V1Category = require('./V1Category'); + + + + +/** + * The V1UpdateCategoryRequest model module. + * @module model/V1UpdateCategoryRequest + */ + +/** + * Constructs a new V1UpdateCategoryRequest. + * + * @alias module:model/V1UpdateCategoryRequest + * @class + * @param body {module:model/V1Category} An object containing the fields to POST for the request. See the corresponding object definition for field details. + */ +var exports = function(body) { + var _this = this; + + _this['body'] = body; +}; + +/** + * Constructs a V1UpdateCategoryRequest 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/V1UpdateCategoryRequest} obj Optional instance to populate. + * @return {module:model/V1UpdateCategoryRequest} The populated V1UpdateCategoryRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1Category.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1Category} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1UpdateDiscountRequest.js b/src/model/V1UpdateDiscountRequest.js new file mode 100644 index 0000000..c0bbc34 --- /dev/null +++ b/src/model/V1UpdateDiscountRequest.js @@ -0,0 +1,67 @@ +/** + * 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 V1Discount = require('./V1Discount'); + + + + +/** + * The V1UpdateDiscountRequest model module. + * @module model/V1UpdateDiscountRequest + */ + +/** + * Constructs a new V1UpdateDiscountRequest. + * + * @alias module:model/V1UpdateDiscountRequest + * @class + * @param body {module:model/V1Discount} An object containing the fields to POST for the request. See the corresponding object definition for field details. + */ +var exports = function(body) { + var _this = this; + + _this['body'] = body; +}; + +/** + * Constructs a V1UpdateDiscountRequest 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/V1UpdateDiscountRequest} obj Optional instance to populate. + * @return {module:model/V1UpdateDiscountRequest} The populated V1UpdateDiscountRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1Discount.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1Discount} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1UpdateEmployeeRequest.js b/src/model/V1UpdateEmployeeRequest.js new file mode 100644 index 0000000..fa34712 --- /dev/null +++ b/src/model/V1UpdateEmployeeRequest.js @@ -0,0 +1,67 @@ +/** + * 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 V1Employee = require('./V1Employee'); + + + + +/** + * The V1UpdateEmployeeRequest model module. + * @module model/V1UpdateEmployeeRequest + */ + +/** + * Constructs a new V1UpdateEmployeeRequest. + * + * @alias module:model/V1UpdateEmployeeRequest + * @class + * @param body {module:model/V1Employee} An object containing the fields to POST for the request. See the corresponding object definition for field details. + */ +var exports = function(body) { + var _this = this; + + _this['body'] = body; +}; + +/** + * Constructs a V1UpdateEmployeeRequest 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/V1UpdateEmployeeRequest} obj Optional instance to populate. + * @return {module:model/V1UpdateEmployeeRequest} The populated V1UpdateEmployeeRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1Employee.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1Employee} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1UpdateEmployeeRoleRequest.js b/src/model/V1UpdateEmployeeRoleRequest.js new file mode 100644 index 0000000..a5aeb90 --- /dev/null +++ b/src/model/V1UpdateEmployeeRoleRequest.js @@ -0,0 +1,67 @@ +/** + * 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 V1EmployeeRole = require('./V1EmployeeRole'); + + + + +/** + * The V1UpdateEmployeeRoleRequest model module. + * @module model/V1UpdateEmployeeRoleRequest + */ + +/** + * Constructs a new V1UpdateEmployeeRoleRequest. + * + * @alias module:model/V1UpdateEmployeeRoleRequest + * @class + * @param body {module:model/V1EmployeeRole} An object containing the fields to POST for the request. See the corresponding object definition for field details. + */ +var exports = function(body) { + var _this = this; + + _this['body'] = body; +}; + +/** + * Constructs a V1UpdateEmployeeRoleRequest 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/V1UpdateEmployeeRoleRequest} obj Optional instance to populate. + * @return {module:model/V1UpdateEmployeeRoleRequest} The populated V1UpdateEmployeeRoleRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1EmployeeRole.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1EmployeeRole} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1UpdateFeeRequest.js b/src/model/V1UpdateFeeRequest.js new file mode 100644 index 0000000..6f05c82 --- /dev/null +++ b/src/model/V1UpdateFeeRequest.js @@ -0,0 +1,67 @@ +/** + * 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 V1Fee = require('./V1Fee'); + + + + +/** + * The V1UpdateFeeRequest model module. + * @module model/V1UpdateFeeRequest + */ + +/** + * Constructs a new V1UpdateFeeRequest. + * + * @alias module:model/V1UpdateFeeRequest + * @class + * @param body {module:model/V1Fee} An object containing the fields to POST for the request. See the corresponding object definition for field details. + */ +var exports = function(body) { + var _this = this; + + _this['body'] = body; +}; + +/** + * Constructs a V1UpdateFeeRequest 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/V1UpdateFeeRequest} obj Optional instance to populate. + * @return {module:model/V1UpdateFeeRequest} The populated V1UpdateFeeRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1Fee.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1Fee} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1UpdateItemRequest.js b/src/model/V1UpdateItemRequest.js new file mode 100644 index 0000000..6a1f571 --- /dev/null +++ b/src/model/V1UpdateItemRequest.js @@ -0,0 +1,67 @@ +/** + * 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 V1Item = require('./V1Item'); + + + + +/** + * The V1UpdateItemRequest model module. + * @module model/V1UpdateItemRequest + */ + +/** + * Constructs a new V1UpdateItemRequest. + * + * @alias module:model/V1UpdateItemRequest + * @class + * @param body {module:model/V1Item} An object containing the fields to POST for the request. See the corresponding object definition for field details. + */ +var exports = function(body) { + var _this = this; + + _this['body'] = body; +}; + +/** + * Constructs a V1UpdateItemRequest 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/V1UpdateItemRequest} obj Optional instance to populate. + * @return {module:model/V1UpdateItemRequest} The populated V1UpdateItemRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1Item.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1Item} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1UpdateModifierListRequest.js b/src/model/V1UpdateModifierListRequest.js index 6633c30..9e8c811 100644 --- a/src/model/V1UpdateModifierListRequest.js +++ b/src/model/V1UpdateModifierListRequest.js @@ -23,6 +23,7 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new V1UpdateModifierListRequest. + * V1UpdateModifierListRequest * @alias module:model/V1UpdateModifierListRequest * @class */ @@ -60,7 +61,7 @@ exports.constructFromObject = function(data, obj) { */ exports.prototype['name'] = undefined; /** - * Indicates whether multiple options from the modifier list can be applied to a single item. + * Indicates whether multiple options from the modifier list can be applied to a single item. See [V1UpdateModifierListRequestSelectionType](#type-v1updatemodifierlistrequestselectiontype) for possible values * @member {module:model/V1UpdateModifierListRequest.SelectionTypeEnum} selection_type */ exports.prototype['selection_type'] = undefined; diff --git a/src/model/V1UpdateModifierListRequestSelectionType.js b/src/model/V1UpdateModifierListRequestSelectionType.js new file mode 100644 index 0000000..ddbdd10 --- /dev/null +++ b/src/model/V1UpdateModifierListRequestSelectionType.js @@ -0,0 +1,45 @@ +/** + * 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 V1UpdateModifierListRequestSelectionType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "SINGLE" + * @const + */ + "SINGLE": "SINGLE", + /** + * value: "MULTIPLE" + * @const + */ + "MULTIPLE": "MULTIPLE"}; + +/** + * Returns a V1UpdateModifierListRequestSelectionType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1UpdateModifierListRequestSelectionType} The enum V1UpdateModifierListRequestSelectionType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1UpdateModifierOptionRequest.js b/src/model/V1UpdateModifierOptionRequest.js new file mode 100644 index 0000000..4709559 --- /dev/null +++ b/src/model/V1UpdateModifierOptionRequest.js @@ -0,0 +1,67 @@ +/** + * 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 V1ModifierOption = require('./V1ModifierOption'); + + + + +/** + * The V1UpdateModifierOptionRequest model module. + * @module model/V1UpdateModifierOptionRequest + */ + +/** + * Constructs a new V1UpdateModifierOptionRequest. + * + * @alias module:model/V1UpdateModifierOptionRequest + * @class + * @param body {module:model/V1ModifierOption} An object containing the fields to POST for the request. See the corresponding object definition for field details. + */ +var exports = function(body) { + var _this = this; + + _this['body'] = body; +}; + +/** + * Constructs a V1UpdateModifierOptionRequest 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/V1UpdateModifierOptionRequest} obj Optional instance to populate. + * @return {module:model/V1UpdateModifierOptionRequest} The populated V1UpdateModifierOptionRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1ModifierOption.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1ModifierOption} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1UpdateOrderRequest.js b/src/model/V1UpdateOrderRequest.js index 89ad296..608b2c9 100644 --- a/src/model/V1UpdateOrderRequest.js +++ b/src/model/V1UpdateOrderRequest.js @@ -23,9 +23,10 @@ var ApiClient = require('../ApiClient'); /** * Constructs a new V1UpdateOrderRequest. + * V1UpdateOrderRequest * @alias module:model/V1UpdateOrderRequest * @class - * @param action {module:model/V1UpdateOrderRequest.ActionEnum} The action to perform on the order (COMPLETE, CANCEL, or REFUND). + * @param action {module:model/V1UpdateOrderRequest.ActionEnum} The action to perform on the order (COMPLETE, CANCEL, or REFUND). See [V1UpdateOrderRequestAction](#type-v1updateorderrequestaction) for possible values */ var exports = function(action) { var _this = this; @@ -68,7 +69,7 @@ exports.constructFromObject = function(data, obj) { } /** - * The action to perform on the order (COMPLETE, CANCEL, or REFUND). + * The action to perform on the order (COMPLETE, CANCEL, or REFUND). See [V1UpdateOrderRequestAction](#type-v1updateorderrequestaction) for possible values * @member {module:model/V1UpdateOrderRequest.ActionEnum} action */ exports.prototype['action'] = undefined; diff --git a/src/model/V1UpdateOrderRequestAction.js b/src/model/V1UpdateOrderRequestAction.js new file mode 100644 index 0000000..fe31bc2 --- /dev/null +++ b/src/model/V1UpdateOrderRequestAction.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 V1UpdateOrderRequestAction. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "COMPLETE" + * @const + */ + "COMPLETE": "COMPLETE", + /** + * value: "CANCEL" + * @const + */ + "CANCEL": "CANCEL", + /** + * value: "REFUND" + * @const + */ + "REFUND": "REFUND"}; + +/** + * Returns a V1UpdateOrderRequestAction enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1UpdateOrderRequestAction} The enum V1UpdateOrderRequestAction value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1UpdatePageCellRequest.js b/src/model/V1UpdatePageCellRequest.js new file mode 100644 index 0000000..a8bc256 --- /dev/null +++ b/src/model/V1UpdatePageCellRequest.js @@ -0,0 +1,67 @@ +/** + * 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 V1PageCell = require('./V1PageCell'); + + + + +/** + * The V1UpdatePageCellRequest model module. + * @module model/V1UpdatePageCellRequest + */ + +/** + * Constructs a new V1UpdatePageCellRequest. + * + * @alias module:model/V1UpdatePageCellRequest + * @class + * @param body {module:model/V1PageCell} An object containing the fields to POST for the request. See the corresponding object definition for field details. + */ +var exports = function(body) { + var _this = this; + + _this['body'] = body; +}; + +/** + * Constructs a V1UpdatePageCellRequest 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/V1UpdatePageCellRequest} obj Optional instance to populate. + * @return {module:model/V1UpdatePageCellRequest} The populated V1UpdatePageCellRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1PageCell.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1PageCell} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1UpdatePageRequest.js b/src/model/V1UpdatePageRequest.js new file mode 100644 index 0000000..3018738 --- /dev/null +++ b/src/model/V1UpdatePageRequest.js @@ -0,0 +1,67 @@ +/** + * 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 V1Page = require('./V1Page'); + + + + +/** + * The V1UpdatePageRequest model module. + * @module model/V1UpdatePageRequest + */ + +/** + * Constructs a new V1UpdatePageRequest. + * + * @alias module:model/V1UpdatePageRequest + * @class + * @param body {module:model/V1Page} An object containing the fields to POST for the request. See the corresponding object definition for field details. + */ +var exports = function(body) { + var _this = this; + + _this['body'] = body; +}; + +/** + * Constructs a V1UpdatePageRequest 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/V1UpdatePageRequest} obj Optional instance to populate. + * @return {module:model/V1UpdatePageRequest} The populated V1UpdatePageRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1Page.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1Page} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1UpdateTimecardRequest.js b/src/model/V1UpdateTimecardRequest.js new file mode 100644 index 0000000..ac53853 --- /dev/null +++ b/src/model/V1UpdateTimecardRequest.js @@ -0,0 +1,67 @@ +/** + * 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 V1Timecard = require('./V1Timecard'); + + + + +/** + * The V1UpdateTimecardRequest model module. + * @module model/V1UpdateTimecardRequest + */ + +/** + * Constructs a new V1UpdateTimecardRequest. + * + * @alias module:model/V1UpdateTimecardRequest + * @class + * @param body {module:model/V1Timecard} An object containing the fields to POST for the request. See the corresponding object definition for field details. + */ +var exports = function(body) { + var _this = this; + + _this['body'] = body; +}; + +/** + * Constructs a V1UpdateTimecardRequest 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/V1UpdateTimecardRequest} obj Optional instance to populate. + * @return {module:model/V1UpdateTimecardRequest} The populated V1UpdateTimecardRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1Timecard.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1Timecard} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1UpdateVariationRequest.js b/src/model/V1UpdateVariationRequest.js new file mode 100644 index 0000000..0f43e9b --- /dev/null +++ b/src/model/V1UpdateVariationRequest.js @@ -0,0 +1,67 @@ +/** + * 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 V1Variation = require('./V1Variation'); + + + + +/** + * The V1UpdateVariationRequest model module. + * @module model/V1UpdateVariationRequest + */ + +/** + * Constructs a new V1UpdateVariationRequest. + * + * @alias module:model/V1UpdateVariationRequest + * @class + * @param body {module:model/V1Variation} An object containing the fields to POST for the request. See the corresponding object definition for field details. + */ +var exports = function(body) { + var _this = this; + + _this['body'] = body; +}; + +/** + * Constructs a V1UpdateVariationRequest 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/V1UpdateVariationRequest} obj Optional instance to populate. + * @return {module:model/V1UpdateVariationRequest} The populated V1UpdateVariationRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('body')) { + obj['body'] = V1Variation.constructFromObject(data['body']); + } + } + return obj; +} + +/** + * An object containing the fields to POST for the request. See the corresponding object definition for field details. + * @member {module:model/V1Variation} body + */ +exports.prototype['body'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/V1Variation.js b/src/model/V1Variation.js index 39f5989..a4c3167 100644 --- a/src/model/V1Variation.js +++ b/src/model/V1Variation.js @@ -24,6 +24,7 @@ var V1Money = require('./V1Money'); /** * Constructs a new V1Variation. + * V1Variation * @alias module:model/V1Variation * @class */ @@ -112,7 +113,7 @@ exports.prototype['item_id'] = undefined; */ exports.prototype['ordinal'] = undefined; /** - * Indicates whether the item variation's price is fixed or determined at the time of sale. + * Indicates whether the item variation's price is fixed or determined at the time of sale. See [V1VariationPricingType](#type-v1variationpricingtype) for possible values * @member {module:model/V1Variation.PricingTypeEnum} pricing_type */ exports.prototype['pricing_type'] = undefined; @@ -132,7 +133,7 @@ exports.prototype['sku'] = undefined; */ exports.prototype['track_inventory'] = undefined; /** - * Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its inventory_alert_threshold. + * Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its inventory_alert_threshold. See [V1VariationInventoryAlertType](#type-v1variationinventoryalerttype) for possible values * @member {module:model/V1Variation.InventoryAlertTypeEnum} inventory_alert_type */ exports.prototype['inventory_alert_type'] = undefined; diff --git a/src/model/V1VariationInventoryAlertType.js b/src/model/V1VariationInventoryAlertType.js new file mode 100644 index 0000000..fc527fe --- /dev/null +++ b/src/model/V1VariationInventoryAlertType.js @@ -0,0 +1,65 @@ +/** + * 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 V1VariationInventoryAlertType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "LOW_QUANTITY" + * @const + */ + "LOW_QUANTITY": "LOW_QUANTITY", + /** + * value: "NONE" + * @const + */ + "NONE": "NONE", + /** + * value: "INVESTMENT" + * @const + */ + "INVESTMENT": "INVESTMENT", + /** + * value: "LOAN" + * @const + */ + "LOAN": "LOAN", + /** + * value: "SAVINGS" + * @const + */ + "SAVINGS": "SAVINGS", + /** + * value: "OTHER" + * @const + */ + "OTHER": "OTHER"}; + +/** + * Returns a V1VariationInventoryAlertType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1VariationInventoryAlertType} The enum V1VariationInventoryAlertType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/V1VariationPricingType.js b/src/model/V1VariationPricingType.js new file mode 100644 index 0000000..08c25bd --- /dev/null +++ b/src/model/V1VariationPricingType.js @@ -0,0 +1,45 @@ +/** + * 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 V1VariationPricingType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "FIXED_PRICING" + * @const + */ + "FIXED_PRICING": "FIXED_PRICING", + /** + * value: "VARIABLE_PRICING" + * @const + */ + "VARIABLE_PRICING": "VARIABLE_PRICING"}; + +/** + * Returns a V1VariationPricingType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/V1VariationPricingType} The enum V1VariationPricingType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/Weekday.js b/src/model/Weekday.js new file mode 100644 index 0000000..7f324f3 --- /dev/null +++ b/src/model/Weekday.js @@ -0,0 +1,70 @@ +/** + * 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 Weekday. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "MON" + * @const + */ + "MON": "MON", + /** + * value: "TUE" + * @const + */ + "TUE": "TUE", + /** + * value: "WED" + * @const + */ + "WED": "WED", + /** + * value: "THU" + * @const + */ + "THU": "THU", + /** + * value: "FRI" + * @const + */ + "FRI": "FRI", + /** + * value: "SAT" + * @const + */ + "SAT": "SAT", + /** + * value: "SUN" + * @const + */ + "SUN": "SUN"}; + +/** + * Returns a Weekday enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/Weekday} The enum Weekday value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/WorkweekConfig.js b/src/model/WorkweekConfig.js new file mode 100644 index 0000000..7685a25 --- /dev/null +++ b/src/model/WorkweekConfig.js @@ -0,0 +1,154 @@ +/** + * 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'); + + + + +/** + * The WorkweekConfig model module. + * @module model/WorkweekConfig + */ + +/** + * Constructs a new WorkweekConfig. + * Sets the Day of the week and hour of the day that a business starts a work week. Used for the calculation of overtime pay. + * @alias module:model/WorkweekConfig + * @class + * @param startOfWeek {module:model/WorkweekConfig.StartOfWeekEnum} The day of the week on which a business week cuts over for compensation purposes. + * @param startOfDayLocalTime {String} The local time at which a business week cuts over. Represented as a string in `HH:MM` format (`HH:MM:SS` is also accepted, but seconds are truncated). + */ +var exports = function(startOfWeek, startOfDayLocalTime) { + var _this = this; + + + _this['start_of_week'] = startOfWeek; + _this['start_of_day_local_time'] = startOfDayLocalTime; + + + +}; + +/** + * Constructs a WorkweekConfig 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/WorkweekConfig} obj Optional instance to populate. + * @return {module:model/WorkweekConfig} The populated WorkweekConfig 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('start_of_week')) { + obj['start_of_week'] = ApiClient.convertToType(data['start_of_week'], 'String'); + } + if (data.hasOwnProperty('start_of_day_local_time')) { + obj['start_of_day_local_time'] = ApiClient.convertToType(data['start_of_day_local_time'], 'String'); + } + if (data.hasOwnProperty('version')) { + obj['version'] = ApiClient.convertToType(data['version'], 'Number'); + } + if (data.hasOwnProperty('created_at')) { + obj['created_at'] = ApiClient.convertToType(data['created_at'], 'String'); + } + if (data.hasOwnProperty('updated_at')) { + obj['updated_at'] = ApiClient.convertToType(data['updated_at'], 'String'); + } + } + return obj; +} + +/** + * UUID for this object + * @member {String} id + */ +exports.prototype['id'] = undefined; +/** + * The day of the week on which a business week cuts over for compensation purposes. + * @member {module:model/WorkweekConfig.StartOfWeekEnum} start_of_week + */ +exports.prototype['start_of_week'] = undefined; +/** + * The local time at which a business week cuts over. Represented as a string in `HH:MM` format (`HH:MM:SS` is also accepted, but seconds are truncated). + * @member {String} start_of_day_local_time + */ +exports.prototype['start_of_day_local_time'] = undefined; +/** + * 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. + * @member {Number} version + */ +exports.prototype['version'] = undefined; +/** + * A read-only timestamp in RFC 3339 format; presented in UTC + * @member {String} created_at + */ +exports.prototype['created_at'] = undefined; +/** + * A read-only timestamp in RFC 3339 format; presented in UTC + * @member {String} updated_at + */ +exports.prototype['updated_at'] = undefined; + + + /** + * Allowed values for the start_of_week property. + * @enum {String} + * @readonly + */ + exports.StartOfWeekEnum = { + /** + * value: "MON" + * @const + */ + "MON": "MON", + /** + * value: "TUE" + * @const + */ + "TUE": "TUE", + /** + * value: "WED" + * @const + */ + "WED": "WED", + /** + * value: "THU" + * @const + */ + "THU": "THU", + /** + * value: "FRI" + * @const + */ + "FRI": "FRI", + /** + * value: "SAT" + * @const + */ + "SAT": "SAT", + /** + * value: "SUN" + * @const + */ + "SUN": "SUN" }; + + +module.exports = exports; + + + diff --git a/test/api/EmployeesApi.spec.js b/test/api/EmployeesApi.spec.js new file mode 100644 index 0000000..7e0c6f8 --- /dev/null +++ b/test/api/EmployeesApi.spec.js @@ -0,0 +1,56 @@ +const SquareConnect = require('../../src/index'); +const { + accounts, + expect, + handleUnexpectedError +} = require('../support/setup'); + +/** + * 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 + * + */ + +describe('EmployeesApi', function() { + beforeEach(function() { + const defaultClient = SquareConnect.ApiClient.instance; + const oauth2 = defaultClient.authentications['oauth2']; + // Some APIs do not work with sandbox. Replace `sandbox` with `production` for those test suites. + oauth2.accessToken = accounts.sandbox.access_token; + this.api = new SquareConnect.EmployeesApi(); + }); + + afterEach(function(){ + }); + + describe('EmployeesApi', function() { + describe('listEmployees', function() { + it('should call listEmployees successfully', function(done) { + //uncomment below and update the code to test listEmployees + //instance.listEmployees(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('retrieveEmployee', function() { + it('should call retrieveEmployee successfully', function(done) { + //uncomment below and update the code to test retrieveEmployee + //instance.retrieveEmployee(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + }); +}); diff --git a/test/api/LaborApi.spec.js b/test/api/LaborApi.spec.js new file mode 100644 index 0000000..af3a5a9 --- /dev/null +++ b/test/api/LaborApi.spec.js @@ -0,0 +1,176 @@ +const SquareConnect = require('../../src/index'); +const { + accounts, + expect, + handleUnexpectedError +} = require('../support/setup'); + +/** + * 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 + * + */ + +describe('LaborApi', function() { + beforeEach(function() { + const defaultClient = SquareConnect.ApiClient.instance; + const oauth2 = defaultClient.authentications['oauth2']; + // Some APIs do not work with sandbox. Replace `sandbox` with `production` for those test suites. + oauth2.accessToken = accounts.sandbox.access_token; + this.api = new SquareConnect.LaborApi(); + }); + + afterEach(function(){ + }); + + describe('LaborApi', function() { + describe('createBreakType', function() { + it('should call createBreakType successfully', function(done) { + //uncomment below and update the code to test createBreakType + //instance.createBreakType(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('createShift', function() { + it('should call createShift successfully', function(done) { + //uncomment below and update the code to test createShift + //instance.createShift(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('deleteBreakType', function() { + it('should call deleteBreakType successfully', function(done) { + //uncomment below and update the code to test deleteBreakType + //instance.deleteBreakType(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('deleteShift', function() { + it('should call deleteShift successfully', function(done) { + //uncomment below and update the code to test deleteShift + //instance.deleteShift(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('getBreakType', function() { + it('should call getBreakType successfully', function(done) { + //uncomment below and update the code to test getBreakType + //instance.getBreakType(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('getEmployeeWage', function() { + it('should call getEmployeeWage successfully', function(done) { + //uncomment below and update the code to test getEmployeeWage + //instance.getEmployeeWage(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('getShift', function() { + it('should call getShift successfully', function(done) { + //uncomment below and update the code to test getShift + //instance.getShift(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('listBreakTypes', function() { + it('should call listBreakTypes successfully', function(done) { + //uncomment below and update the code to test listBreakTypes + //instance.listBreakTypes(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('listEmployeeWages', function() { + it('should call listEmployeeWages successfully', function(done) { + //uncomment below and update the code to test listEmployeeWages + //instance.listEmployeeWages(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('listWorkweekConfigs', function() { + it('should call listWorkweekConfigs successfully', function(done) { + //uncomment below and update the code to test listWorkweekConfigs + //instance.listWorkweekConfigs(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('searchShifts', function() { + it('should call searchShifts successfully', function(done) { + //uncomment below and update the code to test searchShifts + //instance.searchShifts(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('updateBreakType', function() { + it('should call updateBreakType successfully', function(done) { + //uncomment below and update the code to test updateBreakType + //instance.updateBreakType(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('updateShift', function() { + it('should call updateShift successfully', function(done) { + //uncomment below and update the code to test updateShift + //instance.updateShift(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('updateWorkweekConfig', function() { + it('should call updateWorkweekConfig successfully', function(done) { + //uncomment below and update the code to test updateWorkweekConfig + //instance.updateWorkweekConfig(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + }); +}); diff --git a/test/model/BreakType.spec.js b/test/model/BreakType.spec.js new file mode 100644 index 0000000..2f98c6b --- /dev/null +++ b/test/model/BreakType.spec.js @@ -0,0 +1,67 @@ +/** + * 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('BreakType', function() { + beforeEach(function() { + this.api = new SquareConnect.BreakType(); + }); + + it('should create an instance of BreakType', function() { + // uncomment below and update the code to test BreakType + //var instane = new SquareConnect.BreakType(); + //expect(instance).to.be.a(SquareConnect.BreakType); + }); + + 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.BreakType(); + //expect(instance).to.be(); + }); + it('should have the property locationId (base name: "location_id")', function() { + // uncomment below and update the code to test the property locationId + //var instane = new SquareConnect.BreakType(); + //expect(instance).to.be(); + }); + it('should have the property breakName (base name: "break_name")', function() { + // uncomment below and update the code to test the property breakName + //var instane = new SquareConnect.BreakType(); + //expect(instance).to.be(); + }); + it('should have the property expectedDuration (base name: "expected_duration")', function() { + // uncomment below and update the code to test the property expectedDuration + //var instane = new SquareConnect.BreakType(); + //expect(instance).to.be(); + }); + it('should have the property isPaid (base name: "is_paid")', function() { + // uncomment below and update the code to test the property isPaid + //var instane = new SquareConnect.BreakType(); + //expect(instance).to.be(); + }); + it('should have the property version (base name: "version")', function() { + // uncomment below and update the code to test the property version + //var instane = new SquareConnect.BreakType(); + //expect(instance).to.be(); + }); + it('should have the property createdAt (base name: "created_at")', function() { + // uncomment below and update the code to test the property createdAt + //var instane = new SquareConnect.BreakType(); + //expect(instance).to.be(); + }); + it('should have the property updatedAt (base name: "updated_at")', function() { + // uncomment below and update the code to test the property updatedAt + //var instane = new SquareConnect.BreakType(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/CreateBreakTypeRequest.spec.js b/test/model/CreateBreakTypeRequest.spec.js new file mode 100644 index 0000000..2ba117b --- /dev/null +++ b/test/model/CreateBreakTypeRequest.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('CreateBreakTypeRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.CreateBreakTypeRequest(); + }); + + it('should create an instance of CreateBreakTypeRequest', function() { + // uncomment below and update the code to test CreateBreakTypeRequest + //var instane = new SquareConnect.CreateBreakTypeRequest(); + //expect(instance).to.be.a(SquareConnect.CreateBreakTypeRequest); + }); + + it('should have the property idempotencyKey (base name: "idempotency_key")', function() { + // uncomment below and update the code to test the property idempotencyKey + //var instane = new SquareConnect.CreateBreakTypeRequest(); + //expect(instance).to.be(); + }); + it('should have the property breakType (base name: "break_type")', function() { + // uncomment below and update the code to test the property breakType + //var instane = new SquareConnect.CreateBreakTypeRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/CreateBreakTypeResponse.spec.js b/test/model/CreateBreakTypeResponse.spec.js new file mode 100644 index 0000000..aab6bbc --- /dev/null +++ b/test/model/CreateBreakTypeResponse.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('CreateBreakTypeResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.CreateBreakTypeResponse(); + }); + + it('should create an instance of CreateBreakTypeResponse', function() { + // uncomment below and update the code to test CreateBreakTypeResponse + //var instane = new SquareConnect.CreateBreakTypeResponse(); + //expect(instance).to.be.a(SquareConnect.CreateBreakTypeResponse); + }); + + it('should have the property breakType (base name: "break_type")', function() { + // uncomment below and update the code to test the property breakType + //var instane = new SquareConnect.CreateBreakTypeResponse(); + //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.CreateBreakTypeResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/CreateShiftRequest.spec.js b/test/model/CreateShiftRequest.spec.js new file mode 100644 index 0000000..a0059f3 --- /dev/null +++ b/test/model/CreateShiftRequest.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('CreateShiftRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.CreateShiftRequest(); + }); + + it('should create an instance of CreateShiftRequest', function() { + // uncomment below and update the code to test CreateShiftRequest + //var instane = new SquareConnect.CreateShiftRequest(); + //expect(instance).to.be.a(SquareConnect.CreateShiftRequest); + }); + + it('should have the property idempotencyKey (base name: "idempotency_key")', function() { + // uncomment below and update the code to test the property idempotencyKey + //var instane = new SquareConnect.CreateShiftRequest(); + //expect(instance).to.be(); + }); + it('should have the property shift (base name: "shift")', function() { + // uncomment below and update the code to test the property shift + //var instane = new SquareConnect.CreateShiftRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/CreateShiftResponse.spec.js b/test/model/CreateShiftResponse.spec.js new file mode 100644 index 0000000..27e5dd9 --- /dev/null +++ b/test/model/CreateShiftResponse.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('CreateShiftResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.CreateShiftResponse(); + }); + + it('should create an instance of CreateShiftResponse', function() { + // uncomment below and update the code to test CreateShiftResponse + //var instane = new SquareConnect.CreateShiftResponse(); + //expect(instance).to.be.a(SquareConnect.CreateShiftResponse); + }); + + it('should have the property shift (base name: "shift")', function() { + // uncomment below and update the code to test the property shift + //var instane = new SquareConnect.CreateShiftResponse(); + //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.CreateShiftResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/DateRange.spec.js b/test/model/DateRange.spec.js new file mode 100644 index 0000000..51b27e2 --- /dev/null +++ b/test/model/DateRange.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('DateRange', function() { + beforeEach(function() { + this.api = new SquareConnect.DateRange(); + }); + + it('should create an instance of DateRange', function() { + // uncomment below and update the code to test DateRange + //var instane = new SquareConnect.DateRange(); + //expect(instance).to.be.a(SquareConnect.DateRange); + }); + + it('should have the property startDate (base name: "start_date")', function() { + // uncomment below and update the code to test the property startDate + //var instane = new SquareConnect.DateRange(); + //expect(instance).to.be(); + }); + it('should have the property endDate (base name: "end_date")', function() { + // uncomment below and update the code to test the property endDate + //var instane = new SquareConnect.DateRange(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/DeleteBreakTypeRequest.spec.js b/test/model/DeleteBreakTypeRequest.spec.js new file mode 100644 index 0000000..f4dc251 --- /dev/null +++ b/test/model/DeleteBreakTypeRequest.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('DeleteBreakTypeRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.DeleteBreakTypeRequest(); + }); + + it('should create an instance of DeleteBreakTypeRequest', function() { + // uncomment below and update the code to test DeleteBreakTypeRequest + //var instane = new SquareConnect.DeleteBreakTypeRequest(); + //expect(instance).to.be.a(SquareConnect.DeleteBreakTypeRequest); + }); + +}); diff --git a/test/model/DeleteBreakTypeResponse.spec.js b/test/model/DeleteBreakTypeResponse.spec.js new file mode 100644 index 0000000..4ef3e76 --- /dev/null +++ b/test/model/DeleteBreakTypeResponse.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('DeleteBreakTypeResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.DeleteBreakTypeResponse(); + }); + + it('should create an instance of DeleteBreakTypeResponse', function() { + // uncomment below and update the code to test DeleteBreakTypeResponse + //var instane = new SquareConnect.DeleteBreakTypeResponse(); + //expect(instance).to.be.a(SquareConnect.DeleteBreakTypeResponse); + }); + + 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.DeleteBreakTypeResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/DeleteShiftRequest.spec.js b/test/model/DeleteShiftRequest.spec.js new file mode 100644 index 0000000..c59d5cc --- /dev/null +++ b/test/model/DeleteShiftRequest.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('DeleteShiftRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.DeleteShiftRequest(); + }); + + it('should create an instance of DeleteShiftRequest', function() { + // uncomment below and update the code to test DeleteShiftRequest + //var instane = new SquareConnect.DeleteShiftRequest(); + //expect(instance).to.be.a(SquareConnect.DeleteShiftRequest); + }); + +}); diff --git a/test/model/DeleteShiftResponse.spec.js b/test/model/DeleteShiftResponse.spec.js new file mode 100644 index 0000000..3c5087a --- /dev/null +++ b/test/model/DeleteShiftResponse.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('DeleteShiftResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.DeleteShiftResponse(); + }); + + it('should create an instance of DeleteShiftResponse', function() { + // uncomment below and update the code to test DeleteShiftResponse + //var instane = new SquareConnect.DeleteShiftResponse(); + //expect(instance).to.be.a(SquareConnect.DeleteShiftResponse); + }); + + 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.DeleteShiftResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/Employee.spec.js b/test/model/Employee.spec.js new file mode 100644 index 0000000..1455683 --- /dev/null +++ b/test/model/Employee.spec.js @@ -0,0 +1,62 @@ +/** + * 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('Employee', function() { + beforeEach(function() { + this.api = new SquareConnect.Employee(); + }); + + it('should create an instance of Employee', function() { + // uncomment below and update the code to test Employee + //var instane = new SquareConnect.Employee(); + //expect(instance).to.be.a(SquareConnect.Employee); + }); + + 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.Employee(); + //expect(instance).to.be(); + }); + it('should have the property firstName (base name: "first_name")', function() { + // uncomment below and update the code to test the property firstName + //var instane = new SquareConnect.Employee(); + //expect(instance).to.be(); + }); + it('should have the property lastName (base name: "last_name")', function() { + // uncomment below and update the code to test the property lastName + //var instane = new SquareConnect.Employee(); + //expect(instance).to.be(); + }); + it('should have the property locationIds (base name: "location_ids")', function() { + // uncomment below and update the code to test the property locationIds + //var instane = new SquareConnect.Employee(); + //expect(instance).to.be(); + }); + 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.Employee(); + //expect(instance).to.be(); + }); + it('should have the property createdAt (base name: "created_at")', function() { + // uncomment below and update the code to test the property createdAt + //var instane = new SquareConnect.Employee(); + //expect(instance).to.be(); + }); + it('should have the property updatedAt (base name: "updated_at")', function() { + // uncomment below and update the code to test the property updatedAt + //var instane = new SquareConnect.Employee(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/EmployeeStatus.spec.js b/test/model/EmployeeStatus.spec.js new file mode 100644 index 0000000..f4dbe5c --- /dev/null +++ b/test/model/EmployeeStatus.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('EmployeeStatus', function() { + beforeEach(function() { + }); + + it('should create an instance of EmployeeStatus', function() { + // uncomment below and update the code to test EmployeeStatus + //var instane = new SquareConnect.EmployeeStatus(); + //expect(instance).to.be.a(SquareConnect.EmployeeStatus); + }); + +}); diff --git a/test/model/EmployeeWage.spec.js b/test/model/EmployeeWage.spec.js new file mode 100644 index 0000000..5b56c8f --- /dev/null +++ b/test/model/EmployeeWage.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('EmployeeWage', function() { + beforeEach(function() { + this.api = new SquareConnect.EmployeeWage(); + }); + + it('should create an instance of EmployeeWage', function() { + // uncomment below and update the code to test EmployeeWage + //var instane = new SquareConnect.EmployeeWage(); + //expect(instance).to.be.a(SquareConnect.EmployeeWage); + }); + + 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.EmployeeWage(); + //expect(instance).to.be(); + }); + it('should have the property employeeId (base name: "employee_id")', function() { + // uncomment below and update the code to test the property employeeId + //var instane = new SquareConnect.EmployeeWage(); + //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.EmployeeWage(); + //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.EmployeeWage(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/GetBreakTypeRequest.spec.js b/test/model/GetBreakTypeRequest.spec.js new file mode 100644 index 0000000..2dfadfb --- /dev/null +++ b/test/model/GetBreakTypeRequest.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('GetBreakTypeRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.GetBreakTypeRequest(); + }); + + it('should create an instance of GetBreakTypeRequest', function() { + // uncomment below and update the code to test GetBreakTypeRequest + //var instane = new SquareConnect.GetBreakTypeRequest(); + //expect(instance).to.be.a(SquareConnect.GetBreakTypeRequest); + }); + +}); diff --git a/test/model/GetBreakTypeResponse.spec.js b/test/model/GetBreakTypeResponse.spec.js new file mode 100644 index 0000000..da9969c --- /dev/null +++ b/test/model/GetBreakTypeResponse.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('GetBreakTypeResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.GetBreakTypeResponse(); + }); + + it('should create an instance of GetBreakTypeResponse', function() { + // uncomment below and update the code to test GetBreakTypeResponse + //var instane = new SquareConnect.GetBreakTypeResponse(); + //expect(instance).to.be.a(SquareConnect.GetBreakTypeResponse); + }); + + it('should have the property breakType (base name: "break_type")', function() { + // uncomment below and update the code to test the property breakType + //var instane = new SquareConnect.GetBreakTypeResponse(); + //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.GetBreakTypeResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/GetEmployeeWageRequest.spec.js b/test/model/GetEmployeeWageRequest.spec.js new file mode 100644 index 0000000..36896ec --- /dev/null +++ b/test/model/GetEmployeeWageRequest.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('GetEmployeeWageRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.GetEmployeeWageRequest(); + }); + + it('should create an instance of GetEmployeeWageRequest', function() { + // uncomment below and update the code to test GetEmployeeWageRequest + //var instane = new SquareConnect.GetEmployeeWageRequest(); + //expect(instance).to.be.a(SquareConnect.GetEmployeeWageRequest); + }); + +}); diff --git a/test/model/GetEmployeeWageResponse.spec.js b/test/model/GetEmployeeWageResponse.spec.js new file mode 100644 index 0000000..6251c87 --- /dev/null +++ b/test/model/GetEmployeeWageResponse.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('GetEmployeeWageResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.GetEmployeeWageResponse(); + }); + + it('should create an instance of GetEmployeeWageResponse', function() { + // uncomment below and update the code to test GetEmployeeWageResponse + //var instane = new SquareConnect.GetEmployeeWageResponse(); + //expect(instance).to.be.a(SquareConnect.GetEmployeeWageResponse); + }); + + it('should have the property employeeWage (base name: "employee_wage")', function() { + // uncomment below and update the code to test the property employeeWage + //var instane = new SquareConnect.GetEmployeeWageResponse(); + //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.GetEmployeeWageResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/GetShiftRequest.spec.js b/test/model/GetShiftRequest.spec.js new file mode 100644 index 0000000..467f5d5 --- /dev/null +++ b/test/model/GetShiftRequest.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('GetShiftRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.GetShiftRequest(); + }); + + it('should create an instance of GetShiftRequest', function() { + // uncomment below and update the code to test GetShiftRequest + //var instane = new SquareConnect.GetShiftRequest(); + //expect(instance).to.be.a(SquareConnect.GetShiftRequest); + }); + +}); diff --git a/test/model/GetShiftResponse.spec.js b/test/model/GetShiftResponse.spec.js new file mode 100644 index 0000000..b3b9b99 --- /dev/null +++ b/test/model/GetShiftResponse.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('GetShiftResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.GetShiftResponse(); + }); + + it('should create an instance of GetShiftResponse', function() { + // uncomment below and update the code to test GetShiftResponse + //var instane = new SquareConnect.GetShiftResponse(); + //expect(instance).to.be.a(SquareConnect.GetShiftResponse); + }); + + it('should have the property shift (base name: "shift")', function() { + // uncomment below and update the code to test the property shift + //var instane = new SquareConnect.GetShiftResponse(); + //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.GetShiftResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/ListBreakTypesRequest.spec.js b/test/model/ListBreakTypesRequest.spec.js new file mode 100644 index 0000000..4322382 --- /dev/null +++ b/test/model/ListBreakTypesRequest.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('ListBreakTypesRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.ListBreakTypesRequest(); + }); + + it('should create an instance of ListBreakTypesRequest', function() { + // uncomment below and update the code to test ListBreakTypesRequest + //var instane = new SquareConnect.ListBreakTypesRequest(); + //expect(instance).to.be.a(SquareConnect.ListBreakTypesRequest); + }); + + it('should have the property locationId (base name: "location_id")', function() { + // uncomment below and update the code to test the property locationId + //var instane = new SquareConnect.ListBreakTypesRequest(); + //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.ListBreakTypesRequest(); + //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.ListBreakTypesRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/ListBreakTypesResponse.spec.js b/test/model/ListBreakTypesResponse.spec.js new file mode 100644 index 0000000..b94334f --- /dev/null +++ b/test/model/ListBreakTypesResponse.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('ListBreakTypesResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.ListBreakTypesResponse(); + }); + + it('should create an instance of ListBreakTypesResponse', function() { + // uncomment below and update the code to test ListBreakTypesResponse + //var instane = new SquareConnect.ListBreakTypesResponse(); + //expect(instance).to.be.a(SquareConnect.ListBreakTypesResponse); + }); + + it('should have the property breakTypes (base name: "break_types")', function() { + // uncomment below and update the code to test the property breakTypes + //var instane = new SquareConnect.ListBreakTypesResponse(); + //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.ListBreakTypesResponse(); + //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.ListBreakTypesResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/ListEmployeeWagesRequest.spec.js b/test/model/ListEmployeeWagesRequest.spec.js new file mode 100644 index 0000000..d02f753 --- /dev/null +++ b/test/model/ListEmployeeWagesRequest.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('ListEmployeeWagesRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.ListEmployeeWagesRequest(); + }); + + it('should create an instance of ListEmployeeWagesRequest', function() { + // uncomment below and update the code to test ListEmployeeWagesRequest + //var instane = new SquareConnect.ListEmployeeWagesRequest(); + //expect(instance).to.be.a(SquareConnect.ListEmployeeWagesRequest); + }); + + it('should have the property employeeId (base name: "employee_id")', function() { + // uncomment below and update the code to test the property employeeId + //var instane = new SquareConnect.ListEmployeeWagesRequest(); + //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.ListEmployeeWagesRequest(); + //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.ListEmployeeWagesRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/ListEmployeeWagesResponse.spec.js b/test/model/ListEmployeeWagesResponse.spec.js new file mode 100644 index 0000000..2b4568c --- /dev/null +++ b/test/model/ListEmployeeWagesResponse.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('ListEmployeeWagesResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.ListEmployeeWagesResponse(); + }); + + it('should create an instance of ListEmployeeWagesResponse', function() { + // uncomment below and update the code to test ListEmployeeWagesResponse + //var instane = new SquareConnect.ListEmployeeWagesResponse(); + //expect(instance).to.be.a(SquareConnect.ListEmployeeWagesResponse); + }); + + it('should have the property employeeWages (base name: "employee_wages")', function() { + // uncomment below and update the code to test the property employeeWages + //var instane = new SquareConnect.ListEmployeeWagesResponse(); + //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.ListEmployeeWagesResponse(); + //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.ListEmployeeWagesResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/ListEmployeesRequest.spec.js b/test/model/ListEmployeesRequest.spec.js new file mode 100644 index 0000000..5787f23 --- /dev/null +++ b/test/model/ListEmployeesRequest.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('ListEmployeesRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.ListEmployeesRequest(); + }); + + it('should create an instance of ListEmployeesRequest', function() { + // uncomment below and update the code to test ListEmployeesRequest + //var instane = new SquareConnect.ListEmployeesRequest(); + //expect(instance).to.be.a(SquareConnect.ListEmployeesRequest); + }); + + it('should have the property locationId (base name: "location_id")', function() { + // uncomment below and update the code to test the property locationId + //var instane = new SquareConnect.ListEmployeesRequest(); + //expect(instance).to.be(); + }); + 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.ListEmployeesRequest(); + //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.ListEmployeesRequest(); + //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.ListEmployeesRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/ListEmployeesResponse.spec.js b/test/model/ListEmployeesResponse.spec.js new file mode 100644 index 0000000..673a611 --- /dev/null +++ b/test/model/ListEmployeesResponse.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('ListEmployeesResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.ListEmployeesResponse(); + }); + + it('should create an instance of ListEmployeesResponse', function() { + // uncomment below and update the code to test ListEmployeesResponse + //var instane = new SquareConnect.ListEmployeesResponse(); + //expect(instance).to.be.a(SquareConnect.ListEmployeesResponse); + }); + + it('should have the property employees (base name: "employees")', function() { + // uncomment below and update the code to test the property employees + //var instane = new SquareConnect.ListEmployeesResponse(); + //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.ListEmployeesResponse(); + //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.ListEmployeesResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/ListWorkweekConfigsRequest.spec.js b/test/model/ListWorkweekConfigsRequest.spec.js new file mode 100644 index 0000000..2d60a7c --- /dev/null +++ b/test/model/ListWorkweekConfigsRequest.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('ListWorkweekConfigsRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.ListWorkweekConfigsRequest(); + }); + + it('should create an instance of ListWorkweekConfigsRequest', function() { + // uncomment below and update the code to test ListWorkweekConfigsRequest + //var instane = new SquareConnect.ListWorkweekConfigsRequest(); + //expect(instance).to.be.a(SquareConnect.ListWorkweekConfigsRequest); + }); + + 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.ListWorkweekConfigsRequest(); + //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.ListWorkweekConfigsRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/ListWorkweekConfigsResponse.spec.js b/test/model/ListWorkweekConfigsResponse.spec.js new file mode 100644 index 0000000..7180700 --- /dev/null +++ b/test/model/ListWorkweekConfigsResponse.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('ListWorkweekConfigsResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.ListWorkweekConfigsResponse(); + }); + + it('should create an instance of ListWorkweekConfigsResponse', function() { + // uncomment below and update the code to test ListWorkweekConfigsResponse + //var instane = new SquareConnect.ListWorkweekConfigsResponse(); + //expect(instance).to.be.a(SquareConnect.ListWorkweekConfigsResponse); + }); + + it('should have the property workweekConfigs (base name: "workweek_configs")', function() { + // uncomment below and update the code to test the property workweekConfigs + //var instane = new SquareConnect.ListWorkweekConfigsResponse(); + //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.ListWorkweekConfigsResponse(); + //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.ListWorkweekConfigsResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/ModelBreak.spec.js b/test/model/ModelBreak.spec.js new file mode 100644 index 0000000..77bb315 --- /dev/null +++ b/test/model/ModelBreak.spec.js @@ -0,0 +1,62 @@ +/** + * 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('ModelBreak', function() { + beforeEach(function() { + this.api = new SquareConnect.ModelBreak(); + }); + + it('should create an instance of ModelBreak', function() { + // uncomment below and update the code to test ModelBreak + //var instane = new SquareConnect.ModelBreak(); + //expect(instance).to.be.a(SquareConnect.ModelBreak); + }); + + 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.ModelBreak(); + //expect(instance).to.be(); + }); + it('should have the property startAt (base name: "start_at")', function() { + // uncomment below and update the code to test the property startAt + //var instane = new SquareConnect.ModelBreak(); + //expect(instance).to.be(); + }); + it('should have the property endAt (base name: "end_at")', function() { + // uncomment below and update the code to test the property endAt + //var instane = new SquareConnect.ModelBreak(); + //expect(instance).to.be(); + }); + it('should have the property breakTypeId (base name: "break_type_id")', function() { + // uncomment below and update the code to test the property breakTypeId + //var instane = new SquareConnect.ModelBreak(); + //expect(instance).to.be(); + }); + it('should have the property name (base name: "name")', function() { + // uncomment below and update the code to test the property name + //var instane = new SquareConnect.ModelBreak(); + //expect(instance).to.be(); + }); + it('should have the property expectedDuration (base name: "expected_duration")', function() { + // uncomment below and update the code to test the property expectedDuration + //var instane = new SquareConnect.ModelBreak(); + //expect(instance).to.be(); + }); + it('should have the property isPaid (base name: "is_paid")', function() { + // uncomment below and update the code to test the property isPaid + //var instane = new SquareConnect.ModelBreak(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/RetrieveEmployeeRequest.spec.js b/test/model/RetrieveEmployeeRequest.spec.js new file mode 100644 index 0000000..160c7de --- /dev/null +++ b/test/model/RetrieveEmployeeRequest.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('RetrieveEmployeeRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.RetrieveEmployeeRequest(); + }); + + it('should create an instance of RetrieveEmployeeRequest', function() { + // uncomment below and update the code to test RetrieveEmployeeRequest + //var instane = new SquareConnect.RetrieveEmployeeRequest(); + //expect(instance).to.be.a(SquareConnect.RetrieveEmployeeRequest); + }); + +}); diff --git a/test/model/RetrieveEmployeeResponse.spec.js b/test/model/RetrieveEmployeeResponse.spec.js new file mode 100644 index 0000000..f31a57b --- /dev/null +++ b/test/model/RetrieveEmployeeResponse.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('RetrieveEmployeeResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.RetrieveEmployeeResponse(); + }); + + it('should create an instance of RetrieveEmployeeResponse', function() { + // uncomment below and update the code to test RetrieveEmployeeResponse + //var instane = new SquareConnect.RetrieveEmployeeResponse(); + //expect(instance).to.be.a(SquareConnect.RetrieveEmployeeResponse); + }); + + it('should have the property employee (base name: "employee")', function() { + // uncomment below and update the code to test the property employee + //var instane = new SquareConnect.RetrieveEmployeeResponse(); + //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.RetrieveEmployeeResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/SearchShiftsRequest.spec.js b/test/model/SearchShiftsRequest.spec.js new file mode 100644 index 0000000..37efecb --- /dev/null +++ b/test/model/SearchShiftsRequest.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('SearchShiftsRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.SearchShiftsRequest(); + }); + + it('should create an instance of SearchShiftsRequest', function() { + // uncomment below and update the code to test SearchShiftsRequest + //var instane = new SquareConnect.SearchShiftsRequest(); + //expect(instance).to.be.a(SquareConnect.SearchShiftsRequest); + }); + + it('should have the property query (base name: "query")', function() { + // uncomment below and update the code to test the property query + //var instane = new SquareConnect.SearchShiftsRequest(); + //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.SearchShiftsRequest(); + //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.SearchShiftsRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/SearchShiftsResponse.spec.js b/test/model/SearchShiftsResponse.spec.js new file mode 100644 index 0000000..fbdaf9b --- /dev/null +++ b/test/model/SearchShiftsResponse.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('SearchShiftsResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.SearchShiftsResponse(); + }); + + it('should create an instance of SearchShiftsResponse', function() { + // uncomment below and update the code to test SearchShiftsResponse + //var instane = new SquareConnect.SearchShiftsResponse(); + //expect(instance).to.be.a(SquareConnect.SearchShiftsResponse); + }); + + it('should have the property shifts (base name: "shifts")', function() { + // uncomment below and update the code to test the property shifts + //var instane = new SquareConnect.SearchShiftsResponse(); + //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.SearchShiftsResponse(); + //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.SearchShiftsResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/Shift.spec.js b/test/model/Shift.spec.js new file mode 100644 index 0000000..14e72f2 --- /dev/null +++ b/test/model/Shift.spec.js @@ -0,0 +1,87 @@ +/** + * 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('Shift', function() { + beforeEach(function() { + this.api = new SquareConnect.Shift(); + }); + + it('should create an instance of Shift', function() { + // uncomment below and update the code to test Shift + //var instane = new SquareConnect.Shift(); + //expect(instance).to.be.a(SquareConnect.Shift); + }); + + 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.Shift(); + //expect(instance).to.be(); + }); + it('should have the property employeeId (base name: "employee_id")', function() { + // uncomment below and update the code to test the property employeeId + //var instane = new SquareConnect.Shift(); + //expect(instance).to.be(); + }); + it('should have the property locationId (base name: "location_id")', function() { + // uncomment below and update the code to test the property locationId + //var instane = new SquareConnect.Shift(); + //expect(instance).to.be(); + }); + it('should have the property timezone (base name: "timezone")', function() { + // uncomment below and update the code to test the property timezone + //var instane = new SquareConnect.Shift(); + //expect(instance).to.be(); + }); + it('should have the property startAt (base name: "start_at")', function() { + // uncomment below and update the code to test the property startAt + //var instane = new SquareConnect.Shift(); + //expect(instance).to.be(); + }); + it('should have the property endAt (base name: "end_at")', function() { + // uncomment below and update the code to test the property endAt + //var instane = new SquareConnect.Shift(); + //expect(instance).to.be(); + }); + it('should have the property wage (base name: "wage")', function() { + // uncomment below and update the code to test the property wage + //var instane = new SquareConnect.Shift(); + //expect(instance).to.be(); + }); + it('should have the property breaks (base name: "breaks")', function() { + // uncomment below and update the code to test the property breaks + //var instane = new SquareConnect.Shift(); + //expect(instance).to.be(); + }); + 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.Shift(); + //expect(instance).to.be(); + }); + it('should have the property version (base name: "version")', function() { + // uncomment below and update the code to test the property version + //var instane = new SquareConnect.Shift(); + //expect(instance).to.be(); + }); + it('should have the property createdAt (base name: "created_at")', function() { + // uncomment below and update the code to test the property createdAt + //var instane = new SquareConnect.Shift(); + //expect(instance).to.be(); + }); + it('should have the property updatedAt (base name: "updated_at")', function() { + // uncomment below and update the code to test the property updatedAt + //var instane = new SquareConnect.Shift(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/ShiftFilter.spec.js b/test/model/ShiftFilter.spec.js new file mode 100644 index 0000000..c9366cd --- /dev/null +++ b/test/model/ShiftFilter.spec.js @@ -0,0 +1,57 @@ +/** + * 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('ShiftFilter', function() { + beforeEach(function() { + this.api = new SquareConnect.ShiftFilter(); + }); + + it('should create an instance of ShiftFilter', function() { + // uncomment below and update the code to test ShiftFilter + //var instane = new SquareConnect.ShiftFilter(); + //expect(instance).to.be.a(SquareConnect.ShiftFilter); + }); + + it('should have the property locationId (base name: "location_id")', function() { + // uncomment below and update the code to test the property locationId + //var instane = new SquareConnect.ShiftFilter(); + //expect(instance).to.be(); + }); + it('should have the property employeeId (base name: "employee_id")', function() { + // uncomment below and update the code to test the property employeeId + //var instane = new SquareConnect.ShiftFilter(); + //expect(instance).to.be(); + }); + 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.ShiftFilter(); + //expect(instance).to.be(); + }); + it('should have the property start (base name: "start")', function() { + // uncomment below and update the code to test the property start + //var instane = new SquareConnect.ShiftFilter(); + //expect(instance).to.be(); + }); + it('should have the property end (base name: "end")', function() { + // uncomment below and update the code to test the property end + //var instane = new SquareConnect.ShiftFilter(); + //expect(instance).to.be(); + }); + it('should have the property workday (base name: "workday")', function() { + // uncomment below and update the code to test the property workday + //var instane = new SquareConnect.ShiftFilter(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/ShiftFilterStatus.spec.js b/test/model/ShiftFilterStatus.spec.js new file mode 100644 index 0000000..316091f --- /dev/null +++ b/test/model/ShiftFilterStatus.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('ShiftFilterStatus', function() { + beforeEach(function() { + }); + + it('should create an instance of ShiftFilterStatus', function() { + // uncomment below and update the code to test ShiftFilterStatus + //var instane = new SquareConnect.ShiftFilterStatus(); + //expect(instance).to.be.a(SquareConnect.ShiftFilterStatus); + }); + +}); diff --git a/test/model/ShiftQuery.spec.js b/test/model/ShiftQuery.spec.js new file mode 100644 index 0000000..54cb2a9 --- /dev/null +++ b/test/model/ShiftQuery.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('ShiftQuery', function() { + beforeEach(function() { + this.api = new SquareConnect.ShiftQuery(); + }); + + it('should create an instance of ShiftQuery', function() { + // uncomment below and update the code to test ShiftQuery + //var instane = new SquareConnect.ShiftQuery(); + //expect(instance).to.be.a(SquareConnect.ShiftQuery); + }); + + it('should have the property filter (base name: "filter")', function() { + // uncomment below and update the code to test the property filter + //var instane = new SquareConnect.ShiftQuery(); + //expect(instance).to.be(); + }); + it('should have the property sort (base name: "sort")', function() { + // uncomment below and update the code to test the property sort + //var instane = new SquareConnect.ShiftQuery(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/ShiftSort.spec.js b/test/model/ShiftSort.spec.js new file mode 100644 index 0000000..b70e4ae --- /dev/null +++ b/test/model/ShiftSort.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('ShiftSort', function() { + beforeEach(function() { + this.api = new SquareConnect.ShiftSort(); + }); + + it('should create an instance of ShiftSort', function() { + // uncomment below and update the code to test ShiftSort + //var instane = new SquareConnect.ShiftSort(); + //expect(instance).to.be.a(SquareConnect.ShiftSort); + }); + + it('should have the property field (base name: "field")', function() { + // uncomment below and update the code to test the property field + //var instane = new SquareConnect.ShiftSort(); + //expect(instance).to.be(); + }); + it('should have the property order (base name: "order")', function() { + // uncomment below and update the code to test the property order + //var instane = new SquareConnect.ShiftSort(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/ShiftSortField.spec.js b/test/model/ShiftSortField.spec.js new file mode 100644 index 0000000..cb871b0 --- /dev/null +++ b/test/model/ShiftSortField.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('ShiftSortField', function() { + beforeEach(function() { + }); + + it('should create an instance of ShiftSortField', function() { + // uncomment below and update the code to test ShiftSortField + //var instane = new SquareConnect.ShiftSortField(); + //expect(instance).to.be.a(SquareConnect.ShiftSortField); + }); + +}); diff --git a/test/model/ShiftStatus.spec.js b/test/model/ShiftStatus.spec.js new file mode 100644 index 0000000..e8e54cb --- /dev/null +++ b/test/model/ShiftStatus.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('ShiftStatus', function() { + beforeEach(function() { + }); + + it('should create an instance of ShiftStatus', function() { + // uncomment below and update the code to test ShiftStatus + //var instane = new SquareConnect.ShiftStatus(); + //expect(instance).to.be.a(SquareConnect.ShiftStatus); + }); + +}); diff --git a/test/model/ShiftWage.spec.js b/test/model/ShiftWage.spec.js new file mode 100644 index 0000000..a5b9b8f --- /dev/null +++ b/test/model/ShiftWage.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('ShiftWage', function() { + beforeEach(function() { + this.api = new SquareConnect.ShiftWage(); + }); + + it('should create an instance of ShiftWage', function() { + // uncomment below and update the code to test ShiftWage + //var instane = new SquareConnect.ShiftWage(); + //expect(instance).to.be.a(SquareConnect.ShiftWage); + }); + + 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.ShiftWage(); + //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.ShiftWage(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/ShiftWorkday.spec.js b/test/model/ShiftWorkday.spec.js new file mode 100644 index 0000000..362163c --- /dev/null +++ b/test/model/ShiftWorkday.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('ShiftWorkday', function() { + beforeEach(function() { + this.api = new SquareConnect.ShiftWorkday(); + }); + + it('should create an instance of ShiftWorkday', function() { + // uncomment below and update the code to test ShiftWorkday + //var instane = new SquareConnect.ShiftWorkday(); + //expect(instance).to.be.a(SquareConnect.ShiftWorkday); + }); + + it('should have the property dateRange (base name: "date_range")', function() { + // uncomment below and update the code to test the property dateRange + //var instane = new SquareConnect.ShiftWorkday(); + //expect(instance).to.be(); + }); + it('should have the property matchShiftsBy (base name: "match_shifts_by")', function() { + // uncomment below and update the code to test the property matchShiftsBy + //var instane = new SquareConnect.ShiftWorkday(); + //expect(instance).to.be(); + }); + it('should have the property defaultTimezone (base name: "default_timezone")', function() { + // uncomment below and update the code to test the property defaultTimezone + //var instane = new SquareConnect.ShiftWorkday(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/ShiftWorkdayMatcher.spec.js b/test/model/ShiftWorkdayMatcher.spec.js new file mode 100644 index 0000000..b77f910 --- /dev/null +++ b/test/model/ShiftWorkdayMatcher.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('ShiftWorkdayMatcher', function() { + beforeEach(function() { + }); + + it('should create an instance of ShiftWorkdayMatcher', function() { + // uncomment below and update the code to test ShiftWorkdayMatcher + //var instane = new SquareConnect.ShiftWorkdayMatcher(); + //expect(instance).to.be.a(SquareConnect.ShiftWorkdayMatcher); + }); + +}); diff --git a/test/model/UpdateBreakTypeRequest.spec.js b/test/model/UpdateBreakTypeRequest.spec.js new file mode 100644 index 0000000..a429c12 --- /dev/null +++ b/test/model/UpdateBreakTypeRequest.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('UpdateBreakTypeRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.UpdateBreakTypeRequest(); + }); + + it('should create an instance of UpdateBreakTypeRequest', function() { + // uncomment below and update the code to test UpdateBreakTypeRequest + //var instane = new SquareConnect.UpdateBreakTypeRequest(); + //expect(instance).to.be.a(SquareConnect.UpdateBreakTypeRequest); + }); + + it('should have the property breakType (base name: "break_type")', function() { + // uncomment below and update the code to test the property breakType + //var instane = new SquareConnect.UpdateBreakTypeRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/UpdateBreakTypeResponse.spec.js b/test/model/UpdateBreakTypeResponse.spec.js new file mode 100644 index 0000000..5d2e3d9 --- /dev/null +++ b/test/model/UpdateBreakTypeResponse.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('UpdateBreakTypeResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.UpdateBreakTypeResponse(); + }); + + it('should create an instance of UpdateBreakTypeResponse', function() { + // uncomment below and update the code to test UpdateBreakTypeResponse + //var instane = new SquareConnect.UpdateBreakTypeResponse(); + //expect(instance).to.be.a(SquareConnect.UpdateBreakTypeResponse); + }); + + it('should have the property breakType (base name: "break_type")', function() { + // uncomment below and update the code to test the property breakType + //var instane = new SquareConnect.UpdateBreakTypeResponse(); + //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.UpdateBreakTypeResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/UpdateShiftRequest.spec.js b/test/model/UpdateShiftRequest.spec.js new file mode 100644 index 0000000..2053ce1 --- /dev/null +++ b/test/model/UpdateShiftRequest.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('UpdateShiftRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.UpdateShiftRequest(); + }); + + it('should create an instance of UpdateShiftRequest', function() { + // uncomment below and update the code to test UpdateShiftRequest + //var instane = new SquareConnect.UpdateShiftRequest(); + //expect(instance).to.be.a(SquareConnect.UpdateShiftRequest); + }); + + it('should have the property shift (base name: "shift")', function() { + // uncomment below and update the code to test the property shift + //var instane = new SquareConnect.UpdateShiftRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/UpdateShiftResponse.spec.js b/test/model/UpdateShiftResponse.spec.js new file mode 100644 index 0000000..c0314e1 --- /dev/null +++ b/test/model/UpdateShiftResponse.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('UpdateShiftResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.UpdateShiftResponse(); + }); + + it('should create an instance of UpdateShiftResponse', function() { + // uncomment below and update the code to test UpdateShiftResponse + //var instane = new SquareConnect.UpdateShiftResponse(); + //expect(instance).to.be.a(SquareConnect.UpdateShiftResponse); + }); + + it('should have the property shift (base name: "shift")', function() { + // uncomment below and update the code to test the property shift + //var instane = new SquareConnect.UpdateShiftResponse(); + //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.UpdateShiftResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/UpdateWorkweekConfigRequest.spec.js b/test/model/UpdateWorkweekConfigRequest.spec.js new file mode 100644 index 0000000..e52467f --- /dev/null +++ b/test/model/UpdateWorkweekConfigRequest.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('UpdateWorkweekConfigRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.UpdateWorkweekConfigRequest(); + }); + + it('should create an instance of UpdateWorkweekConfigRequest', function() { + // uncomment below and update the code to test UpdateWorkweekConfigRequest + //var instane = new SquareConnect.UpdateWorkweekConfigRequest(); + //expect(instance).to.be.a(SquareConnect.UpdateWorkweekConfigRequest); + }); + + it('should have the property workweekConfig (base name: "workweek_config")', function() { + // uncomment below and update the code to test the property workweekConfig + //var instane = new SquareConnect.UpdateWorkweekConfigRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/UpdateWorkweekConfigResponse.spec.js b/test/model/UpdateWorkweekConfigResponse.spec.js new file mode 100644 index 0000000..408793b --- /dev/null +++ b/test/model/UpdateWorkweekConfigResponse.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('UpdateWorkweekConfigResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.UpdateWorkweekConfigResponse(); + }); + + it('should create an instance of UpdateWorkweekConfigResponse', function() { + // uncomment below and update the code to test UpdateWorkweekConfigResponse + //var instane = new SquareConnect.UpdateWorkweekConfigResponse(); + //expect(instance).to.be.a(SquareConnect.UpdateWorkweekConfigResponse); + }); + + it('should have the property workweekConfig (base name: "workweek_config")', function() { + // uncomment below and update the code to test the property workweekConfig + //var instane = new SquareConnect.UpdateWorkweekConfigResponse(); + //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.UpdateWorkweekConfigResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1AdjustInventoryRequestAdjustmentType.spec.js b/test/model/V1AdjustInventoryRequestAdjustmentType.spec.js new file mode 100644 index 0000000..867930b --- /dev/null +++ b/test/model/V1AdjustInventoryRequestAdjustmentType.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('V1AdjustInventoryRequestAdjustmentType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1AdjustInventoryRequestAdjustmentType', function() { + // uncomment below and update the code to test V1AdjustInventoryRequestAdjustmentType + //var instane = new SquareConnect.V1AdjustInventoryRequestAdjustmentType(); + //expect(instance).to.be.a(SquareConnect.V1AdjustInventoryRequestAdjustmentType); + }); + +}); diff --git a/test/model/V1ApplyFeeRequest.spec.js b/test/model/V1ApplyFeeRequest.spec.js new file mode 100644 index 0000000..6f8d5a6 --- /dev/null +++ b/test/model/V1ApplyFeeRequest.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('V1ApplyFeeRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ApplyFeeRequest(); + }); + + it('should create an instance of V1ApplyFeeRequest', function() { + // uncomment below and update the code to test V1ApplyFeeRequest + //var instane = new SquareConnect.V1ApplyFeeRequest(); + //expect(instance).to.be.a(SquareConnect.V1ApplyFeeRequest); + }); + +}); diff --git a/test/model/V1ApplyModifierListRequest.spec.js b/test/model/V1ApplyModifierListRequest.spec.js new file mode 100644 index 0000000..57cae7c --- /dev/null +++ b/test/model/V1ApplyModifierListRequest.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('V1ApplyModifierListRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ApplyModifierListRequest(); + }); + + it('should create an instance of V1ApplyModifierListRequest', function() { + // uncomment below and update the code to test V1ApplyModifierListRequest + //var instane = new SquareConnect.V1ApplyModifierListRequest(); + //expect(instance).to.be.a(SquareConnect.V1ApplyModifierListRequest); + }); + +}); diff --git a/test/model/V1BankAccountType.spec.js b/test/model/V1BankAccountType.spec.js new file mode 100644 index 0000000..87d1bf9 --- /dev/null +++ b/test/model/V1BankAccountType.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('V1BankAccountType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1BankAccountType', function() { + // uncomment below and update the code to test V1BankAccountType + //var instane = new SquareConnect.V1BankAccountType(); + //expect(instance).to.be.a(SquareConnect.V1BankAccountType); + }); + +}); diff --git a/test/model/V1CashDrawerEventEventType.spec.js b/test/model/V1CashDrawerEventEventType.spec.js new file mode 100644 index 0000000..fff35fb --- /dev/null +++ b/test/model/V1CashDrawerEventEventType.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('V1CashDrawerEventEventType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1CashDrawerEventEventType', function() { + // uncomment below and update the code to test V1CashDrawerEventEventType + //var instane = new SquareConnect.V1CashDrawerEventEventType(); + //expect(instance).to.be.a(SquareConnect.V1CashDrawerEventEventType); + }); + +}); diff --git a/test/model/V1CashDrawerShiftEventType.spec.js b/test/model/V1CashDrawerShiftEventType.spec.js new file mode 100644 index 0000000..51c7f7b --- /dev/null +++ b/test/model/V1CashDrawerShiftEventType.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('V1CashDrawerShiftEventType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1CashDrawerShiftEventType', function() { + // uncomment below and update the code to test V1CashDrawerShiftEventType + //var instane = new SquareConnect.V1CashDrawerShiftEventType(); + //expect(instance).to.be.a(SquareConnect.V1CashDrawerShiftEventType); + }); + +}); diff --git a/test/model/V1CreateCategoryRequest.spec.js b/test/model/V1CreateCategoryRequest.spec.js new file mode 100644 index 0000000..f26f85d --- /dev/null +++ b/test/model/V1CreateCategoryRequest.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('V1CreateCategoryRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1CreateCategoryRequest(); + }); + + it('should create an instance of V1CreateCategoryRequest', function() { + // uncomment below and update the code to test V1CreateCategoryRequest + //var instane = new SquareConnect.V1CreateCategoryRequest(); + //expect(instance).to.be.a(SquareConnect.V1CreateCategoryRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1CreateCategoryRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1CreateDiscountRequest.spec.js b/test/model/V1CreateDiscountRequest.spec.js new file mode 100644 index 0000000..0a467d3 --- /dev/null +++ b/test/model/V1CreateDiscountRequest.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('V1CreateDiscountRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1CreateDiscountRequest(); + }); + + it('should create an instance of V1CreateDiscountRequest', function() { + // uncomment below and update the code to test V1CreateDiscountRequest + //var instane = new SquareConnect.V1CreateDiscountRequest(); + //expect(instance).to.be.a(SquareConnect.V1CreateDiscountRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1CreateDiscountRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1CreateEmployeeRoleRequest.spec.js b/test/model/V1CreateEmployeeRoleRequest.spec.js new file mode 100644 index 0000000..3d10b3a --- /dev/null +++ b/test/model/V1CreateEmployeeRoleRequest.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('V1CreateEmployeeRoleRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1CreateEmployeeRoleRequest(); + }); + + it('should create an instance of V1CreateEmployeeRoleRequest', function() { + // uncomment below and update the code to test V1CreateEmployeeRoleRequest + //var instane = new SquareConnect.V1CreateEmployeeRoleRequest(); + //expect(instance).to.be.a(SquareConnect.V1CreateEmployeeRoleRequest); + }); + + it('should have the property employeeRole (base name: "employee_role")', function() { + // uncomment below and update the code to test the property employeeRole + //var instane = new SquareConnect.V1CreateEmployeeRoleRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1CreateFeeRequest.spec.js b/test/model/V1CreateFeeRequest.spec.js new file mode 100644 index 0000000..b2c6324 --- /dev/null +++ b/test/model/V1CreateFeeRequest.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('V1CreateFeeRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1CreateFeeRequest(); + }); + + it('should create an instance of V1CreateFeeRequest', function() { + // uncomment below and update the code to test V1CreateFeeRequest + //var instane = new SquareConnect.V1CreateFeeRequest(); + //expect(instance).to.be.a(SquareConnect.V1CreateFeeRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1CreateFeeRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1CreateItemRequest.spec.js b/test/model/V1CreateItemRequest.spec.js new file mode 100644 index 0000000..7e42a7d --- /dev/null +++ b/test/model/V1CreateItemRequest.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('V1CreateItemRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1CreateItemRequest(); + }); + + it('should create an instance of V1CreateItemRequest', function() { + // uncomment below and update the code to test V1CreateItemRequest + //var instane = new SquareConnect.V1CreateItemRequest(); + //expect(instance).to.be.a(SquareConnect.V1CreateItemRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1CreateItemRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1CreateModifierListRequest.spec.js b/test/model/V1CreateModifierListRequest.spec.js new file mode 100644 index 0000000..e8d635d --- /dev/null +++ b/test/model/V1CreateModifierListRequest.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('V1CreateModifierListRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1CreateModifierListRequest(); + }); + + it('should create an instance of V1CreateModifierListRequest', function() { + // uncomment below and update the code to test V1CreateModifierListRequest + //var instane = new SquareConnect.V1CreateModifierListRequest(); + //expect(instance).to.be.a(SquareConnect.V1CreateModifierListRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1CreateModifierListRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1CreateModifierOptionRequest.spec.js b/test/model/V1CreateModifierOptionRequest.spec.js new file mode 100644 index 0000000..b6e210f --- /dev/null +++ b/test/model/V1CreateModifierOptionRequest.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('V1CreateModifierOptionRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1CreateModifierOptionRequest(); + }); + + it('should create an instance of V1CreateModifierOptionRequest', function() { + // uncomment below and update the code to test V1CreateModifierOptionRequest + //var instane = new SquareConnect.V1CreateModifierOptionRequest(); + //expect(instance).to.be.a(SquareConnect.V1CreateModifierOptionRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1CreateModifierOptionRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1CreatePageRequest.spec.js b/test/model/V1CreatePageRequest.spec.js new file mode 100644 index 0000000..a76e804 --- /dev/null +++ b/test/model/V1CreatePageRequest.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('V1CreatePageRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1CreatePageRequest(); + }); + + it('should create an instance of V1CreatePageRequest', function() { + // uncomment below and update the code to test V1CreatePageRequest + //var instane = new SquareConnect.V1CreatePageRequest(); + //expect(instance).to.be.a(SquareConnect.V1CreatePageRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1CreatePageRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1CreateRefundRequestType.spec.js b/test/model/V1CreateRefundRequestType.spec.js new file mode 100644 index 0000000..9be5612 --- /dev/null +++ b/test/model/V1CreateRefundRequestType.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('V1CreateRefundRequestType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1CreateRefundRequestType', function() { + // uncomment below and update the code to test V1CreateRefundRequestType + //var instane = new SquareConnect.V1CreateRefundRequestType(); + //expect(instance).to.be.a(SquareConnect.V1CreateRefundRequestType); + }); + +}); diff --git a/test/model/V1CreateVariationRequest.spec.js b/test/model/V1CreateVariationRequest.spec.js new file mode 100644 index 0000000..81a6d63 --- /dev/null +++ b/test/model/V1CreateVariationRequest.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('V1CreateVariationRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1CreateVariationRequest(); + }); + + it('should create an instance of V1CreateVariationRequest', function() { + // uncomment below and update the code to test V1CreateVariationRequest + //var instane = new SquareConnect.V1CreateVariationRequest(); + //expect(instance).to.be.a(SquareConnect.V1CreateVariationRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1CreateVariationRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1DeleteCategoryRequest.spec.js b/test/model/V1DeleteCategoryRequest.spec.js new file mode 100644 index 0000000..853fe95 --- /dev/null +++ b/test/model/V1DeleteCategoryRequest.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('V1DeleteCategoryRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1DeleteCategoryRequest(); + }); + + it('should create an instance of V1DeleteCategoryRequest', function() { + // uncomment below and update the code to test V1DeleteCategoryRequest + //var instane = new SquareConnect.V1DeleteCategoryRequest(); + //expect(instance).to.be.a(SquareConnect.V1DeleteCategoryRequest); + }); + +}); diff --git a/test/model/V1DeleteDiscountRequest.spec.js b/test/model/V1DeleteDiscountRequest.spec.js new file mode 100644 index 0000000..7156d91 --- /dev/null +++ b/test/model/V1DeleteDiscountRequest.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('V1DeleteDiscountRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1DeleteDiscountRequest(); + }); + + it('should create an instance of V1DeleteDiscountRequest', function() { + // uncomment below and update the code to test V1DeleteDiscountRequest + //var instane = new SquareConnect.V1DeleteDiscountRequest(); + //expect(instance).to.be.a(SquareConnect.V1DeleteDiscountRequest); + }); + +}); diff --git a/test/model/V1DeleteFeeRequest.spec.js b/test/model/V1DeleteFeeRequest.spec.js new file mode 100644 index 0000000..3d1d154 --- /dev/null +++ b/test/model/V1DeleteFeeRequest.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('V1DeleteFeeRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1DeleteFeeRequest(); + }); + + it('should create an instance of V1DeleteFeeRequest', function() { + // uncomment below and update the code to test V1DeleteFeeRequest + //var instane = new SquareConnect.V1DeleteFeeRequest(); + //expect(instance).to.be.a(SquareConnect.V1DeleteFeeRequest); + }); + +}); diff --git a/test/model/V1DeleteItemRequest.spec.js b/test/model/V1DeleteItemRequest.spec.js new file mode 100644 index 0000000..efead69 --- /dev/null +++ b/test/model/V1DeleteItemRequest.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('V1DeleteItemRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1DeleteItemRequest(); + }); + + it('should create an instance of V1DeleteItemRequest', function() { + // uncomment below and update the code to test V1DeleteItemRequest + //var instane = new SquareConnect.V1DeleteItemRequest(); + //expect(instance).to.be.a(SquareConnect.V1DeleteItemRequest); + }); + +}); diff --git a/test/model/V1DeleteModifierListRequest.spec.js b/test/model/V1DeleteModifierListRequest.spec.js new file mode 100644 index 0000000..1c47e5f --- /dev/null +++ b/test/model/V1DeleteModifierListRequest.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('V1DeleteModifierListRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1DeleteModifierListRequest(); + }); + + it('should create an instance of V1DeleteModifierListRequest', function() { + // uncomment below and update the code to test V1DeleteModifierListRequest + //var instane = new SquareConnect.V1DeleteModifierListRequest(); + //expect(instance).to.be.a(SquareConnect.V1DeleteModifierListRequest); + }); + +}); diff --git a/test/model/V1DeleteModifierOptionRequest.spec.js b/test/model/V1DeleteModifierOptionRequest.spec.js new file mode 100644 index 0000000..46369e1 --- /dev/null +++ b/test/model/V1DeleteModifierOptionRequest.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('V1DeleteModifierOptionRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1DeleteModifierOptionRequest(); + }); + + it('should create an instance of V1DeleteModifierOptionRequest', function() { + // uncomment below and update the code to test V1DeleteModifierOptionRequest + //var instane = new SquareConnect.V1DeleteModifierOptionRequest(); + //expect(instance).to.be.a(SquareConnect.V1DeleteModifierOptionRequest); + }); + +}); diff --git a/test/model/V1DeletePageCellRequest.spec.js b/test/model/V1DeletePageCellRequest.spec.js new file mode 100644 index 0000000..219beb2 --- /dev/null +++ b/test/model/V1DeletePageCellRequest.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('V1DeletePageCellRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1DeletePageCellRequest(); + }); + + it('should create an instance of V1DeletePageCellRequest', function() { + // uncomment below and update the code to test V1DeletePageCellRequest + //var instane = new SquareConnect.V1DeletePageCellRequest(); + //expect(instance).to.be.a(SquareConnect.V1DeletePageCellRequest); + }); + + it('should have the property row (base name: "row")', function() { + // uncomment below and update the code to test the property row + //var instane = new SquareConnect.V1DeletePageCellRequest(); + //expect(instance).to.be(); + }); + it('should have the property column (base name: "column")', function() { + // uncomment below and update the code to test the property column + //var instane = new SquareConnect.V1DeletePageCellRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1DeletePageRequest.spec.js b/test/model/V1DeletePageRequest.spec.js new file mode 100644 index 0000000..abcd873 --- /dev/null +++ b/test/model/V1DeletePageRequest.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('V1DeletePageRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1DeletePageRequest(); + }); + + it('should create an instance of V1DeletePageRequest', function() { + // uncomment below and update the code to test V1DeletePageRequest + //var instane = new SquareConnect.V1DeletePageRequest(); + //expect(instance).to.be.a(SquareConnect.V1DeletePageRequest); + }); + +}); diff --git a/test/model/V1DeleteTimecardRequest.spec.js b/test/model/V1DeleteTimecardRequest.spec.js new file mode 100644 index 0000000..9fb19dc --- /dev/null +++ b/test/model/V1DeleteTimecardRequest.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('V1DeleteTimecardRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1DeleteTimecardRequest(); + }); + + it('should create an instance of V1DeleteTimecardRequest', function() { + // uncomment below and update the code to test V1DeleteTimecardRequest + //var instane = new SquareConnect.V1DeleteTimecardRequest(); + //expect(instance).to.be.a(SquareConnect.V1DeleteTimecardRequest); + }); + +}); diff --git a/test/model/V1DeleteTimecardResponse.spec.js b/test/model/V1DeleteTimecardResponse.spec.js new file mode 100644 index 0000000..f3eadbc --- /dev/null +++ b/test/model/V1DeleteTimecardResponse.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('V1DeleteTimecardResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1DeleteTimecardResponse(); + }); + + it('should create an instance of V1DeleteTimecardResponse', function() { + // uncomment below and update the code to test V1DeleteTimecardResponse + //var instane = new SquareConnect.V1DeleteTimecardResponse(); + //expect(instance).to.be.a(SquareConnect.V1DeleteTimecardResponse); + }); + +}); diff --git a/test/model/V1DeleteVariationRequest.spec.js b/test/model/V1DeleteVariationRequest.spec.js new file mode 100644 index 0000000..f91ead5 --- /dev/null +++ b/test/model/V1DeleteVariationRequest.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('V1DeleteVariationRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1DeleteVariationRequest(); + }); + + it('should create an instance of V1DeleteVariationRequest', function() { + // uncomment below and update the code to test V1DeleteVariationRequest + //var instane = new SquareConnect.V1DeleteVariationRequest(); + //expect(instance).to.be.a(SquareConnect.V1DeleteVariationRequest); + }); + +}); diff --git a/test/model/V1DiscountColor.spec.js b/test/model/V1DiscountColor.spec.js new file mode 100644 index 0000000..6d414ff --- /dev/null +++ b/test/model/V1DiscountColor.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('V1DiscountColor', function() { + beforeEach(function() { + }); + + it('should create an instance of V1DiscountColor', function() { + // uncomment below and update the code to test V1DiscountColor + //var instane = new SquareConnect.V1DiscountColor(); + //expect(instance).to.be.a(SquareConnect.V1DiscountColor); + }); + +}); diff --git a/test/model/V1DiscountDiscountType.spec.js b/test/model/V1DiscountDiscountType.spec.js new file mode 100644 index 0000000..a892731 --- /dev/null +++ b/test/model/V1DiscountDiscountType.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('V1DiscountDiscountType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1DiscountDiscountType', function() { + // uncomment below and update the code to test V1DiscountDiscountType + //var instane = new SquareConnect.V1DiscountDiscountType(); + //expect(instance).to.be.a(SquareConnect.V1DiscountDiscountType); + }); + +}); diff --git a/test/model/V1EmployeeRolePermissions.spec.js b/test/model/V1EmployeeRolePermissions.spec.js new file mode 100644 index 0000000..40e655e --- /dev/null +++ b/test/model/V1EmployeeRolePermissions.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('V1EmployeeRolePermissions', function() { + beforeEach(function() { + }); + + it('should create an instance of V1EmployeeRolePermissions', function() { + // uncomment below and update the code to test V1EmployeeRolePermissions + //var instane = new SquareConnect.V1EmployeeRolePermissions(); + //expect(instance).to.be.a(SquareConnect.V1EmployeeRolePermissions); + }); + +}); diff --git a/test/model/V1EmployeeStatus.spec.js b/test/model/V1EmployeeStatus.spec.js new file mode 100644 index 0000000..ee4c1ad --- /dev/null +++ b/test/model/V1EmployeeStatus.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('V1EmployeeStatus', function() { + beforeEach(function() { + }); + + it('should create an instance of V1EmployeeStatus', function() { + // uncomment below and update the code to test V1EmployeeStatus + //var instane = new SquareConnect.V1EmployeeStatus(); + //expect(instance).to.be.a(SquareConnect.V1EmployeeStatus); + }); + +}); diff --git a/test/model/V1FeeAdjustmentType.spec.js b/test/model/V1FeeAdjustmentType.spec.js new file mode 100644 index 0000000..0885456 --- /dev/null +++ b/test/model/V1FeeAdjustmentType.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('V1FeeAdjustmentType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1FeeAdjustmentType', function() { + // uncomment below and update the code to test V1FeeAdjustmentType + //var instane = new SquareConnect.V1FeeAdjustmentType(); + //expect(instance).to.be.a(SquareConnect.V1FeeAdjustmentType); + }); + +}); diff --git a/test/model/V1FeeCalculationPhase.spec.js b/test/model/V1FeeCalculationPhase.spec.js new file mode 100644 index 0000000..db7a3d6 --- /dev/null +++ b/test/model/V1FeeCalculationPhase.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('V1FeeCalculationPhase', function() { + beforeEach(function() { + }); + + it('should create an instance of V1FeeCalculationPhase', function() { + // uncomment below and update the code to test V1FeeCalculationPhase + //var instane = new SquareConnect.V1FeeCalculationPhase(); + //expect(instance).to.be.a(SquareConnect.V1FeeCalculationPhase); + }); + +}); diff --git a/test/model/V1FeeInclusionType.spec.js b/test/model/V1FeeInclusionType.spec.js new file mode 100644 index 0000000..e2286fb --- /dev/null +++ b/test/model/V1FeeInclusionType.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('V1FeeInclusionType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1FeeInclusionType', function() { + // uncomment below and update the code to test V1FeeInclusionType + //var instane = new SquareConnect.V1FeeInclusionType(); + //expect(instance).to.be.a(SquareConnect.V1FeeInclusionType); + }); + +}); diff --git a/test/model/V1FeeType.spec.js b/test/model/V1FeeType.spec.js new file mode 100644 index 0000000..955db60 --- /dev/null +++ b/test/model/V1FeeType.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('V1FeeType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1FeeType', function() { + // uncomment below and update the code to test V1FeeType + //var instane = new SquareConnect.V1FeeType(); + //expect(instance).to.be.a(SquareConnect.V1FeeType); + }); + +}); diff --git a/test/model/V1ItemColor.spec.js b/test/model/V1ItemColor.spec.js new file mode 100644 index 0000000..2cb5002 --- /dev/null +++ b/test/model/V1ItemColor.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('V1ItemColor', function() { + beforeEach(function() { + }); + + it('should create an instance of V1ItemColor', function() { + // uncomment below and update the code to test V1ItemColor + //var instane = new SquareConnect.V1ItemColor(); + //expect(instance).to.be.a(SquareConnect.V1ItemColor); + }); + +}); diff --git a/test/model/V1ItemType.spec.js b/test/model/V1ItemType.spec.js new file mode 100644 index 0000000..81842bf --- /dev/null +++ b/test/model/V1ItemType.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('V1ItemType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1ItemType', function() { + // uncomment below and update the code to test V1ItemType + //var instane = new SquareConnect.V1ItemType(); + //expect(instance).to.be.a(SquareConnect.V1ItemType); + }); + +}); diff --git a/test/model/V1ItemVisibility.spec.js b/test/model/V1ItemVisibility.spec.js new file mode 100644 index 0000000..e01d3e3 --- /dev/null +++ b/test/model/V1ItemVisibility.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('V1ItemVisibility', function() { + beforeEach(function() { + }); + + it('should create an instance of V1ItemVisibility', function() { + // uncomment below and update the code to test V1ItemVisibility + //var instane = new SquareConnect.V1ItemVisibility(); + //expect(instance).to.be.a(SquareConnect.V1ItemVisibility); + }); + +}); diff --git a/test/model/V1ListBankAccountsRequest.spec.js b/test/model/V1ListBankAccountsRequest.spec.js new file mode 100644 index 0000000..0d49dd6 --- /dev/null +++ b/test/model/V1ListBankAccountsRequest.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('V1ListBankAccountsRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListBankAccountsRequest(); + }); + + it('should create an instance of V1ListBankAccountsRequest', function() { + // uncomment below and update the code to test V1ListBankAccountsRequest + //var instane = new SquareConnect.V1ListBankAccountsRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListBankAccountsRequest); + }); + +}); diff --git a/test/model/V1ListBankAccountsResponse.spec.js b/test/model/V1ListBankAccountsResponse.spec.js new file mode 100644 index 0000000..61c85ca --- /dev/null +++ b/test/model/V1ListBankAccountsResponse.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('V1ListBankAccountsResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListBankAccountsResponse(); + }); + + it('should create an instance of V1ListBankAccountsResponse', function() { + // uncomment below and update the code to test V1ListBankAccountsResponse + //var instane = new SquareConnect.V1ListBankAccountsResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListBankAccountsResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListBankAccountsResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListCashDrawerShiftsRequest.spec.js b/test/model/V1ListCashDrawerShiftsRequest.spec.js new file mode 100644 index 0000000..33e8225 --- /dev/null +++ b/test/model/V1ListCashDrawerShiftsRequest.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('V1ListCashDrawerShiftsRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListCashDrawerShiftsRequest(); + }); + + it('should create an instance of V1ListCashDrawerShiftsRequest', function() { + // uncomment below and update the code to test V1ListCashDrawerShiftsRequest + //var instane = new SquareConnect.V1ListCashDrawerShiftsRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListCashDrawerShiftsRequest); + }); + + it('should have the property order (base name: "order")', function() { + // uncomment below and update the code to test the property order + //var instane = new SquareConnect.V1ListCashDrawerShiftsRequest(); + //expect(instance).to.be(); + }); + it('should have the property beginTime (base name: "begin_time")', function() { + // uncomment below and update the code to test the property beginTime + //var instane = new SquareConnect.V1ListCashDrawerShiftsRequest(); + //expect(instance).to.be(); + }); + it('should have the property endTime (base name: "end_time")', function() { + // uncomment below and update the code to test the property endTime + //var instane = new SquareConnect.V1ListCashDrawerShiftsRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListCashDrawerShiftsResponse.spec.js b/test/model/V1ListCashDrawerShiftsResponse.spec.js new file mode 100644 index 0000000..069e0fe --- /dev/null +++ b/test/model/V1ListCashDrawerShiftsResponse.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('V1ListCashDrawerShiftsResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListCashDrawerShiftsResponse(); + }); + + it('should create an instance of V1ListCashDrawerShiftsResponse', function() { + // uncomment below and update the code to test V1ListCashDrawerShiftsResponse + //var instane = new SquareConnect.V1ListCashDrawerShiftsResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListCashDrawerShiftsResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListCashDrawerShiftsResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListCategoriesRequest.spec.js b/test/model/V1ListCategoriesRequest.spec.js new file mode 100644 index 0000000..7d767d4 --- /dev/null +++ b/test/model/V1ListCategoriesRequest.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('V1ListCategoriesRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListCategoriesRequest(); + }); + + it('should create an instance of V1ListCategoriesRequest', function() { + // uncomment below and update the code to test V1ListCategoriesRequest + //var instane = new SquareConnect.V1ListCategoriesRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListCategoriesRequest); + }); + +}); diff --git a/test/model/V1ListCategoriesResponse.spec.js b/test/model/V1ListCategoriesResponse.spec.js new file mode 100644 index 0000000..eaa5027 --- /dev/null +++ b/test/model/V1ListCategoriesResponse.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('V1ListCategoriesResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListCategoriesResponse(); + }); + + it('should create an instance of V1ListCategoriesResponse', function() { + // uncomment below and update the code to test V1ListCategoriesResponse + //var instane = new SquareConnect.V1ListCategoriesResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListCategoriesResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListCategoriesResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListDiscountsRequest.spec.js b/test/model/V1ListDiscountsRequest.spec.js new file mode 100644 index 0000000..cab4aec --- /dev/null +++ b/test/model/V1ListDiscountsRequest.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('V1ListDiscountsRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListDiscountsRequest(); + }); + + it('should create an instance of V1ListDiscountsRequest', function() { + // uncomment below and update the code to test V1ListDiscountsRequest + //var instane = new SquareConnect.V1ListDiscountsRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListDiscountsRequest); + }); + +}); diff --git a/test/model/V1ListDiscountsResponse.spec.js b/test/model/V1ListDiscountsResponse.spec.js new file mode 100644 index 0000000..154b673 --- /dev/null +++ b/test/model/V1ListDiscountsResponse.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('V1ListDiscountsResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListDiscountsResponse(); + }); + + it('should create an instance of V1ListDiscountsResponse', function() { + // uncomment below and update the code to test V1ListDiscountsResponse + //var instane = new SquareConnect.V1ListDiscountsResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListDiscountsResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListDiscountsResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListEmployeeRolesRequest.spec.js b/test/model/V1ListEmployeeRolesRequest.spec.js new file mode 100644 index 0000000..9846a7d --- /dev/null +++ b/test/model/V1ListEmployeeRolesRequest.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('V1ListEmployeeRolesRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListEmployeeRolesRequest(); + }); + + it('should create an instance of V1ListEmployeeRolesRequest', function() { + // uncomment below and update the code to test V1ListEmployeeRolesRequest + //var instane = new SquareConnect.V1ListEmployeeRolesRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListEmployeeRolesRequest); + }); + + it('should have the property order (base name: "order")', function() { + // uncomment below and update the code to test the property order + //var instane = new SquareConnect.V1ListEmployeeRolesRequest(); + //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.V1ListEmployeeRolesRequest(); + //expect(instance).to.be(); + }); + it('should have the property batchToken (base name: "batch_token")', function() { + // uncomment below and update the code to test the property batchToken + //var instane = new SquareConnect.V1ListEmployeeRolesRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListEmployeeRolesResponse.spec.js b/test/model/V1ListEmployeeRolesResponse.spec.js new file mode 100644 index 0000000..7fac581 --- /dev/null +++ b/test/model/V1ListEmployeeRolesResponse.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('V1ListEmployeeRolesResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListEmployeeRolesResponse(); + }); + + it('should create an instance of V1ListEmployeeRolesResponse', function() { + // uncomment below and update the code to test V1ListEmployeeRolesResponse + //var instane = new SquareConnect.V1ListEmployeeRolesResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListEmployeeRolesResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListEmployeeRolesResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListEmployeesRequest.spec.js b/test/model/V1ListEmployeesRequest.spec.js new file mode 100644 index 0000000..75efabd --- /dev/null +++ b/test/model/V1ListEmployeesRequest.spec.js @@ -0,0 +1,72 @@ +/** + * 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('V1ListEmployeesRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListEmployeesRequest(); + }); + + it('should create an instance of V1ListEmployeesRequest', function() { + // uncomment below and update the code to test V1ListEmployeesRequest + //var instane = new SquareConnect.V1ListEmployeesRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListEmployeesRequest); + }); + + it('should have the property order (base name: "order")', function() { + // uncomment below and update the code to test the property order + //var instane = new SquareConnect.V1ListEmployeesRequest(); + //expect(instance).to.be(); + }); + it('should have the property beginUpdatedAt (base name: "begin_updated_at")', function() { + // uncomment below and update the code to test the property beginUpdatedAt + //var instane = new SquareConnect.V1ListEmployeesRequest(); + //expect(instance).to.be(); + }); + it('should have the property endUpdatedAt (base name: "end_updated_at")', function() { + // uncomment below and update the code to test the property endUpdatedAt + //var instane = new SquareConnect.V1ListEmployeesRequest(); + //expect(instance).to.be(); + }); + it('should have the property beginCreatedAt (base name: "begin_created_at")', function() { + // uncomment below and update the code to test the property beginCreatedAt + //var instane = new SquareConnect.V1ListEmployeesRequest(); + //expect(instance).to.be(); + }); + it('should have the property endCreatedAt (base name: "end_created_at")', function() { + // uncomment below and update the code to test the property endCreatedAt + //var instane = new SquareConnect.V1ListEmployeesRequest(); + //expect(instance).to.be(); + }); + 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.V1ListEmployeesRequest(); + //expect(instance).to.be(); + }); + it('should have the property externalId (base name: "external_id")', function() { + // uncomment below and update the code to test the property externalId + //var instane = new SquareConnect.V1ListEmployeesRequest(); + //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.V1ListEmployeesRequest(); + //expect(instance).to.be(); + }); + it('should have the property batchToken (base name: "batch_token")', function() { + // uncomment below and update the code to test the property batchToken + //var instane = new SquareConnect.V1ListEmployeesRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListEmployeesRequestStatus.spec.js b/test/model/V1ListEmployeesRequestStatus.spec.js new file mode 100644 index 0000000..ca71345 --- /dev/null +++ b/test/model/V1ListEmployeesRequestStatus.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('V1ListEmployeesRequestStatus', function() { + beforeEach(function() { + }); + + it('should create an instance of V1ListEmployeesRequestStatus', function() { + // uncomment below and update the code to test V1ListEmployeesRequestStatus + //var instane = new SquareConnect.V1ListEmployeesRequestStatus(); + //expect(instance).to.be.a(SquareConnect.V1ListEmployeesRequestStatus); + }); + +}); diff --git a/test/model/V1ListEmployeesResponse.spec.js b/test/model/V1ListEmployeesResponse.spec.js new file mode 100644 index 0000000..c79c36d --- /dev/null +++ b/test/model/V1ListEmployeesResponse.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('V1ListEmployeesResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListEmployeesResponse(); + }); + + it('should create an instance of V1ListEmployeesResponse', function() { + // uncomment below and update the code to test V1ListEmployeesResponse + //var instane = new SquareConnect.V1ListEmployeesResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListEmployeesResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListEmployeesResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListFeesRequest.spec.js b/test/model/V1ListFeesRequest.spec.js new file mode 100644 index 0000000..fff1d06 --- /dev/null +++ b/test/model/V1ListFeesRequest.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('V1ListFeesRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListFeesRequest(); + }); + + it('should create an instance of V1ListFeesRequest', function() { + // uncomment below and update the code to test V1ListFeesRequest + //var instane = new SquareConnect.V1ListFeesRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListFeesRequest); + }); + +}); diff --git a/test/model/V1ListFeesResponse.spec.js b/test/model/V1ListFeesResponse.spec.js new file mode 100644 index 0000000..cbbc5eb --- /dev/null +++ b/test/model/V1ListFeesResponse.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('V1ListFeesResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListFeesResponse(); + }); + + it('should create an instance of V1ListFeesResponse', function() { + // uncomment below and update the code to test V1ListFeesResponse + //var instane = new SquareConnect.V1ListFeesResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListFeesResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListFeesResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListInventoryRequest.spec.js b/test/model/V1ListInventoryRequest.spec.js new file mode 100644 index 0000000..f866e67 --- /dev/null +++ b/test/model/V1ListInventoryRequest.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('V1ListInventoryRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListInventoryRequest(); + }); + + it('should create an instance of V1ListInventoryRequest', function() { + // uncomment below and update the code to test V1ListInventoryRequest + //var instane = new SquareConnect.V1ListInventoryRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListInventoryRequest); + }); + + 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.V1ListInventoryRequest(); + //expect(instance).to.be(); + }); + it('should have the property batchToken (base name: "batch_token")', function() { + // uncomment below and update the code to test the property batchToken + //var instane = new SquareConnect.V1ListInventoryRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListInventoryResponse.spec.js b/test/model/V1ListInventoryResponse.spec.js new file mode 100644 index 0000000..98091d6 --- /dev/null +++ b/test/model/V1ListInventoryResponse.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('V1ListInventoryResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListInventoryResponse(); + }); + + it('should create an instance of V1ListInventoryResponse', function() { + // uncomment below and update the code to test V1ListInventoryResponse + //var instane = new SquareConnect.V1ListInventoryResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListInventoryResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListInventoryResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListItemsRequest.spec.js b/test/model/V1ListItemsRequest.spec.js new file mode 100644 index 0000000..2336ae6 --- /dev/null +++ b/test/model/V1ListItemsRequest.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('V1ListItemsRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListItemsRequest(); + }); + + it('should create an instance of V1ListItemsRequest', function() { + // uncomment below and update the code to test V1ListItemsRequest + //var instane = new SquareConnect.V1ListItemsRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListItemsRequest); + }); + + it('should have the property batchToken (base name: "batch_token")', function() { + // uncomment below and update the code to test the property batchToken + //var instane = new SquareConnect.V1ListItemsRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListItemsResponse.spec.js b/test/model/V1ListItemsResponse.spec.js new file mode 100644 index 0000000..c70eb63 --- /dev/null +++ b/test/model/V1ListItemsResponse.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('V1ListItemsResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListItemsResponse(); + }); + + it('should create an instance of V1ListItemsResponse', function() { + // uncomment below and update the code to test V1ListItemsResponse + //var instane = new SquareConnect.V1ListItemsResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListItemsResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListItemsResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListLocationsRequest.spec.js b/test/model/V1ListLocationsRequest.spec.js new file mode 100644 index 0000000..30fcb82 --- /dev/null +++ b/test/model/V1ListLocationsRequest.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('V1ListLocationsRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListLocationsRequest(); + }); + + it('should create an instance of V1ListLocationsRequest', function() { + // uncomment below and update the code to test V1ListLocationsRequest + //var instane = new SquareConnect.V1ListLocationsRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListLocationsRequest); + }); + +}); diff --git a/test/model/V1ListLocationsResponse.spec.js b/test/model/V1ListLocationsResponse.spec.js new file mode 100644 index 0000000..13ce30d --- /dev/null +++ b/test/model/V1ListLocationsResponse.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('V1ListLocationsResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListLocationsResponse(); + }); + + it('should create an instance of V1ListLocationsResponse', function() { + // uncomment below and update the code to test V1ListLocationsResponse + //var instane = new SquareConnect.V1ListLocationsResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListLocationsResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListLocationsResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListModifierListsRequest.spec.js b/test/model/V1ListModifierListsRequest.spec.js new file mode 100644 index 0000000..fddf9dd --- /dev/null +++ b/test/model/V1ListModifierListsRequest.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('V1ListModifierListsRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListModifierListsRequest(); + }); + + it('should create an instance of V1ListModifierListsRequest', function() { + // uncomment below and update the code to test V1ListModifierListsRequest + //var instane = new SquareConnect.V1ListModifierListsRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListModifierListsRequest); + }); + +}); diff --git a/test/model/V1ListModifierListsResponse.spec.js b/test/model/V1ListModifierListsResponse.spec.js new file mode 100644 index 0000000..2767466 --- /dev/null +++ b/test/model/V1ListModifierListsResponse.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('V1ListModifierListsResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListModifierListsResponse(); + }); + + it('should create an instance of V1ListModifierListsResponse', function() { + // uncomment below and update the code to test V1ListModifierListsResponse + //var instane = new SquareConnect.V1ListModifierListsResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListModifierListsResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListModifierListsResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListOrdersRequest.spec.js b/test/model/V1ListOrdersRequest.spec.js new file mode 100644 index 0000000..5543915 --- /dev/null +++ b/test/model/V1ListOrdersRequest.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('V1ListOrdersRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListOrdersRequest(); + }); + + it('should create an instance of V1ListOrdersRequest', function() { + // uncomment below and update the code to test V1ListOrdersRequest + //var instane = new SquareConnect.V1ListOrdersRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListOrdersRequest); + }); + + it('should have the property order (base name: "order")', function() { + // uncomment below and update the code to test the property order + //var instane = new SquareConnect.V1ListOrdersRequest(); + //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.V1ListOrdersRequest(); + //expect(instance).to.be(); + }); + it('should have the property batchToken (base name: "batch_token")', function() { + // uncomment below and update the code to test the property batchToken + //var instane = new SquareConnect.V1ListOrdersRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListOrdersResponse.spec.js b/test/model/V1ListOrdersResponse.spec.js new file mode 100644 index 0000000..00fe7f4 --- /dev/null +++ b/test/model/V1ListOrdersResponse.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('V1ListOrdersResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListOrdersResponse(); + }); + + it('should create an instance of V1ListOrdersResponse', function() { + // uncomment below and update the code to test V1ListOrdersResponse + //var instane = new SquareConnect.V1ListOrdersResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListOrdersResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListOrdersResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListPagesRequest.spec.js b/test/model/V1ListPagesRequest.spec.js new file mode 100644 index 0000000..f4e167d --- /dev/null +++ b/test/model/V1ListPagesRequest.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('V1ListPagesRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListPagesRequest(); + }); + + it('should create an instance of V1ListPagesRequest', function() { + // uncomment below and update the code to test V1ListPagesRequest + //var instane = new SquareConnect.V1ListPagesRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListPagesRequest); + }); + +}); diff --git a/test/model/V1ListPagesResponse.spec.js b/test/model/V1ListPagesResponse.spec.js new file mode 100644 index 0000000..68065a0 --- /dev/null +++ b/test/model/V1ListPagesResponse.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('V1ListPagesResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListPagesResponse(); + }); + + it('should create an instance of V1ListPagesResponse', function() { + // uncomment below and update the code to test V1ListPagesResponse + //var instane = new SquareConnect.V1ListPagesResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListPagesResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListPagesResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListPaymentsRequest.spec.js b/test/model/V1ListPaymentsRequest.spec.js new file mode 100644 index 0000000..e5bd7d7 --- /dev/null +++ b/test/model/V1ListPaymentsRequest.spec.js @@ -0,0 +1,57 @@ +/** + * 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('V1ListPaymentsRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListPaymentsRequest(); + }); + + it('should create an instance of V1ListPaymentsRequest', function() { + // uncomment below and update the code to test V1ListPaymentsRequest + //var instane = new SquareConnect.V1ListPaymentsRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListPaymentsRequest); + }); + + it('should have the property order (base name: "order")', function() { + // uncomment below and update the code to test the property order + //var instane = new SquareConnect.V1ListPaymentsRequest(); + //expect(instance).to.be(); + }); + it('should have the property beginTime (base name: "begin_time")', function() { + // uncomment below and update the code to test the property beginTime + //var instane = new SquareConnect.V1ListPaymentsRequest(); + //expect(instance).to.be(); + }); + it('should have the property endTime (base name: "end_time")', function() { + // uncomment below and update the code to test the property endTime + //var instane = new SquareConnect.V1ListPaymentsRequest(); + //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.V1ListPaymentsRequest(); + //expect(instance).to.be(); + }); + it('should have the property batchToken (base name: "batch_token")', function() { + // uncomment below and update the code to test the property batchToken + //var instane = new SquareConnect.V1ListPaymentsRequest(); + //expect(instance).to.be(); + }); + it('should have the property includePartial (base name: "include_partial")', function() { + // uncomment below and update the code to test the property includePartial + //var instane = new SquareConnect.V1ListPaymentsRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListPaymentsResponse.spec.js b/test/model/V1ListPaymentsResponse.spec.js new file mode 100644 index 0000000..67742fa --- /dev/null +++ b/test/model/V1ListPaymentsResponse.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('V1ListPaymentsResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListPaymentsResponse(); + }); + + it('should create an instance of V1ListPaymentsResponse', function() { + // uncomment below and update the code to test V1ListPaymentsResponse + //var instane = new SquareConnect.V1ListPaymentsResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListPaymentsResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListPaymentsResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListRefundsRequest.spec.js b/test/model/V1ListRefundsRequest.spec.js new file mode 100644 index 0000000..a97bc6f --- /dev/null +++ b/test/model/V1ListRefundsRequest.spec.js @@ -0,0 +1,52 @@ +/** + * 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('V1ListRefundsRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListRefundsRequest(); + }); + + it('should create an instance of V1ListRefundsRequest', function() { + // uncomment below and update the code to test V1ListRefundsRequest + //var instane = new SquareConnect.V1ListRefundsRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListRefundsRequest); + }); + + it('should have the property order (base name: "order")', function() { + // uncomment below and update the code to test the property order + //var instane = new SquareConnect.V1ListRefundsRequest(); + //expect(instance).to.be(); + }); + it('should have the property beginTime (base name: "begin_time")', function() { + // uncomment below and update the code to test the property beginTime + //var instane = new SquareConnect.V1ListRefundsRequest(); + //expect(instance).to.be(); + }); + it('should have the property endTime (base name: "end_time")', function() { + // uncomment below and update the code to test the property endTime + //var instane = new SquareConnect.V1ListRefundsRequest(); + //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.V1ListRefundsRequest(); + //expect(instance).to.be(); + }); + it('should have the property batchToken (base name: "batch_token")', function() { + // uncomment below and update the code to test the property batchToken + //var instane = new SquareConnect.V1ListRefundsRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListRefundsResponse.spec.js b/test/model/V1ListRefundsResponse.spec.js new file mode 100644 index 0000000..114bcc8 --- /dev/null +++ b/test/model/V1ListRefundsResponse.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('V1ListRefundsResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListRefundsResponse(); + }); + + it('should create an instance of V1ListRefundsResponse', function() { + // uncomment below and update the code to test V1ListRefundsResponse + //var instane = new SquareConnect.V1ListRefundsResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListRefundsResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListRefundsResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListSettlementsRequest.spec.js b/test/model/V1ListSettlementsRequest.spec.js new file mode 100644 index 0000000..17efa03 --- /dev/null +++ b/test/model/V1ListSettlementsRequest.spec.js @@ -0,0 +1,57 @@ +/** + * 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('V1ListSettlementsRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListSettlementsRequest(); + }); + + it('should create an instance of V1ListSettlementsRequest', function() { + // uncomment below and update the code to test V1ListSettlementsRequest + //var instane = new SquareConnect.V1ListSettlementsRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListSettlementsRequest); + }); + + it('should have the property order (base name: "order")', function() { + // uncomment below and update the code to test the property order + //var instane = new SquareConnect.V1ListSettlementsRequest(); + //expect(instance).to.be(); + }); + it('should have the property beginTime (base name: "begin_time")', function() { + // uncomment below and update the code to test the property beginTime + //var instane = new SquareConnect.V1ListSettlementsRequest(); + //expect(instance).to.be(); + }); + it('should have the property endTime (base name: "end_time")', function() { + // uncomment below and update the code to test the property endTime + //var instane = new SquareConnect.V1ListSettlementsRequest(); + //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.V1ListSettlementsRequest(); + //expect(instance).to.be(); + }); + 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.V1ListSettlementsRequest(); + //expect(instance).to.be(); + }); + it('should have the property batchToken (base name: "batch_token")', function() { + // uncomment below and update the code to test the property batchToken + //var instane = new SquareConnect.V1ListSettlementsRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListSettlementsRequestStatus.spec.js b/test/model/V1ListSettlementsRequestStatus.spec.js new file mode 100644 index 0000000..5a5cb49 --- /dev/null +++ b/test/model/V1ListSettlementsRequestStatus.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('V1ListSettlementsRequestStatus', function() { + beforeEach(function() { + }); + + it('should create an instance of V1ListSettlementsRequestStatus', function() { + // uncomment below and update the code to test V1ListSettlementsRequestStatus + //var instane = new SquareConnect.V1ListSettlementsRequestStatus(); + //expect(instance).to.be.a(SquareConnect.V1ListSettlementsRequestStatus); + }); + +}); diff --git a/test/model/V1ListSettlementsResponse.spec.js b/test/model/V1ListSettlementsResponse.spec.js new file mode 100644 index 0000000..e8560e9 --- /dev/null +++ b/test/model/V1ListSettlementsResponse.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('V1ListSettlementsResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListSettlementsResponse(); + }); + + it('should create an instance of V1ListSettlementsResponse', function() { + // uncomment below and update the code to test V1ListSettlementsResponse + //var instane = new SquareConnect.V1ListSettlementsResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListSettlementsResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListSettlementsResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListTimecardEventsRequest.spec.js b/test/model/V1ListTimecardEventsRequest.spec.js new file mode 100644 index 0000000..a957d4c --- /dev/null +++ b/test/model/V1ListTimecardEventsRequest.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('V1ListTimecardEventsRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListTimecardEventsRequest(); + }); + + it('should create an instance of V1ListTimecardEventsRequest', function() { + // uncomment below and update the code to test V1ListTimecardEventsRequest + //var instane = new SquareConnect.V1ListTimecardEventsRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListTimecardEventsRequest); + }); + + it('should have the property timecardId (base name: "timecard_id")', function() { + // uncomment below and update the code to test the property timecardId + //var instane = new SquareConnect.V1ListTimecardEventsRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListTimecardEventsResponse.spec.js b/test/model/V1ListTimecardEventsResponse.spec.js new file mode 100644 index 0000000..e8c5e56 --- /dev/null +++ b/test/model/V1ListTimecardEventsResponse.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('V1ListTimecardEventsResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListTimecardEventsResponse(); + }); + + it('should create an instance of V1ListTimecardEventsResponse', function() { + // uncomment below and update the code to test V1ListTimecardEventsResponse + //var instane = new SquareConnect.V1ListTimecardEventsResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListTimecardEventsResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListTimecardEventsResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListTimecardsRequest.spec.js b/test/model/V1ListTimecardsRequest.spec.js new file mode 100644 index 0000000..5aaef8e --- /dev/null +++ b/test/model/V1ListTimecardsRequest.spec.js @@ -0,0 +1,82 @@ +/** + * 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('V1ListTimecardsRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListTimecardsRequest(); + }); + + it('should create an instance of V1ListTimecardsRequest', function() { + // uncomment below and update the code to test V1ListTimecardsRequest + //var instane = new SquareConnect.V1ListTimecardsRequest(); + //expect(instance).to.be.a(SquareConnect.V1ListTimecardsRequest); + }); + + it('should have the property order (base name: "order")', function() { + // uncomment below and update the code to test the property order + //var instane = new SquareConnect.V1ListTimecardsRequest(); + //expect(instance).to.be(); + }); + it('should have the property employeeId (base name: "employee_id")', function() { + // uncomment below and update the code to test the property employeeId + //var instane = new SquareConnect.V1ListTimecardsRequest(); + //expect(instance).to.be(); + }); + it('should have the property beginClockinTime (base name: "begin_clockin_time")', function() { + // uncomment below and update the code to test the property beginClockinTime + //var instane = new SquareConnect.V1ListTimecardsRequest(); + //expect(instance).to.be(); + }); + it('should have the property endClockinTime (base name: "end_clockin_time")', function() { + // uncomment below and update the code to test the property endClockinTime + //var instane = new SquareConnect.V1ListTimecardsRequest(); + //expect(instance).to.be(); + }); + it('should have the property beginClockoutTime (base name: "begin_clockout_time")', function() { + // uncomment below and update the code to test the property beginClockoutTime + //var instane = new SquareConnect.V1ListTimecardsRequest(); + //expect(instance).to.be(); + }); + it('should have the property endClockoutTime (base name: "end_clockout_time")', function() { + // uncomment below and update the code to test the property endClockoutTime + //var instane = new SquareConnect.V1ListTimecardsRequest(); + //expect(instance).to.be(); + }); + it('should have the property beginUpdatedAt (base name: "begin_updated_at")', function() { + // uncomment below and update the code to test the property beginUpdatedAt + //var instane = new SquareConnect.V1ListTimecardsRequest(); + //expect(instance).to.be(); + }); + it('should have the property endUpdatedAt (base name: "end_updated_at")', function() { + // uncomment below and update the code to test the property endUpdatedAt + //var instane = new SquareConnect.V1ListTimecardsRequest(); + //expect(instance).to.be(); + }); + it('should have the property deleted (base name: "deleted")', function() { + // uncomment below and update the code to test the property deleted + //var instane = new SquareConnect.V1ListTimecardsRequest(); + //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.V1ListTimecardsRequest(); + //expect(instance).to.be(); + }); + it('should have the property batchToken (base name: "batch_token")', function() { + // uncomment below and update the code to test the property batchToken + //var instane = new SquareConnect.V1ListTimecardsRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1ListTimecardsResponse.spec.js b/test/model/V1ListTimecardsResponse.spec.js new file mode 100644 index 0000000..6abc481 --- /dev/null +++ b/test/model/V1ListTimecardsResponse.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('V1ListTimecardsResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.V1ListTimecardsResponse(); + }); + + it('should create an instance of V1ListTimecardsResponse', function() { + // uncomment below and update the code to test V1ListTimecardsResponse + //var instane = new SquareConnect.V1ListTimecardsResponse(); + //expect(instance).to.be.a(SquareConnect.V1ListTimecardsResponse); + }); + + it('should have the property items (base name: "items")', function() { + // uncomment below and update the code to test the property items + //var instane = new SquareConnect.V1ListTimecardsResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1MerchantAccountType.spec.js b/test/model/V1MerchantAccountType.spec.js new file mode 100644 index 0000000..1e065bd --- /dev/null +++ b/test/model/V1MerchantAccountType.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('V1MerchantAccountType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1MerchantAccountType', function() { + // uncomment below and update the code to test V1MerchantAccountType + //var instane = new SquareConnect.V1MerchantAccountType(); + //expect(instance).to.be.a(SquareConnect.V1MerchantAccountType); + }); + +}); diff --git a/test/model/V1MerchantBusinessType.spec.js b/test/model/V1MerchantBusinessType.spec.js new file mode 100644 index 0000000..d241f69 --- /dev/null +++ b/test/model/V1MerchantBusinessType.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('V1MerchantBusinessType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1MerchantBusinessType', function() { + // uncomment below and update the code to test V1MerchantBusinessType + //var instane = new SquareConnect.V1MerchantBusinessType(); + //expect(instance).to.be.a(SquareConnect.V1MerchantBusinessType); + }); + +}); diff --git a/test/model/V1ModifierListSelectionType.spec.js b/test/model/V1ModifierListSelectionType.spec.js new file mode 100644 index 0000000..d5ebdb4 --- /dev/null +++ b/test/model/V1ModifierListSelectionType.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('V1ModifierListSelectionType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1ModifierListSelectionType', function() { + // uncomment below and update the code to test V1ModifierListSelectionType + //var instane = new SquareConnect.V1ModifierListSelectionType(); + //expect(instance).to.be.a(SquareConnect.V1ModifierListSelectionType); + }); + +}); diff --git a/test/model/V1OrderHistoryEntryAction.spec.js b/test/model/V1OrderHistoryEntryAction.spec.js new file mode 100644 index 0000000..168c845 --- /dev/null +++ b/test/model/V1OrderHistoryEntryAction.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('V1OrderHistoryEntryAction', function() { + beforeEach(function() { + }); + + it('should create an instance of V1OrderHistoryEntryAction', function() { + // uncomment below and update the code to test V1OrderHistoryEntryAction + //var instane = new SquareConnect.V1OrderHistoryEntryAction(); + //expect(instance).to.be.a(SquareConnect.V1OrderHistoryEntryAction); + }); + +}); diff --git a/test/model/V1OrderState.spec.js b/test/model/V1OrderState.spec.js new file mode 100644 index 0000000..277811b --- /dev/null +++ b/test/model/V1OrderState.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('V1OrderState', function() { + beforeEach(function() { + }); + + it('should create an instance of V1OrderState', function() { + // uncomment below and update the code to test V1OrderState + //var instane = new SquareConnect.V1OrderState(); + //expect(instance).to.be.a(SquareConnect.V1OrderState); + }); + +}); diff --git a/test/model/V1PageCellObjectType.spec.js b/test/model/V1PageCellObjectType.spec.js new file mode 100644 index 0000000..a2e0f92 --- /dev/null +++ b/test/model/V1PageCellObjectType.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('V1PageCellObjectType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1PageCellObjectType', function() { + // uncomment below and update the code to test V1PageCellObjectType + //var instane = new SquareConnect.V1PageCellObjectType(); + //expect(instance).to.be.a(SquareConnect.V1PageCellObjectType); + }); + +}); diff --git a/test/model/V1PageCellPlaceholderType.spec.js b/test/model/V1PageCellPlaceholderType.spec.js new file mode 100644 index 0000000..dd2a3f8 --- /dev/null +++ b/test/model/V1PageCellPlaceholderType.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('V1PageCellPlaceholderType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1PageCellPlaceholderType', function() { + // uncomment below and update the code to test V1PageCellPlaceholderType + //var instane = new SquareConnect.V1PageCellPlaceholderType(); + //expect(instance).to.be.a(SquareConnect.V1PageCellPlaceholderType); + }); + +}); diff --git a/test/model/V1PaymentItemizationItemizationType.spec.js b/test/model/V1PaymentItemizationItemizationType.spec.js new file mode 100644 index 0000000..41b6535 --- /dev/null +++ b/test/model/V1PaymentItemizationItemizationType.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('V1PaymentItemizationItemizationType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1PaymentItemizationItemizationType', function() { + // uncomment below and update the code to test V1PaymentItemizationItemizationType + //var instane = new SquareConnect.V1PaymentItemizationItemizationType(); + //expect(instance).to.be.a(SquareConnect.V1PaymentItemizationItemizationType); + }); + +}); diff --git a/test/model/V1PaymentSurchargeType.spec.js b/test/model/V1PaymentSurchargeType.spec.js new file mode 100644 index 0000000..0edee28 --- /dev/null +++ b/test/model/V1PaymentSurchargeType.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('V1PaymentSurchargeType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1PaymentSurchargeType', function() { + // uncomment below and update the code to test V1PaymentSurchargeType + //var instane = new SquareConnect.V1PaymentSurchargeType(); + //expect(instance).to.be.a(SquareConnect.V1PaymentSurchargeType); + }); + +}); diff --git a/test/model/V1PaymentTaxInclusionType.spec.js b/test/model/V1PaymentTaxInclusionType.spec.js new file mode 100644 index 0000000..1a1b75c --- /dev/null +++ b/test/model/V1PaymentTaxInclusionType.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('V1PaymentTaxInclusionType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1PaymentTaxInclusionType', function() { + // uncomment below and update the code to test V1PaymentTaxInclusionType + //var instane = new SquareConnect.V1PaymentTaxInclusionType(); + //expect(instance).to.be.a(SquareConnect.V1PaymentTaxInclusionType); + }); + +}); diff --git a/test/model/V1RefundType.spec.js b/test/model/V1RefundType.spec.js new file mode 100644 index 0000000..b599c40 --- /dev/null +++ b/test/model/V1RefundType.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('V1RefundType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1RefundType', function() { + // uncomment below and update the code to test V1RefundType + //var instane = new SquareConnect.V1RefundType(); + //expect(instance).to.be.a(SquareConnect.V1RefundType); + }); + +}); diff --git a/test/model/V1RemoveFeeRequest.spec.js b/test/model/V1RemoveFeeRequest.spec.js new file mode 100644 index 0000000..6490b64 --- /dev/null +++ b/test/model/V1RemoveFeeRequest.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('V1RemoveFeeRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1RemoveFeeRequest(); + }); + + it('should create an instance of V1RemoveFeeRequest', function() { + // uncomment below and update the code to test V1RemoveFeeRequest + //var instane = new SquareConnect.V1RemoveFeeRequest(); + //expect(instance).to.be.a(SquareConnect.V1RemoveFeeRequest); + }); + +}); diff --git a/test/model/V1RemoveModifierListRequest.spec.js b/test/model/V1RemoveModifierListRequest.spec.js new file mode 100644 index 0000000..823fdf8 --- /dev/null +++ b/test/model/V1RemoveModifierListRequest.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('V1RemoveModifierListRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1RemoveModifierListRequest(); + }); + + it('should create an instance of V1RemoveModifierListRequest', function() { + // uncomment below and update the code to test V1RemoveModifierListRequest + //var instane = new SquareConnect.V1RemoveModifierListRequest(); + //expect(instance).to.be.a(SquareConnect.V1RemoveModifierListRequest); + }); + +}); diff --git a/test/model/V1RetrieveBankAccountRequest.spec.js b/test/model/V1RetrieveBankAccountRequest.spec.js new file mode 100644 index 0000000..f84814e --- /dev/null +++ b/test/model/V1RetrieveBankAccountRequest.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('V1RetrieveBankAccountRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1RetrieveBankAccountRequest(); + }); + + it('should create an instance of V1RetrieveBankAccountRequest', function() { + // uncomment below and update the code to test V1RetrieveBankAccountRequest + //var instane = new SquareConnect.V1RetrieveBankAccountRequest(); + //expect(instance).to.be.a(SquareConnect.V1RetrieveBankAccountRequest); + }); + +}); diff --git a/test/model/V1RetrieveBusinessRequest.spec.js b/test/model/V1RetrieveBusinessRequest.spec.js new file mode 100644 index 0000000..f93ed46 --- /dev/null +++ b/test/model/V1RetrieveBusinessRequest.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('V1RetrieveBusinessRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1RetrieveBusinessRequest(); + }); + + it('should create an instance of V1RetrieveBusinessRequest', function() { + // uncomment below and update the code to test V1RetrieveBusinessRequest + //var instane = new SquareConnect.V1RetrieveBusinessRequest(); + //expect(instance).to.be.a(SquareConnect.V1RetrieveBusinessRequest); + }); + +}); diff --git a/test/model/V1RetrieveCashDrawerShiftRequest.spec.js b/test/model/V1RetrieveCashDrawerShiftRequest.spec.js new file mode 100644 index 0000000..6f58123 --- /dev/null +++ b/test/model/V1RetrieveCashDrawerShiftRequest.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('V1RetrieveCashDrawerShiftRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1RetrieveCashDrawerShiftRequest(); + }); + + it('should create an instance of V1RetrieveCashDrawerShiftRequest', function() { + // uncomment below and update the code to test V1RetrieveCashDrawerShiftRequest + //var instane = new SquareConnect.V1RetrieveCashDrawerShiftRequest(); + //expect(instance).to.be.a(SquareConnect.V1RetrieveCashDrawerShiftRequest); + }); + +}); diff --git a/test/model/V1RetrieveEmployeeRequest.spec.js b/test/model/V1RetrieveEmployeeRequest.spec.js new file mode 100644 index 0000000..71a7ed3 --- /dev/null +++ b/test/model/V1RetrieveEmployeeRequest.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('V1RetrieveEmployeeRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1RetrieveEmployeeRequest(); + }); + + it('should create an instance of V1RetrieveEmployeeRequest', function() { + // uncomment below and update the code to test V1RetrieveEmployeeRequest + //var instane = new SquareConnect.V1RetrieveEmployeeRequest(); + //expect(instance).to.be.a(SquareConnect.V1RetrieveEmployeeRequest); + }); + +}); diff --git a/test/model/V1RetrieveEmployeeRoleRequest.spec.js b/test/model/V1RetrieveEmployeeRoleRequest.spec.js new file mode 100644 index 0000000..5f7938b --- /dev/null +++ b/test/model/V1RetrieveEmployeeRoleRequest.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('V1RetrieveEmployeeRoleRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1RetrieveEmployeeRoleRequest(); + }); + + it('should create an instance of V1RetrieveEmployeeRoleRequest', function() { + // uncomment below and update the code to test V1RetrieveEmployeeRoleRequest + //var instane = new SquareConnect.V1RetrieveEmployeeRoleRequest(); + //expect(instance).to.be.a(SquareConnect.V1RetrieveEmployeeRoleRequest); + }); + +}); diff --git a/test/model/V1RetrieveItemRequest.spec.js b/test/model/V1RetrieveItemRequest.spec.js new file mode 100644 index 0000000..91e699b --- /dev/null +++ b/test/model/V1RetrieveItemRequest.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('V1RetrieveItemRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1RetrieveItemRequest(); + }); + + it('should create an instance of V1RetrieveItemRequest', function() { + // uncomment below and update the code to test V1RetrieveItemRequest + //var instane = new SquareConnect.V1RetrieveItemRequest(); + //expect(instance).to.be.a(SquareConnect.V1RetrieveItemRequest); + }); + +}); diff --git a/test/model/V1RetrieveModifierListRequest.spec.js b/test/model/V1RetrieveModifierListRequest.spec.js new file mode 100644 index 0000000..cdfaa6e --- /dev/null +++ b/test/model/V1RetrieveModifierListRequest.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('V1RetrieveModifierListRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1RetrieveModifierListRequest(); + }); + + it('should create an instance of V1RetrieveModifierListRequest', function() { + // uncomment below and update the code to test V1RetrieveModifierListRequest + //var instane = new SquareConnect.V1RetrieveModifierListRequest(); + //expect(instance).to.be.a(SquareConnect.V1RetrieveModifierListRequest); + }); + +}); diff --git a/test/model/V1RetrieveOrderRequest.spec.js b/test/model/V1RetrieveOrderRequest.spec.js new file mode 100644 index 0000000..e352004 --- /dev/null +++ b/test/model/V1RetrieveOrderRequest.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('V1RetrieveOrderRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1RetrieveOrderRequest(); + }); + + it('should create an instance of V1RetrieveOrderRequest', function() { + // uncomment below and update the code to test V1RetrieveOrderRequest + //var instane = new SquareConnect.V1RetrieveOrderRequest(); + //expect(instance).to.be.a(SquareConnect.V1RetrieveOrderRequest); + }); + +}); diff --git a/test/model/V1RetrievePaymentRequest.spec.js b/test/model/V1RetrievePaymentRequest.spec.js new file mode 100644 index 0000000..08dd153 --- /dev/null +++ b/test/model/V1RetrievePaymentRequest.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('V1RetrievePaymentRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1RetrievePaymentRequest(); + }); + + it('should create an instance of V1RetrievePaymentRequest', function() { + // uncomment below and update the code to test V1RetrievePaymentRequest + //var instane = new SquareConnect.V1RetrievePaymentRequest(); + //expect(instance).to.be.a(SquareConnect.V1RetrievePaymentRequest); + }); + +}); diff --git a/test/model/V1RetrieveSettlementRequest.spec.js b/test/model/V1RetrieveSettlementRequest.spec.js new file mode 100644 index 0000000..868d995 --- /dev/null +++ b/test/model/V1RetrieveSettlementRequest.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('V1RetrieveSettlementRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1RetrieveSettlementRequest(); + }); + + it('should create an instance of V1RetrieveSettlementRequest', function() { + // uncomment below and update the code to test V1RetrieveSettlementRequest + //var instane = new SquareConnect.V1RetrieveSettlementRequest(); + //expect(instance).to.be.a(SquareConnect.V1RetrieveSettlementRequest); + }); + +}); diff --git a/test/model/V1RetrieveTimecardRequest.spec.js b/test/model/V1RetrieveTimecardRequest.spec.js new file mode 100644 index 0000000..7d7bf44 --- /dev/null +++ b/test/model/V1RetrieveTimecardRequest.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('V1RetrieveTimecardRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1RetrieveTimecardRequest(); + }); + + it('should create an instance of V1RetrieveTimecardRequest', function() { + // uncomment below and update the code to test V1RetrieveTimecardRequest + //var instane = new SquareConnect.V1RetrieveTimecardRequest(); + //expect(instance).to.be.a(SquareConnect.V1RetrieveTimecardRequest); + }); + +}); diff --git a/test/model/V1SettlementEntryType.spec.js b/test/model/V1SettlementEntryType.spec.js new file mode 100644 index 0000000..9b2c6a1 --- /dev/null +++ b/test/model/V1SettlementEntryType.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('V1SettlementEntryType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1SettlementEntryType', function() { + // uncomment below and update the code to test V1SettlementEntryType + //var instane = new SquareConnect.V1SettlementEntryType(); + //expect(instance).to.be.a(SquareConnect.V1SettlementEntryType); + }); + +}); diff --git a/test/model/V1SettlementStatus.spec.js b/test/model/V1SettlementStatus.spec.js new file mode 100644 index 0000000..548cfd9 --- /dev/null +++ b/test/model/V1SettlementStatus.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('V1SettlementStatus', function() { + beforeEach(function() { + }); + + it('should create an instance of V1SettlementStatus', function() { + // uncomment below and update the code to test V1SettlementStatus + //var instane = new SquareConnect.V1SettlementStatus(); + //expect(instance).to.be.a(SquareConnect.V1SettlementStatus); + }); + +}); diff --git a/test/model/V1TenderEntryMethod.spec.js b/test/model/V1TenderEntryMethod.spec.js new file mode 100644 index 0000000..ca9724c --- /dev/null +++ b/test/model/V1TenderEntryMethod.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('V1TenderEntryMethod', function() { + beforeEach(function() { + }); + + it('should create an instance of V1TenderEntryMethod', function() { + // uncomment below and update the code to test V1TenderEntryMethod + //var instane = new SquareConnect.V1TenderEntryMethod(); + //expect(instance).to.be.a(SquareConnect.V1TenderEntryMethod); + }); + +}); diff --git a/test/model/V1TenderType.spec.js b/test/model/V1TenderType.spec.js new file mode 100644 index 0000000..7d424de --- /dev/null +++ b/test/model/V1TenderType.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('V1TenderType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1TenderType', function() { + // uncomment below and update the code to test V1TenderType + //var instane = new SquareConnect.V1TenderType(); + //expect(instance).to.be.a(SquareConnect.V1TenderType); + }); + +}); diff --git a/test/model/V1TimecardEventEventType.spec.js b/test/model/V1TimecardEventEventType.spec.js new file mode 100644 index 0000000..e8ef0e2 --- /dev/null +++ b/test/model/V1TimecardEventEventType.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('V1TimecardEventEventType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1TimecardEventEventType', function() { + // uncomment below and update the code to test V1TimecardEventEventType + //var instane = new SquareConnect.V1TimecardEventEventType(); + //expect(instance).to.be.a(SquareConnect.V1TimecardEventEventType); + }); + +}); diff --git a/test/model/V1UpdateCategoryRequest.spec.js b/test/model/V1UpdateCategoryRequest.spec.js new file mode 100644 index 0000000..cfb3993 --- /dev/null +++ b/test/model/V1UpdateCategoryRequest.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('V1UpdateCategoryRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1UpdateCategoryRequest(); + }); + + it('should create an instance of V1UpdateCategoryRequest', function() { + // uncomment below and update the code to test V1UpdateCategoryRequest + //var instane = new SquareConnect.V1UpdateCategoryRequest(); + //expect(instance).to.be.a(SquareConnect.V1UpdateCategoryRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1UpdateCategoryRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1UpdateDiscountRequest.spec.js b/test/model/V1UpdateDiscountRequest.spec.js new file mode 100644 index 0000000..77d8bed --- /dev/null +++ b/test/model/V1UpdateDiscountRequest.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('V1UpdateDiscountRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1UpdateDiscountRequest(); + }); + + it('should create an instance of V1UpdateDiscountRequest', function() { + // uncomment below and update the code to test V1UpdateDiscountRequest + //var instane = new SquareConnect.V1UpdateDiscountRequest(); + //expect(instance).to.be.a(SquareConnect.V1UpdateDiscountRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1UpdateDiscountRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1UpdateEmployeeRequest.spec.js b/test/model/V1UpdateEmployeeRequest.spec.js new file mode 100644 index 0000000..5341884 --- /dev/null +++ b/test/model/V1UpdateEmployeeRequest.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('V1UpdateEmployeeRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1UpdateEmployeeRequest(); + }); + + it('should create an instance of V1UpdateEmployeeRequest', function() { + // uncomment below and update the code to test V1UpdateEmployeeRequest + //var instane = new SquareConnect.V1UpdateEmployeeRequest(); + //expect(instance).to.be.a(SquareConnect.V1UpdateEmployeeRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1UpdateEmployeeRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1UpdateEmployeeRoleRequest.spec.js b/test/model/V1UpdateEmployeeRoleRequest.spec.js new file mode 100644 index 0000000..f60cd71 --- /dev/null +++ b/test/model/V1UpdateEmployeeRoleRequest.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('V1UpdateEmployeeRoleRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1UpdateEmployeeRoleRequest(); + }); + + it('should create an instance of V1UpdateEmployeeRoleRequest', function() { + // uncomment below and update the code to test V1UpdateEmployeeRoleRequest + //var instane = new SquareConnect.V1UpdateEmployeeRoleRequest(); + //expect(instance).to.be.a(SquareConnect.V1UpdateEmployeeRoleRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1UpdateEmployeeRoleRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1UpdateFeeRequest.spec.js b/test/model/V1UpdateFeeRequest.spec.js new file mode 100644 index 0000000..9ee5b37 --- /dev/null +++ b/test/model/V1UpdateFeeRequest.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('V1UpdateFeeRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1UpdateFeeRequest(); + }); + + it('should create an instance of V1UpdateFeeRequest', function() { + // uncomment below and update the code to test V1UpdateFeeRequest + //var instane = new SquareConnect.V1UpdateFeeRequest(); + //expect(instance).to.be.a(SquareConnect.V1UpdateFeeRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1UpdateFeeRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1UpdateItemRequest.spec.js b/test/model/V1UpdateItemRequest.spec.js new file mode 100644 index 0000000..2e8d09d --- /dev/null +++ b/test/model/V1UpdateItemRequest.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('V1UpdateItemRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1UpdateItemRequest(); + }); + + it('should create an instance of V1UpdateItemRequest', function() { + // uncomment below and update the code to test V1UpdateItemRequest + //var instane = new SquareConnect.V1UpdateItemRequest(); + //expect(instance).to.be.a(SquareConnect.V1UpdateItemRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1UpdateItemRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1UpdateModifierListRequestSelectionType.spec.js b/test/model/V1UpdateModifierListRequestSelectionType.spec.js new file mode 100644 index 0000000..ca968cb --- /dev/null +++ b/test/model/V1UpdateModifierListRequestSelectionType.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('V1UpdateModifierListRequestSelectionType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1UpdateModifierListRequestSelectionType', function() { + // uncomment below and update the code to test V1UpdateModifierListRequestSelectionType + //var instane = new SquareConnect.V1UpdateModifierListRequestSelectionType(); + //expect(instance).to.be.a(SquareConnect.V1UpdateModifierListRequestSelectionType); + }); + +}); diff --git a/test/model/V1UpdateModifierOptionRequest.spec.js b/test/model/V1UpdateModifierOptionRequest.spec.js new file mode 100644 index 0000000..5764a1a --- /dev/null +++ b/test/model/V1UpdateModifierOptionRequest.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('V1UpdateModifierOptionRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1UpdateModifierOptionRequest(); + }); + + it('should create an instance of V1UpdateModifierOptionRequest', function() { + // uncomment below and update the code to test V1UpdateModifierOptionRequest + //var instane = new SquareConnect.V1UpdateModifierOptionRequest(); + //expect(instance).to.be.a(SquareConnect.V1UpdateModifierOptionRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1UpdateModifierOptionRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1UpdateOrderRequestAction.spec.js b/test/model/V1UpdateOrderRequestAction.spec.js new file mode 100644 index 0000000..b48af07 --- /dev/null +++ b/test/model/V1UpdateOrderRequestAction.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('V1UpdateOrderRequestAction', function() { + beforeEach(function() { + }); + + it('should create an instance of V1UpdateOrderRequestAction', function() { + // uncomment below and update the code to test V1UpdateOrderRequestAction + //var instane = new SquareConnect.V1UpdateOrderRequestAction(); + //expect(instance).to.be.a(SquareConnect.V1UpdateOrderRequestAction); + }); + +}); diff --git a/test/model/V1UpdatePageCellRequest.spec.js b/test/model/V1UpdatePageCellRequest.spec.js new file mode 100644 index 0000000..1344909 --- /dev/null +++ b/test/model/V1UpdatePageCellRequest.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('V1UpdatePageCellRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1UpdatePageCellRequest(); + }); + + it('should create an instance of V1UpdatePageCellRequest', function() { + // uncomment below and update the code to test V1UpdatePageCellRequest + //var instane = new SquareConnect.V1UpdatePageCellRequest(); + //expect(instance).to.be.a(SquareConnect.V1UpdatePageCellRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1UpdatePageCellRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1UpdatePageRequest.spec.js b/test/model/V1UpdatePageRequest.spec.js new file mode 100644 index 0000000..b7d525f --- /dev/null +++ b/test/model/V1UpdatePageRequest.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('V1UpdatePageRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1UpdatePageRequest(); + }); + + it('should create an instance of V1UpdatePageRequest', function() { + // uncomment below and update the code to test V1UpdatePageRequest + //var instane = new SquareConnect.V1UpdatePageRequest(); + //expect(instance).to.be.a(SquareConnect.V1UpdatePageRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1UpdatePageRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1UpdateTimecardRequest.spec.js b/test/model/V1UpdateTimecardRequest.spec.js new file mode 100644 index 0000000..50d5ce0 --- /dev/null +++ b/test/model/V1UpdateTimecardRequest.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('V1UpdateTimecardRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1UpdateTimecardRequest(); + }); + + it('should create an instance of V1UpdateTimecardRequest', function() { + // uncomment below and update the code to test V1UpdateTimecardRequest + //var instane = new SquareConnect.V1UpdateTimecardRequest(); + //expect(instance).to.be.a(SquareConnect.V1UpdateTimecardRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1UpdateTimecardRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1UpdateVariationRequest.spec.js b/test/model/V1UpdateVariationRequest.spec.js new file mode 100644 index 0000000..9da2eea --- /dev/null +++ b/test/model/V1UpdateVariationRequest.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('V1UpdateVariationRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.V1UpdateVariationRequest(); + }); + + it('should create an instance of V1UpdateVariationRequest', function() { + // uncomment below and update the code to test V1UpdateVariationRequest + //var instane = new SquareConnect.V1UpdateVariationRequest(); + //expect(instance).to.be.a(SquareConnect.V1UpdateVariationRequest); + }); + + it('should have the property body (base name: "body")', function() { + // uncomment below and update the code to test the property body + //var instane = new SquareConnect.V1UpdateVariationRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/V1VariationInventoryAlertType.spec.js b/test/model/V1VariationInventoryAlertType.spec.js new file mode 100644 index 0000000..63a02bd --- /dev/null +++ b/test/model/V1VariationInventoryAlertType.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('V1VariationInventoryAlertType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1VariationInventoryAlertType', function() { + // uncomment below and update the code to test V1VariationInventoryAlertType + //var instane = new SquareConnect.V1VariationInventoryAlertType(); + //expect(instance).to.be.a(SquareConnect.V1VariationInventoryAlertType); + }); + +}); diff --git a/test/model/V1VariationPricingType.spec.js b/test/model/V1VariationPricingType.spec.js new file mode 100644 index 0000000..37dec29 --- /dev/null +++ b/test/model/V1VariationPricingType.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('V1VariationPricingType', function() { + beforeEach(function() { + }); + + it('should create an instance of V1VariationPricingType', function() { + // uncomment below and update the code to test V1VariationPricingType + //var instane = new SquareConnect.V1VariationPricingType(); + //expect(instance).to.be.a(SquareConnect.V1VariationPricingType); + }); + +}); diff --git a/test/model/Weekday.spec.js b/test/model/Weekday.spec.js new file mode 100644 index 0000000..981305a --- /dev/null +++ b/test/model/Weekday.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('Weekday', function() { + beforeEach(function() { + }); + + it('should create an instance of Weekday', function() { + // uncomment below and update the code to test Weekday + //var instane = new SquareConnect.Weekday(); + //expect(instance).to.be.a(SquareConnect.Weekday); + }); + +}); diff --git a/test/model/WorkweekConfig.spec.js b/test/model/WorkweekConfig.spec.js new file mode 100644 index 0000000..0aafa47 --- /dev/null +++ b/test/model/WorkweekConfig.spec.js @@ -0,0 +1,57 @@ +/** + * 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('WorkweekConfig', function() { + beforeEach(function() { + this.api = new SquareConnect.WorkweekConfig(); + }); + + it('should create an instance of WorkweekConfig', function() { + // uncomment below and update the code to test WorkweekConfig + //var instane = new SquareConnect.WorkweekConfig(); + //expect(instance).to.be.a(SquareConnect.WorkweekConfig); + }); + + 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.WorkweekConfig(); + //expect(instance).to.be(); + }); + it('should have the property startOfWeek (base name: "start_of_week")', function() { + // uncomment below and update the code to test the property startOfWeek + //var instane = new SquareConnect.WorkweekConfig(); + //expect(instance).to.be(); + }); + it('should have the property startOfDayLocalTime (base name: "start_of_day_local_time")', function() { + // uncomment below and update the code to test the property startOfDayLocalTime + //var instane = new SquareConnect.WorkweekConfig(); + //expect(instance).to.be(); + }); + it('should have the property version (base name: "version")', function() { + // uncomment below and update the code to test the property version + //var instane = new SquareConnect.WorkweekConfig(); + //expect(instance).to.be(); + }); + it('should have the property createdAt (base name: "created_at")', function() { + // uncomment below and update the code to test the property createdAt + //var instane = new SquareConnect.WorkweekConfig(); + //expect(instance).to.be(); + }); + it('should have the property updatedAt (base name: "updated_at")', function() { + // uncomment below and update the code to test the property updatedAt + //var instane = new SquareConnect.WorkweekConfig(); + //expect(instance).to.be(); + }); +});