You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* From connect-api-specification: Fix push-lang-sdk script to correctly look for proposed branch (square#60)
* Add Checkout Test with Taxes and discount (square#34)
Copy file name to clipboardExpand all lines: docs/Card.md
+1
Original file line number
Diff line number
Diff line change
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
10
10
**ExpYear** | **long?** | The four-digit year of the card's expiration date. | [optional]
11
11
**CardholderName** | **string** | The cardholder name. This value is present only if this object represents a customer's card on file. | [optional]
12
12
**BillingAddress** | [**Address**](Address.md) | The card's billing address. This value is present only if this object represents a customer's card on file. | [optional]
13
+
**Fingerprint** | **string** | The unique string fingerprint for the card. The fingerprint is based on the credit card number and is unique to the merchant. If a card is used at multiple locations for the same merchant, it will have the same fingerprint in each case. Note: Fingerprint may not exist on old transactions. | [optional]
Copy file name to clipboardExpand all lines: docs/CatalogApi.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -88,7 +88,7 @@ Name | Type | Description | Notes
88
88
89
89
BatchRetrieveCatalogObjects
90
90
91
-
Returns a set of objects based on the provided ID. [CatalogItem](#type-catalogitem)s returned in the set include all of the child information including: all [CatalogItemVariation](#type-catalogitemvariation) objects, references to its [CatalogModifierList](#type-catalogmodifierlist) objects, and the ids of any [CatalogTax](#type-catalogtax) objects that apply to it.
91
+
Returns a set of objects based on the provided ID. Each [CatalogItem](#type-catalogitem) returned in the set includes all of its child information including: all of its[CatalogItemVariation](#type-catalogitemvariation) objects, references to its [CatalogModifierList](#type-catalogmodifierlist) objects, and the ids of any [CatalogTax](#type-catalogtax) objects that apply to it.
92
92
93
93
### Example
94
94
```csharp
@@ -433,7 +433,7 @@ namespace Example
433
433
434
434
varapiInstance=newCatalogApi();
435
435
varobjectId=objectId_example; // string | The object ID of any type of [CatalogObject](#type-catalogobject)s to be retrieved.
436
-
varincludeRelatedObjects=true; // bool? | If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a [CatalogItem](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. (optional)
436
+
varincludeRelatedObjects=true; // bool? | If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a [CatalogItem](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. Default value: `false` (optional)
**objectId** | **string**| The object ID of any type of [CatalogObject](#type-catalogobject)s to be retrieved. |
458
-
**includeRelatedObjects** | **bool?**| If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a [CatalogItem](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. | [optional]
458
+
**includeRelatedObjects** | **bool?**| If `true`, the response will include additional objects that are related to the requested object, as follows: If the `object` field of the response contains a [CatalogItem](#type-catalogitem), its associated [CatalogCategory](#type-catalogcategory), [CatalogTax](#type-catalogtax)es, and [CatalogModifierList](#type-catalogmodifierlist)s will be returned in the `related_objects` field of the response. If the `object` field of the response contains a [CatalogItemVariation](#type-catalogitemvariation), its parent [CatalogItem](#type-catalogitem) will be returned in the `related_objects` field of the response. Default value: `false`| [optional]
459
459
460
460
### Return type
461
461
@@ -478,7 +478,7 @@ Name | Type | Description | Notes
478
478
479
479
SearchCatalogObjects
480
480
481
-
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), ([CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist)).
481
+
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), ([CatalogQueryItemsForModifierList](#type-catalogqueryitemsformodifierlist)).
Copy file name to clipboardExpand all lines: docs/CatalogItem.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
**Name** | **string** | The item's name. Searchable. |
7
7
**Description** | **string** | The item's description. Searchable. | [optional]
8
8
**Abbreviation** | **string** | The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used. Searchable. | [optional]
9
-
**LabelColor** | **string** | The color of the item's display label in the Square Point of Sale app. Searchable. | [optional]
9
+
**LabelColor** | **string** | The color of the item's display label in the Square Point of Sale app. | [optional]
10
10
**AvailableOnline** | **bool?** | If `true`, the item can be added to shipping orders from the merchant's online store. | [optional]
11
11
**AvailableForPickup** | **bool?** | If `true`, the item can be added to pickup orders from the merchant's online store. | [optional]
12
12
**AvailableElectronically** | **bool?** | If `true`, the item can be added to electronically fulfilled orders from the merchant's online store. | [optional]
Copy file name to clipboardExpand all lines: docs/CatalogItemVariation.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ Name | Type | Description | Notes
9
9
**Upc** | **string** | The item variation's UPC, if any. Searchable. | [optional]
10
10
**PricingType** | **PricingTypeEnum** | Indicates whether the item variation's price is fixed or determined at the time of sale. See [CatalogPricingType](#type-catalogpricingtype) for all possible values. | [optional]
11
11
**PriceMoney** | [**Money**](Money.md) | The item variation's price, if fixed pricing is used. | [optional]
**TrackInventory** | **bool?** | If `true`, inventory tracking is active for the variation. | [optional]
14
14
**InventoryAlertType** | **InventoryAlertTypeEnum** | Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for all possible values. | [optional]
15
15
**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]
**Type** | **TypeEnum** | The type of this object. Each object type has expected properties expressed in a structured format within its corresponding `*_data` field below. See [CatalogObjectType](#type-catalogobjecttype) for all possible values. |
7
-
**Id** | **string** | A unique Square-assigned identifier to reference this object in the catalog. |
7
+
**Id** | **string** | An identifier to reference this object in the catalog. When a new CatalogObject is inserted, the client should set the id to a temporary identifier starting with a `'#'` character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. |
8
8
**UpdatedAt** | **string** | Last modification [timestamp](#workingwithdates) in RFC 3339 format, e.g., `\"2016-08-15T23:59:33.123Z\"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. | [optional]
9
9
**Version** | **long?** | The version of the object. When updating an object, the version supplied by the must match the version in the database, otherwise the write will be rejected as conflicting. | [optional]
10
-
**IsDeleted** | **bool?** | 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. being inserted. When deleted, the `updated_at` field will equal the deletion time. | [optional]
11
-
**CatalogV1Ids** | [**List<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]
10
+
**IsDeleted** | **bool?** | 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]
11
+
**CatalogV1Ids** | [**List<CatalogV1Id>**](CatalogV1Id.md) | The Connect V1 IDs for this object at each [location][#type-location] where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs. | [optional]
12
12
**PresentAtAllLocations** | **bool?** | 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. | [optional]
13
13
**PresentAtLocationIds** | **List<string>** | A list of locations where the object is present, even if `present_at_all_locations` is `false`. | [optional]
14
14
**AbsentAtLocationIds** | **List<string>** | A list of locations where the object is not present, even if `present_at_all_locations` is `true`. | [optional]
Copy file name to clipboardExpand all lines: docs/CatalogQuery.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ Name | Type | Description | Notes
7
7
**ExactQuery** | [**CatalogQueryExact**](CatalogQueryExact.md) | A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive value. | [optional]
8
8
**PrefixQuery** | [**CatalogQueryPrefix**](CatalogQueryPrefix.md) | A query that returns only objects for which the given (string-valued) attribute has the given case-insensitive prefix. | [optional]
9
9
**RangeQuery** | [**CatalogQueryRange**](CatalogQueryRange.md) | A query that returns only objects for which the given (integer-valued) attribute lies in the given range. | [optional]
10
-
**TextQuery** | [**CatalogQueryText**](CatalogQueryText.md) | A query that returns only objects whose searchable attributes contain all of the given keywords as prefixes. For example, if a [CatalogItem](#type-catalogitem) contains attributes `{\"name\": \"t-shirt\"}` and `{\"description\": \"Small, Red\"}`, it will be matched by the query `{\"keywords\": [\"shirt\", \"sm\", \"re\"]}`. | [optional]
10
+
**TextQuery** | [**CatalogQueryText**](CatalogQueryText.md) | A query that returns only objects whose searchable attributes contain all of the given keywords as prefixes. For example, if a [CatalogItem](#type-catalogitem) contains attributes `{\"name\": \"t-shirt\"}` and `{\"description\": \"Small, Purple\"}`, it will be matched by the query `{\"keywords\": [\"shirt\", \"sma\", \"purp\"]}`. | [optional]
11
11
**ItemsForTaxQuery** | [**CatalogQueryItemsForTax**](CatalogQueryItemsForTax.md) | A query that returns all [CatalogItem](#type-catalogitem)s that have any of the given [CatalogTax](#type-catalogtax)es enabled. | [optional]
12
12
**ItemsForModifierListQuery** | [**CatalogQueryItemsForModifierList**](CatalogQueryItemsForModifierList.md) | A query that returns all [CatalogItem](#type-catalogitem)s that have any of the given [CatalogModifierList](#type-catalogmodifierlist)s enabled. | [optional]
Copy file name to clipboardExpand all lines: docs/CatalogTax.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
6
6
**Name** | **string** | The tax's name. Searchable. |
7
7
**CalculationPhase** | **CalculationPhaseEnum** | Whether the tax is calculated based on a payment's subtotal or total. See [TaxCalculationPhase](#type-taxcalculationphase) for all possible values. | [optional]
8
8
**InclusionType** | **InclusionTypeEnum** | Whether the tax is `ADDITIVE` or `INCLUSIVE`. See [TaxInclusionType](#type-taxinclusiontype) for all possible values. | [optional]
9
-
**Percentage** | **string** | The percentage of the tax in decimal form, using a '.' as the decimal separator and without a '%' sign. A value of `7.5` corresponds to 7.5%. | [optional]
9
+
**Percentage** | **string** | The percentage of the tax in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. A value of `7.5` corresponds to 7.5%. | [optional]
10
10
**AppliesToCustomAmounts** | **bool?** | If `true`, the fee applies to custom amounts entered into the Square Point of Sale app that are not associated with a particular [CatalogItem](#type-catalogitem). | [optional]
11
11
**Enabled** | **bool?** | If `true`, the tax will be shown as enabled in the Square Point of Sale app. | [optional]
**IdempotencyKey** | **string** | A unique string that identifies this checkout among others you've created. It can be any valid string but must be unique for every order sent to Square Checkout for a given location ID. The idempotency key is used to avoid processing the same order more than once. If you're unsure whether a particular checkout was created successfully, you can reattempt it with the same idempotency key and all the same other parameters without worrying about creating duplicates. We recommend using a random number/string generator native to the language you are working in to generate strings for your idempotency keys. See [Idempotency keys](#idempotencykeys) for more information. |
7
-
**Order** | [**CreateOrderRequestOrder**](CreateOrderRequestOrder.md) | The order including line items to be checked out. |
7
+
**Order** | [**CreateOrderRequest**](CreateOrderRequest.md) | The order including line items to be checked out. |
8
8
**AskForShippingAddress** | **bool?** | If `true`, Square Checkout will collect shipping information on your behalf and store that information with the transaction information in your Square Dashboard. Default: `false`. | [optional]
9
9
**MerchantSupportEmail** | **string** | The email address to display on the Square Checkout confirmation page and confirmation email that the buyer can use to contact the merchant. If this value is not set, the confirmation page and email will display the primary email address associated with the merchant's Square account. Default: none; only exists if explicitly set. | [optional]
10
10
**PrePopulateBuyerEmail** | **string** | If provided, the buyer's email is pre-populated on the checkout page as an editable text field. Default: none; only exists if explicitly set. | [optional]
0 commit comments