diff --git a/CHANGES.md b/CHANGES.md index 2a6200d..83fce14 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,5 +1,21 @@ # Change Log +## Version 4.20200625.0 (2020-06-25T00:00) +## New API release + +* **Team API generally available (GA)** + * For an overview, see [Team API Overview](https://developer.squareup.com/docs/team/overview). + * For technical reference, see [Team API](https://developer.squareup.com/reference/square_2020-06-25/team-api). + +## Existing API updates + +* **Catalog API** + * [Pricing](https://developer.squareup.com/reference/square_2020-06-25/objects/CatalogPricingRule) is now GA. It allows an application to configure catalog item pricing rules for the specified discounts to apply automatically. + +* **Payments API** + * The [CardPaymentDetails](https://developer.squareup.com/reference/square_2020-06-25/objects/CardPaymentDetails) type now supports a new field, [refund_requires_card_presence](https://developer.squareup.com/reference/square_2020-06-25/objects/CardPaymentDetails#definition__property-refund_requires_card_presence). When set to true, the payment card must be physically present to refund a payment. + + ## Version 3.20200528.0 (2020-05-28) ## API releases diff --git a/README.md b/README.md index 43f6d02..af2f8d2 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,14 @@ [![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0) ================== ## NOTICE: Square Connect Node.js SDK deprecated -This Square Connect SDK will enter a security maintenance phase in Q4 2020 and will be RETIRED (EOL) in Q2 2021. In the security +This Square Connect SDK will enter a security maintenance phase in Q3 2020 and will be RETIRED (EOL) in Q1 2021. In the security maintenance phase, this SDK will continue to receive support and security patches but will no longer receive bug fixes or product updates. Once it is retired, support and security patches will no longer be available. A new SDK, more bespoke to the language, will be available once this SDK enters its security maintenance phase. -The SDK itself will continue to work indefinitely until such time that the underlying APIs are retired at which point portions of the SDK may stop functioning. For a full list of API retirement dates, please see our [Square API Lifecycle documentation](https://developer.squareup.com/docs/build-basics/api-lifecycle#deprecated-apis). +The SDK itself will continue to work indefinitely until such time that the underlying APIs are retired at which point portions of the SDK may stop functioning. For a full list of API retirement dates, please see our [Square API Lifecycle documentation](https ://developer.squareup.com/docs/build-basics/api-lifecycle#deprecated-apis). | Security Maintenance | New SDK Release | Retired (EOL) | | ------------- |-------------| -----| -| Q4, 2020 | Q4, 2020 | Q2, 2021 | +| Q3, 2020 | Q3, 2020 | Q1, 2021 | **If you have feedback about the new SDKs, or just want to talk to other Square Developers, request an invite to the new [slack community for Square Developers](https://squ.re/2uLSRw5)** @@ -186,6 +186,14 @@ Class | Method | HTTP request | Description *SquareConnect.RefundsApi* | [**refundPayment**](docs/RefundsApi.md#refundPayment) | **POST** /v2/refunds | RefundPayment *SquareConnect.ReportingApi* | [**listAdditionalRecipientReceivableRefunds**](docs/ReportingApi.md#listAdditionalRecipientReceivableRefunds) | **GET** /v2/locations/{location_id}/additional-recipient-receivable-refunds | ListAdditionalRecipientReceivableRefunds *SquareConnect.ReportingApi* | [**listAdditionalRecipientReceivables**](docs/ReportingApi.md#listAdditionalRecipientReceivables) | **GET** /v2/locations/{location_id}/additional-recipient-receivables | ListAdditionalRecipientReceivables +*SquareConnect.TeamApi* | [**bulkCreateTeamMembers**](docs/TeamApi.md#bulkCreateTeamMembers) | **POST** /v2/team-members/bulk-create | BulkCreateTeamMembers +*SquareConnect.TeamApi* | [**bulkUpdateTeamMembers**](docs/TeamApi.md#bulkUpdateTeamMembers) | **POST** /v2/team-members/bulk-update | BulkUpdateTeamMembers +*SquareConnect.TeamApi* | [**createTeamMember**](docs/TeamApi.md#createTeamMember) | **POST** /v2/team-members | CreateTeamMember +*SquareConnect.TeamApi* | [**retrieveTeamMember**](docs/TeamApi.md#retrieveTeamMember) | **GET** /v2/team-members/{team_member_id} | RetrieveTeamMember +*SquareConnect.TeamApi* | [**retrieveWageSetting**](docs/TeamApi.md#retrieveWageSetting) | **GET** /v2/team-members/{team_member_id}/wage-setting | RetrieveWageSetting +*SquareConnect.TeamApi* | [**searchTeamMembers**](docs/TeamApi.md#searchTeamMembers) | **POST** /v2/team-members/search | SearchTeamMembers +*SquareConnect.TeamApi* | [**updateTeamMember**](docs/TeamApi.md#updateTeamMember) | **PUT** /v2/team-members/{team_member_id} | UpdateTeamMember +*SquareConnect.TeamApi* | [**updateWageSetting**](docs/TeamApi.md#updateWageSetting) | **PUT** /v2/team-members/{team_member_id}/wage-setting | UpdateWageSetting *SquareConnect.TerminalApi* | [**cancelTerminalCheckout**](docs/TerminalApi.md#cancelTerminalCheckout) | **POST** /v2/terminals/checkouts/{checkout_id}/cancel | CancelTerminalCheckout *SquareConnect.TerminalApi* | [**createTerminalCheckout**](docs/TerminalApi.md#createTerminalCheckout) | **POST** /v2/terminals/checkouts | CreateTerminalCheckout *SquareConnect.TerminalApi* | [**getTerminalCheckout**](docs/TerminalApi.md#getTerminalCheckout) | **GET** /v2/terminals/checkouts/{checkout_id} | GetTerminalCheckout @@ -301,6 +309,10 @@ Class | Method | HTTP request | Description - [SquareConnect.BatchUpsertCatalogObjectsRequest](docs/BatchUpsertCatalogObjectsRequest.md) - [SquareConnect.BatchUpsertCatalogObjectsResponse](docs/BatchUpsertCatalogObjectsResponse.md) - [SquareConnect.BreakType](docs/BreakType.md) + - [SquareConnect.BulkCreateTeamMembersRequest](docs/BulkCreateTeamMembersRequest.md) + - [SquareConnect.BulkCreateTeamMembersResponse](docs/BulkCreateTeamMembersResponse.md) + - [SquareConnect.BulkUpdateTeamMembersRequest](docs/BulkUpdateTeamMembersRequest.md) + - [SquareConnect.BulkUpdateTeamMembersResponse](docs/BulkUpdateTeamMembersResponse.md) - [SquareConnect.BusinessHours](docs/BusinessHours.md) - [SquareConnect.BusinessHoursPeriod](docs/BusinessHoursPeriod.md) - [SquareConnect.CalculateLoyaltyPointsRequest](docs/CalculateLoyaltyPointsRequest.md) @@ -364,13 +376,7 @@ Class | Method | HTTP request | Description - [SquareConnect.CatalogPricingType](docs/CatalogPricingType.md) - [SquareConnect.CatalogProductSet](docs/CatalogProductSet.md) - [SquareConnect.CatalogQuery](docs/CatalogQuery.md) - - [SquareConnect.CatalogQueryCustomAttributeUsage](docs/CatalogQueryCustomAttributeUsage.md) - [SquareConnect.CatalogQueryExact](docs/CatalogQueryExact.md) - - [SquareConnect.CatalogQueryFilteredItems](docs/CatalogQueryFilteredItems.md) - - [SquareConnect.CatalogQueryFilteredItemsCustomAttributeFilter](docs/CatalogQueryFilteredItemsCustomAttributeFilter.md) - - [SquareConnect.CatalogQueryFilteredItemsCustomAttributeFilterFilterType](docs/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.md) - - [SquareConnect.CatalogQueryFilteredItemsNullableAttribute](docs/CatalogQueryFilteredItemsNullableAttribute.md) - - [SquareConnect.CatalogQueryFilteredItemsStockLevel](docs/CatalogQueryFilteredItemsStockLevel.md) - [SquareConnect.CatalogQueryItemVariationsForItemOptionValues](docs/CatalogQueryItemVariationsForItemOptionValues.md) - [SquareConnect.CatalogQueryItemsForItemOptions](docs/CatalogQueryItemsForItemOptions.md) - [SquareConnect.CatalogQueryItemsForModifierList](docs/CatalogQueryItemsForModifierList.md) @@ -428,6 +434,8 @@ Class | Method | HTTP request | Description - [SquareConnect.CreateRefundResponse](docs/CreateRefundResponse.md) - [SquareConnect.CreateShiftRequest](docs/CreateShiftRequest.md) - [SquareConnect.CreateShiftResponse](docs/CreateShiftResponse.md) + - [SquareConnect.CreateTeamMemberRequest](docs/CreateTeamMemberRequest.md) + - [SquareConnect.CreateTeamMemberResponse](docs/CreateTeamMemberResponse.md) - [SquareConnect.CreateTerminalCheckoutRequest](docs/CreateTerminalCheckoutRequest.md) - [SquareConnect.CreateTerminalCheckoutResponse](docs/CreateTerminalCheckoutResponse.md) - [SquareConnect.Currency](docs/Currency.md) @@ -508,6 +516,8 @@ Class | Method | HTTP request | Description - [SquareConnect.InventoryState](docs/InventoryState.md) - [SquareConnect.InventoryTransfer](docs/InventoryTransfer.md) - [SquareConnect.ItemVariationLocationOverrides](docs/ItemVariationLocationOverrides.md) + - [SquareConnect.JobAssignment](docs/JobAssignment.md) + - [SquareConnect.JobAssignmentPayType](docs/JobAssignmentPayType.md) - [SquareConnect.ListAdditionalRecipientReceivableRefundsRequest](docs/ListAdditionalRecipientReceivableRefundsRequest.md) - [SquareConnect.ListAdditionalRecipientReceivableRefundsResponse](docs/ListAdditionalRecipientReceivableRefundsResponse.md) - [SquareConnect.ListAdditionalRecipientReceivablesRequest](docs/ListAdditionalRecipientReceivablesRequest.md) @@ -702,8 +712,12 @@ Class | Method | HTTP request | Description - [SquareConnect.RetrieveLoyaltyRewardResponse](docs/RetrieveLoyaltyRewardResponse.md) - [SquareConnect.RetrieveMerchantRequest](docs/RetrieveMerchantRequest.md) - [SquareConnect.RetrieveMerchantResponse](docs/RetrieveMerchantResponse.md) + - [SquareConnect.RetrieveTeamMemberRequest](docs/RetrieveTeamMemberRequest.md) + - [SquareConnect.RetrieveTeamMemberResponse](docs/RetrieveTeamMemberResponse.md) - [SquareConnect.RetrieveTransactionRequest](docs/RetrieveTransactionRequest.md) - [SquareConnect.RetrieveTransactionResponse](docs/RetrieveTransactionResponse.md) + - [SquareConnect.RetrieveWageSettingRequest](docs/RetrieveWageSettingRequest.md) + - [SquareConnect.RetrieveWageSettingResponse](docs/RetrieveWageSettingResponse.md) - [SquareConnect.RevokeTokenRequest](docs/RevokeTokenRequest.md) - [SquareConnect.RevokeTokenResponse](docs/RevokeTokenResponse.md) - [SquareConnect.SearchCatalogObjectsRequest](docs/SearchCatalogObjectsRequest.md) @@ -731,6 +745,10 @@ Class | Method | HTTP request | Description - [SquareConnect.SearchOrdersStateFilter](docs/SearchOrdersStateFilter.md) - [SquareConnect.SearchShiftsRequest](docs/SearchShiftsRequest.md) - [SquareConnect.SearchShiftsResponse](docs/SearchShiftsResponse.md) + - [SquareConnect.SearchTeamMembersFilter](docs/SearchTeamMembersFilter.md) + - [SquareConnect.SearchTeamMembersQuery](docs/SearchTeamMembersQuery.md) + - [SquareConnect.SearchTeamMembersRequest](docs/SearchTeamMembersRequest.md) + - [SquareConnect.SearchTeamMembersResponse](docs/SearchTeamMembersResponse.md) - [SquareConnect.SearchTerminalCheckoutsRequest](docs/SearchTerminalCheckoutsRequest.md) - [SquareConnect.SearchTerminalCheckoutsResponse](docs/SearchTerminalCheckoutsResponse.md) - [SquareConnect.Shift](docs/Shift.md) @@ -751,6 +769,10 @@ Class | Method | HTTP request | Description - [SquareConnect.SubmitEvidenceResponse](docs/SubmitEvidenceResponse.md) - [SquareConnect.TaxCalculationPhase](docs/TaxCalculationPhase.md) - [SquareConnect.TaxInclusionType](docs/TaxInclusionType.md) + - [SquareConnect.TeamMember](docs/TeamMember.md) + - [SquareConnect.TeamMemberAssignedLocations](docs/TeamMemberAssignedLocations.md) + - [SquareConnect.TeamMemberAssignedLocationsAssignmentType](docs/TeamMemberAssignedLocationsAssignmentType.md) + - [SquareConnect.TeamMemberStatus](docs/TeamMemberStatus.md) - [SquareConnect.Tender](docs/Tender.md) - [SquareConnect.TenderCardDetails](docs/TenderCardDetails.md) - [SquareConnect.TenderCardDetailsEntryMethod](docs/TenderCardDetailsEntryMethod.md) @@ -783,6 +805,10 @@ Class | Method | HTTP request | Description - [SquareConnect.UpdateOrderResponse](docs/UpdateOrderResponse.md) - [SquareConnect.UpdateShiftRequest](docs/UpdateShiftRequest.md) - [SquareConnect.UpdateShiftResponse](docs/UpdateShiftResponse.md) + - [SquareConnect.UpdateTeamMemberRequest](docs/UpdateTeamMemberRequest.md) + - [SquareConnect.UpdateTeamMemberResponse](docs/UpdateTeamMemberResponse.md) + - [SquareConnect.UpdateWageSettingRequest](docs/UpdateWageSettingRequest.md) + - [SquareConnect.UpdateWageSettingResponse](docs/UpdateWageSettingResponse.md) - [SquareConnect.UpdateWorkweekConfigRequest](docs/UpdateWorkweekConfigRequest.md) - [SquareConnect.UpdateWorkweekConfigResponse](docs/UpdateWorkweekConfigResponse.md) - [SquareConnect.UpsertCatalogObjectRequest](docs/UpsertCatalogObjectRequest.md) @@ -949,6 +975,7 @@ Class | Method | HTTP request | Description - [SquareConnect.V1VariationPricingType](docs/V1VariationPricingType.md) - [SquareConnect.VoidTransactionRequest](docs/VoidTransactionRequest.md) - [SquareConnect.VoidTransactionResponse](docs/VoidTransactionResponse.md) + - [SquareConnect.WageSetting](docs/WageSetting.md) - [SquareConnect.Weekday](docs/Weekday.md) - [SquareConnect.WorkweekConfig](docs/WorkweekConfig.md) diff --git a/docs/BulkCreateTeamMembersRequest.md b/docs/BulkCreateTeamMembersRequest.md new file mode 100644 index 0000000..a1d0591 --- /dev/null +++ b/docs/BulkCreateTeamMembersRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.BulkCreateTeamMembersRequest + +### Description + +Represents a bulk create request for `TeamMember` objects. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**team_members** | [**{String: CreateTeamMemberRequest}**](CreateTeamMemberRequest.md) | The data which will be used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. | + + diff --git a/docs/BulkCreateTeamMembersResponse.md b/docs/BulkCreateTeamMembersResponse.md new file mode 100644 index 0000000..2220612 --- /dev/null +++ b/docs/BulkCreateTeamMembersResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.BulkCreateTeamMembersResponse + +### Description + +Represents a response from a bulk create request, containing the created `TeamMember` objects or error messages. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**team_members** | [**{String: CreateTeamMemberResponse}**](CreateTeamMemberResponse.md) | The successfully created `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. | [optional] +**errors** | [**[Error]**](Error.md) | The errors that occurred during the request. | [optional] + + diff --git a/docs/BulkUpdateTeamMembersRequest.md b/docs/BulkUpdateTeamMembersRequest.md new file mode 100644 index 0000000..21da462 --- /dev/null +++ b/docs/BulkUpdateTeamMembersRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.BulkUpdateTeamMembersRequest + +### Description + +Represents a bulk update request for `TeamMember` objects. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**team_members** | [**{String: UpdateTeamMemberRequest}**](UpdateTeamMemberRequest.md) | The data which will be used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. | + + diff --git a/docs/BulkUpdateTeamMembersResponse.md b/docs/BulkUpdateTeamMembersResponse.md new file mode 100644 index 0000000..0e77a8b --- /dev/null +++ b/docs/BulkUpdateTeamMembersResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.BulkUpdateTeamMembersResponse + +### Description + +Represents a response from a bulk update request, containing the updated `TeamMember` objects or error messages. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**team_members** | [**{String: UpdateTeamMemberResponse}**](UpdateTeamMemberResponse.md) | The successfully updated `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. | [optional] +**errors** | [**[Error]**](Error.md) | The errors that occurred during the request. | [optional] + + diff --git a/docs/Card.md b/docs/Card.md index 34eed9b..9f38efe 100644 --- a/docs/Card.md +++ b/docs/Card.md @@ -14,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] **card_type** | **String** | The type of the card. The Card object includes this field only in response to Payments API calls. See [CardType](#type-cardtype) for possible values | [optional] [beta] **prepaid_type** | **String** | Indicates whether the Card is prepaid or not. The Card object includes this field only in response to Payments API calls. See [CardPrepaidType](#type-cardprepaidtype) for possible values | [optional] [beta] **bin** | **String** | The first six digits of the card number, known as the Bank Identification Number (BIN). Only the Payments API returns this field. | [optional] diff --git a/docs/CardBrand.md b/docs/CardBrand.md index 773c7ab..eace3d0 100644 --- a/docs/CardBrand.md +++ b/docs/CardBrand.md @@ -23,4 +23,10 @@ * `SQUARE_CAPITAL_CARD` (value: `"SQUARE_CAPITAL_CARD"`) +* `INTERAC` (value: `"INTERAC"`) + +* `EFTPOS` (value: `"EFTPOS"`) + +* `FELICA` (value: `"FELICA"`) + diff --git a/docs/CardPaymentDetails.md b/docs/CardPaymentDetails.md index e6fa9df..f3b41b8 100644 --- a/docs/CardPaymentDetails.md +++ b/docs/CardPaymentDetails.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **verification_results** | **String** | For EMV payments, the results of the cardholder verification. Can be one of `SUCCESS`, `FAILURE`, or `UNKNOWN`. | [optional] **statement_description** | **String** | The statement description sent to the card networks. Note: The actual statement description will vary and is likely to be truncated and appended with additional information on a per issuer basis. | [optional] **device_details** | [**DeviceDetails**](DeviceDetails.md) | Details about the device that took the payment. | [optional] +**refund_requires_card_presence** | **Boolean** | Whether or not the card is required to be physically present in order for the payment to be refunded. If true, the card is required to be present. | [optional] [beta] **errors** | [**[Error]**](Error.md) | Information on errors encountered during the request. | [optional] diff --git a/docs/CatalogApi.md b/docs/CatalogApi.md index 18e16c2..fd052eb 100644 --- a/docs/CatalogApi.md +++ b/docs/CatalogApi.md @@ -360,7 +360,7 @@ Name | Type | Description | Notes SearchCatalogObjects -Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). -- -- Future end of the above comment: [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). +Queries the targeted catalog using a variety of query expressions. Supported query expressions are of the following types: - [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), - [CatalogQueryExact](#type-catalogqueryexact), - [CatalogQueryRange](#type-catalogqueryrange), - [CatalogQueryText](#type-catalogquerytext), - [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), - [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), - [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and - [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). ### Example ```javascript diff --git a/docs/CatalogCustomAttributeDefinitionNumberConfig.md b/docs/CatalogCustomAttributeDefinitionNumberConfig.md index 3e2d078..5700c0f 100644 --- a/docs/CatalogCustomAttributeDefinitionNumberConfig.md +++ b/docs/CatalogCustomAttributeDefinitionNumberConfig.md @@ -8,6 +8,6 @@ ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**precision** | **Number** | An integer between 0 and 5 that represents the maximum number of positions allowed after the decimal in number custom attribute values For example: - if the precision is 0, the quantity can be 1, 2, 3, etc. - if the precision is 1, the quantity can be 0.1, 0.2, etc. - if the precision is 2, the quantity can be 0.01, 0.12, etc. Default: 3 | [optional] +**precision** | **Number** | An integer between 0 and 5 that represents the maximum number of positions allowed after the decimal in number custom attribute values For example: - if the precision is 0, the quantity can be 1, 2, 3, etc. - if the precision is 1, the quantity can be 0.1, 0.2, etc. - if the precision is 2, the quantity can be 0.01, 0.12, etc. Default: 5 | [optional] diff --git a/docs/CatalogObject.md b/docs/CatalogObject.md index cad8409..4fbd01d 100644 --- a/docs/CatalogObject.md +++ b/docs/CatalogObject.md @@ -2,7 +2,7 @@ ### 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` object. - if type = `ITEM_VARIATION`, only `item_variation_data` will be populated and it will contain a valid `CatalogItemVariation` object. - if type = `MODIFIER`, only `modifier_data` will be populated and it will contain a valid `CatalogModifier` object. - if type = `MODIFIER_LIST`, only `modifier_list_data` will be populated and it will contain a valid `CatalogModifierList` object. - if type = `CATEGORY`, only `category_data` will be populated and it will contain a valid `CatalogCategory` object. - if type = `DISCOUNT`, only `discount_data` will be populated and it will contain a valid `CatalogDiscount` object. - if type = `TAX`, only `tax_data` will be populated and it will contain a valid `CatalogTax` object. - if type = `IMAGE`, only `image_data` will be populated and it will contain a valid `CatalogImage` object. - if type = `QUICK_AMOUNTS_SETTINGS`, only `quick_amounts_settings_data` will be populated and will contain a valid `CatalogQuickAmountsSettings` object. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/catalog-api/design-a-catalog) guide. +The wrapper object for the Catalog entries of a given object type. The type of a particular `CatalogObject` is determined by the value of the `type` attribute and only the corresponding data attribute can be set on the `CatalogObject` instance. For example, the following list shows some instances of `CatalogObject` of a given `type` and their corresponding data atrribute that can be set: - For a `CatalogObject` of the `ITEM` type, set the `item_data` attribute to yield the `CatalogItem` object. - For a `CatalogObject` of the `ITEM_VARIATION` type, set the `item_variation_data` attribute to yield the `CatalogItemVariation` object. - For a 'CatalogObject' of the `MODIFIER` type, set the `modifier_data` attribute to yield the `CatalogModifier` object. - For a 'CatalogObject' of the `MODIFIER_LIST` type, set the `modifier_list_data` attribute to yield the `CatalogModifierList` object. - For a 'CatalogObject' of the `CATEGORY` type, set the `category_data` attribute to yield the `CatalogCategory` object. - For a 'CatalogObject' of the `DISCOUNT` type, set the `discount_data` attribute to yield the `CatalogDiscount` object. - For a 'CatalogObject' of the `TAX` type, set the `tax_data` attribute to yield the `CatalogTax` object. - For a 'CatalogObject' of the `IMAGE` type, set the `image_data` attribute to yield the `CatalogImageData` object. - For a 'CatalogObject' of the `QUICK_AMOUNTS_SETTINGS` type, set the `quick_amounts_settings_data` attribute to yield the `CatalogQuickAmountsSettings` object. - For a 'CatalogObject' of the `PRICING_RULE` type, set the `pricing_rule_data` attribute to yield the `CatalogPricingRule` object. - For a 'CatalogObject' of the `TIME_PERIOD` type, set the `time_period_data` attribute to yield the `CatalogTimePeriod` object. - For a 'CatalogObject' of the `PRODUCT_SET` type, set the `product_set_data` attribute to yield the `CatalogProductSet` object. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/catalog-api/design-a-catalog) guide. ## Properties Name | Type | Description | Notes @@ -12,7 +12,7 @@ Name | Type | Description | Notes **updated_at** | **String** | Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) 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] **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] -**custom_attribute_values** | [**{String: CatalogCustomAttributeValue}**](CatalogCustomAttributeValue.md) | Application-defined key/value attributes that are set at a global (location-independent) level. Custom Attribute Values are intended to store additional information about a Catalog Object or associations with an entity in another system. Do not use custom attributes to store any sensitive information (personally identifiable information, card details, etc.). For CustomAttributesDefinitions defined by the app making the request, the map key is the key defined in the `CatalogCustomAttributeDefinition` (e.g. “reference_id”). For custom attributes created by other apps, the map key is the key defined in `CatalogCustomAttributeDefinition` prefixed with the application ID and a colon (eg. “abcd1234:reference_id”). | [optional] [beta] +**custom_attribute_values** | [**{String: CatalogCustomAttributeValue}**](CatalogCustomAttributeValue.md) | A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair is a `CatalogCustomAttributeValue` object. The key is the `key` attribute value defined in the associated `CatalogCustomAttributeDefinition` object defined by the application making the request. If the `CatalogCustomAttributeDefinition` object is defined by another application, the `CatalogCustomAttributeDefinition`'s key attribute value is prefixed by the defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of \"cocoa_brand\" and the defining application ID is \"abcd1234\", the key in the map is \"abcd1234:cocoa_brand\" if the application making the request is different from the application defining the custom attribute definition. Otherwise, the key used in the map is simply \"cocoa-brand\". Application-defined custom attributes that are set at a global (location-independent) level. Custom attribute values are intended to store additional information about a catalog object or associations with an entity in another system. Do not use custom attributes to store any sensitive information (personally identifiable information, card details, etc.). | [optional] [beta] **catalog_v1_ids** | [**[CatalogV1Id]**](CatalogV1Id.md) | The Connect v1 IDs for this object at each 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] **present_at_location_ids** | **[String]** | A list of locations where the object is present, even if `present_at_all_locations` is `false`. | [optional] @@ -27,7 +27,7 @@ Name | Type | Description | Notes **modifier_data** | [**CatalogModifier**](CatalogModifier.md) | Structured data for a `CatalogModifier`, set for CatalogObjects of type `MODIFIER`. | [optional] **time_period_data** | [**CatalogTimePeriod**](CatalogTimePeriod.md) | Structured data for a `CatalogTimePeriod`, set for CatalogObjects of type `TIME_PERIOD`. | [optional] **product_set_data** | [**CatalogProductSet**](CatalogProductSet.md) | Structured data for a `CatalogProductSet`, set for CatalogObjects of type `PRODUCT_SET`. | [optional] -**pricing_rule_data** | [**CatalogPricingRule**](CatalogPricingRule.md) | Structured data for a `CatalogPricingRule`, set for CatalogObjects of type `PRICING_RULE`. | [optional] +**pricing_rule_data** | [**CatalogPricingRule**](CatalogPricingRule.md) | Structured data for a `CatalogPricingRule`, set for CatalogObjects of type `PRICING_RULE`. A `CatalogPricingRule` object often works with a `CatalogProductSet` object or a `CatalogTimePeriod` object. | [optional] **image_data** | [**CatalogImage**](CatalogImage.md) | Structured data for a `CatalogImage`, set for CatalogObjects of type `IMAGE`. | [optional] **measurement_unit_data** | [**CatalogMeasurementUnit**](CatalogMeasurementUnit.md) | Structured data for a `CatalogMeasurementUnit`, set for CatalogObjects of type `MEASUREMENT_UNIT`. | [optional] **item_option_data** | [**CatalogItemOption**](CatalogItemOption.md) | Structured data for a `CatalogItemOption`, set for CatalogObjects of type `ITEM_OPTION`. | [optional] diff --git a/docs/CatalogPricingRule.md b/docs/CatalogPricingRule.md index f0a1f7c..f33b222 100644 --- a/docs/CatalogPricingRule.md +++ b/docs/CatalogPricingRule.md @@ -1,9 +1,8 @@ # SquareConnect.CatalogPricingRule ### Description -**Note: This model is in beta.** -Defines how prices are modified or set for items that match the pricing rule during the active time period. +Defines how discounts are automatically applied to a set of items that match the pricing rule during the active time period. ## Properties Name | Type | Description | Notes diff --git a/docs/CatalogProductSet.md b/docs/CatalogProductSet.md index 6f5d49e..be58b6c 100644 --- a/docs/CatalogProductSet.md +++ b/docs/CatalogProductSet.md @@ -1,7 +1,6 @@ # SquareConnect.CatalogProductSet ### Description -**Note: This model is in beta.** Represents a collection of catalog objects for the purpose of applying a `PricingRule`. Including a catalog object will include all of its subtypes. For example, including a category in a product set will include all of its items and associated item variations in the product set. Including an item in a product set will also include its item variations. diff --git a/docs/CatalogQueryCustomAttributeUsage.md b/docs/CatalogQueryCustomAttributeUsage.md deleted file mode 100644 index 852e3ca..0000000 --- a/docs/CatalogQueryCustomAttributeUsage.md +++ /dev/null @@ -1,13 +0,0 @@ -# SquareConnect.CatalogQueryCustomAttributeUsage - -### Description - - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**custom_attribute_definition_ids** | **[String]** | | [optional] -**has_value** | **Boolean** | | [optional] - - diff --git a/docs/CatalogQueryFilteredItems.md b/docs/CatalogQueryFilteredItems.md deleted file mode 100644 index 663a08d..0000000 --- a/docs/CatalogQueryFilteredItems.md +++ /dev/null @@ -1,21 +0,0 @@ -# SquareConnect.CatalogQueryFilteredItems - -### Description - - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**text_filter** | **String** | | [optional] -**search_vendor_code** | **Boolean** | | [optional] -**category_ids** | **[String]** | | [optional] -**stock_levels** | **[String]** | See [CatalogQueryFilteredItemsStockLevel](#type-catalogqueryfiltereditemsstocklevel) for possible values | [optional] -**enabled_location_ids** | **[String]** | | [optional] -**vendor_ids** | **[String]** | | [optional] -**product_types** | **[String]** | See [CatalogItemProductType](#type-catalogitemproducttype) for possible values | [optional] -**custom_attribute_filters** | [**[CatalogQueryFilteredItemsCustomAttributeFilter]**](CatalogQueryFilteredItemsCustomAttributeFilter.md) | | [optional] -**does_not_exist** | **[String]** | See [CatalogQueryFilteredItemsNullableAttribute](#type-catalogqueryfiltereditemsnullableattribute) for possible values | [optional] -**sort_order** | **String** | See [SortOrder](#type-sortorder) for possible values | [optional] - - diff --git a/docs/CatalogQueryFilteredItemsCustomAttributeFilter.md b/docs/CatalogQueryFilteredItemsCustomAttributeFilter.md deleted file mode 100644 index cefb788..0000000 --- a/docs/CatalogQueryFilteredItemsCustomAttributeFilter.md +++ /dev/null @@ -1,17 +0,0 @@ -# SquareConnect.CatalogQueryFilteredItemsCustomAttributeFilter - -### Description - - - -## Properties -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**filter_type** | **String** | See [CatalogQueryFilteredItemsCustomAttributeFilterFilterType](#type-catalogqueryfiltereditemscustomattributefilterfiltertype) for possible values | [optional] -**custom_attribute_definition_ids** | **[String]** | | [optional] -**custom_attribute_value_exact** | **String** | | [optional] -**custom_attribute_value_prefix** | **String** | | [optional] -**custom_attribute_min_value** | **String** | | [optional] -**custom_attribute_max_value** | **String** | | [optional] - - diff --git a/docs/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.md b/docs/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.md deleted file mode 100644 index bc140ee..0000000 --- a/docs/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.md +++ /dev/null @@ -1,14 +0,0 @@ -# SquareConnect.CatalogQueryFilteredItemsCustomAttributeFilterFilterType - -## Enum - - -* `CUSTOM_ATTRIBUTE_FILTER_TYPE_DO_NOT_USE` (value: `"CUSTOM_ATTRIBUTE_FILTER_TYPE_DO_NOT_USE"`) - -* `EXACT` (value: `"EXACT"`) - -* `PREFIX` (value: `"PREFIX"`) - -* `RANGE` (value: `"RANGE"`) - - diff --git a/docs/CatalogQueryFilteredItemsNullableAttribute.md b/docs/CatalogQueryFilteredItemsNullableAttribute.md deleted file mode 100644 index 3d15fed..0000000 --- a/docs/CatalogQueryFilteredItemsNullableAttribute.md +++ /dev/null @@ -1,8 +0,0 @@ -# SquareConnect.CatalogQueryFilteredItemsNullableAttribute - -## Enum - - -* `TOKEN` (value: `"VENDOR_TOKEN"`) - - diff --git a/docs/CatalogQueryFilteredItemsStockLevel.md b/docs/CatalogQueryFilteredItemsStockLevel.md deleted file mode 100644 index dca7457..0000000 --- a/docs/CatalogQueryFilteredItemsStockLevel.md +++ /dev/null @@ -1,10 +0,0 @@ -# SquareConnect.CatalogQueryFilteredItemsStockLevel - -## Enum - - -* `OUT` (value: `"OUT"`) - -* `LOW` (value: `"LOW"`) - - diff --git a/docs/CatalogTimePeriod.md b/docs/CatalogTimePeriod.md index 1098b3d..2c7086c 100644 --- a/docs/CatalogTimePeriod.md +++ b/docs/CatalogTimePeriod.md @@ -1,7 +1,6 @@ # SquareConnect.CatalogTimePeriod ### Description -**Note: This model is in beta.** Represents a time period - either a single period or a repeating period. diff --git a/docs/CreateTeamMemberRequest.md b/docs/CreateTeamMemberRequest.md new file mode 100644 index 0000000..41ce4da --- /dev/null +++ b/docs/CreateTeamMemberRequest.md @@ -0,0 +1,13 @@ +# SquareConnect.CreateTeamMemberRequest + +### Description + +Represents a create request for a `TeamMember` object. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**idempotency_key** | **String** | A unique string that identifies this CreateTeamMember request. Keys can be any valid string but must be unique for every request. See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. <br> <b>Min Length 1 Max Length 45</b> | [optional] +**team_member** | [**TeamMember**](TeamMember.md) | <b>Required</b> The data which will be used to create the `TeamMember` object. | [optional] + + diff --git a/docs/CreateTeamMemberResponse.md b/docs/CreateTeamMemberResponse.md new file mode 100644 index 0000000..2a0fd36 --- /dev/null +++ b/docs/CreateTeamMemberResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.CreateTeamMemberResponse + +### Description + +Represents a response from a create request, containing the created `TeamMember` object or error messages. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**team_member** | [**TeamMember**](TeamMember.md) | The successfully created `TeamMember` object. | [optional] +**errors** | [**[Error]**](Error.md) | The errors that occurred during the request. | [optional] + + diff --git a/docs/ErrorCode.md b/docs/ErrorCode.md index 893a691..b0014f3 100644 --- a/docs/ErrorCode.md +++ b/docs/ErrorCode.md @@ -89,6 +89,8 @@ * `INVALID_FORM_VALUE` (value: `"INVALID_FORM_VALUE"`) +* `CUSTOMER_NOT_FOUND` (value: `"CUSTOMER_NOT_FOUND"`) + * `ONE_INSTRUMENT_EXPECTED` (value: `"ONE_INSTRUMENT_EXPECTED"`) * `NO_FIELDS_SET` (value: `"NO_FIELDS_SET"`) diff --git a/docs/JobAssignment.md b/docs/JobAssignment.md new file mode 100644 index 0000000..3720a2a --- /dev/null +++ b/docs/JobAssignment.md @@ -0,0 +1,16 @@ +# SquareConnect.JobAssignment + +### Description + +An object describing a job that a team member is assigned to. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**job_title** | **String** | The title of the job. | +**pay_type** | **String** | The current pay type for the job assignment used to calculate the pay amount in a pay period. See [JobAssignmentPayType](#type-jobassignmentpaytype) for possible values | +**hourly_rate** | [**Money**](Money.md) | The hourly pay rate of the job. | [optional] +**annual_rate** | [**Money**](Money.md) | The total pay amount for a 12 month period on the job. Set if the job `PayType` is `SALARY`. | [optional] +**weekly_hours** | **Number** | The planned hours per week for the job. Set if the job `PayType` is `SALARY`. | [optional] + + diff --git a/docs/JobAssignmentPayType.md b/docs/JobAssignmentPayType.md new file mode 100644 index 0000000..e3b73b2 --- /dev/null +++ b/docs/JobAssignmentPayType.md @@ -0,0 +1,12 @@ +# SquareConnect.JobAssignmentPayType + +## Enum + + +* `NONE` (value: `"NONE"`) + +* `HOURLY` (value: `"HOURLY"`) + +* `SALARY` (value: `"SALARY"`) + + diff --git a/docs/ListPaymentRefundsRequest.md b/docs/ListPaymentRefundsRequest.md index e245993..cecbebe 100644 --- a/docs/ListPaymentRefundsRequest.md +++ b/docs/ListPaymentRefundsRequest.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **end_time** | **String** | Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. | [optional] **sort_order** | **String** | The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). | [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](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] -**location_id** | **String** | ID of location associated with payment. | [optional] +**location_id** | **String** | Limit results to the location supplied. By default, results are returned for all locations associated with the merchant. | [optional] **status** | **String** | If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. | [optional] **source_type** | **String** | If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. | [optional] diff --git a/docs/Refund.md b/docs/Refund.md index 862bd49..fa5962b 100644 --- a/docs/Refund.md +++ b/docs/Refund.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **location_id** | **String** | The ID of the refund's associated location. | **transaction_id** | **String** | The ID of the transaction that the refunded tender is part of. | **tender_id** | **String** | The ID of the refunded tender. | -**created_at** | **String** | The time when the refund was created, in RFC 3339 format. | [optional] +**created_at** | **String** | The timestamp for when the refund was created, in RFC 3339 format. | [optional] **reason** | **String** | The reason for the refund being issued. | **amount_money** | [**Money**](Money.md) | The amount of money refunded to the buyer. | **status** | **String** | The current status of the refund (`PENDING`, `APPROVED`, `REJECTED`, or `FAILED`). See [RefundStatus](#type-refundstatus) for possible values | diff --git a/docs/RefundPaymentRequest.md b/docs/RefundPaymentRequest.md index 8ed9bd2..0ef84ee 100644 --- a/docs/RefundPaymentRequest.md +++ b/docs/RefundPaymentRequest.md @@ -7,7 +7,7 @@ Refunds a payment. ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**idempotency_key** | **String** | A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency). | +**idempotency_key** | **String** | A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency). | **amount_money** | [**Money**](Money.md) | The amount of money to refund. Cannot be more than the `total_money` value of the payment minus the total amount of all previously completed refunds for this payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is charging the card. | **app_fee_money** | [**Money**](Money.md) | Amount of money the developer will contribute to help cover the refunded amount. Specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. Value cannot be more than the `amount_money`. You can specify this parameter in a refund request only if the same parameter was also included when taking the payment. This is part of the application fee scenario the API supports. For more information, see [Collect Fees](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees) | [optional] **payment_id** | **String** | Unique ID of the payment being refunded. | diff --git a/docs/RefundsApi.md b/docs/RefundsApi.md index 7c6b216..a4595fe 100644 --- a/docs/RefundsApi.md +++ b/docs/RefundsApi.md @@ -81,7 +81,7 @@ var opts = { 'endTime': "endTime_example", // String | Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. 'sortOrder': "sortOrder_example", // String | The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). '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](https://developer.squareup.com/docs/basics/api101/pagination) for more information. - 'locationId': "locationId_example", // String | ID of location associated with payment. + 'locationId': "locationId_example", // String | Limit results to the location supplied. By default, results are returned for all locations associated with the merchant. 'status': "status_example", // String | If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. 'sourceType': "sourceType_example" // String | If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. }; @@ -101,7 +101,7 @@ Name | Type | Description | Notes **endTime** | **String**| Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. | [optional] **sortOrder** | **String**| The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). | [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](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | [optional] - **locationId** | **String**| ID of location associated with payment. | [optional] + **locationId** | **String**| Limit results to the location supplied. By default, results are returned for all locations associated with the merchant. | [optional] **status** | **String**| If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. | [optional] **sourceType** | **String**| If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. | [optional] diff --git a/docs/RetrieveTeamMemberRequest.md b/docs/RetrieveTeamMemberRequest.md new file mode 100644 index 0000000..fbf5daa --- /dev/null +++ b/docs/RetrieveTeamMemberRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.RetrieveTeamMemberRequest + +### Description + +Represents a retrieve request for a `TeamMember` object. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/RetrieveTeamMemberResponse.md b/docs/RetrieveTeamMemberResponse.md new file mode 100644 index 0000000..e232d8b --- /dev/null +++ b/docs/RetrieveTeamMemberResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.RetrieveTeamMemberResponse + +### Description + +Represents a response from a retrieve request, containing a `TeamMember` object or error messages. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**team_member** | [**TeamMember**](TeamMember.md) | The successfully retrieved `TeamMember` object. | [optional] +**errors** | [**[Error]**](Error.md) | The errors that occurred during the request. | [optional] + + diff --git a/docs/RetrieveWageSettingRequest.md b/docs/RetrieveWageSettingRequest.md new file mode 100644 index 0000000..80e7c98 --- /dev/null +++ b/docs/RetrieveWageSettingRequest.md @@ -0,0 +1,11 @@ +# SquareConnect.RetrieveWageSettingRequest + +### Description + +Represents a retrieve request for the wage setting of a team member + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + + diff --git a/docs/RetrieveWageSettingResponse.md b/docs/RetrieveWageSettingResponse.md new file mode 100644 index 0000000..10968b7 --- /dev/null +++ b/docs/RetrieveWageSettingResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.RetrieveWageSettingResponse + +### Description + +Represents a response from a retrieve request, containing the specified `WageSetting` object or error messages. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**wage_setting** | [**WageSetting**](WageSetting.md) | The successfully retrieved `WageSetting` object. | [optional] +**errors** | [**[Error]**](Error.md) | The errors that occurred during the request. | [optional] + + diff --git a/docs/SearchTeamMembersFilter.md b/docs/SearchTeamMembersFilter.md new file mode 100644 index 0000000..c264b3f --- /dev/null +++ b/docs/SearchTeamMembersFilter.md @@ -0,0 +1,13 @@ +# SquareConnect.SearchTeamMembersFilter + +### Description + +Represents a filter used in a search for `TeamMember` objects. `AND` logic is applied between the individual fields, and `OR` logic is applied within list-based fields. For example, setting this filter value, ``` filter = (locations_ids = [\"A\", \"B\"], status = ACTIVE) ``` returns only active team members assigned to either location \"A\" or \"B\". + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**location_ids** | **[String]** | When present, filter by team members assigned to the specified locations. When empty, include team members assigned to any location. | [optional] +**status** | **String** | When present, filter by team members who match the given status. When empty, include team members of all statuses. See [TeamMemberStatus](#type-teammemberstatus) for possible values | [optional] + + diff --git a/docs/SearchTeamMembersQuery.md b/docs/SearchTeamMembersQuery.md new file mode 100644 index 0000000..86dbb6e --- /dev/null +++ b/docs/SearchTeamMembersQuery.md @@ -0,0 +1,12 @@ +# SquareConnect.SearchTeamMembersQuery + +### Description + +Represents the parameters in a search for `TeamMember` objects. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**filter** | [**SearchTeamMembersFilter**](SearchTeamMembersFilter.md) | The options to filter by. | [optional] + + diff --git a/docs/SearchTeamMembersRequest.md b/docs/SearchTeamMembersRequest.md new file mode 100644 index 0000000..97b26a8 --- /dev/null +++ b/docs/SearchTeamMembersRequest.md @@ -0,0 +1,14 @@ +# SquareConnect.SearchTeamMembersRequest + +### Description + +Represents a search request for a filtered list of `TeamMember` objects. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**query** | [**SearchTeamMembersQuery**](SearchTeamMembersQuery.md) | The query parameters. | [optional] +**limit** | **Number** | The maximum number of `TeamMember` objects in a page (25 by default). | [optional] +**cursor** | **String** | The opaque cursor for fetching the next page. Read about [pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) with Square APIs for more information. | [optional] + + diff --git a/docs/SearchTeamMembersResponse.md b/docs/SearchTeamMembersResponse.md new file mode 100644 index 0000000..863e87f --- /dev/null +++ b/docs/SearchTeamMembersResponse.md @@ -0,0 +1,14 @@ +# SquareConnect.SearchTeamMembersResponse + +### Description + +Represents a response from a search request, containing a filtered list of `TeamMember` objects. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**team_members** | [**[TeamMember]**](TeamMember.md) | The filtered list of `TeamMember` objects. | [optional] +**cursor** | **String** | The opaque cursor for fetching the next page. Read about [pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) with Square APIs for more information. | [optional] +**errors** | [**[Error]**](Error.md) | The errors that occurred during the request. | [optional] + + diff --git a/docs/TeamApi.md b/docs/TeamApi.md new file mode 100644 index 0000000..16a8d5e --- /dev/null +++ b/docs/TeamApi.md @@ -0,0 +1,406 @@ +# SquareConnect.TeamApi + +All URIs are relative to *https://connect.squareup.com* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**bulkCreateTeamMembers**](TeamApi.md#bulkCreateTeamMembers) | **POST** /v2/team-members/bulk-create | BulkCreateTeamMembers +[**bulkUpdateTeamMembers**](TeamApi.md#bulkUpdateTeamMembers) | **POST** /v2/team-members/bulk-update | BulkUpdateTeamMembers +[**createTeamMember**](TeamApi.md#createTeamMember) | **POST** /v2/team-members | CreateTeamMember +[**retrieveTeamMember**](TeamApi.md#retrieveTeamMember) | **GET** /v2/team-members/{team_member_id} | RetrieveTeamMember +[**retrieveWageSetting**](TeamApi.md#retrieveWageSetting) | **GET** /v2/team-members/{team_member_id}/wage-setting | RetrieveWageSetting +[**searchTeamMembers**](TeamApi.md#searchTeamMembers) | **POST** /v2/team-members/search | SearchTeamMembers +[**updateTeamMember**](TeamApi.md#updateTeamMember) | **PUT** /v2/team-members/{team_member_id} | UpdateTeamMember +[**updateWageSetting**](TeamApi.md#updateWageSetting) | **PUT** /v2/team-members/{team_member_id}/wage-setting | UpdateWageSetting + + + +# **bulkCreateTeamMembers** +> BulkCreateTeamMembersResponse bulkCreateTeamMembers(body) + +BulkCreateTeamMembers + +Creates multiple `TeamMember` objects. The created `TeamMember` objects will be returned on successful creates. This process is non-transactional and will process as much of the request as is possible. If one of the creates in the request cannot be successfully processed, the request will NOT be marked as failed, but the body of the response will contain explicit error information for this particular create. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#bulkcreateteammembers). + +### 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.TeamApi(); + +var body = new SquareConnect.BulkCreateTeamMembersRequest(); // BulkCreateTeamMembersRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. + +apiInstance.bulkCreateTeamMembers(body).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**BulkCreateTeamMembersRequest**](BulkCreateTeamMembersRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**BulkCreateTeamMembersResponse**](BulkCreateTeamMembersResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **bulkUpdateTeamMembers** +> BulkUpdateTeamMembersResponse bulkUpdateTeamMembers(body) + +BulkUpdateTeamMembers + +Updates multiple `TeamMember` objects. The updated `TeamMember` objects will be returned on successful updates. This process is non-transactional and will process as much of the request as is possible. If one of the updates in the request cannot be successfully processed, the request will NOT be marked as failed, but the body of the response will contain explicit error information for this particular update. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#bulkupdateteammembers). + +### 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.TeamApi(); + +var body = new SquareConnect.BulkUpdateTeamMembersRequest(); // BulkUpdateTeamMembersRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. + +apiInstance.bulkUpdateTeamMembers(body).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**BulkUpdateTeamMembersRequest**](BulkUpdateTeamMembersRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**BulkUpdateTeamMembersResponse**](BulkUpdateTeamMembersResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **createTeamMember** +> CreateTeamMemberResponse createTeamMember(body) + +CreateTeamMember + +Creates a single `TeamMember` object. The `TeamMember` will be returned on successful creates. You must provide the following values in your request to this endpoint: - `first_name` - `last_name` Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#createteammember). + +### 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.TeamApi(); + +var body = new SquareConnect.CreateTeamMemberRequest(); // CreateTeamMemberRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. + +apiInstance.createTeamMember(body).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**CreateTeamMemberRequest**](CreateTeamMemberRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**CreateTeamMemberResponse**](CreateTeamMemberResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **retrieveTeamMember** +> RetrieveTeamMemberResponse retrieveTeamMember(teamMemberId) + +RetrieveTeamMember + +Retrieve a `TeamMember` object for the given `TeamMember.id` Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#retrieveteammember). + +### 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.TeamApi(); + +var teamMemberId = "teamMemberId_example"; // String | The ID of the team member to retrieve. + +apiInstance.retrieveTeamMember(teamMemberId).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **teamMemberId** | **String**| The ID of the team member to retrieve. | + +### Return type + +[**RetrieveTeamMemberResponse**](RetrieveTeamMemberResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **retrieveWageSetting** +> RetrieveWageSettingResponse retrieveWageSetting(teamMemberId) + +RetrieveWageSetting + +Retrieve a `WageSetting` object for a team member specified by `TeamMember.id`. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#retrievewagesetting). + +### 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.TeamApi(); + +var teamMemberId = "teamMemberId_example"; // String | The ID of the team member to retrieve wage setting for + +apiInstance.retrieveWageSetting(teamMemberId).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **teamMemberId** | **String**| The ID of the team member to retrieve wage setting for | + +### Return type + +[**RetrieveWageSettingResponse**](RetrieveWageSettingResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **searchTeamMembers** +> SearchTeamMembersResponse searchTeamMembers(body) + +SearchTeamMembers + +Returns a paginated list of `TeamMember` objects for a business. The list to be returned can be filtered by: - location IDs **and** - `is_active` + +### 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.TeamApi(); + +var body = new SquareConnect.SearchTeamMembersRequest(); // SearchTeamMembersRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. + +apiInstance.searchTeamMembers(body).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | [**SearchTeamMembersRequest**](SearchTeamMembersRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**SearchTeamMembersResponse**](SearchTeamMembersResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **updateTeamMember** +> UpdateTeamMemberResponse updateTeamMember(teamMemberId, body) + +UpdateTeamMember + +Updates a single `TeamMember` object. The `TeamMember` will be returned on successful updates. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#updateteammember). + +### 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.TeamApi(); + +var teamMemberId = "teamMemberId_example"; // String | The ID of the team member to update. + +var body = new SquareConnect.UpdateTeamMemberRequest(); // UpdateTeamMemberRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. + +apiInstance.updateTeamMember(teamMemberId, body).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **teamMemberId** | **String**| The ID of the team member to update. | + **body** | [**UpdateTeamMemberRequest**](UpdateTeamMemberRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**UpdateTeamMemberResponse**](UpdateTeamMemberResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + +# **updateWageSetting** +> UpdateWageSettingResponse updateWageSetting(teamMemberId, body) + +UpdateWageSetting + +Creates or updates a `WageSetting` object. The object is created if a `WageSetting` with the specified `team_member_id` does not exist. Otherwise, it fully replaces the `WageSetting` object for the team member. The `WageSetting` will be returned upon successful update. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#updatewagesetting). + +### 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.TeamApi(); + +var teamMemberId = "teamMemberId_example"; // String | The ID of the team member to update the `WageSetting` object for. + +var body = new SquareConnect.UpdateWageSettingRequest(); // UpdateWageSettingRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. + +apiInstance.updateWageSetting(teamMemberId, body).then(function(data) { + console.log('API called successfully. Returned data: ' + data); +}, function(error) { + console.error(error); +}); + +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **teamMemberId** | **String**| The ID of the team member to update the `WageSetting` object for. | + **body** | [**UpdateWageSettingRequest**](UpdateWageSettingRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | + +### Return type + +[**UpdateWageSettingResponse**](UpdateWageSettingResponse.md) + +### Authorization + +[oauth2](../README.md#oauth2) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + diff --git a/docs/TeamMember.md b/docs/TeamMember.md new file mode 100644 index 0000000..801306a --- /dev/null +++ b/docs/TeamMember.md @@ -0,0 +1,22 @@ +# SquareConnect.TeamMember + +### Description + +A record representing an individual team member for a business. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**id** | **String** | The unique ID for the team member. | [optional] +**reference_id** | **String** | A second ID used to associate the team member with an entity in another system. | [optional] +**is_owner** | **Boolean** | Whether the team member is the owner of the Square account. | [optional] +**status** | **String** | Describes the status of the team member. See [TeamMemberStatus](#type-teammemberstatus) for possible values | [optional] +**given_name** | **String** | The given (i.e., first) name associated with the team member. | [optional] +**family_name** | **String** | The family (i.e., last) name associated with the team member. | [optional] +**email_address** | **String** | The email address associated with the team member. | [optional] +**phone_number** | **String** | The team member's phone number in E.164 format. Examples: +14155552671 - the country code is 1 for US +551155256325 - the country code is 55 for BR | [optional] +**created_at** | **String** | The timestamp in RFC 3339 format describing when the team member was created. Ex: \"2018-10-04T04:00:00-07:00\" or \"2019-02-05T12:00:00Z\" | [optional] +**updated_at** | **String** | The timestamp in RFC 3339 format describing when the team member was last updated. Ex: \"2018-10-04T04:00:00-07:00\" or \"2019-02-05T12:00:00Z\" | [optional] +**assigned_locations** | [**TeamMemberAssignedLocations**](TeamMemberAssignedLocations.md) | Describes the team member's assigned locations. | [optional] + + diff --git a/docs/TeamMemberAssignedLocations.md b/docs/TeamMemberAssignedLocations.md new file mode 100644 index 0000000..7d9f797 --- /dev/null +++ b/docs/TeamMemberAssignedLocations.md @@ -0,0 +1,13 @@ +# SquareConnect.TeamMemberAssignedLocations + +### Description + +An object that represents a team member's assignment to locations. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**assignment_type** | **String** | The current assignment type of the team member. See [TeamMemberAssignedLocationsAssignmentType](#type-teammemberassignedlocationsassignmenttype) for possible values | [optional] +**location_ids** | **[String]** | The locations that the team member is assigned to. | [optional] + + diff --git a/docs/TeamMemberAssignedLocationsAssignmentType.md b/docs/TeamMemberAssignedLocationsAssignmentType.md new file mode 100644 index 0000000..e67538e --- /dev/null +++ b/docs/TeamMemberAssignedLocationsAssignmentType.md @@ -0,0 +1,10 @@ +# SquareConnect.TeamMemberAssignedLocationsAssignmentType + +## Enum + + +* `ALL_CURRENT_AND_FUTURE_LOCATIONS` (value: `"ALL_CURRENT_AND_FUTURE_LOCATIONS"`) + +* `EXPLICIT_LOCATIONS` (value: `"EXPLICIT_LOCATIONS"`) + + diff --git a/docs/TeamMemberStatus.md b/docs/TeamMemberStatus.md new file mode 100644 index 0000000..5592211 --- /dev/null +++ b/docs/TeamMemberStatus.md @@ -0,0 +1,10 @@ +# SquareConnect.TeamMemberStatus + +## Enum + + +* `ACTIVE` (value: `"ACTIVE"`) + +* `INACTIVE` (value: `"INACTIVE"`) + + diff --git a/docs/Tender.md b/docs/Tender.md index 2ec70e0..c7add45 100644 --- a/docs/Tender.md +++ b/docs/Tender.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **id** | **String** | The tender's unique ID. | [optional] **location_id** | **String** | The ID of the transaction's associated location. | [optional] **transaction_id** | **String** | The ID of the tender's associated transaction. | [optional] -**created_at** | **String** | The time when the tender was created, in RFC 3339 format. | [optional] +**created_at** | **String** | The timestamp for when the tender was created, in RFC 3339 format. | [optional] **note** | **String** | An optional note associated with the tender at the time of payment. | [optional] **amount_money** | [**Money**](Money.md) | The total amount of the tender, including `tip_money`. If the tender has a `payment_id`, the `total_money` of the corresponding `Payment` will be equal to the `amount_money` of the tender. | [optional] **tip_money** | [**Money**](Money.md) | The tip's amount of the tender. | [optional] diff --git a/docs/Transaction.md b/docs/Transaction.md index bf06777..d78f26a 100644 --- a/docs/Transaction.md +++ b/docs/Transaction.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The transaction's unique ID, issued by Square payments servers. | [optional] **location_id** | **String** | The ID of the transaction's associated location. | [optional] -**created_at** | **String** | The time when the transaction was created, in RFC 3339 format. | [optional] +**created_at** | **String** | The timestamp for when the transaction was created, in RFC 3339 format. | [optional] **tenders** | [**[Tender]**](Tender.md) | The tenders used to pay in the transaction. | [optional] **refunds** | [**[Refund]**](Refund.md) | Refunds that have been applied to any tender in the transaction. | [optional] **reference_id** | **String** | If the transaction was created with the `Charge` endpoint, this value is the same as the value provided for the `reference_id` parameter in the request to that endpoint. Otherwise, it is not set. | [optional] diff --git a/docs/TransactionsApi.md b/docs/TransactionsApi.md index 20bc406..73b9f34 100644 --- a/docs/TransactionsApi.md +++ b/docs/TransactionsApi.md @@ -20,7 +20,7 @@ Method | HTTP request | Description CaptureTransaction -Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. +Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. ### Example ```javascript @@ -72,7 +72,7 @@ Name | Type | Description | Notes Charge -Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. +Charges a card represented by a card nonce or a customer's card on file. Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. ### Example ```javascript @@ -124,7 +124,7 @@ Name | Type | Description | Notes CreateRefund -Initiates a refund for a previously charged tender. Deprecated - recommend using [RefundPayment](#endpoint-refunds-refundpayment) --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- You must issue a refund within 120 days of the associated payment. See [this article](https://squareup.com/help/us/en/article/5060) for more information on refund behavior. NOTE: Card-present transactions with Interac credit cards **cannot be refunded using the Connect API**. Interac transactions must refunded in-person (e.g., dipping the card using POS app). +Initiates a refund for a previously charged tender. You must issue a refund within 120 days of the associated payment. See [this article](https://squareup.com/help/us/en/article/5060) for more information on refund behavior. NOTE: Card-present transactions with Interac credit cards **cannot be refunded using the Connect API**. Interac transactions must refunded in-person (e.g., dipping the card using POS app). ### Example ```javascript @@ -179,7 +179,7 @@ Name | Type | Description | Notes ListRefunds -Lists refunds for one of a business's locations. Deprecated - recommend using [SearchOrders](#endpoint-orders-searchorders) --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- In addition to full or partial tender refunds processed through Square APIs, refunds may result from itemized returns or exchanges through Square's Point of Sale applications. Refunds with a `status` of `PENDING` are not currently included in this endpoint's response. Max results per [page](#paginatingresults): 50 +Lists refunds for one of a business's locations. In addition to full or partial tender refunds processed through Square APIs, refunds may result from itemized returns or exchanges through Square's Point of Sale applications. Refunds with a `status` of `PENDING` are not currently included in this endpoint's response. Max results per [page](#paginatingresults): 50 ### Example ```javascript @@ -238,7 +238,7 @@ Name | Type | Description | Notes ListTransactions -Lists transactions for a particular location. Deprecated - recommend using [SearchOrders](#endpoint-orders-searchorders) --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- Transactions include payment information from sales and exchanges and refund information from returns and exchanges. Max results per [page](#paginatingresults): 50 +Lists transactions for a particular location. Transactions include payment information from sales and exchanges and refund information from returns and exchanges. Max results per [page](#paginatingresults): 50 ### Example ```javascript @@ -297,7 +297,7 @@ Name | Type | Description | Notes RetrieveTransaction -Retrieves details for a single transaction. Deprecated - recommend using [BatchRetrieveOrders](#endpoint-batchretrieveorders) --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- +Retrieves details for a single transaction. ### Example ```javascript @@ -349,7 +349,7 @@ Name | Type | Description | Notes VoidTransaction -Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. +Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. ### Example ```javascript diff --git a/docs/UpdateTeamMemberRequest.md b/docs/UpdateTeamMemberRequest.md new file mode 100644 index 0000000..03f4da8 --- /dev/null +++ b/docs/UpdateTeamMemberRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.UpdateTeamMemberRequest + +### Description + +Represents an update request for a `TeamMember` object. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**team_member** | [**TeamMember**](TeamMember.md) | The data which will be used to update the `TeamMember` object. | [optional] + + diff --git a/docs/UpdateTeamMemberResponse.md b/docs/UpdateTeamMemberResponse.md new file mode 100644 index 0000000..c623394 --- /dev/null +++ b/docs/UpdateTeamMemberResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.UpdateTeamMemberResponse + +### Description + +Represents a response from an update request, containing the updated `TeamMember` object or error messages. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**team_member** | [**TeamMember**](TeamMember.md) | The successfully updated `TeamMember` object. | [optional] +**errors** | [**[Error]**](Error.md) | The errors that occurred during the request. | [optional] + + diff --git a/docs/UpdateWageSettingRequest.md b/docs/UpdateWageSettingRequest.md new file mode 100644 index 0000000..610f69f --- /dev/null +++ b/docs/UpdateWageSettingRequest.md @@ -0,0 +1,12 @@ +# SquareConnect.UpdateWageSettingRequest + +### Description + +Represents an update request for the `WageSetting` object describing a `TeamMember`. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**wage_setting** | [**WageSetting**](WageSetting.md) | The new `WageSetting` object that will completely replace the existing one. | + + diff --git a/docs/UpdateWageSettingResponse.md b/docs/UpdateWageSettingResponse.md new file mode 100644 index 0000000..25de98d --- /dev/null +++ b/docs/UpdateWageSettingResponse.md @@ -0,0 +1,13 @@ +# SquareConnect.UpdateWageSettingResponse + +### Description + +Represents a response from an update request, containing the updated `WageSetting` object or error messages. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**wage_setting** | [**WageSetting**](WageSetting.md) | The successfully updated `WageSetting` object. | [optional] +**errors** | [**[Error]**](Error.md) | The errors that occurred during the request. | [optional] + + diff --git a/docs/V1EmployeesApi.md b/docs/V1EmployeesApi.md index e08610f..f1ee3e2 100644 --- a/docs/V1EmployeesApi.md +++ b/docs/V1EmployeesApi.md @@ -125,7 +125,7 @@ Name | Type | Description | Notes 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- 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. +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 @@ -174,7 +174,7 @@ Name | Type | Description | Notes 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- *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> +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. Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. ### Example ```javascript @@ -223,7 +223,7 @@ Name | Type | Description | Notes 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-cashdrawershifts) --- +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. ### Example ```javascript @@ -398,7 +398,7 @@ Name | Type | Description | Notes ListTimecardEvents -Provides summary information for all events associated with a particular timecard. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside> +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 @@ -447,7 +447,7 @@ Name | Type | Description | Notes ListTimecards -Provides summary information for all of a business's employee timecards. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- +Provides summary information for all of a business's employee timecards. ### Example ```javascript @@ -517,7 +517,7 @@ Name | Type | Description | Notes RetrieveCashDrawerShift -Provides the details for a single cash drawer shift, including all events that occurred during the shift. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-cashdrawershifts) --- +Provides the details for a single cash drawer shift, including all events that occurred during the shift. ### Example ```javascript @@ -665,7 +665,7 @@ Name | Type | Description | Notes RetrieveTimecard -Provides the details for a single timecard. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside> +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 @@ -816,7 +816,7 @@ Name | Type | Description | Notes 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- +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 diff --git a/docs/V1ItemsApi.md b/docs/V1ItemsApi.md index d6d16fb..93d3a30 100644 --- a/docs/V1ItemsApi.md +++ b/docs/V1ItemsApi.md @@ -53,7 +53,7 @@ Method | HTTP request | Description AdjustInventory -Adjusts the current available inventory of an item variation. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Adjusts the current available inventory of an item variation. ### Example ```javascript @@ -108,7 +108,7 @@ Name | Type | Description | Notes ApplyFee -Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. ### Example ```javascript @@ -163,7 +163,7 @@ Name | Type | Description | Notes ApplyModifierList -Associates a modifier list with an item so the associated modifier options can be applied to the item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Associates a modifier list with an item so the associated modifier options can be applied to the item. ### Example ```javascript @@ -218,7 +218,7 @@ Name | Type | Description | Notes CreateCategory -Creates an item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Creates an item category. ### Example ```javascript @@ -270,7 +270,7 @@ Name | Type | Description | Notes CreateDiscount -Creates a discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Creates a discount. ### Example ```javascript @@ -322,7 +322,7 @@ Name | Type | Description | Notes CreateFee -Creates a fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Creates a fee (tax). ### Example ```javascript @@ -374,7 +374,7 @@ Name | Type | Description | Notes CreateItem -Creates an item and at least one variation for it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- 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 `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. +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 `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 @@ -426,7 +426,7 @@ Name | Type | Description | Notes CreateModifierList -Creates an item modifier list and at least 1 modifier option for it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Creates an item modifier list and at least 1 modifier option for it. ### Example ```javascript @@ -478,7 +478,7 @@ Name | Type | Description | Notes CreateModifierOption -Creates an item modifier option and adds it to a modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Creates an item modifier option and adds it to a modifier list. ### Example ```javascript @@ -533,7 +533,7 @@ Name | Type | Description | Notes CreatePage -Creates a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Creates a Favorites page in Square Point of Sale. ### Example ```javascript @@ -585,7 +585,7 @@ Name | Type | Description | Notes CreateVariation -Creates an item variation for an existing item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Creates an item variation for an existing item. ### Example ```javascript @@ -640,7 +640,7 @@ Name | Type | Description | Notes DeleteCategory -Deletes an existing item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. +Deletes an existing item category. __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. ### Example ```javascript @@ -692,7 +692,7 @@ Name | Type | Description | Notes DeleteDiscount -Deletes an existing discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. +Deletes an existing discount. __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. ### Example ```javascript @@ -744,7 +744,7 @@ Name | Type | Description | Notes DeleteFee -Deletes an existing fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. +Deletes an existing fee (tax). __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. ### Example ```javascript @@ -796,7 +796,7 @@ Name | Type | Description | Notes DeleteItem -Deletes an existing item and all item variations associated with it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. +Deletes an existing item and all item variations associated with it. __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. ### Example ```javascript @@ -848,7 +848,7 @@ Name | Type | Description | Notes DeleteModifierList -Deletes an existing item modifier list and all modifier options associated with it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. +Deletes an existing item modifier list and all modifier options associated with it. __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. ### Example ```javascript @@ -900,7 +900,7 @@ Name | Type | Description | Notes DeleteModifierOption -Deletes an existing item modifier option from a modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. +Deletes an existing item modifier option from a modifier list. __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. ### Example ```javascript @@ -955,7 +955,7 @@ Name | Type | Description | Notes DeletePage -Deletes an existing Favorites page and all of its cells. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. +Deletes an existing Favorites page and all of its cells. __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. ### Example ```javascript @@ -1007,7 +1007,7 @@ Name | Type | Description | Notes DeletePageCell -Deletes a cell from a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeletePageCell__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. +Deletes a cell from a Favorites page in Square Point of Sale. __DeletePageCell__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. ### Example ```javascript @@ -1065,7 +1065,7 @@ Name | Type | Description | Notes DeleteVariation -Deletes an existing item variation from an item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. +Deletes an existing item variation from an item. __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. ### Example ```javascript @@ -1120,7 +1120,7 @@ Name | Type | Description | Notes ListCategories -Lists all the item categories for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Lists all the item categories for a given location. ### Example ```javascript @@ -1169,7 +1169,7 @@ Name | Type | Description | Notes ListDiscounts -Lists all the discounts for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Lists all the discounts for a given location. ### Example ```javascript @@ -1218,7 +1218,7 @@ Name | Type | Description | Notes ListFees -Lists all the fees (taxes) for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Lists all the fees (taxes) for a given location. ### Example ```javascript @@ -1267,7 +1267,7 @@ Name | Type | Description | Notes ListInventory -Provides inventory information for all inventory-enabled item variations. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Provides inventory information for all inventory-enabled item variations. ### Example ```javascript @@ -1322,7 +1322,7 @@ Name | Type | Description | Notes ListItems -Provides summary information of all items for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Provides summary information of all items for a given location. ### Example ```javascript @@ -1375,7 +1375,7 @@ Name | Type | Description | Notes ListModifierLists -Lists all the modifier lists for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Lists all the modifier lists for a given location. ### Example ```javascript @@ -1424,7 +1424,7 @@ Name | Type | Description | Notes ListPages -Lists all Favorites pages (in Square Point of Sale) for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Lists all Favorites pages (in Square Point of Sale) for a given location. ### Example ```javascript @@ -1473,7 +1473,7 @@ Name | Type | Description | Notes RemoveFee -Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. ### Example ```javascript @@ -1528,7 +1528,7 @@ Name | Type | Description | Notes RemoveModifierList -Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item. ### Example ```javascript @@ -1583,7 +1583,7 @@ Name | Type | Description | Notes RetrieveItem -Provides the details for a single item, including associated modifier lists and fees. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Provides the details for a single item, including associated modifier lists and fees. ### Example ```javascript @@ -1635,7 +1635,7 @@ Name | Type | Description | Notes RetrieveModifierList -Provides the details for a single modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Provides the details for a single modifier list. ### Example ```javascript @@ -1687,7 +1687,7 @@ Name | Type | Description | Notes UpdateCategory -Modifies the details of an existing item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Modifies the details of an existing item category. ### Example ```javascript @@ -1742,7 +1742,7 @@ Name | Type | Description | Notes UpdateDiscount -Modifies the details of an existing discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Modifies the details of an existing discount. ### Example ```javascript @@ -1797,7 +1797,7 @@ Name | Type | Description | Notes UpdateFee -Modifies the details of an existing fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Modifies the details of an existing fee (tax). ### Example ```javascript @@ -1852,7 +1852,7 @@ Name | Type | Description | Notes UpdateItem -Modifies the core details of an existing item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Modifies the core details of an existing item. ### Example ```javascript @@ -1907,7 +1907,7 @@ Name | Type | Description | Notes UpdateModifierList -Modifies the details of an existing item modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Modifies the details of an existing item modifier list. ### Example ```javascript @@ -1962,7 +1962,7 @@ Name | Type | Description | Notes UpdateModifierOption -Modifies the details of an existing item modifier option. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Modifies the details of an existing item modifier option. ### Example ```javascript @@ -2020,7 +2020,7 @@ Name | Type | Description | Notes UpdatePage -Modifies the details of a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Modifies the details of a Favorites page in Square Point of Sale. ### Example ```javascript @@ -2075,7 +2075,7 @@ Name | Type | Description | Notes UpdatePageCell -Modifies a cell of a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Modifies a cell of a Favorites page in Square Point of Sale. ### Example ```javascript @@ -2130,7 +2130,7 @@ Name | Type | Description | Notes UpdateVariation -Modifies the details of an existing item variation. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- +Modifies the details of an existing item variation. ### Example ```javascript diff --git a/docs/V1LocationsApi.md b/docs/V1LocationsApi.md index 0bea7c3..6a14eb3 100644 --- a/docs/V1LocationsApi.md +++ b/docs/V1LocationsApi.md @@ -15,7 +15,7 @@ Method | HTTP request | Description ListLocations -Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) --- +Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. ### Example ```javascript @@ -58,7 +58,7 @@ This endpoint does not need any parameter. RetrieveBusiness -Get the general information for a business. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) --- +Get the general information for a business. ### Example ```javascript diff --git a/docs/V1TransactionsApi.md b/docs/V1TransactionsApi.md index 7440592..a24e26b 100644 --- a/docs/V1TransactionsApi.md +++ b/docs/V1TransactionsApi.md @@ -75,7 +75,7 @@ Name | Type | Description | Notes 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-bankaccounts) --- +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. ### Example ```javascript @@ -364,7 +364,7 @@ Name | Type | Description | Notes 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-bankaccounts) --- +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. ### Example ```javascript diff --git a/docs/WageSetting.md b/docs/WageSetting.md new file mode 100644 index 0000000..2a20388 --- /dev/null +++ b/docs/WageSetting.md @@ -0,0 +1,17 @@ +# SquareConnect.WageSetting + +### Description + +An object representing a team member's wage information. + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**team_member_id** | **String** | The unique ID of the `TeamMember` whom this wage setting describes. | [optional] +**job_assignments** | [**[JobAssignment]**](JobAssignment.md) | <b>Required</b> The ordered list of jobs that the team member is assigned to. The first job assignment is considered the team member's \"Primary Job\". <br> <b>Min Length 1 Max Length 12</b> | [optional] +**is_overtime_exempt** | **Boolean** | Whether the team member is exempt from the overtime rules of the seller country. | [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. Read about [optimistic concurrency](https://developer.squareup.com/docs/docs/working-with-apis/optimistic-concurrency) in Square APIs for more information. | [optional] +**created_at** | **String** | The timestamp in RFC 3339 format describing when the wage setting object was created. Ex: \"2018-10-04T04:00:00-07:00\" or \"2019-02-05T12:00:00Z\" | [optional] +**updated_at** | **String** | The timestamp in RFC 3339 format describing when the wage setting object was last updated. Ex: \"2018-10-04T04:00:00-07:00\" or \"2019-02-05T12:00:00Z\" | [optional] + + diff --git a/package.json b/package.json index 521bdd1..32cb904 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "square-connect", - "version": "3.20200528.0", + "version": "4.20200625.0", "description": "JavaScript client library for the Square Connect v2 API", "keywords": [ "square", diff --git a/src/ApiClient.js b/src/ApiClient.js index 861da5e..fdded20 100644 --- a/src/ApiClient.js +++ b/src/ApiClient.js @@ -17,7 +17,7 @@ var HeaderUtils = require('./lib/HeaderUtils'); /** * @module ApiClient - * @version 3.20200528.0 + * @version 4.20200625.0 */ /** @@ -49,7 +49,7 @@ var exports = function() { * @default {} */ this.defaultHeaders = { - 'User-Agent': 'Square-Connect-Javascript/3.20200528.0' + 'User-Agent': 'Square-Connect-Javascript/4.20200625.0' }; /** * The default HTTP timeout for all API calls. diff --git a/src/api/ApplePayApi.js b/src/api/ApplePayApi.js index 4ddd301..e13e60a 100644 --- a/src/api/ApplePayApi.js +++ b/src/api/ApplePayApi.js @@ -53,7 +53,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/BankAccountsApi.js b/src/api/BankAccountsApi.js index 7184f87..898798e 100644 --- a/src/api/BankAccountsApi.js +++ b/src/api/BankAccountsApi.js @@ -55,7 +55,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -108,7 +108,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -162,7 +162,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/CashDrawersApi.js b/src/api/CashDrawersApi.js index 572df46..d246cb1 100644 --- a/src/api/CashDrawersApi.js +++ b/src/api/CashDrawersApi.js @@ -68,7 +68,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -137,7 +137,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -203,7 +203,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/CatalogApi.js b/src/api/CatalogApi.js index 86465ed..33ae140 100644 --- a/src/api/CatalogApi.js +++ b/src/api/CatalogApi.js @@ -69,7 +69,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -121,7 +121,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -173,7 +173,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -219,7 +219,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -271,7 +271,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -323,7 +323,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -382,7 +382,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -417,7 +417,7 @@ module.exports = function(apiClient) { /** * SearchCatalogObjects - * Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). -- -- Future end of the above comment: [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). + * Queries the targeted catalog using a variety of query expressions. Supported query expressions are of the following types: - [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), - [CatalogQueryExact](#type-catalogqueryexact), - [CatalogQueryRange](#type-catalogqueryrange), - [CatalogQueryText](#type-catalogquerytext), - [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), - [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), - [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and - [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). * @param {module:model/SearchCatalogObjectsRequest} 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/SearchCatalogObjectsResponse} and HTTP response */ @@ -436,7 +436,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -455,7 +455,7 @@ module.exports = function(apiClient) { /** * SearchCatalogObjects - * Queries the targeted catalog using a variety of query types: [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), [CatalogQueryExact](#type-catalogqueryexact), [CatalogQueryRange](#type-catalogqueryrange), [CatalogQueryText](#type-catalogquerytext), [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), and [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist). -- -- Future end of the above comment: [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). + * Queries the targeted catalog using a variety of query expressions. Supported query expressions are of the following types: - [CatalogQuerySortedAttribute](#type-catalogquerysortedattribute), - [CatalogQueryExact](#type-catalogqueryexact), - [CatalogQueryRange](#type-catalogqueryrange), - [CatalogQueryText](#type-catalogquerytext), - [CatalogQueryItemsForTax](#type-catalogqueryitemsfortax), - [CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist), - [CatalogQueryItemsForItemOptions](#type-catalogqueryitemsforitemoptions), and - [CatalogQueryItemVariationsForItemOptionValues](#type-catalogqueryitemvariationsforitemoptionvalues). * @param {module:model/SearchCatalogObjectsRequest} 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/SearchCatalogObjectsResponse} */ @@ -488,7 +488,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -540,7 +540,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -592,7 +592,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/CheckoutApi.js b/src/api/CheckoutApi.js index 1e9a150..74603bf 100644 --- a/src/api/CheckoutApi.js +++ b/src/api/CheckoutApi.js @@ -60,7 +60,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/CustomerGroupsApi.js b/src/api/CustomerGroupsApi.js index 49ec1e0..8470122 100644 --- a/src/api/CustomerGroupsApi.js +++ b/src/api/CustomerGroupsApi.js @@ -59,7 +59,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -113,7 +113,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -164,7 +164,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -219,7 +219,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -279,7 +279,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/CustomerSegmentsApi.js b/src/api/CustomerSegmentsApi.js index 3f7b684..6d74e6a 100644 --- a/src/api/CustomerSegmentsApi.js +++ b/src/api/CustomerSegmentsApi.js @@ -52,7 +52,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -107,7 +107,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/CustomersApi.js b/src/api/CustomersApi.js index bd8c6f1..4be073c 100644 --- a/src/api/CustomersApi.js +++ b/src/api/CustomersApi.js @@ -74,7 +74,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -127,7 +127,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -186,7 +186,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -240,7 +240,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -300,7 +300,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -355,7 +355,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -419,7 +419,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -473,7 +473,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -525,7 +525,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -584,7 +584,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/DevicesApi.js b/src/api/DevicesApi.js index 863b18b..4716a61 100644 --- a/src/api/DevicesApi.js +++ b/src/api/DevicesApi.js @@ -56,7 +56,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -110,7 +110,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -165,7 +165,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/DisputesApi.js b/src/api/DisputesApi.js index 56c8c4b..dc41485 100644 --- a/src/api/DisputesApi.js +++ b/src/api/DisputesApi.js @@ -62,7 +62,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -122,7 +122,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -177,7 +177,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -232,7 +232,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -296,7 +296,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -351,7 +351,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -412,7 +412,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -467,7 +467,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/EmployeesApi.js b/src/api/EmployeesApi.js index a91893c..84e0b0d 100644 --- a/src/api/EmployeesApi.js +++ b/src/api/EmployeesApi.js @@ -57,7 +57,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -114,7 +114,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/InventoryApi.js b/src/api/InventoryApi.js index 9c47c1a..44e76e0 100644 --- a/src/api/InventoryApi.js +++ b/src/api/InventoryApi.js @@ -61,7 +61,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -113,7 +113,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -165,7 +165,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -218,7 +218,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -277,7 +277,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -339,7 +339,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -395,7 +395,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/LaborApi.js b/src/api/LaborApi.js index 59e4663..585a42e 100644 --- a/src/api/LaborApi.js +++ b/src/api/LaborApi.js @@ -71,7 +71,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -123,7 +123,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -176,7 +176,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -229,7 +229,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -282,7 +282,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -335,7 +335,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -388,7 +388,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -442,7 +442,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -499,7 +499,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -554,7 +554,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -608,7 +608,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -667,7 +667,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -727,7 +727,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -787,7 +787,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/LocationsApi.js b/src/api/LocationsApi.js index 0dc1875..5c0eceb 100644 --- a/src/api/LocationsApi.js +++ b/src/api/LocationsApi.js @@ -58,7 +58,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -104,7 +104,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -156,7 +156,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -216,7 +216,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/LoyaltyApi.js b/src/api/LoyaltyApi.js index de96138..fbd0dd4 100644 --- a/src/api/LoyaltyApi.js +++ b/src/api/LoyaltyApi.js @@ -81,7 +81,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -142,7 +142,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -203,7 +203,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -257,7 +257,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -310,7 +310,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -364,7 +364,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -411,7 +411,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -470,7 +470,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -525,7 +525,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -579,7 +579,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -632,7 +632,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -685,7 +685,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -738,7 +738,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/MerchantsApi.js b/src/api/MerchantsApi.js index d05ec7c..5b4a69a 100644 --- a/src/api/MerchantsApi.js +++ b/src/api/MerchantsApi.js @@ -51,7 +51,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -105,7 +105,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/MobileAuthorizationApi.js b/src/api/MobileAuthorizationApi.js index 8b0b679..30ed390 100644 --- a/src/api/MobileAuthorizationApi.js +++ b/src/api/MobileAuthorizationApi.js @@ -53,7 +53,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/OAuthApi.js b/src/api/OAuthApi.js index f4cb780..6d959b5 100644 --- a/src/api/OAuthApi.js +++ b/src/api/OAuthApi.js @@ -57,7 +57,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -118,7 +118,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -171,7 +171,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/OrdersApi.js b/src/api/OrdersApi.js index e5f781c..4ce0fdc 100644 --- a/src/api/OrdersApi.js +++ b/src/api/OrdersApi.js @@ -70,7 +70,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -124,7 +124,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -183,7 +183,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -244,7 +244,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -297,7 +297,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -364,7 +364,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/PaymentsApi.js b/src/api/PaymentsApi.js index dcbf399..a2d6d35 100644 --- a/src/api/PaymentsApi.js +++ b/src/api/PaymentsApi.js @@ -61,7 +61,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -113,7 +113,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -172,7 +172,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -225,7 +225,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -278,7 +278,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -342,7 +342,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/RefundsApi.js b/src/api/RefundsApi.js index 8a9ad7b..82d8c17 100644 --- a/src/api/RefundsApi.js +++ b/src/api/RefundsApi.js @@ -56,7 +56,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -95,7 +95,7 @@ module.exports = function(apiClient) { * @param {String} opts.endTime Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. * @param {String} opts.sortOrder The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). * @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](https://developer.squareup.com/docs/basics/api101/pagination) for more information. - * @param {String} opts.locationId ID of location associated with payment. + * @param {String} opts.locationId Limit results to the location supplied. By default, results are returned for all locations associated with the merchant. * @param {String} opts.status If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. * @param {String} opts.sourceType If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/ListPaymentRefundsResponse} and HTTP response @@ -118,7 +118,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -143,7 +143,7 @@ module.exports = function(apiClient) { * @param {String} opts.endTime Timestamp for the end of the requested reporting period, in RFC 3339 format. Default: The current time. * @param {String} opts.sortOrder The order in which results are listed. - `ASC` - oldest to newest - `DESC` - newest to oldest (default). * @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](https://developer.squareup.com/docs/basics/api101/pagination) for more information. - * @param {String} opts.locationId ID of location associated with payment. + * @param {String} opts.locationId Limit results to the location supplied. By default, results are returned for all locations associated with the merchant. * @param {String} opts.status If provided, only refunds with the given status are returned. For a list of refund status values, see `PaymentRefund`. Default: If omitted refunds are returned regardless of status. * @param {String} opts.sourceType If provided, only refunds with the given source type are returned. - `CARD` - List refunds only for payments where card was specified as payment source. Default: If omitted refunds are returned regardless of source type. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/ListPaymentRefundsResponse} @@ -177,7 +177,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/ReportingApi.js b/src/api/ReportingApi.js index d9fd59d..6e3b1bc 100644 --- a/src/api/ReportingApi.js +++ b/src/api/ReportingApi.js @@ -66,7 +66,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -136,7 +136,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/TeamApi.js b/src/api/TeamApi.js new file mode 100644 index 0000000..64bf808 --- /dev/null +++ b/src/api/TeamApi.js @@ -0,0 +1,479 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class 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 BulkCreateTeamMembersRequest = require('../model/BulkCreateTeamMembersRequest'); +var BulkCreateTeamMembersResponse = require('../model/BulkCreateTeamMembersResponse'); +var BulkUpdateTeamMembersRequest = require('../model/BulkUpdateTeamMembersRequest'); +var BulkUpdateTeamMembersResponse = require('../model/BulkUpdateTeamMembersResponse'); +var CreateTeamMemberRequest = require('../model/CreateTeamMemberRequest'); +var CreateTeamMemberResponse = require('../model/CreateTeamMemberResponse'); +var RetrieveTeamMemberResponse = require('../model/RetrieveTeamMemberResponse'); +var RetrieveWageSettingResponse = require('../model/RetrieveWageSettingResponse'); +var SearchTeamMembersRequest = require('../model/SearchTeamMembersRequest'); +var SearchTeamMembersResponse = require('../model/SearchTeamMembersResponse'); +var UpdateTeamMemberRequest = require('../model/UpdateTeamMemberRequest'); +var UpdateTeamMemberResponse = require('../model/UpdateTeamMemberResponse'); +var UpdateWageSettingRequest = require('../model/UpdateWageSettingRequest'); +var UpdateWageSettingResponse = require('../model/UpdateWageSettingResponse'); + +/** + * Team service. + * @module api/TeamApi + */ + +/** + * Constructs a new TeamApi. + * @alias module:api/TeamApi + * @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; + + + + /** + * BulkCreateTeamMembers + * Creates multiple `TeamMember` objects. The created `TeamMember` objects will be returned on successful creates. This process is non-transactional and will process as much of the request as is possible. If one of the creates in the request cannot be successfully processed, the request will NOT be marked as failed, but the body of the response will contain explicit error information for this particular create. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#bulkcreateteammembers). + * @param {module:model/BulkCreateTeamMembersRequest} 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/BulkCreateTeamMembersResponse} and HTTP response + */ + this.bulkCreateTeamMembersWithHttpInfo = 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 bulkCreateTeamMembers"); + } + + + var pathParams = { + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-06-25'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = BulkCreateTeamMembersResponse; + + return this.apiClient.callApi( + '/v2/team-members/bulk-create', 'POST', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * BulkCreateTeamMembers + * Creates multiple `TeamMember` objects. The created `TeamMember` objects will be returned on successful creates. This process is non-transactional and will process as much of the request as is possible. If one of the creates in the request cannot be successfully processed, the request will NOT be marked as failed, but the body of the response will contain explicit error information for this particular create. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#bulkcreateteammembers). + * @param {module:model/BulkCreateTeamMembersRequest} 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/BulkCreateTeamMembersResponse} + */ + this.bulkCreateTeamMembers = function(body) { + return this.bulkCreateTeamMembersWithHttpInfo(body) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * BulkUpdateTeamMembers + * Updates multiple `TeamMember` objects. The updated `TeamMember` objects will be returned on successful updates. This process is non-transactional and will process as much of the request as is possible. If one of the updates in the request cannot be successfully processed, the request will NOT be marked as failed, but the body of the response will contain explicit error information for this particular update. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#bulkupdateteammembers). + * @param {module:model/BulkUpdateTeamMembersRequest} 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/BulkUpdateTeamMembersResponse} and HTTP response + */ + this.bulkUpdateTeamMembersWithHttpInfo = 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 bulkUpdateTeamMembers"); + } + + + var pathParams = { + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-06-25'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = BulkUpdateTeamMembersResponse; + + return this.apiClient.callApi( + '/v2/team-members/bulk-update', 'POST', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * BulkUpdateTeamMembers + * Updates multiple `TeamMember` objects. The updated `TeamMember` objects will be returned on successful updates. This process is non-transactional and will process as much of the request as is possible. If one of the updates in the request cannot be successfully processed, the request will NOT be marked as failed, but the body of the response will contain explicit error information for this particular update. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#bulkupdateteammembers). + * @param {module:model/BulkUpdateTeamMembersRequest} 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/BulkUpdateTeamMembersResponse} + */ + this.bulkUpdateTeamMembers = function(body) { + return this.bulkUpdateTeamMembersWithHttpInfo(body) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * CreateTeamMember + * Creates a single `TeamMember` object. The `TeamMember` will be returned on successful creates. You must provide the following values in your request to this endpoint: - `first_name` - `last_name` Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#createteammember). + * @param {module:model/CreateTeamMemberRequest} 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/CreateTeamMemberResponse} and HTTP response + */ + this.createTeamMemberWithHttpInfo = 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 createTeamMember"); + } + + + var pathParams = { + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-06-25'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = CreateTeamMemberResponse; + + return this.apiClient.callApi( + '/v2/team-members', 'POST', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * CreateTeamMember + * Creates a single `TeamMember` object. The `TeamMember` will be returned on successful creates. You must provide the following values in your request to this endpoint: - `first_name` - `last_name` Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#createteammember). + * @param {module:model/CreateTeamMemberRequest} 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/CreateTeamMemberResponse} + */ + this.createTeamMember = function(body) { + return this.createTeamMemberWithHttpInfo(body) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * RetrieveTeamMember + * Retrieve a `TeamMember` object for the given `TeamMember.id` Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#retrieveteammember). + * @param {String} teamMemberId The ID of the team member to retrieve. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveTeamMemberResponse} and HTTP response + */ + this.retrieveTeamMemberWithHttpInfo = function(teamMemberId) { + var postBody = null; + + // verify the required parameter 'teamMemberId' is set + if (teamMemberId === undefined || teamMemberId === null) { + throw new Error("Missing the required parameter 'teamMemberId' when calling retrieveTeamMember"); + } + + + var pathParams = { + 'team_member_id': teamMemberId + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-06-25'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = RetrieveTeamMemberResponse; + + return this.apiClient.callApi( + '/v2/team-members/{team_member_id}', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * RetrieveTeamMember + * Retrieve a `TeamMember` object for the given `TeamMember.id` Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#retrieveteammember). + * @param {String} teamMemberId The ID of the team member to retrieve. + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveTeamMemberResponse} + */ + this.retrieveTeamMember = function(teamMemberId) { + return this.retrieveTeamMemberWithHttpInfo(teamMemberId) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * RetrieveWageSetting + * Retrieve a `WageSetting` object for a team member specified by `TeamMember.id`. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#retrievewagesetting). + * @param {String} teamMemberId The ID of the team member to retrieve wage setting for + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveWageSettingResponse} and HTTP response + */ + this.retrieveWageSettingWithHttpInfo = function(teamMemberId) { + var postBody = null; + + // verify the required parameter 'teamMemberId' is set + if (teamMemberId === undefined || teamMemberId === null) { + throw new Error("Missing the required parameter 'teamMemberId' when calling retrieveWageSetting"); + } + + + var pathParams = { + 'team_member_id': teamMemberId + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-06-25'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = RetrieveWageSettingResponse; + + return this.apiClient.callApi( + '/v2/team-members/{team_member_id}/wage-setting', 'GET', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * RetrieveWageSetting + * Retrieve a `WageSetting` object for a team member specified by `TeamMember.id`. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#retrievewagesetting). + * @param {String} teamMemberId The ID of the team member to retrieve wage setting for + * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveWageSettingResponse} + */ + this.retrieveWageSetting = function(teamMemberId) { + return this.retrieveWageSettingWithHttpInfo(teamMemberId) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * SearchTeamMembers + * Returns a paginated list of `TeamMember` objects for a business. The list to be returned can be filtered by: - location IDs **and** - `is_active` + * @param {module:model/SearchTeamMembersRequest} 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/SearchTeamMembersResponse} and HTTP response + */ + this.searchTeamMembersWithHttpInfo = 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 searchTeamMembers"); + } + + + var pathParams = { + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-06-25'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = SearchTeamMembersResponse; + + return this.apiClient.callApi( + '/v2/team-members/search', 'POST', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * SearchTeamMembers + * Returns a paginated list of `TeamMember` objects for a business. The list to be returned can be filtered by: - location IDs **and** - `is_active` + * @param {module:model/SearchTeamMembersRequest} 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/SearchTeamMembersResponse} + */ + this.searchTeamMembers = function(body) { + return this.searchTeamMembersWithHttpInfo(body) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * UpdateTeamMember + * Updates a single `TeamMember` object. The `TeamMember` will be returned on successful updates. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#updateteammember). + * @param {String} teamMemberId The ID of the team member to update. + * @param {module:model/UpdateTeamMemberRequest} 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/UpdateTeamMemberResponse} and HTTP response + */ + this.updateTeamMemberWithHttpInfo = function(teamMemberId, body) { + var postBody = body; + + // verify the required parameter 'teamMemberId' is set + if (teamMemberId === undefined || teamMemberId === null) { + throw new Error("Missing the required parameter 'teamMemberId' when calling updateTeamMember"); + } + + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw new Error("Missing the required parameter 'body' when calling updateTeamMember"); + } + + + var pathParams = { + 'team_member_id': teamMemberId + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-06-25'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = UpdateTeamMemberResponse; + + return this.apiClient.callApi( + '/v2/team-members/{team_member_id}', 'PUT', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * UpdateTeamMember + * Updates a single `TeamMember` object. The `TeamMember` will be returned on successful updates. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#updateteammember). + * @param {String} teamMemberId The ID of the team member to update. + * @param {module:model/UpdateTeamMemberRequest} 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/UpdateTeamMemberResponse} + */ + this.updateTeamMember = function(teamMemberId, body) { + return this.updateTeamMemberWithHttpInfo(teamMemberId, body) + .then(function(response_and_data) { + return response_and_data.data; + }); + } + + + /** + * UpdateWageSetting + * Creates or updates a `WageSetting` object. The object is created if a `WageSetting` with the specified `team_member_id` does not exist. Otherwise, it fully replaces the `WageSetting` object for the team member. The `WageSetting` will be returned upon successful update. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#updatewagesetting). + * @param {String} teamMemberId The ID of the team member to update the `WageSetting` object for. + * @param {module:model/UpdateWageSettingRequest} 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/UpdateWageSettingResponse} and HTTP response + */ + this.updateWageSettingWithHttpInfo = function(teamMemberId, body) { + var postBody = body; + + // verify the required parameter 'teamMemberId' is set + if (teamMemberId === undefined || teamMemberId === null) { + throw new Error("Missing the required parameter 'teamMemberId' when calling updateWageSetting"); + } + + // verify the required parameter 'body' is set + if (body === undefined || body === null) { + throw new Error("Missing the required parameter 'body' when calling updateWageSetting"); + } + + + var pathParams = { + 'team_member_id': teamMemberId + }; + var queryParams = { + }; + var headerParams = { + }; + headerParams['Square-Version'] = '2020-06-25'; + + var formParams = { + }; + + var authNames = ['oauth2']; + var contentTypes = ['application/json']; + var accepts = ['application/json']; + var returnType = UpdateWageSettingResponse; + + return this.apiClient.callApi( + '/v2/team-members/{team_member_id}/wage-setting', 'PUT', + pathParams, queryParams, headerParams, formParams, postBody, + authNames, contentTypes, accepts, returnType + ); + } + + /** + * UpdateWageSetting + * Creates or updates a `WageSetting` object. The object is created if a `WageSetting` with the specified `team_member_id` does not exist. Otherwise, it fully replaces the `WageSetting` object for the team member. The `WageSetting` will be returned upon successful update. Learn about [Troubleshooting the Teams API](/docs/team/troubleshooting#updatewagesetting). + * @param {String} teamMemberId The ID of the team member to update the `WageSetting` object for. + * @param {module:model/UpdateWageSettingRequest} 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/UpdateWageSettingResponse} + */ + this.updateWageSetting = function(teamMemberId, body) { + return this.updateWageSettingWithHttpInfo(teamMemberId, body) + .then(function(response_and_data) { + return response_and_data.data; + }); + } +}; diff --git a/src/api/TerminalApi.js b/src/api/TerminalApi.js index c841ace..d422951 100644 --- a/src/api/TerminalApi.js +++ b/src/api/TerminalApi.js @@ -59,7 +59,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -112,7 +112,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -166,7 +166,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -219,7 +219,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/api/TransactionsApi.js b/src/api/TransactionsApi.js index 3a729f5..409fa50 100644 --- a/src/api/TransactionsApi.js +++ b/src/api/TransactionsApi.js @@ -42,7 +42,7 @@ module.exports = function(apiClient) { /** * @deprecated * CaptureTransaction - * Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. + * Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. * @param {String} locationId * @param {String} transactionId * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CaptureTransactionResponse} and HTTP response @@ -70,7 +70,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -89,7 +89,7 @@ module.exports = function(apiClient) { /** * CaptureTransaction - * Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. + * Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. * @param {String} locationId * @param {String} transactionId * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CaptureTransactionResponse} @@ -105,7 +105,7 @@ module.exports = function(apiClient) { /** * @deprecated * Charge - * Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. + * Charges a card represented by a card nonce or a customer's card on file. Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. * @param {String} locationId The ID of the location to associate the created transaction with. * @param {module:model/ChargeRequest} 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/ChargeResponse} and HTTP response @@ -132,7 +132,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -151,7 +151,7 @@ module.exports = function(apiClient) { /** * Charge - * Charges a card represented by a card nonce or a customer's card on file. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment) --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. + * Charges a card represented by a card nonce or a customer's card on file. Your request to this endpoint must include _either_: - A value for the `card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer's card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](https://squareup.com/help/article/5394), you _must_ provide values for the following parameters in your request: - `buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square's processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the `processing_fee_money` field of each [Tender included](#type-tender) in the transaction. * @param {String} locationId The ID of the location to associate the created transaction with. * @param {module:model/ChargeRequest} 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/ChargeResponse} @@ -167,7 +167,7 @@ module.exports = function(apiClient) { /** * @deprecated * CreateRefund - * Initiates a refund for a previously charged tender. Deprecated - recommend using [RefundPayment](#endpoint-refunds-refundpayment) --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- You must issue a refund within 120 days of the associated payment. See [this article](https://squareup.com/help/us/en/article/5060) for more information on refund behavior. NOTE: Card-present transactions with Interac credit cards **cannot be refunded using the Connect API**. Interac transactions must refunded in-person (e.g., dipping the card using POS app). + * Initiates a refund for a previously charged tender. You must issue a refund within 120 days of the associated payment. See [this article](https://squareup.com/help/us/en/article/5060) for more information on refund behavior. NOTE: Card-present transactions with Interac credit cards **cannot be refunded using the Connect API**. Interac transactions must refunded in-person (e.g., dipping the card using POS app). * @param {String} locationId The ID of the original transaction's associated location. * @param {String} transactionId The ID of the original transaction that includes the tender to refund. * @param {module:model/CreateRefundRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -201,7 +201,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -220,7 +220,7 @@ module.exports = function(apiClient) { /** * CreateRefund - * Initiates a refund for a previously charged tender. Deprecated - recommend using [RefundPayment](#endpoint-refunds-refundpayment) --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- You must issue a refund within 120 days of the associated payment. See [this article](https://squareup.com/help/us/en/article/5060) for more information on refund behavior. NOTE: Card-present transactions with Interac credit cards **cannot be refunded using the Connect API**. Interac transactions must refunded in-person (e.g., dipping the card using POS app). + * Initiates a refund for a previously charged tender. You must issue a refund within 120 days of the associated payment. See [this article](https://squareup.com/help/us/en/article/5060) for more information on refund behavior. NOTE: Card-present transactions with Interac credit cards **cannot be refunded using the Connect API**. Interac transactions must refunded in-person (e.g., dipping the card using POS app). * @param {String} locationId The ID of the original transaction's associated location. * @param {String} transactionId The ID of the original transaction that includes the tender to refund. * @param {module:model/CreateRefundRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -237,7 +237,7 @@ module.exports = function(apiClient) { /** * @deprecated * ListRefunds - * Lists refunds for one of a business's locations. Deprecated - recommend using [SearchOrders](#endpoint-orders-searchorders) --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- In addition to full or partial tender refunds processed through Square APIs, refunds may result from itemized returns or exchanges through Square's Point of Sale applications. Refunds with a `status` of `PENDING` are not currently included in this endpoint's response. Max results per [page](#paginatingresults): 50 + * Lists refunds for one of a business's locations. In addition to full or partial tender refunds processed through Square APIs, refunds may result from itemized returns or exchanges through Square's Point of Sale applications. Refunds with a `status` of `PENDING` are not currently included in this endpoint's response. Max results per [page](#paginatingresults): 50 * @param {String} locationId The ID of the location to list refunds for. * @param {Object} opts Optional parameters * @param {String} opts.beginTime The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. @@ -268,7 +268,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -287,7 +287,7 @@ module.exports = function(apiClient) { /** * ListRefunds - * Lists refunds for one of a business's locations. Deprecated - recommend using [SearchOrders](#endpoint-orders-searchorders) --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- In addition to full or partial tender refunds processed through Square APIs, refunds may result from itemized returns or exchanges through Square's Point of Sale applications. Refunds with a `status` of `PENDING` are not currently included in this endpoint's response. Max results per [page](#paginatingresults): 50 + * Lists refunds for one of a business's locations. In addition to full or partial tender refunds processed through Square APIs, refunds may result from itemized returns or exchanges through Square's Point of Sale applications. Refunds with a `status` of `PENDING` are not currently included in this endpoint's response. Max results per [page](#paginatingresults): 50 * @param {String} locationId The ID of the location to list refunds for. * @param {Object} opts Optional parameters * @param {String} opts.beginTime The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. @@ -307,7 +307,7 @@ module.exports = function(apiClient) { /** * @deprecated * ListTransactions - * Lists transactions for a particular location. Deprecated - recommend using [SearchOrders](#endpoint-orders-searchorders) --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- Transactions include payment information from sales and exchanges and refund information from returns and exchanges. Max results per [page](#paginatingresults): 50 + * Lists transactions for a particular location. Transactions include payment information from sales and exchanges and refund information from returns and exchanges. Max results per [page](#paginatingresults): 50 * @param {String} locationId The ID of the location to list transactions for. * @param {Object} opts Optional parameters * @param {String} opts.beginTime The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. @@ -338,7 +338,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -357,7 +357,7 @@ module.exports = function(apiClient) { /** * ListTransactions - * Lists transactions for a particular location. Deprecated - recommend using [SearchOrders](#endpoint-orders-searchorders) --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- Transactions include payment information from sales and exchanges and refund information from returns and exchanges. Max results per [page](#paginatingresults): 50 + * Lists transactions for a particular location. Transactions include payment information from sales and exchanges and refund information from returns and exchanges. Max results per [page](#paginatingresults): 50 * @param {String} locationId The ID of the location to list transactions for. * @param {Object} opts Optional parameters * @param {String} opts.beginTime The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year. @@ -377,7 +377,7 @@ module.exports = function(apiClient) { /** * @deprecated * RetrieveTransaction - * Retrieves details for a single transaction. Deprecated - recommend using [BatchRetrieveOrders](#endpoint-batchretrieveorders) --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- + * Retrieves details for a single transaction. * @param {String} locationId The ID of the transaction's associated location. * @param {String} transactionId The ID of the transaction to retrieve. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RetrieveTransactionResponse} and HTTP response @@ -405,7 +405,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -424,7 +424,7 @@ module.exports = function(apiClient) { /** * RetrieveTransaction - * Retrieves details for a single transaction. Deprecated - recommend using [BatchRetrieveOrders](#endpoint-batchretrieveorders) --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- + * Retrieves details for a single transaction. * @param {String} locationId The ID of the transaction's associated location. * @param {String} transactionId The ID of the transaction to retrieve. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RetrieveTransactionResponse} @@ -440,7 +440,7 @@ module.exports = function(apiClient) { /** * @deprecated * VoidTransaction - * Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. + * Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. * @param {String} locationId * @param {String} transactionId * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/VoidTransactionResponse} and HTTP response @@ -468,7 +468,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -487,7 +487,7 @@ module.exports = function(apiClient) { /** * VoidTransaction - * Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. --- - __Deprecation date__: 2019-08-15 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2021-09-01 - [Migration guide](/payments-api/migrate-from-transactions-api) --- See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. + * Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a `delay_capture` value of `true`. See [Delayed capture transactions](/payments/transactions/overview#delayed-capture) for more information. * @param {String} locationId * @param {String} transactionId * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/VoidTransactionResponse} diff --git a/src/api/V1EmployeesApi.js b/src/api/V1EmployeesApi.js index e9ee9a5..e75a9ed 100644 --- a/src/api/V1EmployeesApi.js +++ b/src/api/V1EmployeesApi.js @@ -56,7 +56,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -108,7 +108,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -142,7 +142,7 @@ module.exports = function(apiClient) { /** * @deprecated * 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- 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. + * 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 */ @@ -162,7 +162,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -181,7 +181,7 @@ module.exports = function(apiClient) { /** * 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- 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. + * 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} */ @@ -196,7 +196,7 @@ module.exports = function(apiClient) { /** * @deprecated * 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- *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> + * 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. Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. * @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 */ @@ -217,7 +217,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -236,7 +236,7 @@ module.exports = function(apiClient) { /** * 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- *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> + * 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. Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. * @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} */ @@ -251,7 +251,7 @@ module.exports = function(apiClient) { /** * @deprecated * 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-cashdrawershifts) --- + * 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 * @param {String} opts.order The order in which cash drawer shifts are listed in the response, based on their created_at field. Default value: ASC @@ -280,7 +280,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -299,7 +299,7 @@ module.exports = function(apiClient) { /** * 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-cashdrawershifts) --- + * 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 * @param {String} opts.order The order in which cash drawer shifts are listed in the response, based on their created_at field. Default value: ASC @@ -338,7 +338,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -407,7 +407,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -450,7 +450,7 @@ module.exports = function(apiClient) { /** * @deprecated * ListTimecardEvents - * Provides summary information for all events associated with a particular timecard. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside> + * 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 */ @@ -471,7 +471,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -490,7 +490,7 @@ module.exports = function(apiClient) { /** * ListTimecardEvents - * Provides summary information for all events associated with a particular timecard. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside> + * 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.} */ @@ -505,7 +505,7 @@ module.exports = function(apiClient) { /** * @deprecated * ListTimecards - * Provides summary information for all of a business's employee timecards. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- + * Provides summary information for all of a business's employee timecards. * @param {Object} opts Optional parameters * @param {String} opts.order The order in which timecards are listed in the response, based on their created_at field. * @param {String} opts.employeeId If provided, the endpoint returns only timecards for the employee with the specified ID. @@ -543,7 +543,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -562,7 +562,7 @@ module.exports = function(apiClient) { /** * ListTimecards - * Provides summary information for all of a business's employee timecards. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- + * Provides summary information for all of a business's employee timecards. * @param {Object} opts Optional parameters * @param {String} opts.order The order in which timecards are listed in the response, based on their created_at field. * @param {String} opts.employeeId If provided, the endpoint returns only timecards for the employee with the specified ID. @@ -588,7 +588,7 @@ module.exports = function(apiClient) { /** * @deprecated * RetrieveCashDrawerShift - * Provides the details for a single cash drawer shift, including all events that occurred during the shift. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-cashdrawershifts) --- + * 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1CashDrawerShift} and HTTP response @@ -616,7 +616,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -635,7 +635,7 @@ module.exports = function(apiClient) { /** * RetrieveCashDrawerShift - * Provides the details for a single cash drawer shift, including all events that occurred during the shift. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-cashdrawershifts) --- + * 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1CashDrawerShift} @@ -670,7 +670,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -723,7 +723,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -757,7 +757,7 @@ module.exports = function(apiClient) { /** * @deprecated * RetrieveTimecard - * Provides the details for a single timecard. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside> + * 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 */ @@ -778,7 +778,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -797,7 +797,7 @@ module.exports = function(apiClient) { /** * RetrieveTimecard - * Provides the details for a single timecard. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- <aside> Only approved accounts can manage their employees with Square. Unapproved accounts cannot use employee management features with the API. </aside> + * 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} */ @@ -837,7 +837,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -897,7 +897,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -932,7 +932,7 @@ module.exports = function(apiClient) { /** * @deprecated * 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- + * 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1Timecard} and HTTP response @@ -959,7 +959,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -978,7 +978,7 @@ module.exports = function(apiClient) { /** * 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-timecards) --- + * 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1Timecard} diff --git a/src/api/V1ItemsApi.js b/src/api/V1ItemsApi.js index 10f6f44..718632c 100644 --- a/src/api/V1ItemsApi.js +++ b/src/api/V1ItemsApi.js @@ -45,7 +45,7 @@ module.exports = function(apiClient) { /** * @deprecated * AdjustInventory - * Adjusts the current available inventory of an item variation. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Adjusts the current available inventory of an item variation. * @param {String} locationId The ID of the item's associated location. * @param {String} variationId The ID of the variation to adjust inventory information for. * @param {module:model/V1AdjustInventoryRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -79,7 +79,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -98,7 +98,7 @@ module.exports = function(apiClient) { /** * AdjustInventory - * Adjusts the current available inventory of an item variation. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Adjusts the current available inventory of an item variation. * @param {String} locationId The ID of the item's associated location. * @param {String} variationId The ID of the variation to adjust inventory information for. * @param {module:model/V1AdjustInventoryRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -115,7 +115,7 @@ module.exports = function(apiClient) { /** * @deprecated * ApplyFee - * Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. * @param {String} locationId The ID of the fee's associated location. * @param {String} itemId The ID of the item to add the fee to. * @param {String} feeId The ID of the fee to apply. @@ -150,7 +150,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -169,7 +169,7 @@ module.exports = function(apiClient) { /** * ApplyFee - * Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Associates a fee with an item so the fee is automatically applied to the item in Square Point of Sale. * @param {String} locationId The ID of the fee's associated location. * @param {String} itemId The ID of the item to add the fee to. * @param {String} feeId The ID of the fee to apply. @@ -186,7 +186,7 @@ module.exports = function(apiClient) { /** * @deprecated * ApplyModifierList - * Associates a modifier list with an item so the associated modifier options can be applied to the item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Associates a modifier list with an item so the associated modifier options 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. * @param {String} itemId The ID of the item to add the modifier list to. @@ -221,7 +221,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -240,7 +240,7 @@ module.exports = function(apiClient) { /** * ApplyModifierList - * Associates a modifier list with an item so the associated modifier options can be applied to the item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Associates a modifier list with an item so the associated modifier options 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. * @param {String} itemId The ID of the item to add the modifier list to. @@ -257,7 +257,7 @@ module.exports = function(apiClient) { /** * @deprecated * CreateCategory - * Creates an item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1Category} and HTTP response @@ -284,7 +284,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -303,7 +303,7 @@ module.exports = function(apiClient) { /** * CreateCategory - * Creates an item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1Category} @@ -319,7 +319,7 @@ module.exports = function(apiClient) { /** * @deprecated * CreateDiscount - * Creates a discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1Discount} and HTTP response @@ -346,7 +346,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -365,7 +365,7 @@ module.exports = function(apiClient) { /** * CreateDiscount - * Creates a discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1Discount} @@ -381,7 +381,7 @@ module.exports = function(apiClient) { /** * @deprecated * CreateFee - * Creates a fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1Fee} and HTTP response @@ -408,7 +408,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -427,7 +427,7 @@ module.exports = function(apiClient) { /** * CreateFee - * Creates a fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1Fee} @@ -443,7 +443,7 @@ module.exports = function(apiClient) { /** * @deprecated * CreateItem - * Creates an item and at least one variation for it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- 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 `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. + * 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 `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 @@ -470,7 +470,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -489,7 +489,7 @@ module.exports = function(apiClient) { /** * CreateItem - * Creates an item and at least one variation for it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- 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 `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. + * 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 `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} @@ -505,7 +505,7 @@ module.exports = function(apiClient) { /** * @deprecated * CreateModifierList - * Creates an item modifier list and at least 1 modifier option for it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Creates an item modifier list and at least 1 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1ModifierList} and HTTP response @@ -532,7 +532,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -551,7 +551,7 @@ module.exports = function(apiClient) { /** * CreateModifierList - * Creates an item modifier list and at least 1 modifier option for it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Creates an item modifier list and at least 1 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1ModifierList} @@ -567,7 +567,7 @@ module.exports = function(apiClient) { /** * @deprecated * CreateModifierOption - * Creates an item modifier option and adds it to a modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {module:model/V1ModifierOption} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -601,7 +601,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -620,7 +620,7 @@ module.exports = function(apiClient) { /** * CreateModifierOption - * Creates an item modifier option and adds it to a modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {module:model/V1ModifierOption} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -637,7 +637,7 @@ module.exports = function(apiClient) { /** * @deprecated * CreatePage - * Creates a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Creates a Favorites page in Square Point of Sale. * @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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1Page} and HTTP response @@ -664,7 +664,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -683,7 +683,7 @@ module.exports = function(apiClient) { /** * CreatePage - * Creates a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Creates a Favorites page in Square Point of Sale. * @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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1Page} @@ -699,7 +699,7 @@ module.exports = function(apiClient) { /** * @deprecated * CreateVariation - * Creates an item variation for an existing item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {module:model/V1Variation} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -733,7 +733,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -752,7 +752,7 @@ module.exports = function(apiClient) { /** * CreateVariation - * Creates an item variation for an existing item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {module:model/V1Variation} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -769,7 +769,7 @@ module.exports = function(apiClient) { /** * @deprecated * DeleteCategory - * Deletes an existing item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. + * Deletes an existing item category. __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 @@ -797,7 +797,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -816,7 +816,7 @@ module.exports = function(apiClient) { /** * DeleteCategory - * Deletes an existing item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteCategory__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteCategoryRequest` object as documented below. + * Deletes an existing item category. __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} @@ -832,7 +832,7 @@ module.exports = function(apiClient) { /** * @deprecated * DeleteDiscount - * Deletes an existing discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. + * Deletes an existing discount. __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 @@ -860,7 +860,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -879,7 +879,7 @@ module.exports = function(apiClient) { /** * DeleteDiscount - * Deletes an existing discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteDiscount__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteDiscountRequest` object as documented below. + * Deletes an existing discount. __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} @@ -895,7 +895,7 @@ module.exports = function(apiClient) { /** * @deprecated * DeleteFee - * Deletes an existing fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. + * Deletes an existing fee (tax). __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 @@ -923,7 +923,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -942,7 +942,7 @@ module.exports = function(apiClient) { /** * DeleteFee - * Deletes an existing fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteFee__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteFeeRequest` object as documented below. + * Deletes an existing fee (tax). __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} @@ -958,7 +958,7 @@ module.exports = function(apiClient) { /** * @deprecated * DeleteItem - * Deletes an existing item and all item variations associated with it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. + * Deletes an existing item and all item variations associated with it. __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 @@ -986,7 +986,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -1005,7 +1005,7 @@ module.exports = function(apiClient) { /** * DeleteItem - * Deletes an existing item and all item variations associated with it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteItem__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteItemRequest` object as documented below. + * Deletes an existing item and all item variations associated with it. __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} @@ -1021,7 +1021,7 @@ module.exports = function(apiClient) { /** * @deprecated * DeleteModifierList - * Deletes an existing item modifier list and all modifier options associated with it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. + * Deletes an existing item modifier list and all modifier options associated with it. __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 @@ -1049,7 +1049,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -1068,7 +1068,7 @@ module.exports = function(apiClient) { /** * DeleteModifierList - * Deletes an existing item modifier list and all modifier options associated with it. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteModifierList__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierListRequest` object as documented below. + * Deletes an existing item modifier list and all modifier options associated with it. __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} @@ -1084,7 +1084,7 @@ module.exports = function(apiClient) { /** * @deprecated * DeleteModifierOption - * Deletes an existing item modifier option from a modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. + * Deletes an existing item modifier option from a modifier list. __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. * @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. @@ -1119,7 +1119,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -1138,7 +1138,7 @@ module.exports = function(apiClient) { /** * DeleteModifierOption - * Deletes an existing item modifier option from a modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. + * Deletes an existing item modifier option from a modifier list. __DeleteModifierOption__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteModifierOptionRequest` object. * @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. @@ -1155,7 +1155,7 @@ module.exports = function(apiClient) { /** * @deprecated * DeletePage - * Deletes an existing Favorites page and all of its cells. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. + * Deletes an existing Favorites page and all of its cells. __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. * @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 @@ -1183,7 +1183,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -1202,7 +1202,7 @@ module.exports = function(apiClient) { /** * DeletePage - * Deletes an existing Favorites page and all of its cells. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. + * Deletes an existing Favorites page and all of its cells. __DeletePage__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageRequest` object. * @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} @@ -1218,7 +1218,7 @@ module.exports = function(apiClient) { /** * @deprecated * DeletePageCell - * Deletes a cell from a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeletePageCell__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. + * Deletes a cell from a Favorites page in Square Point of Sale. __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 @@ -1252,7 +1252,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -1271,7 +1271,7 @@ module.exports = function(apiClient) { /** * DeletePageCell - * Deletes a cell from a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeletePageCell__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeletePageCellRequest` object as documented below. + * Deletes a cell from a Favorites page in Square Point of Sale. __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 @@ -1290,7 +1290,7 @@ module.exports = function(apiClient) { /** * @deprecated * DeleteVariation - * Deletes an existing item variation from an item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. + * Deletes an existing item variation from an item. __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. @@ -1325,7 +1325,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -1344,7 +1344,7 @@ module.exports = function(apiClient) { /** * DeleteVariation - * Deletes an existing item variation from an item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- __DeleteVariation__ returns nothing on success but Connect SDKs map the empty response to an empty `V1DeleteVariationRequest` object as documented below. + * Deletes an existing item variation from an item. __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. @@ -1361,7 +1361,7 @@ module.exports = function(apiClient) { /** * @deprecated * ListCategories - * Lists all the item categories for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Lists all the item categories for a given location. * @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 */ @@ -1382,7 +1382,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -1401,7 +1401,7 @@ module.exports = function(apiClient) { /** * ListCategories - * Lists all the item categories for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Lists all the item categories for a given location. * @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.} */ @@ -1416,7 +1416,7 @@ module.exports = function(apiClient) { /** * @deprecated * ListDiscounts - * Lists all the discounts for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Lists all the discounts for a given location. * @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 */ @@ -1437,7 +1437,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -1456,7 +1456,7 @@ module.exports = function(apiClient) { /** * ListDiscounts - * Lists all the discounts for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Lists all the discounts for a given location. * @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.} */ @@ -1471,7 +1471,7 @@ module.exports = function(apiClient) { /** * @deprecated * ListFees - * Lists all the fees (taxes) for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Lists all the fees (taxes) for a given location. * @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 */ @@ -1492,7 +1492,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -1511,7 +1511,7 @@ module.exports = function(apiClient) { /** * ListFees - * Lists all the fees (taxes) for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Lists all the fees (taxes) for a given location. * @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.} */ @@ -1526,7 +1526,7 @@ module.exports = function(apiClient) { /** * @deprecated * ListInventory - * Provides inventory information for all inventory-enabled item variations. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Provides inventory information for all inventory-enabled item variations. * @param {String} locationId The ID of the item's associated location. * @param {Object} opts Optional parameters * @param {Number} opts.limit The maximum number of inventory entries to return in a single response. This value cannot exceed 1000. @@ -1553,7 +1553,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -1572,7 +1572,7 @@ module.exports = function(apiClient) { /** * ListInventory - * Provides inventory information for all inventory-enabled item variations. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Provides inventory information for all inventory-enabled item variations. * @param {String} locationId The ID of the item's associated location. * @param {Object} opts Optional parameters * @param {Number} opts.limit The maximum number of inventory entries to return in a single response. This value cannot exceed 1000. @@ -1590,7 +1590,7 @@ module.exports = function(apiClient) { /** * @deprecated * ListItems - * Provides summary information of all items for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Provides summary information of all items for a given location. * @param {String} locationId The ID of the location to list items for. * @param {Object} opts Optional parameters * @param {String} opts.batchToken A pagination cursor to retrieve the next set of results for your original query to the endpoint. @@ -1615,7 +1615,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -1634,7 +1634,7 @@ module.exports = function(apiClient) { /** * ListItems - * Provides summary information of all items for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Provides summary information of all items for a given location. * @param {String} locationId The ID of the location to list items for. * @param {Object} opts Optional parameters * @param {String} opts.batchToken A pagination cursor to retrieve the next set of results for your original query to the endpoint. @@ -1651,7 +1651,7 @@ module.exports = function(apiClient) { /** * @deprecated * ListModifierLists - * Lists all the modifier lists for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Lists all the modifier lists for a given location. * @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 */ @@ -1672,7 +1672,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -1691,7 +1691,7 @@ module.exports = function(apiClient) { /** * ListModifierLists - * Lists all the modifier lists for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Lists all the modifier lists for a given location. * @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.} */ @@ -1706,7 +1706,7 @@ module.exports = function(apiClient) { /** * @deprecated * ListPages - * Lists all Favorites pages (in Square Point of Sale) for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Lists all Favorites pages (in Square Point of Sale) for a given location. * @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 */ @@ -1727,7 +1727,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -1746,7 +1746,7 @@ module.exports = function(apiClient) { /** * ListPages - * Lists all Favorites pages (in Square Point of Sale) for a given location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Lists all Favorites pages (in Square Point of Sale) for a given location. * @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.} */ @@ -1761,7 +1761,7 @@ module.exports = function(apiClient) { /** * @deprecated * RemoveFee - * Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. * @param {String} locationId The ID of the fee's associated location. * @param {String} itemId The ID of the item to add the fee to. * @param {String} feeId The ID of the fee to apply. @@ -1796,7 +1796,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -1815,7 +1815,7 @@ module.exports = function(apiClient) { /** * RemoveFee - * Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Removes a fee assocation from an item so the fee is no longer automatically applied to the item in Square Point of Sale. * @param {String} locationId The ID of the fee's associated location. * @param {String} itemId The ID of the item to add the fee to. * @param {String} feeId The ID of the fee to apply. @@ -1832,7 +1832,7 @@ module.exports = function(apiClient) { /** * @deprecated * RemoveModifierList - * Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Removes a modifier list association from an item so the 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. * @param {String} itemId The ID of the item to remove the modifier list from. @@ -1867,7 +1867,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -1886,7 +1886,7 @@ module.exports = function(apiClient) { /** * RemoveModifierList - * Removes a modifier list association from an item so the modifier options from the list can no longer be applied to the item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Removes a modifier list association from an item so the 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. * @param {String} itemId The ID of the item to remove the modifier list from. @@ -1903,7 +1903,7 @@ module.exports = function(apiClient) { /** * @deprecated * RetrieveItem - * Provides the details for a single item, including associated modifier lists and fees. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1Item} and HTTP response @@ -1931,7 +1931,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -1950,7 +1950,7 @@ module.exports = function(apiClient) { /** * RetrieveItem - * Provides the details for a single item, including associated modifier lists and fees. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1Item} @@ -1966,7 +1966,7 @@ module.exports = function(apiClient) { /** * @deprecated * RetrieveModifierList - * Provides the details for a single modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1ModifierList} and HTTP response @@ -1994,7 +1994,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -2013,7 +2013,7 @@ module.exports = function(apiClient) { /** * RetrieveModifierList - * Provides the details for a single modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1ModifierList} @@ -2029,7 +2029,7 @@ module.exports = function(apiClient) { /** * @deprecated * UpdateCategory - * Modifies the details of an existing item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {module:model/V1Category} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -2063,7 +2063,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -2082,7 +2082,7 @@ module.exports = function(apiClient) { /** * UpdateCategory - * Modifies the details of an existing item category. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {module:model/V1Category} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -2099,7 +2099,7 @@ module.exports = function(apiClient) { /** * @deprecated * UpdateDiscount - * Modifies the details of an existing discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {module:model/V1Discount} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -2133,7 +2133,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -2152,7 +2152,7 @@ module.exports = function(apiClient) { /** * UpdateDiscount - * Modifies the details of an existing discount. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {module:model/V1Discount} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -2169,7 +2169,7 @@ module.exports = function(apiClient) { /** * @deprecated * UpdateFee - * Modifies the details of an existing fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {module:model/V1Fee} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -2203,7 +2203,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -2222,7 +2222,7 @@ module.exports = function(apiClient) { /** * UpdateFee - * Modifies the details of an existing fee (tax). --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {module:model/V1Fee} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -2239,7 +2239,7 @@ module.exports = function(apiClient) { /** * @deprecated * UpdateItem - * Modifies the core details of an existing item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {module:model/V1Item} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -2273,7 +2273,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -2292,7 +2292,7 @@ module.exports = function(apiClient) { /** * UpdateItem - * Modifies the core details of an existing item. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {module:model/V1Item} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -2309,7 +2309,7 @@ module.exports = function(apiClient) { /** * @deprecated * UpdateModifierList - * Modifies the details of an existing item modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {module:model/V1UpdateModifierListRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -2343,7 +2343,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -2362,7 +2362,7 @@ module.exports = function(apiClient) { /** * UpdateModifierList - * Modifies the details of an existing item modifier list. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {module:model/V1UpdateModifierListRequest} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -2379,7 +2379,7 @@ module.exports = function(apiClient) { /** * @deprecated * UpdateModifierOption - * Modifies the details of an existing item modifier option. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {String} modifierOptionId The ID of the modifier list to edit. @@ -2420,7 +2420,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -2439,7 +2439,7 @@ module.exports = function(apiClient) { /** * UpdateModifierOption - * Modifies the details of an existing item modifier option. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {String} modifierOptionId The ID of the modifier list to edit. @@ -2457,7 +2457,7 @@ module.exports = function(apiClient) { /** * @deprecated * UpdatePage - * Modifies the details of a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Modifies the details of a Favorites page in Square Point of Sale. * @param {String} locationId The ID of the Favorites page's associated location * @param {String} pageId The ID of the page to modify. * @param {module:model/V1Page} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -2491,7 +2491,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -2510,7 +2510,7 @@ module.exports = function(apiClient) { /** * UpdatePage - * Modifies the details of a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Modifies the details of a Favorites page in Square Point of Sale. * @param {String} locationId The ID of the Favorites page's associated location * @param {String} pageId The ID of the page to modify. * @param {module:model/V1Page} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -2527,7 +2527,7 @@ module.exports = function(apiClient) { /** * @deprecated * UpdatePageCell - * Modifies a cell of a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Modifies a cell of a Favorites page in Square Point of Sale. * @param {String} locationId The ID of the Favorites page's associated location. * @param {String} pageId The ID of the page the cell belongs to. * @param {module:model/V1PageCell} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -2561,7 +2561,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -2580,7 +2580,7 @@ module.exports = function(apiClient) { /** * UpdatePageCell - * Modifies a cell of a Favorites page in Square Point of Sale. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * Modifies a cell of a Favorites page in Square Point of Sale. * @param {String} locationId The ID of the Favorites page's associated location. * @param {String} pageId The ID of the page the cell belongs to. * @param {module:model/V1PageCell} body An object containing the fields to POST for the request. See the corresponding object definition for field details. @@ -2597,7 +2597,7 @@ module.exports = function(apiClient) { /** * @deprecated * UpdateVariation - * Modifies the details of an existing item variation. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {String} variationId The ID of the variation to modify. @@ -2638,7 +2638,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -2657,7 +2657,7 @@ module.exports = function(apiClient) { /** * UpdateVariation - * Modifies the details of an existing item variation. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-items) --- + * 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. * @param {String} variationId The ID of the variation to modify. diff --git a/src/api/V1LocationsApi.js b/src/api/V1LocationsApi.js index a59aebd..3cad44d 100644 --- a/src/api/V1LocationsApi.js +++ b/src/api/V1LocationsApi.js @@ -34,7 +34,7 @@ module.exports = function(apiClient) { /** * @deprecated * ListLocations - * Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) --- + * Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link Array.} and HTTP response */ this.listLocationsWithHttpInfo = function() { @@ -48,7 +48,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -67,7 +67,7 @@ module.exports = function(apiClient) { /** * ListLocations - * Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) --- + * Provides details for all business locations associated with a Square account, including the Square-assigned object ID for the location. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link Array.} */ this.listLocations = function() { @@ -81,7 +81,7 @@ module.exports = function(apiClient) { /** * @deprecated * RetrieveBusiness - * Get the general information for a business. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) --- + * Get the general information for a business. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1Merchant} and HTTP response */ this.retrieveBusinessWithHttpInfo = function() { @@ -95,7 +95,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -114,7 +114,7 @@ module.exports = function(apiClient) { /** * RetrieveBusiness - * Get the general information for a business. --- - __Deprecation date__: 2019-11-20 - [__Retirement date__](/build-basics/api-lifecycle#deprecated): 2020-11-18 - [Migration guide](/migrate-from-v1/guides/v1-locations) --- + * Get the general information for a business. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1Merchant} */ this.retrieveBusiness = function() { diff --git a/src/api/V1TransactionsApi.js b/src/api/V1TransactionsApi.js index c1187b4..5ef6106 100644 --- a/src/api/V1TransactionsApi.js +++ b/src/api/V1TransactionsApi.js @@ -65,7 +65,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -100,7 +100,7 @@ module.exports = function(apiClient) { /** * @deprecated * 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-bankaccounts) --- + * 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 */ @@ -121,7 +121,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -140,7 +140,7 @@ module.exports = function(apiClient) { /** * 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-bankaccounts) --- + * 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.} */ @@ -182,7 +182,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -253,7 +253,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -325,7 +325,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -398,7 +398,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -439,7 +439,7 @@ module.exports = function(apiClient) { /** * @deprecated * 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-bankaccounts) --- + * 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/V1BankAccount} and HTTP response @@ -467,7 +467,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -486,7 +486,7 @@ module.exports = function(apiClient) { /** * 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. --- - __Deprecation date__: 2020-02-26 - [__Retirement date__](/docs/build-basics/api-lifecycle#deprecated): 2021-02-26 - [Migration guide](/docs/migrate-from-v1/guides/v1-bankaccounts) --- + * 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. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/V1BankAccount} @@ -528,7 +528,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -589,7 +589,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -650,7 +650,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; @@ -717,7 +717,7 @@ module.exports = function(apiClient) { }; var headerParams = { }; - headerParams['Square-Version'] = '2020-05-28'; + headerParams['Square-Version'] = '2020-06-25'; var formParams = { }; diff --git a/src/index.js b/src/index.js index 827ca0c..b07c1d2 100644 --- a/src/index.js +++ b/src/index.js @@ -44,6 +44,10 @@ var BatchRetrieveOrdersResponse = require('./model/BatchRetrieveOrdersResponse') var BatchUpsertCatalogObjectsRequest = require('./model/BatchUpsertCatalogObjectsRequest'); var BatchUpsertCatalogObjectsResponse = require('./model/BatchUpsertCatalogObjectsResponse'); var BreakType = require('./model/BreakType'); +var BulkCreateTeamMembersRequest = require('./model/BulkCreateTeamMembersRequest'); +var BulkCreateTeamMembersResponse = require('./model/BulkCreateTeamMembersResponse'); +var BulkUpdateTeamMembersRequest = require('./model/BulkUpdateTeamMembersRequest'); +var BulkUpdateTeamMembersResponse = require('./model/BulkUpdateTeamMembersResponse'); var BusinessHours = require('./model/BusinessHours'); var BusinessHoursPeriod = require('./model/BusinessHoursPeriod'); var CalculateLoyaltyPointsRequest = require('./model/CalculateLoyaltyPointsRequest'); @@ -107,13 +111,7 @@ var CatalogPricingRule = require('./model/CatalogPricingRule'); var CatalogPricingType = require('./model/CatalogPricingType'); var CatalogProductSet = require('./model/CatalogProductSet'); var CatalogQuery = require('./model/CatalogQuery'); -var CatalogQueryCustomAttributeUsage = require('./model/CatalogQueryCustomAttributeUsage'); var CatalogQueryExact = require('./model/CatalogQueryExact'); -var CatalogQueryFilteredItems = require('./model/CatalogQueryFilteredItems'); -var CatalogQueryFilteredItemsCustomAttributeFilter = require('./model/CatalogQueryFilteredItemsCustomAttributeFilter'); -var CatalogQueryFilteredItemsCustomAttributeFilterFilterType = require('./model/CatalogQueryFilteredItemsCustomAttributeFilterFilterType'); -var CatalogQueryFilteredItemsNullableAttribute = require('./model/CatalogQueryFilteredItemsNullableAttribute'); -var CatalogQueryFilteredItemsStockLevel = require('./model/CatalogQueryFilteredItemsStockLevel'); var CatalogQueryItemVariationsForItemOptionValues = require('./model/CatalogQueryItemVariationsForItemOptionValues'); var CatalogQueryItemsForItemOptions = require('./model/CatalogQueryItemsForItemOptions'); var CatalogQueryItemsForModifierList = require('./model/CatalogQueryItemsForModifierList'); @@ -171,6 +169,8 @@ var CreateRefundRequest = require('./model/CreateRefundRequest'); var CreateRefundResponse = require('./model/CreateRefundResponse'); var CreateShiftRequest = require('./model/CreateShiftRequest'); var CreateShiftResponse = require('./model/CreateShiftResponse'); +var CreateTeamMemberRequest = require('./model/CreateTeamMemberRequest'); +var CreateTeamMemberResponse = require('./model/CreateTeamMemberResponse'); var CreateTerminalCheckoutRequest = require('./model/CreateTerminalCheckoutRequest'); var CreateTerminalCheckoutResponse = require('./model/CreateTerminalCheckoutResponse'); var Currency = require('./model/Currency'); @@ -251,6 +251,8 @@ var InventoryPhysicalCount = require('./model/InventoryPhysicalCount'); var InventoryState = require('./model/InventoryState'); var InventoryTransfer = require('./model/InventoryTransfer'); var ItemVariationLocationOverrides = require('./model/ItemVariationLocationOverrides'); +var JobAssignment = require('./model/JobAssignment'); +var JobAssignmentPayType = require('./model/JobAssignmentPayType'); var ListAdditionalRecipientReceivableRefundsRequest = require('./model/ListAdditionalRecipientReceivableRefundsRequest'); var ListAdditionalRecipientReceivableRefundsResponse = require('./model/ListAdditionalRecipientReceivableRefundsResponse'); var ListAdditionalRecipientReceivablesRequest = require('./model/ListAdditionalRecipientReceivablesRequest'); @@ -445,8 +447,12 @@ var RetrieveLoyaltyRewardRequest = require('./model/RetrieveLoyaltyRewardRequest var RetrieveLoyaltyRewardResponse = require('./model/RetrieveLoyaltyRewardResponse'); var RetrieveMerchantRequest = require('./model/RetrieveMerchantRequest'); var RetrieveMerchantResponse = require('./model/RetrieveMerchantResponse'); +var RetrieveTeamMemberRequest = require('./model/RetrieveTeamMemberRequest'); +var RetrieveTeamMemberResponse = require('./model/RetrieveTeamMemberResponse'); var RetrieveTransactionRequest = require('./model/RetrieveTransactionRequest'); var RetrieveTransactionResponse = require('./model/RetrieveTransactionResponse'); +var RetrieveWageSettingRequest = require('./model/RetrieveWageSettingRequest'); +var RetrieveWageSettingResponse = require('./model/RetrieveWageSettingResponse'); var RevokeTokenRequest = require('./model/RevokeTokenRequest'); var RevokeTokenResponse = require('./model/RevokeTokenResponse'); var SearchCatalogObjectsRequest = require('./model/SearchCatalogObjectsRequest'); @@ -474,6 +480,10 @@ var SearchOrdersSourceFilter = require('./model/SearchOrdersSourceFilter'); var SearchOrdersStateFilter = require('./model/SearchOrdersStateFilter'); var SearchShiftsRequest = require('./model/SearchShiftsRequest'); var SearchShiftsResponse = require('./model/SearchShiftsResponse'); +var SearchTeamMembersFilter = require('./model/SearchTeamMembersFilter'); +var SearchTeamMembersQuery = require('./model/SearchTeamMembersQuery'); +var SearchTeamMembersRequest = require('./model/SearchTeamMembersRequest'); +var SearchTeamMembersResponse = require('./model/SearchTeamMembersResponse'); var SearchTerminalCheckoutsRequest = require('./model/SearchTerminalCheckoutsRequest'); var SearchTerminalCheckoutsResponse = require('./model/SearchTerminalCheckoutsResponse'); var Shift = require('./model/Shift'); @@ -494,6 +504,10 @@ var SubmitEvidenceRequest = require('./model/SubmitEvidenceRequest'); var SubmitEvidenceResponse = require('./model/SubmitEvidenceResponse'); var TaxCalculationPhase = require('./model/TaxCalculationPhase'); var TaxInclusionType = require('./model/TaxInclusionType'); +var TeamMember = require('./model/TeamMember'); +var TeamMemberAssignedLocations = require('./model/TeamMemberAssignedLocations'); +var TeamMemberAssignedLocationsAssignmentType = require('./model/TeamMemberAssignedLocationsAssignmentType'); +var TeamMemberStatus = require('./model/TeamMemberStatus'); var Tender = require('./model/Tender'); var TenderCardDetails = require('./model/TenderCardDetails'); var TenderCardDetailsEntryMethod = require('./model/TenderCardDetailsEntryMethod'); @@ -526,6 +540,10 @@ var UpdateOrderRequest = require('./model/UpdateOrderRequest'); var UpdateOrderResponse = require('./model/UpdateOrderResponse'); var UpdateShiftRequest = require('./model/UpdateShiftRequest'); var UpdateShiftResponse = require('./model/UpdateShiftResponse'); +var UpdateTeamMemberRequest = require('./model/UpdateTeamMemberRequest'); +var UpdateTeamMemberResponse = require('./model/UpdateTeamMemberResponse'); +var UpdateWageSettingRequest = require('./model/UpdateWageSettingRequest'); +var UpdateWageSettingResponse = require('./model/UpdateWageSettingResponse'); var UpdateWorkweekConfigRequest = require('./model/UpdateWorkweekConfigRequest'); var UpdateWorkweekConfigResponse = require('./model/UpdateWorkweekConfigResponse'); var UpsertCatalogObjectRequest = require('./model/UpsertCatalogObjectRequest'); @@ -692,6 +710,7 @@ var V1VariationInventoryAlertType = require('./model/V1VariationInventoryAlertTy var V1VariationPricingType = require('./model/V1VariationPricingType'); var VoidTransactionRequest = require('./model/VoidTransactionRequest'); var VoidTransactionResponse = require('./model/VoidTransactionResponse'); +var WageSetting = require('./model/WageSetting'); var Weekday = require('./model/Weekday'); var WorkweekConfig = require('./model/WorkweekConfig'); @@ -717,6 +736,7 @@ var OrdersApi = require('./api/OrdersApi'); var PaymentsApi = require('./api/PaymentsApi'); var RefundsApi = require('./api/RefundsApi'); var ReportingApi = require('./api/ReportingApi'); +var TeamApi = require('./api/TeamApi'); var TerminalApi = require('./api/TerminalApi'); var TransactionsApi = require('./api/TransactionsApi'); var V1EmployeesApi = require('./api/V1EmployeesApi'); @@ -754,7 +774,7 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * *

