Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Commit 5cf9e58

Browse files
square-sdk-deployersquare-sdk-deployer
committed
Release 2.24.0
1 parent 0d3f34c commit 5cf9e58

File tree

196 files changed

+1217
-741
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

196 files changed

+1217
-741
lines changed

‎CHANGES.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# Change Log
22

3+
## Version 2.24.0 (2019-10-23)
4+
* **GA release**: Merchants.ListMerchant is GA for all SDKs.
5+
* **Beta release**: All SDKs support new Locations API endpoint, CreateLocation.
6+
* **Beta release**: All SDKs support exclusion strategies for pricing rules.
7+
8+
39
## Version 2.23.0 (2019-09-25)
410

511
* **GA release**: All SDKs have been updated to support the new Merchants API.
@@ -21,7 +27,7 @@
2127

2228
## Version 2.22.1 (2018-08-16)
2329

24-
* **Bug fix**: Removed a currently unsupported API object type
30+
* **Bug fix**: Removed a currentlyunsupported API object type
2531
## Version 2.22.0 (2019-08-15)
2632

2733
* **New functionality**: All SDKs have been updated to support the Sandbox v2 BETA release

‎README.md

+1
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,7 @@ Class | Method | HTTP request
180180
*LocationsApi* | [**ListLocations**](docs/LocationsApi.md#listlocations) | **GET** /v2/locations
181181
*LocationsApi* | [**RetrieveLocation**](docs/LocationsApi.md#retrievelocation) | **GET** /v2/locations/{location_id}
182182
*LocationsApi* | [**UpdateLocation**](docs/LocationsApi.md#updatelocation) | **PUT** /v2/locations/{location_id}
183+
*MerchantsApi* | [**ListMerchants**](docs/MerchantsApi.md#listmerchants) | **GET** /v2/merchants
183184
*MerchantsApi* | [**RetrieveMerchant**](docs/MerchantsApi.md#retrievemerchant) | **GET** /v2/merchants/{merchant_id}
184185
*MobileAuthorizationApi* | [**CreateMobileAuthorizationCode**](docs/MobileAuthorizationApi.md#createmobileauthorizationcode) | **POST** /mobile/authorization-code
185186
*OAuthApi* | [**ObtainToken**](docs/OAuthApi.md#obtaintoken) | **POST** /oauth2/token

‎docs/AdditionalRecipientReceivable.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Description
44

55
Represents a monetary distribution of part of a [Transaction](#type-transaction)'s amount for Transactions which included additional recipients. The location of this receivable is that same as the one specified in the [AdditionalRecipient](#type-additionalrecipient).
6+
**Note: This model is deprecated.**
67

78
## Properties
89

‎docs/AdditionalRecipientReceivableRefund.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Description
44

55
A refund of an [AdditionalRecipientReceivable](#type-additionalrecipientreceivable). This includes the ID of the additional recipient receivable associated to this object, as well as a reference to the [Refund](#type-refund) that created this receivable refund.
6+
**Note: This model is deprecated.**
67

78
## Properties
89

‎docs/CaptureTransactionRequest.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Description
44

55
Defines the query parameters for calls to the CaptureTransaction endpoint.
6+
**Note: This model is deprecated.**
67

78
## Properties
89

‎docs/CaptureTransactionResponse.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Description
44

55
Defines the fields that are included in the response body of a request to the [CaptureTransaction](#endpoint-capturetransaction) endpoint.
6+
**Note: This model is deprecated.**
67

78
## Properties
89

‎docs/CatalogApi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -344,7 +344,7 @@ Name | Type | Description | Notes
344344
345345
ListCatalog
346346

347-
Returns a list of [CatalogObject](#type-catalogobject)s that includes all objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem) and [CatalogTax](#type-catalogtax) objects) in the catalog. The `types` parameter is specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types: `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`. __Important:__ ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use SearchCatalogObjects and set `include_deleted_objects` to `true`.
347+
Returns a list of [CatalogObject](#type-catalogobject)s that includes all objects of a set of desired types (for example, all [CatalogItem](#type-catalogitem) and [CatalogTax](#type-catalogtax) objects) in the catalog. The `types` parameter is specified as a comma-separated list of valid [CatalogObject](#type-catalogobject) types: `ITEM`, `ITEM_VARIATION`, `MODIFIER`, `MODIFIER_LIST`, `CATEGORY`, `DISCOUNT`, `TAX`, `IMAGE`. __Important:__ ListCatalog does not return deleted catalog items. To retrieve deleted catalog items, use SearchCatalogObjects and set `include_deleted_objects` to `true`.
348348

349349
### Example
350350
```csharp

‎docs/CatalogItem.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
2121
**Variations** | [**List<CatalogObject>**](CatalogObject.md) | A list of `CatalogObject`s containing the `CatalogItemVariation`s for this item. Maximum: 250 item variations | [optional]
2222
**ProductType** | **string** | The product type of the item. May not be changed once an item has been created. Only items of product type `REGULAR` or `APPOINTMENTS_SERVICE` may be created by this API; items with other product types are read-only. See [CatalogItemProductType](#type-catalogitemproducttype) for possible values | [optional]
2323
**SkipModifierScreen** | **bool?** | If `false`, the Square Point of Sale app will present the `CatalogItem`'s details screen immediately, allowing the merchant to choose `CatalogModifier`s before adding the item to the cart. This is the default behavior. If `true`, the Square Point of Sale app will immediately add the item to the cart with the pre-selected modifiers, and merchants can edit modifiers by drilling down onto the item's details. Third-party clients are encouraged to implement similar behaviors. | [optional]
24-
**ItemOptions** | [**List<CatalogItemOptionForItem>**](CatalogItemOptionForItem.md) | List of item options IDs for this item. Used to manage and group item variations in a specified order. Maximum: 6 item options. | [optional]
24+
**ItemOptions** | [**List<CatalogItemOptionForItem>**](CatalogItemOptionForItem.md) | List of item options IDs for this item. Used to manage and group item variations in a specified order. Maximum: 6 item options. | [optional] [beta]
2525

2626

2727

‎docs/CatalogItemOption.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Description
44

55
A group of variations for a [CatalogItem](#type-catalogitem)'s.
6+
**Note: This model is in beta.**
67

78
## Properties
89

‎docs/CatalogItemOptionForItem.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Description
44

55
A list of item option values that can be assigned to item variations. For example, a t-shirt item may offer a color option or a size option.
6+
**Note: This model is in beta.**
67

78
## Properties
89

‎docs/CatalogItemOptionValue.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Description
44

55
An enumerated value that can link a [CatalogItemVariation(#type-catalogitemvariation) to an item option as one of its item option values.
6+
**Note: This model is in beta.**
67

78
## Properties
89

@@ -11,7 +12,7 @@ Name | Type | Description | Notes
1112
**ItemOptionId** | **string** | Unique ID of the associated item option. | [optional]
1213
**Name** | **string** | Name of this item option value. Searchable. | [optional]
1314
**Description** | **string** | The option value's human-readable description. | [optional]
14-
**Color** | **string** | The HTML color for this value in the format #FFRRGGBB or #RRGGBB (e.g., \"#ff8d4e85\"). Only displayed if parent Item Option's `show_colors` flag is enabled. value. | [optional]
15+
**Color** | **string** | The HTML-supported hex color for the item option (e.g., \"#ff8d4e85\"). Only displayed if `show_colors` is enabled on the parent `ItemOption`. When left unset, `color` defaults to white (\"#ffffff\") when `show_colors` is enabled on the parent `ItemOption`. | [optional]
1516
**Ordinal** | **int?** | Determines where this option value appears in a list of option values. | [optional]
1617
**ItemVariationCount** | **long?** | The number of [CatalogItemVariation(#type-catalogitemvariation)s that currently make use of this Item Option value. Present only if `retrieve_counts` was specified on the request used to retrieve the parent Item Option of this value. Maximum: 100 counts. | [optional]
1718

‎docs/CatalogItemOptionValueForItemVariation.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Description
44

55
A [CatalogItemOptionValue](#type-catalogitemoptionvalue) links an item variation to an item option as an item option value. For example, a t-shirt item may offer a color option and a size option. An item option value would represent each variation of t-shirt: For example, “Color:Red, Size:Small” or “Color:Blue, Size:Medium”.
6+
**Note: This model is in beta.**
67

78
## Properties
89

‎docs/CatalogItemVariation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Name | Type | Description | Notes
2121
**InventoryAlertThreshold** | **long?** | If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. This value is always an integer. | [optional]
2222
**UserData** | **string** | Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable. | [optional]
2323
**ServiceDuration** | **long?** | If the `CatalogItem` that owns this item variation is of type `APPOINTMENTS_SERVICE`, then this is the duration of the service in milliseconds. For example, a 30 minute appointment would have the value `1800000`, which is equal to 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second). | [optional]
24-
**ItemOptionValues** | [**List<CatalogItemOptionValueForItemVariation>**](CatalogItemOptionValueForItemVariation.md) | List of item option values associated with this item variation. Listed in the same order as the item options of the parent item. | [optional]
25-
**MeasurementUnitId** | **string** | ID of the ‘CatalogMeasurementUnit’ that is used to measure the quantity sold of this item variation. If left unset, the item will be sold in whole quantities. | [optional]
24+
**ItemOptionValues** | [**List<CatalogItemOptionValueForItemVariation>**](CatalogItemOptionValueForItemVariation.md) | List of item option values associated with this item variation. Listed in the same order as the item options of the parent item. | [optional] [beta]
25+
**MeasurementUnitId** | **string** | ID of the ‘CatalogMeasurementUnit’ that is used to measure the quantity sold of this item variation. If left unset, the item will be sold in whole quantities. | [optional] [beta]
2626

2727

2828

‎docs/CatalogMeasurementUnit.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Description
44

55
Represents the unit used to measure a [CatalogItemVariation](#type-catalogitemvariation) and specifies the precision for decimal quantities.
6+
**Note: This model is in beta.**
67

78
## Properties
89

‎docs/CatalogPricingRule.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Description
44

55
Defines how prices are modified or set for items that match the pricing rule during the active time period.
6+
**Note: This model is in beta.**
67

78
## Properties
89

@@ -12,12 +13,13 @@ Name | Type | Description | Notes
1213
**TimePeriodIds** | **List<string>** | Unique ID for the &#x60;CatalogTimePeriod&#x60;s when this pricing rule is in effect. If left unset, the pricing rule is always in effect. | [optional]
1314
**DiscountId** | **string** | Unique ID for the &#x60;CatalogDiscount&#x60; to take off the price of all matched items. | [optional]
1415
**MatchProductsId** | **string** | Unique ID for the &#x60;CatalogProductSet&#x60; that will be matched by this rule. A match rule matches within the entire cart. | [optional]
15-
**ApplyProductsId** | **string** | The &#x60;CatalogProductSet&#x60; to apply the pricing rule to within the set of matched products specified by &#x60;match_products_id&#x60;. An apply rule can only match once within the set of matched products. If left unset, the pricing rule will be applied to all products within the set of matched products. | [optional]
16+
**ApplyProductsId** | **string** | &#x60;CatalogProductSet&#x60; to apply the pricing to. An apply rule matches within the subset of the cart that fits the match rules (the match set). An apply rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. This field has been deprecated: new pricing rules should prefer the exclude_products_id field. Exclude sets allow better control over quantity ranges and offer more flexibility for which matched items receive a discount. | [optional] [deprecated]
1617
**ExcludeProductsId** | **string** | Identifies the &#x60;CatalogProductSet&#x60; to exclude from this pricing rule. An exclude rule matches within the subset of the cart that fits the match rules (the match set). An exclude rule can only match once in the match set. If not supplied, the pricing will be applied to all products in the match set. Other products retain their base price, or a price generated by other rules. | [optional]
1718
**ValidFromDate** | **string** | Represents the date the Pricing Rule is valid from. Represented in RFC3339 full-date format (YYYY-MM-DD). | [optional]
1819
**ValidFromLocalTime** | **string** | Represents the local time the pricing rule should be valid from. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. | [optional]
1920
**ValidUntilDate** | **string** | Represents the date the pricing rule will become inactive. Represented in RFC3339 full-date format (YYYY-MM-DD). | [optional]
2021
**ValidUntilLocalTime** | **string** | Represents the local time at which the pricing rule will become inactive. Time zone is determined by the device running the Point of Sale app. Represented in RFC3339 partial-time format (HH:MM:SS). Partial seconds will be truncated. | [optional]
22+
**ExcludeStrategy** | **string** | If an &#x60;exclude_products_id&#x60; was given, controls which subset of matched products is excluded from any discounts. See &#x60;ExcludeStrategy&#x60; for all possible values. Default value: &#x60;LEAST_EXPENSIVE&#x60; See [ExcludeStrategy](#type-excludestrategy) for possible values | [optional]
2123

2224

2325

‎docs/CatalogProductSet.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Description
44

55
Represents a collection of catalog objects for the purpose of applying a [PricingRule](#type-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.
6+
**Note: This model is in beta.**
67

78
## Properties
89

‎docs/CatalogQueryItemVariationsForItemOptionValues.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Description
44

55

6+
**Note: This model is in beta.**
67

78
## Properties
89

‎docs/CatalogQueryItemsForItemOptions.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Description
44

55

6+
**Note: This model is in beta.**
67

78
## Properties
89

‎docs/CatalogTimePeriod.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Description
44

55
Represents a time period - either a single period or a repeating period.
6+
**Note: This model is in beta.**
67

78
## Properties
89

‎docs/ChargeRequest.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,14 @@
33
### Description
44

55
Defines the parameters that can be included in the body of a request to the [Charge](#endpoint-charge) endpoint. Deprecated - recommend using [CreatePayment](#endpoint-payments-createpayment)
6+
**Note: This model is deprecated.**
67

78
## Properties
89

910
Name | Type | Description | Notes
1011
------------ | ------------- | ------------- | -------------
1112
**IdempotencyKey** | **string** | A value you specify that uniquely identifies this transaction among transactions you&#39;ve created. If you&#39;re unsure whether a particular transaction succeeded, you can reattempt it with the same idempotency key without worrying about double-charging the buyer. See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) for more information. |
12-
**AmountMoney** | [**Money**](Money.md) | The amount of money to charge. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](#workingwithmonetaryamounts) for details. The value of &#x60;currency&#x60; must match the currency associated with the business that is charging the card. |
13+
**AmountMoney** | [**Money**](Money.md) | The amount of money to charge. Note that you specify the amount in the __smallest denomination of the applicable currency__. For example, US dollar amounts are specified in cents. See [Working with monetary amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for details. The value of &#x60;currency&#x60; must match the currency associated with the business that is charging the card. |
1314
**CardNonce** | **string** | A nonce generated from the &#x60;SqPaymentForm&#x60; that represents the card to charge. The application that provides a nonce to this endpoint must be the _same application_ that generated the nonce with the &#x60;SqPaymentForm&#x60;. Otherwise, the nonce is invalid. Do not provide a value for this field if you provide a value for &#x60;customer_card_id&#x60;. | [optional]
1415
**CustomerCardId** | **string** | The ID of the customer card on file to charge. Do not provide a value for this field if you provide a value for &#x60;card_nonce&#x60;. If you provide this value, you _must_ also provide a value for &#x60;customer_id&#x60;. | [optional]
1516
**DelayCapture** | **bool?** | If &#x60;true&#x60;, the request will only perform an Auth on the provided card. You can then later perform either a Capture (with the &#x60;CaptureTransaction&#x60; or a Void (with the &#x60;VoidTransaction&#x60;. Default value: &#x60;false&#x60; | [optional]

‎docs/ChargeRequestAdditionalRecipient.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Description
44

55
Represents an additional recipient (other than the merchant) entitled to a portion of the tender. Support is currently limited to USD, CAD and GBP currencies
6+
**Note: This model is deprecated.**
67

78
## Properties
89

‎docs/ChargeResponse.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
### Description
44

55
Defines the fields that are included in the response body of a request to the [Charge](#endpoint-charge) endpoint. One of `errors` or `transaction` is present in a given response (never both).
6+
**Note: This model is deprecated.**
67

78
## Properties
89

0 commit comments

Comments
 (0)