* @module index - * @version 3.20200528.0 + * @version 4.20200625.0 */ module.exports = { /** @@ -917,6 +937,26 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/BreakType} */ BreakType: BreakType, + /** + * The BulkCreateTeamMembersRequest model constructor. + * @property {module:model/BulkCreateTeamMembersRequest} + */ + BulkCreateTeamMembersRequest: BulkCreateTeamMembersRequest, + /** + * The BulkCreateTeamMembersResponse model constructor. + * @property {module:model/BulkCreateTeamMembersResponse} + */ + BulkCreateTeamMembersResponse: BulkCreateTeamMembersResponse, + /** + * The BulkUpdateTeamMembersRequest model constructor. + * @property {module:model/BulkUpdateTeamMembersRequest} + */ + BulkUpdateTeamMembersRequest: BulkUpdateTeamMembersRequest, + /** + * The BulkUpdateTeamMembersResponse model constructor. + * @property {module:model/BulkUpdateTeamMembersResponse} + */ + BulkUpdateTeamMembersResponse: BulkUpdateTeamMembersResponse, /** * The BusinessHours model constructor. * @property {module:model/BusinessHours} @@ -1232,41 +1272,11 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/CatalogQuery} */ CatalogQuery: CatalogQuery, - /** - * The CatalogQueryCustomAttributeUsage model constructor. - * @property {module:model/CatalogQueryCustomAttributeUsage} - */ - CatalogQueryCustomAttributeUsage: CatalogQueryCustomAttributeUsage, /** * The CatalogQueryExact model constructor. * @property {module:model/CatalogQueryExact} */ CatalogQueryExact: CatalogQueryExact, - /** - * The CatalogQueryFilteredItems model constructor. - * @property {module:model/CatalogQueryFilteredItems} - */ - CatalogQueryFilteredItems: CatalogQueryFilteredItems, - /** - * The CatalogQueryFilteredItemsCustomAttributeFilter model constructor. - * @property {module:model/CatalogQueryFilteredItemsCustomAttributeFilter} - */ - CatalogQueryFilteredItemsCustomAttributeFilter: CatalogQueryFilteredItemsCustomAttributeFilter, - /** - * The CatalogQueryFilteredItemsCustomAttributeFilterFilterType model constructor. - * @property {module:model/CatalogQueryFilteredItemsCustomAttributeFilterFilterType} - */ - CatalogQueryFilteredItemsCustomAttributeFilterFilterType: CatalogQueryFilteredItemsCustomAttributeFilterFilterType, - /** - * The CatalogQueryFilteredItemsNullableAttribute model constructor. - * @property {module:model/CatalogQueryFilteredItemsNullableAttribute} - */ - CatalogQueryFilteredItemsNullableAttribute: CatalogQueryFilteredItemsNullableAttribute, - /** - * The CatalogQueryFilteredItemsStockLevel model constructor. - * @property {module:model/CatalogQueryFilteredItemsStockLevel} - */ - CatalogQueryFilteredItemsStockLevel: CatalogQueryFilteredItemsStockLevel, /** * The CatalogQueryItemVariationsForItemOptionValues model constructor. * @property {module:model/CatalogQueryItemVariationsForItemOptionValues} @@ -1552,6 +1562,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/CreateShiftResponse} */ CreateShiftResponse: CreateShiftResponse, + /** + * The CreateTeamMemberRequest model constructor. + * @property {module:model/CreateTeamMemberRequest} + */ + CreateTeamMemberRequest: CreateTeamMemberRequest, + /** + * The CreateTeamMemberResponse model constructor. + * @property {module:model/CreateTeamMemberResponse} + */ + CreateTeamMemberResponse: CreateTeamMemberResponse, /** * The CreateTerminalCheckoutRequest model constructor. * @property {module:model/CreateTerminalCheckoutRequest} @@ -1952,6 +1972,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/ItemVariationLocationOverrides} */ ItemVariationLocationOverrides: ItemVariationLocationOverrides, + /** + * The JobAssignment model constructor. + * @property {module:model/JobAssignment} + */ + JobAssignment: JobAssignment, + /** + * The JobAssignmentPayType model constructor. + * @property {module:model/JobAssignmentPayType} + */ + JobAssignmentPayType: JobAssignmentPayType, /** * The ListAdditionalRecipientReceivableRefundsRequest model constructor. * @property {module:model/ListAdditionalRecipientReceivableRefundsRequest} @@ -2922,6 +2952,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/RetrieveMerchantResponse} */ RetrieveMerchantResponse: RetrieveMerchantResponse, + /** + * The RetrieveTeamMemberRequest model constructor. + * @property {module:model/RetrieveTeamMemberRequest} + */ + RetrieveTeamMemberRequest: RetrieveTeamMemberRequest, + /** + * The RetrieveTeamMemberResponse model constructor. + * @property {module:model/RetrieveTeamMemberResponse} + */ + RetrieveTeamMemberResponse: RetrieveTeamMemberResponse, /** * The RetrieveTransactionRequest model constructor. * @property {module:model/RetrieveTransactionRequest} @@ -2932,6 +2972,16 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/RetrieveTransactionResponse} */ RetrieveTransactionResponse: RetrieveTransactionResponse, + /** + * The RetrieveWageSettingRequest model constructor. + * @property {module:model/RetrieveWageSettingRequest} + */ + RetrieveWageSettingRequest: RetrieveWageSettingRequest, + /** + * The RetrieveWageSettingResponse model constructor. + * @property {module:model/RetrieveWageSettingResponse} + */ + RetrieveWageSettingResponse: RetrieveWageSettingResponse, /** * The RevokeTokenRequest model constructor. * @property {module:model/RevokeTokenRequest} @@ -3067,6 +3117,26 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/SearchShiftsResponse} */ SearchShiftsResponse: SearchShiftsResponse, + /** + * The SearchTeamMembersFilter model constructor. + * @property {module:model/SearchTeamMembersFilter} + */ + SearchTeamMembersFilter: SearchTeamMembersFilter, + /** + * The SearchTeamMembersQuery model constructor. + * @property {module:model/SearchTeamMembersQuery} + */ + SearchTeamMembersQuery: SearchTeamMembersQuery, + /** + * The SearchTeamMembersRequest model constructor. + * @property {module:model/SearchTeamMembersRequest} + */ + SearchTeamMembersRequest: SearchTeamMembersRequest, + /** + * The SearchTeamMembersResponse model constructor. + * @property {module:model/SearchTeamMembersResponse} + */ + SearchTeamMembersResponse: SearchTeamMembersResponse, /** * The SearchTerminalCheckoutsRequest model constructor. * @property {module:model/SearchTerminalCheckoutsRequest} @@ -3167,6 +3237,26 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/TaxInclusionType} */ TaxInclusionType: TaxInclusionType, + /** + * The TeamMember model constructor. + * @property {module:model/TeamMember} + */ + TeamMember: TeamMember, + /** + * The TeamMemberAssignedLocations model constructor. + * @property {module:model/TeamMemberAssignedLocations} + */ + TeamMemberAssignedLocations: TeamMemberAssignedLocations, + /** + * The TeamMemberAssignedLocationsAssignmentType model constructor. + * @property {module:model/TeamMemberAssignedLocationsAssignmentType} + */ + TeamMemberAssignedLocationsAssignmentType: TeamMemberAssignedLocationsAssignmentType, + /** + * The TeamMemberStatus model constructor. + * @property {module:model/TeamMemberStatus} + */ + TeamMemberStatus: TeamMemberStatus, /** * The Tender model constructor. * @property {module:model/Tender} @@ -3327,6 +3417,26 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/UpdateShiftResponse} */ UpdateShiftResponse: UpdateShiftResponse, + /** + * The UpdateTeamMemberRequest model constructor. + * @property {module:model/UpdateTeamMemberRequest} + */ + UpdateTeamMemberRequest: UpdateTeamMemberRequest, + /** + * The UpdateTeamMemberResponse model constructor. + * @property {module:model/UpdateTeamMemberResponse} + */ + UpdateTeamMemberResponse: UpdateTeamMemberResponse, + /** + * The UpdateWageSettingRequest model constructor. + * @property {module:model/UpdateWageSettingRequest} + */ + UpdateWageSettingRequest: UpdateWageSettingRequest, + /** + * The UpdateWageSettingResponse model constructor. + * @property {module:model/UpdateWageSettingResponse} + */ + UpdateWageSettingResponse: UpdateWageSettingResponse, /** * The UpdateWorkweekConfigRequest model constructor. * @property {module:model/UpdateWorkweekConfigRequest} @@ -4157,6 +4267,11 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:model/VoidTransactionResponse} */ VoidTransactionResponse: VoidTransactionResponse, + /** + * The WageSetting model constructor. + * @property {module:model/WageSetting} + */ + WageSetting: WageSetting, /** * The Weekday model constructor. * @property {module:model/Weekday} @@ -4277,6 +4392,11 @@ var V1TransactionsApi = require('./api/V1TransactionsApi'); * @property {module:api/ReportingApi} */ ReportingApi: ReportingApi, + /** + * The TeamApi service constructor. + * @property {module:api/TeamApi} + */ + TeamApi: TeamApi, /** * The TerminalApi service constructor. * @property {module:api/TerminalApi} diff --git a/src/model/BulkCreateTeamMembersRequest.js b/src/model/BulkCreateTeamMembersRequest.js new file mode 100644 index 0000000..88a0499 --- /dev/null +++ b/src/model/BulkCreateTeamMembersRequest.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 CreateTeamMemberRequest = require('./CreateTeamMemberRequest'); + + + + +/** + * The BulkCreateTeamMembersRequest model module. + * @module model/BulkCreateTeamMembersRequest + */ + +/** + * Constructs a new BulkCreateTeamMembersRequest. + * Represents a bulk create request for `TeamMember` objects. + * @alias module:model/BulkCreateTeamMembersRequest + * @class + * @param teamMembers {Object.} The data which will be used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. + */ +var exports = function(teamMembers) { + var _this = this; + + _this['team_members'] = teamMembers; +}; + +/** + * Constructs a BulkCreateTeamMembersRequest 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/BulkCreateTeamMembersRequest} obj Optional instance to populate. + * @return {module:model/BulkCreateTeamMembersRequest} The populated BulkCreateTeamMembersRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('team_members')) { + obj['team_members'] = ApiClient.convertToType(data['team_members'], {'String': CreateTeamMemberRequest}); + } + } + return obj; +} + +/** + * The data which will be used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. + * @member {Object.} team_members + */ +exports.prototype['team_members'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/BulkCreateTeamMembersResponse.js b/src/model/BulkCreateTeamMembersResponse.js new file mode 100644 index 0000000..940f502 --- /dev/null +++ b/src/model/BulkCreateTeamMembersResponse.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 CreateTeamMemberResponse = require('./CreateTeamMemberResponse'); +var Error = require('./Error'); + + + + +/** + * The BulkCreateTeamMembersResponse model module. + * @module model/BulkCreateTeamMembersResponse + */ + +/** + * Constructs a new BulkCreateTeamMembersResponse. + * Represents a response from a bulk create request, containing the created `TeamMember` objects or error messages. + * @alias module:model/BulkCreateTeamMembersResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a BulkCreateTeamMembersResponse 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/BulkCreateTeamMembersResponse} obj Optional instance to populate. + * @return {module:model/BulkCreateTeamMembersResponse} The populated BulkCreateTeamMembersResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('team_members')) { + obj['team_members'] = ApiClient.convertToType(data['team_members'], {'String': CreateTeamMemberResponse}); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The successfully created `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. + * @member {Object.} team_members + */ +exports.prototype['team_members'] = undefined; +/** + * The errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/BulkUpdateTeamMembersRequest.js b/src/model/BulkUpdateTeamMembersRequest.js new file mode 100644 index 0000000..c40ad44 --- /dev/null +++ b/src/model/BulkUpdateTeamMembersRequest.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 UpdateTeamMemberRequest = require('./UpdateTeamMemberRequest'); + + + + +/** + * The BulkUpdateTeamMembersRequest model module. + * @module model/BulkUpdateTeamMembersRequest + */ + +/** + * Constructs a new BulkUpdateTeamMembersRequest. + * Represents a bulk update request for `TeamMember` objects. + * @alias module:model/BulkUpdateTeamMembersRequest + * @class + * @param teamMembers {Object.} The data which will be used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. + */ +var exports = function(teamMembers) { + var _this = this; + + _this['team_members'] = teamMembers; +}; + +/** + * Constructs a BulkUpdateTeamMembersRequest 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/BulkUpdateTeamMembersRequest} obj Optional instance to populate. + * @return {module:model/BulkUpdateTeamMembersRequest} The populated BulkUpdateTeamMembersRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('team_members')) { + obj['team_members'] = ApiClient.convertToType(data['team_members'], {'String': UpdateTeamMemberRequest}); + } + } + return obj; +} + +/** + * The data which will be used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. + * @member {Object.} team_members + */ +exports.prototype['team_members'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/BulkUpdateTeamMembersResponse.js b/src/model/BulkUpdateTeamMembersResponse.js new file mode 100644 index 0000000..70dc628 --- /dev/null +++ b/src/model/BulkUpdateTeamMembersResponse.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 UpdateTeamMemberResponse = require('./UpdateTeamMemberResponse'); + + + + +/** + * The BulkUpdateTeamMembersResponse model module. + * @module model/BulkUpdateTeamMembersResponse + */ + +/** + * Constructs a new BulkUpdateTeamMembersResponse. + * Represents a response from a bulk update request, containing the updated `TeamMember` objects or error messages. + * @alias module:model/BulkUpdateTeamMembersResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a BulkUpdateTeamMembersResponse 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/BulkUpdateTeamMembersResponse} obj Optional instance to populate. + * @return {module:model/BulkUpdateTeamMembersResponse} The populated BulkUpdateTeamMembersResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('team_members')) { + obj['team_members'] = ApiClient.convertToType(data['team_members'], {'String': UpdateTeamMemberResponse}); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The successfully updated `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. + * @member {Object.} team_members + */ +exports.prototype['team_members'] = undefined; +/** + * The errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/Card.js b/src/model/Card.js index 8429963..e543282 100644 --- a/src/model/Card.js +++ b/src/model/Card.js @@ -128,7 +128,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/CardBrand.js b/src/model/CardBrand.js index 04fca5e..42421b7 100644 --- a/src/model/CardBrand.js +++ b/src/model/CardBrand.js @@ -69,7 +69,22 @@ var exports = { * value: "SQUARE_CAPITAL_CARD" * @const */ - "SQUARE_CAPITAL_CARD": "SQUARE_CAPITAL_CARD"}; + "SQUARE_CAPITAL_CARD": "SQUARE_CAPITAL_CARD", + /** + * value: "INTERAC" + * @const + */ + "INTERAC": "INTERAC", + /** + * value: "EFTPOS" + * @const + */ + "EFTPOS": "EFTPOS", + /** + * value: "FELICA" + * @const + */ + "FELICA": "FELICA"}; /** * Returns a CardBrand enum value from a Javascript object name. diff --git a/src/model/CardPaymentDetails.js b/src/model/CardPaymentDetails.js index 2e86d40..92dbbcf 100644 --- a/src/model/CardPaymentDetails.js +++ b/src/model/CardPaymentDetails.js @@ -47,6 +47,7 @@ var exports = function() { + }; /** @@ -98,6 +99,9 @@ exports.constructFromObject = function(data, obj) { } if (data.hasOwnProperty('device_details')) { obj['device_details'] = DeviceDetails.constructFromObject(data['device_details']); + } + if (data.hasOwnProperty('refund_requires_card_presence')) { + obj['refund_requires_card_presence'] = ApiClient.convertToType(data['refund_requires_card_presence'], 'Boolean'); } if (data.hasOwnProperty('errors')) { obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); @@ -171,6 +175,11 @@ exports.prototype['statement_description'] = undefined; * @member {module:model/DeviceDetails} device_details */ exports.prototype['device_details'] = undefined; +/** + * Whether or not the card is required to be physically present in order for the payment to be refunded. If true, the card is required to be present. + * @member {Boolean} refund_requires_card_presence + */ +exports.prototype['refund_requires_card_presence'] = undefined; /** * Information on errors encountered during the request. * @member {Array.} errors diff --git a/src/model/CatalogCustomAttributeDefinitionNumberConfig.js b/src/model/CatalogCustomAttributeDefinitionNumberConfig.js index e935090..9501e61 100644 --- a/src/model/CatalogCustomAttributeDefinitionNumberConfig.js +++ b/src/model/CatalogCustomAttributeDefinitionNumberConfig.js @@ -53,7 +53,7 @@ exports.constructFromObject = function(data, obj) { } /** - * An integer between 0 and 5 that represents the maximum number of positions allowed after the decimal in number custom attribute values For example: - if the precision is 0, the quantity can be 1, 2, 3, etc. - if the precision is 1, the quantity can be 0.1, 0.2, etc. - if the precision is 2, the quantity can be 0.01, 0.12, etc. Default: 3 + * An integer between 0 and 5 that represents the maximum number of positions allowed after the decimal in number custom attribute values For example: - if the precision is 0, the quantity can be 1, 2, 3, etc. - if the precision is 1, the quantity can be 0.1, 0.2, etc. - if the precision is 2, the quantity can be 0.01, 0.12, etc. Default: 5 * @member {Number} precision */ exports.prototype['precision'] = undefined; diff --git a/src/model/CatalogObject.js b/src/model/CatalogObject.js index 78bae69..fabd30c 100644 --- a/src/model/CatalogObject.js +++ b/src/model/CatalogObject.js @@ -41,7 +41,7 @@ var CatalogV1Id = require('./CatalogV1Id'); /** * Constructs a new CatalogObject. - * 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` object. - if type = `ITEM_VARIATION`, only `item_variation_data` will be populated and it will contain a valid `CatalogItemVariation` object. - if type = `MODIFIER`, only `modifier_data` will be populated and it will contain a valid `CatalogModifier` object. - if type = `MODIFIER_LIST`, only `modifier_list_data` will be populated and it will contain a valid `CatalogModifierList` object. - if type = `CATEGORY`, only `category_data` will be populated and it will contain a valid `CatalogCategory` object. - if type = `DISCOUNT`, only `discount_data` will be populated and it will contain a valid `CatalogDiscount` object. - if type = `TAX`, only `tax_data` will be populated and it will contain a valid `CatalogTax` object. - if type = `IMAGE`, only `image_data` will be populated and it will contain a valid `CatalogImage` object. - if type = `QUICK_AMOUNTS_SETTINGS`, only `quick_amounts_settings_data` will be populated and will contain a valid `CatalogQuickAmountsSettings` object. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/catalog-api/design-a-catalog) guide. + * The wrapper object for the Catalog entries of a given object type. The type of a particular `CatalogObject` is determined by the value of the `type` attribute and only the corresponding data attribute can be set on the `CatalogObject` instance. For example, the following list shows some instances of `CatalogObject` of a given `type` and their corresponding data atrribute that can be set: - For a `CatalogObject` of the `ITEM` type, set the `item_data` attribute to yield the `CatalogItem` object. - For a `CatalogObject` of the `ITEM_VARIATION` type, set the `item_variation_data` attribute to yield the `CatalogItemVariation` object. - For a 'CatalogObject' of the `MODIFIER` type, set the `modifier_data` attribute to yield the `CatalogModifier` object. - For a 'CatalogObject' of the `MODIFIER_LIST` type, set the `modifier_list_data` attribute to yield the `CatalogModifierList` object. - For a 'CatalogObject' of the `CATEGORY` type, set the `category_data` attribute to yield the `CatalogCategory` object. - For a 'CatalogObject' of the `DISCOUNT` type, set the `discount_data` attribute to yield the `CatalogDiscount` object. - For a 'CatalogObject' of the `TAX` type, set the `tax_data` attribute to yield the `CatalogTax` object. - For a 'CatalogObject' of the `IMAGE` type, set the `image_data` attribute to yield the `CatalogImageData` object. - For a 'CatalogObject' of the `QUICK_AMOUNTS_SETTINGS` type, set the `quick_amounts_settings_data` attribute to yield the `CatalogQuickAmountsSettings` object. - For a 'CatalogObject' of the `PRICING_RULE` type, set the `pricing_rule_data` attribute to yield the `CatalogPricingRule` object. - For a 'CatalogObject' of the `TIME_PERIOD` type, set the `time_period_data` attribute to yield the `CatalogTimePeriod` object. - For a 'CatalogObject' of the `PRODUCT_SET` type, set the `product_set_data` attribute to yield the `CatalogProductSet` object. For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/catalog-api/design-a-catalog) guide. * @alias module:model/CatalogObject * @class * @param 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 possible values @@ -201,7 +201,7 @@ exports.prototype['version'] = undefined; */ exports.prototype['is_deleted'] = undefined; /** - * Application-defined key/value attributes that are set at a global (location-independent) level. Custom Attribute Values are intended to store additional information about a Catalog Object or associations with an entity in another system. Do not use custom attributes to store any sensitive information (personally identifiable information, card details, etc.). For CustomAttributesDefinitions defined by the app making the request, the map key is the key defined in the `CatalogCustomAttributeDefinition` (e.g. “reference_id”). For custom attributes created by other apps, the map key is the key defined in `CatalogCustomAttributeDefinition` prefixed with the application ID and a colon (eg. “abcd1234:reference_id”). + * A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair is a `CatalogCustomAttributeValue` object. The key is the `key` attribute value defined in the associated `CatalogCustomAttributeDefinition` object defined by the application making the request. If the `CatalogCustomAttributeDefinition` object is defined by another application, the `CatalogCustomAttributeDefinition`'s key attribute value is prefixed by the defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of \"cocoa_brand\" and the defining application ID is \"abcd1234\", the key in the map is \"abcd1234:cocoa_brand\" if the application making the request is different from the application defining the custom attribute definition. Otherwise, the key used in the map is simply \"cocoa-brand\". Application-defined custom attributes that are set at a global (location-independent) level. Custom attribute values are intended to store additional information about a catalog object or associations with an entity in another system. Do not use custom attributes to store any sensitive information (personally identifiable information, card details, etc.). * @member {Object.} custom_attribute_values */ exports.prototype['custom_attribute_values'] = undefined; @@ -276,7 +276,7 @@ exports.prototype['time_period_data'] = undefined; */ exports.prototype['product_set_data'] = undefined; /** - * Structured data for a `CatalogPricingRule`, set for CatalogObjects of type `PRICING_RULE`. + * Structured data for a `CatalogPricingRule`, set for CatalogObjects of type `PRICING_RULE`. A `CatalogPricingRule` object often works with a `CatalogProductSet` object or a `CatalogTimePeriod` object. * @member {module:model/CatalogPricingRule} pricing_rule_data */ exports.prototype['pricing_rule_data'] = undefined; diff --git a/src/model/CatalogPricingRule.js b/src/model/CatalogPricingRule.js index c4ae25e..fa05685 100644 --- a/src/model/CatalogPricingRule.js +++ b/src/model/CatalogPricingRule.js @@ -18,13 +18,12 @@ var ApiClient = require('../ApiClient'); /** * The CatalogPricingRule model module. - * Note: This model is in beta. * @module model/CatalogPricingRule */ /** * Constructs a new CatalogPricingRule. - * Defines how prices are modified or set for items that match the pricing rule during the active time period. + * Defines how discounts are automatically applied to a set of items that match the pricing rule during the active time period. * @alias module:model/CatalogPricingRule * @class */ diff --git a/src/model/CatalogProductSet.js b/src/model/CatalogProductSet.js index 491acd9..5c8632c 100644 --- a/src/model/CatalogProductSet.js +++ b/src/model/CatalogProductSet.js @@ -18,7 +18,6 @@ var ApiClient = require('../ApiClient'); /** * The CatalogProductSet model module. - * Note: This model is in beta. * @module model/CatalogProductSet */ diff --git a/src/model/CatalogQueryCustomAttributeUsage.js b/src/model/CatalogQueryCustomAttributeUsage.js deleted file mode 100644 index f0fa59f..0000000 --- a/src/model/CatalogQueryCustomAttributeUsage.js +++ /dev/null @@ -1,74 +0,0 @@ -/** - * Square Connect API - * Client library for accessing the Square Connect APIs - * - * OpenAPI spec version: 2.0 - * Contact: developers@squareup.com - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * - * Swagger Codegen version: 2.3.0-SNAPSHOT - * - */ -var ApiClient = require('../ApiClient'); - - - - -/** - * The CatalogQueryCustomAttributeUsage model module. - * @module model/CatalogQueryCustomAttributeUsage - */ - -/** - * Constructs a new CatalogQueryCustomAttributeUsage. - * - * @alias module:model/CatalogQueryCustomAttributeUsage - * @class - */ -var exports = function() { - var _this = this; - - - -}; - -/** - * Constructs a CatalogQueryCustomAttributeUsage 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/CatalogQueryCustomAttributeUsage} obj Optional instance to populate. - * @return {module:model/CatalogQueryCustomAttributeUsage} The populated CatalogQueryCustomAttributeUsage instance. - */ -exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('custom_attribute_definition_ids')) { - obj['custom_attribute_definition_ids'] = ApiClient.convertToType(data['custom_attribute_definition_ids'], ['String']); - } - if (data.hasOwnProperty('has_value')) { - obj['has_value'] = ApiClient.convertToType(data['has_value'], 'Boolean'); - } - } - return obj; -} - -/** - * - * @member {Array.} custom_attribute_definition_ids - */ -exports.prototype['custom_attribute_definition_ids'] = undefined; -/** - * - * @member {Boolean} has_value - */ -exports.prototype['has_value'] = undefined; - - - -module.exports = exports; - - - diff --git a/src/model/CatalogQueryFilteredItems.js b/src/model/CatalogQueryFilteredItems.js deleted file mode 100644 index 3e34879..0000000 --- a/src/model/CatalogQueryFilteredItems.js +++ /dev/null @@ -1,147 +0,0 @@ -/** - * Square Connect API - * Client library for accessing the Square Connect APIs - * - * OpenAPI spec version: 2.0 - * Contact: developers@squareup.com - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * - * Swagger Codegen version: 2.3.0-SNAPSHOT - * - */ -var ApiClient = require('../ApiClient'); -var CatalogQueryFilteredItemsCustomAttributeFilter = require('./CatalogQueryFilteredItemsCustomAttributeFilter'); - - - - -/** - * The CatalogQueryFilteredItems model module. - * @module model/CatalogQueryFilteredItems - */ - -/** - * Constructs a new CatalogQueryFilteredItems. - * - * @alias module:model/CatalogQueryFilteredItems - * @class - */ -var exports = function() { - var _this = this; - - - - - - - - - - - -}; - -/** - * Constructs a CatalogQueryFilteredItems 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/CatalogQueryFilteredItems} obj Optional instance to populate. - * @return {module:model/CatalogQueryFilteredItems} The populated CatalogQueryFilteredItems instance. - */ -exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('text_filter')) { - obj['text_filter'] = ApiClient.convertToType(data['text_filter'], 'String'); - } - if (data.hasOwnProperty('search_vendor_code')) { - obj['search_vendor_code'] = ApiClient.convertToType(data['search_vendor_code'], 'Boolean'); - } - if (data.hasOwnProperty('category_ids')) { - obj['category_ids'] = ApiClient.convertToType(data['category_ids'], ['String']); - } - if (data.hasOwnProperty('stock_levels')) { - obj['stock_levels'] = ApiClient.convertToType(data['stock_levels'], ['String']); - } - if (data.hasOwnProperty('enabled_location_ids')) { - obj['enabled_location_ids'] = ApiClient.convertToType(data['enabled_location_ids'], ['String']); - } - if (data.hasOwnProperty('vendor_ids')) { - obj['vendor_ids'] = ApiClient.convertToType(data['vendor_ids'], ['String']); - } - if (data.hasOwnProperty('product_types')) { - obj['product_types'] = ApiClient.convertToType(data['product_types'], ['String']); - } - if (data.hasOwnProperty('custom_attribute_filters')) { - obj['custom_attribute_filters'] = ApiClient.convertToType(data['custom_attribute_filters'], [CatalogQueryFilteredItemsCustomAttributeFilter]); - } - if (data.hasOwnProperty('does_not_exist')) { - obj['does_not_exist'] = ApiClient.convertToType(data['does_not_exist'], ['String']); - } - if (data.hasOwnProperty('sort_order')) { - obj['sort_order'] = ApiClient.convertToType(data['sort_order'], 'String'); - } - } - return obj; -} - -/** - * - * @member {String} text_filter - */ -exports.prototype['text_filter'] = undefined; -/** - * - * @member {Boolean} search_vendor_code - */ -exports.prototype['search_vendor_code'] = undefined; -/** - * - * @member {Array.} category_ids - */ -exports.prototype['category_ids'] = undefined; -/** - * See [CatalogQueryFilteredItemsStockLevel](#type-catalogqueryfiltereditemsstocklevel) for possible values - * @member {Array.} stock_levels - */ -exports.prototype['stock_levels'] = undefined; -/** - * - * @member {Array.} enabled_location_ids - */ -exports.prototype['enabled_location_ids'] = undefined; -/** - * - * @member {Array.} vendor_ids - */ -exports.prototype['vendor_ids'] = undefined; -/** - * See [CatalogItemProductType](#type-catalogitemproducttype) for possible values - * @member {Array.} product_types - */ -exports.prototype['product_types'] = undefined; -/** - * - * @member {Array.} custom_attribute_filters - */ -exports.prototype['custom_attribute_filters'] = undefined; -/** - * See [CatalogQueryFilteredItemsNullableAttribute](#type-catalogqueryfiltereditemsnullableattribute) for possible values - * @member {Array.} does_not_exist - */ -exports.prototype['does_not_exist'] = undefined; -/** - * See [SortOrder](#type-sortorder) for possible values - * @member {String} sort_order - */ -exports.prototype['sort_order'] = undefined; - - - -module.exports = exports; - - - diff --git a/src/model/CatalogQueryFilteredItemsCustomAttributeFilter.js b/src/model/CatalogQueryFilteredItemsCustomAttributeFilter.js deleted file mode 100644 index f87e55e..0000000 --- a/src/model/CatalogQueryFilteredItemsCustomAttributeFilter.js +++ /dev/null @@ -1,110 +0,0 @@ -/** - * Square Connect API - * Client library for accessing the Square Connect APIs - * - * OpenAPI spec version: 2.0 - * Contact: developers@squareup.com - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * - * Swagger Codegen version: 2.3.0-SNAPSHOT - * - */ -var ApiClient = require('../ApiClient'); - - - - -/** - * The CatalogQueryFilteredItemsCustomAttributeFilter model module. - * @module model/CatalogQueryFilteredItemsCustomAttributeFilter - */ - -/** - * Constructs a new CatalogQueryFilteredItemsCustomAttributeFilter. - * - * @alias module:model/CatalogQueryFilteredItemsCustomAttributeFilter - * @class - */ -var exports = function() { - var _this = this; - - - - - - - -}; - -/** - * Constructs a CatalogQueryFilteredItemsCustomAttributeFilter 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/CatalogQueryFilteredItemsCustomAttributeFilter} obj Optional instance to populate. - * @return {module:model/CatalogQueryFilteredItemsCustomAttributeFilter} The populated CatalogQueryFilteredItemsCustomAttributeFilter instance. - */ -exports.constructFromObject = function(data, obj) { - if (data) { - obj = obj || new exports(); - - if (data.hasOwnProperty('filter_type')) { - obj['filter_type'] = ApiClient.convertToType(data['filter_type'], 'String'); - } - if (data.hasOwnProperty('custom_attribute_definition_ids')) { - obj['custom_attribute_definition_ids'] = ApiClient.convertToType(data['custom_attribute_definition_ids'], ['String']); - } - if (data.hasOwnProperty('custom_attribute_value_exact')) { - obj['custom_attribute_value_exact'] = ApiClient.convertToType(data['custom_attribute_value_exact'], 'String'); - } - if (data.hasOwnProperty('custom_attribute_value_prefix')) { - obj['custom_attribute_value_prefix'] = ApiClient.convertToType(data['custom_attribute_value_prefix'], 'String'); - } - if (data.hasOwnProperty('custom_attribute_min_value')) { - obj['custom_attribute_min_value'] = ApiClient.convertToType(data['custom_attribute_min_value'], 'String'); - } - if (data.hasOwnProperty('custom_attribute_max_value')) { - obj['custom_attribute_max_value'] = ApiClient.convertToType(data['custom_attribute_max_value'], 'String'); - } - } - return obj; -} - -/** - * See [CatalogQueryFilteredItemsCustomAttributeFilterFilterType](#type-catalogqueryfiltereditemscustomattributefilterfiltertype) for possible values - * @member {String} filter_type - */ -exports.prototype['filter_type'] = undefined; -/** - * - * @member {Array.} custom_attribute_definition_ids - */ -exports.prototype['custom_attribute_definition_ids'] = undefined; -/** - * - * @member {String} custom_attribute_value_exact - */ -exports.prototype['custom_attribute_value_exact'] = undefined; -/** - * - * @member {String} custom_attribute_value_prefix - */ -exports.prototype['custom_attribute_value_prefix'] = undefined; -/** - * - * @member {String} custom_attribute_min_value - */ -exports.prototype['custom_attribute_min_value'] = undefined; -/** - * - * @member {String} custom_attribute_max_value - */ -exports.prototype['custom_attribute_max_value'] = undefined; - - - -module.exports = exports; - - - diff --git a/src/model/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.js b/src/model/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.js deleted file mode 100644 index 23e5df5..0000000 --- a/src/model/CatalogQueryFilteredItemsCustomAttributeFilterFilterType.js +++ /dev/null @@ -1,55 +0,0 @@ -/** - * Square Connect API - * Client library for accessing the Square Connect APIs - * - * OpenAPI spec version: 2.0 - * Contact: developers@squareup.com - * - * NOTE: This class is auto generated by the swagger code generator program. - * https://github.com/swagger-api/swagger-codegen.git - * - * Swagger Codegen version: 2.3.0-SNAPSHOT - * - */ -var ApiClient = require('../ApiClient'); - - -/** - * Enum class CatalogQueryFilteredItemsCustomAttributeFilterFilterType. - * @enum {} - * @readonly - */ -var exports = { - /** - * value: "CUSTOM_ATTRIBUTE_FILTER_TYPE_DO_NOT_USE" - * @const - */ - "CUSTOM_ATTRIBUTE_FILTER_TYPE_DO_NOT_USE": "CUSTOM_ATTRIBUTE_FILTER_TYPE_DO_NOT_USE", - /** - * value: "EXACT" - * @const - */ - "EXACT": "EXACT", - /** - * value: "PREFIX" - * @const - */ - "PREFIX": "PREFIX", - /** - * value: "RANGE" - * @const - */ - "RANGE": "RANGE"}; - -/** - * Returns a CatalogQueryFilteredItemsCustomAttributeFilterFilterType enum value from a Javascript object name. - * @param {Object} data The plain JavaScript object containing the name of the enum value. - * @return {module:model/CatalogQueryFilteredItemsCustomAttributeFilterFilterType} The enum CatalogQueryFilteredItemsCustomAttributeFilterFilterType value. - */ -exports.constructFromObject = function(object) { - return object; -} - -module.exports = exports; - - diff --git a/src/model/CatalogTimePeriod.js b/src/model/CatalogTimePeriod.js index d7521ea..5db6cab 100644 --- a/src/model/CatalogTimePeriod.js +++ b/src/model/CatalogTimePeriod.js @@ -18,7 +18,6 @@ var ApiClient = require('../ApiClient'); /** * The CatalogTimePeriod model module. - * Note: This model is in beta. * @module model/CatalogTimePeriod */ diff --git a/src/model/CreateTeamMemberRequest.js b/src/model/CreateTeamMemberRequest.js new file mode 100644 index 0000000..df8d9e7 --- /dev/null +++ b/src/model/CreateTeamMemberRequest.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 TeamMember = require('./TeamMember'); + + + + +/** + * The CreateTeamMemberRequest model module. + * @module model/CreateTeamMemberRequest + */ + +/** + * Constructs a new CreateTeamMemberRequest. + * Represents a create request for a `TeamMember` object. + * @alias module:model/CreateTeamMemberRequest + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a CreateTeamMemberRequest 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/CreateTeamMemberRequest} obj Optional instance to populate. + * @return {module:model/CreateTeamMemberRequest} The populated CreateTeamMemberRequest 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('team_member')) { + obj['team_member'] = TeamMember.constructFromObject(data['team_member']); + } + } + return obj; +} + +/** + * A unique string that identifies this CreateTeamMember request. Keys can be any valid string but must be unique for every request. See [Idempotency keys](https://developer.squareup.com/docs/basics/api101/idempotency) for more information.
Min Length 1 Max Length 45 + * @member {String} idempotency_key + */ +exports.prototype['idempotency_key'] = undefined; +/** + * Required The data which will be used to create the `TeamMember` object. + * @member {module:model/TeamMember} team_member + */ +exports.prototype['team_member'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/CreateTeamMemberResponse.js b/src/model/CreateTeamMemberResponse.js new file mode 100644 index 0000000..c9f6f81 --- /dev/null +++ b/src/model/CreateTeamMemberResponse.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 TeamMember = require('./TeamMember'); + + + + +/** + * The CreateTeamMemberResponse model module. + * @module model/CreateTeamMemberResponse + */ + +/** + * Constructs a new CreateTeamMemberResponse. + * Represents a response from a create request, containing the created `TeamMember` object or error messages. + * @alias module:model/CreateTeamMemberResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a CreateTeamMemberResponse 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/CreateTeamMemberResponse} obj Optional instance to populate. + * @return {module:model/CreateTeamMemberResponse} The populated CreateTeamMemberResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('team_member')) { + obj['team_member'] = TeamMember.constructFromObject(data['team_member']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The successfully created `TeamMember` object. + * @member {module:model/TeamMember} team_member + */ +exports.prototype['team_member'] = undefined; +/** + * The errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/ErrorCode.js b/src/model/ErrorCode.js index dec18fa..3071781 100644 --- a/src/model/ErrorCode.js +++ b/src/model/ErrorCode.js @@ -235,6 +235,11 @@ var exports = { * @const */ "INVALID_FORM_VALUE": "INVALID_FORM_VALUE", + /** + * value: "CUSTOMER_NOT_FOUND" + * @const + */ + "CUSTOMER_NOT_FOUND": "CUSTOMER_NOT_FOUND", /** * value: "ONE_INSTRUMENT_EXPECTED" * @const diff --git a/src/model/JobAssignment.js b/src/model/JobAssignment.js new file mode 100644 index 0000000..2264b60 --- /dev/null +++ b/src/model/JobAssignment.js @@ -0,0 +1,104 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class 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 JobAssignment model module. + * @module model/JobAssignment + */ + +/** + * Constructs a new JobAssignment. + * An object describing a job that a team member is assigned to. + * @alias module:model/JobAssignment + * @class + * @param jobTitle {String} The title of the job. + * @param payType {String} The current pay type for the job assignment used to calculate the pay amount in a pay period. See [JobAssignmentPayType](#type-jobassignmentpaytype) for possible values + */ +var exports = function(jobTitle, payType) { + var _this = this; + + _this['job_title'] = jobTitle; + _this['pay_type'] = payType; + + + +}; + +/** + * Constructs a JobAssignment 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/JobAssignment} obj Optional instance to populate. + * @return {module:model/JobAssignment} The populated JobAssignment instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('job_title')) { + obj['job_title'] = ApiClient.convertToType(data['job_title'], 'String'); + } + if (data.hasOwnProperty('pay_type')) { + obj['pay_type'] = ApiClient.convertToType(data['pay_type'], 'String'); + } + if (data.hasOwnProperty('hourly_rate')) { + obj['hourly_rate'] = Money.constructFromObject(data['hourly_rate']); + } + if (data.hasOwnProperty('annual_rate')) { + obj['annual_rate'] = Money.constructFromObject(data['annual_rate']); + } + if (data.hasOwnProperty('weekly_hours')) { + obj['weekly_hours'] = ApiClient.convertToType(data['weekly_hours'], 'Number'); + } + } + return obj; +} + +/** + * The title of the job. + * @member {String} job_title + */ +exports.prototype['job_title'] = undefined; +/** + * The current pay type for the job assignment used to calculate the pay amount in a pay period. See [JobAssignmentPayType](#type-jobassignmentpaytype) for possible values + * @member {String} pay_type + */ +exports.prototype['pay_type'] = undefined; +/** + * The hourly pay rate of the job. + * @member {module:model/Money} hourly_rate + */ +exports.prototype['hourly_rate'] = undefined; +/** + * The total pay amount for a 12 month period on the job. Set if the job `PayType` is `SALARY`. + * @member {module:model/Money} annual_rate + */ +exports.prototype['annual_rate'] = undefined; +/** + * The planned hours per week for the job. Set if the job `PayType` is `SALARY`. + * @member {Number} weekly_hours + */ +exports.prototype['weekly_hours'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/CatalogQueryFilteredItemsNullableAttribute.js b/src/model/JobAssignmentPayType.js similarity index 62% rename from src/model/CatalogQueryFilteredItemsNullableAttribute.js rename to src/model/JobAssignmentPayType.js index 74c65de..cf43f30 100644 --- a/src/model/CatalogQueryFilteredItemsNullableAttribute.js +++ b/src/model/JobAssignmentPayType.js @@ -15,21 +15,31 @@ var ApiClient = require('../ApiClient'); /** - * Enum class CatalogQueryFilteredItemsNullableAttribute. + * Enum class JobAssignmentPayType. * @enum {} * @readonly */ var exports = { /** - * value: "VENDOR_TOKEN" + * value: "NONE" * @const */ - "TOKEN": "VENDOR_TOKEN"}; + "NONE": "NONE", + /** + * value: "HOURLY" + * @const + */ + "HOURLY": "HOURLY", + /** + * value: "SALARY" + * @const + */ + "SALARY": "SALARY"}; /** - * Returns a CatalogQueryFilteredItemsNullableAttribute enum value from a Javascript object name. + * Returns a JobAssignmentPayType enum value from a Javascript object name. * @param {Object} data The plain JavaScript object containing the name of the enum value. - * @return {module:model/CatalogQueryFilteredItemsNullableAttribute} The enum CatalogQueryFilteredItemsNullableAttribute value. + * @return {module:model/JobAssignmentPayType} The enum JobAssignmentPayType value. */ exports.constructFromObject = function(object) { return object; diff --git a/src/model/ListPaymentRefundsRequest.js b/src/model/ListPaymentRefundsRequest.js index 10c340f..0edd9a4 100644 --- a/src/model/ListPaymentRefundsRequest.js +++ b/src/model/ListPaymentRefundsRequest.js @@ -96,7 +96,7 @@ exports.prototype['sort_order'] = undefined; */ exports.prototype['cursor'] = undefined; /** - * ID of location associated with payment. + * Limit results to the location supplied. By default, results are returned for all locations associated with the merchant. * @member {String} location_id */ exports.prototype['location_id'] = undefined; diff --git a/src/model/Refund.js b/src/model/Refund.js index a5839ac..5cbe57e 100644 --- a/src/model/Refund.js +++ b/src/model/Refund.js @@ -117,7 +117,7 @@ exports.prototype['transaction_id'] = undefined; */ exports.prototype['tender_id'] = undefined; /** - * The time when the refund was created, in RFC 3339 format. + * The timestamp for when the refund was created, in RFC 3339 format. * @member {String} created_at */ exports.prototype['created_at'] = undefined; diff --git a/src/model/RefundPaymentRequest.js b/src/model/RefundPaymentRequest.js index 0c8d998..00d7148 100644 --- a/src/model/RefundPaymentRequest.js +++ b/src/model/RefundPaymentRequest.js @@ -27,7 +27,7 @@ var Money = require('./Money'); * Refunds a payment. * @alias module:model/RefundPaymentRequest * @class - * @param idempotencyKey {String} A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency). + * @param idempotencyKey {String} A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency). * @param amountMoney {module:model/Money} The amount of money to refund. Cannot be more than the `total_money` value of the payment minus the total amount of all previously completed refunds for this payment. Must be specified in the smallest denomination of the applicable currency. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The currency code must match the currency associated with the business that is charging the card. * @param paymentId {String} Unique ID of the payment being refunded. */ @@ -72,7 +72,7 @@ exports.constructFromObject = function(data, obj) { } /** - * A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency). + * A unique string that identifies this RefundPayment request. Key can be any valid string but must be unique for every RefundPayment request. For more information, see [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency). * @member {String} idempotency_key */ exports.prototype['idempotency_key'] = undefined; diff --git a/src/model/RetrieveTeamMemberRequest.js b/src/model/RetrieveTeamMemberRequest.js new file mode 100644 index 0000000..e0fdc53 --- /dev/null +++ b/src/model/RetrieveTeamMemberRequest.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 RetrieveTeamMemberRequest model module. + * @module model/RetrieveTeamMemberRequest + */ + +/** + * Constructs a new RetrieveTeamMemberRequest. + * Represents a retrieve request for a `TeamMember` object. + * @alias module:model/RetrieveTeamMemberRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a RetrieveTeamMemberRequest 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/RetrieveTeamMemberRequest} obj Optional instance to populate. + * @return {module:model/RetrieveTeamMemberRequest} The populated RetrieveTeamMemberRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/RetrieveTeamMemberResponse.js b/src/model/RetrieveTeamMemberResponse.js new file mode 100644 index 0000000..fdcd649 --- /dev/null +++ b/src/model/RetrieveTeamMemberResponse.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 TeamMember = require('./TeamMember'); + + + + +/** + * The RetrieveTeamMemberResponse model module. + * @module model/RetrieveTeamMemberResponse + */ + +/** + * Constructs a new RetrieveTeamMemberResponse. + * Represents a response from a retrieve request, containing a `TeamMember` object or error messages. + * @alias module:model/RetrieveTeamMemberResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a RetrieveTeamMemberResponse 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/RetrieveTeamMemberResponse} obj Optional instance to populate. + * @return {module:model/RetrieveTeamMemberResponse} The populated RetrieveTeamMemberResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('team_member')) { + obj['team_member'] = TeamMember.constructFromObject(data['team_member']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The successfully retrieved `TeamMember` object. + * @member {module:model/TeamMember} team_member + */ +exports.prototype['team_member'] = undefined; +/** + * The errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/RetrieveWageSettingRequest.js b/src/model/RetrieveWageSettingRequest.js new file mode 100644 index 0000000..5fb7370 --- /dev/null +++ b/src/model/RetrieveWageSettingRequest.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 RetrieveWageSettingRequest model module. + * @module model/RetrieveWageSettingRequest + */ + +/** + * Constructs a new RetrieveWageSettingRequest. + * Represents a retrieve request for the wage setting of a team member + * @alias module:model/RetrieveWageSettingRequest + * @class + */ +var exports = function() { + var _this = this; + +}; + +/** + * Constructs a RetrieveWageSettingRequest 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/RetrieveWageSettingRequest} obj Optional instance to populate. + * @return {module:model/RetrieveWageSettingRequest} The populated RetrieveWageSettingRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + } + return obj; +} + + + + +module.exports = exports; + + + diff --git a/src/model/RetrieveWageSettingResponse.js b/src/model/RetrieveWageSettingResponse.js new file mode 100644 index 0000000..1d96936 --- /dev/null +++ b/src/model/RetrieveWageSettingResponse.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 WageSetting = require('./WageSetting'); + + + + +/** + * The RetrieveWageSettingResponse model module. + * @module model/RetrieveWageSettingResponse + */ + +/** + * Constructs a new RetrieveWageSettingResponse. + * Represents a response from a retrieve request, containing the specified `WageSetting` object or error messages. + * @alias module:model/RetrieveWageSettingResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a RetrieveWageSettingResponse 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/RetrieveWageSettingResponse} obj Optional instance to populate. + * @return {module:model/RetrieveWageSettingResponse} The populated RetrieveWageSettingResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('wage_setting')) { + obj['wage_setting'] = WageSetting.constructFromObject(data['wage_setting']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The successfully retrieved `WageSetting` object. + * @member {module:model/WageSetting} wage_setting + */ +exports.prototype['wage_setting'] = undefined; +/** + * The errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/SearchTeamMembersFilter.js b/src/model/SearchTeamMembersFilter.js new file mode 100644 index 0000000..557fa6c --- /dev/null +++ b/src/model/SearchTeamMembersFilter.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 SearchTeamMembersFilter model module. + * @module model/SearchTeamMembersFilter + */ + +/** + * Constructs a new SearchTeamMembersFilter. + * Represents a filter used in a search for `TeamMember` objects. `AND` logic is applied between the individual fields, and `OR` logic is applied within list-based fields. For example, setting this filter value, ``` filter = (locations_ids = [\"A\", \"B\"], status = ACTIVE) ``` returns only active team members assigned to either location \"A\" or \"B\". + * @alias module:model/SearchTeamMembersFilter + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a SearchTeamMembersFilter 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/SearchTeamMembersFilter} obj Optional instance to populate. + * @return {module:model/SearchTeamMembersFilter} The populated SearchTeamMembersFilter instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + 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'); + } + } + return obj; +} + +/** + * When present, filter by team members assigned to the specified locations. When empty, include team members assigned to any location. + * @member {Array.} location_ids + */ +exports.prototype['location_ids'] = undefined; +/** + * When present, filter by team members who match the given status. When empty, include team members of all statuses. See [TeamMemberStatus](#type-teammemberstatus) for possible values + * @member {String} status + */ +exports.prototype['status'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/SearchTeamMembersQuery.js b/src/model/SearchTeamMembersQuery.js new file mode 100644 index 0000000..6e72d83 --- /dev/null +++ b/src/model/SearchTeamMembersQuery.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 SearchTeamMembersFilter = require('./SearchTeamMembersFilter'); + + + + +/** + * The SearchTeamMembersQuery model module. + * @module model/SearchTeamMembersQuery + */ + +/** + * Constructs a new SearchTeamMembersQuery. + * Represents the parameters in a search for `TeamMember` objects. + * @alias module:model/SearchTeamMembersQuery + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a SearchTeamMembersQuery 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/SearchTeamMembersQuery} obj Optional instance to populate. + * @return {module:model/SearchTeamMembersQuery} The populated SearchTeamMembersQuery instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('filter')) { + obj['filter'] = SearchTeamMembersFilter.constructFromObject(data['filter']); + } + } + return obj; +} + +/** + * The options to filter by. + * @member {module:model/SearchTeamMembersFilter} filter + */ +exports.prototype['filter'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/SearchTeamMembersRequest.js b/src/model/SearchTeamMembersRequest.js new file mode 100644 index 0000000..864827e --- /dev/null +++ b/src/model/SearchTeamMembersRequest.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 SearchTeamMembersQuery = require('./SearchTeamMembersQuery'); + + + + +/** + * The SearchTeamMembersRequest model module. + * @module model/SearchTeamMembersRequest + */ + +/** + * Constructs a new SearchTeamMembersRequest. + * Represents a search request for a filtered list of `TeamMember` objects. + * @alias module:model/SearchTeamMembersRequest + * @class + */ +var exports = function() { + var _this = this; + + + + +}; + +/** + * Constructs a SearchTeamMembersRequest 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/SearchTeamMembersRequest} obj Optional instance to populate. + * @return {module:model/SearchTeamMembersRequest} The populated SearchTeamMembersRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('query')) { + obj['query'] = SearchTeamMembersQuery.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; +} + +/** + * The query parameters. + * @member {module:model/SearchTeamMembersQuery} query + */ +exports.prototype['query'] = undefined; +/** + * The maximum number of `TeamMember` objects in a page (25 by default). + * @member {Number} limit + */ +exports.prototype['limit'] = undefined; +/** + * The opaque cursor for fetching the next page. Read about [pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) with Square APIs for more information. + * @member {String} cursor + */ +exports.prototype['cursor'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/SearchTeamMembersResponse.js b/src/model/SearchTeamMembersResponse.js new file mode 100644 index 0000000..b21c7bd --- /dev/null +++ b/src/model/SearchTeamMembersResponse.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 TeamMember = require('./TeamMember'); + + + + +/** + * The SearchTeamMembersResponse model module. + * @module model/SearchTeamMembersResponse + */ + +/** + * Constructs a new SearchTeamMembersResponse. + * Represents a response from a search request, containing a filtered list of `TeamMember` objects. + * @alias module:model/SearchTeamMembersResponse + * @class + */ +var exports = function() { + var _this = this; + + + + +}; + +/** + * Constructs a SearchTeamMembersResponse 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/SearchTeamMembersResponse} obj Optional instance to populate. + * @return {module:model/SearchTeamMembersResponse} The populated SearchTeamMembersResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('team_members')) { + obj['team_members'] = ApiClient.convertToType(data['team_members'], [TeamMember]); + } + if (data.hasOwnProperty('cursor')) { + obj['cursor'] = ApiClient.convertToType(data['cursor'], 'String'); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The filtered list of `TeamMember` objects. + * @member {Array.} team_members + */ +exports.prototype['team_members'] = undefined; +/** + * The opaque cursor for fetching the next page. Read about [pagination](https://developer.squareup.com/docs/docs/working-with-apis/pagination) with Square APIs for more information. + * @member {String} cursor + */ +exports.prototype['cursor'] = undefined; +/** + * The errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/TeamMember.js b/src/model/TeamMember.js new file mode 100644 index 0000000..e8965b7 --- /dev/null +++ b/src/model/TeamMember.js @@ -0,0 +1,156 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class 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 TeamMemberAssignedLocations = require('./TeamMemberAssignedLocations'); + + + + +/** + * The TeamMember model module. + * @module model/TeamMember + */ + +/** + * Constructs a new TeamMember. + * A record representing an individual team member for a business. + * @alias module:model/TeamMember + * @class + */ +var exports = function() { + var _this = this; + + + + + + + + + + + + +}; + +/** + * Constructs a TeamMember 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/TeamMember} obj Optional instance to populate. + * @return {module:model/TeamMember} The populated TeamMember 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('reference_id')) { + obj['reference_id'] = ApiClient.convertToType(data['reference_id'], 'String'); + } + if (data.hasOwnProperty('is_owner')) { + obj['is_owner'] = ApiClient.convertToType(data['is_owner'], 'Boolean'); + } + if (data.hasOwnProperty('status')) { + obj['status'] = ApiClient.convertToType(data['status'], 'String'); + } + if (data.hasOwnProperty('given_name')) { + obj['given_name'] = ApiClient.convertToType(data['given_name'], 'String'); + } + if (data.hasOwnProperty('family_name')) { + obj['family_name'] = ApiClient.convertToType(data['family_name'], 'String'); + } + if (data.hasOwnProperty('email_address')) { + obj['email_address'] = ApiClient.convertToType(data['email_address'], 'String'); + } + if (data.hasOwnProperty('phone_number')) { + obj['phone_number'] = ApiClient.convertToType(data['phone_number'], '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'); + } + if (data.hasOwnProperty('assigned_locations')) { + obj['assigned_locations'] = TeamMemberAssignedLocations.constructFromObject(data['assigned_locations']); + } + } + return obj; +} + +/** + * The unique ID for the team member. + * @member {String} id + */ +exports.prototype['id'] = undefined; +/** + * A second ID used to associate the team member with an entity in another system. + * @member {String} reference_id + */ +exports.prototype['reference_id'] = undefined; +/** + * Whether the team member is the owner of the Square account. + * @member {Boolean} is_owner + */ +exports.prototype['is_owner'] = undefined; +/** + * Describes the status of the team member. See [TeamMemberStatus](#type-teammemberstatus) for possible values + * @member {String} status + */ +exports.prototype['status'] = undefined; +/** + * The given (i.e., first) name associated with the team member. + * @member {String} given_name + */ +exports.prototype['given_name'] = undefined; +/** + * The family (i.e., last) name associated with the team member. + * @member {String} family_name + */ +exports.prototype['family_name'] = undefined; +/** + * The email address associated with the team member. + * @member {String} email_address + */ +exports.prototype['email_address'] = undefined; +/** + * The team member's phone number in E.164 format. Examples: +14155552671 - the country code is 1 for US +551155256325 - the country code is 55 for BR + * @member {String} phone_number + */ +exports.prototype['phone_number'] = undefined; +/** + * The timestamp in RFC 3339 format describing when the team member was created. Ex: \"2018-10-04T04:00:00-07:00\" or \"2019-02-05T12:00:00Z\" + * @member {String} created_at + */ +exports.prototype['created_at'] = undefined; +/** + * The timestamp in RFC 3339 format describing when the team member was last updated. Ex: \"2018-10-04T04:00:00-07:00\" or \"2019-02-05T12:00:00Z\" + * @member {String} updated_at + */ +exports.prototype['updated_at'] = undefined; +/** + * Describes the team member's assigned locations. + * @member {module:model/TeamMemberAssignedLocations} assigned_locations + */ +exports.prototype['assigned_locations'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/TeamMemberAssignedLocations.js b/src/model/TeamMemberAssignedLocations.js new file mode 100644 index 0000000..1bbe2ae --- /dev/null +++ b/src/model/TeamMemberAssignedLocations.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 TeamMemberAssignedLocations model module. + * @module model/TeamMemberAssignedLocations + */ + +/** + * Constructs a new TeamMemberAssignedLocations. + * An object that represents a team member's assignment to locations. + * @alias module:model/TeamMemberAssignedLocations + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a TeamMemberAssignedLocations 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/TeamMemberAssignedLocations} obj Optional instance to populate. + * @return {module:model/TeamMemberAssignedLocations} The populated TeamMemberAssignedLocations instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('assignment_type')) { + obj['assignment_type'] = ApiClient.convertToType(data['assignment_type'], 'String'); + } + if (data.hasOwnProperty('location_ids')) { + obj['location_ids'] = ApiClient.convertToType(data['location_ids'], ['String']); + } + } + return obj; +} + +/** + * The current assignment type of the team member. See [TeamMemberAssignedLocationsAssignmentType](#type-teammemberassignedlocationsassignmenttype) for possible values + * @member {String} assignment_type + */ +exports.prototype['assignment_type'] = undefined; +/** + * The locations that the team member is assigned to. + * @member {Array.} location_ids + */ +exports.prototype['location_ids'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/TeamMemberAssignedLocationsAssignmentType.js b/src/model/TeamMemberAssignedLocationsAssignmentType.js new file mode 100644 index 0000000..eeda3e7 --- /dev/null +++ b/src/model/TeamMemberAssignedLocationsAssignmentType.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 TeamMemberAssignedLocationsAssignmentType. + * @enum {} + * @readonly + */ +var exports = { + /** + * value: "ALL_CURRENT_AND_FUTURE_LOCATIONS" + * @const + */ + "ALL_CURRENT_AND_FUTURE_LOCATIONS": "ALL_CURRENT_AND_FUTURE_LOCATIONS", + /** + * value: "EXPLICIT_LOCATIONS" + * @const + */ + "EXPLICIT_LOCATIONS": "EXPLICIT_LOCATIONS"}; + +/** + * Returns a TeamMemberAssignedLocationsAssignmentType enum value from a Javascript object name. + * @param {Object} data The plain JavaScript object containing the name of the enum value. + * @return {module:model/TeamMemberAssignedLocationsAssignmentType} The enum TeamMemberAssignedLocationsAssignmentType value. + */ +exports.constructFromObject = function(object) { + return object; +} + +module.exports = exports; + + diff --git a/src/model/CatalogQueryFilteredItemsStockLevel.js b/src/model/TeamMemberStatus.js similarity index 65% rename from src/model/CatalogQueryFilteredItemsStockLevel.js rename to src/model/TeamMemberStatus.js index 9d8beb7..21c7377 100644 --- a/src/model/CatalogQueryFilteredItemsStockLevel.js +++ b/src/model/TeamMemberStatus.js @@ -15,26 +15,26 @@ var ApiClient = require('../ApiClient'); /** - * Enum class CatalogQueryFilteredItemsStockLevel. + * Enum class TeamMemberStatus. * @enum {} * @readonly */ var exports = { /** - * value: "OUT" + * value: "ACTIVE" * @const */ - "OUT": "OUT", + "ACTIVE": "ACTIVE", /** - * value: "LOW" + * value: "INACTIVE" * @const */ - "LOW": "LOW"}; + "INACTIVE": "INACTIVE"}; /** - * Returns a CatalogQueryFilteredItemsStockLevel enum value from a Javascript object name. + * Returns a TeamMemberStatus enum value from a Javascript object name. * @param {Object} data The plain JavaScript object containing the name of the enum value. - * @return {module:model/CatalogQueryFilteredItemsStockLevel} The enum CatalogQueryFilteredItemsStockLevel value. + * @return {module:model/TeamMemberStatus} The enum TeamMemberStatus value. */ exports.constructFromObject = function(object) { return object; diff --git a/src/model/Tender.js b/src/model/Tender.js index 9032824..b4b5054 100644 --- a/src/model/Tender.js +++ b/src/model/Tender.js @@ -124,7 +124,7 @@ exports.prototype['location_id'] = undefined; */ exports.prototype['transaction_id'] = undefined; /** - * The time when the tender was created, in RFC 3339 format. + * The timestamp for when the tender was created, in RFC 3339 format. * @member {String} created_at */ exports.prototype['created_at'] = undefined; diff --git a/src/model/Transaction.js b/src/model/Transaction.js index 880a18b..38c0a7f 100644 --- a/src/model/Transaction.js +++ b/src/model/Transaction.js @@ -102,7 +102,7 @@ exports.prototype['id'] = undefined; */ exports.prototype['location_id'] = undefined; /** - * The time when the transaction was created, in RFC 3339 format. + * The timestamp for when the transaction was created, in RFC 3339 format. * @member {String} created_at */ exports.prototype['created_at'] = undefined; diff --git a/src/model/UpdateTeamMemberRequest.js b/src/model/UpdateTeamMemberRequest.js new file mode 100644 index 0000000..c79034c --- /dev/null +++ b/src/model/UpdateTeamMemberRequest.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 TeamMember = require('./TeamMember'); + + + + +/** + * The UpdateTeamMemberRequest model module. + * @module model/UpdateTeamMemberRequest + */ + +/** + * Constructs a new UpdateTeamMemberRequest. + * Represents an update request for a `TeamMember` object. + * @alias module:model/UpdateTeamMemberRequest + * @class + */ +var exports = function() { + var _this = this; + + +}; + +/** + * Constructs a UpdateTeamMemberRequest 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/UpdateTeamMemberRequest} obj Optional instance to populate. + * @return {module:model/UpdateTeamMemberRequest} The populated UpdateTeamMemberRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('team_member')) { + obj['team_member'] = TeamMember.constructFromObject(data['team_member']); + } + } + return obj; +} + +/** + * The data which will be used to update the `TeamMember` object. + * @member {module:model/TeamMember} team_member + */ +exports.prototype['team_member'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/UpdateTeamMemberResponse.js b/src/model/UpdateTeamMemberResponse.js new file mode 100644 index 0000000..5961255 --- /dev/null +++ b/src/model/UpdateTeamMemberResponse.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 TeamMember = require('./TeamMember'); + + + + +/** + * The UpdateTeamMemberResponse model module. + * @module model/UpdateTeamMemberResponse + */ + +/** + * Constructs a new UpdateTeamMemberResponse. + * Represents a response from an update request, containing the updated `TeamMember` object or error messages. + * @alias module:model/UpdateTeamMemberResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a UpdateTeamMemberResponse 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/UpdateTeamMemberResponse} obj Optional instance to populate. + * @return {module:model/UpdateTeamMemberResponse} The populated UpdateTeamMemberResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('team_member')) { + obj['team_member'] = TeamMember.constructFromObject(data['team_member']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The successfully updated `TeamMember` object. + * @member {module:model/TeamMember} team_member + */ +exports.prototype['team_member'] = undefined; +/** + * The errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/UpdateWageSettingRequest.js b/src/model/UpdateWageSettingRequest.js new file mode 100644 index 0000000..7ab317a --- /dev/null +++ b/src/model/UpdateWageSettingRequest.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 WageSetting = require('./WageSetting'); + + + + +/** + * The UpdateWageSettingRequest model module. + * @module model/UpdateWageSettingRequest + */ + +/** + * Constructs a new UpdateWageSettingRequest. + * Represents an update request for the `WageSetting` object describing a `TeamMember`. + * @alias module:model/UpdateWageSettingRequest + * @class + * @param wageSetting {module:model/WageSetting} The new `WageSetting` object that will completely replace the existing one. + */ +var exports = function(wageSetting) { + var _this = this; + + _this['wage_setting'] = wageSetting; +}; + +/** + * Constructs a UpdateWageSettingRequest 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/UpdateWageSettingRequest} obj Optional instance to populate. + * @return {module:model/UpdateWageSettingRequest} The populated UpdateWageSettingRequest instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('wage_setting')) { + obj['wage_setting'] = WageSetting.constructFromObject(data['wage_setting']); + } + } + return obj; +} + +/** + * The new `WageSetting` object that will completely replace the existing one. + * @member {module:model/WageSetting} wage_setting + */ +exports.prototype['wage_setting'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/UpdateWageSettingResponse.js b/src/model/UpdateWageSettingResponse.js new file mode 100644 index 0000000..8b3ce76 --- /dev/null +++ b/src/model/UpdateWageSettingResponse.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 WageSetting = require('./WageSetting'); + + + + +/** + * The UpdateWageSettingResponse model module. + * @module model/UpdateWageSettingResponse + */ + +/** + * Constructs a new UpdateWageSettingResponse. + * Represents a response from an update request, containing the updated `WageSetting` object or error messages. + * @alias module:model/UpdateWageSettingResponse + * @class + */ +var exports = function() { + var _this = this; + + + +}; + +/** + * Constructs a UpdateWageSettingResponse 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/UpdateWageSettingResponse} obj Optional instance to populate. + * @return {module:model/UpdateWageSettingResponse} The populated UpdateWageSettingResponse instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('wage_setting')) { + obj['wage_setting'] = WageSetting.constructFromObject(data['wage_setting']); + } + if (data.hasOwnProperty('errors')) { + obj['errors'] = ApiClient.convertToType(data['errors'], [Error]); + } + } + return obj; +} + +/** + * The successfully updated `WageSetting` object. + * @member {module:model/WageSetting} wage_setting + */ +exports.prototype['wage_setting'] = undefined; +/** + * The errors that occurred during the request. + * @member {Array.} errors + */ +exports.prototype['errors'] = undefined; + + + +module.exports = exports; + + + diff --git a/src/model/WageSetting.js b/src/model/WageSetting.js new file mode 100644 index 0000000..3f8aefe --- /dev/null +++ b/src/model/WageSetting.js @@ -0,0 +1,111 @@ +/** + * Square Connect API + * Client library for accessing the Square Connect APIs + * + * OpenAPI spec version: 2.0 + * Contact: developers@squareup.com + * + * NOTE: This class 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 JobAssignment = require('./JobAssignment'); + + + + +/** + * The WageSetting model module. + * @module model/WageSetting + */ + +/** + * Constructs a new WageSetting. + * An object representing a team member's wage information. + * @alias module:model/WageSetting + * @class + */ +var exports = function() { + var _this = this; + + + + + + + +}; + +/** + * Constructs a WageSetting 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/WageSetting} obj Optional instance to populate. + * @return {module:model/WageSetting} The populated WageSetting instance. + */ +exports.constructFromObject = function(data, obj) { + if (data) { + obj = obj || new exports(); + + if (data.hasOwnProperty('team_member_id')) { + obj['team_member_id'] = ApiClient.convertToType(data['team_member_id'], 'String'); + } + if (data.hasOwnProperty('job_assignments')) { + obj['job_assignments'] = ApiClient.convertToType(data['job_assignments'], [JobAssignment]); + } + if (data.hasOwnProperty('is_overtime_exempt')) { + obj['is_overtime_exempt'] = ApiClient.convertToType(data['is_overtime_exempt'], '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; +} + +/** + * The unique ID of the `TeamMember` whom this wage setting describes. + * @member {String} team_member_id + */ +exports.prototype['team_member_id'] = undefined; +/** + * Required The ordered list of jobs that the team member is assigned to. The first job assignment is considered the team member's \"Primary Job\".
Min Length 1 Max Length 12 + * @member {Array.} job_assignments + */ +exports.prototype['job_assignments'] = undefined; +/** + * Whether the team member is exempt from the overtime rules of the seller country. + * @member {Boolean} is_overtime_exempt + */ +exports.prototype['is_overtime_exempt'] = 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. Read about [optimistic concurrency](https://developer.squareup.com/docs/docs/working-with-apis/optimistic-concurrency) in Square APIs for more information. + * @member {Number} version + */ +exports.prototype['version'] = undefined; +/** + * The timestamp in RFC 3339 format describing when the wage setting object was created. Ex: \"2018-10-04T04:00:00-07:00\" or \"2019-02-05T12:00:00Z\" + * @member {String} created_at + */ +exports.prototype['created_at'] = undefined; +/** + * The timestamp in RFC 3339 format describing when the wage setting object was last updated. Ex: \"2018-10-04T04:00:00-07:00\" or \"2019-02-05T12:00:00Z\" + * @member {String} updated_at + */ +exports.prototype['updated_at'] = undefined; + + + +module.exports = exports; + + + diff --git a/test/api/TeamApi.spec.js b/test/api/TeamApi.spec.js new file mode 100644 index 0000000..950b9fd --- /dev/null +++ b/test/api/TeamApi.spec.js @@ -0,0 +1,116 @@ +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('TeamApi', 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.TeamApi(); + }); + + afterEach(function(){ + }); + + describe('TeamApi', function() { + describe('bulkCreateTeamMembers', function() { + it('should call bulkCreateTeamMembers successfully', function(done) { + //uncomment below and update the code to test bulkCreateTeamMembers + //instance.bulkCreateTeamMembers(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('bulkUpdateTeamMembers', function() { + it('should call bulkUpdateTeamMembers successfully', function(done) { + //uncomment below and update the code to test bulkUpdateTeamMembers + //instance.bulkUpdateTeamMembers(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('createTeamMember', function() { + it('should call createTeamMember successfully', function(done) { + //uncomment below and update the code to test createTeamMember + //instance.createTeamMember(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('retrieveTeamMember', function() { + it('should call retrieveTeamMember successfully', function(done) { + //uncomment below and update the code to test retrieveTeamMember + //instance.retrieveTeamMember(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('retrieveWageSetting', function() { + it('should call retrieveWageSetting successfully', function(done) { + //uncomment below and update the code to test retrieveWageSetting + //instance.retrieveWageSetting(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('searchTeamMembers', function() { + it('should call searchTeamMembers successfully', function(done) { + //uncomment below and update the code to test searchTeamMembers + //instance.searchTeamMembers(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('updateTeamMember', function() { + it('should call updateTeamMember successfully', function(done) { + //uncomment below and update the code to test updateTeamMember + //instance.updateTeamMember(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + describe('updateWageSetting', function() { + it('should call updateWageSetting successfully', function(done) { + //uncomment below and update the code to test updateWageSetting + //instance.updateWageSetting(function(error) { + // if (error) throw error; + //expect().to.be(); + //}); + done(); + }); + }); + }); +}); diff --git a/test/model/BulkCreateTeamMembersRequest.spec.js b/test/model/BulkCreateTeamMembersRequest.spec.js new file mode 100644 index 0000000..9ec4f60 --- /dev/null +++ b/test/model/BulkCreateTeamMembersRequest.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('BulkCreateTeamMembersRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.BulkCreateTeamMembersRequest(); + }); + + it('should create an instance of BulkCreateTeamMembersRequest', function() { + // uncomment below and update the code to test BulkCreateTeamMembersRequest + //var instane = new SquareConnect.BulkCreateTeamMembersRequest(); + //expect(instance).to.be.a(SquareConnect.BulkCreateTeamMembersRequest); + }); + + it('should have the property teamMembers (base name: "team_members")', function() { + // uncomment below and update the code to test the property teamMembers + //var instane = new SquareConnect.BulkCreateTeamMembersRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/BulkCreateTeamMembersResponse.spec.js b/test/model/BulkCreateTeamMembersResponse.spec.js new file mode 100644 index 0000000..261e91e --- /dev/null +++ b/test/model/BulkCreateTeamMembersResponse.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('BulkCreateTeamMembersResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.BulkCreateTeamMembersResponse(); + }); + + it('should create an instance of BulkCreateTeamMembersResponse', function() { + // uncomment below and update the code to test BulkCreateTeamMembersResponse + //var instane = new SquareConnect.BulkCreateTeamMembersResponse(); + //expect(instance).to.be.a(SquareConnect.BulkCreateTeamMembersResponse); + }); + + it('should have the property teamMembers (base name: "team_members")', function() { + // uncomment below and update the code to test the property teamMembers + //var instane = new SquareConnect.BulkCreateTeamMembersResponse(); + //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.BulkCreateTeamMembersResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/BulkUpdateTeamMembersRequest.spec.js b/test/model/BulkUpdateTeamMembersRequest.spec.js new file mode 100644 index 0000000..8bd376e --- /dev/null +++ b/test/model/BulkUpdateTeamMembersRequest.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('BulkUpdateTeamMembersRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.BulkUpdateTeamMembersRequest(); + }); + + it('should create an instance of BulkUpdateTeamMembersRequest', function() { + // uncomment below and update the code to test BulkUpdateTeamMembersRequest + //var instane = new SquareConnect.BulkUpdateTeamMembersRequest(); + //expect(instance).to.be.a(SquareConnect.BulkUpdateTeamMembersRequest); + }); + + it('should have the property teamMembers (base name: "team_members")', function() { + // uncomment below and update the code to test the property teamMembers + //var instane = new SquareConnect.BulkUpdateTeamMembersRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/BulkUpdateTeamMembersResponse.spec.js b/test/model/BulkUpdateTeamMembersResponse.spec.js new file mode 100644 index 0000000..2aa8bb2 --- /dev/null +++ b/test/model/BulkUpdateTeamMembersResponse.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('BulkUpdateTeamMembersResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.BulkUpdateTeamMembersResponse(); + }); + + it('should create an instance of BulkUpdateTeamMembersResponse', function() { + // uncomment below and update the code to test BulkUpdateTeamMembersResponse + //var instane = new SquareConnect.BulkUpdateTeamMembersResponse(); + //expect(instance).to.be.a(SquareConnect.BulkUpdateTeamMembersResponse); + }); + + it('should have the property teamMembers (base name: "team_members")', function() { + // uncomment below and update the code to test the property teamMembers + //var instane = new SquareConnect.BulkUpdateTeamMembersResponse(); + //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.BulkUpdateTeamMembersResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/CatalogQueryCustomAttributeUsage.spec.js b/test/model/CatalogQueryCustomAttributeUsage.spec.js index 50df3fd..e53b507 100644 --- a/test/model/CatalogQueryCustomAttributeUsage.spec.js +++ b/test/model/CatalogQueryCustomAttributeUsage.spec.js @@ -15,7 +15,7 @@ const SquareConnect = require('../../src/index'); describe('CatalogQueryCustomAttributeUsage', function() { beforeEach(function() { - this.api = new SquareConnect.CatalogQueryCustomAttributeUsage(); +// this.api = new SquareConnect.CatalogQueryCustomAttributeUsage(); }); it('should create an instance of CatalogQueryCustomAttributeUsage', function() { diff --git a/test/model/CatalogQueryFilteredItems.spec.js b/test/model/CatalogQueryFilteredItems.spec.js index 43509b7..1059438 100644 --- a/test/model/CatalogQueryFilteredItems.spec.js +++ b/test/model/CatalogQueryFilteredItems.spec.js @@ -15,7 +15,7 @@ const SquareConnect = require('../../src/index'); describe('CatalogQueryFilteredItems', function() { beforeEach(function() { - this.api = new SquareConnect.CatalogQueryFilteredItems(); +// this.api = new SquareConnect.CatalogQueryFilteredItems(); }); it('should create an instance of CatalogQueryFilteredItems', function() { diff --git a/test/model/CatalogQueryFilteredItemsCustomAttributeFilter.spec.js b/test/model/CatalogQueryFilteredItemsCustomAttributeFilter.spec.js index 04bb853..4fac714 100644 --- a/test/model/CatalogQueryFilteredItemsCustomAttributeFilter.spec.js +++ b/test/model/CatalogQueryFilteredItemsCustomAttributeFilter.spec.js @@ -15,7 +15,7 @@ const SquareConnect = require('../../src/index'); describe('CatalogQueryFilteredItemsCustomAttributeFilter', function() { beforeEach(function() { - this.api = new SquareConnect.CatalogQueryFilteredItemsCustomAttributeFilter(); +// this.api = new SquareConnect.CatalogQueryFilteredItemsCustomAttributeFilter(); }); it('should create an instance of CatalogQueryFilteredItemsCustomAttributeFilter', function() { diff --git a/test/model/CreateTeamMemberRequest.spec.js b/test/model/CreateTeamMemberRequest.spec.js new file mode 100644 index 0000000..b2a9ed8 --- /dev/null +++ b/test/model/CreateTeamMemberRequest.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('CreateTeamMemberRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.CreateTeamMemberRequest(); + }); + + it('should create an instance of CreateTeamMemberRequest', function() { + // uncomment below and update the code to test CreateTeamMemberRequest + //var instane = new SquareConnect.CreateTeamMemberRequest(); + //expect(instance).to.be.a(SquareConnect.CreateTeamMemberRequest); + }); + + 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.CreateTeamMemberRequest(); + //expect(instance).to.be(); + }); + it('should have the property teamMember (base name: "team_member")', function() { + // uncomment below and update the code to test the property teamMember + //var instane = new SquareConnect.CreateTeamMemberRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/CreateTeamMemberResponse.spec.js b/test/model/CreateTeamMemberResponse.spec.js new file mode 100644 index 0000000..c6608c2 --- /dev/null +++ b/test/model/CreateTeamMemberResponse.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('CreateTeamMemberResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.CreateTeamMemberResponse(); + }); + + it('should create an instance of CreateTeamMemberResponse', function() { + // uncomment below and update the code to test CreateTeamMemberResponse + //var instane = new SquareConnect.CreateTeamMemberResponse(); + //expect(instance).to.be.a(SquareConnect.CreateTeamMemberResponse); + }); + + it('should have the property teamMember (base name: "team_member")', function() { + // uncomment below and update the code to test the property teamMember + //var instane = new SquareConnect.CreateTeamMemberResponse(); + //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.CreateTeamMemberResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/JobAssignment.spec.js b/test/model/JobAssignment.spec.js new file mode 100644 index 0000000..42775ab --- /dev/null +++ b/test/model/JobAssignment.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('JobAssignment', function() { + beforeEach(function() { + this.api = new SquareConnect.JobAssignment(); + }); + + it('should create an instance of JobAssignment', function() { + // uncomment below and update the code to test JobAssignment + //var instane = new SquareConnect.JobAssignment(); + //expect(instance).to.be.a(SquareConnect.JobAssignment); + }); + + it('should have the property jobTitle (base name: "job_title")', function() { + // uncomment below and update the code to test the property jobTitle + //var instane = new SquareConnect.JobAssignment(); + //expect(instance).to.be(); + }); + it('should have the property payType (base name: "pay_type")', function() { + // uncomment below and update the code to test the property payType + //var instane = new SquareConnect.JobAssignment(); + //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.JobAssignment(); + //expect(instance).to.be(); + }); + it('should have the property annualRate (base name: "annual_rate")', function() { + // uncomment below and update the code to test the property annualRate + //var instane = new SquareConnect.JobAssignment(); + //expect(instance).to.be(); + }); + it('should have the property weeklyHours (base name: "weekly_hours")', function() { + // uncomment below and update the code to test the property weeklyHours + //var instane = new SquareConnect.JobAssignment(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/JobAssignmentPayType.spec.js b/test/model/JobAssignmentPayType.spec.js new file mode 100644 index 0000000..7ec873c --- /dev/null +++ b/test/model/JobAssignmentPayType.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('JobAssignmentPayType', function() { + beforeEach(function() { + }); + + it('should create an instance of JobAssignmentPayType', function() { + // uncomment below and update the code to test JobAssignmentPayType + //var instane = new SquareConnect.JobAssignmentPayType(); + //expect(instance).to.be.a(SquareConnect.JobAssignmentPayType); + }); + +}); diff --git a/test/model/RetrieveTeamMemberRequest.spec.js b/test/model/RetrieveTeamMemberRequest.spec.js new file mode 100644 index 0000000..a9bfe31 --- /dev/null +++ b/test/model/RetrieveTeamMemberRequest.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('RetrieveTeamMemberRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.RetrieveTeamMemberRequest(); + }); + + it('should create an instance of RetrieveTeamMemberRequest', function() { + // uncomment below and update the code to test RetrieveTeamMemberRequest + //var instane = new SquareConnect.RetrieveTeamMemberRequest(); + //expect(instance).to.be.a(SquareConnect.RetrieveTeamMemberRequest); + }); + +}); diff --git a/test/model/RetrieveTeamMemberResponse.spec.js b/test/model/RetrieveTeamMemberResponse.spec.js new file mode 100644 index 0000000..470b163 --- /dev/null +++ b/test/model/RetrieveTeamMemberResponse.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('RetrieveTeamMemberResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.RetrieveTeamMemberResponse(); + }); + + it('should create an instance of RetrieveTeamMemberResponse', function() { + // uncomment below and update the code to test RetrieveTeamMemberResponse + //var instane = new SquareConnect.RetrieveTeamMemberResponse(); + //expect(instance).to.be.a(SquareConnect.RetrieveTeamMemberResponse); + }); + + it('should have the property teamMember (base name: "team_member")', function() { + // uncomment below and update the code to test the property teamMember + //var instane = new SquareConnect.RetrieveTeamMemberResponse(); + //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.RetrieveTeamMemberResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/RetrieveWageSettingRequest.spec.js b/test/model/RetrieveWageSettingRequest.spec.js new file mode 100644 index 0000000..2699be3 --- /dev/null +++ b/test/model/RetrieveWageSettingRequest.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('RetrieveWageSettingRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.RetrieveWageSettingRequest(); + }); + + it('should create an instance of RetrieveWageSettingRequest', function() { + // uncomment below and update the code to test RetrieveWageSettingRequest + //var instane = new SquareConnect.RetrieveWageSettingRequest(); + //expect(instance).to.be.a(SquareConnect.RetrieveWageSettingRequest); + }); + +}); diff --git a/test/model/RetrieveWageSettingResponse.spec.js b/test/model/RetrieveWageSettingResponse.spec.js new file mode 100644 index 0000000..671cd60 --- /dev/null +++ b/test/model/RetrieveWageSettingResponse.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('RetrieveWageSettingResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.RetrieveWageSettingResponse(); + }); + + it('should create an instance of RetrieveWageSettingResponse', function() { + // uncomment below and update the code to test RetrieveWageSettingResponse + //var instane = new SquareConnect.RetrieveWageSettingResponse(); + //expect(instance).to.be.a(SquareConnect.RetrieveWageSettingResponse); + }); + + it('should have the property wageSetting (base name: "wage_setting")', function() { + // uncomment below and update the code to test the property wageSetting + //var instane = new SquareConnect.RetrieveWageSettingResponse(); + //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.RetrieveWageSettingResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/SearchTeamMembersFilter.spec.js b/test/model/SearchTeamMembersFilter.spec.js new file mode 100644 index 0000000..32deeb6 --- /dev/null +++ b/test/model/SearchTeamMembersFilter.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('SearchTeamMembersFilter', function() { + beforeEach(function() { + this.api = new SquareConnect.SearchTeamMembersFilter(); + }); + + it('should create an instance of SearchTeamMembersFilter', function() { + // uncomment below and update the code to test SearchTeamMembersFilter + //var instane = new SquareConnect.SearchTeamMembersFilter(); + //expect(instance).to.be.a(SquareConnect.SearchTeamMembersFilter); + }); + + 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.SearchTeamMembersFilter(); + //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.SearchTeamMembersFilter(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/SearchTeamMembersQuery.spec.js b/test/model/SearchTeamMembersQuery.spec.js new file mode 100644 index 0000000..cf27c5a --- /dev/null +++ b/test/model/SearchTeamMembersQuery.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('SearchTeamMembersQuery', function() { + beforeEach(function() { + this.api = new SquareConnect.SearchTeamMembersQuery(); + }); + + it('should create an instance of SearchTeamMembersQuery', function() { + // uncomment below and update the code to test SearchTeamMembersQuery + //var instane = new SquareConnect.SearchTeamMembersQuery(); + //expect(instance).to.be.a(SquareConnect.SearchTeamMembersQuery); + }); + + 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.SearchTeamMembersQuery(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/SearchTeamMembersRequest.spec.js b/test/model/SearchTeamMembersRequest.spec.js new file mode 100644 index 0000000..e7f7775 --- /dev/null +++ b/test/model/SearchTeamMembersRequest.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('SearchTeamMembersRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.SearchTeamMembersRequest(); + }); + + it('should create an instance of SearchTeamMembersRequest', function() { + // uncomment below and update the code to test SearchTeamMembersRequest + //var instane = new SquareConnect.SearchTeamMembersRequest(); + //expect(instance).to.be.a(SquareConnect.SearchTeamMembersRequest); + }); + + 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.SearchTeamMembersRequest(); + //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.SearchTeamMembersRequest(); + //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.SearchTeamMembersRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/SearchTeamMembersResponse.spec.js b/test/model/SearchTeamMembersResponse.spec.js new file mode 100644 index 0000000..f6e2d22 --- /dev/null +++ b/test/model/SearchTeamMembersResponse.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('SearchTeamMembersResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.SearchTeamMembersResponse(); + }); + + it('should create an instance of SearchTeamMembersResponse', function() { + // uncomment below and update the code to test SearchTeamMembersResponse + //var instane = new SquareConnect.SearchTeamMembersResponse(); + //expect(instance).to.be.a(SquareConnect.SearchTeamMembersResponse); + }); + + it('should have the property teamMembers (base name: "team_members")', function() { + // uncomment below and update the code to test the property teamMembers + //var instane = new SquareConnect.SearchTeamMembersResponse(); + //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.SearchTeamMembersResponse(); + //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.SearchTeamMembersResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/TeamMember.spec.js b/test/model/TeamMember.spec.js new file mode 100644 index 0000000..962327e --- /dev/null +++ b/test/model/TeamMember.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('TeamMember', function() { + beforeEach(function() { + this.api = new SquareConnect.TeamMember(); + }); + + it('should create an instance of TeamMember', function() { + // uncomment below and update the code to test TeamMember + //var instane = new SquareConnect.TeamMember(); + //expect(instance).to.be.a(SquareConnect.TeamMember); + }); + + 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.TeamMember(); + //expect(instance).to.be(); + }); + it('should have the property referenceId (base name: "reference_id")', function() { + // uncomment below and update the code to test the property referenceId + //var instane = new SquareConnect.TeamMember(); + //expect(instance).to.be(); + }); + it('should have the property isOwner (base name: "is_owner")', function() { + // uncomment below and update the code to test the property isOwner + //var instane = new SquareConnect.TeamMember(); + //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.TeamMember(); + //expect(instance).to.be(); + }); + it('should have the property givenName (base name: "given_name")', function() { + // uncomment below and update the code to test the property givenName + //var instane = new SquareConnect.TeamMember(); + //expect(instance).to.be(); + }); + it('should have the property familyName (base name: "family_name")', function() { + // uncomment below and update the code to test the property familyName + //var instane = new SquareConnect.TeamMember(); + //expect(instance).to.be(); + }); + it('should have the property emailAddress (base name: "email_address")', function() { + // uncomment below and update the code to test the property emailAddress + //var instane = new SquareConnect.TeamMember(); + //expect(instance).to.be(); + }); + it('should have the property phoneNumber (base name: "phone_number")', function() { + // uncomment below and update the code to test the property phoneNumber + //var instane = new SquareConnect.TeamMember(); + //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.TeamMember(); + //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.TeamMember(); + //expect(instance).to.be(); + }); + it('should have the property assignedLocations (base name: "assigned_locations")', function() { + // uncomment below and update the code to test the property assignedLocations + //var instane = new SquareConnect.TeamMember(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/TeamMemberAssignedLocations.spec.js b/test/model/TeamMemberAssignedLocations.spec.js new file mode 100644 index 0000000..ff8a769 --- /dev/null +++ b/test/model/TeamMemberAssignedLocations.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('TeamMemberAssignedLocations', function() { + beforeEach(function() { + this.api = new SquareConnect.TeamMemberAssignedLocations(); + }); + + it('should create an instance of TeamMemberAssignedLocations', function() { + // uncomment below and update the code to test TeamMemberAssignedLocations + //var instane = new SquareConnect.TeamMemberAssignedLocations(); + //expect(instance).to.be.a(SquareConnect.TeamMemberAssignedLocations); + }); + + it('should have the property assignmentType (base name: "assignment_type")', function() { + // uncomment below and update the code to test the property assignmentType + //var instane = new SquareConnect.TeamMemberAssignedLocations(); + //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.TeamMemberAssignedLocations(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/TeamMemberAssignedLocationsAssignmentType.spec.js b/test/model/TeamMemberAssignedLocationsAssignmentType.spec.js new file mode 100644 index 0000000..84fa857 --- /dev/null +++ b/test/model/TeamMemberAssignedLocationsAssignmentType.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('TeamMemberAssignedLocationsAssignmentType', function() { + beforeEach(function() { + }); + + it('should create an instance of TeamMemberAssignedLocationsAssignmentType', function() { + // uncomment below and update the code to test TeamMemberAssignedLocationsAssignmentType + //var instane = new SquareConnect.TeamMemberAssignedLocationsAssignmentType(); + //expect(instance).to.be.a(SquareConnect.TeamMemberAssignedLocationsAssignmentType); + }); + +}); diff --git a/test/model/TeamMemberStatus.spec.js b/test/model/TeamMemberStatus.spec.js new file mode 100644 index 0000000..f00277f --- /dev/null +++ b/test/model/TeamMemberStatus.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('TeamMemberStatus', function() { + beforeEach(function() { + }); + + it('should create an instance of TeamMemberStatus', function() { + // uncomment below and update the code to test TeamMemberStatus + //var instane = new SquareConnect.TeamMemberStatus(); + //expect(instance).to.be.a(SquareConnect.TeamMemberStatus); + }); + +}); diff --git a/test/model/UpdateTeamMemberRequest.spec.js b/test/model/UpdateTeamMemberRequest.spec.js new file mode 100644 index 0000000..a6b5077 --- /dev/null +++ b/test/model/UpdateTeamMemberRequest.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('UpdateTeamMemberRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.UpdateTeamMemberRequest(); + }); + + it('should create an instance of UpdateTeamMemberRequest', function() { + // uncomment below and update the code to test UpdateTeamMemberRequest + //var instane = new SquareConnect.UpdateTeamMemberRequest(); + //expect(instance).to.be.a(SquareConnect.UpdateTeamMemberRequest); + }); + + it('should have the property teamMember (base name: "team_member")', function() { + // uncomment below and update the code to test the property teamMember + //var instane = new SquareConnect.UpdateTeamMemberRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/UpdateTeamMemberResponse.spec.js b/test/model/UpdateTeamMemberResponse.spec.js new file mode 100644 index 0000000..93e49cb --- /dev/null +++ b/test/model/UpdateTeamMemberResponse.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('UpdateTeamMemberResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.UpdateTeamMemberResponse(); + }); + + it('should create an instance of UpdateTeamMemberResponse', function() { + // uncomment below and update the code to test UpdateTeamMemberResponse + //var instane = new SquareConnect.UpdateTeamMemberResponse(); + //expect(instance).to.be.a(SquareConnect.UpdateTeamMemberResponse); + }); + + it('should have the property teamMember (base name: "team_member")', function() { + // uncomment below and update the code to test the property teamMember + //var instane = new SquareConnect.UpdateTeamMemberResponse(); + //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.UpdateTeamMemberResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/UpdateWageSettingRequest.spec.js b/test/model/UpdateWageSettingRequest.spec.js new file mode 100644 index 0000000..b44cbde --- /dev/null +++ b/test/model/UpdateWageSettingRequest.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('UpdateWageSettingRequest', function() { + beforeEach(function() { + this.api = new SquareConnect.UpdateWageSettingRequest(); + }); + + it('should create an instance of UpdateWageSettingRequest', function() { + // uncomment below and update the code to test UpdateWageSettingRequest + //var instane = new SquareConnect.UpdateWageSettingRequest(); + //expect(instance).to.be.a(SquareConnect.UpdateWageSettingRequest); + }); + + it('should have the property wageSetting (base name: "wage_setting")', function() { + // uncomment below and update the code to test the property wageSetting + //var instane = new SquareConnect.UpdateWageSettingRequest(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/UpdateWageSettingResponse.spec.js b/test/model/UpdateWageSettingResponse.spec.js new file mode 100644 index 0000000..85f43c7 --- /dev/null +++ b/test/model/UpdateWageSettingResponse.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('UpdateWageSettingResponse', function() { + beforeEach(function() { + this.api = new SquareConnect.UpdateWageSettingResponse(); + }); + + it('should create an instance of UpdateWageSettingResponse', function() { + // uncomment below and update the code to test UpdateWageSettingResponse + //var instane = new SquareConnect.UpdateWageSettingResponse(); + //expect(instance).to.be.a(SquareConnect.UpdateWageSettingResponse); + }); + + it('should have the property wageSetting (base name: "wage_setting")', function() { + // uncomment below and update the code to test the property wageSetting + //var instane = new SquareConnect.UpdateWageSettingResponse(); + //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.UpdateWageSettingResponse(); + //expect(instance).to.be(); + }); +}); diff --git a/test/model/WageSetting.spec.js b/test/model/WageSetting.spec.js new file mode 100644 index 0000000..783fbe6 --- /dev/null +++ b/test/model/WageSetting.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('WageSetting', function() { + beforeEach(function() { + this.api = new SquareConnect.WageSetting(); + }); + + it('should create an instance of WageSetting', function() { + // uncomment below and update the code to test WageSetting + //var instane = new SquareConnect.WageSetting(); + //expect(instance).to.be.a(SquareConnect.WageSetting); + }); + + it('should have the property teamMemberId (base name: "team_member_id")', function() { + // uncomment below and update the code to test the property teamMemberId + //var instane = new SquareConnect.WageSetting(); + //expect(instance).to.be(); + }); + it('should have the property jobAssignments (base name: "job_assignments")', function() { + // uncomment below and update the code to test the property jobAssignments + //var instane = new SquareConnect.WageSetting(); + //expect(instance).to.be(); + }); + it('should have the property isOvertimeExempt (base name: "is_overtime_exempt")', function() { + // uncomment below and update the code to test the property isOvertimeExempt + //var instane = new SquareConnect.WageSetting(); + //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.WageSetting(); + //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.WageSetting(); + //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.WageSetting(); + //expect(instance).to.be(); + }); +});