`](../../doc/models/catalog-custom-attribute-value.md) | Optional | A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair
is a [CatalogCustomAttributeValue](entity:CatalogCustomAttributeValue) object. The key is the `key` attribute
value defined in the associated [CatalogCustomAttributeDefinition](entity: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 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.). | getCustomAttributeValues(): ?array | setCustomAttributeValues(?array customAttributeValues): void |
-| `catalogV1Ids` | [`?(CatalogV1Id[])`](../../doc/models/catalog-v1-id.md) | Optional | 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. | getCatalogV1Ids(): ?array | setCatalogV1Ids(?array catalogV1Ids): void |
-| `presentAtAllLocations` | `?bool` | Optional | 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`. | getPresentAtAllLocations(): ?bool | setPresentAtAllLocations(?bool presentAtAllLocations): void |
-| `presentAtLocationIds` | `?(string[])` | Optional | A list of locations where the object is present, even if `present_at_all_locations` is `false`.
This can include locations that are deactivated. | getPresentAtLocationIds(): ?array | setPresentAtLocationIds(?array presentAtLocationIds): void |
-| `absentAtLocationIds` | `?(string[])` | Optional | A list of locations where the object is not present, even if `present_at_all_locations` is `true`.
This can include locations that are deactivated. | getAbsentAtLocationIds(): ?array | setAbsentAtLocationIds(?array absentAtLocationIds): void |
-| `itemData` | [`?CatalogItem`](../../doc/models/catalog-item.md) | Optional | A [CatalogObject](../../doc/models/catalog-object.md) instance of the `ITEM` type, also referred to as an item, in the catalog. | getItemData(): ?CatalogItem | setItemData(?CatalogItem itemData): void |
-| `categoryData` | [`?CatalogCategory`](../../doc/models/catalog-category.md) | Optional | A category to which a `CatalogItem` instance belongs. | getCategoryData(): ?CatalogCategory | setCategoryData(?CatalogCategory categoryData): void |
-| `itemVariationData` | [`?CatalogItemVariation`](../../doc/models/catalog-item-variation.md) | Optional | An item variation, representing a product for sale, in the Catalog object model. Each [item](../../doc/models/catalog-item.md) must have at least one
item variation and can have at most 250 item variations.
An item variation can be sellable, stockable, or both if it has a unit of measure for its count for the sold number of the variation, the stocked
number of the variation, or both. For example, when a variation representing wine is stocked and sold by the bottle, the variation is both
stockable and sellable. But when a variation of the wine is sold by the glass, the sold units cannot be used as a measure of the stocked units. This by-the-glass
variation is sellable, but not stockable. To accurately keep track of the wine's inventory count at any time, the sellable count must be
converted to stockable count. Typically, the seller defines this unit conversion. For example, 1 bottle equals 5 glasses. The Square API exposes
the `stockable_conversion` property on the variation to specify the conversion. Thus, when two glasses of the wine are sold, the sellable count
decreases by 2, and the stockable count automatically decreases by 0.4 bottle according to the conversion. | getItemVariationData(): ?CatalogItemVariation | setItemVariationData(?CatalogItemVariation itemVariationData): void |
-| `taxData` | [`?CatalogTax`](../../doc/models/catalog-tax.md) | Optional | A tax applicable to an item. | getTaxData(): ?CatalogTax | setTaxData(?CatalogTax taxData): void |
-| `discountData` | [`?CatalogDiscount`](../../doc/models/catalog-discount.md) | Optional | A discount applicable to items. | getDiscountData(): ?CatalogDiscount | setDiscountData(?CatalogDiscount discountData): void |
-| `modifierListData` | [`?CatalogModifierList`](../../doc/models/catalog-modifier-list.md) | Optional | For a text-based modifier, this encapsulates the modifier's text when its `modifier_type` is `TEXT`.
For example, to sell T-shirts with custom prints, a text-based modifier can be used to capture the buyer-supplied
text string to be selected for the T-shirt at the time of sale.
For non text-based modifiers, this encapsulates a non-empty list of modifiers applicable to items
at the time of sale. Each element of the modifier list is a `CatalogObject` instance of the `MODIFIER` type.
For example, a "Condiments" modifier list applicable to a "Hot Dog" item
may contain "Ketchup", "Mustard", and "Relish" modifiers.
A non text-based modifier can be applied to the modified item once or multiple times, if the `selection_type` field
is set to `SINGLE` or `MULTIPLE`, respectively. On the other hand, a text-based modifier can be applied to the item
only once and the `selection_type` field is always set to `SINGLE`. | getModifierListData(): ?CatalogModifierList | setModifierListData(?CatalogModifierList modifierListData): void |
-| `modifierData` | [`?CatalogModifier`](../../doc/models/catalog-modifier.md) | Optional | A modifier applicable to items at the time of sale. An example of a modifier is a Cheese add-on to a Burger item. | getModifierData(): ?CatalogModifier | setModifierData(?CatalogModifier modifierData): void |
-| `timePeriodData` | [`?CatalogTimePeriod`](../../doc/models/catalog-time-period.md) | Optional | Represents a time period - either a single period or a repeating period. | getTimePeriodData(): ?CatalogTimePeriod | setTimePeriodData(?CatalogTimePeriod timePeriodData): void |
-| `productSetData` | [`?CatalogProductSet`](../../doc/models/catalog-product-set.md) | Optional | 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. | getProductSetData(): ?CatalogProductSet | setProductSetData(?CatalogProductSet productSetData): void |
-| `pricingRuleData` | [`?CatalogPricingRule`](../../doc/models/catalog-pricing-rule.md) | Optional | Defines how discounts are automatically applied to a set of items that match the pricing rule
during the active time period. | getPricingRuleData(): ?CatalogPricingRule | setPricingRuleData(?CatalogPricingRule pricingRuleData): void |
-| `imageData` | [`?CatalogImage`](../../doc/models/catalog-image.md) | Optional | An image file to use in Square catalogs. It can be associated with
`CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, and `CatalogModifierList` objects.
Only the images on items and item variations are exposed in Dashboard.
Only the first image on an item is displayed in Square Point of Sale (SPOS).
Images on items and variations are displayed through Square Online Store.
Images on other object types are for use by 3rd party application developers. | getImageData(): ?CatalogImage | setImageData(?CatalogImage imageData): void |
-| `measurementUnitData` | [`?CatalogMeasurementUnit`](../../doc/models/catalog-measurement-unit.md) | Optional | Represents the unit used to measure a `CatalogItemVariation` and
specifies the precision for decimal quantities. | getMeasurementUnitData(): ?CatalogMeasurementUnit | setMeasurementUnitData(?CatalogMeasurementUnit measurementUnitData): void |
-| `subscriptionPlanData` | [`?CatalogSubscriptionPlan`](../../doc/models/catalog-subscription-plan.md) | Optional | Describes a subscription plan. A subscription plan represents what you want to sell in a subscription model, and includes references to each of the associated subscription plan variations.
For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations). | getSubscriptionPlanData(): ?CatalogSubscriptionPlan | setSubscriptionPlanData(?CatalogSubscriptionPlan subscriptionPlanData): void |
-| `itemOptionData` | [`?CatalogItemOption`](../../doc/models/catalog-item-option.md) | Optional | A group of variations for a `CatalogItem`. | getItemOptionData(): ?CatalogItemOption | setItemOptionData(?CatalogItemOption itemOptionData): void |
-| `itemOptionValueData` | [`?CatalogItemOptionValue`](../../doc/models/catalog-item-option-value.md) | Optional | An enumerated value that can link a
`CatalogItemVariation` to an item option as one of
its item option values. | getItemOptionValueData(): ?CatalogItemOptionValue | setItemOptionValueData(?CatalogItemOptionValue itemOptionValueData): void |
-| `customAttributeDefinitionData` | [`?CatalogCustomAttributeDefinition`](../../doc/models/catalog-custom-attribute-definition.md) | Optional | Contains information defining a custom attribute. Custom attributes are
intended to store additional information about a catalog object or to associate a
catalog object with an entity in another system. Do not use custom attributes
to store any sensitive information (personally identifiable information, card details, etc.).
[Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes) | getCustomAttributeDefinitionData(): ?CatalogCustomAttributeDefinition | setCustomAttributeDefinitionData(?CatalogCustomAttributeDefinition customAttributeDefinitionData): void |
-| `quickAmountsSettingsData` | [`?CatalogQuickAmountsSettings`](../../doc/models/catalog-quick-amounts-settings.md) | Optional | A parent Catalog Object model represents a set of Quick Amounts and the settings control the amounts. | getQuickAmountsSettingsData(): ?CatalogQuickAmountsSettings | setQuickAmountsSettingsData(?CatalogQuickAmountsSettings quickAmountsSettingsData): void |
-| `subscriptionPlanVariationData` | [`?CatalogSubscriptionPlanVariation`](../../doc/models/catalog-subscription-plan-variation.md) | Optional | Describes a subscription plan variation. A subscription plan variation represents how the subscription for a product or service is sold.
For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations). | getSubscriptionPlanVariationData(): ?CatalogSubscriptionPlanVariation | setSubscriptionPlanVariationData(?CatalogSubscriptionPlanVariation subscriptionPlanVariationData): void |
-| `availabilityPeriodData` | [`?CatalogAvailabilityPeriod`](../../doc/models/catalog-availability-period.md) | Optional | Represents a time period of availability. | getAvailabilityPeriodData(): ?CatalogAvailabilityPeriod | setAvailabilityPeriodData(?CatalogAvailabilityPeriod availabilityPeriodData): void |
-
-## Example (as JSON)
-
-```json
-{
- "type": "TIME_PERIOD",
- "id": "id4",
- "category_data": {
- "object": {
- "category_data": {
- "name": "Beverages"
- },
- "id": "#Beverages",
- "present_at_all_locations": true,
- "type": "CATEGORY"
- }
- },
- "tax_data": {
- "object": {
- "id": "#SalesTax",
- "present_at_all_locations": true,
- "tax_data": {
- "calculation_phase": "TAX_SUBTOTAL_PHASE",
- "enabled": true,
- "fee_applies_to_custom_amounts": true,
- "inclusion_type": "ADDITIVE",
- "name": "Sales Tax",
- "percentage": "5.0"
- },
- "type": "TAX"
- }
- },
- "discount_data": {
- "object": {
- "discount_data": {
- "discount_type": "FIXED_PERCENTAGE",
- "label_color": "red",
- "name": "Welcome to the Dark(Roast) Side!",
- "percentage": "5.4",
- "pin_required": false
- },
- "id": "#Maythe4th",
- "present_at_all_locations": true,
- "type": "DISCOUNT"
- }
- },
- "modifier_data": {
- "object": {
- "modifier_data": {
- "name": "Almond Milk",
- "price_money": {
- "amount": 250,
- "currency": "USD"
- }
- },
- "present_at_all_locations": true,
- "type": "MODIFIER"
- }
- },
- "updated_at": "updated_at0",
- "version": 186,
- "is_deleted": false,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key2": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
-}
-```
-
diff --git a/doc/models/catalog-pricing-rule.md b/doc/models/catalog-pricing-rule.md
deleted file mode 100644
index 16b9aeab..00000000
--- a/doc/models/catalog-pricing-rule.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-# Catalog Pricing Rule
-
-Defines how discounts are automatically applied to a set of items that match the pricing rule
-during the active time period.
-
-## Structure
-
-`CatalogPricingRule`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `name` | `?string` | Optional | User-defined name for the pricing rule. For example, "Buy one get one
free" or "10% off". | getName(): ?string | setName(?string name): void |
-| `timePeriodIds` | `?(string[])` | Optional | A list of unique IDs for the catalog time periods when
this pricing rule is in effect. If left unset, the pricing rule is always
in effect. | getTimePeriodIds(): ?array | setTimePeriodIds(?array timePeriodIds): void |
-| `discountId` | `?string` | Optional | Unique ID for the `CatalogDiscount` to take off
the price of all matched items. | getDiscountId(): ?string | setDiscountId(?string discountId): void |
-| `matchProductsId` | `?string` | Optional | Unique ID for the `CatalogProductSet` that will be matched by this rule. A match rule
matches within the entire cart, and can match multiple times. This field will always be set. | getMatchProductsId(): ?string | setMatchProductsId(?string matchProductsId): void |
-| `applyProductsId` | `?string` | Optional | __Deprecated__: Please use the `exclude_products_id` field to apply
an exclude set instead. Exclude sets allow better control over quantity
ranges and offer more flexibility for which matched items receive a discount.
`CatalogProductSet` 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. | getApplyProductsId(): ?string | setApplyProductsId(?string applyProductsId): void |
-| `excludeProductsId` | `?string` | Optional | `CatalogProductSet` to exclude from the 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. | getExcludeProductsId(): ?string | setExcludeProductsId(?string excludeProductsId): void |
-| `validFromDate` | `?string` | Optional | Represents the date the Pricing Rule is valid from. Represented in RFC 3339 full-date format (YYYY-MM-DD). | getValidFromDate(): ?string | setValidFromDate(?string validFromDate): void |
-| `validFromLocalTime` | `?string` | Optional | Represents the local time the pricing rule should be valid from. Represented in RFC 3339 partial-time format
(HH:MM:SS). Partial seconds will be truncated. | getValidFromLocalTime(): ?string | setValidFromLocalTime(?string validFromLocalTime): void |
-| `validUntilDate` | `?string` | Optional | Represents the date the Pricing Rule is valid until. Represented in RFC 3339 full-date format (YYYY-MM-DD). | getValidUntilDate(): ?string | setValidUntilDate(?string validUntilDate): void |
-| `validUntilLocalTime` | `?string` | Optional | Represents the local time the pricing rule should be valid until. Represented in RFC 3339 partial-time format
(HH:MM:SS). Partial seconds will be truncated. | getValidUntilLocalTime(): ?string | setValidUntilLocalTime(?string validUntilLocalTime): void |
-| `excludeStrategy` | [`?string(ExcludeStrategy)`](../../doc/models/exclude-strategy.md) | Optional | Indicates which products matched by a CatalogPricingRule
will be excluded if the pricing rule uses an exclude set. | getExcludeStrategy(): ?string | setExcludeStrategy(?string excludeStrategy): void |
-| `minimumOrderSubtotalMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getMinimumOrderSubtotalMoney(): ?Money | setMinimumOrderSubtotalMoney(?Money minimumOrderSubtotalMoney): void |
-| `customerGroupIdsAny` | `?(string[])` | Optional | A list of IDs of customer groups, the members of which are eligible for discounts specified in this pricing rule.
Notice that a group ID is generated by the Customers API.
If this field is not set, the specified discount applies to matched products sold to anyone whether the buyer
has a customer profile created or not. If this `customer_group_ids_any` field is set, the specified discount
applies only to matched products sold to customers belonging to the specified customer groups. | getCustomerGroupIdsAny(): ?array | setCustomerGroupIdsAny(?array customerGroupIdsAny): void |
-
-## Example (as JSON)
-
-```json
-{
- "name": "name6",
- "time_period_ids": [
- "time_period_ids8"
- ],
- "discount_id": "discount_id4",
- "match_products_id": "match_products_id4",
- "apply_products_id": "apply_products_id0"
-}
-```
-
diff --git a/doc/models/catalog-pricing-type.md b/doc/models/catalog-pricing-type.md
deleted file mode 100644
index f49d4587..00000000
--- a/doc/models/catalog-pricing-type.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Catalog Pricing Type
-
-Indicates whether the price of a CatalogItemVariation should be entered manually at the time of sale.
-
-## Enumeration
-
-`CatalogPricingType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `FIXED_PRICING` | The catalog item variation's price is fixed. |
-| `VARIABLE_PRICING` | The catalog item variation's price is entered at the time of sale. |
-
diff --git a/doc/models/catalog-product-set.md b/doc/models/catalog-product-set.md
deleted file mode 100644
index 081a3545..00000000
--- a/doc/models/catalog-product-set.md
+++ /dev/null
@@ -1,41 +0,0 @@
-
-# Catalog Product Set
-
-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.
-
-## Structure
-
-`CatalogProductSet`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `name` | `?string` | Optional | User-defined name for the product set. For example, "Clearance Items"
or "Winter Sale Items". | getName(): ?string | setName(?string name): void |
-| `productIdsAny` | `?(string[])` | Optional | Unique IDs for any `CatalogObject` included in this product set. Any
number of these catalog objects can be in an order for a pricing rule to apply.
This can be used with `product_ids_all` in a parent `CatalogProductSet` to
match groups of products for a bulk discount, such as a discount for an
entree and side combo.
Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.
Max: 500 catalog object IDs. | getProductIdsAny(): ?array | setProductIdsAny(?array productIdsAny): void |
-| `productIdsAll` | `?(string[])` | Optional | Unique IDs for any `CatalogObject` included in this product set.
All objects in this set must be included in an order for a pricing rule to apply.
Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set.
Max: 500 catalog object IDs. | getProductIdsAll(): ?array | setProductIdsAll(?array productIdsAll): void |
-| `quantityExact` | `?int` | Optional | If set, there must be exactly this many items from `products_any` or `products_all`
in the cart for the discount to apply.
Cannot be combined with either `quantity_min` or `quantity_max`. | getQuantityExact(): ?int | setQuantityExact(?int quantityExact): void |
-| `quantityMin` | `?int` | Optional | If set, there must be at least this many items from `products_any` or `products_all`
in a cart for the discount to apply. See `quantity_exact`. Defaults to 0 if
`quantity_exact`, `quantity_min` and `quantity_max` are all unspecified. | getQuantityMin(): ?int | setQuantityMin(?int quantityMin): void |
-| `quantityMax` | `?int` | Optional | If set, the pricing rule will apply to a maximum of this many items from
`products_any` or `products_all`. | getQuantityMax(): ?int | setQuantityMax(?int quantityMax): void |
-| `allProducts` | `?bool` | Optional | If set to `true`, the product set will include every item in the catalog.
Only one of `product_ids_all`, `product_ids_any`, or `all_products` can be set. | getAllProducts(): ?bool | setAllProducts(?bool allProducts): void |
-
-## Example (as JSON)
-
-```json
-{
- "name": "name6",
- "product_ids_any": [
- "product_ids_any8"
- ],
- "product_ids_all": [
- "product_ids_all7"
- ],
- "quantity_exact": 222,
- "quantity_min": 100
-}
-```
-
diff --git a/doc/models/catalog-query-exact.md b/doc/models/catalog-query-exact.md
deleted file mode 100644
index ea0e475a..00000000
--- a/doc/models/catalog-query-exact.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Catalog Query Exact
-
-The query filter to return the search result by exact match of the specified attribute name and value.
-
-## Structure
-
-`CatalogQueryExact`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `attributeName` | `string` | Required | The name of the attribute to be searched. Matching of the attribute name is exact.
**Constraints**: *Minimum Length*: `1` | getAttributeName(): string | setAttributeName(string attributeName): void |
-| `attributeValue` | `string` | Required | The desired value of the search attribute. Matching of the attribute value is case insensitive and can be partial.
For example, if a specified value of "sma", objects with the named attribute value of "Small", "small" are both matched. | getAttributeValue(): string | setAttributeValue(string attributeValue): void |
-
-## Example (as JSON)
-
-```json
-{
- "attribute_name": "attribute_name4",
- "attribute_value": "attribute_value6"
-}
-```
-
diff --git a/doc/models/catalog-query-item-variations-for-item-option-values.md b/doc/models/catalog-query-item-variations-for-item-option-values.md
deleted file mode 100644
index f67c1b17..00000000
--- a/doc/models/catalog-query-item-variations-for-item-option-values.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Catalog Query Item Variations for Item Option Values
-
-The query filter to return the item variations containing the specified item option value IDs.
-
-## Structure
-
-`CatalogQueryItemVariationsForItemOptionValues`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `itemOptionValueIds` | `?(string[])` | Optional | A set of `CatalogItemOptionValue` IDs to be used to find associated
`CatalogItemVariation`s. All ItemVariations that contain all of the given
Item Option Values (in any order) will be returned. | getItemOptionValueIds(): ?array | setItemOptionValueIds(?array itemOptionValueIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "item_option_value_ids": [
- "item_option_value_ids0",
- "item_option_value_ids9",
- "item_option_value_ids8"
- ]
-}
-```
-
diff --git a/doc/models/catalog-query-items-for-item-options.md b/doc/models/catalog-query-items-for-item-options.md
deleted file mode 100644
index 82e14847..00000000
--- a/doc/models/catalog-query-items-for-item-options.md
+++ /dev/null
@@ -1,26 +0,0 @@
-
-# Catalog Query Items for Item Options
-
-The query filter to return the items containing the specified item option IDs.
-
-## Structure
-
-`CatalogQueryItemsForItemOptions`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `itemOptionIds` | `?(string[])` | Optional | A set of `CatalogItemOption` IDs to be used to find associated
`CatalogItem`s. All Items that contain all of the given Item Options (in any order)
will be returned. | getItemOptionIds(): ?array | setItemOptionIds(?array itemOptionIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "item_option_ids": [
- "item_option_ids5",
- "item_option_ids6"
- ]
-}
-```
-
diff --git a/doc/models/catalog-query-items-for-modifier-list.md b/doc/models/catalog-query-items-for-modifier-list.md
deleted file mode 100644
index 7d8a78f2..00000000
--- a/doc/models/catalog-query-items-for-modifier-list.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Catalog Query Items for Modifier List
-
-The query filter to return the items containing the specified modifier list IDs.
-
-## Structure
-
-`CatalogQueryItemsForModifierList`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `modifierListIds` | `string[]` | Required | A set of `CatalogModifierList` IDs to be used to find associated `CatalogItem`s. | getModifierListIds(): array | setModifierListIds(array modifierListIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "modifier_list_ids": [
- "modifier_list_ids8",
- "modifier_list_ids9",
- "modifier_list_ids0"
- ]
-}
-```
-
diff --git a/doc/models/catalog-query-items-for-tax.md b/doc/models/catalog-query-items-for-tax.md
deleted file mode 100644
index d8b943e8..00000000
--- a/doc/models/catalog-query-items-for-tax.md
+++ /dev/null
@@ -1,26 +0,0 @@
-
-# Catalog Query Items for Tax
-
-The query filter to return the items containing the specified tax IDs.
-
-## Structure
-
-`CatalogQueryItemsForTax`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `taxIds` | `string[]` | Required | A set of `CatalogTax` IDs to be used to find associated `CatalogItem`s. | getTaxIds(): array | setTaxIds(array taxIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "tax_ids": [
- "tax_ids9",
- "tax_ids8"
- ]
-}
-```
-
diff --git a/doc/models/catalog-query-prefix.md b/doc/models/catalog-query-prefix.md
deleted file mode 100644
index 10d655ef..00000000
--- a/doc/models/catalog-query-prefix.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Catalog Query Prefix
-
-The query filter to return the search result whose named attribute values are prefixed by the specified attribute value.
-
-## Structure
-
-`CatalogQueryPrefix`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `attributeName` | `string` | Required | The name of the attribute to be searched.
**Constraints**: *Minimum Length*: `1` | getAttributeName(): string | setAttributeName(string attributeName): void |
-| `attributePrefix` | `string` | Required | The desired prefix of the search attribute value.
**Constraints**: *Minimum Length*: `1` | getAttributePrefix(): string | setAttributePrefix(string attributePrefix): void |
-
-## Example (as JSON)
-
-```json
-{
- "attribute_name": "attribute_name8",
- "attribute_prefix": "attribute_prefix6"
-}
-```
-
diff --git a/doc/models/catalog-query-range.md b/doc/models/catalog-query-range.md
deleted file mode 100644
index 4d3e6875..00000000
--- a/doc/models/catalog-query-range.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Catalog Query Range
-
-The query filter to return the search result whose named attribute values fall between the specified range.
-
-## Structure
-
-`CatalogQueryRange`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `attributeName` | `string` | Required | The name of the attribute to be searched.
**Constraints**: *Minimum Length*: `1` | getAttributeName(): string | setAttributeName(string attributeName): void |
-| `attributeMinValue` | `?int` | Optional | The desired minimum value for the search attribute (inclusive). | getAttributeMinValue(): ?int | setAttributeMinValue(?int attributeMinValue): void |
-| `attributeMaxValue` | `?int` | Optional | The desired maximum value for the search attribute (inclusive). | getAttributeMaxValue(): ?int | setAttributeMaxValue(?int attributeMaxValue): void |
-
-## Example (as JSON)
-
-```json
-{
- "attribute_name": "attribute_name0",
- "attribute_min_value": 184,
- "attribute_max_value": 94
-}
-```
-
diff --git a/doc/models/catalog-query-set.md b/doc/models/catalog-query-set.md
deleted file mode 100644
index 3305161a..00000000
--- a/doc/models/catalog-query-set.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# Catalog Query Set
-
-The query filter to return the search result(s) by exact match of the specified `attribute_name` and any of
-the `attribute_values`.
-
-## Structure
-
-`CatalogQuerySet`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `attributeName` | `string` | Required | The name of the attribute to be searched. Matching of the attribute name is exact.
**Constraints**: *Minimum Length*: `1` | getAttributeName(): string | setAttributeName(string attributeName): void |
-| `attributeValues` | `string[]` | Required | The desired values of the search attribute. Matching of the attribute values is exact and case insensitive.
A maximum of 250 values may be searched in a request. | getAttributeValues(): array | setAttributeValues(array attributeValues): void |
-
-## Example (as JSON)
-
-```json
-{
- "attribute_name": "attribute_name0",
- "attribute_values": [
- "attribute_values8"
- ]
-}
-```
-
diff --git a/doc/models/catalog-query-sorted-attribute.md b/doc/models/catalog-query-sorted-attribute.md
deleted file mode 100644
index b8d67edd..00000000
--- a/doc/models/catalog-query-sorted-attribute.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Catalog Query Sorted Attribute
-
-The query expression to specify the key to sort search results.
-
-## Structure
-
-`CatalogQuerySortedAttribute`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `attributeName` | `string` | Required | The attribute whose value is used as the sort key.
**Constraints**: *Minimum Length*: `1` | getAttributeName(): string | setAttributeName(string attributeName): void |
-| `initialAttributeValue` | `?string` | Optional | The first attribute value to be returned by the query. Ascending sorts will return only
objects with this value or greater, while descending sorts will return only objects with this value
or less. If unset, start at the beginning (for ascending sorts) or end (for descending sorts). | getInitialAttributeValue(): ?string | setInitialAttributeValue(?string initialAttributeValue): void |
-| `sortOrder` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-
-## Example (as JSON)
-
-```json
-{
- "attribute_name": "attribute_name2",
- "initial_attribute_value": "initial_attribute_value4",
- "sort_order": "DESC"
-}
-```
-
diff --git a/doc/models/catalog-query-text.md b/doc/models/catalog-query-text.md
deleted file mode 100644
index 1fddbdfb..00000000
--- a/doc/models/catalog-query-text.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Catalog Query Text
-
-The query filter to return the search result whose searchable attribute values contain all of the specified keywords or tokens, independent of the token order or case.
-
-## Structure
-
-`CatalogQueryText`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `keywords` | `string[]` | Required | A list of 1, 2, or 3 search keywords. Keywords with fewer than 3 alphanumeric characters are ignored. | getKeywords(): array | setKeywords(array keywords): void |
-
-## Example (as JSON)
-
-```json
-{
- "keywords": [
- "keywords1"
- ]
-}
-```
-
diff --git a/doc/models/catalog-query.md b/doc/models/catalog-query.md
deleted file mode 100644
index be9e7448..00000000
--- a/doc/models/catalog-query.md
+++ /dev/null
@@ -1,82 +0,0 @@
-
-# Catalog Query
-
-A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint.
-
-Although a query can have multiple filters, only certain query types can be combined per call to [SearchCatalogObjects](../../doc/apis/catalog.md#search-catalog-objects).
-Any combination of the following types may be used together:
-
-- [exact_query](../../doc/models/catalog-query-exact.md)
-- [prefix_query](../../doc/models/catalog-query-prefix.md)
-- [range_query](../../doc/models/catalog-query-range.md)
-- [sorted_attribute_query](../../doc/models/catalog-query-sorted-attribute.md)
-- [text_query](../../doc/models/catalog-query-text.md)
-
-All other query types cannot be combined with any others.
-
-When a query filter is based on an attribute, the attribute must be searchable.
-Searchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters.
-
-Searchable attribute and objects queryable by searchable attributes:
-
-- `name`: `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, `CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue`
-- `description`: `CatalogItem`, `CatalogItemOptionValue`
-- `abbreviation`: `CatalogItem`
-- `upc`: `CatalogItemVariation`
-- `sku`: `CatalogItemVariation`
-- `caption`: `CatalogImage`
-- `display_name`: `CatalogItemOption`
-
-For example, to search for [CatalogItem](../../doc/models/catalog-item.md) objects by searchable attributes, you can use
-the `"name"`, `"description"`, or `"abbreviation"` attribute in an applicable query filter.
-
-## Structure
-
-`CatalogQuery`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `sortedAttributeQuery` | [`?CatalogQuerySortedAttribute`](../../doc/models/catalog-query-sorted-attribute.md) | Optional | The query expression to specify the key to sort search results. | getSortedAttributeQuery(): ?CatalogQuerySortedAttribute | setSortedAttributeQuery(?CatalogQuerySortedAttribute sortedAttributeQuery): void |
-| `exactQuery` | [`?CatalogQueryExact`](../../doc/models/catalog-query-exact.md) | Optional | The query filter to return the search result by exact match of the specified attribute name and value. | getExactQuery(): ?CatalogQueryExact | setExactQuery(?CatalogQueryExact exactQuery): void |
-| `setQuery` | [`?CatalogQuerySet`](../../doc/models/catalog-query-set.md) | Optional | The query filter to return the search result(s) by exact match of the specified `attribute_name` and any of
the `attribute_values`. | getSetQuery(): ?CatalogQuerySet | setSetQuery(?CatalogQuerySet setQuery): void |
-| `prefixQuery` | [`?CatalogQueryPrefix`](../../doc/models/catalog-query-prefix.md) | Optional | The query filter to return the search result whose named attribute values are prefixed by the specified attribute value. | getPrefixQuery(): ?CatalogQueryPrefix | setPrefixQuery(?CatalogQueryPrefix prefixQuery): void |
-| `rangeQuery` | [`?CatalogQueryRange`](../../doc/models/catalog-query-range.md) | Optional | The query filter to return the search result whose named attribute values fall between the specified range. | getRangeQuery(): ?CatalogQueryRange | setRangeQuery(?CatalogQueryRange rangeQuery): void |
-| `textQuery` | [`?CatalogQueryText`](../../doc/models/catalog-query-text.md) | Optional | The query filter to return the search result whose searchable attribute values contain all of the specified keywords or tokens, independent of the token order or case. | getTextQuery(): ?CatalogQueryText | setTextQuery(?CatalogQueryText textQuery): void |
-| `itemsForTaxQuery` | [`?CatalogQueryItemsForTax`](../../doc/models/catalog-query-items-for-tax.md) | Optional | The query filter to return the items containing the specified tax IDs. | getItemsForTaxQuery(): ?CatalogQueryItemsForTax | setItemsForTaxQuery(?CatalogQueryItemsForTax itemsForTaxQuery): void |
-| `itemsForModifierListQuery` | [`?CatalogQueryItemsForModifierList`](../../doc/models/catalog-query-items-for-modifier-list.md) | Optional | The query filter to return the items containing the specified modifier list IDs. | getItemsForModifierListQuery(): ?CatalogQueryItemsForModifierList | setItemsForModifierListQuery(?CatalogQueryItemsForModifierList itemsForModifierListQuery): void |
-| `itemsForItemOptionsQuery` | [`?CatalogQueryItemsForItemOptions`](../../doc/models/catalog-query-items-for-item-options.md) | Optional | The query filter to return the items containing the specified item option IDs. | getItemsForItemOptionsQuery(): ?CatalogQueryItemsForItemOptions | setItemsForItemOptionsQuery(?CatalogQueryItemsForItemOptions itemsForItemOptionsQuery): void |
-| `itemVariationsForItemOptionValuesQuery` | [`?CatalogQueryItemVariationsForItemOptionValues`](../../doc/models/catalog-query-item-variations-for-item-option-values.md) | Optional | The query filter to return the item variations containing the specified item option value IDs. | getItemVariationsForItemOptionValuesQuery(): ?CatalogQueryItemVariationsForItemOptionValues | setItemVariationsForItemOptionValuesQuery(?CatalogQueryItemVariationsForItemOptionValues itemVariationsForItemOptionValuesQuery): void |
-
-## Example (as JSON)
-
-```json
-{
- "sorted_attribute_query": {
- "attribute_name": "attribute_name0",
- "initial_attribute_value": "initial_attribute_value8",
- "sort_order": "DESC"
- },
- "exact_query": {
- "attribute_name": "attribute_name4",
- "attribute_value": "attribute_value6"
- },
- "set_query": {
- "attribute_name": "attribute_name2",
- "attribute_values": [
- "attribute_values6"
- ]
- },
- "prefix_query": {
- "attribute_name": "attribute_name6",
- "attribute_prefix": "attribute_prefix8"
- },
- "range_query": {
- "attribute_name": "attribute_name0",
- "attribute_min_value": 208,
- "attribute_max_value": 138
- }
-}
-```
-
diff --git a/doc/models/catalog-quick-amount-type.md b/doc/models/catalog-quick-amount-type.md
deleted file mode 100644
index 4b35cc8c..00000000
--- a/doc/models/catalog-quick-amount-type.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Catalog Quick Amount Type
-
-Determines the type of a specific Quick Amount.
-
-## Enumeration
-
-`CatalogQuickAmountType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `QUICK_AMOUNT_TYPE_MANUAL` | Quick Amount is created manually by the seller. |
-| `QUICK_AMOUNT_TYPE_AUTO` | Quick Amount is generated automatically by machine learning algorithms. |
-
diff --git a/doc/models/catalog-quick-amount.md b/doc/models/catalog-quick-amount.md
deleted file mode 100644
index 738845ce..00000000
--- a/doc/models/catalog-quick-amount.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Catalog Quick Amount
-
-Represents a Quick Amount in the Catalog.
-
-## Structure
-
-`CatalogQuickAmount`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `type` | [`string(CatalogQuickAmountType)`](../../doc/models/catalog-quick-amount-type.md) | Required | Determines the type of a specific Quick Amount. | getType(): string | setType(string type): void |
-| `amount` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmount(): Money | setAmount(Money amount): void |
-| `score` | `?int` | Optional | Describes the ranking of the Quick Amount provided by machine learning model, in the range [0, 100].
MANUAL type amount will always have score = 100. | getScore(): ?int | setScore(?int score): void |
-| `ordinal` | `?int` | Optional | The order in which this Quick Amount should be displayed. | getOrdinal(): ?int | setOrdinal(?int ordinal): void |
-
-## Example (as JSON)
-
-```json
-{
- "type": "QUICK_AMOUNT_TYPE_MANUAL",
- "amount": {
- "amount": 0,
- "currency": "LAK"
- },
- "score": 12,
- "ordinal": 200
-}
-```
-
diff --git a/doc/models/catalog-quick-amounts-settings-option.md b/doc/models/catalog-quick-amounts-settings-option.md
deleted file mode 100644
index 52672a35..00000000
--- a/doc/models/catalog-quick-amounts-settings-option.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Catalog Quick Amounts Settings Option
-
-Determines a seller's option on Quick Amounts feature.
-
-## Enumeration
-
-`CatalogQuickAmountsSettingsOption`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `DISABLED` | Option for seller to disable Quick Amounts. |
-| `MANUAL` | Option for seller to choose manually created Quick Amounts. |
-| `AUTO` | Option for seller to choose automatically created Quick Amounts. |
-
diff --git a/doc/models/catalog-quick-amounts-settings.md b/doc/models/catalog-quick-amounts-settings.md
deleted file mode 100644
index 5c5ff893..00000000
--- a/doc/models/catalog-quick-amounts-settings.md
+++ /dev/null
@@ -1,46 +0,0 @@
-
-# Catalog Quick Amounts Settings
-
-A parent Catalog Object model represents a set of Quick Amounts and the settings control the amounts.
-
-## Structure
-
-`CatalogQuickAmountsSettings`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `option` | [`string(CatalogQuickAmountsSettingsOption)`](../../doc/models/catalog-quick-amounts-settings-option.md) | Required | Determines a seller's option on Quick Amounts feature. | getOption(): string | setOption(string option): void |
-| `eligibleForAutoAmounts` | `?bool` | Optional | Represents location's eligibility for auto amounts
The boolean should be consistent with whether there are AUTO amounts in the `amounts`. | getEligibleForAutoAmounts(): ?bool | setEligibleForAutoAmounts(?bool eligibleForAutoAmounts): void |
-| `amounts` | [`?(CatalogQuickAmount[])`](../../doc/models/catalog-quick-amount.md) | Optional | Represents a set of Quick Amounts at this location. | getAmounts(): ?array | setAmounts(?array amounts): void |
-
-## Example (as JSON)
-
-```json
-{
- "option": "AUTO",
- "eligible_for_auto_amounts": false,
- "amounts": [
- {
- "type": "QUICK_AMOUNT_TYPE_MANUAL",
- "amount": {
- "amount": 0,
- "currency": "LAK"
- },
- "score": 116,
- "ordinal": 48
- },
- {
- "type": "QUICK_AMOUNT_TYPE_MANUAL",
- "amount": {
- "amount": 0,
- "currency": "LAK"
- },
- "score": 116,
- "ordinal": 48
- }
- ]
-}
-```
-
diff --git a/doc/models/catalog-stock-conversion.md b/doc/models/catalog-stock-conversion.md
deleted file mode 100644
index aad6fcd5..00000000
--- a/doc/models/catalog-stock-conversion.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Catalog Stock Conversion
-
-Represents the rule of conversion between a stockable [CatalogItemVariation](../../doc/models/catalog-item-variation.md)
-and a non-stockable sell-by or receive-by `CatalogItemVariation` that
-share the same underlying stock.
-
-## Structure
-
-`CatalogStockConversion`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `stockableItemVariationId` | `string` | Required | References to the stockable [CatalogItemVariation](entity:CatalogItemVariation)
for this stock conversion. Selling, receiving or recounting the non-stockable `CatalogItemVariation`
defined with a stock conversion results in adjustments of this stockable `CatalogItemVariation`.
This immutable field must reference a stockable `CatalogItemVariation`
that shares the parent [CatalogItem](entity:CatalogItem) of the converted `CatalogItemVariation.`
**Constraints**: *Minimum Length*: `1` | getStockableItemVariationId(): string | setStockableItemVariationId(string stockableItemVariationId): void |
-| `stockableQuantity` | `string` | Required | The quantity of the stockable item variation (as identified by `stockable_item_variation_id`)
equivalent to the non-stockable item variation quantity (as specified in `nonstockable_quantity`)
as defined by this stock conversion. It accepts a decimal number in a string format that can take
up to 10 digits before the decimal point and up to 5 digits after the decimal point.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `16` | getStockableQuantity(): string | setStockableQuantity(string stockableQuantity): void |
-| `nonstockableQuantity` | `string` | Required | The converted equivalent quantity of the non-stockable [CatalogItemVariation](entity:CatalogItemVariation)
in its measurement unit. The `stockable_quantity` value and this `nonstockable_quantity` value together
define the conversion ratio between stockable item variation and the non-stockable item variation.
It accepts a decimal number in a string format that can take up to 10 digits before the decimal point
and up to 5 digits after the decimal point.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `16` | getNonstockableQuantity(): string | setNonstockableQuantity(string nonstockableQuantity): void |
-
-## Example (as JSON)
-
-```json
-{
- "stockable_item_variation_id": "stockable_item_variation_id2",
- "stockable_quantity": "stockable_quantity0",
- "nonstockable_quantity": "nonstockable_quantity2"
-}
-```
-
diff --git a/doc/models/catalog-subscription-plan-variation.md b/doc/models/catalog-subscription-plan-variation.md
deleted file mode 100644
index 4797b895..00000000
--- a/doc/models/catalog-subscription-plan-variation.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Catalog Subscription Plan Variation
-
-Describes a subscription plan variation. A subscription plan variation represents how the subscription for a product or service is sold.
-For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).
-
-## Structure
-
-`CatalogSubscriptionPlanVariation`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `name` | `string` | Required | The name of the plan variation. | getName(): string | setName(string name): void |
-| `phases` | [`SubscriptionPhase[]`](../../doc/models/subscription-phase.md) | Required | A list containing each [SubscriptionPhase](entity:SubscriptionPhase) for this plan variation. | getPhases(): array | setPhases(array phases): void |
-| `subscriptionPlanId` | `?string` | Optional | The id of the subscription plan, if there is one. | getSubscriptionPlanId(): ?string | setSubscriptionPlanId(?string subscriptionPlanId): void |
-| `monthlyBillingAnchorDate` | `?int` | Optional | The day of the month the billing period starts.
**Constraints**: `>= 1`, `<= 31` | getMonthlyBillingAnchorDate(): ?int | setMonthlyBillingAnchorDate(?int monthlyBillingAnchorDate): void |
-| `canProrate` | `?bool` | Optional | Whether bills for this plan variation can be split for proration. | getCanProrate(): ?bool | setCanProrate(?bool canProrate): void |
-| `successorPlanVariationId` | `?string` | Optional | The ID of a "successor" plan variation to this one. If the field is set, and this object is disabled at all
locations, it indicates that this variation is deprecated and the object identified by the successor ID be used in
its stead. | getSuccessorPlanVariationId(): ?string | setSuccessorPlanVariationId(?string successorPlanVariationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "name": "name2",
- "phases": [
- {
- "uid": "uid0",
- "cadence": "QUARTERLY",
- "periods": 112,
- "recurring_price_money": {
- "amount": 66,
- "currency": "ZMW"
- },
- "ordinal": 78,
- "pricing": {
- "type": "STATIC",
- "discount_ids": [
- "discount_ids5",
- "discount_ids6"
- ],
- "price_money": {
- "amount": 202,
- "currency": "GTQ"
- }
- }
- }
- ],
- "subscription_plan_id": "subscription_plan_id0",
- "monthly_billing_anchor_date": 38,
- "can_prorate": false,
- "successor_plan_variation_id": "successor_plan_variation_id2"
-}
-```
-
diff --git a/doc/models/catalog-subscription-plan.md b/doc/models/catalog-subscription-plan.md
deleted file mode 100644
index 9e7ad4dc..00000000
--- a/doc/models/catalog-subscription-plan.md
+++ /dev/null
@@ -1,194 +0,0 @@
-
-# Catalog Subscription Plan
-
-Describes a subscription plan. A subscription plan represents what you want to sell in a subscription model, and includes references to each of the associated subscription plan variations.
-For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).
-
-## Structure
-
-`CatalogSubscriptionPlan`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `name` | `string` | Required | The name of the plan. | getName(): string | setName(string name): void |
-| `phases` | [`?(SubscriptionPhase[])`](../../doc/models/subscription-phase.md) | Optional | A list of SubscriptionPhase containing the [SubscriptionPhase](entity:SubscriptionPhase) for this plan.
This field it required. Not including this field will throw a REQUIRED_FIELD_MISSING error | getPhases(): ?array | setPhases(?array phases): void |
-| `subscriptionPlanVariations` | [`?(CatalogObject[])`](../../doc/models/catalog-object.md) | Optional | The list of subscription plan variations available for this product | getSubscriptionPlanVariations(): ?array | setSubscriptionPlanVariations(?array subscriptionPlanVariations): void |
-| `eligibleItemIds` | `?(string[])` | Optional | The list of IDs of `CatalogItems` that are eligible for subscription by this SubscriptionPlan's variations. | getEligibleItemIds(): ?array | setEligibleItemIds(?array eligibleItemIds): void |
-| `eligibleCategoryIds` | `?(string[])` | Optional | The list of IDs of `CatalogCategory` that are eligible for subscription by this SubscriptionPlan's variations. | getEligibleCategoryIds(): ?array | setEligibleCategoryIds(?array eligibleCategoryIds): void |
-| `allItems` | `?bool` | Optional | If true, all items in the merchant's catalog are subscribable by this SubscriptionPlan. | getAllItems(): ?bool | setAllItems(?bool allItems): void |
-
-## Example (as JSON)
-
-```json
-{
- "name": "name6",
- "phases": [
- {
- "uid": "uid0",
- "cadence": "QUARTERLY",
- "periods": 112,
- "recurring_price_money": {
- "amount": 66,
- "currency": "ZMW"
- },
- "ordinal": 78,
- "pricing": {
- "type": "STATIC",
- "discount_ids": [
- "discount_ids5",
- "discount_ids6"
- ],
- "price_money": {
- "amount": 202,
- "currency": "GTQ"
- }
- }
- },
- {
- "uid": "uid0",
- "cadence": "QUARTERLY",
- "periods": 112,
- "recurring_price_money": {
- "amount": 66,
- "currency": "ZMW"
- },
- "ordinal": 78,
- "pricing": {
- "type": "STATIC",
- "discount_ids": [
- "discount_ids5",
- "discount_ids6"
- ],
- "price_money": {
- "amount": 202,
- "currency": "GTQ"
- }
- }
- },
- {
- "uid": "uid0",
- "cadence": "QUARTERLY",
- "periods": 112,
- "recurring_price_money": {
- "amount": 66,
- "currency": "ZMW"
- },
- "ordinal": 78,
- "pricing": {
- "type": "STATIC",
- "discount_ids": [
- "discount_ids5",
- "discount_ids6"
- ],
- "price_money": {
- "amount": 202,
- "currency": "GTQ"
- }
- }
- }
- ],
- "subscription_plan_variations": [
- {
- "type": "MODIFIER",
- "id": "id4",
- "updated_at": "updated_at0",
- "version": 208,
- "is_deleted": false,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key2": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- },
- {
- "type": "MODIFIER",
- "id": "id4",
- "updated_at": "updated_at0",
- "version": 208,
- "is_deleted": false,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key2": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- }
- ],
- "eligible_item_ids": [
- "eligible_item_ids8",
- "eligible_item_ids7"
- ],
- "eligible_category_ids": [
- "eligible_category_ids5",
- "eligible_category_ids6",
- "eligible_category_ids7"
- ],
- "all_items": false
-}
-```
-
diff --git a/doc/models/catalog-tax.md b/doc/models/catalog-tax.md
deleted file mode 100644
index a856a1c9..00000000
--- a/doc/models/catalog-tax.md
+++ /dev/null
@@ -1,46 +0,0 @@
-
-# Catalog Tax
-
-A tax applicable to an item.
-
-## Structure
-
-`CatalogTax`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `name` | `?string` | Optional | The tax's name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.
**Constraints**: *Maximum Length*: `255` | getName(): ?string | setName(?string name): void |
-| `calculationPhase` | [`?string(TaxCalculationPhase)`](../../doc/models/tax-calculation-phase.md) | Optional | When to calculate the taxes due on a cart. | getCalculationPhase(): ?string | setCalculationPhase(?string calculationPhase): void |
-| `inclusionType` | [`?string(TaxInclusionType)`](../../doc/models/tax-inclusion-type.md) | Optional | Whether to the tax amount should be additional to or included in the CatalogItem price. | getInclusionType(): ?string | setInclusionType(?string inclusionType): void |
-| `percentage` | `?string` | Optional | 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%. For a location-specific tax rate, contact the tax authority of the location or a tax consultant. | getPercentage(): ?string | setPercentage(?string percentage): void |
-| `appliesToCustomAmounts` | `?bool` | Optional | If `true`, the fee applies to custom amounts entered into the Square Point of Sale
app that are not associated with a particular `CatalogItem`. | getAppliesToCustomAmounts(): ?bool | setAppliesToCustomAmounts(?bool appliesToCustomAmounts): void |
-| `enabled` | `?bool` | Optional | A Boolean flag to indicate whether the tax is displayed as enabled (`true`) in the Square Point of Sale app or not (`false`). | getEnabled(): ?bool | setEnabled(?bool enabled): void |
-| `appliesToProductSetId` | `?string` | Optional | The ID of a `CatalogProductSet` object. If set, the tax is applicable to all products in the product set. | getAppliesToProductSetId(): ?string | setAppliesToProductSetId(?string appliesToProductSetId): void |
-
-## Example (as JSON)
-
-```json
-{
- "object": {
- "id": "#SalesTax",
- "present_at_all_locations": true,
- "tax_data": {
- "calculation_phase": "TAX_SUBTOTAL_PHASE",
- "enabled": true,
- "fee_applies_to_custom_amounts": true,
- "inclusion_type": "ADDITIVE",
- "name": "Sales Tax",
- "percentage": "5.0"
- },
- "type": "TAX"
- },
- "name": "name2",
- "calculation_phase": "TAX_SUBTOTAL_PHASE",
- "inclusion_type": "ADDITIVE",
- "percentage": "percentage0",
- "applies_to_custom_amounts": false
-}
-```
-
diff --git a/doc/models/catalog-time-period.md b/doc/models/catalog-time-period.md
deleted file mode 100644
index bae4fc58..00000000
--- a/doc/models/catalog-time-period.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Catalog Time Period
-
-Represents a time period - either a single period or a repeating period.
-
-## Structure
-
-`CatalogTimePeriod`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `event` | `?string` | Optional | An iCalendar (RFC 5545) [event](https://tools.ietf.org/html/rfc5545#section-3.6.1), which
specifies the name, timing, duration and recurrence of this time period.
Example:
```
DTSTART:20190707T180000
DURATION:P2H
RRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR
```
Only `SUMMARY`, `DTSTART`, `DURATION` and `RRULE` fields are supported.
`DTSTART` must be in local (unzoned) time format. Note that while `BEGIN:VEVENT`
and `END:VEVENT` is not required in the request. The response will always
include them. | getEvent(): ?string | setEvent(?string event): void |
-
-## Example (as JSON)
-
-```json
-{
- "event": "event8"
-}
-```
-
diff --git a/doc/models/catalog-v1-id.md b/doc/models/catalog-v1-id.md
deleted file mode 100644
index 5e93175c..00000000
--- a/doc/models/catalog-v1-id.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Catalog V1 Id
-
-A Square API V1 identifier of an item, including the object ID and its associated location ID.
-
-## Structure
-
-`CatalogV1Id`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `catalogV1Id` | `?string` | Optional | The ID for an object used in the Square API V1, if the object ID differs from the Square API V2 object ID. | getCatalogV1Id(): ?string | setCatalogV1Id(?string catalogV1Id): void |
-| `locationId` | `?string` | Optional | The ID of the `Location` this Connect V1 ID is associated with. | getLocationId(): ?string | setLocationId(?string locationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "catalog_v1_id": "catalog_v1_id2",
- "location_id": "location_id2"
-}
-```
-
diff --git a/doc/models/category-path-to-root-node.md b/doc/models/category-path-to-root-node.md
deleted file mode 100644
index bb5590b2..00000000
--- a/doc/models/category-path-to-root-node.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Category Path to Root Node
-
-A node in the path from a retrieved category to its root node.
-
-## Structure
-
-`CategoryPathToRootNode`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `categoryId` | `?string` | Optional | The category's ID. | getCategoryId(): ?string | setCategoryId(?string categoryId): void |
-| `categoryName` | `?string` | Optional | The category's name. | getCategoryName(): ?string | setCategoryName(?string categoryName): void |
-
-## Example (as JSON)
-
-```json
-{
- "category_id": "category_id0",
- "category_name": "category_name0"
-}
-```
-
diff --git a/doc/models/change-billing-anchor-date-request.md b/doc/models/change-billing-anchor-date-request.md
deleted file mode 100644
index fcb20075..00000000
--- a/doc/models/change-billing-anchor-date-request.md
+++ /dev/null
@@ -1,26 +0,0 @@
-
-# Change Billing Anchor Date Request
-
-Defines input parameters in a request to the
-[ChangeBillingAnchorDate](../../doc/apis/subscriptions.md#change-billing-anchor-date) endpoint.
-
-## Structure
-
-`ChangeBillingAnchorDateRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `monthlyBillingAnchorDate` | `?int` | Optional | The anchor day for the billing cycle.
**Constraints**: `>= 1`, `<= 31` | getMonthlyBillingAnchorDate(): ?int | setMonthlyBillingAnchorDate(?int monthlyBillingAnchorDate): void |
-| `effectiveDate` | `?string` | Optional | The `YYYY-MM-DD`-formatted date when the scheduled `BILLING_ANCHOR_CHANGE` action takes
place on the subscription.
When this date is unspecified or falls within the current billing cycle, the billing anchor date
is changed immediately. | getEffectiveDate(): ?string | setEffectiveDate(?string effectiveDate): void |
-
-## Example (as JSON)
-
-```json
-{
- "monthly_billing_anchor_date": 1,
- "effective_date": "effective_date8"
-}
-```
-
diff --git a/doc/models/change-billing-anchor-date-response.md b/doc/models/change-billing-anchor-date-response.md
deleted file mode 100644
index d8839795..00000000
--- a/doc/models/change-billing-anchor-date-response.md
+++ /dev/null
@@ -1,94 +0,0 @@
-
-# Change Billing Anchor Date Response
-
-Defines output parameters in a request to the
-[ChangeBillingAnchorDate](../../doc/apis/subscriptions.md#change-billing-anchor-date) endpoint.
-
-## Structure
-
-`ChangeBillingAnchorDateResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `subscription` | [`?Subscription`](../../doc/models/subscription.md) | Optional | Represents a subscription purchased by a customer.
For more information, see
[Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions). | getSubscription(): ?Subscription | setSubscription(?Subscription subscription): void |
-| `actions` | [`?(SubscriptionAction[])`](../../doc/models/subscription-action.md) | Optional | A list of a single billing anchor date change for the subscription. | getActions(): ?array | setActions(?array actions): void |
-
-## Example (as JSON)
-
-```json
-{
- "actions": [
- {
- "effective_date": "2023-11-01",
- "id": "f0a1dfdc-675b-3a14-a640-99f7ac1cee83",
- "monthly_billing_anchor_date": 1,
- "type": "CHANGE_BILLING_ANCHOR_DATE",
- "phases": [
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- },
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- },
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- }
- ]
- }
- ],
- "subscription": {
- "created_at": "2023-06-20T21:53:10Z",
- "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
- "id": "9ba40961-995a-4a3d-8c53-048c40cafc13",
- "location_id": "S8GWD5R9QB376",
- "monthly_billing_anchor_date": 20,
- "phases": [
- {
- "order_template_id": "E6oBY5WfQ2eN4pkYZwq4ka6n7KeZY",
- "ordinal": 0,
- "plan_phase_uid": "C66BKH3ASTDYGJJCEZXQQSS7",
- "uid": "98d6f53b-40e1-4714-8827-032fd923be25"
- }
- ],
- "plan_variation_id": "FQ7CDXXWSLUJRPM3GFJSJGZ7",
- "price_override_money": {
- "amount": 2000,
- "currency": "USD"
- },
- "source": {
- "name": "My Application"
- },
- "status": "ACTIVE",
- "timezone": "America/Los_Angeles",
- "version": 3,
- "start_date": "start_date8"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/change-timing.md b/doc/models/change-timing.md
deleted file mode 100644
index 1934eb99..00000000
--- a/doc/models/change-timing.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Change Timing
-
-Supported timings when a pending change, as an action, takes place to a subscription.
-
-## Enumeration
-
-`ChangeTiming`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `IMMEDIATE` | The action occurs immediately. |
-| `END_OF_BILLING_CYCLE` | The action occurs at the end of the billing cycle. |
-
diff --git a/doc/models/charge-request-additional-recipient.md b/doc/models/charge-request-additional-recipient.md
deleted file mode 100644
index 2a3127ab..00000000
--- a/doc/models/charge-request-additional-recipient.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Charge Request Additional Recipient
-
-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
-
-## Structure
-
-`ChargeRequestAdditionalRecipient`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationId` | `string` | Required | The location ID for a recipient (other than the merchant) receiving a portion of the tender.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `50` | getLocationId(): string | setLocationId(string locationId): void |
-| `description` | `string` | Required | The description of the additional recipient.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `100` | getDescription(): string | setDescription(string description): void |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_id": "location_id6",
- "description": "description2",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- }
-}
-```
-
diff --git a/doc/models/charge-request.md b/doc/models/charge-request.md
deleted file mode 100644
index 64131d3a..00000000
--- a/doc/models/charge-request.md
+++ /dev/null
@@ -1,73 +0,0 @@
-
-# Charge Request
-
-Defines the parameters that can be included in the body of
-a request to the [Charge](api-endpoint:Transactions-Charge) endpoint.
-
-Deprecated - recommend using [CreatePayment](api-endpoint:Payments-CreatePayment)
-
-## Structure
-
-`ChargeRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A value you specify that uniquely identifies this
transaction among transactions you've created.
If you're unsure whether a particular transaction succeeded,
you can reattempt it with the same idempotency key without
worrying about double-charging the buyer.
See [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency) for more information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `192` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-| `cardNonce` | `?string` | Optional | A payment token generated from the [Card.tokenize()](https://developer.squareup.com/reference/sdks/web/payments/objects/Card#Card.tokenize) that represents the card
to charge.
The application that provides a payment token to this endpoint must be the
_same application_ that generated the payment token with the Web Payments SDK.
Otherwise, the nonce is invalid.
Do not provide a value for this field if you provide a value for
`customer_card_id`.
**Constraints**: *Maximum Length*: `192` | getCardNonce(): ?string | setCardNonce(?string cardNonce): void |
-| `customerCardId` | `?string` | Optional | The ID of the customer card on file to charge. Do
not provide a value for this field if you provide a value for `card_nonce`.
If you provide this value, you _must_ also provide a value for
`customer_id`.
**Constraints**: *Maximum Length*: `192` | getCustomerCardId(): ?string | setCustomerCardId(?string customerCardId): void |
-| `delayCapture` | `?bool` | Optional | If `true`, the request will only perform an Auth on the provided
card. You can then later perform either a Capture (with the
[CaptureTransaction](api-endpoint:Transactions-CaptureTransaction) endpoint) or a Void
(with the [VoidTransaction](api-endpoint:Transactions-VoidTransaction) endpoint).
Default value: `false` | getDelayCapture(): ?bool | setDelayCapture(?bool delayCapture): void |
-| `referenceId` | `?string` | Optional | An optional ID you can associate with the transaction for your own
purposes (such as to associate the transaction with an entity ID in your
own database).
This value cannot exceed 40 characters.
**Constraints**: *Maximum Length*: `40` | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `note` | `?string` | Optional | An optional note to associate with the transaction.
This value cannot exceed 60 characters.
**Constraints**: *Maximum Length*: `60` | getNote(): ?string | setNote(?string note): void |
-| `customerId` | `?string` | Optional | The ID of the customer to associate this transaction with. This field
is required if you provide a value for `customer_card_id`, and optional
otherwise.
**Constraints**: *Maximum Length*: `50` | getCustomerId(): ?string | setCustomerId(?string customerId): void |
-| `billingAddress` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void |
-| `shippingAddress` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getShippingAddress(): ?Address | setShippingAddress(?Address shippingAddress): void |
-| `buyerEmailAddress` | `?string` | Optional | The buyer's email address, if available. This value is optional,
but this transaction is ineligible for chargeback protection if it is not
provided. | getBuyerEmailAddress(): ?string | setBuyerEmailAddress(?string buyerEmailAddress): void |
-| `orderId` | `?string` | Optional | The ID of the order to associate with this transaction.
If you provide this value, the `amount_money` value of your request must
__exactly match__ the value of the order's `total_money` field.
**Constraints**: *Maximum Length*: `192` | getOrderId(): ?string | setOrderId(?string orderId): void |
-| `additionalRecipients` | [`?(ChargeRequestAdditionalRecipient[])`](../../doc/models/charge-request-additional-recipient.md) | Optional | The basic primitive of multi-party transaction. The value is optional.
The transaction facilitated by you can be split from here.
If you provide this value, the `amount_money` value in your additional_recipients
must not be more than 90% of the `amount_money` value in the charge request.
The `location_id` must be the valid location of the app owner merchant.
This field requires the `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission.
This field is currently not supported in sandbox. | getAdditionalRecipients(): ?array | setAdditionalRecipients(?array additionalRecipients): void |
-| `verificationToken` | `?string` | Optional | A token generated by SqPaymentForm's verifyBuyer() that represents
customer's device info and 3ds challenge result. | getVerificationToken(): ?string | setVerificationToken(?string verificationToken): void |
-
-## Example (as JSON)
-
-```json
-{
- "additional_recipients": [
- {
- "amount_money": {
- "amount": 20,
- "currency": "USD"
- },
- "description": "Application fees",
- "location_id": "057P5VYJ4A5X1"
- }
- ],
- "amount_money": {
- "amount": 200,
- "currency": "USD"
- },
- "billing_address": {
- "address_line_1": "500 Electric Ave",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "NY",
- "country": "US",
- "locality": "New York",
- "postal_code": "10003"
- },
- "card_nonce": "card_nonce_from_square_123",
- "delay_capture": false,
- "idempotency_key": "74ae1696-b1e3-4328-af6d-f1e04d947a13",
- "note": "some optional note",
- "reference_id": "some optional reference id",
- "shipping_address": {
- "address_line_1": "123 Main St",
- "administrative_district_level_1": "CA",
- "country": "US",
- "locality": "San Francisco",
- "postal_code": "94114"
- },
- "customer_card_id": "customer_card_id0"
-}
-```
-
diff --git a/doc/models/charge-response.md b/doc/models/charge-response.md
deleted file mode 100644
index 4a17639e..00000000
--- a/doc/models/charge-response.md
+++ /dev/null
@@ -1,187 +0,0 @@
-
-# Charge Response
-
-Defines the fields that are included in the response body of
-a request to the [Charge](api-endpoint:Transactions-Charge) endpoint.
-
-One of `errors` or `transaction` is present in a given response (never both).
-
-## Structure
-
-`ChargeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `transaction` | [`?Transaction`](../../doc/models/transaction.md) | Optional | Represents a transaction processed with Square, either with the
Connect API or with Square Point of Sale.
The `tenders` field of this object lists all methods of payment used to pay in
the transaction. | getTransaction(): ?Transaction | setTransaction(?Transaction transaction): void |
-
-## Example (as JSON)
-
-```json
-{
- "transaction": {
- "created_at": "2016-03-10T22:57:56Z",
- "id": "KnL67ZIwXCPtzOrqj0HrkxMF",
- "location_id": "18YC4JDH91E1H",
- "product": "EXTERNAL_API",
- "reference_id": "some optional reference id",
- "tenders": [
- {
- "additional_recipients": [
- {
- "amount_money": {
- "amount": 20,
- "currency": "USD"
- },
- "description": "Application fees",
- "location_id": "057P5VYJ4A5X1",
- "receivable_id": "ISu5xwxJ5v0CMJTQq7RvqyMF"
- }
- ],
- "amount_money": {
- "amount": 200,
- "currency": "USD"
- },
- "card_details": {
- "card": {
- "card_brand": "VISA",
- "last_4": "1111"
- },
- "entry_method": "KEYED",
- "status": "CAPTURED"
- },
- "created_at": "2016-03-10T22:57:56Z",
- "id": "MtZRYYdDrYNQbOvV7nbuBvMF",
- "location_id": "18YC4JDH91E1H",
- "note": "some optional note",
- "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF",
- "type": "CARD"
- }
- ],
- "refunds": [
- {
- "id": "id8",
- "location_id": "location_id2",
- "transaction_id": "transaction_id6",
- "tender_id": "tender_id6",
- "created_at": "created_at6",
- "reason": "reason4",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "status": "PENDING",
- "processing_fee_money": {
- "amount": 112,
- "currency": "DJF"
- },
- "additional_recipients": [
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- },
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- }
- ]
- },
- {
- "id": "id8",
- "location_id": "location_id2",
- "transaction_id": "transaction_id6",
- "tender_id": "tender_id6",
- "created_at": "created_at6",
- "reason": "reason4",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "status": "PENDING",
- "processing_fee_money": {
- "amount": 112,
- "currency": "DJF"
- },
- "additional_recipients": [
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- },
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- }
- ]
- },
- {
- "id": "id8",
- "location_id": "location_id2",
- "transaction_id": "transaction_id6",
- "tender_id": "tender_id6",
- "created_at": "created_at6",
- "reason": "reason4",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "status": "PENDING",
- "processing_fee_money": {
- "amount": 112,
- "currency": "DJF"
- },
- "additional_recipients": [
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- },
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- }
- ]
- }
- ]
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/checkout-location-settings-branding-button-shape.md b/doc/models/checkout-location-settings-branding-button-shape.md
deleted file mode 100644
index 788cac88..00000000
--- a/doc/models/checkout-location-settings-branding-button-shape.md
+++ /dev/null
@@ -1,15 +0,0 @@
-
-# Checkout Location Settings Branding Button Shape
-
-## Enumeration
-
-`CheckoutLocationSettingsBrandingButtonShape`
-
-## Fields
-
-| Name |
-| --- |
-| `SQUARED` |
-| `ROUNDED` |
-| `PILL` |
-
diff --git a/doc/models/checkout-location-settings-branding-header-type.md b/doc/models/checkout-location-settings-branding-header-type.md
deleted file mode 100644
index b78204a8..00000000
--- a/doc/models/checkout-location-settings-branding-header-type.md
+++ /dev/null
@@ -1,15 +0,0 @@
-
-# Checkout Location Settings Branding Header Type
-
-## Enumeration
-
-`CheckoutLocationSettingsBrandingHeaderType`
-
-## Fields
-
-| Name |
-| --- |
-| `BUSINESS_NAME` |
-| `FRAMED_LOGO` |
-| `FULL_WIDTH_LOGO` |
-
diff --git a/doc/models/checkout-location-settings-branding.md b/doc/models/checkout-location-settings-branding.md
deleted file mode 100644
index 4887e3c5..00000000
--- a/doc/models/checkout-location-settings-branding.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Checkout Location Settings Branding
-
-## Structure
-
-`CheckoutLocationSettingsBranding`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `headerType` | [`?string(CheckoutLocationSettingsBrandingHeaderType)`](../../doc/models/checkout-location-settings-branding-header-type.md) | Optional | - | getHeaderType(): ?string | setHeaderType(?string headerType): void |
-| `buttonColor` | `?string` | Optional | The HTML-supported hex color for the button on the checkout page (for example, "#FFFFFF").
**Constraints**: *Minimum Length*: `7`, *Maximum Length*: `7` | getButtonColor(): ?string | setButtonColor(?string buttonColor): void |
-| `buttonShape` | [`?string(CheckoutLocationSettingsBrandingButtonShape)`](../../doc/models/checkout-location-settings-branding-button-shape.md) | Optional | - | getButtonShape(): ?string | setButtonShape(?string buttonShape): void |
-
-## Example (as JSON)
-
-```json
-{
- "header_type": "FULL_WIDTH_LOGO",
- "button_color": "button_color2",
- "button_shape": "ROUNDED"
-}
-```
-
diff --git a/doc/models/checkout-location-settings-coupons.md b/doc/models/checkout-location-settings-coupons.md
deleted file mode 100644
index 8ca0bcf9..00000000
--- a/doc/models/checkout-location-settings-coupons.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Checkout Location Settings Coupons
-
-## Structure
-
-`CheckoutLocationSettingsCoupons`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `enabled` | `?bool` | Optional | Indicates whether coupons are enabled for this location. | getEnabled(): ?bool | setEnabled(?bool enabled): void |
-
-## Example (as JSON)
-
-```json
-{
- "enabled": false
-}
-```
-
diff --git a/doc/models/checkout-location-settings-policy.md b/doc/models/checkout-location-settings-policy.md
deleted file mode 100644
index da092569..00000000
--- a/doc/models/checkout-location-settings-policy.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Checkout Location Settings Policy
-
-## Structure
-
-`CheckoutLocationSettingsPolicy`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID to identify the policy when making changes. You must set the UID for policy updates, but it’s optional when setting new policies. | getUid(): ?string | setUid(?string uid): void |
-| `title` | `?string` | Optional | The title of the policy. This is required when setting the description, though you can update it in a different request.
**Constraints**: *Maximum Length*: `50` | getTitle(): ?string | setTitle(?string title): void |
-| `description` | `?string` | Optional | The description of the policy.
**Constraints**: *Maximum Length*: `4096` | getDescription(): ?string | setDescription(?string description): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid0",
- "title": "title6",
- "description": "description0"
-}
-```
-
diff --git a/doc/models/checkout-location-settings-tipping.md b/doc/models/checkout-location-settings-tipping.md
deleted file mode 100644
index 81e0d882..00000000
--- a/doc/models/checkout-location-settings-tipping.md
+++ /dev/null
@@ -1,48 +0,0 @@
-
-# Checkout Location Settings Tipping
-
-## Structure
-
-`CheckoutLocationSettingsTipping`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `percentages` | `?(int[])` | Optional | Set three custom percentage amounts that buyers can select at checkout. If Smart Tip is enabled, this only applies to transactions totaling $10 or more. | getPercentages(): ?array | setPercentages(?array percentages): void |
-| `smartTippingEnabled` | `?bool` | Optional | Enables Smart Tip Amounts. If Smart Tip Amounts is enabled, tipping works as follows:
If a transaction is less than $10, the available tipping options include No Tip, $1, $2, or $3.
If a transaction is $10 or more, the available tipping options include No Tip, 15%, 20%, or 25%.
You can set custom percentage amounts with the `percentages` field. | getSmartTippingEnabled(): ?bool | setSmartTippingEnabled(?bool smartTippingEnabled): void |
-| `defaultPercent` | `?int` | Optional | Set the pre-selected percentage amounts that appear at checkout. If Smart Tip is enabled, this only applies to transactions totaling $10 or more. | getDefaultPercent(): ?int | setDefaultPercent(?int defaultPercent): void |
-| `smartTips` | [`?(Money[])`](../../doc/models/money.md) | Optional | Show the Smart Tip Amounts for this location. | getSmartTips(): ?array | setSmartTips(?array smartTips): void |
-| `defaultSmartTip` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getDefaultSmartTip(): ?Money | setDefaultSmartTip(?Money defaultSmartTip): void |
-
-## Example (as JSON)
-
-```json
-{
- "percentages": [
- 192,
- 193
- ],
- "smart_tipping_enabled": false,
- "default_percent": 72,
- "smart_tips": [
- {
- "amount": 152,
- "currency": "GEL"
- },
- {
- "amount": 152,
- "currency": "GEL"
- },
- {
- "amount": 152,
- "currency": "GEL"
- }
- ],
- "default_smart_tip": {
- "amount": 58,
- "currency": "KWD"
- }
-}
-```
-
diff --git a/doc/models/checkout-location-settings.md b/doc/models/checkout-location-settings.md
deleted file mode 100644
index 4d8c06c7..00000000
--- a/doc/models/checkout-location-settings.md
+++ /dev/null
@@ -1,67 +0,0 @@
-
-# Checkout Location Settings
-
-## Structure
-
-`CheckoutLocationSettings`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationId` | `?string` | Optional | The ID of the location that these settings apply to. | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `customerNotesEnabled` | `?bool` | Optional | Indicates whether customers are allowed to leave notes at checkout. | getCustomerNotesEnabled(): ?bool | setCustomerNotesEnabled(?bool customerNotesEnabled): void |
-| `policies` | [`?(CheckoutLocationSettingsPolicy[])`](../../doc/models/checkout-location-settings-policy.md) | Optional | Policy information is displayed at the bottom of the checkout pages.
You can set a maximum of two policies. | getPolicies(): ?array | setPolicies(?array policies): void |
-| `branding` | [`?CheckoutLocationSettingsBranding`](../../doc/models/checkout-location-settings-branding.md) | Optional | - | getBranding(): ?CheckoutLocationSettingsBranding | setBranding(?CheckoutLocationSettingsBranding branding): void |
-| `tipping` | [`?CheckoutLocationSettingsTipping`](../../doc/models/checkout-location-settings-tipping.md) | Optional | - | getTipping(): ?CheckoutLocationSettingsTipping | setTipping(?CheckoutLocationSettingsTipping tipping): void |
-| `coupons` | [`?CheckoutLocationSettingsCoupons`](../../doc/models/checkout-location-settings-coupons.md) | Optional | - | getCoupons(): ?CheckoutLocationSettingsCoupons | setCoupons(?CheckoutLocationSettingsCoupons coupons): void |
-| `updatedAt` | `?string` | Optional | The timestamp when the settings were last updated, in RFC 3339 format.
Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:
UTC: 2020-01-26T02:25:34Z
Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_id": "location_id4",
- "customer_notes_enabled": false,
- "policies": [
- {
- "uid": "uid8",
- "title": "title4",
- "description": "description8"
- },
- {
- "uid": "uid8",
- "title": "title4",
- "description": "description8"
- }
- ],
- "branding": {
- "header_type": "FULL_WIDTH_LOGO",
- "button_color": "button_color2",
- "button_shape": "PILL"
- },
- "tipping": {
- "percentages": [
- 246,
- 247
- ],
- "smart_tipping_enabled": false,
- "default_percent": 46,
- "smart_tips": [
- {
- "amount": 152,
- "currency": "GEL"
- },
- {
- "amount": 152,
- "currency": "GEL"
- }
- ],
- "default_smart_tip": {
- "amount": 58,
- "currency": "KWD"
- }
- }
-}
-```
-
diff --git a/doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay-eligibility-range.md b/doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay-eligibility-range.md
deleted file mode 100644
index 3288f551..00000000
--- a/doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay-eligibility-range.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Checkout Merchant Settings Payment Methods Afterpay Clearpay Eligibility Range
-
-A range of purchase price that qualifies.
-
-## Structure
-
-`CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `min` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getMin(): Money | setMin(Money min): void |
-| `max` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getMax(): Money | setMax(Money max): void |
-
-## Example (as JSON)
-
-```json
-{
- "min": {
- "amount": 34,
- "currency": "OMR"
- },
- "max": {
- "amount": 140,
- "currency": "JPY"
- }
-}
-```
-
diff --git a/doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay.md b/doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay.md
deleted file mode 100644
index e983896f..00000000
--- a/doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay.md
+++ /dev/null
@@ -1,45 +0,0 @@
-
-# Checkout Merchant Settings Payment Methods Afterpay Clearpay
-
-The settings allowed for AfterpayClearpay.
-
-## Structure
-
-`CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `orderEligibilityRange` | [`?CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange`](../../doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay-eligibility-range.md) | Optional | A range of purchase price that qualifies. | getOrderEligibilityRange(): ?CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange | setOrderEligibilityRange(?CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange orderEligibilityRange): void |
-| `itemEligibilityRange` | [`?CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange`](../../doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay-eligibility-range.md) | Optional | A range of purchase price that qualifies. | getItemEligibilityRange(): ?CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange | setItemEligibilityRange(?CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange itemEligibilityRange): void |
-| `enabled` | `?bool` | Optional | Indicates whether the payment method is enabled for the account. | getEnabled(): ?bool | setEnabled(?bool enabled): void |
-
-## Example (as JSON)
-
-```json
-{
- "order_eligibility_range": {
- "min": {
- "amount": 34,
- "currency": "OMR"
- },
- "max": {
- "amount": 140,
- "currency": "JPY"
- }
- },
- "item_eligibility_range": {
- "min": {
- "amount": 34,
- "currency": "OMR"
- },
- "max": {
- "amount": 140,
- "currency": "JPY"
- }
- },
- "enabled": false
-}
-```
-
diff --git a/doc/models/checkout-merchant-settings-payment-methods-payment-method.md b/doc/models/checkout-merchant-settings-payment-methods-payment-method.md
deleted file mode 100644
index 8ba99f7d..00000000
--- a/doc/models/checkout-merchant-settings-payment-methods-payment-method.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Checkout Merchant Settings Payment Methods Payment Method
-
-The settings allowed for a payment method.
-
-## Structure
-
-`CheckoutMerchantSettingsPaymentMethodsPaymentMethod`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `enabled` | `?bool` | Optional | Indicates whether the payment method is enabled for the account. | getEnabled(): ?bool | setEnabled(?bool enabled): void |
-
-## Example (as JSON)
-
-```json
-{
- "enabled": false
-}
-```
-
diff --git a/doc/models/checkout-merchant-settings-payment-methods.md b/doc/models/checkout-merchant-settings-payment-methods.md
deleted file mode 100644
index d061537a..00000000
--- a/doc/models/checkout-merchant-settings-payment-methods.md
+++ /dev/null
@@ -1,55 +0,0 @@
-
-# Checkout Merchant Settings Payment Methods
-
-## Structure
-
-`CheckoutMerchantSettingsPaymentMethods`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `applePay` | [`?CheckoutMerchantSettingsPaymentMethodsPaymentMethod`](../../doc/models/checkout-merchant-settings-payment-methods-payment-method.md) | Optional | The settings allowed for a payment method. | getApplePay(): ?CheckoutMerchantSettingsPaymentMethodsPaymentMethod | setApplePay(?CheckoutMerchantSettingsPaymentMethodsPaymentMethod applePay): void |
-| `googlePay` | [`?CheckoutMerchantSettingsPaymentMethodsPaymentMethod`](../../doc/models/checkout-merchant-settings-payment-methods-payment-method.md) | Optional | The settings allowed for a payment method. | getGooglePay(): ?CheckoutMerchantSettingsPaymentMethodsPaymentMethod | setGooglePay(?CheckoutMerchantSettingsPaymentMethodsPaymentMethod googlePay): void |
-| `cashApp` | [`?CheckoutMerchantSettingsPaymentMethodsPaymentMethod`](../../doc/models/checkout-merchant-settings-payment-methods-payment-method.md) | Optional | The settings allowed for a payment method. | getCashApp(): ?CheckoutMerchantSettingsPaymentMethodsPaymentMethod | setCashApp(?CheckoutMerchantSettingsPaymentMethodsPaymentMethod cashApp): void |
-| `afterpayClearpay` | [`?CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay`](../../doc/models/checkout-merchant-settings-payment-methods-afterpay-clearpay.md) | Optional | The settings allowed for AfterpayClearpay. | getAfterpayClearpay(): ?CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay | setAfterpayClearpay(?CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay afterpayClearpay): void |
-
-## Example (as JSON)
-
-```json
-{
- "apple_pay": {
- "enabled": false
- },
- "google_pay": {
- "enabled": false
- },
- "cash_app": {
- "enabled": false
- },
- "afterpay_clearpay": {
- "order_eligibility_range": {
- "min": {
- "amount": 34,
- "currency": "OMR"
- },
- "max": {
- "amount": 140,
- "currency": "JPY"
- }
- },
- "item_eligibility_range": {
- "min": {
- "amount": 34,
- "currency": "OMR"
- },
- "max": {
- "amount": 140,
- "currency": "JPY"
- }
- },
- "enabled": false
- }
-}
-```
-
diff --git a/doc/models/checkout-merchant-settings.md b/doc/models/checkout-merchant-settings.md
deleted file mode 100644
index d91a48fc..00000000
--- a/doc/models/checkout-merchant-settings.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Checkout Merchant Settings
-
-## Structure
-
-`CheckoutMerchantSettings`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentMethods` | [`?CheckoutMerchantSettingsPaymentMethods`](../../doc/models/checkout-merchant-settings-payment-methods.md) | Optional | - | getPaymentMethods(): ?CheckoutMerchantSettingsPaymentMethods | setPaymentMethods(?CheckoutMerchantSettingsPaymentMethods paymentMethods): void |
-| `updatedAt` | `?string` | Optional | The timestamp when the settings were last updated, in RFC 3339 format.
Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:
UTC: 2020-01-26T02:25:34Z
Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00 | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_methods": {
- "apple_pay": {
- "enabled": false
- },
- "google_pay": {
- "enabled": false
- },
- "cash_app": {
- "enabled": false
- },
- "afterpay_clearpay": {
- "order_eligibility_range": {
- "min": {
- "amount": 34,
- "currency": "OMR"
- },
- "max": {
- "amount": 140,
- "currency": "JPY"
- }
- },
- "item_eligibility_range": {
- "min": {
- "amount": 34,
- "currency": "OMR"
- },
- "max": {
- "amount": 140,
- "currency": "JPY"
- }
- },
- "enabled": false
- }
- },
- "updated_at": "updated_at0"
-}
-```
-
diff --git a/doc/models/checkout-options-payment-type.md b/doc/models/checkout-options-payment-type.md
deleted file mode 100644
index 3ea1b1ce..00000000
--- a/doc/models/checkout-options-payment-type.md
+++ /dev/null
@@ -1,20 +0,0 @@
-
-# Checkout Options Payment Type
-
-## Enumeration
-
-`CheckoutOptionsPaymentType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `CARD_PRESENT` | Accept credit card or debit card payments via tap, dip or swipe. |
-| `MANUAL_CARD_ENTRY` | Launches the manual credit or debit card entry screen for the buyer to complete. |
-| `FELICA_ID` | Launches the iD checkout screen for the buyer to complete. |
-| `FELICA_QUICPAY` | Launches the QUICPay checkout screen for the buyer to complete. |
-| `FELICA_TRANSPORTATION_GROUP` | Launches the Transportation Group checkout screen for the buyer to complete. |
-| `FELICA_ALL` | Launches a checkout screen for the buyer on the Square Terminal that
allows them to select a specific FeliCa brand or select the check balance screen. |
-| `PAYPAY` | Replaced by `QR_CODE`. |
-| `QR_CODE` | Launches Square's QR Code checkout screen for the buyer to complete.
Displays a single code that supports all digital wallets connected to the target
Seller location (e.g. PayPay) |
-
diff --git a/doc/models/checkout-options.md b/doc/models/checkout-options.md
deleted file mode 100644
index c5e7a3d1..00000000
--- a/doc/models/checkout-options.md
+++ /dev/null
@@ -1,45 +0,0 @@
-
-# Checkout Options
-
-## Structure
-
-`CheckoutOptions`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `allowTipping` | `?bool` | Optional | Indicates whether the payment allows tipping. | getAllowTipping(): ?bool | setAllowTipping(?bool allowTipping): void |
-| `customFields` | [`?(CustomField[])`](../../doc/models/custom-field.md) | Optional | The custom fields requesting information from the buyer. | getCustomFields(): ?array | setCustomFields(?array customFields): void |
-| `subscriptionPlanId` | `?string` | Optional | The ID of the subscription plan for the buyer to pay and subscribe.
For more information, see [Subscription Plan Checkout](https://developer.squareup.com/docs/checkout-api/subscription-plan-checkout).
**Constraints**: *Maximum Length*: `255` | getSubscriptionPlanId(): ?string | setSubscriptionPlanId(?string subscriptionPlanId): void |
-| `redirectUrl` | `?string` | Optional | The confirmation page URL to redirect the buyer to after Square processes the payment.
**Constraints**: *Maximum Length*: `2048` | getRedirectUrl(): ?string | setRedirectUrl(?string redirectUrl): void |
-| `merchantSupportEmail` | `?string` | Optional | The email address that buyers can use to contact the seller.
**Constraints**: *Maximum Length*: `256` | getMerchantSupportEmail(): ?string | setMerchantSupportEmail(?string merchantSupportEmail): void |
-| `askForShippingAddress` | `?bool` | Optional | Indicates whether to include the address fields in the payment form. | getAskForShippingAddress(): ?bool | setAskForShippingAddress(?bool askForShippingAddress): void |
-| `acceptedPaymentMethods` | [`?AcceptedPaymentMethods`](../../doc/models/accepted-payment-methods.md) | Optional | - | getAcceptedPaymentMethods(): ?AcceptedPaymentMethods | setAcceptedPaymentMethods(?AcceptedPaymentMethods acceptedPaymentMethods): void |
-| `appFeeMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAppFeeMoney(): ?Money | setAppFeeMoney(?Money appFeeMoney): void |
-| `shippingFee` | [`?ShippingFee`](../../doc/models/shipping-fee.md) | Optional | - | getShippingFee(): ?ShippingFee | setShippingFee(?ShippingFee shippingFee): void |
-| `enableCoupon` | `?bool` | Optional | Indicates whether to include the `Add coupon` section for the buyer to provide a Square marketing coupon in the payment form. | getEnableCoupon(): ?bool | setEnableCoupon(?bool enableCoupon): void |
-| `enableLoyalty` | `?bool` | Optional | Indicates whether to include the `REWARDS` section for the buyer to opt in to loyalty, redeem rewards in the payment form, or both. | getEnableLoyalty(): ?bool | setEnableLoyalty(?bool enableLoyalty): void |
-
-## Example (as JSON)
-
-```json
-{
- "allow_tipping": false,
- "custom_fields": [
- {
- "title": "title8"
- },
- {
- "title": "title8"
- },
- {
- "title": "title8"
- }
- ],
- "subscription_plan_id": "subscription_plan_id0",
- "redirect_url": "redirect_url4",
- "merchant_support_email": "merchant_support_email0"
-}
-```
-
diff --git a/doc/models/checkout.md b/doc/models/checkout.md
deleted file mode 100644
index 00d3fb64..00000000
--- a/doc/models/checkout.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-# Checkout
-
-Square Checkout lets merchants accept online payments for supported
-payment types using a checkout workflow hosted on squareup.com.
-
-## Structure
-
-`Checkout`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | ID generated by Square Checkout when a new checkout is requested. | getId(): ?string | setId(?string id): void |
-| `checkoutPageUrl` | `?string` | Optional | The URL that the buyer's browser should be redirected to after the
checkout is completed. | getCheckoutPageUrl(): ?string | setCheckoutPageUrl(?string checkoutPageUrl): void |
-| `askForShippingAddress` | `?bool` | Optional | 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`. | getAskForShippingAddress(): ?bool | setAskForShippingAddress(?bool askForShippingAddress): void |
-| `merchantSupportEmail` | `?string` | Optional | 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. | getMerchantSupportEmail(): ?string | setMerchantSupportEmail(?string merchantSupportEmail): void |
-| `prePopulateBuyerEmail` | `?string` | Optional | 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. | getPrePopulateBuyerEmail(): ?string | setPrePopulateBuyerEmail(?string prePopulateBuyerEmail): void |
-| `prePopulateShippingAddress` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getPrePopulateShippingAddress(): ?Address | setPrePopulateShippingAddress(?Address prePopulateShippingAddress): void |
-| `redirectUrl` | `?string` | Optional | The URL to redirect to after checkout is completed with `checkoutId`,
Square's `orderId`, `transactionId`, and `referenceId` appended as URL
parameters. For example, if the provided redirect_url is
`http://www.example.com/order-complete`, a successful transaction redirects
the customer to:
http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx
If you do not provide a redirect URL, Square Checkout will display an order
confirmation page on your behalf; however Square strongly recommends that
you provide a redirect URL so you can verify the transaction results and
finalize the order through your existing/normal confirmation workflow. | getRedirectUrl(): ?string | setRedirectUrl(?string redirectUrl): void |
-| `order` | [`?Order`](../../doc/models/order.md) | Optional | Contains all information related to a single order to process with Square,
including line items that specify the products to purchase. `Order` objects also
include information about any associated tenders, refunds, and returns.
All Connect V2 Transactions have all been converted to Orders including all associated
itemization data. | getOrder(): ?Order | setOrder(?Order order): void |
-| `createdAt` | `?string` | Optional | The time when the checkout was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `additionalRecipients` | [`?(AdditionalRecipient[])`](../../doc/models/additional-recipient.md) | Optional | Additional recipients (other than the merchant) receiving a portion of this checkout.
For example, fees assessed on the purchase by a third party integration. | getAdditionalRecipients(): ?array | setAdditionalRecipients(?array additionalRecipients): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id0",
- "checkout_page_url": "checkout_page_url4",
- "ask_for_shipping_address": false,
- "merchant_support_email": "merchant_support_email8",
- "pre_populate_buyer_email": "pre_populate_buyer_email2"
-}
-```
-
diff --git a/doc/models/clearpay-details.md b/doc/models/clearpay-details.md
deleted file mode 100644
index 38d7e9e5..00000000
--- a/doc/models/clearpay-details.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Clearpay Details
-
-Additional details about Clearpay payments.
-
-## Structure
-
-`ClearpayDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `emailAddress` | `?string` | Optional | Email address on the buyer's Clearpay account.
**Constraints**: *Maximum Length*: `255` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void |
-
-## Example (as JSON)
-
-```json
-{
- "email_address": "email_address6"
-}
-```
-
diff --git a/doc/models/clone-order-request.md b/doc/models/clone-order-request.md
deleted file mode 100644
index 732d472c..00000000
--- a/doc/models/clone-order-request.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# Clone Order Request
-
-Defines the fields that are included in requests to the
-[CloneOrder](../../doc/apis/orders.md#clone-order) endpoint.
-
-## Structure
-
-`CloneOrderRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `orderId` | `string` | Required | The ID of the order to clone. | getOrderId(): string | setOrderId(string orderId): void |
-| `version` | `?int` | Optional | An optional order version for concurrency protection.
If a version is provided, it must match the latest stored version of the order to clone.
If a version is not provided, the API clones the latest version. | getVersion(): ?int | setVersion(?int version): void |
-| `idempotencyKey` | `?string` | Optional | A value you specify that uniquely identifies this clone request.
If you are unsure whether a particular order was cloned successfully,
you can reattempt the call with the same idempotency key without
worrying about creating duplicate cloned orders.
The originally cloned order is returned.
For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "UNIQUE_STRING",
- "order_id": "ZAISEM52YcpmcWAzERDOyiWS123",
- "version": 3
-}
-```
-
diff --git a/doc/models/clone-order-response.md b/doc/models/clone-order-response.md
deleted file mode 100644
index 4288480f..00000000
--- a/doc/models/clone-order-response.md
+++ /dev/null
@@ -1,333 +0,0 @@
-
-# Clone Order Response
-
-Defines the fields that are included in the response body of
-a request to the [CloneOrder](../../doc/apis/orders.md#clone-order) endpoint.
-
-## Structure
-
-`CloneOrderResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `order` | [`?Order`](../../doc/models/order.md) | Optional | Contains all information related to a single order to process with Square,
including line items that specify the products to purchase. `Order` objects also
include information about any associated tenders, refunds, and returns.
All Connect V2 Transactions have all been converted to Orders including all associated
itemization data. | getOrder(): ?Order | setOrder(?Order order): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "order": {
- "created_at": "2020-01-17T20:47:53.293Z",
- "discounts": [
- {
- "applied_money": {
- "amount": 30,
- "currency": "USD"
- },
- "catalog_object_id": "DB7L55ZH2BGWI4H23ULIWOQ7",
- "name": "Membership Discount",
- "percentage": "0.5",
- "scope": "ORDER",
- "type": "FIXED_PERCENTAGE",
- "uid": "membership-discount"
- },
- {
- "applied_money": {
- "amount": 303,
- "currency": "USD"
- },
- "name": "Labor Day Sale",
- "percentage": "5",
- "scope": "ORDER",
- "type": "FIXED_PERCENTAGE",
- "uid": "labor-day-sale"
- },
- {
- "amount_money": {
- "amount": 100,
- "currency": "USD"
- },
- "applied_money": {
- "amount": 100,
- "currency": "USD"
- },
- "name": "Sale - $1.00 off",
- "scope": "LINE_ITEM",
- "type": "FIXED_AMOUNT",
- "uid": "one-dollar-off"
- }
- ],
- "id": "CAISENgvlJ6jLWAzERDzjyHVybY",
- "line_items": [
- {
- "applied_discounts": [
- {
- "applied_money": {
- "amount": 8,
- "currency": "USD"
- },
- "discount_uid": "membership-discount",
- "uid": "jWdgP1TpHPFBuVrz81mXVC"
- },
- {
- "applied_money": {
- "amount": 79,
- "currency": "USD"
- },
- "discount_uid": "labor-day-sale",
- "uid": "jnZOjjVY57eRcQAVgEwFuC"
- }
- ],
- "applied_taxes": [
- {
- "applied_money": {
- "amount": 136,
- "currency": "USD"
- },
- "tax_uid": "state-sales-tax",
- "uid": "aKG87ArnDpvMLSZJHxWUl"
- }
- ],
- "base_price_money": {
- "amount": 1599,
- "currency": "USD"
- },
- "gross_sales_money": {
- "amount": 1599,
- "currency": "USD"
- },
- "name": "New York Strip Steak",
- "quantity": "1",
- "total_discount_money": {
- "amount": 87,
- "currency": "USD"
- },
- "total_money": {
- "amount": 1648,
- "currency": "USD"
- },
- "total_service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 136,
- "currency": "USD"
- },
- "uid": "8uSwfzvUImn3IRrvciqlXC",
- "variation_total_price_money": {
- "amount": 1599,
- "currency": "USD"
- },
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- },
- {
- "applied_discounts": [
- {
- "applied_money": {
- "amount": 22,
- "currency": "USD"
- },
- "discount_uid": "membership-discount",
- "uid": "nUXvdsIItfKko0dbYtY58C"
- },
- {
- "applied_money": {
- "amount": 224,
- "currency": "USD"
- },
- "discount_uid": "labor-day-sale",
- "uid": "qSdkOOOernlVQqsJ94SPjB"
- },
- {
- "applied_money": {
- "amount": 100,
- "currency": "USD"
- },
- "discount_uid": "one-dollar-off",
- "uid": "y7bVl4njrWAnfDwmz19izB"
- }
- ],
- "applied_taxes": [
- {
- "applied_money": {
- "amount": 374,
- "currency": "USD"
- },
- "tax_uid": "state-sales-tax",
- "uid": "v1dAgrfUVUPTnVTf9sRPz"
- }
- ],
- "base_price_money": {
- "amount": 2200,
- "currency": "USD"
- },
- "catalog_object_id": "BEMYCSMIJL46OCDV4KYIKXIB",
- "gross_sales_money": {
- "amount": 4500,
- "currency": "USD"
- },
- "modifiers": [
- {
- "base_price_money": {
- "amount": 50,
- "currency": "USD"
- },
- "catalog_object_id": "CHQX7Y4KY6N5KINJKZCFURPZ",
- "name": "Well",
- "total_price_money": {
- "amount": 100,
- "currency": "USD"
- },
- "uid": "Lo3qMMckDluu9Qsb58d4CC"
- }
- ],
- "name": "New York Steak",
- "quantity": "2",
- "total_discount_money": {
- "amount": 346,
- "currency": "USD"
- },
- "total_money": {
- "amount": 4528,
- "currency": "USD"
- },
- "total_service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 374,
- "currency": "USD"
- },
- "uid": "v8ZuEXpOJpb0bazLuvrLDB",
- "variation_name": "Larger",
- "variation_total_price_money": {
- "amount": 4400,
- "currency": "USD"
- },
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4"
- }
- ],
- "location_id": "057P5VYJ4A5X1",
- "net_amounts": {
- "discount_money": {
- "amount": 433,
- "currency": "USD"
- },
- "service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "tax_money": {
- "amount": 510,
- "currency": "USD"
- },
- "tip_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_money": {
- "amount": 6176,
- "currency": "USD"
- }
- },
- "reference_id": "my-order-001",
- "source": {
- "name": "My App"
- },
- "state": "DRAFT",
- "taxes": [
- {
- "applied_money": {
- "amount": 510,
- "currency": "USD"
- },
- "name": "State Sales Tax",
- "percentage": "9",
- "scope": "ORDER",
- "type": "ADDITIVE",
- "uid": "state-sales-tax"
- }
- ],
- "total_discount_money": {
- "amount": 433,
- "currency": "USD"
- },
- "total_money": {
- "amount": 6176,
- "currency": "USD"
- },
- "total_service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 510,
- "currency": "USD"
- },
- "total_tip_money": {
- "amount": 0,
- "currency": "USD"
- },
- "updated_at": "2020-01-17T20:47:53.293Z",
- "version": 1,
- "customer_id": "customer_id4"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/collected-data.md b/doc/models/collected-data.md
deleted file mode 100644
index 0951820c..00000000
--- a/doc/models/collected-data.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Collected Data
-
-## Structure
-
-`CollectedData`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `inputText` | `?string` | Optional | The buyer's input text. | getInputText(): ?string | setInputText(?string inputText): void |
-
-## Example (as JSON)
-
-```json
-{
- "input_text": "input_text8"
-}
-```
-
diff --git a/doc/models/complete-payment-request.md b/doc/models/complete-payment-request.md
deleted file mode 100644
index 7aac0ae1..00000000
--- a/doc/models/complete-payment-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Complete Payment Request
-
-Describes a request to complete (capture) a payment using
-[CompletePayment](../../doc/apis/payments.md#complete-payment).
-
-By default, payments are set to `autocomplete` immediately after they are created.
-To complete payments manually, set `autocomplete` to `false`.
-
-## Structure
-
-`CompletePaymentRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `versionToken` | `?string` | Optional | Used for optimistic concurrency. This opaque token identifies the current `Payment`
version that the caller expects. If the server has a different version of the Payment,
the update fails and a response with a VERSION_MISMATCH error is returned. | getVersionToken(): ?string | setVersionToken(?string versionToken): void |
-
-## Example (as JSON)
-
-```json
-{
- "version_token": "version_token8"
-}
-```
-
diff --git a/doc/models/complete-payment-response.md b/doc/models/complete-payment-response.md
deleted file mode 100644
index 593d37cf..00000000
--- a/doc/models/complete-payment-response.md
+++ /dev/null
@@ -1,107 +0,0 @@
-
-# Complete Payment Response
-
-Defines the response returned by[CompletePayment](../../doc/apis/payments.md#complete-payment).
-
-## Structure
-
-`CompletePaymentResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `payment` | [`?Payment`](../../doc/models/payment.md) | Optional | Represents a payment processed by the Square API. | getPayment(): ?Payment | setPayment(?Payment payment): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment": {
- "amount_money": {
- "amount": 555,
- "currency": "USD"
- },
- "application_details": {
- "application_id": "sq0ids-Pw67AZAlLVB7hsRmwlJPuA",
- "square_product": "VIRTUAL_TERMINAL"
- },
- "approved_money": {
- "amount": 555,
- "currency": "USD"
- },
- "card_details": {
- "auth_result_code": "2Nkw7q",
- "avs_status": "AVS_ACCEPTED",
- "card": {
- "bin": "411111",
- "card_brand": "VISA",
- "card_type": "DEBIT",
- "exp_month": 11,
- "exp_year": 2022,
- "fingerprint": "sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ",
- "last_4": "1111",
- "prepaid_type": "NOT_PREPAID"
- },
- "card_payment_timeline": {
- "authorized_at": "2021-10-13T19:34:33.680Z",
- "captured_at": "2021-10-13T19:34:34.340Z"
- },
- "cvv_status": "CVV_ACCEPTED",
- "entry_method": "KEYED",
- "statement_description": "SQ *EXAMPLE TEST GOSQ.C",
- "status": "CAPTURED"
- },
- "created_at": "2021-10-13T19:34:33.524Z",
- "delay_action": "CANCEL",
- "delay_duration": "PT168H",
- "delayed_until": "2021-10-20T19:34:33.524Z",
- "employee_id": "TMoK_ogh6rH1o4dV",
- "id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY",
- "location_id": "L88917AVBK2S5",
- "note": "Test Note",
- "order_id": "d7eKah653Z579f3gVtjlxpSlmUcZY",
- "processing_fee": [
- {
- "amount_money": {
- "amount": 34,
- "currency": "USD"
- },
- "effective_at": "2021-10-13T21:34:35.000Z",
- "type": "INITIAL"
- }
- ],
- "receipt_number": "bP9m",
- "receipt_url": "https://squareup.com/receipt/preview/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY",
- "source_type": "CARD",
- "status": "COMPLETED",
- "team_member_id": "TMoK_ogh6rH1o4dV",
- "total_money": {
- "amount": 555,
- "currency": "USD"
- },
- "updated_at": "2021-10-13T19:34:34.339Z",
- "version_token": "56pRkL3slrzet2iQrTp9n0bdJVYTB9YEWdTNjQfZOPV6o",
- "tip_money": {
- "amount": 190,
- "currency": "TWD"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/component-component-type.md b/doc/models/component-component-type.md
deleted file mode 100644
index 3619b08e..00000000
--- a/doc/models/component-component-type.md
+++ /dev/null
@@ -1,20 +0,0 @@
-
-# Component Component Type
-
-An enum for ComponentType.
-
-## Enumeration
-
-`ComponentComponentType`
-
-## Fields
-
-| Name |
-| --- |
-| `APPLICATION` |
-| `CARD_READER` |
-| `BATTERY` |
-| `WIFI` |
-| `ETHERNET` |
-| `PRINTER` |
-
diff --git a/doc/models/component.md b/doc/models/component.md
deleted file mode 100644
index 7aa6be7b..00000000
--- a/doc/models/component.md
+++ /dev/null
@@ -1,54 +0,0 @@
-
-# Component
-
-The wrapper object for the component entries of a given component type.
-
-## Structure
-
-`Component`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `type` | [`string(ComponentComponentType)`](../../doc/models/component-component-type.md) | Required | An enum for ComponentType. | getType(): string | setType(string type): void |
-| `applicationDetails` | [`?DeviceComponentDetailsApplicationDetails`](../../doc/models/device-component-details-application-details.md) | Optional | - | getApplicationDetails(): ?DeviceComponentDetailsApplicationDetails | setApplicationDetails(?DeviceComponentDetailsApplicationDetails applicationDetails): void |
-| `cardReaderDetails` | [`?DeviceComponentDetailsCardReaderDetails`](../../doc/models/device-component-details-card-reader-details.md) | Optional | - | getCardReaderDetails(): ?DeviceComponentDetailsCardReaderDetails | setCardReaderDetails(?DeviceComponentDetailsCardReaderDetails cardReaderDetails): void |
-| `batteryDetails` | [`?DeviceComponentDetailsBatteryDetails`](../../doc/models/device-component-details-battery-details.md) | Optional | - | getBatteryDetails(): ?DeviceComponentDetailsBatteryDetails | setBatteryDetails(?DeviceComponentDetailsBatteryDetails batteryDetails): void |
-| `wifiDetails` | [`?DeviceComponentDetailsWiFiDetails`](../../doc/models/device-component-details-wi-fi-details.md) | Optional | - | getWifiDetails(): ?DeviceComponentDetailsWiFiDetails | setWifiDetails(?DeviceComponentDetailsWiFiDetails wifiDetails): void |
-| `ethernetDetails` | [`?DeviceComponentDetailsEthernetDetails`](../../doc/models/device-component-details-ethernet-details.md) | Optional | - | getEthernetDetails(): ?DeviceComponentDetailsEthernetDetails | setEthernetDetails(?DeviceComponentDetailsEthernetDetails ethernetDetails): void |
-
-## Example (as JSON)
-
-```json
-{
- "type": "BATTERY",
- "application_details": {
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
- },
- "card_reader_details": {
- "version": "version0"
- },
- "battery_details": {
- "visible_percent": 108,
- "external_power": "AVAILABLE_CHARGING"
- },
- "wifi_details": {
- "active": false,
- "ssid": "ssid8",
- "ip_address_v4": "ip_address_v42",
- "secure_connection": "secure_connection8",
- "signal_strength": {
- "value": 222
- }
- },
- "ethernet_details": {
- "active": false,
- "ip_address_v4": "ip_address_v42"
- }
-}
-```
-
diff --git a/doc/models/confirmation-decision.md b/doc/models/confirmation-decision.md
deleted file mode 100644
index f3038a99..00000000
--- a/doc/models/confirmation-decision.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Confirmation Decision
-
-## Structure
-
-`ConfirmationDecision`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `hasAgreed` | `?bool` | Optional | The buyer's decision to the displayed terms. | getHasAgreed(): ?bool | setHasAgreed(?bool hasAgreed): void |
-
-## Example (as JSON)
-
-```json
-{
- "has_agreed": false
-}
-```
-
diff --git a/doc/models/confirmation-options.md b/doc/models/confirmation-options.md
deleted file mode 100644
index 5ed5778a..00000000
--- a/doc/models/confirmation-options.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Confirmation Options
-
-## Structure
-
-`ConfirmationOptions`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `title` | `string` | Required | The title text to display in the confirmation screen flow on the Terminal.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `250` | getTitle(): string | setTitle(string title): void |
-| `body` | `string` | Required | The agreement details to display in the confirmation flow on the Terminal.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `10000` | getBody(): string | setBody(string body): void |
-| `agreeButtonText` | `string` | Required | The button text to display indicating the customer agrees to the displayed terms.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `250` | getAgreeButtonText(): string | setAgreeButtonText(string agreeButtonText): void |
-| `disagreeButtonText` | `?string` | Optional | The button text to display indicating the customer does not agree to the displayed terms.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `250` | getDisagreeButtonText(): ?string | setDisagreeButtonText(?string disagreeButtonText): void |
-| `decision` | [`?ConfirmationDecision`](../../doc/models/confirmation-decision.md) | Optional | - | getDecision(): ?ConfirmationDecision | setDecision(?ConfirmationDecision decision): void |
-
-## Example (as JSON)
-
-```json
-{
- "title": "title0",
- "body": "body0",
- "agree_button_text": "agree_button_text8",
- "disagree_button_text": "disagree_button_text8",
- "decision": {
- "has_agreed": false
- }
-}
-```
-
diff --git a/doc/models/coordinates.md b/doc/models/coordinates.md
deleted file mode 100644
index 3bc70606..00000000
--- a/doc/models/coordinates.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Coordinates
-
-Latitude and longitude coordinates.
-
-## Structure
-
-`Coordinates`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `latitude` | `?float` | Optional | The latitude of the coordinate expressed in degrees. | getLatitude(): ?float | setLatitude(?float latitude): void |
-| `longitude` | `?float` | Optional | The longitude of the coordinate expressed in degrees. | getLongitude(): ?float | setLongitude(?float longitude): void |
-
-## Example (as JSON)
-
-```json
-{
- "latitude": 200.94,
- "longitude": 52.86
-}
-```
-
diff --git a/doc/models/country.md b/doc/models/country.md
deleted file mode 100644
index 39422596..00000000
--- a/doc/models/country.md
+++ /dev/null
@@ -1,265 +0,0 @@
-
-# Country
-
-Indicates the country associated with another entity, such as a business.
-Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm).
-
-## Enumeration
-
-`Country`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ZZ` | Unknown |
-| `AD` | Andorra |
-| `AE` | United Arab Emirates |
-| `AF` | Afghanistan |
-| `AG` | Antigua and Barbuda |
-| `AI` | Anguilla |
-| `AL` | Albania |
-| `AM` | Armenia |
-| `AO` | Angola |
-| `AQ` | Antartica |
-| `AR` | Argentina |
-| `AS` | American Samoa |
-| `AT` | Austria |
-| `AU` | Australia |
-| `AW` | Aruba |
-| `AX` | Åland Islands |
-| `AZ` | Azerbaijan |
-| `BA` | Bosnia and Herzegovina |
-| `BB` | Barbados |
-| `BD` | Bangladesh |
-| `BE` | Belgium |
-| `BF` | Burkina Faso |
-| `BG` | Bulgaria |
-| `BH` | Bahrain |
-| `BI` | Burundi |
-| `BJ` | Benin |
-| `BL` | Saint Barthélemy |
-| `BM` | Bermuda |
-| `BN` | Brunei |
-| `BO` | Bolivia |
-| `BQ` | Bonaire |
-| `BR` | Brazil |
-| `BS` | Bahamas |
-| `BT` | Bhutan |
-| `BV` | Bouvet Island |
-| `BW` | Botswana |
-| `BY` | Belarus |
-| `BZ` | Belize |
-| `CA` | Canada |
-| `CC` | Cocos Islands |
-| `CD` | Democratic Republic of the Congo |
-| `CF` | Central African Republic |
-| `CG` | Congo |
-| `CH` | Switzerland |
-| `CI` | Ivory Coast |
-| `CK` | Cook Islands |
-| `CL` | Chile |
-| `CM` | Cameroon |
-| `CN` | China |
-| `CO` | Colombia |
-| `CR` | Costa Rica |
-| `CU` | Cuba |
-| `CV` | Cabo Verde |
-| `CW` | Curaçao |
-| `CX` | Christmas Island |
-| `CY` | Cyprus |
-| `CZ` | Czechia |
-| `DE` | Germany |
-| `DJ` | Djibouti |
-| `DK` | Denmark |
-| `DM` | Dominica |
-| `DO` | Dominican Republic |
-| `DZ` | Algeria |
-| `EC` | Ecuador |
-| `EE` | Estonia |
-| `EG` | Egypt |
-| `EH` | Western Sahara |
-| `ER` | Eritrea |
-| `ES` | Spain |
-| `ET` | Ethiopia |
-| `FI` | Finland |
-| `FJ` | Fiji |
-| `FK` | Falkland Islands |
-| `FM` | Federated States of Micronesia |
-| `FO` | Faroe Islands |
-| `FR` | France |
-| `GA` | Gabon |
-| `GB` | United Kingdom |
-| `GD` | Grenada |
-| `GE` | Georgia |
-| `GF` | French Guiana |
-| `GG` | Guernsey |
-| `GH` | Ghana |
-| `GI` | Gibraltar |
-| `GL` | Greenland |
-| `GM` | Gambia |
-| `GN` | Guinea |
-| `GP` | Guadeloupe |
-| `GQ` | Equatorial Guinea |
-| `GR` | Greece |
-| `GS` | South Georgia and the South Sandwich Islands |
-| `GT` | Guatemala |
-| `GU` | Guam |
-| `GW` | Guinea-Bissau |
-| `GY` | Guyana |
-| `HK` | Hong Kong |
-| `HM` | Heard Island and McDonald Islands |
-| `HN` | Honduras |
-| `HR` | Croatia |
-| `HT` | Haiti |
-| `HU` | Hungary |
-| `ID` | Indonesia |
-| `IE` | Ireland |
-| `IL` | Israel |
-| `IM` | Isle of Man |
-| `IN` | India |
-| `IO` | British Indian Ocean Territory |
-| `IQ` | Iraq |
-| `IR` | Iran |
-| `IS` | Iceland |
-| `IT` | Italy |
-| `JE` | Jersey |
-| `JM` | Jamaica |
-| `JO` | Jordan |
-| `JP` | Japan |
-| `KE` | Kenya |
-| `KG` | Kyrgyzstan |
-| `KH` | Cambodia |
-| `KI` | Kiribati |
-| `KM` | Comoros |
-| `KN` | Saint Kitts and Nevis |
-| `KP` | Democratic People's Republic of Korea |
-| `KR` | Republic of Korea |
-| `KW` | Kuwait |
-| `KY` | Cayman Islands |
-| `KZ` | Kazakhstan |
-| `LA` | Lao People's Democratic Republic |
-| `LB` | Lebanon |
-| `LC` | Saint Lucia |
-| `LI` | Liechtenstein |
-| `LK` | Sri Lanka |
-| `LR` | Liberia |
-| `LS` | Lesotho |
-| `LT` | Lithuania |
-| `LU` | Luxembourg |
-| `LV` | Latvia |
-| `LY` | Libya |
-| `MA` | Morocco |
-| `MC` | Monaco |
-| `MD` | Moldova |
-| `ME` | Montenegro |
-| `MF` | Saint Martin |
-| `MG` | Madagascar |
-| `MH` | Marshall Islands |
-| `MK` | North Macedonia |
-| `ML` | Mali |
-| `MM` | Myanmar |
-| `MN` | Mongolia |
-| `MO` | Macao |
-| `MP` | Northern Mariana Islands |
-| `MQ` | Martinique |
-| `MR` | Mauritania |
-| `MS` | Montserrat |
-| `MT` | Malta |
-| `MU` | Mauritius |
-| `MV` | Maldives |
-| `MW` | Malawi |
-| `MX` | Mexico |
-| `MY` | Malaysia |
-| `MZ` | Mozambique |
-| `NA` | Namibia |
-| `NC` | New Caledonia |
-| `NE` | Niger |
-| `NF` | Norfolk Island |
-| `NG` | Nigeria |
-| `NI` | Nicaragua |
-| `NL` | Netherlands |
-| `NO` | Norway |
-| `NP` | Nepal |
-| `NR` | Nauru |
-| `NU` | Niue |
-| `NZ` | New Zealand |
-| `OM` | Oman |
-| `PA` | Panama |
-| `PE` | Peru |
-| `PF` | French Polynesia |
-| `PG` | Papua New Guinea |
-| `PH` | Philippines |
-| `PK` | Pakistan |
-| `PL` | Poland |
-| `PM` | Saint Pierre and Miquelon |
-| `PN` | Pitcairn |
-| `PR` | Puerto Rico |
-| `PS` | Palestine |
-| `PT` | Portugal |
-| `PW` | Palau |
-| `PY` | Paraguay |
-| `QA` | Qatar |
-| `RE` | Réunion |
-| `RO` | Romania |
-| `RS` | Serbia |
-| `RU` | Russia |
-| `RW` | Rwanda |
-| `SA` | Saudi Arabia |
-| `SB` | Solomon Islands |
-| `SC` | Seychelles |
-| `SD` | Sudan |
-| `SE` | Sweden |
-| `SG` | Singapore |
-| `SH` | Saint Helena, Ascension and Tristan da Cunha |
-| `SI` | Slovenia |
-| `SJ` | Svalbard and Jan Mayen |
-| `SK` | Slovakia |
-| `SL` | Sierra Leone |
-| `SM` | San Marino |
-| `SN` | Senegal |
-| `SO` | Somalia |
-| `SR` | Suriname |
-| `SS` | South Sudan |
-| `ST` | Sao Tome and Principe |
-| `SV` | El Salvador |
-| `SX` | Sint Maarten |
-| `SY` | Syrian Arab Republic |
-| `SZ` | Eswatini |
-| `TC` | Turks and Caicos Islands |
-| `TD` | Chad |
-| `TF` | French Southern Territories |
-| `TG` | Togo |
-| `TH` | Thailand |
-| `TJ` | Tajikistan |
-| `TK` | Tokelau |
-| `TL` | Timor-Leste |
-| `TM` | Turkmenistan |
-| `TN` | Tunisia |
-| `TO` | Tonga |
-| `TR` | Turkey |
-| `TT` | Trinidad and Tobago |
-| `TV` | Tuvalu |
-| `TW` | Taiwan |
-| `TZ` | Tanzania |
-| `UA` | Ukraine |
-| `UG` | Uganda |
-| `UM` | United States Minor Outlying Islands |
-| `US` | United States of America |
-| `UY` | Uruguay |
-| `UZ` | Uzbekistan |
-| `VA` | Vatican City |
-| `VC` | Saint Vincent and the Grenadines |
-| `VE` | Venezuela |
-| `VG` | British Virgin Islands |
-| `VI` | U.S. Virgin Islands |
-| `VN` | Vietnam |
-| `VU` | Vanuatu |
-| `WF` | Wallis and Futuna |
-| `WS` | Samoa |
-| `YE` | Yemen |
-| `YT` | Mayotte |
-| `ZA` | South Africa |
-| `ZM` | Zambia |
-| `ZW` | Zimbabwe |
-
diff --git a/doc/models/create-booking-custom-attribute-definition-request.md b/doc/models/create-booking-custom-attribute-definition-request.md
deleted file mode 100644
index 4a915dff..00000000
--- a/doc/models/create-booking-custom-attribute-definition-request.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Create Booking Custom Attribute Definition Request
-
-Represents a [CreateBookingCustomAttributeDefinition](../../doc/apis/booking-custom-attributes.md#create-booking-custom-attribute-definition) request.
-
-## Structure
-
-`CreateBookingCustomAttributeDefinitionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Required | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): CustomAttributeDefinition | setCustomAttributeDefinition(CustomAttributeDefinition customAttributeDefinition): void |
-| `idempotencyKey` | `?string` | Optional | A unique identifier for this request, used to ensure idempotency. For more information,
see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "key": "key2",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name2",
- "description": "description8",
- "visibility": "VISIBILITY_HIDDEN"
- },
- "idempotency_key": "idempotency_key6"
-}
-```
-
diff --git a/doc/models/create-booking-custom-attribute-definition-response.md b/doc/models/create-booking-custom-attribute-definition-response.md
deleted file mode 100644
index 3eb18b0e..00000000
--- a/doc/models/create-booking-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,38 +0,0 @@
-
-# Create Booking Custom Attribute Definition Response
-
-Represents a [CreateBookingCustomAttributeDefinition](../../doc/apis/booking-custom-attributes.md#create-booking-custom-attribute-definition) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`CreateBookingCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`?CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Optional | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): ?CustomAttributeDefinition | setCustomAttributeDefinition(?CustomAttributeDefinition customAttributeDefinition): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "created_at": "2022-11-16T15:27:30Z",
- "description": "The favorite shampoo of the customer.",
- "key": "favoriteShampoo",
- "name": "Favorite Shampoo",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-11-16T15:27:30Z",
- "version": 1,
- "visibility": "VISIBILITY_HIDDEN"
- },
- "errors": []
-}
-```
-
diff --git a/doc/models/create-booking-request.md b/doc/models/create-booking-request.md
deleted file mode 100644
index a171eae3..00000000
--- a/doc/models/create-booking-request.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Create Booking Request
-
-## Structure
-
-`CreateBookingRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `?string` | Optional | A unique key to make this request an idempotent operation.
**Constraints**: *Maximum Length*: `255` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-| `booking` | [`Booking`](../../doc/models/booking.md) | Required | Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service
at a given location to a requesting customer in one or more appointment segments. | getBooking(): Booking | setBooking(Booking booking): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "idempotency_key4",
- "booking": {
- "id": "id4",
- "version": 156,
- "status": "CANCELLED_BY_SELLER",
- "created_at": "created_at2",
- "updated_at": "updated_at0"
- }
-}
-```
-
diff --git a/doc/models/create-booking-response.md b/doc/models/create-booking-response.md
deleted file mode 100644
index eecf6e06..00000000
--- a/doc/models/create-booking-response.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-# Create Booking Response
-
-## Structure
-
-`CreateBookingResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `booking` | [`?Booking`](../../doc/models/booking.md) | Optional | Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service
at a given location to a requesting customer in one or more appointment segments. | getBooking(): ?Booking | setBooking(?Booking booking): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "booking": {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMXUrsBWWcHTt79t"
- }
- ],
- "created_at": "2020-10-28T15:47:41Z",
- "customer_id": "EX2QSVGTZN4K1E5QE1CBFNVQ8M",
- "customer_note": "",
- "id": "zkras0xv0xwswx",
- "location_id": "LEQHH0YY8B42M",
- "seller_note": "",
- "start_at": "2020-11-26T13:00:00Z",
- "status": "ACCEPTED",
- "updated_at": "2020-10-28T15:47:41Z",
- "version": 0
- },
- "errors": []
-}
-```
-
diff --git a/doc/models/create-break-type-request.md b/doc/models/create-break-type-request.md
deleted file mode 100644
index 6ec62e9e..00000000
--- a/doc/models/create-break-type-request.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Create Break Type Request
-
-A request to create a new `BreakType`.
-
-## Structure
-
-`CreateBreakTypeRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `?string` | Optional | A unique string value to ensure the idempotency of the operation.
**Constraints**: *Maximum Length*: `128` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-| `breakType` | [`BreakType`](../../doc/models/break-type.md) | Required | A defined break template that sets an expectation for possible `Break`
instances on a `Shift`. | getBreakType(): BreakType | setBreakType(BreakType breakType): void |
-
-## Example (as JSON)
-
-```json
-{
- "break_type": {
- "break_name": "Lunch Break",
- "expected_duration": "PT30M",
- "is_paid": true,
- "location_id": "CGJN03P1D08GF",
- "id": "id8",
- "version": 132,
- "created_at": "created_at6",
- "updated_at": "updated_at4"
- },
- "idempotency_key": "PAD3NG5KSN2GL"
-}
-```
-
diff --git a/doc/models/create-break-type-response.md b/doc/models/create-break-type-response.md
deleted file mode 100644
index 678bbefb..00000000
--- a/doc/models/create-break-type-response.md
+++ /dev/null
@@ -1,55 +0,0 @@
-
-# Create Break Type Response
-
-The response to the request to create a `BreakType`. The response contains
-the created `BreakType` object and might contain a set of `Error` objects if
-the request resulted in errors.
-
-## Structure
-
-`CreateBreakTypeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `breakType` | [`?BreakType`](../../doc/models/break-type.md) | Optional | A defined break template that sets an expectation for possible `Break`
instances on a `Shift`. | getBreakType(): ?BreakType | setBreakType(?BreakType breakType): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "break_type": {
- "break_name": "Lunch Break",
- "created_at": "2019-02-26T22:42:54Z",
- "expected_duration": "PT30M",
- "id": "49SSVDJG76WF3",
- "is_paid": true,
- "location_id": "CGJN03P1D08GF",
- "updated_at": "2019-02-26T22:42:54Z",
- "version": 1
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-card-request.md b/doc/models/create-card-request.md
deleted file mode 100644
index e4255f44..00000000
--- a/doc/models/create-card-request.md
+++ /dev/null
@@ -1,47 +0,0 @@
-
-# Create Card Request
-
-Creates a card from the source (payment token or payment id). Accessible via
-HTTP requests at POST https://connect.squareup.com/v2/cards
-
-## Structure
-
-`CreateCardRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A unique string that identifies this CreateCard request. Keys can be
any valid string and must be unique for every request.
Max: 45 characters
See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
**Constraints**: *Minimum Length*: `1` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `sourceId` | `string` | Required | The ID of the source which represents the card information to be stored. This can be a card nonce or a payment id.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `16384` | getSourceId(): string | setSourceId(string sourceId): void |
-| `verificationToken` | `?string` | Optional | An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer).
Verification tokens encapsulate customer device information and 3-D Secure
challenge results to indicate that Square has verified the buyer identity.
See the [SCA Overview](https://developer.squareup.com/docs/sca-overview). | getVerificationToken(): ?string | setVerificationToken(?string verificationToken): void |
-| `card` | [`Card`](../../doc/models/card.md) | Required | Represents the payment details of a card to be used for payments. These
details are determined by the payment token generated by Web Payments SDK. | getCard(): Card | setCard(Card card): void |
-
-## Example (as JSON)
-
-```json
-{
- "card": {
- "billing_address": {
- "address_line_1": "500 Electric Ave",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "NY",
- "country": "US",
- "locality": "New York",
- "postal_code": "10003"
- },
- "cardholder_name": "Amelia Earhart",
- "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8",
- "reference_id": "user-id-1",
- "id": "id6",
- "card_brand": "OTHER_BRAND",
- "last_4": "last_48",
- "exp_month": 228,
- "exp_year": 68
- },
- "idempotency_key": "4935a656-a929-4792-b97c-8848be85c27c",
- "source_id": "cnon:uIbfJXhXETSP197M3GB",
- "verification_token": "verification_token4"
-}
-```
-
diff --git a/doc/models/create-card-response.md b/doc/models/create-card-response.md
deleted file mode 100644
index e81d314a..00000000
--- a/doc/models/create-card-response.md
+++ /dev/null
@@ -1,72 +0,0 @@
-
-# Create Card Response
-
-Defines the fields that are included in the response body of
-a request to the [CreateCard](../../doc/apis/cards.md#create-card) endpoint.
-
-Note: if there are errors processing the request, the card field will not be
-present.
-
-## Structure
-
-`CreateCardResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors resulting from the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `card` | [`?Card`](../../doc/models/card.md) | Optional | Represents the payment details of a card to be used for payments. These
details are determined by the payment token generated by Web Payments SDK. | getCard(): ?Card | setCard(?Card card): void |
-
-## Example (as JSON)
-
-```json
-{
- "card": {
- "billing_address": {
- "address_line_1": "500 Electric Ave",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "NY",
- "country": "US",
- "locality": "New York",
- "postal_code": "10003"
- },
- "bin": "411111",
- "card_brand": "VISA",
- "card_type": "CREDIT",
- "cardholder_name": "Amelia Earhart",
- "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8",
- "enabled": true,
- "exp_month": 11,
- "exp_year": 2022,
- "fingerprint": "ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q",
- "id": "ccof:uIbfJXhXETSP197M3GB",
- "last_4": "1111",
- "merchant_id": "6SSW7HV8K2ST5",
- "prepaid_type": "NOT_PREPAID",
- "reference_id": "user-id-1",
- "version": 1
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-catalog-image-request.md b/doc/models/create-catalog-image-request.md
deleted file mode 100644
index d458e6ae..00000000
--- a/doc/models/create-catalog-image-request.md
+++ /dev/null
@@ -1,66 +0,0 @@
-
-# Create Catalog Image Request
-
-## Structure
-
-`CreateCatalogImageRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A unique string that identifies this CreateCatalogImage request.
Keys can be any valid string but must be unique for every CreateCatalogImage request.
See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
**Constraints**: *Minimum Length*: `1` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `objectId` | `?string` | Optional | Unique ID of the `CatalogObject` to attach this `CatalogImage` object to. Leave this
field empty to create unattached images, for example if you are building an integration
where an image can be attached to catalog items at a later time. | getObjectId(): ?string | setObjectId(?string objectId): void |
-| `image` | [`CatalogObject`](../../doc/models/catalog-object.md) | Required | The wrapper object for the catalog entries of a given object type.
Depending on the `type` attribute value, a `CatalogObject` instance assumes a type-specific data to yield the corresponding type of catalog object.
For example, if `type=ITEM`, the `CatalogObject` instance must have the ITEM-specific data set on the `item_data` attribute. The resulting `CatalogObject` instance is also a `CatalogItem` instance.
In general, if `type=`, the `CatalogObject` instance must have the ``-specific data set on the `_data` attribute. The resulting `CatalogObject` instance is also a `Catalog` instance.
For a more detailed discussion of the Catalog data model, please see the
[Design a Catalog](https://developer.squareup.com/docs/catalog-api/design-a-catalog) guide. | getImage(): CatalogObject | setImage(CatalogObject image): void |
-| `isPrimary` | `?bool` | Optional | If this is set to `true`, the image created will be the primary, or first image of the object referenced by `object_id`.
If the `CatalogObject` already has a primary `CatalogImage`, setting this field to `true` will replace the primary image.
If this is set to `false` and you use the Square API version 2021-12-15 or later, the image id will be appended to the list of `image_ids` on the object.
With Square API version 2021-12-15 or later, the default value is `false`. Otherwise, the effective default value is `true`. | getIsPrimary(): ?bool | setIsPrimary(?bool isPrimary): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "528dea59-7bfb-43c1-bd48-4a6bba7dd61f86",
- "image": {
- "id": "#TEMP_ID",
- "image_data": {
- "caption": "A picture of a cup of coffee"
- },
- "type": "IMAGE",
- "updated_at": "updated_at2",
- "version": 100,
- "is_deleted": false,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- },
- "object_id": "ND6EA5AAJEO5WL3JNNIAQA32",
- "is_primary": false
-}
-```
-
diff --git a/doc/models/create-catalog-image-response.md b/doc/models/create-catalog-image-response.md
deleted file mode 100644
index e23eec82..00000000
--- a/doc/models/create-catalog-image-response.md
+++ /dev/null
@@ -1,70 +0,0 @@
-
-# Create Catalog Image Response
-
-## Structure
-
-`CreateCatalogImageResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `image` | [`?CatalogObject`](../../doc/models/catalog-object.md) | Optional | The wrapper object for the catalog entries of a given object type.
Depending on the `type` attribute value, a `CatalogObject` instance assumes a type-specific data to yield the corresponding type of catalog object.
For example, if `type=ITEM`, the `CatalogObject` instance must have the ITEM-specific data set on the `item_data` attribute. The resulting `CatalogObject` instance is also a `CatalogItem` instance.
In general, if `type=`, the `CatalogObject` instance must have the ``-specific data set on the `_data` attribute. The resulting `CatalogObject` instance is also a `Catalog` instance.
For a more detailed discussion of the Catalog data model, please see the
[Design a Catalog](https://developer.squareup.com/docs/catalog-api/design-a-catalog) guide. | getImage(): ?CatalogObject | setImage(?CatalogObject image): void |
-
-## Example (as JSON)
-
-```json
-{
- "image": {
- "id": "KQLFFHA6K6J3YQAQAWDQAL57",
- "image_data": {
- "caption": "A picture of a cup of coffee",
- "url": "https://..."
- },
- "type": "IMAGE",
- "updated_at": "updated_at2",
- "version": 100,
- "is_deleted": false,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-checkout-request.md b/doc/models/create-checkout-request.md
deleted file mode 100644
index a630c19a..00000000
--- a/doc/models/create-checkout-request.md
+++ /dev/null
@@ -1,179 +0,0 @@
-
-# Create Checkout Request
-
-Defines the parameters that can be included in the body of
-a request to the `CreateCheckout` endpoint.
-
-## Structure
-
-`CreateCheckoutRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A unique string that identifies this checkout among others you have 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 are
unsure whether a particular checkout was created successfully, you can attempt it again with
the same idempotency key and all the same other parameters without worrying about creating duplicates.
You should use a random number/string generator native to the language
you are working in to generate strings for your idempotency keys.
For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `192` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `order` | [`CreateOrderRequest`](../../doc/models/create-order-request.md) | Required | - | getOrder(): CreateOrderRequest | setOrder(CreateOrderRequest order): void |
-| `askForShippingAddress` | `?bool` | Optional | If `true`, Square Checkout collects shipping information on your behalf and stores
that information with the transaction information in the Square Seller Dashboard.
Default: `false`. | getAskForShippingAddress(): ?bool | setAskForShippingAddress(?bool askForShippingAddress): void |
-| `merchantSupportEmail` | `?string` | Optional | The email address to display on the Square Checkout confirmation page
and confirmation email that the buyer can use to contact the seller.
If this value is not set, the confirmation page and email display the
primary email address associated with the seller's Square account.
Default: none; only exists if explicitly set.
**Constraints**: *Maximum Length*: `254` | getMerchantSupportEmail(): ?string | setMerchantSupportEmail(?string merchantSupportEmail): void |
-| `prePopulateBuyerEmail` | `?string` | Optional | If provided, the buyer's email is prepopulated on the checkout page
as an editable text field.
Default: none; only exists if explicitly set.
**Constraints**: *Maximum Length*: `254` | getPrePopulateBuyerEmail(): ?string | setPrePopulateBuyerEmail(?string prePopulateBuyerEmail): void |
-| `prePopulateShippingAddress` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getPrePopulateShippingAddress(): ?Address | setPrePopulateShippingAddress(?Address prePopulateShippingAddress): void |
-| `redirectUrl` | `?string` | Optional | The URL to redirect to after the checkout is completed with `checkoutId`,
`transactionId`, and `referenceId` appended as URL parameters. For example,
if the provided redirect URL is `http://www.example.com/order-complete`, a
successful transaction redirects the customer to:
`http://www.example.com/order-complete?checkoutId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx`
If you do not provide a redirect URL, Square Checkout displays an order
confirmation page on your behalf; however, it is strongly recommended that
you provide a redirect URL so you can verify the transaction results and
finalize the order through your existing/normal confirmation workflow.
Default: none; only exists if explicitly set.
**Constraints**: *Maximum Length*: `800` | getRedirectUrl(): ?string | setRedirectUrl(?string redirectUrl): void |
-| `additionalRecipients` | [`?(ChargeRequestAdditionalRecipient[])`](../../doc/models/charge-request-additional-recipient.md) | Optional | The basic primitive of a multi-party transaction. The value is optional.
The transaction facilitated by you can be split from here.
If you provide this value, the `amount_money` value in your `additional_recipients` field
cannot be more than 90% of the `total_money` calculated by Square for your order.
The `location_id` must be a valid seller location where the checkout is occurring.
This field requires `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission.
This field is currently not supported in the Square Sandbox. | getAdditionalRecipients(): ?array | setAdditionalRecipients(?array additionalRecipients): void |
-| `note` | `?string` | Optional | An optional note to associate with the `checkout` object.
This value cannot exceed 60 characters.
**Constraints**: *Maximum Length*: `60` | getNote(): ?string | setNote(?string note): void |
-
-## Example (as JSON)
-
-```json
-{
- "additional_recipients": [
- {
- "amount_money": {
- "amount": 60,
- "currency": "USD"
- },
- "description": "Application fees",
- "location_id": "057P5VYJ4A5X1"
- }
- ],
- "ask_for_shipping_address": true,
- "idempotency_key": "86ae1696-b1e3-4328-af6d-f1e04d947ad6",
- "merchant_support_email": "merchant+support@website.com",
- "order": {
- "idempotency_key": "12ae1696-z1e3-4328-af6d-f1e04d947gd4",
- "order": {
- "customer_id": "customer_id",
- "discounts": [
- {
- "amount_money": {
- "amount": 100,
- "currency": "USD"
- },
- "scope": "LINE_ITEM",
- "type": "FIXED_AMOUNT",
- "uid": "56ae1696-z1e3-9328-af6d-f1e04d947gd4"
- }
- ],
- "line_items": [
- {
- "applied_discounts": [
- {
- "discount_uid": "56ae1696-z1e3-9328-af6d-f1e04d947gd4"
- }
- ],
- "applied_taxes": [
- {
- "tax_uid": "38ze1696-z1e3-5628-af6d-f1e04d947fg3"
- }
- ],
- "base_price_money": {
- "amount": 1500,
- "currency": "USD"
- },
- "name": "Printed T Shirt",
- "quantity": "2",
- "uid": "uid8",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- },
- {
- "base_price_money": {
- "amount": 2500,
- "currency": "USD"
- },
- "name": "Slim Jeans",
- "quantity": "1",
- "uid": "uid8",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- },
- {
- "base_price_money": {
- "amount": 3500,
- "currency": "USD"
- },
- "name": "Woven Sweater",
- "quantity": "3",
- "uid": "uid8",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- }
- ],
- "location_id": "location_id",
- "reference_id": "reference_id",
- "taxes": [
- {
- "percentage": "7.75",
- "scope": "LINE_ITEM",
- "type": "INCLUSIVE",
- "uid": "38ze1696-z1e3-5628-af6d-f1e04d947fg3"
- }
- ],
- "id": "id6",
- "source": {
- "name": "name4"
- }
- }
- },
- "pre_populate_buyer_email": "example@email.com",
- "pre_populate_shipping_address": {
- "address_line_1": "1455 Market St.",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "CA",
- "country": "US",
- "first_name": "Jane",
- "last_name": "Doe",
- "locality": "San Francisco",
- "postal_code": "94103",
- "address_line_3": "address_line_32",
- "sublocality": "sublocality6"
- },
- "redirect_url": "https://merchant.website.com/order-confirm"
-}
-```
-
diff --git a/doc/models/create-checkout-response.md b/doc/models/create-checkout-response.md
deleted file mode 100644
index f602d186..00000000
--- a/doc/models/create-checkout-response.md
+++ /dev/null
@@ -1,172 +0,0 @@
-
-# Create Checkout Response
-
-Defines the fields that are included in the response body of
-a request to the `CreateCheckout` endpoint.
-
-## Structure
-
-`CreateCheckoutResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `checkout` | [`?Checkout`](../../doc/models/checkout.md) | Optional | Square Checkout lets merchants accept online payments for supported
payment types using a checkout workflow hosted on squareup.com. | getCheckout(): ?Checkout | setCheckout(?Checkout checkout): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "checkout": {
- "additional_recipients": [
- {
- "amount_money": {
- "amount": 60,
- "currency": "USD"
- },
- "description": "Application fees",
- "location_id": "057P5VYJ4A5X1"
- }
- ],
- "ask_for_shipping_address": true,
- "checkout_page_url": "https://connect.squareup.com/v2/checkout?c=CAISEHGimXh-C3RIT4og1a6u1qw&l=CYTKRM7R7JMV8",
- "created_at": "2017-06-16T22:25:35Z",
- "id": "CAISEHGimXh-C3RIT4og1a6u1qw",
- "merchant_support_email": "merchant+support@website.com",
- "order": {
- "customer_id": "customer_id",
- "discounts": [
- {
- "amount_money": {
- "amount": 100,
- "currency": "USD"
- },
- "applied_money": {
- "amount": 100,
- "currency": "USD"
- },
- "scope": "LINE_ITEM",
- "type": "FIXED_AMOUNT",
- "uid": "56ae1696-z1e3-9328-af6d-f1e04d947gd4"
- }
- ],
- "line_items": [
- {
- "applied_discounts": [
- {
- "applied_money": {
- "amount": 100,
- "currency": "USD"
- },
- "discount_uid": "56ae1696-z1e3-9328-af6d-f1e04d947gd4"
- }
- ],
- "applied_taxes": [
- {
- "applied_money": {
- "amount": 103,
- "currency": "USD"
- },
- "tax_uid": "38ze1696-z1e3-5628-af6d-f1e04d947fg3"
- }
- ],
- "base_price_money": {
- "amount": 1500,
- "currency": "USD"
- },
- "name": "Printed T Shirt",
- "quantity": "2",
- "total_discount_money": {
- "amount": 100,
- "currency": "USD"
- },
- "total_money": {
- "amount": 1503,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 103,
- "currency": "USD"
- }
- },
- {
- "base_price_money": {
- "amount": 2500,
- "currency": "USD"
- },
- "name": "Slim Jeans",
- "quantity": "1",
- "total_money": {
- "amount": 2500,
- "currency": "USD"
- }
- },
- {
- "base_price_money": {
- "amount": 3500,
- "currency": "USD"
- },
- "name": "Woven Sweater",
- "quantity": "3",
- "total_money": {
- "amount": 10500,
- "currency": "USD"
- }
- }
- ],
- "location_id": "location_id",
- "reference_id": "reference_id",
- "taxes": [
- {
- "percentage": "7.75",
- "scope": "LINE_ITEM",
- "type": "INCLUSIVE",
- "uid": "38ze1696-z1e3-5628-af6d-f1e04d947fg3"
- }
- ],
- "total_discount_money": {
- "amount": 100,
- "currency": "USD"
- },
- "total_money": {
- "amount": 14503,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 103,
- "currency": "USD"
- }
- },
- "pre_populate_buyer_email": "example@email.com",
- "pre_populate_shipping_address": {
- "address_line_1": "1455 Market St.",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "CA",
- "country": "US",
- "first_name": "Jane",
- "last_name": "Doe",
- "locality": "San Francisco",
- "postal_code": "94103"
- },
- "redirect_url": "https://merchant.website.com/order-confirm",
- "version": 1
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-customer-card-request.md b/doc/models/create-customer-card-request.md
deleted file mode 100644
index bb150458..00000000
--- a/doc/models/create-customer-card-request.md
+++ /dev/null
@@ -1,39 +0,0 @@
-
-# Create Customer Card Request
-
-Defines the fields that are included in the request body of a request
-to the `CreateCustomerCard` endpoint.
-
-## Structure
-
-`CreateCustomerCardRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cardNonce` | `string` | Required | A card nonce representing the credit card to link to the customer.
Card nonces are generated by the Square payment form when customers enter
their card information. For more information, see
[Walkthrough: Integrate Square Payments in a Website](https://developer.squareup.com/docs/web-payments/take-card-payment).
__NOTE:__ Card nonces generated by digital wallets (such as Apple Pay)
cannot be used to create a customer card. | getCardNonce(): string | setCardNonce(string cardNonce): void |
-| `billingAddress` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void |
-| `cardholderName` | `?string` | Optional | The full name printed on the credit card. | getCardholderName(): ?string | setCardholderName(?string cardholderName): void |
-| `verificationToken` | `?string` | Optional | An identifying token generated by [Payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer).
Verification tokens encapsulate customer device information and 3-D Secure
challenge results to indicate that Square has verified the buyer identity. | getVerificationToken(): ?string | setVerificationToken(?string verificationToken): void |
-
-## Example (as JSON)
-
-```json
-{
- "billing_address": {
- "address_line_1": "500 Electric Ave",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "NY",
- "country": "US",
- "locality": "New York",
- "postal_code": "10003",
- "address_line_3": "address_line_34",
- "sublocality": "sublocality8"
- },
- "card_nonce": "YOUR_CARD_NONCE",
- "cardholder_name": "Amelia Earhart",
- "verification_token": "verification_token0"
-}
-```
-
diff --git a/doc/models/create-customer-card-response.md b/doc/models/create-customer-card-response.md
deleted file mode 100644
index 2c7fdc75..00000000
--- a/doc/models/create-customer-card-response.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Create Customer Card Response
-
-Defines the fields that are included in the response body of
-a request to the `CreateCustomerCard` endpoint.
-
-Either `errors` or `card` is present in a given response (never both).
-
-## Structure
-
-`CreateCustomerCardResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `card` | [`?Card`](../../doc/models/card.md) | Optional | Represents the payment details of a card to be used for payments. These
details are determined by the payment token generated by Web Payments SDK. | getCard(): ?Card | setCard(?Card card): void |
-
-## Example (as JSON)
-
-```json
-{
- "card": {
- "billing_address": {
- "address_line_1": "500 Electric Ave",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "NY",
- "country": "US",
- "locality": "New York",
- "postal_code": "10003"
- },
- "card_brand": "VISA",
- "cardholder_name": "Amelia Earhart",
- "exp_month": 11,
- "exp_year": 2018,
- "id": "icard-card_id",
- "last_4": "1111"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-customer-custom-attribute-definition-request.md b/doc/models/create-customer-custom-attribute-definition-request.md
deleted file mode 100644
index 5d8403ea..00000000
--- a/doc/models/create-customer-custom-attribute-definition-request.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Create Customer Custom Attribute Definition Request
-
-Represents a [CreateCustomerCustomAttributeDefinition](../../doc/apis/customer-custom-attributes.md#create-customer-custom-attribute-definition) request.
-
-## Structure
-
-`CreateCustomerCustomAttributeDefinitionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Required | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): CustomAttributeDefinition | setCustomAttributeDefinition(CustomAttributeDefinition customAttributeDefinition): void |
-| `idempotencyKey` | `?string` | Optional | A unique identifier for this request, used to ensure idempotency. For more information,
see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "description": "The favorite movie of the customer.",
- "key": "favoritemovie",
- "name": "Favorite Movie",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "visibility": "VISIBILITY_HIDDEN"
- },
- "idempotency_key": "idempotency_key4"
-}
-```
-
diff --git a/doc/models/create-customer-custom-attribute-definition-response.md b/doc/models/create-customer-custom-attribute-definition-response.md
deleted file mode 100644
index 9ddea2df..00000000
--- a/doc/models/create-customer-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,57 +0,0 @@
-
-# Create Customer Custom Attribute Definition Response
-
-Represents a [CreateCustomerCustomAttributeDefinition](../../doc/apis/customer-custom-attributes.md#create-customer-custom-attribute-definition) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`CreateCustomerCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`?CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Optional | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): ?CustomAttributeDefinition | setCustomAttributeDefinition(?CustomAttributeDefinition customAttributeDefinition): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "created_at": "2022-04-26T15:27:30Z",
- "description": "The favorite movie of the customer.",
- "key": "favoritemovie",
- "name": "Favorite Movie",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-04-26T15:27:30Z",
- "version": 1,
- "visibility": "VISIBILITY_HIDDEN"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-customer-group-request.md b/doc/models/create-customer-group-request.md
deleted file mode 100644
index ecccf074..00000000
--- a/doc/models/create-customer-group-request.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Create Customer Group Request
-
-Defines the body parameters that can be included in a request to the
-[CreateCustomerGroup](../../doc/apis/customer-groups.md#create-customer-group) endpoint.
-
-## Structure
-
-`CreateCustomerGroupRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `?string` | Optional | The idempotency key for the request. For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-| `group` | [`CustomerGroup`](../../doc/models/customer-group.md) | Required | Represents a group of customer profiles.
Customer groups can be created, be modified, and have their membership defined using
the Customers API or within the Customer Directory in the Square Seller Dashboard or Point of Sale. | getGroup(): CustomerGroup | setGroup(CustomerGroup group): void |
-
-## Example (as JSON)
-
-```json
-{
- "group": {
- "name": "Loyal Customers",
- "id": "id8",
- "created_at": "created_at4",
- "updated_at": "updated_at6"
- },
- "idempotency_key": "idempotency_key0"
-}
-```
-
diff --git a/doc/models/create-customer-group-response.md b/doc/models/create-customer-group-response.md
deleted file mode 100644
index 01efb7be..00000000
--- a/doc/models/create-customer-group-response.md
+++ /dev/null
@@ -1,40 +0,0 @@
-
-# Create Customer Group Response
-
-Defines the fields that are included in the response body of
-a request to the [CreateCustomerGroup](../../doc/apis/customer-groups.md#create-customer-group) endpoint.
-
-Either `errors` or `group` is present in a given response (never both).
-
-## Structure
-
-`CreateCustomerGroupResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `group` | [`?CustomerGroup`](../../doc/models/customer-group.md) | Optional | Represents a group of customer profiles.
Customer groups can be created, be modified, and have their membership defined using
the Customers API or within the Customer Directory in the Square Seller Dashboard or Point of Sale. | getGroup(): ?CustomerGroup | setGroup(?CustomerGroup group): void |
-
-## Example (as JSON)
-
-```json
-{
- "group": {
- "created_at": "2020-04-13T21:54:57.863Z",
- "id": "2TAT3CMH4Q0A9M87XJZED0WMR3",
- "name": "Loyal Customers",
- "updated_at": "2020-04-13T21:54:58Z"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-customer-request.md b/doc/models/create-customer-request.md
deleted file mode 100644
index 1eca73c3..00000000
--- a/doc/models/create-customer-request.md
+++ /dev/null
@@ -1,51 +0,0 @@
-
-# Create Customer Request
-
-Defines the body parameters that can be included in a request to the
-`CreateCustomer` endpoint.
-
-## Structure
-
-`CreateCustomerRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `?string` | Optional | The idempotency key for the request. For more information, see
[Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-| `givenName` | `?string` | Optional | The given name (that is, the first name) associated with the customer profile.
The maximum length for this value is 300 characters. | getGivenName(): ?string | setGivenName(?string givenName): void |
-| `familyName` | `?string` | Optional | The family name (that is, the last name) associated with the customer profile.
The maximum length for this value is 300 characters. | getFamilyName(): ?string | setFamilyName(?string familyName): void |
-| `companyName` | `?string` | Optional | A business name associated with the customer profile.
The maximum length for this value is 500 characters. | getCompanyName(): ?string | setCompanyName(?string companyName): void |
-| `nickname` | `?string` | Optional | A nickname for the customer profile.
The maximum length for this value is 100 characters. | getNickname(): ?string | setNickname(?string nickname): void |
-| `emailAddress` | `?string` | Optional | The email address associated with the customer profile.
The maximum length for this value is 254 characters. | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void |
-| `address` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getAddress(): ?Address | setAddress(?Address address): void |
-| `phoneNumber` | `?string` | Optional | The phone number associated with the customer profile. The phone number must be valid and can contain
9–16 digits, with an optional `+` prefix and country code. For more information, see
[Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). | getPhoneNumber(): ?string | setPhoneNumber(?string phoneNumber): void |
-| `referenceId` | `?string` | Optional | An optional second ID used to associate the customer profile with an
entity in another system.
The maximum length for this value is 100 characters. | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `note` | `?string` | Optional | A custom note associated with the customer profile. | getNote(): ?string | setNote(?string note): void |
-| `birthday` | `?string` | Optional | The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example,
specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD`
format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified. | getBirthday(): ?string | setBirthday(?string birthday): void |
-| `taxIds` | [`?CustomerTaxIds`](../../doc/models/customer-tax-ids.md) | Optional | Represents the tax ID associated with a [customer profile](../../doc/models/customer.md). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom.
For more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). | getTaxIds(): ?CustomerTaxIds | setTaxIds(?CustomerTaxIds taxIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "address": {
- "address_line_1": "500 Electric Ave",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "NY",
- "country": "US",
- "locality": "New York",
- "postal_code": "10003"
- },
- "email_address": "Amelia.Earhart@example.com",
- "family_name": "Earhart",
- "given_name": "Amelia",
- "note": "a customer",
- "phone_number": "+1-212-555-4240",
- "reference_id": "YOUR_REFERENCE_ID",
- "idempotency_key": "idempotency_key4",
- "company_name": "company_name4",
- "nickname": "nickname4"
-}
-```
-
diff --git a/doc/models/create-customer-response.md b/doc/models/create-customer-response.md
deleted file mode 100644
index e87db6f3..00000000
--- a/doc/models/create-customer-response.md
+++ /dev/null
@@ -1,68 +0,0 @@
-
-# Create Customer Response
-
-Defines the fields that are included in the response body of
-a request to the [CreateCustomer](../../doc/apis/customers.md#create-customer) or
-[BulkCreateCustomers](../../doc/apis/customers.md#bulk-create-customers) endpoint.
-
-Either `errors` or `customer` is present in a given response (never both).
-
-## Structure
-
-`CreateCustomerResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `customer` | [`?Customer`](../../doc/models/customer.md) | Optional | Represents a Square customer profile in the Customer Directory of a Square seller. | getCustomer(): ?Customer | setCustomer(?Customer customer): void |
-
-## Example (as JSON)
-
-```json
-{
- "customer": {
- "address": {
- "address_line_1": "500 Electric Ave",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "NY",
- "country": "US",
- "locality": "New York",
- "postal_code": "10003"
- },
- "created_at": "2016-03-23T20:21:54.859Z",
- "creation_source": "THIRD_PARTY",
- "email_address": "Amelia.Earhart@example.com",
- "family_name": "Earhart",
- "given_name": "Amelia",
- "id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "note": "a customer",
- "phone_number": "+1-212-555-4240",
- "preferences": {
- "email_unsubscribed": false
- },
- "reference_id": "YOUR_REFERENCE_ID",
- "updated_at": "2016-03-23T20:21:54.859Z",
- "version": 0,
- "cards": [
- {
- "id": "id8",
- "card_brand": "DISCOVER",
- "last_4": "last_40",
- "exp_month": 152,
- "exp_year": 144
- }
- ]
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-device-code-request.md b/doc/models/create-device-code-request.md
deleted file mode 100644
index c93ee39c..00000000
--- a/doc/models/create-device-code-request.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Create Device Code Request
-
-## Structure
-
-`CreateDeviceCodeRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A unique string that identifies this CreateDeviceCode request. Keys can
be any valid string but must be unique for every CreateDeviceCode request.
See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `deviceCode` | [`DeviceCode`](../../doc/models/device-code.md) | Required | - | getDeviceCode(): DeviceCode | setDeviceCode(DeviceCode deviceCode): void |
-
-## Example (as JSON)
-
-```json
-{
- "device_code": {
- "location_id": "B5E4484SHHNYH",
- "name": "Counter 1",
- "product_type": "TERMINAL_API",
- "id": "id4",
- "code": "code2",
- "device_id": "device_id0"
- },
- "idempotency_key": "01bb00a6-0c86-4770-94ed-f5fca973cd56"
-}
-```
-
diff --git a/doc/models/create-device-code-response.md b/doc/models/create-device-code-response.md
deleted file mode 100644
index 14672b2b..00000000
--- a/doc/models/create-device-code-response.md
+++ /dev/null
@@ -1,41 +0,0 @@
-
-# Create Device Code Response
-
-## Structure
-
-`CreateDeviceCodeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `deviceCode` | [`?DeviceCode`](../../doc/models/device-code.md) | Optional | - | getDeviceCode(): ?DeviceCode | setDeviceCode(?DeviceCode deviceCode): void |
-
-## Example (as JSON)
-
-```json
-{
- "device_code": {
- "code": "EBCARJ",
- "created_at": "2020-02-06T18:44:33.000Z",
- "id": "B3Z6NAMYQSMTM",
- "location_id": "B5E4484SHHNYH",
- "name": "Counter 1",
- "pair_by": "2020-02-06T18:49:33.000Z",
- "product_type": "TERMINAL_API",
- "status": "UNPAIRED",
- "status_changed_at": "2020-02-06T18:44:33.000Z",
- "device_id": "device_id0"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-dispute-evidence-file-request.md b/doc/models/create-dispute-evidence-file-request.md
deleted file mode 100644
index 02886c70..00000000
--- a/doc/models/create-dispute-evidence-file-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Create Dispute Evidence File Request
-
-Defines the parameters for a `CreateDisputeEvidenceFile` request.
-
-## Structure
-
-`CreateDisputeEvidenceFileRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A unique key identifying the request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `45` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `evidenceType` | [`?string(DisputeEvidenceType)`](../../doc/models/dispute-evidence-type.md) | Optional | The type of the dispute evidence. | getEvidenceType(): ?string | setEvidenceType(?string evidenceType): void |
-| `contentType` | `?string` | Optional | The MIME type of the uploaded file.
The type can be image/heic, image/heif, image/jpeg, application/pdf, image/png, or image/tiff.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getContentType(): ?string | setContentType(?string contentType): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "idempotency_key8",
- "evidence_type": "REBUTTAL_EXPLANATION",
- "content_type": "content_type6"
-}
-```
-
diff --git a/doc/models/create-dispute-evidence-file-response.md b/doc/models/create-dispute-evidence-file-response.md
deleted file mode 100644
index 7b4616e9..00000000
--- a/doc/models/create-dispute-evidence-file-response.md
+++ /dev/null
@@ -1,48 +0,0 @@
-
-# Create Dispute Evidence File Response
-
-Defines the fields in a `CreateDisputeEvidenceFile` response.
-
-## Structure
-
-`CreateDisputeEvidenceFileResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `evidence` | [`?DisputeEvidence`](../../doc/models/dispute-evidence.md) | Optional | - | getEvidence(): ?DisputeEvidence | setEvidence(?DisputeEvidence evidence): void |
-
-## Example (as JSON)
-
-```json
-{
- "evidence": {
- "dispute_id": "bVTprrwk0gygTLZ96VX1oB",
- "evidence_file": {
- "filename": "customer-interaction.jpg",
- "filetype": "image/jpeg"
- },
- "id": "TOomLInj6iWmP3N8qfCXrB",
- "uploaded_at": "2022-05-18T16:01:10.000Z",
- "evidence_id": "evidence_id0",
- "evidence_text": "evidence_text6"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-dispute-evidence-text-request.md b/doc/models/create-dispute-evidence-text-request.md
deleted file mode 100644
index 7b756318..00000000
--- a/doc/models/create-dispute-evidence-text-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Create Dispute Evidence Text Request
-
-Defines the parameters for a `CreateDisputeEvidenceText` request.
-
-## Structure
-
-`CreateDisputeEvidenceTextRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A unique key identifying the request. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `45` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `evidenceType` | [`?string(DisputeEvidenceType)`](../../doc/models/dispute-evidence-type.md) | Optional | The type of the dispute evidence. | getEvidenceType(): ?string | setEvidenceType(?string evidenceType): void |
-| `evidenceText` | `string` | Required | The evidence string.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `500` | getEvidenceText(): string | setEvidenceText(string evidenceText): void |
-
-## Example (as JSON)
-
-```json
-{
- "evidence_text": "1Z8888888888888888",
- "evidence_type": "TRACKING_NUMBER",
- "idempotency_key": "ed3ee3933d946f1514d505d173c82648"
-}
-```
-
diff --git a/doc/models/create-dispute-evidence-text-response.md b/doc/models/create-dispute-evidence-text-response.md
deleted file mode 100644
index 23658f2b..00000000
--- a/doc/models/create-dispute-evidence-text-response.md
+++ /dev/null
@@ -1,49 +0,0 @@
-
-# Create Dispute Evidence Text Response
-
-Defines the fields in a `CreateDisputeEvidenceText` response.
-
-## Structure
-
-`CreateDisputeEvidenceTextResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `evidence` | [`?DisputeEvidence`](../../doc/models/dispute-evidence.md) | Optional | - | getEvidence(): ?DisputeEvidence | setEvidence(?DisputeEvidence evidence): void |
-
-## Example (as JSON)
-
-```json
-{
- "evidence": {
- "dispute_id": "bVTprrwk0gygTLZ96VX1oB",
- "evidence_text": "The customer purchased the item twice, on April 11 and April 28.",
- "evidence_type": "REBUTTAL_EXPLANATION",
- "id": "TOomLInj6iWmP3N8qfCXrB",
- "uploaded_at": "2022-05-18T16:01:10.000Z",
- "evidence_id": "evidence_id0",
- "evidence_file": {
- "filename": "filename8",
- "filetype": "filetype8"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-gift-card-activity-request.md b/doc/models/create-gift-card-activity-request.md
deleted file mode 100644
index 175d48e5..00000000
--- a/doc/models/create-gift-card-activity-request.md
+++ /dev/null
@@ -1,40 +0,0 @@
-
-# Create Gift Card Activity Request
-
-A request to create a gift card activity.
-
-## Structure
-
-`CreateGiftCardActivityRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A unique string that identifies the `CreateGiftCardActivity` request.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `giftCardActivity` | [`GiftCardActivity`](../../doc/models/gift-card-activity.md) | Required | Represents an action performed on a [gift card](../../doc/models/gift-card.md) that affects its state or balance.
A gift card activity contains information about a specific activity type. For example, a `REDEEM` activity
includes a `redeem_activity_details` field that contains information about the redemption. | getGiftCardActivity(): GiftCardActivity | setGiftCardActivity(GiftCardActivity giftCardActivity): void |
-
-## Example (as JSON)
-
-```json
-{
- "gift_card_activity": {
- "activate_activity_details": {
- "line_item_uid": "eIWl7X0nMuO9Ewbh0ChIx",
- "order_id": "jJNGHm4gLI6XkFbwtiSLqK72KkAZY"
- },
- "gift_card_id": "gftc:6d55a72470d940c6ba09c0ab8ad08d20",
- "location_id": "81FN9BNFZTKS4",
- "type": "ACTIVATE",
- "id": "id6",
- "created_at": "created_at6",
- "gift_card_gan": "gift_card_gan2",
- "gift_card_balance_money": {
- "amount": 82,
- "currency": "IRR"
- }
- },
- "idempotency_key": "U16kfr-kA70er-q4Rsym-7U7NnY"
-}
-```
-
diff --git a/doc/models/create-gift-card-activity-response.md b/doc/models/create-gift-card-activity-response.md
deleted file mode 100644
index a65bc80b..00000000
--- a/doc/models/create-gift-card-activity-response.md
+++ /dev/null
@@ -1,58 +0,0 @@
-
-# Create Gift Card Activity Response
-
-A response that contains a `GiftCardActivity` that was created.
-The response might contain a set of `Error` objects if the request resulted in errors.
-
-## Structure
-
-`CreateGiftCardActivityResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `giftCardActivity` | [`?GiftCardActivity`](../../doc/models/gift-card-activity.md) | Optional | Represents an action performed on a [gift card](../../doc/models/gift-card.md) that affects its state or balance.
A gift card activity contains information about a specific activity type. For example, a `REDEEM` activity
includes a `redeem_activity_details` field that contains information about the redemption. | getGiftCardActivity(): ?GiftCardActivity | setGiftCardActivity(?GiftCardActivity giftCardActivity): void |
-
-## Example (as JSON)
-
-```json
-{
- "gift_card_activity": {
- "activate_activity_details": {
- "amount_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "line_item_uid": "eIWl7X0nMuO9Ewbh0ChIx",
- "order_id": "jJNGHm4gLI6XkFbwtiSLqK72KkAZY"
- },
- "created_at": "2021-05-20T22:26:54.000Z",
- "gift_card_balance_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "gift_card_gan": "7783320002929081",
- "gift_card_id": "gftc:6d55a72470d940c6ba09c0ab8ad08d20",
- "id": "gcact_c8f8cbf1f24b448d8ecf39ed03f97864",
- "location_id": "81FN9BNFZTKS4",
- "type": "ACTIVATE"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-gift-card-request.md b/doc/models/create-gift-card-request.md
deleted file mode 100644
index f829c842..00000000
--- a/doc/models/create-gift-card-request.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-# Create Gift Card Request
-
-Represents a [CreateGiftCard](../../doc/apis/gift-cards.md#create-gift-card) request.
-
-## Structure
-
-`CreateGiftCardRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A unique identifier for this request, used to ensure idempotency. For more information,
see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `locationId` | `string` | Required | The ID of the [location](entity:Location) where the gift card should be registered for
reporting purposes. Gift cards can be redeemed at any of the seller's locations.
**Constraints**: *Minimum Length*: `1` | getLocationId(): string | setLocationId(string locationId): void |
-| `giftCard` | [`GiftCard`](../../doc/models/gift-card.md) | Required | Represents a Square gift card. | getGiftCard(): GiftCard | setGiftCard(GiftCard giftCard): void |
-
-## Example (as JSON)
-
-```json
-{
- "gift_card": {
- "type": "DIGITAL",
- "id": "id0",
- "gan_source": "SQUARE",
- "state": "ACTIVE",
- "balance_money": {
- "amount": 146,
- "currency": "BBD"
- },
- "gan": "gan6"
- },
- "idempotency_key": "NC9Tm69EjbjtConu",
- "location_id": "81FN9BNFZTKS4"
-}
-```
-
diff --git a/doc/models/create-gift-card-response.md b/doc/models/create-gift-card-response.md
deleted file mode 100644
index 3c087fb4..00000000
--- a/doc/models/create-gift-card-response.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Create Gift Card Response
-
-A response that contains a `GiftCard`. The response might contain a set of `Error` objects if the request
-resulted in errors.
-
-## Structure
-
-`CreateGiftCardResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `giftCard` | [`?GiftCard`](../../doc/models/gift-card.md) | Optional | Represents a Square gift card. | getGiftCard(): ?GiftCard | setGiftCard(?GiftCard giftCard): void |
-
-## Example (as JSON)
-
-```json
-{
- "gift_card": {
- "balance_money": {
- "amount": 0,
- "currency": "USD"
- },
- "created_at": "2021-05-20T22:26:54.000Z",
- "gan": "7783320006753271",
- "gan_source": "SQUARE",
- "id": "gftc:6cbacbb64cf54e2ca9f573d619038059",
- "state": "PENDING",
- "type": "DIGITAL"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-invoice-attachment-request.md b/doc/models/create-invoice-attachment-request.md
deleted file mode 100644
index 4ccbc8c0..00000000
--- a/doc/models/create-invoice-attachment-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Create Invoice Attachment Request
-
-Represents a [CreateInvoiceAttachment](../../doc/apis/invoices.md#create-invoice-attachment) request.
-
-## Structure
-
-`CreateInvoiceAttachmentRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `?string` | Optional | A unique string that identifies the `CreateInvoiceAttachment` request.
For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `128` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-| `description` | `?string` | Optional | The description of the attachment to display on the invoice.
**Constraints**: *Maximum Length*: `128` | getDescription(): ?string | setDescription(?string description): void |
-
-## Example (as JSON)
-
-```json
-{
- "description": "Service contract",
- "idempotency_key": "ae5e84f9-4742-4fc1-ba12-a3ce3748f1c3"
-}
-```
-
diff --git a/doc/models/create-invoice-attachment-response.md b/doc/models/create-invoice-attachment-response.md
deleted file mode 100644
index 2b37a82d..00000000
--- a/doc/models/create-invoice-attachment-response.md
+++ /dev/null
@@ -1,52 +0,0 @@
-
-# Create Invoice Attachment Response
-
-Represents a [CreateInvoiceAttachment](../../doc/apis/invoices.md#create-invoice-attachment) response.
-
-## Structure
-
-`CreateInvoiceAttachmentResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `attachment` | [`?InvoiceAttachment`](../../doc/models/invoice-attachment.md) | Optional | Represents a file attached to an [invoice](../../doc/models/invoice.md). | getAttachment(): ?InvoiceAttachment | setAttachment(?InvoiceAttachment attachment): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "attachment": {
- "description": "Service contract",
- "filename": "file.jpg",
- "filesize": 102705,
- "hash": "273ee02cb6f5f8a3a8ca23604930dd53",
- "id": "inva:0-3bB9ZuDHiziThQhuC4fwWt",
- "mime_type": "image/jpeg",
- "uploaded_at": "2023-02-03T20:28:14Z"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-invoice-request.md b/doc/models/create-invoice-request.md
deleted file mode 100644
index 8f945891..00000000
--- a/doc/models/create-invoice-request.md
+++ /dev/null
@@ -1,83 +0,0 @@
-
-# Create Invoice Request
-
-Describes a `CreateInvoice` request.
-
-## Structure
-
-`CreateInvoiceRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | Stores information about an invoice. You use the Invoices API to create and manage
invoices. For more information, see [Invoices API Overview](https://developer.squareup.com/docs/invoices-api/overview). | getInvoice(): Invoice | setInvoice(Invoice invoice): void |
-| `idempotencyKey` | `?string` | Optional | A unique string that identifies the `CreateInvoice` request. If you do not
provide `idempotency_key` (or provide an empty string as the value), the endpoint
treats each request as independent.
For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `128` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "ce3748f9-5fc1-4762-aa12-aae5e843f1f4",
- "invoice": {
- "accepted_payment_methods": {
- "bank_account": false,
- "buy_now_pay_later": false,
- "card": true,
- "cash_app_pay": false,
- "square_gift_card": false
- },
- "custom_fields": [
- {
- "label": "Event Reference Number",
- "placement": "ABOVE_LINE_ITEMS",
- "value": "Ref. #1234"
- },
- {
- "label": "Terms of Service",
- "placement": "BELOW_LINE_ITEMS",
- "value": "The terms of service are..."
- }
- ],
- "delivery_method": "EMAIL",
- "description": "We appreciate your business!",
- "invoice_number": "inv-100",
- "location_id": "ES0RJRZYEC39A",
- "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY",
- "payment_requests": [
- {
- "automatic_payment_source": "NONE",
- "due_date": "2030-01-24",
- "reminders": [
- {
- "message": "Your invoice is due tomorrow",
- "relative_scheduled_days": -1
- }
- ],
- "request_type": "BALANCE",
- "tipping_enabled": true
- }
- ],
- "primary_recipient": {
- "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "given_name": "given_name6",
- "family_name": "family_name8",
- "email_address": "email_address2",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- },
- "sale_or_service_date": "2030-01-24",
- "scheduled_at": "2030-01-13T10:00:00Z",
- "store_payment_method_enabled": false,
- "title": "Event Planning Services",
- "id": "id6",
- "version": 118
- }
-}
-```
-
diff --git a/doc/models/create-invoice-response.md b/doc/models/create-invoice-response.md
deleted file mode 100644
index 4887197e..00000000
--- a/doc/models/create-invoice-response.md
+++ /dev/null
@@ -1,106 +0,0 @@
-
-# Create Invoice Response
-
-The response returned by the `CreateInvoice` request.
-
-## Structure
-
-`CreateInvoiceResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `invoice` | [`?Invoice`](../../doc/models/invoice.md) | Optional | Stores information about an invoice. You use the Invoices API to create and manage
invoices. For more information, see [Invoices API Overview](https://developer.squareup.com/docs/invoices-api/overview). | getInvoice(): ?Invoice | setInvoice(?Invoice invoice): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "invoice": {
- "accepted_payment_methods": {
- "bank_account": false,
- "buy_now_pay_later": false,
- "card": true,
- "cash_app_pay": false,
- "square_gift_card": false
- },
- "created_at": "2020-06-18T17:45:13Z",
- "custom_fields": [
- {
- "label": "Event Reference Number",
- "placement": "ABOVE_LINE_ITEMS",
- "value": "Ref. #1234"
- },
- {
- "label": "Terms of Service",
- "placement": "BELOW_LINE_ITEMS",
- "value": "The terms of service are..."
- }
- ],
- "delivery_method": "EMAIL",
- "description": "We appreciate your business!",
- "id": "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY",
- "invoice_number": "inv-100",
- "location_id": "ES0RJRZYEC39A",
- "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY",
- "payment_requests": [
- {
- "automatic_payment_source": "NONE",
- "computed_amount_money": {
- "amount": 10000,
- "currency": "USD"
- },
- "due_date": "2030-01-24",
- "reminders": [
- {
- "message": "Your invoice is due tomorrow",
- "relative_scheduled_days": -1,
- "status": "PENDING",
- "uid": "beebd363-e47f-4075-8785-c235aaa7df11"
- }
- ],
- "request_type": "BALANCE",
- "tipping_enabled": true,
- "total_completed_amount_money": {
- "amount": 0,
- "currency": "USD"
- },
- "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355"
- }
- ],
- "primary_recipient": {
- "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "email_address": "Amelia.Earhart@example.com",
- "family_name": "Earhart",
- "given_name": "Amelia",
- "phone_number": "1-212-555-4240",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- },
- "sale_or_service_date": "2030-01-24",
- "scheduled_at": "2030-01-13T10:00:00Z",
- "status": "DRAFT",
- "store_payment_method_enabled": false,
- "timezone": "America/Los_Angeles",
- "title": "Event Planning Services",
- "updated_at": "2020-06-18T17:45:13Z",
- "version": 0
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-job-request.md b/doc/models/create-job-request.md
deleted file mode 100644
index 6274d5c2..00000000
--- a/doc/models/create-job-request.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Create Job Request
-
-Represents a [CreateJob](../../doc/apis/team.md#create-job) request.
-
-## Structure
-
-`CreateJobRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `job` | [`Job`](../../doc/models/job.md) | Required | Represents a job that can be assigned to [team members](../../doc/models/team-member.md). This object defines the
job's title and tip eligibility. Compensation is defined in a [job assignment](../../doc/models/job-assignment.md)
in a team member's wage setting. | getJob(): Job | setJob(Job job): void |
-| `idempotencyKey` | `string` | Required | A unique identifier for the `CreateJob` request. Keys can be any valid string,
but must be unique for each request. For more information, see
[Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `45` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "idempotency-key-0",
- "job": {
- "is_tip_eligible": true,
- "title": "Cashier",
- "id": "id6",
- "created_at": "created_at4",
- "updated_at": "updated_at8"
- }
-}
-```
-
diff --git a/doc/models/create-job-response.md b/doc/models/create-job-response.md
deleted file mode 100644
index 02c7de71..00000000
--- a/doc/models/create-job-response.md
+++ /dev/null
@@ -1,40 +0,0 @@
-
-# Create Job Response
-
-Represents a [CreateJob](../../doc/apis/team.md#create-job) response. Either `job` or `errors`
-is present in the response.
-
-## Structure
-
-`CreateJobResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `job` | [`?Job`](../../doc/models/job.md) | Optional | Represents a job that can be assigned to [team members](../../doc/models/team-member.md). This object defines the
job's title and tip eligibility. Compensation is defined in a [job assignment](../../doc/models/job-assignment.md)
in a team member's wage setting. | getJob(): ?Job | setJob(?Job job): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | The errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "job": {
- "created_at": "2021-06-11T22:55:45Z",
- "id": "1yJlHapkseYnNPETIU1B",
- "is_tip_eligible": true,
- "title": "Cashier",
- "updated_at": "2021-06-11T22:55:45Z",
- "version": 1
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-location-custom-attribute-definition-request.md b/doc/models/create-location-custom-attribute-definition-request.md
deleted file mode 100644
index 86515713..00000000
--- a/doc/models/create-location-custom-attribute-definition-request.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Create Location Custom Attribute Definition Request
-
-Represents a [CreateLocationCustomAttributeDefinition](../../doc/apis/location-custom-attributes.md#create-location-custom-attribute-definition) request.
-
-## Structure
-
-`CreateLocationCustomAttributeDefinitionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Required | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): CustomAttributeDefinition | setCustomAttributeDefinition(CustomAttributeDefinition customAttributeDefinition): void |
-| `idempotencyKey` | `?string` | Optional | A unique identifier for this request, used to ensure idempotency. For more information,
see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "description": "Bestselling item at location",
- "key": "bestseller",
- "name": "Bestseller",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "visibility": "VISIBILITY_READ_WRITE_VALUES"
- },
- "idempotency_key": "idempotency_key6"
-}
-```
-
diff --git a/doc/models/create-location-custom-attribute-definition-response.md b/doc/models/create-location-custom-attribute-definition-response.md
deleted file mode 100644
index 72988023..00000000
--- a/doc/models/create-location-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,45 +0,0 @@
-
-# Create Location Custom Attribute Definition Response
-
-Represents a [CreateLocationCustomAttributeDefinition](../../doc/apis/location-custom-attributes.md#create-location-custom-attribute-definition) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`CreateLocationCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`?CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Optional | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): ?CustomAttributeDefinition | setCustomAttributeDefinition(?CustomAttributeDefinition customAttributeDefinition): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "created_at": "2022-12-02T19:06:36.559Z",
- "description": "Bestselling item at location",
- "key": "bestseller",
- "name": "Bestseller",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-12-02T19:06:36.559Z",
- "version": 1,
- "visibility": "VISIBILITY_READ_WRITE_VALUES"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-location-request.md b/doc/models/create-location-request.md
deleted file mode 100644
index cd401a39..00000000
--- a/doc/models/create-location-request.md
+++ /dev/null
@@ -1,40 +0,0 @@
-
-# Create Location Request
-
-The request object for the [CreateLocation](../../doc/apis/locations.md#create-location) endpoint.
-
-## Structure
-
-`CreateLocationRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `location` | [`?Location`](../../doc/models/location.md) | Optional | Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api). | getLocation(): ?Location | setLocation(?Location location): void |
-
-## Example (as JSON)
-
-```json
-{
- "location": {
- "address": {
- "address_line_1": "1234 Peachtree St. NE",
- "administrative_district_level_1": "GA",
- "locality": "Atlanta",
- "postal_code": "30309",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "sublocality": "sublocality6"
- },
- "description": "Midtown Atlanta store",
- "name": "Midtown",
- "id": "id4",
- "timezone": "timezone6",
- "capabilities": [
- "CREDIT_CARD_PROCESSING"
- ]
- }
-}
-```
-
diff --git a/doc/models/create-location-response.md b/doc/models/create-location-response.md
deleted file mode 100644
index 72eaf549..00000000
--- a/doc/models/create-location-response.md
+++ /dev/null
@@ -1,74 +0,0 @@
-
-# Create Location Response
-
-The response object returned by the [CreateLocation](../../doc/apis/locations.md#create-location) endpoint.
-
-## Structure
-
-`CreateLocationResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about [errors](https://developer.squareup.com/docs/build-basics/handling-errors) encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `location` | [`?Location`](../../doc/models/location.md) | Optional | Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api). | getLocation(): ?Location | setLocation(?Location location): void |
-
-## Example (as JSON)
-
-```json
-{
- "location": {
- "address": {
- "address_line_1": "1234 Peachtree St. NE",
- "administrative_district_level_1": "GA",
- "locality": "Atlanta",
- "postal_code": "30309",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "sublocality": "sublocality6"
- },
- "business_name": "Jet Fuel Coffee",
- "capabilities": [
- "CREDIT_CARD_PROCESSING"
- ],
- "coordinates": {
- "latitude": 33.7889,
- "longitude": -84.3841
- },
- "country": "US",
- "created_at": "2022-02-19T17:58:25Z",
- "currency": "USD",
- "description": "Midtown Atlanta store",
- "id": "3Z4V4WHQK64X9",
- "language_code": "en-US",
- "mcc": "7299",
- "merchant_id": "3MYCJG5GVYQ8Q",
- "name": "Midtown",
- "status": "ACTIVE",
- "timezone": "America/New_York",
- "type": "PHYSICAL"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-loyalty-account-request.md b/doc/models/create-loyalty-account-request.md
deleted file mode 100644
index f2f5b7b1..00000000
--- a/doc/models/create-loyalty-account-request.md
+++ /dev/null
@@ -1,35 +0,0 @@
-
-# Create Loyalty Account Request
-
-A request to create a new loyalty account.
-
-## Structure
-
-`CreateLoyaltyAccountRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `loyaltyAccount` | [`LoyaltyAccount`](../../doc/models/loyalty-account.md) | Required | Describes a loyalty account in a [loyalty program](../../doc/models/loyalty-program.md). For more information, see
[Create and Retrieve Loyalty Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts). | getLoyaltyAccount(): LoyaltyAccount | setLoyaltyAccount(LoyaltyAccount loyaltyAccount): void |
-| `idempotencyKey` | `string` | Required | A unique string that identifies this `CreateLoyaltyAccount` request.
Keys can be any valid string, but must be unique for every request.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "ec78c477-b1c3-4899-a209-a4e71337c996",
- "loyalty_account": {
- "mapping": {
- "phone_number": "+14155551234"
- },
- "program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
- "id": "id6",
- "balance": 6,
- "lifetime_points": 30,
- "customer_id": "customer_id4",
- "enrolled_at": "enrolled_at6"
- }
-}
-```
-
diff --git a/doc/models/create-loyalty-account-response.md b/doc/models/create-loyalty-account-response.md
deleted file mode 100644
index cc023aca..00000000
--- a/doc/models/create-loyalty-account-response.md
+++ /dev/null
@@ -1,46 +0,0 @@
-
-# Create Loyalty Account Response
-
-A response that includes loyalty account created.
-
-## Structure
-
-`CreateLoyaltyAccountResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `loyaltyAccount` | [`?LoyaltyAccount`](../../doc/models/loyalty-account.md) | Optional | Describes a loyalty account in a [loyalty program](../../doc/models/loyalty-program.md). For more information, see
[Create and Retrieve Loyalty Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts). | getLoyaltyAccount(): ?LoyaltyAccount | setLoyaltyAccount(?LoyaltyAccount loyaltyAccount): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_account": {
- "balance": 0,
- "created_at": "2020-05-08T21:44:32Z",
- "customer_id": "QPTXM8PQNX3Q726ZYHPMNP46XC",
- "id": "79b807d2-d786-46a9-933b-918028d7a8c5",
- "lifetime_points": 0,
- "mapping": {
- "created_at": "2020-05-08T21:44:32Z",
- "id": "66aaab3f-da99-49ed-8b19-b87f851c844f",
- "phone_number": "+14155551234"
- },
- "program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
- "updated_at": "2020-05-08T21:44:32Z",
- "enrolled_at": "enrolled_at6"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-loyalty-promotion-request.md b/doc/models/create-loyalty-promotion-request.md
deleted file mode 100644
index 48151692..00000000
--- a/doc/models/create-loyalty-promotion-request.md
+++ /dev/null
@@ -1,59 +0,0 @@
-
-# Create Loyalty Promotion Request
-
-Represents a [CreateLoyaltyPromotion](../../doc/apis/loyalty.md#create-loyalty-promotion) request.
-
-## Structure
-
-`CreateLoyaltyPromotionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `loyaltyPromotion` | [`LoyaltyPromotion`](../../doc/models/loyalty-promotion.md) | Required | Represents a promotion for a [loyalty program](../../doc/models/loyalty-program.md). Loyalty promotions enable buyers
to earn extra points on top of those earned from the base program.
A loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status. | getLoyaltyPromotion(): LoyaltyPromotion | setLoyaltyPromotion(LoyaltyPromotion loyaltyPromotion): void |
-| `idempotencyKey` | `string` | Required | A unique identifier for this request, which is used to ensure idempotency. For more information,
see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "ec78c477-b1c3-4899-a209-a4e71337c996",
- "loyalty_promotion": {
- "available_time": {
- "time_periods": [
- "BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT"
- ],
- "start_date": "start_date4",
- "end_date": "end_date8"
- },
- "incentive": {
- "points_multiplier_data": {
- "multiplier": "3.0",
- "points_multiplier": 134
- },
- "type": "POINTS_MULTIPLIER",
- "points_addition_data": {
- "points_addition": 218
- }
- },
- "minimum_spend_amount_money": {
- "amount": 2000,
- "currency": "USD"
- },
- "name": "Tuesday Happy Hour Promo",
- "qualifying_category_ids": [
- "XTQPYLR3IIU9C44VRCB3XD12"
- ],
- "trigger_limit": {
- "interval": "DAY",
- "times": 1
- },
- "id": "id4",
- "status": "ACTIVE",
- "created_at": "created_at2",
- "canceled_at": "canceled_at0"
- }
-}
-```
-
diff --git a/doc/models/create-loyalty-promotion-response.md b/doc/models/create-loyalty-promotion-response.md
deleted file mode 100644
index 5a6b5e38..00000000
--- a/doc/models/create-loyalty-promotion-response.md
+++ /dev/null
@@ -1,75 +0,0 @@
-
-# Create Loyalty Promotion Response
-
-Represents a [CreateLoyaltyPromotion](../../doc/apis/loyalty.md#create-loyalty-promotion) response.
-Either `loyalty_promotion` or `errors` is present in the response.
-
-## Structure
-
-`CreateLoyaltyPromotionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `loyaltyPromotion` | [`?LoyaltyPromotion`](../../doc/models/loyalty-promotion.md) | Optional | Represents a promotion for a [loyalty program](../../doc/models/loyalty-program.md). Loyalty promotions enable buyers
to earn extra points on top of those earned from the base program.
A loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status. | getLoyaltyPromotion(): ?LoyaltyPromotion | setLoyaltyPromotion(?LoyaltyPromotion loyaltyPromotion): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_promotion": {
- "available_time": {
- "start_date": "2022-08-16",
- "time_periods": [
- "BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT"
- ],
- "end_date": "end_date8"
- },
- "created_at": "2022-08-16T08:38:54Z",
- "id": "loypromo_f0f9b849-725e-378d-b810-511237e07b67",
- "incentive": {
- "points_multiplier_data": {
- "multiplier": "3.000",
- "points_multiplier": 3
- },
- "type": "POINTS_MULTIPLIER",
- "points_addition_data": {
- "points_addition": 218
- }
- },
- "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
- "minimum_spend_amount_money": {
- "amount": 2000,
- "currency": "USD"
- },
- "name": "Tuesday Happy Hour Promo",
- "qualifying_category_ids": [
- "XTQPYLR3IIU9C44VRCB3XD12"
- ],
- "status": "ACTIVE",
- "trigger_limit": {
- "interval": "DAY",
- "times": 1
- },
- "updated_at": "2022-08-16T08:38:54Z",
- "canceled_at": "canceled_at0"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-loyalty-reward-request.md b/doc/models/create-loyalty-reward-request.md
deleted file mode 100644
index 0c136aea..00000000
--- a/doc/models/create-loyalty-reward-request.md
+++ /dev/null
@@ -1,33 +0,0 @@
-
-# Create Loyalty Reward Request
-
-A request to create a loyalty reward.
-
-## Structure
-
-`CreateLoyaltyRewardRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `reward` | [`LoyaltyReward`](../../doc/models/loyalty-reward.md) | Required | Represents a contract to redeem loyalty points for a [reward tier](../../doc/models/loyalty-program-reward-tier.md) discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state.
For more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards). | getReward(): LoyaltyReward | setReward(LoyaltyReward reward): void |
-| `idempotencyKey` | `string` | Required | A unique string that identifies this `CreateLoyaltyReward` request.
Keys can be any valid string, but must be unique for every request.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "18c2e5ea-a620-4b1f-ad60-7b167285e451",
- "reward": {
- "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
- "order_id": "RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY",
- "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f",
- "id": "id0",
- "status": "ISSUED",
- "points": 222,
- "created_at": "created_at8"
- }
-}
-```
-
diff --git a/doc/models/create-loyalty-reward-response.md b/doc/models/create-loyalty-reward-response.md
deleted file mode 100644
index 6da4dc5f..00000000
--- a/doc/models/create-loyalty-reward-response.md
+++ /dev/null
@@ -1,47 +0,0 @@
-
-# Create Loyalty Reward Response
-
-A response that includes the loyalty reward created.
-
-## Structure
-
-`CreateLoyaltyRewardResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `reward` | [`?LoyaltyReward`](../../doc/models/loyalty-reward.md) | Optional | Represents a contract to redeem loyalty points for a [reward tier](../../doc/models/loyalty-program-reward-tier.md) discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state.
For more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards). | getReward(): ?LoyaltyReward | setReward(?LoyaltyReward reward): void |
-
-## Example (as JSON)
-
-```json
-{
- "reward": {
- "created_at": "2020-05-01T21:49:54Z",
- "id": "a8f43ebe-2ad6-3001-bdd5-7d7c2da08943",
- "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
- "order_id": "RFZfrdtm3mhO1oGzf5Cx7fEMsmGZY",
- "points": 10,
- "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f",
- "status": "ISSUED",
- "updated_at": "2020-05-01T21:49:54Z"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-merchant-custom-attribute-definition-request.md b/doc/models/create-merchant-custom-attribute-definition-request.md
deleted file mode 100644
index 30790ee3..00000000
--- a/doc/models/create-merchant-custom-attribute-definition-request.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Create Merchant Custom Attribute Definition Request
-
-Represents a [CreateMerchantCustomAttributeDefinition](../../doc/apis/merchant-custom-attributes.md#create-merchant-custom-attribute-definition) request.
-
-## Structure
-
-`CreateMerchantCustomAttributeDefinitionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Required | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): CustomAttributeDefinition | setCustomAttributeDefinition(CustomAttributeDefinition customAttributeDefinition): void |
-| `idempotencyKey` | `?string` | Optional | A unique identifier for this request, used to ensure idempotency. For more information,
see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "description": "This is the other name this merchant goes by.",
- "key": "alternative_seller_name",
- "name": "Alternative Merchant Name",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "visibility": "VISIBILITY_READ_ONLY"
- },
- "idempotency_key": "idempotency_key6"
-}
-```
-
diff --git a/doc/models/create-merchant-custom-attribute-definition-response.md b/doc/models/create-merchant-custom-attribute-definition-response.md
deleted file mode 100644
index 3ac7ac28..00000000
--- a/doc/models/create-merchant-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,45 +0,0 @@
-
-# Create Merchant Custom Attribute Definition Response
-
-Represents a [CreateMerchantCustomAttributeDefinition](../../doc/apis/merchant-custom-attributes.md#create-merchant-custom-attribute-definition) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`CreateMerchantCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`?CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Optional | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): ?CustomAttributeDefinition | setCustomAttributeDefinition(?CustomAttributeDefinition customAttributeDefinition): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "created_at": "2023-05-05T19:06:36.559Z",
- "description": "This is the other name this merchant goes by.",
- "key": "alternative_seller_name",
- "name": "Alternative Merchant Name",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2023-05-05T19:06:36.559Z",
- "version": 1,
- "visibility": "VISIBILITY_READ_ONLY"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-mobile-authorization-code-request.md b/doc/models/create-mobile-authorization-code-request.md
deleted file mode 100644
index 7a3de350..00000000
--- a/doc/models/create-mobile-authorization-code-request.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-# Create Mobile Authorization Code Request
-
-Defines the body parameters that can be provided in a request to the
-`CreateMobileAuthorizationCode` endpoint.
-
-## Structure
-
-`CreateMobileAuthorizationCodeRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationId` | `?string` | Optional | The Square location ID that the authorization code should be tied to.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `191` | getLocationId(): ?string | setLocationId(?string locationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_id": "YOUR_LOCATION_ID"
-}
-```
-
diff --git a/doc/models/create-mobile-authorization-code-response.md b/doc/models/create-mobile-authorization-code-response.md
deleted file mode 100644
index 3a576bc0..00000000
--- a/doc/models/create-mobile-authorization-code-response.md
+++ /dev/null
@@ -1,41 +0,0 @@
-
-# Create Mobile Authorization Code Response
-
-Defines the fields that are included in the response body of
-a request to the `CreateMobileAuthorizationCode` endpoint.
-
-## Structure
-
-`CreateMobileAuthorizationCodeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `authorizationCode` | `?string` | Optional | The generated authorization code that connects a mobile application instance
to a Square account.
**Constraints**: *Maximum Length*: `191` | getAuthorizationCode(): ?string | setAuthorizationCode(?string authorizationCode): void |
-| `expiresAt` | `?string` | Optional | The timestamp when `authorization_code` expires, in
[RFC 3339](https://tools.ietf.org/html/rfc3339) format (for example, "2016-09-04T23:59:33.123Z").
**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `48` | getExpiresAt(): ?string | setExpiresAt(?string expiresAt): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "authorization_code": "YOUR_MOBILE_AUTHORIZATION_CODE",
- "expires_at": "2019-01-10T19:42:08Z",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-order-custom-attribute-definition-request.md b/doc/models/create-order-custom-attribute-definition-request.md
deleted file mode 100644
index b61fd1f8..00000000
--- a/doc/models/create-order-custom-attribute-definition-request.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Create Order Custom Attribute Definition Request
-
-Represents a create request for an order custom attribute definition.
-
-## Structure
-
-`CreateOrderCustomAttributeDefinitionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Required | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): CustomAttributeDefinition | setCustomAttributeDefinition(CustomAttributeDefinition customAttributeDefinition): void |
-| `idempotencyKey` | `?string` | Optional | A unique identifier for this request, used to ensure idempotency.
For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "description": "The number of people seated at a table",
- "key": "cover-count",
- "name": "Cover count",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "visibility": "VISIBILITY_READ_WRITE_VALUES"
- },
- "idempotency_key": "IDEMPOTENCY_KEY"
-}
-```
-
diff --git a/doc/models/create-order-custom-attribute-definition-response.md b/doc/models/create-order-custom-attribute-definition-response.md
deleted file mode 100644
index 14df7b9c..00000000
--- a/doc/models/create-order-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Create Order Custom Attribute Definition Response
-
-Represents a response from creating an order custom attribute definition.
-
-## Structure
-
-`CreateOrderCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`?CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Optional | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): ?CustomAttributeDefinition | setCustomAttributeDefinition(?CustomAttributeDefinition customAttributeDefinition): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "created_at": "2022-10-06T16:53:23.141Z",
- "description": "The number of people seated at a table",
- "key": "cover-count",
- "name": "Cover count",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-10-06T16:53:23.141Z",
- "version": 1,
- "visibility": "VISIBILITY_READ_WRITE_VALUES"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-order-request.md b/doc/models/create-order-request.md
deleted file mode 100644
index 4d6aac30..00000000
--- a/doc/models/create-order-request.md
+++ /dev/null
@@ -1,121 +0,0 @@
-
-# Create Order Request
-
-## Structure
-
-`CreateOrderRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `order` | [`?Order`](../../doc/models/order.md) | Optional | Contains all information related to a single order to process with Square,
including line items that specify the products to purchase. `Order` objects also
include information about any associated tenders, refunds, and returns.
All Connect V2 Transactions have all been converted to Orders including all associated
itemization data. | getOrder(): ?Order | setOrder(?Order order): void |
-| `idempotencyKey` | `?string` | Optional | A value you specify that uniquely identifies this
order among orders you have created.
If you are unsure whether a particular order was created successfully,
you can try it again with the same idempotency key without
worrying about creating duplicate orders.
For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `192` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "8193148c-9586-11e6-99f9-28cfe92138cf",
- "order": {
- "discounts": [
- {
- "name": "Labor Day Sale",
- "percentage": "5",
- "scope": "ORDER",
- "uid": "labor-day-sale"
- },
- {
- "catalog_object_id": "DB7L55ZH2BGWI4H23ULIWOQ7",
- "scope": "ORDER",
- "uid": "membership-discount"
- },
- {
- "amount_money": {
- "amount": 100,
- "currency": "USD"
- },
- "name": "Sale - $1.00 off",
- "scope": "LINE_ITEM",
- "uid": "one-dollar-off"
- }
- ],
- "line_items": [
- {
- "base_price_money": {
- "amount": 1599,
- "currency": "USD"
- },
- "name": "New York Strip Steak",
- "quantity": "1",
- "uid": "uid8",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- },
- {
- "applied_discounts": [
- {
- "discount_uid": "one-dollar-off"
- }
- ],
- "catalog_object_id": "BEMYCSMIJL46OCDV4KYIKXIB",
- "modifiers": [
- {
- "catalog_object_id": "CHQX7Y4KY6N5KINJKZCFURPZ"
- }
- ],
- "quantity": "2",
- "uid": "uid8",
- "name": "name8",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4"
- }
- ],
- "location_id": "057P5VYJ4A5X1",
- "reference_id": "my-order-001",
- "taxes": [
- {
- "name": "State Sales Tax",
- "percentage": "9",
- "scope": "ORDER",
- "uid": "state-sales-tax"
- }
- ],
- "id": "id6",
- "source": {
- "name": "name4"
- },
- "customer_id": "customer_id4"
- }
-}
-```
-
diff --git a/doc/models/create-order-response.md b/doc/models/create-order-response.md
deleted file mode 100644
index fb0a3a56..00000000
--- a/doc/models/create-order-response.md
+++ /dev/null
@@ -1,329 +0,0 @@
-
-# Create Order Response
-
-Defines the fields that are included in the response body of
-a request to the `CreateOrder` endpoint.
-
-Either `errors` or `order` is present in a given response, but never both.
-
-## Structure
-
-`CreateOrderResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `order` | [`?Order`](../../doc/models/order.md) | Optional | Contains all information related to a single order to process with Square,
including line items that specify the products to purchase. `Order` objects also
include information about any associated tenders, refunds, and returns.
All Connect V2 Transactions have all been converted to Orders including all associated
itemization data. | getOrder(): ?Order | setOrder(?Order order): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "order": {
- "created_at": "2020-01-17T20:47:53.293Z",
- "discounts": [
- {
- "applied_money": {
- "amount": 30,
- "currency": "USD"
- },
- "catalog_object_id": "DB7L55ZH2BGWI4H23ULIWOQ7",
- "name": "Membership Discount",
- "percentage": "0.5",
- "scope": "ORDER",
- "type": "FIXED_PERCENTAGE",
- "uid": "membership-discount"
- },
- {
- "applied_money": {
- "amount": 303,
- "currency": "USD"
- },
- "name": "Labor Day Sale",
- "percentage": "5",
- "scope": "ORDER",
- "type": "FIXED_PERCENTAGE",
- "uid": "labor-day-sale"
- },
- {
- "amount_money": {
- "amount": 100,
- "currency": "USD"
- },
- "applied_money": {
- "amount": 100,
- "currency": "USD"
- },
- "name": "Sale - $1.00 off",
- "scope": "LINE_ITEM",
- "type": "FIXED_AMOUNT",
- "uid": "one-dollar-off"
- }
- ],
- "id": "CAISENgvlJ6jLWAzERDzjyHVybY",
- "line_items": [
- {
- "applied_discounts": [
- {
- "applied_money": {
- "amount": 8,
- "currency": "USD"
- },
- "discount_uid": "membership-discount",
- "uid": "jWdgP1TpHPFBuVrz81mXVC"
- },
- {
- "applied_money": {
- "amount": 79,
- "currency": "USD"
- },
- "discount_uid": "labor-day-sale",
- "uid": "jnZOjjVY57eRcQAVgEwFuC"
- }
- ],
- "applied_taxes": [
- {
- "applied_money": {
- "amount": 136,
- "currency": "USD"
- },
- "tax_uid": "state-sales-tax",
- "uid": "aKG87ArnDpvMLSZJHxWUl"
- }
- ],
- "base_price_money": {
- "amount": 1599,
- "currency": "USD"
- },
- "gross_sales_money": {
- "amount": 1599,
- "currency": "USD"
- },
- "name": "New York Strip Steak",
- "quantity": "1",
- "total_discount_money": {
- "amount": 87,
- "currency": "USD"
- },
- "total_money": {
- "amount": 1648,
- "currency": "USD"
- },
- "total_service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 136,
- "currency": "USD"
- },
- "uid": "8uSwfzvUImn3IRrvciqlXC",
- "variation_total_price_money": {
- "amount": 1599,
- "currency": "USD"
- },
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- },
- {
- "applied_discounts": [
- {
- "applied_money": {
- "amount": 22,
- "currency": "USD"
- },
- "discount_uid": "membership-discount",
- "uid": "nUXvdsIItfKko0dbYtY58C"
- },
- {
- "applied_money": {
- "amount": 224,
- "currency": "USD"
- },
- "discount_uid": "labor-day-sale",
- "uid": "qSdkOOOernlVQqsJ94SPjB"
- },
- {
- "applied_money": {
- "amount": 100,
- "currency": "USD"
- },
- "discount_uid": "one-dollar-off",
- "uid": "y7bVl4njrWAnfDwmz19izB"
- }
- ],
- "applied_taxes": [
- {
- "applied_money": {
- "amount": 374,
- "currency": "USD"
- },
- "tax_uid": "state-sales-tax",
- "uid": "v1dAgrfUVUPTnVTf9sRPz"
- }
- ],
- "base_price_money": {
- "amount": 2200,
- "currency": "USD"
- },
- "catalog_object_id": "BEMYCSMIJL46OCDV4KYIKXIB",
- "gross_sales_money": {
- "amount": 4500,
- "currency": "USD"
- },
- "modifiers": [
- {
- "base_price_money": {
- "amount": 50,
- "currency": "USD"
- },
- "catalog_object_id": "CHQX7Y4KY6N5KINJKZCFURPZ",
- "name": "Well",
- "total_price_money": {
- "amount": 100,
- "currency": "USD"
- },
- "uid": "Lo3qMMckDluu9Qsb58d4CC"
- }
- ],
- "name": "New York Steak",
- "quantity": "2",
- "total_discount_money": {
- "amount": 346,
- "currency": "USD"
- },
- "total_money": {
- "amount": 4528,
- "currency": "USD"
- },
- "total_service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 374,
- "currency": "USD"
- },
- "uid": "v8ZuEXpOJpb0bazLuvrLDB",
- "variation_name": "Larger",
- "variation_total_price_money": {
- "amount": 4400,
- "currency": "USD"
- },
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4"
- }
- ],
- "location_id": "057P5VYJ4A5X1",
- "net_amounts": {
- "discount_money": {
- "amount": 433,
- "currency": "USD"
- },
- "service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "tax_money": {
- "amount": 510,
- "currency": "USD"
- },
- "tip_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_money": {
- "amount": 6176,
- "currency": "USD"
- }
- },
- "reference_id": "my-order-001",
- "source": {
- "name": "My App"
- },
- "state": "OPEN",
- "taxes": [
- {
- "applied_money": {
- "amount": 510,
- "currency": "USD"
- },
- "name": "State Sales Tax",
- "percentage": "9",
- "scope": "ORDER",
- "type": "ADDITIVE",
- "uid": "state-sales-tax"
- }
- ],
- "total_discount_money": {
- "amount": 433,
- "currency": "USD"
- },
- "total_money": {
- "amount": 6176,
- "currency": "USD"
- },
- "total_service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 510,
- "currency": "USD"
- },
- "total_tip_money": {
- "amount": 0,
- "currency": "USD"
- },
- "updated_at": "2020-01-17T20:47:53.293Z",
- "version": 1,
- "customer_id": "customer_id4"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-payment-link-request.md b/doc/models/create-payment-link-request.md
deleted file mode 100644
index 71730158..00000000
--- a/doc/models/create-payment-link-request.md
+++ /dev/null
@@ -1,83 +0,0 @@
-
-# Create Payment Link Request
-
-## Structure
-
-`CreatePaymentLinkRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `?string` | Optional | A unique string that identifies this `CreatePaymentLinkRequest` request.
If you do not provide a unique string (or provide an empty string as the value),
the endpoint treats each request as independent.
For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
**Constraints**: *Maximum Length*: `192` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-| `description` | `?string` | Optional | A description of the payment link. You provide this optional description that is useful in your
application context. It is not used anywhere.
**Constraints**: *Maximum Length*: `4096` | getDescription(): ?string | setDescription(?string description): void |
-| `quickPay` | [`?QuickPay`](../../doc/models/quick-pay.md) | Optional | Describes an ad hoc item and price to generate a quick pay checkout link.
For more information,
see [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout). | getQuickPay(): ?QuickPay | setQuickPay(?QuickPay quickPay): void |
-| `order` | [`?Order`](../../doc/models/order.md) | Optional | Contains all information related to a single order to process with Square,
including line items that specify the products to purchase. `Order` objects also
include information about any associated tenders, refunds, and returns.
All Connect V2 Transactions have all been converted to Orders including all associated
itemization data. | getOrder(): ?Order | setOrder(?Order order): void |
-| `checkoutOptions` | [`?CheckoutOptions`](../../doc/models/checkout-options.md) | Optional | - | getCheckoutOptions(): ?CheckoutOptions | setCheckoutOptions(?CheckoutOptions checkoutOptions): void |
-| `prePopulatedData` | [`?PrePopulatedData`](../../doc/models/pre-populated-data.md) | Optional | Describes buyer data to prepopulate in the payment form.
For more information,
see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations). | getPrePopulatedData(): ?PrePopulatedData | setPrePopulatedData(?PrePopulatedData prePopulatedData): void |
-| `paymentNote` | `?string` | Optional | A note for the payment. After processing the payment, Square adds this note to the resulting `Payment`.
**Constraints**: *Maximum Length*: `500` | getPaymentNote(): ?string | setPaymentNote(?string paymentNote): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "cd9e25dc-d9f2-4430-aedb-61605070e95f",
- "quick_pay": {
- "location_id": "A9Y43N9ABXZBP",
- "name": "Auto Detailing",
- "price_money": {
- "amount": 10000,
- "currency": "USD"
- }
- },
- "description": "description6",
- "order": {
- "id": "id6",
- "location_id": "location_id0",
- "reference_id": "reference_id4",
- "source": {
- "name": "name4"
- },
- "customer_id": "customer_id4",
- "line_items": [
- {
- "uid": "uid8",
- "name": "name8",
- "quantity": "quantity4",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- }
- ]
- },
- "checkout_options": {
- "allow_tipping": false,
- "custom_fields": [
- {
- "title": "title8"
- },
- {
- "title": "title8"
- }
- ],
- "subscription_plan_id": "subscription_plan_id8",
- "redirect_url": "redirect_url2",
- "merchant_support_email": "merchant_support_email8"
- }
-}
-```
-
diff --git a/doc/models/create-payment-link-response.md b/doc/models/create-payment-link-response.md
deleted file mode 100644
index 408c3f1b..00000000
--- a/doc/models/create-payment-link-response.md
+++ /dev/null
@@ -1,266 +0,0 @@
-
-# Create Payment Link Response
-
-## Structure
-
-`CreatePaymentLinkResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `paymentLink` | [`?PaymentLink`](../../doc/models/payment-link.md) | Optional | - | getPaymentLink(): ?PaymentLink | setPaymentLink(?PaymentLink paymentLink): void |
-| `relatedResources` | [`?PaymentLinkRelatedResources`](../../doc/models/payment-link-related-resources.md) | Optional | - | getRelatedResources(): ?PaymentLinkRelatedResources | setRelatedResources(?PaymentLinkRelatedResources relatedResources): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "payment_link": {
- "id": "id2",
- "version": 184,
- "description": "description2",
- "order_id": "order_id6",
- "checkout_options": {
- "allow_tipping": false,
- "custom_fields": [
- {
- "title": "title8"
- },
- {
- "title": "title8"
- }
- ],
- "subscription_plan_id": "subscription_plan_id8",
- "redirect_url": "redirect_url2",
- "merchant_support_email": "merchant_support_email8"
- },
- "pre_populated_data": {
- "buyer_email": "buyer_email8",
- "buyer_phone_number": "buyer_phone_number0",
- "buyer_address": {
- "address_line_1": "address_line_12",
- "address_line_2": "address_line_22",
- "address_line_3": "address_line_38",
- "locality": "locality2",
- "sublocality": "sublocality2"
- }
- }
- },
- "related_resources": {
- "orders": [
- {
- "id": "id2",
- "location_id": "location_id6",
- "reference_id": "reference_id0",
- "source": {
- "name": "name4"
- },
- "customer_id": "customer_id0",
- "line_items": [
- {
- "uid": "uid8",
- "name": "name8",
- "quantity": "quantity4",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- },
- {
- "uid": "uid8",
- "name": "name8",
- "quantity": "quantity4",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- }
- ]
- }
- ],
- "subscription_plans": [
- {
- "type": "ITEM_OPTION",
- "id": "id4",
- "updated_at": "updated_at0",
- "version": 112,
- "is_deleted": false,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key2": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- },
- {
- "type": "ITEM_OPTION",
- "id": "id4",
- "updated_at": "updated_at0",
- "version": 112,
- "is_deleted": false,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key2": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- },
- {
- "type": "ITEM_OPTION",
- "id": "id4",
- "updated_at": "updated_at0",
- "version": 112,
- "is_deleted": false,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key2": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- }
- ]
- }
-}
-```
-
diff --git a/doc/models/create-payment-request.md b/doc/models/create-payment-request.md
deleted file mode 100644
index a450f592..00000000
--- a/doc/models/create-payment-request.md
+++ /dev/null
@@ -1,68 +0,0 @@
-
-# Create Payment Request
-
-Describes a request to create a payment using
-[CreatePayment](../../doc/apis/payments.md#create-payment).
-
-## Structure
-
-`CreatePaymentRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `sourceId` | `string` | Required | The ID for the source of funds for this payment.
This could be a payment token generated by the Web Payments SDK for any of its
[supported methods](https://developer.squareup.com/docs/web-payments/overview#explore-payment-methods),
including cards, bank transfers, Afterpay or Cash App Pay. If recording a payment
that the seller received outside of Square, specify either "CASH" or "EXTERNAL".
For more information, see
[Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).
**Constraints**: *Minimum Length*: `1` | getSourceId(): string | setSourceId(string sourceId): void |
-| `idempotencyKey` | `string` | Required | A unique string that identifies this `CreatePayment` request. Keys can be any valid string
but must be unique for every `CreatePayment` request.
Note: The number of allowed characters might be less than the stated maximum, if multi-byte
characters are used.
For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `45` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `amountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): ?Money | setAmountMoney(?Money amountMoney): void |
-| `tipMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTipMoney(): ?Money | setTipMoney(?Money tipMoney): void |
-| `appFeeMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAppFeeMoney(): ?Money | setAppFeeMoney(?Money appFeeMoney): void |
-| `delayDuration` | `?string` | Optional | The duration of time after the payment's creation when Square automatically
either completes or cancels the payment depending on the `delay_action` field value.
For more information, see
[Time threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold).
This parameter should be specified as a time duration, in RFC 3339 format.
Note: This feature is only supported for card payments. This parameter can only be set for a delayed
capture payment (`autocomplete=false`).
Default:
- Card-present payments: "PT36H" (36 hours) from the creation time.
- Card-not-present payments: "P7D" (7 days) from the creation time. | getDelayDuration(): ?string | setDelayDuration(?string delayDuration): void |
-| `delayAction` | `?string` | Optional | The action to be applied to the payment when the `delay_duration` has elapsed. The action must be
CANCEL or COMPLETE. For more information, see
[Time Threshold](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/delayed-capture#time-threshold).
Default: CANCEL | getDelayAction(): ?string | setDelayAction(?string delayAction): void |
-| `autocomplete` | `?bool` | Optional | If set to `true`, this payment will be completed when possible. If
set to `false`, this payment is held in an approved state until either
explicitly completed (captured) or canceled (voided). For more information, see
[Delayed capture](https://developer.squareup.com/docs/payments-api/take-payments/card-payments#delayed-capture-of-a-card-payment).
Default: true | getAutocomplete(): ?bool | setAutocomplete(?bool autocomplete): void |
-| `orderId` | `?string` | Optional | Associates a previously created order with this payment. | getOrderId(): ?string | setOrderId(?string orderId): void |
-| `customerId` | `?string` | Optional | The [Customer](entity:Customer) ID of the customer associated with the payment.
This is required if the `source_id` refers to a card on file created using the Cards API. | getCustomerId(): ?string | setCustomerId(?string customerId): void |
-| `locationId` | `?string` | Optional | The location ID to associate with the payment. If not specified, the [main location](https://developer.squareup.com/docs/locations-api#about-the-main-location) is
used. | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `teamMemberId` | `?string` | Optional | An optional [TeamMember](entity:TeamMember) ID to associate with
this payment. | getTeamMemberId(): ?string | setTeamMemberId(?string teamMemberId): void |
-| `referenceId` | `?string` | Optional | A user-defined ID to associate with the payment.
You can use this field to associate the payment to an entity in an external system
(for example, you might specify an order ID that is generated by a third-party shopping cart).
**Constraints**: *Maximum Length*: `40` | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `verificationToken` | `?string` | Optional | An identifying token generated by [payments.verifyBuyer()](https://developer.squareup.com/reference/sdks/web/payments/objects/Payments#Payments.verifyBuyer).
Verification tokens encapsulate customer device information and 3-D Secure
challenge results to indicate that Square has verified the buyer identity.
For more information, see [SCA Overview](https://developer.squareup.com/docs/sca-overview). | getVerificationToken(): ?string | setVerificationToken(?string verificationToken): void |
-| `acceptPartialAuthorization` | `?bool` | Optional | If set to `true` and charging a Square Gift Card, a payment might be returned with
`amount_money` equal to less than what was requested. For example, a request for $20 when charging
a Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose
to prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card
payment. This field cannot be `true` when `autocomplete = true`.
For more information, see
[Partial amount with Square Gift Cards](https://developer.squareup.com/docs/payments-api/take-payments#partial-payment-gift-card).
Default: false | getAcceptPartialAuthorization(): ?bool | setAcceptPartialAuthorization(?bool acceptPartialAuthorization): void |
-| `buyerEmailAddress` | `?string` | Optional | The buyer's email address.
**Constraints**: *Maximum Length*: `255` | getBuyerEmailAddress(): ?string | setBuyerEmailAddress(?string buyerEmailAddress): void |
-| `buyerPhoneNumber` | `?string` | Optional | The buyer's phone number.
Must follow the following format:
1. A leading + symbol (followed by a country code)
2. The phone number can contain spaces and the special characters `(` , `)` , `-` , and `.`.
Alphabetical characters aren't allowed.
3. The phone number must contain between 9 and 16 digits. | getBuyerPhoneNumber(): ?string | setBuyerPhoneNumber(?string buyerPhoneNumber): void |
-| `billingAddress` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void |
-| `shippingAddress` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getShippingAddress(): ?Address | setShippingAddress(?Address shippingAddress): void |
-| `note` | `?string` | Optional | An optional note to be entered by the developer when creating a payment.
**Constraints**: *Maximum Length*: `500` | getNote(): ?string | setNote(?string note): void |
-| `statementDescriptionIdentifier` | `?string` | Optional | Optional additional payment information to include on the customer's card statement
as part of the statement description. This can be, for example, an invoice number, ticket number,
or short description that uniquely identifies the purchase.
Note that the `statement_description_identifier` might get truncated on the statement description
to fit the required information including the Square identifier (SQ *) and name of the
seller taking the payment.
**Constraints**: *Maximum Length*: `20` | getStatementDescriptionIdentifier(): ?string | setStatementDescriptionIdentifier(?string statementDescriptionIdentifier): void |
-| `cashDetails` | [`?CashPaymentDetails`](../../doc/models/cash-payment-details.md) | Optional | Stores details about a cash payment. Contains only non-confidential information. For more information, see
[Take Cash Payments](https://developer.squareup.com/docs/payments-api/take-payments/cash-payments). | getCashDetails(): ?CashPaymentDetails | setCashDetails(?CashPaymentDetails cashDetails): void |
-| `externalDetails` | [`?ExternalPaymentDetails`](../../doc/models/external-payment-details.md) | Optional | Stores details about an external payment. Contains only non-confidential information.
For more information, see
[Take External Payments](https://developer.squareup.com/docs/payments-api/take-payments/external-payments). | getExternalDetails(): ?ExternalPaymentDetails | setExternalDetails(?ExternalPaymentDetails externalDetails): void |
-| `customerDetails` | [`?CustomerDetails`](../../doc/models/customer-details.md) | Optional | Details about the customer making the payment. | getCustomerDetails(): ?CustomerDetails | setCustomerDetails(?CustomerDetails customerDetails): void |
-| `offlinePaymentDetails` | [`?OfflinePaymentDetails`](../../doc/models/offline-payment-details.md) | Optional | Details specific to offline payments. | getOfflinePaymentDetails(): ?OfflinePaymentDetails | setOfflinePaymentDetails(?OfflinePaymentDetails offlinePaymentDetails): void |
-
-## Example (as JSON)
-
-```json
-{
- "amount_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "app_fee_money": {
- "amount": 10,
- "currency": "USD"
- },
- "autocomplete": true,
- "customer_id": "W92WH6P11H4Z77CTET0RNTGFW8",
- "idempotency_key": "7b0f3ec5-086a-4871-8f13-3c81b3875218",
- "location_id": "L88917AVBK2S5",
- "note": "Brief description",
- "reference_id": "123456",
- "source_id": "ccof:GaJGNaZa8x4OgDJn4GB",
- "tip_money": {
- "amount": 190,
- "currency": "TWD"
- },
- "delay_duration": "delay_duration6",
- "delay_action": "delay_action6"
-}
-```
-
diff --git a/doc/models/create-payment-response.md b/doc/models/create-payment-response.md
deleted file mode 100644
index 12671903..00000000
--- a/doc/models/create-payment-response.md
+++ /dev/null
@@ -1,114 +0,0 @@
-
-# Create Payment Response
-
-Defines the response returned by [CreatePayment](../../doc/apis/payments.md#create-payment).
-
-If there are errors processing the request, the `payment` field might not be
-present, or it might be present with a status of `FAILED`.
-
-## Structure
-
-`CreatePaymentResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `payment` | [`?Payment`](../../doc/models/payment.md) | Optional | Represents a payment processed by the Square API. | getPayment(): ?Payment | setPayment(?Payment payment): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment": {
- "amount_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "app_fee_money": {
- "amount": 10,
- "currency": "USD"
- },
- "application_details": {
- "application_id": "sq0ids-TcgftTEtKxJTRF1lCFJ9TA",
- "square_product": "ECOMMERCE_API"
- },
- "approved_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "card_details": {
- "auth_result_code": "vNEn2f",
- "avs_status": "AVS_ACCEPTED",
- "card": {
- "bin": "411111",
- "card_brand": "VISA",
- "card_type": "DEBIT",
- "exp_month": 11,
- "exp_year": 2022,
- "fingerprint": "sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ",
- "last_4": "1111",
- "prepaid_type": "NOT_PREPAID"
- },
- "card_payment_timeline": {
- "authorized_at": "2021-10-13T21:14:29.732Z",
- "captured_at": "2021-10-13T21:14:30.504Z"
- },
- "cvv_status": "CVV_ACCEPTED",
- "entry_method": "ON_FILE",
- "statement_description": "SQ *EXAMPLE TEST GOSQ.C",
- "status": "CAPTURED"
- },
- "created_at": "2021-10-13T21:14:29.577Z",
- "customer_id": "W92WH6P11H4Z77CTET0RNTGFW8",
- "delay_action": "CANCEL",
- "delay_duration": "PT168H",
- "delayed_until": "2021-10-20T21:14:29.577Z",
- "id": "R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY",
- "location_id": "L88917AVBK2S5",
- "note": "Brief Description",
- "order_id": "pRsjRTgFWATl7so6DxdKBJa7ssbZY",
- "receipt_number": "R2B3",
- "receipt_url": "https://squareup.com/receipt/preview/EXAMPLE_RECEIPT_ID",
- "reference_id": "123456",
- "risk_evaluation": {
- "created_at": "2021-10-13T21:14:30.423Z",
- "risk_level": "NORMAL"
- },
- "source_type": "CARD",
- "status": "COMPLETED",
- "total_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "updated_at": "2021-10-13T21:14:30.504Z",
- "version_token": "TPtNEOBOa6Qq6E3C3IjckSVOM6b3hMbfhjvTxHBQUsB6o",
- "tip_money": {
- "amount": 190,
- "currency": "TWD"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-refund-request.md b/doc/models/create-refund-request.md
deleted file mode 100644
index f0c0c14c..00000000
--- a/doc/models/create-refund-request.md
+++ /dev/null
@@ -1,35 +0,0 @@
-
-# Create Refund Request
-
-Defines the body parameters that can be included in
-a request to the [CreateRefund](api-endpoint:Transactions-CreateRefund) endpoint.
-
-Deprecated - recommend using [RefundPayment](api-endpoint:Refunds-RefundPayment)
-
-## Structure
-
-`CreateRefundRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A value you specify that uniquely identifies this
refund among refunds you've created for the tender.
If you're unsure whether a particular refund succeeded,
you can reattempt it with the same idempotency key without
worrying about duplicating the refund.
See [Idempotency keys](https://developer.squareup.com/docs/working-with-apis/idempotency) for more information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `192` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `tenderId` | `string` | Required | The ID of the tender to refund.
A [`Transaction`](entity:Transaction) has one or more `tenders` (i.e., methods
of payment) associated with it, and you refund each tender separately with
the Connect API.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `192` | getTenderId(): string | setTenderId(string tenderId): void |
-| `reason` | `?string` | Optional | A description of the reason for the refund.
Default value: `Refund via API`
**Constraints**: *Maximum Length*: `192` | getReason(): ?string | setReason(?string reason): void |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "amount_money": {
- "amount": 100,
- "currency": "USD"
- },
- "idempotency_key": "86ae1696-b1e3-4328-af6d-f1e04d947ad2",
- "reason": "a reason",
- "tender_id": "MtZRYYdDrYNQbOvV7nbuBvMF"
-}
-```
-
diff --git a/doc/models/create-refund-response.md b/doc/models/create-refund-response.md
deleted file mode 100644
index 5c067db0..00000000
--- a/doc/models/create-refund-response.md
+++ /dev/null
@@ -1,68 +0,0 @@
-
-# Create Refund Response
-
-Defines the fields that are included in the response body of
-a request to the [CreateRefund](api-endpoint:Transactions-CreateRefund) endpoint.
-
-One of `errors` or `refund` is present in a given response (never both).
-
-## Structure
-
-`CreateRefundResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `refund` | [`?Refund`](../../doc/models/refund.md) | Optional | Represents a refund processed for a Square transaction. | getRefund(): ?Refund | setRefund(?Refund refund): void |
-
-## Example (as JSON)
-
-```json
-{
- "refund": {
- "additional_recipients": [
- {
- "amount_money": {
- "amount": 10,
- "currency": "USD"
- },
- "description": "Application fees",
- "location_id": "057P5VYJ4A5X1",
- "receivable_id": "ISu5xwxJ5v0CMJTQq7RvqyMF"
- }
- ],
- "amount_money": {
- "amount": 100,
- "currency": "USD"
- },
- "created_at": "2016-02-12T00:28:18Z",
- "id": "b27436d1-7f8e-5610-45c6-417ef71434b4-SW",
- "location_id": "18YC4JDH91E1H",
- "reason": "some reason",
- "status": "PENDING",
- "tender_id": "MtZRYYdDrYNQbOvV7nbuBvMF",
- "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF",
- "processing_fee_money": {
- "amount": 112,
- "currency": "DJF"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-shift-request.md b/doc/models/create-shift-request.md
deleted file mode 100644
index 7c3b3862..00000000
--- a/doc/models/create-shift-request.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Create Shift Request
-
-Represents a request to create a `Shift`.
-
-## Structure
-
-`CreateShiftRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `?string` | Optional | A unique string value to ensure the idempotency of the operation.
**Constraints**: *Maximum Length*: `128` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-| `shift` | [`Shift`](../../doc/models/shift.md) | Required | A record of the hourly rate, start, and end times for a single work shift
for an employee. This might include a record of the start and end times for breaks
taken during the shift. | getShift(): Shift | setShift(Shift shift): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "HIDSNG5KS478L",
- "shift": {
- "breaks": [
- {
- "break_type_id": "REGS1EQR1TPZ5",
- "end_at": "2019-01-25T06:16:00-05:00",
- "expected_duration": "PT5M",
- "is_paid": true,
- "name": "Tea Break",
- "start_at": "2019-01-25T06:11:00-05:00"
- }
- ],
- "declared_cash_tip_money": {
- "amount": 500,
- "currency": "USD"
- },
- "end_at": "2019-01-25T13:11:00-05:00",
- "location_id": "PAA1RJZZKXBFG",
- "start_at": "2019-01-25T03:11:00-05:00",
- "team_member_id": "ormj0jJJZ5OZIzxrZYJI",
- "wage": {
- "hourly_rate": {
- "amount": 1100,
- "currency": "USD"
- },
- "tip_eligible": true,
- "title": "Barista",
- "job_id": "job_id0"
- },
- "id": "id4",
- "employee_id": "employee_id4",
- "timezone": "timezone4"
- }
-}
-```
-
diff --git a/doc/models/create-shift-response.md b/doc/models/create-shift-response.md
deleted file mode 100644
index c58cd34a..00000000
--- a/doc/models/create-shift-response.md
+++ /dev/null
@@ -1,82 +0,0 @@
-
-# Create Shift Response
-
-The response to a request to create a `Shift`. The response contains
-the created `Shift` object and might contain a set of `Error` objects if
-the request resulted in errors.
-
-## Structure
-
-`CreateShiftResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `shift` | [`?Shift`](../../doc/models/shift.md) | Optional | A record of the hourly rate, start, and end times for a single work shift
for an employee. This might include a record of the start and end times for breaks
taken during the shift. | getShift(): ?Shift | setShift(?Shift shift): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "shift": {
- "breaks": [
- {
- "break_type_id": "REGS1EQR1TPZ5",
- "end_at": "2019-01-25T06:16:00-05:00",
- "expected_duration": "PT5M",
- "id": "X7GAQYVVRRG6P",
- "is_paid": true,
- "name": "Tea Break",
- "start_at": "2019-01-25T06:11:00-05:00"
- }
- ],
- "created_at": "2019-02-28T00:39:02Z",
- "declared_cash_tip_money": {
- "amount": 500,
- "currency": "USD"
- },
- "employee_id": "ormj0jJJZ5OZIzxrZYJI",
- "end_at": "2019-01-25T13:11:00-05:00",
- "id": "K0YH4CV5462JB",
- "location_id": "PAA1RJZZKXBFG",
- "start_at": "2019-01-25T03:11:00-05:00",
- "status": "CLOSED",
- "team_member_id": "ormj0jJJZ5OZIzxrZYJI",
- "timezone": "America/New_York",
- "updated_at": "2019-02-28T00:39:02Z",
- "version": 1,
- "wage": {
- "hourly_rate": {
- "amount": 1100,
- "currency": "USD"
- },
- "job_id": "FzbJAtt9qEWncK1BWgVCxQ6M",
- "tip_eligible": true,
- "title": "Barista"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-subscription-request.md b/doc/models/create-subscription-request.md
deleted file mode 100644
index 45c0e815..00000000
--- a/doc/models/create-subscription-request.md
+++ /dev/null
@@ -1,53 +0,0 @@
-
-# Create Subscription Request
-
-Defines input parameters in a request to the
-[CreateSubscription](../../doc/apis/subscriptions.md#create-subscription) endpoint.
-
-## Structure
-
-`CreateSubscriptionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `?string` | Optional | A unique string that identifies this `CreateSubscription` request.
If you do not provide a unique string (or provide an empty string as the value),
the endpoint treats each request as independent.
For more information, see [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency). | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-| `locationId` | `string` | Required | The ID of the location the subscription is associated with.
**Constraints**: *Minimum Length*: `1` | getLocationId(): string | setLocationId(string locationId): void |
-| `planVariationId` | `?string` | Optional | The ID of the [subscription plan variation](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations#plan-variations) created using the Catalog API. | getPlanVariationId(): ?string | setPlanVariationId(?string planVariationId): void |
-| `customerId` | `string` | Required | The ID of the [customer](entity:Customer) subscribing to the subscription plan variation.
**Constraints**: *Minimum Length*: `1` | getCustomerId(): string | setCustomerId(string customerId): void |
-| `startDate` | `?string` | Optional | The `YYYY-MM-DD`-formatted date to start the subscription.
If it is unspecified, the subscription starts immediately. | getStartDate(): ?string | setStartDate(?string startDate): void |
-| `canceledDate` | `?string` | Optional | The `YYYY-MM-DD`-formatted date when the newly created subscription is scheduled for cancellation.
This date overrides the cancellation date set in the plan variation configuration.
If the cancellation date is earlier than the end date of a subscription cycle, the subscription stops
at the canceled date and the subscriber is sent a prorated invoice at the beginning of the canceled cycle.
When the subscription plan of the newly created subscription has a fixed number of cycles and the `canceled_date`
occurs before the subscription plan expires, the specified `canceled_date` sets the date when the subscription
stops through the end of the last cycle. | getCanceledDate(): ?string | setCanceledDate(?string canceledDate): void |
-| `taxPercentage` | `?string` | Optional | The tax to add when billing the subscription.
The percentage is expressed in decimal form, using a `'.'` as the decimal
separator and without a `'%'` sign. For example, a value of 7.5
corresponds to 7.5%.
**Constraints**: *Maximum Length*: `10` | getTaxPercentage(): ?string | setTaxPercentage(?string taxPercentage): void |
-| `priceOverrideMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getPriceOverrideMoney(): ?Money | setPriceOverrideMoney(?Money priceOverrideMoney): void |
-| `cardId` | `?string` | Optional | The ID of the [subscriber's](entity:Customer) [card](entity:Card) to charge.
If it is not specified, the subscriber receives an invoice via email with a link to pay for their subscription. | getCardId(): ?string | setCardId(?string cardId): void |
-| `timezone` | `?string` | Optional | The timezone that is used in date calculations for the subscription. If unset, defaults to
the location timezone. If a timezone is not configured for the location, defaults to "America/New_York".
Format: the IANA Timezone Database identifier for the location timezone. For
a list of time zones, see [List of tz database time zones](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). | getTimezone(): ?string | setTimezone(?string timezone): void |
-| `source` | [`?SubscriptionSource`](../../doc/models/subscription-source.md) | Optional | The origination details of the subscription. | getSource(): ?SubscriptionSource | setSource(?SubscriptionSource source): void |
-| `monthlyBillingAnchorDate` | `?int` | Optional | The day-of-the-month to change the billing date to.
**Constraints**: `>= 1`, `<= 31` | getMonthlyBillingAnchorDate(): ?int | setMonthlyBillingAnchorDate(?int monthlyBillingAnchorDate): void |
-| `phases` | [`?(Phase[])`](../../doc/models/phase.md) | Optional | array of phases for this subscription | getPhases(): ?array | setPhases(?array phases): void |
-
-## Example (as JSON)
-
-```json
-{
- "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB",
- "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
- "idempotency_key": "8193148c-9586-11e6-99f9-28cfe92138cf",
- "location_id": "S8GWD5R9QB376",
- "phases": [
- {
- "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY",
- "ordinal": 0
- }
- ],
- "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
- "source": {
- "name": "My Application"
- },
- "start_date": "2023-06-20",
- "timezone": "America/Los_Angeles",
- "canceled_date": "canceled_date6",
- "tax_percentage": "tax_percentage6"
-}
-```
-
diff --git a/doc/models/create-subscription-response.md b/doc/models/create-subscription-response.md
deleted file mode 100644
index fd623c70..00000000
--- a/doc/models/create-subscription-response.md
+++ /dev/null
@@ -1,67 +0,0 @@
-
-# Create Subscription Response
-
-Defines output parameters in a response from the
-[CreateSubscription](../../doc/apis/subscriptions.md#create-subscription) endpoint.
-
-## Structure
-
-`CreateSubscriptionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `subscription` | [`?Subscription`](../../doc/models/subscription.md) | Optional | Represents a subscription purchased by a customer.
For more information, see
[Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions). | getSubscription(): ?Subscription | setSubscription(?Subscription subscription): void |
-
-## Example (as JSON)
-
-```json
-{
- "subscription": {
- "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB",
- "created_at": "2023-06-20T21:53:10Z",
- "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
- "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f",
- "location_id": "S8GWD5R9QB376",
- "phases": [
- {
- "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY",
- "ordinal": 0,
- "plan_phase_uid": "X2Q2AONPB3RB64Y27S25QCZP",
- "uid": "873451e0-745b-4e87-ab0b-c574933fe616"
- }
- ],
- "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
- "source": {
- "name": "My Application"
- },
- "start_date": "2023-06-20",
- "status": "ACTIVE",
- "timezone": "America/Los_Angeles",
- "version": 1
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-team-member-request.md b/doc/models/create-team-member-request.md
deleted file mode 100644
index 3595bcf9..00000000
--- a/doc/models/create-team-member-request.md
+++ /dev/null
@@ -1,63 +0,0 @@
-
-# Create Team Member Request
-
-Represents a create request for a `TeamMember` object.
-
-## Structure
-
-`CreateTeamMemberRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `?string` | Optional | A unique string that identifies this `CreateTeamMember` request.
Keys can be any valid string, but must be unique for every request.
For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
The minimum length is 1 and the maximum length is 45. | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-| `teamMember` | [`?TeamMember`](../../doc/models/team-member.md) | Optional | A record representing an individual team member for a business. | getTeamMember(): ?TeamMember | setTeamMember(?TeamMember teamMember): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "idempotency-key-0",
- "team_member": {
- "assigned_locations": {
- "assignment_type": "EXPLICIT_LOCATIONS",
- "location_ids": [
- "YSGH2WBKG94QZ",
- "GA2Y9HSJ8KRYT"
- ]
- },
- "email_address": "joe_doe@gmail.com",
- "family_name": "Doe",
- "given_name": "Joe",
- "phone_number": "+14159283333",
- "reference_id": "reference_id_1",
- "status": "ACTIVE",
- "wage_setting": {
- "is_overtime_exempt": true,
- "job_assignments": [
- {
- "annual_rate": {
- "amount": 3000000,
- "currency": "USD"
- },
- "job_id": "FjS8x95cqHiMenw4f1NAUH4P",
- "pay_type": "SALARY",
- "weekly_hours": 40
- },
- {
- "hourly_rate": {
- "amount": 2000,
- "currency": "USD"
- },
- "job_id": "VDNpRv8da51NU8qZFC5zDWpF",
- "pay_type": "HOURLY"
- }
- ]
- },
- "id": "id6",
- "is_owner": false
- }
-}
-```
-
diff --git a/doc/models/create-team-member-response.md b/doc/models/create-team-member-response.md
deleted file mode 100644
index b2b600fb..00000000
--- a/doc/models/create-team-member-response.md
+++ /dev/null
@@ -1,94 +0,0 @@
-
-# Create Team Member Response
-
-Represents a response from a create request containing the created `TeamMember` object or error messages.
-
-## Structure
-
-`CreateTeamMemberResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `teamMember` | [`?TeamMember`](../../doc/models/team-member.md) | Optional | A record representing an individual team member for a business. | getTeamMember(): ?TeamMember | setTeamMember(?TeamMember teamMember): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | The errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "team_member": {
- "assigned_locations": {
- "assignment_type": "EXPLICIT_LOCATIONS",
- "location_ids": [
- "GA2Y9HSJ8KRYT",
- "YSGH2WBKG94QZ"
- ]
- },
- "created_at": "2021-06-11T22:55:45Z",
- "email_address": "joe_doe@example.com",
- "family_name": "Doe",
- "given_name": "Joe",
- "id": "1yJlHapkseYnNPETIU1B",
- "is_owner": false,
- "phone_number": "+14159283333",
- "reference_id": "reference_id_1",
- "status": "ACTIVE",
- "updated_at": "2021-06-11T22:55:45Z",
- "wage_setting": {
- "created_at": "2021-06-11T22:55:45Z",
- "is_overtime_exempt": true,
- "job_assignments": [
- {
- "annual_rate": {
- "amount": 3000000,
- "currency": "USD"
- },
- "hourly_rate": {
- "amount": 1443,
- "currency": "USD"
- },
- "job_id": "FjS8x95cqHiMenw4f1NAUH4P",
- "job_title": "Manager",
- "pay_type": "SALARY",
- "weekly_hours": 40
- },
- {
- "hourly_rate": {
- "amount": 2000,
- "currency": "USD"
- },
- "job_id": "VDNpRv8da51NU8qZFC5zDWpF",
- "job_title": "Cashier",
- "pay_type": "HOURLY"
- }
- ],
- "team_member_id": "1yJlHapkseYnNPETIU1B",
- "updated_at": "2021-06-11T22:55:45Z",
- "version": 1
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-terminal-action-request.md b/doc/models/create-terminal-action-request.md
deleted file mode 100644
index 39e1d1f5..00000000
--- a/doc/models/create-terminal-action-request.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Create Terminal Action Request
-
-## Structure
-
-`CreateTerminalActionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A unique string that identifies this `CreateAction` request. Keys can be any valid string
but must be unique for every `CreateAction` request.
See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more
information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `action` | [`TerminalAction`](../../doc/models/terminal-action.md) | Required | Represents an action processed by the Square Terminal. | getAction(): TerminalAction | setAction(TerminalAction action): void |
-
-## Example (as JSON)
-
-```json
-{
- "action": {
- "deadline_duration": "PT5M",
- "device_id": "{{DEVICE_ID}}",
- "save_card_options": {
- "customer_id": "{{CUSTOMER_ID}}",
- "reference_id": "user-id-1"
- },
- "type": "SAVE_CARD",
- "id": "id2",
- "status": "status4",
- "cancel_reason": "TIMED_OUT"
- },
- "idempotency_key": "thahn-70e75c10-47f7-4ab6-88cc-aaa4076d065e"
-}
-```
-
diff --git a/doc/models/create-terminal-action-response.md b/doc/models/create-terminal-action-response.md
deleted file mode 100644
index 0ef5bbbf..00000000
--- a/doc/models/create-terminal-action-response.md
+++ /dev/null
@@ -1,51 +0,0 @@
-
-# Create Terminal Action Response
-
-## Structure
-
-`CreateTerminalActionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `action` | [`?TerminalAction`](../../doc/models/terminal-action.md) | Optional | Represents an action processed by the Square Terminal. | getAction(): ?TerminalAction | setAction(?TerminalAction action): void |
-
-## Example (as JSON)
-
-```json
-{
- "action": {
- "app_id": "APP_ID",
- "created_at": "2021-07-28T23:22:07.476Z",
- "deadline_duration": "PT5M",
- "device_id": "DEVICE_ID",
- "id": "termapia:jveJIAkkAjILHkdCE",
- "location_id": "LOCATION_ID",
- "save_card_options": {
- "customer_id": "CUSTOMER_ID",
- "reference_id": "user-id-1"
- },
- "status": "PENDING",
- "type": "SAVE_CARD",
- "updated_at": "2021-07-28T23:22:07.476Z",
- "cancel_reason": "TIMED_OUT"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-terminal-checkout-request.md b/doc/models/create-terminal-checkout-request.md
deleted file mode 100644
index f89fddc8..00000000
--- a/doc/models/create-terminal-checkout-request.md
+++ /dev/null
@@ -1,53 +0,0 @@
-
-# Create Terminal Checkout Request
-
-## Structure
-
-`CreateTerminalCheckoutRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A unique string that identifies this `CreateCheckout` request. Keys can be any valid string but
must be unique for every `CreateCheckout` request.
See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `checkout` | [`TerminalCheckout`](../../doc/models/terminal-checkout.md) | Required | Represents a checkout processed by the Square Terminal. | getCheckout(): TerminalCheckout | setCheckout(TerminalCheckout checkout): void |
-
-## Example (as JSON)
-
-```json
-{
- "checkout": {
- "amount_money": {
- "amount": 2610,
- "currency": "USD"
- },
- "device_options": {
- "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003",
- "skip_receipt_screen": false,
- "collect_signature": false,
- "tip_settings": {
- "allow_tipping": false,
- "separate_tip_screen": false,
- "custom_tip_field": false,
- "tip_percentages": [
- 48
- ],
- "smart_tipping": false
- },
- "show_itemized_cart": false
- },
- "note": "A brief note",
- "reference_id": "id11572",
- "id": "id2",
- "order_id": "order_id6",
- "payment_options": {
- "autocomplete": false,
- "delay_duration": "delay_duration2",
- "accept_partial_authorization": false,
- "delay_action": "CANCEL"
- }
- },
- "idempotency_key": "28a0c3bc-7839-11ea-bc55-0242ac130003"
-}
-```
-
diff --git a/doc/models/create-terminal-checkout-response.md b/doc/models/create-terminal-checkout-response.md
deleted file mode 100644
index dfea2411..00000000
--- a/doc/models/create-terminal-checkout-response.md
+++ /dev/null
@@ -1,67 +0,0 @@
-
-# Create Terminal Checkout Response
-
-## Structure
-
-`CreateTerminalCheckoutResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `checkout` | [`?TerminalCheckout`](../../doc/models/terminal-checkout.md) | Optional | Represents a checkout processed by the Square Terminal. | getCheckout(): ?TerminalCheckout | setCheckout(?TerminalCheckout checkout): void |
-
-## Example (as JSON)
-
-```json
-{
- "checkout": {
- "amount_money": {
- "amount": 2610,
- "currency": "USD"
- },
- "app_id": "APP_ID",
- "created_at": "2020-04-06T16:39:32.545Z",
- "deadline_duration": "PT5M",
- "device_options": {
- "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003",
- "skip_receipt_screen": false,
- "tip_settings": {
- "allow_tipping": false,
- "separate_tip_screen": false,
- "custom_tip_field": false,
- "tip_percentages": [
- 48
- ],
- "smart_tipping": false
- },
- "collect_signature": false,
- "show_itemized_cart": false
- },
- "id": "08YceKh7B3ZqO",
- "location_id": "LOCATION_ID",
- "note": "A brief note",
- "payment_type": "CARD_PRESENT",
- "reference_id": "id11572",
- "status": "PENDING",
- "updated_at": "2020-04-06T16:39:32.545Z",
- "order_id": "order_id6",
- "payment_options": {
- "autocomplete": false,
- "delay_duration": "delay_duration2",
- "accept_partial_authorization": false,
- "delay_action": "CANCEL"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-terminal-refund-request.md b/doc/models/create-terminal-refund-request.md
deleted file mode 100644
index c8232415..00000000
--- a/doc/models/create-terminal-refund-request.md
+++ /dev/null
@@ -1,36 +0,0 @@
-
-# Create Terminal Refund Request
-
-## Structure
-
-`CreateTerminalRefundRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A unique string that identifies this `CreateRefund` request. Keys can be any valid string but
must be unique for every `CreateRefund` request.
See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `64` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `refund` | [`?TerminalRefund`](../../doc/models/terminal-refund.md) | Optional | Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds. | getRefund(): ?TerminalRefund | setRefund(?TerminalRefund refund): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "402a640b-b26f-401f-b406-46f839590c04",
- "refund": {
- "amount_money": {
- "amount": 111,
- "currency": "CAD"
- },
- "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291",
- "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY",
- "reason": "Returning items",
- "id": "id8",
- "refund_id": "refund_id2",
- "order_id": "order_id2",
- "deadline_duration": "deadline_duration0",
- "status": "status0"
- }
-}
-```
-
diff --git a/doc/models/create-terminal-refund-response.md b/doc/models/create-terminal-refund-response.md
deleted file mode 100644
index 78933915..00000000
--- a/doc/models/create-terminal-refund-response.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Create Terminal Refund Response
-
-## Structure
-
-`CreateTerminalRefundResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `refund` | [`?TerminalRefund`](../../doc/models/terminal-refund.md) | Optional | Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds. | getRefund(): ?TerminalRefund | setRefund(?TerminalRefund refund): void |
-
-## Example (as JSON)
-
-```json
-{
- "refund": {
- "amount_money": {
- "amount": 111,
- "currency": "CAD"
- },
- "app_id": "sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ",
- "card": {
- "bin": "411111",
- "card_brand": "INTERAC",
- "card_type": "CREDIT",
- "exp_month": 1,
- "exp_year": 2022,
- "fingerprint": "sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw",
- "last_4": "1111"
- },
- "created_at": "2020-09-29T15:21:46.771Z",
- "deadline_duration": "PT5M",
- "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291",
- "id": "009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY",
- "location_id": "76C9W6K8CNNQ5",
- "order_id": "kcuKDKreRaI4gF4TjmEgZjHk8Z7YY",
- "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY",
- "reason": "Returning items",
- "status": "PENDING",
- "updated_at": "2020-09-29T15:21:46.771Z",
- "refund_id": "refund_id2"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/create-vendor-request.md b/doc/models/create-vendor-request.md
deleted file mode 100644
index 9b9075e4..00000000
--- a/doc/models/create-vendor-request.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-# Create Vendor Request
-
-Represents an input to a call to [CreateVendor](../../doc/apis/vendors.md#create-vendor).
-
-## Structure
-
-`CreateVendorRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](api-endpoint:Vendors-CreateVendor) call idempotent.
See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the
[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more
information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `vendor` | [`?Vendor`](../../doc/models/vendor.md) | Optional | Represents a supplier to a seller. | getVendor(): ?Vendor | setVendor(?Vendor vendor): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "idempotency_key6",
- "vendor": {
- "id": "id6",
- "created_at": "created_at4",
- "updated_at": "updated_at2",
- "name": "name6",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- }
-}
-```
-
diff --git a/doc/models/create-vendor-response.md b/doc/models/create-vendor-response.md
deleted file mode 100644
index e5affc10..00000000
--- a/doc/models/create-vendor-response.md
+++ /dev/null
@@ -1,50 +0,0 @@
-
-# Create Vendor Response
-
-Represents an output from a call to [CreateVendor](../../doc/apis/vendors.md#create-vendor).
-
-## Structure
-
-`CreateVendorResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors encountered when the request fails. | getErrors(): ?array | setErrors(?array errors): void |
-| `vendor` | [`?Vendor`](../../doc/models/vendor.md) | Optional | Represents a supplier to a seller. | getVendor(): ?Vendor | setVendor(?Vendor vendor): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "vendor": {
- "id": "id6",
- "created_at": "created_at4",
- "updated_at": "updated_at2",
- "name": "name6",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- }
-}
-```
-
diff --git a/doc/models/create-webhook-subscription-request.md b/doc/models/create-webhook-subscription-request.md
deleted file mode 100644
index 2dcc2533..00000000
--- a/doc/models/create-webhook-subscription-request.md
+++ /dev/null
@@ -1,35 +0,0 @@
-
-# Create Webhook Subscription Request
-
-Creates a [Subscription](../../doc/models/webhook-subscription.md).
-
-## Structure
-
-`CreateWebhookSubscriptionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `?string` | Optional | A unique string that identifies the [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscription) request.
**Constraints**: *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-| `subscription` | [`WebhookSubscription`](../../doc/models/webhook-subscription.md) | Required | Represents the details of a webhook subscription, including notification URL,
event types, and signature key. | getSubscription(): WebhookSubscription | setSubscription(WebhookSubscription subscription): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "63f84c6c-2200-4c99-846c-2670a1311fbf",
- "subscription": {
- "api_version": "2021-12-15",
- "event_types": [
- "payment.created",
- "payment.updated"
- ],
- "name": "Example Webhook Subscription",
- "notification_url": "https://example-webhook-url.com",
- "id": "id4",
- "enabled": false
- }
-}
-```
-
diff --git a/doc/models/create-webhook-subscription-response.md b/doc/models/create-webhook-subscription-response.md
deleted file mode 100644
index e9894279..00000000
--- a/doc/models/create-webhook-subscription-response.md
+++ /dev/null
@@ -1,49 +0,0 @@
-
-# Create Webhook Subscription Response
-
-Defines the fields that are included in the response body of
-a request to the [CreateWebhookSubscription](../../doc/apis/webhook-subscriptions.md#create-webhook-subscription) endpoint.
-
-Note: if there are errors processing the request, the [Subscription](../../doc/models/webhook-subscription.md) will not be
-present.
-
-## Structure
-
-`CreateWebhookSubscriptionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `subscription` | [`?WebhookSubscription`](../../doc/models/webhook-subscription.md) | Optional | Represents the details of a webhook subscription, including notification URL,
event types, and signature key. | getSubscription(): ?WebhookSubscription | setSubscription(?WebhookSubscription subscription): void |
-
-## Example (as JSON)
-
-```json
-{
- "subscription": {
- "api_version": "2021-12-15",
- "created_at": "2022-01-10 23:29:48 +0000 UTC",
- "enabled": true,
- "event_types": [
- "payment.created",
- "payment.updated"
- ],
- "id": "wbhk_b35f6b3145074cf9ad513610786c19d5",
- "name": "Example Webhook Subscription",
- "notification_url": "https://example-webhook-url.com",
- "signature_key": "1k9bIJKCeTmSQwyagtNRLg",
- "updated_at": "2022-01-10 23:29:48 +0000 UTC"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/currency.md b/doc/models/currency.md
deleted file mode 100644
index 3667d5fe..00000000
--- a/doc/models/currency.md
+++ /dev/null
@@ -1,198 +0,0 @@
-
-# Currency
-
-Indicates the associated currency for an amount of money. Values correspond
-to [ISO 4217](https://wikipedia.org/wiki/ISO_4217).
-
-## Enumeration
-
-`Currency`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `UNKNOWN_CURRENCY` | Unknown currency |
-| `AED` | United Arab Emirates dirham |
-| `AFN` | Afghan afghani |
-| `ALL` | Albanian lek |
-| `AMD` | Armenian dram |
-| `ANG` | Netherlands Antillean guilder |
-| `AOA` | Angolan kwanza |
-| `ARS` | Argentine peso |
-| `AUD` | Australian dollar |
-| `AWG` | Aruban florin |
-| `AZN` | Azerbaijani manat |
-| `BAM` | Bosnia and Herzegovina convertible mark |
-| `BBD` | Barbados dollar |
-| `BDT` | Bangladeshi taka |
-| `BGN` | Bulgarian lev |
-| `BHD` | Bahraini dinar |
-| `BIF` | Burundian franc |
-| `BMD` | Bermudian dollar |
-| `BND` | Brunei dollar |
-| `BOB` | Boliviano |
-| `BOV` | Bolivian Mvdol |
-| `BRL` | Brazilian real |
-| `BSD` | Bahamian dollar |
-| `BTN` | Bhutanese ngultrum |
-| `BWP` | Botswana pula |
-| `BYR` | Belarusian ruble |
-| `BZD` | Belize dollar |
-| `CAD` | Canadian dollar |
-| `CDF` | Congolese franc |
-| `CHE` | WIR Euro |
-| `CHF` | Swiss franc |
-| `CHW` | WIR Franc |
-| `CLF` | Unidad de Fomento |
-| `CLP` | Chilean peso |
-| `CNY` | Chinese yuan |
-| `COP` | Colombian peso |
-| `COU` | Unidad de Valor Real |
-| `CRC` | Costa Rican colon |
-| `CUC` | Cuban convertible peso |
-| `CUP` | Cuban peso |
-| `CVE` | Cape Verdean escudo |
-| `CZK` | Czech koruna |
-| `DJF` | Djiboutian franc |
-| `DKK` | Danish krone |
-| `DOP` | Dominican peso |
-| `DZD` | Algerian dinar |
-| `EGP` | Egyptian pound |
-| `ERN` | Eritrean nakfa |
-| `ETB` | Ethiopian birr |
-| `EUR` | Euro |
-| `FJD` | Fiji dollar |
-| `FKP` | Falkland Islands pound |
-| `GBP` | Pound sterling |
-| `GEL` | Georgian lari |
-| `GHS` | Ghanaian cedi |
-| `GIP` | Gibraltar pound |
-| `GMD` | Gambian dalasi |
-| `GNF` | Guinean franc |
-| `GTQ` | Guatemalan quetzal |
-| `GYD` | Guyanese dollar |
-| `HKD` | Hong Kong dollar |
-| `HNL` | Honduran lempira |
-| `HRK` | Croatian kuna |
-| `HTG` | Haitian gourde |
-| `HUF` | Hungarian forint |
-| `IDR` | Indonesian rupiah |
-| `ILS` | Israeli new shekel |
-| `INR` | Indian rupee |
-| `IQD` | Iraqi dinar |
-| `IRR` | Iranian rial |
-| `ISK` | Icelandic króna |
-| `JMD` | Jamaican dollar |
-| `JOD` | Jordanian dinar |
-| `JPY` | Japanese yen |
-| `KES` | Kenyan shilling |
-| `KGS` | Kyrgyzstani som |
-| `KHR` | Cambodian riel |
-| `KMF` | Comoro franc |
-| `KPW` | North Korean won |
-| `KRW` | South Korean won |
-| `KWD` | Kuwaiti dinar |
-| `KYD` | Cayman Islands dollar |
-| `KZT` | Kazakhstani tenge |
-| `LAK` | Lao kip |
-| `LBP` | Lebanese pound |
-| `LKR` | Sri Lankan rupee |
-| `LRD` | Liberian dollar |
-| `LSL` | Lesotho loti |
-| `LTL` | Lithuanian litas |
-| `LVL` | Latvian lats |
-| `LYD` | Libyan dinar |
-| `MAD` | Moroccan dirham |
-| `MDL` | Moldovan leu |
-| `MGA` | Malagasy ariary |
-| `MKD` | Macedonian denar |
-| `MMK` | Myanmar kyat |
-| `MNT` | Mongolian tögrög |
-| `MOP` | Macanese pataca |
-| `MRO` | Mauritanian ouguiya |
-| `MUR` | Mauritian rupee |
-| `MVR` | Maldivian rufiyaa |
-| `MWK` | Malawian kwacha |
-| `MXN` | Mexican peso |
-| `MXV` | Mexican Unidad de Inversion |
-| `MYR` | Malaysian ringgit |
-| `MZN` | Mozambican metical |
-| `NAD` | Namibian dollar |
-| `NGN` | Nigerian naira |
-| `NIO` | Nicaraguan córdoba |
-| `NOK` | Norwegian krone |
-| `NPR` | Nepalese rupee |
-| `NZD` | New Zealand dollar |
-| `OMR` | Omani rial |
-| `PAB` | Panamanian balboa |
-| `PEN` | Peruvian sol |
-| `PGK` | Papua New Guinean kina |
-| `PHP` | Philippine peso |
-| `PKR` | Pakistani rupee |
-| `PLN` | Polish złoty |
-| `PYG` | Paraguayan guaraní |
-| `QAR` | Qatari riyal |
-| `RON` | Romanian leu |
-| `RSD` | Serbian dinar |
-| `RUB` | Russian ruble |
-| `RWF` | Rwandan franc |
-| `SAR` | Saudi riyal |
-| `SBD` | Solomon Islands dollar |
-| `SCR` | Seychelles rupee |
-| `SDG` | Sudanese pound |
-| `SEK` | Swedish krona |
-| `SGD` | Singapore dollar |
-| `SHP` | Saint Helena pound |
-| `SLL` | Sierra Leonean first leone |
-| `SLE` | Sierra Leonean second leone |
-| `SOS` | Somali shilling |
-| `SRD` | Surinamese dollar |
-| `SSP` | South Sudanese pound |
-| `STD` | São Tomé and Príncipe dobra |
-| `SVC` | Salvadoran colón |
-| `SYP` | Syrian pound |
-| `SZL` | Swazi lilangeni |
-| `THB` | Thai baht |
-| `TJS` | Tajikstani somoni |
-| `TMT` | Turkmenistan manat |
-| `TND` | Tunisian dinar |
-| `TOP` | Tongan pa'anga |
-| `TRY` | Turkish lira |
-| `TTD` | Trinidad and Tobago dollar |
-| `TWD` | New Taiwan dollar |
-| `TZS` | Tanzanian shilling |
-| `UAH` | Ukrainian hryvnia |
-| `UGX` | Ugandan shilling |
-| `USD` | United States dollar |
-| `USN` | United States dollar (next day) |
-| `USS` | United States dollar (same day) |
-| `UYI` | Uruguay Peso en Unidedades Indexadas |
-| `UYU` | Uruguyan peso |
-| `UZS` | Uzbekistan som |
-| `VEF` | Venezuelan bolívar soberano |
-| `VND` | Vietnamese đồng |
-| `VUV` | Vanuatu vatu |
-| `WST` | Samoan tala |
-| `XAF` | CFA franc BEAC |
-| `XAG` | Silver |
-| `XAU` | Gold |
-| `XBA` | European Composite Unit |
-| `XBB` | European Monetary Unit |
-| `XBC` | European Unit of Account 9 |
-| `XBD` | European Unit of Account 17 |
-| `XCD` | East Caribbean dollar |
-| `XDR` | Special drawing rights (International Monetary Fund) |
-| `XOF` | CFA franc BCEAO |
-| `XPD` | Palladium |
-| `XPF` | CFP franc |
-| `XPT` | Platinum |
-| `XTS` | Code reserved for testing |
-| `XXX` | No currency |
-| `YER` | Yemeni rial |
-| `ZAR` | South African rand |
-| `ZMK` | Zambian kwacha |
-| `ZMW` | Zambian kwacha |
-| `BTC` | Bitcoin |
-| `XUS` | USD Coin |
-
diff --git a/doc/models/custom-attribute-definition-visibility.md b/doc/models/custom-attribute-definition-visibility.md
deleted file mode 100644
index 3e51a4af..00000000
--- a/doc/models/custom-attribute-definition-visibility.md
+++ /dev/null
@@ -1,20 +0,0 @@
-
-# Custom Attribute Definition Visibility
-
-The level of permission that a seller or other applications requires to
-view this custom attribute definition.
-The `Visibility` field controls who can read and write the custom attribute values
-and custom attribute definition.
-
-## Enumeration
-
-`CustomAttributeDefinitionVisibility`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `VISIBILITY_HIDDEN` | The custom attribute definition and values are hidden from the seller (except on export
of all seller data) and other developers. |
-| `VISIBILITY_READ_ONLY` | The seller and other developers can read the custom attribute definition and values
on resources. |
-| `VISIBILITY_READ_WRITE_VALUES` | The seller and other developers can read the custom attribute definition,
and can read and write values on resources. A custom attribute definition
can only be edited or deleted by the application that created it. |
-
diff --git a/doc/models/custom-attribute-definition.md b/doc/models/custom-attribute-definition.md
deleted file mode 100644
index 68cdc072..00000000
--- a/doc/models/custom-attribute-definition.md
+++ /dev/null
@@ -1,38 +0,0 @@
-
-# Custom Attribute Definition
-
-Represents a definition for custom attribute values. A custom attribute definition
-specifies the key, visibility, schema, and other properties for a custom attribute.
-
-## Structure
-
-`CustomAttributeDefinition`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `key` | `?string` | Optional | The identifier
of the custom attribute definition and its corresponding custom attributes. This value
can be a simple key, which is the key that is provided when the custom attribute definition
is created, or a qualified key, if the requesting
application is not the definition owner. The qualified key consists of the application ID
of the custom attribute definition owner
followed by the simple key that was provided when the definition was created. It has the
format application_id:simple key.
The value for a simple key can contain up to 60 alphanumeric characters, periods (.),
underscores (_), and hyphens (-).
This field can not be changed
after the custom attribute definition is created. This field is required when creating
a definition and must be unique per application, seller, and resource type.
**Constraints**: *Minimum Length*: `1`, *Pattern*: `^([a-zA-Z0-9\._-]+:)?[a-zA-Z0-9\._-]{1,60}$` | getKey(): ?string | setKey(?string key): void |
-| `schema` | `mixed` | Optional | The JSON schema for the custom attribute definition, which determines the data type of the corresponding custom attributes. For more information,
see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). This field is required when creating a definition. | getSchema(): | setSchema( schema): void |
-| `name` | `?string` | Optional | The name of the custom attribute definition for API and seller-facing UI purposes. The name must
be unique within the seller and application pair. This field is required if the
`visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
**Constraints**: *Maximum Length*: `255` | getName(): ?string | setName(?string name): void |
-| `description` | `?string` | Optional | Seller-oriented description of the custom attribute definition, including any constraints
that the seller should observe. May be displayed as a tooltip in Square UIs. This field is
required if the `visibility` field is `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
**Constraints**: *Maximum Length*: `255` | getDescription(): ?string | setDescription(?string description): void |
-| `visibility` | [`?string(CustomAttributeDefinitionVisibility)`](../../doc/models/custom-attribute-definition-visibility.md) | Optional | The level of permission that a seller or other applications requires to
view this custom attribute definition.
The `Visibility` field controls who can read and write the custom attribute values
and custom attribute definition. | getVisibility(): ?string | setVisibility(?string visibility): void |
-| `version` | `?int` | Optional | Read only. The current version of the custom attribute definition.
The value is incremented each time the custom attribute definition is updated.
When updating a custom attribute definition, you can provide this field
and specify the current version of the custom attribute definition to enable
[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).
On writes, this field must be set to the latest version. Stale writes are rejected.
This field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,
see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). | getVersion(): ?int | setVersion(?int version): void |
-| `updatedAt` | `?string` | Optional | The timestamp that indicates when the custom attribute definition was created or most recently updated,
in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `createdAt` | `?string` | Optional | The timestamp that indicates when the custom attribute definition was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "key": "key8",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name8",
- "description": "description2",
- "visibility": "VISIBILITY_READ_WRITE_VALUES"
-}
-```
-
diff --git a/doc/models/custom-attribute-filter.md b/doc/models/custom-attribute-filter.md
deleted file mode 100644
index a1e65381..00000000
--- a/doc/models/custom-attribute-filter.md
+++ /dev/null
@@ -1,41 +0,0 @@
-
-# Custom Attribute Filter
-
-Supported custom attribute query expressions for calling the
-[SearchCatalogItems](../../doc/apis/catalog.md#search-catalog-items)
-endpoint to search for items or item variations.
-
-## Structure
-
-`CustomAttributeFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinitionId` | `?string` | Optional | A query expression to filter items or item variations by matching their custom attributes'
`custom_attribute_definition_id` property value against the the specified id.
Exactly one of `custom_attribute_definition_id` or `key` must be specified. | getCustomAttributeDefinitionId(): ?string | setCustomAttributeDefinitionId(?string customAttributeDefinitionId): void |
-| `key` | `?string` | Optional | A query expression to filter items or item variations by matching their custom attributes'
`key` property value against the specified key.
Exactly one of `custom_attribute_definition_id` or `key` must be specified. | getKey(): ?string | setKey(?string key): void |
-| `stringFilter` | `?string` | Optional | A query expression to filter items or item variations by matching their custom attributes'
`string_value` property value against the specified text.
Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified. | getStringFilter(): ?string | setStringFilter(?string stringFilter): void |
-| `numberFilter` | [`?Range`](../../doc/models/range.md) | Optional | The range of a number value between the specified lower and upper bounds. | getNumberFilter(): ?Range | setNumberFilter(?Range numberFilter): void |
-| `selectionUidsFilter` | `?(string[])` | Optional | A query expression to filter items or item variations by matching their custom attributes'
`selection_uid_values` values against the specified selection uids.
Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified. | getSelectionUidsFilter(): ?array | setSelectionUidsFilter(?array selectionUidsFilter): void |
-| `boolFilter` | `?bool` | Optional | A query expression to filter items or item variations by matching their custom attributes'
`boolean_value` property values against the specified Boolean expression.
Exactly one of `string_filter`, `number_filter`, `selection_uids_filter`, or `bool_filter` must be specified. | getBoolFilter(): ?bool | setBoolFilter(?bool boolFilter): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition_id": "custom_attribute_definition_id0",
- "key": "key2",
- "string_filter": "string_filter4",
- "number_filter": {
- "min": "min8",
- "max": "max4"
- },
- "selection_uids_filter": [
- "selection_uids_filter0",
- "selection_uids_filter9",
- "selection_uids_filter8"
- ]
-}
-```
-
diff --git a/doc/models/custom-attribute.md b/doc/models/custom-attribute.md
deleted file mode 100644
index 3e45e6e6..00000000
--- a/doc/models/custom-attribute.md
+++ /dev/null
@@ -1,46 +0,0 @@
-
-# Custom Attribute
-
-A custom attribute value. Each custom attribute value has a corresponding
-`CustomAttributeDefinition` object.
-
-## Structure
-
-`CustomAttribute`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `key` | `?string` | Optional | The identifier
of the custom attribute definition and its corresponding custom attributes. This value
can be a simple key, which is the key that is provided when the custom attribute definition
is created, or a qualified key, if the requesting
application is not the definition owner. The qualified key consists of the application ID
of the custom attribute definition owner
followed by the simple key that was provided when the definition was created. It has the
format application_id:simple key.
The value for a simple key can contain up to 60 alphanumeric characters, periods (.),
underscores (_), and hyphens (-).
**Constraints**: *Minimum Length*: `1`, *Pattern*: `^([a-zA-Z0-9\._-]+:)?[a-zA-Z0-9\._-]{1,60}$` | getKey(): ?string | setKey(?string key): void |
-| `value` | `mixed` | Optional | The value assigned to the custom attribute. It is validated against the custom
attribute definition's schema on write operations. For more information about custom
attribute values,
see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). | getValue(): | setValue( value): void |
-| `version` | `?int` | Optional | Read only. The current version of the custom attribute. This field is incremented when the custom attribute is changed.
When updating an existing custom attribute value, you can provide this field
and specify the current version of the custom attribute to enable
[optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency).
This field can also be used to enforce strong consistency for reads. For more information about strong consistency for reads,
see [Custom Attributes Overview](https://developer.squareup.com/docs/devtools/customattributes/overview). | getVersion(): ?int | setVersion(?int version): void |
-| `visibility` | [`?string(CustomAttributeDefinitionVisibility)`](../../doc/models/custom-attribute-definition-visibility.md) | Optional | The level of permission that a seller or other applications requires to
view this custom attribute definition.
The `Visibility` field controls who can read and write the custom attribute values
and custom attribute definition. | getVisibility(): ?string | setVisibility(?string visibility): void |
-| `definition` | [`?CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Optional | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getDefinition(): ?CustomAttributeDefinition | setDefinition(?CustomAttributeDefinition definition): void |
-| `updatedAt` | `?string` | Optional | The timestamp that indicates when the custom attribute was created or was most recently
updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `createdAt` | `?string` | Optional | The timestamp that indicates when the custom attribute was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "key": "key0",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 20,
- "visibility": "VISIBILITY_HIDDEN",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
-}
-```
-
diff --git a/doc/models/custom-field.md b/doc/models/custom-field.md
deleted file mode 100644
index e89747d9..00000000
--- a/doc/models/custom-field.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Custom Field
-
-Describes a custom form field to add to the checkout page to collect more information from buyers during checkout.
-For more information,
-see [Specify checkout options](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations#specify-checkout-options-1).
-
-## Structure
-
-`CustomField`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `title` | `string` | Required | The title of the custom field.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `50` | getTitle(): string | setTitle(string title): void |
-
-## Example (as JSON)
-
-```json
-{
- "title": "title4"
-}
-```
-
diff --git a/doc/models/customer-address-filter.md b/doc/models/customer-address-filter.md
deleted file mode 100644
index 36979e12..00000000
--- a/doc/models/customer-address-filter.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Customer Address Filter
-
-The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](../../doc/models/customer-custom-attribute-filter-value.md) filter when
-searching by an `Address`-type custom attribute.
-
-## Structure
-
-`CustomerAddressFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `postalCode` | [`?CustomerTextFilter`](../../doc/models/customer-text-filter.md) | Optional | A filter to select customers based on exact or fuzzy matching of
customer attributes against a specified query. Depending on the customer attributes,
the filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both. | getPostalCode(): ?CustomerTextFilter | setPostalCode(?CustomerTextFilter postalCode): void |
-| `country` | [`?string(Country)`](../../doc/models/country.md) | Optional | Indicates the country associated with another entity, such as a business.
Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm). | getCountry(): ?string | setCountry(?string country): void |
-
-## Example (as JSON)
-
-```json
-{
- "postal_code": {
- "exact": "exact2",
- "fuzzy": "fuzzy2"
- },
- "country": "ZM"
-}
-```
-
diff --git a/doc/models/customer-creation-source-filter.md b/doc/models/customer-creation-source-filter.md
deleted file mode 100644
index 460e1e8a..00000000
--- a/doc/models/customer-creation-source-filter.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Customer Creation Source Filter
-
-The creation source filter.
-
-If one or more creation sources are set, customer profiles are included in,
-or excluded from, the result if they match at least one of the filter criteria.
-
-## Structure
-
-`CustomerCreationSourceFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `values` | [`?(string(CustomerCreationSource)[])`](../../doc/models/customer-creation-source.md) | Optional | The list of creation sources used as filtering criteria.
See [CustomerCreationSource](#type-customercreationsource) for possible values | getValues(): ?array | setValues(?array values): void |
-| `rule` | [`?string(CustomerInclusionExclusion)`](../../doc/models/customer-inclusion-exclusion.md) | Optional | Indicates whether customers should be included in, or excluded from,
the result set when they match the filtering criteria. | getRule(): ?string | setRule(?string rule): void |
-
-## Example (as JSON)
-
-```json
-{
- "values": [
- "EGIFTING",
- "EMAIL_COLLECTION",
- "FEEDBACK"
- ],
- "rule": "INCLUDE"
-}
-```
-
diff --git a/doc/models/customer-creation-source.md b/doc/models/customer-creation-source.md
deleted file mode 100644
index 8a4997f5..00000000
--- a/doc/models/customer-creation-source.md
+++ /dev/null
@@ -1,33 +0,0 @@
-
-# Customer Creation Source
-
-Indicates the method used to create the customer profile.
-
-## Enumeration
-
-`CustomerCreationSource`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `OTHER` | The default creation source. This source is typically used for backward/future
compatibility when the original source of a customer profile is
unrecognized. For example, when older clients do not support newer
source types. |
-| `APPOINTMENTS` | The customer profile was created automatically when an appointment
was scheduled. |
-| `COUPON` | The customer profile was created automatically when a coupon was issued
using Square Point of Sale. |
-| `DELETION_RECOVERY` | The customer profile was restored through Square's deletion recovery
process. |
-| `DIRECTORY` | The customer profile was created manually through Square Seller Dashboard or the
Point of Sale application. |
-| `EGIFTING` | The customer profile was created automatically when a gift card was
issued using Square Point of Sale. Customer profiles are created for
both the buyer and the recipient of the gift card. |
-| `EMAIL_COLLECTION` | The customer profile was created through Square Point of Sale when
signing up for marketing emails during checkout. |
-| `FEEDBACK` | The customer profile was created automatically when providing feedback
through a digital receipt. |
-| `IMPORT` | The customer profile was created automatically when importing customer
data through Square Seller Dashboard. |
-| `INVOICES` | The customer profile was created automatically during an invoice payment. |
-| `LOYALTY` | The customer profile was created automatically when customers provide a
phone number for loyalty reward programs during checkout. |
-| `MARKETING` | The customer profile was created as the result of a campaign managed
through Square’s Facebook integration. |
-| `MERGE` | The customer profile was created as the result of explicitly merging
multiple customer profiles through the Square Seller Dashboard or the Point of
Sale application. |
-| `ONLINE_STORE` | The customer profile was created through Square's Online Store solution
(legacy service). |
-| `INSTANT_PROFILE` | The customer profile was created automatically as the result of a successful
transaction that did not explicitly link to an existing customer profile. |
-| `TERMINAL` | The customer profile was created through Square's Virtual Terminal. |
-| `THIRD_PARTY` | The customer profile was created through a Square API call. |
-| `THIRD_PARTY_IMPORT` | The customer profile was created by a third-party product and imported
through an official integration. |
-| `UNMERGE_RECOVERY` | The customer profile was restored through Square's unmerge recovery
process. |
-
diff --git a/doc/models/customer-custom-attribute-filter-value.md b/doc/models/customer-custom-attribute-filter-value.md
deleted file mode 100644
index 164821d8..00000000
--- a/doc/models/customer-custom-attribute-filter-value.md
+++ /dev/null
@@ -1,58 +0,0 @@
-
-# Customer Custom Attribute Filter Value
-
-A type-specific filter used in a [custom attribute filter](../../doc/models/customer-custom-attribute-filter.md) to search based on the value
-of a customer-related [custom attribute](../../doc/models/custom-attribute.md).
-
-## Structure
-
-`CustomerCustomAttributeFilterValue`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `email` | [`?CustomerTextFilter`](../../doc/models/customer-text-filter.md) | Optional | A filter to select customers based on exact or fuzzy matching of
customer attributes against a specified query. Depending on the customer attributes,
the filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both. | getEmail(): ?CustomerTextFilter | setEmail(?CustomerTextFilter email): void |
-| `phone` | [`?CustomerTextFilter`](../../doc/models/customer-text-filter.md) | Optional | A filter to select customers based on exact or fuzzy matching of
customer attributes against a specified query. Depending on the customer attributes,
the filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both. | getPhone(): ?CustomerTextFilter | setPhone(?CustomerTextFilter phone): void |
-| `text` | [`?CustomerTextFilter`](../../doc/models/customer-text-filter.md) | Optional | A filter to select customers based on exact or fuzzy matching of
customer attributes against a specified query. Depending on the customer attributes,
the filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both. | getText(): ?CustomerTextFilter | setText(?CustomerTextFilter text): void |
-| `selection` | [`?FilterValue`](../../doc/models/filter-value.md) | Optional | A filter to select resources based on an exact field value. For any given
value, the value can only be in one property. Depending on the field, either
all properties can be set or only a subset will be available.
Refer to the documentation of the field. | getSelection(): ?FilterValue | setSelection(?FilterValue selection): void |
-| `date` | [`?TimeRange`](../../doc/models/time-range.md) | Optional | Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled. | getDate(): ?TimeRange | setDate(?TimeRange date): void |
-| `number` | [`?FloatNumberRange`](../../doc/models/float-number-range.md) | Optional | Specifies a decimal number range. | getNumber(): ?FloatNumberRange | setNumber(?FloatNumberRange number): void |
-| `boolean` | `?bool` | Optional | A filter for a query based on the value of a `Boolean`-type custom attribute. | getBoolean(): ?bool | setBoolean(?bool boolean): void |
-| `address` | [`?CustomerAddressFilter`](../../doc/models/customer-address-filter.md) | Optional | The customer address filter. This filter is used in a [CustomerCustomAttributeFilterValue](../../doc/models/customer-custom-attribute-filter-value.md) filter when
searching by an `Address`-type custom attribute. | getAddress(): ?CustomerAddressFilter | setAddress(?CustomerAddressFilter address): void |
-
-## Example (as JSON)
-
-```json
-{
- "email": {
- "exact": "exact6",
- "fuzzy": "fuzzy2"
- },
- "phone": {
- "exact": "exact0",
- "fuzzy": "fuzzy6"
- },
- "text": {
- "exact": "exact0",
- "fuzzy": "fuzzy6"
- },
- "selection": {
- "all": [
- "all1"
- ],
- "any": [
- "any8",
- "any9"
- ],
- "none": [
- "none3"
- ]
- },
- "date": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- }
-}
-```
-
diff --git a/doc/models/customer-custom-attribute-filter.md b/doc/models/customer-custom-attribute-filter.md
deleted file mode 100644
index 653d620e..00000000
--- a/doc/models/customer-custom-attribute-filter.md
+++ /dev/null
@@ -1,60 +0,0 @@
-
-# Customer Custom Attribute Filter
-
-The custom attribute filter. Use this filter in a set of [custom attribute filters](../../doc/models/customer-custom-attribute-filters.md) to search
-based on the value or last updated date of a customer-related [custom attribute](../../doc/models/custom-attribute.md).
-
-## Structure
-
-`CustomerCustomAttributeFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `key` | `string` | Required | The `key` of the [custom attribute](entity:CustomAttribute) to filter by. The key is the identifier of the custom attribute
(and the corresponding custom attribute definition) and can be retrieved using the [Customer Custom Attributes API](api:CustomerCustomAttributes). | getKey(): string | setKey(string key): void |
-| `filter` | [`?CustomerCustomAttributeFilterValue`](../../doc/models/customer-custom-attribute-filter-value.md) | Optional | A type-specific filter used in a [custom attribute filter](../../doc/models/customer-custom-attribute-filter.md) to search based on the value
of a customer-related [custom attribute](../../doc/models/custom-attribute.md). | getFilter(): ?CustomerCustomAttributeFilterValue | setFilter(?CustomerCustomAttributeFilterValue filter): void |
-| `updatedAt` | [`?TimeRange`](../../doc/models/time-range.md) | Optional | Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled. | getUpdatedAt(): ?TimeRange | setUpdatedAt(?TimeRange updatedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "key": "key6",
- "filter": {
- "email": {
- "exact": "exact6",
- "fuzzy": "fuzzy2"
- },
- "phone": {
- "exact": "exact0",
- "fuzzy": "fuzzy6"
- },
- "text": {
- "exact": "exact0",
- "fuzzy": "fuzzy6"
- },
- "selection": {
- "all": [
- "all1"
- ],
- "any": [
- "any8",
- "any9"
- ],
- "none": [
- "none3"
- ]
- },
- "date": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- }
- },
- "updated_at": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- }
-}
-```
-
diff --git a/doc/models/customer-custom-attribute-filters.md b/doc/models/customer-custom-attribute-filters.md
deleted file mode 100644
index 42741957..00000000
--- a/doc/models/customer-custom-attribute-filters.md
+++ /dev/null
@@ -1,63 +0,0 @@
-
-# Customer Custom Attribute Filters
-
-The custom attribute filters in a set of [customer filters](../../doc/models/customer-filter.md) used in a search query. Use this filter
-to search based on [custom attributes](../../doc/models/custom-attribute.md) that are assigned to customer profiles. For more information, see
-[Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute).
-
-## Structure
-
-`CustomerCustomAttributeFilters`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `filters` | [`?(CustomerCustomAttributeFilter[])`](../../doc/models/customer-custom-attribute-filter.md) | Optional | The custom attribute filters. Each filter must specify `key` and include the `filter` field with a type-specific filter,
the `updated_at` field, or both. The provided keys must be unique within the list of custom attribute filters. | getFilters(): ?array | setFilters(?array filters): void |
-
-## Example (as JSON)
-
-```json
-{
- "filters": [
- {
- "key": "key0",
- "filter": {
- "email": {
- "exact": "exact6",
- "fuzzy": "fuzzy2"
- },
- "phone": {
- "exact": "exact0",
- "fuzzy": "fuzzy6"
- },
- "text": {
- "exact": "exact0",
- "fuzzy": "fuzzy6"
- },
- "selection": {
- "all": [
- "all1"
- ],
- "any": [
- "any8",
- "any9"
- ],
- "none": [
- "none3"
- ]
- },
- "date": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- }
- },
- "updated_at": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- }
- }
- ]
-}
-```
-
diff --git a/doc/models/customer-details.md b/doc/models/customer-details.md
deleted file mode 100644
index a63cb74a..00000000
--- a/doc/models/customer-details.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Customer Details
-
-Details about the customer making the payment.
-
-## Structure
-
-`CustomerDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customerInitiated` | `?bool` | Optional | Indicates whether the customer initiated the payment. | getCustomerInitiated(): ?bool | setCustomerInitiated(?bool customerInitiated): void |
-| `sellerKeyedIn` | `?bool` | Optional | Indicates that the seller keyed in payment details on behalf of the customer.
This is used to flag a payment as Mail Order / Telephone Order (MOTO). | getSellerKeyedIn(): ?bool | setSellerKeyedIn(?bool sellerKeyedIn): void |
-
-## Example (as JSON)
-
-```json
-{
- "customer_initiated": false,
- "seller_keyed_in": false
-}
-```
-
diff --git a/doc/models/customer-filter.md b/doc/models/customer-filter.md
deleted file mode 100644
index 487461fa..00000000
--- a/doc/models/customer-filter.md
+++ /dev/null
@@ -1,55 +0,0 @@
-
-# Customer Filter
-
-Represents the filtering criteria in a [search query](../../doc/models/customer-query.md) that defines how to filter
-customer profiles returned in [SearchCustomers](../../doc/apis/customers.md#search-customers) results.
-
-## Structure
-
-`CustomerFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `creationSource` | [`?CustomerCreationSourceFilter`](../../doc/models/customer-creation-source-filter.md) | Optional | The creation source filter.
If one or more creation sources are set, customer profiles are included in,
or excluded from, the result if they match at least one of the filter criteria. | getCreationSource(): ?CustomerCreationSourceFilter | setCreationSource(?CustomerCreationSourceFilter creationSource): void |
-| `createdAt` | [`?TimeRange`](../../doc/models/time-range.md) | Optional | Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled. | getCreatedAt(): ?TimeRange | setCreatedAt(?TimeRange createdAt): void |
-| `updatedAt` | [`?TimeRange`](../../doc/models/time-range.md) | Optional | Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled. | getUpdatedAt(): ?TimeRange | setUpdatedAt(?TimeRange updatedAt): void |
-| `emailAddress` | [`?CustomerTextFilter`](../../doc/models/customer-text-filter.md) | Optional | A filter to select customers based on exact or fuzzy matching of
customer attributes against a specified query. Depending on the customer attributes,
the filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both. | getEmailAddress(): ?CustomerTextFilter | setEmailAddress(?CustomerTextFilter emailAddress): void |
-| `phoneNumber` | [`?CustomerTextFilter`](../../doc/models/customer-text-filter.md) | Optional | A filter to select customers based on exact or fuzzy matching of
customer attributes against a specified query. Depending on the customer attributes,
the filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both. | getPhoneNumber(): ?CustomerTextFilter | setPhoneNumber(?CustomerTextFilter phoneNumber): void |
-| `referenceId` | [`?CustomerTextFilter`](../../doc/models/customer-text-filter.md) | Optional | A filter to select customers based on exact or fuzzy matching of
customer attributes against a specified query. Depending on the customer attributes,
the filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both. | getReferenceId(): ?CustomerTextFilter | setReferenceId(?CustomerTextFilter referenceId): void |
-| `groupIds` | [`?FilterValue`](../../doc/models/filter-value.md) | Optional | A filter to select resources based on an exact field value. For any given
value, the value can only be in one property. Depending on the field, either
all properties can be set or only a subset will be available.
Refer to the documentation of the field. | getGroupIds(): ?FilterValue | setGroupIds(?FilterValue groupIds): void |
-| `customAttribute` | [`?CustomerCustomAttributeFilters`](../../doc/models/customer-custom-attribute-filters.md) | Optional | The custom attribute filters in a set of [customer filters](../../doc/models/customer-filter.md) used in a search query. Use this filter
to search based on [custom attributes](../../doc/models/custom-attribute.md) that are assigned to customer profiles. For more information, see
[Search by custom attribute](https://developer.squareup.com/docs/customers-api/use-the-api/search-customers#search-by-custom-attribute). | getCustomAttribute(): ?CustomerCustomAttributeFilters | setCustomAttribute(?CustomerCustomAttributeFilters customAttribute): void |
-| `segmentIds` | [`?FilterValue`](../../doc/models/filter-value.md) | Optional | A filter to select resources based on an exact field value. For any given
value, the value can only be in one property. Depending on the field, either
all properties can be set or only a subset will be available.
Refer to the documentation of the field. | getSegmentIds(): ?FilterValue | setSegmentIds(?FilterValue segmentIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "creation_source": {
- "values": [
- "THIRD_PARTY_IMPORT",
- "THIRD_PARTY",
- "TERMINAL"
- ],
- "rule": "INCLUDE"
- },
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- },
- "updated_at": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- },
- "email_address": {
- "exact": "exact2",
- "fuzzy": "fuzzy8"
- },
- "phone_number": {
- "exact": "exact2",
- "fuzzy": "fuzzy8"
- }
-}
-```
-
diff --git a/doc/models/customer-group.md b/doc/models/customer-group.md
deleted file mode 100644
index bc4c2c8a..00000000
--- a/doc/models/customer-group.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Customer Group
-
-Represents a group of customer profiles.
-
-Customer groups can be created, be modified, and have their membership defined using
-the Customers API or within the Customer Directory in the Square Seller Dashboard or Point of Sale.
-
-## Structure
-
-`CustomerGroup`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A unique Square-generated ID for the customer group.
**Constraints**: *Maximum Length*: `255` | getId(): ?string | setId(?string id): void |
-| `name` | `string` | Required | The name of the customer group. | getName(): string | setName(string name): void |
-| `createdAt` | `?string` | Optional | The timestamp when the customer group was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp when the customer group was last updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id0",
- "name": "name0",
- "created_at": "created_at8",
- "updated_at": "updated_at6"
-}
-```
-
diff --git a/doc/models/customer-inclusion-exclusion.md b/doc/models/customer-inclusion-exclusion.md
deleted file mode 100644
index 037c202c..00000000
--- a/doc/models/customer-inclusion-exclusion.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Customer Inclusion Exclusion
-
-Indicates whether customers should be included in, or excluded from,
-the result set when they match the filtering criteria.
-
-## Enumeration
-
-`CustomerInclusionExclusion`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `INCLUDE` | Customers should be included in the result set when they match the
filtering criteria. |
-| `EXCLUDE` | Customers should be excluded from the result set when they match
the filtering criteria. |
-
diff --git a/doc/models/customer-preferences.md b/doc/models/customer-preferences.md
deleted file mode 100644
index fda0d22c..00000000
--- a/doc/models/customer-preferences.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Customer Preferences
-
-Represents communication preferences for the customer profile.
-
-## Structure
-
-`CustomerPreferences`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `emailUnsubscribed` | `?bool` | Optional | Indicates whether the customer has unsubscribed from marketing campaign emails. A value of `true` means that the customer chose to opt out of email marketing from the current Square seller or from all Square sellers. This value is read-only from the Customers API. | getEmailUnsubscribed(): ?bool | setEmailUnsubscribed(?bool emailUnsubscribed): void |
-
-## Example (as JSON)
-
-```json
-{
- "email_unsubscribed": false
-}
-```
-
diff --git a/doc/models/customer-query.md b/doc/models/customer-query.md
deleted file mode 100644
index f3174a70..00000000
--- a/doc/models/customer-query.md
+++ /dev/null
@@ -1,53 +0,0 @@
-
-# Customer Query
-
-Represents filtering and sorting criteria for a [SearchCustomers](../../doc/apis/customers.md#search-customers) request.
-
-## Structure
-
-`CustomerQuery`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `filter` | [`?CustomerFilter`](../../doc/models/customer-filter.md) | Optional | Represents the filtering criteria in a [search query](../../doc/models/customer-query.md) that defines how to filter
customer profiles returned in [SearchCustomers](../../doc/apis/customers.md#search-customers) results. | getFilter(): ?CustomerFilter | setFilter(?CustomerFilter filter): void |
-| `sort` | [`?CustomerSort`](../../doc/models/customer-sort.md) | Optional | Represents the sorting criteria in a [search query](../../doc/models/customer-query.md) that defines how to sort
customer profiles returned in [SearchCustomers](../../doc/apis/customers.md#search-customers) results. | getSort(): ?CustomerSort | setSort(?CustomerSort sort): void |
-
-## Example (as JSON)
-
-```json
-{
- "filter": {
- "creation_source": {
- "values": [
- "THIRD_PARTY_IMPORT",
- "THIRD_PARTY",
- "TERMINAL"
- ],
- "rule": "INCLUDE"
- },
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- },
- "updated_at": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- },
- "email_address": {
- "exact": "exact2",
- "fuzzy": "fuzzy8"
- },
- "phone_number": {
- "exact": "exact2",
- "fuzzy": "fuzzy8"
- }
- },
- "sort": {
- "field": "DEFAULT",
- "order": "DESC"
- }
-}
-```
-
diff --git a/doc/models/customer-segment.md b/doc/models/customer-segment.md
deleted file mode 100644
index 5fdfcc63..00000000
--- a/doc/models/customer-segment.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Customer Segment
-
-Represents a group of customer profiles that match one or more predefined filter criteria.
-
-Segments (also known as Smart Groups) are defined and created within the Customer Directory in the
-Square Seller Dashboard or Point of Sale.
-
-## Structure
-
-`CustomerSegment`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A unique Square-generated ID for the segment.
**Constraints**: *Maximum Length*: `255` | getId(): ?string | setId(?string id): void |
-| `name` | `string` | Required | The name of the segment. | getName(): string | setName(string name): void |
-| `createdAt` | `?string` | Optional | The timestamp when the segment was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp when the segment was last updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id0",
- "name": "name0",
- "created_at": "created_at8",
- "updated_at": "updated_at6"
-}
-```
-
diff --git a/doc/models/customer-sort-field.md b/doc/models/customer-sort-field.md
deleted file mode 100644
index 7052f404..00000000
--- a/doc/models/customer-sort-field.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Customer Sort Field
-
-Specifies customer attributes as the sort key to customer profiles returned from a search.
-
-## Enumeration
-
-`CustomerSortField`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `DEFAULT` | Use the default sort key. By default, customers are sorted
alphanumerically by concatenating their `given_name` and `family_name`. If
neither name field is set, string comparison is performed using one of the
remaining fields in the following order: `company_name`, `email`,
`phone_number`. |
-| `CREATED_AT` | Use the creation date attribute (`created_at`) of customer profiles as the sort key. |
-
diff --git a/doc/models/customer-sort.md b/doc/models/customer-sort.md
deleted file mode 100644
index e93773cb..00000000
--- a/doc/models/customer-sort.md
+++ /dev/null
@@ -1,26 +0,0 @@
-
-# Customer Sort
-
-Represents the sorting criteria in a [search query](../../doc/models/customer-query.md) that defines how to sort
-customer profiles returned in [SearchCustomers](../../doc/apis/customers.md#search-customers) results.
-
-## Structure
-
-`CustomerSort`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `field` | [`?string(CustomerSortField)`](../../doc/models/customer-sort-field.md) | Optional | Specifies customer attributes as the sort key to customer profiles returned from a search. | getField(): ?string | setField(?string field): void |
-| `order` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getOrder(): ?string | setOrder(?string order): void |
-
-## Example (as JSON)
-
-```json
-{
- "field": "DEFAULT",
- "order": "DESC"
-}
-```
-
diff --git a/doc/models/customer-tax-ids.md b/doc/models/customer-tax-ids.md
deleted file mode 100644
index 495ba40c..00000000
--- a/doc/models/customer-tax-ids.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-# Customer Tax Ids
-
-Represents the tax ID associated with a [customer profile](../../doc/models/customer.md). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom.
-For more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids).
-
-## Structure
-
-`CustomerTaxIds`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `euVat` | `?string` | Optional | The EU VAT identification number for the customer. For example, `IE3426675K`. The ID can contain alphanumeric characters only.
**Constraints**: *Maximum Length*: `20` | getEuVat(): ?string | setEuVat(?string euVat): void |
-
-## Example (as JSON)
-
-```json
-{
- "eu_vat": "eu_vat6"
-}
-```
-
diff --git a/doc/models/customer-text-filter.md b/doc/models/customer-text-filter.md
deleted file mode 100644
index cbd0a5a0..00000000
--- a/doc/models/customer-text-filter.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Customer Text Filter
-
-A filter to select customers based on exact or fuzzy matching of
-customer attributes against a specified query. Depending on the customer attributes,
-the filter can be case-sensitive. This filter can be exact or fuzzy, but it cannot be both.
-
-## Structure
-
-`CustomerTextFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `exact` | `?string` | Optional | Use the exact filter to select customers whose attributes match exactly the specified query. | getExact(): ?string | setExact(?string exact): void |
-| `fuzzy` | `?string` | Optional | Use the fuzzy filter to select customers whose attributes match the specified query
in a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then
each query token must be matched somewhere in the searched attribute. For single token queries,
this is effectively the same behavior as a partial match operation. | getFuzzy(): ?string | setFuzzy(?string fuzzy): void |
-
-## Example (as JSON)
-
-```json
-{
- "exact": "exact4",
- "fuzzy": "fuzzy0"
-}
-```
-
diff --git a/doc/models/customer.md b/doc/models/customer.md
deleted file mode 100644
index 641b4709..00000000
--- a/doc/models/customer.md
+++ /dev/null
@@ -1,54 +0,0 @@
-
-# Customer
-
-Represents a Square customer profile in the Customer Directory of a Square seller.
-
-## Structure
-
-`Customer`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A unique Square-assigned ID for the customer profile.
If you need this ID for an API request, use the ID returned when you created the customer profile or call the [SearchCustomers](api-endpoint:Customers-SearchCustomers)
or [ListCustomers](api-endpoint:Customers-ListCustomers) endpoint. | getId(): ?string | setId(?string id): void |
-| `createdAt` | `?string` | Optional | The timestamp when the customer profile was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp when the customer profile was last updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `cards` | [`?(Card[])`](../../doc/models/card.md) | Optional | Payment details of the credit, debit, and gift cards stored on file for the customer profile.
DEPRECATED at version 2021-06-16 and will be RETIRED at version 2024-12-18. Replaced by calling [ListCards](api-endpoint:Cards-ListCards) (for credit and debit cards on file)
or [ListGiftCards](api-endpoint:GiftCards-ListGiftCards) (for gift cards on file) and including the `customer_id` query parameter.
For more information, see [Migration notes](https://developer.squareup.com/docs/customers-api/what-it-does#migrate-customer-cards). | getCards(): ?array | setCards(?array cards): void |
-| `givenName` | `?string` | Optional | The given name (that is, the first name) associated with the customer profile. | getGivenName(): ?string | setGivenName(?string givenName): void |
-| `familyName` | `?string` | Optional | The family name (that is, the last name) associated with the customer profile. | getFamilyName(): ?string | setFamilyName(?string familyName): void |
-| `nickname` | `?string` | Optional | A nickname for the customer profile. | getNickname(): ?string | setNickname(?string nickname): void |
-| `companyName` | `?string` | Optional | A business name associated with the customer profile. | getCompanyName(): ?string | setCompanyName(?string companyName): void |
-| `emailAddress` | `?string` | Optional | The email address associated with the customer profile. | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void |
-| `address` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getAddress(): ?Address | setAddress(?Address address): void |
-| `phoneNumber` | `?string` | Optional | The phone number associated with the customer profile. | getPhoneNumber(): ?string | setPhoneNumber(?string phoneNumber): void |
-| `birthday` | `?string` | Optional | The birthday associated with the customer profile, in `YYYY-MM-DD` format. For example, `1998-09-21`
represents September 21, 1998, and `0000-09-21` represents September 21 (without a birth year). | getBirthday(): ?string | setBirthday(?string birthday): void |
-| `referenceId` | `?string` | Optional | An optional second ID used to associate the customer profile with an
entity in another system. | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `note` | `?string` | Optional | A custom note associated with the customer profile. | getNote(): ?string | setNote(?string note): void |
-| `preferences` | [`?CustomerPreferences`](../../doc/models/customer-preferences.md) | Optional | Represents communication preferences for the customer profile. | getPreferences(): ?CustomerPreferences | setPreferences(?CustomerPreferences preferences): void |
-| `creationSource` | [`?string(CustomerCreationSource)`](../../doc/models/customer-creation-source.md) | Optional | Indicates the method used to create the customer profile. | getCreationSource(): ?string | setCreationSource(?string creationSource): void |
-| `groupIds` | `?(string[])` | Optional | The IDs of [customer groups](entity:CustomerGroup) the customer belongs to. | getGroupIds(): ?array | setGroupIds(?array groupIds): void |
-| `segmentIds` | `?(string[])` | Optional | The IDs of [customer segments](entity:CustomerSegment) the customer belongs to. | getSegmentIds(): ?array | setSegmentIds(?array segmentIds): void |
-| `version` | `?int` | Optional | The Square-assigned version number of the customer profile. The version number is incremented each time an update is committed to the customer profile, except for changes to customer segment membership and cards on file. | getVersion(): ?int | setVersion(?int version): void |
-| `taxIds` | [`?CustomerTaxIds`](../../doc/models/customer-tax-ids.md) | Optional | Represents the tax ID associated with a [customer profile](../../doc/models/customer.md). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom.
For more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). | getTaxIds(): ?CustomerTaxIds | setTaxIds(?CustomerTaxIds taxIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id8",
- "created_at": "created_at6",
- "updated_at": "updated_at6",
- "cards": [
- {
- "id": "id8",
- "card_brand": "DISCOVER",
- "last_4": "last_40",
- "exp_month": 152,
- "exp_year": 144
- }
- ],
- "given_name": "given_name0"
-}
-```
-
diff --git a/doc/models/data-collection-options-input-type.md b/doc/models/data-collection-options-input-type.md
deleted file mode 100644
index 083724f8..00000000
--- a/doc/models/data-collection-options-input-type.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Data Collection Options Input Type
-
-Describes the input type of the data.
-
-## Enumeration
-
-`DataCollectionOptionsInputType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `EMAIL` | This value is used to represent an input text that contains a email validation on the
client. |
-| `PHONE_NUMBER` | This value is used to represent an input text that contains a phone number validation on
the client. |
-
diff --git a/doc/models/data-collection-options.md b/doc/models/data-collection-options.md
deleted file mode 100644
index 5d7545a9..00000000
--- a/doc/models/data-collection-options.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Data Collection Options
-
-## Structure
-
-`DataCollectionOptions`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `title` | `string` | Required | The title text to display in the data collection flow on the Terminal.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `250` | getTitle(): string | setTitle(string title): void |
-| `body` | `string` | Required | The body text to display under the title in the data collection screen flow on the
Terminal.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `10000` | getBody(): string | setBody(string body): void |
-| `inputType` | [`string(DataCollectionOptionsInputType)`](../../doc/models/data-collection-options-input-type.md) | Required | Describes the input type of the data. | getInputType(): string | setInputType(string inputType): void |
-| `collectedData` | [`?CollectedData`](../../doc/models/collected-data.md) | Optional | - | getCollectedData(): ?CollectedData | setCollectedData(?CollectedData collectedData): void |
-
-## Example (as JSON)
-
-```json
-{
- "title": "title4",
- "body": "body4",
- "input_type": "EMAIL",
- "collected_data": {
- "input_text": "input_text0"
- }
-}
-```
-
diff --git a/doc/models/date-range.md b/doc/models/date-range.md
deleted file mode 100644
index 7239b395..00000000
--- a/doc/models/date-range.md
+++ /dev/null
@@ -1,26 +0,0 @@
-
-# Date Range
-
-A range defined by two dates. Used for filtering a query for Connect v2
-objects that have date properties.
-
-## Structure
-
-`DateRange`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `startDate` | `?string` | Optional | A string in `YYYY-MM-DD` format, such as `2017-10-31`, per the ISO 8601
extended format for calendar dates.
The beginning of a date range (inclusive). | getStartDate(): ?string | setStartDate(?string startDate): void |
-| `endDate` | `?string` | Optional | A string in `YYYY-MM-DD` format, such as `2017-10-31`, per the ISO 8601
extended format for calendar dates.
The end of a date range (inclusive). | getEndDate(): ?string | setEndDate(?string endDate): void |
-
-## Example (as JSON)
-
-```json
-{
- "start_date": "start_date0",
- "end_date": "end_date6"
-}
-```
-
diff --git a/doc/models/day-of-week.md b/doc/models/day-of-week.md
deleted file mode 100644
index 2ce16311..00000000
--- a/doc/models/day-of-week.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Day of Week
-
-Indicates the specific day of the week.
-
-## Enumeration
-
-`DayOfWeek`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `SUN` | Sunday |
-| `MON` | Monday |
-| `TUE` | Tuesday |
-| `WED` | Wednesday |
-| `THU` | Thursday |
-| `FRI` | Friday |
-| `SAT` | Saturday |
-
diff --git a/doc/models/delete-booking-custom-attribute-definition-response.md b/doc/models/delete-booking-custom-attribute-definition-response.md
deleted file mode 100644
index 8028be5b..00000000
--- a/doc/models/delete-booking-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-# Delete Booking Custom Attribute Definition Response
-
-Represents a [DeleteBookingCustomAttributeDefinition](../../doc/apis/booking-custom-attributes.md#delete-booking-custom-attribute-definition) response
-containing error messages when errors occurred during the request. The successful response does not contain any payload.
-
-## Structure
-
-`DeleteBookingCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": []
-}
-```
-
diff --git a/doc/models/delete-booking-custom-attribute-response.md b/doc/models/delete-booking-custom-attribute-response.md
deleted file mode 100644
index f0507cab..00000000
--- a/doc/models/delete-booking-custom-attribute-response.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-# Delete Booking Custom Attribute Response
-
-Represents a [DeleteBookingCustomAttribute](../../doc/apis/booking-custom-attributes.md#delete-booking-custom-attribute) response.
-Either an empty object `{}` (for a successful deletion) or `errors` is present in the response.
-
-## Structure
-
-`DeleteBookingCustomAttributeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": []
-}
-```
-
diff --git a/doc/models/delete-break-type-response.md b/doc/models/delete-break-type-response.md
deleted file mode 100644
index 475610fb..00000000
--- a/doc/models/delete-break-type-response.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Delete Break Type Response
-
-The response to a request to delete a `BreakType`. The response might contain a set
-of `Error` objects if the request resulted in errors.
-
-## Structure
-
-`DeleteBreakTypeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-catalog-object-response.md b/doc/models/delete-catalog-object-response.md
deleted file mode 100644
index 003853d9..00000000
--- a/doc/models/delete-catalog-object-response.md
+++ /dev/null
@@ -1,35 +0,0 @@
-
-# Delete Catalog Object Response
-
-## Structure
-
-`DeleteCatalogObjectResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `deletedObjectIds` | `?(string[])` | Optional | The IDs of all catalog objects deleted by this request.
Multiple IDs may be returned when associated objects are also deleted, for example
a catalog item variation will be deleted (and its ID included in this field)
when its parent catalog item is deleted. | getDeletedObjectIds(): ?array | setDeletedObjectIds(?array deletedObjectIds): void |
-| `deletedAt` | `?string` | Optional | The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
of this deletion in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. | getDeletedAt(): ?string | setDeletedAt(?string deletedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "deleted_at": "2016-11-16T22:25:24.878Z",
- "deleted_object_ids": [
- "7SB3ZQYJ5GDMVFL7JK46JCHT",
- "KQLFFHA6K6J3YQAQAWDQAL57"
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-customer-card-response.md b/doc/models/delete-customer-card-response.md
deleted file mode 100644
index e2b96019..00000000
--- a/doc/models/delete-customer-card-response.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-# Delete Customer Card Response
-
-Defines the fields that are included in the response body of
-a request to the `DeleteCustomerCard` endpoint.
-
-## Structure
-
-`DeleteCustomerCardResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-customer-custom-attribute-definition-response.md b/doc/models/delete-customer-custom-attribute-definition-response.md
deleted file mode 100644
index 5840837e..00000000
--- a/doc/models/delete-customer-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,36 +0,0 @@
-
-# Delete Customer Custom Attribute Definition Response
-
-Represents a response from a delete request containing error messages if there are any.
-
-## Structure
-
-`DeleteCustomerCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-customer-custom-attribute-response.md b/doc/models/delete-customer-custom-attribute-response.md
deleted file mode 100644
index 9999692f..00000000
--- a/doc/models/delete-customer-custom-attribute-response.md
+++ /dev/null
@@ -1,43 +0,0 @@
-
-# Delete Customer Custom Attribute Response
-
-Represents a [DeleteCustomerCustomAttribute](../../doc/apis/customer-custom-attributes.md#delete-customer-custom-attribute) response.
-Either an empty object `{}` (for a successful deletion) or `errors` is present in the response.
-
-## Structure
-
-`DeleteCustomerCustomAttributeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-customer-group-response.md b/doc/models/delete-customer-group-response.md
deleted file mode 100644
index ec3f237e..00000000
--- a/doc/models/delete-customer-group-response.md
+++ /dev/null
@@ -1,43 +0,0 @@
-
-# Delete Customer Group Response
-
-Defines the fields that are included in the response body of
-a request to the [DeleteCustomerGroup](../../doc/apis/customer-groups.md#delete-customer-group) endpoint.
-
-## Structure
-
-`DeleteCustomerGroupResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-customer-request.md b/doc/models/delete-customer-request.md
deleted file mode 100644
index 8f421988..00000000
--- a/doc/models/delete-customer-request.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-# Delete Customer Request
-
-Defines the fields that are included in a request to the `DeleteCustomer`
-endpoint.
-
-## Structure
-
-`DeleteCustomerRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `version` | `?int` | Optional | The current version of the customer profile.
As a best practice, you should include this parameter to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Delete a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#delete-customer-profile). | getVersion(): ?int | setVersion(?int version): void |
-
-## Example (as JSON)
-
-```json
-{
- "version": 222
-}
-```
-
diff --git a/doc/models/delete-customer-response.md b/doc/models/delete-customer-response.md
deleted file mode 100644
index 94922bb1..00000000
--- a/doc/models/delete-customer-response.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Delete Customer Response
-
-Defines the fields that are included in the response body of
-a request to the `DeleteCustomer` endpoint.
-
-## Structure
-
-`DeleteCustomerResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-dispute-evidence-response.md b/doc/models/delete-dispute-evidence-response.md
deleted file mode 100644
index 716903ed..00000000
--- a/doc/models/delete-dispute-evidence-response.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-# Delete Dispute Evidence Response
-
-Defines the fields in a `DeleteDisputeEvidence` response.
-
-## Structure
-
-`DeleteDisputeEvidenceResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-invoice-attachment-response.md b/doc/models/delete-invoice-attachment-response.md
deleted file mode 100644
index 2a062d42..00000000
--- a/doc/models/delete-invoice-attachment-response.md
+++ /dev/null
@@ -1,36 +0,0 @@
-
-# Delete Invoice Attachment Response
-
-Represents a [DeleteInvoiceAttachment](../../doc/apis/invoices.md#delete-invoice-attachment) response.
-
-## Structure
-
-`DeleteInvoiceAttachmentResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-invoice-request.md b/doc/models/delete-invoice-request.md
deleted file mode 100644
index 976b5622..00000000
--- a/doc/models/delete-invoice-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Delete Invoice Request
-
-Describes a `DeleteInvoice` request.
-
-## Structure
-
-`DeleteInvoiceRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `version` | `?int` | Optional | The version of the [invoice](entity:Invoice) to delete.
If you do not know the version, you can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or
[ListInvoices](api-endpoint:Invoices-ListInvoices). | getVersion(): ?int | setVersion(?int version): void |
-
-## Example (as JSON)
-
-```json
-{
- "version": 26
-}
-```
-
diff --git a/doc/models/delete-invoice-response.md b/doc/models/delete-invoice-response.md
deleted file mode 100644
index 328d1bfe..00000000
--- a/doc/models/delete-invoice-response.md
+++ /dev/null
@@ -1,36 +0,0 @@
-
-# Delete Invoice Response
-
-Describes a `DeleteInvoice` response.
-
-## Structure
-
-`DeleteInvoiceResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-location-custom-attribute-definition-response.md b/doc/models/delete-location-custom-attribute-definition-response.md
deleted file mode 100644
index a2fd2d97..00000000
--- a/doc/models/delete-location-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-# Delete Location Custom Attribute Definition Response
-
-Represents a response from a delete request containing error messages if there are any.
-
-## Structure
-
-`DeleteLocationCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-location-custom-attribute-response.md b/doc/models/delete-location-custom-attribute-response.md
deleted file mode 100644
index 1108feb7..00000000
--- a/doc/models/delete-location-custom-attribute-response.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-# Delete Location Custom Attribute Response
-
-Represents a [DeleteLocationCustomAttribute](../../doc/apis/location-custom-attributes.md#delete-location-custom-attribute) response.
-Either an empty object `{}` (for a successful deletion) or `errors` is present in the response.
-
-## Structure
-
-`DeleteLocationCustomAttributeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-loyalty-reward-response.md b/doc/models/delete-loyalty-reward-response.md
deleted file mode 100644
index c8fdb995..00000000
--- a/doc/models/delete-loyalty-reward-response.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-# Delete Loyalty Reward Response
-
-A response returned by the API call.
-
-## Structure
-
-`DeleteLoyaltyRewardResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-merchant-custom-attribute-definition-response.md b/doc/models/delete-merchant-custom-attribute-definition-response.md
deleted file mode 100644
index 5e1e57f3..00000000
--- a/doc/models/delete-merchant-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,36 +0,0 @@
-
-# Delete Merchant Custom Attribute Definition Response
-
-Represents a response from a delete request containing error messages if there are any.
-
-## Structure
-
-`DeleteMerchantCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-merchant-custom-attribute-response.md b/doc/models/delete-merchant-custom-attribute-response.md
deleted file mode 100644
index fc1f28ff..00000000
--- a/doc/models/delete-merchant-custom-attribute-response.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-# Delete Merchant Custom Attribute Response
-
-Represents a [DeleteMerchantCustomAttribute](../../doc/apis/merchant-custom-attributes.md#delete-merchant-custom-attribute) response.
-Either an empty object `{}` (for a successful deletion) or `errors` is present in the response.
-
-## Structure
-
-`DeleteMerchantCustomAttributeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-order-custom-attribute-definition-response.md b/doc/models/delete-order-custom-attribute-definition-response.md
deleted file mode 100644
index dbf45866..00000000
--- a/doc/models/delete-order-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Delete Order Custom Attribute Definition Response
-
-Represents a response from deleting an order custom attribute definition.
-
-## Structure
-
-`DeleteOrderCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-order-custom-attribute-response.md b/doc/models/delete-order-custom-attribute-response.md
deleted file mode 100644
index 2b2e368a..00000000
--- a/doc/models/delete-order-custom-attribute-response.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Delete Order Custom Attribute Response
-
-Represents a response from deleting an order custom attribute.
-
-## Structure
-
-`DeleteOrderCustomAttributeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-payment-link-response.md b/doc/models/delete-payment-link-response.md
deleted file mode 100644
index 68b8dbd0..00000000
--- a/doc/models/delete-payment-link-response.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Delete Payment Link Response
-
-## Structure
-
-`DeletePaymentLinkResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | - | getErrors(): ?array | setErrors(?array errors): void |
-| `id` | `?string` | Optional | The ID of the link that is deleted. | getId(): ?string | setId(?string id): void |
-| `cancelledOrderId` | `?string` | Optional | The ID of the order that is canceled. When a payment link is deleted, Square updates the
the `state` (of the order that the checkout link created) to CANCELED. | getCancelledOrderId(): ?string | setCancelledOrderId(?string cancelledOrderId): void |
-
-## Example (as JSON)
-
-```json
-{
- "cancelled_order_id": "asx8LgZ6MRzD0fObfkJ6obBmSh4F",
- "id": "MQASNYL6QB6DFCJ3",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-shift-response.md b/doc/models/delete-shift-response.md
deleted file mode 100644
index 6de5690a..00000000
--- a/doc/models/delete-shift-response.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Delete Shift Response
-
-The response to a request to delete a `Shift`. The response might contain a set of
-`Error` objects if the request resulted in errors.
-
-## Structure
-
-`DeleteShiftResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-snippet-response.md b/doc/models/delete-snippet-response.md
deleted file mode 100644
index 588e6c3d..00000000
--- a/doc/models/delete-snippet-response.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-# Delete Snippet Response
-
-Represents a `DeleteSnippet` response.
-
-## Structure
-
-`DeleteSnippetResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-subscription-action-response.md b/doc/models/delete-subscription-action-response.md
deleted file mode 100644
index ba2f80c1..00000000
--- a/doc/models/delete-subscription-action-response.md
+++ /dev/null
@@ -1,62 +0,0 @@
-
-# Delete Subscription Action Response
-
-Defines output parameters in a response of the [DeleteSubscriptionAction](../../doc/apis/subscriptions.md#delete-subscription-action)
-endpoint.
-
-## Structure
-
-`DeleteSubscriptionActionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `subscription` | [`?Subscription`](../../doc/models/subscription.md) | Optional | Represents a subscription purchased by a customer.
For more information, see
[Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions). | getSubscription(): ?Subscription | setSubscription(?Subscription subscription): void |
-
-## Example (as JSON)
-
-```json
-{
- "subscription": {
- "card_id": "ccof:IkWfpLj4tNHMyFii3GB",
- "charged_through_date": "2023-11-20",
- "created_at": "2022-07-27T21:53:10Z",
- "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "id": "8151fc89-da15-4eb9-a685-1a70883cebfc",
- "invoice_ids": [
- "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY",
- "inv:0-ChrcX_i3sNmfsHTGKhI4Wg2mceA"
- ],
- "location_id": "S8GWD5R9QB376",
- "paid_until_date": "2024-08-01",
- "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
- "price_override_money": {
- "amount": 25000,
- "currency": "USD"
- },
- "source": {
- "name": "My Application"
- },
- "start_date": "2022-07-27",
- "status": "ACTIVE",
- "timezone": "America/Los_Angeles"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/delete-webhook-subscription-response.md b/doc/models/delete-webhook-subscription-response.md
deleted file mode 100644
index ebd14550..00000000
--- a/doc/models/delete-webhook-subscription-response.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Delete Webhook Subscription Response
-
-Defines the fields that are included in the response body of
-a request to the [DeleteWebhookSubscription](../../doc/apis/webhook-subscriptions.md#delete-webhook-subscription) endpoint.
-
-## Structure
-
-`DeleteWebhookSubscriptionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/deprecated-create-dispute-evidence-file-request.md b/doc/models/deprecated-create-dispute-evidence-file-request.md
deleted file mode 100644
index 2bc70a9c..00000000
--- a/doc/models/deprecated-create-dispute-evidence-file-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Deprecated Create Dispute Evidence File Request
-
-Defines the parameters for a `DeprecatedCreateDisputeEvidenceFile` request.
-
-## Structure
-
-`DeprecatedCreateDisputeEvidenceFileRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | The Unique ID. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `45` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `evidenceType` | [`?string(DisputeEvidenceType)`](../../doc/models/dispute-evidence-type.md) | Optional | The type of the dispute evidence. | getEvidenceType(): ?string | setEvidenceType(?string evidenceType): void |
-| `contentType` | `?string` | Optional | The MIME type of the uploaded file.
The type can be image/heic, image/heif, image/jpeg, application/pdf, image/png, or image/tiff.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getContentType(): ?string | setContentType(?string contentType): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "idempotency_key4",
- "evidence_type": "ONLINE_OR_APP_ACCESS_LOG",
- "content_type": "content_type2"
-}
-```
-
diff --git a/doc/models/deprecated-create-dispute-evidence-file-response.md b/doc/models/deprecated-create-dispute-evidence-file-response.md
deleted file mode 100644
index ba234d9f..00000000
--- a/doc/models/deprecated-create-dispute-evidence-file-response.md
+++ /dev/null
@@ -1,43 +0,0 @@
-
-# Deprecated Create Dispute Evidence File Response
-
-Defines the fields in a `DeprecatedCreateDisputeEvidenceFile` response.
-
-## Structure
-
-`DeprecatedCreateDisputeEvidenceFileResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `evidence` | [`?DisputeEvidence`](../../doc/models/dispute-evidence.md) | Optional | - | getEvidence(): ?DisputeEvidence | setEvidence(?DisputeEvidence evidence): void |
-
-## Example (as JSON)
-
-```json
-{
- "evidence": {
- "dispute_id": "bVTprrwk0gygTLZ96VX1oB",
- "evidence_file": {
- "filename": "evidence.tiff",
- "filetype": "image/tiff"
- },
- "evidence_id": "TOomLInj6iWmP3N8qfCXrB",
- "evidence_type": "GENERIC_EVIDENCE",
- "uploaded_at": "2018-10-18T16:01:10.000Z",
- "id": "id2",
- "evidence_text": "evidence_text6"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/deprecated-create-dispute-evidence-text-request.md b/doc/models/deprecated-create-dispute-evidence-text-request.md
deleted file mode 100644
index 476e4d09..00000000
--- a/doc/models/deprecated-create-dispute-evidence-text-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Deprecated Create Dispute Evidence Text Request
-
-Defines the parameters for a `DeprecatedCreateDisputeEvidenceText` request.
-
-## Structure
-
-`DeprecatedCreateDisputeEvidenceTextRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | The Unique ID. For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `45` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `evidenceType` | [`?string(DisputeEvidenceType)`](../../doc/models/dispute-evidence-type.md) | Optional | The type of the dispute evidence. | getEvidenceType(): ?string | setEvidenceType(?string evidenceType): void |
-| `evidenceText` | `string` | Required | The evidence string.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `500` | getEvidenceText(): string | setEvidenceText(string evidenceText): void |
-
-## Example (as JSON)
-
-```json
-{
- "evidence_text": "1Z8888888888888888",
- "evidence_type": "TRACKING_NUMBER",
- "idempotency_key": "ed3ee3933d946f1514d505d173c82648"
-}
-```
-
diff --git a/doc/models/deprecated-create-dispute-evidence-text-response.md b/doc/models/deprecated-create-dispute-evidence-text-response.md
deleted file mode 100644
index c186c221..00000000
--- a/doc/models/deprecated-create-dispute-evidence-text-response.md
+++ /dev/null
@@ -1,43 +0,0 @@
-
-# Deprecated Create Dispute Evidence Text Response
-
-Defines the fields in a `DeprecatedCreateDisputeEvidenceText` response.
-
-## Structure
-
-`DeprecatedCreateDisputeEvidenceTextResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `evidence` | [`?DisputeEvidence`](../../doc/models/dispute-evidence.md) | Optional | - | getEvidence(): ?DisputeEvidence | setEvidence(?DisputeEvidence evidence): void |
-
-## Example (as JSON)
-
-```json
-{
- "evidence": {
- "dispute_id": "bVTprrwk0gygTLZ96VX1oB",
- "evidence_text": "The customer purchased the item twice, on April 11 and April 28.",
- "evidence_type": "REBUTTAL_EXPLANATION",
- "id": "TOomLInj6iWmP3N8qfCXrB",
- "uploaded_at": "2022-05-18T16:01:10.000Z",
- "evidence_id": "evidence_id0",
- "evidence_file": {
- "filename": "filename8",
- "filetype": "filetype8"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/destination-details-card-refund-details.md b/doc/models/destination-details-card-refund-details.md
deleted file mode 100644
index d22a6798..00000000
--- a/doc/models/destination-details-card-refund-details.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Destination Details Card Refund Details
-
-## Structure
-
-`DestinationDetailsCardRefundDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `card` | [`?Card`](../../doc/models/card.md) | Optional | Represents the payment details of a card to be used for payments. These
details are determined by the payment token generated by Web Payments SDK. | getCard(): ?Card | setCard(?Card card): void |
-| `entryMethod` | `?string` | Optional | The method used to enter the card's details for the refund. The method can be
`KEYED`, `SWIPED`, `EMV`, `ON_FILE`, or `CONTACTLESS`.
**Constraints**: *Maximum Length*: `50` | getEntryMethod(): ?string | setEntryMethod(?string entryMethod): void |
-| `authResultCode` | `?string` | Optional | The authorization code provided by the issuer when a refund is approved.
**Constraints**: *Maximum Length*: `10` | getAuthResultCode(): ?string | setAuthResultCode(?string authResultCode): void |
-
-## Example (as JSON)
-
-```json
-{
- "card": {
- "id": "id6",
- "card_brand": "OTHER_BRAND",
- "last_4": "last_48",
- "exp_month": 228,
- "exp_year": 68
- },
- "entry_method": "entry_method4",
- "auth_result_code": "auth_result_code6"
-}
-```
-
diff --git a/doc/models/destination-details-cash-refund-details.md b/doc/models/destination-details-cash-refund-details.md
deleted file mode 100644
index 1364858a..00000000
--- a/doc/models/destination-details-cash-refund-details.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Destination Details Cash Refund Details
-
-Stores details about a cash refund. Contains only non-confidential information.
-
-## Structure
-
-`DestinationDetailsCashRefundDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `sellerSuppliedMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getSellerSuppliedMoney(): Money | setSellerSuppliedMoney(Money sellerSuppliedMoney): void |
-| `changeBackMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getChangeBackMoney(): ?Money | setChangeBackMoney(?Money changeBackMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "seller_supplied_money": {
- "amount": 36,
- "currency": "MKD"
- },
- "change_back_money": {
- "amount": 78,
- "currency": "XBD"
- }
-}
-```
-
diff --git a/doc/models/destination-details-external-refund-details.md b/doc/models/destination-details-external-refund-details.md
deleted file mode 100644
index 7ad3bfe7..00000000
--- a/doc/models/destination-details-external-refund-details.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Destination Details External Refund Details
-
-Stores details about an external refund. Contains only non-confidential information.
-
-## Structure
-
-`DestinationDetailsExternalRefundDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `type` | `string` | Required | The type of external refund the seller paid to the buyer. It can be one of the
following:
- CHECK - Refunded using a physical check.
- BANK_TRANSFER - Refunded using external bank transfer.
- OTHER\_GIFT\_CARD - Refunded using a non-Square gift card.
- CRYPTO - Refunded using a crypto currency.
- SQUARE_CASH - Refunded using Square Cash App.
- SOCIAL - Refunded using peer-to-peer payment applications.
- EXTERNAL - A third-party application gathered this refund outside of Square.
- EMONEY - Refunded using an E-money provider.
- CARD - A credit or debit card that Square does not support.
- STORED_BALANCE - Use for house accounts, store credit, and so forth.
- FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals
- OTHER - A type not listed here.
**Constraints**: *Maximum Length*: `50` | getType(): string | setType(string type): void |
-| `source` | `string` | Required | A description of the external refund source. For example,
"Food Delivery Service".
**Constraints**: *Maximum Length*: `255` | getSource(): string | setSource(string source): void |
-| `sourceId` | `?string` | Optional | An ID to associate the refund to its originating source.
**Constraints**: *Maximum Length*: `255` | getSourceId(): ?string | setSourceId(?string sourceId): void |
-
-## Example (as JSON)
-
-```json
-{
- "type": "type4",
- "source": "source2",
- "source_id": "source_id0"
-}
-```
-
diff --git a/doc/models/destination-details.md b/doc/models/destination-details.md
deleted file mode 100644
index 58a4cab5..00000000
--- a/doc/models/destination-details.md
+++ /dev/null
@@ -1,50 +0,0 @@
-
-# Destination Details
-
-Details about a refund's destination.
-
-## Structure
-
-`DestinationDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cardDetails` | [`?DestinationDetailsCardRefundDetails`](../../doc/models/destination-details-card-refund-details.md) | Optional | - | getCardDetails(): ?DestinationDetailsCardRefundDetails | setCardDetails(?DestinationDetailsCardRefundDetails cardDetails): void |
-| `cashDetails` | [`?DestinationDetailsCashRefundDetails`](../../doc/models/destination-details-cash-refund-details.md) | Optional | Stores details about a cash refund. Contains only non-confidential information. | getCashDetails(): ?DestinationDetailsCashRefundDetails | setCashDetails(?DestinationDetailsCashRefundDetails cashDetails): void |
-| `externalDetails` | [`?DestinationDetailsExternalRefundDetails`](../../doc/models/destination-details-external-refund-details.md) | Optional | Stores details about an external refund. Contains only non-confidential information. | getExternalDetails(): ?DestinationDetailsExternalRefundDetails | setExternalDetails(?DestinationDetailsExternalRefundDetails externalDetails): void |
-
-## Example (as JSON)
-
-```json
-{
- "card_details": {
- "card": {
- "id": "id6",
- "card_brand": "OTHER_BRAND",
- "last_4": "last_48",
- "exp_month": 228,
- "exp_year": 68
- },
- "entry_method": "entry_method8",
- "auth_result_code": "auth_result_code0"
- },
- "cash_details": {
- "seller_supplied_money": {
- "amount": 36,
- "currency": "MKD"
- },
- "change_back_money": {
- "amount": 78,
- "currency": "XBD"
- }
- },
- "external_details": {
- "type": "type6",
- "source": "source0",
- "source_id": "source_id8"
- }
-}
-```
-
diff --git a/doc/models/destination-type.md b/doc/models/destination-type.md
deleted file mode 100644
index f1d7bddd..00000000
--- a/doc/models/destination-type.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# Destination Type
-
-List of possible destinations against which a payout can be made.
-
-## Enumeration
-
-`DestinationType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `BANK_ACCOUNT` | An external bank account outside of Square. |
-| `CARD` | An external card outside of Square used for the transfer. |
-| `SQUARE_BALANCE` | |
-| `SQUARE_STORED_BALANCE` | Square Checking or Savings account (US), Square Card (CA) |
-
diff --git a/doc/models/destination.md b/doc/models/destination.md
deleted file mode 100644
index 5e0ef8dc..00000000
--- a/doc/models/destination.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Destination
-
-Information about the destination against which the payout was made.
-
-## Structure
-
-`Destination`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `type` | [`?string(DestinationType)`](../../doc/models/destination-type.md) | Optional | List of possible destinations against which a payout can be made. | getType(): ?string | setType(?string type): void |
-| `id` | `?string` | Optional | Square issued unique ID (also known as the instrument ID) associated with this destination. | getId(): ?string | setId(?string id): void |
-
-## Example (as JSON)
-
-```json
-{
- "type": "SQUARE_BALANCE",
- "id": "id6"
-}
-```
-
diff --git a/doc/models/device-attributes-device-type.md b/doc/models/device-attributes-device-type.md
deleted file mode 100644
index 19c965a2..00000000
--- a/doc/models/device-attributes-device-type.md
+++ /dev/null
@@ -1,15 +0,0 @@
-
-# Device Attributes Device Type
-
-An enum identifier of the device type.
-
-## Enumeration
-
-`DeviceAttributesDeviceType`
-
-## Fields
-
-| Name |
-| --- |
-| `TERMINAL` |
-
diff --git a/doc/models/device-attributes.md b/doc/models/device-attributes.md
deleted file mode 100644
index d2c544a3..00000000
--- a/doc/models/device-attributes.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Device Attributes
-
-## Structure
-
-`DeviceAttributes`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `type` | `string` | Required, Constant | An enum identifier of the device type.
**Default**: `'TERMINAL'` | getType(): string | setType(string type): void |
-| `manufacturer` | `string` | Required | The maker of the device. | getManufacturer(): string | setManufacturer(string manufacturer): void |
-| `model` | `?string` | Optional | The specific model of the device. | getModel(): ?string | setModel(?string model): void |
-| `name` | `?string` | Optional | A seller-specified name for the device. | getName(): ?string | setName(?string name): void |
-| `manufacturersId` | `?string` | Optional | The manufacturer-supplied identifier for the device (where available). In many cases,
this identifier will be a serial number. | getManufacturersId(): ?string | setManufacturersId(?string manufacturersId): void |
-| `updatedAt` | `?string` | Optional | The RFC 3339-formatted value of the most recent update to the device information.
(Could represent any field update on the device.) | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `version` | `?string` | Optional | The current version of software installed on the device. | getVersion(): ?string | setVersion(?string version): void |
-| `merchantToken` | `?string` | Optional | The merchant_token identifying the merchant controlling the device. | getMerchantToken(): ?string | setMerchantToken(?string merchantToken): void |
-
-## Example (as JSON)
-
-```json
-{
- "type": "TERMINAL",
- "manufacturer": "manufacturer0",
- "model": "model4",
- "name": "name6",
- "manufacturers_id": "manufacturers_id2",
- "updated_at": "updated_at2",
- "version": "version2"
-}
-```
-
diff --git a/doc/models/device-checkout-options.md b/doc/models/device-checkout-options.md
deleted file mode 100644
index 38d798f7..00000000
--- a/doc/models/device-checkout-options.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-# Device Checkout Options
-
-## Structure
-
-`DeviceCheckoutOptions`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `deviceId` | `string` | Required | The unique ID of the device intended for this `TerminalCheckout`.
A list of `DeviceCode` objects can be retrieved from the /v2/devices/codes endpoint.
Match a `DeviceCode.device_id` value with `device_id` to get the associated device code. | getDeviceId(): string | setDeviceId(string deviceId): void |
-| `skipReceiptScreen` | `?bool` | Optional | Instructs the device to skip the receipt screen. Defaults to false. | getSkipReceiptScreen(): ?bool | setSkipReceiptScreen(?bool skipReceiptScreen): void |
-| `collectSignature` | `?bool` | Optional | Indicates that signature collection is desired during checkout. Defaults to false. | getCollectSignature(): ?bool | setCollectSignature(?bool collectSignature): void |
-| `tipSettings` | [`?TipSettings`](../../doc/models/tip-settings.md) | Optional | - | getTipSettings(): ?TipSettings | setTipSettings(?TipSettings tipSettings): void |
-| `showItemizedCart` | `?bool` | Optional | Show the itemization screen prior to taking a payment. This field is only meaningful when the
checkout includes an order ID. Defaults to true. | getShowItemizedCart(): ?bool | setShowItemizedCart(?bool showItemizedCart): void |
-
-## Example (as JSON)
-
-```json
-{
- "device_id": "device_id4",
- "skip_receipt_screen": false,
- "collect_signature": false,
- "tip_settings": {
- "allow_tipping": false,
- "separate_tip_screen": false,
- "custom_tip_field": false,
- "tip_percentages": [
- 48
- ],
- "smart_tipping": false
- },
- "show_itemized_cart": false
-}
-```
-
diff --git a/doc/models/device-code-status.md b/doc/models/device-code-status.md
deleted file mode 100644
index 84f9da02..00000000
--- a/doc/models/device-code-status.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# Device Code Status
-
-DeviceCode.Status enum.
-
-## Enumeration
-
-`DeviceCodeStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `UNKNOWN` | The status cannot be determined or does not exist. |
-| `UNPAIRED` | The device code is just created and unpaired. |
-| `PAIRED` | The device code has been signed in and paired to a device. |
-| `EXPIRED` | The device code was unpaired and expired before it was paired. |
-
diff --git a/doc/models/device-code.md b/doc/models/device-code.md
deleted file mode 100644
index e0987c9c..00000000
--- a/doc/models/device-code.md
+++ /dev/null
@@ -1,36 +0,0 @@
-
-# Device Code
-
-## Structure
-
-`DeviceCode`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The unique id for this device code. | getId(): ?string | setId(?string id): void |
-| `name` | `?string` | Optional | An optional user-defined name for the device code.
**Constraints**: *Maximum Length*: `128` | getName(): ?string | setName(?string name): void |
-| `code` | `?string` | Optional | The unique code that can be used to login. | getCode(): ?string | setCode(?string code): void |
-| `deviceId` | `?string` | Optional | The unique id of the device that used this code. Populated when the device is paired up. | getDeviceId(): ?string | setDeviceId(?string deviceId): void |
-| `productType` | `string` | Required, Constant | **Default**: `'TERMINAL_API'` | getProductType(): string | setProductType(string productType): void |
-| `locationId` | `?string` | Optional | The location assigned to this code.
**Constraints**: *Maximum Length*: `50` | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `status` | [`?string(DeviceCodeStatus)`](../../doc/models/device-code-status.md) | Optional | DeviceCode.Status enum. | getStatus(): ?string | setStatus(?string status): void |
-| `pairBy` | `?string` | Optional | When this DeviceCode will expire and no longer login. Timestamp in RFC 3339 format. | getPairBy(): ?string | setPairBy(?string pairBy): void |
-| `createdAt` | `?string` | Optional | When this DeviceCode was created. Timestamp in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `statusChangedAt` | `?string` | Optional | When this DeviceCode's status was last changed. Timestamp in RFC 3339 format. | getStatusChangedAt(): ?string | setStatusChangedAt(?string statusChangedAt): void |
-| `pairedAt` | `?string` | Optional | When this DeviceCode was paired. Timestamp in RFC 3339 format. | getPairedAt(): ?string | setPairedAt(?string pairedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "product_type": "TERMINAL_API",
- "id": "id4",
- "name": "name4",
- "code": "code2",
- "device_id": "device_id0",
- "location_id": "location_id8"
-}
-```
-
diff --git a/doc/models/device-component-details-application-details.md b/doc/models/device-component-details-application-details.md
deleted file mode 100644
index e1a7a2cb..00000000
--- a/doc/models/device-component-details-application-details.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Device Component Details Application Details
-
-## Structure
-
-`DeviceComponentDetailsApplicationDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `applicationType` | [`?string(ApplicationType)`](../../doc/models/application-type.md) | Optional | - | getApplicationType(): ?string | setApplicationType(?string applicationType): void |
-| `version` | `?string` | Optional | The version of the application. | getVersion(): ?string | setVersion(?string version): void |
-| `sessionLocation` | `?string` | Optional | The location_id of the session for the application. | getSessionLocation(): ?string | setSessionLocation(?string sessionLocation): void |
-| `deviceCodeId` | `?string` | Optional | The id of the device code that was used to log in to the device. | getDeviceCodeId(): ?string | setDeviceCodeId(?string deviceCodeId): void |
-
-## Example (as JSON)
-
-```json
-{
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
-}
-```
-
diff --git a/doc/models/device-component-details-battery-details.md b/doc/models/device-component-details-battery-details.md
deleted file mode 100644
index 06cdf295..00000000
--- a/doc/models/device-component-details-battery-details.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Device Component Details Battery Details
-
-## Structure
-
-`DeviceComponentDetailsBatteryDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `visiblePercent` | `?int` | Optional | The battery charge percentage as displayed on the device. | getVisiblePercent(): ?int | setVisiblePercent(?int visiblePercent): void |
-| `externalPower` | [`?string(DeviceComponentDetailsExternalPower)`](../../doc/models/device-component-details-external-power.md) | Optional | An enum for ExternalPower. | getExternalPower(): ?string | setExternalPower(?string externalPower): void |
-
-## Example (as JSON)
-
-```json
-{
- "visible_percent": 48,
- "external_power": "AVAILABLE_CHARGING"
-}
-```
-
diff --git a/doc/models/device-component-details-card-reader-details.md b/doc/models/device-component-details-card-reader-details.md
deleted file mode 100644
index 5bd610a7..00000000
--- a/doc/models/device-component-details-card-reader-details.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Device Component Details Card Reader Details
-
-## Structure
-
-`DeviceComponentDetailsCardReaderDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `version` | `?string` | Optional | The version of the card reader. | getVersion(): ?string | setVersion(?string version): void |
-
-## Example (as JSON)
-
-```json
-{
- "version": "version8"
-}
-```
-
diff --git a/doc/models/device-component-details-ethernet-details.md b/doc/models/device-component-details-ethernet-details.md
deleted file mode 100644
index 2fe4e83f..00000000
--- a/doc/models/device-component-details-ethernet-details.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Device Component Details Ethernet Details
-
-## Structure
-
-`DeviceComponentDetailsEthernetDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `active` | `?bool` | Optional | A boolean to represent whether the Ethernet interface is currently active. | getActive(): ?bool | setActive(?bool active): void |
-| `ipAddressV4` | `?string` | Optional | The string representation of the device’s IPv4 address. | getIpAddressV4(): ?string | setIpAddressV4(?string ipAddressV4): void |
-
-## Example (as JSON)
-
-```json
-{
- "active": false,
- "ip_address_v4": "ip_address_v46"
-}
-```
-
diff --git a/doc/models/device-component-details-external-power.md b/doc/models/device-component-details-external-power.md
deleted file mode 100644
index 713c92ae..00000000
--- a/doc/models/device-component-details-external-power.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# Device Component Details External Power
-
-An enum for ExternalPower.
-
-## Enumeration
-
-`DeviceComponentDetailsExternalPower`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `AVAILABLE_CHARGING` | Plugged in and charging. |
-| `AVAILABLE_NOT_IN_USE` | Fully charged. |
-| `UNAVAILABLE` | On battery power. |
-| `AVAILABLE_INSUFFICIENT` | Not providing enough power for the device. |
-
diff --git a/doc/models/device-component-details-measurement.md b/doc/models/device-component-details-measurement.md
deleted file mode 100644
index b9ce2fa7..00000000
--- a/doc/models/device-component-details-measurement.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Device Component Details Measurement
-
-A value qualified by unit of measure.
-
-## Structure
-
-`DeviceComponentDetailsMeasurement`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `value` | `?int` | Optional | - | getValue(): ?int | setValue(?int value): void |
-
-## Example (as JSON)
-
-```json
-{
- "value": 132
-}
-```
-
diff --git a/doc/models/device-component-details-network-interface-details.md b/doc/models/device-component-details-network-interface-details.md
deleted file mode 100644
index c37c4260..00000000
--- a/doc/models/device-component-details-network-interface-details.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Device Component Details Network Interface Details
-
-## Structure
-
-`DeviceComponentDetailsNetworkInterfaceDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `ipAddressV4` | `?string` | Optional | The string representation of the device’s IPv4 address. | getIpAddressV4(): ?string | setIpAddressV4(?string ipAddressV4): void |
-
-## Example (as JSON)
-
-```json
-{
- "ip_address_v4": "ip_address_v46"
-}
-```
-
diff --git a/doc/models/device-component-details-wi-fi-details.md b/doc/models/device-component-details-wi-fi-details.md
deleted file mode 100644
index cb37f31f..00000000
--- a/doc/models/device-component-details-wi-fi-details.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Device Component Details Wi Fi Details
-
-## Structure
-
-`DeviceComponentDetailsWiFiDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `active` | `?bool` | Optional | A boolean to represent whether the WiFI interface is currently active. | getActive(): ?bool | setActive(?bool active): void |
-| `ssid` | `?string` | Optional | The name of the connected WIFI network. | getSsid(): ?string | setSsid(?string ssid): void |
-| `ipAddressV4` | `?string` | Optional | The string representation of the device’s IPv4 address. | getIpAddressV4(): ?string | setIpAddressV4(?string ipAddressV4): void |
-| `secureConnection` | `?string` | Optional | The security protocol for a secure connection (e.g. WPA2). None provided if the connection
is unsecured. | getSecureConnection(): ?string | setSecureConnection(?string secureConnection): void |
-| `signalStrength` | [`?DeviceComponentDetailsMeasurement`](../../doc/models/device-component-details-measurement.md) | Optional | A value qualified by unit of measure. | getSignalStrength(): ?DeviceComponentDetailsMeasurement | setSignalStrength(?DeviceComponentDetailsMeasurement signalStrength): void |
-
-## Example (as JSON)
-
-```json
-{
- "active": false,
- "ssid": "ssid6",
- "ip_address_v4": "ip_address_v40",
- "secure_connection": "secure_connection6",
- "signal_strength": {
- "value": 222
- }
-}
-```
-
diff --git a/doc/models/device-details.md b/doc/models/device-details.md
deleted file mode 100644
index d32194af..00000000
--- a/doc/models/device-details.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Device Details
-
-Details about the device that took the payment.
-
-## Structure
-
-`DeviceDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `deviceId` | `?string` | Optional | The Square-issued ID of the device.
**Constraints**: *Maximum Length*: `255` | getDeviceId(): ?string | setDeviceId(?string deviceId): void |
-| `deviceInstallationId` | `?string` | Optional | The Square-issued installation ID for the device.
**Constraints**: *Maximum Length*: `255` | getDeviceInstallationId(): ?string | setDeviceInstallationId(?string deviceInstallationId): void |
-| `deviceName` | `?string` | Optional | The name of the device set by the seller.
**Constraints**: *Maximum Length*: `255` | getDeviceName(): ?string | setDeviceName(?string deviceName): void |
-
-## Example (as JSON)
-
-```json
-{
- "device_id": "device_id0",
- "device_installation_id": "device_installation_id2",
- "device_name": "device_name2"
-}
-```
-
diff --git a/doc/models/device-metadata.md b/doc/models/device-metadata.md
deleted file mode 100644
index 3aad13a7..00000000
--- a/doc/models/device-metadata.md
+++ /dev/null
@@ -1,36 +0,0 @@
-
-# Device Metadata
-
-## Structure
-
-`DeviceMetadata`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `batteryPercentage` | `?string` | Optional | The Terminal’s remaining battery percentage, between 1-100. | getBatteryPercentage(): ?string | setBatteryPercentage(?string batteryPercentage): void |
-| `chargingState` | `?string` | Optional | The current charging state of the Terminal.
Options: `CHARGING`, `NOT_CHARGING` | getChargingState(): ?string | setChargingState(?string chargingState): void |
-| `locationId` | `?string` | Optional | The ID of the Square seller business location associated with the Terminal. | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `merchantId` | `?string` | Optional | The ID of the Square merchant account that is currently signed-in to the Terminal. | getMerchantId(): ?string | setMerchantId(?string merchantId): void |
-| `networkConnectionType` | `?string` | Optional | The Terminal’s current network connection type.
Options: `WIFI`, `ETHERNET` | getNetworkConnectionType(): ?string | setNetworkConnectionType(?string networkConnectionType): void |
-| `paymentRegion` | `?string` | Optional | The country in which the Terminal is authorized to take payments. | getPaymentRegion(): ?string | setPaymentRegion(?string paymentRegion): void |
-| `serialNumber` | `?string` | Optional | The unique identifier assigned to the Terminal, which can be found on the lower back
of the device. | getSerialNumber(): ?string | setSerialNumber(?string serialNumber): void |
-| `osVersion` | `?string` | Optional | The current version of the Terminal’s operating system. | getOsVersion(): ?string | setOsVersion(?string osVersion): void |
-| `appVersion` | `?string` | Optional | The current version of the application running on the Terminal. | getAppVersion(): ?string | setAppVersion(?string appVersion): void |
-| `wifiNetworkName` | `?string` | Optional | The name of the Wi-Fi network to which the Terminal is connected. | getWifiNetworkName(): ?string | setWifiNetworkName(?string wifiNetworkName): void |
-| `wifiNetworkStrength` | `?string` | Optional | The signal strength of the Wi-FI network connection.
Options: `POOR`, `FAIR`, `GOOD`, `EXCELLENT` | getWifiNetworkStrength(): ?string | setWifiNetworkStrength(?string wifiNetworkStrength): void |
-| `ipAddress` | `?string` | Optional | The IP address of the Terminal. | getIpAddress(): ?string | setIpAddress(?string ipAddress): void |
-
-## Example (as JSON)
-
-```json
-{
- "battery_percentage": "battery_percentage4",
- "charging_state": "charging_state6",
- "location_id": "location_id2",
- "merchant_id": "merchant_id8",
- "network_connection_type": "network_connection_type8"
-}
-```
-
diff --git a/doc/models/device-status-category.md b/doc/models/device-status-category.md
deleted file mode 100644
index 96ca1c67..00000000
--- a/doc/models/device-status-category.md
+++ /dev/null
@@ -1,15 +0,0 @@
-
-# Device Status Category
-
-## Enumeration
-
-`DeviceStatusCategory`
-
-## Fields
-
-| Name |
-| --- |
-| `AVAILABLE` |
-| `NEEDS_ATTENTION` |
-| `OFFLINE` |
-
diff --git a/doc/models/device-status.md b/doc/models/device-status.md
deleted file mode 100644
index 936a5898..00000000
--- a/doc/models/device-status.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Device Status
-
-## Structure
-
-`DeviceStatus`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `category` | [`?string(DeviceStatusCategory)`](../../doc/models/device-status-category.md) | Optional | - | getCategory(): ?string | setCategory(?string category): void |
-
-## Example (as JSON)
-
-```json
-{
- "category": "NEEDS_ATTENTION"
-}
-```
-
diff --git a/doc/models/device.md b/doc/models/device.md
deleted file mode 100644
index b8ecb4a8..00000000
--- a/doc/models/device.md
+++ /dev/null
@@ -1,125 +0,0 @@
-
-# Device
-
-## Structure
-
-`Device`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A synthetic identifier for the device. The identifier includes a standardized prefix and
is otherwise an opaque id generated from key device fields. | getId(): ?string | setId(?string id): void |
-| `attributes` | [`DeviceAttributes`](../../doc/models/device-attributes.md) | Required | - | getAttributes(): DeviceAttributes | setAttributes(DeviceAttributes attributes): void |
-| `components` | [`?(Component[])`](../../doc/models/component.md) | Optional | A list of components applicable to the device. | getComponents(): ?array | setComponents(?array components): void |
-| `status` | [`?DeviceStatus`](../../doc/models/device-status.md) | Optional | - | getStatus(): ?DeviceStatus | setStatus(?DeviceStatus status): void |
-
-## Example (as JSON)
-
-```json
-{
- "attributes": {
- "type": "TERMINAL",
- "manufacturer": "manufacturer2",
- "model": "model2",
- "name": "name4",
- "manufacturers_id": "manufacturers_id0",
- "updated_at": "updated_at0",
- "version": "version0"
- },
- "id": "id0",
- "components": [
- {
- "type": "BATTERY",
- "application_details": {
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
- },
- "card_reader_details": {
- "version": "version0"
- },
- "battery_details": {
- "visible_percent": 108,
- "external_power": "AVAILABLE_CHARGING"
- },
- "wifi_details": {
- "active": false,
- "ssid": "ssid8",
- "ip_address_v4": "ip_address_v42",
- "secure_connection": "secure_connection8",
- "signal_strength": {
- "value": 222
- }
- },
- "ethernet_details": {
- "active": false,
- "ip_address_v4": "ip_address_v42"
- }
- },
- {
- "type": "BATTERY",
- "application_details": {
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
- },
- "card_reader_details": {
- "version": "version0"
- },
- "battery_details": {
- "visible_percent": 108,
- "external_power": "AVAILABLE_CHARGING"
- },
- "wifi_details": {
- "active": false,
- "ssid": "ssid8",
- "ip_address_v4": "ip_address_v42",
- "secure_connection": "secure_connection8",
- "signal_strength": {
- "value": 222
- }
- },
- "ethernet_details": {
- "active": false,
- "ip_address_v4": "ip_address_v42"
- }
- },
- {
- "type": "BATTERY",
- "application_details": {
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
- },
- "card_reader_details": {
- "version": "version0"
- },
- "battery_details": {
- "visible_percent": 108,
- "external_power": "AVAILABLE_CHARGING"
- },
- "wifi_details": {
- "active": false,
- "ssid": "ssid8",
- "ip_address_v4": "ip_address_v42",
- "secure_connection": "secure_connection8",
- "signal_strength": {
- "value": 222
- }
- },
- "ethernet_details": {
- "active": false,
- "ip_address_v4": "ip_address_v42"
- }
- }
- ],
- "status": {
- "category": "AVAILABLE"
- }
-}
-```
-
diff --git a/doc/models/digital-wallet-details.md b/doc/models/digital-wallet-details.md
deleted file mode 100644
index 9f60caae..00000000
--- a/doc/models/digital-wallet-details.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Digital Wallet Details
-
-Additional details about `WALLET` type payments. Contains only non-confidential information.
-
-## Structure
-
-`DigitalWalletDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `status` | `?string` | Optional | The status of the `WALLET` payment. The status can be `AUTHORIZED`, `CAPTURED`, `VOIDED`, or
`FAILED`.
**Constraints**: *Maximum Length*: `50` | getStatus(): ?string | setStatus(?string status): void |
-| `brand` | `?string` | Optional | The brand used for the `WALLET` payment. The brand can be `CASH_APP`, `PAYPAY`, `ALIPAY`,
`RAKUTEN_PAY`, `AU_PAY`, `D_BARAI`, `MERPAY`, `WECHAT_PAY` or `UNKNOWN`.
**Constraints**: *Maximum Length*: `50` | getBrand(): ?string | setBrand(?string brand): void |
-| `cashAppDetails` | [`?CashAppDetails`](../../doc/models/cash-app-details.md) | Optional | Additional details about `WALLET` type payments with the `brand` of `CASH_APP`. | getCashAppDetails(): ?CashAppDetails | setCashAppDetails(?CashAppDetails cashAppDetails): void |
-
-## Example (as JSON)
-
-```json
-{
- "status": "status4",
- "brand": "brand8",
- "cash_app_details": {
- "buyer_full_name": "buyer_full_name2",
- "buyer_country_code": "buyer_country_code8",
- "buyer_cashtag": "buyer_cashtag4"
- }
-}
-```
-
diff --git a/doc/models/disable-card-response.md b/doc/models/disable-card-response.md
deleted file mode 100644
index bd773347..00000000
--- a/doc/models/disable-card-response.md
+++ /dev/null
@@ -1,66 +0,0 @@
-
-# Disable Card Response
-
-Defines the fields that are included in the response body of
-a request to the [DisableCard](../../doc/apis/cards.md#disable-card) endpoint.
-
-Note: if there are errors processing the request, the card field will not be
-present.
-
-## Structure
-
-`DisableCardResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `card` | [`?Card`](../../doc/models/card.md) | Optional | Represents the payment details of a card to be used for payments. These
details are determined by the payment token generated by Web Payments SDK. | getCard(): ?Card | setCard(?Card card): void |
-
-## Example (as JSON)
-
-```json
-{
- "card": {
- "billing_address": {
- "address_line_1": "500 Electric Ave",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "NY",
- "country": "US",
- "locality": "New York",
- "postal_code": "10003"
- },
- "bin": "411111",
- "card_brand": "VISA",
- "card_type": "CREDIT",
- "cardholder_name": "Amelia Earhart",
- "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8",
- "enabled": false,
- "exp_month": 11,
- "exp_year": 2022,
- "fingerprint": "ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q",
- "id": "ccof:uIbfJXhXETSP197M3GB",
- "last_4": "1111",
- "merchant_id": "6SSW7HV8K2ST5",
- "prepaid_type": "NOT_PREPAID",
- "reference_id": "user-id-1",
- "version": 2
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/disable-events-response.md b/doc/models/disable-events-response.md
deleted file mode 100644
index 5db137a5..00000000
--- a/doc/models/disable-events-response.md
+++ /dev/null
@@ -1,40 +0,0 @@
-
-# Disable Events Response
-
-Defines the fields that are included in the response body of
-a request to the [DisableEvents](../../doc/apis/events.md#disable-events) endpoint.
-
-Note: if there are errors processing the request, the events field will not be
-present.
-
-## Structure
-
-`DisableEventsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/dismiss-terminal-action-response.md b/doc/models/dismiss-terminal-action-response.md
deleted file mode 100644
index 7de9a7a9..00000000
--- a/doc/models/dismiss-terminal-action-response.md
+++ /dev/null
@@ -1,63 +0,0 @@
-
-# Dismiss Terminal Action Response
-
-## Structure
-
-`DismissTerminalActionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `action` | [`?TerminalAction`](../../doc/models/terminal-action.md) | Optional | Represents an action processed by the Square Terminal. | getAction(): ?TerminalAction | setAction(?TerminalAction action): void |
-
-## Example (as JSON)
-
-```json
-{
- "action": {
- "app_id": "APP_ID",
- "await_next_action": true,
- "await_next_action_duration": "PT5M",
- "confirmation_options": {
- "agree_button_text": "Agree",
- "body": "I agree to receive promotional emails about future events and activities.",
- "decision": {
- "has_agreed": true
- },
- "disagree_button_text": "Decline",
- "title": "Marketing communications"
- },
- "created_at": "2021-07-28T23:22:07.476Z",
- "deadline_duration": "PT5M",
- "device_id": "DEVICE_ID",
- "id": "termapia:abcdefg1234567",
- "status": "COMPLETED",
- "type": "CONFIRMATION",
- "updated_at": "2021-07-28T23:22:29.511Z",
- "cancel_reason": "TIMED_OUT"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/dismiss-terminal-checkout-response.md b/doc/models/dismiss-terminal-checkout-response.md
deleted file mode 100644
index 260302a0..00000000
--- a/doc/models/dismiss-terminal-checkout-response.md
+++ /dev/null
@@ -1,76 +0,0 @@
-
-# Dismiss Terminal Checkout Response
-
-## Structure
-
-`DismissTerminalCheckoutResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `checkout` | [`?TerminalCheckout`](../../doc/models/terminal-checkout.md) | Optional | Represents a checkout processed by the Square Terminal. | getCheckout(): ?TerminalCheckout | setCheckout(?TerminalCheckout checkout): void |
-
-## Example (as JSON)
-
-```json
-{
- "checkout": {
- "amount_money": {
- "amount": 2610,
- "currency": "USD"
- },
- "app_id": "APP_ID",
- "created_at": "2023-11-29T14:59:50.682Z",
- "deadline_duration": "PT5M",
- "device_options": {
- "collect_signature": true,
- "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003",
- "loyalty_settings": {
- "loyalty_screen_max_display_duration": "PT60S",
- "show_card_linked_reward_redemption_screen": false,
- "show_loyalty_screen": false,
- "show_non_qualifying_loyalty_screen": false
- },
- "skip_receipt_screen": false,
- "tip_settings": {
- "allow_tipping": true,
- "custom_tip_field": false,
- "separate_tip_screen": true,
- "tip_percentages": [
- 48
- ],
- "smart_tipping": false
- },
- "show_itemized_cart": false
- },
- "id": "LmZEKbo3SBfqO",
- "location_id": "LOCATION_ID",
- "payment_ids": [
- "D7vLJqMkvSoAlX4yyFzUitOy4EPZY"
- ],
- "payment_options": {
- "autocomplete": true,
- "delay_duration": "delay_duration2",
- "accept_partial_authorization": false,
- "delay_action": "CANCEL"
- },
- "payment_type": "CARD_PRESENT",
- "status": "COMPLETED",
- "updated_at": "2023-11-29T15:00:18.936Z",
- "reference_id": "reference_id0",
- "note": "note8",
- "order_id": "order_id6"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/dismiss-terminal-refund-response.md b/doc/models/dismiss-terminal-refund-response.md
deleted file mode 100644
index eebe2a54..00000000
--- a/doc/models/dismiss-terminal-refund-response.md
+++ /dev/null
@@ -1,92 +0,0 @@
-
-# Dismiss Terminal Refund Response
-
-## Structure
-
-`DismissTerminalRefundResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `refund` | [`?TerminalRefund`](../../doc/models/terminal-refund.md) | Optional | Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds. | getRefund(): ?TerminalRefund | setRefund(?TerminalRefund refund): void |
-
-## Example (as JSON)
-
-```json
-{
- "refund": {
- "amount_money": {
- "amount": 111,
- "currency": "CAD"
- },
- "app_id": "APP_ID",
- "card": {
- "bin": "411111",
- "card_brand": "VISA",
- "card_type": "DEBIT",
- "exp_month": 12,
- "exp_year": 2024,
- "fingerprint": "sq-1-ElNeDpZZqUBNDI7yNghyKO-o0yLXASp4qQDGIPtxnFvTTWoqdfdP6TV8gLsSxoztXA",
- "last_4": "1111",
- "prepaid_type": "NOT_PREPAID"
- },
- "card_details": {
- "auth_result_code": "RNy6Lf",
- "avs_status": "AVS_ACCEPTED",
- "card": {
- "bin": "411111",
- "card_brand": "VISA",
- "card_type": "DEBIT",
- "exp_month": 12,
- "exp_year": 2024,
- "fingerprint": "sq-1-ElNeDpZZqUBNDI7yNghyKO-o0yLXASp3qQDGIPtxnFvTTWoqdfdP6TV9gLsSxoztXA",
- "last_4": "1111",
- "prepaid_type": "NOT_PREPAID"
- },
- "card_payment_timeline": {
- "authorized_at": "2023-11-30T16:15:06.645Z",
- "captured_at": "2023-11-30T16:15:13.272Z"
- },
- "cvv_status": "CVV_ACCEPTED",
- "device_details": {
- "device_credential": {
- "name": "Terminal API Device created on Nov 2, 2023",
- "token": "9BFDXEYKB7H8Y"
- },
- "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291",
- "device_installation_id": "0ef67d8e-61a3-4418-a0be-c143bfe6108d"
- },
- "entry_method": "SWIPED",
- "statement_description": "SQ TREATS",
- "status": "CAPTURED"
- },
- "created_at": "2023-11-30T16:16:39.299Z",
- "deadline_duration": "PT5M",
- "device_id": "47776348fd8b32b9",
- "id": "vjkNb2HD-xq5kiWWiJ7RhwrQnkxIn2N0l1nPZY",
- "order_id": "s8OMhQcpEp1b61YywlccSHWqUaQZY",
- "payment_id": "xq5kiWWiJ7RhwrQnkxIn2N0l1nPZY",
- "reason": "Returning item",
- "status": "IN_PROGRESS",
- "updated_at": "2023-11-30T16:16:57.863Z",
- "refund_id": "refund_id2"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/dispute-evidence-file.md b/doc/models/dispute-evidence-file.md
deleted file mode 100644
index c055bf74..00000000
--- a/doc/models/dispute-evidence-file.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Dispute Evidence File
-
-A file to be uploaded as dispute evidence.
-
-## Structure
-
-`DisputeEvidenceFile`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `filename` | `?string` | Optional | The file name including the file extension. For example: "receipt.tiff".
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getFilename(): ?string | setFilename(?string filename): void |
-| `filetype` | `?string` | Optional | Dispute evidence files must be application/pdf, image/heic, image/heif, image/jpeg, image/png, or image/tiff formats.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getFiletype(): ?string | setFiletype(?string filetype): void |
-
-## Example (as JSON)
-
-```json
-{
- "filename": "filename0",
- "filetype": "filetype0"
-}
-```
-
diff --git a/doc/models/dispute-evidence-type.md b/doc/models/dispute-evidence-type.md
deleted file mode 100644
index 9808a2a3..00000000
--- a/doc/models/dispute-evidence-type.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Dispute Evidence Type
-
-The type of the dispute evidence.
-
-## Enumeration
-
-`DisputeEvidenceType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `GENERIC_EVIDENCE` | Square assumes this evidence type if you do not provide a type when uploading evidence.
Use when uploading evidence as a file or string. |
-| `ONLINE_OR_APP_ACCESS_LOG` | Server or activity logs that show proof of the cardholder’s identity and that the
cardholder successfully ordered and received the goods (digitally or otherwise).
Example evidence includes IP addresses, corresponding timestamps/dates, cardholder’s name and email
address linked to a cardholder profile held by the seller, proof the same device and card (used
in dispute) were previously used in prior undisputed transaction, and any related detailed activity.
Use when uploading evidence as a file or string. |
-| `AUTHORIZATION_DOCUMENTATION` | Evidence that the cardholder did provide authorization for the charge.
Example evidence includes a signed credit card authorization.
Use when uploading evidence as a file. |
-| `CANCELLATION_OR_REFUND_DOCUMENTATION` | Evidence that the cardholder acknowledged your refund or cancellation policy.
Example evidence includes a signature or checkbox showing the cardholder’s acknowledgement of your
refund or cancellation policy.
Use when uploading evidence as a file or string. |
-| `CARDHOLDER_COMMUNICATION` | Evidence that shows relevant communication with the cardholder.
Example evidence includes emails or texts that show the cardholder received goods/services or
demonstrate cardholder satisfaction.
Use when uploading evidence as a file. |
-| `CARDHOLDER_INFORMATION` | Evidence that validates the customer's identity.
Example evidence includes personally identifiable details such as name, email address, purchaser IP
address, and a copy of the cardholder ID.
Use when uploading evidence as a file or string. |
-| `PURCHASE_ACKNOWLEDGEMENT` | Evidence that shows proof of the sale/transaction.
Example evidence includes an invoice, contract, or other item showing the customer’s acknowledgement
of the purchase and your terms.
Use when uploading evidence as a file or string. |
-| `DUPLICATE_CHARGE_DOCUMENTATION` | Evidence that shows the charges in question are valid and distinct from one another.
Example evidence includes receipts, shipping labels, and invoices along with their distinct payment IDs.
Use when uploading evidence as a file. |
-| `PRODUCT_OR_SERVICE_DESCRIPTION` | A description of the product or service sold.
Use when uploading evidence as a file or string. |
-| `RECEIPT` | A receipt or message sent to the cardholder detailing the charge.
Note: You do not need to upload the Square receipt; Square submits the receipt on your behalf.
Use when uploading evidence as a file or string. |
-| `SERVICE_RECEIVED_DOCUMENTATION` | Evidence that the service was provided to the cardholder or the expected date that services will be rendered.
Example evidence includes a signed delivery form, work order, expected delivery date, or other written agreements.
Use when uploading evidence as a file or string. |
-| `PROOF_OF_DELIVERY_DOCUMENTATION` | Evidence that shows the product was provided to the cardholder or the expected date of delivery.
Example evidence includes a signed delivery form or written agreement acknowledging receipt of the goods or services.
Use when uploading evidence as a file or string. |
-| `RELATED_TRANSACTION_DOCUMENTATION` | Evidence that shows the cardholder previously processed transactions on the same card and did not dispute them.
Note: Square automatically provides up to five distinct Square receipts for related transactions, when available.
Use when uploading evidence as a file or string. |
-| `REBUTTAL_EXPLANATION` | An explanation of why the cardholder’s claim is invalid.
Example evidence includes an explanation of why each distinct charge is a legitimate purchase, why the cardholder’s claim
for credit owed due to their attempt to cancel, return, or refund is invalid per your stated policy and cardholder
agreement, or an explanation of how the cardholder did not attempt to remedy the issue with you first to receive credit.
Use when uploading evidence as a file or string. |
-| `TRACKING_NUMBER` | The tracking number for the order provided by the shipping carrier. If you have multiple numbers, they need to be
submitted individually as separate pieces of evidence.
Use when uploading evidence as a string. |
-
diff --git a/doc/models/dispute-evidence.md b/doc/models/dispute-evidence.md
deleted file mode 100644
index de33783f..00000000
--- a/doc/models/dispute-evidence.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Dispute Evidence
-
-## Structure
-
-`DisputeEvidence`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `evidenceId` | `?string` | Optional | The Square-generated ID of the evidence.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getEvidenceId(): ?string | setEvidenceId(?string evidenceId): void |
-| `id` | `?string` | Optional | The Square-generated ID of the evidence.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getId(): ?string | setId(?string id): void |
-| `disputeId` | `?string` | Optional | The ID of the dispute the evidence is associated with.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getDisputeId(): ?string | setDisputeId(?string disputeId): void |
-| `evidenceFile` | [`?DisputeEvidenceFile`](../../doc/models/dispute-evidence-file.md) | Optional | A file to be uploaded as dispute evidence. | getEvidenceFile(): ?DisputeEvidenceFile | setEvidenceFile(?DisputeEvidenceFile evidenceFile): void |
-| `evidenceText` | `?string` | Optional | Raw text
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `500` | getEvidenceText(): ?string | setEvidenceText(?string evidenceText): void |
-| `uploadedAt` | `?string` | Optional | The time when the evidence was uploaded, in RFC 3339 format.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getUploadedAt(): ?string | setUploadedAt(?string uploadedAt): void |
-| `evidenceType` | [`?string(DisputeEvidenceType)`](../../doc/models/dispute-evidence-type.md) | Optional | The type of the dispute evidence. | getEvidenceType(): ?string | setEvidenceType(?string evidenceType): void |
-
-## Example (as JSON)
-
-```json
-{
- "evidence_id": "evidence_id0",
- "id": "id2",
- "dispute_id": "dispute_id4",
- "evidence_file": {
- "filename": "filename8",
- "filetype": "filetype8"
- },
- "evidence_text": "evidence_text6"
-}
-```
-
diff --git a/doc/models/dispute-reason.md b/doc/models/dispute-reason.md
deleted file mode 100644
index b348da05..00000000
--- a/doc/models/dispute-reason.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-# Dispute Reason
-
-The list of possible reasons why a cardholder might initiate a
-dispute with their bank.
-
-## Enumeration
-
-`DisputeReason`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `AMOUNT_DIFFERS` | The cardholder claims that they were charged the wrong amount for the purchase.
To challenge this dispute, provide specific and concrete evidence that the cardholder agreed
to the amount charged. |
-| `CANCELLED` | The cardholder claims that they attempted to return the goods or cancel the service.
To challenge this dispute, provide specific and concrete evidence to prove that the cardholder
is not due a refund and that the cardholder acknowledged your cancellation policy. |
-| `DUPLICATE` | The cardholder claims that they were charged twice for the same purchase.
To challenge this dispute, provide specific and concrete evidence that shows both charges are
legitimate and independent of one another. |
-| `NO_KNOWLEDGE` | The cardholder claims that they did not make this purchase nor authorized the charge.
To challenge this dispute, provide specific and concrete evidence that proves that the cardholder
identity was verified at the time of purchase and that the purchase was authorized. |
-| `NOT_AS_DESCRIBED` | The cardholder claims the product or service was provided, but the quality of the deliverable
did not align with the expectations of the cardholder based on the description.
To challenge this dispute, provide specific and concrete evidence that shows the cardholder is in
possession of the product as described or received the service as described and agreed on. |
-| `NOT_RECEIVED` | The cardholder claims the product or service was not received by the cardholder within the
stated time frame.
To challenge this dispute, provide specific and concrete evidence to prove that the cardholder is
in possession of or received the product or service sold. |
-| `PAID_BY_OTHER_MEANS` | The cardholder claims that they previously paid for this purchase.
To challenge this dispute, provide specific and concrete evidence that shows both charges are
legitimate and independent of one another or proof that you already provided a credit for the charge. |
-| `CUSTOMER_REQUESTS_CREDIT` | The cardholder claims that the purchase was canceled or returned, but they have not yet received
the credit.
To challenge this dispute, provide specific and concrete evidence to prove that the cardholder is not
due a refund and that they acknowledged your cancellation and/or refund policy. |
-| `EMV_LIABILITY_SHIFT` | A chip-enabled card was not processed through a compliant chip-card reader (for example, it was swiped
instead of dipped into a chip-card reader).
You cannot challenge this dispute because the payment did not comply with EMV security requirements.
For more information, see [What Is EMV?](https://squareup.com/emv) |
-
diff --git a/doc/models/dispute-state.md b/doc/models/dispute-state.md
deleted file mode 100644
index d629040d..00000000
--- a/doc/models/dispute-state.md
+++ /dev/null
@@ -1,22 +0,0 @@
-
-# Dispute State
-
-The list of possible dispute states.
-
-## Enumeration
-
-`DisputeState`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `INQUIRY_EVIDENCE_REQUIRED` | The initial state of an inquiry with evidence required |
-| `INQUIRY_PROCESSING` | Inquiry evidence has been submitted and the bank is processing the inquiry |
-| `INQUIRY_CLOSED` | The inquiry is complete |
-| `EVIDENCE_REQUIRED` | The initial state of a dispute with evidence required |
-| `PROCESSING` | Dispute evidence has been submitted and the bank is processing the dispute |
-| `WON` | The bank has completed processing the dispute and the seller has won |
-| `LOST` | The bank has completed processing the dispute and the seller has lost |
-| `ACCEPTED` | The seller has accepted the dispute |
-
diff --git a/doc/models/dispute.md b/doc/models/dispute.md
deleted file mode 100644
index 8ca6f08a..00000000
--- a/doc/models/dispute.md
+++ /dev/null
@@ -1,45 +0,0 @@
-
-# Dispute
-
-Represents a [dispute](https://developer.squareup.com/docs/disputes-api/overview) a cardholder initiated with their bank.
-
-## Structure
-
-`Dispute`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `disputeId` | `?string` | Optional | The unique ID for this `Dispute`, generated by Square.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getDisputeId(): ?string | setDisputeId(?string disputeId): void |
-| `id` | `?string` | Optional | The unique ID for this `Dispute`, generated by Square.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getId(): ?string | setId(?string id): void |
-| `amountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): ?Money | setAmountMoney(?Money amountMoney): void |
-| `reason` | [`?string(DisputeReason)`](../../doc/models/dispute-reason.md) | Optional | The list of possible reasons why a cardholder might initiate a
dispute with their bank. | getReason(): ?string | setReason(?string reason): void |
-| `state` | [`?string(DisputeState)`](../../doc/models/dispute-state.md) | Optional | The list of possible dispute states. | getState(): ?string | setState(?string state): void |
-| `dueAt` | `?string` | Optional | The deadline by which the seller must respond to the dispute, in [RFC 3339 format](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-dates).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getDueAt(): ?string | setDueAt(?string dueAt): void |
-| `disputedPayment` | [`?DisputedPayment`](../../doc/models/disputed-payment.md) | Optional | The payment the cardholder disputed. | getDisputedPayment(): ?DisputedPayment | setDisputedPayment(?DisputedPayment disputedPayment): void |
-| `evidenceIds` | `?(string[])` | Optional | The IDs of the evidence associated with the dispute. | getEvidenceIds(): ?array | setEvidenceIds(?array evidenceIds): void |
-| `cardBrand` | [`?string(CardBrand)`](../../doc/models/card-brand.md) | Optional | Indicates a card's brand, such as `VISA` or `MASTERCARD`. | getCardBrand(): ?string | setCardBrand(?string cardBrand): void |
-| `createdAt` | `?string` | Optional | The timestamp when the dispute was created, in RFC 3339 format.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp when the dispute was last updated, in RFC 3339 format.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `brandDisputeId` | `?string` | Optional | The ID of the dispute in the card brand system, generated by the card brand.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getBrandDisputeId(): ?string | setBrandDisputeId(?string brandDisputeId): void |
-| `reportedDate` | `?string` | Optional | The timestamp when the dispute was reported, in RFC 3339 format.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getReportedDate(): ?string | setReportedDate(?string reportedDate): void |
-| `reportedAt` | `?string` | Optional | The timestamp when the dispute was reported, in RFC 3339 format.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getReportedAt(): ?string | setReportedAt(?string reportedAt): void |
-| `version` | `?int` | Optional | The current version of the `Dispute`. | getVersion(): ?int | setVersion(?int version): void |
-| `locationId` | `?string` | Optional | The ID of the location where the dispute originated.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getLocationId(): ?string | setLocationId(?string locationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "dispute_id": "dispute_id2",
- "id": "id0",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "reason": "NOT_AS_DESCRIBED",
- "state": "LOST"
-}
-```
-
diff --git a/doc/models/disputed-payment.md b/doc/models/disputed-payment.md
deleted file mode 100644
index 976dec66..00000000
--- a/doc/models/disputed-payment.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Disputed Payment
-
-The payment the cardholder disputed.
-
-## Structure
-
-`DisputedPayment`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | Square-generated unique ID of the payment being disputed.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `192` | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id8"
-}
-```
-
diff --git a/doc/models/ecom-visibility.md b/doc/models/ecom-visibility.md
deleted file mode 100644
index 17f24573..00000000
--- a/doc/models/ecom-visibility.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# Ecom Visibility
-
-Determines item visibility in Ecom (Online Store) and Online Checkout.
-
-## Enumeration
-
-`EcomVisibility`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `UNINDEXED` | Item is not synced with Ecom (Weebly). This is the default state |
-| `UNAVAILABLE` | Item is synced but is unavailable within Ecom (Weebly) and Online Checkout |
-| `HIDDEN` | Option for seller to choose manually created Quick Amounts. |
-| `VISIBLE` | Item is synced but available within Ecom (Weebly) and Online Checkout but is hidden from Ecom Store. |
-
diff --git a/doc/models/employee-status.md b/doc/models/employee-status.md
deleted file mode 100644
index c56cca14..00000000
--- a/doc/models/employee-status.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# Employee Status
-
-The status of the Employee being retrieved.
-
-DEPRECATED at version 2020-08-26. Replaced by [TeamMemberStatus](entity:TeamMemberStatus).
-
-## Enumeration
-
-`EmployeeStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ACTIVE` | Specifies that the employee is in the Active state. |
-| `INACTIVE` | Specifies that the employee is in the Inactive state. |
-
diff --git a/doc/models/employee-wage.md b/doc/models/employee-wage.md
deleted file mode 100644
index 618db7dd..00000000
--- a/doc/models/employee-wage.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Employee Wage
-
-The hourly wage rate that an employee earns on a `Shift` for doing the job specified by the `title` property of this object. Deprecated at version 2020-08-26. Use [TeamMemberWage](entity:TeamMemberWage).
-
-## Structure
-
-`EmployeeWage`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The UUID for this object. | getId(): ?string | setId(?string id): void |
-| `employeeId` | `?string` | Optional | The `Employee` that this wage is assigned to. | getEmployeeId(): ?string | setEmployeeId(?string employeeId): void |
-| `title` | `?string` | Optional | The job title that this wage relates to. | getTitle(): ?string | setTitle(?string title): void |
-| `hourlyRate` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getHourlyRate(): ?Money | setHourlyRate(?Money hourlyRate): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id0",
- "employee_id": "employee_id0",
- "title": "title6",
- "hourly_rate": {
- "amount": 172,
- "currency": "LAK"
- }
-}
-```
-
diff --git a/doc/models/employee.md b/doc/models/employee.md
deleted file mode 100644
index 868a07c3..00000000
--- a/doc/models/employee.md
+++ /dev/null
@@ -1,38 +0,0 @@
-
-# Employee
-
-An employee object that is used by the external API.
-
-DEPRECATED at version 2020-08-26. Replaced by [TeamMember](entity:TeamMember).
-
-## Structure
-
-`Employee`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | UUID for this object. | getId(): ?string | setId(?string id): void |
-| `firstName` | `?string` | Optional | The employee's first name. | getFirstName(): ?string | setFirstName(?string firstName): void |
-| `lastName` | `?string` | Optional | The employee's last name. | getLastName(): ?string | setLastName(?string lastName): void |
-| `email` | `?string` | Optional | The employee's email address | getEmail(): ?string | setEmail(?string email): void |
-| `phoneNumber` | `?string` | Optional | The employee's phone number in E.164 format, i.e. "+12125554250" | getPhoneNumber(): ?string | setPhoneNumber(?string phoneNumber): void |
-| `locationIds` | `?(string[])` | Optional | A list of location IDs where this employee has access to. | getLocationIds(): ?array | setLocationIds(?array locationIds): void |
-| `status` | [`?string(EmployeeStatus)`](../../doc/models/employee-status.md) | Optional | The status of the Employee being retrieved.
DEPRECATED at version 2020-08-26. Replaced by [TeamMemberStatus](entity:TeamMemberStatus). | getStatus(): ?string | setStatus(?string status): void |
-| `isOwner` | `?bool` | Optional | Whether this employee is the owner of the merchant. Each merchant
has one owner employee, and that employee has full authority over
the account. | getIsOwner(): ?bool | setIsOwner(?bool isOwner): void |
-| `createdAt` | `?string` | Optional | A read-only timestamp in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | A read-only timestamp in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id6",
- "first_name": "first_name6",
- "last_name": "last_name4",
- "email": "email0",
- "phone_number": "phone_number6"
-}
-```
-
diff --git a/doc/models/enable-events-response.md b/doc/models/enable-events-response.md
deleted file mode 100644
index 0d935dde..00000000
--- a/doc/models/enable-events-response.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Enable Events Response
-
-Defines the fields that are included in the response body of
-a request to the [EnableEvents](../../doc/apis/events.md#enable-events) endpoint.
-
-Note: if there are errors processing the request, the events field will not be
-present.
-
-## Structure
-
-`EnableEventsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/error-category.md b/doc/models/error-category.md
deleted file mode 100644
index 2fb6f113..00000000
--- a/doc/models/error-category.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Error Category
-
-Indicates which high-level category of error has occurred during a
-request to the Connect API.
-
-## Enumeration
-
-`ErrorCategory`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `API_ERROR` | An error occurred with the Connect API itself. |
-| `AUTHENTICATION_ERROR` | An authentication error occurred. Most commonly, the request had
a missing, malformed, or otherwise invalid `Authorization` header. |
-| `INVALID_REQUEST_ERROR` | The request was invalid. Most commonly, a required parameter was
missing, or a provided parameter had an invalid value. |
-| `RATE_LIMIT_ERROR` | Your application reached the Square API rate limit. You might receive this error if your application sends a high number of requests
to Square APIs in a short period of time.
Your application should monitor responses for `429 RATE_LIMITED` errors and use a retry mechanism with an [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff)
schedule to resend the requests at an increasingly slower rate. It is also a good practice to use a randomized delay (jitter) in your retry schedule. |
-| `PAYMENT_METHOD_ERROR` | An error occurred while processing a payment method. Most commonly,
the details of the payment method were invalid (such as a card's CVV
or expiration date). |
-| `REFUND_ERROR` | An error occurred while attempting to process a refund. |
-| `MERCHANT_SUBSCRIPTION_ERROR` | An error occurred when checking a merchant subscription status |
-| `EXTERNAL_VENDOR_ERROR` | An error that is returned from an external vendor's API |
-
diff --git a/doc/models/error-code.md b/doc/models/error-code.md
deleted file mode 100644
index 32884931..00000000
--- a/doc/models/error-code.md
+++ /dev/null
@@ -1,165 +0,0 @@
-
-# Error Code
-
-Indicates the specific error that occurred during a request to a
-Square API.
-
-## Enumeration
-
-`ErrorCode`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `INTERNAL_SERVER_ERROR` | A general server error occurred. |
-| `UNAUTHORIZED` | A general authorization error occurred. |
-| `ACCESS_TOKEN_EXPIRED` | The provided access token has expired. |
-| `ACCESS_TOKEN_REVOKED` | The provided access token has been revoked. |
-| `CLIENT_DISABLED` | The provided client has been disabled. |
-| `FORBIDDEN` | A general access error occurred. |
-| `INSUFFICIENT_SCOPES` | The provided access token does not have permission
to execute the requested action. |
-| `APPLICATION_DISABLED` | The calling application was disabled. |
-| `V1_APPLICATION` | The calling application was created prior to
2016-03-30 and is not compatible with v2 Square API calls. |
-| `V1_ACCESS_TOKEN` | The calling application is using an access token
created prior to 2016-03-30 and is not compatible with v2 Square API
calls. |
-| `CARD_PROCESSING_NOT_ENABLED` | The location provided in the API call is not
enabled for credit card processing. |
-| `MERCHANT_SUBSCRIPTION_NOT_FOUND` | A required subscription was not found for the merchant |
-| `BAD_REQUEST` | A general error occurred with the request. |
-| `MISSING_REQUIRED_PARAMETER` | The request is missing a required path, query, or
body parameter. |
-| `INCORRECT_TYPE` | The value provided in the request is the wrong
type. For example, a string instead of an integer. |
-| `INVALID_TIME` | Formatting for the provided time value is
incorrect. |
-| `INVALID_TIME_RANGE` | The time range provided in the request is invalid.
For example, the end time is before the start time. |
-| `INVALID_VALUE` | The provided value is invalid. For example,
including `%` in a phone number. |
-| `INVALID_CURSOR` | The pagination cursor included in the request is
invalid. |
-| `UNKNOWN_QUERY_PARAMETER` | The query parameters provided is invalid for the
requested endpoint. |
-| `CONFLICTING_PARAMETERS` | One or more of the request parameters conflict with
each other. |
-| `EXPECTED_JSON_BODY` | The request body is not a JSON object. |
-| `INVALID_SORT_ORDER` | The provided sort order is not a valid key.
Currently, sort order must be `ASC` or `DESC`. |
-| `VALUE_REGEX_MISMATCH` | The provided value does not match an expected
regular expression. |
-| `VALUE_TOO_SHORT` | The provided string value is shorter than the
minimum length allowed. |
-| `VALUE_TOO_LONG` | The provided string value is longer than the
maximum length allowed. |
-| `VALUE_TOO_LOW` | The provided value is less than the supported
minimum. |
-| `VALUE_TOO_HIGH` | The provided value is greater than the supported
maximum. |
-| `VALUE_EMPTY` | The provided value has a default (empty) value
such as a blank string. |
-| `ARRAY_LENGTH_TOO_LONG` | The provided array has too many elements. |
-| `ARRAY_LENGTH_TOO_SHORT` | The provided array has too few elements. |
-| `ARRAY_EMPTY` | The provided array is empty. |
-| `EXPECTED_BOOLEAN` | The endpoint expected the provided value to be a
boolean. |
-| `EXPECTED_INTEGER` | The endpoint expected the provided value to be an
integer. |
-| `EXPECTED_FLOAT` | The endpoint expected the provided value to be a
float. |
-| `EXPECTED_STRING` | The endpoint expected the provided value to be a
string. |
-| `EXPECTED_OBJECT` | The endpoint expected the provided value to be a
JSON object. |
-| `EXPECTED_ARRAY` | The endpoint expected the provided value to be an
array or list. |
-| `EXPECTED_MAP` | The endpoint expected the provided value to be a
map or associative array. |
-| `EXPECTED_BASE64_ENCODED_BYTE_ARRAY` | The endpoint expected the provided value to be an
array encoded in base64. |
-| `INVALID_ARRAY_VALUE` | One or more objects in the array does not match the
array type. |
-| `INVALID_ENUM_VALUE` | The provided static string is not valid for the
field. |
-| `INVALID_CONTENT_TYPE` | Invalid content type header. |
-| `INVALID_FORM_VALUE` | Only relevant for applications created prior to
2016-03-30. Indicates there was an error while parsing form values. |
-| `CUSTOMER_NOT_FOUND` | The provided customer id can't be found in the merchant's customers list. |
-| `ONE_INSTRUMENT_EXPECTED` | A general error occurred. |
-| `NO_FIELDS_SET` | A general error occurred. |
-| `TOO_MANY_MAP_ENTRIES` | Too many entries in the map field. |
-| `MAP_KEY_LENGTH_TOO_SHORT` | The length of one of the provided keys in the map is too short. |
-| `MAP_KEY_LENGTH_TOO_LONG` | The length of one of the provided keys in the map is too long. |
-| `CUSTOMER_MISSING_NAME` | The provided customer does not have a recorded name. |
-| `CUSTOMER_MISSING_EMAIL` | The provided customer does not have a recorded email. |
-| `INVALID_PAUSE_LENGTH` | The subscription cannot be paused longer than the duration of the current phase. |
-| `INVALID_DATE` | The subscription cannot be paused/resumed on the given date. |
-| `UNSUPPORTED_COUNTRY` | The API request references an unsupported country. |
-| `UNSUPPORTED_CURRENCY` | The API request references an unsupported currency. |
-| `APPLE_TTP_PIN_TOKEN` | The payment was declined by the card issuer during an Apple Tap to Pay (TTP)
transaction with a request for the card's PIN. This code will be returned alongside
`CARD_DECLINED_VERIFICATION_REQUIRED` as a supplemental error, and will include an
issuer-provided token in the `details` field that is needed to initiate the PIN
collection flow on the iOS device. |
-| `CARD_EXPIRED` | The card issuer declined the request because the card is expired. |
-| `INVALID_EXPIRATION` | The expiration date for the payment card is invalid. For example,
it indicates a date in the past. |
-| `INVALID_EXPIRATION_YEAR` | The expiration year for the payment card is invalid. For example,
it indicates a year in the past or contains invalid characters. |
-| `INVALID_EXPIRATION_DATE` | The expiration date for the payment card is invalid. For example,
it contains invalid characters. |
-| `UNSUPPORTED_CARD_BRAND` | The credit card provided is not from a supported issuer. |
-| `UNSUPPORTED_ENTRY_METHOD` | The entry method for the credit card (swipe, dip, tap) is not supported. |
-| `INVALID_ENCRYPTED_CARD` | The encrypted card information is invalid. |
-| `INVALID_CARD` | The credit card cannot be validated based on the provided details. |
-| `PAYMENT_AMOUNT_MISMATCH` | The payment was declined because there was a payment amount mismatch.
The money amount Square was expecting does not match the amount provided. |
-| `GENERIC_DECLINE` | Square received a decline without any additional information.
If the payment information seems correct, the buyer can contact their
issuer to ask for more information. |
-| `CVV_FAILURE` | The card issuer declined the request because the CVV value is invalid. |
-| `ADDRESS_VERIFICATION_FAILURE` | The card issuer declined the request because the postal code is invalid. |
-| `INVALID_ACCOUNT` | The issuer was not able to locate the account on record. |
-| `CURRENCY_MISMATCH` | The currency associated with the payment is not valid for the provided
funding source. For example, a gift card funded in USD cannot be used to process
payments in GBP. |
-| `INSUFFICIENT_FUNDS` | The funding source has insufficient funds to cover the payment. |
-| `INSUFFICIENT_PERMISSIONS` | The Square account does not have the permissions to accept
this payment. For example, Square may limit which merchants are
allowed to receive gift card payments. |
-| `CARDHOLDER_INSUFFICIENT_PERMISSIONS` | The card issuer has declined the transaction due to restrictions on where the card can be used.
For example, a gift card is limited to a single merchant. |
-| `INVALID_LOCATION` | The Square account cannot take payments in the specified region.
A Square account can take payments only from the region where the account was created. |
-| `TRANSACTION_LIMIT` | The card issuer has determined the payment amount is either too high or too low.
The API returns the error code mostly for credit cards (for example, the card reached
the credit limit). However, sometimes the issuer bank can indicate the error for debit
or prepaid cards (for example, card has insufficient funds). |
-| `VOICE_FAILURE` | The card issuer declined the request because the issuer requires voice authorization from the cardholder. The seller should ask the customer to contact the card issuing bank to authorize the payment. |
-| `PAN_FAILURE` | The specified card number is invalid. For example, it is of
incorrect length or is incorrectly formatted. |
-| `EXPIRATION_FAILURE` | The card expiration date is either invalid or indicates that the
card is expired. |
-| `CARD_NOT_SUPPORTED` | The card is not supported either in the geographic region or by
the [merchant category code](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) (MCC). |
-| `INVALID_PIN` | The card issuer declined the request because the PIN is invalid. |
-| `MISSING_PIN` | The payment is missing a required PIN. |
-| `MISSING_ACCOUNT_TYPE` | The payment is missing a required ACCOUNT_TYPE parameter. |
-| `INVALID_POSTAL_CODE` | The postal code is incorrectly formatted. |
-| `INVALID_FEES` | The app_fee_money on a payment is too high. |
-| `MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED` | The card must be swiped, tapped, or dipped. Payments attempted by manually entering the card number are declined. |
-| `PAYMENT_LIMIT_EXCEEDED` | Square declined the request because the payment amount exceeded the processing limit for this merchant. |
-| `GIFT_CARD_AVAILABLE_AMOUNT` | When a Gift Card is a payment source, you can allow taking a partial payment
by adding the `accept_partial_authorization` parameter in the request.
However, taking such a partial payment does not work if your request also includes
`tip_money`, `app_fee_money`, or both. Square declines such payments and returns
the `GIFT_CARD_AVAILABLE_AMOUNT` error.
For more information, see
[CreatePayment errors (additional information)](https://developer.squareup.com/docs/payments-api/error-codes#createpayment-errors-additional-information). |
-| `ACCOUNT_UNUSABLE` | The account provided cannot carry out transactions. |
-| `BUYER_REFUSED_PAYMENT` | Bank account rejected or was not authorized for the payment. |
-| `DELAYED_TRANSACTION_EXPIRED` | The application tried to update a delayed-capture payment that has expired. |
-| `DELAYED_TRANSACTION_CANCELED` | The application tried to cancel a delayed-capture payment that was already cancelled. |
-| `DELAYED_TRANSACTION_CAPTURED` | The application tried to capture a delayed-capture payment that was already captured. |
-| `DELAYED_TRANSACTION_FAILED` | The application tried to update a delayed-capture payment that failed. |
-| `CARD_TOKEN_EXPIRED` | The provided card token (nonce) has expired. |
-| `CARD_TOKEN_USED` | The provided card token (nonce) was already used to process the payment or refund. |
-| `AMOUNT_TOO_HIGH` | The requested payment amount is too high for the provided payment source. |
-| `UNSUPPORTED_INSTRUMENT_TYPE` | The API request references an unsupported instrument type. |
-| `REFUND_AMOUNT_INVALID` | The requested refund amount exceeds the amount available to refund. |
-| `REFUND_ALREADY_PENDING` | The payment already has a pending refund. |
-| `PAYMENT_NOT_REFUNDABLE` | The payment is not refundable. For example, the payment is too old to be refunded. |
-| `PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE` | The payment is not refundable because it has been disputed. |
-| `REFUND_DECLINED` | Request failed - The card issuer declined the refund. |
-| `INSUFFICIENT_PERMISSIONS_FOR_REFUND` | The Square account does not have the permissions to process this refund. |
-| `INVALID_CARD_DATA` | Generic error - the provided card data is invalid. |
-| `SOURCE_USED` | The provided source id was already used to create a card. |
-| `SOURCE_EXPIRED` | The provided source id has expired. |
-| `UNSUPPORTED_LOYALTY_REWARD_TIER` | The referenced loyalty program reward tier is not supported.
This could happen if the reward tier created in a first party
application is incompatible with the Loyalty API. |
-| `LOCATION_MISMATCH` | Generic error - the given location does not matching what is expected. |
-| `IDEMPOTENCY_KEY_REUSED` | The provided idempotency key has already been used. |
-| `UNEXPECTED_VALUE` | General error - the value provided was unexpected. |
-| `SANDBOX_NOT_SUPPORTED` | The API request is not supported in sandbox. |
-| `INVALID_EMAIL_ADDRESS` | The provided email address is invalid. |
-| `INVALID_PHONE_NUMBER` | The provided phone number is invalid. |
-| `CHECKOUT_EXPIRED` | The provided checkout URL has expired. |
-| `BAD_CERTIFICATE` | Bad certificate. |
-| `INVALID_SQUARE_VERSION_FORMAT` | The provided Square-Version is incorrectly formatted. |
-| `API_VERSION_INCOMPATIBLE` | The provided Square-Version is incompatible with the requested action. |
-| `CARD_PRESENCE_REQUIRED` | The transaction requires that a card be present. |
-| `UNSUPPORTED_SOURCE_TYPE` | The API request references an unsupported source type. |
-| `CARD_MISMATCH` | The provided card does not match what is expected. |
-| `PLAID_ERROR` | Generic plaid error |
-| `PLAID_ERROR_ITEM_LOGIN_REQUIRED` | Plaid error - ITEM_LOGIN_REQUIRED |
-| `PLAID_ERROR_RATE_LIMIT` | Plaid error - RATE_LIMIT |
-| `CARD_DECLINED` | The card was declined. |
-| `VERIFY_CVV_FAILURE` | The CVV could not be verified. |
-| `VERIFY_AVS_FAILURE` | The AVS could not be verified. |
-| `CARD_DECLINED_CALL_ISSUER` | The payment card was declined with a request
for the card holder to call the issuer. |
-| `CARD_DECLINED_VERIFICATION_REQUIRED` | The payment card was declined with a request
for additional verification. |
-| `BAD_EXPIRATION` | The card expiration date is either missing or
incorrectly formatted. |
-| `CHIP_INSERTION_REQUIRED` | The card issuer requires that the card be read
using a chip reader. |
-| `ALLOWABLE_PIN_TRIES_EXCEEDED` | The card has exhausted its available pin entry
retries set by the card issuer. Resolving the error typically requires the
card holder to contact the card issuer. |
-| `RESERVATION_DECLINED` | The card issuer declined the refund. |
-| `UNKNOWN_BODY_PARAMETER` | The body parameter is not recognized by the requested endpoint. |
-| `NOT_FOUND` | Not Found - a general error occurred. |
-| `APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND` | Square could not find the associated Apple Pay certificate. |
-| `METHOD_NOT_ALLOWED` | Method Not Allowed - a general error occurred. |
-| `NOT_ACCEPTABLE` | Not Acceptable - a general error occurred. |
-| `REQUEST_TIMEOUT` | Request Timeout - a general error occurred. |
-| `CONFLICT` | Conflict - a general error occurred. |
-| `GONE` | The target resource is no longer available and this
condition is likely to be permanent. |
-| `REQUEST_ENTITY_TOO_LARGE` | Request Entity Too Large - a general error occurred. |
-| `UNSUPPORTED_MEDIA_TYPE` | Unsupported Media Type - a general error occurred. |
-| `UNPROCESSABLE_ENTITY` | Unprocessable Entity - a general error occurred. |
-| `RATE_LIMITED` | Rate Limited - a general error occurred. |
-| `NOT_IMPLEMENTED` | Not Implemented - a general error occurred. |
-| `BAD_GATEWAY` | Bad Gateway - a general error occurred. |
-| `SERVICE_UNAVAILABLE` | Service Unavailable - a general error occurred. |
-| `TEMPORARY_ERROR` | A temporary internal error occurred. You can safely retry your call
using the same idempotency key. |
-| `GATEWAY_TIMEOUT` | Gateway Timeout - a general error occurred. |
-
diff --git a/doc/models/error.md b/doc/models/error.md
deleted file mode 100644
index 44f66e5a..00000000
--- a/doc/models/error.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Error
-
-Represents an error encountered during a request to the Connect API.
-
-See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information.
-
-## Structure
-
-`Error`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `category` | [`string(ErrorCategory)`](../../doc/models/error-category.md) | Required | Indicates which high-level category of error has occurred during a
request to the Connect API. | getCategory(): string | setCategory(string category): void |
-| `code` | [`string(ErrorCode)`](../../doc/models/error-code.md) | Required | Indicates the specific error that occurred during a request to a
Square API. | getCode(): string | setCode(string code): void |
-| `detail` | `?string` | Optional | A human-readable description of the error for debugging purposes. | getDetail(): ?string | setDetail(?string detail): void |
-| `field` | `?string` | Optional | The name of the field provided in the original request (if any) that
the error pertains to. | getField(): ?string | setField(?string field): void |
-
-## Example (as JSON)
-
-```json
-{
- "category": "API_ERROR",
- "code": "INVALID_PAUSE_LENGTH",
- "detail": "detail0",
- "field": "field8"
-}
-```
-
diff --git a/doc/models/event-data.md b/doc/models/event-data.md
deleted file mode 100644
index 545af008..00000000
--- a/doc/models/event-data.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Event Data
-
-## Structure
-
-`EventData`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `type` | `?string` | Optional | The name of the affected object’s type. | getType(): ?string | setType(?string type): void |
-| `id` | `?string` | Optional | The ID of the affected object. | getId(): ?string | setId(?string id): void |
-| `deleted` | `?bool` | Optional | This is true if the affected object has been deleted; otherwise, it's absent. | getDeleted(): ?bool | setDeleted(?bool deleted): void |
-| `object` | `mixed` | Optional | An object containing fields and values relevant to the event. It is absent if the affected object has been deleted. | getObject(): | setObject( object): void |
-
-## Example (as JSON)
-
-```json
-{
- "type": "type2",
- "id": "id8",
- "deleted": false,
- "object": {
- "key1": "val1",
- "key2": "val2"
- }
-}
-```
-
diff --git a/doc/models/event-metadata.md b/doc/models/event-metadata.md
deleted file mode 100644
index bf9b88cc..00000000
--- a/doc/models/event-metadata.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Event Metadata
-
-Contains metadata about a particular [Event](../../doc/models/event.md).
-
-## Structure
-
-`EventMetadata`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `eventId` | `?string` | Optional | A unique ID for the event. | getEventId(): ?string | setEventId(?string eventId): void |
-| `apiVersion` | `?string` | Optional | The API version of the event. This corresponds to the default API version of the developer application at the time when the event was created. | getApiVersion(): ?string | setApiVersion(?string apiVersion): void |
-
-## Example (as JSON)
-
-```json
-{
- "event_id": "event_id0",
- "api_version": "api_version6"
-}
-```
-
diff --git a/doc/models/event-type-metadata.md b/doc/models/event-type-metadata.md
deleted file mode 100644
index 3384a281..00000000
--- a/doc/models/event-type-metadata.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Event Type Metadata
-
-Contains the metadata of a webhook event type.
-
-## Structure
-
-`EventTypeMetadata`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `eventType` | `?string` | Optional | The event type. | getEventType(): ?string | setEventType(?string eventType): void |
-| `apiVersionIntroduced` | `?string` | Optional | The API version at which the event type was introduced. | getApiVersionIntroduced(): ?string | setApiVersionIntroduced(?string apiVersionIntroduced): void |
-| `releaseStatus` | `?string` | Optional | The release status of the event type. | getReleaseStatus(): ?string | setReleaseStatus(?string releaseStatus): void |
-
-## Example (as JSON)
-
-```json
-{
- "event_type": "event_type0",
- "api_version_introduced": "api_version_introduced0",
- "release_status": "release_status4"
-}
-```
-
diff --git a/doc/models/event.md b/doc/models/event.md
deleted file mode 100644
index eaebb946..00000000
--- a/doc/models/event.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Event
-
-## Structure
-
-`Event`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `merchantId` | `?string` | Optional | The ID of the target merchant associated with the event. | getMerchantId(): ?string | setMerchantId(?string merchantId): void |
-| `locationId` | `?string` | Optional | The ID of the target location associated with the event. | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `type` | `?string` | Optional | The type of event this represents. | getType(): ?string | setType(?string type): void |
-| `eventId` | `?string` | Optional | A unique ID for the event. | getEventId(): ?string | setEventId(?string eventId): void |
-| `createdAt` | `?string` | Optional | Timestamp of when the event was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `data` | [`?EventData`](../../doc/models/event-data.md) | Optional | - | getData(): ?EventData | setData(?EventData data): void |
-
-## Example (as JSON)
-
-```json
-{
- "merchant_id": "merchant_id2",
- "location_id": "location_id6",
- "type": "type8",
- "event_id": "event_id8",
- "created_at": "created_at0"
-}
-```
-
diff --git a/doc/models/exclude-strategy.md b/doc/models/exclude-strategy.md
deleted file mode 100644
index a86dcc1a..00000000
--- a/doc/models/exclude-strategy.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Exclude Strategy
-
-Indicates which products matched by a CatalogPricingRule
-will be excluded if the pricing rule uses an exclude set.
-
-## Enumeration
-
-`ExcludeStrategy`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `LEAST_EXPENSIVE` | The least expensive matched products are excluded from the pricing. If
the pricing rule is set to exclude one product and multiple products in the
match set qualify as least expensive, then one will be excluded at random.
Excluding the least expensive product gives the best discount value to the buyer. |
-| `MOST_EXPENSIVE` | The most expensive matched product is excluded from the pricing rule.
If multiple products have the same price and all qualify as least expensive,
one will be excluded at random.
This guarantees that the most expensive product is purchased at full price. |
-
diff --git a/doc/models/external-payment-details.md b/doc/models/external-payment-details.md
deleted file mode 100644
index c7d063b2..00000000
--- a/doc/models/external-payment-details.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# External Payment Details
-
-Stores details about an external payment. Contains only non-confidential information.
-For more information, see
-[Take External Payments](https://developer.squareup.com/docs/payments-api/take-payments/external-payments).
-
-## Structure
-
-`ExternalPaymentDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `type` | `string` | Required | The type of external payment the seller received. It can be one of the following:
- CHECK - Paid using a physical check.
- BANK_TRANSFER - Paid using external bank transfer.
- OTHER\_GIFT\_CARD - Paid using a non-Square gift card.
- CRYPTO - Paid using a crypto currency.
- SQUARE_CASH - Paid using Square Cash App.
- SOCIAL - Paid using peer-to-peer payment applications.
- EXTERNAL - A third-party application gathered this payment outside of Square.
- EMONEY - Paid using an E-money provider.
- CARD - A credit or debit card that Square does not support.
- STORED_BALANCE - Use for house accounts, store credit, and so forth.
- FOOD_VOUCHER - Restaurant voucher provided by employers to employees to pay for meals
- OTHER - A type not listed here.
**Constraints**: *Maximum Length*: `50` | getType(): string | setType(string type): void |
-| `source` | `string` | Required | A description of the external payment source. For example,
"Food Delivery Service".
**Constraints**: *Maximum Length*: `255` | getSource(): string | setSource(string source): void |
-| `sourceId` | `?string` | Optional | An ID to associate the payment to its originating source.
**Constraints**: *Maximum Length*: `255` | getSourceId(): ?string | setSourceId(?string sourceId): void |
-| `sourceFeeMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getSourceFeeMoney(): ?Money | setSourceFeeMoney(?Money sourceFeeMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "type": "type8",
- "source": "source8",
- "source_id": "source_id6",
- "source_fee_money": {
- "amount": 130,
- "currency": "NIO"
- }
-}
-```
-
diff --git a/doc/models/filter-value.md b/doc/models/filter-value.md
deleted file mode 100644
index d2a565f2..00000000
--- a/doc/models/filter-value.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-# Filter Value
-
-A filter to select resources based on an exact field value. For any given
-value, the value can only be in one property. Depending on the field, either
-all properties can be set or only a subset will be available.
-
-Refer to the documentation of the field.
-
-## Structure
-
-`FilterValue`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `all` | `?(string[])` | Optional | A list of terms that must be present on the field of the resource. | getAll(): ?array | setAll(?array all): void |
-| `any` | `?(string[])` | Optional | A list of terms where at least one of them must be present on the
field of the resource. | getAny(): ?array | setAny(?array any): void |
-| `none` | `?(string[])` | Optional | A list of terms that must not be present on the field the resource | getNone(): ?array | setNone(?array none): void |
-
-## Example (as JSON)
-
-```json
-{
- "all": [
- "all9",
- "all0",
- "all1"
- ],
- "any": [
- "any8",
- "any9",
- "any0"
- ],
- "none": [
- "none3",
- "none4"
- ]
-}
-```
-
diff --git a/doc/models/float-number-range.md b/doc/models/float-number-range.md
deleted file mode 100644
index 48aebe4f..00000000
--- a/doc/models/float-number-range.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Float Number Range
-
-Specifies a decimal number range.
-
-## Structure
-
-`FloatNumberRange`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `startAt` | `?string` | Optional | A decimal value indicating where the range starts. | getStartAt(): ?string | setStartAt(?string startAt): void |
-| `endAt` | `?string` | Optional | A decimal value indicating where the range ends. | getEndAt(): ?string | setEndAt(?string endAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "start_at": "start_at0",
- "end_at": "end_at2"
-}
-```
-
diff --git a/doc/models/fulfillment-delivery-details-order-fulfillment-delivery-details-schedule-type.md b/doc/models/fulfillment-delivery-details-order-fulfillment-delivery-details-schedule-type.md
deleted file mode 100644
index 0b4d55d6..00000000
--- a/doc/models/fulfillment-delivery-details-order-fulfillment-delivery-details-schedule-type.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Fulfillment Delivery Details Order Fulfillment Delivery Details Schedule Type
-
-The schedule type of the delivery fulfillment.
-
-## Enumeration
-
-`FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `SCHEDULED` | Indicates the fulfillment to deliver at a scheduled deliver time. |
-| `ASAP` | Indicates that the fulfillment to deliver as soon as possible and should be prepared
immediately. |
-
diff --git a/doc/models/fulfillment-delivery-details.md b/doc/models/fulfillment-delivery-details.md
deleted file mode 100644
index 0edfc240..00000000
--- a/doc/models/fulfillment-delivery-details.md
+++ /dev/null
@@ -1,61 +0,0 @@
-
-# Fulfillment Delivery Details
-
-Describes delivery details of an order fulfillment.
-
-## Structure
-
-`FulfillmentDeliveryDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `recipient` | [`?FulfillmentRecipient`](../../doc/models/fulfillment-recipient.md) | Optional | Information about the fulfillment recipient. | getRecipient(): ?FulfillmentRecipient | setRecipient(?FulfillmentRecipient recipient): void |
-| `scheduleType` | [`?string(FulfillmentDeliveryDetailsOrderFulfillmentDeliveryDetailsScheduleType)`](../../doc/models/fulfillment-delivery-details-order-fulfillment-delivery-details-schedule-type.md) | Optional | The schedule type of the delivery fulfillment. | getScheduleType(): ?string | setScheduleType(?string scheduleType): void |
-| `placedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was placed.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").
Must be in RFC 3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". | getPlacedAt(): ?string | setPlacedAt(?string placedAt): void |
-| `deliverAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
that represents the start of the delivery period.
When the fulfillment `schedule_type` is `ASAP`, the field is automatically
set to the current time plus the `prep_time_duration`.
Otherwise, the application can set this field while the fulfillment `state` is
`PROPOSED`, `RESERVED`, or `PREPARED` (any time before the
terminal state such as `COMPLETED`, `CANCELED`, and `FAILED`).
The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getDeliverAt(): ?string | setDeliverAt(?string deliverAt): void |
-| `prepTimeDuration` | `?string` | Optional | The duration of time it takes to prepare and deliver this fulfillment.
The duration must be in RFC 3339 format (for example, "P1W3D"). | getPrepTimeDuration(): ?string | setPrepTimeDuration(?string prepTimeDuration): void |
-| `deliveryWindowDuration` | `?string` | Optional | The time period after `deliver_at` in which to deliver the order.
Applications can set this field when the fulfillment `state` is
`PROPOSED`, `RESERVED`, or `PREPARED` (any time before the terminal state
such as `COMPLETED`, `CANCELED`, and `FAILED`).
The duration must be in RFC 3339 format (for example, "P1W3D"). | getDeliveryWindowDuration(): ?string | setDeliveryWindowDuration(?string deliveryWindowDuration): void |
-| `note` | `?string` | Optional | Provides additional instructions about the delivery fulfillment.
It is displayed in the Square Point of Sale application and set by the API.
**Constraints**: *Maximum Length*: `550` | getNote(): ?string | setNote(?string note): void |
-| `completedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicates when the seller completed the fulfillment.
This field is automatically set when fulfillment `state` changes to `COMPLETED`.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getCompletedAt(): ?string | setCompletedAt(?string completedAt): void |
-| `inProgressAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicates when the seller started processing the fulfillment.
This field is automatically set when the fulfillment `state` changes to `RESERVED`.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getInProgressAt(): ?string | setInProgressAt(?string inProgressAt): void |
-| `rejectedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was rejected. This field is
automatically set when the fulfillment `state` changes to `FAILED`.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getRejectedAt(): ?string | setRejectedAt(?string rejectedAt): void |
-| `readyAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the seller marked the fulfillment as ready for
courier pickup. This field is automatically set when the fulfillment `state` changes
to PREPARED.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getReadyAt(): ?string | setReadyAt(?string readyAt): void |
-| `deliveredAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was delivered to the recipient.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getDeliveredAt(): ?string | setDeliveredAt(?string deliveredAt): void |
-| `canceledAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was canceled. This field is automatically
set when the fulfillment `state` changes to `CANCELED`.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getCanceledAt(): ?string | setCanceledAt(?string canceledAt): void |
-| `cancelReason` | `?string` | Optional | The delivery cancellation reason. Max length: 100 characters.
**Constraints**: *Maximum Length*: `100` | getCancelReason(): ?string | setCancelReason(?string cancelReason): void |
-| `courierPickupAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when an order can be picked up by the courier for delivery.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getCourierPickupAt(): ?string | setCourierPickupAt(?string courierPickupAt): void |
-| `courierPickupWindowDuration` | `?string` | Optional | The time period after `courier_pickup_at` in which the courier should pick up the order.
The duration must be in RFC 3339 format (for example, "P1W3D"). | getCourierPickupWindowDuration(): ?string | setCourierPickupWindowDuration(?string courierPickupWindowDuration): void |
-| `isNoContactDelivery` | `?bool` | Optional | Whether the delivery is preferred to be no contact. | getIsNoContactDelivery(): ?bool | setIsNoContactDelivery(?bool isNoContactDelivery): void |
-| `dropoffNotes` | `?string` | Optional | A note to provide additional instructions about how to deliver the order.
**Constraints**: *Maximum Length*: `550` | getDropoffNotes(): ?string | setDropoffNotes(?string dropoffNotes): void |
-| `courierProviderName` | `?string` | Optional | The name of the courier provider.
**Constraints**: *Maximum Length*: `255` | getCourierProviderName(): ?string | setCourierProviderName(?string courierProviderName): void |
-| `courierSupportPhoneNumber` | `?string` | Optional | The support phone number of the courier.
**Constraints**: *Maximum Length*: `17` | getCourierSupportPhoneNumber(): ?string | setCourierSupportPhoneNumber(?string courierSupportPhoneNumber): void |
-| `squareDeliveryId` | `?string` | Optional | The identifier for the delivery created by Square.
**Constraints**: *Maximum Length*: `50` | getSquareDeliveryId(): ?string | setSquareDeliveryId(?string squareDeliveryId): void |
-| `externalDeliveryId` | `?string` | Optional | The identifier for the delivery created by the third-party courier service.
**Constraints**: *Maximum Length*: `50` | getExternalDeliveryId(): ?string | setExternalDeliveryId(?string externalDeliveryId): void |
-| `managedDelivery` | `?bool` | Optional | The flag to indicate the delivery is managed by a third party (ie DoorDash), which means
we may not receive all recipient information for PII purposes. | getManagedDelivery(): ?bool | setManagedDelivery(?bool managedDelivery): void |
-
-## Example (as JSON)
-
-```json
-{
- "recipient": {
- "customer_id": "customer_id6",
- "display_name": "display_name8",
- "email_address": "email_address4",
- "phone_number": "phone_number4",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- },
- "schedule_type": "SCHEDULED",
- "placed_at": "placed_at6",
- "deliver_at": "deliver_at2",
- "prep_time_duration": "prep_time_duration6"
-}
-```
-
diff --git a/doc/models/fulfillment-fulfillment-entry.md b/doc/models/fulfillment-fulfillment-entry.md
deleted file mode 100644
index 06f3a55a..00000000
--- a/doc/models/fulfillment-fulfillment-entry.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Fulfillment Fulfillment Entry
-
-Links an order line item to a fulfillment. Each entry must reference
-a valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to
-fulfill.
-
-## Structure
-
-`FulfillmentFulfillmentEntry`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the fulfillment entry only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `lineItemUid` | `string` | Required | The `uid` from the order line item.
**Constraints**: *Minimum Length*: `1` | getLineItemUid(): string | setLineItemUid(string lineItemUid): void |
-| `quantity` | `string` | Required | The quantity of the line item being fulfilled, formatted as a decimal number.
For example, `"3"`.
Fulfillments for line items with a `quantity_unit` can have non-integer quantities.
For example, `"1.70000"`.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `12` | getQuantity(): string | setQuantity(string quantity): void |
-| `metadata` | `?array` | Optional | Application-defined data attached to this fulfillment entry. Metadata fields are intended
to store descriptive references or associations with an entity in another system or store brief
information about the object. Square does not process this field; it only stores and returns it
in relevant API calls. Do not use metadata to store any sensitive information (such as personally
identifiable information or card details).
Keys written by applications must be 60 characters or less and must be in the character set
`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed
with a namespace, separated from the key with a ':' character.
Values have a maximum length of 255 characters.
An application can have up to 10 entries per metadata field.
Entries written by applications are private and can only be read or modified by the same
application.
For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). | getMetadata(): ?array | setMetadata(?array metadata): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid0",
- "line_item_uid": "line_item_uid0",
- "quantity": "quantity6",
- "metadata": {
- "key0": "metadata3",
- "key1": "metadata4"
- }
-}
-```
-
diff --git a/doc/models/fulfillment-fulfillment-line-item-application.md b/doc/models/fulfillment-fulfillment-line-item-application.md
deleted file mode 100644
index 1e4dd975..00000000
--- a/doc/models/fulfillment-fulfillment-line-item-application.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Fulfillment Fulfillment Line Item Application
-
-The `line_item_application` describes what order line items this fulfillment applies
-to. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.
-
-## Enumeration
-
-`FulfillmentFulfillmentLineItemApplication`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ALL` | If `ALL`, `entries` must be unset. |
-| `ENTRY_LIST` | If `ENTRY_LIST`, supply a list of `entries`. |
-
diff --git a/doc/models/fulfillment-pickup-details-curbside-pickup-details.md b/doc/models/fulfillment-pickup-details-curbside-pickup-details.md
deleted file mode 100644
index e4e5f20e..00000000
--- a/doc/models/fulfillment-pickup-details-curbside-pickup-details.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Fulfillment Pickup Details Curbside Pickup Details
-
-Specific details for curbside pickup.
-
-## Structure
-
-`FulfillmentPickupDetailsCurbsidePickupDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `curbsideDetails` | `?string` | Optional | Specific details for curbside pickup, such as parking number and vehicle model.
**Constraints**: *Maximum Length*: `250` | getCurbsideDetails(): ?string | setCurbsideDetails(?string curbsideDetails): void |
-| `buyerArrivedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getBuyerArrivedAt(): ?string | setBuyerArrivedAt(?string buyerArrivedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "curbside_details": "curbside_details0",
- "buyer_arrived_at": "buyer_arrived_at6"
-}
-```
-
diff --git a/doc/models/fulfillment-pickup-details-schedule-type.md b/doc/models/fulfillment-pickup-details-schedule-type.md
deleted file mode 100644
index 6879ccc4..00000000
--- a/doc/models/fulfillment-pickup-details-schedule-type.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Fulfillment Pickup Details Schedule Type
-
-The schedule type of the pickup fulfillment.
-
-## Enumeration
-
-`FulfillmentPickupDetailsScheduleType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `SCHEDULED` | Indicates that the fulfillment will be picked up at a scheduled pickup time. |
-| `ASAP` | Indicates that the fulfillment will be picked up as soon as possible and
should be prepared immediately. |
-
diff --git a/doc/models/fulfillment-pickup-details.md b/doc/models/fulfillment-pickup-details.md
deleted file mode 100644
index 350355ea..00000000
--- a/doc/models/fulfillment-pickup-details.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Fulfillment Pickup Details
-
-Contains details necessary to fulfill a pickup order.
-
-## Structure
-
-`FulfillmentPickupDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `recipient` | [`?FulfillmentRecipient`](../../doc/models/fulfillment-recipient.md) | Optional | Information about the fulfillment recipient. | getRecipient(): ?FulfillmentRecipient | setRecipient(?FulfillmentRecipient recipient): void |
-| `expiresAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when this fulfillment expires if it is not marked in progress. The timestamp must be
in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). The expiration time can only be set
up to 7 days in the future. If `expires_at` is not set, any new payments attached to the order
are automatically completed. | getExpiresAt(): ?string | setExpiresAt(?string expiresAt): void |
-| `autoCompleteDuration` | `?string` | Optional | The duration of time after which an in progress pickup fulfillment is automatically moved
to the `COMPLETED` state. The duration must be in RFC 3339 format (for example, "P1W3D").
If not set, this pickup fulfillment remains in progress until it is canceled or completed. | getAutoCompleteDuration(): ?string | setAutoCompleteDuration(?string autoCompleteDuration): void |
-| `scheduleType` | [`?string(FulfillmentPickupDetailsScheduleType)`](../../doc/models/fulfillment-pickup-details-schedule-type.md) | Optional | The schedule type of the pickup fulfillment. | getScheduleType(): ?string | setScheduleType(?string scheduleType): void |
-| `pickupAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
that represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g.,
"2016-09-04T23:59:33.123Z".
For fulfillments with the schedule type `ASAP`, this is automatically set
to the current time plus the expected duration to prepare the fulfillment. | getPickupAt(): ?string | setPickupAt(?string pickupAt): void |
-| `pickupWindowDuration` | `?string` | Optional | The window of time in which the order should be picked up after the `pickup_at` timestamp.
Must be in RFC 3339 duration format, e.g., "P1W3D". Can be used as an
informational guideline for merchants. | getPickupWindowDuration(): ?string | setPickupWindowDuration(?string pickupWindowDuration): void |
-| `prepTimeDuration` | `?string` | Optional | The duration of time it takes to prepare this fulfillment.
The duration must be in RFC 3339 format (for example, "P1W3D"). | getPrepTimeDuration(): ?string | setPrepTimeDuration(?string prepTimeDuration): void |
-| `note` | `?string` | Optional | A note to provide additional instructions about the pickup
fulfillment displayed in the Square Point of Sale application and set by the API.
**Constraints**: *Maximum Length*: `500` | getNote(): ?string | setNote(?string note): void |
-| `placedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was placed. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getPlacedAt(): ?string | setPlacedAt(?string placedAt): void |
-| `acceptedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was marked in progress. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getAcceptedAt(): ?string | setAcceptedAt(?string acceptedAt): void |
-| `rejectedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getRejectedAt(): ?string | setRejectedAt(?string rejectedAt): void |
-| `readyAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getReadyAt(): ?string | setReadyAt(?string readyAt): void |
-| `expiredAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment expired. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getExpiredAt(): ?string | setExpiredAt(?string expiredAt): void |
-| `pickedUpAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getPickedUpAt(): ?string | setPickedUpAt(?string pickedUpAt): void |
-| `canceledAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getCanceledAt(): ?string | setCanceledAt(?string canceledAt): void |
-| `cancelReason` | `?string` | Optional | A description of why the pickup was canceled. The maximum length: 100 characters.
**Constraints**: *Maximum Length*: `100` | getCancelReason(): ?string | setCancelReason(?string cancelReason): void |
-| `isCurbsidePickup` | `?bool` | Optional | If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup. | getIsCurbsidePickup(): ?bool | setIsCurbsidePickup(?bool isCurbsidePickup): void |
-| `curbsidePickupDetails` | [`?FulfillmentPickupDetailsCurbsidePickupDetails`](../../doc/models/fulfillment-pickup-details-curbside-pickup-details.md) | Optional | Specific details for curbside pickup. | getCurbsidePickupDetails(): ?FulfillmentPickupDetailsCurbsidePickupDetails | setCurbsidePickupDetails(?FulfillmentPickupDetailsCurbsidePickupDetails curbsidePickupDetails): void |
-
-## Example (as JSON)
-
-```json
-{
- "recipient": {
- "customer_id": "customer_id6",
- "display_name": "display_name8",
- "email_address": "email_address4",
- "phone_number": "phone_number4",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- },
- "expires_at": "expires_at0",
- "auto_complete_duration": "auto_complete_duration0",
- "schedule_type": "SCHEDULED",
- "pickup_at": "pickup_at8"
-}
-```
-
diff --git a/doc/models/fulfillment-recipient.md b/doc/models/fulfillment-recipient.md
deleted file mode 100644
index 98eb9db0..00000000
--- a/doc/models/fulfillment-recipient.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-# Fulfillment Recipient
-
-Information about the fulfillment recipient.
-
-## Structure
-
-`FulfillmentRecipient`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customerId` | `?string` | Optional | The ID of the customer associated with the fulfillment.
If `customer_id` is provided, the fulfillment recipient's `display_name`,
`email_address`, and `phone_number` are automatically populated from the
targeted customer profile. If these fields are set in the request, the request
values override the information from the customer profile. If the
targeted customer profile does not contain the necessary information and
these fields are left unset, the request results in an error.
**Constraints**: *Maximum Length*: `191` | getCustomerId(): ?string | setCustomerId(?string customerId): void |
-| `displayName` | `?string` | Optional | The display name of the fulfillment recipient. This field is required.
If provided, the display name overrides the corresponding customer profile value
indicated by `customer_id`.
**Constraints**: *Maximum Length*: `255` | getDisplayName(): ?string | setDisplayName(?string displayName): void |
-| `emailAddress` | `?string` | Optional | The email address of the fulfillment recipient.
If provided, the email address overrides the corresponding customer profile value
indicated by `customer_id`.
**Constraints**: *Maximum Length*: `255` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void |
-| `phoneNumber` | `?string` | Optional | The phone number of the fulfillment recipient. This field is required.
If provided, the phone number overrides the corresponding customer profile value
indicated by `customer_id`.
**Constraints**: *Maximum Length*: `17` | getPhoneNumber(): ?string | setPhoneNumber(?string phoneNumber): void |
-| `address` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getAddress(): ?Address | setAddress(?Address address): void |
-
-## Example (as JSON)
-
-```json
-{
- "customer_id": "customer_id2",
- "display_name": "display_name4",
- "email_address": "email_address2",
- "phone_number": "phone_number2",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
-}
-```
-
diff --git a/doc/models/fulfillment-shipment-details.md b/doc/models/fulfillment-shipment-details.md
deleted file mode 100644
index 5eb0c9d5..00000000
--- a/doc/models/fulfillment-shipment-details.md
+++ /dev/null
@@ -1,53 +0,0 @@
-
-# Fulfillment Shipment Details
-
-Contains the details necessary to fulfill a shipment order.
-
-## Structure
-
-`FulfillmentShipmentDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `recipient` | [`?FulfillmentRecipient`](../../doc/models/fulfillment-recipient.md) | Optional | Information about the fulfillment recipient. | getRecipient(): ?FulfillmentRecipient | setRecipient(?FulfillmentRecipient recipient): void |
-| `carrier` | `?string` | Optional | The shipping carrier being used to ship this fulfillment (such as UPS, FedEx, or USPS).
**Constraints**: *Maximum Length*: `50` | getCarrier(): ?string | setCarrier(?string carrier): void |
-| `shippingNote` | `?string` | Optional | A note with additional information for the shipping carrier.
**Constraints**: *Maximum Length*: `500` | getShippingNote(): ?string | setShippingNote(?string shippingNote): void |
-| `shippingType` | `?string` | Optional | A description of the type of shipping product purchased from the carrier
(such as First Class, Priority, or Express).
**Constraints**: *Maximum Length*: `50` | getShippingType(): ?string | setShippingType(?string shippingType): void |
-| `trackingNumber` | `?string` | Optional | The reference number provided by the carrier to track the shipment's progress.
**Constraints**: *Maximum Length*: `100` | getTrackingNumber(): ?string | setTrackingNumber(?string trackingNumber): void |
-| `trackingUrl` | `?string` | Optional | A link to the tracking webpage on the carrier's website.
**Constraints**: *Maximum Length*: `2000` | getTrackingUrl(): ?string | setTrackingUrl(?string trackingUrl): void |
-| `placedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the shipment was requested. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getPlacedAt(): ?string | setPlacedAt(?string placedAt): void |
-| `inProgressAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when this fulfillment was moved to the `RESERVED` state, which indicates that preparation
of this shipment has begun. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getInProgressAt(): ?string | setInProgressAt(?string inProgressAt): void |
-| `packagedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when this fulfillment was moved to the `PREPARED` state, which indicates that the
fulfillment is packaged. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getPackagedAt(): ?string | setPackagedAt(?string packagedAt): void |
-| `expectedShippedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the shipment is expected to be delivered to the shipping carrier.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getExpectedShippedAt(): ?string | setExpectedShippedAt(?string expectedShippedAt): void |
-| `shippedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when this fulfillment was moved to the `COMPLETED` state, which indicates that
the fulfillment has been given to the shipping carrier. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getShippedAt(): ?string | setShippedAt(?string shippedAt): void |
-| `canceledAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating the shipment was canceled.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getCanceledAt(): ?string | setCanceledAt(?string canceledAt): void |
-| `cancelReason` | `?string` | Optional | A description of why the shipment was canceled.
**Constraints**: *Maximum Length*: `100` | getCancelReason(): ?string | setCancelReason(?string cancelReason): void |
-| `failedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the shipment failed to be completed. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getFailedAt(): ?string | setFailedAt(?string failedAt): void |
-| `failureReason` | `?string` | Optional | A description of why the shipment failed to be completed.
**Constraints**: *Maximum Length*: `100` | getFailureReason(): ?string | setFailureReason(?string failureReason): void |
-
-## Example (as JSON)
-
-```json
-{
- "recipient": {
- "customer_id": "customer_id6",
- "display_name": "display_name8",
- "email_address": "email_address4",
- "phone_number": "phone_number4",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- },
- "carrier": "carrier6",
- "shipping_note": "shipping_note0",
- "shipping_type": "shipping_type2",
- "tracking_number": "tracking_number2"
-}
-```
-
diff --git a/doc/models/fulfillment-state.md b/doc/models/fulfillment-state.md
deleted file mode 100644
index 7d4cc072..00000000
--- a/doc/models/fulfillment-state.md
+++ /dev/null
@@ -1,20 +0,0 @@
-
-# Fulfillment State
-
-The current state of this fulfillment.
-
-## Enumeration
-
-`FulfillmentState`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `PROPOSED` | Indicates that the fulfillment has been proposed. |
-| `RESERVED` | Indicates that the fulfillment has been reserved. |
-| `PREPARED` | Indicates that the fulfillment has been prepared. |
-| `COMPLETED` | Indicates that the fulfillment was successfully completed. |
-| `CANCELED` | Indicates that the fulfillment was canceled. |
-| `FAILED` | Indicates that the fulfillment failed to be completed, but was not explicitly
canceled. |
-
diff --git a/doc/models/fulfillment-type.md b/doc/models/fulfillment-type.md
deleted file mode 100644
index cada76fd..00000000
--- a/doc/models/fulfillment-type.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Fulfillment Type
-
-The type of fulfillment.
-
-## Enumeration
-
-`FulfillmentType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `PICKUP` | A recipient to pick up the fulfillment from a physical [location](../../doc/models/location.md). |
-| `SHIPMENT` | A shipping carrier to ship the fulfillment. |
-| `DELIVERY` | A courier to deliver the fulfillment. |
-
diff --git a/doc/models/fulfillment.md b/doc/models/fulfillment.md
deleted file mode 100644
index fe5f709e..00000000
--- a/doc/models/fulfillment.md
+++ /dev/null
@@ -1,48 +0,0 @@
-
-# Fulfillment
-
-Contains details about how to fulfill this order.
-Orders can only be created with at most one fulfillment using the API.
-However, orders returned by the Orders API might contain multiple fulfillments because sellers can create multiple fulfillments using Square products such as Square Online.
-
-## Structure
-
-`Fulfillment`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the fulfillment only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `type` | [`?string(FulfillmentType)`](../../doc/models/fulfillment-type.md) | Optional | The type of fulfillment. | getType(): ?string | setType(?string type): void |
-| `state` | [`?string(FulfillmentState)`](../../doc/models/fulfillment-state.md) | Optional | The current state of this fulfillment. | getState(): ?string | setState(?string state): void |
-| `lineItemApplication` | [`?string(FulfillmentFulfillmentLineItemApplication)`](../../doc/models/fulfillment-fulfillment-line-item-application.md) | Optional | The `line_item_application` describes what order line items this fulfillment applies
to. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries. | getLineItemApplication(): ?string | setLineItemApplication(?string lineItemApplication): void |
-| `entries` | [`?(FulfillmentFulfillmentEntry[])`](../../doc/models/fulfillment-fulfillment-entry.md) | Optional | A list of entries pertaining to the fulfillment of an order. Each entry must reference
a valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to
fulfill.
Multiple entries can reference the same line item `uid`, as long as the total quantity among
all fulfillment entries referencing a single line item does not exceed the quantity of the
order's line item itself.
An order cannot be marked as `COMPLETED` before all fulfillments are `COMPLETED`,
`CANCELED`, or `FAILED`. Fulfillments can be created and completed independently
before order completion. | getEntries(): ?array | setEntries(?array entries): void |
-| `metadata` | `?array` | Optional | Application-defined data attached to this fulfillment. Metadata fields are intended
to store descriptive references or associations with an entity in another system or store brief
information about the object. Square does not process this field; it only stores and returns it
in relevant API calls. Do not use metadata to store any sensitive information (such as personally
identifiable information or card details).
Keys written by applications must be 60 characters or less and must be in the character set
`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed
with a namespace, separated from the key with a ':' character.
Values have a maximum length of 255 characters.
An application can have up to 10 entries per metadata field.
Entries written by applications are private and can only be read or modified by the same
application.
For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). | getMetadata(): ?array | setMetadata(?array metadata): void |
-| `pickupDetails` | [`?FulfillmentPickupDetails`](../../doc/models/fulfillment-pickup-details.md) | Optional | Contains details necessary to fulfill a pickup order. | getPickupDetails(): ?FulfillmentPickupDetails | setPickupDetails(?FulfillmentPickupDetails pickupDetails): void |
-| `shipmentDetails` | [`?FulfillmentShipmentDetails`](../../doc/models/fulfillment-shipment-details.md) | Optional | Contains the details necessary to fulfill a shipment order. | getShipmentDetails(): ?FulfillmentShipmentDetails | setShipmentDetails(?FulfillmentShipmentDetails shipmentDetails): void |
-| `deliveryDetails` | [`?FulfillmentDeliveryDetails`](../../doc/models/fulfillment-delivery-details.md) | Optional | Describes delivery details of an order fulfillment. | getDeliveryDetails(): ?FulfillmentDeliveryDetails | setDeliveryDetails(?FulfillmentDeliveryDetails deliveryDetails): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid0",
- "type": "DELIVERY",
- "state": "CANCELED",
- "line_item_application": "ALL",
- "entries": [
- {
- "uid": "uid0",
- "line_item_uid": "line_item_uid0",
- "quantity": "quantity6",
- "metadata": {
- "key0": "metadata3",
- "key1": "metadata4",
- "key2": "metadata5"
- }
- }
- ]
-}
-```
-
diff --git a/doc/models/get-bank-account-by-v1-id-response.md b/doc/models/get-bank-account-by-v1-id-response.md
deleted file mode 100644
index 095a8e4c..00000000
--- a/doc/models/get-bank-account-by-v1-id-response.md
+++ /dev/null
@@ -1,62 +0,0 @@
-
-# Get Bank Account by V1 Id Response
-
-Response object returned by GetBankAccountByV1Id.
-
-## Structure
-
-`GetBankAccountByV1IdResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `bankAccount` | [`?BankAccount`](../../doc/models/bank-account.md) | Optional | Represents a bank account. For more information about
linking a bank account to a Square account, see
[Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api). | getBankAccount(): ?BankAccount | setBankAccount(?BankAccount bankAccount): void |
-
-## Example (as JSON)
-
-```json
-{
- "bank_account": {
- "account_number_suffix": "971",
- "account_type": "CHECKING",
- "bank_name": "Bank Name",
- "country": "US",
- "creditable": false,
- "currency": "USD",
- "debitable": false,
- "holder_name": "Jane Doe",
- "id": "w3yRgCGYQnwmdl0R3GB",
- "location_id": "S8GWD5example",
- "primary_bank_identification_number": "112200303",
- "status": "VERIFICATION_IN_PROGRESS",
- "version": 5,
- "secondary_bank_identification_number": "secondary_bank_identification_number4",
- "debit_mandate_reference_id": "debit_mandate_reference_id0",
- "reference_id": "reference_id2",
- "fingerprint": "fingerprint0"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/get-bank-account-response.md b/doc/models/get-bank-account-response.md
deleted file mode 100644
index 9bf91fa5..00000000
--- a/doc/models/get-bank-account-response.md
+++ /dev/null
@@ -1,50 +0,0 @@
-
-# Get Bank Account Response
-
-Response object returned by `GetBankAccount`.
-
-## Structure
-
-`GetBankAccountResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `bankAccount` | [`?BankAccount`](../../doc/models/bank-account.md) | Optional | Represents a bank account. For more information about
linking a bank account to a Square account, see
[Bank Accounts API](https://developer.squareup.com/docs/bank-accounts-api). | getBankAccount(): ?BankAccount | setBankAccount(?BankAccount bankAccount): void |
-
-## Example (as JSON)
-
-```json
-{
- "bank_account": {
- "account_number_suffix": "971",
- "account_type": "CHECKING",
- "bank_name": "Bank Name",
- "country": "US",
- "creditable": false,
- "currency": "USD",
- "debitable": false,
- "holder_name": "Jane Doe",
- "id": "w3yRgCGYQnwmdl0R3GB",
- "location_id": "S8GWD5example",
- "primary_bank_identification_number": "112200303",
- "status": "VERIFICATION_IN_PROGRESS",
- "version": 5,
- "secondary_bank_identification_number": "secondary_bank_identification_number4",
- "debit_mandate_reference_id": "debit_mandate_reference_id0",
- "reference_id": "reference_id2",
- "fingerprint": "fingerprint0"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/get-break-type-response.md b/doc/models/get-break-type-response.md
deleted file mode 100644
index abc0fc26..00000000
--- a/doc/models/get-break-type-response.md
+++ /dev/null
@@ -1,49 +0,0 @@
-
-# Get Break Type Response
-
-The response to a request to get a `BreakType`. The response contains
-the requested `BreakType` objects and might contain a set of `Error` objects if
-the request resulted in errors.
-
-## Structure
-
-`GetBreakTypeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `breakType` | [`?BreakType`](../../doc/models/break-type.md) | Optional | A defined break template that sets an expectation for possible `Break`
instances on a `Shift`. | getBreakType(): ?BreakType | setBreakType(?BreakType breakType): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "break_type": {
- "break_name": "Lunch Break",
- "created_at": "2019-02-21T17:50:00Z",
- "expected_duration": "PT30M",
- "id": "lA0mj_RSOprNPwMUXdYp",
- "is_paid": true,
- "location_id": "059SB0E0WCNWS",
- "updated_at": "2019-02-21T17:50:00Z",
- "version": 1
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/get-device-code-response.md b/doc/models/get-device-code-response.md
deleted file mode 100644
index 4679861a..00000000
--- a/doc/models/get-device-code-response.md
+++ /dev/null
@@ -1,41 +0,0 @@
-
-# Get Device Code Response
-
-## Structure
-
-`GetDeviceCodeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `deviceCode` | [`?DeviceCode`](../../doc/models/device-code.md) | Optional | - | getDeviceCode(): ?DeviceCode | setDeviceCode(?DeviceCode deviceCode): void |
-
-## Example (as JSON)
-
-```json
-{
- "device_code": {
- "code": "EBCARJ",
- "created_at": "2020-02-06T18:44:33.000Z",
- "device_id": "907CS13101300122",
- "id": "B3Z6NAMYQSMTM",
- "location_id": "B5E4484SHHNYH",
- "name": "Counter 1",
- "pair_by": "2020-02-06T18:49:33.000Z",
- "product_type": "TERMINAL_API",
- "status": "PAIRED",
- "status_changed_at": "2020-02-06T18:47:28.000Z"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/get-device-response.md b/doc/models/get-device-response.md
deleted file mode 100644
index e3c64dab..00000000
--- a/doc/models/get-device-response.md
+++ /dev/null
@@ -1,191 +0,0 @@
-
-# Get Device Response
-
-## Structure
-
-`GetDeviceResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `device` | [`?Device`](../../doc/models/device.md) | Optional | - | getDevice(): ?Device | setDevice(?Device device): void |
-
-## Example (as JSON)
-
-```json
-{
- "device": {
- "attributes": {
- "manufacturer": "Square",
- "manufacturers_id": "995CS397A6475287",
- "merchant_token": "MLCHXZCBWFGDW",
- "model": "T2",
- "name": "Square Terminal 995",
- "type": "TERMINAL",
- "updated_at": "2023-09-29T13:12:22.365049321Z",
- "version": "5.41.0085"
- },
- "components": [
- {
- "application_details": {
- "application_type": "TERMINAL_API",
- "session_location": "LMN2K7S3RTOU3",
- "version": "6.25",
- "device_code_id": "device_code_id2"
- },
- "type": "APPLICATION",
- "card_reader_details": {
- "version": "version0"
- },
- "battery_details": {
- "visible_percent": 108,
- "external_power": "AVAILABLE_CHARGING"
- },
- "wifi_details": {
- "active": false,
- "ssid": "ssid8",
- "ip_address_v4": "ip_address_v42",
- "secure_connection": "secure_connection8",
- "signal_strength": {
- "value": 222
- }
- },
- "ethernet_details": {
- "active": false,
- "ip_address_v4": "ip_address_v42"
- }
- },
- {
- "card_reader_details": {
- "version": "3.53.70"
- },
- "type": "CARD_READER",
- "application_details": {
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
- },
- "battery_details": {
- "visible_percent": 108,
- "external_power": "AVAILABLE_CHARGING"
- },
- "wifi_details": {
- "active": false,
- "ssid": "ssid8",
- "ip_address_v4": "ip_address_v42",
- "secure_connection": "secure_connection8",
- "signal_strength": {
- "value": 222
- }
- },
- "ethernet_details": {
- "active": false,
- "ip_address_v4": "ip_address_v42"
- }
- },
- {
- "battery_details": {
- "external_power": "AVAILABLE_CHARGING",
- "visible_percent": 5
- },
- "type": "BATTERY",
- "application_details": {
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
- },
- "card_reader_details": {
- "version": "version0"
- },
- "wifi_details": {
- "active": false,
- "ssid": "ssid8",
- "ip_address_v4": "ip_address_v42",
- "secure_connection": "secure_connection8",
- "signal_strength": {
- "value": 222
- }
- },
- "ethernet_details": {
- "active": false,
- "ip_address_v4": "ip_address_v42"
- }
- },
- {
- "type": "WIFI",
- "wifi_details": {
- "active": true,
- "ip_address_v4": "10.0.0.7",
- "secure_connection": "WPA/WPA2 PSK",
- "signal_strength": {
- "value": 2
- },
- "ssid": "Staff Network"
- },
- "application_details": {
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
- },
- "card_reader_details": {
- "version": "version0"
- },
- "battery_details": {
- "visible_percent": 108,
- "external_power": "AVAILABLE_CHARGING"
- },
- "ethernet_details": {
- "active": false,
- "ip_address_v4": "ip_address_v42"
- }
- },
- {
- "ethernet_details": {
- "active": false
- },
- "type": "ETHERNET",
- "application_details": {
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
- },
- "card_reader_details": {
- "version": "version0"
- },
- "battery_details": {
- "visible_percent": 108,
- "external_power": "AVAILABLE_CHARGING"
- },
- "wifi_details": {
- "active": false,
- "ssid": "ssid8",
- "ip_address_v4": "ip_address_v42",
- "secure_connection": "secure_connection8",
- "signal_strength": {
- "value": 222
- }
- }
- }
- ],
- "id": "device:995CS397A6475287",
- "status": {
- "category": "AVAILABLE"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/get-employee-wage-response.md b/doc/models/get-employee-wage-response.md
deleted file mode 100644
index 112b48d2..00000000
--- a/doc/models/get-employee-wage-response.md
+++ /dev/null
@@ -1,54 +0,0 @@
-
-# Get Employee Wage Response
-
-A response to a request to get an `EmployeeWage`. The response contains
-the requested `EmployeeWage` objects and might contain a set of `Error` objects if
-the request resulted in errors.
-
-## Structure
-
-`GetEmployeeWageResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `employeeWage` | [`?EmployeeWage`](../../doc/models/employee-wage.md) | Optional | The hourly wage rate that an employee earns on a `Shift` for doing the job specified by the `title` property of this object. Deprecated at version 2020-08-26. Use [TeamMemberWage](entity:TeamMemberWage). | getEmployeeWage(): ?EmployeeWage | setEmployeeWage(?EmployeeWage employeeWage): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "employee_wage": {
- "employee_id": "33fJchumvVdJwxV0H6L9",
- "hourly_rate": {
- "amount": 2000,
- "currency": "USD"
- },
- "id": "pXS3qCv7BERPnEGedM4S8mhm",
- "title": "Manager"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/get-invoice-response.md b/doc/models/get-invoice-response.md
deleted file mode 100644
index 6a9fc1de..00000000
--- a/doc/models/get-invoice-response.md
+++ /dev/null
@@ -1,106 +0,0 @@
-
-# Get Invoice Response
-
-Describes a `GetInvoice` response.
-
-## Structure
-
-`GetInvoiceResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `invoice` | [`?Invoice`](../../doc/models/invoice.md) | Optional | Stores information about an invoice. You use the Invoices API to create and manage
invoices. For more information, see [Invoices API Overview](https://developer.squareup.com/docs/invoices-api/overview). | getInvoice(): ?Invoice | setInvoice(?Invoice invoice): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "invoice": {
- "accepted_payment_methods": {
- "bank_account": false,
- "buy_now_pay_later": false,
- "card": true,
- "cash_app_pay": false,
- "square_gift_card": false
- },
- "created_at": "2020-06-18T17:45:13Z",
- "custom_fields": [
- {
- "label": "Event Reference Number",
- "placement": "ABOVE_LINE_ITEMS",
- "value": "Ref. #1234"
- },
- {
- "label": "Terms of Service",
- "placement": "BELOW_LINE_ITEMS",
- "value": "The terms of service are..."
- }
- ],
- "delivery_method": "EMAIL",
- "description": "We appreciate your business!",
- "id": "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY",
- "invoice_number": "inv-100",
- "location_id": "ES0RJRZYEC39A",
- "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY",
- "payment_requests": [
- {
- "automatic_payment_source": "NONE",
- "computed_amount_money": {
- "amount": 10000,
- "currency": "USD"
- },
- "due_date": "2030-01-24",
- "reminders": [
- {
- "message": "Your invoice is due tomorrow",
- "relative_scheduled_days": -1,
- "status": "PENDING",
- "uid": "beebd363-e47f-4075-8785-c235aaa7df11"
- }
- ],
- "request_type": "BALANCE",
- "tipping_enabled": true,
- "total_completed_amount_money": {
- "amount": 0,
- "currency": "USD"
- },
- "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355"
- }
- ],
- "primary_recipient": {
- "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "email_address": "Amelia.Earhart@example.com",
- "family_name": "Earhart",
- "given_name": "Amelia",
- "phone_number": "1-212-555-4240",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- },
- "sale_or_service_date": "2030-01-24",
- "scheduled_at": "2030-01-13T10:00:00Z",
- "status": "DRAFT",
- "store_payment_method_enabled": false,
- "timezone": "America/Los_Angeles",
- "title": "Event Planning Services",
- "updated_at": "2020-06-18T17:45:13Z",
- "version": 0
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/get-payment-refund-response.md b/doc/models/get-payment-refund-response.md
deleted file mode 100644
index 091fd761..00000000
--- a/doc/models/get-payment-refund-response.md
+++ /dev/null
@@ -1,100 +0,0 @@
-
-# Get Payment Refund Response
-
-Defines the response returned by [GetRefund](../../doc/apis/refunds.md#get-payment-refund).
-
-Note: If there are errors processing the request, the refund field might not be
-present or it might be present in a FAILED state.
-
-## Structure
-
-`GetPaymentRefundResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `refund` | [`?PaymentRefund`](../../doc/models/payment-refund.md) | Optional | Represents a refund of a payment made using Square. Contains information about
the original payment and the amount of money refunded. | getRefund(): ?PaymentRefund | setRefund(?PaymentRefund refund): void |
-
-## Example (as JSON)
-
-```json
-{
- "refund": {
- "amount_money": {
- "amount": 555,
- "currency": "USD"
- },
- "created_at": "2021-10-13T19:59:05.073Z",
- "id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY_69MmgHubkLqx9wGhnmenRUHOaKitE6llfZuxcWYjGxd",
- "location_id": "L88917AVBK2S5",
- "order_id": "9ltv0bx5PuvGXUYHYHxYSKEqC3IZY",
- "payment_id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY",
- "processing_fee": [
- {
- "amount_money": {
- "amount": -34,
- "currency": "USD"
- },
- "effective_at": "2021-10-13T21:34:35.000Z",
- "type": "INITIAL"
- }
- ],
- "reason": "Example Refund",
- "status": "COMPLETED",
- "updated_at": "2021-10-13T20:00:02.442Z",
- "unlinked": false,
- "destination_type": "destination_type2",
- "destination_details": {
- "card_details": {
- "card": {
- "id": "id6",
- "card_brand": "OTHER_BRAND",
- "last_4": "last_48",
- "exp_month": 228,
- "exp_year": 68
- },
- "entry_method": "entry_method8",
- "auth_result_code": "auth_result_code0"
- },
- "cash_details": {
- "seller_supplied_money": {
- "amount": 36,
- "currency": "MKD"
- },
- "change_back_money": {
- "amount": 78,
- "currency": "XBD"
- }
- },
- "external_details": {
- "type": "type6",
- "source": "source0",
- "source_id": "source_id8"
- }
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/get-payment-response.md b/doc/models/get-payment-response.md
deleted file mode 100644
index ef32b1a5..00000000
--- a/doc/models/get-payment-response.md
+++ /dev/null
@@ -1,101 +0,0 @@
-
-# Get Payment Response
-
-Defines the response returned by [GetPayment](../../doc/apis/payments.md#get-payment).
-
-## Structure
-
-`GetPaymentResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `payment` | [`?Payment`](../../doc/models/payment.md) | Optional | Represents a payment processed by the Square API. | getPayment(): ?Payment | setPayment(?Payment payment): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment": {
- "amount_money": {
- "amount": 555,
- "currency": "USD"
- },
- "application_details": {
- "application_id": "sq0ids-Pw67AZAlLVB7hsRmwlJPuA",
- "square_product": "VIRTUAL_TERMINAL"
- },
- "approved_money": {
- "amount": 555,
- "currency": "USD"
- },
- "card_details": {
- "auth_result_code": "2Nkw7q",
- "avs_status": "AVS_ACCEPTED",
- "card": {
- "bin": "411111",
- "card_brand": "VISA",
- "card_type": "DEBIT",
- "exp_month": 11,
- "exp_year": 2022,
- "fingerprint": "sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ",
- "last_4": "1111",
- "prepaid_type": "NOT_PREPAID"
- },
- "card_payment_timeline": {
- "authorized_at": "2021-10-13T19:34:33.680Z",
- "captured_at": "2021-10-13T19:34:34.340Z"
- },
- "cvv_status": "CVV_ACCEPTED",
- "entry_method": "KEYED",
- "statement_description": "SQ *EXAMPLE TEST GOSQ.C",
- "status": "CAPTURED"
- },
- "created_at": "2021-10-13T19:34:33.524Z",
- "delay_action": "CANCEL",
- "delay_duration": "PT168H",
- "delayed_until": "2021-10-20T19:34:33.524Z",
- "employee_id": "TMoK_ogh6rH1o4dV",
- "id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY",
- "location_id": "L88917AVBK2S5",
- "note": "Test Note",
- "order_id": "d7eKah653Z579f3gVtjlxpSlmUcZY",
- "processing_fee": [
- {
- "amount_money": {
- "amount": 34,
- "currency": "USD"
- },
- "effective_at": "2021-10-13T21:34:35.000Z",
- "type": "INITIAL"
- }
- ],
- "receipt_number": "bP9m",
- "receipt_url": "https://squareup.com/receipt/preview/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY",
- "source_type": "CARD",
- "status": "COMPLETED",
- "team_member_id": "TMoK_ogh6rH1o4dV",
- "total_money": {
- "amount": 555,
- "currency": "USD"
- },
- "updated_at": "2021-10-13T19:34:34.339Z",
- "version_token": "56pRkL3slrzet2iQrTp9n0bdJVYTB9YEWdTNjQfZOPV6o",
- "tip_money": {
- "amount": 190,
- "currency": "TWD"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/get-payout-response.md b/doc/models/get-payout-response.md
deleted file mode 100644
index 29f24d62..00000000
--- a/doc/models/get-payout-response.md
+++ /dev/null
@@ -1,54 +0,0 @@
-
-# Get Payout Response
-
-## Structure
-
-`GetPayoutResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `payout` | [`?Payout`](../../doc/models/payout.md) | Optional | An accounting of the amount owed the seller and record of the actual transfer to their
external bank account or to the Square balance. | getPayout(): ?Payout | setPayout(?Payout payout): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "payout": {
- "amount_money": {
- "amount": -103,
- "currency_code": "USD",
- "currency": "AUD"
- },
- "arrival_date": "2022-03-24",
- "created_at": "2022-03-24T03:07:09Z",
- "destination": {
- "id": "bact:ZPp3oedR3AeEUNd3z7",
- "type": "BANK_ACCOUNT"
- },
- "id": "po_f3c0fb38-a5ce-427d-b858-52b925b72e45",
- "location_id": "L88917AVBK2S5",
- "status": "PAID",
- "type": "BATCH",
- "updated_at": "2022-03-24T03:07:09Z",
- "version": 1
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/get-shift-response.md b/doc/models/get-shift-response.md
deleted file mode 100644
index 076a54f6..00000000
--- a/doc/models/get-shift-response.md
+++ /dev/null
@@ -1,82 +0,0 @@
-
-# Get Shift Response
-
-A response to a request to get a `Shift`. The response contains
-the requested `Shift` object and might contain a set of `Error` objects if
-the request resulted in errors.
-
-## Structure
-
-`GetShiftResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `shift` | [`?Shift`](../../doc/models/shift.md) | Optional | A record of the hourly rate, start, and end times for a single work shift
for an employee. This might include a record of the start and end times for breaks
taken during the shift. | getShift(): ?Shift | setShift(?Shift shift): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "shift": {
- "breaks": [
- {
- "break_type_id": "92EPDRQKJ5088",
- "end_at": "2019-02-23T20:00:00-05:00",
- "expected_duration": "PT1H",
- "id": "M9BBKEPQAQD2T",
- "is_paid": true,
- "name": "Lunch Break",
- "start_at": "2019-02-23T19:00:00-05:00"
- }
- ],
- "created_at": "2019-02-27T00:12:12Z",
- "declared_cash_tip_money": {
- "amount": 500,
- "currency": "USD"
- },
- "employee_id": "D71KRMQof6cXGUW0aAv7",
- "end_at": "2019-02-23T21:00:00-05:00",
- "id": "T35HMQSN89SV4",
- "location_id": "PAA1RJZZKXBFG",
- "start_at": "2019-02-23T18:00:00-05:00",
- "status": "CLOSED",
- "team_member_id": "D71KRMQof6cXGUW0aAv7",
- "timezone": "America/New_York",
- "updated_at": "2019-02-27T00:12:12Z",
- "version": 1,
- "wage": {
- "hourly_rate": {
- "amount": 1457,
- "currency": "USD"
- },
- "job_id": "N4YKVLzFj3oGtNocqoYHYpW3",
- "tip_eligible": true,
- "title": "Cashier"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/get-team-member-wage-response.md b/doc/models/get-team-member-wage-response.md
deleted file mode 100644
index eaed40df..00000000
--- a/doc/models/get-team-member-wage-response.md
+++ /dev/null
@@ -1,44 +0,0 @@
-
-# Get Team Member Wage Response
-
-A response to a request to get a `TeamMemberWage`. The response contains
-the requested `TeamMemberWage` objects and might contain a set of `Error` objects if
-the request resulted in errors.
-
-## Structure
-
-`GetTeamMemberWageResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `teamMemberWage` | [`?TeamMemberWage`](../../doc/models/team-member-wage.md) | Optional | The hourly wage rate that a team member earns on a `Shift` for doing the job
specified by the `title` property of this object. | getTeamMemberWage(): ?TeamMemberWage | setTeamMemberWage(?TeamMemberWage teamMemberWage): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "team_member_wage": {
- "hourly_rate": {
- "amount": 2000,
- "currency": "USD"
- },
- "id": "pXS3qCv7BERPnEGedM4S8mhm",
- "job_id": "jxJNN6eCJsLrhg5UFJrDWDGE",
- "team_member_id": "33fJchumvVdJwxV0H6L9",
- "tip_eligible": false,
- "title": "Manager"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/get-terminal-action-response.md b/doc/models/get-terminal-action-response.md
deleted file mode 100644
index a0c4a3f1..00000000
--- a/doc/models/get-terminal-action-response.md
+++ /dev/null
@@ -1,51 +0,0 @@
-
-# Get Terminal Action Response
-
-## Structure
-
-`GetTerminalActionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `action` | [`?TerminalAction`](../../doc/models/terminal-action.md) | Optional | Represents an action processed by the Square Terminal. | getAction(): ?TerminalAction | setAction(?TerminalAction action): void |
-
-## Example (as JSON)
-
-```json
-{
- "action": {
- "app_id": "APP_ID",
- "created_at": "2021-07-28T23:22:07.476Z",
- "deadline_duration": "PT5M",
- "device_id": "DEVICE_ID",
- "id": "termapia:jveJIAkkAjILHkdCE",
- "location_id": "LOCATION_ID",
- "save_card_options": {
- "customer_id": "CUSTOMER_ID",
- "reference_id": "user-id-1"
- },
- "status": "IN_PROGRESS",
- "type": "SAVE_CARD",
- "updated_at": "2021-07-28T23:22:08.301Z",
- "cancel_reason": "TIMED_OUT"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/get-terminal-checkout-response.md b/doc/models/get-terminal-checkout-response.md
deleted file mode 100644
index ac7078dc..00000000
--- a/doc/models/get-terminal-checkout-response.md
+++ /dev/null
@@ -1,66 +0,0 @@
-
-# Get Terminal Checkout Response
-
-## Structure
-
-`GetTerminalCheckoutResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `checkout` | [`?TerminalCheckout`](../../doc/models/terminal-checkout.md) | Optional | Represents a checkout processed by the Square Terminal. | getCheckout(): ?TerminalCheckout | setCheckout(?TerminalCheckout checkout): void |
-
-## Example (as JSON)
-
-```json
-{
- "checkout": {
- "amount_money": {
- "amount": 2610,
- "currency": "USD"
- },
- "app_id": "APP_ID",
- "created_at": "2020-04-06T16:39:32.545Z",
- "deadline_duration": "PT5M",
- "device_options": {
- "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003",
- "skip_receipt_screen": false,
- "tip_settings": {
- "allow_tipping": false,
- "separate_tip_screen": false,
- "custom_tip_field": false,
- "tip_percentages": [
- 48
- ],
- "smart_tipping": false
- },
- "collect_signature": false,
- "show_itemized_cart": false
- },
- "id": "08YceKh7B3ZqO",
- "location_id": "LOCATION_ID",
- "note": "A brief note",
- "reference_id": "id11572",
- "status": "IN_PROGRESS",
- "updated_at": "2020-04-06T16:39:323.001Z",
- "order_id": "order_id6",
- "payment_options": {
- "autocomplete": false,
- "delay_duration": "delay_duration2",
- "accept_partial_authorization": false,
- "delay_action": "CANCEL"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/get-terminal-refund-response.md b/doc/models/get-terminal-refund-response.md
deleted file mode 100644
index cd1a9410..00000000
--- a/doc/models/get-terminal-refund-response.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Get Terminal Refund Response
-
-## Structure
-
-`GetTerminalRefundResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `refund` | [`?TerminalRefund`](../../doc/models/terminal-refund.md) | Optional | Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds. | getRefund(): ?TerminalRefund | setRefund(?TerminalRefund refund): void |
-
-## Example (as JSON)
-
-```json
-{
- "refund": {
- "amount_money": {
- "amount": 111,
- "currency": "CAD"
- },
- "app_id": "sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ",
- "card": {
- "bin": "411111",
- "card_brand": "INTERAC",
- "card_type": "CREDIT",
- "exp_month": 1,
- "exp_year": 2022,
- "fingerprint": "sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw",
- "last_4": "1111"
- },
- "created_at": "2020-09-29T15:21:46.771Z",
- "deadline_duration": "PT5M",
- "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291",
- "id": "009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY",
- "location_id": "76C9W6K8CNNQ5",
- "order_id": "kcuKDKreRaI4gF4TjmEgZjHk8Z7YY",
- "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY",
- "reason": "Returning item",
- "refund_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY_43Q4iGp7sNeATiWrUruA1EYeMRUXaddXXlDDJ1EQLvb",
- "status": "COMPLETED",
- "updated_at": "2020-09-29T15:21:48.675Z"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/gift-card-activity-activate.md b/doc/models/gift-card-activity-activate.md
deleted file mode 100644
index 6ed8d9fd..00000000
--- a/doc/models/gift-card-activity-activate.md
+++ /dev/null
@@ -1,36 +0,0 @@
-
-# Gift Card Activity Activate
-
-Represents details about an `ACTIVATE` [gift card activity type](../../doc/models/gift-card-activity-type.md).
-
-## Structure
-
-`GiftCardActivityActivate`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `amountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): ?Money | setAmountMoney(?Money amountMoney): void |
-| `orderId` | `?string` | Optional | The ID of the [order](entity:Order) that contains the `GIFT_CARD` line item.
Applications that use the Square Orders API to process orders must specify the order ID
[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. | getOrderId(): ?string | setOrderId(?string orderId): void |
-| `lineItemUid` | `?string` | Optional | The UID of the `GIFT_CARD` line item in the order that represents the gift card purchase.
Applications that use the Square Orders API to process orders must specify the line item UID
in the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. | getLineItemUid(): ?string | setLineItemUid(?string lineItemUid): void |
-| `referenceId` | `?string` | Optional | A client-specified ID that associates the gift card activity with an entity in another system.
Applications that use a custom order processing system can use this field to track information
related to an order or payment. | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `buyerPaymentInstrumentIds` | `?(string[])` | Optional | The payment instrument IDs used to process the gift card purchase, such as a credit card ID
or bank account ID.
Applications that use a custom order processing system must specify payment instrument IDs in
the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.
Square uses this information to perform compliance checks.
For applications that use the Square Orders API to process payments, Square has the necessary
instrument IDs to perform compliance checks.
Each buyer payment instrument ID can contain a maximum of 255 characters. | getBuyerPaymentInstrumentIds(): ?array | setBuyerPaymentInstrumentIds(?array buyerPaymentInstrumentIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "order_id": "order_id2",
- "line_item_uid": "line_item_uid4",
- "reference_id": "reference_id8",
- "buyer_payment_instrument_ids": [
- "buyer_payment_instrument_ids0"
- ]
-}
-```
-
diff --git a/doc/models/gift-card-activity-adjust-decrement-reason.md b/doc/models/gift-card-activity-adjust-decrement-reason.md
deleted file mode 100644
index 6af17603..00000000
--- a/doc/models/gift-card-activity-adjust-decrement-reason.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# Gift Card Activity Adjust Decrement Reason
-
-Indicates the reason for deducting money from a [gift card](../../doc/models/gift-card.md).
-
-## Enumeration
-
-`GiftCardActivityAdjustDecrementReason`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `SUSPICIOUS_ACTIVITY` | The balance was decreased because the seller detected suspicious or fraudulent activity
on the gift card. |
-| `BALANCE_ACCIDENTALLY_INCREASED` | The balance was decreased to reverse an unintentional balance increase. |
-| `SUPPORT_ISSUE` | The balance was decreased to accommodate support issues. |
-| `PURCHASE_WAS_REFUNDED` | The balance was decreased because the order used to purchase or reload the
gift card was refunded. |
-
diff --git a/doc/models/gift-card-activity-adjust-decrement.md b/doc/models/gift-card-activity-adjust-decrement.md
deleted file mode 100644
index 84616259..00000000
--- a/doc/models/gift-card-activity-adjust-decrement.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# Gift Card Activity Adjust Decrement
-
-Represents details about an `ADJUST_DECREMENT` [gift card activity type](../../doc/models/gift-card-activity-type.md).
-
-## Structure
-
-`GiftCardActivityAdjustDecrement`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-| `reason` | [`string(GiftCardActivityAdjustDecrementReason)`](../../doc/models/gift-card-activity-adjust-decrement-reason.md) | Required | Indicates the reason for deducting money from a [gift card](../../doc/models/gift-card.md). | getReason(): string | setReason(string reason): void |
-
-## Example (as JSON)
-
-```json
-{
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "reason": "SUPPORT_ISSUE"
-}
-```
-
diff --git a/doc/models/gift-card-activity-adjust-increment-reason.md b/doc/models/gift-card-activity-adjust-increment-reason.md
deleted file mode 100644
index c7bebb4d..00000000
--- a/doc/models/gift-card-activity-adjust-increment-reason.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Gift Card Activity Adjust Increment Reason
-
-Indicates the reason for adding money to a [gift card](../../doc/models/gift-card.md).
-
-## Enumeration
-
-`GiftCardActivityAdjustIncrementReason`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `COMPLIMENTARY` | The seller gifted a complimentary gift card balance increase. |
-| `SUPPORT_ISSUE` | The seller increased the gift card balance
to accommodate support issues. |
-| `TRANSACTION_VOIDED` | The transaction is voided. |
-
diff --git a/doc/models/gift-card-activity-adjust-increment.md b/doc/models/gift-card-activity-adjust-increment.md
deleted file mode 100644
index e65146c7..00000000
--- a/doc/models/gift-card-activity-adjust-increment.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# Gift Card Activity Adjust Increment
-
-Represents details about an `ADJUST_INCREMENT` [gift card activity type](../../doc/models/gift-card-activity-type.md).
-
-## Structure
-
-`GiftCardActivityAdjustIncrement`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-| `reason` | [`string(GiftCardActivityAdjustIncrementReason)`](../../doc/models/gift-card-activity-adjust-increment-reason.md) | Required | Indicates the reason for adding money to a [gift card](../../doc/models/gift-card.md). | getReason(): string | setReason(string reason): void |
-
-## Example (as JSON)
-
-```json
-{
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "reason": "COMPLIMENTARY"
-}
-```
-
diff --git a/doc/models/gift-card-activity-block-reason.md b/doc/models/gift-card-activity-block-reason.md
deleted file mode 100644
index 6bf54c74..00000000
--- a/doc/models/gift-card-activity-block-reason.md
+++ /dev/null
@@ -1,15 +0,0 @@
-
-# Gift Card Activity Block Reason
-
-Indicates the reason for blocking a [gift card](../../doc/models/gift-card.md).
-
-## Enumeration
-
-`GiftCardActivityBlockReason`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `CHARGEBACK_BLOCK` | The gift card is blocked because the buyer initiated a chargeback on the gift card purchase. |
-
diff --git a/doc/models/gift-card-activity-block.md b/doc/models/gift-card-activity-block.md
deleted file mode 100644
index 8745983c..00000000
--- a/doc/models/gift-card-activity-block.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Gift Card Activity Block
-
-Represents details about a `BLOCK` [gift card activity type](../../doc/models/gift-card-activity-type.md).
-
-## Structure
-
-`GiftCardActivityBlock`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `reason` | `string` | Required, Constant | Indicates the reason for blocking a [gift card](../../doc/models/gift-card.md).
**Default**: `'CHARGEBACK_BLOCK'` | getReason(): string | setReason(string reason): void |
-
-## Example (as JSON)
-
-```json
-{
- "reason": "CHARGEBACK_BLOCK"
-}
-```
-
diff --git a/doc/models/gift-card-activity-clear-balance-reason.md b/doc/models/gift-card-activity-clear-balance-reason.md
deleted file mode 100644
index 64a28491..00000000
--- a/doc/models/gift-card-activity-clear-balance-reason.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Gift Card Activity Clear Balance Reason
-
-Indicates the reason for clearing the balance of a [gift card](../../doc/models/gift-card.md).
-
-## Enumeration
-
-`GiftCardActivityClearBalanceReason`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `SUSPICIOUS_ACTIVITY` | The seller suspects suspicious activity. |
-| `REUSE_GIFTCARD` | The seller cleared the balance to reuse the gift card. |
-| `UNKNOWN_REASON` | The gift card balance was cleared for an unknown reason.
This reason is read-only and cannot be used to create a `CLEAR_BALANCE` activity using the Gift Card Activities API. |
-
diff --git a/doc/models/gift-card-activity-clear-balance.md b/doc/models/gift-card-activity-clear-balance.md
deleted file mode 100644
index c2896cb8..00000000
--- a/doc/models/gift-card-activity-clear-balance.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Gift Card Activity Clear Balance
-
-Represents details about a `CLEAR_BALANCE` [gift card activity type](../../doc/models/gift-card-activity-type.md).
-
-## Structure
-
-`GiftCardActivityClearBalance`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `reason` | [`string(GiftCardActivityClearBalanceReason)`](../../doc/models/gift-card-activity-clear-balance-reason.md) | Required | Indicates the reason for clearing the balance of a [gift card](../../doc/models/gift-card.md). | getReason(): string | setReason(string reason): void |
-
-## Example (as JSON)
-
-```json
-{
- "reason": "SUSPICIOUS_ACTIVITY"
-}
-```
-
diff --git a/doc/models/gift-card-activity-deactivate-reason.md b/doc/models/gift-card-activity-deactivate-reason.md
deleted file mode 100644
index 9cc8fd8d..00000000
--- a/doc/models/gift-card-activity-deactivate-reason.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Gift Card Activity Deactivate Reason
-
-Indicates the reason for deactivating a [gift card](../../doc/models/gift-card.md).
-
-## Enumeration
-
-`GiftCardActivityDeactivateReason`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `SUSPICIOUS_ACTIVITY` | The seller suspects suspicious activity. |
-| `UNKNOWN_REASON` | The gift card was deactivated for an unknown reason.
This reason is read-only and cannot be used to create a `DEACTIVATE` activity using the Gift Card Activities API. |
-| `CHARGEBACK_DEACTIVATE` | A chargeback on the gift card purchase (or the gift card load) was ruled in favor of the buyer.
This reason is read-only and cannot be used to create a `DEACTIVATE` activity using the Gift Card Activities API. |
-
diff --git a/doc/models/gift-card-activity-deactivate.md b/doc/models/gift-card-activity-deactivate.md
deleted file mode 100644
index 62512b11..00000000
--- a/doc/models/gift-card-activity-deactivate.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Gift Card Activity Deactivate
-
-Represents details about a `DEACTIVATE` [gift card activity type](../../doc/models/gift-card-activity-type.md).
-
-## Structure
-
-`GiftCardActivityDeactivate`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `reason` | [`string(GiftCardActivityDeactivateReason)`](../../doc/models/gift-card-activity-deactivate-reason.md) | Required | Indicates the reason for deactivating a [gift card](../../doc/models/gift-card.md). | getReason(): string | setReason(string reason): void |
-
-## Example (as JSON)
-
-```json
-{
- "reason": "CHARGEBACK_DEACTIVATE"
-}
-```
-
diff --git a/doc/models/gift-card-activity-import-reversal.md b/doc/models/gift-card-activity-import-reversal.md
deleted file mode 100644
index d4d1366c..00000000
--- a/doc/models/gift-card-activity-import-reversal.md
+++ /dev/null
@@ -1,26 +0,0 @@
-
-# Gift Card Activity Import Reversal
-
-Represents details about an `IMPORT_REVERSAL` [gift card activity type](../../doc/models/gift-card-activity-type.md).
-
-## Structure
-
-`GiftCardActivityImportReversal`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- }
-}
-```
-
diff --git a/doc/models/gift-card-activity-import.md b/doc/models/gift-card-activity-import.md
deleted file mode 100644
index 07f8a5f6..00000000
--- a/doc/models/gift-card-activity-import.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# Gift Card Activity Import
-
-Represents details about an `IMPORT` [gift card activity type](../../doc/models/gift-card-activity-type.md).
-This activity type is used when Square imports a third-party gift card, in which case the
-`gan_source` of the gift card is set to `OTHER`.
-
-## Structure
-
-`GiftCardActivityImport`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- }
-}
-```
-
diff --git a/doc/models/gift-card-activity-load.md b/doc/models/gift-card-activity-load.md
deleted file mode 100644
index a010ef31..00000000
--- a/doc/models/gift-card-activity-load.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-# Gift Card Activity Load
-
-Represents details about a `LOAD` [gift card activity type](../../doc/models/gift-card-activity-type.md).
-
-## Structure
-
-`GiftCardActivityLoad`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `amountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): ?Money | setAmountMoney(?Money amountMoney): void |
-| `orderId` | `?string` | Optional | The ID of the [order](entity:Order) that contains the `GIFT_CARD` line item.
Applications that use the Square Orders API to process orders must specify the order ID in the
[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. | getOrderId(): ?string | setOrderId(?string orderId): void |
-| `lineItemUid` | `?string` | Optional | The UID of the `GIFT_CARD` line item in the order that represents the additional funds for the gift card.
Applications that use the Square Orders API to process orders must specify the line item UID
in the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. | getLineItemUid(): ?string | setLineItemUid(?string lineItemUid): void |
-| `referenceId` | `?string` | Optional | A client-specified ID that associates the gift card activity with an entity in another system.
Applications that use a custom order processing system can use this field to track information related to
an order or payment. | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `buyerPaymentInstrumentIds` | `?(string[])` | Optional | The payment instrument IDs used to process the order for the additional funds, such as a credit card ID
or bank account ID.
Applications that use a custom order processing system must specify payment instrument IDs in
the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request.
Square uses this information to perform compliance checks.
For applications that use the Square Orders API to process payments, Square has the necessary
instrument IDs to perform compliance checks.
Each buyer payment instrument ID can contain a maximum of 255 characters. | getBuyerPaymentInstrumentIds(): ?array | setBuyerPaymentInstrumentIds(?array buyerPaymentInstrumentIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "order_id": "order_id2",
- "line_item_uid": "line_item_uid8",
- "reference_id": "reference_id6",
- "buyer_payment_instrument_ids": [
- "buyer_payment_instrument_ids4",
- "buyer_payment_instrument_ids5"
- ]
-}
-```
-
diff --git a/doc/models/gift-card-activity-redeem-status.md b/doc/models/gift-card-activity-redeem-status.md
deleted file mode 100644
index ea411fbe..00000000
--- a/doc/models/gift-card-activity-redeem-status.md
+++ /dev/null
@@ -1,19 +0,0 @@
-
-# Gift Card Activity Redeem Status
-
-Indicates the status of a [gift card](../../doc/models/gift-card.md) redemption. This status is relevant only for
-redemptions made from Square products (such as Square Point of Sale) because Square products use a
-two-state process. Gift cards redeemed using the Gift Card Activities API always have a `COMPLETED` status.
-
-## Enumeration
-
-`GiftCardActivityRedeemStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `PENDING` | The gift card redemption is pending. `PENDING` is a temporary status that applies when a
gift card is redeemed from Square Point of Sale or another Square product. A `PENDING` status is updated to
`COMPLETED` if the payment is captured or `CANCELED` if the authorization is voided. |
-| `COMPLETED` | The gift card redemption is completed. |
-| `CANCELED` | The gift card redemption is canceled. A redemption is canceled if the authorization
on the gift card is voided. |
-
diff --git a/doc/models/gift-card-activity-redeem.md b/doc/models/gift-card-activity-redeem.md
deleted file mode 100644
index f7fe5997..00000000
--- a/doc/models/gift-card-activity-redeem.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Gift Card Activity Redeem
-
-Represents details about a `REDEEM` [gift card activity type](../../doc/models/gift-card-activity-type.md).
-
-## Structure
-
-`GiftCardActivityRedeem`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-| `paymentId` | `?string` | Optional | The ID of the payment that represents the gift card redemption. Square populates this field
if the payment was processed by Square. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-| `referenceId` | `?string` | Optional | A client-specified ID that associates the gift card activity with an entity in another system.
Applications that use a custom payment processing system can use this field to track information
related to an order or payment. | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `status` | [`?string(GiftCardActivityRedeemStatus)`](../../doc/models/gift-card-activity-redeem-status.md) | Optional | Indicates the status of a [gift card](../../doc/models/gift-card.md) redemption. This status is relevant only for
redemptions made from Square products (such as Square Point of Sale) because Square products use a
two-state process. Gift cards redeemed using the Gift Card Activities API always have a `COMPLETED` status. | getStatus(): ?string | setStatus(?string status): void |
-
-## Example (as JSON)
-
-```json
-{
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "payment_id": "payment_id4",
- "reference_id": "reference_id2",
- "status": "COMPLETED"
-}
-```
-
diff --git a/doc/models/gift-card-activity-refund.md b/doc/models/gift-card-activity-refund.md
deleted file mode 100644
index 6eb9ed00..00000000
--- a/doc/models/gift-card-activity-refund.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Gift Card Activity Refund
-
-Represents details about a `REFUND` [gift card activity type](../../doc/models/gift-card-activity-type.md).
-
-## Structure
-
-`GiftCardActivityRefund`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `redeemActivityId` | `?string` | Optional | The ID of the refunded `REDEEM` gift card activity. Square populates this field if the
`payment_id` in the corresponding [RefundPayment](api-endpoint:Refunds-RefundPayment) request
represents a gift card redemption.
For applications that use a custom payment processing system, this field is required when creating
a `REFUND` activity. The provided `REDEEM` activity ID must be linked to the same gift card. | getRedeemActivityId(): ?string | setRedeemActivityId(?string redeemActivityId): void |
-| `amountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): ?Money | setAmountMoney(?Money amountMoney): void |
-| `referenceId` | `?string` | Optional | A client-specified ID that associates the gift card activity with an entity in another system. | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `paymentId` | `?string` | Optional | The ID of the refunded payment. Square populates this field if the refund is for a
payment processed by Square. This field matches the `payment_id` in the corresponding
[RefundPayment](api-endpoint:Refunds-RefundPayment) request. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "redeem_activity_id": "redeem_activity_id4",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "reference_id": "reference_id8",
- "payment_id": "payment_id4"
-}
-```
-
diff --git a/doc/models/gift-card-activity-transfer-balance-from.md b/doc/models/gift-card-activity-transfer-balance-from.md
deleted file mode 100644
index 3f8f4163..00000000
--- a/doc/models/gift-card-activity-transfer-balance-from.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# Gift Card Activity Transfer Balance From
-
-Represents details about a `TRANSFER_BALANCE_FROM` [gift card activity type](../../doc/models/gift-card-activity-type.md).
-
-## Structure
-
-`GiftCardActivityTransferBalanceFrom`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `transferToGiftCardId` | `string` | Required | The ID of the gift card to which the specified amount was transferred. | getTransferToGiftCardId(): string | setTransferToGiftCardId(string transferToGiftCardId): void |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "transfer_to_gift_card_id": "transfer_to_gift_card_id0",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- }
-}
-```
-
diff --git a/doc/models/gift-card-activity-transfer-balance-to.md b/doc/models/gift-card-activity-transfer-balance-to.md
deleted file mode 100644
index e7b47992..00000000
--- a/doc/models/gift-card-activity-transfer-balance-to.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# Gift Card Activity Transfer Balance To
-
-Represents details about a `TRANSFER_BALANCE_TO` [gift card activity type](../../doc/models/gift-card-activity-type.md).
-
-## Structure
-
-`GiftCardActivityTransferBalanceTo`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `transferFromGiftCardId` | `string` | Required | The ID of the gift card from which the specified amount was transferred. | getTransferFromGiftCardId(): string | setTransferFromGiftCardId(string transferFromGiftCardId): void |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "transfer_from_gift_card_id": "transfer_from_gift_card_id6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- }
-}
-```
-
diff --git a/doc/models/gift-card-activity-type.md b/doc/models/gift-card-activity-type.md
deleted file mode 100644
index 53df15bc..00000000
--- a/doc/models/gift-card-activity-type.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Gift Card Activity Type
-
-Indicates the type of [gift card activity](../../doc/models/gift-card-activity.md).
-
-## Enumeration
-
-`GiftCardActivityType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ACTIVATE` | Activated a gift card with a balance. When a gift card is activated, Square changes
the gift card state from `PENDING` to `ACTIVE`. A gift card must be in the `ACTIVE` state
to be used for other balance-changing activities. |
-| `LOAD` | Loaded a gift card with additional funds. |
-| `REDEEM` | Redeemed a gift card for a purchase. |
-| `CLEAR_BALANCE` | Set the balance of a gift card to zero. |
-| `DEACTIVATE` | Permanently blocked a gift card from balance-changing activities. |
-| `ADJUST_INCREMENT` | Added money to a gift card outside of a typical `ACTIVATE`, `LOAD`, or `REFUND` activity flow. |
-| `ADJUST_DECREMENT` | Deducted money from a gift card outside of a typical `REDEEM` activity flow. |
-| `REFUND` | Added money to a gift card from a refunded transaction. A `REFUND` activity might be linked to
a Square payment, depending on how the payment and refund are processed. For example:
- A payment processed by Square can be refunded to a `PENDING` or `ACTIVE` gift card using the Square
Seller Dashboard, Square Point of Sale, or Refunds API.
- A payment processed using a custom processing system can be refunded to the same gift card. |
-| `UNLINKED_ACTIVITY_REFUND` | Added money to a gift card from a refunded transaction that was processed using a custom payment
processing system and not linked to the gift card. |
-| `IMPORT` | Imported a third-party gift card with a balance. `IMPORT` activities are managed
by Square and cannot be created using the Gift Card Activities API. |
-| `BLOCK` | Temporarily blocked a gift card from balance-changing activities. `BLOCK` activities
are managed by Square and cannot be created using the Gift Card Activities API. |
-| `UNBLOCK` | Unblocked a gift card, which enables it to resume balance-changing activities. `UNBLOCK`
activities are managed by Square and cannot be created using the Gift Card Activities API. |
-| `IMPORT_REVERSAL` | Reversed the import of a third-party gift card, which sets the gift card state to
`PENDING` and clears the balance. `IMPORT_REVERSAL` activities are managed by Square and
cannot be created using the Gift Card Activities API. |
-| `TRANSFER_BALANCE_FROM` | Deducted money from a gift card as the result of a transfer to the balance of another gift card.
`TRANSFER_BALANCE_FROM` activities are managed by Square and cannot be created using the Gift Card Activities API. |
-| `TRANSFER_BALANCE_TO` | Added money to a gift card as the result of a transfer from the balance of another gift card.
`TRANSFER_BALANCE_TO` activities are managed by Square and cannot be created using the Gift Card Activities API. |
-
diff --git a/doc/models/gift-card-activity-unblock-reason.md b/doc/models/gift-card-activity-unblock-reason.md
deleted file mode 100644
index 11ccbda8..00000000
--- a/doc/models/gift-card-activity-unblock-reason.md
+++ /dev/null
@@ -1,15 +0,0 @@
-
-# Gift Card Activity Unblock Reason
-
-Indicates the reason for unblocking a [gift card](../../doc/models/gift-card.md).
-
-## Enumeration
-
-`GiftCardActivityUnblockReason`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `CHARGEBACK_UNBLOCK` | The gift card is unblocked because a chargeback was ruled in favor of the seller. |
-
diff --git a/doc/models/gift-card-activity-unblock.md b/doc/models/gift-card-activity-unblock.md
deleted file mode 100644
index dd6dfa73..00000000
--- a/doc/models/gift-card-activity-unblock.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Gift Card Activity Unblock
-
-Represents details about an `UNBLOCK` [gift card activity type](../../doc/models/gift-card-activity-type.md).
-
-## Structure
-
-`GiftCardActivityUnblock`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `reason` | `string` | Required, Constant | Indicates the reason for unblocking a [gift card](../../doc/models/gift-card.md).
**Default**: `'CHARGEBACK_UNBLOCK'` | getReason(): string | setReason(string reason): void |
-
-## Example (as JSON)
-
-```json
-{
- "reason": "CHARGEBACK_UNBLOCK"
-}
-```
-
diff --git a/doc/models/gift-card-activity-unlinked-activity-refund.md b/doc/models/gift-card-activity-unlinked-activity-refund.md
deleted file mode 100644
index 5cc8afaa..00000000
--- a/doc/models/gift-card-activity-unlinked-activity-refund.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Gift Card Activity Unlinked Activity Refund
-
-Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity type](../../doc/models/gift-card-activity-type.md).
-
-## Structure
-
-`GiftCardActivityUnlinkedActivityRefund`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-| `referenceId` | `?string` | Optional | A client-specified ID that associates the gift card activity with an entity in another system. | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `paymentId` | `?string` | Optional | The ID of the refunded payment. This field is not used starting in Square version 2022-06-16. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "reference_id": "reference_id8",
- "payment_id": "payment_id0"
-}
-```
-
diff --git a/doc/models/gift-card-activity.md b/doc/models/gift-card-activity.md
deleted file mode 100644
index 02e0b0c8..00000000
--- a/doc/models/gift-card-activity.md
+++ /dev/null
@@ -1,55 +0,0 @@
-
-# Gift Card Activity
-
-Represents an action performed on a [gift card](../../doc/models/gift-card.md) that affects its state or balance.
-A gift card activity contains information about a specific activity type. For example, a `REDEEM` activity
-includes a `redeem_activity_details` field that contains information about the redemption.
-
-## Structure
-
-`GiftCardActivity`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The Square-assigned ID of the gift card activity. | getId(): ?string | setId(?string id): void |
-| `type` | [`string(GiftCardActivityType)`](../../doc/models/gift-card-activity-type.md) | Required | Indicates the type of [gift card activity](../../doc/models/gift-card-activity.md). | getType(): string | setType(string type): void |
-| `locationId` | `string` | Required | The ID of the [business location](entity:Location) where the activity occurred. | getLocationId(): string | setLocationId(string locationId): void |
-| `createdAt` | `?string` | Optional | The timestamp when the gift card activity was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `giftCardId` | `?string` | Optional | The gift card ID. When creating a gift card activity, `gift_card_id` is not required if
`gift_card_gan` is specified. | getGiftCardId(): ?string | setGiftCardId(?string giftCardId): void |
-| `giftCardGan` | `?string` | Optional | The gift card account number (GAN). When creating a gift card activity, `gift_card_gan`
is not required if `gift_card_id` is specified. | getGiftCardGan(): ?string | setGiftCardGan(?string giftCardGan): void |
-| `giftCardBalanceMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getGiftCardBalanceMoney(): ?Money | setGiftCardBalanceMoney(?Money giftCardBalanceMoney): void |
-| `loadActivityDetails` | [`?GiftCardActivityLoad`](../../doc/models/gift-card-activity-load.md) | Optional | Represents details about a `LOAD` [gift card activity type](../../doc/models/gift-card-activity-type.md). | getLoadActivityDetails(): ?GiftCardActivityLoad | setLoadActivityDetails(?GiftCardActivityLoad loadActivityDetails): void |
-| `activateActivityDetails` | [`?GiftCardActivityActivate`](../../doc/models/gift-card-activity-activate.md) | Optional | Represents details about an `ACTIVATE` [gift card activity type](../../doc/models/gift-card-activity-type.md). | getActivateActivityDetails(): ?GiftCardActivityActivate | setActivateActivityDetails(?GiftCardActivityActivate activateActivityDetails): void |
-| `redeemActivityDetails` | [`?GiftCardActivityRedeem`](../../doc/models/gift-card-activity-redeem.md) | Optional | Represents details about a `REDEEM` [gift card activity type](../../doc/models/gift-card-activity-type.md). | getRedeemActivityDetails(): ?GiftCardActivityRedeem | setRedeemActivityDetails(?GiftCardActivityRedeem redeemActivityDetails): void |
-| `clearBalanceActivityDetails` | [`?GiftCardActivityClearBalance`](../../doc/models/gift-card-activity-clear-balance.md) | Optional | Represents details about a `CLEAR_BALANCE` [gift card activity type](../../doc/models/gift-card-activity-type.md). | getClearBalanceActivityDetails(): ?GiftCardActivityClearBalance | setClearBalanceActivityDetails(?GiftCardActivityClearBalance clearBalanceActivityDetails): void |
-| `deactivateActivityDetails` | [`?GiftCardActivityDeactivate`](../../doc/models/gift-card-activity-deactivate.md) | Optional | Represents details about a `DEACTIVATE` [gift card activity type](../../doc/models/gift-card-activity-type.md). | getDeactivateActivityDetails(): ?GiftCardActivityDeactivate | setDeactivateActivityDetails(?GiftCardActivityDeactivate deactivateActivityDetails): void |
-| `adjustIncrementActivityDetails` | [`?GiftCardActivityAdjustIncrement`](../../doc/models/gift-card-activity-adjust-increment.md) | Optional | Represents details about an `ADJUST_INCREMENT` [gift card activity type](../../doc/models/gift-card-activity-type.md). | getAdjustIncrementActivityDetails(): ?GiftCardActivityAdjustIncrement | setAdjustIncrementActivityDetails(?GiftCardActivityAdjustIncrement adjustIncrementActivityDetails): void |
-| `adjustDecrementActivityDetails` | [`?GiftCardActivityAdjustDecrement`](../../doc/models/gift-card-activity-adjust-decrement.md) | Optional | Represents details about an `ADJUST_DECREMENT` [gift card activity type](../../doc/models/gift-card-activity-type.md). | getAdjustDecrementActivityDetails(): ?GiftCardActivityAdjustDecrement | setAdjustDecrementActivityDetails(?GiftCardActivityAdjustDecrement adjustDecrementActivityDetails): void |
-| `refundActivityDetails` | [`?GiftCardActivityRefund`](../../doc/models/gift-card-activity-refund.md) | Optional | Represents details about a `REFUND` [gift card activity type](../../doc/models/gift-card-activity-type.md). | getRefundActivityDetails(): ?GiftCardActivityRefund | setRefundActivityDetails(?GiftCardActivityRefund refundActivityDetails): void |
-| `unlinkedActivityRefundActivityDetails` | [`?GiftCardActivityUnlinkedActivityRefund`](../../doc/models/gift-card-activity-unlinked-activity-refund.md) | Optional | Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity type](../../doc/models/gift-card-activity-type.md). | getUnlinkedActivityRefundActivityDetails(): ?GiftCardActivityUnlinkedActivityRefund | setUnlinkedActivityRefundActivityDetails(?GiftCardActivityUnlinkedActivityRefund unlinkedActivityRefundActivityDetails): void |
-| `importActivityDetails` | [`?GiftCardActivityImport`](../../doc/models/gift-card-activity-import.md) | Optional | Represents details about an `IMPORT` [gift card activity type](../../doc/models/gift-card-activity-type.md).
This activity type is used when Square imports a third-party gift card, in which case the
`gan_source` of the gift card is set to `OTHER`. | getImportActivityDetails(): ?GiftCardActivityImport | setImportActivityDetails(?GiftCardActivityImport importActivityDetails): void |
-| `blockActivityDetails` | [`?GiftCardActivityBlock`](../../doc/models/gift-card-activity-block.md) | Optional | Represents details about a `BLOCK` [gift card activity type](../../doc/models/gift-card-activity-type.md). | getBlockActivityDetails(): ?GiftCardActivityBlock | setBlockActivityDetails(?GiftCardActivityBlock blockActivityDetails): void |
-| `unblockActivityDetails` | [`?GiftCardActivityUnblock`](../../doc/models/gift-card-activity-unblock.md) | Optional | Represents details about an `UNBLOCK` [gift card activity type](../../doc/models/gift-card-activity-type.md). | getUnblockActivityDetails(): ?GiftCardActivityUnblock | setUnblockActivityDetails(?GiftCardActivityUnblock unblockActivityDetails): void |
-| `importReversalActivityDetails` | [`?GiftCardActivityImportReversal`](../../doc/models/gift-card-activity-import-reversal.md) | Optional | Represents details about an `IMPORT_REVERSAL` [gift card activity type](../../doc/models/gift-card-activity-type.md). | getImportReversalActivityDetails(): ?GiftCardActivityImportReversal | setImportReversalActivityDetails(?GiftCardActivityImportReversal importReversalActivityDetails): void |
-| `transferBalanceToActivityDetails` | [`?GiftCardActivityTransferBalanceTo`](../../doc/models/gift-card-activity-transfer-balance-to.md) | Optional | Represents details about a `TRANSFER_BALANCE_TO` [gift card activity type](../../doc/models/gift-card-activity-type.md). | getTransferBalanceToActivityDetails(): ?GiftCardActivityTransferBalanceTo | setTransferBalanceToActivityDetails(?GiftCardActivityTransferBalanceTo transferBalanceToActivityDetails): void |
-| `transferBalanceFromActivityDetails` | [`?GiftCardActivityTransferBalanceFrom`](../../doc/models/gift-card-activity-transfer-balance-from.md) | Optional | Represents details about a `TRANSFER_BALANCE_FROM` [gift card activity type](../../doc/models/gift-card-activity-type.md). | getTransferBalanceFromActivityDetails(): ?GiftCardActivityTransferBalanceFrom | setTransferBalanceFromActivityDetails(?GiftCardActivityTransferBalanceFrom transferBalanceFromActivityDetails): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id8",
- "type": "REDEEM",
- "location_id": "location_id2",
- "created_at": "created_at6",
- "gift_card_id": "gift_card_id6",
- "gift_card_gan": "gift_card_gan4",
- "gift_card_balance_money": {
- "amount": 82,
- "currency": "IRR"
- }
-}
-```
-
diff --git a/doc/models/gift-card-gan-source.md b/doc/models/gift-card-gan-source.md
deleted file mode 100644
index f58aa093..00000000
--- a/doc/models/gift-card-gan-source.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Gift Card GAN Source
-
-Indicates the source that generated the gift card
-account number (GAN).
-
-## Enumeration
-
-`GiftCardGANSource`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `SQUARE` | The GAN is generated by Square. |
-| `OTHER` | The GAN is provided by a non-Square system. For more information, see
[Custom GANs](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#custom-gans) or
[Third-party gift cards](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api#third-party-gift-cards). |
-
diff --git a/doc/models/gift-card-status.md b/doc/models/gift-card-status.md
deleted file mode 100644
index 29540465..00000000
--- a/doc/models/gift-card-status.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# Gift Card Status
-
-Indicates the gift card state.
-
-## Enumeration
-
-`GiftCardStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ACTIVE` | The gift card is active and can be used as a payment source. |
-| `DEACTIVATED` | Any activity that changes the gift card balance is permanently forbidden. |
-| `BLOCKED` | Any activity that changes the gift card balance is temporarily forbidden. |
-| `PENDING` | The gift card is pending activation.
This is the initial state when a gift card is created. Typically, you'll call
[CreateGiftCardActivity](../../doc/apis/gift-card-activities.md#create-gift-card-activity) to create an
`ACTIVATE` activity that activates the gift card with an initial balance before first use. |
-
diff --git a/doc/models/gift-card-type.md b/doc/models/gift-card-type.md
deleted file mode 100644
index fff0b7b8..00000000
--- a/doc/models/gift-card-type.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Gift Card Type
-
-Indicates the gift card type.
-
-## Enumeration
-
-`GiftCardType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `PHYSICAL` | A plastic gift card. |
-| `DIGITAL` | A digital gift card. |
-
diff --git a/doc/models/gift-card.md b/doc/models/gift-card.md
deleted file mode 100644
index cd118ac4..00000000
--- a/doc/models/gift-card.md
+++ /dev/null
@@ -1,38 +0,0 @@
-
-# Gift Card
-
-Represents a Square gift card.
-
-## Structure
-
-`GiftCard`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The Square-assigned ID of the gift card. | getId(): ?string | setId(?string id): void |
-| `type` | [`string(GiftCardType)`](../../doc/models/gift-card-type.md) | Required | Indicates the gift card type. | getType(): string | setType(string type): void |
-| `ganSource` | [`?string(GiftCardGANSource)`](../../doc/models/gift-card-gan-source.md) | Optional | Indicates the source that generated the gift card
account number (GAN). | getGanSource(): ?string | setGanSource(?string ganSource): void |
-| `state` | [`?string(GiftCardStatus)`](../../doc/models/gift-card-status.md) | Optional | Indicates the gift card state. | getState(): ?string | setState(?string state): void |
-| `balanceMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getBalanceMoney(): ?Money | setBalanceMoney(?Money balanceMoney): void |
-| `gan` | `?string` | Optional | The gift card account number (GAN). Buyers can use the GAN to make purchases or check
the gift card balance. | getGan(): ?string | setGan(?string gan): void |
-| `createdAt` | `?string` | Optional | The timestamp when the gift card was created, in RFC 3339 format.
In the case of a digital gift card, it is the time when you create a card
(using the Square Point of Sale application, Seller Dashboard, or Gift Cards API).
In the case of a plastic gift card, it is the time when Square associates the card with the
seller at the time of activation. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `customerIds` | `?(string[])` | Optional | The IDs of the [customer profiles](entity:Customer) to whom this gift card is linked. | getCustomerIds(): ?array | setCustomerIds(?array customerIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id0",
- "type": "PHYSICAL",
- "gan_source": "SQUARE",
- "state": "ACTIVE",
- "balance_money": {
- "amount": 146,
- "currency": "BBD"
- },
- "gan": "gan6"
-}
-```
-
diff --git a/doc/models/inventory-adjustment-group.md b/doc/models/inventory-adjustment-group.md
deleted file mode 100644
index 03d70ca0..00000000
--- a/doc/models/inventory-adjustment-group.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Inventory Adjustment Group
-
-## Structure
-
-`InventoryAdjustmentGroup`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A unique ID generated by Square for the
`InventoryAdjustmentGroup`.
**Constraints**: *Maximum Length*: `100` | getId(): ?string | setId(?string id): void |
-| `rootAdjustmentId` | `?string` | Optional | The inventory adjustment of the composed variation.
**Constraints**: *Maximum Length*: `100` | getRootAdjustmentId(): ?string | setRootAdjustmentId(?string rootAdjustmentId): void |
-| `fromState` | [`?string(InventoryState)`](../../doc/models/inventory-state.md) | Optional | Indicates the state of a tracked item quantity in the lifecycle of goods. | getFromState(): ?string | setFromState(?string fromState): void |
-| `toState` | [`?string(InventoryState)`](../../doc/models/inventory-state.md) | Optional | Indicates the state of a tracked item quantity in the lifecycle of goods. | getToState(): ?string | setToState(?string toState): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id4",
- "root_adjustment_id": "root_adjustment_id4",
- "from_state": "WASTE",
- "to_state": "RESERVED_FOR_SALE"
-}
-```
-
diff --git a/doc/models/inventory-adjustment.md b/doc/models/inventory-adjustment.md
deleted file mode 100644
index c6e02edd..00000000
--- a/doc/models/inventory-adjustment.md
+++ /dev/null
@@ -1,46 +0,0 @@
-
-# Inventory Adjustment
-
-Represents a change in state or quantity of product inventory at a
-particular time and location.
-
-## Structure
-
-`InventoryAdjustment`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A unique ID generated by Square for the
`InventoryAdjustment`.
**Constraints**: *Maximum Length*: `100` | getId(): ?string | setId(?string id): void |
-| `referenceId` | `?string` | Optional | An optional ID provided by the application to tie the
`InventoryAdjustment` to an external
system.
**Constraints**: *Maximum Length*: `255` | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `fromState` | [`?string(InventoryState)`](../../doc/models/inventory-state.md) | Optional | Indicates the state of a tracked item quantity in the lifecycle of goods. | getFromState(): ?string | setFromState(?string fromState): void |
-| `toState` | [`?string(InventoryState)`](../../doc/models/inventory-state.md) | Optional | Indicates the state of a tracked item quantity in the lifecycle of goods. | getToState(): ?string | setToState(?string toState): void |
-| `locationId` | `?string` | Optional | The Square-generated ID of the [Location](entity:Location) where the related
quantity of items is being tracked.
**Constraints**: *Maximum Length*: `100` | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `catalogObjectId` | `?string` | Optional | The Square-generated ID of the
[CatalogObject](entity:CatalogObject) being tracked.
**Constraints**: *Maximum Length*: `100` | getCatalogObjectId(): ?string | setCatalogObjectId(?string catalogObjectId): void |
-| `catalogObjectType` | `?string` | Optional | The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked.
The Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value.
In addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app.
**Constraints**: *Maximum Length*: `14` | getCatalogObjectType(): ?string | setCatalogObjectType(?string catalogObjectType): void |
-| `quantity` | `?string` | Optional | The number of items affected by the adjustment as a decimal string.
Can support up to 5 digits after the decimal point.
**Constraints**: *Maximum Length*: `26` | getQuantity(): ?string | setQuantity(?string quantity): void |
-| `totalPriceMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalPriceMoney(): ?Money | setTotalPriceMoney(?Money totalPriceMoney): void |
-| `occurredAt` | `?string` | Optional | A client-generated RFC 3339-formatted timestamp that indicates when
the inventory adjustment took place. For inventory adjustment updates, the `occurred_at`
timestamp cannot be older than 24 hours or in the future relative to the
time of the request.
**Constraints**: *Maximum Length*: `34` | getOccurredAt(): ?string | setOccurredAt(?string occurredAt): void |
-| `createdAt` | `?string` | Optional | An RFC 3339-formatted timestamp that indicates when the inventory adjustment is received.
**Constraints**: *Maximum Length*: `34` | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `source` | [`?SourceApplication`](../../doc/models/source-application.md) | Optional | Represents information about the application used to generate a change. | getSource(): ?SourceApplication | setSource(?SourceApplication source): void |
-| `employeeId` | `?string` | Optional | The Square-generated ID of the [Employee](entity:Employee) responsible for the
inventory adjustment.
**Constraints**: *Maximum Length*: `100` | getEmployeeId(): ?string | setEmployeeId(?string employeeId): void |
-| `teamMemberId` | `?string` | Optional | The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the
inventory adjustment.
**Constraints**: *Maximum Length*: `100` | getTeamMemberId(): ?string | setTeamMemberId(?string teamMemberId): void |
-| `transactionId` | `?string` | Optional | The Square-generated ID of the [Transaction](entity:Transaction) that
caused the adjustment. Only relevant for payment-related state
transitions.
**Constraints**: *Maximum Length*: `255` | getTransactionId(): ?string | setTransactionId(?string transactionId): void |
-| `refundId` | `?string` | Optional | The Square-generated ID of the [Refund](entity:Refund) that
caused the adjustment. Only relevant for refund-related state
transitions.
**Constraints**: *Maximum Length*: `255` | getRefundId(): ?string | setRefundId(?string refundId): void |
-| `purchaseOrderId` | `?string` | Optional | The Square-generated ID of the purchase order that caused the
adjustment. Only relevant for state transitions from the Square for Retail
app.
**Constraints**: *Maximum Length*: `100` | getPurchaseOrderId(): ?string | setPurchaseOrderId(?string purchaseOrderId): void |
-| `goodsReceiptId` | `?string` | Optional | The Square-generated ID of the goods receipt that caused the
adjustment. Only relevant for state transitions from the Square for Retail
app.
**Constraints**: *Maximum Length*: `100` | getGoodsReceiptId(): ?string | setGoodsReceiptId(?string goodsReceiptId): void |
-| `adjustmentGroup` | [`?InventoryAdjustmentGroup`](../../doc/models/inventory-adjustment-group.md) | Optional | - | getAdjustmentGroup(): ?InventoryAdjustmentGroup | setAdjustmentGroup(?InventoryAdjustmentGroup adjustmentGroup): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id6",
- "reference_id": "reference_id6",
- "from_state": "WASTE",
- "to_state": "RESERVED_FOR_SALE",
- "location_id": "location_id0"
-}
-```
-
diff --git a/doc/models/inventory-alert-type.md b/doc/models/inventory-alert-type.md
deleted file mode 100644
index 0d9e9d47..00000000
--- a/doc/models/inventory-alert-type.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Inventory Alert Type
-
-Indicates whether Square should alert the merchant when the inventory quantity of a CatalogItemVariation is low.
-
-## Enumeration
-
-`InventoryAlertType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `NONE` | The variation does not display an alert. |
-| `LOW_QUANTITY` | The variation generates an alert when its quantity is low. |
-
diff --git a/doc/models/inventory-change-type.md b/doc/models/inventory-change-type.md
deleted file mode 100644
index bc4f17b5..00000000
--- a/doc/models/inventory-change-type.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Inventory Change Type
-
-Indicates how the inventory change was applied to a tracked product quantity.
-
-## Enumeration
-
-`InventoryChangeType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `PHYSICAL_COUNT` | The change occurred as part of a physical count update. |
-| `ADJUSTMENT` | The change occurred as part of the normal lifecycle of goods
(e.g., as an inventory adjustment). |
-| `TRANSFER` | The change occurred as part of an inventory transfer. |
-
diff --git a/doc/models/inventory-change.md b/doc/models/inventory-change.md
deleted file mode 100644
index b9ed2822..00000000
--- a/doc/models/inventory-change.md
+++ /dev/null
@@ -1,64 +0,0 @@
-
-# Inventory Change
-
-Represents a single physical count, inventory, adjustment, or transfer
-that is part of the history of inventory changes for a particular
-[CatalogObject](../../doc/models/catalog-object.md) instance.
-
-## Structure
-
-`InventoryChange`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `type` | [`?string(InventoryChangeType)`](../../doc/models/inventory-change-type.md) | Optional | Indicates how the inventory change was applied to a tracked product quantity. | getType(): ?string | setType(?string type): void |
-| `physicalCount` | [`?InventoryPhysicalCount`](../../doc/models/inventory-physical-count.md) | Optional | Represents the quantity of an item variation that is physically present
at a specific location, verified by a seller or a seller's employee. For example,
a physical count might come from an employee counting the item variations on
hand or from syncing with an external system. | getPhysicalCount(): ?InventoryPhysicalCount | setPhysicalCount(?InventoryPhysicalCount physicalCount): void |
-| `adjustment` | [`?InventoryAdjustment`](../../doc/models/inventory-adjustment.md) | Optional | Represents a change in state or quantity of product inventory at a
particular time and location. | getAdjustment(): ?InventoryAdjustment | setAdjustment(?InventoryAdjustment adjustment): void |
-| `transfer` | [`?InventoryTransfer`](../../doc/models/inventory-transfer.md) | Optional | Represents the transfer of a quantity of product inventory at a
particular time from one location to another. | getTransfer(): ?InventoryTransfer | setTransfer(?InventoryTransfer transfer): void |
-| `measurementUnit` | [`?CatalogMeasurementUnit`](../../doc/models/catalog-measurement-unit.md) | Optional | Represents the unit used to measure a `CatalogItemVariation` and
specifies the precision for decimal quantities. | getMeasurementUnit(): ?CatalogMeasurementUnit | setMeasurementUnit(?CatalogMeasurementUnit measurementUnit): void |
-| `measurementUnitId` | `?string` | Optional | The ID of the [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change. | getMeasurementUnitId(): ?string | setMeasurementUnitId(?string measurementUnitId): void |
-
-## Example (as JSON)
-
-```json
-{
- "type": "ADJUSTMENT",
- "physical_count": {
- "id": "id2",
- "reference_id": "reference_id0",
- "catalog_object_id": "catalog_object_id6",
- "catalog_object_type": "catalog_object_type6",
- "state": "SUPPORTED_BY_NEWER_VERSION"
- },
- "adjustment": {
- "id": "id4",
- "reference_id": "reference_id2",
- "from_state": "IN_TRANSIT_TO",
- "to_state": "SOLD",
- "location_id": "location_id8"
- },
- "transfer": {
- "id": "id8",
- "reference_id": "reference_id6",
- "state": "RESERVED_FOR_SALE",
- "from_location_id": "from_location_id0",
- "to_location_id": "to_location_id0"
- },
- "measurement_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 184
- }
-}
-```
-
diff --git a/doc/models/inventory-count.md b/doc/models/inventory-count.md
deleted file mode 100644
index e93994f3..00000000
--- a/doc/models/inventory-count.md
+++ /dev/null
@@ -1,35 +0,0 @@
-
-# Inventory Count
-
-Represents Square-estimated quantity of items in a particular state at a
-particular seller location based on the known history of physical counts and
-inventory adjustments.
-
-## Structure
-
-`InventoryCount`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `catalogObjectId` | `?string` | Optional | The Square-generated ID of the
[CatalogObject](entity:CatalogObject) being tracked.
**Constraints**: *Maximum Length*: `100` | getCatalogObjectId(): ?string | setCatalogObjectId(?string catalogObjectId): void |
-| `catalogObjectType` | `?string` | Optional | The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked.
The Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value.
In addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app.
**Constraints**: *Maximum Length*: `14` | getCatalogObjectType(): ?string | setCatalogObjectType(?string catalogObjectType): void |
-| `state` | [`?string(InventoryState)`](../../doc/models/inventory-state.md) | Optional | Indicates the state of a tracked item quantity in the lifecycle of goods. | getState(): ?string | setState(?string state): void |
-| `locationId` | `?string` | Optional | The Square-generated ID of the [Location](entity:Location) where the related
quantity of items is being tracked.
**Constraints**: *Maximum Length*: `100` | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `quantity` | `?string` | Optional | The number of items affected by the estimated count as a decimal string.
Can support up to 5 digits after the decimal point.
**Constraints**: *Maximum Length*: `26` | getQuantity(): ?string | setQuantity(?string quantity): void |
-| `calculatedAt` | `?string` | Optional | An RFC 3339-formatted timestamp that indicates when the most recent physical count or adjustment affecting
the estimated count is received.
**Constraints**: *Maximum Length*: `34` | getCalculatedAt(): ?string | setCalculatedAt(?string calculatedAt): void |
-| `isEstimated` | `?bool` | Optional | Whether the inventory count is for composed variation (TRUE) or not (FALSE). If true, the inventory count will not be present in the response of
any of these endpoints: [BatchChangeInventory](../../doc/apis/inventory.md#batch-change-inventory),
[BatchRetrieveInventoryChanges](../../doc/apis/inventory.md#batch-retrieve-inventory-changes),
[BatchRetrieveInventoryCounts](../../doc/apis/inventory.md#batch-retrieve-inventory-counts), and
[RetrieveInventoryChanges](../../doc/apis/inventory.md#retrieve-inventory-changes). | getIsEstimated(): ?bool | setIsEstimated(?bool isEstimated): void |
-
-## Example (as JSON)
-
-```json
-{
- "catalog_object_id": "catalog_object_id4",
- "catalog_object_type": "catalog_object_type4",
- "state": "SOLD",
- "location_id": "location_id6",
- "quantity": "quantity8"
-}
-```
-
diff --git a/doc/models/inventory-physical-count.md b/doc/models/inventory-physical-count.md
deleted file mode 100644
index 006729c3..00000000
--- a/doc/models/inventory-physical-count.md
+++ /dev/null
@@ -1,41 +0,0 @@
-
-# Inventory Physical Count
-
-Represents the quantity of an item variation that is physically present
-at a specific location, verified by a seller or a seller's employee. For example,
-a physical count might come from an employee counting the item variations on
-hand or from syncing with an external system.
-
-## Structure
-
-`InventoryPhysicalCount`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A unique Square-generated ID for the
[InventoryPhysicalCount](entity:InventoryPhysicalCount).
**Constraints**: *Maximum Length*: `100` | getId(): ?string | setId(?string id): void |
-| `referenceId` | `?string` | Optional | An optional ID provided by the application to tie the
[InventoryPhysicalCount](entity:InventoryPhysicalCount) to an external
system.
**Constraints**: *Maximum Length*: `255` | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `catalogObjectId` | `?string` | Optional | The Square-generated ID of the
[CatalogObject](entity:CatalogObject) being tracked.
**Constraints**: *Maximum Length*: `100` | getCatalogObjectId(): ?string | setCatalogObjectId(?string catalogObjectId): void |
-| `catalogObjectType` | `?string` | Optional | The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked.
The Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value.
In addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app.
**Constraints**: *Maximum Length*: `14` | getCatalogObjectType(): ?string | setCatalogObjectType(?string catalogObjectType): void |
-| `state` | [`?string(InventoryState)`](../../doc/models/inventory-state.md) | Optional | Indicates the state of a tracked item quantity in the lifecycle of goods. | getState(): ?string | setState(?string state): void |
-| `locationId` | `?string` | Optional | The Square-generated ID of the [Location](entity:Location) where the related
quantity of items is being tracked.
**Constraints**: *Maximum Length*: `100` | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `quantity` | `?string` | Optional | The number of items affected by the physical count as a decimal string.
The number can support up to 5 digits after the decimal point.
**Constraints**: *Maximum Length*: `26` | getQuantity(): ?string | setQuantity(?string quantity): void |
-| `source` | [`?SourceApplication`](../../doc/models/source-application.md) | Optional | Represents information about the application used to generate a change. | getSource(): ?SourceApplication | setSource(?SourceApplication source): void |
-| `employeeId` | `?string` | Optional | The Square-generated ID of the [Employee](entity:Employee) responsible for the
physical count.
**Constraints**: *Maximum Length*: `100` | getEmployeeId(): ?string | setEmployeeId(?string employeeId): void |
-| `teamMemberId` | `?string` | Optional | The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the
physical count.
**Constraints**: *Maximum Length*: `100` | getTeamMemberId(): ?string | setTeamMemberId(?string teamMemberId): void |
-| `occurredAt` | `?string` | Optional | A client-generated RFC 3339-formatted timestamp that indicates when
the physical count was examined. For physical count updates, the `occurred_at`
timestamp cannot be older than 24 hours or in the future relative to the
time of the request.
**Constraints**: *Maximum Length*: `34` | getOccurredAt(): ?string | setOccurredAt(?string occurredAt): void |
-| `createdAt` | `?string` | Optional | An RFC 3339-formatted timestamp that indicates when the physical count is received.
**Constraints**: *Maximum Length*: `34` | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id0",
- "reference_id": "reference_id8",
- "catalog_object_id": "catalog_object_id4",
- "catalog_object_type": "catalog_object_type4",
- "state": "COMPOSED"
-}
-```
-
diff --git a/doc/models/inventory-state.md b/doc/models/inventory-state.md
deleted file mode 100644
index a50a2208..00000000
--- a/doc/models/inventory-state.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Inventory State
-
-Indicates the state of a tracked item quantity in the lifecycle of goods.
-
-## Enumeration
-
-`InventoryState`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `CUSTOM` | The related quantity of items are in a custom state. **READ-ONLY**:
the Inventory API cannot move quantities to or from this state. |
-| `IN_STOCK` | The related quantity of items are on hand and available for sale. |
-| `SOLD` | The related quantity of items were sold as part of an itemized
transaction. Quantities in the `SOLD` state are no longer tracked. |
-| `RETURNED_BY_CUSTOMER` | The related quantity of items were returned through the Square Point
of Sale application, but are not yet available for sale. **READ-ONLY**:
the Inventory API cannot move quantities to or from this state. |
-| `RESERVED_FOR_SALE` | The related quantity of items are on hand, but not currently
available for sale. **READ-ONLY**: the Inventory API cannot move
quantities to or from this state. |
-| `SOLD_ONLINE` | The related quantity of items were sold online. **READ-ONLY**: the
Inventory API cannot move quantities to or from this state. |
-| `ORDERED_FROM_VENDOR` | The related quantity of items were ordered from a vendor but not yet
received. **READ-ONLY**: the Inventory API cannot move quantities to or
from this state. |
-| `RECEIVED_FROM_VENDOR` | The related quantity of items were received from a vendor but are
not yet available for sale. **READ-ONLY**: the Inventory API cannot move
quantities to or from this state. |
-| `IN_TRANSIT_TO` | Replaced by `IN_TRANSIT` to represent quantities
of items that are in transit between locations. |
-| `NONE` | A placeholder indicating that the related quantity of items are not
currently tracked in Square. Transferring quantities from the `NONE` state
to a tracked state (e.g., `IN_STOCK`) introduces stock into the system. |
-| `WASTE` | The related quantity of items are lost or damaged and cannot be
sold. |
-| `UNLINKED_RETURN` | The related quantity of items were returned but not linked to a
previous transaction. Unlinked returns are not tracked in Square.
Transferring a quantity from `UNLINKED_RETURN` to a tracked state (e.g.,
`IN_STOCK`) introduces new stock into the system. |
-| `COMPOSED` | The related quantity of items that are part of a composition consisting one or more components. |
-| `DECOMPOSED` | The related quantity of items that are part of a component. |
-| `SUPPORTED_BY_NEWER_VERSION` | This state is not supported by this version of the Square API. We recommend that you upgrade the client to use the appropriate version of the Square API supporting this state. |
-| `IN_TRANSIT` | The related quantity of items are in transit between locations. **READ-ONLY:** the Inventory API cannot currently be used to move quantities to or from this inventory state. |
-
diff --git a/doc/models/inventory-transfer.md b/doc/models/inventory-transfer.md
deleted file mode 100644
index 4e3f7f18..00000000
--- a/doc/models/inventory-transfer.md
+++ /dev/null
@@ -1,40 +0,0 @@
-
-# Inventory Transfer
-
-Represents the transfer of a quantity of product inventory at a
-particular time from one location to another.
-
-## Structure
-
-`InventoryTransfer`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A unique ID generated by Square for the
`InventoryTransfer`.
**Constraints**: *Maximum Length*: `100` | getId(): ?string | setId(?string id): void |
-| `referenceId` | `?string` | Optional | An optional ID provided by the application to tie the
`InventoryTransfer` to an external system.
**Constraints**: *Maximum Length*: `255` | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `state` | [`?string(InventoryState)`](../../doc/models/inventory-state.md) | Optional | Indicates the state of a tracked item quantity in the lifecycle of goods. | getState(): ?string | setState(?string state): void |
-| `fromLocationId` | `?string` | Optional | The Square-generated ID of the [Location](entity:Location) where the related
quantity of items was tracked before the transfer.
**Constraints**: *Maximum Length*: `100` | getFromLocationId(): ?string | setFromLocationId(?string fromLocationId): void |
-| `toLocationId` | `?string` | Optional | The Square-generated ID of the [Location](entity:Location) where the related
quantity of items was tracked after the transfer.
**Constraints**: *Maximum Length*: `100` | getToLocationId(): ?string | setToLocationId(?string toLocationId): void |
-| `catalogObjectId` | `?string` | Optional | The Square-generated ID of the
[CatalogObject](entity:CatalogObject) being tracked.
**Constraints**: *Maximum Length*: `100` | getCatalogObjectId(): ?string | setCatalogObjectId(?string catalogObjectId): void |
-| `catalogObjectType` | `?string` | Optional | The [type](entity:CatalogObjectType) of the [CatalogObject](entity:CatalogObject) being tracked.
The Inventory API supports setting and reading the `"catalog_object_type": "ITEM_VARIATION"` field value.
In addition, it can also read the `"catalog_object_type": "ITEM"` field value that is set by the Square Restaurants app.
**Constraints**: *Maximum Length*: `14` | getCatalogObjectType(): ?string | setCatalogObjectType(?string catalogObjectType): void |
-| `quantity` | `?string` | Optional | The number of items affected by the transfer as a decimal string.
Can support up to 5 digits after the decimal point.
**Constraints**: *Maximum Length*: `26` | getQuantity(): ?string | setQuantity(?string quantity): void |
-| `occurredAt` | `?string` | Optional | A client-generated RFC 3339-formatted timestamp that indicates when
the transfer took place. For write actions, the `occurred_at` timestamp
cannot be older than 24 hours or in the future relative to the time of the
request.
**Constraints**: *Maximum Length*: `34` | getOccurredAt(): ?string | setOccurredAt(?string occurredAt): void |
-| `createdAt` | `?string` | Optional | An RFC 3339-formatted timestamp that indicates when Square
received the transfer request.
**Constraints**: *Maximum Length*: `34` | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `source` | [`?SourceApplication`](../../doc/models/source-application.md) | Optional | Represents information about the application used to generate a change. | getSource(): ?SourceApplication | setSource(?SourceApplication source): void |
-| `employeeId` | `?string` | Optional | The Square-generated ID of the [Employee](entity:Employee) responsible for the
inventory transfer.
**Constraints**: *Maximum Length*: `100` | getEmployeeId(): ?string | setEmployeeId(?string employeeId): void |
-| `teamMemberId` | `?string` | Optional | The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the
inventory transfer.
**Constraints**: *Maximum Length*: `100` | getTeamMemberId(): ?string | setTeamMemberId(?string teamMemberId): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id8",
- "reference_id": "reference_id4",
- "state": "ORDERED_FROM_VENDOR",
- "from_location_id": "from_location_id0",
- "to_location_id": "to_location_id0"
-}
-```
-
diff --git a/doc/models/invoice-accepted-payment-methods.md b/doc/models/invoice-accepted-payment-methods.md
deleted file mode 100644
index af0b3a0e..00000000
--- a/doc/models/invoice-accepted-payment-methods.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Invoice Accepted Payment Methods
-
-The payment methods that customers can use to pay an [invoice](../../doc/models/invoice.md) on the Square-hosted invoice payment page.
-
-## Structure
-
-`InvoiceAcceptedPaymentMethods`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `card` | `?bool` | Optional | Indicates whether credit card or debit card payments are accepted. The default value is `false`. | getCard(): ?bool | setCard(?bool card): void |
-| `squareGiftCard` | `?bool` | Optional | Indicates whether Square gift card payments are accepted. The default value is `false`. | getSquareGiftCard(): ?bool | setSquareGiftCard(?bool squareGiftCard): void |
-| `bankAccount` | `?bool` | Optional | Indicates whether ACH bank transfer payments are accepted. The default value is `false`. | getBankAccount(): ?bool | setBankAccount(?bool bankAccount): void |
-| `buyNowPayLater` | `?bool` | Optional | Indicates whether Afterpay (also known as Clearpay) payments are accepted. The default value is `false`.
This option is allowed only for invoices that have a single payment request of the `BALANCE` type. This payment method is
supported if the seller account accepts Afterpay payments and the seller location is in a country where Afterpay
invoice payments are supported. As a best practice, consider enabling an additional payment method when allowing
`buy_now_pay_later` payments. For more information, including detailed requirements and processing limits, see
[Buy Now Pay Later payments with Afterpay](https://developer.squareup.com/docs/invoices-api/overview#buy-now-pay-later). | getBuyNowPayLater(): ?bool | setBuyNowPayLater(?bool buyNowPayLater): void |
-| `cashAppPay` | `?bool` | Optional | Indicates whether Cash App payments are accepted. The default value is `false`.
This payment method is supported only for seller [locations](entity:Location) in the United States. | getCashAppPay(): ?bool | setCashAppPay(?bool cashAppPay): void |
-
-## Example (as JSON)
-
-```json
-{
- "card": false,
- "square_gift_card": false,
- "bank_account": false,
- "buy_now_pay_later": false,
- "cash_app_pay": false
-}
-```
-
diff --git a/doc/models/invoice-attachment.md b/doc/models/invoice-attachment.md
deleted file mode 100644
index 054cffd6..00000000
--- a/doc/models/invoice-attachment.md
+++ /dev/null
@@ -1,33 +0,0 @@
-
-# Invoice Attachment
-
-Represents a file attached to an [invoice](../../doc/models/invoice.md).
-
-## Structure
-
-`InvoiceAttachment`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The Square-assigned ID of the attachment. | getId(): ?string | setId(?string id): void |
-| `filename` | `?string` | Optional | The file name of the attachment, which is displayed on the invoice. | getFilename(): ?string | setFilename(?string filename): void |
-| `description` | `?string` | Optional | The description of the attachment, which is displayed on the invoice.
This field maps to the seller-defined **Message** field. | getDescription(): ?string | setDescription(?string description): void |
-| `filesize` | `?int` | Optional | The file size of the attachment in bytes. | getFilesize(): ?int | setFilesize(?int filesize): void |
-| `hash` | `?string` | Optional | The MD5 hash that was generated from the file contents. | getHash(): ?string | setHash(?string hash): void |
-| `mimeType` | `?string` | Optional | The mime type of the attachment.
The following mime types are supported:
image/gif, image/jpeg, image/png, image/tiff, image/bmp, application/pdf. | getMimeType(): ?string | setMimeType(?string mimeType): void |
-| `uploadedAt` | `?string` | Optional | The timestamp when the attachment was uploaded, in RFC 3339 format. | getUploadedAt(): ?string | setUploadedAt(?string uploadedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id4",
- "filename": "filename6",
- "description": "description6",
- "filesize": 164,
- "hash": "hash0"
-}
-```
-
diff --git a/doc/models/invoice-automatic-payment-source.md b/doc/models/invoice-automatic-payment-source.md
deleted file mode 100644
index 5f6f256d..00000000
--- a/doc/models/invoice-automatic-payment-source.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Invoice Automatic Payment Source
-
-Indicates the automatic payment method for an [invoice payment request](../../doc/models/invoice-payment-request.md).
-
-## Enumeration
-
-`InvoiceAutomaticPaymentSource`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `NONE` | An automatic payment is not configured for the payment request. |
-| `CARD_ON_FILE` | Use a card on file as the automatic payment method. On the due date, Square charges the card
for the amount of the payment request.
For `CARD_ON_FILE` payments, the invoice delivery method must be `EMAIL` and `card_id` must be
specified for the payment request before the invoice can be published. |
-| `BANK_ON_FILE` | Use a bank account on file as the automatic payment method. On the due date, Square charges the bank
account for the amount of the payment request if the buyer has approved the payment. The buyer receives a
request to approve the payment when the invoice is sent or the invoice is updated.
This payment method applies only to invoices that sellers create in the Seller Dashboard or other
Square product. The bank account is provided by the customer during the payment flow.
You cannot set `BANK_ON_FILE` as a payment method using the Invoices API, but you can change a `BANK_ON_FILE`
payment method to `NONE` or `CARD_ON_FILE`. For `BANK_ON_FILE` payments, the invoice delivery method must be `EMAIL`. |
-
diff --git a/doc/models/invoice-custom-field-placement.md b/doc/models/invoice-custom-field-placement.md
deleted file mode 100644
index 4d4ceb92..00000000
--- a/doc/models/invoice-custom-field-placement.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Invoice Custom Field Placement
-
-Indicates where to render a custom field on the Square-hosted invoice page and in emailed or PDF
-copies of the invoice.
-
-## Enumeration
-
-`InvoiceCustomFieldPlacement`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ABOVE_LINE_ITEMS` | Render the custom field above the invoice line items. |
-| `BELOW_LINE_ITEMS` | Render the custom field below the invoice line items. |
-
diff --git a/doc/models/invoice-custom-field.md b/doc/models/invoice-custom-field.md
deleted file mode 100644
index ec43068b..00000000
--- a/doc/models/invoice-custom-field.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Invoice Custom Field
-
-An additional seller-defined and customer-facing field to include on the invoice. For more information,
-see [Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields).
-
-Adding custom fields to an invoice requires an
-[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).
-
-## Structure
-
-`InvoiceCustomField`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `label` | `?string` | Optional | The label or title of the custom field. This field is required for a custom field.
**Constraints**: *Maximum Length*: `30` | getLabel(): ?string | setLabel(?string label): void |
-| `value` | `?string` | Optional | The text of the custom field. If omitted, only the label is rendered.
**Constraints**: *Maximum Length*: `2000` | getValue(): ?string | setValue(?string value): void |
-| `placement` | [`?string(InvoiceCustomFieldPlacement)`](../../doc/models/invoice-custom-field-placement.md) | Optional | Indicates where to render a custom field on the Square-hosted invoice page and in emailed or PDF
copies of the invoice. | getPlacement(): ?string | setPlacement(?string placement): void |
-
-## Example (as JSON)
-
-```json
-{
- "label": "label6",
- "value": "value8",
- "placement": "ABOVE_LINE_ITEMS"
-}
-```
-
diff --git a/doc/models/invoice-delivery-method.md b/doc/models/invoice-delivery-method.md
deleted file mode 100644
index 80ade49a..00000000
--- a/doc/models/invoice-delivery-method.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Invoice Delivery Method
-
-Indicates how Square delivers the [invoice](../../doc/models/invoice.md) to the customer.
-
-## Enumeration
-
-`InvoiceDeliveryMethod`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `EMAIL` | Directs Square to send invoices, reminders, and receipts to the customer using email. |
-| `SHARE_MANUALLY` | Directs Square to take no action on the invoice. In this case, the seller
or application developer follows up with the customer for payment. For example,
a seller might collect a payment in the Seller Dashboard or Point of Sale (POS) application.
The seller might also share the URL of the Square-hosted invoice page (`public_url`) with the customer to request payment. |
-| `SMS` | Directs Square to send invoices and receipts to the customer using SMS (text message).
You cannot set `SMS` as a delivery method using the Invoices API, but you can change an `SMS` delivery method to `EMAIL` or `SHARE_MANUALLY`. |
-
diff --git a/doc/models/invoice-filter.md b/doc/models/invoice-filter.md
deleted file mode 100644
index 0d40ebe0..00000000
--- a/doc/models/invoice-filter.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Invoice Filter
-
-Describes query filters to apply.
-
-## Structure
-
-`InvoiceFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationIds` | `string[]` | Required | Limits the search to the specified locations. A location is required.
In the current implementation, only one location can be specified. | getLocationIds(): array | setLocationIds(array locationIds): void |
-| `customerIds` | `?(string[])` | Optional | Limits the search to the specified customers, within the specified locations.
Specifying a customer is optional. In the current implementation,
a maximum of one customer can be specified. | getCustomerIds(): ?array | setCustomerIds(?array customerIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_ids": [
- "location_ids0",
- "location_ids1",
- "location_ids2"
- ],
- "customer_ids": [
- "customer_ids3",
- "customer_ids2"
- ]
-}
-```
-
diff --git a/doc/models/invoice-payment-reminder-status.md b/doc/models/invoice-payment-reminder-status.md
deleted file mode 100644
index cc78753c..00000000
--- a/doc/models/invoice-payment-reminder-status.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Invoice Payment Reminder Status
-
-The status of a payment request reminder.
-
-## Enumeration
-
-`InvoicePaymentReminderStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `PENDING` | The reminder will be sent on the `relative_scheduled_date` (if the invoice is published). |
-| `NOT_APPLICABLE` | The reminder is not applicable and is not sent. The following are examples
of when reminders are not applicable and are not sent:
- You schedule a reminder to be sent before the invoice is published.
- The invoice is configured with multiple payment requests and a payment request reminder
is configured to be sent after the next payment request `due_date`.
- Two reminders (for different payment requests) are configured to be sent on the
same date. Therefore, only one reminder is sent.
- You configure a reminder to be sent on the date that the invoice is scheduled to be sent.
- The payment request is already paid.
- The invoice status is `CANCELED` or `FAILED`. |
-| `SENT` | The reminder is sent. |
-
diff --git a/doc/models/invoice-payment-reminder.md b/doc/models/invoice-payment-reminder.md
deleted file mode 100644
index 22e9b97e..00000000
--- a/doc/models/invoice-payment-reminder.md
+++ /dev/null
@@ -1,33 +0,0 @@
-
-# Invoice Payment Reminder
-
-Describes a payment request reminder (automatic notification) that Square sends
-to the customer. You configure a reminder relative to the payment request
-`due_date`.
-
-## Structure
-
-`InvoicePaymentReminder`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A Square-assigned ID that uniquely identifies the reminder within the
`InvoicePaymentRequest`. | getUid(): ?string | setUid(?string uid): void |
-| `relativeScheduledDays` | `?int` | Optional | The number of days before (a negative number) or after (a positive number)
the payment request `due_date` when the reminder is sent. For example, -3 indicates that
the reminder should be sent 3 days before the payment request `due_date`.
**Constraints**: `>= -32767`, `<= 32767` | getRelativeScheduledDays(): ?int | setRelativeScheduledDays(?int relativeScheduledDays): void |
-| `message` | `?string` | Optional | The reminder message.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `1000` | getMessage(): ?string | setMessage(?string message): void |
-| `status` | [`?string(InvoicePaymentReminderStatus)`](../../doc/models/invoice-payment-reminder-status.md) | Optional | The status of a payment request reminder. | getStatus(): ?string | setStatus(?string status): void |
-| `sentAt` | `?string` | Optional | If sent, the timestamp when the reminder was sent, in RFC 3339 format. | getSentAt(): ?string | setSentAt(?string sentAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid6",
- "relative_scheduled_days": 198,
- "message": "message4",
- "status": "SENT",
- "sent_at": "sent_at6"
-}
-```
-
diff --git a/doc/models/invoice-payment-request.md b/doc/models/invoice-payment-request.md
deleted file mode 100644
index 7c8a13d1..00000000
--- a/doc/models/invoice-payment-request.md
+++ /dev/null
@@ -1,47 +0,0 @@
-
-# Invoice Payment Request
-
-Represents a payment request for an [invoice](../../doc/models/invoice.md). Invoices can specify a maximum
-of 13 payment requests, with up to 12 `INSTALLMENT` request types. For more information,
-see [Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).
-
-Adding `INSTALLMENT` payment requests to an invoice requires an
-[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).
-
-## Structure
-
-`InvoicePaymentRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | The Square-generated ID of the payment request in an [invoice](entity:Invoice).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getUid(): ?string | setUid(?string uid): void |
-| `requestMethod` | [`?string(InvoiceRequestMethod)`](../../doc/models/invoice-request-method.md) | Optional | Specifies the action for Square to take for processing the invoice. For example,
email the invoice, charge a customer's card on file, or do nothing. DEPRECATED at
version 2021-01-21. The corresponding `request_method` field is replaced by the
`Invoice.delivery_method` and `InvoicePaymentRequest.automatic_payment_source` fields. | getRequestMethod(): ?string | setRequestMethod(?string requestMethod): void |
-| `requestType` | [`?string(InvoiceRequestType)`](../../doc/models/invoice-request-type.md) | Optional | Indicates the type of the payment request. For more information, see
[Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests). | getRequestType(): ?string | setRequestType(?string requestType): void |
-| `dueDate` | `?string` | Optional | The due date (in the invoice's time zone) for the payment request, in `YYYY-MM-DD` format. This field
is required to create a payment request. If an `automatic_payment_source` is defined for the request, Square
charges the payment source on this date.
After this date, the invoice becomes overdue. For example, a payment `due_date` of 2021-03-09 with a `timezone`
of America/Los\_Angeles becomes overdue at midnight on March 9 in America/Los\_Angeles (which equals a UTC
timestamp of 2021-03-10T08:00:00Z). | getDueDate(): ?string | setDueDate(?string dueDate): void |
-| `fixedAmountRequestedMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getFixedAmountRequestedMoney(): ?Money | setFixedAmountRequestedMoney(?Money fixedAmountRequestedMoney): void |
-| `percentageRequested` | `?string` | Optional | Specifies the amount for the payment request in percentage:
- When the payment `request_type` is `DEPOSIT`, it is the percentage of the order's total amount.
- When the payment `request_type` is `INSTALLMENT`, it is the percentage of the order's total less
the deposit, if requested. The sum of the `percentage_requested` in all installment
payment requests must be equal to 100.
You cannot specify this when the payment `request_type` is `BALANCE` or when the
payment request specifies the `fixed_amount_requested_money` field. | getPercentageRequested(): ?string | setPercentageRequested(?string percentageRequested): void |
-| `tippingEnabled` | `?bool` | Optional | If set to true, the Square-hosted invoice page (the `public_url` field of the invoice)
provides a place for the customer to pay a tip.
This field is allowed only on the final payment request
and the payment `request_type` must be `BALANCE` or `INSTALLMENT`. | getTippingEnabled(): ?bool | setTippingEnabled(?bool tippingEnabled): void |
-| `automaticPaymentSource` | [`?string(InvoiceAutomaticPaymentSource)`](../../doc/models/invoice-automatic-payment-source.md) | Optional | Indicates the automatic payment method for an [invoice payment request](../../doc/models/invoice-payment-request.md). | getAutomaticPaymentSource(): ?string | setAutomaticPaymentSource(?string automaticPaymentSource): void |
-| `cardId` | `?string` | Optional | The ID of the credit or debit card on file to charge for the payment request. To get the cards on file for a customer,
call [ListCards](api-endpoint:Cards-ListCards) and include the `customer_id` of the invoice recipient.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getCardId(): ?string | setCardId(?string cardId): void |
-| `reminders` | [`?(InvoicePaymentReminder[])`](../../doc/models/invoice-payment-reminder.md) | Optional | A list of one or more reminders to send for the payment request. | getReminders(): ?array | setReminders(?array reminders): void |
-| `computedAmountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getComputedAmountMoney(): ?Money | setComputedAmountMoney(?Money computedAmountMoney): void |
-| `totalCompletedAmountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalCompletedAmountMoney(): ?Money | setTotalCompletedAmountMoney(?Money totalCompletedAmountMoney): void |
-| `roundingAdjustmentIncludedMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getRoundingAdjustmentIncludedMoney(): ?Money | setRoundingAdjustmentIncludedMoney(?Money roundingAdjustmentIncludedMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid0",
- "request_method": "SHARE_MANUALLY",
- "request_type": "DEPOSIT",
- "due_date": "due_date8",
- "fixed_amount_requested_money": {
- "amount": 162,
- "currency": "JOD"
- }
-}
-```
-
diff --git a/doc/models/invoice-query.md b/doc/models/invoice-query.md
deleted file mode 100644
index fc460cf7..00000000
--- a/doc/models/invoice-query.md
+++ /dev/null
@@ -1,36 +0,0 @@
-
-# Invoice Query
-
-Describes query criteria for searching invoices.
-
-## Structure
-
-`InvoiceQuery`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `filter` | [`InvoiceFilter`](../../doc/models/invoice-filter.md) | Required | Describes query filters to apply. | getFilter(): InvoiceFilter | setFilter(InvoiceFilter filter): void |
-| `sort` | [`?InvoiceSort`](../../doc/models/invoice-sort.md) | Optional | Identifies the sort field and sort order. | getSort(): ?InvoiceSort | setSort(?InvoiceSort sort): void |
-
-## Example (as JSON)
-
-```json
-{
- "filter": {
- "location_ids": [
- "location_ids4"
- ],
- "customer_ids": [
- "customer_ids3",
- "customer_ids2"
- ]
- },
- "sort": {
- "field": "field2",
- "order": "DESC"
- }
-}
-```
-
diff --git a/doc/models/invoice-recipient-tax-ids.md b/doc/models/invoice-recipient-tax-ids.md
deleted file mode 100644
index 3349a78a..00000000
--- a/doc/models/invoice-recipient-tax-ids.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Invoice Recipient Tax Ids
-
-Represents the tax IDs for an invoice recipient. The country of the seller account determines
-whether the corresponding `tax_ids` field is available for the customer. For more information,
-see [Invoice recipient tax IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids).
-
-## Structure
-
-`InvoiceRecipientTaxIds`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `euVat` | `?string` | Optional | The EU VAT identification number for the invoice recipient. For example, `IE3426675K`. | getEuVat(): ?string | setEuVat(?string euVat): void |
-
-## Example (as JSON)
-
-```json
-{
- "eu_vat": "eu_vat8"
-}
-```
-
diff --git a/doc/models/invoice-recipient.md b/doc/models/invoice-recipient.md
deleted file mode 100644
index 75cf6382..00000000
--- a/doc/models/invoice-recipient.md
+++ /dev/null
@@ -1,45 +0,0 @@
-
-# Invoice Recipient
-
-Represents a snapshot of customer data. This object stores customer data that is displayed on the invoice
-and that Square uses to deliver the invoice.
-
-When you provide a customer ID for a draft invoice, Square retrieves the associated customer profile and populates
-the remaining `InvoiceRecipient` fields. You cannot update these fields after the invoice is published.
-Square updates the customer ID in response to a merge operation, but does not update other fields.
-
-## Structure
-
-`InvoiceRecipient`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customerId` | `?string` | Optional | The ID of the customer. This is the customer profile ID that
you provide when creating a draft invoice.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getCustomerId(): ?string | setCustomerId(?string customerId): void |
-| `givenName` | `?string` | Optional | The recipient's given (that is, first) name. | getGivenName(): ?string | setGivenName(?string givenName): void |
-| `familyName` | `?string` | Optional | The recipient's family (that is, last) name. | getFamilyName(): ?string | setFamilyName(?string familyName): void |
-| `emailAddress` | `?string` | Optional | The recipient's email address. | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void |
-| `address` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getAddress(): ?Address | setAddress(?Address address): void |
-| `phoneNumber` | `?string` | Optional | The recipient's phone number. | getPhoneNumber(): ?string | setPhoneNumber(?string phoneNumber): void |
-| `companyName` | `?string` | Optional | The name of the recipient's company. | getCompanyName(): ?string | setCompanyName(?string companyName): void |
-| `taxIds` | [`?InvoiceRecipientTaxIds`](../../doc/models/invoice-recipient-tax-ids.md) | Optional | Represents the tax IDs for an invoice recipient. The country of the seller account determines
whether the corresponding `tax_ids` field is available for the customer. For more information,
see [Invoice recipient tax IDs](https://developer.squareup.com/docs/invoices-api/overview#recipient-tax-ids). | getTaxIds(): ?InvoiceRecipientTaxIds | setTaxIds(?InvoiceRecipientTaxIds taxIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "customer_id": "customer_id8",
- "given_name": "given_name2",
- "family_name": "family_name4",
- "email_address": "email_address8",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
-}
-```
-
diff --git a/doc/models/invoice-request-method.md b/doc/models/invoice-request-method.md
deleted file mode 100644
index 412d716b..00000000
--- a/doc/models/invoice-request-method.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-# Invoice Request Method
-
-Specifies the action for Square to take for processing the invoice. For example,
-email the invoice, charge a customer's card on file, or do nothing. DEPRECATED at
-version 2021-01-21. The corresponding `request_method` field is replaced by the
-`Invoice.delivery_method` and `InvoicePaymentRequest.automatic_payment_source` fields.
-
-## Enumeration
-
-`InvoiceRequestMethod`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `EMAIL` | Directs Square to send invoices, reminders, and receipts to the customer using email.
Square sends the invoice after it is published (either immediately or at the `scheduled_at`
time, if specified in the [invoice](entity:Invoice)). |
-| `CHARGE_CARD_ON_FILE` | Directs Square to charge the card on file on the `due_date` specified in the payment request
and to use email to send invoices, reminders, and receipts. |
-| `SHARE_MANUALLY` | Directs Square to take no specific action on the invoice. In this case, the seller
(or the application developer) follows up with the customer for payment. For example,
a seller might collect a payment in the Seller Dashboard or use the Point of Sale (POS) application.
The seller might also share the URL of the Square-hosted invoice page (`public_url`) with the customer requesting payment. |
-| `CHARGE_BANK_ON_FILE` | Directs Square to charge the customer's bank account on file and to use email to send invoices, reminders, and receipts.
The customer must approve the payment.
The bank on file payment method applies only to invoices that sellers create in the Seller Dashboard or other
Square product. The bank account is provided by the customer during the payment flow. You
cannot set `CHARGE_BANK_ON_FILE` as a request method using the Invoices API. |
-| `SMS` | Directs Square to send invoices and receipts to the customer using SMS (text message). Square sends the invoice
after it is published (either immediately or at the `scheduled_at` time, if specified in the [invoice](entity:Invoice)).
You cannot set `SMS` as a request method using the Invoices API. |
-| `SMS_CHARGE_CARD_ON_FILE` | Directs Square to charge the card on file on the `due_date` specified in the payment request and to
use SMS (text message) to send invoices and receipts.
You cannot set `SMS_CHARGE_CARD_ON_FILE` as a request method using the Invoices API. |
-| `SMS_CHARGE_BANK_ON_FILE` | Directs Square to charge the customer's bank account on file and to use SMS (text message) to send invoices and receipts.
The customer must approve the payment.
The bank on file payment method applies only to invoices that sellers create in the Seller Dashboard
or other Square product. The bank account is provided by the customer during the payment flow.
You cannot set `SMS_CHARGE_BANK_ON_FILE` as a request method using the Invoices API. |
-
diff --git a/doc/models/invoice-request-type.md b/doc/models/invoice-request-type.md
deleted file mode 100644
index 2f9a9e88..00000000
--- a/doc/models/invoice-request-type.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# Invoice Request Type
-
-Indicates the type of the payment request. For more information, see
-[Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).
-
-## Enumeration
-
-`InvoiceRequestType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `BALANCE` | A request for a balance payment. The balance amount is computed as follows:
- If the invoice specifies only a balance payment request, the balance amount is the
total amount of the associated order.
- If the invoice also specifies a deposit request, the balance amount is the amount
remaining after the deposit.
`INSTALLMENT` and `BALANCE` payment requests are not allowed in the same invoice. |
-| `DEPOSIT` | A request for a deposit payment. You have the option of specifying
an exact amount or a percentage of the total order amount. If you request a deposit,
it must be due before any other payment requests. |
-| `INSTALLMENT` | A request for an installment payment. Installments allow buyers to pay the invoice over time. Installments can optionally be combined with a deposit.
Adding `INSTALLMENT` payment requests to an invoice requires an
[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription). |
-
diff --git a/doc/models/invoice-sort-field.md b/doc/models/invoice-sort-field.md
deleted file mode 100644
index 6e3bbf54..00000000
--- a/doc/models/invoice-sort-field.md
+++ /dev/null
@@ -1,15 +0,0 @@
-
-# Invoice Sort Field
-
-The field to use for sorting.
-
-## Enumeration
-
-`InvoiceSortField`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `INVOICE_SORT_DATE` | The field works as follows:
- If the invoice is a draft, it uses the invoice `created_at` date.
- If the invoice is scheduled for publication, it uses the `scheduled_at` date.
- If the invoice is published, it uses the invoice publication date. |
-
diff --git a/doc/models/invoice-sort.md b/doc/models/invoice-sort.md
deleted file mode 100644
index a29ba9aa..00000000
--- a/doc/models/invoice-sort.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Invoice Sort
-
-Identifies the sort field and sort order.
-
-## Structure
-
-`InvoiceSort`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `field` | `string` | Required, Constant | The field to use for sorting.
**Default**: `'INVOICE_SORT_DATE'` | getField(): string | setField(string field): void |
-| `order` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getOrder(): ?string | setOrder(?string order): void |
-
-## Example (as JSON)
-
-```json
-{
- "field": "INVOICE_SORT_DATE",
- "order": "DESC"
-}
-```
-
diff --git a/doc/models/invoice-status.md b/doc/models/invoice-status.md
deleted file mode 100644
index ec13bb97..00000000
--- a/doc/models/invoice-status.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-# Invoice Status
-
-Indicates the status of an invoice.
-
-## Enumeration
-
-`InvoiceStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `DRAFT` | The invoice is a draft. You must publish a draft invoice before Square can process it.
A draft invoice has no `public_url`, so it is not available to customers. |
-| `UNPAID` | The invoice is published but not yet paid. |
-| `SCHEDULED` | The invoice is scheduled to be processed. On the scheduled date,
Square sends the invoice, initiates an automatic payment, or takes no action, depending on
the delivery method and payment request settings. Square also sets the invoice status to the
appropriate state: `UNPAID`, `PAID`, `PARTIALLY_PAID`, or `PAYMENT_PENDING`. |
-| `PARTIALLY_PAID` | A partial payment is received for the invoice. |
-| `PAID` | The customer paid the invoice in full. |
-| `PARTIALLY_REFUNDED` | The invoice is paid (or partially paid) and some but not all the amount paid is
refunded. |
-| `REFUNDED` | The full amount that the customer paid for the invoice is refunded. |
-| `CANCELED` | The invoice is canceled. Square no longer requests payments from the customer.
The `public_url` page remains and is accessible, but it displays the invoice
as canceled and does not accept payment. |
-| `FAILED` | Square canceled the invoice due to suspicious activity. |
-| `PAYMENT_PENDING` | A payment on the invoice was initiated but has not yet been processed.
When in this state, invoices cannot be updated and other payments cannot be initiated. |
-
diff --git a/doc/models/invoice.md b/doc/models/invoice.md
deleted file mode 100644
index e2844f7c..00000000
--- a/doc/models/invoice.md
+++ /dev/null
@@ -1,63 +0,0 @@
-
-# Invoice
-
-Stores information about an invoice. You use the Invoices API to create and manage
-invoices. For more information, see [Invoices API Overview](https://developer.squareup.com/docs/invoices-api/overview).
-
-## Structure
-
-`Invoice`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The Square-assigned ID of the invoice. | getId(): ?string | setId(?string id): void |
-| `version` | `?int` | Optional | The Square-assigned version number, which is incremented each time an update is committed to the invoice. | getVersion(): ?int | setVersion(?int version): void |
-| `locationId` | `?string` | Optional | The ID of the location that this invoice is associated with.
If specified in a `CreateInvoice` request, the value must match the `location_id` of the associated order.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `orderId` | `?string` | Optional | The ID of the [order](entity:Order) for which the invoice is created.
This field is required when creating an invoice, and the order must be in the `OPEN` state.
To view the line items and other information for the associated order, call the
[RetrieveOrder](api-endpoint:Orders-RetrieveOrder) endpoint using the order ID.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getOrderId(): ?string | setOrderId(?string orderId): void |
-| `primaryRecipient` | [`?InvoiceRecipient`](../../doc/models/invoice-recipient.md) | Optional | Represents a snapshot of customer data. This object stores customer data that is displayed on the invoice
and that Square uses to deliver the invoice.
When you provide a customer ID for a draft invoice, Square retrieves the associated customer profile and populates
the remaining `InvoiceRecipient` fields. You cannot update these fields after the invoice is published.
Square updates the customer ID in response to a merge operation, but does not update other fields. | getPrimaryRecipient(): ?InvoiceRecipient | setPrimaryRecipient(?InvoiceRecipient primaryRecipient): void |
-| `paymentRequests` | [`?(InvoicePaymentRequest[])`](../../doc/models/invoice-payment-request.md) | Optional | The payment schedule for the invoice, represented by one or more payment requests that
define payment settings, such as amount due and due date. An invoice supports the following payment request combinations:
- One balance
- One deposit with one balance
- 2–12 installments
- One deposit with 2–12 installments
This field is required when creating an invoice. It must contain at least one payment request.
All payment requests for the invoice must equal the total order amount. For more information, see
[Configuring payment requests](https://developer.squareup.com/docs/invoices-api/create-publish-invoices#payment-requests).
Adding `INSTALLMENT` payment requests to an invoice requires an
[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription). | getPaymentRequests(): ?array | setPaymentRequests(?array paymentRequests): void |
-| `deliveryMethod` | [`?string(InvoiceDeliveryMethod)`](../../doc/models/invoice-delivery-method.md) | Optional | Indicates how Square delivers the [invoice](../../doc/models/invoice.md) to the customer. | getDeliveryMethod(): ?string | setDeliveryMethod(?string deliveryMethod): void |
-| `invoiceNumber` | `?string` | Optional | A user-friendly invoice number that is displayed on the invoice. The value is unique within a location.
If not provided when creating an invoice, Square assigns a value.
It increments from 1 and is padded with zeros making it 7 characters long
(for example, 0000001 and 0000002).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `191` | getInvoiceNumber(): ?string | setInvoiceNumber(?string invoiceNumber): void |
-| `title` | `?string` | Optional | The title of the invoice, which is displayed on the invoice.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getTitle(): ?string | setTitle(?string title): void |
-| `description` | `?string` | Optional | The description of the invoice, which is displayed on the invoice.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `65536` | getDescription(): ?string | setDescription(?string description): void |
-| `scheduledAt` | `?string` | Optional | The timestamp when the invoice is scheduled for processing, in RFC 3339 format.
After the invoice is published, Square processes the invoice on the specified date,
according to the delivery method and payment request settings.
If the field is not set, Square processes the invoice immediately after it is published. | getScheduledAt(): ?string | setScheduledAt(?string scheduledAt): void |
-| `publicUrl` | `?string` | Optional | The URL of the Square-hosted invoice page.
After you publish the invoice using the `PublishInvoice` endpoint, Square hosts the invoice
page and returns the page URL in the response. | getPublicUrl(): ?string | setPublicUrl(?string publicUrl): void |
-| `nextPaymentAmountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getNextPaymentAmountMoney(): ?Money | setNextPaymentAmountMoney(?Money nextPaymentAmountMoney): void |
-| `status` | [`?string(InvoiceStatus)`](../../doc/models/invoice-status.md) | Optional | Indicates the status of an invoice. | getStatus(): ?string | setStatus(?string status): void |
-| `timezone` | `?string` | Optional | The time zone used to interpret calendar dates on the invoice, such as `due_date`.
When an invoice is created, this field is set to the `timezone` specified for the seller
location. The value cannot be changed.
For example, a payment `due_date` of 2021-03-09 with a `timezone` of America/Los\_Angeles
becomes overdue at midnight on March 9 in America/Los\_Angeles (which equals a UTC timestamp
of 2021-03-10T08:00:00Z). | getTimezone(): ?string | setTimezone(?string timezone): void |
-| `createdAt` | `?string` | Optional | The timestamp when the invoice was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp when the invoice was last updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `acceptedPaymentMethods` | [`?InvoiceAcceptedPaymentMethods`](../../doc/models/invoice-accepted-payment-methods.md) | Optional | The payment methods that customers can use to pay an [invoice](../../doc/models/invoice.md) on the Square-hosted invoice payment page. | getAcceptedPaymentMethods(): ?InvoiceAcceptedPaymentMethods | setAcceptedPaymentMethods(?InvoiceAcceptedPaymentMethods acceptedPaymentMethods): void |
-| `customFields` | [`?(InvoiceCustomField[])`](../../doc/models/invoice-custom-field.md) | Optional | Additional seller-defined fields that are displayed on the invoice. For more information, see
[Custom fields](https://developer.squareup.com/docs/invoices-api/overview#custom-fields).
Adding custom fields to an invoice requires an
[Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription).
Max: 2 custom fields | getCustomFields(): ?array | setCustomFields(?array customFields): void |
-| `subscriptionId` | `?string` | Optional | The ID of the [subscription](entity:Subscription) associated with the invoice.
This field is present only on subscription billing invoices. | getSubscriptionId(): ?string | setSubscriptionId(?string subscriptionId): void |
-| `saleOrServiceDate` | `?string` | Optional | The date of the sale or the date that the service is rendered, in `YYYY-MM-DD` format.
This field can be used to specify a past or future date which is displayed on the invoice. | getSaleOrServiceDate(): ?string | setSaleOrServiceDate(?string saleOrServiceDate): void |
-| `paymentConditions` | `?string` | Optional | **France only.** The payment terms and conditions that are displayed on the invoice. For more information,
see [Payment conditions](https://developer.squareup.com/docs/invoices-api/overview#payment-conditions).
For countries other than France, Square returns an `INVALID_REQUEST_ERROR` with a `BAD_REQUEST` code and
"Payment conditions are not supported for this location's country" detail if this field is included in `CreateInvoice` or `UpdateInvoice` requests.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `2000` | getPaymentConditions(): ?string | setPaymentConditions(?string paymentConditions): void |
-| `storePaymentMethodEnabled` | `?bool` | Optional | Indicates whether to allow a customer to save a credit or debit card as a card on file or a bank transfer as a
bank account on file. If `true`, Square displays a __Save my card on file__ or __Save my bank on file__ checkbox on the
invoice payment page. Stored payment information can be used for future automatic payments. The default value is `false`. | getStorePaymentMethodEnabled(): ?bool | setStorePaymentMethodEnabled(?bool storePaymentMethodEnabled): void |
-| `attachments` | [`?(InvoiceAttachment[])`](../../doc/models/invoice-attachment.md) | Optional | Metadata about the attachments on the invoice. Invoice attachments are managed using the
[CreateInvoiceAttachment](api-endpoint:Invoices-CreateInvoiceAttachment) and [DeleteInvoiceAttachment](api-endpoint:Invoices-DeleteInvoiceAttachment) endpoints. | getAttachments(): ?array | setAttachments(?array attachments): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id0",
- "version": 224,
- "location_id": "location_id4",
- "order_id": "order_id4",
- "primary_recipient": {
- "customer_id": "customer_id2",
- "given_name": "given_name6",
- "family_name": "family_name8",
- "email_address": "email_address2",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- }
-}
-```
-
diff --git a/doc/models/item-variation-location-overrides.md b/doc/models/item-variation-location-overrides.md
deleted file mode 100644
index f2342b6d..00000000
--- a/doc/models/item-variation-location-overrides.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-# Item Variation Location Overrides
-
-Price and inventory alerting overrides for a `CatalogItemVariation` at a specific `Location`.
-
-## Structure
-
-`ItemVariationLocationOverrides`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationId` | `?string` | Optional | The ID of the `Location`. This can include locations that are deactivated. | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `priceMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getPriceMoney(): ?Money | setPriceMoney(?Money priceMoney): void |
-| `pricingType` | [`?string(CatalogPricingType)`](../../doc/models/catalog-pricing-type.md) | Optional | Indicates whether the price of a CatalogItemVariation should be entered manually at the time of sale. | getPricingType(): ?string | setPricingType(?string pricingType): void |
-| `trackInventory` | `?bool` | Optional | If `true`, inventory tracking is active for the `CatalogItemVariation` at this `Location`. | getTrackInventory(): ?bool | setTrackInventory(?bool trackInventory): void |
-| `inventoryAlertType` | [`?string(InventoryAlertType)`](../../doc/models/inventory-alert-type.md) | Optional | Indicates whether Square should alert the merchant when the inventory quantity of a CatalogItemVariation is low. | getInventoryAlertType(): ?string | setInventoryAlertType(?string inventoryAlertType): void |
-| `inventoryAlertThreshold` | `?int` | Optional | 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. | getInventoryAlertThreshold(): ?int | setInventoryAlertThreshold(?int inventoryAlertThreshold): void |
-| `soldOut` | `?bool` | Optional | Indicates whether the overridden item variation is sold out at the specified location.
When inventory tracking is enabled on the item variation either globally or at the specified location,
the item variation is automatically marked as sold out when its inventory count reaches zero. The seller
can manually set the item variation as sold out even when the inventory count is greater than zero.
Attempts by an application to set this attribute are ignored. Regardless how the sold-out status is set,
applications should treat its inventory count as zero when this attribute value is `true`. | getSoldOut(): ?bool | setSoldOut(?bool soldOut): void |
-| `soldOutValidUntil` | `?string` | Optional | The seller-assigned timestamp, of the RFC 3339 format, to indicate when this sold-out variation
becomes available again at the specified location. Attempts by an application to set this attribute are ignored.
When the current time is later than this attribute value, the affected item variation is no longer sold out. | getSoldOutValidUntil(): ?string | setSoldOutValidUntil(?string soldOutValidUntil): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_id": "location_id6",
- "price_money": {
- "amount": 202,
- "currency": "GTQ"
- },
- "pricing_type": "FIXED_PRICING",
- "track_inventory": false,
- "inventory_alert_type": "NONE"
-}
-```
-
diff --git a/doc/models/job-assignment-pay-type.md b/doc/models/job-assignment-pay-type.md
deleted file mode 100644
index f093e47e..00000000
--- a/doc/models/job-assignment-pay-type.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Job Assignment Pay Type
-
-Enumerates the possible pay types that a job can be assigned.
-
-## Enumeration
-
-`JobAssignmentPayType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `NONE` | The job does not have a defined pay type. |
-| `HOURLY` | The job pays an hourly rate. |
-| `SALARY` | The job pays an annual salary. |
-
diff --git a/doc/models/job-assignment.md b/doc/models/job-assignment.md
deleted file mode 100644
index 00672aab..00000000
--- a/doc/models/job-assignment.md
+++ /dev/null
@@ -1,40 +0,0 @@
-
-# Job Assignment
-
-Represents a job assigned to a [team member](../../doc/models/team-member.md), including the compensation the team
-member earns for the job. Job assignments are listed in the team member's [wage setting](../../doc/models/wage-setting.md).
-
-## Structure
-
-`JobAssignment`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `jobTitle` | `?string` | Optional | The title of the job. | getJobTitle(): ?string | setJobTitle(?string jobTitle): void |
-| `payType` | [`string(JobAssignmentPayType)`](../../doc/models/job-assignment-pay-type.md) | Required | Enumerates the possible pay types that a job can be assigned. | getPayType(): string | setPayType(string payType): void |
-| `hourlyRate` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getHourlyRate(): ?Money | setHourlyRate(?Money hourlyRate): void |
-| `annualRate` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAnnualRate(): ?Money | setAnnualRate(?Money annualRate): void |
-| `weeklyHours` | `?int` | Optional | The planned hours per week for the job. Set if the job `PayType` is `SALARY`. | getWeeklyHours(): ?int | setWeeklyHours(?int weeklyHours): void |
-| `jobId` | `?string` | Optional | The ID of the [job](../../doc/models/job.md). | getJobId(): ?string | setJobId(?string jobId): void |
-
-## Example (as JSON)
-
-```json
-{
- "job_title": "job_title6",
- "pay_type": "NONE",
- "hourly_rate": {
- "amount": 172,
- "currency": "LAK"
- },
- "annual_rate": {
- "amount": 232,
- "currency": "NIO"
- },
- "weekly_hours": 120,
- "job_id": "job_id8"
-}
-```
-
diff --git a/doc/models/job.md b/doc/models/job.md
deleted file mode 100644
index 06f712f5..00000000
--- a/doc/models/job.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Job
-
-Represents a job that can be assigned to [team members](../../doc/models/team-member.md). This object defines the
-job's title and tip eligibility. Compensation is defined in a [job assignment](../../doc/models/job-assignment.md)
-in a team member's wage setting.
-
-## Structure
-
-`Job`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | **Read only** The unique Square-assigned ID of the job. If you need a job ID for an API request,
call [ListJobs](api-endpoint:Team-ListJobs) or use the ID returned when you created the job.
You can also get job IDs from a team member's wage setting. | getId(): ?string | setId(?string id): void |
-| `title` | `?string` | Optional | The title of the job.
**Constraints**: *Maximum Length*: `150` | getTitle(): ?string | setTitle(?string title): void |
-| `isTipEligible` | `?bool` | Optional | Indicates whether team members can earn tips for the job. | getIsTipEligible(): ?bool | setIsTipEligible(?bool isTipEligible): void |
-| `createdAt` | `?string` | Optional | The timestamp when the job was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp when the job was last updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `version` | `?int` | Optional | **Read only** The current version of the job. Include this field in `UpdateJob` requests to enable
[optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency)
control and avoid overwrites from concurrent requests. Requests fail if the provided version doesn't
match the server version at the time of the request. | getVersion(): ?int | setVersion(?int version): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id6",
- "title": "title2",
- "is_tip_eligible": false,
- "created_at": "created_at4",
- "updated_at": "updated_at2"
-}
-```
-
diff --git a/doc/models/link-customer-to-gift-card-request.md b/doc/models/link-customer-to-gift-card-request.md
deleted file mode 100644
index 4d5e9619..00000000
--- a/doc/models/link-customer-to-gift-card-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Link Customer to Gift Card Request
-
-A request to link a customer to a gift card.
-
-## Structure
-
-`LinkCustomerToGiftCardRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customerId` | `string` | Required | The ID of the customer to link to the gift card.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `191` | getCustomerId(): string | setCustomerId(string customerId): void |
-
-## Example (as JSON)
-
-```json
-{
- "customer_id": "GKY0FZ3V717AH8Q2D821PNT2ZW"
-}
-```
-
diff --git a/doc/models/link-customer-to-gift-card-response.md b/doc/models/link-customer-to-gift-card-response.md
deleted file mode 100644
index c9f1da05..00000000
--- a/doc/models/link-customer-to-gift-card-response.md
+++ /dev/null
@@ -1,47 +0,0 @@
-
-# Link Customer to Gift Card Response
-
-A response that contains the linked `GiftCard` object. If the request resulted in errors,
-the response contains a set of `Error` objects.
-
-## Structure
-
-`LinkCustomerToGiftCardResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `giftCard` | [`?GiftCard`](../../doc/models/gift-card.md) | Optional | Represents a Square gift card. | getGiftCard(): ?GiftCard | setGiftCard(?GiftCard giftCard): void |
-
-## Example (as JSON)
-
-```json
-{
- "gift_card": {
- "balance_money": {
- "amount": 2500,
- "currency": "USD"
- },
- "created_at": "2021-03-25T05:13:01Z",
- "customer_ids": [
- "GKY0FZ3V717AH8Q2D821PNT2ZW"
- ],
- "gan": "7783320005440920",
- "gan_source": "SQUARE",
- "id": "gftc:71ea002277a34f8a945e284b04822edb",
- "state": "ACTIVE",
- "type": "DIGITAL"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-bank-accounts-request.md b/doc/models/list-bank-accounts-request.md
deleted file mode 100644
index 1bb6338e..00000000
--- a/doc/models/list-bank-accounts-request.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# List Bank Accounts Request
-
-Request object for fetching all `BankAccount`
-objects linked to a account.
-
-## Structure
-
-`ListBankAccountsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | The pagination cursor returned by a previous call to this endpoint.
Use it in the next `ListBankAccounts` request to retrieve the next set
of results.
See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | Upper limit on the number of bank accounts to return in the response.
Currently, 1000 is the largest supported limit. You can specify a limit
of up to 1000 bank accounts. This is also the default limit. | getLimit(): ?int | setLimit(?int limit): void |
-| `locationId` | `?string` | Optional | Location ID. You can specify this optional filter
to retrieve only the linked bank accounts belonging to a specific location. | getLocationId(): ?string | setLocationId(?string locationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "cursor8",
- "limit": 182,
- "location_id": "location_id2"
-}
-```
-
diff --git a/doc/models/list-bank-accounts-response.md b/doc/models/list-bank-accounts-response.md
deleted file mode 100644
index 4e851330..00000000
--- a/doc/models/list-bank-accounts-response.md
+++ /dev/null
@@ -1,73 +0,0 @@
-
-# List Bank Accounts Response
-
-Response object returned by ListBankAccounts.
-
-## Structure
-
-`ListBankAccountsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `bankAccounts` | [`?(BankAccount[])`](../../doc/models/bank-account.md) | Optional | List of BankAccounts associated with this account. | getBankAccounts(): ?array | setBankAccounts(?array bankAccounts): void |
-| `cursor` | `?string` | Optional | When a response is truncated, it includes a cursor that you can
use in a subsequent request to fetch next set of bank accounts.
If empty, this is the final response.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "bank_accounts": [
- {
- "account_number_suffix": "971",
- "account_type": "CHECKING",
- "bank_name": "Bank Name",
- "country": "US",
- "creditable": false,
- "currency": "USD",
- "debitable": false,
- "holder_name": "Jane Doe",
- "id": "ao6iaQ9vhDiaQD7n3GB",
- "location_id": "S8GWD5example",
- "primary_bank_identification_number": "112200303",
- "status": "VERIFICATION_IN_PROGRESS",
- "version": 5,
- "secondary_bank_identification_number": "secondary_bank_identification_number0",
- "debit_mandate_reference_id": "debit_mandate_reference_id4",
- "reference_id": "reference_id8",
- "fingerprint": "fingerprint6"
- },
- {
- "account_number_suffix": "972",
- "account_type": "CHECKING",
- "bank_name": "Bank Name",
- "country": "US",
- "creditable": false,
- "currency": "USD",
- "debitable": false,
- "holder_name": "Jane Doe",
- "id": "4x7WXuaxrkQkVlka3GB",
- "location_id": "S8GWD5example",
- "primary_bank_identification_number": "112200303",
- "status": "VERIFICATION_IN_PROGRESS",
- "version": 5,
- "secondary_bank_identification_number": "secondary_bank_identification_number0",
- "debit_mandate_reference_id": "debit_mandate_reference_id4",
- "reference_id": "reference_id8",
- "fingerprint": "fingerprint6"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor2"
-}
-```
-
diff --git a/doc/models/list-booking-custom-attribute-definitions-request.md b/doc/models/list-booking-custom-attribute-definitions-request.md
deleted file mode 100644
index 8ff58be5..00000000
--- a/doc/models/list-booking-custom-attribute-definitions-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# List Booking Custom Attribute Definitions Request
-
-Represents a [ListBookingCustomAttributeDefinitions](../../doc/apis/booking-custom-attributes.md#list-booking-custom-attribute-definitions) request.
-
-## Structure
-
-`ListBookingCustomAttributeDefinitionsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `limit` | `?int` | Optional | The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 98,
- "cursor": "cursor6"
-}
-```
-
diff --git a/doc/models/list-booking-custom-attribute-definitions-response.md b/doc/models/list-booking-custom-attribute-definitions-response.md
deleted file mode 100644
index a87e3628..00000000
--- a/doc/models/list-booking-custom-attribute-definitions-response.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# List Booking Custom Attribute Definitions Response
-
-Represents a [ListBookingCustomAttributeDefinitions](../../doc/apis/booking-custom-attributes.md#list-booking-custom-attribute-definitions) response.
-Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response.
-If additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.
-
-## Structure
-
-`ListBookingCustomAttributeDefinitionsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinitions` | [`?(CustomAttributeDefinition[])`](../../doc/models/custom-attribute-definition.md) | Optional | The retrieved custom attribute definitions. If no custom attribute definitions are found,
Square returns an empty object (`{}`). | getCustomAttributeDefinitions(): ?array | setCustomAttributeDefinitions(?array customAttributeDefinitions): void |
-| `cursor` | `?string` | Optional | The cursor to provide in your next call to this endpoint to retrieve the next page of
results for your original request. This field is present only if the request succeeded and
additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "YEk4UPbUEsu8MUV0xouO5hCiFcD9T5ztB6UWEJq5vZnqBFmoBEi0j1j6HWYTFGMRre4p7T5wAQBj3Th1NX3XgBFcQVEVsIxUQ2NsbwjRitfoEZDml9uxxQXepowyRvCuSThHPbJSn7M7wInl3x8XypQF9ahVVQXegJ0CxEKc0SBH",
- "custom_attribute_definitions": [
- {
- "created_at": "2022-11-16T15:27:30Z",
- "description": "Update the description as desired.",
- "key": "favoriteShampoo",
- "name": "Favorite shampoo",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-11-16T15:39:38Z",
- "version": 3,
- "visibility": "VISIBILITY_READ_ONLY"
- },
- {
- "created_at": "2022-11-16T15:49:05Z",
- "description": "Number of people in the party for dine-in",
- "key": "partySize",
- "name": "Party size",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-11-16T15:49:05Z",
- "version": 1,
- "visibility": "VISIBILITY_HIDDEN"
- }
- ],
- "errors": []
-}
-```
-
diff --git a/doc/models/list-booking-custom-attributes-request.md b/doc/models/list-booking-custom-attributes-request.md
deleted file mode 100644
index 168db910..00000000
--- a/doc/models/list-booking-custom-attributes-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# List Booking Custom Attributes Request
-
-Represents a [ListBookingCustomAttributes](../../doc/apis/booking-custom-attributes.md#list-booking-custom-attributes) request.
-
-## Structure
-
-`ListBookingCustomAttributesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `limit` | `?int` | Optional | The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request. For more
information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `withDefinitions` | `?bool` | Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom
attribute, information about the data type, or other definition details. The default value is `false`. | getWithDefinitions(): ?bool | setWithDefinitions(?bool withDefinitions): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 254,
- "cursor": "cursor8",
- "with_definitions": false
-}
-```
-
diff --git a/doc/models/list-booking-custom-attributes-response.md b/doc/models/list-booking-custom-attributes-response.md
deleted file mode 100644
index 97c942df..00000000
--- a/doc/models/list-booking-custom-attributes-response.md
+++ /dev/null
@@ -1,81 +0,0 @@
-
-# List Booking Custom Attributes Response
-
-Represents a [ListBookingCustomAttributes](../../doc/apis/booking-custom-attributes.md#list-booking-custom-attributes) response.
-Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional
-results are available, the `cursor` field is also present along with `custom_attributes`.
-
-## Structure
-
-`ListBookingCustomAttributesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributes` | [`?(CustomAttribute[])`](../../doc/models/custom-attribute.md) | Optional | The retrieved custom attributes. If `with_definitions` was set to `true` in the request,
the custom attribute definition is returned in the `definition` field of each custom attribute.
If no custom attributes are found, Square returns an empty object (`{}`). | getCustomAttributes(): ?array | setCustomAttributes(?array customAttributes): void |
-| `cursor` | `?string` | Optional | The cursor to use in your next call to this endpoint to retrieve the next page of results
for your original request. This field is present only if the request succeeded and additional
results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attributes": [
- {
- "key": "key8",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 180,
- "visibility": "VISIBILITY_HIDDEN",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- {
- "key": "key8",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 180,
- "visibility": "VISIBILITY_HIDDEN",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- }
- ],
- "cursor": "cursor0",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-bookings-request.md b/doc/models/list-bookings-request.md
deleted file mode 100644
index 3be09a71..00000000
--- a/doc/models/list-bookings-request.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# List Bookings Request
-
-## Structure
-
-`ListBookingsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `limit` | `?int` | Optional | The maximum number of results per page to return in a paged response.
**Constraints**: `>= 1`, `<= 10000` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.
**Constraints**: *Maximum Length*: `65536` | getCursor(): ?string | setCursor(?string cursor): void |
-| `customerId` | `?string` | Optional | The [customer](entity:Customer) for whom to retrieve bookings. If this is not set, bookings for all customers are retrieved.
**Constraints**: *Maximum Length*: `192` | getCustomerId(): ?string | setCustomerId(?string customerId): void |
-| `teamMemberId` | `?string` | Optional | The team member for whom to retrieve bookings. If this is not set, bookings of all members are retrieved.
**Constraints**: *Maximum Length*: `32` | getTeamMemberId(): ?string | setTeamMemberId(?string teamMemberId): void |
-| `locationId` | `?string` | Optional | The location for which to retrieve bookings. If this is not set, all locations' bookings are retrieved.
**Constraints**: *Maximum Length*: `32` | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `startAtMin` | `?string` | Optional | The RFC 3339 timestamp specifying the earliest of the start time. If this is not set, the current time is used. | getStartAtMin(): ?string | setStartAtMin(?string startAtMin): void |
-| `startAtMax` | `?string` | Optional | The RFC 3339 timestamp specifying the latest of the start time. If this is not set, the time of 31 days after `start_at_min` is used. | getStartAtMax(): ?string | setStartAtMax(?string startAtMax): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 34,
- "cursor": "cursor4",
- "customer_id": "customer_id0",
- "team_member_id": "team_member_id2",
- "location_id": "location_id6"
-}
-```
-
diff --git a/doc/models/list-bookings-response.md b/doc/models/list-bookings-response.md
deleted file mode 100644
index 72f9f711..00000000
--- a/doc/models/list-bookings-response.md
+++ /dev/null
@@ -1,52 +0,0 @@
-
-# List Bookings Response
-
-## Structure
-
-`ListBookingsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `bookings` | [`?(Booking[])`](../../doc/models/booking.md) | Optional | The list of targeted bookings. | getBookings(): ?array | setBookings(?array bookings): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in the subsequent request to get the next page of the results. Stop retrieving the next page of the results when the cursor is not set.
**Constraints**: *Maximum Length*: `65536` | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "bookings": [
- {
- "id": "id4",
- "version": 218,
- "status": "ACCEPTED",
- "created_at": "created_at2",
- "updated_at": "updated_at0"
- }
- ],
- "cursor": "cursor6",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-break-types-request.md b/doc/models/list-break-types-request.md
deleted file mode 100644
index bc0e3534..00000000
--- a/doc/models/list-break-types-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# List Break Types Request
-
-A request for a filtered set of `BreakType` objects.
-
-## Structure
-
-`ListBreakTypesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationId` | `?string` | Optional | Filter the returned `BreakType` results to only those that are associated with the
specified location. | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `limit` | `?int` | Optional | The maximum number of `BreakType` results to return per page. The number can range between 1
and 200. The default is 200.
**Constraints**: `>= 1`, `<= 200` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | A pointer to the next page of `BreakType` results to fetch. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_id": "location_id6",
- "limit": 244,
- "cursor": "cursor4"
-}
-```
-
diff --git a/doc/models/list-break-types-response.md b/doc/models/list-break-types-response.md
deleted file mode 100644
index cf61221b..00000000
--- a/doc/models/list-break-types-response.md
+++ /dev/null
@@ -1,63 +0,0 @@
-
-# List Break Types Response
-
-The response to a request for a set of `BreakType` objects. The response contains
-the requested `BreakType` objects and might contain a set of `Error` objects if
-the request resulted in errors.
-
-## Structure
-
-`ListBreakTypesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `breakTypes` | [`?(BreakType[])`](../../doc/models/break-type.md) | Optional | A page of `BreakType` results. | getBreakTypes(): ?array | setBreakTypes(?array breakTypes): void |
-| `cursor` | `?string` | Optional | The value supplied in the subsequent request to fetch the next page
of `BreakType` results. | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "break_types": [
- {
- "break_name": "Coffee Break",
- "created_at": "2019-01-22T20:47:37Z",
- "expected_duration": "PT5M",
- "id": "REGS1EQR1TPZ5",
- "is_paid": false,
- "location_id": "PAA1RJZZKXBFG",
- "updated_at": "2019-01-22T20:47:37Z",
- "version": 1
- },
- {
- "break_name": "Lunch Break",
- "created_at": "2019-01-25T19:26:30Z",
- "expected_duration": "PT1H",
- "id": "92EPDRQKJ5088",
- "is_paid": true,
- "location_id": "PAA1RJZZKXBFG",
- "updated_at": "2019-01-25T19:26:30Z",
- "version": 3
- }
- ],
- "cursor": "2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-cards-request.md b/doc/models/list-cards-request.md
deleted file mode 100644
index 1a858185..00000000
--- a/doc/models/list-cards-request.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# List Cards Request
-
-Retrieves details for a specific Card. Accessible via
-HTTP requests at GET https://connect.squareup.com/v2/cards
-
-## Structure
-
-`ListCardsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this to retrieve the next set of results for your original query.
See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information.
**Constraints**: *Maximum Length*: `256` | getCursor(): ?string | setCursor(?string cursor): void |
-| `customerId` | `?string` | Optional | Limit results to cards associated with the customer supplied.
By default, all cards owned by the merchant are returned. | getCustomerId(): ?string | setCustomerId(?string customerId): void |
-| `includeDisabled` | `?bool` | Optional | Includes disabled cards.
By default, all enabled cards owned by the merchant are returned. | getIncludeDisabled(): ?bool | setIncludeDisabled(?bool includeDisabled): void |
-| `referenceId` | `?string` | Optional | Limit results to cards associated with the reference_id supplied. | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `sortOrder` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "cursor6",
- "customer_id": "customer_id8",
- "include_disabled": false,
- "reference_id": "reference_id8",
- "sort_order": "DESC"
-}
-```
-
diff --git a/doc/models/list-cards-response.md b/doc/models/list-cards-response.md
deleted file mode 100644
index 09e32e2c..00000000
--- a/doc/models/list-cards-response.md
+++ /dev/null
@@ -1,64 +0,0 @@
-
-# List Cards Response
-
-Defines the fields that are included in the response body of
-a request to the [ListCards](../../doc/apis/cards.md#list-cards) endpoint.
-
-Note: if there are errors processing the request, the card field will not be
-present.
-
-## Structure
-
-`ListCardsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `cards` | [`?(Card[])`](../../doc/models/card.md) | Optional | The requested list of `Card`s. | getCards(): ?array | setCards(?array cards): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request. If empty,
this is the final response.
See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "cards": [
- {
- "billing_address": {
- "address_line_1": "500 Electric Ave",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "NY",
- "country": "US",
- "locality": "New York",
- "postal_code": "10003"
- },
- "bin": "411111",
- "card_brand": "VISA",
- "card_type": "CREDIT",
- "cardholder_name": "Amelia Earhart",
- "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8",
- "enabled": true,
- "exp_month": 11,
- "exp_year": 2022,
- "fingerprint": "ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q",
- "id": "ccof:uIbfJXhXETSP197M3GB",
- "last_4": "1111",
- "merchant_id": "6SSW7HV8K2ST5",
- "prepaid_type": "NOT_PREPAID",
- "reference_id": "user-id-1",
- "version": 1
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor6"
-}
-```
-
diff --git a/doc/models/list-cash-drawer-shift-events-request.md b/doc/models/list-cash-drawer-shift-events-request.md
deleted file mode 100644
index e8121d2c..00000000
--- a/doc/models/list-cash-drawer-shift-events-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# List Cash Drawer Shift Events Request
-
-## Structure
-
-`ListCashDrawerShiftEventsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationId` | `string` | Required | The ID of the location to list cash drawer shifts for.
**Constraints**: *Minimum Length*: `1` | getLocationId(): string | setLocationId(string locationId): void |
-| `limit` | `?int` | Optional | Number of resources to be returned in a page of results (200 by
default, 1000 max).
**Constraints**: `<= 1000` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | Opaque cursor for fetching the next page of results. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_id": "location_id8",
- "limit": 24,
- "cursor": "cursor2"
-}
-```
-
diff --git a/doc/models/list-cash-drawer-shift-events-response.md b/doc/models/list-cash-drawer-shift-events-response.md
deleted file mode 100644
index c3ed1c98..00000000
--- a/doc/models/list-cash-drawer-shift-events-response.md
+++ /dev/null
@@ -1,99 +0,0 @@
-
-# List Cash Drawer Shift Events Response
-
-## Structure
-
-`ListCashDrawerShiftEventsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | Opaque cursor for fetching the next page. Cursor is not present in
the last page of results. | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `cashDrawerShiftEvents` | [`?(CashDrawerShiftEvent[])`](../../doc/models/cash-drawer-shift-event.md) | Optional | All of the events (payments, refunds, etc.) for a cash drawer during
the shift. | getCashDrawerShiftEvents(): ?array | setCashDrawerShiftEvents(?array cashDrawerShiftEvents): void |
-
-## Example (as JSON)
-
-```json
-{
- "cash_drawer_shift_events": [
- {
- "created_at": "2019-11-22T00:43:02.000Z",
- "description": "",
- "event_money": {
- "amount": 100,
- "currency": "USD"
- },
- "event_type": "CASH_TENDER_PAYMENT",
- "id": "9F07DB01-D85A-4B77-88C3-D5C64CEB5155",
- "team_member_id": ""
- },
- {
- "created_at": "2019-11-22T00:43:12.000Z",
- "description": "",
- "event_money": {
- "amount": 250,
- "currency": "USD"
- },
- "event_type": "CASH_TENDER_PAYMENT",
- "id": "B2854CEA-A781-49B3-8F31-C64558231F48",
- "team_member_id": ""
- },
- {
- "created_at": "2019-11-22T00:43:23.000Z",
- "description": "",
- "event_money": {
- "amount": 250,
- "currency": "USD"
- },
- "event_type": "CASH_TENDER_CANCELLED_PAYMENT",
- "id": "B5FB7F72-95CD-44A3-974D-26C41064D042",
- "team_member_id": ""
- },
- {
- "created_at": "2019-11-22T00:43:46.000Z",
- "description": "",
- "event_money": {
- "amount": 100,
- "currency": "USD"
- },
- "event_type": "CASH_TENDER_REFUND",
- "id": "0B425480-8504-40B4-A867-37B23543931B",
- "team_member_id": ""
- },
- {
- "created_at": "2019-11-22T00:44:18.000Z",
- "description": "Transfer from another drawer",
- "event_money": {
- "amount": 10000,
- "currency": "USD"
- },
- "event_type": "PAID_IN",
- "id": "8C66E60E-FDCF-4EEF-A98D-3B14B7ED5CBE",
- "team_member_id": ""
- },
- {
- "created_at": "2019-11-22T00:44:29.000Z",
- "description": "Transfer out to another drawer",
- "event_money": {
- "amount": 10000,
- "currency": "USD"
- },
- "event_type": "PAID_OUT",
- "id": "D5ACA7FE-C64D-4ADA-8BC8-82118A2DAE4F",
- "team_member_id": ""
- }
- ],
- "cursor": "cursor8",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-cash-drawer-shifts-request.md b/doc/models/list-cash-drawer-shifts-request.md
deleted file mode 100644
index aa256bd7..00000000
--- a/doc/models/list-cash-drawer-shifts-request.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# List Cash Drawer Shifts Request
-
-## Structure
-
-`ListCashDrawerShiftsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationId` | `string` | Required | The ID of the location to query for a list of cash drawer shifts.
**Constraints**: *Minimum Length*: `1` | getLocationId(): string | setLocationId(string locationId): void |
-| `sortOrder` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-| `beginTime` | `?string` | Optional | The inclusive start time of the query on opened_at, in ISO 8601 format. | getBeginTime(): ?string | setBeginTime(?string beginTime): void |
-| `endTime` | `?string` | Optional | The exclusive end date of the query on opened_at, in ISO 8601 format. | getEndTime(): ?string | setEndTime(?string endTime): void |
-| `limit` | `?int` | Optional | Number of cash drawer shift events in a page of results (200 by
default, 1000 max).
**Constraints**: `<= 1000` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | Opaque cursor for fetching the next page of results. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_id": "location_id6",
- "sort_order": "DESC",
- "begin_time": "begin_time0",
- "end_time": "end_time4",
- "limit": 154,
- "cursor": "cursor4"
-}
-```
-
diff --git a/doc/models/list-cash-drawer-shifts-response.md b/doc/models/list-cash-drawer-shifts-response.md
deleted file mode 100644
index 9df939fb..00000000
--- a/doc/models/list-cash-drawer-shifts-response.md
+++ /dev/null
@@ -1,59 +0,0 @@
-
-# List Cash Drawer Shifts Response
-
-## Structure
-
-`ListCashDrawerShiftsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | Opaque cursor for fetching the next page of results. Cursor is not
present in the last page of results. | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `cashDrawerShifts` | [`?(CashDrawerShiftSummary[])`](../../doc/models/cash-drawer-shift-summary.md) | Optional | A collection of CashDrawerShiftSummary objects for shifts that match
the query. | getCashDrawerShifts(): ?array | setCashDrawerShifts(?array cashDrawerShifts): void |
-
-## Example (as JSON)
-
-```json
-{
- "cash_drawer_shifts": [
- {
- "closed_at": "2019-11-22T00:44:49.000Z",
- "closed_cash_money": {
- "amount": 9970,
- "currency": "USD"
- },
- "description": "Misplaced some change",
- "ended_at": "2019-11-22T00:44:49.000Z",
- "expected_cash_money": {
- "amount": 10000,
- "currency": "USD"
- },
- "id": "DCC99978-09A6-4926-849F-300BE9C5793A",
- "opened_at": "2019-11-22T00:42:54.000Z",
- "opened_cash_money": {
- "amount": 10000,
- "currency": "USD"
- },
- "state": "CLOSED"
- }
- ],
- "cursor": "cursor6",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-catalog-request.md b/doc/models/list-catalog-request.md
deleted file mode 100644
index 2e6ad722..00000000
--- a/doc/models/list-catalog-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# List Catalog Request
-
-## Structure
-
-`ListCatalogRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | The pagination cursor returned in the previous response. Leave unset for an initial request.
The page size is currently set to be 100.
See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-| `types` | `?string` | Optional | An optional case-insensitive, comma-separated list of object types to retrieve.
The valid values are defined in the [CatalogObjectType](entity:CatalogObjectType) enum, for example,
`ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,
`MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.
If this is unspecified, the operation returns objects of all the top level types at the version
of the Square API used to make the request. Object types that are nested onto other object types
are not included in the defaults.
At the current API version the default object types are:
ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST,
PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,
SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS. | getTypes(): ?string | setTypes(?string types): void |
-| `catalogVersion` | `?int` | Optional | The specific version of the catalog objects to be included in the response.
This allows you to retrieve historical versions of objects. The specified version value is matched against
the [CatalogObject](../../doc/models/catalog-object.md)s' `version` attribute. If not included, results will be from the
current version of the catalog. | getCatalogVersion(): ?int | setCatalogVersion(?int catalogVersion): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "cursor2",
- "types": "types0",
- "catalog_version": 254
-}
-```
-
diff --git a/doc/models/list-catalog-response.md b/doc/models/list-catalog-response.md
deleted file mode 100644
index ac44f452..00000000
--- a/doc/models/list-catalog-response.md
+++ /dev/null
@@ -1,119 +0,0 @@
-
-# List Catalog Response
-
-## Structure
-
-`ListCatalogResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request. If unset, this is the final response.
See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-| `objects` | [`?(CatalogObject[])`](../../doc/models/catalog-object.md) | Optional | The CatalogObjects returned. | getObjects(): ?array | setObjects(?array objects): void |
-
-## Example (as JSON)
-
-```json
-{
- "objects": [
- {
- "category_data": {
- "name": "Beverages"
- },
- "id": "5ZYQZZ2IECPVJ2IJ5KQPRDC3",
- "is_deleted": false,
- "present_at_all_locations": true,
- "type": "CATEGORY",
- "updated_at": "2017-02-21T14:50:26.495Z",
- "version": 1487688626495,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- },
- {
- "id": "L5R47DGBZOOVKCAFIXC56AEN",
- "is_deleted": false,
- "present_at_all_locations": true,
- "tax_data": {
- "calculation_phase": "TAX_SUBTOTAL_PHASE",
- "enabled": true,
- "inclusion_type": "ADDITIVE",
- "name": "Sales Tax",
- "percentage": "5.0"
- },
- "type": "TAX",
- "updated_at": "2017-02-21T14:50:26.495Z",
- "version": 1487688626495,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor6"
-}
-```
-
diff --git a/doc/models/list-customer-custom-attribute-definitions-request.md b/doc/models/list-customer-custom-attribute-definitions-request.md
deleted file mode 100644
index 1a57ea9a..00000000
--- a/doc/models/list-customer-custom-attribute-definitions-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# List Customer Custom Attribute Definitions Request
-
-Represents a [ListCustomerCustomAttributeDefinitions](../../doc/apis/customer-custom-attributes.md#list-customer-custom-attribute-definitions) request.
-
-## Structure
-
-`ListCustomerCustomAttributeDefinitionsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `limit` | `?int` | Optional | The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 198,
- "cursor": "cursor8"
-}
-```
-
diff --git a/doc/models/list-customer-custom-attribute-definitions-response.md b/doc/models/list-customer-custom-attribute-definitions-response.md
deleted file mode 100644
index 16ba2730..00000000
--- a/doc/models/list-customer-custom-attribute-definitions-response.md
+++ /dev/null
@@ -1,69 +0,0 @@
-
-# List Customer Custom Attribute Definitions Response
-
-Represents a [ListCustomerCustomAttributeDefinitions](../../doc/apis/customer-custom-attributes.md#list-customer-custom-attribute-definitions) response.
-Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response.
-If additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.
-
-## Structure
-
-`ListCustomerCustomAttributeDefinitionsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinitions` | [`?(CustomAttributeDefinition[])`](../../doc/models/custom-attribute-definition.md) | Optional | The retrieved custom attribute definitions. If no custom attribute definitions are found,
Square returns an empty object (`{}`). | getCustomAttributeDefinitions(): ?array | setCustomAttributeDefinitions(?array customAttributeDefinitions): void |
-| `cursor` | `?string` | Optional | The cursor to provide in your next call to this endpoint to retrieve the next page of
results for your original request. This field is present only if the request succeeded and
additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "YEk4UPbUEsu8MUV0xouO5hCiFcD9T5ztB6UWEJq5vZnqBFmoBEi0j1j6HWYTFGMRre4p7T5wAQBj3Th1NX3XgBFcQVEVsIxUQ2NsbwjRitfoEZDml9uxxQXepowyRvCuSThHPbJSn7M7wInl3x8XypQF9ahVVQXegJ0CxEKc0SBH",
- "custom_attribute_definitions": [
- {
- "created_at": "2022-04-26T15:27:30Z",
- "description": "Update the description as desired.",
- "key": "favoritemovie",
- "name": "Favorite Movie",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-04-26T15:39:38Z",
- "version": 3,
- "visibility": "VISIBILITY_READ_ONLY"
- },
- {
- "created_at": "2022-04-26T15:49:05Z",
- "description": "Customer owns movie.",
- "key": "ownsmovie",
- "name": "Owns Movie",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-04-26T15:49:05Z",
- "version": 1,
- "visibility": "VISIBILITY_HIDDEN"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-customer-custom-attributes-request.md b/doc/models/list-customer-custom-attributes-request.md
deleted file mode 100644
index 1c4fdab6..00000000
--- a/doc/models/list-customer-custom-attributes-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# List Customer Custom Attributes Request
-
-Represents a [ListCustomerCustomAttributes](../../doc/apis/customer-custom-attributes.md#list-customer-custom-attributes) request.
-
-## Structure
-
-`ListCustomerCustomAttributesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `limit` | `?int` | Optional | The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request. For more
information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `withDefinitions` | `?bool` | Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom
attribute, information about the data type, or other definition details. The default value is `false`. | getWithDefinitions(): ?bool | setWithDefinitions(?bool withDefinitions): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 224,
- "cursor": "cursor6",
- "with_definitions": false
-}
-```
-
diff --git a/doc/models/list-customer-custom-attributes-response.md b/doc/models/list-customer-custom-attributes-response.md
deleted file mode 100644
index 7cb4267d..00000000
--- a/doc/models/list-customer-custom-attributes-response.md
+++ /dev/null
@@ -1,106 +0,0 @@
-
-# List Customer Custom Attributes Response
-
-Represents a [ListCustomerCustomAttributes](../../doc/apis/customer-custom-attributes.md#list-customer-custom-attributes) response.
-Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional
-results are available, the `cursor` field is also present along with `custom_attributes`.
-
-## Structure
-
-`ListCustomerCustomAttributesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributes` | [`?(CustomAttribute[])`](../../doc/models/custom-attribute.md) | Optional | The retrieved custom attributes. If `with_definitions` was set to `true` in the request,
the custom attribute definition is returned in the `definition` field of each custom attribute.
If no custom attributes are found, Square returns an empty object (`{}`). | getCustomAttributes(): ?array | setCustomAttributes(?array customAttributes): void |
-| `cursor` | `?string` | Optional | The cursor to use in your next call to this endpoint to retrieve the next page of results
for your original request. This field is present only if the request succeeded and additional
results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attributes": [
- {
- "key": "key8",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 180,
- "visibility": "VISIBILITY_HIDDEN",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- {
- "key": "key8",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 180,
- "visibility": "VISIBILITY_HIDDEN",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- {
- "key": "key8",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 180,
- "visibility": "VISIBILITY_HIDDEN",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- }
- ],
- "cursor": "cursor4",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-customer-groups-request.md b/doc/models/list-customer-groups-request.md
deleted file mode 100644
index 10b87622..00000000
--- a/doc/models/list-customer-groups-request.md
+++ /dev/null
@@ -1,26 +0,0 @@
-
-# List Customer Groups Request
-
-Defines the query parameters that can be included in a request to the
-[ListCustomerGroups](../../doc/apis/customer-groups.md#list-customer-groups) endpoint.
-
-## Structure
-
-`ListCustomerGroupsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for your original query.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.
If the limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: `>= 1`, `<= 50` | getLimit(): ?int | setLimit(?int limit): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "cursor4",
- "limit": 104
-}
-```
-
diff --git a/doc/models/list-customer-groups-response.md b/doc/models/list-customer-groups-response.md
deleted file mode 100644
index da566093..00000000
--- a/doc/models/list-customer-groups-response.md
+++ /dev/null
@@ -1,62 +0,0 @@
-
-# List Customer Groups Response
-
-Defines the fields that are included in the response body of
-a request to the [ListCustomerGroups](../../doc/apis/customer-groups.md#list-customer-groups) endpoint.
-
-Either `errors` or `groups` is present in a given response (never both).
-
-## Structure
-
-`ListCustomerGroupsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `groups` | [`?(CustomerGroup[])`](../../doc/models/customer-group.md) | Optional | A list of customer groups belonging to the current seller. | getGroups(): ?array | setGroups(?array groups): void |
-| `cursor` | `?string` | Optional | A pagination cursor to retrieve the next set of results for your
original query to the endpoint. This value is present only if the request
succeeded and additional results are available.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "groups": [
- {
- "created_at": "2020-04-13T21:54:57.863Z",
- "id": "2TAT3CMH4Q0A9M87XJZED0WMR3",
- "name": "Loyal Customers",
- "updated_at": "2020-04-13T21:54:58Z"
- },
- {
- "created_at": "2020-04-13T21:55:18.795Z",
- "id": "4XMEHESXJBNE9S9JAKZD2FGB14",
- "name": "Super Loyal Customers",
- "updated_at": "2020-04-13T21:55:19Z"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor0"
-}
-```
-
diff --git a/doc/models/list-customer-segments-request.md b/doc/models/list-customer-segments-request.md
deleted file mode 100644
index 904b8b9e..00000000
--- a/doc/models/list-customer-segments-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# List Customer Segments Request
-
-Defines the valid parameters for requests to the `ListCustomerSegments` endpoint.
-
-## Structure
-
-`ListCustomerSegmentsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | A pagination cursor returned by previous calls to `ListCustomerSegments`.
This cursor is used to retrieve the next set of query results.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.
If the specified limit is less than 1 or greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 50.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: `>= 1`, `<= 50` | getLimit(): ?int | setLimit(?int limit): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "cursor4",
- "limit": 4
-}
-```
-
diff --git a/doc/models/list-customer-segments-response.md b/doc/models/list-customer-segments-response.md
deleted file mode 100644
index bd1429d0..00000000
--- a/doc/models/list-customer-segments-response.md
+++ /dev/null
@@ -1,73 +0,0 @@
-
-# List Customer Segments Response
-
-Defines the fields that are included in the response body for requests to the `ListCustomerSegments` endpoint.
-
-Either `errors` or `segments` is present in a given response (never both).
-
-## Structure
-
-`ListCustomerSegmentsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `segments` | [`?(CustomerSegment[])`](../../doc/models/customer-segment.md) | Optional | The list of customer segments belonging to the associated Square account. | getSegments(): ?array | setSegments(?array segments): void |
-| `cursor` | `?string` | Optional | A pagination cursor to be used in subsequent calls to `ListCustomerSegments`
to retrieve the next set of query results. The cursor is only present if the request succeeded and
additional results are available.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "segments": [
- {
- "created_at": "2020-01-09T19:33:24.469Z",
- "id": "GMNXRZVEXNQDF.CHURN_RISK",
- "name": "Lapsed",
- "updated_at": "2020-04-13T21:47:04Z"
- },
- {
- "created_at": "2020-01-09T19:33:24.486Z",
- "id": "GMNXRZVEXNQDF.LOYAL",
- "name": "Regulars",
- "updated_at": "2020-04-13T21:47:04Z"
- },
- {
- "created_at": "2020-01-09T19:33:21.813Z",
- "id": "GMNXRZVEXNQDF.REACHABLE",
- "name": "Reachable",
- "updated_at": "2020-04-13T21:47:04Z"
- },
- {
- "created_at": "2020-01-09T19:33:25Z",
- "id": "gv2:KF92J19VXN5FK30GX2E8HSGQ20",
- "name": "Instant Profile",
- "updated_at": "2020-04-13T23:01:03Z"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor2"
-}
-```
-
diff --git a/doc/models/list-customers-request.md b/doc/models/list-customers-request.md
deleted file mode 100644
index 805936f4..00000000
--- a/doc/models/list-customers-request.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# List Customers Request
-
-Defines the query parameters that can be included in a request to the
-`ListCustomers` endpoint.
-
-## Structure
-
-`ListCustomersRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for your original query.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.
If the specified limit is less than 1 or greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `sortField` | [`?string(CustomerSortField)`](../../doc/models/customer-sort-field.md) | Optional | Specifies customer attributes as the sort key to customer profiles returned from a search. | getSortField(): ?string | setSortField(?string sortField): void |
-| `sortOrder` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-| `count` | `?bool` | Optional | Indicates whether to return the total count of customers in the `count` field of the response.
The default value is `false`. | getCount(): ?bool | setCount(?bool count): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "cursor6",
- "limit": 96,
- "sort_field": "DEFAULT",
- "sort_order": "DESC",
- "count": false
-}
-```
-
diff --git a/doc/models/list-customers-response.md b/doc/models/list-customers-response.md
deleted file mode 100644
index dd0b26bf..00000000
--- a/doc/models/list-customers-response.md
+++ /dev/null
@@ -1,98 +0,0 @@
-
-# List Customers Response
-
-Defines the fields that are included in the response body of
-a request to the `ListCustomers` endpoint.
-
-Either `errors` or `customers` is present in a given response (never both).
-
-## Structure
-
-`ListCustomersResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `customers` | [`?(Customer[])`](../../doc/models/customer.md) | Optional | The customer profiles associated with the Square account or an empty object (`{}`) if none are found.
Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or
`phone_number`) are included in the response. | getCustomers(): ?array | setCustomers(?array customers): void |
-| `cursor` | `?string` | Optional | A pagination cursor to retrieve the next set of results for the
original query. A cursor is only present if the request succeeded and additional results
are available.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `count` | `?int` | Optional | The total count of customers associated with the Square account. Only customer profiles with public information
(`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are counted. This field is present
only if `count` is set to `true` in the request. | getCount(): ?int | setCount(?int count): void |
-
-## Example (as JSON)
-
-```json
-{
- "customers": [
- {
- "address": {
- "address_line_1": "500 Electric Ave",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "NY",
- "country": "US",
- "locality": "New York",
- "postal_code": "10003"
- },
- "created_at": "2016-03-23T20:21:54.859Z",
- "creation_source": "THIRD_PARTY",
- "email_address": "Amelia.Earhart@example.com",
- "family_name": "Earhart",
- "given_name": "Amelia",
- "group_ids": [
- "545AXB44B4XXWMVQ4W8SBT3HHF"
- ],
- "id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "note": "a customer",
- "phone_number": "+1-212-555-4240",
- "preferences": {
- "email_unsubscribed": false
- },
- "reference_id": "YOUR_REFERENCE_ID",
- "segment_ids": [
- "1KB9JE5EGJXCW.REACHABLE"
- ],
- "updated_at": "2016-03-23T20:21:55Z",
- "version": 1,
- "cards": [
- {
- "id": "id8",
- "card_brand": "DISCOVER",
- "last_4": "last_40",
- "exp_month": 152,
- "exp_year": 144
- },
- {
- "id": "id8",
- "card_brand": "DISCOVER",
- "last_4": "last_40",
- "exp_month": 152,
- "exp_year": 144
- }
- ]
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor6",
- "count": 184
-}
-```
-
diff --git a/doc/models/list-device-codes-request.md b/doc/models/list-device-codes-request.md
deleted file mode 100644
index afbbbe23..00000000
--- a/doc/models/list-device-codes-request.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# List Device Codes Request
-
-## Structure
-
-`ListDeviceCodesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this to retrieve the next set of results for your original query.
See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-| `locationId` | `?string` | Optional | If specified, only returns DeviceCodes of the specified location.
Returns DeviceCodes of all locations if empty. | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `productType` | [`?string(ProductType)`](../../doc/models/product-type.md) | Optional | - | getProductType(): ?string | setProductType(?string productType): void |
-| `status` | [`?(string(DeviceCodeStatus)[])`](../../doc/models/device-code-status.md) | Optional | If specified, returns DeviceCodes with the specified statuses.
Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.
See [DeviceCodeStatus](#type-devicecodestatus) for possible values | getStatus(): ?array | setStatus(?array status): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "cursor6",
- "location_id": "location_id4",
- "product_type": "TERMINAL_API",
- "status": [
- "UNKNOWN",
- "UNPAIRED",
- "PAIRED"
- ]
-}
-```
-
diff --git a/doc/models/list-device-codes-response.md b/doc/models/list-device-codes-response.md
deleted file mode 100644
index cb3afe5a..00000000
--- a/doc/models/list-device-codes-response.md
+++ /dev/null
@@ -1,69 +0,0 @@
-
-# List Device Codes Response
-
-## Structure
-
-`ListDeviceCodesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `deviceCodes` | [`?(DeviceCode[])`](../../doc/models/device-code.md) | Optional | The queried DeviceCode. | getDeviceCodes(): ?array | setDeviceCodes(?array deviceCodes): void |
-| `cursor` | `?string` | Optional | A pagination cursor to retrieve the next set of results for your
original query to the endpoint. This value is present only if the request
succeeded and additional results are available.
See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "device_codes": [
- {
- "code": "EBCARJ",
- "created_at": "2020-02-06T18:44:33.000Z",
- "device_id": "907CS13101300122",
- "id": "B3Z6NAMYQSMTM",
- "location_id": "B5E4484SHHNYH",
- "name": "Counter 1",
- "pair_by": "2020-02-06T18:49:33.000Z",
- "product_type": "TERMINAL_API",
- "status": "PAIRED",
- "status_changed_at": "2020-02-06T18:47:28.000Z"
- },
- {
- "code": "GVXNYN",
- "created_at": "2020-02-07T19:55:04.000Z",
- "id": "YKGMJMYK8H4PQ",
- "location_id": "A6SYFRSV4WAFW",
- "name": "Unused device code",
- "pair_by": "2020-02-07T20:00:04.000Z",
- "product_type": "TERMINAL_API",
- "status": "UNPAIRED",
- "status_changed_at": "2020-02-07T19:55:04.000Z",
- "device_id": "device_id4"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor6"
-}
-```
-
diff --git a/doc/models/list-devices-request.md b/doc/models/list-devices-request.md
deleted file mode 100644
index 8582e6cf..00000000
--- a/doc/models/list-devices-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# List Devices Request
-
-## Structure
-
-`ListDevicesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-| `sortOrder` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-| `limit` | `?int` | Optional | The number of results to return in a single page.
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `locationId` | `?string` | Optional | If present, only returns devices at the target location. | getLocationId(): ?string | setLocationId(?string locationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "cursor0",
- "sort_order": "DESC",
- "limit": 164,
- "location_id": "location_id0"
-}
-```
-
diff --git a/doc/models/list-devices-response.md b/doc/models/list-devices-response.md
deleted file mode 100644
index 0b4fdd7a..00000000
--- a/doc/models/list-devices-response.md
+++ /dev/null
@@ -1,368 +0,0 @@
-
-# List Devices Response
-
-## Structure
-
-`ListDevicesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `devices` | [`?(Device[])`](../../doc/models/device.md) | Optional | The requested list of `Device` objects. | getDevices(): ?array | setDevices(?array devices): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request. If empty,
this is the final response.
See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "GcXjlV2iaizH7R0fMT6wUDbw6l4otigjzx8XOOspUKHo9EPLRByM",
- "devices": [
- {
- "attributes": {
- "manufacturer": "Square",
- "manufacturers_id": "995CS397A6475287",
- "merchant_token": "MLCHNZCBWFDZB",
- "model": "T2",
- "name": "Square Terminal 995",
- "type": "TERMINAL",
- "updated_at": "2023-09-29T13:04:56.335762883Z",
- "version": "5.41.0085"
- },
- "components": [
- {
- "application_details": {
- "application_type": "TERMINAL_API",
- "session_location": "LMN2K7S3RTOU3",
- "version": "6.25",
- "device_code_id": "device_code_id2"
- },
- "type": "APPLICATION",
- "card_reader_details": {
- "version": "version0"
- },
- "battery_details": {
- "visible_percent": 108,
- "external_power": "AVAILABLE_CHARGING"
- },
- "wifi_details": {
- "active": false,
- "ssid": "ssid8",
- "ip_address_v4": "ip_address_v42",
- "secure_connection": "secure_connection8",
- "signal_strength": {
- "value": 222
- }
- },
- "ethernet_details": {
- "active": false,
- "ip_address_v4": "ip_address_v42"
- }
- },
- {
- "card_reader_details": {
- "version": "3.53.70"
- },
- "type": "CARD_READER",
- "application_details": {
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
- },
- "battery_details": {
- "visible_percent": 108,
- "external_power": "AVAILABLE_CHARGING"
- },
- "wifi_details": {
- "active": false,
- "ssid": "ssid8",
- "ip_address_v4": "ip_address_v42",
- "secure_connection": "secure_connection8",
- "signal_strength": {
- "value": 222
- }
- },
- "ethernet_details": {
- "active": false,
- "ip_address_v4": "ip_address_v42"
- }
- },
- {
- "battery_details": {
- "external_power": "AVAILABLE_CHARGING",
- "visible_percent": 5
- },
- "type": "BATTERY",
- "application_details": {
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
- },
- "card_reader_details": {
- "version": "version0"
- },
- "wifi_details": {
- "active": false,
- "ssid": "ssid8",
- "ip_address_v4": "ip_address_v42",
- "secure_connection": "secure_connection8",
- "signal_strength": {
- "value": 222
- }
- },
- "ethernet_details": {
- "active": false,
- "ip_address_v4": "ip_address_v42"
- }
- },
- {
- "type": "WIFI",
- "wifi_details": {
- "active": true,
- "ip_address_v4": "10.0.0.7",
- "secure_connection": "WPA/WPA2 PSK",
- "signal_strength": {
- "value": 2
- },
- "ssid": "Staff Network"
- },
- "application_details": {
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
- },
- "card_reader_details": {
- "version": "version0"
- },
- "battery_details": {
- "visible_percent": 108,
- "external_power": "AVAILABLE_CHARGING"
- },
- "ethernet_details": {
- "active": false,
- "ip_address_v4": "ip_address_v42"
- }
- },
- {
- "ethernet_details": {
- "active": false
- },
- "type": "ETHERNET",
- "application_details": {
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
- },
- "card_reader_details": {
- "version": "version0"
- },
- "battery_details": {
- "visible_percent": 108,
- "external_power": "AVAILABLE_CHARGING"
- },
- "wifi_details": {
- "active": false,
- "ssid": "ssid8",
- "ip_address_v4": "ip_address_v42",
- "secure_connection": "secure_connection8",
- "signal_strength": {
- "value": 222
- }
- }
- }
- ],
- "id": "device:995CS397A6475287",
- "status": {
- "category": "AVAILABLE"
- }
- },
- {
- "attributes": {
- "manufacturer": "Square",
- "manufacturers_id": "995CS234B5493559",
- "merchant_token": "MLCHXZCBWFGDW",
- "model": "T2",
- "name": "Square Terminal 995",
- "type": "TERMINAL",
- "updated_at": "2023-09-29T12:39:56.335742073Z",
- "version": "5.41.0085"
- },
- "components": [
- {
- "application_details": {
- "application_type": "TERMINAL_API",
- "session_location": "LMN2K7S3RTOU3",
- "version": "6.25"
- },
- "type": "APPLICATION",
- "card_reader_details": {
- "version": "version0"
- },
- "battery_details": {
- "visible_percent": 108,
- "external_power": "AVAILABLE_CHARGING"
- },
- "wifi_details": {
- "active": false,
- "ssid": "ssid8",
- "ip_address_v4": "ip_address_v42",
- "secure_connection": "secure_connection8",
- "signal_strength": {
- "value": 222
- }
- },
- "ethernet_details": {
- "active": false,
- "ip_address_v4": "ip_address_v42"
- }
- },
- {
- "card_reader_details": {
- "version": "3.53.70"
- },
- "type": "CARD_READER",
- "application_details": {
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
- },
- "battery_details": {
- "visible_percent": 108,
- "external_power": "AVAILABLE_CHARGING"
- },
- "wifi_details": {
- "active": false,
- "ssid": "ssid8",
- "ip_address_v4": "ip_address_v42",
- "secure_connection": "secure_connection8",
- "signal_strength": {
- "value": 222
- }
- },
- "ethernet_details": {
- "active": false,
- "ip_address_v4": "ip_address_v42"
- }
- },
- {
- "battery_details": {
- "external_power": "AVAILABLE_CHARGING",
- "visible_percent": 24
- },
- "type": "BATTERY",
- "application_details": {
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
- },
- "card_reader_details": {
- "version": "version0"
- },
- "wifi_details": {
- "active": false,
- "ssid": "ssid8",
- "ip_address_v4": "ip_address_v42",
- "secure_connection": "secure_connection8",
- "signal_strength": {
- "value": 222
- }
- },
- "ethernet_details": {
- "active": false,
- "ip_address_v4": "ip_address_v42"
- }
- },
- {
- "type": "WIFI",
- "wifi_details": {
- "active": true,
- "ip_address_v4": "10.0.0.7",
- "secure_connection": "WPA/WPA2 PSK",
- "signal_strength": {
- "value": 2
- },
- "ssid": "Staff Network"
- },
- "application_details": {
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
- },
- "card_reader_details": {
- "version": "version0"
- },
- "battery_details": {
- "visible_percent": 108,
- "external_power": "AVAILABLE_CHARGING"
- },
- "ethernet_details": {
- "active": false,
- "ip_address_v4": "ip_address_v42"
- }
- },
- {
- "ethernet_details": {
- "active": false
- },
- "type": "ETHERNET",
- "application_details": {
- "application_type": "TERMINAL_API",
- "version": "version4",
- "session_location": "session_location0",
- "device_code_id": "device_code_id2"
- },
- "card_reader_details": {
- "version": "version0"
- },
- "battery_details": {
- "visible_percent": 108,
- "external_power": "AVAILABLE_CHARGING"
- },
- "wifi_details": {
- "active": false,
- "ssid": "ssid8",
- "ip_address_v4": "ip_address_v42",
- "secure_connection": "secure_connection8",
- "signal_strength": {
- "value": 222
- }
- }
- }
- ],
- "id": "device:995CS234B5493559",
- "status": {
- "category": "NEEDS_ATTENTION"
- }
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-dispute-evidence-request.md b/doc/models/list-dispute-evidence-request.md
deleted file mode 100644
index c28b5b62..00000000
--- a/doc/models/list-dispute-evidence-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# List Dispute Evidence Request
-
-Defines the parameters for a `ListDisputeEvidence` request.
-
-## Structure
-
-`ListDisputeEvidenceRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "cursor6"
-}
-```
-
diff --git a/doc/models/list-dispute-evidence-response.md b/doc/models/list-dispute-evidence-response.md
deleted file mode 100644
index bf96775a..00000000
--- a/doc/models/list-dispute-evidence-response.md
+++ /dev/null
@@ -1,45 +0,0 @@
-
-# List Dispute Evidence Response
-
-Defines the fields in a `ListDisputeEvidence` response.
-
-## Structure
-
-`ListDisputeEvidenceResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `evidence` | [`?(DisputeEvidence[])`](../../doc/models/dispute-evidence.md) | Optional | The list of evidence previously uploaded to the specified dispute. | getEvidence(): ?array | setEvidence(?array evidence): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request.
If unset, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "evidence": [
- {
- "evidence_id": "evidence_id0",
- "id": "id2",
- "dispute_id": "dispute_id4",
- "evidence_file": {
- "filename": "filename8",
- "filetype": "filetype8"
- },
- "evidence_text": "evidence_text6"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor6"
-}
-```
-
diff --git a/doc/models/list-disputes-request.md b/doc/models/list-disputes-request.md
deleted file mode 100644
index 103742e3..00000000
--- a/doc/models/list-disputes-request.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# List Disputes Request
-
-Defines the request parameters for the `ListDisputes` endpoint.
-
-## Structure
-
-`ListDisputesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `states` | [`?(string(DisputeState)[])`](../../doc/models/dispute-state.md) | Optional | The dispute states used to filter the result. If not specified, the endpoint returns all disputes.
See [DisputeState](#type-disputestate) for possible values | getStates(): ?array | setStates(?array states): void |
-| `locationId` | `?string` | Optional | The ID of the location for which to return a list of disputes.
If not specified, the endpoint returns disputes associated with all locations.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getLocationId(): ?string | setLocationId(?string locationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "cursor2",
- "states": [
- "INQUIRY_EVIDENCE_REQUIRED",
- "INQUIRY_PROCESSING",
- "INQUIRY_CLOSED"
- ],
- "location_id": "location_id8"
-}
-```
-
diff --git a/doc/models/list-disputes-response.md b/doc/models/list-disputes-response.md
deleted file mode 100644
index 35b4d4fe..00000000
--- a/doc/models/list-disputes-response.md
+++ /dev/null
@@ -1,77 +0,0 @@
-
-# List Disputes Response
-
-Defines fields in a `ListDisputes` response.
-
-## Structure
-
-`ListDisputesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `disputes` | [`?(Dispute[])`](../../doc/models/dispute.md) | Optional | The list of disputes. | getDisputes(): ?array | setDisputes(?array disputes): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request.
If unset, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "G1aSTRm48CLjJsg6Sg3hQN1b1OMaoVuG",
- "disputes": [
- {
- "amount_money": {
- "amount": 2500,
- "currency": "USD"
- },
- "brand_dispute_id": "100000809947",
- "card_brand": "VISA",
- "created_at": "2022-06-29T18:45:22.265Z",
- "disputed_payment": {
- "payment_id": "zhyh1ch64kRBrrlfVhwjCEjZWzNZY"
- },
- "due_at": "2022-07-13T00:00:00.000Z",
- "id": "XDgyFu7yo1E2S5lQGGpYn",
- "location_id": "L1HN3ZMQK64X9",
- "reason": "NO_KNOWLEDGE",
- "reported_at": "2022-06-29T00:00:00.000Z",
- "state": "ACCEPTED",
- "updated_at": "2022-07-07T19:14:42.650Z",
- "version": 2,
- "dispute_id": "dispute_id4"
- },
- {
- "amount_money": {
- "amount": 2209,
- "currency": "USD"
- },
- "brand_dispute_id": "r5Of6YaGT7AdeRaVoAGCJw",
- "card_brand": "VISA",
- "created_at": "2022-04-29T18:45:22.265Z",
- "disputed_payment": {
- "payment_id": "zhyh1ch64kRBrrlfVhwjCEjZWzNZY"
- },
- "due_at": "2022-05-13T00:00:00.000Z",
- "id": "jLGg7aXC7lvKPr9PISt0T",
- "location_id": "18YC4JDH91E1H",
- "reason": "NOT_AS_DESCRIBED",
- "reported_at": "2022-04-29T00:00:00.000Z",
- "state": "EVIDENCE_REQUIRED",
- "updated_at": "2022-04-29T18:45:22.265Z",
- "version": 1,
- "dispute_id": "dispute_id4"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-employee-wages-request.md b/doc/models/list-employee-wages-request.md
deleted file mode 100644
index 3b7bd868..00000000
--- a/doc/models/list-employee-wages-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# List Employee Wages Request
-
-A request for a set of `EmployeeWage` objects.
-
-## Structure
-
-`ListEmployeeWagesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `employeeId` | `?string` | Optional | Filter the returned wages to only those that are associated with the specified employee. | getEmployeeId(): ?string | setEmployeeId(?string employeeId): void |
-| `limit` | `?int` | Optional | The maximum number of `EmployeeWage` results to return per page. The number can range between
1 and 200. The default is 200.
**Constraints**: `>= 1`, `<= 200` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | A pointer to the next page of `EmployeeWage` results to fetch. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "employee_id": "employee_id2",
- "limit": 58,
- "cursor": "cursor4"
-}
-```
-
diff --git a/doc/models/list-employee-wages-response.md b/doc/models/list-employee-wages-response.md
deleted file mode 100644
index e3b6b367..00000000
--- a/doc/models/list-employee-wages-response.md
+++ /dev/null
@@ -1,72 +0,0 @@
-
-# List Employee Wages Response
-
-The response to a request for a set of `EmployeeWage` objects. The response contains
-a set of `EmployeeWage` objects.
-
-## Structure
-
-`ListEmployeeWagesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `employeeWages` | [`?(EmployeeWage[])`](../../doc/models/employee-wage.md) | Optional | A page of `EmployeeWage` results. | getEmployeeWages(): ?array | setEmployeeWages(?array employeeWages): void |
-| `cursor` | `?string` | Optional | The value supplied in the subsequent request to fetch the next page
of `EmployeeWage` results. | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED",
- "employee_wages": [
- {
- "employee_id": "33fJchumvVdJwxV0H6L9",
- "hourly_rate": {
- "amount": 3250,
- "currency": "USD"
- },
- "id": "pXS3qCv7BERPnEGedM4S8mhm",
- "title": "Manager"
- },
- {
- "employee_id": "33fJchumvVdJwxV0H6L9",
- "hourly_rate": {
- "amount": 2600,
- "currency": "USD"
- },
- "id": "rZduCkzYDUVL3ovh1sQgbue6",
- "title": "Cook"
- },
- {
- "employee_id": "33fJchumvVdJwxV0H6L9",
- "hourly_rate": {
- "amount": 1600,
- "currency": "USD"
- },
- "id": "FxLbs5KpPUHa8wyt5ctjubDX",
- "title": "Barista"
- },
- {
- "employee_id": "33fJchumvVdJwxV0H6L9",
- "hourly_rate": {
- "amount": 1700,
- "currency": "USD"
- },
- "id": "vD1wCgijMDR3cX5TPnu7VXto",
- "title": "Cashier"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-employees-request.md b/doc/models/list-employees-request.md
deleted file mode 100644
index c46b97ac..00000000
--- a/doc/models/list-employees-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# List Employees Request
-
-## Structure
-
-`ListEmployeesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationId` | `?string` | Optional | - | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `status` | [`?string(EmployeeStatus)`](../../doc/models/employee-status.md) | Optional | The status of the Employee being retrieved.
DEPRECATED at version 2020-08-26. Replaced by [TeamMemberStatus](entity:TeamMemberStatus). | getStatus(): ?string | setStatus(?string status): void |
-| `limit` | `?int` | Optional | The number of employees to be returned on each page. | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | The token required to retrieve the specified page of results. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_id": "location_id4",
- "status": "ACTIVE",
- "limit": 18,
- "cursor": "cursor6"
-}
-```
-
diff --git a/doc/models/list-employees-response.md b/doc/models/list-employees-response.md
deleted file mode 100644
index 4c131cc4..00000000
--- a/doc/models/list-employees-response.md
+++ /dev/null
@@ -1,52 +0,0 @@
-
-# List Employees Response
-
-## Structure
-
-`ListEmployeesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `employees` | [`?(Employee[])`](../../doc/models/employee.md) | Optional | - | getEmployees(): ?array | setEmployees(?array employees): void |
-| `cursor` | `?string` | Optional | The token to be used to retrieve the next page of results. | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "employees": [
- {
- "id": "id4",
- "first_name": "first_name4",
- "last_name": "last_name2",
- "email": "email2",
- "phone_number": "phone_number8"
- }
- ],
- "cursor": "cursor8",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-event-types-request.md b/doc/models/list-event-types-request.md
deleted file mode 100644
index ba29874b..00000000
--- a/doc/models/list-event-types-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# List Event Types Request
-
-Lists all event types that can be subscribed to.
-
-## Structure
-
-`ListEventTypesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `apiVersion` | `?string` | Optional | The API version for which to list event types. Setting this field overrides the default version used by the application. | getApiVersion(): ?string | setApiVersion(?string apiVersion): void |
-
-## Example (as JSON)
-
-```json
-{
- "api_version": "api_version0"
-}
-```
-
diff --git a/doc/models/list-event-types-response.md b/doc/models/list-event-types-response.md
deleted file mode 100644
index e336f6dd..00000000
--- a/doc/models/list-event-types-response.md
+++ /dev/null
@@ -1,52 +0,0 @@
-
-# List Event Types Response
-
-Defines the fields that are included in the response body of
-a request to the [ListEventTypes](../../doc/apis/events.md#list-event-types) endpoint.
-
-Note: if there are errors processing the request, the event types field will not be
-present.
-
-## Structure
-
-`ListEventTypesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `eventTypes` | `?(string[])` | Optional | The list of event types. | getEventTypes(): ?array | setEventTypes(?array eventTypes): void |
-| `metadata` | [`?(EventTypeMetadata[])`](../../doc/models/event-type-metadata.md) | Optional | Contains the metadata of an event type. For more information, see [EventTypeMetadata](entity:EventTypeMetadata). | getMetadata(): ?array | setMetadata(?array metadata): void |
-
-## Example (as JSON)
-
-```json
-{
- "event_types": [
- "inventory.count.updated"
- ],
- "metadata": [
- {
- "api_version_introduced": "2018-07-12",
- "event_type": "inventory.count.updated",
- "release_status": "PUBLIC"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-gift-card-activities-request.md b/doc/models/list-gift-card-activities-request.md
deleted file mode 100644
index 10706e3b..00000000
--- a/doc/models/list-gift-card-activities-request.md
+++ /dev/null
@@ -1,35 +0,0 @@
-
-# List Gift Card Activities Request
-
-Returns a list of gift card activities. You can optionally specify a filter to retrieve a
-subset of activites.
-
-## Structure
-
-`ListGiftCardActivitiesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `giftCardId` | `?string` | Optional | If a gift card ID is provided, the endpoint returns activities related
to the specified gift card. Otherwise, the endpoint returns all gift card activities for
the seller.
**Constraints**: *Maximum Length*: `50` | getGiftCardId(): ?string | setGiftCardId(?string giftCardId): void |
-| `type` | `?string` | Optional | If a [type](entity:GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type.
Otherwise, the endpoint returns all types of gift card activities. | getType(): ?string | setType(?string type): void |
-| `locationId` | `?string` | Optional | If a location ID is provided, the endpoint returns gift card activities for the specified location.
Otherwise, the endpoint returns gift card activities for all locations. | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `beginTime` | `?string` | Optional | The timestamp for the beginning of the reporting period, in RFC 3339 format.
This start time is inclusive. The default value is the current time minus one year. | getBeginTime(): ?string | setBeginTime(?string beginTime): void |
-| `endTime` | `?string` | Optional | The timestamp for the end of the reporting period, in RFC 3339 format.
This end time is inclusive. The default value is the current time. | getEndTime(): ?string | setEndTime(?string endTime): void |
-| `limit` | `?int` | Optional | If a limit is provided, the endpoint returns the specified number
of results (or fewer) per page. The maximum value is 100. The default value is 50.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
If a cursor is not provided, the endpoint returns the first page of the results.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `sortOrder` | `?string` | Optional | The order in which the endpoint returns the activities, based on `created_at`.
- `ASC` - Oldest to newest.
- `DESC` - Newest to oldest (default). | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-
-## Example (as JSON)
-
-```json
-{
- "gift_card_id": "gift_card_id6",
- "type": "type8",
- "location_id": "location_id2",
- "begin_time": "begin_time6",
- "end_time": "end_time0"
-}
-```
-
diff --git a/doc/models/list-gift-card-activities-response.md b/doc/models/list-gift-card-activities-response.md
deleted file mode 100644
index 3ff2080f..00000000
--- a/doc/models/list-gift-card-activities-response.md
+++ /dev/null
@@ -1,76 +0,0 @@
-
-# List Gift Card Activities Response
-
-A response that contains a list of `GiftCardActivity` objects. If the request resulted in errors,
-the response contains a set of `Error` objects.
-
-## Structure
-
-`ListGiftCardActivitiesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `giftCardActivities` | [`?(GiftCardActivity[])`](../../doc/models/gift-card-activity.md) | Optional | The requested gift card activities or an empty object if none are found. | getGiftCardActivities(): ?array | setGiftCardActivities(?array giftCardActivities): void |
-| `cursor` | `?string` | Optional | When a response is truncated, it includes a cursor that you can use in a
subsequent request to retrieve the next set of activities. If a cursor is not present, this is
the final response.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "gift_card_activities": [
- {
- "created_at": "2021-06-02T22:26:38.000Z",
- "gift_card_balance_money": {
- "amount": 700,
- "currency": "USD"
- },
- "gift_card_gan": "7783320002929081",
- "gift_card_id": "gftc:6d55a72470d940c6ba09c0ab8ad08d20",
- "id": "gcact_897698f894b44b3db46c6147e26a0e19",
- "location_id": "81FN9BNFZTKS4",
- "payment_id": "dEv2eksNPy6GqdYiLe4ZBNk6HqXZY",
- "redeem_activity_details": {
- "amount_money": {
- "amount": 300,
- "currency": "USD"
- }
- },
- "status": "COMPLETED",
- "type": "REDEEM"
- },
- {
- "activate_activity_details": {
- "amount_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "line_item_uid": "eIWl7X0nMuO9Ewbh0ChIx",
- "order_id": "jJNGHm4gLI6XkFbwtiSLqK72KkAZY"
- },
- "created_at": "2021-05-20T22:26:54.000Z",
- "gift_card_balance_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "gift_card_gan": "7783320002929081",
- "gift_card_id": "gftc:6d55a72470d940c6ba09c0ab8ad08d20",
- "id": "gcact_b968ebfc7d46437b945be7b9e09123b4",
- "location_id": "81FN9BNFZTKS4",
- "type": "ACTIVATE"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor2"
-}
-```
-
diff --git a/doc/models/list-gift-cards-request.md b/doc/models/list-gift-cards-request.md
deleted file mode 100644
index 3145fb74..00000000
--- a/doc/models/list-gift-cards-request.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# List Gift Cards Request
-
-A request to list gift cards. You can optionally specify a filter to retrieve a subset of
-gift cards.
-
-## Structure
-
-`ListGiftCardsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `type` | `?string` | Optional | If a [type](entity:GiftCardType) is provided, the endpoint returns gift cards of the specified type.
Otherwise, the endpoint returns gift cards of all types. | getType(): ?string | setType(?string type): void |
-| `state` | `?string` | Optional | If a [state](entity:GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state.
Otherwise, the endpoint returns the gift cards of all states. | getState(): ?string | setState(?string state): void |
-| `limit` | `?int` | Optional | If a limit is provided, the endpoint returns only the specified number of results per page.
The maximum value is 200. The default value is 30.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
**Constraints**: `>= 1`, `<= 200` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
If a cursor is not provided, the endpoint returns the first page of the results.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `customerId` | `?string` | Optional | If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer.
**Constraints**: *Maximum Length*: `191` | getCustomerId(): ?string | setCustomerId(?string customerId): void |
-
-## Example (as JSON)
-
-```json
-{
- "type": "type0",
- "state": "state6",
- "limit": 162,
- "cursor": "cursor4",
- "customer_id": "customer_id8"
-}
-```
-
diff --git a/doc/models/list-gift-cards-response.md b/doc/models/list-gift-cards-response.md
deleted file mode 100644
index e79c0b3e..00000000
--- a/doc/models/list-gift-cards-response.md
+++ /dev/null
@@ -1,72 +0,0 @@
-
-# List Gift Cards Response
-
-A response that contains a list of `GiftCard` objects. If the request resulted in errors,
-the response contains a set of `Error` objects.
-
-## Structure
-
-`ListGiftCardsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `giftCards` | [`?(GiftCard[])`](../../doc/models/gift-card.md) | Optional | The requested gift cards or an empty object if none are found. | getGiftCards(): ?array | setGiftCards(?array giftCards): void |
-| `cursor` | `?string` | Optional | When a response is truncated, it includes a cursor that you can use in a
subsequent request to retrieve the next set of gift cards. If a cursor is not present, this is
the final response.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "JbFmyvUpaNKsfC1hoLSA4WlqkgkZXTWeKuStajR5BkP7OE0ETAbeWSi6U6u7sH",
- "gift_cards": [
- {
- "balance_money": {
- "amount": 3900,
- "currency": "USD"
- },
- "created_at": "2021-06-09T22:26:54.000Z",
- "gan": "7783320008524605",
- "gan_source": "SQUARE",
- "id": "gftc:00113070ba5745f0b2377c1b9570cb03",
- "state": "ACTIVE",
- "type": "DIGITAL"
- },
- {
- "balance_money": {
- "amount": 2000,
- "currency": "USD"
- },
- "created_at": "2021-05-20T22:26:54.000Z",
- "gan": "7783320002692465",
- "gan_source": "SQUARE",
- "id": "gftc:00128a12725b41e58e0de1d20497a9dd",
- "state": "ACTIVE",
- "type": "DIGITAL"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-invoices-request.md b/doc/models/list-invoices-request.md
deleted file mode 100644
index 9790bdc9..00000000
--- a/doc/models/list-invoices-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# List Invoices Request
-
-Describes a `ListInvoice` request.
-
-## Structure
-
-`ListInvoicesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationId` | `string` | Required | The ID of the location for which to list invoices.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getLocationId(): string | setLocationId(string locationId): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for your original query.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | The maximum number of invoices to return (200 is the maximum `limit`).
If not provided, the server uses a default limit of 100 invoices. | getLimit(): ?int | setLimit(?int limit): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_id": "location_id2",
- "cursor": "cursor8",
- "limit": 152
-}
-```
-
diff --git a/doc/models/list-invoices-response.md b/doc/models/list-invoices-response.md
deleted file mode 100644
index f2dca9b4..00000000
--- a/doc/models/list-invoices-response.md
+++ /dev/null
@@ -1,196 +0,0 @@
-
-# List Invoices Response
-
-Describes a `ListInvoice` response.
-
-## Structure
-
-`ListInvoicesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `invoices` | [`?(Invoice[])`](../../doc/models/invoice.md) | Optional | The invoices retrieved. | getInvoices(): ?array | setInvoices(?array invoices): void |
-| `cursor` | `?string` | Optional | When a response is truncated, it includes a cursor that you can use in a
subsequent request to retrieve the next set of invoices. If empty, this is the final
response.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "ChoIDhIWVm54ZVRhLXhySFBOejBBM2xJb2daUQoFCI4IGAE",
- "invoices": [
- {
- "accepted_payment_methods": {
- "bank_account": false,
- "buy_now_pay_later": false,
- "card": true,
- "cash_app_pay": false,
- "square_gift_card": false
- },
- "attachments": [
- {
- "description": "Service contract",
- "filename": "file.jpg",
- "filesize": 102705,
- "hash": "273ee02cb6f5f8a3a8ca23604930dd53",
- "id": "inva:0-3bB9ZuDHiziThQhuC4fwWt",
- "mime_type": "image/jpeg",
- "uploaded_at": "2030-01-13T21:24:10Z"
- }
- ],
- "created_at": "2030-01-13T17:45:13Z",
- "custom_fields": [
- {
- "label": "Event Reference Number",
- "placement": "ABOVE_LINE_ITEMS",
- "value": "Ref. #1234"
- },
- {
- "label": "Terms of Service",
- "placement": "BELOW_LINE_ITEMS",
- "value": "The terms of service are..."
- }
- ],
- "delivery_method": "EMAIL",
- "description": "We appreciate your business!",
- "id": "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY",
- "invoice_number": "inv-100",
- "location_id": "ES0RJRZYEC39A",
- "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY",
- "payment_requests": [
- {
- "automatic_payment_source": "NONE",
- "computed_amount_money": {
- "amount": 10000,
- "currency": "USD"
- },
- "due_date": "2030-01-24",
- "reminders": [
- {
- "message": "Your invoice is due tomorrow",
- "relative_scheduled_days": -1,
- "status": "PENDING",
- "uid": "beebd363-e47f-4075-8785-c235aaa7df11"
- }
- ],
- "request_type": "BALANCE",
- "tipping_enabled": true,
- "total_completed_amount_money": {
- "amount": 0,
- "currency": "USD"
- },
- "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355"
- }
- ],
- "primary_recipient": {
- "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "email_address": "Amelia.Earhart@example.com",
- "family_name": "Earhart",
- "given_name": "Amelia",
- "phone_number": "1-212-555-4240",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- },
- "sale_or_service_date": "2030-01-24",
- "scheduled_at": "2030-01-13T10:00:00Z",
- "status": "DRAFT",
- "store_payment_method_enabled": false,
- "timezone": "America/Los_Angeles",
- "title": "Event Planning Services",
- "updated_at": "2030-01-13T21:24:10Z",
- "version": 1
- },
- {
- "accepted_payment_methods": {
- "bank_account": false,
- "buy_now_pay_later": false,
- "card": true,
- "cash_app_pay": false,
- "square_gift_card": true
- },
- "created_at": "2021-01-23T15:29:12Z",
- "delivery_method": "EMAIL",
- "id": "inv:0-ChC366qAfskpGrBI_1bozs9mEA3",
- "invoice_number": "inv-455",
- "location_id": "ES0RJRZYEC39A",
- "next_payment_amount_money": {
- "amount": 3000,
- "currency": "USD"
- },
- "order_id": "a65jnS8NXbfprvGJzY9F4fQTuaB",
- "payment_requests": [
- {
- "automatic_payment_source": "CARD_ON_FILE",
- "card_id": "ccof:IkWfpLj4tNHMyFii3GB",
- "computed_amount_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "due_date": "2021-01-23",
- "percentage_requested": "25",
- "request_type": "DEPOSIT",
- "tipping_enabled": false,
- "total_completed_amount_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "uid": "66c3bdfd-5090-4ff9-a8a0-c1e1a2ffa176"
- },
- {
- "automatic_payment_source": "CARD_ON_FILE",
- "card_id": "ccof:IkWfpLj4tNHMyFii3GB",
- "computed_amount_money": {
- "amount": 3000,
- "currency": "USD"
- },
- "due_date": "2021-06-15",
- "request_type": "BALANCE",
- "tipping_enabled": false,
- "total_completed_amount_money": {
- "amount": 0,
- "currency": "USD"
- },
- "uid": "120c5e18-4f80-4f6b-b159-774cb9bf8f99"
- }
- ],
- "primary_recipient": {
- "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "email_address": "Amelia.Earhart@example.com",
- "family_name": "Earhart",
- "given_name": "Amelia",
- "phone_number": "1-212-555-4240",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- },
- "public_url": "https://squareup.com/pay-invoice/h9sfsfTGTSnYEhISUDBhEQ",
- "sale_or_service_date": "2030-01-24",
- "status": "PARTIALLY_PAID",
- "store_payment_method_enabled": false,
- "timezone": "America/Los_Angeles",
- "updated_at": "2021-01-23T15:29:56Z",
- "version": 3
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-jobs-request.md b/doc/models/list-jobs-request.md
deleted file mode 100644
index cdca11a5..00000000
--- a/doc/models/list-jobs-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# List Jobs Request
-
-Represents a [ListJobs](../../doc/apis/team.md#list-jobs) request.
-
-## Structure
-
-`ListJobsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | The pagination cursor returned by the previous call to this endpoint. Provide this
cursor to retrieve the next page of results for your original request. For more information,
see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "cursor4"
-}
-```
-
diff --git a/doc/models/list-jobs-response.md b/doc/models/list-jobs-response.md
deleted file mode 100644
index 82bdcb46..00000000
--- a/doc/models/list-jobs-response.md
+++ /dev/null
@@ -1,52 +0,0 @@
-
-# List Jobs Response
-
-Represents a [ListJobs](../../doc/apis/team.md#list-jobs) response. Either `jobs` or `errors`
-is present in the response. If additional results are available, the `cursor` field is also present.
-
-## Structure
-
-`ListJobsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `jobs` | [`?(Job[])`](../../doc/models/job.md) | Optional | The retrieved jobs. A single paged response contains up to 100 jobs. | getJobs(): ?array | setJobs(?array jobs): void |
-| `cursor` | `?string` | Optional | An opaque cursor used to retrieve the next page of results. This field is present only
if the request succeeded and additional results are available. For more information, see
[Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | The errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "jobs": [
- {
- "created_at": "2021-06-11T22:55:45Z",
- "id": "VDNpRv8da51NU8qZFC5zDWpF",
- "is_tip_eligible": true,
- "title": "Cashier",
- "updated_at": "2021-06-11T22:55:45Z",
- "version": 2
- },
- {
- "created_at": "2021-06-11T22:55:45Z",
- "id": "FjS8x95cqHiMenw4f1NAUH4P",
- "is_tip_eligible": false,
- "title": "Chef",
- "updated_at": "2021-06-11T22:55:45Z",
- "version": 1
- }
- ],
- "cursor": "cursor6",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-location-booking-profiles-request.md b/doc/models/list-location-booking-profiles-request.md
deleted file mode 100644
index de573209..00000000
--- a/doc/models/list-location-booking-profiles-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# List Location Booking Profiles Request
-
-## Structure
-
-`ListLocationBookingProfilesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `limit` | `?int` | Optional | The maximum number of results to return in a paged response.
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.
**Constraints**: *Maximum Length*: `65536` | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 134,
- "cursor": "cursor2"
-}
-```
-
diff --git a/doc/models/list-location-booking-profiles-response.md b/doc/models/list-location-booking-profiles-response.md
deleted file mode 100644
index 13eb61c4..00000000
--- a/doc/models/list-location-booking-profiles-response.md
+++ /dev/null
@@ -1,36 +0,0 @@
-
-# List Location Booking Profiles Response
-
-## Structure
-
-`ListLocationBookingProfilesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationBookingProfiles` | [`?(LocationBookingProfile[])`](../../doc/models/location-booking-profile.md) | Optional | The list of a seller's location booking profiles. | getLocationBookingProfiles(): ?array | setLocationBookingProfiles(?array locationBookingProfiles): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in the subsequent request to get the next page of the results. Stop retrieving the next page of the results when the cursor is not set. | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [],
- "location_booking_profiles": [
- {
- "booking_site_url": "https://squareup.com/book/LY6WNBPVM6VGV/testbusiness",
- "location_id": "LY6WNBPVM6VGV",
- "online_booking_enabled": true
- },
- {
- "location_id": "PYTRNBPVMJUPV",
- "online_booking_enabled": false,
- "booking_site_url": "booking_site_url2"
- }
- ],
- "cursor": "cursor8"
-}
-```
-
diff --git a/doc/models/list-location-custom-attribute-definitions-request.md b/doc/models/list-location-custom-attribute-definitions-request.md
deleted file mode 100644
index fb2baa40..00000000
--- a/doc/models/list-location-custom-attribute-definitions-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# List Location Custom Attribute Definitions Request
-
-Represents a [ListLocationCustomAttributeDefinitions](../../doc/apis/location-custom-attributes.md#list-location-custom-attribute-definitions) request.
-
-## Structure
-
-`ListLocationCustomAttributeDefinitionsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `visibilityFilter` | [`?string(VisibilityFilter)`](../../doc/models/visibility-filter.md) | Optional | Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions. | getVisibilityFilter(): ?string | setVisibilityFilter(?string visibilityFilter): void |
-| `limit` | `?int` | Optional | The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "visibility_filter": "ALL",
- "limit": 242,
- "cursor": "cursor8"
-}
-```
-
diff --git a/doc/models/list-location-custom-attribute-definitions-response.md b/doc/models/list-location-custom-attribute-definitions-response.md
deleted file mode 100644
index f3f1d9a9..00000000
--- a/doc/models/list-location-custom-attribute-definitions-response.md
+++ /dev/null
@@ -1,63 +0,0 @@
-
-# List Location Custom Attribute Definitions Response
-
-Represents a [ListLocationCustomAttributeDefinitions](../../doc/apis/location-custom-attributes.md#list-location-custom-attribute-definitions) response.
-Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response.
-If additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.
-
-## Structure
-
-`ListLocationCustomAttributeDefinitionsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinitions` | [`?(CustomAttributeDefinition[])`](../../doc/models/custom-attribute-definition.md) | Optional | The retrieved custom attribute definitions. If no custom attribute definitions are found,
Square returns an empty object (`{}`). | getCustomAttributeDefinitions(): ?array | setCustomAttributeDefinitions(?array customAttributeDefinitions): void |
-| `cursor` | `?string` | Optional | The cursor to provide in your next call to this endpoint to retrieve the next page of
results for your original request. This field is present only if the request succeeded and
additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "ImfNzWVSiAYyiAR4gEcxDJ75KZAOSjX8H2BVHUTR0ofCtp4SdYvrUKbwYY2aCH2WqZ2FsfAuylEVUlTfaINg3ecIlFpP9Y5Ie66w9NSg9nqdI5fCJ6qdH2s0za5m2plFonsjIuFaoN89j78ROUwuSOzD6mFZPcJHhJ0CxEKc0SBH",
- "custom_attribute_definitions": [
- {
- "created_at": "2022-12-02T19:50:21.832Z",
- "description": "Location's phone number",
- "key": "phone-number",
- "name": "phone number",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-12-02T19:50:21.832Z",
- "version": 1,
- "visibility": "VISIBILITY_READ_ONLY"
- },
- {
- "created_at": "2022-12-02T19:06:36.559Z",
- "description": "Bestselling item at location",
- "key": "bestseller",
- "name": "Bestseller",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-12-03T10:17:52.341Z",
- "version": 4,
- "visibility": "VISIBILITY_READ_WRITE_VALUES"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-location-custom-attributes-request.md b/doc/models/list-location-custom-attributes-request.md
deleted file mode 100644
index 7da49e1d..00000000
--- a/doc/models/list-location-custom-attributes-request.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# List Location Custom Attributes Request
-
-Represents a [ListLocationCustomAttributes](../../doc/apis/location-custom-attributes.md#list-location-custom-attributes) request.
-
-## Structure
-
-`ListLocationCustomAttributesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `visibilityFilter` | [`?string(VisibilityFilter)`](../../doc/models/visibility-filter.md) | Optional | Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions. | getVisibilityFilter(): ?string | setVisibilityFilter(?string visibilityFilter): void |
-| `limit` | `?int` | Optional | The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request. For more
information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `withDefinitions` | `?bool` | Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom
attribute, information about the data type, or other definition details. The default value is `false`. | getWithDefinitions(): ?bool | setWithDefinitions(?bool withDefinitions): void |
-
-## Example (as JSON)
-
-```json
-{
- "visibility_filter": "ALL",
- "limit": 172,
- "cursor": "cursor6",
- "with_definitions": false
-}
-```
-
diff --git a/doc/models/list-location-custom-attributes-response.md b/doc/models/list-location-custom-attributes-response.md
deleted file mode 100644
index 106bad9d..00000000
--- a/doc/models/list-location-custom-attributes-response.md
+++ /dev/null
@@ -1,81 +0,0 @@
-
-# List Location Custom Attributes Response
-
-Represents a [ListLocationCustomAttributes](../../doc/apis/location-custom-attributes.md#list-location-custom-attributes) response.
-Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional
-results are available, the `cursor` field is also present along with `custom_attributes`.
-
-## Structure
-
-`ListLocationCustomAttributesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributes` | [`?(CustomAttribute[])`](../../doc/models/custom-attribute.md) | Optional | The retrieved custom attributes. If `with_definitions` was set to `true` in the request,
the custom attribute definition is returned in the `definition` field of each custom attribute.
If no custom attributes are found, Square returns an empty object (`{}`). | getCustomAttributes(): ?array | setCustomAttributes(?array customAttributes): void |
-| `cursor` | `?string` | Optional | The cursor to use in your next call to this endpoint to retrieve the next page of results
for your original request. This field is present only if the request succeeded and additional
results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attributes": [
- {
- "key": "key8",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 180,
- "visibility": "VISIBILITY_HIDDEN",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- {
- "key": "key8",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 180,
- "visibility": "VISIBILITY_HIDDEN",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- }
- ],
- "cursor": "cursor0",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-locations-response.md b/doc/models/list-locations-response.md
deleted file mode 100644
index 0cad7d2f..00000000
--- a/doc/models/list-locations-response.md
+++ /dev/null
@@ -1,99 +0,0 @@
-
-# List Locations Response
-
-Defines the fields that are included in the response body of a request
-to the [ListLocations](../../doc/apis/locations.md#list-locations) endpoint.
-
-Either `errors` or `locations` is present in a given response (never both).
-
-## Structure
-
-`ListLocationsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `locations` | [`?(Location[])`](../../doc/models/location.md) | Optional | The business locations. | getLocations(): ?array | setLocations(?array locations): void |
-
-## Example (as JSON)
-
-```json
-{
- "locations": [
- {
- "address": {
- "address_line_1": "123 Main St",
- "administrative_district_level_1": "CA",
- "country": "US",
- "locality": "San Francisco",
- "postal_code": "94114",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "sublocality": "sublocality6"
- },
- "business_name": "Jet Fuel Coffee",
- "capabilities": [
- "CREDIT_CARD_PROCESSING"
- ],
- "country": "US",
- "created_at": "2016-09-19T17:33:12Z",
- "currency": "USD",
- "id": "18YC4JDH91E1H",
- "language_code": "en-US",
- "merchant_id": "3MYCJG5GVYQ8Q",
- "name": "Grant Park",
- "phone_number": "+1 650-354-7217",
- "status": "ACTIVE",
- "timezone": "America/Los_Angeles"
- },
- {
- "address": {
- "address_line_1": "1234 Peachtree St. NE",
- "administrative_district_level_1": "GA",
- "locality": "Atlanta",
- "postal_code": "30309",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "sublocality": "sublocality6"
- },
- "business_name": "Jet Fuel Coffee",
- "capabilities": [
- "CREDIT_CARD_PROCESSING"
- ],
- "coordinates": {
- "latitude": 33.7889,
- "longitude": -84.3841
- },
- "country": "US",
- "created_at": "2022-02-19T17:58:25Z",
- "currency": "USD",
- "description": "Midtown Atlanta store",
- "id": "3Z4V4WHQK64X9",
- "language_code": "en-US",
- "mcc": "7299",
- "merchant_id": "3MYCJG5GVYQ8Q",
- "name": "Midtown",
- "status": "ACTIVE",
- "timezone": "America/New_York",
- "type": "PHYSICAL"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-loyalty-programs-response.md b/doc/models/list-loyalty-programs-response.md
deleted file mode 100644
index fb1e1616..00000000
--- a/doc/models/list-loyalty-programs-response.md
+++ /dev/null
@@ -1,110 +0,0 @@
-
-# List Loyalty Programs Response
-
-A response that contains all loyalty programs.
-
-## Structure
-
-`ListLoyaltyProgramsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `programs` | [`?(LoyaltyProgram[])`](../../doc/models/loyalty-program.md) | Optional | A list of `LoyaltyProgram` for the merchant. | getPrograms(): ?array | setPrograms(?array programs): void |
-
-## Example (as JSON)
-
-```json
-{
- "programs": [
- {
- "accrual_rules": [
- {
- "accrual_type": "SPEND",
- "points": 1,
- "spend_data": {
- "amount_money": {
- "amount": 100,
- "currency": "USD"
- },
- "excluded_category_ids": [
- "7ZERJKO5PVYXCVUHV2JCZ2UG",
- "FQKAOJE5C4FIMF5A2URMLW6V"
- ],
- "excluded_item_variation_ids": [
- "CBZXBUVVTYUBZGQO44RHMR6B",
- "EDILT24Z2NISEXDKGY6HP7XV"
- ],
- "tax_mode": "BEFORE_TAX"
- }
- }
- ],
- "created_at": "2020-04-20T16:55:11Z",
- "id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
- "location_ids": [
- "P034NEENMD09F"
- ],
- "reward_tiers": [
- {
- "created_at": "2020-04-20T16:55:11Z",
- "definition": {
- "discount_type": "FIXED_PERCENTAGE",
- "percentage_discount": "10",
- "scope": "ORDER",
- "catalog_object_ids": [
- "catalog_object_ids6"
- ],
- "fixed_discount_money": {
- "amount": 36,
- "currency": "SLL"
- },
- "max_discount_money": {
- "amount": 84,
- "currency": "BOB"
- }
- },
- "id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f",
- "name": "10% off entire sale",
- "points": 10,
- "pricing_rule_reference": {
- "catalog_version": 1605486402527,
- "object_id": "74C4JSHESNLTB2A7ITO5HO6F"
- }
- }
- ],
- "status": "ACTIVE",
- "terminology": {
- "one": "Point",
- "other": "Points"
- },
- "updated_at": "2020-05-01T02:00:02Z",
- "expiration_policy": {
- "expiration_duration": "expiration_duration0"
- }
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-loyalty-promotions-request.md b/doc/models/list-loyalty-promotions-request.md
deleted file mode 100644
index 06b5aa3e..00000000
--- a/doc/models/list-loyalty-promotions-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# List Loyalty Promotions Request
-
-Represents a [ListLoyaltyPromotions](../../doc/apis/loyalty.md#list-loyalty-promotions) request.
-
-## Structure
-
-`ListLoyaltyPromotionsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `status` | [`?string(LoyaltyPromotionStatus)`](../../doc/models/loyalty-promotion-status.md) | Optional | Indicates the status of a [loyalty promotion](../../doc/models/loyalty-promotion.md). | getStatus(): ?string | setStatus(?string status): void |
-| `cursor` | `?string` | Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | The maximum number of results to return in a single paged response.
The minimum value is 1 and the maximum value is 30. The default value is 30.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: `>= 1`, `<= 30` | getLimit(): ?int | setLimit(?int limit): void |
-
-## Example (as JSON)
-
-```json
-{
- "status": "CANCELED",
- "cursor": "cursor2",
- "limit": 58
-}
-```
-
diff --git a/doc/models/list-loyalty-promotions-response.md b/doc/models/list-loyalty-promotions-response.md
deleted file mode 100644
index 35ba66a5..00000000
--- a/doc/models/list-loyalty-promotions-response.md
+++ /dev/null
@@ -1,124 +0,0 @@
-
-# List Loyalty Promotions Response
-
-Represents a [ListLoyaltyPromotions](../../doc/apis/loyalty.md#list-loyalty-promotions) response.
-One of `loyalty_promotions`, an empty object, or `errors` is present in the response.
-If additional results are available, the `cursor` field is also present along with `loyalty_promotions`.
-
-## Structure
-
-`ListLoyaltyPromotionsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `loyaltyPromotions` | [`?(LoyaltyPromotion[])`](../../doc/models/loyalty-promotion.md) | Optional | The retrieved loyalty promotions. | getLoyaltyPromotions(): ?array | setLoyaltyPromotions(?array loyaltyPromotions): void |
-| `cursor` | `?string` | Optional | The cursor to use in your next call to this endpoint to retrieve the next page of results
for your original request. This field is present only if the request succeeded and additional
results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_promotions": [
- {
- "available_time": {
- "start_date": "2022-08-16",
- "time_periods": [
- "BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT"
- ],
- "end_date": "end_date8"
- },
- "created_at": "2022-08-16T08:38:54Z",
- "id": "loypromo_f0f9b849-725e-378d-b810-511237e07b67",
- "incentive": {
- "points_multiplier_data": {
- "multiplier": "3.000",
- "points_multiplier": 3
- },
- "type": "POINTS_MULTIPLIER",
- "points_addition_data": {
- "points_addition": 218
- }
- },
- "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
- "name": "Tuesday Happy Hour Promo",
- "qualifying_item_variation_ids": [
- "CJ3RYL56ITAKMD4VRCM7XERS",
- "AT3RYLR3TUA9C34VRCB7X5RR"
- ],
- "status": "ACTIVE",
- "trigger_limit": {
- "interval": "DAY",
- "times": 1
- },
- "updated_at": "2022-08-16T08:38:54Z",
- "canceled_at": "canceled_at0"
- },
- {
- "available_time": {
- "end_date": "2022-08-01",
- "start_date": "2022-07-01",
- "time_periods": [
- "BEGIN:VEVENT\nDTSTART:20220704T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=MO\nEND:VEVENT",
- "BEGIN:VEVENT\nDTSTART:20220705T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=TU\nEND:VEVENT",
- "BEGIN:VEVENT\nDTSTART:20220706T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=WE\nEND:VEVENT",
- "BEGIN:VEVENT\nDTSTART:20220707T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=TH\nEND:VEVENT",
- "BEGIN:VEVENT\nDTSTART:20220701T090000\nDURATION:PT8H\nRRULE:FREQ=WEEKLY;UNTIL=20220801T000000;BYDAY=FR\nEND:VEVENT"
- ]
- },
- "created_at": "2022-06-27T15:37:38Z",
- "id": "loypromo_e696f057-2286-35ff-8108-132241328106",
- "incentive": {
- "points_multiplier_data": {
- "multiplier": "2.000",
- "points_multiplier": 2
- },
- "type": "POINTS_MULTIPLIER",
- "points_addition_data": {
- "points_addition": 218
- }
- },
- "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
- "minimum_spend_amount_money": {
- "amount": 2000,
- "currency": "USD"
- },
- "name": "July Special",
- "qualifying_category_ids": [
- "XTQPYLR3IIU9C44VRCB3XD12"
- ],
- "status": "ENDED",
- "trigger_limit": {
- "interval": "ALL_TIME",
- "times": 5
- },
- "updated_at": "2022-06-27T15:37:38Z",
- "canceled_at": "canceled_at0"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor8"
-}
-```
-
diff --git a/doc/models/list-merchant-custom-attribute-definitions-request.md b/doc/models/list-merchant-custom-attribute-definitions-request.md
deleted file mode 100644
index 819036e6..00000000
--- a/doc/models/list-merchant-custom-attribute-definitions-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# List Merchant Custom Attribute Definitions Request
-
-Represents a [ListMerchantCustomAttributeDefinitions](../../doc/apis/merchant-custom-attributes.md#list-merchant-custom-attribute-definitions) request.
-
-## Structure
-
-`ListMerchantCustomAttributeDefinitionsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `visibilityFilter` | [`?string(VisibilityFilter)`](../../doc/models/visibility-filter.md) | Optional | Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions. | getVisibilityFilter(): ?string | setVisibilityFilter(?string visibilityFilter): void |
-| `limit` | `?int` | Optional | The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "visibility_filter": "ALL",
- "limit": 48,
- "cursor": "cursor6"
-}
-```
-
diff --git a/doc/models/list-merchant-custom-attribute-definitions-response.md b/doc/models/list-merchant-custom-attribute-definitions-response.md
deleted file mode 100644
index 8a480c89..00000000
--- a/doc/models/list-merchant-custom-attribute-definitions-response.md
+++ /dev/null
@@ -1,69 +0,0 @@
-
-# List Merchant Custom Attribute Definitions Response
-
-Represents a [ListMerchantCustomAttributeDefinitions](../../doc/apis/merchant-custom-attributes.md#list-merchant-custom-attribute-definitions) response.
-Either `custom_attribute_definitions`, an empty object, or `errors` is present in the response.
-If additional results are available, the `cursor` field is also present along with `custom_attribute_definitions`.
-
-## Structure
-
-`ListMerchantCustomAttributeDefinitionsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinitions` | [`?(CustomAttributeDefinition[])`](../../doc/models/custom-attribute-definition.md) | Optional | The retrieved custom attribute definitions. If no custom attribute definitions are found,
Square returns an empty object (`{}`). | getCustomAttributeDefinitions(): ?array | setCustomAttributeDefinitions(?array customAttributeDefinitions): void |
-| `cursor` | `?string` | Optional | The cursor to provide in your next call to this endpoint to retrieve the next page of
results for your original request. This field is present only if the request succeeded and
additional results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "ImfNzWVSiAYyiAR4gEcxDJ75KZAOSjX8H2BVHUTR0ofCtp4SdYvrUKbwYY2aCH2WqZ2FsfAuylEVUlTfaINg3ecIlFpP9Y5Ie66w9NSg9nqdI5fCJ6qdH2s0za5m2plFonsjIuFaoN89j78ROUwuSOzD6mFZPcJHhJ0CxEKc0SBH",
- "custom_attribute_definitions": [
- {
- "created_at": "2023-05-05T16:50:21.832Z",
- "description": "Whether the merchant has seen the tutorial screen for using the app.",
- "key": "has_seen_tutorial",
- "name": "NAME",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2023-05-05T16:50:21.832Z",
- "version": 1,
- "visibility": "VISIBILITY_READ_WRITE_VALUES"
- },
- {
- "created_at": "2023-05-05T19:06:36.559Z",
- "description": "This is the other name this merchant goes by.",
- "key": "alternative_seller_name",
- "name": "Alternative Merchant Name",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2023-05-05T10:17:52.341Z",
- "version": 4,
- "visibility": "VISIBILITY_READ_ONLY"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-merchant-custom-attributes-request.md b/doc/models/list-merchant-custom-attributes-request.md
deleted file mode 100644
index 6b37cbf9..00000000
--- a/doc/models/list-merchant-custom-attributes-request.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# List Merchant Custom Attributes Request
-
-Represents a [ListMerchantCustomAttributes](../../doc/apis/merchant-custom-attributes.md#list-merchant-custom-attributes) request.
-
-## Structure
-
-`ListMerchantCustomAttributesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `visibilityFilter` | [`?string(VisibilityFilter)`](../../doc/models/visibility-filter.md) | Optional | Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions. | getVisibilityFilter(): ?string | setVisibilityFilter(?string visibilityFilter): void |
-| `limit` | `?int` | Optional | The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request. For more
information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `withDefinitions` | `?bool` | Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom
attribute, information about the data type, or other definition details. The default value is `false`. | getWithDefinitions(): ?bool | setWithDefinitions(?bool withDefinitions): void |
-
-## Example (as JSON)
-
-```json
-{
- "visibility_filter": "READ_WRITE",
- "limit": 132,
- "cursor": "cursor6",
- "with_definitions": false
-}
-```
-
diff --git a/doc/models/list-merchant-custom-attributes-response.md b/doc/models/list-merchant-custom-attributes-response.md
deleted file mode 100644
index 0714760f..00000000
--- a/doc/models/list-merchant-custom-attributes-response.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# List Merchant Custom Attributes Response
-
-Represents a [ListMerchantCustomAttributes](../../doc/apis/merchant-custom-attributes.md#list-merchant-custom-attributes) response.
-Either `custom_attributes`, an empty object, or `errors` is present in the response. If additional
-results are available, the `cursor` field is also present along with `custom_attributes`.
-
-## Structure
-
-`ListMerchantCustomAttributesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributes` | [`?(CustomAttribute[])`](../../doc/models/custom-attribute.md) | Optional | The retrieved custom attributes. If `with_definitions` was set to `true` in the request,
the custom attribute definition is returned in the `definition` field of each custom attribute.
If no custom attributes are found, Square returns an empty object (`{}`). | getCustomAttributes(): ?array | setCustomAttributes(?array customAttributes): void |
-| `cursor` | `?string` | Optional | The cursor to use in your next call to this endpoint to retrieve the next page of results
for your original request. This field is present only if the request succeeded and additional
results are available. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attributes": [
- {
- "key": "key8",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 180,
- "visibility": "VISIBILITY_HIDDEN",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- }
- ],
- "cursor": "cursor6",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-merchants-request.md b/doc/models/list-merchants-request.md
deleted file mode 100644
index 76ec77ce..00000000
--- a/doc/models/list-merchants-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# List Merchants Request
-
-Request object for the [ListMerchant](../../doc/apis/merchants.md#list-merchants) endpoint.
-
-## Structure
-
-`ListMerchantsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?int` | Optional | The cursor generated by the previous response. | getCursor(): ?int | setCursor(?int cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": 106
-}
-```
-
diff --git a/doc/models/list-merchants-response.md b/doc/models/list-merchants-response.md
deleted file mode 100644
index 34ed2c4a..00000000
--- a/doc/models/list-merchants-response.md
+++ /dev/null
@@ -1,45 +0,0 @@
-
-# List Merchants Response
-
-The response object returned by the [ListMerchant](../../doc/apis/merchants.md#list-merchants) endpoint.
-
-## Structure
-
-`ListMerchantsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `merchant` | [`?(Merchant[])`](../../doc/models/merchant.md) | Optional | The requested `Merchant` entities. | getMerchant(): ?array | setMerchant(?array merchant): void |
-| `cursor` | `?int` | Optional | If the response is truncated, the cursor to use in next request to fetch next set of objects. | getCursor(): ?int | setCursor(?int cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "merchant": [
- {
- "business_name": "Apple A Day",
- "country": "US",
- "created_at": "2021-12-10T19:25:52.484Z",
- "currency": "USD",
- "id": "DM7VKY8Q63GNP",
- "language_code": "en-US",
- "main_location_id": "9A65CGC72ZQG1",
- "status": "ACTIVE"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": 124
-}
-```
-
diff --git a/doc/models/list-order-custom-attribute-definitions-request.md b/doc/models/list-order-custom-attribute-definitions-request.md
deleted file mode 100644
index a1d49c9c..00000000
--- a/doc/models/list-order-custom-attribute-definitions-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# List Order Custom Attribute Definitions Request
-
-Represents a list request for order custom attribute definitions.
-
-## Structure
-
-`ListOrderCustomAttributeDefinitionsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `visibilityFilter` | [`?string(VisibilityFilter)`](../../doc/models/visibility-filter.md) | Optional | Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions. | getVisibilityFilter(): ?string | setVisibilityFilter(?string visibilityFilter): void |
-| `cursor` | `?string` | Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
**Constraints**: *Minimum Length*: `1` | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-
-## Example (as JSON)
-
-```json
-{
- "visibility_filter": "READ_WRITE",
- "cursor": "cursor2",
- "limit": 6
-}
-```
-
diff --git a/doc/models/list-order-custom-attribute-definitions-response.md b/doc/models/list-order-custom-attribute-definitions-response.md
deleted file mode 100644
index 030752c4..00000000
--- a/doc/models/list-order-custom-attribute-definitions-response.md
+++ /dev/null
@@ -1,80 +0,0 @@
-
-# List Order Custom Attribute Definitions Response
-
-Represents a response from listing order custom attribute definitions.
-
-## Structure
-
-`ListOrderCustomAttributeDefinitionsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinitions` | [`CustomAttributeDefinition[]`](../../doc/models/custom-attribute-definition.md) | Required | The retrieved custom attribute definitions. If no custom attribute definitions are found, Square returns an empty object (`{}`). | getCustomAttributeDefinitions(): array | setCustomAttributeDefinitions(array customAttributeDefinitions): void |
-| `cursor` | `?string` | Optional | The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request.
This field is present only if the request succeeded and additional results are available.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
**Constraints**: *Minimum Length*: `1` | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definitions": [
- {
- "created_at": "2022-11-16T18:03:44.051Z",
- "description": "The number of people seated at a table",
- "key": "cover-count",
- "name": "Cover count",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-11-16T18:03:44.051Z",
- "version": 1,
- "visibility": "VISIBILITY_READ_WRITE_VALUES"
- },
- {
- "created_at": "2022-11-16T18:04:32.059Z",
- "description": "The identifier for a particular seat",
- "key": "seat-number",
- "name": "Seat number",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-11-16T18:04:32.059Z",
- "version": 1,
- "visibility": "VISIBILITY_READ_WRITE_VALUES"
- },
- {
- "created_at": "2022-11-16T18:04:21.912Z",
- "description": "The identifier for a particular table",
- "key": "table-number",
- "name": "Table number",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-11-16T18:04:21.912Z",
- "version": 1,
- "visibility": "VISIBILITY_READ_WRITE_VALUES"
- }
- ],
- "cursor": "cursor4",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-order-custom-attributes-request.md b/doc/models/list-order-custom-attributes-request.md
deleted file mode 100644
index a035b7d9..00000000
--- a/doc/models/list-order-custom-attributes-request.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# List Order Custom Attributes Request
-
-Represents a list request for order custom attributes.
-
-## Structure
-
-`ListOrderCustomAttributesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `visibilityFilter` | [`?string(VisibilityFilter)`](../../doc/models/visibility-filter.md) | Optional | Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions. | getVisibilityFilter(): ?string | setVisibilityFilter(?string visibilityFilter): void |
-| `cursor` | `?string` | Optional | The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
**Constraints**: *Minimum Length*: `1` | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `withDefinitions` | `?bool` | Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom attribute,
information about the data type, or other definition details. The default value is `false`. | getWithDefinitions(): ?bool | setWithDefinitions(?bool withDefinitions): void |
-
-## Example (as JSON)
-
-```json
-{
- "visibility_filter": "READ",
- "cursor": "cursor2",
- "limit": 158,
- "with_definitions": false
-}
-```
-
diff --git a/doc/models/list-order-custom-attributes-response.md b/doc/models/list-order-custom-attributes-response.md
deleted file mode 100644
index 1d846037..00000000
--- a/doc/models/list-order-custom-attributes-response.md
+++ /dev/null
@@ -1,79 +0,0 @@
-
-# List Order Custom Attributes Response
-
-Represents a response from listing order custom attributes.
-
-## Structure
-
-`ListOrderCustomAttributesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributes` | [`?(CustomAttribute[])`](../../doc/models/custom-attribute.md) | Optional | The retrieved custom attributes. If no custom attribute are found, Square returns an empty object (`{}`). | getCustomAttributes(): ?array | setCustomAttributes(?array customAttributes): void |
-| `cursor` | `?string` | Optional | The cursor to provide in your next call to this endpoint to retrieve the next page of results for your original request.
This field is present only if the request succeeded and additional results are available.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
**Constraints**: *Minimum Length*: `1` | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attributes": [
- {
- "key": "key8",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 180,
- "visibility": "VISIBILITY_HIDDEN",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- {
- "key": "key8",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 180,
- "visibility": "VISIBILITY_HIDDEN",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- }
- ],
- "cursor": "cursor4",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-payment-links-request.md b/doc/models/list-payment-links-request.md
deleted file mode 100644
index f78cfc3a..00000000
--- a/doc/models/list-payment-links-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# List Payment Links Request
-
-## Structure
-
-`ListPaymentLinksRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
If a cursor is not provided, the endpoint returns the first page of the results.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | A limit on the number of results to return per page. The limit is advisory and
the implementation might return more or less results. If the supplied limit is negative, zero, or
greater than the maximum limit of 1000, it is ignored.
Default value: `100` | getLimit(): ?int | setLimit(?int limit): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "cursor6",
- "limit": 182
-}
-```
-
diff --git a/doc/models/list-payment-links-response.md b/doc/models/list-payment-links-response.md
deleted file mode 100644
index 299cfea3..00000000
--- a/doc/models/list-payment-links-response.md
+++ /dev/null
@@ -1,102 +0,0 @@
-
-# List Payment Links Response
-
-## Structure
-
-`ListPaymentLinksResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `paymentLinks` | [`?(PaymentLink[])`](../../doc/models/payment-link.md) | Optional | The list of payment links. | getPaymentLinks(): ?array | setPaymentLinks(?array paymentLinks): void |
-| `cursor` | `?string` | Optional | When a response is truncated, it includes a cursor that you can use in a subsequent request
to retrieve the next set of gift cards. If a cursor is not present, this is the final response.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "MTY1NQ==",
- "payment_links": [
- {
- "checkout_options": {
- "ask_for_shipping_address": true,
- "allow_tipping": false,
- "custom_fields": [
- {
- "title": "title8"
- },
- {
- "title": "title8"
- }
- ],
- "subscription_plan_id": "subscription_plan_id8",
- "redirect_url": "redirect_url2",
- "merchant_support_email": "merchant_support_email8"
- },
- "created_at": "2022-04-26T00:15:15Z",
- "id": "TN4BWEDJ9AI5MBIV",
- "order_id": "Qqc6yppGvxVwc46Cch4zHTaJqc4F",
- "payment_note": "test",
- "updated_at": "2022-04-26T00:18:24Z",
- "url": "https://square.link/u/EXAMPLE",
- "version": 2,
- "description": "description2",
- "pre_populated_data": {
- "buyer_email": "buyer_email8",
- "buyer_phone_number": "buyer_phone_number0",
- "buyer_address": {
- "address_line_1": "address_line_12",
- "address_line_2": "address_line_22",
- "address_line_3": "address_line_38",
- "locality": "locality2",
- "sublocality": "sublocality2"
- }
- }
- },
- {
- "created_at": "2022-04-11T23:14:59Z",
- "description": "",
- "id": "RY5UNCUMPJN5XKCT",
- "order_id": "EmBmGt3zJD15QeO1dxzBTxMxtwfZY",
- "url": "https://square.link/u/EXAMPLE",
- "version": 1,
- "checkout_options": {
- "allow_tipping": false,
- "custom_fields": [
- {
- "title": "title8"
- },
- {
- "title": "title8"
- }
- ],
- "subscription_plan_id": "subscription_plan_id8",
- "redirect_url": "redirect_url2",
- "merchant_support_email": "merchant_support_email8"
- },
- "pre_populated_data": {
- "buyer_email": "buyer_email8",
- "buyer_phone_number": "buyer_phone_number0",
- "buyer_address": {
- "address_line_1": "address_line_12",
- "address_line_2": "address_line_22",
- "address_line_3": "address_line_38",
- "locality": "locality2",
- "sublocality": "sublocality2"
- }
- }
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-payment-refunds-request.md b/doc/models/list-payment-refunds-request.md
deleted file mode 100644
index ac06ef98..00000000
--- a/doc/models/list-payment-refunds-request.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-# List Payment Refunds Request
-
-Describes a request to list refunds using
-[ListPaymentRefunds](../../doc/apis/refunds.md#list-payment-refunds).
-
-The maximum results per page is 100.
-
-## Structure
-
-`ListPaymentRefundsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `beginTime` | `?string` | Optional | Indicates the start of the time range to retrieve each `PaymentRefund` for, in RFC 3339
format. The range is determined using the `created_at` field for each `PaymentRefund`.
Default: The current time minus one year. | getBeginTime(): ?string | setBeginTime(?string beginTime): void |
-| `endTime` | `?string` | Optional | Indicates the end of the time range to retrieve each `PaymentRefund` for, in RFC 3339
format. The range is determined using the `created_at` field for each `PaymentRefund`.
Default: The current time. | getEndTime(): ?string | setEndTime(?string endTime): void |
-| `sortOrder` | `?string` | Optional | The order in which results are listed by `PaymentRefund.created_at`:
- `ASC` - Oldest to newest.
- `DESC` - Newest to oldest (default). | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `locationId` | `?string` | Optional | Limit results to the location supplied. By default, results are returned
for all locations associated with the seller. | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `status` | `?string` | Optional | If provided, only refunds with the given status are returned.
For a list of refund status values, see [PaymentRefund](entity:PaymentRefund).
Default: If omitted, refunds are returned regardless of their status. | getStatus(): ?string | setStatus(?string status): void |
-| `sourceType` | `?string` | Optional | If provided, only returns refunds whose payments have the indicated source type.
Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `CASH`, and `EXTERNAL`.
For information about these payment source types, see
[Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).
Default: If omitted, refunds are returned regardless of the source type. | getSourceType(): ?string | setSourceType(?string sourceType): void |
-| `limit` | `?int` | Optional | The maximum number of results to be returned in a single page.
It is possible to receive fewer results than the specified limit on a given page.
If the supplied value is greater than 100, no more than 100 results are returned.
Default: 100 | getLimit(): ?int | setLimit(?int limit): void |
-
-## Example (as JSON)
-
-```json
-{
- "begin_time": "begin_time8",
- "end_time": "end_time2",
- "sort_order": "sort_order0",
- "cursor": "cursor4",
- "location_id": "location_id4"
-}
-```
-
diff --git a/doc/models/list-payment-refunds-response.md b/doc/models/list-payment-refunds-response.md
deleted file mode 100644
index a7577892..00000000
--- a/doc/models/list-payment-refunds-response.md
+++ /dev/null
@@ -1,97 +0,0 @@
-
-# List Payment Refunds Response
-
-Defines the response returned by [ListPaymentRefunds](../../doc/apis/refunds.md#list-payment-refunds).
-
-Either `errors` or `refunds` is present in a given response (never both).
-
-## Structure
-
-`ListPaymentRefundsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `refunds` | [`?(PaymentRefund[])`](../../doc/models/payment-refund.md) | Optional | The list of requested refunds. | getRefunds(): ?array | setRefunds(?array refunds): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request. If empty,
this is the final response.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "5evquW1YswHoT4EoyUhzMmTsCnsSXBU9U0WJ4FU4623nrMQcocH0RGU6Up1YkwfiMcF59ood58EBTEGgzMTGHQJpocic7ExOL0NtrTXCeWcv0UJIJNk8eXb",
- "refunds": [
- {
- "amount_money": {
- "amount": 555,
- "currency": "USD"
- },
- "created_at": "2021-10-13T19:59:05.342Z",
- "id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY_69MmgHubkLqx9wGhnmenRUHOaKitE6llfZuxcWYjGxd",
- "location_id": "L88917AVBK2S5",
- "order_id": "9ltv0bx5PuvGXUYHYHxYSKEqC3IZY",
- "payment_id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY",
- "processing_fee": [
- {
- "amount_money": {
- "amount": -34,
- "currency": "USD"
- },
- "effective_at": "2021-10-13T21:34:35.000Z",
- "type": "INITIAL"
- }
- ],
- "reason": "Example Refund",
- "status": "COMPLETED",
- "updated_at": "2021-10-13T20:00:03.497Z",
- "unlinked": false,
- "destination_type": "destination_type2",
- "destination_details": {
- "card_details": {
- "card": {
- "id": "id6",
- "card_brand": "OTHER_BRAND",
- "last_4": "last_48",
- "exp_month": 228,
- "exp_year": 68
- },
- "entry_method": "entry_method8",
- "auth_result_code": "auth_result_code0"
- },
- "cash_details": {
- "seller_supplied_money": {
- "amount": 36,
- "currency": "MKD"
- },
- "change_back_money": {
- "amount": 78,
- "currency": "XBD"
- }
- },
- "external_details": {
- "type": "type6",
- "source": "source0",
- "source_id": "source_id8"
- }
- }
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-payments-request.md b/doc/models/list-payments-request.md
deleted file mode 100644
index c2f637d4..00000000
--- a/doc/models/list-payments-request.md
+++ /dev/null
@@ -1,44 +0,0 @@
-
-# List Payments Request
-
-Describes a request to list payments using
-[ListPayments](../../doc/apis/payments.md#list-payments).
-
-The maximum results per page is 100.
-
-## Structure
-
-`ListPaymentsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `beginTime` | `?string` | Optional | Indicates the start of the time range to retrieve payments for, in RFC 3339 format.
The range is determined using the `created_at` field for each Payment.
Inclusive. Default: The current time minus one year. | getBeginTime(): ?string | setBeginTime(?string beginTime): void |
-| `endTime` | `?string` | Optional | Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The
range is determined using the `created_at` field for each Payment.
Default: The current time. | getEndTime(): ?string | setEndTime(?string endTime): void |
-| `sortOrder` | `?string` | Optional | The order in which results are listed by `ListPaymentsRequest.sort_field`:
- `ASC` - Oldest to newest.
- `DESC` - Newest to oldest (default). | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `locationId` | `?string` | Optional | Limit results to the location supplied. By default, results are returned
for the default (main) location associated with the seller. | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `total` | `?int` | Optional | The exact amount in the `total_money` for a payment. | getTotal(): ?int | setTotal(?int total): void |
-| `last4` | `?string` | Optional | The last four digits of a payment card. | getLast4(): ?string | setLast4(?string last4): void |
-| `cardBrand` | `?string` | Optional | The brand of the payment card (for example, VISA). | getCardBrand(): ?string | setCardBrand(?string cardBrand): void |
-| `limit` | `?int` | Optional | The maximum number of results to be returned in a single page.
It is possible to receive fewer results than the specified limit on a given page.
The default value of 100 is also the maximum allowed value. If the provided value is
greater than 100, it is ignored and the default value is used instead.
Default: `100` | getLimit(): ?int | setLimit(?int limit): void |
-| `isOfflinePayment` | `?bool` | Optional | Whether the payment was taken offline or not. | getIsOfflinePayment(): ?bool | setIsOfflinePayment(?bool isOfflinePayment): void |
-| `offlineBeginTime` | `?string` | Optional | Indicates the start of the time range for which to retrieve offline payments, in RFC 3339
format for timestamps. The range is determined using the
`offline_payment_details.client_created_at` field for each Payment. If set, payments without a
value set in `offline_payment_details.client_created_at` will not be returned.
Default: The current time. | getOfflineBeginTime(): ?string | setOfflineBeginTime(?string offlineBeginTime): void |
-| `offlineEndTime` | `?string` | Optional | Indicates the end of the time range for which to retrieve offline payments, in RFC 3339
format for timestamps. The range is determined using the
`offline_payment_details.client_created_at` field for each Payment. If set, payments without a
value set in `offline_payment_details.client_created_at` will not be returned.
Default: The current time. | getOfflineEndTime(): ?string | setOfflineEndTime(?string offlineEndTime): void |
-| `updatedAtBeginTime` | `?string` | Optional | Indicates the start of the time range to retrieve payments for, in RFC 3339 format. The
range is determined using the `updated_at` field for each Payment. | getUpdatedAtBeginTime(): ?string | setUpdatedAtBeginTime(?string updatedAtBeginTime): void |
-| `updatedAtEndTime` | `?string` | Optional | Indicates the end of the time range to retrieve payments for, in RFC 3339 format. The
range is determined using the `updated_at` field for each Payment. | getUpdatedAtEndTime(): ?string | setUpdatedAtEndTime(?string updatedAtEndTime): void |
-| `sortField` | [`?string(PaymentSortField)`](../../doc/models/payment-sort-field.md) | Optional | - | getSortField(): ?string | setSortField(?string sortField): void |
-
-## Example (as JSON)
-
-```json
-{
- "begin_time": "begin_time0",
- "end_time": "end_time4",
- "sort_order": "sort_order2",
- "cursor": "cursor4",
- "location_id": "location_id6"
-}
-```
-
diff --git a/doc/models/list-payments-response.md b/doc/models/list-payments-response.md
deleted file mode 100644
index 5d8560da..00000000
--- a/doc/models/list-payments-response.md
+++ /dev/null
@@ -1,105 +0,0 @@
-
-# List Payments Response
-
-Defines the response returned by [ListPayments](../../doc/apis/payments.md#list-payments).
-
-## Structure
-
-`ListPaymentsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `payments` | [`?(Payment[])`](../../doc/models/payment.md) | Optional | The requested list of payments. | getPayments(): ?array | setPayments(?array payments): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request. If empty,
this is the final response.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "payments": [
- {
- "amount_money": {
- "amount": 555,
- "currency": "USD"
- },
- "application_details": {
- "application_id": "sq0ids-Pw67AZAlLVB7hsRmwlJPuA",
- "square_product": "VIRTUAL_TERMINAL"
- },
- "approved_money": {
- "amount": 555,
- "currency": "USD"
- },
- "card_details": {
- "auth_result_code": "2Nkw7q",
- "avs_status": "AVS_ACCEPTED",
- "card": {
- "bin": "411111",
- "card_brand": "VISA",
- "card_type": "DEBIT",
- "exp_month": 11,
- "exp_year": 2022,
- "fingerprint": "sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ",
- "last_4": "1111",
- "prepaid_type": "NOT_PREPAID"
- },
- "card_payment_timeline": {
- "authorized_at": "2021-10-13T19:34:33.680Z",
- "captured_at": "2021-10-13T19:34:34.340Z"
- },
- "cvv_status": "CVV_ACCEPTED",
- "entry_method": "KEYED",
- "statement_description": "SQ *EXAMPLE TEST GOSQ.C",
- "status": "CAPTURED"
- },
- "created_at": "2021-10-13T19:34:33.524Z",
- "delay_action": "CANCEL",
- "delay_duration": "PT168H",
- "delayed_until": "2021-10-20T19:34:33.524Z",
- "employee_id": "TMoK_ogh6rH1o4dV",
- "id": "bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY",
- "location_id": "L88917AVBK2S5",
- "note": "Test Note",
- "order_id": "d7eKah653Z579f3gVtjlxpSlmUcZY",
- "processing_fee": [
- {
- "amount_money": {
- "amount": 34,
- "currency": "USD"
- },
- "effective_at": "2021-10-13T21:34:35.000Z",
- "type": "INITIAL"
- }
- ],
- "receipt_number": "bP9m",
- "receipt_url": "https://squareup.com/receipt/preview/bP9mAsEMYPUGjjGNaNO5ZDVyLhSZY",
- "source_type": "CARD",
- "status": "COMPLETED",
- "team_member_id": "TMoK_ogh6rH1o4dV",
- "total_money": {
- "amount": 555,
- "currency": "USD"
- },
- "updated_at": "2021-10-13T19:34:37.261Z",
- "version_token": "vguW2km0KpVCdAXZcNTZ438qg5LlVPTP4HO5OpiHNfa6o",
- "tip_money": {
- "amount": 190,
- "currency": "TWD"
- }
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor0"
-}
-```
-
diff --git a/doc/models/list-payout-entries-request.md b/doc/models/list-payout-entries-request.md
deleted file mode 100644
index aaa69edd..00000000
--- a/doc/models/list-payout-entries-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# List Payout Entries Request
-
-## Structure
-
-`ListPayoutEntriesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `sortOrder` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
If request parameters change between requests, subsequent results may contain duplicates or missing records. | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | The maximum number of results to be returned in a single page.
It is possible to receive fewer results than the specified limit on a given page.
The default value of 100 is also the maximum allowed value. If the provided value is
greater than 100, it is ignored and the default value is used instead.
Default: `100` | getLimit(): ?int | setLimit(?int limit): void |
-
-## Example (as JSON)
-
-```json
-{
- "sort_order": "DESC",
- "cursor": "cursor2",
- "limit": 194
-}
-```
-
diff --git a/doc/models/list-payout-entries-response.md b/doc/models/list-payout-entries-response.md
deleted file mode 100644
index a33c380f..00000000
--- a/doc/models/list-payout-entries-response.md
+++ /dev/null
@@ -1,84 +0,0 @@
-
-# List Payout Entries Response
-
-The response to retrieve payout records entries.
-
-## Structure
-
-`ListPayoutEntriesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `payoutEntries` | [`?(PayoutEntry[])`](../../doc/models/payout-entry.md) | Optional | The requested list of payout entries, ordered with the given or default sort order. | getPayoutEntries(): ?array | setPayoutEntries(?array payoutEntries): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request. If empty, this is the final response.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "TbfI80z98Xc2LdApCyZ2NvCYLpkPurYLR16GRIttpMJ55mrSIMzHgtkcRQdT0mOnTtfHO",
- "payout_entries": [
- {
- "effective_at": "2021-12-14T23:31:49Z",
- "fee_amount_money": {
- "amount": -2,
- "currency_code": "USD",
- "currency": "CHF"
- },
- "gross_amount_money": {
- "amount": -50,
- "currency_code": "USD",
- "currency": "MNT"
- },
- "id": "poe_ZQWcw41d0SGJS6IWd4cSi8mKHk",
- "net_amount_money": {
- "amount": -48,
- "currency_code": "USD",
- "currency": "XPT"
- },
- "payout_id": "po_4d28e6c4-7dd5-4de4-8ec9-a059277646a6",
- "type": "REFUND",
- "type_refund_details": {
- "payment_id": "HVdG62HeMlti8YYf94oxrN",
- "refund_id": "HVdG62HeMlti8YYf94oxrN_dR8Nztxg7umf94oxrN12Ji5r2KW14FAY"
- }
- },
- {
- "effective_at": "2021-12-14T23:31:49Z",
- "fee_amount_money": {
- "amount": 19,
- "currency_code": "USD",
- "currency": "CHF"
- },
- "gross_amount_money": {
- "amount": 100,
- "currency_code": "USD",
- "currency": "MNT"
- },
- "id": "poe_EibbY9Ob1d0SGJS6IWd4cSiSi6wkaPk",
- "net_amount_money": {
- "amount": 81,
- "currency_code": "USD",
- "currency": "XPT"
- },
- "payout_id": "po_4d28e6c4-7dd5-4de4-8ec9-a059277646a6",
- "type": "CHARGE",
- "type_charge_details": {
- "payment_id": "HVdG62H5K3291d0SGJS6IWd4cSi8YY"
- }
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-payouts-request.md b/doc/models/list-payouts-request.md
deleted file mode 100644
index 92ef08f3..00000000
--- a/doc/models/list-payouts-request.md
+++ /dev/null
@@ -1,33 +0,0 @@
-
-# List Payouts Request
-
-A request to retrieve payout records.
-
-## Structure
-
-`ListPayoutsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationId` | `?string` | Optional | The ID of the location for which to list the payouts.
By default, payouts are returned for the default (main) location associated with the seller.
**Constraints**: *Maximum Length*: `255` | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `status` | [`?string(PayoutStatus)`](../../doc/models/payout-status.md) | Optional | Payout status types | getStatus(): ?string | setStatus(?string status): void |
-| `beginTime` | `?string` | Optional | The timestamp for the beginning of the payout creation time, in RFC 3339 format.
Inclusive. Default: The current time minus one year. | getBeginTime(): ?string | setBeginTime(?string beginTime): void |
-| `endTime` | `?string` | Optional | The timestamp for the end of the payout creation time, in RFC 3339 format.
Default: The current time. | getEndTime(): ?string | setEndTime(?string endTime): void |
-| `sortOrder` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
If request parameters change between requests, subsequent results may contain duplicates or missing records. | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | The maximum number of results to be returned in a single page.
It is possible to receive fewer results than the specified limit on a given page.
The default value of 100 is also the maximum allowed value. If the provided value is
greater than 100, it is ignored and the default value is used instead.
Default: `100` | getLimit(): ?int | setLimit(?int limit): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_id": "location_id4",
- "status": "SENT",
- "begin_time": "begin_time2",
- "end_time": "end_time2",
- "sort_order": "DESC"
-}
-```
-
diff --git a/doc/models/list-payouts-response.md b/doc/models/list-payouts-response.md
deleted file mode 100644
index e033bce7..00000000
--- a/doc/models/list-payouts-response.md
+++ /dev/null
@@ -1,97 +0,0 @@
-
-# List Payouts Response
-
-The response to retrieve payout records entries.
-
-## Structure
-
-`ListPayoutsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `payouts` | [`?(Payout[])`](../../doc/models/payout.md) | Optional | The requested list of payouts. | getPayouts(): ?array | setPayouts(?array payouts): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request. If empty, this is the final response.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "EMPCyStibo64hS8wLayZPp3oedR3AeEUNd3z7u6zphi72LQZFIEMbkKVvot9eefpU",
- "payouts": [
- {
- "amount_money": {
- "amount": 6259,
- "currency_code": "USD",
- "currency": "AUD"
- },
- "arrival_date": "2022-03-29",
- "created_at": "2022-03-29T16:12:31Z",
- "destination": {
- "id": "ccof:ZPp3oedR3AeEUNd3z7",
- "type": "CARD"
- },
- "end_to_end_id": "L2100000005",
- "id": "po_b345d2c7-90b3-4f0b-a2aa-df1def7f8afc",
- "location_id": "L88917AVBK2S5",
- "payout_fee": [
- {
- "amount_money": {
- "amount": 95,
- "currency_code": "USD"
- },
- "effective_at": "2022-03-29T16:12:31Z",
- "type": "TRANSFER_FEE"
- }
- ],
- "status": "PAID",
- "type": "BATCH",
- "updated_at": "2022-03-30T01:07:22.875Z",
- "version": 2
- },
- {
- "amount_money": {
- "amount": -103,
- "currency_code": "USD",
- "currency": "AUD"
- },
- "arrival_date": "2022-03-24",
- "created_at": "2022-03-24T03:07:09Z",
- "destination": {
- "id": "bact:ZPp3oedR3AeEUNd3z7",
- "type": "BANK_ACCOUNT"
- },
- "end_to_end_id": "L2100000006",
- "id": "po_f3c0fb38-a5ce-427d-b858-52b925b72e45",
- "location_id": "L88917AVBK2S5",
- "status": "PAID",
- "type": "BATCH",
- "updated_at": "2022-03-24T03:07:09Z",
- "version": 1
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-refunds-request.md b/doc/models/list-refunds-request.md
deleted file mode 100644
index b96d2abb..00000000
--- a/doc/models/list-refunds-request.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# List Refunds Request
-
-Defines the query parameters that can be included in
-a request to the [ListRefunds](api-endpoint:Transactions-ListRefunds) endpoint.
-
-Deprecated - recommend using [SearchOrders](api-endpoint:Orders-SearchOrders)
-
-## Structure
-
-`ListRefundsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `beginTime` | `?string` | Optional | The beginning of the requested reporting period, in RFC 3339 format.
See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.
Default value: The current time minus one year. | getBeginTime(): ?string | setBeginTime(?string beginTime): void |
-| `endTime` | `?string` | Optional | The end of the requested reporting period, in RFC 3339 format.
See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.
Default value: The current time. | getEndTime(): ?string | setEndTime(?string endTime): void |
-| `sortOrder` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this to retrieve the next set of results for your original query.
See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "begin_time": "begin_time6",
- "end_time": "end_time0",
- "sort_order": "DESC",
- "cursor": "cursor8"
-}
-```
-
diff --git a/doc/models/list-refunds-response.md b/doc/models/list-refunds-response.md
deleted file mode 100644
index 0577762a..00000000
--- a/doc/models/list-refunds-response.md
+++ /dev/null
@@ -1,66 +0,0 @@
-
-# List Refunds Response
-
-Defines the fields that are included in the response body of
-a request to the [ListRefunds](api-endpoint:Transactions-ListRefunds) endpoint.
-
-One of `errors` or `refunds` is present in a given response (never both).
-
-## Structure
-
-`ListRefundsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `refunds` | [`?(Refund[])`](../../doc/models/refund.md) | Optional | An array of refunds that match your query. | getRefunds(): ?array | setRefunds(?array refunds): void |
-| `cursor` | `?string` | Optional | A pagination cursor for retrieving the next set of results,
if any remain. Provide this value as the `cursor` parameter in a subsequent
request to this endpoint.
See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "refunds": [
- {
- "additional_recipients": [
- {
- "amount_money": {
- "amount": 10,
- "currency": "USD"
- },
- "description": "Application fees",
- "location_id": "057P5VYJ4A5X1",
- "receivable_id": "receivable_id6"
- }
- ],
- "amount_money": {
- "amount": 100,
- "currency": "USD"
- },
- "created_at": "2016-01-20T00:28:18Z",
- "id": "b27436d1-7f8e-5610-45c6-417ef71434b4-SW",
- "location_id": "18YC4JDH91E1H",
- "reason": "some reason",
- "status": "APPROVED",
- "tender_id": "MtZRYYdDrYNQbOvV7nbuBvMF",
- "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF",
- "processing_fee_money": {
- "amount": 112,
- "currency": "DJF"
- }
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor8"
-}
-```
-
diff --git a/doc/models/list-sites-response.md b/doc/models/list-sites-response.md
deleted file mode 100644
index 4791b2e7..00000000
--- a/doc/models/list-sites-response.md
+++ /dev/null
@@ -1,49 +0,0 @@
-
-# List Sites Response
-
-Represents a `ListSites` response. The response can include either `sites` or `errors`.
-
-## Structure
-
-`ListSitesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `sites` | [`?(Site[])`](../../doc/models/site.md) | Optional | The sites that belong to the seller. | getSites(): ?array | setSites(?array sites): void |
-
-## Example (as JSON)
-
-```json
-{
- "sites": [
- {
- "created_at": "2020-10-28T13:22:51.000000Z",
- "domain": "mysite2.square.site",
- "id": "site_278075276488921835",
- "is_published": false,
- "site_title": "My Second Site",
- "updated_at": "2020-10-28T13:22:51.000000Z"
- },
- {
- "created_at": "2020-06-18T17:45:13.000000Z",
- "domain": "mysite1.square.site",
- "id": "site_102725345836253849",
- "is_published": true,
- "site_title": "My First Site",
- "updated_at": "2020-11-23T02:19:10.000000Z"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-subscription-events-request.md b/doc/models/list-subscription-events-request.md
deleted file mode 100644
index 9e5f213e..00000000
--- a/doc/models/list-subscription-events-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# List Subscription Events Request
-
-Defines input parameters in a request to the
-[ListSubscriptionEvents](../../doc/apis/subscriptions.md#list-subscription-events)
-endpoint.
-
-## Structure
-
-`ListSubscriptionEventsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | When the total number of resulting subscription events exceeds the limit of a paged response,
specify the cursor returned from a preceding response here to fetch the next set of results.
If the cursor is unset, the response contains the last page of the results.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | The upper limit on the number of subscription events to return
in a paged response.
**Constraints**: `>= 1` | getLimit(): ?int | setLimit(?int limit): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "cursor8",
- "limit": 182
-}
-```
-
diff --git a/doc/models/list-subscription-events-response.md b/doc/models/list-subscription-events-response.md
deleted file mode 100644
index a569522c..00000000
--- a/doc/models/list-subscription-events-response.md
+++ /dev/null
@@ -1,169 +0,0 @@
-
-# List Subscription Events Response
-
-Defines output parameters in a response from the
-[ListSubscriptionEvents](../../doc/apis/subscriptions.md#list-subscription-events).
-
-## Structure
-
-`ListSubscriptionEventsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `subscriptionEvents` | [`?(SubscriptionEvent[])`](../../doc/models/subscription-event.md) | Optional | The retrieved subscription events. | getSubscriptionEvents(): ?array | setSubscriptionEvents(?array subscriptionEvents): void |
-| `cursor` | `?string` | Optional | When the total number of resulting subscription events exceeds the limit of a paged response,
the response includes a cursor for you to use in a subsequent request to fetch the next set of events.
If the cursor is unset, the response contains the last page of the results.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "subscription_events": [
- {
- "effective_date": "2020-04-24",
- "id": "06809161-3867-4598-8269-8aea5be4f9de",
- "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
- "subscription_event_type": "START_SUBSCRIPTION",
- "monthly_billing_anchor_date": 16,
- "info": {
- "detail": "detail6",
- "code": "CUSTOMER_DELETED"
- },
- "phases": [
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- }
- ]
- },
- {
- "effective_date": "2020-05-01",
- "id": "f2736603-cd2e-47ec-8675-f815fff54f88",
- "info": {
- "code": "CUSTOMER_NO_NAME",
- "detail": "The customer with ID `V74BMG0GPS2KNCWJE1BTYJ37Y0` does not have a name on record."
- },
- "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
- "subscription_event_type": "DEACTIVATE_SUBSCRIPTION",
- "monthly_billing_anchor_date": 16,
- "phases": [
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- }
- ]
- },
- {
- "effective_date": "2022-05-01",
- "id": "b426fc85-6859-450b-b0d0-fe3a5d1b565f",
- "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
- "subscription_event_type": "RESUME_SUBSCRIPTION",
- "monthly_billing_anchor_date": 16,
- "info": {
- "detail": "detail6",
- "code": "CUSTOMER_DELETED"
- },
- "phases": [
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- }
- ]
- },
- {
- "effective_date": "2022-09-01",
- "id": "09f14de1-2f53-4dae-9091-49aa53f83d01",
- "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
- "subscription_event_type": "PAUSE_SUBSCRIPTION",
- "monthly_billing_anchor_date": 16,
- "info": {
- "detail": "detail6",
- "code": "CUSTOMER_DELETED"
- },
- "phases": [
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- }
- ]
- },
- {
- "effective_date": "2022-12-01",
- "id": "f28a73ac-1a1b-4b0f-8eeb-709a72945776",
- "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
- "subscription_event_type": "RESUME_SUBSCRIPTION",
- "monthly_billing_anchor_date": 16,
- "info": {
- "detail": "detail6",
- "code": "CUSTOMER_DELETED"
- },
- "phases": [
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- }
- ]
- },
- {
- "effective_date": "2023-04-01",
- "id": "1eee8790-472d-4efe-8c69-8ad84e9cefe0",
- "plan_variation_id": "02CD53CFA4d1498AFAD42",
- "subscription_event_type": "PLAN_CHANGE",
- "monthly_billing_anchor_date": 16,
- "info": {
- "detail": "detail6",
- "code": "CUSTOMER_DELETED"
- },
- "phases": [
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- }
- ]
- },
- {
- "effective_date": "2023-06-21",
- "id": "a0c08083-5db0-4800-85c7-d398de4fbb6e",
- "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
- "subscription_event_type": "STOP_SUBSCRIPTION",
- "monthly_billing_anchor_date": 16,
- "info": {
- "detail": "detail6",
- "code": "CUSTOMER_DELETED"
- },
- "phases": [
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- }
- ]
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor4"
-}
-```
-
diff --git a/doc/models/list-team-member-booking-profiles-request.md b/doc/models/list-team-member-booking-profiles-request.md
deleted file mode 100644
index bcfc58ef..00000000
--- a/doc/models/list-team-member-booking-profiles-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# List Team Member Booking Profiles Request
-
-## Structure
-
-`ListTeamMemberBookingProfilesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `bookableOnly` | `?bool` | Optional | Indicates whether to include only bookable team members in the returned result (`true`) or not (`false`). | getBookableOnly(): ?bool | setBookableOnly(?bool bookableOnly): void |
-| `limit` | `?int` | Optional | The maximum number of results to return in a paged response.
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | The pagination cursor from the preceding response to return the next page of the results. Do not set this when retrieving the first page of the results.
**Constraints**: *Maximum Length*: `65536` | getCursor(): ?string | setCursor(?string cursor): void |
-| `locationId` | `?string` | Optional | Indicates whether to include only team members enabled at the given location in the returned result.
**Constraints**: *Maximum Length*: `32` | getLocationId(): ?string | setLocationId(?string locationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "bookable_only": false,
- "limit": 112,
- "cursor": "cursor2",
- "location_id": "location_id8"
-}
-```
-
diff --git a/doc/models/list-team-member-booking-profiles-response.md b/doc/models/list-team-member-booking-profiles-response.md
deleted file mode 100644
index 56690f5e..00000000
--- a/doc/models/list-team-member-booking-profiles-response.md
+++ /dev/null
@@ -1,40 +0,0 @@
-
-# List Team Member Booking Profiles Response
-
-## Structure
-
-`ListTeamMemberBookingProfilesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `teamMemberBookingProfiles` | [`?(TeamMemberBookingProfile[])`](../../doc/models/team-member-booking-profile.md) | Optional | The list of team member booking profiles. The results are returned in the ascending order of the time
when the team member booking profiles were last updated. Multiple booking profiles updated at the same time
are further sorted in the ascending order of their IDs. | getTeamMemberBookingProfiles(): ?array | setTeamMemberBookingProfiles(?array teamMemberBookingProfiles): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in the subsequent request to get the next page of the results. Stop retrieving the next page of the results when the cursor is not set.
**Constraints**: *Maximum Length*: `65536` | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [],
- "team_member_booking_profiles": [
- {
- "display_name": "Sandbox Seller",
- "is_bookable": true,
- "team_member_id": "TMXUrsBWWcHTt79t",
- "description": "description4",
- "profile_image_url": "profile_image_url2"
- },
- {
- "display_name": "Sandbox Staff",
- "is_bookable": true,
- "team_member_id": "TMaJcbiRqPIGZuS9",
- "description": "description4",
- "profile_image_url": "profile_image_url2"
- }
- ],
- "cursor": "cursor0"
-}
-```
-
diff --git a/doc/models/list-team-member-wages-request.md b/doc/models/list-team-member-wages-request.md
deleted file mode 100644
index 263f1242..00000000
--- a/doc/models/list-team-member-wages-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# List Team Member Wages Request
-
-A request for a set of `TeamMemberWage` objects.
-
-## Structure
-
-`ListTeamMemberWagesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `teamMemberId` | `?string` | Optional | Filter the returned wages to only those that are associated with the
specified team member. | getTeamMemberId(): ?string | setTeamMemberId(?string teamMemberId): void |
-| `limit` | `?int` | Optional | The maximum number of `TeamMemberWage` results to return per page. The number can range between
1 and 200. The default is 200.
**Constraints**: `>= 1`, `<= 200` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | A pointer to the next page of `EmployeeWage` results to fetch. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "team_member_id": "team_member_id2",
- "limit": 210,
- "cursor": "cursor8"
-}
-```
-
diff --git a/doc/models/list-team-member-wages-response.md b/doc/models/list-team-member-wages-response.md
deleted file mode 100644
index ea1ec500..00000000
--- a/doc/models/list-team-member-wages-response.md
+++ /dev/null
@@ -1,86 +0,0 @@
-
-# List Team Member Wages Response
-
-The response to a request for a set of `TeamMemberWage` objects. The response contains
-a set of `TeamMemberWage` objects.
-
-## Structure
-
-`ListTeamMemberWagesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `teamMemberWages` | [`?(TeamMemberWage[])`](../../doc/models/team-member-wage.md) | Optional | A page of `TeamMemberWage` results. | getTeamMemberWages(): ?array | setTeamMemberWages(?array teamMemberWages): void |
-| `cursor` | `?string` | Optional | The value supplied in the subsequent request to fetch the next page
of `TeamMemberWage` results. | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED",
- "team_member_wages": [
- {
- "hourly_rate": {
- "amount": 3250,
- "currency": "USD"
- },
- "id": "pXS3qCv7BERPnEGedM4S8mhm",
- "job_id": "jxJNN6eCJsLrhg5UFJrDWDGE",
- "team_member_id": "33fJchumvVdJwxV0H6L9",
- "tip_eligible": false,
- "title": "Manager"
- },
- {
- "hourly_rate": {
- "amount": 2600,
- "currency": "USD"
- },
- "id": "rZduCkzYDUVL3ovh1sQgbue6",
- "job_id": "gcbz15vKGnMKmaWJJ152kjim",
- "team_member_id": "33fJchumvVdJwxV0H6L9",
- "tip_eligible": true,
- "title": "Cook"
- },
- {
- "hourly_rate": {
- "amount": 1600,
- "currency": "USD"
- },
- "id": "FxLbs5KpPUHa8wyt5ctjubDX",
- "job_id": "FzbJAtt9qEWncK1BWgVCxQ6M",
- "team_member_id": "33fJchumvVdJwxV0H6L9",
- "tip_eligible": true,
- "title": "Barista"
- },
- {
- "hourly_rate": {
- "amount": 1700,
- "currency": "USD"
- },
- "id": "vD1wCgijMDR3cX5TPnu7VXto",
- "job_id": "N4YKVLzFj3oGtNocqoYHYpW3",
- "team_member_id": "33fJchumvVdJwxV0H6L9",
- "tip_eligible": true,
- "title": "Cashier"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-transactions-request.md b/doc/models/list-transactions-request.md
deleted file mode 100644
index 9c70901a..00000000
--- a/doc/models/list-transactions-request.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# List Transactions Request
-
-Defines the query parameters that can be included in
-a request to the [ListTransactions](api-endpoint:Transactions-ListTransactions) endpoint.
-
-Deprecated - recommend using [SearchOrders](api-endpoint:Orders-SearchOrders)
-
-## Structure
-
-`ListTransactionsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `beginTime` | `?string` | Optional | The beginning of the requested reporting period, in RFC 3339 format.
See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.
Default value: The current time minus one year. | getBeginTime(): ?string | setBeginTime(?string beginTime): void |
-| `endTime` | `?string` | Optional | The end of the requested reporting period, in RFC 3339 format.
See [Date ranges](https://developer.squareup.com/docs/build-basics/working-with-dates) for details on date inclusivity/exclusivity.
Default value: The current time. | getEndTime(): ?string | setEndTime(?string endTime): void |
-| `sortOrder` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this to retrieve the next set of results for your original query.
See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "begin_time": "begin_time6",
- "end_time": "end_time0",
- "sort_order": "DESC",
- "cursor": "cursor8"
-}
-```
-
diff --git a/doc/models/list-transactions-response.md b/doc/models/list-transactions-response.md
deleted file mode 100644
index c8986e18..00000000
--- a/doc/models/list-transactions-response.md
+++ /dev/null
@@ -1,111 +0,0 @@
-
-# List Transactions Response
-
-Defines the fields that are included in the response body of
-a request to the [ListTransactions](api-endpoint:Transactions-ListTransactions) endpoint.
-
-One of `errors` or `transactions` is present in a given response (never both).
-
-## Structure
-
-`ListTransactionsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `transactions` | [`?(Transaction[])`](../../doc/models/transaction.md) | Optional | An array of transactions that match your query. | getTransactions(): ?array | setTransactions(?array transactions): void |
-| `cursor` | `?string` | Optional | A pagination cursor for retrieving the next set of results,
if any remain. Provide this value as the `cursor` parameter in a subsequent
request to this endpoint.
See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "transactions": [
- {
- "created_at": "2016-01-20T22:57:56Z",
- "id": "KnL67ZIwXCPtzOrqj0HrkxMF",
- "location_id": "18YC4JDH91E1H",
- "product": "EXTERNAL_API",
- "reference_id": "some optional reference id",
- "refunds": [
- {
- "additional_recipients": [
- {
- "amount_money": {
- "amount": 100,
- "currency": "USD"
- },
- "description": "Application fees",
- "location_id": "057P5VYJ4A5X1",
- "receivable_id": "receivable_id6"
- }
- ],
- "amount_money": {
- "amount": 5000,
- "currency": "USD"
- },
- "created_at": "2016-01-20T22:59:20Z",
- "id": "7a5RcVI0CxbOcJ2wMOkE",
- "location_id": "18YC4JDH91E1H",
- "processing_fee_money": {
- "amount": 138,
- "currency": "USD"
- },
- "reason": "some reason why",
- "status": "APPROVED",
- "tender_id": "MtZRYYdDrYNQbOvV7nbuBvMF",
- "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF"
- }
- ],
- "tenders": [
- {
- "additional_recipients": [
- {
- "amount_money": {
- "amount": 20,
- "currency": "USD"
- },
- "description": "Application fees",
- "location_id": "057P5VYJ4A5X1"
- }
- ],
- "amount_money": {
- "amount": 5000,
- "currency": "USD"
- },
- "card_details": {
- "card": {
- "card_brand": "VISA",
- "last_4": "1111"
- },
- "entry_method": "KEYED",
- "status": "CAPTURED"
- },
- "created_at": "2016-01-20T22:57:56Z",
- "id": "MtZRYYdDrYNQbOvV7nbuBvMF",
- "location_id": "18YC4JDH91E1H",
- "note": "some optional note",
- "processing_fee_money": {
- "amount": 138,
- "currency": "USD"
- },
- "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF",
- "type": "CARD"
- }
- ]
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor8"
-}
-```
-
diff --git a/doc/models/list-webhook-event-types-request.md b/doc/models/list-webhook-event-types-request.md
deleted file mode 100644
index 6b747cad..00000000
--- a/doc/models/list-webhook-event-types-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# List Webhook Event Types Request
-
-Lists all webhook event types that can be subscribed to.
-
-## Structure
-
-`ListWebhookEventTypesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `apiVersion` | `?string` | Optional | The API version for which to list event types. Setting this field overrides the default version used by the application. | getApiVersion(): ?string | setApiVersion(?string apiVersion): void |
-
-## Example (as JSON)
-
-```json
-{
- "api_version": "api_version0"
-}
-```
-
diff --git a/doc/models/list-webhook-event-types-response.md b/doc/models/list-webhook-event-types-response.md
deleted file mode 100644
index 90f6953f..00000000
--- a/doc/models/list-webhook-event-types-response.md
+++ /dev/null
@@ -1,46 +0,0 @@
-
-# List Webhook Event Types Response
-
-Defines the fields that are included in the response body of
-a request to the [ListWebhookEventTypes](../../doc/apis/webhook-subscriptions.md#list-webhook-event-types) endpoint.
-
-Note: if there are errors processing the request, the event types field will not be
-present.
-
-## Structure
-
-`ListWebhookEventTypesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `eventTypes` | `?(string[])` | Optional | The list of event types. | getEventTypes(): ?array | setEventTypes(?array eventTypes): void |
-| `metadata` | [`?(EventTypeMetadata[])`](../../doc/models/event-type-metadata.md) | Optional | Contains the metadata of a webhook event type. For more information, see [EventTypeMetadata](entity:EventTypeMetadata). | getMetadata(): ?array | setMetadata(?array metadata): void |
-
-## Example (as JSON)
-
-```json
-{
- "event_types": [
- "inventory.count.updated"
- ],
- "metadata": [
- {
- "api_version_introduced": "2018-07-12",
- "event_type": "inventory.count.updated",
- "release_status": "PUBLIC"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/list-webhook-subscriptions-request.md b/doc/models/list-webhook-subscriptions-request.md
deleted file mode 100644
index 485769d1..00000000
--- a/doc/models/list-webhook-subscriptions-request.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# List Webhook Subscriptions Request
-
-Lists all [Subscription](../../doc/models/webhook-subscription.md)s owned by your application.
-
-## Structure
-
-`ListWebhookSubscriptionsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this to retrieve the next set of results for your original query.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: *Maximum Length*: `256` | getCursor(): ?string | setCursor(?string cursor): void |
-| `includeDisabled` | `?bool` | Optional | Includes disabled [Subscription](entity:WebhookSubscription)s.
By default, all enabled [Subscription](entity:WebhookSubscription)s are returned. | getIncludeDisabled(): ?bool | setIncludeDisabled(?bool includeDisabled): void |
-| `sortOrder` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-| `limit` | `?int` | Optional | The maximum number of results to be returned in a single page.
It is possible to receive fewer results than the specified limit on a given page.
The default value of 100 is also the maximum allowed value.
Default: 100
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "cursor2",
- "include_disabled": false,
- "sort_order": "DESC",
- "limit": 190
-}
-```
-
diff --git a/doc/models/list-webhook-subscriptions-response.md b/doc/models/list-webhook-subscriptions-response.md
deleted file mode 100644
index cd48f513..00000000
--- a/doc/models/list-webhook-subscriptions-response.md
+++ /dev/null
@@ -1,52 +0,0 @@
-
-# List Webhook Subscriptions Response
-
-Defines the fields that are included in the response body of
-a request to the [ListWebhookSubscriptions](../../doc/apis/webhook-subscriptions.md#list-webhook-subscriptions) endpoint.
-
-Note: if there are errors processing the request, the subscriptions field will not be
-present.
-
-## Structure
-
-`ListWebhookSubscriptionsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `subscriptions` | [`?(WebhookSubscription[])`](../../doc/models/webhook-subscription.md) | Optional | The requested list of [Subscription](entity:WebhookSubscription)s. | getSubscriptions(): ?array | setSubscriptions(?array subscriptions): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request. If empty,
this is the final response.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "subscriptions": [
- {
- "api_version": "2021-12-15",
- "created_at": "2022-01-10 23:29:48 +0000 UTC",
- "enabled": true,
- "event_types": [
- "payment.created",
- "payment.updated"
- ],
- "id": "wbhk_b35f6b3145074cf9ad513610786c19d5",
- "name": "Example Webhook Subscription",
- "notification_url": "https://example-webhook-url.com",
- "updated_at": "2022-01-10 23:29:48 +0000 UTC"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor6"
-}
-```
-
diff --git a/doc/models/list-workweek-configs-request.md b/doc/models/list-workweek-configs-request.md
deleted file mode 100644
index 9ba90c48..00000000
--- a/doc/models/list-workweek-configs-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# List Workweek Configs Request
-
-A request for a set of `WorkweekConfig` objects.
-
-## Structure
-
-`ListWorkweekConfigsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `limit` | `?int` | Optional | The maximum number of `WorkweekConfigs` results to return per page. | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | A pointer to the next page of `WorkweekConfig` results to fetch. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 98,
- "cursor": "cursor0"
-}
-```
-
diff --git a/doc/models/list-workweek-configs-response.md b/doc/models/list-workweek-configs-response.md
deleted file mode 100644
index f727acc8..00000000
--- a/doc/models/list-workweek-configs-response.md
+++ /dev/null
@@ -1,45 +0,0 @@
-
-# List Workweek Configs Response
-
-The response to a request for a set of `WorkweekConfig` objects. The response contains
-the requested `WorkweekConfig` objects and might contain a set of `Error` objects if
-the request resulted in errors.
-
-## Structure
-
-`ListWorkweekConfigsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `workweekConfigs` | [`?(WorkweekConfig[])`](../../doc/models/workweek-config.md) | Optional | A page of `WorkweekConfig` results. | getWorkweekConfigs(): ?array | setWorkweekConfigs(?array workweekConfigs): void |
-| `cursor` | `?string` | Optional | The value supplied in the subsequent request to fetch the next page of
`WorkweekConfig` results. | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "2fofTniCgT0yIPAq26kmk0YyFQJZfbWkh73OOnlTHmTAx13NgED",
- "workweek_configs": [
- {
- "created_at": "2016-02-04T00:58:24Z",
- "id": "FY4VCAQN700GM",
- "start_of_day_local_time": "10:00",
- "start_of_week": "MON",
- "updated_at": "2019-02-28T01:04:35Z",
- "version": 11
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/location-booking-profile.md b/doc/models/location-booking-profile.md
deleted file mode 100644
index cddbb9af..00000000
--- a/doc/models/location-booking-profile.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Location Booking Profile
-
-The booking profile of a seller's location, including the location's ID and whether the location is enabled for online booking.
-
-## Structure
-
-`LocationBookingProfile`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationId` | `?string` | Optional | The ID of the [location](entity:Location). | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `bookingSiteUrl` | `?string` | Optional | Url for the online booking site for this location. | getBookingSiteUrl(): ?string | setBookingSiteUrl(?string bookingSiteUrl): void |
-| `onlineBookingEnabled` | `?bool` | Optional | Indicates whether the location is enabled for online booking. | getOnlineBookingEnabled(): ?bool | setOnlineBookingEnabled(?bool onlineBookingEnabled): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_id": "location_id8",
- "booking_site_url": "booking_site_url4",
- "online_booking_enabled": false
-}
-```
-
diff --git a/doc/models/location-capability.md b/doc/models/location-capability.md
deleted file mode 100644
index bed5e30e..00000000
--- a/doc/models/location-capability.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Location Capability
-
-The capabilities a location might have.
-
-## Enumeration
-
-`LocationCapability`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `CREDIT_CARD_PROCESSING` | The capability to process credit card transactions with Square. |
-| `AUTOMATIC_TRANSFERS` | The capability to receive automatic transfers from Square. |
-| `UNLINKED_REFUNDS` | The capability to process unlinked refunds with Square. |
-
diff --git a/doc/models/location-status.md b/doc/models/location-status.md
deleted file mode 100644
index 3edf1db7..00000000
--- a/doc/models/location-status.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Location Status
-
-A location's status.
-
-## Enumeration
-
-`LocationStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ACTIVE` | A location that is active for business. |
-| `INACTIVE` | A location that is not active for business. Inactive locations provide historical
information. Hide inactive locations unless the user has requested to see them. |
-
diff --git a/doc/models/location-type.md b/doc/models/location-type.md
deleted file mode 100644
index 5aaf34af..00000000
--- a/doc/models/location-type.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Location Type
-
-A location's type.
-
-## Enumeration
-
-`LocationType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `PHYSICAL` | A place of business with a physical location. |
-| `MOBILE` | A place of business that is mobile, such as a food truck or online store. |
-
diff --git a/doc/models/location.md b/doc/models/location.md
deleted file mode 100644
index e640f193..00000000
--- a/doc/models/location.md
+++ /dev/null
@@ -1,61 +0,0 @@
-
-# Location
-
-Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api).
-
-## Structure
-
-`Location`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A short generated string of letters and numbers that uniquely identifies this location instance.
**Constraints**: *Maximum Length*: `32` | getId(): ?string | setId(?string id): void |
-| `name` | `?string` | Optional | The name of the location.
This information appears in the Seller Dashboard as the nickname.
A location name must be unique within a seller account.
**Constraints**: *Maximum Length*: `255` | getName(): ?string | setName(?string name): void |
-| `address` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getAddress(): ?Address | setAddress(?Address address): void |
-| `timezone` | `?string` | Optional | The [IANA time zone](https://www.iana.org/time-zones) identifier for
the time zone of the location. For example, `America/Los_Angeles`.
**Constraints**: *Maximum Length*: `30` | getTimezone(): ?string | setTimezone(?string timezone): void |
-| `capabilities` | [`?(string(LocationCapability)[])`](../../doc/models/location-capability.md) | Optional | The Square features that are enabled for the location.
See [LocationCapability](entity:LocationCapability) for possible values.
See [LocationCapability](#type-locationcapability) for possible values | getCapabilities(): ?array | setCapabilities(?array capabilities): void |
-| `status` | [`?string(LocationStatus)`](../../doc/models/location-status.md) | Optional | A location's status. | getStatus(): ?string | setStatus(?string status): void |
-| `createdAt` | `?string` | Optional | The time when the location was created, in RFC 3339 format.
For more information, see [Working with Dates](https://developer.squareup.com/docs/build-basics/working-with-dates).
**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `25` | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `merchantId` | `?string` | Optional | The ID of the merchant that owns the location.
**Constraints**: *Maximum Length*: `32` | getMerchantId(): ?string | setMerchantId(?string merchantId): void |
-| `country` | [`?string(Country)`](../../doc/models/country.md) | Optional | Indicates the country associated with another entity, such as a business.
Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm). | getCountry(): ?string | setCountry(?string country): void |
-| `languageCode` | `?string` | Optional | The language associated with the location, in
[BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A).
For more information, see [Language Preferences](https://developer.squareup.com/docs/build-basics/general-considerations/language-preferences).
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `5` | getLanguageCode(): ?string | setLanguageCode(?string languageCode): void |
-| `currency` | [`?string(Currency)`](../../doc/models/currency.md) | Optional | Indicates the associated currency for an amount of money. Values correspond
to [ISO 4217](https://wikipedia.org/wiki/ISO_4217). | getCurrency(): ?string | setCurrency(?string currency): void |
-| `phoneNumber` | `?string` | Optional | The phone number of the location. For example, `+1 855-700-6000`.
**Constraints**: *Maximum Length*: `17` | getPhoneNumber(): ?string | setPhoneNumber(?string phoneNumber): void |
-| `businessName` | `?string` | Optional | The name of the location's overall business. This name is present on receipts and other customer-facing branding, and can be changed no more than three times in a twelve-month period.
**Constraints**: *Maximum Length*: `255` | getBusinessName(): ?string | setBusinessName(?string businessName): void |
-| `type` | [`?string(LocationType)`](../../doc/models/location-type.md) | Optional | A location's type. | getType(): ?string | setType(?string type): void |
-| `websiteUrl` | `?string` | Optional | The website URL of the location. For example, `https://squareup.com`.
**Constraints**: *Maximum Length*: `255` | getWebsiteUrl(): ?string | setWebsiteUrl(?string websiteUrl): void |
-| `businessHours` | [`?BusinessHours`](../../doc/models/business-hours.md) | Optional | The hours of operation for a location. | getBusinessHours(): ?BusinessHours | setBusinessHours(?BusinessHours businessHours): void |
-| `businessEmail` | `?string` | Optional | The email address of the location. This can be unique to the location and is not always the email address for the business owner or administrator.
**Constraints**: *Maximum Length*: `255` | getBusinessEmail(): ?string | setBusinessEmail(?string businessEmail): void |
-| `description` | `?string` | Optional | The description of the location. For example, `Main Street location`.
**Constraints**: *Maximum Length*: `1024` | getDescription(): ?string | setDescription(?string description): void |
-| `twitterUsername` | `?string` | Optional | The Twitter username of the location without the '@' symbol. For example, `Square`.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `15` | getTwitterUsername(): ?string | setTwitterUsername(?string twitterUsername): void |
-| `instagramUsername` | `?string` | Optional | The Instagram username of the location without the '@' symbol. For example, `square`.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `30` | getInstagramUsername(): ?string | setInstagramUsername(?string instagramUsername): void |
-| `facebookUrl` | `?string` | Optional | The Facebook profile URL of the location. The URL should begin with 'facebook.com/'. For example, `https://www.facebook.com/square`.
**Constraints**: *Maximum Length*: `255` | getFacebookUrl(): ?string | setFacebookUrl(?string facebookUrl): void |
-| `coordinates` | [`?Coordinates`](../../doc/models/coordinates.md) | Optional | Latitude and longitude coordinates. | getCoordinates(): ?Coordinates | setCoordinates(?Coordinates coordinates): void |
-| `logoUrl` | `?string` | Optional | The URL of the logo image for the location. When configured in the Seller
Dashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller.
This image should have a roughly square (1:1) aspect ratio and should be at least 200x200 pixels.
**Constraints**: *Maximum Length*: `255` | getLogoUrl(): ?string | setLogoUrl(?string logoUrl): void |
-| `posBackgroundUrl` | `?string` | Optional | The URL of the Point of Sale background image for the location.
**Constraints**: *Maximum Length*: `255` | getPosBackgroundUrl(): ?string | setPosBackgroundUrl(?string posBackgroundUrl): void |
-| `mcc` | `?string` | Optional | A four-digit number that describes the kind of goods or services sold at the location.
The [merchant category code (MCC)](https://developer.squareup.com/docs/locations-api#initialize-a-merchant-category-code) of the location as standardized by ISO 18245.
For example, `5045`, for a location that sells computer goods and software.
**Constraints**: *Minimum Length*: `4`, *Maximum Length*: `4` | getMcc(): ?string | setMcc(?string mcc): void |
-| `fullFormatLogoUrl` | `?string` | Optional | The URL of a full-format logo image for the location. When configured in the Seller
Dashboard (Receipts section), the logo appears on transactions (such as receipts and invoices) that Square generates on behalf of the seller.
This image can be wider than it is tall and should be at least 1280x648 pixels. | getFullFormatLogoUrl(): ?string | setFullFormatLogoUrl(?string fullFormatLogoUrl): void |
-| `taxIds` | [`?TaxIds`](../../doc/models/tax-ids.md) | Optional | Identifiers for the location used by various governments for tax purposes. | getTaxIds(): ?TaxIds | setTaxIds(?TaxIds taxIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id4",
- "name": "name4",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- },
- "timezone": "timezone4",
- "capabilities": [
- "CREDIT_CARD_PROCESSING"
- ]
-}
-```
-
diff --git a/doc/models/loyalty-account-expiring-point-deadline.md b/doc/models/loyalty-account-expiring-point-deadline.md
deleted file mode 100644
index 4c686246..00000000
--- a/doc/models/loyalty-account-expiring-point-deadline.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Loyalty Account Expiring Point Deadline
-
-Represents a set of points for a loyalty account that are scheduled to expire on a specific date.
-
-## Structure
-
-`LoyaltyAccountExpiringPointDeadline`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `points` | `int` | Required | The number of points scheduled to expire at the `expires_at` timestamp. | getPoints(): int | setPoints(int points): void |
-| `expiresAt` | `string` | Required | The timestamp of when the points are scheduled to expire, in RFC 3339 format.
**Constraints**: *Minimum Length*: `1` | getExpiresAt(): string | setExpiresAt(string expiresAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "points": 104,
- "expires_at": "expires_at6"
-}
-```
-
diff --git a/doc/models/loyalty-account-mapping-type.md b/doc/models/loyalty-account-mapping-type.md
deleted file mode 100644
index 1367bd91..00000000
--- a/doc/models/loyalty-account-mapping-type.md
+++ /dev/null
@@ -1,15 +0,0 @@
-
-# Loyalty Account Mapping Type
-
-The type of mapping.
-
-## Enumeration
-
-`LoyaltyAccountMappingType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `PHONE` | The loyalty account is mapped by phone. |
-
diff --git a/doc/models/loyalty-account-mapping.md b/doc/models/loyalty-account-mapping.md
deleted file mode 100644
index 9eb5c9c1..00000000
--- a/doc/models/loyalty-account-mapping.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Loyalty Account Mapping
-
-Represents the mapping that associates a loyalty account with a buyer.
-
-Currently, a loyalty account can only be mapped to a buyer by phone number. For more information, see
-[Loyalty Overview](https://developer.squareup.com/docs/loyalty/overview).
-
-## Structure
-
-`LoyaltyAccountMapping`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The Square-assigned ID of the mapping.
**Constraints**: *Maximum Length*: `36` | getId(): ?string | setId(?string id): void |
-| `createdAt` | `?string` | Optional | The timestamp when the mapping was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `phoneNumber` | `?string` | Optional | The phone number of the buyer, in E.164 format. For example, "+14155551111". | getPhoneNumber(): ?string | setPhoneNumber(?string phoneNumber): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id2",
- "created_at": "created_at0",
- "phone_number": "phone_number0"
-}
-```
-
diff --git a/doc/models/loyalty-account.md b/doc/models/loyalty-account.md
deleted file mode 100644
index 6e627071..00000000
--- a/doc/models/loyalty-account.md
+++ /dev/null
@@ -1,38 +0,0 @@
-
-# Loyalty Account
-
-Describes a loyalty account in a [loyalty program](../../doc/models/loyalty-program.md). For more information, see
-[Create and Retrieve Loyalty Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts).
-
-## Structure
-
-`LoyaltyAccount`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The Square-assigned ID of the loyalty account.
**Constraints**: *Maximum Length*: `36` | getId(): ?string | setId(?string id): void |
-| `programId` | `string` | Required | The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram) to which the account belongs.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | getProgramId(): string | setProgramId(string programId): void |
-| `balance` | `?int` | Optional | The available point balance in the loyalty account. If points are scheduled to expire, they are listed in the `expiring_point_deadlines` field.
Your application should be able to handle loyalty accounts that have a negative point balance (`balance` is less than 0). This might occur if a seller makes a manual adjustment or as a result of a refund or exchange. | getBalance(): ?int | setBalance(?int balance): void |
-| `lifetimePoints` | `?int` | Optional | The total points accrued during the lifetime of the account. | getLifetimePoints(): ?int | setLifetimePoints(?int lifetimePoints): void |
-| `customerId` | `?string` | Optional | The Square-assigned ID of the [customer](entity:Customer) that is associated with the account. | getCustomerId(): ?string | setCustomerId(?string customerId): void |
-| `enrolledAt` | `?string` | Optional | The timestamp when the buyer joined the loyalty program, in RFC 3339 format. This field is used to display the **Enrolled On** or **Member Since** date in first-party Square products.
If this field is not set in a `CreateLoyaltyAccount` request, Square populates it after the buyer's first action on their account
(when `AccumulateLoyaltyPoints` or `CreateLoyaltyReward` is called). In first-party flows, Square populates the field when the buyer agrees to the terms of service in Square Point of Sale.
This field is typically specified in a `CreateLoyaltyAccount` request when creating a loyalty account for a buyer who already interacted with their account.
For example, you would set this field when migrating accounts from an external system. The timestamp in the request can represent a current or previous date and time, but it cannot be set for the future. | getEnrolledAt(): ?string | setEnrolledAt(?string enrolledAt): void |
-| `createdAt` | `?string` | Optional | The timestamp when the loyalty account was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp when the loyalty account was last updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `mapping` | [`?LoyaltyAccountMapping`](../../doc/models/loyalty-account-mapping.md) | Optional | Represents the mapping that associates a loyalty account with a buyer.
Currently, a loyalty account can only be mapped to a buyer by phone number. For more information, see
[Loyalty Overview](https://developer.squareup.com/docs/loyalty/overview). | getMapping(): ?LoyaltyAccountMapping | setMapping(?LoyaltyAccountMapping mapping): void |
-| `expiringPointDeadlines` | [`?(LoyaltyAccountExpiringPointDeadline[])`](../../doc/models/loyalty-account-expiring-point-deadline.md) | Optional | The schedule for when points expire in the loyalty account balance. This field is present only if the account has points that are scheduled to expire.
The total number of points in this field equals the number of points in the `balance` field. | getExpiringPointDeadlines(): ?array | setExpiringPointDeadlines(?array expiringPointDeadlines): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id4",
- "program_id": "program_id6",
- "balance": 52,
- "lifetime_points": 76,
- "customer_id": "customer_id2",
- "enrolled_at": "enrolled_at4"
-}
-```
-
diff --git a/doc/models/loyalty-event-accumulate-points.md b/doc/models/loyalty-event-accumulate-points.md
deleted file mode 100644
index d2f03ac0..00000000
--- a/doc/models/loyalty-event-accumulate-points.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Loyalty Event Accumulate Points
-
-Provides metadata when the event `type` is `ACCUMULATE_POINTS`.
-
-## Structure
-
-`LoyaltyEventAccumulatePoints`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `loyaltyProgramId` | `?string` | Optional | The ID of the [loyalty program](entity:LoyaltyProgram).
**Constraints**: *Maximum Length*: `36` | getLoyaltyProgramId(): ?string | setLoyaltyProgramId(?string loyaltyProgramId): void |
-| `points` | `?int` | Optional | The number of points accumulated by the event.
**Constraints**: `>= 1` | getPoints(): ?int | setPoints(?int points): void |
-| `orderId` | `?string` | Optional | The ID of the [order](entity:Order) for which the buyer accumulated the points.
This field is returned only if the Orders API is used to process orders. | getOrderId(): ?string | setOrderId(?string orderId): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_program_id": "loyalty_program_id0",
- "points": 104,
- "order_id": "order_id4"
-}
-```
-
diff --git a/doc/models/loyalty-event-accumulate-promotion-points.md b/doc/models/loyalty-event-accumulate-promotion-points.md
deleted file mode 100644
index 7a91034c..00000000
--- a/doc/models/loyalty-event-accumulate-promotion-points.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Loyalty Event Accumulate Promotion Points
-
-Provides metadata when the event `type` is `ACCUMULATE_PROMOTION_POINTS`.
-
-## Structure
-
-`LoyaltyEventAccumulatePromotionPoints`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `loyaltyProgramId` | `?string` | Optional | The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).
**Constraints**: *Maximum Length*: `36` | getLoyaltyProgramId(): ?string | setLoyaltyProgramId(?string loyaltyProgramId): void |
-| `loyaltyPromotionId` | `?string` | Optional | The Square-assigned ID of the [loyalty promotion](entity:LoyaltyPromotion).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getLoyaltyPromotionId(): ?string | setLoyaltyPromotionId(?string loyaltyPromotionId): void |
-| `points` | `int` | Required | The number of points earned by the event. | getPoints(): int | setPoints(int points): void |
-| `orderId` | `string` | Required | The ID of the [order](entity:Order) for which the buyer earned the promotion points.
Only applications that use the Orders API to process orders can trigger this event.
**Constraints**: *Minimum Length*: `1` | getOrderId(): string | setOrderId(string orderId): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_program_id": "loyalty_program_id0",
- "loyalty_promotion_id": "loyalty_promotion_id8",
- "points": 98,
- "order_id": "order_id4"
-}
-```
-
diff --git a/doc/models/loyalty-event-adjust-points.md b/doc/models/loyalty-event-adjust-points.md
deleted file mode 100644
index 863081e0..00000000
--- a/doc/models/loyalty-event-adjust-points.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Loyalty Event Adjust Points
-
-Provides metadata when the event `type` is `ADJUST_POINTS`.
-
-## Structure
-
-`LoyaltyEventAdjustPoints`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `loyaltyProgramId` | `?string` | Optional | The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).
**Constraints**: *Maximum Length*: `36` | getLoyaltyProgramId(): ?string | setLoyaltyProgramId(?string loyaltyProgramId): void |
-| `points` | `int` | Required | The number of points added or removed. | getPoints(): int | setPoints(int points): void |
-| `reason` | `?string` | Optional | The reason for the adjustment of points. | getReason(): ?string | setReason(?string reason): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_program_id": "loyalty_program_id4",
- "points": 98,
- "reason": "reason0"
-}
-```
-
diff --git a/doc/models/loyalty-event-create-reward.md b/doc/models/loyalty-event-create-reward.md
deleted file mode 100644
index 7c0817e9..00000000
--- a/doc/models/loyalty-event-create-reward.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Loyalty Event Create Reward
-
-Provides metadata when the event `type` is `CREATE_REWARD`.
-
-## Structure
-
-`LoyaltyEventCreateReward`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `loyaltyProgramId` | `string` | Required | The ID of the [loyalty program](entity:LoyaltyProgram).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | getLoyaltyProgramId(): string | setLoyaltyProgramId(string loyaltyProgramId): void |
-| `rewardId` | `?string` | Optional | The Square-assigned ID of the created [loyalty reward](entity:LoyaltyReward).
This field is returned only if the event source is `LOYALTY_API`.
**Constraints**: *Maximum Length*: `36` | getRewardId(): ?string | setRewardId(?string rewardId): void |
-| `points` | `int` | Required | The loyalty points used to create the reward. | getPoints(): int | setPoints(int points): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_program_id": "loyalty_program_id4",
- "reward_id": "reward_id8",
- "points": 198
-}
-```
-
diff --git a/doc/models/loyalty-event-date-time-filter.md b/doc/models/loyalty-event-date-time-filter.md
deleted file mode 100644
index 97e80e5e..00000000
--- a/doc/models/loyalty-event-date-time-filter.md
+++ /dev/null
@@ -1,26 +0,0 @@
-
-# Loyalty Event Date Time Filter
-
-Filter events by date time range.
-
-## Structure
-
-`LoyaltyEventDateTimeFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `createdAt` | [`TimeRange`](../../doc/models/time-range.md) | Required | Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled. | getCreatedAt(): TimeRange | setCreatedAt(TimeRange createdAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- }
-}
-```
-
diff --git a/doc/models/loyalty-event-delete-reward.md b/doc/models/loyalty-event-delete-reward.md
deleted file mode 100644
index 110a5cd2..00000000
--- a/doc/models/loyalty-event-delete-reward.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Loyalty Event Delete Reward
-
-Provides metadata when the event `type` is `DELETE_REWARD`.
-
-## Structure
-
-`LoyaltyEventDeleteReward`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `loyaltyProgramId` | `string` | Required | The ID of the [loyalty program](entity:LoyaltyProgram).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | getLoyaltyProgramId(): string | setLoyaltyProgramId(string loyaltyProgramId): void |
-| `rewardId` | `?string` | Optional | The ID of the deleted [loyalty reward](entity:LoyaltyReward).
This field is returned only if the event source is `LOYALTY_API`.
**Constraints**: *Maximum Length*: `36` | getRewardId(): ?string | setRewardId(?string rewardId): void |
-| `points` | `int` | Required | The number of points returned to the loyalty account. | getPoints(): int | setPoints(int points): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_program_id": "loyalty_program_id2",
- "reward_id": "reward_id6",
- "points": 84
-}
-```
-
diff --git a/doc/models/loyalty-event-expire-points.md b/doc/models/loyalty-event-expire-points.md
deleted file mode 100644
index 3967a7b8..00000000
--- a/doc/models/loyalty-event-expire-points.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Loyalty Event Expire Points
-
-Provides metadata when the event `type` is `EXPIRE_POINTS`.
-
-## Structure
-
-`LoyaltyEventExpirePoints`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `loyaltyProgramId` | `string` | Required | The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | getLoyaltyProgramId(): string | setLoyaltyProgramId(string loyaltyProgramId): void |
-| `points` | `int` | Required | The number of points expired. | getPoints(): int | setPoints(int points): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_program_id": "loyalty_program_id8",
- "points": 84
-}
-```
-
diff --git a/doc/models/loyalty-event-filter.md b/doc/models/loyalty-event-filter.md
deleted file mode 100644
index 569402ed..00000000
--- a/doc/models/loyalty-event-filter.md
+++ /dev/null
@@ -1,53 +0,0 @@
-
-# Loyalty Event Filter
-
-The filtering criteria. If the request specifies multiple filters,
-the endpoint uses a logical AND to evaluate them.
-
-## Structure
-
-`LoyaltyEventFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `loyaltyAccountFilter` | [`?LoyaltyEventLoyaltyAccountFilter`](../../doc/models/loyalty-event-loyalty-account-filter.md) | Optional | Filter events by loyalty account. | getLoyaltyAccountFilter(): ?LoyaltyEventLoyaltyAccountFilter | setLoyaltyAccountFilter(?LoyaltyEventLoyaltyAccountFilter loyaltyAccountFilter): void |
-| `typeFilter` | [`?LoyaltyEventTypeFilter`](../../doc/models/loyalty-event-type-filter.md) | Optional | Filter events by event type. | getTypeFilter(): ?LoyaltyEventTypeFilter | setTypeFilter(?LoyaltyEventTypeFilter typeFilter): void |
-| `dateTimeFilter` | [`?LoyaltyEventDateTimeFilter`](../../doc/models/loyalty-event-date-time-filter.md) | Optional | Filter events by date time range. | getDateTimeFilter(): ?LoyaltyEventDateTimeFilter | setDateTimeFilter(?LoyaltyEventDateTimeFilter dateTimeFilter): void |
-| `locationFilter` | [`?LoyaltyEventLocationFilter`](../../doc/models/loyalty-event-location-filter.md) | Optional | Filter events by location. | getLocationFilter(): ?LoyaltyEventLocationFilter | setLocationFilter(?LoyaltyEventLocationFilter locationFilter): void |
-| `orderFilter` | [`?LoyaltyEventOrderFilter`](../../doc/models/loyalty-event-order-filter.md) | Optional | Filter events by the order associated with the event. | getOrderFilter(): ?LoyaltyEventOrderFilter | setOrderFilter(?LoyaltyEventOrderFilter orderFilter): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_account_filter": {
- "loyalty_account_id": "loyalty_account_id8"
- },
- "type_filter": {
- "types": [
- "ACCUMULATE_PROMOTION_POINTS",
- "ACCUMULATE_POINTS",
- "CREATE_REWARD"
- ]
- },
- "date_time_filter": {
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- }
- },
- "location_filter": {
- "location_ids": [
- "location_ids0",
- "location_ids1",
- "location_ids2"
- ]
- },
- "order_filter": {
- "order_id": "order_id2"
- }
-}
-```
-
diff --git a/doc/models/loyalty-event-location-filter.md b/doc/models/loyalty-event-location-filter.md
deleted file mode 100644
index a7a343db..00000000
--- a/doc/models/loyalty-event-location-filter.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Loyalty Event Location Filter
-
-Filter events by location.
-
-## Structure
-
-`LoyaltyEventLocationFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationIds` | `string[]` | Required | The [location](entity:Location) IDs for loyalty events to query.
If multiple values are specified, the endpoint uses
a logical OR to combine them. | getLocationIds(): array | setLocationIds(array locationIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_ids": [
- "location_ids6",
- "location_ids7",
- "location_ids8"
- ]
-}
-```
-
diff --git a/doc/models/loyalty-event-loyalty-account-filter.md b/doc/models/loyalty-event-loyalty-account-filter.md
deleted file mode 100644
index ecba9010..00000000
--- a/doc/models/loyalty-event-loyalty-account-filter.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Loyalty Event Loyalty Account Filter
-
-Filter events by loyalty account.
-
-## Structure
-
-`LoyaltyEventLoyaltyAccountFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `loyaltyAccountId` | `string` | Required | The ID of the [loyalty account](entity:LoyaltyAccount) associated with loyalty events.
**Constraints**: *Minimum Length*: `1` | getLoyaltyAccountId(): string | setLoyaltyAccountId(string loyaltyAccountId): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_account_id": "loyalty_account_id2"
-}
-```
-
diff --git a/doc/models/loyalty-event-order-filter.md b/doc/models/loyalty-event-order-filter.md
deleted file mode 100644
index 05fd21b2..00000000
--- a/doc/models/loyalty-event-order-filter.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Loyalty Event Order Filter
-
-Filter events by the order associated with the event.
-
-## Structure
-
-`LoyaltyEventOrderFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `orderId` | `string` | Required | The ID of the [order](entity:Order) associated with the event.
**Constraints**: *Minimum Length*: `1` | getOrderId(): string | setOrderId(string orderId): void |
-
-## Example (as JSON)
-
-```json
-{
- "order_id": "order_id4"
-}
-```
-
diff --git a/doc/models/loyalty-event-other.md b/doc/models/loyalty-event-other.md
deleted file mode 100644
index 9950ea8a..00000000
--- a/doc/models/loyalty-event-other.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Loyalty Event Other
-
-Provides metadata when the event `type` is `OTHER`.
-
-## Structure
-
-`LoyaltyEventOther`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `loyaltyProgramId` | `string` | Required | The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | getLoyaltyProgramId(): string | setLoyaltyProgramId(string loyaltyProgramId): void |
-| `points` | `int` | Required | The number of points added or removed. | getPoints(): int | setPoints(int points): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_program_id": "loyalty_program_id4",
- "points": 94
-}
-```
-
diff --git a/doc/models/loyalty-event-query.md b/doc/models/loyalty-event-query.md
deleted file mode 100644
index 9a666ab6..00000000
--- a/doc/models/loyalty-event-query.md
+++ /dev/null
@@ -1,50 +0,0 @@
-
-# Loyalty Event Query
-
-Represents a query used to search for loyalty events.
-
-## Structure
-
-`LoyaltyEventQuery`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `filter` | [`?LoyaltyEventFilter`](../../doc/models/loyalty-event-filter.md) | Optional | The filtering criteria. If the request specifies multiple filters,
the endpoint uses a logical AND to evaluate them. | getFilter(): ?LoyaltyEventFilter | setFilter(?LoyaltyEventFilter filter): void |
-
-## Example (as JSON)
-
-```json
-{
- "filter": {
- "loyalty_account_filter": {
- "loyalty_account_id": "loyalty_account_id8"
- },
- "type_filter": {
- "types": [
- "ACCUMULATE_PROMOTION_POINTS",
- "ACCUMULATE_POINTS",
- "CREATE_REWARD"
- ]
- },
- "date_time_filter": {
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- }
- },
- "location_filter": {
- "location_ids": [
- "location_ids0",
- "location_ids1",
- "location_ids2"
- ]
- },
- "order_filter": {
- "order_id": "order_id2"
- }
- }
-}
-```
-
diff --git a/doc/models/loyalty-event-redeem-reward.md b/doc/models/loyalty-event-redeem-reward.md
deleted file mode 100644
index 0bc0c76c..00000000
--- a/doc/models/loyalty-event-redeem-reward.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Loyalty Event Redeem Reward
-
-Provides metadata when the event `type` is `REDEEM_REWARD`.
-
-## Structure
-
-`LoyaltyEventRedeemReward`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `loyaltyProgramId` | `string` | Required | The ID of the [loyalty program](entity:LoyaltyProgram).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | getLoyaltyProgramId(): string | setLoyaltyProgramId(string loyaltyProgramId): void |
-| `rewardId` | `?string` | Optional | The ID of the redeemed [loyalty reward](entity:LoyaltyReward).
This field is returned only if the event source is `LOYALTY_API`.
**Constraints**: *Maximum Length*: `36` | getRewardId(): ?string | setRewardId(?string rewardId): void |
-| `orderId` | `?string` | Optional | The ID of the [order](entity:Order) that redeemed the reward.
This field is returned only if the Orders API is used to process orders. | getOrderId(): ?string | setOrderId(?string orderId): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_program_id": "loyalty_program_id4",
- "reward_id": "reward_id8",
- "order_id": "order_id8"
-}
-```
-
diff --git a/doc/models/loyalty-event-source.md b/doc/models/loyalty-event-source.md
deleted file mode 100644
index 4cfa3d59..00000000
--- a/doc/models/loyalty-event-source.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Loyalty Event Source
-
-Defines whether the event was generated by the Square Point of Sale.
-
-## Enumeration
-
-`LoyaltyEventSource`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `SQUARE` | The event is generated by the Square Point of Sale (POS). |
-| `LOYALTY_API` | The event is generated by something other than the Square Point of Sale that used the Loyalty API. |
-
diff --git a/doc/models/loyalty-event-type-filter.md b/doc/models/loyalty-event-type-filter.md
deleted file mode 100644
index 45112310..00000000
--- a/doc/models/loyalty-event-type-filter.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Loyalty Event Type Filter
-
-Filter events by event type.
-
-## Structure
-
-`LoyaltyEventTypeFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `types` | [`string(LoyaltyEventType)[]`](../../doc/models/loyalty-event-type.md) | Required | The loyalty event types used to filter the result.
If multiple values are specified, the endpoint uses a
logical OR to combine them.
See [LoyaltyEventType](#type-loyaltyeventtype) for possible values | getTypes(): array | setTypes(array types): void |
-
-## Example (as JSON)
-
-```json
-{
- "types": [
- "EXPIRE_POINTS",
- "OTHER",
- "ACCUMULATE_PROMOTION_POINTS"
- ]
-}
-```
-
diff --git a/doc/models/loyalty-event-type.md b/doc/models/loyalty-event-type.md
deleted file mode 100644
index 71364f4f..00000000
--- a/doc/models/loyalty-event-type.md
+++ /dev/null
@@ -1,22 +0,0 @@
-
-# Loyalty Event Type
-
-The type of the loyalty event.
-
-## Enumeration
-
-`LoyaltyEventType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ACCUMULATE_POINTS` | Points are added to a loyalty account for a purchase that
qualified for points based on an [accrual rule](../../doc/models/loyalty-program-accrual-rule.md). |
-| `CREATE_REWARD` | A [loyalty reward](../../doc/models/loyalty-reward.md) is created. |
-| `REDEEM_REWARD` | A loyalty reward is redeemed. |
-| `DELETE_REWARD` | A loyalty reward is deleted. |
-| `ADJUST_POINTS` | Loyalty points are manually adjusted. |
-| `EXPIRE_POINTS` | Loyalty points are expired according to the
expiration policy of the loyalty program. |
-| `OTHER` | Some other loyalty event occurred. |
-| `ACCUMULATE_PROMOTION_POINTS` | Points are added to a loyalty account for a purchase that
qualified for a [loyalty promotion](../../doc/models/loyalty-promotion.md). |
-
diff --git a/doc/models/loyalty-event.md b/doc/models/loyalty-event.md
deleted file mode 100644
index 66e4cad0..00000000
--- a/doc/models/loyalty-event.md
+++ /dev/null
@@ -1,66 +0,0 @@
-
-# Loyalty Event
-
-Provides information about a loyalty event.
-For more information, see [Search for Balance-Changing Loyalty Events](https://developer.squareup.com/docs/loyalty-api/loyalty-events).
-
-## Structure
-
-`LoyaltyEvent`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `string` | Required | The Square-assigned ID of the loyalty event.
**Constraints**: *Minimum Length*: `1` | getId(): string | setId(string id): void |
-| `type` | [`string(LoyaltyEventType)`](../../doc/models/loyalty-event-type.md) | Required | The type of the loyalty event. | getType(): string | setType(string type): void |
-| `createdAt` | `string` | Required | The timestamp when the event was created, in RFC 3339 format.
**Constraints**: *Minimum Length*: `1` | getCreatedAt(): string | setCreatedAt(string createdAt): void |
-| `accumulatePoints` | [`?LoyaltyEventAccumulatePoints`](../../doc/models/loyalty-event-accumulate-points.md) | Optional | Provides metadata when the event `type` is `ACCUMULATE_POINTS`. | getAccumulatePoints(): ?LoyaltyEventAccumulatePoints | setAccumulatePoints(?LoyaltyEventAccumulatePoints accumulatePoints): void |
-| `createReward` | [`?LoyaltyEventCreateReward`](../../doc/models/loyalty-event-create-reward.md) | Optional | Provides metadata when the event `type` is `CREATE_REWARD`. | getCreateReward(): ?LoyaltyEventCreateReward | setCreateReward(?LoyaltyEventCreateReward createReward): void |
-| `redeemReward` | [`?LoyaltyEventRedeemReward`](../../doc/models/loyalty-event-redeem-reward.md) | Optional | Provides metadata when the event `type` is `REDEEM_REWARD`. | getRedeemReward(): ?LoyaltyEventRedeemReward | setRedeemReward(?LoyaltyEventRedeemReward redeemReward): void |
-| `deleteReward` | [`?LoyaltyEventDeleteReward`](../../doc/models/loyalty-event-delete-reward.md) | Optional | Provides metadata when the event `type` is `DELETE_REWARD`. | getDeleteReward(): ?LoyaltyEventDeleteReward | setDeleteReward(?LoyaltyEventDeleteReward deleteReward): void |
-| `adjustPoints` | [`?LoyaltyEventAdjustPoints`](../../doc/models/loyalty-event-adjust-points.md) | Optional | Provides metadata when the event `type` is `ADJUST_POINTS`. | getAdjustPoints(): ?LoyaltyEventAdjustPoints | setAdjustPoints(?LoyaltyEventAdjustPoints adjustPoints): void |
-| `loyaltyAccountId` | `string` | Required | The ID of the [loyalty account](entity:LoyaltyAccount) associated with the event.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | getLoyaltyAccountId(): string | setLoyaltyAccountId(string loyaltyAccountId): void |
-| `locationId` | `?string` | Optional | The ID of the [location](entity:Location) where the event occurred. | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `source` | [`string(LoyaltyEventSource)`](../../doc/models/loyalty-event-source.md) | Required | Defines whether the event was generated by the Square Point of Sale. | getSource(): string | setSource(string source): void |
-| `expirePoints` | [`?LoyaltyEventExpirePoints`](../../doc/models/loyalty-event-expire-points.md) | Optional | Provides metadata when the event `type` is `EXPIRE_POINTS`. | getExpirePoints(): ?LoyaltyEventExpirePoints | setExpirePoints(?LoyaltyEventExpirePoints expirePoints): void |
-| `otherEvent` | [`?LoyaltyEventOther`](../../doc/models/loyalty-event-other.md) | Optional | Provides metadata when the event `type` is `OTHER`. | getOtherEvent(): ?LoyaltyEventOther | setOtherEvent(?LoyaltyEventOther otherEvent): void |
-| `accumulatePromotionPoints` | [`?LoyaltyEventAccumulatePromotionPoints`](../../doc/models/loyalty-event-accumulate-promotion-points.md) | Optional | Provides metadata when the event `type` is `ACCUMULATE_PROMOTION_POINTS`. | getAccumulatePromotionPoints(): ?LoyaltyEventAccumulatePromotionPoints | setAccumulatePromotionPoints(?LoyaltyEventAccumulatePromotionPoints accumulatePromotionPoints): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id0",
- "type": "ACCUMULATE_POINTS",
- "created_at": "created_at2",
- "accumulate_points": {
- "loyalty_program_id": "loyalty_program_id8",
- "points": 118,
- "order_id": "order_id8"
- },
- "create_reward": {
- "loyalty_program_id": "loyalty_program_id2",
- "reward_id": "reward_id6",
- "points": 90
- },
- "redeem_reward": {
- "loyalty_program_id": "loyalty_program_id8",
- "reward_id": "reward_id2",
- "order_id": "order_id8"
- },
- "delete_reward": {
- "loyalty_program_id": "loyalty_program_id4",
- "reward_id": "reward_id8",
- "points": 104
- },
- "adjust_points": {
- "loyalty_program_id": "loyalty_program_id2",
- "points": 96,
- "reason": "reason2"
- },
- "loyalty_account_id": "loyalty_account_id0",
- "source": "SQUARE"
-}
-```
-
diff --git a/doc/models/loyalty-program-accrual-rule-category-data.md b/doc/models/loyalty-program-accrual-rule-category-data.md
deleted file mode 100644
index 11e7dbc0..00000000
--- a/doc/models/loyalty-program-accrual-rule-category-data.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Loyalty Program Accrual Rule Category Data
-
-Represents additional data for rules with the `CATEGORY` accrual type.
-
-## Structure
-
-`LoyaltyProgramAccrualRuleCategoryData`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `categoryId` | `string` | Required | The ID of the `CATEGORY` [catalog object](entity:CatalogObject) that buyers can purchase to earn
points.
**Constraints**: *Minimum Length*: `1` | getCategoryId(): string | setCategoryId(string categoryId): void |
-
-## Example (as JSON)
-
-```json
-{
- "category_id": "category_id6"
-}
-```
-
diff --git a/doc/models/loyalty-program-accrual-rule-item-variation-data.md b/doc/models/loyalty-program-accrual-rule-item-variation-data.md
deleted file mode 100644
index 65fd2c9b..00000000
--- a/doc/models/loyalty-program-accrual-rule-item-variation-data.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Loyalty Program Accrual Rule Item Variation Data
-
-Represents additional data for rules with the `ITEM_VARIATION` accrual type.
-
-## Structure
-
-`LoyaltyProgramAccrualRuleItemVariationData`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `itemVariationId` | `string` | Required | The ID of the `ITEM_VARIATION` [catalog object](entity:CatalogObject) that buyers can purchase to earn
points.
**Constraints**: *Minimum Length*: `1` | getItemVariationId(): string | setItemVariationId(string itemVariationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "item_variation_id": "item_variation_id6"
-}
-```
-
diff --git a/doc/models/loyalty-program-accrual-rule-spend-data.md b/doc/models/loyalty-program-accrual-rule-spend-data.md
deleted file mode 100644
index a284913d..00000000
--- a/doc/models/loyalty-program-accrual-rule-spend-data.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-# Loyalty Program Accrual Rule Spend Data
-
-Represents additional data for rules with the `SPEND` accrual type.
-
-## Structure
-
-`LoyaltyProgramAccrualRuleSpendData`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-| `excludedCategoryIds` | `?(string[])` | Optional | The IDs of any `CATEGORY` catalog objects that are excluded from points accrual.
You can use the [BatchRetrieveCatalogObjects](api-endpoint:Catalog-BatchRetrieveCatalogObjects)
endpoint to retrieve information about the excluded categories. | getExcludedCategoryIds(): ?array | setExcludedCategoryIds(?array excludedCategoryIds): void |
-| `excludedItemVariationIds` | `?(string[])` | Optional | The IDs of any `ITEM_VARIATION` catalog objects that are excluded from points accrual.
You can use the [BatchRetrieveCatalogObjects](api-endpoint:Catalog-BatchRetrieveCatalogObjects)
endpoint to retrieve information about the excluded item variations. | getExcludedItemVariationIds(): ?array | setExcludedItemVariationIds(?array excludedItemVariationIds): void |
-| `taxMode` | [`string(LoyaltyProgramAccrualRuleTaxMode)`](../../doc/models/loyalty-program-accrual-rule-tax-mode.md) | Required | Indicates how taxes should be treated when calculating the purchase amount used for loyalty points accrual.
This setting applies only to `SPEND` accrual rules or `VISIT` accrual rules that have a minimum spend requirement. | getTaxMode(): string | setTaxMode(string taxMode): void |
-
-## Example (as JSON)
-
-```json
-{
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "excluded_category_ids": [
- "excluded_category_ids4"
- ],
- "excluded_item_variation_ids": [
- "excluded_item_variation_ids7",
- "excluded_item_variation_ids6"
- ],
- "tax_mode": "BEFORE_TAX"
-}
-```
-
diff --git a/doc/models/loyalty-program-accrual-rule-tax-mode.md b/doc/models/loyalty-program-accrual-rule-tax-mode.md
deleted file mode 100644
index 6a4d1016..00000000
--- a/doc/models/loyalty-program-accrual-rule-tax-mode.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Loyalty Program Accrual Rule Tax Mode
-
-Indicates how taxes should be treated when calculating the purchase amount used for loyalty points accrual.
-This setting applies only to `SPEND` accrual rules or `VISIT` accrual rules that have a minimum spend requirement.
-
-## Enumeration
-
-`LoyaltyProgramAccrualRuleTaxMode`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `BEFORE_TAX` | Exclude taxes from the purchase amount used for loyalty points accrual. |
-| `AFTER_TAX` | Include taxes in the purchase amount used for loyalty points accrual. |
-
diff --git a/doc/models/loyalty-program-accrual-rule-type.md b/doc/models/loyalty-program-accrual-rule-type.md
deleted file mode 100644
index cf8384ee..00000000
--- a/doc/models/loyalty-program-accrual-rule-type.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# Loyalty Program Accrual Rule Type
-
-The type of the accrual rule that defines how buyers can earn points.
-
-## Enumeration
-
-`LoyaltyProgramAccrualRuleType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `VISIT` | A visit-based accrual rule. A buyer earns points for each visit.
You can specify the minimum purchase required. |
-| `SPEND` | A spend-based accrual rule. A buyer earns points based on the amount
spent. |
-| `ITEM_VARIATION` | An accrual rule based on an item variation. For example, accrue
points for purchasing a coffee. |
-| `CATEGORY` | An accrual rule based on an item category. For example, accrue points
for purchasing any item in the "hot drink" category: coffee, tea, or hot cocoa. |
-
diff --git a/doc/models/loyalty-program-accrual-rule-visit-data.md b/doc/models/loyalty-program-accrual-rule-visit-data.md
deleted file mode 100644
index 72490a4f..00000000
--- a/doc/models/loyalty-program-accrual-rule-visit-data.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# Loyalty Program Accrual Rule Visit Data
-
-Represents additional data for rules with the `VISIT` accrual type.
-
-## Structure
-
-`LoyaltyProgramAccrualRuleVisitData`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `minimumAmountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getMinimumAmountMoney(): ?Money | setMinimumAmountMoney(?Money minimumAmountMoney): void |
-| `taxMode` | [`string(LoyaltyProgramAccrualRuleTaxMode)`](../../doc/models/loyalty-program-accrual-rule-tax-mode.md) | Required | Indicates how taxes should be treated when calculating the purchase amount used for loyalty points accrual.
This setting applies only to `SPEND` accrual rules or `VISIT` accrual rules that have a minimum spend requirement. | getTaxMode(): string | setTaxMode(string taxMode): void |
-
-## Example (as JSON)
-
-```json
-{
- "minimum_amount_money": {
- "amount": 146,
- "currency": "GHS"
- },
- "tax_mode": "BEFORE_TAX"
-}
-```
-
diff --git a/doc/models/loyalty-program-accrual-rule.md b/doc/models/loyalty-program-accrual-rule.md
deleted file mode 100644
index 04df1802..00000000
--- a/doc/models/loyalty-program-accrual-rule.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Loyalty Program Accrual Rule
-
-Represents an accrual rule, which defines how buyers can earn points from the base [loyalty program](../../doc/models/loyalty-program.md).
-
-## Structure
-
-`LoyaltyProgramAccrualRule`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `accrualType` | [`string(LoyaltyProgramAccrualRuleType)`](../../doc/models/loyalty-program-accrual-rule-type.md) | Required | The type of the accrual rule that defines how buyers can earn points. | getAccrualType(): string | setAccrualType(string accrualType): void |
-| `points` | `?int` | Optional | The number of points that
buyers earn based on the `accrual_type`.
**Constraints**: `>= 1` | getPoints(): ?int | setPoints(?int points): void |
-| `visitData` | [`?LoyaltyProgramAccrualRuleVisitData`](../../doc/models/loyalty-program-accrual-rule-visit-data.md) | Optional | Represents additional data for rules with the `VISIT` accrual type. | getVisitData(): ?LoyaltyProgramAccrualRuleVisitData | setVisitData(?LoyaltyProgramAccrualRuleVisitData visitData): void |
-| `spendData` | [`?LoyaltyProgramAccrualRuleSpendData`](../../doc/models/loyalty-program-accrual-rule-spend-data.md) | Optional | Represents additional data for rules with the `SPEND` accrual type. | getSpendData(): ?LoyaltyProgramAccrualRuleSpendData | setSpendData(?LoyaltyProgramAccrualRuleSpendData spendData): void |
-| `itemVariationData` | [`?LoyaltyProgramAccrualRuleItemVariationData`](../../doc/models/loyalty-program-accrual-rule-item-variation-data.md) | Optional | Represents additional data for rules with the `ITEM_VARIATION` accrual type. | getItemVariationData(): ?LoyaltyProgramAccrualRuleItemVariationData | setItemVariationData(?LoyaltyProgramAccrualRuleItemVariationData itemVariationData): void |
-| `categoryData` | [`?LoyaltyProgramAccrualRuleCategoryData`](../../doc/models/loyalty-program-accrual-rule-category-data.md) | Optional | Represents additional data for rules with the `CATEGORY` accrual type. | getCategoryData(): ?LoyaltyProgramAccrualRuleCategoryData | setCategoryData(?LoyaltyProgramAccrualRuleCategoryData categoryData): void |
-
-## Example (as JSON)
-
-```json
-{
- "accrual_type": "VISIT",
- "points": 86,
- "visit_data": {
- "minimum_amount_money": {
- "amount": 146,
- "currency": "GHS"
- },
- "tax_mode": "BEFORE_TAX"
- },
- "spend_data": {
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "excluded_category_ids": [
- "excluded_category_ids4"
- ],
- "excluded_item_variation_ids": [
- "excluded_item_variation_ids3",
- "excluded_item_variation_ids4"
- ],
- "tax_mode": "BEFORE_TAX"
- },
- "item_variation_data": {
- "item_variation_id": "item_variation_id0"
- },
- "category_data": {
- "category_id": "category_id4"
- }
-}
-```
-
diff --git a/doc/models/loyalty-program-expiration-policy.md b/doc/models/loyalty-program-expiration-policy.md
deleted file mode 100644
index c135ad78..00000000
--- a/doc/models/loyalty-program-expiration-policy.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Loyalty Program Expiration Policy
-
-Describes when the loyalty program expires.
-
-## Structure
-
-`LoyaltyProgramExpirationPolicy`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `expirationDuration` | `string` | Required | The number of months before points expire, in `P[n]M` RFC 3339 duration format. For example, a value of `P12M` represents a duration of 12 months.
Points are valid through the last day of the month in which they are scheduled to expire. For example, with a `P12M` duration, points earned on July 6, 2020 expire on August 1, 2021.
**Constraints**: *Minimum Length*: `1` | getExpirationDuration(): string | setExpirationDuration(string expirationDuration): void |
-
-## Example (as JSON)
-
-```json
-{
- "expiration_duration": "expiration_duration2"
-}
-```
-
diff --git a/doc/models/loyalty-program-reward-definition-scope.md b/doc/models/loyalty-program-reward-definition-scope.md
deleted file mode 100644
index bb399709..00000000
--- a/doc/models/loyalty-program-reward-definition-scope.md
+++ /dev/null
@@ -1,19 +0,0 @@
-
-# Loyalty Program Reward Definition Scope
-
-Indicates the scope of the reward tier. DEPRECATED at version 2020-12-16. Discount details
-are now defined using a catalog pricing rule and other catalog objects. For more information, see
-[Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details).
-
-## Enumeration
-
-`LoyaltyProgramRewardDefinitionScope`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ORDER` | The discount applies to the entire order. |
-| `ITEM_VARIATION` | The discount applies only to specific item variations. |
-| `CATEGORY` | The discount applies only to items in the given categories. |
-
diff --git a/doc/models/loyalty-program-reward-definition-type.md b/doc/models/loyalty-program-reward-definition-type.md
deleted file mode 100644
index 03302579..00000000
--- a/doc/models/loyalty-program-reward-definition-type.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# Loyalty Program Reward Definition Type
-
-The type of discount the reward tier offers. DEPRECATED at version 2020-12-16. Discount details
-are now defined using a catalog pricing rule and other catalog objects. For more information, see
-[Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details).
-
-## Enumeration
-
-`LoyaltyProgramRewardDefinitionType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `FIXED_AMOUNT` | The fixed amount discounted. |
-| `FIXED_PERCENTAGE` | The fixed percentage discounted. |
-
diff --git a/doc/models/loyalty-program-reward-definition.md b/doc/models/loyalty-program-reward-definition.md
deleted file mode 100644
index f7b4d189..00000000
--- a/doc/models/loyalty-program-reward-definition.md
+++ /dev/null
@@ -1,43 +0,0 @@
-
-# Loyalty Program Reward Definition
-
-Provides details about the reward tier discount. DEPRECATED at version 2020-12-16. Discount details
-are now defined using a catalog pricing rule and other catalog objects. For more information, see
-[Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details).
-
-## Structure
-
-`LoyaltyProgramRewardDefinition`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `scope` | [`string(LoyaltyProgramRewardDefinitionScope)`](../../doc/models/loyalty-program-reward-definition-scope.md) | Required | Indicates the scope of the reward tier. DEPRECATED at version 2020-12-16. Discount details
are now defined using a catalog pricing rule and other catalog objects. For more information, see
[Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details). | getScope(): string | setScope(string scope): void |
-| `discountType` | [`string(LoyaltyProgramRewardDefinitionType)`](../../doc/models/loyalty-program-reward-definition-type.md) | Required | The type of discount the reward tier offers. DEPRECATED at version 2020-12-16. Discount details
are now defined using a catalog pricing rule and other catalog objects. For more information, see
[Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details). | getDiscountType(): string | setDiscountType(string discountType): void |
-| `percentageDiscount` | `?string` | Optional | The fixed percentage of the discount. Present if `discount_type` is `FIXED_PERCENTAGE`.
For example, a 7.25% off discount will be represented as "7.25". DEPRECATED at version 2020-12-16. You can find this
information in the `discount_data.percentage` field of the `DISCOUNT` catalog object referenced by the pricing rule. | getPercentageDiscount(): ?string | setPercentageDiscount(?string percentageDiscount): void |
-| `catalogObjectIds` | `?(string[])` | Optional | The list of catalog objects to which this reward can be applied. They are either all item-variation ids or category ids, depending on the `type` field.
DEPRECATED at version 2020-12-16. You can find this information in the `product_set_data.product_ids_any` field
of the `PRODUCT_SET` catalog object referenced by the pricing rule. | getCatalogObjectIds(): ?array | setCatalogObjectIds(?array catalogObjectIds): void |
-| `fixedDiscountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getFixedDiscountMoney(): ?Money | setFixedDiscountMoney(?Money fixedDiscountMoney): void |
-| `maxDiscountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getMaxDiscountMoney(): ?Money | setMaxDiscountMoney(?Money maxDiscountMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "scope": "ORDER",
- "discount_type": "FIXED_AMOUNT",
- "percentage_discount": "percentage_discount0",
- "catalog_object_ids": [
- "catalog_object_ids8"
- ],
- "fixed_discount_money": {
- "amount": 36,
- "currency": "SLL"
- },
- "max_discount_money": {
- "amount": 84,
- "currency": "BOB"
- }
-}
-```
-
diff --git a/doc/models/loyalty-program-reward-tier.md b/doc/models/loyalty-program-reward-tier.md
deleted file mode 100644
index 6b65f4f4..00000000
--- a/doc/models/loyalty-program-reward-tier.md
+++ /dev/null
@@ -1,51 +0,0 @@
-
-# Loyalty Program Reward Tier
-
-Represents a reward tier in a loyalty program. A reward tier defines how buyers can redeem points for a reward, such as the number of points required and the value and scope of the discount. A loyalty program can offer multiple reward tiers.
-
-## Structure
-
-`LoyaltyProgramRewardTier`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The Square-assigned ID of the reward tier.
**Constraints**: *Maximum Length*: `36` | getId(): ?string | setId(?string id): void |
-| `points` | `int` | Required | The points exchanged for the reward tier.
**Constraints**: `>= 1` | getPoints(): int | setPoints(int points): void |
-| `name` | `?string` | Optional | The name of the reward tier. | getName(): ?string | setName(?string name): void |
-| `definition` | [`?LoyaltyProgramRewardDefinition`](../../doc/models/loyalty-program-reward-definition.md) | Optional | Provides details about the reward tier discount. DEPRECATED at version 2020-12-16. Discount details
are now defined using a catalog pricing rule and other catalog objects. For more information, see
[Getting discount details for a reward tier](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards#get-discount-details). | getDefinition(): ?LoyaltyProgramRewardDefinition | setDefinition(?LoyaltyProgramRewardDefinition definition): void |
-| `createdAt` | `?string` | Optional | The timestamp when the reward tier was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `pricingRuleReference` | [`CatalogObjectReference`](../../doc/models/catalog-object-reference.md) | Required | A reference to a Catalog object at a specific version. In general this is
used as an entry point into a graph of catalog objects, where the objects exist
at a specific version. | getPricingRuleReference(): CatalogObjectReference | setPricingRuleReference(CatalogObjectReference pricingRuleReference): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id2",
- "points": 94,
- "name": "name2",
- "definition": {
- "scope": "ORDER",
- "discount_type": "FIXED_AMOUNT",
- "percentage_discount": "percentage_discount2",
- "catalog_object_ids": [
- "catalog_object_ids6"
- ],
- "fixed_discount_money": {
- "amount": 36,
- "currency": "SLL"
- },
- "max_discount_money": {
- "amount": 84,
- "currency": "BOB"
- }
- },
- "created_at": "created_at0",
- "pricing_rule_reference": {
- "object_id": "object_id0",
- "catalog_version": 218
- }
-}
-```
-
diff --git a/doc/models/loyalty-program-status.md b/doc/models/loyalty-program-status.md
deleted file mode 100644
index ef1a3ed7..00000000
--- a/doc/models/loyalty-program-status.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Loyalty Program Status
-
-Indicates whether the program is currently active.
-
-## Enumeration
-
-`LoyaltyProgramStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `INACTIVE` | The loyalty program does not have an active subscription.
Loyalty API requests fail. |
-| `ACTIVE` | The program is fully functional. The program has an active subscription. |
-
diff --git a/doc/models/loyalty-program-terminology.md b/doc/models/loyalty-program-terminology.md
deleted file mode 100644
index 6e49b83b..00000000
--- a/doc/models/loyalty-program-terminology.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Loyalty Program Terminology
-
-Represents the naming used for loyalty points.
-
-## Structure
-
-`LoyaltyProgramTerminology`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `one` | `string` | Required | A singular unit for a point (for example, 1 point is called 1 star).
**Constraints**: *Minimum Length*: `1` | getOne(): string | setOne(string one): void |
-| `other` | `string` | Required | A plural unit for point (for example, 10 points is called 10 stars).
**Constraints**: *Minimum Length*: `1` | getOther(): string | setOther(string other): void |
-
-## Example (as JSON)
-
-```json
-{
- "one": "one4",
- "other": "other0"
-}
-```
-
diff --git a/doc/models/loyalty-program.md b/doc/models/loyalty-program.md
deleted file mode 100644
index c4eb69da..00000000
--- a/doc/models/loyalty-program.md
+++ /dev/null
@@ -1,95 +0,0 @@
-
-# Loyalty Program
-
-Represents a Square loyalty program. Loyalty programs define how buyers can earn points and redeem points for rewards.
-Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard.
-For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).
-
-## Structure
-
-`LoyaltyProgram`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The Square-assigned ID of the loyalty program. Updates to
the loyalty program do not modify the identifier.
**Constraints**: *Maximum Length*: `36` | getId(): ?string | setId(?string id): void |
-| `status` | [`?string(LoyaltyProgramStatus)`](../../doc/models/loyalty-program-status.md) | Optional | Indicates whether the program is currently active. | getStatus(): ?string | setStatus(?string status): void |
-| `rewardTiers` | [`?(LoyaltyProgramRewardTier[])`](../../doc/models/loyalty-program-reward-tier.md) | Optional | The list of rewards for buyers, sorted by ascending points. | getRewardTiers(): ?array | setRewardTiers(?array rewardTiers): void |
-| `expirationPolicy` | [`?LoyaltyProgramExpirationPolicy`](../../doc/models/loyalty-program-expiration-policy.md) | Optional | Describes when the loyalty program expires. | getExpirationPolicy(): ?LoyaltyProgramExpirationPolicy | setExpirationPolicy(?LoyaltyProgramExpirationPolicy expirationPolicy): void |
-| `terminology` | [`?LoyaltyProgramTerminology`](../../doc/models/loyalty-program-terminology.md) | Optional | Represents the naming used for loyalty points. | getTerminology(): ?LoyaltyProgramTerminology | setTerminology(?LoyaltyProgramTerminology terminology): void |
-| `locationIds` | `?(string[])` | Optional | The [locations](entity:Location) at which the program is active. | getLocationIds(): ?array | setLocationIds(?array locationIds): void |
-| `createdAt` | `?string` | Optional | The timestamp when the program was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp when the reward was last updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `accrualRules` | [`?(LoyaltyProgramAccrualRule[])`](../../doc/models/loyalty-program-accrual-rule.md) | Optional | Defines how buyers can earn loyalty points from the base loyalty program.
To check for associated [loyalty promotions](entity:LoyaltyPromotion) that enable
buyers to earn extra points, call [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions). | getAccrualRules(): ?array | setAccrualRules(?array accrualRules): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id2",
- "status": "INACTIVE",
- "reward_tiers": [
- {
- "id": "id8",
- "points": 250,
- "name": "name8",
- "definition": {
- "scope": "ORDER",
- "discount_type": "FIXED_AMOUNT",
- "percentage_discount": "percentage_discount2",
- "catalog_object_ids": [
- "catalog_object_ids6"
- ],
- "fixed_discount_money": {
- "amount": 36,
- "currency": "SLL"
- },
- "max_discount_money": {
- "amount": 84,
- "currency": "BOB"
- }
- },
- "created_at": "created_at6",
- "pricing_rule_reference": {
- "object_id": "object_id0",
- "catalog_version": 218
- }
- },
- {
- "id": "id8",
- "points": 250,
- "name": "name8",
- "definition": {
- "scope": "ORDER",
- "discount_type": "FIXED_AMOUNT",
- "percentage_discount": "percentage_discount2",
- "catalog_object_ids": [
- "catalog_object_ids6"
- ],
- "fixed_discount_money": {
- "amount": 36,
- "currency": "SLL"
- },
- "max_discount_money": {
- "amount": 84,
- "currency": "BOB"
- }
- },
- "created_at": "created_at6",
- "pricing_rule_reference": {
- "object_id": "object_id0",
- "catalog_version": 218
- }
- }
- ],
- "expiration_policy": {
- "expiration_duration": "expiration_duration0"
- },
- "terminology": {
- "one": "one0",
- "other": "other6"
- }
-}
-```
-
diff --git a/doc/models/loyalty-promotion-available-time-data.md b/doc/models/loyalty-promotion-available-time-data.md
deleted file mode 100644
index daa7c15c..00000000
--- a/doc/models/loyalty-promotion-available-time-data.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Loyalty Promotion Available Time Data
-
-Represents scheduling information that determines when purchases can qualify to earn points
-from a [loyalty promotion](../../doc/models/loyalty-promotion.md).
-
-## Structure
-
-`LoyaltyPromotionAvailableTimeData`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `startDate` | `?string` | Optional | The date that the promotion starts, in `YYYY-MM-DD` format. Square populates this field
based on the provided `time_periods`. | getStartDate(): ?string | setStartDate(?string startDate): void |
-| `endDate` | `?string` | Optional | The date that the promotion ends, in `YYYY-MM-DD` format. Square populates this field
based on the provided `time_periods`. If an end date is not specified, an `ACTIVE` promotion
remains available until it is canceled. | getEndDate(): ?string | setEndDate(?string endDate): void |
-| `timePeriods` | `string[]` | Required | A list of [iCalendar (RFC 5545) events](https://tools.ietf.org/html/rfc5545#section-3.6.1)
(`VEVENT`). Each event represents an available time period per day or days of the week.
A day can have a maximum of one available time period.
Only `DTSTART`, `DURATION`, and `RRULE` are supported. `DTSTART` and `DURATION` are required and
timestamps must be in local (unzoned) time format. Include `RRULE` to specify recurring promotions,
an end date (using the `UNTIL` keyword), or both. For more information, see
[Available time](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions#available-time).
Note that `BEGIN:VEVENT` and `END:VEVENT` are optional in a `CreateLoyaltyPromotion` request
but are always included in the response. | getTimePeriods(): array | setTimePeriods(array timePeriods): void |
-
-## Example (as JSON)
-
-```json
-{
- "start_date": "start_date4",
- "end_date": "end_date0",
- "time_periods": [
- "time_periods7",
- "time_periods8",
- "time_periods9"
- ]
-}
-```
-
diff --git a/doc/models/loyalty-promotion-incentive-points-addition-data.md b/doc/models/loyalty-promotion-incentive-points-addition-data.md
deleted file mode 100644
index 01c3854a..00000000
--- a/doc/models/loyalty-promotion-incentive-points-addition-data.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Loyalty Promotion Incentive Points Addition Data
-
-Represents the metadata for a `POINTS_ADDITION` type of [loyalty promotion incentive](../../doc/models/loyalty-promotion-incentive.md).
-
-## Structure
-
-`LoyaltyPromotionIncentivePointsAdditionData`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `pointsAddition` | `int` | Required | The number of additional points to earn each time the promotion is triggered. For example,
suppose a purchase qualifies for 5 points from the base loyalty program. If the purchase also
qualifies for a `POINTS_ADDITION` promotion incentive with a `points_addition` of 3, the buyer
earns a total of 8 points (5 program points + 3 promotion points = 8 points).
**Constraints**: `>= 1` | getPointsAddition(): int | setPointsAddition(int pointsAddition): void |
-
-## Example (as JSON)
-
-```json
-{
- "points_addition": 88
-}
-```
-
diff --git a/doc/models/loyalty-promotion-incentive-points-multiplier-data.md b/doc/models/loyalty-promotion-incentive-points-multiplier-data.md
deleted file mode 100644
index a3a9ad81..00000000
--- a/doc/models/loyalty-promotion-incentive-points-multiplier-data.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Loyalty Promotion Incentive Points Multiplier Data
-
-Represents the metadata for a `POINTS_MULTIPLIER` type of [loyalty promotion incentive](../../doc/models/loyalty-promotion-incentive.md).
-
-## Structure
-
-`LoyaltyPromotionIncentivePointsMultiplierData`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `pointsMultiplier` | `?int` | Optional | The multiplier used to calculate the number of points earned each time the promotion
is triggered. For example, suppose a purchase qualifies for 5 points from the base loyalty program.
If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a `points_multiplier`
of 3, the buyer earns a total of 15 points (5 program points x 3 promotion multiplier = 15 points).
DEPRECATED at version 2023-08-16. Replaced by the `multiplier` field.
One of the following is required when specifying a points multiplier:
- (Recommended) The `multiplier` field.
- This deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier`
with the equivalent value.
**Constraints**: `>= 2`, `<= 10` | getPointsMultiplier(): ?int | setPointsMultiplier(?int pointsMultiplier): void |
-| `multiplier` | `?string` | Optional | The multiplier used to calculate the number of points earned each time the promotion is triggered,
specified as a string representation of a decimal. Square supports multipliers up to 10x, with three
point precision for decimal multipliers. For example, suppose a purchase qualifies for 4 points from the
base loyalty program. If the purchase also qualifies for a `POINTS_MULTIPLIER` promotion incentive with a
`multiplier` of "1.5", the buyer earns a total of 6 points (4 program points x 1.5 promotion multiplier = 6 points).
Fractional points are dropped.
One of the following is required when specifying a points multiplier:
- (Recommended) This `multiplier` field.
- The deprecated `points_multiplier` field. If provided in the request, Square also returns `multiplier`
with the equivalent value.
**Constraints**: *Maximum Length*: `5` | getMultiplier(): ?string | setMultiplier(?string multiplier): void |
-
-## Example (as JSON)
-
-```json
-{
- "points_multiplier": 116,
- "multiplier": "multiplier2"
-}
-```
-
diff --git a/doc/models/loyalty-promotion-incentive-type.md b/doc/models/loyalty-promotion-incentive-type.md
deleted file mode 100644
index 4797dfee..00000000
--- a/doc/models/loyalty-promotion-incentive-type.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Loyalty Promotion Incentive Type
-
-Indicates the type of points incentive for a [loyalty promotion](../../doc/models/loyalty-promotion.md),
-which is used to determine how buyers can earn points from the promotion.
-
-## Enumeration
-
-`LoyaltyPromotionIncentiveType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `POINTS_MULTIPLIER` | Multiply the number of points earned from the base loyalty program.
For example, "Earn double points." |
-| `POINTS_ADDITION` | Add a specified number of points to those earned from the base loyalty program.
For example, "Earn 10 additional points." |
-
diff --git a/doc/models/loyalty-promotion-incentive.md b/doc/models/loyalty-promotion-incentive.md
deleted file mode 100644
index ab4c0c49..00000000
--- a/doc/models/loyalty-promotion-incentive.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Loyalty Promotion Incentive
-
-Represents how points for a [loyalty promotion](../../doc/models/loyalty-promotion.md) are calculated,
-either by multiplying the points earned from the base program or by adding a specified number
-of points to the points earned from the base program.
-
-## Structure
-
-`LoyaltyPromotionIncentive`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `type` | [`string(LoyaltyPromotionIncentiveType)`](../../doc/models/loyalty-promotion-incentive-type.md) | Required | Indicates the type of points incentive for a [loyalty promotion](../../doc/models/loyalty-promotion.md),
which is used to determine how buyers can earn points from the promotion. | getType(): string | setType(string type): void |
-| `pointsMultiplierData` | [`?LoyaltyPromotionIncentivePointsMultiplierData`](../../doc/models/loyalty-promotion-incentive-points-multiplier-data.md) | Optional | Represents the metadata for a `POINTS_MULTIPLIER` type of [loyalty promotion incentive](../../doc/models/loyalty-promotion-incentive.md). | getPointsMultiplierData(): ?LoyaltyPromotionIncentivePointsMultiplierData | setPointsMultiplierData(?LoyaltyPromotionIncentivePointsMultiplierData pointsMultiplierData): void |
-| `pointsAdditionData` | [`?LoyaltyPromotionIncentivePointsAdditionData`](../../doc/models/loyalty-promotion-incentive-points-addition-data.md) | Optional | Represents the metadata for a `POINTS_ADDITION` type of [loyalty promotion incentive](../../doc/models/loyalty-promotion-incentive.md). | getPointsAdditionData(): ?LoyaltyPromotionIncentivePointsAdditionData | setPointsAdditionData(?LoyaltyPromotionIncentivePointsAdditionData pointsAdditionData): void |
-
-## Example (as JSON)
-
-```json
-{
- "type": "POINTS_MULTIPLIER",
- "points_multiplier_data": {
- "points_multiplier": 134,
- "multiplier": "multiplier4"
- },
- "points_addition_data": {
- "points_addition": 218
- }
-}
-```
-
diff --git a/doc/models/loyalty-promotion-status.md b/doc/models/loyalty-promotion-status.md
deleted file mode 100644
index 393c90c7..00000000
--- a/doc/models/loyalty-promotion-status.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# Loyalty Promotion Status
-
-Indicates the status of a [loyalty promotion](../../doc/models/loyalty-promotion.md).
-
-## Enumeration
-
-`LoyaltyPromotionStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ACTIVE` | The loyalty promotion is currently active. Buyers can earn points for purchases
that meet the promotion conditions, such as the promotion's `available_time`. |
-| `ENDED` | The loyalty promotion has ended because the specified `end_date` was reached.
`ENDED` is a terminal status. |
-| `CANCELED` | The loyalty promotion was canceled. `CANCELED` is a terminal status. |
-| `SCHEDULED` | The loyalty promotion is scheduled to start in the future. Square changes the
promotion status to `ACTIVE` when the `start_date` is reached. |
-
diff --git a/doc/models/loyalty-promotion-trigger-limit-interval.md b/doc/models/loyalty-promotion-trigger-limit-interval.md
deleted file mode 100644
index 3be1d813..00000000
--- a/doc/models/loyalty-promotion-trigger-limit-interval.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Loyalty Promotion Trigger Limit Interval
-
-Indicates the time period that the [trigger limit](../../doc/models/loyalty-promotion-trigger-limit.md) applies to,
-which is used to determine the number of times a buyer can earn points for a [loyalty promotion](../../doc/models/loyalty-promotion.md).
-
-## Enumeration
-
-`LoyaltyPromotionTriggerLimitInterval`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ALL_TIME` | The limit applies to the entire time that the promotion is active. For example, if `times`
is set to 1 and `time_period` is set to `ALL_TIME`, a buyer can earn promotion points a maximum
of one time during the promotion. |
-| `DAY` | The limit applies per day, according to the `available_time` schedule specified for the promotion.
For example, if the `times` field of the trigger limit is set to 1, a buyer can trigger the promotion
a maximum of once per day. |
-
diff --git a/doc/models/loyalty-promotion-trigger-limit.md b/doc/models/loyalty-promotion-trigger-limit.md
deleted file mode 100644
index 25a432f8..00000000
--- a/doc/models/loyalty-promotion-trigger-limit.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Loyalty Promotion Trigger Limit
-
-Represents the number of times a buyer can earn points during a [loyalty promotion](../../doc/models/loyalty-promotion.md).
-If this field is not set, buyers can trigger the promotion an unlimited number of times to earn points during
-the time that the promotion is available.
-
-A purchase that is disqualified from earning points because of this limit might qualify for another active promotion.
-
-## Structure
-
-`LoyaltyPromotionTriggerLimit`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `times` | `int` | Required | The maximum number of times a buyer can trigger the promotion during the specified `interval`.
**Constraints**: `>= 1`, `<= 30` | getTimes(): int | setTimes(int times): void |
-| `interval` | [`?string(LoyaltyPromotionTriggerLimitInterval)`](../../doc/models/loyalty-promotion-trigger-limit-interval.md) | Optional | Indicates the time period that the [trigger limit](../../doc/models/loyalty-promotion-trigger-limit.md) applies to,
which is used to determine the number of times a buyer can earn points for a [loyalty promotion](../../doc/models/loyalty-promotion.md). | getInterval(): ?string | setInterval(?string interval): void |
-
-## Example (as JSON)
-
-```json
-{
- "times": 32,
- "interval": "ALL_TIME"
-}
-```
-
diff --git a/doc/models/loyalty-promotion.md b/doc/models/loyalty-promotion.md
deleted file mode 100644
index f88372a9..00000000
--- a/doc/models/loyalty-promotion.md
+++ /dev/null
@@ -1,63 +0,0 @@
-
-# Loyalty Promotion
-
-Represents a promotion for a [loyalty program](../../doc/models/loyalty-program.md). Loyalty promotions enable buyers
-to earn extra points on top of those earned from the base program.
-
-A loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status.
-
-## Structure
-
-`LoyaltyPromotion`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The Square-assigned ID of the promotion.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getId(): ?string | setId(?string id): void |
-| `name` | `string` | Required | The name of the promotion.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `70` | getName(): string | setName(string name): void |
-| `incentive` | [`LoyaltyPromotionIncentive`](../../doc/models/loyalty-promotion-incentive.md) | Required | Represents how points for a [loyalty promotion](../../doc/models/loyalty-promotion.md) are calculated,
either by multiplying the points earned from the base program or by adding a specified number
of points to the points earned from the base program. | getIncentive(): LoyaltyPromotionIncentive | setIncentive(LoyaltyPromotionIncentive incentive): void |
-| `availableTime` | [`LoyaltyPromotionAvailableTimeData`](../../doc/models/loyalty-promotion-available-time-data.md) | Required | Represents scheduling information that determines when purchases can qualify to earn points
from a [loyalty promotion](../../doc/models/loyalty-promotion.md). | getAvailableTime(): LoyaltyPromotionAvailableTimeData | setAvailableTime(LoyaltyPromotionAvailableTimeData availableTime): void |
-| `triggerLimit` | [`?LoyaltyPromotionTriggerLimit`](../../doc/models/loyalty-promotion-trigger-limit.md) | Optional | Represents the number of times a buyer can earn points during a [loyalty promotion](../../doc/models/loyalty-promotion.md).
If this field is not set, buyers can trigger the promotion an unlimited number of times to earn points during
the time that the promotion is available.
A purchase that is disqualified from earning points because of this limit might qualify for another active promotion. | getTriggerLimit(): ?LoyaltyPromotionTriggerLimit | setTriggerLimit(?LoyaltyPromotionTriggerLimit triggerLimit): void |
-| `status` | [`?string(LoyaltyPromotionStatus)`](../../doc/models/loyalty-promotion-status.md) | Optional | Indicates the status of a [loyalty promotion](../../doc/models/loyalty-promotion.md). | getStatus(): ?string | setStatus(?string status): void |
-| `createdAt` | `?string` | Optional | The timestamp of when the promotion was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `canceledAt` | `?string` | Optional | The timestamp of when the promotion was canceled, in RFC 3339 format. | getCanceledAt(): ?string | setCanceledAt(?string canceledAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp when the promotion was last updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `loyaltyProgramId` | `?string` | Optional | The ID of the [loyalty program](entity:LoyaltyProgram) associated with the promotion. | getLoyaltyProgramId(): ?string | setLoyaltyProgramId(?string loyaltyProgramId): void |
-| `minimumSpendAmountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getMinimumSpendAmountMoney(): ?Money | setMinimumSpendAmountMoney(?Money minimumSpendAmountMoney): void |
-| `qualifyingItemVariationIds` | `?(string[])` | Optional | The IDs of any qualifying `ITEM_VARIATION` [catalog objects](entity:CatalogObject). If specified,
the purchase must include at least one of these items to qualify for the promotion.
This option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule.
With `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.
You can specify `qualifying_item_variation_ids` or `qualifying_category_ids` for a given promotion, but not both. | getQualifyingItemVariationIds(): ?array | setQualifyingItemVariationIds(?array qualifyingItemVariationIds): void |
-| `qualifyingCategoryIds` | `?(string[])` | Optional | The IDs of any qualifying `CATEGORY` [catalog objects](entity:CatalogObject). If specified,
the purchase must include at least one item from one of these categories to qualify for the promotion.
This option is valid only if the base loyalty program uses a `VISIT` or `SPEND` accrual rule.
With `SPEND` accrual rules, make sure that qualifying promotional items are not excluded.
You can specify `qualifying_category_ids` or `qualifying_item_variation_ids` for a promotion, but not both. | getQualifyingCategoryIds(): ?array | setQualifyingCategoryIds(?array qualifyingCategoryIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id4",
- "name": "name4",
- "incentive": {
- "type": "POINTS_MULTIPLIER",
- "points_multiplier_data": {
- "points_multiplier": 134,
- "multiplier": "multiplier4"
- },
- "points_addition_data": {
- "points_addition": 218
- }
- },
- "available_time": {
- "start_date": "start_date4",
- "end_date": "end_date8",
- "time_periods": [
- "time_periods9"
- ]
- },
- "trigger_limit": {
- "times": 26,
- "interval": "ALL_TIME"
- },
- "status": "ACTIVE",
- "created_at": "created_at8",
- "canceled_at": "canceled_at0"
-}
-```
-
diff --git a/doc/models/loyalty-reward-status.md b/doc/models/loyalty-reward-status.md
deleted file mode 100644
index 26be27d3..00000000
--- a/doc/models/loyalty-reward-status.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Loyalty Reward Status
-
-The status of the loyalty reward.
-
-## Enumeration
-
-`LoyaltyRewardStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ISSUED` | The reward is issued. |
-| `REDEEMED` | The reward is redeemed. |
-| `DELETED` | The reward is deleted. |
-
diff --git a/doc/models/loyalty-reward.md b/doc/models/loyalty-reward.md
deleted file mode 100644
index 38382e30..00000000
--- a/doc/models/loyalty-reward.md
+++ /dev/null
@@ -1,38 +0,0 @@
-
-# Loyalty Reward
-
-Represents a contract to redeem loyalty points for a [reward tier](../../doc/models/loyalty-program-reward-tier.md) discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state.
-For more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards).
-
-## Structure
-
-`LoyaltyReward`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The Square-assigned ID of the loyalty reward.
**Constraints**: *Maximum Length*: `36` | getId(): ?string | setId(?string id): void |
-| `status` | [`?string(LoyaltyRewardStatus)`](../../doc/models/loyalty-reward-status.md) | Optional | The status of the loyalty reward. | getStatus(): ?string | setStatus(?string status): void |
-| `loyaltyAccountId` | `string` | Required | The Square-assigned ID of the [loyalty account](entity:LoyaltyAccount) to which the reward belongs.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | getLoyaltyAccountId(): string | setLoyaltyAccountId(string loyaltyAccountId): void |
-| `rewardTierId` | `string` | Required | The Square-assigned ID of the [reward tier](entity:LoyaltyProgramRewardTier) used to create the reward.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | getRewardTierId(): string | setRewardTierId(string rewardTierId): void |
-| `points` | `?int` | Optional | The number of loyalty points used for the reward.
**Constraints**: `>= 1` | getPoints(): ?int | setPoints(?int points): void |
-| `orderId` | `?string` | Optional | The Square-assigned ID of the [order](entity:Order) to which the reward is attached. | getOrderId(): ?string | setOrderId(?string orderId): void |
-| `createdAt` | `?string` | Optional | The timestamp when the reward was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp when the reward was last updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `redeemedAt` | `?string` | Optional | The timestamp when the reward was redeemed, in RFC 3339 format. | getRedeemedAt(): ?string | setRedeemedAt(?string redeemedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id6",
- "status": "DELETED",
- "loyalty_account_id": "loyalty_account_id4",
- "reward_tier_id": "reward_tier_id2",
- "points": 114,
- "order_id": "order_id0",
- "created_at": "created_at4"
-}
-```
-
diff --git a/doc/models/m-break.md b/doc/models/m-break.md
deleted file mode 100644
index aab653da..00000000
--- a/doc/models/m-break.md
+++ /dev/null
@@ -1,35 +0,0 @@
-
-# M Break
-
-A record of an employee's break during a shift.
-
-## Structure
-
-`MBreak`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The UUID for this object. | getId(): ?string | setId(?string id): void |
-| `startAt` | `string` | Required | RFC 3339; follows the same timezone information as `Shift`. Precision up to
the minute is respected; seconds are truncated.
**Constraints**: *Minimum Length*: `1` | getStartAt(): string | setStartAt(string startAt): void |
-| `endAt` | `?string` | Optional | RFC 3339; follows the same timezone information as `Shift`. Precision up to
the minute is respected; seconds are truncated. | getEndAt(): ?string | setEndAt(?string endAt): void |
-| `breakTypeId` | `string` | Required | The `BreakType` that this `Break` was templated on.
**Constraints**: *Minimum Length*: `1` | getBreakTypeId(): string | setBreakTypeId(string breakTypeId): void |
-| `name` | `string` | Required | A human-readable name.
**Constraints**: *Minimum Length*: `1` | getName(): string | setName(string name): void |
-| `expectedDuration` | `string` | Required | Format: RFC-3339 P[n]Y[n]M[n]DT[n]H[n]M[n]S. The expected length of
the break.
**Constraints**: *Minimum Length*: `1` | getExpectedDuration(): string | setExpectedDuration(string expectedDuration): void |
-| `isPaid` | `bool` | Required | Whether this break counts towards time worked for compensation
purposes. | getIsPaid(): bool | setIsPaid(bool isPaid): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id6",
- "start_at": "start_at8",
- "end_at": "end_at4",
- "break_type_id": "break_type_id2",
- "name": "name6",
- "expected_duration": "expected_duration8",
- "is_paid": false
-}
-```
-
diff --git a/doc/models/measurement-unit-area.md b/doc/models/measurement-unit-area.md
deleted file mode 100644
index c1148914..00000000
--- a/doc/models/measurement-unit-area.md
+++ /dev/null
@@ -1,22 +0,0 @@
-
-# Measurement Unit Area
-
-Unit of area used to measure a quantity.
-
-## Enumeration
-
-`MeasurementUnitArea`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `IMPERIAL_ACRE` | The area is measured in acres. |
-| `IMPERIAL_SQUARE_INCH` | The area is measured in square inches. |
-| `IMPERIAL_SQUARE_FOOT` | The area is measured in square feet. |
-| `IMPERIAL_SQUARE_YARD` | The area is measured in square yards. |
-| `IMPERIAL_SQUARE_MILE` | The area is measured in square miles. |
-| `METRIC_SQUARE_CENTIMETER` | The area is measured in square centimeters. |
-| `METRIC_SQUARE_METER` | The area is measured in square meters. |
-| `METRIC_SQUARE_KILOMETER` | The area is measured in square kilometers. |
-
diff --git a/doc/models/measurement-unit-custom.md b/doc/models/measurement-unit-custom.md
deleted file mode 100644
index f593cb57..00000000
--- a/doc/models/measurement-unit-custom.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Measurement Unit Custom
-
-The information needed to define a custom unit, provided by the seller.
-
-## Structure
-
-`MeasurementUnitCustom`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `name` | `string` | Required | The name of the custom unit, for example "bushel". | getName(): string | setName(string name): void |
-| `abbreviation` | `string` | Required | The abbreviation of the custom unit, such as "bsh" (bushel). This appears
in the cart for the Point of Sale app, and in reports. | getAbbreviation(): string | setAbbreviation(string abbreviation): void |
-
-## Example (as JSON)
-
-```json
-{
- "name": "name8",
- "abbreviation": "abbreviation0"
-}
-```
-
diff --git a/doc/models/measurement-unit-generic.md b/doc/models/measurement-unit-generic.md
deleted file mode 100644
index 0206fe95..00000000
--- a/doc/models/measurement-unit-generic.md
+++ /dev/null
@@ -1,13 +0,0 @@
-
-# Measurement Unit Generic
-
-## Enumeration
-
-`MeasurementUnitGeneric`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `UNIT` | The generic unit. |
-
diff --git a/doc/models/measurement-unit-length.md b/doc/models/measurement-unit-length.md
deleted file mode 100644
index 82dfc078..00000000
--- a/doc/models/measurement-unit-length.md
+++ /dev/null
@@ -1,22 +0,0 @@
-
-# Measurement Unit Length
-
-The unit of length used to measure a quantity.
-
-## Enumeration
-
-`MeasurementUnitLength`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `IMPERIAL_INCH` | The length is measured in inches. |
-| `IMPERIAL_FOOT` | The length is measured in feet. |
-| `IMPERIAL_YARD` | The length is measured in yards. |
-| `IMPERIAL_MILE` | The length is measured in miles. |
-| `METRIC_MILLIMETER` | The length is measured in millimeters. |
-| `METRIC_CENTIMETER` | The length is measured in centimeters. |
-| `METRIC_METER` | The length is measured in meters. |
-| `METRIC_KILOMETER` | The length is measured in kilometers. |
-
diff --git a/doc/models/measurement-unit-time.md b/doc/models/measurement-unit-time.md
deleted file mode 100644
index 43b8c4ce..00000000
--- a/doc/models/measurement-unit-time.md
+++ /dev/null
@@ -1,19 +0,0 @@
-
-# Measurement Unit Time
-
-Unit of time used to measure a quantity (a duration).
-
-## Enumeration
-
-`MeasurementUnitTime`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `GENERIC_MILLISECOND` | The time is measured in milliseconds. |
-| `GENERIC_SECOND` | The time is measured in seconds. |
-| `GENERIC_MINUTE` | The time is measured in minutes. |
-| `GENERIC_HOUR` | The time is measured in hours. |
-| `GENERIC_DAY` | The time is measured in days. |
-
diff --git a/doc/models/measurement-unit-unit-type.md b/doc/models/measurement-unit-unit-type.md
deleted file mode 100644
index bcf03f39..00000000
--- a/doc/models/measurement-unit-unit-type.md
+++ /dev/null
@@ -1,20 +0,0 @@
-
-# Measurement Unit Unit Type
-
-Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum.
-
-## Enumeration
-
-`MeasurementUnitUnitType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `TYPE_CUSTOM` | The unit details are contained in the custom_unit field. |
-| `TYPE_AREA` | The unit details are contained in the area_unit field. |
-| `TYPE_LENGTH` | The unit details are contained in the length_unit field. |
-| `TYPE_VOLUME` | The unit details are contained in the volume_unit field. |
-| `TYPE_WEIGHT` | The unit details are contained in the weight_unit field. |
-| `TYPE_GENERIC` | The unit details are contained in the generic_unit field. |
-
diff --git a/doc/models/measurement-unit-volume.md b/doc/models/measurement-unit-volume.md
deleted file mode 100644
index 822a5216..00000000
--- a/doc/models/measurement-unit-volume.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Measurement Unit Volume
-
-The unit of volume used to measure a quantity.
-
-## Enumeration
-
-`MeasurementUnitVolume`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `GENERIC_FLUID_OUNCE` | The volume is measured in ounces. |
-| `GENERIC_SHOT` | The volume is measured in shots. |
-| `GENERIC_CUP` | The volume is measured in cups. |
-| `GENERIC_PINT` | The volume is measured in pints. |
-| `GENERIC_QUART` | The volume is measured in quarts. |
-| `GENERIC_GALLON` | The volume is measured in gallons. |
-| `IMPERIAL_CUBIC_INCH` | The volume is measured in cubic inches. |
-| `IMPERIAL_CUBIC_FOOT` | The volume is measured in cubic feet. |
-| `IMPERIAL_CUBIC_YARD` | The volume is measured in cubic yards. |
-| `METRIC_MILLILITER` | The volume is measured in metric milliliters. |
-| `METRIC_LITER` | The volume is measured in metric liters. |
-
diff --git a/doc/models/measurement-unit-weight.md b/doc/models/measurement-unit-weight.md
deleted file mode 100644
index 1b81d26e..00000000
--- a/doc/models/measurement-unit-weight.md
+++ /dev/null
@@ -1,20 +0,0 @@
-
-# Measurement Unit Weight
-
-Unit of weight used to measure a quantity.
-
-## Enumeration
-
-`MeasurementUnitWeight`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `IMPERIAL_WEIGHT_OUNCE` | The weight is measured in ounces. |
-| `IMPERIAL_POUND` | The weight is measured in pounds. |
-| `IMPERIAL_STONE` | The weight is measured in stones. |
-| `METRIC_MILLIGRAM` | The weight is measured in milligrams. |
-| `METRIC_GRAM` | The weight is measured in grams. |
-| `METRIC_KILOGRAM` | The weight is measured in kilograms. |
-
diff --git a/doc/models/measurement-unit.md b/doc/models/measurement-unit.md
deleted file mode 100644
index 30bc1189..00000000
--- a/doc/models/measurement-unit.md
+++ /dev/null
@@ -1,39 +0,0 @@
-
-# Measurement Unit
-
-Represents a unit of measurement to use with a quantity, such as ounces
-or inches. Exactly one of the following fields are required: `custom_unit`,
-`area_unit`, `length_unit`, `volume_unit`, and `weight_unit`.
-
-## Structure
-
-`MeasurementUnit`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customUnit` | [`?MeasurementUnitCustom`](../../doc/models/measurement-unit-custom.md) | Optional | The information needed to define a custom unit, provided by the seller. | getCustomUnit(): ?MeasurementUnitCustom | setCustomUnit(?MeasurementUnitCustom customUnit): void |
-| `areaUnit` | [`?string(MeasurementUnitArea)`](../../doc/models/measurement-unit-area.md) | Optional | Unit of area used to measure a quantity. | getAreaUnit(): ?string | setAreaUnit(?string areaUnit): void |
-| `lengthUnit` | [`?string(MeasurementUnitLength)`](../../doc/models/measurement-unit-length.md) | Optional | The unit of length used to measure a quantity. | getLengthUnit(): ?string | setLengthUnit(?string lengthUnit): void |
-| `volumeUnit` | [`?string(MeasurementUnitVolume)`](../../doc/models/measurement-unit-volume.md) | Optional | The unit of volume used to measure a quantity. | getVolumeUnit(): ?string | setVolumeUnit(?string volumeUnit): void |
-| `weightUnit` | [`?string(MeasurementUnitWeight)`](../../doc/models/measurement-unit-weight.md) | Optional | Unit of weight used to measure a quantity. | getWeightUnit(): ?string | setWeightUnit(?string weightUnit): void |
-| `genericUnit` | [`?string(MeasurementUnitGeneric)`](../../doc/models/measurement-unit-generic.md) | Optional | - | getGenericUnit(): ?string | setGenericUnit(?string genericUnit): void |
-| `timeUnit` | [`?string(MeasurementUnitTime)`](../../doc/models/measurement-unit-time.md) | Optional | Unit of time used to measure a quantity (a duration). | getTimeUnit(): ?string | setTimeUnit(?string timeUnit): void |
-| `type` | [`?string(MeasurementUnitUnitType)`](../../doc/models/measurement-unit-unit-type.md) | Optional | Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum. | getType(): ?string | setType(?string type): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_SQUARE_MILE",
- "length_unit": "METRIC_MILLIMETER",
- "volume_unit": "IMPERIAL_CUBIC_INCH",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
-}
-```
-
diff --git a/doc/models/merchant-status.md b/doc/models/merchant-status.md
deleted file mode 100644
index 9e3e199d..00000000
--- a/doc/models/merchant-status.md
+++ /dev/null
@@ -1,14 +0,0 @@
-
-# Merchant Status
-
-## Enumeration
-
-`MerchantStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ACTIVE` | A fully operational merchant account. The merchant can interact with Square products and APIs. |
-| `INACTIVE` | A functionally limited merchant account. The merchant can only have limited interaction
via Square APIs. The merchant cannot log in or access the seller dashboard. |
-
diff --git a/doc/models/merchant.md b/doc/models/merchant.md
deleted file mode 100644
index 811660a7..00000000
--- a/doc/models/merchant.md
+++ /dev/null
@@ -1,35 +0,0 @@
-
-# Merchant
-
-Represents a business that sells with Square.
-
-## Structure
-
-`Merchant`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The Square-issued ID of the merchant. | getId(): ?string | setId(?string id): void |
-| `businessName` | `?string` | Optional | The name of the merchant's overall business. | getBusinessName(): ?string | setBusinessName(?string businessName): void |
-| `country` | [`string(Country)`](../../doc/models/country.md) | Required | Indicates the country associated with another entity, such as a business.
Values are in [ISO 3166-1-alpha-2 format](http://www.iso.org/iso/home/standards/country_codes.htm). | getCountry(): string | setCountry(string country): void |
-| `languageCode` | `?string` | Optional | The code indicating the [language preferences](https://developer.squareup.com/docs/build-basics/general-considerations/language-preferences) of the merchant, in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A). For example, `en-US` or `fr-CA`. | getLanguageCode(): ?string | setLanguageCode(?string languageCode): void |
-| `currency` | [`?string(Currency)`](../../doc/models/currency.md) | Optional | Indicates the associated currency for an amount of money. Values correspond
to [ISO 4217](https://wikipedia.org/wiki/ISO_4217). | getCurrency(): ?string | setCurrency(?string currency): void |
-| `status` | [`?string(MerchantStatus)`](../../doc/models/merchant-status.md) | Optional | - | getStatus(): ?string | setStatus(?string status): void |
-| `mainLocationId` | `?string` | Optional | The ID of the [main `Location`](https://developer.squareup.com/docs/locations-api#about-the-main-location) for this merchant. | getMainLocationId(): ?string | setMainLocationId(?string mainLocationId): void |
-| `createdAt` | `?string` | Optional | The time when the merchant was created, in RFC 3339 format.
For more information, see [Working with Dates](https://developer.squareup.com/docs/build-basics/working-with-dates). | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id2",
- "business_name": "business_name6",
- "country": "HM",
- "language_code": "language_code0",
- "currency": "BTC",
- "status": "ACTIVE"
-}
-```
-
diff --git a/doc/models/modifier-location-overrides.md b/doc/models/modifier-location-overrides.md
deleted file mode 100644
index d1e6bebd..00000000
--- a/doc/models/modifier-location-overrides.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Modifier Location Overrides
-
-Location-specific overrides for specified properties of a `CatalogModifier` object.
-
-## Structure
-
-`ModifierLocationOverrides`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationId` | `?string` | Optional | The ID of the `Location` object representing the location. This can include a deactivated location. | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `priceMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getPriceMoney(): ?Money | setPriceMoney(?Money priceMoney): void |
-| `soldOut` | `?bool` | Optional | Indicates whether the modifier is sold out at the specified location or not. As an example, for cheese (modifier) burger (item), when the modifier is sold out, it is the cheese, but not the burger, that is sold out.
The seller can manually set this sold out status. Attempts by an application to set this attribute are ignored. | getSoldOut(): ?bool | setSoldOut(?bool soldOut): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_id": "location_id2",
- "price_money": {
- "amount": 202,
- "currency": "GTQ"
- },
- "sold_out": false
-}
-```
-
diff --git a/doc/models/money.md b/doc/models/money.md
deleted file mode 100644
index 3e7a795f..00000000
--- a/doc/models/money.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Money
-
-Represents an amount of money. `Money` fields can be signed or unsigned.
-Fields that do not explicitly define whether they are signed or unsigned are
-considered unsigned and can only hold positive amounts. For signed fields, the
-sign of the value indicates the purpose of the money transfer. See
-[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
-for more information.
-
-## Structure
-
-`Money`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `amount` | `?int` | Optional | The amount of money, in the smallest denomination of the currency
indicated by `currency`. For example, when `currency` is `USD`, `amount` is
in cents. Monetary amounts can be positive or negative. See the specific
field description to determine the meaning of the sign in a particular case. | getAmount(): ?int | setAmount(?int amount): void |
-| `currency` | [`?string(Currency)`](../../doc/models/currency.md) | Optional | Indicates the associated currency for an amount of money. Values correspond
to [ISO 4217](https://wikipedia.org/wiki/ISO_4217). | getCurrency(): ?string | setCurrency(?string currency): void |
-
-## Example (as JSON)
-
-```json
-{
- "amount": 36,
- "currency": "AZN"
-}
-```
-
diff --git a/doc/models/obtain-token-request.md b/doc/models/obtain-token-request.md
deleted file mode 100644
index bb46eff5..00000000
--- a/doc/models/obtain-token-request.md
+++ /dev/null
@@ -1,36 +0,0 @@
-
-# Obtain Token Request
-
-## Structure
-
-`ObtainTokenRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `clientId` | `string` | Required | The Square-issued ID of your application, which is available on the **OAuth** page in the
[Developer Dashboard](https://developer.squareup.com/apps).
**Constraints**: *Maximum Length*: `191` | getClientId(): string | setClientId(string clientId): void |
-| `clientSecret` | `?string` | Optional | The Square-issued application secret for your application, which is available on the **OAuth** page
in the [Developer Dashboard](https://developer.squareup.com/apps). This parameter is only required when
you're not using the [OAuth PKCE (Proof Key for Code Exchange) flow](https://developer.squareup.com/docs/oauth-api/overview#pkce-flow).
The PKCE flow requires a `code_verifier` instead of a `client_secret` when `grant_type` is set to `authorization_code`.
If `grant_type` is set to `refresh_token` and the `refresh_token` is obtained uaing PKCE, the PKCE flow only requires `client_id`,
`grant_type`, and `refresh_token`.
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `1024` | getClientSecret(): ?string | setClientSecret(?string clientSecret): void |
-| `code` | `?string` | Optional | The authorization code to exchange.
This code is required if `grant_type` is set to `authorization_code` to indicate that
the application wants to exchange an authorization code for an OAuth access token.
**Constraints**: *Maximum Length*: `191` | getCode(): ?string | setCode(?string code): void |
-| `redirectUri` | `?string` | Optional | The redirect URL assigned on the **OAuth** page for your application in the [Developer Dashboard](https://developer.squareup.com/apps).
**Constraints**: *Maximum Length*: `2048` | getRedirectUri(): ?string | setRedirectUri(?string redirectUri): void |
-| `grantType` | `string` | Required | Specifies the method to request an OAuth access token.
Valid values are `authorization_code`, `refresh_token`, and `migration_token`.
**Constraints**: *Minimum Length*: `10`, *Maximum Length*: `20` | getGrantType(): string | setGrantType(string grantType): void |
-| `refreshToken` | `?string` | Optional | A valid refresh token for generating a new OAuth access token.
A valid refresh token is required if `grant_type` is set to `refresh_token`
to indicate that the application wants a replacement for an expired OAuth access token.
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `1024` | getRefreshToken(): ?string | setRefreshToken(?string refreshToken): void |
-| `migrationToken` | `?string` | Optional | A legacy OAuth access token obtained using a Connect API version prior
to 2019-03-13. This parameter is required if `grant_type` is set to
`migration_token` to indicate that the application wants to get a replacement
OAuth access token. The response also returns a refresh token.
For more information, see [Migrate to Using Refresh Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens).
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `1024` | getMigrationToken(): ?string | setMigrationToken(?string migrationToken): void |
-| `scopes` | `?(string[])` | Optional | A JSON list of strings representing the permissions that the application is requesting.
For example, "`["MERCHANT_PROFILE_READ","PAYMENTS_READ","BANK_ACCOUNTS_READ"]`".
The access token returned in the response is granted the permissions
that comprise the intersection between the requested list of permissions and those
that belong to the provided refresh token. | getScopes(): ?array | setScopes(?array scopes): void |
-| `shortLived` | `?bool` | Optional | A Boolean indicating a request for a short-lived access token.
The short-lived access token returned in the response expires in 24 hours. | getShortLived(): ?bool | setShortLived(?bool shortLived): void |
-| `codeVerifier` | `?string` | Optional | Must be provided when using the PKCE OAuth flow if `grant_type` is set to `authorization_code`. The `code_verifier` is used to verify against the
`code_challenge` associated with the `authorization_code`. | getCodeVerifier(): ?string | setCodeVerifier(?string codeVerifier): void |
-
-## Example (as JSON)
-
-```json
-{
- "client_id": "APPLICATION_ID",
- "client_secret": "APPLICATION_SECRET",
- "code": "CODE_FROM_AUTHORIZE",
- "grant_type": "authorization_code",
- "redirect_uri": "redirect_uri6",
- "refresh_token": "refresh_token8",
- "migration_token": "migration_token6"
-}
-```
-
diff --git a/doc/models/obtain-token-response.md b/doc/models/obtain-token-response.md
deleted file mode 100644
index 00a7a931..00000000
--- a/doc/models/obtain-token-response.md
+++ /dev/null
@@ -1,36 +0,0 @@
-
-# Obtain Token Response
-
-## Structure
-
-`ObtainTokenResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `accessToken` | `?string` | Optional | A valid OAuth access token.
Provide the access token in a header with every request to Connect API
endpoints. For more information, see [OAuth API: Walkthrough](https://developer.squareup.com/docs/oauth-api/walkthrough).
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `1024` | getAccessToken(): ?string | setAccessToken(?string accessToken): void |
-| `tokenType` | `?string` | Optional | This value is always _bearer_.
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `10` | getTokenType(): ?string | setTokenType(?string tokenType): void |
-| `expiresAt` | `?string` | Optional | The date when the `access_token` expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.
**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `48` | getExpiresAt(): ?string | setExpiresAt(?string expiresAt): void |
-| `merchantId` | `?string` | Optional | The ID of the authorizing merchant's business.
**Constraints**: *Minimum Length*: `8`, *Maximum Length*: `191` | getMerchantId(): ?string | setMerchantId(?string merchantId): void |
-| `subscriptionId` | `?string` | Optional | __LEGACY FIELD__. The ID of a subscription plan the merchant signed up
for. The ID is only present if the merchant signed up for a subscription plan during authorization. | getSubscriptionId(): ?string | setSubscriptionId(?string subscriptionId): void |
-| `planId` | `?string` | Optional | __LEGACY FIELD__. The ID of the subscription plan the merchant signed
up for. The ID is only present if the merchant signed up for a subscription plan during
authorization. | getPlanId(): ?string | setPlanId(?string planId): void |
-| `idToken` | `?string` | Optional | The OpenID token belonging to this person. This token is only present if the
OPENID scope is included in the authorization request. | getIdToken(): ?string | setIdToken(?string idToken): void |
-| `refreshToken` | `?string` | Optional | A refresh token.
For more information, see [Refresh, Revoke, and Limit the Scope of OAuth Tokens](https://developer.squareup.com/docs/oauth-api/refresh-revoke-limit-scope).
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `1024` | getRefreshToken(): ?string | setRefreshToken(?string refreshToken): void |
-| `shortLived` | `?bool` | Optional | A Boolean indicating that the access token is a short-lived access token.
The short-lived access token returned in the response expires in 24 hours. | getShortLived(): ?bool | setShortLived(?bool shortLived): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `refreshTokenExpiresAt` | `?string` | Optional | The date when the `refresh_token` expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.
**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `48` | getRefreshTokenExpiresAt(): ?string | setRefreshTokenExpiresAt(?string refreshTokenExpiresAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "access_token": "ACCESS_TOKEN",
- "expires_at": "2006-01-02T15:04:05Z",
- "merchant_id": "MERCHANT_ID",
- "refresh_token": "REFRESH_TOKEN",
- "token_type": "bearer",
- "subscription_id": "subscription_id8"
-}
-```
-
diff --git a/doc/models/offline-payment-details.md b/doc/models/offline-payment-details.md
deleted file mode 100644
index 0a43a74c..00000000
--- a/doc/models/offline-payment-details.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Offline Payment Details
-
-Details specific to offline payments.
-
-## Structure
-
-`OfflinePaymentDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `clientCreatedAt` | `?string` | Optional | The client-side timestamp of when the offline payment was created, in RFC 3339 format.
**Constraints**: *Maximum Length*: `32` | getClientCreatedAt(): ?string | setClientCreatedAt(?string clientCreatedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "client_created_at": "client_created_at6"
-}
-```
-
diff --git a/doc/models/order-created-object.md b/doc/models/order-created-object.md
deleted file mode 100644
index c6160cd6..00000000
--- a/doc/models/order-created-object.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Order Created Object
-
-## Structure
-
-`OrderCreatedObject`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `orderCreated` | [`?OrderCreated`](../../doc/models/order-created.md) | Optional | - | getOrderCreated(): ?OrderCreated | setOrderCreated(?OrderCreated orderCreated): void |
-
-## Example (as JSON)
-
-```json
-{
- "order_created": {
- "order_id": "order_id8",
- "version": 170,
- "location_id": "location_id8",
- "state": "CANCELED",
- "created_at": "created_at2"
- }
-}
-```
-
diff --git a/doc/models/order-created.md b/doc/models/order-created.md
deleted file mode 100644
index 715b4255..00000000
--- a/doc/models/order-created.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Order Created
-
-## Structure
-
-`OrderCreated`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `orderId` | `?string` | Optional | The order's unique ID. | getOrderId(): ?string | setOrderId(?string orderId): void |
-| `version` | `?int` | Optional | The version number, which is incremented each time an update is committed to the order.
Orders that were not created through the API do not include a version number and
therefore cannot be updated.
[Read more about working with versions.](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders) | getVersion(): ?int | setVersion(?int version): void |
-| `locationId` | `?string` | Optional | The ID of the seller location that this order is associated with. | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `state` | [`?string(OrderState)`](../../doc/models/order-state.md) | Optional | The state of the order. | getState(): ?string | setState(?string state): void |
-| `createdAt` | `?string` | Optional | The timestamp for when the order was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "order_id": "order_id8",
- "version": 86,
- "location_id": "location_id8",
- "state": "CANCELED",
- "created_at": "created_at2"
-}
-```
-
diff --git a/doc/models/order-entry.md b/doc/models/order-entry.md
deleted file mode 100644
index f19be1cd..00000000
--- a/doc/models/order-entry.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# Order Entry
-
-A lightweight description of an [order](../../doc/models/order.md) that is returned when
-`returned_entries` is `true` on a [SearchOrdersRequest](../../doc/apis/orders.md#search-orders).
-
-## Structure
-
-`OrderEntry`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `orderId` | `?string` | Optional | The ID of the order. | getOrderId(): ?string | setOrderId(?string orderId): void |
-| `version` | `?int` | Optional | The version number, which is incremented each time an update is committed to the order.
Orders that were not created through the API do not include a version number and
therefore cannot be updated.
[Read more about working with versions.](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders) | getVersion(): ?int | setVersion(?int version): void |
-| `locationId` | `?string` | Optional | The location ID the order belongs to. | getLocationId(): ?string | setLocationId(?string locationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "order_id": "order_id0",
- "version": 72,
- "location_id": "location_id0"
-}
-```
-
diff --git a/doc/models/order-fulfillment-delivery-details-schedule-type.md b/doc/models/order-fulfillment-delivery-details-schedule-type.md
deleted file mode 100644
index 31e92720..00000000
--- a/doc/models/order-fulfillment-delivery-details-schedule-type.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Order Fulfillment Delivery Details Schedule Type
-
-The schedule type of the delivery fulfillment.
-
-## Enumeration
-
-`OrderFulfillmentDeliveryDetailsScheduleType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `SCHEDULED` | Indicates the fulfillment to deliver at a scheduled deliver time. |
-| `ASAP` | Indicates that the fulfillment to deliver as soon as possible and should be prepared
immediately. |
-
diff --git a/doc/models/order-fulfillment-delivery-details.md b/doc/models/order-fulfillment-delivery-details.md
deleted file mode 100644
index 07aab339..00000000
--- a/doc/models/order-fulfillment-delivery-details.md
+++ /dev/null
@@ -1,61 +0,0 @@
-
-# Order Fulfillment Delivery Details
-
-Describes delivery details of an order fulfillment.
-
-## Structure
-
-`OrderFulfillmentDeliveryDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `recipient` | [`?OrderFulfillmentRecipient`](../../doc/models/order-fulfillment-recipient.md) | Optional | Information about the fulfillment recipient. | getRecipient(): ?OrderFulfillmentRecipient | setRecipient(?OrderFulfillmentRecipient recipient): void |
-| `scheduleType` | [`?string(OrderFulfillmentDeliveryDetailsScheduleType)`](../../doc/models/order-fulfillment-delivery-details-schedule-type.md) | Optional | The schedule type of the delivery fulfillment. | getScheduleType(): ?string | setScheduleType(?string scheduleType): void |
-| `placedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was placed.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z").
Must be in RFC 3339 timestamp format, e.g., "2016-09-04T23:59:33.123Z". | getPlacedAt(): ?string | setPlacedAt(?string placedAt): void |
-| `deliverAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
that represents the start of the delivery period.
When the fulfillment `schedule_type` is `ASAP`, the field is automatically
set to the current time plus the `prep_time_duration`.
Otherwise, the application can set this field while the fulfillment `state` is
`PROPOSED`, `RESERVED`, or `PREPARED` (any time before the
terminal state such as `COMPLETED`, `CANCELED`, and `FAILED`).
The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getDeliverAt(): ?string | setDeliverAt(?string deliverAt): void |
-| `prepTimeDuration` | `?string` | Optional | The duration of time it takes to prepare and deliver this fulfillment.
The duration must be in RFC 3339 format (for example, "P1W3D"). | getPrepTimeDuration(): ?string | setPrepTimeDuration(?string prepTimeDuration): void |
-| `deliveryWindowDuration` | `?string` | Optional | The time period after `deliver_at` in which to deliver the order.
Applications can set this field when the fulfillment `state` is
`PROPOSED`, `RESERVED`, or `PREPARED` (any time before the terminal state
such as `COMPLETED`, `CANCELED`, and `FAILED`).
The duration must be in RFC 3339 format (for example, "P1W3D"). | getDeliveryWindowDuration(): ?string | setDeliveryWindowDuration(?string deliveryWindowDuration): void |
-| `note` | `?string` | Optional | Provides additional instructions about the delivery fulfillment.
It is displayed in the Square Point of Sale application and set by the API.
**Constraints**: *Maximum Length*: `550` | getNote(): ?string | setNote(?string note): void |
-| `completedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicates when the seller completed the fulfillment.
This field is automatically set when fulfillment `state` changes to `COMPLETED`.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getCompletedAt(): ?string | setCompletedAt(?string completedAt): void |
-| `inProgressAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicates when the seller started processing the fulfillment.
This field is automatically set when the fulfillment `state` changes to `RESERVED`.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getInProgressAt(): ?string | setInProgressAt(?string inProgressAt): void |
-| `rejectedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was rejected. This field is
automatically set when the fulfillment `state` changes to `FAILED`.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getRejectedAt(): ?string | setRejectedAt(?string rejectedAt): void |
-| `readyAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the seller marked the fulfillment as ready for
courier pickup. This field is automatically set when the fulfillment `state` changes
to PREPARED.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getReadyAt(): ?string | setReadyAt(?string readyAt): void |
-| `deliveredAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was delivered to the recipient.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getDeliveredAt(): ?string | setDeliveredAt(?string deliveredAt): void |
-| `canceledAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was canceled. This field is automatically
set when the fulfillment `state` changes to `CANCELED`.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getCanceledAt(): ?string | setCanceledAt(?string canceledAt): void |
-| `cancelReason` | `?string` | Optional | The delivery cancellation reason. Max length: 100 characters.
**Constraints**: *Maximum Length*: `100` | getCancelReason(): ?string | setCancelReason(?string cancelReason): void |
-| `courierPickupAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when an order can be picked up by the courier for delivery.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getCourierPickupAt(): ?string | setCourierPickupAt(?string courierPickupAt): void |
-| `courierPickupWindowDuration` | `?string` | Optional | The time period after `courier_pickup_at` in which the courier should pick up the order.
The duration must be in RFC 3339 format (for example, "P1W3D"). | getCourierPickupWindowDuration(): ?string | setCourierPickupWindowDuration(?string courierPickupWindowDuration): void |
-| `isNoContactDelivery` | `?bool` | Optional | Whether the delivery is preferred to be no contact. | getIsNoContactDelivery(): ?bool | setIsNoContactDelivery(?bool isNoContactDelivery): void |
-| `dropoffNotes` | `?string` | Optional | A note to provide additional instructions about how to deliver the order.
**Constraints**: *Maximum Length*: `550` | getDropoffNotes(): ?string | setDropoffNotes(?string dropoffNotes): void |
-| `courierProviderName` | `?string` | Optional | The name of the courier provider.
**Constraints**: *Maximum Length*: `255` | getCourierProviderName(): ?string | setCourierProviderName(?string courierProviderName): void |
-| `courierSupportPhoneNumber` | `?string` | Optional | The support phone number of the courier.
**Constraints**: *Maximum Length*: `17` | getCourierSupportPhoneNumber(): ?string | setCourierSupportPhoneNumber(?string courierSupportPhoneNumber): void |
-| `squareDeliveryId` | `?string` | Optional | The identifier for the delivery created by Square.
**Constraints**: *Maximum Length*: `50` | getSquareDeliveryId(): ?string | setSquareDeliveryId(?string squareDeliveryId): void |
-| `externalDeliveryId` | `?string` | Optional | The identifier for the delivery created by the third-party courier service.
**Constraints**: *Maximum Length*: `50` | getExternalDeliveryId(): ?string | setExternalDeliveryId(?string externalDeliveryId): void |
-| `managedDelivery` | `?bool` | Optional | The flag to indicate the delivery is managed by a third party (ie DoorDash), which means
we may not receive all recipient information for PII purposes. | getManagedDelivery(): ?bool | setManagedDelivery(?bool managedDelivery): void |
-
-## Example (as JSON)
-
-```json
-{
- "recipient": {
- "customer_id": "customer_id6",
- "display_name": "display_name8",
- "email_address": "email_address4",
- "phone_number": "phone_number4",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- },
- "schedule_type": "SCHEDULED",
- "placed_at": "placed_at6",
- "deliver_at": "deliver_at2",
- "prep_time_duration": "prep_time_duration6"
-}
-```
-
diff --git a/doc/models/order-fulfillment-fulfillment-entry.md b/doc/models/order-fulfillment-fulfillment-entry.md
deleted file mode 100644
index 421b7ce1..00000000
--- a/doc/models/order-fulfillment-fulfillment-entry.md
+++ /dev/null
@@ -1,35 +0,0 @@
-
-# Order Fulfillment Fulfillment Entry
-
-Links an order line item to a fulfillment. Each entry must reference
-a valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to
-fulfill.
-
-## Structure
-
-`OrderFulfillmentFulfillmentEntry`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the fulfillment entry only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `lineItemUid` | `string` | Required | The `uid` from the order line item.
**Constraints**: *Minimum Length*: `1` | getLineItemUid(): string | setLineItemUid(string lineItemUid): void |
-| `quantity` | `string` | Required | The quantity of the line item being fulfilled, formatted as a decimal number.
For example, `"3"`.
Fulfillments for line items with a `quantity_unit` can have non-integer quantities.
For example, `"1.70000"`.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `12` | getQuantity(): string | setQuantity(string quantity): void |
-| `metadata` | `?array` | Optional | Application-defined data attached to this fulfillment entry. Metadata fields are intended
to store descriptive references or associations with an entity in another system or store brief
information about the object. Square does not process this field; it only stores and returns it
in relevant API calls. Do not use metadata to store any sensitive information (such as personally
identifiable information or card details).
Keys written by applications must be 60 characters or less and must be in the character set
`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed
with a namespace, separated from the key with a ':' character.
Values have a maximum length of 255 characters.
An application can have up to 10 entries per metadata field.
Entries written by applications are private and can only be read or modified by the same
application.
For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). | getMetadata(): ?array | setMetadata(?array metadata): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid6",
- "line_item_uid": "line_item_uid6",
- "quantity": "quantity2",
- "metadata": {
- "key0": "metadata7",
- "key1": "metadata8",
- "key2": "metadata9"
- }
-}
-```
-
diff --git a/doc/models/order-fulfillment-fulfillment-line-item-application.md b/doc/models/order-fulfillment-fulfillment-line-item-application.md
deleted file mode 100644
index 41268cb5..00000000
--- a/doc/models/order-fulfillment-fulfillment-line-item-application.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Order Fulfillment Fulfillment Line Item Application
-
-The `line_item_application` describes what order line items this fulfillment applies
-to. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries.
-
-## Enumeration
-
-`OrderFulfillmentFulfillmentLineItemApplication`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ALL` | If `ALL`, `entries` must be unset. |
-| `ENTRY_LIST` | If `ENTRY_LIST`, supply a list of `entries`. |
-
diff --git a/doc/models/order-fulfillment-pickup-details-curbside-pickup-details.md b/doc/models/order-fulfillment-pickup-details-curbside-pickup-details.md
deleted file mode 100644
index d68e74ba..00000000
--- a/doc/models/order-fulfillment-pickup-details-curbside-pickup-details.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Order Fulfillment Pickup Details Curbside Pickup Details
-
-Specific details for curbside pickup.
-
-## Structure
-
-`OrderFulfillmentPickupDetailsCurbsidePickupDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `curbsideDetails` | `?string` | Optional | Specific details for curbside pickup, such as parking number and vehicle model.
**Constraints**: *Maximum Length*: `250` | getCurbsideDetails(): ?string | setCurbsideDetails(?string curbsideDetails): void |
-| `buyerArrivedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the buyer arrived and is waiting for pickup. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getBuyerArrivedAt(): ?string | setBuyerArrivedAt(?string buyerArrivedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "curbside_details": "curbside_details8",
- "buyer_arrived_at": "buyer_arrived_at4"
-}
-```
-
diff --git a/doc/models/order-fulfillment-pickup-details-schedule-type.md b/doc/models/order-fulfillment-pickup-details-schedule-type.md
deleted file mode 100644
index 6e774d4a..00000000
--- a/doc/models/order-fulfillment-pickup-details-schedule-type.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Order Fulfillment Pickup Details Schedule Type
-
-The schedule type of the pickup fulfillment.
-
-## Enumeration
-
-`OrderFulfillmentPickupDetailsScheduleType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `SCHEDULED` | Indicates that the fulfillment will be picked up at a scheduled pickup time. |
-| `ASAP` | Indicates that the fulfillment will be picked up as soon as possible and
should be prepared immediately. |
-
diff --git a/doc/models/order-fulfillment-pickup-details.md b/doc/models/order-fulfillment-pickup-details.md
deleted file mode 100644
index 9dcc6db7..00000000
--- a/doc/models/order-fulfillment-pickup-details.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Order Fulfillment Pickup Details
-
-Contains details necessary to fulfill a pickup order.
-
-## Structure
-
-`OrderFulfillmentPickupDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `recipient` | [`?OrderFulfillmentRecipient`](../../doc/models/order-fulfillment-recipient.md) | Optional | Information about the fulfillment recipient. | getRecipient(): ?OrderFulfillmentRecipient | setRecipient(?OrderFulfillmentRecipient recipient): void |
-| `expiresAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when this fulfillment expires if it is not marked in progress. The timestamp must be
in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). The expiration time can only be set
up to 7 days in the future. If `expires_at` is not set, any new payments attached to the order
are automatically completed. | getExpiresAt(): ?string | setExpiresAt(?string expiresAt): void |
-| `autoCompleteDuration` | `?string` | Optional | The duration of time after which an in progress pickup fulfillment is automatically moved
to the `COMPLETED` state. The duration must be in RFC 3339 format (for example, "P1W3D").
If not set, this pickup fulfillment remains in progress until it is canceled or completed. | getAutoCompleteDuration(): ?string | setAutoCompleteDuration(?string autoCompleteDuration): void |
-| `scheduleType` | [`?string(OrderFulfillmentPickupDetailsScheduleType)`](../../doc/models/order-fulfillment-pickup-details-schedule-type.md) | Optional | The schedule type of the pickup fulfillment. | getScheduleType(): ?string | setScheduleType(?string scheduleType): void |
-| `pickupAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
that represents the start of the pickup window. Must be in RFC 3339 timestamp format, e.g.,
"2016-09-04T23:59:33.123Z".
For fulfillments with the schedule type `ASAP`, this is automatically set
to the current time plus the expected duration to prepare the fulfillment. | getPickupAt(): ?string | setPickupAt(?string pickupAt): void |
-| `pickupWindowDuration` | `?string` | Optional | The window of time in which the order should be picked up after the `pickup_at` timestamp.
Must be in RFC 3339 duration format, e.g., "P1W3D". Can be used as an
informational guideline for merchants. | getPickupWindowDuration(): ?string | setPickupWindowDuration(?string pickupWindowDuration): void |
-| `prepTimeDuration` | `?string` | Optional | The duration of time it takes to prepare this fulfillment.
The duration must be in RFC 3339 format (for example, "P1W3D"). | getPrepTimeDuration(): ?string | setPrepTimeDuration(?string prepTimeDuration): void |
-| `note` | `?string` | Optional | A note to provide additional instructions about the pickup
fulfillment displayed in the Square Point of Sale application and set by the API.
**Constraints**: *Maximum Length*: `500` | getNote(): ?string | setNote(?string note): void |
-| `placedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was placed. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getPlacedAt(): ?string | setPlacedAt(?string placedAt): void |
-| `acceptedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was marked in progress. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getAcceptedAt(): ?string | setAcceptedAt(?string acceptedAt): void |
-| `rejectedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was rejected. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getRejectedAt(): ?string | setRejectedAt(?string rejectedAt): void |
-| `readyAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment is marked as ready for pickup. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getReadyAt(): ?string | setReadyAt(?string readyAt): void |
-| `expiredAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment expired. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getExpiredAt(): ?string | setExpiredAt(?string expiredAt): void |
-| `pickedUpAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was picked up by the recipient. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getPickedUpAt(): ?string | setPickedUpAt(?string pickedUpAt): void |
-| `canceledAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the fulfillment was canceled. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getCanceledAt(): ?string | setCanceledAt(?string canceledAt): void |
-| `cancelReason` | `?string` | Optional | A description of why the pickup was canceled. The maximum length: 100 characters.
**Constraints**: *Maximum Length*: `100` | getCancelReason(): ?string | setCancelReason(?string cancelReason): void |
-| `isCurbsidePickup` | `?bool` | Optional | If set to `true`, indicates that this pickup order is for curbside pickup, not in-store pickup. | getIsCurbsidePickup(): ?bool | setIsCurbsidePickup(?bool isCurbsidePickup): void |
-| `curbsidePickupDetails` | [`?OrderFulfillmentPickupDetailsCurbsidePickupDetails`](../../doc/models/order-fulfillment-pickup-details-curbside-pickup-details.md) | Optional | Specific details for curbside pickup. | getCurbsidePickupDetails(): ?OrderFulfillmentPickupDetailsCurbsidePickupDetails | setCurbsidePickupDetails(?OrderFulfillmentPickupDetailsCurbsidePickupDetails curbsidePickupDetails): void |
-
-## Example (as JSON)
-
-```json
-{
- "recipient": {
- "customer_id": "customer_id6",
- "display_name": "display_name8",
- "email_address": "email_address4",
- "phone_number": "phone_number4",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- },
- "expires_at": "expires_at0",
- "auto_complete_duration": "auto_complete_duration0",
- "schedule_type": "SCHEDULED",
- "pickup_at": "pickup_at8"
-}
-```
-
diff --git a/doc/models/order-fulfillment-recipient.md b/doc/models/order-fulfillment-recipient.md
deleted file mode 100644
index a627125c..00000000
--- a/doc/models/order-fulfillment-recipient.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-# Order Fulfillment Recipient
-
-Information about the fulfillment recipient.
-
-## Structure
-
-`OrderFulfillmentRecipient`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customerId` | `?string` | Optional | The ID of the customer associated with the fulfillment.
If `customer_id` is provided, the fulfillment recipient's `display_name`,
`email_address`, and `phone_number` are automatically populated from the
targeted customer profile. If these fields are set in the request, the request
values override the information from the customer profile. If the
targeted customer profile does not contain the necessary information and
these fields are left unset, the request results in an error.
**Constraints**: *Maximum Length*: `191` | getCustomerId(): ?string | setCustomerId(?string customerId): void |
-| `displayName` | `?string` | Optional | The display name of the fulfillment recipient. This field is required.
If provided, the display name overrides the corresponding customer profile value
indicated by `customer_id`.
**Constraints**: *Maximum Length*: `255` | getDisplayName(): ?string | setDisplayName(?string displayName): void |
-| `emailAddress` | `?string` | Optional | The email address of the fulfillment recipient.
If provided, the email address overrides the corresponding customer profile value
indicated by `customer_id`.
**Constraints**: *Maximum Length*: `255` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void |
-| `phoneNumber` | `?string` | Optional | The phone number of the fulfillment recipient. This field is required.
If provided, the phone number overrides the corresponding customer profile value
indicated by `customer_id`.
**Constraints**: *Maximum Length*: `17` | getPhoneNumber(): ?string | setPhoneNumber(?string phoneNumber): void |
-| `address` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getAddress(): ?Address | setAddress(?Address address): void |
-
-## Example (as JSON)
-
-```json
-{
- "customer_id": "customer_id0",
- "display_name": "display_name2",
- "email_address": "email_address0",
- "phone_number": "phone_number0",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
-}
-```
-
diff --git a/doc/models/order-fulfillment-shipment-details.md b/doc/models/order-fulfillment-shipment-details.md
deleted file mode 100644
index 330b968f..00000000
--- a/doc/models/order-fulfillment-shipment-details.md
+++ /dev/null
@@ -1,53 +0,0 @@
-
-# Order Fulfillment Shipment Details
-
-Contains the details necessary to fulfill a shipment order.
-
-## Structure
-
-`OrderFulfillmentShipmentDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `recipient` | [`?OrderFulfillmentRecipient`](../../doc/models/order-fulfillment-recipient.md) | Optional | Information about the fulfillment recipient. | getRecipient(): ?OrderFulfillmentRecipient | setRecipient(?OrderFulfillmentRecipient recipient): void |
-| `carrier` | `?string` | Optional | The shipping carrier being used to ship this fulfillment (such as UPS, FedEx, or USPS).
**Constraints**: *Maximum Length*: `50` | getCarrier(): ?string | setCarrier(?string carrier): void |
-| `shippingNote` | `?string` | Optional | A note with additional information for the shipping carrier.
**Constraints**: *Maximum Length*: `500` | getShippingNote(): ?string | setShippingNote(?string shippingNote): void |
-| `shippingType` | `?string` | Optional | A description of the type of shipping product purchased from the carrier
(such as First Class, Priority, or Express).
**Constraints**: *Maximum Length*: `50` | getShippingType(): ?string | setShippingType(?string shippingType): void |
-| `trackingNumber` | `?string` | Optional | The reference number provided by the carrier to track the shipment's progress.
**Constraints**: *Maximum Length*: `100` | getTrackingNumber(): ?string | setTrackingNumber(?string trackingNumber): void |
-| `trackingUrl` | `?string` | Optional | A link to the tracking webpage on the carrier's website.
**Constraints**: *Maximum Length*: `2000` | getTrackingUrl(): ?string | setTrackingUrl(?string trackingUrl): void |
-| `placedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the shipment was requested. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getPlacedAt(): ?string | setPlacedAt(?string placedAt): void |
-| `inProgressAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when this fulfillment was moved to the `RESERVED` state, which indicates that preparation
of this shipment has begun. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getInProgressAt(): ?string | setInProgressAt(?string inProgressAt): void |
-| `packagedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when this fulfillment was moved to the `PREPARED` state, which indicates that the
fulfillment is packaged. The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getPackagedAt(): ?string | setPackagedAt(?string packagedAt): void |
-| `expectedShippedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the shipment is expected to be delivered to the shipping carrier.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getExpectedShippedAt(): ?string | setExpectedShippedAt(?string expectedShippedAt): void |
-| `shippedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when this fulfillment was moved to the `COMPLETED` state, which indicates that
the fulfillment has been given to the shipping carrier. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getShippedAt(): ?string | setShippedAt(?string shippedAt): void |
-| `canceledAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating the shipment was canceled.
The timestamp must be in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getCanceledAt(): ?string | setCanceledAt(?string canceledAt): void |
-| `cancelReason` | `?string` | Optional | A description of why the shipment was canceled.
**Constraints**: *Maximum Length*: `100` | getCancelReason(): ?string | setCancelReason(?string cancelReason): void |
-| `failedAt` | `?string` | Optional | The [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates)
indicating when the shipment failed to be completed. The timestamp must be in RFC 3339 format
(for example, "2016-09-04T23:59:33.123Z"). | getFailedAt(): ?string | setFailedAt(?string failedAt): void |
-| `failureReason` | `?string` | Optional | A description of why the shipment failed to be completed.
**Constraints**: *Maximum Length*: `100` | getFailureReason(): ?string | setFailureReason(?string failureReason): void |
-
-## Example (as JSON)
-
-```json
-{
- "recipient": {
- "customer_id": "customer_id6",
- "display_name": "display_name8",
- "email_address": "email_address4",
- "phone_number": "phone_number4",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- },
- "carrier": "carrier4",
- "shipping_note": "shipping_note8",
- "shipping_type": "shipping_type4",
- "tracking_number": "tracking_number0"
-}
-```
-
diff --git a/doc/models/order-fulfillment-state.md b/doc/models/order-fulfillment-state.md
deleted file mode 100644
index 0885e821..00000000
--- a/doc/models/order-fulfillment-state.md
+++ /dev/null
@@ -1,20 +0,0 @@
-
-# Order Fulfillment State
-
-The current state of this fulfillment.
-
-## Enumeration
-
-`OrderFulfillmentState`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `PROPOSED` | Indicates that the fulfillment has been proposed. |
-| `RESERVED` | Indicates that the fulfillment has been reserved. |
-| `PREPARED` | Indicates that the fulfillment has been prepared. |
-| `COMPLETED` | Indicates that the fulfillment was successfully completed. |
-| `CANCELED` | Indicates that the fulfillment was canceled. |
-| `FAILED` | Indicates that the fulfillment failed to be completed, but was not explicitly
canceled. |
-
diff --git a/doc/models/order-fulfillment-type.md b/doc/models/order-fulfillment-type.md
deleted file mode 100644
index 7370fba8..00000000
--- a/doc/models/order-fulfillment-type.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Order Fulfillment Type
-
-The type of fulfillment.
-
-## Enumeration
-
-`OrderFulfillmentType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `PICKUP` | A recipient to pick up the fulfillment from a physical [location](../../doc/models/location.md). |
-| `SHIPMENT` | A shipping carrier to ship the fulfillment. |
-| `DELIVERY` | A courier to deliver the fulfillment. |
-
diff --git a/doc/models/order-fulfillment-updated-object.md b/doc/models/order-fulfillment-updated-object.md
deleted file mode 100644
index 4762e7b1..00000000
--- a/doc/models/order-fulfillment-updated-object.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Order Fulfillment Updated Object
-
-## Structure
-
-`OrderFulfillmentUpdatedObject`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `orderFulfillmentUpdated` | [`?OrderFulfillmentUpdated`](../../doc/models/order-fulfillment-updated.md) | Optional | - | getOrderFulfillmentUpdated(): ?OrderFulfillmentUpdated | setOrderFulfillmentUpdated(?OrderFulfillmentUpdated orderFulfillmentUpdated): void |
-
-## Example (as JSON)
-
-```json
-{
- "order_fulfillment_updated": {
- "order_id": "order_id8",
- "version": 174,
- "location_id": "location_id8",
- "state": "CANCELED",
- "created_at": "created_at2"
- }
-}
-```
-
diff --git a/doc/models/order-fulfillment-updated-update.md b/doc/models/order-fulfillment-updated-update.md
deleted file mode 100644
index 6ae5bae1..00000000
--- a/doc/models/order-fulfillment-updated-update.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Order Fulfillment Updated Update
-
-Information about fulfillment updates.
-
-## Structure
-
-`OrderFulfillmentUpdatedUpdate`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `fulfillmentUid` | `?string` | Optional | A unique ID that identifies the fulfillment only within this order. | getFulfillmentUid(): ?string | setFulfillmentUid(?string fulfillmentUid): void |
-| `oldState` | [`?string(FulfillmentState)`](../../doc/models/fulfillment-state.md) | Optional | The current state of this fulfillment. | getOldState(): ?string | setOldState(?string oldState): void |
-| `newState` | [`?string(FulfillmentState)`](../../doc/models/fulfillment-state.md) | Optional | The current state of this fulfillment. | getNewState(): ?string | setNewState(?string newState): void |
-
-## Example (as JSON)
-
-```json
-{
- "fulfillment_uid": "fulfillment_uid6",
- "old_state": "CANCELED",
- "new_state": "PREPARED"
-}
-```
-
diff --git a/doc/models/order-fulfillment-updated.md b/doc/models/order-fulfillment-updated.md
deleted file mode 100644
index a5865703..00000000
--- a/doc/models/order-fulfillment-updated.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Order Fulfillment Updated
-
-## Structure
-
-`OrderFulfillmentUpdated`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `orderId` | `?string` | Optional | The order's unique ID. | getOrderId(): ?string | setOrderId(?string orderId): void |
-| `version` | `?int` | Optional | The version number, which is incremented each time an update is committed to the order.
Orders that were not created through the API do not include a version number and
therefore cannot be updated.
[Read more about working with versions.](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders) | getVersion(): ?int | setVersion(?int version): void |
-| `locationId` | `?string` | Optional | The ID of the seller location that this order is associated with. | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `state` | [`?string(OrderState)`](../../doc/models/order-state.md) | Optional | The state of the order. | getState(): ?string | setState(?string state): void |
-| `createdAt` | `?string` | Optional | The timestamp for when the order was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp for when the order was last updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `fulfillmentUpdate` | [`?(OrderFulfillmentUpdatedUpdate[])`](../../doc/models/order-fulfillment-updated-update.md) | Optional | The fulfillments that were updated with this version change. | getFulfillmentUpdate(): ?array | setFulfillmentUpdate(?array fulfillmentUpdate): void |
-
-## Example (as JSON)
-
-```json
-{
- "order_id": "order_id0",
- "version": 8,
- "location_id": "location_id0",
- "state": "OPEN",
- "created_at": "created_at4"
-}
-```
-
diff --git a/doc/models/order-fulfillment.md b/doc/models/order-fulfillment.md
deleted file mode 100644
index bc7ebfb1..00000000
--- a/doc/models/order-fulfillment.md
+++ /dev/null
@@ -1,68 +0,0 @@
-
-# Order Fulfillment
-
-Contains details about how to fulfill this order.
-Orders can only be created with at most one fulfillment using the API.
-However, orders returned by the Orders API might contain multiple fulfillments because sellers can create multiple fulfillments using Square products such as Square Online.
-
-## Structure
-
-`OrderFulfillment`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the fulfillment only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `type` | [`?string(OrderFulfillmentType)`](../../doc/models/order-fulfillment-type.md) | Optional | The type of fulfillment. | getType(): ?string | setType(?string type): void |
-| `state` | [`?string(OrderFulfillmentState)`](../../doc/models/order-fulfillment-state.md) | Optional | The current state of this fulfillment. | getState(): ?string | setState(?string state): void |
-| `lineItemApplication` | [`?string(OrderFulfillmentFulfillmentLineItemApplication)`](../../doc/models/order-fulfillment-fulfillment-line-item-application.md) | Optional | The `line_item_application` describes what order line items this fulfillment applies
to. It can be `ALL` or `ENTRY_LIST` with a supplied list of fulfillment entries. | getLineItemApplication(): ?string | setLineItemApplication(?string lineItemApplication): void |
-| `entries` | [`?(OrderFulfillmentFulfillmentEntry[])`](../../doc/models/order-fulfillment-fulfillment-entry.md) | Optional | A list of entries pertaining to the fulfillment of an order. Each entry must reference
a valid `uid` for an order line item in the `line_item_uid` field, as well as a `quantity` to
fulfill.
Multiple entries can reference the same line item `uid`, as long as the total quantity among
all fulfillment entries referencing a single line item does not exceed the quantity of the
order's line item itself.
An order cannot be marked as `COMPLETED` before all fulfillments are `COMPLETED`,
`CANCELED`, or `FAILED`. Fulfillments can be created and completed independently
before order completion. | getEntries(): ?array | setEntries(?array entries): void |
-| `metadata` | `?array` | Optional | Application-defined data attached to this fulfillment. Metadata fields are intended
to store descriptive references or associations with an entity in another system or store brief
information about the object. Square does not process this field; it only stores and returns it
in relevant API calls. Do not use metadata to store any sensitive information (such as personally
identifiable information or card details).
Keys written by applications must be 60 characters or less and must be in the character set
`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed
with a namespace, separated from the key with a ':' character.
Values have a maximum length of 255 characters.
An application can have up to 10 entries per metadata field.
Entries written by applications are private and can only be read or modified by the same
application.
For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). | getMetadata(): ?array | setMetadata(?array metadata): void |
-| `pickupDetails` | [`?OrderFulfillmentPickupDetails`](../../doc/models/order-fulfillment-pickup-details.md) | Optional | Contains details necessary to fulfill a pickup order. | getPickupDetails(): ?OrderFulfillmentPickupDetails | setPickupDetails(?OrderFulfillmentPickupDetails pickupDetails): void |
-| `shipmentDetails` | [`?OrderFulfillmentShipmentDetails`](../../doc/models/order-fulfillment-shipment-details.md) | Optional | Contains the details necessary to fulfill a shipment order. | getShipmentDetails(): ?OrderFulfillmentShipmentDetails | setShipmentDetails(?OrderFulfillmentShipmentDetails shipmentDetails): void |
-| `deliveryDetails` | [`?OrderFulfillmentDeliveryDetails`](../../doc/models/order-fulfillment-delivery-details.md) | Optional | Describes delivery details of an order fulfillment. | getDeliveryDetails(): ?OrderFulfillmentDeliveryDetails | setDeliveryDetails(?OrderFulfillmentDeliveryDetails deliveryDetails): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid8",
- "type": "PICKUP",
- "state": "PROPOSED",
- "line_item_application": "ALL",
- "entries": [
- {
- "uid": "uid0",
- "line_item_uid": "line_item_uid0",
- "quantity": "quantity6",
- "metadata": {
- "key0": "metadata3",
- "key1": "metadata4",
- "key2": "metadata5"
- }
- },
- {
- "uid": "uid0",
- "line_item_uid": "line_item_uid0",
- "quantity": "quantity6",
- "metadata": {
- "key0": "metadata3",
- "key1": "metadata4",
- "key2": "metadata5"
- }
- },
- {
- "uid": "uid0",
- "line_item_uid": "line_item_uid0",
- "quantity": "quantity6",
- "metadata": {
- "key0": "metadata3",
- "key1": "metadata4",
- "key2": "metadata5"
- }
- }
- ]
-}
-```
-
diff --git a/doc/models/order-line-item-applied-discount.md b/doc/models/order-line-item-applied-discount.md
deleted file mode 100644
index 0e2f8332..00000000
--- a/doc/models/order-line-item-applied-discount.md
+++ /dev/null
@@ -1,35 +0,0 @@
-
-# Order Line Item Applied Discount
-
-Represents an applied portion of a discount to a line item in an order.
-
-Order scoped discounts have automatically applied discounts present for each line item.
-Line-item scoped discounts must have applied discounts added manually for any applicable line
-items. The corresponding applied money is automatically computed based on participating
-line items.
-
-## Structure
-
-`OrderLineItemAppliedDiscount`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the applied discount only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `discountUid` | `string` | Required | The `uid` of the discount that the applied discount represents. It must
reference a discount present in the `order.discounts` field.
This field is immutable. To change which discounts apply to a line item,
you must delete the discount and re-add it as a new `OrderLineItemAppliedDiscount`.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `60` | getDiscountUid(): string | setDiscountUid(string discountUid): void |
-| `appliedMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAppliedMoney(): ?Money | setAppliedMoney(?Money appliedMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid2",
- "discount_uid": "discount_uid2",
- "applied_money": {
- "amount": 196,
- "currency": "AMD"
- }
-}
-```
-
diff --git a/doc/models/order-line-item-applied-service-charge.md b/doc/models/order-line-item-applied-service-charge.md
deleted file mode 100644
index 32f25e10..00000000
--- a/doc/models/order-line-item-applied-service-charge.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# Order Line Item Applied Service Charge
-
-## Structure
-
-`OrderLineItemAppliedServiceCharge`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the applied service charge only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `serviceChargeUid` | `string` | Required | The `uid` of the service charge that the applied service charge represents. It must
reference a service charge present in the `order.service_charges` field.
This field is immutable. To change which service charges apply to a line item,
delete and add a new `OrderLineItemAppliedServiceCharge`.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `60` | getServiceChargeUid(): string | setServiceChargeUid(string serviceChargeUid): void |
-| `appliedMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAppliedMoney(): ?Money | setAppliedMoney(?Money appliedMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid8",
- "service_charge_uid": "service_charge_uid8",
- "applied_money": {
- "amount": 196,
- "currency": "AMD"
- }
-}
-```
-
diff --git a/doc/models/order-line-item-applied-tax.md b/doc/models/order-line-item-applied-tax.md
deleted file mode 100644
index 7aa37e54..00000000
--- a/doc/models/order-line-item-applied-tax.md
+++ /dev/null
@@ -1,35 +0,0 @@
-
-# Order Line Item Applied Tax
-
-Represents an applied portion of a tax to a line item in an order.
-
-Order-scoped taxes automatically include the applied taxes in each line item.
-Line item taxes must be referenced from any applicable line items.
-The corresponding applied money is automatically computed, based on the
-set of participating line items.
-
-## Structure
-
-`OrderLineItemAppliedTax`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the applied tax only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `taxUid` | `string` | Required | The `uid` of the tax for which this applied tax represents. It must reference
a tax present in the `order.taxes` field.
This field is immutable. To change which taxes apply to a line item, delete and add a new
`OrderLineItemAppliedTax`.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `60` | getTaxUid(): string | setTaxUid(string taxUid): void |
-| `appliedMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAppliedMoney(): ?Money | setAppliedMoney(?Money appliedMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid8",
- "tax_uid": "tax_uid6",
- "applied_money": {
- "amount": 196,
- "currency": "AMD"
- }
-}
-```
-
diff --git a/doc/models/order-line-item-discount-scope.md b/doc/models/order-line-item-discount-scope.md
deleted file mode 100644
index ccb5bb8a..00000000
--- a/doc/models/order-line-item-discount-scope.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Order Line Item Discount Scope
-
-Indicates whether this is a line-item or order-level discount.
-
-## Enumeration
-
-`OrderLineItemDiscountScope`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `OTHER_DISCOUNT_SCOPE` | Used for reporting only.
The original transaction discount scope is currently not supported by the API. |
-| `LINE_ITEM` | The discount should be applied to only line items specified by
`OrderLineItemAppliedDiscount` reference records. |
-| `ORDER` | The discount should be applied to the entire order. |
-
diff --git a/doc/models/order-line-item-discount-type.md b/doc/models/order-line-item-discount-type.md
deleted file mode 100644
index 99dc297f..00000000
--- a/doc/models/order-line-item-discount-type.md
+++ /dev/null
@@ -1,19 +0,0 @@
-
-# Order Line Item Discount Type
-
-Indicates how the discount is applied to the associated line item or order.
-
-## Enumeration
-
-`OrderLineItemDiscountType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `UNKNOWN_DISCOUNT` | Used for reporting only.
The original transaction discount type is currently not supported by the API. |
-| `FIXED_PERCENTAGE` | Apply the discount as a fixed percentage (such as 5%) off the item price. |
-| `FIXED_AMOUNT` | Apply the discount as a fixed monetary value (such as $1.00) off the item price. |
-| `VARIABLE_PERCENTAGE` | Apply the discount as a variable percentage based on the item
price.
The specific discount percentage of a `VARIABLE_PERCENTAGE` discount
is assigned at the time of the purchase. |
-| `VARIABLE_AMOUNT` | Apply the discount as a variable amount based on the item price.
The specific discount amount of a `VARIABLE_AMOUNT` discount
is assigned at the time of the purchase. |
-
diff --git a/doc/models/order-line-item-discount.md b/doc/models/order-line-item-discount.md
deleted file mode 100644
index dc6ff224..00000000
--- a/doc/models/order-line-item-discount.md
+++ /dev/null
@@ -1,43 +0,0 @@
-
-# Order Line Item Discount
-
-Represents a discount that applies to one or more line items in an
-order.
-
-Fixed-amount, order-scoped discounts are distributed across all non-zero line item totals.
-The amount distributed to each line item is relative to the
-amount contributed by the item to the order subtotal.
-
-## Structure
-
-`OrderLineItemDiscount`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the discount only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `catalogObjectId` | `?string` | Optional | The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).
**Constraints**: *Maximum Length*: `192` | getCatalogObjectId(): ?string | setCatalogObjectId(?string catalogObjectId): void |
-| `catalogVersion` | `?int` | Optional | The version of the catalog object that this discount references. | getCatalogVersion(): ?int | setCatalogVersion(?int catalogVersion): void |
-| `name` | `?string` | Optional | The discount's name.
**Constraints**: *Maximum Length*: `255` | getName(): ?string | setName(?string name): void |
-| `type` | [`?string(OrderLineItemDiscountType)`](../../doc/models/order-line-item-discount-type.md) | Optional | Indicates how the discount is applied to the associated line item or order. | getType(): ?string | setType(?string type): void |
-| `percentage` | `?string` | Optional | The percentage of the discount, as a string representation of a decimal number.
A value of `7.25` corresponds to a percentage of 7.25%.
`percentage` is not set for amount-based discounts.
**Constraints**: *Maximum Length*: `10` | getPercentage(): ?string | setPercentage(?string percentage): void |
-| `amountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): ?Money | setAmountMoney(?Money amountMoney): void |
-| `appliedMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAppliedMoney(): ?Money | setAppliedMoney(?Money appliedMoney): void |
-| `metadata` | `?array` | Optional | Application-defined data attached to this discount. Metadata fields are intended
to store descriptive references or associations with an entity in another system or store brief
information about the object. Square does not process this field; it only stores and returns it
in relevant API calls. Do not use metadata to store any sensitive information (such as personally
identifiable information or card details).
Keys written by applications must be 60 characters or less and must be in the character set
`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed
with a namespace, separated from the key with a ':' character.
Values have a maximum length of 255 characters.
An application can have up to 10 entries per metadata field.
Entries written by applications are private and can only be read or modified by the same
application.
For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). | getMetadata(): ?array | setMetadata(?array metadata): void |
-| `scope` | [`?string(OrderLineItemDiscountScope)`](../../doc/models/order-line-item-discount-scope.md) | Optional | Indicates whether this is a line-item or order-level discount. | getScope(): ?string | setScope(?string scope): void |
-| `rewardIds` | `?(string[])` | Optional | The reward IDs corresponding to this discount. The application and
specification of discounts that have `reward_ids` are completely controlled by the backing
criteria corresponding to the reward tiers of the rewards that are added to the order
through the Loyalty API. To manually unapply discounts that are the result of added rewards,
the rewards must be removed from the order through the Loyalty API. | getRewardIds(): ?array | setRewardIds(?array rewardIds): void |
-| `pricingRuleId` | `?string` | Optional | The object ID of a [pricing rule](entity:CatalogPricingRule) to be applied
automatically to this discount. The specification and application of the discounts, to
which a `pricing_rule_id` is assigned, are completely controlled by the corresponding
pricing rule. | getPricingRuleId(): ?string | setPricingRuleId(?string pricingRuleId): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid4",
- "catalog_object_id": "catalog_object_id8",
- "catalog_version": 54,
- "name": "name4",
- "type": "FIXED_PERCENTAGE"
-}
-```
-
diff --git a/doc/models/order-line-item-item-type.md b/doc/models/order-line-item-item-type.md
deleted file mode 100644
index 70c09fb0..00000000
--- a/doc/models/order-line-item-item-type.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Order Line Item Item Type
-
-Represents the line item type.
-
-## Enumeration
-
-`OrderLineItemItemType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ITEM` | Indicates that the line item is an itemized sale. |
-| `CUSTOM_AMOUNT` | Indicates that the line item is a non-itemized sale. |
-| `GIFT_CARD` | Indicates that the line item is a gift card sale. Gift cards sold through
the Orders API are sold in an unactivated state and can be activated through the
Gift Cards API using the line item `uid`. |
-
diff --git a/doc/models/order-line-item-modifier.md b/doc/models/order-line-item-modifier.md
deleted file mode 100644
index fabf6a15..00000000
--- a/doc/models/order-line-item-modifier.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Order Line Item Modifier
-
-A [CatalogModifier](../../doc/models/catalog-modifier.md).
-
-## Structure
-
-`OrderLineItemModifier`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the modifier only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `catalogObjectId` | `?string` | Optional | The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).
**Constraints**: *Maximum Length*: `192` | getCatalogObjectId(): ?string | setCatalogObjectId(?string catalogObjectId): void |
-| `catalogVersion` | `?int` | Optional | The version of the catalog object that this modifier references. | getCatalogVersion(): ?int | setCatalogVersion(?int catalogVersion): void |
-| `name` | `?string` | Optional | The name of the item modifier.
**Constraints**: *Maximum Length*: `255` | getName(): ?string | setName(?string name): void |
-| `quantity` | `?string` | Optional | The quantity of the line item modifier. The modifier quantity can be 0 or more.
For example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders
this item, the restaurant records the purchase by creating an `Order` object with a line item
for a burger. The line item includes a line item modifier: the name is cheese and the quantity
is 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses
the extra cheese option, the modifier quantity increases to 2. If the buyer does not want
any cheese, the modifier quantity is set to 0. | getQuantity(): ?string | setQuantity(?string quantity): void |
-| `basePriceMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getBasePriceMoney(): ?Money | setBasePriceMoney(?Money basePriceMoney): void |
-| `totalPriceMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalPriceMoney(): ?Money | setTotalPriceMoney(?Money totalPriceMoney): void |
-| `metadata` | `?array` | Optional | Application-defined data attached to this order. Metadata fields are intended
to store descriptive references or associations with an entity in another system or store brief
information about the object. Square does not process this field; it only stores and returns it
in relevant API calls. Do not use metadata to store any sensitive information (such as personally
identifiable information or card details).
Keys written by applications must be 60 characters or less and must be in the character set
`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed
with a namespace, separated from the key with a ':' character.
Values have a maximum length of 255 characters.
An application can have up to 10 entries per metadata field.
Entries written by applications are private and can only be read or modified by the same
application.
For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). | getMetadata(): ?array | setMetadata(?array metadata): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid2",
- "catalog_object_id": "catalog_object_id6",
- "catalog_version": 134,
- "name": "name2",
- "quantity": "quantity8"
-}
-```
-
diff --git a/doc/models/order-line-item-pricing-blocklists-blocked-discount.md b/doc/models/order-line-item-pricing-blocklists-blocked-discount.md
deleted file mode 100644
index 0bfd5e8a..00000000
--- a/doc/models/order-line-item-pricing-blocklists-blocked-discount.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# Order Line Item Pricing Blocklists Blocked Discount
-
-A discount to block from applying to a line item. The discount must be
-identified by either `discount_uid` or `discount_catalog_object_id`, but not both.
-
-## Structure
-
-`OrderLineItemPricingBlocklistsBlockedDiscount`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID of the `BlockedDiscount` within the order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `discountUid` | `?string` | Optional | The `uid` of the discount that should be blocked. Use this field to block
ad hoc discounts. For catalog discounts, use the `discount_catalog_object_id` field.
**Constraints**: *Maximum Length*: `60` | getDiscountUid(): ?string | setDiscountUid(?string discountUid): void |
-| `discountCatalogObjectId` | `?string` | Optional | The `catalog_object_id` of the discount that should be blocked.
Use this field to block catalog discounts. For ad hoc discounts, use the
`discount_uid` field.
**Constraints**: *Maximum Length*: `192` | getDiscountCatalogObjectId(): ?string | setDiscountCatalogObjectId(?string discountCatalogObjectId): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid6",
- "discount_uid": "discount_uid8",
- "discount_catalog_object_id": "discount_catalog_object_id8"
-}
-```
-
diff --git a/doc/models/order-line-item-pricing-blocklists-blocked-tax.md b/doc/models/order-line-item-pricing-blocklists-blocked-tax.md
deleted file mode 100644
index 4c39884c..00000000
--- a/doc/models/order-line-item-pricing-blocklists-blocked-tax.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# Order Line Item Pricing Blocklists Blocked Tax
-
-A tax to block from applying to a line item. The tax must be
-identified by either `tax_uid` or `tax_catalog_object_id`, but not both.
-
-## Structure
-
-`OrderLineItemPricingBlocklistsBlockedTax`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID of the `BlockedTax` within the order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `taxUid` | `?string` | Optional | The `uid` of the tax that should be blocked. Use this field to block
ad hoc taxes. For catalog, taxes use the `tax_catalog_object_id` field.
**Constraints**: *Maximum Length*: `60` | getTaxUid(): ?string | setTaxUid(?string taxUid): void |
-| `taxCatalogObjectId` | `?string` | Optional | The `catalog_object_id` of the tax that should be blocked.
Use this field to block catalog taxes. For ad hoc taxes, use the
`tax_uid` field.
**Constraints**: *Maximum Length*: `192` | getTaxCatalogObjectId(): ?string | setTaxCatalogObjectId(?string taxCatalogObjectId): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid8",
- "tax_uid": "tax_uid4",
- "tax_catalog_object_id": "tax_catalog_object_id2"
-}
-```
-
diff --git a/doc/models/order-line-item-pricing-blocklists.md b/doc/models/order-line-item-pricing-blocklists.md
deleted file mode 100644
index 607e69db..00000000
--- a/doc/models/order-line-item-pricing-blocklists.md
+++ /dev/null
@@ -1,54 +0,0 @@
-
-# Order Line Item Pricing Blocklists
-
-Describes pricing adjustments that are blocked from automatic
-application to a line item. For more information, see
-[Apply Taxes and Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts).
-
-## Structure
-
-`OrderLineItemPricingBlocklists`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `blockedDiscounts` | [`?(OrderLineItemPricingBlocklistsBlockedDiscount[])`](../../doc/models/order-line-item-pricing-blocklists-blocked-discount.md) | Optional | A list of discounts blocked from applying to the line item.
Discounts can be blocked by the `discount_uid` (for ad hoc discounts) or
the `discount_catalog_object_id` (for catalog discounts). | getBlockedDiscounts(): ?array | setBlockedDiscounts(?array blockedDiscounts): void |
-| `blockedTaxes` | [`?(OrderLineItemPricingBlocklistsBlockedTax[])`](../../doc/models/order-line-item-pricing-blocklists-blocked-tax.md) | Optional | A list of taxes blocked from applying to the line item.
Taxes can be blocked by the `tax_uid` (for ad hoc taxes) or
the `tax_catalog_object_id` (for catalog taxes). | getBlockedTaxes(): ?array | setBlockedTaxes(?array blockedTaxes): void |
-
-## Example (as JSON)
-
-```json
-{
- "blocked_discounts": [
- {
- "uid": "uid0",
- "discount_uid": "discount_uid6",
- "discount_catalog_object_id": "discount_catalog_object_id2"
- },
- {
- "uid": "uid0",
- "discount_uid": "discount_uid6",
- "discount_catalog_object_id": "discount_catalog_object_id2"
- },
- {
- "uid": "uid0",
- "discount_uid": "discount_uid6",
- "discount_catalog_object_id": "discount_catalog_object_id2"
- }
- ],
- "blocked_taxes": [
- {
- "uid": "uid4",
- "tax_uid": "tax_uid0",
- "tax_catalog_object_id": "tax_catalog_object_id8"
- },
- {
- "uid": "uid4",
- "tax_uid": "tax_uid0",
- "tax_catalog_object_id": "tax_catalog_object_id8"
- }
- ]
-}
-```
-
diff --git a/doc/models/order-line-item-tax-scope.md b/doc/models/order-line-item-tax-scope.md
deleted file mode 100644
index 3a27c8fd..00000000
--- a/doc/models/order-line-item-tax-scope.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Order Line Item Tax Scope
-
-Indicates whether this is a line-item or order-level tax.
-
-## Enumeration
-
-`OrderLineItemTaxScope`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `OTHER_TAX_SCOPE` | Used for reporting only.
The original transaction tax scope is currently not supported by the API. |
-| `LINE_ITEM` | The tax should be applied only to line items specified by
the `OrderLineItemAppliedTax` reference records. |
-| `ORDER` | The tax should be applied to the entire order. |
-
diff --git a/doc/models/order-line-item-tax-type.md b/doc/models/order-line-item-tax-type.md
deleted file mode 100644
index 780dfa36..00000000
--- a/doc/models/order-line-item-tax-type.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Order Line Item Tax Type
-
-Indicates how the tax is applied to the associated line item or order.
-
-## Enumeration
-
-`OrderLineItemTaxType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `UNKNOWN_TAX` | Used for reporting only.
The original transaction tax type is currently not supported by the API. |
-| `ADDITIVE` | The tax is an additive tax. The tax amount is added on top of the price.
For example, an item with a cost of 1.00 USD and a 10% additive tax has a total
cost to the buyer of 1.10 USD. |
-| `INCLUSIVE` | The tax is an inclusive tax. Inclusive taxes are already included
in the line item price or order total. For example, an item with a cost of
1.00 USD and a 10% inclusive tax has a pretax cost of 0.91 USD
(91 cents) and a 0.09 (9 cents) tax for a total cost of 1.00 USD to
the buyer. |
-
diff --git a/doc/models/order-line-item-tax.md b/doc/models/order-line-item-tax.md
deleted file mode 100644
index b446d2f4..00000000
--- a/doc/models/order-line-item-tax.md
+++ /dev/null
@@ -1,40 +0,0 @@
-
-# Order Line Item Tax
-
-Represents a tax that applies to one or more line item in the order.
-
-Fixed-amount, order-scoped taxes are distributed across all non-zero line item totals.
-The amount distributed to each line item is relative to the amount the item
-contributes to the order subtotal.
-
-## Structure
-
-`OrderLineItemTax`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the tax only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `catalogObjectId` | `?string` | Optional | The catalog object ID referencing [CatalogTax](entity:CatalogTax).
**Constraints**: *Maximum Length*: `192` | getCatalogObjectId(): ?string | setCatalogObjectId(?string catalogObjectId): void |
-| `catalogVersion` | `?int` | Optional | The version of the catalog object that this tax references. | getCatalogVersion(): ?int | setCatalogVersion(?int catalogVersion): void |
-| `name` | `?string` | Optional | The tax's name.
**Constraints**: *Maximum Length*: `255` | getName(): ?string | setName(?string name): void |
-| `type` | [`?string(OrderLineItemTaxType)`](../../doc/models/order-line-item-tax-type.md) | Optional | Indicates how the tax is applied to the associated line item or order. | getType(): ?string | setType(?string type): void |
-| `percentage` | `?string` | Optional | The percentage of the tax, as a string representation of a decimal
number. For example, a value of `"7.25"` corresponds to a percentage of
7.25%.
**Constraints**: *Maximum Length*: `10` | getPercentage(): ?string | setPercentage(?string percentage): void |
-| `metadata` | `?array` | Optional | Application-defined data attached to this tax. Metadata fields are intended
to store descriptive references or associations with an entity in another system or store brief
information about the object. Square does not process this field; it only stores and returns it
in relevant API calls. Do not use metadata to store any sensitive information (such as personally
identifiable information or card details).
Keys written by applications must be 60 characters or less and must be in the character set
`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed
with a namespace, separated from the key with a ':' character.
Values have a maximum length of 255 characters.
An application can have up to 10 entries per metadata field.
Entries written by applications are private and can only be read or modified by the same
application.
For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). | getMetadata(): ?array | setMetadata(?array metadata): void |
-| `appliedMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAppliedMoney(): ?Money | setAppliedMoney(?Money appliedMoney): void |
-| `scope` | [`?string(OrderLineItemTaxScope)`](../../doc/models/order-line-item-tax-scope.md) | Optional | Indicates whether this is a line-item or order-level tax. | getScope(): ?string | setScope(?string scope): void |
-| `autoApplied` | `?bool` | Optional | Determines whether the tax was automatically applied to the order based on
the catalog configuration. For an example, see
[Automatically Apply Taxes to an Order](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts/auto-apply-taxes). | getAutoApplied(): ?bool | setAutoApplied(?bool autoApplied): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid4",
- "catalog_object_id": "catalog_object_id2",
- "catalog_version": 190,
- "name": "name4",
- "type": "ADDITIVE"
-}
-```
-
diff --git a/doc/models/order-line-item.md b/doc/models/order-line-item.md
deleted file mode 100644
index 22d74059..00000000
--- a/doc/models/order-line-item.md
+++ /dev/null
@@ -1,64 +0,0 @@
-
-# Order Line Item
-
-Represents a line item in an order. Each line item describes a different
-product to purchase, with its own quantity and price details.
-
-## Structure
-
-`OrderLineItem`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the line item only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `name` | `?string` | Optional | The name of the line item.
**Constraints**: *Maximum Length*: `512` | getName(): ?string | setName(?string name): void |
-| `quantity` | `string` | Required | The count, or measurement, of a line item being purchased:
If `quantity` is a whole number, and `quantity_unit` is not specified, then `quantity` denotes an item count. For example: `3` apples.
If `quantity` is a whole or decimal number, and `quantity_unit` is also specified, then `quantity` denotes a measurement. For example: `2.25` pounds of broccoli.
For more information, see [Specify item quantity and measurement unit](https://developer.squareup.com/docs/orders-api/create-orders#specify-item-quantity-and-measurement-unit).
Line items with a quantity of `0` are automatically removed
when paying for or otherwise completing the order.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `12` | getQuantity(): string | setQuantity(string quantity): void |
-| `quantityUnit` | [`?OrderQuantityUnit`](../../doc/models/order-quantity-unit.md) | Optional | Contains the measurement unit for a quantity and a precision that
specifies the number of digits after the decimal point for decimal quantities. | getQuantityUnit(): ?OrderQuantityUnit | setQuantityUnit(?OrderQuantityUnit quantityUnit): void |
-| `note` | `?string` | Optional | An optional note associated with the line item.
**Constraints**: *Maximum Length*: `2000` | getNote(): ?string | setNote(?string note): void |
-| `catalogObjectId` | `?string` | Optional | The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this line item.
**Constraints**: *Maximum Length*: `192` | getCatalogObjectId(): ?string | setCatalogObjectId(?string catalogObjectId): void |
-| `catalogVersion` | `?int` | Optional | The version of the catalog object that this line item references. | getCatalogVersion(): ?int | setCatalogVersion(?int catalogVersion): void |
-| `variationName` | `?string` | Optional | The name of the variation applied to this line item.
**Constraints**: *Maximum Length*: `400` | getVariationName(): ?string | setVariationName(?string variationName): void |
-| `itemType` | [`?string(OrderLineItemItemType)`](../../doc/models/order-line-item-item-type.md) | Optional | Represents the line item type. | getItemType(): ?string | setItemType(?string itemType): void |
-| `metadata` | `?array` | Optional | Application-defined data attached to this line item. Metadata fields are intended
to store descriptive references or associations with an entity in another system or store brief
information about the object. Square does not process this field; it only stores and returns it
in relevant API calls. Do not use metadata to store any sensitive information (such as personally
identifiable information or card details).
Keys written by applications must be 60 characters or less and must be in the character set
`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed
with a namespace, separated from the key with a ':' character.
Values have a maximum length of 255 characters.
An application can have up to 10 entries per metadata field.
Entries written by applications are private and can only be read or modified by the same
application.
For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). | getMetadata(): ?array | setMetadata(?array metadata): void |
-| `modifiers` | [`?(OrderLineItemModifier[])`](../../doc/models/order-line-item-modifier.md) | Optional | The [CatalogModifier](entity:CatalogModifier)s applied to this line item. | getModifiers(): ?array | setModifiers(?array modifiers): void |
-| `appliedTaxes` | [`?(OrderLineItemAppliedTax[])`](../../doc/models/order-line-item-applied-tax.md) | Optional | The list of references to taxes applied to this line item. Each
`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a
top-level `OrderLineItemTax` applied to the line item. On reads, the
amount applied is populated.
An `OrderLineItemAppliedTax` is automatically created on every line
item for all `ORDER` scoped taxes added to the order. `OrderLineItemAppliedTax`
records for `LINE_ITEM` scoped taxes must be added in requests for the tax
to apply to any line items.
To change the amount of a tax, modify the referenced top-level tax. | getAppliedTaxes(): ?array | setAppliedTaxes(?array appliedTaxes): void |
-| `appliedDiscounts` | [`?(OrderLineItemAppliedDiscount[])`](../../doc/models/order-line-item-applied-discount.md) | Optional | The list of references to discounts applied to this line item. Each
`OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level
`OrderLineItemDiscounts` applied to the line item. On reads, the amount
applied is populated.
An `OrderLineItemAppliedDiscount` is automatically created on every line item for all
`ORDER` scoped discounts that are added to the order. `OrderLineItemAppliedDiscount` records
for `LINE_ITEM` scoped discounts must be added in requests for the discount to apply to any
line items.
To change the amount of a discount, modify the referenced top-level discount. | getAppliedDiscounts(): ?array | setAppliedDiscounts(?array appliedDiscounts): void |
-| `appliedServiceCharges` | [`?(OrderLineItemAppliedServiceCharge[])`](../../doc/models/order-line-item-applied-service-charge.md) | Optional | The list of references to service charges applied to this line item. Each
`OrderLineItemAppliedServiceCharge` has a `service_charge_id` that references the `uid` of a
top-level `OrderServiceCharge` applied to the line item. On reads, the amount applied is
populated.
To change the amount of a service charge, modify the referenced top-level service charge. | getAppliedServiceCharges(): ?array | setAppliedServiceCharges(?array appliedServiceCharges): void |
-| `basePriceMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getBasePriceMoney(): ?Money | setBasePriceMoney(?Money basePriceMoney): void |
-| `variationTotalPriceMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getVariationTotalPriceMoney(): ?Money | setVariationTotalPriceMoney(?Money variationTotalPriceMoney): void |
-| `grossSalesMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getGrossSalesMoney(): ?Money | setGrossSalesMoney(?Money grossSalesMoney): void |
-| `totalTaxMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalTaxMoney(): ?Money | setTotalTaxMoney(?Money totalTaxMoney): void |
-| `totalDiscountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalDiscountMoney(): ?Money | setTotalDiscountMoney(?Money totalDiscountMoney): void |
-| `totalMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalMoney(): ?Money | setTotalMoney(?Money totalMoney): void |
-| `pricingBlocklists` | [`?OrderLineItemPricingBlocklists`](../../doc/models/order-line-item-pricing-blocklists.md) | Optional | Describes pricing adjustments that are blocked from automatic
application to a line item. For more information, see
[Apply Taxes and Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts). | getPricingBlocklists(): ?OrderLineItemPricingBlocklists | setPricingBlocklists(?OrderLineItemPricingBlocklists pricingBlocklists): void |
-| `totalServiceChargeMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalServiceChargeMoney(): ?Money | setTotalServiceChargeMoney(?Money totalServiceChargeMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid4",
- "name": "name4",
- "quantity": "quantity0",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note0",
- "catalog_object_id": "catalog_object_id8"
-}
-```
-
diff --git a/doc/models/order-money-amounts.md b/doc/models/order-money-amounts.md
deleted file mode 100644
index 24e95b16..00000000
--- a/doc/models/order-money-amounts.md
+++ /dev/null
@@ -1,46 +0,0 @@
-
-# Order Money Amounts
-
-A collection of various money amounts.
-
-## Structure
-
-`OrderMoneyAmounts`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `totalMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalMoney(): ?Money | setTotalMoney(?Money totalMoney): void |
-| `taxMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTaxMoney(): ?Money | setTaxMoney(?Money taxMoney): void |
-| `discountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getDiscountMoney(): ?Money | setDiscountMoney(?Money discountMoney): void |
-| `tipMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTipMoney(): ?Money | setTipMoney(?Money tipMoney): void |
-| `serviceChargeMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getServiceChargeMoney(): ?Money | setServiceChargeMoney(?Money serviceChargeMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "total_money": {
- "amount": 250,
- "currency": "UAH"
- },
- "tax_money": {
- "amount": 58,
- "currency": "IRR"
- },
- "discount_money": {
- "amount": 92,
- "currency": "PAB"
- },
- "tip_money": {
- "amount": 190,
- "currency": "TWD"
- },
- "service_charge_money": {
- "amount": 160,
- "currency": "XCD"
- }
-}
-```
-
diff --git a/doc/models/order-pricing-options.md b/doc/models/order-pricing-options.md
deleted file mode 100644
index 3e8c7fd3..00000000
--- a/doc/models/order-pricing-options.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Order Pricing Options
-
-Pricing options for an order. The options affect how the order's price is calculated.
-They can be used, for example, to apply automatic price adjustments that are based on preconfigured
-[pricing rules](../../doc/models/catalog-pricing-rule.md).
-
-## Structure
-
-`OrderPricingOptions`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `autoApplyDiscounts` | `?bool` | Optional | The option to determine whether pricing rule-based
discounts are automatically applied to an order. | getAutoApplyDiscounts(): ?bool | setAutoApplyDiscounts(?bool autoApplyDiscounts): void |
-| `autoApplyTaxes` | `?bool` | Optional | The option to determine whether rule-based taxes are automatically
applied to an order when the criteria of the corresponding rules are met. | getAutoApplyTaxes(): ?bool | setAutoApplyTaxes(?bool autoApplyTaxes): void |
-
-## Example (as JSON)
-
-```json
-{
- "auto_apply_discounts": false,
- "auto_apply_taxes": false
-}
-```
-
diff --git a/doc/models/order-quantity-unit.md b/doc/models/order-quantity-unit.md
deleted file mode 100644
index ebdcf416..00000000
--- a/doc/models/order-quantity-unit.md
+++ /dev/null
@@ -1,39 +0,0 @@
-
-# Order Quantity Unit
-
-Contains the measurement unit for a quantity and a precision that
-specifies the number of digits after the decimal point for decimal quantities.
-
-## Structure
-
-`OrderQuantityUnit`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `measurementUnit` | [`?MeasurementUnit`](../../doc/models/measurement-unit.md) | Optional | Represents a unit of measurement to use with a quantity, such as ounces
or inches. Exactly one of the following fields are required: `custom_unit`,
`area_unit`, `length_unit`, `volume_unit`, and `weight_unit`. | getMeasurementUnit(): ?MeasurementUnit | setMeasurementUnit(?MeasurementUnit measurementUnit): void |
-| `precision` | `?int` | Optional | For non-integer quantities, represents the number of digits after the decimal point that are
recorded for this quantity.
For example, a precision of 1 allows quantities such as `"1.0"` and `"1.1"`, but not `"1.01"`.
Min: 0. Max: 5. | getPrecision(): ?int | setPrecision(?int precision): void |
-| `catalogObjectId` | `?string` | Optional | The catalog object ID referencing the
[CatalogMeasurementUnit](entity:CatalogMeasurementUnit).
This field is set when this is a catalog-backed measurement unit. | getCatalogObjectId(): ?string | setCatalogObjectId(?string catalogObjectId): void |
-| `catalogVersion` | `?int` | Optional | The version of the catalog object that this measurement unit references.
This field is set when this is a catalog-backed measurement unit. | getCatalogVersion(): ?int | setCatalogVersion(?int catalogVersion): void |
-
-## Example (as JSON)
-
-```json
-{
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 144,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 78
-}
-```
-
diff --git a/doc/models/order-return-discount.md b/doc/models/order-return-discount.md
deleted file mode 100644
index fbba050b..00000000
--- a/doc/models/order-return-discount.md
+++ /dev/null
@@ -1,41 +0,0 @@
-
-# Order Return Discount
-
-Represents a discount being returned that applies to one or more return line items in an
-order.
-
-Fixed-amount, order-scoped discounts are distributed across all non-zero return line item totals.
-The amount distributed to each return line item is relative to that item’s contribution to the
-order subtotal.
-
-## Structure
-
-`OrderReturnDiscount`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the returned discount only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `sourceDiscountUid` | `?string` | Optional | The discount `uid` from the order that contains the original application of this discount.
**Constraints**: *Maximum Length*: `60` | getSourceDiscountUid(): ?string | setSourceDiscountUid(?string sourceDiscountUid): void |
-| `catalogObjectId` | `?string` | Optional | The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).
**Constraints**: *Maximum Length*: `192` | getCatalogObjectId(): ?string | setCatalogObjectId(?string catalogObjectId): void |
-| `catalogVersion` | `?int` | Optional | The version of the catalog object that this discount references. | getCatalogVersion(): ?int | setCatalogVersion(?int catalogVersion): void |
-| `name` | `?string` | Optional | The discount's name.
**Constraints**: *Maximum Length*: `255` | getName(): ?string | setName(?string name): void |
-| `type` | [`?string(OrderLineItemDiscountType)`](../../doc/models/order-line-item-discount-type.md) | Optional | Indicates how the discount is applied to the associated line item or order. | getType(): ?string | setType(?string type): void |
-| `percentage` | `?string` | Optional | The percentage of the tax, as a string representation of a decimal number.
A value of `"7.25"` corresponds to a percentage of 7.25%.
`percentage` is not set for amount-based discounts.
**Constraints**: *Maximum Length*: `10` | getPercentage(): ?string | setPercentage(?string percentage): void |
-| `amountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): ?Money | setAmountMoney(?Money amountMoney): void |
-| `appliedMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAppliedMoney(): ?Money | setAppliedMoney(?Money appliedMoney): void |
-| `scope` | [`?string(OrderLineItemDiscountScope)`](../../doc/models/order-line-item-discount-scope.md) | Optional | Indicates whether this is a line-item or order-level discount. | getScope(): ?string | setScope(?string scope): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid2",
- "source_discount_uid": "source_discount_uid2",
- "catalog_object_id": "catalog_object_id4",
- "catalog_version": 188,
- "name": "name2"
-}
-```
-
diff --git a/doc/models/order-return-line-item-modifier.md b/doc/models/order-return-line-item-modifier.md
deleted file mode 100644
index 0cd8bf42..00000000
--- a/doc/models/order-return-line-item-modifier.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Order Return Line Item Modifier
-
-A line item modifier being returned.
-
-## Structure
-
-`OrderReturnLineItemModifier`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the return modifier only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `sourceModifierUid` | `?string` | Optional | The modifier `uid` from the order's line item that contains the
original sale of this line item modifier.
**Constraints**: *Maximum Length*: `60` | getSourceModifierUid(): ?string | setSourceModifierUid(?string sourceModifierUid): void |
-| `catalogObjectId` | `?string` | Optional | The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).
**Constraints**: *Maximum Length*: `192` | getCatalogObjectId(): ?string | setCatalogObjectId(?string catalogObjectId): void |
-| `catalogVersion` | `?int` | Optional | The version of the catalog object that this line item modifier references. | getCatalogVersion(): ?int | setCatalogVersion(?int catalogVersion): void |
-| `name` | `?string` | Optional | The name of the item modifier.
**Constraints**: *Maximum Length*: `255` | getName(): ?string | setName(?string name): void |
-| `basePriceMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getBasePriceMoney(): ?Money | setBasePriceMoney(?Money basePriceMoney): void |
-| `totalPriceMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalPriceMoney(): ?Money | setTotalPriceMoney(?Money totalPriceMoney): void |
-| `quantity` | `?string` | Optional | The quantity of the line item modifier. The modifier quantity can be 0 or more.
For example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders
this item, the restaurant records the purchase by creating an `Order` object with a line item
for a burger. The line item includes a line item modifier: the name is cheese and the quantity
is 1. The buyer has the option to order extra cheese (or no cheese). If the buyer chooses
the extra cheese option, the modifier quantity increases to 2. If the buyer does not want
any cheese, the modifier quantity is set to 0. | getQuantity(): ?string | setQuantity(?string quantity): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid4",
- "source_modifier_uid": "source_modifier_uid8",
- "catalog_object_id": "catalog_object_id8",
- "catalog_version": 46,
- "name": "name4"
-}
-```
-
diff --git a/doc/models/order-return-line-item.md b/doc/models/order-return-line-item.md
deleted file mode 100644
index 0b38499e..00000000
--- a/doc/models/order-return-line-item.md
+++ /dev/null
@@ -1,62 +0,0 @@
-
-# Order Return Line Item
-
-The line item being returned in an order.
-
-## Structure
-
-`OrderReturnLineItem`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID for this return line-item entry.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `sourceLineItemUid` | `?string` | Optional | The `uid` of the line item in the original sale order.
**Constraints**: *Maximum Length*: `60` | getSourceLineItemUid(): ?string | setSourceLineItemUid(?string sourceLineItemUid): void |
-| `name` | `?string` | Optional | The name of the line item.
**Constraints**: *Maximum Length*: `512` | getName(): ?string | setName(?string name): void |
-| `quantity` | `string` | Required | The quantity returned, formatted as a decimal number.
For example, `"3"`.
Line items with a `quantity_unit` can have non-integer quantities.
For example, `"1.70000"`.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `12` | getQuantity(): string | setQuantity(string quantity): void |
-| `quantityUnit` | [`?OrderQuantityUnit`](../../doc/models/order-quantity-unit.md) | Optional | Contains the measurement unit for a quantity and a precision that
specifies the number of digits after the decimal point for decimal quantities. | getQuantityUnit(): ?OrderQuantityUnit | setQuantityUnit(?OrderQuantityUnit quantityUnit): void |
-| `note` | `?string` | Optional | The note of the return line item.
**Constraints**: *Maximum Length*: `2000` | getNote(): ?string | setNote(?string note): void |
-| `catalogObjectId` | `?string` | Optional | The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this return line item.
**Constraints**: *Maximum Length*: `192` | getCatalogObjectId(): ?string | setCatalogObjectId(?string catalogObjectId): void |
-| `catalogVersion` | `?int` | Optional | The version of the catalog object that this line item references. | getCatalogVersion(): ?int | setCatalogVersion(?int catalogVersion): void |
-| `variationName` | `?string` | Optional | The name of the variation applied to this return line item.
**Constraints**: *Maximum Length*: `400` | getVariationName(): ?string | setVariationName(?string variationName): void |
-| `itemType` | [`?string(OrderLineItemItemType)`](../../doc/models/order-line-item-item-type.md) | Optional | Represents the line item type. | getItemType(): ?string | setItemType(?string itemType): void |
-| `returnModifiers` | [`?(OrderReturnLineItemModifier[])`](../../doc/models/order-return-line-item-modifier.md) | Optional | The [CatalogModifier](entity:CatalogModifier)s applied to this line item. | getReturnModifiers(): ?array | setReturnModifiers(?array returnModifiers): void |
-| `appliedTaxes` | [`?(OrderLineItemAppliedTax[])`](../../doc/models/order-line-item-applied-tax.md) | Optional | The list of references to `OrderReturnTax` entities applied to the return line item. Each
`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level
`OrderReturnTax` applied to the return line item. On reads, the applied amount
is populated. | getAppliedTaxes(): ?array | setAppliedTaxes(?array appliedTaxes): void |
-| `appliedDiscounts` | [`?(OrderLineItemAppliedDiscount[])`](../../doc/models/order-line-item-applied-discount.md) | Optional | The list of references to `OrderReturnDiscount` entities applied to the return line item. Each
`OrderLineItemAppliedDiscount` has a `discount_uid` that references the `uid` of a top-level
`OrderReturnDiscount` applied to the return line item. On reads, the applied amount
is populated. | getAppliedDiscounts(): ?array | setAppliedDiscounts(?array appliedDiscounts): void |
-| `basePriceMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getBasePriceMoney(): ?Money | setBasePriceMoney(?Money basePriceMoney): void |
-| `variationTotalPriceMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getVariationTotalPriceMoney(): ?Money | setVariationTotalPriceMoney(?Money variationTotalPriceMoney): void |
-| `grossReturnMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getGrossReturnMoney(): ?Money | setGrossReturnMoney(?Money grossReturnMoney): void |
-| `totalTaxMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalTaxMoney(): ?Money | setTotalTaxMoney(?Money totalTaxMoney): void |
-| `totalDiscountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalDiscountMoney(): ?Money | setTotalDiscountMoney(?Money totalDiscountMoney): void |
-| `totalMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalMoney(): ?Money | setTotalMoney(?Money totalMoney): void |
-| `appliedServiceCharges` | [`?(OrderLineItemAppliedServiceCharge[])`](../../doc/models/order-line-item-applied-service-charge.md) | Optional | The list of references to `OrderReturnServiceCharge` entities applied to the return
line item. Each `OrderLineItemAppliedServiceCharge` has a `service_charge_uid` that
references the `uid` of a top-level `OrderReturnServiceCharge` applied to the return line
item. On reads, the applied amount is populated. | getAppliedServiceCharges(): ?array | setAppliedServiceCharges(?array appliedServiceCharges): void |
-| `totalServiceChargeMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalServiceChargeMoney(): ?Money | setTotalServiceChargeMoney(?Money totalServiceChargeMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid2",
- "source_line_item_uid": "source_line_item_uid0",
- "name": "name2",
- "quantity": "quantity8",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note8"
-}
-```
-
diff --git a/doc/models/order-return-service-charge.md b/doc/models/order-return-service-charge.md
deleted file mode 100644
index 13ca452a..00000000
--- a/doc/models/order-return-service-charge.md
+++ /dev/null
@@ -1,41 +0,0 @@
-
-# Order Return Service Charge
-
-Represents the service charge applied to the original order.
-
-## Structure
-
-`OrderReturnServiceCharge`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the return service charge only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `sourceServiceChargeUid` | `?string` | Optional | The service charge `uid` from the order containing the original
service charge. `source_service_charge_uid` is `null` for
unlinked returns.
**Constraints**: *Maximum Length*: `60` | getSourceServiceChargeUid(): ?string | setSourceServiceChargeUid(?string sourceServiceChargeUid): void |
-| `name` | `?string` | Optional | The name of the service charge.
**Constraints**: *Maximum Length*: `255` | getName(): ?string | setName(?string name): void |
-| `catalogObjectId` | `?string` | Optional | The catalog object ID of the associated [OrderServiceCharge](entity:OrderServiceCharge).
**Constraints**: *Maximum Length*: `192` | getCatalogObjectId(): ?string | setCatalogObjectId(?string catalogObjectId): void |
-| `catalogVersion` | `?int` | Optional | The version of the catalog object that this service charge references. | getCatalogVersion(): ?int | setCatalogVersion(?int catalogVersion): void |
-| `percentage` | `?string` | Optional | The percentage of the service charge, as a string representation of
a decimal number. For example, a value of `"7.25"` corresponds to a
percentage of 7.25%.
Either `percentage` or `amount_money` should be set, but not both.
**Constraints**: *Maximum Length*: `10` | getPercentage(): ?string | setPercentage(?string percentage): void |
-| `amountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): ?Money | setAmountMoney(?Money amountMoney): void |
-| `appliedMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAppliedMoney(): ?Money | setAppliedMoney(?Money appliedMoney): void |
-| `totalMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalMoney(): ?Money | setTotalMoney(?Money totalMoney): void |
-| `totalTaxMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalTaxMoney(): ?Money | setTotalTaxMoney(?Money totalTaxMoney): void |
-| `calculationPhase` | [`?string(OrderServiceChargeCalculationPhase)`](../../doc/models/order-service-charge-calculation-phase.md) | Optional | Represents a phase in the process of calculating order totals.
Service charges are applied after the indicated phase.
[Read more about how order totals are calculated.](https://developer.squareup.com/docs/orders-api/how-it-works#how-totals-are-calculated) | getCalculationPhase(): ?string | setCalculationPhase(?string calculationPhase): void |
-| `taxable` | `?bool` | Optional | Indicates whether the surcharge can be taxed. Service charges
calculated in the `TOTAL_PHASE` cannot be marked as taxable. | getTaxable(): ?bool | setTaxable(?bool taxable): void |
-| `appliedTaxes` | [`?(OrderLineItemAppliedTax[])`](../../doc/models/order-line-item-applied-tax.md) | Optional | The list of references to `OrderReturnTax` entities applied to the
`OrderReturnServiceCharge`. Each `OrderLineItemAppliedTax` has a `tax_uid`
that references the `uid` of a top-level `OrderReturnTax` that is being
applied to the `OrderReturnServiceCharge`. On reads, the applied amount is
populated. | getAppliedTaxes(): ?array | setAppliedTaxes(?array appliedTaxes): void |
-| `treatmentType` | [`?string(OrderServiceChargeTreatmentType)`](../../doc/models/order-service-charge-treatment-type.md) | Optional | Indicates whether the service charge will be treated as a value-holding line item or
apportioned toward a line item. | getTreatmentType(): ?string | setTreatmentType(?string treatmentType): void |
-| `scope` | [`?string(OrderServiceChargeScope)`](../../doc/models/order-service-charge-scope.md) | Optional | Indicates whether this is a line-item or order-level apportioned
service charge. | getScope(): ?string | setScope(?string scope): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid0",
- "source_service_charge_uid": "source_service_charge_uid6",
- "name": "name0",
- "catalog_object_id": "catalog_object_id4",
- "catalog_version": 18
-}
-```
-
diff --git a/doc/models/order-return-tax.md b/doc/models/order-return-tax.md
deleted file mode 100644
index 96259f6e..00000000
--- a/doc/models/order-return-tax.md
+++ /dev/null
@@ -1,39 +0,0 @@
-
-# Order Return Tax
-
-Represents a tax being returned that applies to one or more return line items in an order.
-
-Fixed-amount, order-scoped taxes are distributed across all non-zero return line item totals.
-The amount distributed to each return line item is relative to that item’s contribution to the
-order subtotal.
-
-## Structure
-
-`OrderReturnTax`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the returned tax only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `sourceTaxUid` | `?string` | Optional | The tax `uid` from the order that contains the original tax charge.
**Constraints**: *Maximum Length*: `60` | getSourceTaxUid(): ?string | setSourceTaxUid(?string sourceTaxUid): void |
-| `catalogObjectId` | `?string` | Optional | The catalog object ID referencing [CatalogTax](entity:CatalogTax).
**Constraints**: *Maximum Length*: `192` | getCatalogObjectId(): ?string | setCatalogObjectId(?string catalogObjectId): void |
-| `catalogVersion` | `?int` | Optional | The version of the catalog object that this tax references. | getCatalogVersion(): ?int | setCatalogVersion(?int catalogVersion): void |
-| `name` | `?string` | Optional | The tax's name.
**Constraints**: *Maximum Length*: `255` | getName(): ?string | setName(?string name): void |
-| `type` | [`?string(OrderLineItemTaxType)`](../../doc/models/order-line-item-tax-type.md) | Optional | Indicates how the tax is applied to the associated line item or order. | getType(): ?string | setType(?string type): void |
-| `percentage` | `?string` | Optional | The percentage of the tax, as a string representation of a decimal number.
For example, a value of `"7.25"` corresponds to a percentage of 7.25%.
**Constraints**: *Maximum Length*: `10` | getPercentage(): ?string | setPercentage(?string percentage): void |
-| `appliedMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAppliedMoney(): ?Money | setAppliedMoney(?Money appliedMoney): void |
-| `scope` | [`?string(OrderLineItemTaxScope)`](../../doc/models/order-line-item-tax-scope.md) | Optional | Indicates whether this is a line-item or order-level tax. | getScope(): ?string | setScope(?string scope): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid4",
- "source_tax_uid": "source_tax_uid2",
- "catalog_object_id": "catalog_object_id8",
- "catalog_version": 124,
- "name": "name4"
-}
-```
-
diff --git a/doc/models/order-return-tip.md b/doc/models/order-return-tip.md
deleted file mode 100644
index 9f0dce14..00000000
--- a/doc/models/order-return-tip.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Order Return Tip
-
-A tip being returned.
-
-## Structure
-
-`OrderReturnTip`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the tip only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `appliedMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAppliedMoney(): ?Money | setAppliedMoney(?Money appliedMoney): void |
-| `sourceTenderUid` | `?string` | Optional | The tender `uid` from the order that contains the original application of this tip.
**Constraints**: *Maximum Length*: `192` | getSourceTenderUid(): ?string | setSourceTenderUid(?string sourceTenderUid): void |
-| `sourceTenderId` | `?string` | Optional | The tender `id` from the order that contains the original application of this tip.
**Constraints**: *Maximum Length*: `192` | getSourceTenderId(): ?string | setSourceTenderId(?string sourceTenderId): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid4",
- "applied_money": {
- "amount": 196,
- "currency": "AMD"
- },
- "source_tender_uid": "source_tender_uid6",
- "source_tender_id": "source_tender_id0"
-}
-```
-
diff --git a/doc/models/order-return.md b/doc/models/order-return.md
deleted file mode 100644
index 73455eda..00000000
--- a/doc/models/order-return.md
+++ /dev/null
@@ -1,95 +0,0 @@
-
-# Order Return
-
-The set of line items, service charges, taxes, discounts, tips, and other items being returned in an order.
-
-## Structure
-
-`OrderReturn`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the return only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `sourceOrderId` | `?string` | Optional | An order that contains the original sale of these return line items. This is unset
for unlinked returns. | getSourceOrderId(): ?string | setSourceOrderId(?string sourceOrderId): void |
-| `returnLineItems` | [`?(OrderReturnLineItem[])`](../../doc/models/order-return-line-item.md) | Optional | A collection of line items that are being returned. | getReturnLineItems(): ?array | setReturnLineItems(?array returnLineItems): void |
-| `returnServiceCharges` | [`?(OrderReturnServiceCharge[])`](../../doc/models/order-return-service-charge.md) | Optional | A collection of service charges that are being returned. | getReturnServiceCharges(): ?array | setReturnServiceCharges(?array returnServiceCharges): void |
-| `returnTaxes` | [`?(OrderReturnTax[])`](../../doc/models/order-return-tax.md) | Optional | A collection of references to taxes being returned for an order, including the total
applied tax amount to be returned. The taxes must reference a top-level tax ID from the source
order. | getReturnTaxes(): ?array | setReturnTaxes(?array returnTaxes): void |
-| `returnDiscounts` | [`?(OrderReturnDiscount[])`](../../doc/models/order-return-discount.md) | Optional | A collection of references to discounts being returned for an order, including the total
applied discount amount to be returned. The discounts must reference a top-level discount ID
from the source order. | getReturnDiscounts(): ?array | setReturnDiscounts(?array returnDiscounts): void |
-| `returnTips` | [`?(OrderReturnTip[])`](../../doc/models/order-return-tip.md) | Optional | A collection of references to tips being returned for an order. | getReturnTips(): ?array | setReturnTips(?array returnTips): void |
-| `roundingAdjustment` | [`?OrderRoundingAdjustment`](../../doc/models/order-rounding-adjustment.md) | Optional | A rounding adjustment of the money being returned. Commonly used to apply cash rounding
when the minimum unit of the account is smaller than the lowest physical denomination of the currency. | getRoundingAdjustment(): ?OrderRoundingAdjustment | setRoundingAdjustment(?OrderRoundingAdjustment roundingAdjustment): void |
-| `returnAmounts` | [`?OrderMoneyAmounts`](../../doc/models/order-money-amounts.md) | Optional | A collection of various money amounts. | getReturnAmounts(): ?OrderMoneyAmounts | setReturnAmounts(?OrderMoneyAmounts returnAmounts): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid2",
- "source_order_id": "source_order_id0",
- "return_line_items": [
- {
- "uid": "uid0",
- "source_line_item_uid": "source_line_item_uid2",
- "name": "name0",
- "quantity": "quantity6",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4"
- }
- ],
- "return_service_charges": [
- {
- "uid": "uid6",
- "source_service_charge_uid": "source_service_charge_uid0",
- "name": "name6",
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- {
- "uid": "uid6",
- "source_service_charge_uid": "source_service_charge_uid0",
- "name": "name6",
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- }
- ],
- "return_taxes": [
- {
- "uid": "uid2",
- "source_tax_uid": "source_tax_uid0",
- "catalog_object_id": "catalog_object_id4",
- "catalog_version": 106,
- "name": "name2"
- },
- {
- "uid": "uid2",
- "source_tax_uid": "source_tax_uid0",
- "catalog_object_id": "catalog_object_id4",
- "catalog_version": 106,
- "name": "name2"
- },
- {
- "uid": "uid2",
- "source_tax_uid": "source_tax_uid0",
- "catalog_object_id": "catalog_object_id4",
- "catalog_version": 106,
- "name": "name2"
- }
- ]
-}
-```
-
diff --git a/doc/models/order-reward.md b/doc/models/order-reward.md
deleted file mode 100644
index 81e6b124..00000000
--- a/doc/models/order-reward.md
+++ /dev/null
@@ -1,26 +0,0 @@
-
-# Order Reward
-
-Represents a reward that can be applied to an order if the necessary
-reward tier criteria are met. Rewards are created through the Loyalty API.
-
-## Structure
-
-`OrderReward`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `string` | Required | The identifier of the reward.
**Constraints**: *Minimum Length*: `1` | getId(): string | setId(string id): void |
-| `rewardTierId` | `string` | Required | The identifier of the reward tier corresponding to this reward.
**Constraints**: *Minimum Length*: `1` | getRewardTierId(): string | setRewardTierId(string rewardTierId): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id0",
- "reward_tier_id": "reward_tier_id6"
-}
-```
-
diff --git a/doc/models/order-rounding-adjustment.md b/doc/models/order-rounding-adjustment.md
deleted file mode 100644
index 6ed42c78..00000000
--- a/doc/models/order-rounding-adjustment.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Order Rounding Adjustment
-
-A rounding adjustment of the money being returned. Commonly used to apply cash rounding
-when the minimum unit of the account is smaller than the lowest physical denomination of the currency.
-
-## Structure
-
-`OrderRoundingAdjustment`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the rounding adjustment only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `name` | `?string` | Optional | The name of the rounding adjustment from the original sale order. | getName(): ?string | setName(?string name): void |
-| `amountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): ?Money | setAmountMoney(?Money amountMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid0",
- "name": "name0",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- }
-}
-```
-
diff --git a/doc/models/order-service-charge-calculation-phase.md b/doc/models/order-service-charge-calculation-phase.md
deleted file mode 100644
index f1a054a9..00000000
--- a/doc/models/order-service-charge-calculation-phase.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Order Service Charge Calculation Phase
-
-Represents a phase in the process of calculating order totals.
-Service charges are applied after the indicated phase.
-
-[Read more about how order totals are calculated.](https://developer.squareup.com/docs/orders-api/how-it-works#how-totals-are-calculated)
-
-## Enumeration
-
-`OrderServiceChargeCalculationPhase`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `SUBTOTAL_PHASE` | The service charge is applied after discounts, but before
taxes. |
-| `TOTAL_PHASE` | The service charge is applied after all discounts and taxes
are applied. |
-| `APPORTIONED_PERCENTAGE_PHASE` | The service charge is calculated as a compounding adjustment
after any discounts, but before amount based apportioned service charges
and any tax considerations. |
-| `APPORTIONED_AMOUNT_PHASE` | The service charge is calculated as a compounding adjustment
after any discounts and percentage based apportioned service charges,
but before any tax considerations. |
-
diff --git a/doc/models/order-service-charge-scope.md b/doc/models/order-service-charge-scope.md
deleted file mode 100644
index 646680f4..00000000
--- a/doc/models/order-service-charge-scope.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# Order Service Charge Scope
-
-Indicates whether this is a line-item or order-level apportioned
-service charge.
-
-## Enumeration
-
-`OrderServiceChargeScope`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `OTHER_SERVICE_CHARGE_SCOPE` | Used for reporting only.
The original transaction service charge scope is currently not supported by the API. |
-| `LINE_ITEM` | The service charge should be applied to only line items specified by
`OrderLineItemAppliedServiceCharge` reference records. |
-| `ORDER` | The service charge should be applied to the entire order. |
-
diff --git a/doc/models/order-service-charge-treatment-type.md b/doc/models/order-service-charge-treatment-type.md
deleted file mode 100644
index f54d58b5..00000000
--- a/doc/models/order-service-charge-treatment-type.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Order Service Charge Treatment Type
-
-Indicates whether the service charge will be treated as a value-holding line item or
-apportioned toward a line item.
-
-## Enumeration
-
-`OrderServiceChargeTreatmentType`
-
-## Fields
-
-| Name |
-| --- |
-| `LINE_ITEM_TREATMENT` |
-| `APPORTIONED_TREATMENT` |
-
diff --git a/doc/models/order-service-charge-type.md b/doc/models/order-service-charge-type.md
deleted file mode 100644
index 5c9f9159..00000000
--- a/doc/models/order-service-charge-type.md
+++ /dev/null
@@ -1,14 +0,0 @@
-
-# Order Service Charge Type
-
-## Enumeration
-
-`OrderServiceChargeType`
-
-## Fields
-
-| Name |
-| --- |
-| `AUTO_GRATUITY` |
-| `CUSTOM` |
-
diff --git a/doc/models/order-service-charge.md b/doc/models/order-service-charge.md
deleted file mode 100644
index df4b3561..00000000
--- a/doc/models/order-service-charge.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-# Order Service Charge
-
-Represents a service charge applied to an order.
-
-## Structure
-
-`OrderServiceCharge`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | A unique ID that identifies the service charge only within this order.
**Constraints**: *Maximum Length*: `60` | getUid(): ?string | setUid(?string uid): void |
-| `name` | `?string` | Optional | The name of the service charge.
**Constraints**: *Maximum Length*: `512` | getName(): ?string | setName(?string name): void |
-| `catalogObjectId` | `?string` | Optional | The catalog object ID referencing the service charge [CatalogObject](entity:CatalogObject).
**Constraints**: *Maximum Length*: `192` | getCatalogObjectId(): ?string | setCatalogObjectId(?string catalogObjectId): void |
-| `catalogVersion` | `?int` | Optional | The version of the catalog object that this service charge references. | getCatalogVersion(): ?int | setCatalogVersion(?int catalogVersion): void |
-| `percentage` | `?string` | Optional | The service charge percentage as a string representation of a
decimal number. For example, `"7.25"` indicates a service charge of 7.25%.
Exactly 1 of `percentage` or `amount_money` should be set.
**Constraints**: *Maximum Length*: `10` | getPercentage(): ?string | setPercentage(?string percentage): void |
-| `amountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): ?Money | setAmountMoney(?Money amountMoney): void |
-| `appliedMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAppliedMoney(): ?Money | setAppliedMoney(?Money appliedMoney): void |
-| `totalMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalMoney(): ?Money | setTotalMoney(?Money totalMoney): void |
-| `totalTaxMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalTaxMoney(): ?Money | setTotalTaxMoney(?Money totalTaxMoney): void |
-| `calculationPhase` | [`?string(OrderServiceChargeCalculationPhase)`](../../doc/models/order-service-charge-calculation-phase.md) | Optional | Represents a phase in the process of calculating order totals.
Service charges are applied after the indicated phase.
[Read more about how order totals are calculated.](https://developer.squareup.com/docs/orders-api/how-it-works#how-totals-are-calculated) | getCalculationPhase(): ?string | setCalculationPhase(?string calculationPhase): void |
-| `taxable` | `?bool` | Optional | Indicates whether the service charge can be taxed. If set to `true`,
order-level taxes automatically apply to the service charge. Note that
service charges calculated in the `TOTAL_PHASE` cannot be marked as taxable. | getTaxable(): ?bool | setTaxable(?bool taxable): void |
-| `appliedTaxes` | [`?(OrderLineItemAppliedTax[])`](../../doc/models/order-line-item-applied-tax.md) | Optional | The list of references to the taxes applied to this service charge. Each
`OrderLineItemAppliedTax` has a `tax_uid` that references the `uid` of a top-level
`OrderLineItemTax` that is being applied to this service charge. On reads, the amount applied
is populated.
An `OrderLineItemAppliedTax` is automatically created on every taxable service charge
for all `ORDER` scoped taxes that are added to the order. `OrderLineItemAppliedTax` records
for `LINE_ITEM` scoped taxes must be added in requests for the tax to apply to any taxable
service charge. Taxable service charges have the `taxable` field set to `true` and calculated
in the `SUBTOTAL_PHASE`.
To change the amount of a tax, modify the referenced top-level tax. | getAppliedTaxes(): ?array | setAppliedTaxes(?array appliedTaxes): void |
-| `metadata` | `?array` | Optional | Application-defined data attached to this service charge. Metadata fields are intended
to store descriptive references or associations with an entity in another system or store brief
information about the object. Square does not process this field; it only stores and returns it
in relevant API calls. Do not use metadata to store any sensitive information (such as personally
identifiable information or card details).
Keys written by applications must be 60 characters or less and must be in the character set
`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed
with a namespace, separated from the key with a ':' character.
Values have a maximum length of 255 characters.
An application can have up to 10 entries per metadata field.
Entries written by applications are private and can only be read or modified by the same
application.
For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). | getMetadata(): ?array | setMetadata(?array metadata): void |
-| `type` | [`?string(OrderServiceChargeType)`](../../doc/models/order-service-charge-type.md) | Optional | - | getType(): ?string | setType(?string type): void |
-| `treatmentType` | [`?string(OrderServiceChargeTreatmentType)`](../../doc/models/order-service-charge-treatment-type.md) | Optional | Indicates whether the service charge will be treated as a value-holding line item or
apportioned toward a line item. | getTreatmentType(): ?string | setTreatmentType(?string treatmentType): void |
-| `scope` | [`?string(OrderServiceChargeScope)`](../../doc/models/order-service-charge-scope.md) | Optional | Indicates whether this is a line-item or order-level apportioned
service charge. | getScope(): ?string | setScope(?string scope): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid2",
- "name": "name2",
- "catalog_object_id": "catalog_object_id6",
- "catalog_version": 104,
- "percentage": "percentage0"
-}
-```
-
diff --git a/doc/models/order-source.md b/doc/models/order-source.md
deleted file mode 100644
index 94402ff9..00000000
--- a/doc/models/order-source.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Order Source
-
-Represents the origination details of an order.
-
-## Structure
-
-`OrderSource`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `name` | `?string` | Optional | The name used to identify the place (physical or digital) that an order originates.
If unset, the name defaults to the name of the application that created the order. | getName(): ?string | setName(?string name): void |
-
-## Example (as JSON)
-
-```json
-{
- "name": "name2"
-}
-```
-
diff --git a/doc/models/order-state.md b/doc/models/order-state.md
deleted file mode 100644
index 9cc35bf0..00000000
--- a/doc/models/order-state.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# Order State
-
-The state of the order.
-
-## Enumeration
-
-`OrderState`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `OPEN` | Indicates that the order is open. Open orders can be updated. |
-| `COMPLETED` | Indicates that the order is completed. Completed orders are fully paid. This is a terminal state. |
-| `CANCELED` | Indicates that the order is canceled. Canceled orders are not paid. This is a terminal state. |
-| `DRAFT` | Indicates that the order is in a draft state. Draft orders can be updated,
but cannot be paid or fulfilled.
For more information, see [Create Orders](https://developer.squareup.com/docs/orders-api/create-orders). |
-
diff --git a/doc/models/order-updated-object.md b/doc/models/order-updated-object.md
deleted file mode 100644
index 5de0c4b6..00000000
--- a/doc/models/order-updated-object.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Order Updated Object
-
-## Structure
-
-`OrderUpdatedObject`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `orderUpdated` | [`?OrderUpdated`](../../doc/models/order-updated.md) | Optional | - | getOrderUpdated(): ?OrderUpdated | setOrderUpdated(?OrderUpdated orderUpdated): void |
-
-## Example (as JSON)
-
-```json
-{
- "order_updated": {
- "order_id": "order_id6",
- "version": 176,
- "location_id": "location_id4",
- "state": "OPEN",
- "created_at": "created_at2"
- }
-}
-```
-
diff --git a/doc/models/order-updated.md b/doc/models/order-updated.md
deleted file mode 100644
index 590324b7..00000000
--- a/doc/models/order-updated.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Order Updated
-
-## Structure
-
-`OrderUpdated`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `orderId` | `?string` | Optional | The order's unique ID. | getOrderId(): ?string | setOrderId(?string orderId): void |
-| `version` | `?int` | Optional | The version number, which is incremented each time an update is committed to the order.
Orders that were not created through the API do not include a version number and
therefore cannot be updated.
[Read more about working with versions.](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders) | getVersion(): ?int | setVersion(?int version): void |
-| `locationId` | `?string` | Optional | The ID of the seller location that this order is associated with. | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `state` | [`?string(OrderState)`](../../doc/models/order-state.md) | Optional | The state of the order. | getState(): ?string | setState(?string state): void |
-| `createdAt` | `?string` | Optional | The timestamp for when the order was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp for when the order was last updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "order_id": "order_id2",
- "version": 162,
- "location_id": "location_id2",
- "state": "CANCELED",
- "created_at": "created_at6"
-}
-```
-
diff --git a/doc/models/order.md b/doc/models/order.md
deleted file mode 100644
index f38d9861..00000000
--- a/doc/models/order.md
+++ /dev/null
@@ -1,88 +0,0 @@
-
-# Order
-
-Contains all information related to a single order to process with Square,
-including line items that specify the products to purchase. `Order` objects also
-include information about any associated tenders, refunds, and returns.
-
-All Connect V2 Transactions have all been converted to Orders including all associated
-itemization data.
-
-## Structure
-
-`Order`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The order's unique ID. | getId(): ?string | setId(?string id): void |
-| `locationId` | `string` | Required | The ID of the seller location that this order is associated with.
**Constraints**: *Minimum Length*: `1` | getLocationId(): string | setLocationId(string locationId): void |
-| `referenceId` | `?string` | Optional | A client-specified ID to associate an entity in another system
with this order.
**Constraints**: *Maximum Length*: `40` | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `source` | [`?OrderSource`](../../doc/models/order-source.md) | Optional | Represents the origination details of an order. | getSource(): ?OrderSource | setSource(?OrderSource source): void |
-| `customerId` | `?string` | Optional | The ID of the [customer](../../doc/models/customer.md) associated with the order.
You should specify a `customer_id` on the order (or the payment) to ensure that transactions
are reliably linked to customers. Omitting this field might result in the creation of new
[instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).
**Constraints**: *Maximum Length*: `191` | getCustomerId(): ?string | setCustomerId(?string customerId): void |
-| `lineItems` | [`?(OrderLineItem[])`](../../doc/models/order-line-item.md) | Optional | The line items included in the order. | getLineItems(): ?array | setLineItems(?array lineItems): void |
-| `taxes` | [`?(OrderLineItemTax[])`](../../doc/models/order-line-item-tax.md) | Optional | The list of all taxes associated with the order.
Taxes can be scoped to either `ORDER` or `LINE_ITEM`. For taxes with `LINE_ITEM` scope, an
`OrderLineItemAppliedTax` must be added to each line item that the tax applies to. For taxes
with `ORDER` scope, the server generates an `OrderLineItemAppliedTax` for every line item.
On reads, each tax in the list includes the total amount of that tax applied to the order.
__IMPORTANT__: If `LINE_ITEM` scope is set on any taxes in this field, using the deprecated
`line_items.taxes` field results in an error. Use `line_items.applied_taxes`
instead. | getTaxes(): ?array | setTaxes(?array taxes): void |
-| `discounts` | [`?(OrderLineItemDiscount[])`](../../doc/models/order-line-item-discount.md) | Optional | The list of all discounts associated with the order.
Discounts can be scoped to either `ORDER` or `LINE_ITEM`. For discounts scoped to `LINE_ITEM`,
an `OrderLineItemAppliedDiscount` must be added to each line item that the discount applies to.
For discounts with `ORDER` scope, the server generates an `OrderLineItemAppliedDiscount`
for every line item.
__IMPORTANT__: If `LINE_ITEM` scope is set on any discounts in this field, using the deprecated
`line_items.discounts` field results in an error. Use `line_items.applied_discounts`
instead. | getDiscounts(): ?array | setDiscounts(?array discounts): void |
-| `serviceCharges` | [`?(OrderServiceCharge[])`](../../doc/models/order-service-charge.md) | Optional | A list of service charges applied to the order. | getServiceCharges(): ?array | setServiceCharges(?array serviceCharges): void |
-| `fulfillments` | [`?(Fulfillment[])`](../../doc/models/fulfillment.md) | Optional | Details about order fulfillment.
Orders can only be created with at most one fulfillment. However, orders returned
by the API might contain multiple fulfillments. | getFulfillments(): ?array | setFulfillments(?array fulfillments): void |
-| `returns` | [`?(OrderReturn[])`](../../doc/models/order-return.md) | Optional | A collection of items from sale orders being returned in this one. Normally part of an
itemized return or exchange. There is exactly one `Return` object per sale `Order` being
referenced. | getReturns(): ?array | setReturns(?array returns): void |
-| `returnAmounts` | [`?OrderMoneyAmounts`](../../doc/models/order-money-amounts.md) | Optional | A collection of various money amounts. | getReturnAmounts(): ?OrderMoneyAmounts | setReturnAmounts(?OrderMoneyAmounts returnAmounts): void |
-| `netAmounts` | [`?OrderMoneyAmounts`](../../doc/models/order-money-amounts.md) | Optional | A collection of various money amounts. | getNetAmounts(): ?OrderMoneyAmounts | setNetAmounts(?OrderMoneyAmounts netAmounts): void |
-| `roundingAdjustment` | [`?OrderRoundingAdjustment`](../../doc/models/order-rounding-adjustment.md) | Optional | A rounding adjustment of the money being returned. Commonly used to apply cash rounding
when the minimum unit of the account is smaller than the lowest physical denomination of the currency. | getRoundingAdjustment(): ?OrderRoundingAdjustment | setRoundingAdjustment(?OrderRoundingAdjustment roundingAdjustment): void |
-| `tenders` | [`?(Tender[])`](../../doc/models/tender.md) | Optional | The tenders that were used to pay for the order. | getTenders(): ?array | setTenders(?array tenders): void |
-| `refunds` | [`?(Refund[])`](../../doc/models/refund.md) | Optional | The refunds that are part of this order. | getRefunds(): ?array | setRefunds(?array refunds): void |
-| `metadata` | `?array` | Optional | Application-defined data attached to this order. Metadata fields are intended
to store descriptive references or associations with an entity in another system or store brief
information about the object. Square does not process this field; it only stores and returns it
in relevant API calls. Do not use metadata to store any sensitive information (such as personally
identifiable information or card details).
Keys written by applications must be 60 characters or less and must be in the character set
`[a-zA-Z0-9_-]`. Entries can also include metadata generated by Square. These keys are prefixed
with a namespace, separated from the key with a ':' character.
Values have a maximum length of 255 characters.
An application can have up to 10 entries per metadata field.
Entries written by applications are private and can only be read or modified by the same
application.
For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). | getMetadata(): ?array | setMetadata(?array metadata): void |
-| `createdAt` | `?string` | Optional | The timestamp for when the order was created, at server side, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp for when the order was last updated, at server side, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `closedAt` | `?string` | Optional | The timestamp for when the order reached a terminal [state](entity:OrderState), in RFC 3339 format (for example "2016-09-04T23:59:33.123Z"). | getClosedAt(): ?string | setClosedAt(?string closedAt): void |
-| `state` | [`?string(OrderState)`](../../doc/models/order-state.md) | Optional | The state of the order. | getState(): ?string | setState(?string state): void |
-| `version` | `?int` | Optional | The version number, which is incremented each time an update is committed to the order.
Orders not created through the API do not include a version number and
therefore cannot be updated.
[Read more about working with versions](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders). | getVersion(): ?int | setVersion(?int version): void |
-| `totalMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalMoney(): ?Money | setTotalMoney(?Money totalMoney): void |
-| `totalTaxMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalTaxMoney(): ?Money | setTotalTaxMoney(?Money totalTaxMoney): void |
-| `totalDiscountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalDiscountMoney(): ?Money | setTotalDiscountMoney(?Money totalDiscountMoney): void |
-| `totalTipMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalTipMoney(): ?Money | setTotalTipMoney(?Money totalTipMoney): void |
-| `totalServiceChargeMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalServiceChargeMoney(): ?Money | setTotalServiceChargeMoney(?Money totalServiceChargeMoney): void |
-| `ticketName` | `?string` | Optional | A short-term identifier for the order (such as a customer first name,
table number, or auto-generated order number that resets daily).
**Constraints**: *Maximum Length*: `30` | getTicketName(): ?string | setTicketName(?string ticketName): void |
-| `pricingOptions` | [`?OrderPricingOptions`](../../doc/models/order-pricing-options.md) | Optional | Pricing options for an order. The options affect how the order's price is calculated.
They can be used, for example, to apply automatic price adjustments that are based on preconfigured
[pricing rules](../../doc/models/catalog-pricing-rule.md). | getPricingOptions(): ?OrderPricingOptions | setPricingOptions(?OrderPricingOptions pricingOptions): void |
-| `rewards` | [`?(OrderReward[])`](../../doc/models/order-reward.md) | Optional | A set-like list of Rewards that have been added to the Order. | getRewards(): ?array | setRewards(?array rewards): void |
-| `netAmountDueMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getNetAmountDueMoney(): ?Money | setNetAmountDueMoney(?Money netAmountDueMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id2",
- "location_id": "location_id6",
- "reference_id": "reference_id0",
- "source": {
- "name": "name4"
- },
- "customer_id": "customer_id0",
- "line_items": [
- {
- "uid": "uid8",
- "name": "name8",
- "quantity": "quantity4",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- }
- ]
-}
-```
-
diff --git a/doc/models/pagination-cursor.md b/doc/models/pagination-cursor.md
deleted file mode 100644
index 2ae83ee3..00000000
--- a/doc/models/pagination-cursor.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-# Pagination Cursor
-
-Used *internally* to encapsulate pagination details. The resulting proto will be base62 encoded
-in order to produce a cursor that can be used externally.
-
-## Structure
-
-`PaginationCursor`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `orderValue` | `?string` | Optional | The ID of the last resource in the current page. The page can be in an ascending or
descending order | getOrderValue(): ?string | setOrderValue(?string orderValue): void |
-
-## Example (as JSON)
-
-```json
-{
- "order_value": "order_value4"
-}
-```
-
diff --git a/doc/models/pause-subscription-request.md b/doc/models/pause-subscription-request.md
deleted file mode 100644
index 4d4bbaaf..00000000
--- a/doc/models/pause-subscription-request.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Pause Subscription Request
-
-Defines input parameters in a request to the
-[PauseSubscription](../../doc/apis/subscriptions.md#pause-subscription) endpoint.
-
-## Structure
-
-`PauseSubscriptionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `pauseEffectiveDate` | `?string` | Optional | The `YYYY-MM-DD`-formatted date when the scheduled `PAUSE` action takes place on the subscription.
When this date is unspecified or falls within the current billing cycle, the subscription is paused
on the starting date of the next billing cycle. | getPauseEffectiveDate(): ?string | setPauseEffectiveDate(?string pauseEffectiveDate): void |
-| `pauseCycleDuration` | `?int` | Optional | The number of billing cycles the subscription will be paused before it is reactivated.
When this is set, a `RESUME` action is also scheduled to take place on the subscription at
the end of the specified pause cycle duration. In this case, neither `resume_effective_date`
nor `resume_change_timing` may be specified. | getPauseCycleDuration(): ?int | setPauseCycleDuration(?int pauseCycleDuration): void |
-| `resumeEffectiveDate` | `?string` | Optional | The date when the subscription is reactivated by a scheduled `RESUME` action.
This date must be at least one billing cycle ahead of `pause_effective_date`. | getResumeEffectiveDate(): ?string | setResumeEffectiveDate(?string resumeEffectiveDate): void |
-| `resumeChangeTiming` | [`?string(ChangeTiming)`](../../doc/models/change-timing.md) | Optional | Supported timings when a pending change, as an action, takes place to a subscription. | getResumeChangeTiming(): ?string | setResumeChangeTiming(?string resumeChangeTiming): void |
-| `pauseReason` | `?string` | Optional | The user-provided reason to pause the subscription.
**Constraints**: *Maximum Length*: `255` | getPauseReason(): ?string | setPauseReason(?string pauseReason): void |
-
-## Example (as JSON)
-
-```json
-{
- "pause_effective_date": "pause_effective_date2",
- "pause_cycle_duration": 98,
- "resume_effective_date": "resume_effective_date0",
- "resume_change_timing": "IMMEDIATE",
- "pause_reason": "pause_reason6"
-}
-```
-
diff --git a/doc/models/pause-subscription-response.md b/doc/models/pause-subscription-response.md
deleted file mode 100644
index 35d3522f..00000000
--- a/doc/models/pause-subscription-response.md
+++ /dev/null
@@ -1,84 +0,0 @@
-
-# Pause Subscription Response
-
-Defines output parameters in a response from the
-[PauseSubscription](../../doc/apis/subscriptions.md#pause-subscription) endpoint.
-
-## Structure
-
-`PauseSubscriptionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `subscription` | [`?Subscription`](../../doc/models/subscription.md) | Optional | Represents a subscription purchased by a customer.
For more information, see
[Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions). | getSubscription(): ?Subscription | setSubscription(?Subscription subscription): void |
-| `actions` | [`?(SubscriptionAction[])`](../../doc/models/subscription-action.md) | Optional | The list of a `PAUSE` action and a possible `RESUME` action created by the request. | getActions(): ?array | setActions(?array actions): void |
-
-## Example (as JSON)
-
-```json
-{
- "actions": [
- {
- "effective_date": "2023-11-17",
- "id": "99b2439e-63f7-3ad5-95f7-ab2447a80673",
- "type": "PAUSE",
- "monthly_billing_anchor_date": 186,
- "phases": [
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- },
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- },
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- }
- ]
- }
- ],
- "subscription": {
- "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB",
- "created_at": "2023-06-20T21:53:10Z",
- "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
- "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f",
- "location_id": "S8GWD5R9QB376",
- "phases": [
- {
- "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY",
- "ordinal": 0,
- "plan_phase_uid": "X2Q2AONPB3RB64Y27S25QCZP",
- "uid": "873451e0-745b-4e87-ab0b-c574933fe616"
- }
- ],
- "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
- "source": {
- "name": "My Application"
- },
- "start_date": "2023-06-20",
- "status": "ACTIVE",
- "timezone": "America/Los_Angeles",
- "version": 1
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/pay-order-request.md b/doc/models/pay-order-request.md
deleted file mode 100644
index cf42d485..00000000
--- a/doc/models/pay-order-request.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Pay Order Request
-
-Defines the fields that are included in requests to the
-[PayOrder](../../doc/apis/orders.md#pay-order) endpoint.
-
-## Structure
-
-`PayOrderRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A value you specify that uniquely identifies this request among requests you have sent. If
you are unsure whether a particular payment request was completed successfully, you can reattempt
it with the same idempotency key without worrying about duplicate payments.
For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `192` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `orderVersion` | `?int` | Optional | The version of the order being paid. If not supplied, the latest version will be paid. | getOrderVersion(): ?int | setOrderVersion(?int orderVersion): void |
-| `paymentIds` | `?(string[])` | Optional | The IDs of the [payments](entity:Payment) to collect.
The payment total must match the order total. | getPaymentIds(): ?array | setPaymentIds(?array paymentIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "c043a359-7ad9-4136-82a9-c3f1d66dcbff",
- "payment_ids": [
- "EnZdNAlWCmfh6Mt5FMNST1o7taB",
- "0LRiVlbXVwe8ozu4KbZxd12mvaB"
- ],
- "order_version": 102
-}
-```
-
diff --git a/doc/models/pay-order-response.md b/doc/models/pay-order-response.md
deleted file mode 100644
index 72418c6f..00000000
--- a/doc/models/pay-order-response.md
+++ /dev/null
@@ -1,226 +0,0 @@
-
-# Pay Order Response
-
-Defines the fields that are included in the response body of a request to the
-[PayOrder](../../doc/apis/orders.md#pay-order) endpoint.
-
-## Structure
-
-`PayOrderResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `order` | [`?Order`](../../doc/models/order.md) | Optional | Contains all information related to a single order to process with Square,
including line items that specify the products to purchase. `Order` objects also
include information about any associated tenders, refunds, and returns.
All Connect V2 Transactions have all been converted to Orders including all associated
itemization data. | getOrder(): ?Order | setOrder(?Order order): void |
-
-## Example (as JSON)
-
-```json
-{
- "order": {
- "closed_at": "2019-08-06T02:47:37.140Z",
- "created_at": "2019-08-06T02:47:35.693Z",
- "id": "lgwOlEityYPJtcuvKTVKT1pA986YY",
- "line_items": [
- {
- "base_price_money": {
- "amount": 500,
- "currency": "USD"
- },
- "gross_sales_money": {
- "amount": 500,
- "currency": "USD"
- },
- "name": "Item 1",
- "quantity": "1",
- "total_discount_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_money": {
- "amount": 500,
- "currency": "USD"
- },
- "total_service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 0,
- "currency": "USD"
- },
- "uid": "QW6kofLHJK7JEKMjlSVP5C",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- },
- {
- "base_price_money": {
- "amount": 750,
- "currency": "USD"
- },
- "gross_sales_money": {
- "amount": 1500,
- "currency": "USD"
- },
- "name": "Item 2",
- "quantity": "2",
- "total_discount_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_money": {
- "amount": 1500,
- "currency": "USD"
- },
- "total_service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 0,
- "currency": "USD"
- },
- "uid": "zhw8MNfRGdFQMI2WE1UBJD",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- }
- ],
- "location_id": "P3CCK6HSNDAS7",
- "net_amounts": {
- "discount_money": {
- "amount": 0,
- "currency": "USD"
- },
- "service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "tax_money": {
- "amount": 0,
- "currency": "USD"
- },
- "tip_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_money": {
- "amount": 2000,
- "currency": "USD"
- }
- },
- "source": {
- "name": "Source Name"
- },
- "state": "COMPLETED",
- "tenders": [
- {
- "amount_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "card_details": {
- "card": {
- "card_brand": "VISA",
- "exp_month": 2,
- "exp_year": 2022,
- "fingerprint": "sq-1-n_BL15KP87ClDa4-h2nXOI0fp5VnxNH6hfhzqhptTfAgxgLuGFcg6jIPngDz4IkkTQ",
- "last_4": "1111"
- },
- "entry_method": "KEYED",
- "status": "CAPTURED"
- },
- "created_at": "2019-08-06T02:47:36.293Z",
- "id": "EnZdNAlWCmfh6Mt5FMNST1o7taB",
- "location_id": "P3CCK6HSNDAS7",
- "payment_id": "EnZdNAlWCmfh6Mt5FMNST1o7taB",
- "transaction_id": "lgwOlEityYPJtcuvKTVKT1pA986YY",
- "type": "CARD"
- },
- {
- "amount_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "card_details": {
- "card": {
- "card_brand": "VISA",
- "exp_month": 2,
- "exp_year": 2022,
- "fingerprint": "sq-1-n_BL15KP87ClDa4-h2nXOI0fp5VnxNH6hfhzqhptTfAgxgLuGFcg6jIPngDz4IkkTQ",
- "last_4": "1111"
- },
- "entry_method": "KEYED",
- "status": "CAPTURED"
- },
- "created_at": "2019-08-06T02:47:36.809Z",
- "id": "0LRiVlbXVwe8ozu4KbZxd12mvaB",
- "location_id": "P3CCK6HSNDAS7",
- "payment_id": "0LRiVlbXVwe8ozu4KbZxd12mvaB",
- "transaction_id": "lgwOlEityYPJtcuvKTVKT1pA986YY",
- "type": "CARD"
- }
- ],
- "total_discount_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_money": {
- "amount": 2000,
- "currency": "USD"
- },
- "total_service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 0,
- "currency": "USD"
- },
- "updated_at": "2019-08-06T02:47:37.140Z",
- "version": 4,
- "reference_id": "reference_id4",
- "customer_id": "customer_id4"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/payment-balance-activity-app-fee-refund-detail.md b/doc/models/payment-balance-activity-app-fee-refund-detail.md
deleted file mode 100644
index f55d899f..00000000
--- a/doc/models/payment-balance-activity-app-fee-refund-detail.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Payment Balance Activity App Fee Refund Detail
-
-## Structure
-
-`PaymentBalanceActivityAppFeeRefundDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-| `refundId` | `?string` | Optional | The ID of the refund associated with this activity. | getRefundId(): ?string | setRefundId(?string refundId): void |
-| `locationId` | `?string` | Optional | The ID of the location of the merchant associated with the payment refund activity | getLocationId(): ?string | setLocationId(?string locationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id4",
- "refund_id": "refund_id8",
- "location_id": "location_id8"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-app-fee-revenue-detail.md b/doc/models/payment-balance-activity-app-fee-revenue-detail.md
deleted file mode 100644
index 9688954a..00000000
--- a/doc/models/payment-balance-activity-app-fee-revenue-detail.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Payment Balance Activity App Fee Revenue Detail
-
-## Structure
-
-`PaymentBalanceActivityAppFeeRevenueDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-| `locationId` | `?string` | Optional | The ID of the location of the merchant associated with the payment activity | getLocationId(): ?string | setLocationId(?string locationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id0",
- "location_id": "location_id4"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-automatic-savings-detail.md b/doc/models/payment-balance-activity-automatic-savings-detail.md
deleted file mode 100644
index e60a9396..00000000
--- a/doc/models/payment-balance-activity-automatic-savings-detail.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Payment Balance Activity Automatic Savings Detail
-
-## Structure
-
-`PaymentBalanceActivityAutomaticSavingsDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-| `payoutId` | `?string` | Optional | The ID of the payout associated with this activity. | getPayoutId(): ?string | setPayoutId(?string payoutId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id4",
- "payout_id": "payout_id0"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-automatic-savings-reversed-detail.md b/doc/models/payment-balance-activity-automatic-savings-reversed-detail.md
deleted file mode 100644
index b102da23..00000000
--- a/doc/models/payment-balance-activity-automatic-savings-reversed-detail.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Payment Balance Activity Automatic Savings Reversed Detail
-
-## Structure
-
-`PaymentBalanceActivityAutomaticSavingsReversedDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-| `payoutId` | `?string` | Optional | The ID of the payout associated with this activity. | getPayoutId(): ?string | setPayoutId(?string payoutId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id6",
- "payout_id": "payout_id2"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-charge-detail.md b/doc/models/payment-balance-activity-charge-detail.md
deleted file mode 100644
index 5243ab7c..00000000
--- a/doc/models/payment-balance-activity-charge-detail.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Balance Activity Charge Detail
-
-## Structure
-
-`PaymentBalanceActivityChargeDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id2"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-deposit-fee-detail.md b/doc/models/payment-balance-activity-deposit-fee-detail.md
deleted file mode 100644
index 4b123844..00000000
--- a/doc/models/payment-balance-activity-deposit-fee-detail.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Balance Activity Deposit Fee Detail
-
-## Structure
-
-`PaymentBalanceActivityDepositFeeDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `payoutId` | `?string` | Optional | The ID of the payout that triggered this deposit fee activity. | getPayoutId(): ?string | setPayoutId(?string payoutId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payout_id": "payout_id2"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-deposit-fee-reversed-detail.md b/doc/models/payment-balance-activity-deposit-fee-reversed-detail.md
deleted file mode 100644
index 928237b0..00000000
--- a/doc/models/payment-balance-activity-deposit-fee-reversed-detail.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Balance Activity Deposit Fee Reversed Detail
-
-## Structure
-
-`PaymentBalanceActivityDepositFeeReversedDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `payoutId` | `?string` | Optional | The ID of the payout that triggered this deposit fee activity. | getPayoutId(): ?string | setPayoutId(?string payoutId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payout_id": "payout_id6"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-dispute-detail.md b/doc/models/payment-balance-activity-dispute-detail.md
deleted file mode 100644
index 43851703..00000000
--- a/doc/models/payment-balance-activity-dispute-detail.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Payment Balance Activity Dispute Detail
-
-## Structure
-
-`PaymentBalanceActivityDisputeDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-| `disputeId` | `?string` | Optional | The ID of the dispute associated with this activity. | getDisputeId(): ?string | setDisputeId(?string disputeId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id2",
- "dispute_id": "dispute_id4"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-fee-detail.md b/doc/models/payment-balance-activity-fee-detail.md
deleted file mode 100644
index f8f01f34..00000000
--- a/doc/models/payment-balance-activity-fee-detail.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Balance Activity Fee Detail
-
-## Structure
-
-`PaymentBalanceActivityFeeDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity
This will only be populated when a principal LedgerEntryToken is also populated.
If the fee is independent (there is no principal LedgerEntryToken) then this will likely not
be populated. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id2"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-free-processing-detail.md b/doc/models/payment-balance-activity-free-processing-detail.md
deleted file mode 100644
index 9fb7d830..00000000
--- a/doc/models/payment-balance-activity-free-processing-detail.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Balance Activity Free Processing Detail
-
-## Structure
-
-`PaymentBalanceActivityFreeProcessingDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id8"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-hold-adjustment-detail.md b/doc/models/payment-balance-activity-hold-adjustment-detail.md
deleted file mode 100644
index 6099d08d..00000000
--- a/doc/models/payment-balance-activity-hold-adjustment-detail.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Balance Activity Hold Adjustment Detail
-
-## Structure
-
-`PaymentBalanceActivityHoldAdjustmentDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id6"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-open-dispute-detail.md b/doc/models/payment-balance-activity-open-dispute-detail.md
deleted file mode 100644
index 5adf39a1..00000000
--- a/doc/models/payment-balance-activity-open-dispute-detail.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Payment Balance Activity Open Dispute Detail
-
-## Structure
-
-`PaymentBalanceActivityOpenDisputeDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-| `disputeId` | `?string` | Optional | The ID of the dispute associated with this activity. | getDisputeId(): ?string | setDisputeId(?string disputeId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id6",
- "dispute_id": "dispute_id8"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-other-adjustment-detail.md b/doc/models/payment-balance-activity-other-adjustment-detail.md
deleted file mode 100644
index 80fe5f6c..00000000
--- a/doc/models/payment-balance-activity-other-adjustment-detail.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Balance Activity Other Adjustment Detail
-
-## Structure
-
-`PaymentBalanceActivityOtherAdjustmentDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id4"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-other-detail.md b/doc/models/payment-balance-activity-other-detail.md
deleted file mode 100644
index 1d86d416..00000000
--- a/doc/models/payment-balance-activity-other-detail.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Balance Activity Other Detail
-
-## Structure
-
-`PaymentBalanceActivityOtherDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id4"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-refund-detail.md b/doc/models/payment-balance-activity-refund-detail.md
deleted file mode 100644
index b4716d5f..00000000
--- a/doc/models/payment-balance-activity-refund-detail.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Payment Balance Activity Refund Detail
-
-## Structure
-
-`PaymentBalanceActivityRefundDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-| `refundId` | `?string` | Optional | The ID of the refund associated with this activity. | getRefundId(): ?string | setRefundId(?string refundId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id6",
- "refund_id": "refund_id0"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-release-adjustment-detail.md b/doc/models/payment-balance-activity-release-adjustment-detail.md
deleted file mode 100644
index 7c8d31d2..00000000
--- a/doc/models/payment-balance-activity-release-adjustment-detail.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Balance Activity Release Adjustment Detail
-
-## Structure
-
-`PaymentBalanceActivityReleaseAdjustmentDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id0"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-reserve-hold-detail.md b/doc/models/payment-balance-activity-reserve-hold-detail.md
deleted file mode 100644
index bd119266..00000000
--- a/doc/models/payment-balance-activity-reserve-hold-detail.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Balance Activity Reserve Hold Detail
-
-## Structure
-
-`PaymentBalanceActivityReserveHoldDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id8"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-reserve-release-detail.md b/doc/models/payment-balance-activity-reserve-release-detail.md
deleted file mode 100644
index 01d9b961..00000000
--- a/doc/models/payment-balance-activity-reserve-release-detail.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Balance Activity Reserve Release Detail
-
-## Structure
-
-`PaymentBalanceActivityReserveReleaseDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id6"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-square-capital-payment-detail.md b/doc/models/payment-balance-activity-square-capital-payment-detail.md
deleted file mode 100644
index 5d3e069b..00000000
--- a/doc/models/payment-balance-activity-square-capital-payment-detail.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Balance Activity Square Capital Payment Detail
-
-## Structure
-
-`PaymentBalanceActivitySquareCapitalPaymentDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id6"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-square-capital-reversed-payment-detail.md b/doc/models/payment-balance-activity-square-capital-reversed-payment-detail.md
deleted file mode 100644
index 1e40f55b..00000000
--- a/doc/models/payment-balance-activity-square-capital-reversed-payment-detail.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Balance Activity Square Capital Reversed Payment Detail
-
-## Structure
-
-`PaymentBalanceActivitySquareCapitalReversedPaymentDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id8"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-square-payroll-transfer-detail.md b/doc/models/payment-balance-activity-square-payroll-transfer-detail.md
deleted file mode 100644
index c4d55c6f..00000000
--- a/doc/models/payment-balance-activity-square-payroll-transfer-detail.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Balance Activity Square Payroll Transfer Detail
-
-## Structure
-
-`PaymentBalanceActivitySquarePayrollTransferDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id0"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-square-payroll-transfer-reversed-detail.md b/doc/models/payment-balance-activity-square-payroll-transfer-reversed-detail.md
deleted file mode 100644
index 52f46119..00000000
--- a/doc/models/payment-balance-activity-square-payroll-transfer-reversed-detail.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Balance Activity Square Payroll Transfer Reversed Detail
-
-## Structure
-
-`PaymentBalanceActivitySquarePayrollTransferReversedDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id6"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-tax-on-fee-detail.md b/doc/models/payment-balance-activity-tax-on-fee-detail.md
deleted file mode 100644
index 5c2e2d6e..00000000
--- a/doc/models/payment-balance-activity-tax-on-fee-detail.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Payment Balance Activity Tax on Fee Detail
-
-## Structure
-
-`PaymentBalanceActivityTaxOnFeeDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-| `taxRateDescription` | `?string` | Optional | The description of the tax rate being applied. For example: "GST", "HST". | getTaxRateDescription(): ?string | setTaxRateDescription(?string taxRateDescription): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id0",
- "tax_rate_description": "tax_rate_description8"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-third-party-fee-detail.md b/doc/models/payment-balance-activity-third-party-fee-detail.md
deleted file mode 100644
index e737f813..00000000
--- a/doc/models/payment-balance-activity-third-party-fee-detail.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Payment Balance Activity Third Party Fee Detail
-
-## Structure
-
-`PaymentBalanceActivityThirdPartyFeeDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id8"
-}
-```
-
diff --git a/doc/models/payment-balance-activity-third-party-fee-refund-detail.md b/doc/models/payment-balance-activity-third-party-fee-refund-detail.md
deleted file mode 100644
index 776313fc..00000000
--- a/doc/models/payment-balance-activity-third-party-fee-refund-detail.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Payment Balance Activity Third Party Fee Refund Detail
-
-## Structure
-
-`PaymentBalanceActivityThirdPartyFeeRefundDetail`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this activity. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-| `refundId` | `?string` | Optional | The public refund id associated with this activity. | getRefundId(): ?string | setRefundId(?string refundId): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id6",
- "refund_id": "refund_id0"
-}
-```
-
diff --git a/doc/models/payment-link-related-resources.md b/doc/models/payment-link-related-resources.md
deleted file mode 100644
index 92be9a97..00000000
--- a/doc/models/payment-link-related-resources.md
+++ /dev/null
@@ -1,223 +0,0 @@
-
-# Payment Link Related Resources
-
-## Structure
-
-`PaymentLinkRelatedResources`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `orders` | [`?(Order[])`](../../doc/models/order.md) | Optional | The order associated with the payment link. | getOrders(): ?array | setOrders(?array orders): void |
-| `subscriptionPlans` | [`?(CatalogObject[])`](../../doc/models/catalog-object.md) | Optional | The subscription plan associated with the payment link. | getSubscriptionPlans(): ?array | setSubscriptionPlans(?array subscriptionPlans): void |
-
-## Example (as JSON)
-
-```json
-{
- "orders": [
- {
- "id": "id2",
- "location_id": "location_id6",
- "reference_id": "reference_id0",
- "source": {
- "name": "name4"
- },
- "customer_id": "customer_id0",
- "line_items": [
- {
- "uid": "uid8",
- "name": "name8",
- "quantity": "quantity4",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- },
- {
- "uid": "uid8",
- "name": "name8",
- "quantity": "quantity4",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- }
- ]
- },
- {
- "id": "id2",
- "location_id": "location_id6",
- "reference_id": "reference_id0",
- "source": {
- "name": "name4"
- },
- "customer_id": "customer_id0",
- "line_items": [
- {
- "uid": "uid8",
- "name": "name8",
- "quantity": "quantity4",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- },
- {
- "uid": "uid8",
- "name": "name8",
- "quantity": "quantity4",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- }
- ]
- }
- ],
- "subscription_plans": [
- {
- "type": "ITEM_OPTION",
- "id": "id4",
- "updated_at": "updated_at0",
- "version": 112,
- "is_deleted": false,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key2": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- },
- {
- "type": "ITEM_OPTION",
- "id": "id4",
- "updated_at": "updated_at0",
- "version": 112,
- "is_deleted": false,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key2": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- }
- ]
-}
-```
-
diff --git a/doc/models/payment-link.md b/doc/models/payment-link.md
deleted file mode 100644
index f831c68c..00000000
--- a/doc/models/payment-link.md
+++ /dev/null
@@ -1,59 +0,0 @@
-
-# Payment Link
-
-## Structure
-
-`PaymentLink`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The Square-assigned ID of the payment link. | getId(): ?string | setId(?string id): void |
-| `version` | `int` | Required | The Square-assigned version number, which is incremented each time an update is committed to the payment link.
**Constraints**: `<= 65535` | getVersion(): int | setVersion(int version): void |
-| `description` | `?string` | Optional | The optional description of the `payment_link` object.
It is primarily for use by your application and is not used anywhere.
**Constraints**: *Maximum Length*: `4096` | getDescription(): ?string | setDescription(?string description): void |
-| `orderId` | `?string` | Optional | The ID of the order associated with the payment link.
**Constraints**: *Maximum Length*: `192` | getOrderId(): ?string | setOrderId(?string orderId): void |
-| `checkoutOptions` | [`?CheckoutOptions`](../../doc/models/checkout-options.md) | Optional | - | getCheckoutOptions(): ?CheckoutOptions | setCheckoutOptions(?CheckoutOptions checkoutOptions): void |
-| `prePopulatedData` | [`?PrePopulatedData`](../../doc/models/pre-populated-data.md) | Optional | Describes buyer data to prepopulate in the payment form.
For more information,
see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations). | getPrePopulatedData(): ?PrePopulatedData | setPrePopulatedData(?PrePopulatedData prePopulatedData): void |
-| `url` | `?string` | Optional | The shortened URL of the payment link.
**Constraints**: *Maximum Length*: `255` | getUrl(): ?string | setUrl(?string url): void |
-| `longUrl` | `?string` | Optional | The long URL of the payment link.
**Constraints**: *Maximum Length*: `255` | getLongUrl(): ?string | setLongUrl(?string longUrl): void |
-| `createdAt` | `?string` | Optional | The timestamp when the payment link was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp when the payment link was last updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `paymentNote` | `?string` | Optional | An optional note. After Square processes the payment, this note is added to the
resulting `Payment`.
**Constraints**: *Maximum Length*: `500` | getPaymentNote(): ?string | setPaymentNote(?string paymentNote): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id2",
- "version": 64,
- "description": "description8",
- "order_id": "order_id4",
- "checkout_options": {
- "allow_tipping": false,
- "custom_fields": [
- {
- "title": "title8"
- },
- {
- "title": "title8"
- }
- ],
- "subscription_plan_id": "subscription_plan_id8",
- "redirect_url": "redirect_url2",
- "merchant_support_email": "merchant_support_email8"
- },
- "pre_populated_data": {
- "buyer_email": "buyer_email8",
- "buyer_phone_number": "buyer_phone_number0",
- "buyer_address": {
- "address_line_1": "address_line_12",
- "address_line_2": "address_line_22",
- "address_line_3": "address_line_38",
- "locality": "locality2",
- "sublocality": "sublocality2"
- }
- }
-}
-```
-
diff --git a/doc/models/payment-options-delay-action.md b/doc/models/payment-options-delay-action.md
deleted file mode 100644
index 447fa0c1..00000000
--- a/doc/models/payment-options-delay-action.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Payment Options Delay Action
-
-Describes the action to be applied to a delayed capture payment when the delay_duration
-has elapsed.
-
-## Enumeration
-
-`PaymentOptionsDelayAction`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `CANCEL` | Indicates that the payment should be automatically canceled when the delay duration
elapses. |
-| `COMPLETE` | Indicates that the payment should be automatically completed when the delay duration
elapses. |
-
diff --git a/doc/models/payment-options.md b/doc/models/payment-options.md
deleted file mode 100644
index 3822a7da..00000000
--- a/doc/models/payment-options.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Payment Options
-
-## Structure
-
-`PaymentOptions`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `autocomplete` | `?bool` | Optional | Indicates whether the `Payment` objects created from this `TerminalCheckout` are automatically
`COMPLETED` or left in an `APPROVED` state for later modification. | getAutocomplete(): ?bool | setAutocomplete(?bool autocomplete): void |
-| `delayDuration` | `?string` | Optional | The duration of time after the payment's creation when Square automatically cancels the
payment. This automatic cancellation applies only to payments that do not reach a terminal state
(COMPLETED or CANCELED) before the `delay_duration` time period.
This parameter should be specified as a time duration, in RFC 3339 format, with a minimum value
of 1 minute.
Note: This feature is only supported for card payments. This parameter can only be set for a delayed
capture payment (`autocomplete=false`).
Default:
- Card-present payments: "PT36H" (36 hours) from the creation time.
- Card-not-present payments: "P7D" (7 days) from the creation time. | getDelayDuration(): ?string | setDelayDuration(?string delayDuration): void |
-| `acceptPartialAuthorization` | `?bool` | Optional | If set to `true` and charging a Square Gift Card, a payment might be returned with
`amount_money` equal to less than what was requested. For example, a request for $20 when charging
a Square Gift Card with a balance of $5 results in an APPROVED payment of $5. You might choose
to prompt the buyer for an additional payment to cover the remainder or cancel the Gift Card
payment.
This field cannot be `true` when `autocomplete = true`.
This field cannot be `true` when an `order_id` isn't specified.
For more information, see
[Take Partial Payments](https://developer.squareup.com/docs/payments-api/take-payments/card-payments/partial-payments-with-gift-cards).
Default: false | getAcceptPartialAuthorization(): ?bool | setAcceptPartialAuthorization(?bool acceptPartialAuthorization): void |
-| `delayAction` | [`?string(PaymentOptionsDelayAction)`](../../doc/models/payment-options-delay-action.md) | Optional | Describes the action to be applied to a delayed capture payment when the delay_duration
has elapsed. | getDelayAction(): ?string | setDelayAction(?string delayAction): void |
-
-## Example (as JSON)
-
-```json
-{
- "autocomplete": false,
- "delay_duration": "delay_duration8",
- "accept_partial_authorization": false,
- "delay_action": "CANCEL"
-}
-```
-
diff --git a/doc/models/payment-refund.md b/doc/models/payment-refund.md
deleted file mode 100644
index 62757910..00000000
--- a/doc/models/payment-refund.md
+++ /dev/null
@@ -1,75 +0,0 @@
-
-# Payment Refund
-
-Represents a refund of a payment made using Square. Contains information about
-the original payment and the amount of money refunded.
-
-## Structure
-
-`PaymentRefund`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `string` | Required | The unique ID for this refund, generated by Square.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getId(): string | setId(string id): void |
-| `status` | `?string` | Optional | The refund's status:
- `PENDING` - Awaiting approval.
- `COMPLETED` - Successfully completed.
- `REJECTED` - The refund was rejected.
- `FAILED` - An error occurred.
**Constraints**: *Maximum Length*: `50` | getStatus(): ?string | setStatus(?string status): void |
-| `locationId` | `?string` | Optional | The location ID associated with the payment this refund is attached to.
**Constraints**: *Maximum Length*: `50` | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `unlinked` | `?bool` | Optional | Flag indicating whether or not the refund is linked to an existing payment in Square. | getUnlinked(): ?bool | setUnlinked(?bool unlinked): void |
-| `destinationType` | `?string` | Optional | The destination type for this refund.
Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `BUY_NOW_PAY_LATER`, `CASH`,
`EXTERNAL`, and `SQUARE_ACCOUNT`.
**Constraints**: *Maximum Length*: `50` | getDestinationType(): ?string | setDestinationType(?string destinationType): void |
-| `destinationDetails` | [`?DestinationDetails`](../../doc/models/destination-details.md) | Optional | Details about a refund's destination. | getDestinationDetails(): ?DestinationDetails | setDestinationDetails(?DestinationDetails destinationDetails): void |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-| `appFeeMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAppFeeMoney(): ?Money | setAppFeeMoney(?Money appFeeMoney): void |
-| `processingFee` | [`?(ProcessingFee[])`](../../doc/models/processing-fee.md) | Optional | Processing fees and fee adjustments assessed by Square for this refund. | getProcessingFee(): ?array | setProcessingFee(?array processingFee): void |
-| `paymentId` | `?string` | Optional | The ID of the payment associated with this refund.
**Constraints**: *Maximum Length*: `192` | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-| `orderId` | `?string` | Optional | The ID of the order associated with the refund.
**Constraints**: *Maximum Length*: `192` | getOrderId(): ?string | setOrderId(?string orderId): void |
-| `reason` | `?string` | Optional | The reason for the refund.
**Constraints**: *Maximum Length*: `192` | getReason(): ?string | setReason(?string reason): void |
-| `createdAt` | `?string` | Optional | The timestamp of when the refund was created, in RFC 3339 format.
**Constraints**: *Maximum Length*: `32` | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp of when the refund was last updated, in RFC 3339 format.
**Constraints**: *Maximum Length*: `32` | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `teamMemberId` | `?string` | Optional | An optional ID of the team member associated with taking the payment.
**Constraints**: *Maximum Length*: `192` | getTeamMemberId(): ?string | setTeamMemberId(?string teamMemberId): void |
-| `terminalRefundId` | `?string` | Optional | An optional ID for a Terminal refund. | getTerminalRefundId(): ?string | setTerminalRefundId(?string terminalRefundId): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id4",
- "status": "status6",
- "location_id": "location_id8",
- "unlinked": false,
- "destination_type": "destination_type8",
- "destination_details": {
- "card_details": {
- "card": {
- "id": "id6",
- "card_brand": "OTHER_BRAND",
- "last_4": "last_48",
- "exp_month": 228,
- "exp_year": 68
- },
- "entry_method": "entry_method8",
- "auth_result_code": "auth_result_code0"
- },
- "cash_details": {
- "seller_supplied_money": {
- "amount": 36,
- "currency": "MKD"
- },
- "change_back_money": {
- "amount": 78,
- "currency": "XBD"
- }
- },
- "external_details": {
- "type": "type6",
- "source": "source0",
- "source_id": "source_id8"
- }
- },
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- }
-}
-```
-
diff --git a/doc/models/payment-sort-field.md b/doc/models/payment-sort-field.md
deleted file mode 100644
index 4fe5d19e..00000000
--- a/doc/models/payment-sort-field.md
+++ /dev/null
@@ -1,15 +0,0 @@
-
-# Payment Sort Field
-
-## Enumeration
-
-`PaymentSortField`
-
-## Fields
-
-| Name |
-| --- |
-| `CREATED_AT` |
-| `OFFLINE_CREATED_AT` |
-| `UPDATED_AT` |
-
diff --git a/doc/models/payment.md b/doc/models/payment.md
deleted file mode 100644
index 1f6d9905..00000000
--- a/doc/models/payment.md
+++ /dev/null
@@ -1,76 +0,0 @@
-
-# Payment
-
-Represents a payment processed by the Square API.
-
-## Structure
-
-`Payment`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A unique ID for the payment.
**Constraints**: *Maximum Length*: `192` | getId(): ?string | setId(?string id): void |
-| `createdAt` | `?string` | Optional | The timestamp of when the payment was created, in RFC 3339 format.
**Constraints**: *Maximum Length*: `32` | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp of when the payment was last updated, in RFC 3339 format.
**Constraints**: *Maximum Length*: `32` | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `amountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): ?Money | setAmountMoney(?Money amountMoney): void |
-| `tipMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTipMoney(): ?Money | setTipMoney(?Money tipMoney): void |
-| `totalMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTotalMoney(): ?Money | setTotalMoney(?Money totalMoney): void |
-| `appFeeMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAppFeeMoney(): ?Money | setAppFeeMoney(?Money appFeeMoney): void |
-| `approvedMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getApprovedMoney(): ?Money | setApprovedMoney(?Money approvedMoney): void |
-| `processingFee` | [`?(ProcessingFee[])`](../../doc/models/processing-fee.md) | Optional | The processing fees and fee adjustments assessed by Square for this payment. | getProcessingFee(): ?array | setProcessingFee(?array processingFee): void |
-| `refundedMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getRefundedMoney(): ?Money | setRefundedMoney(?Money refundedMoney): void |
-| `status` | `?string` | Optional | Indicates whether the payment is APPROVED, PENDING, COMPLETED, CANCELED, or FAILED.
**Constraints**: *Maximum Length*: `50` | getStatus(): ?string | setStatus(?string status): void |
-| `delayDuration` | `?string` | Optional | The duration of time after the payment's creation when Square automatically applies the
`delay_action` to the payment. This automatic `delay_action` applies only to payments that
do not reach a terminal state (COMPLETED, CANCELED, or FAILED) before the `delay_duration`
time period.
This field is specified as a time duration, in RFC 3339 format.
Notes:
This feature is only supported for card payments.
Default:
- Card-present payments: "PT36H" (36 hours) from the creation time.
- Card-not-present payments: "P7D" (7 days) from the creation time. | getDelayDuration(): ?string | setDelayDuration(?string delayDuration): void |
-| `delayAction` | `?string` | Optional | The action to be applied to the payment when the `delay_duration` has elapsed.
Current values include `CANCEL` and `COMPLETE`. | getDelayAction(): ?string | setDelayAction(?string delayAction): void |
-| `delayedUntil` | `?string` | Optional | The read-only timestamp of when the `delay_action` is automatically applied,
in RFC 3339 format.
Note that this field is calculated by summing the payment's `delay_duration` and `created_at`
fields. The `created_at` field is generated by Square and might not exactly match the
time on your local machine. | getDelayedUntil(): ?string | setDelayedUntil(?string delayedUntil): void |
-| `sourceType` | `?string` | Optional | The source type for this payment.
Current values include `CARD`, `BANK_ACCOUNT`, `WALLET`, `BUY_NOW_PAY_LATER`, `SQUARE_ACCOUNT`,
`CASH` and `EXTERNAL`. For information about these payment source types,
see [Take Payments](https://developer.squareup.com/docs/payments-api/take-payments).
**Constraints**: *Maximum Length*: `50` | getSourceType(): ?string | setSourceType(?string sourceType): void |
-| `cardDetails` | [`?CardPaymentDetails`](../../doc/models/card-payment-details.md) | Optional | Reflects the current status of a card payment. Contains only non-confidential information. | getCardDetails(): ?CardPaymentDetails | setCardDetails(?CardPaymentDetails cardDetails): void |
-| `cashDetails` | [`?CashPaymentDetails`](../../doc/models/cash-payment-details.md) | Optional | Stores details about a cash payment. Contains only non-confidential information. For more information, see
[Take Cash Payments](https://developer.squareup.com/docs/payments-api/take-payments/cash-payments). | getCashDetails(): ?CashPaymentDetails | setCashDetails(?CashPaymentDetails cashDetails): void |
-| `bankAccountDetails` | [`?BankAccountPaymentDetails`](../../doc/models/bank-account-payment-details.md) | Optional | Additional details about BANK_ACCOUNT type payments. | getBankAccountDetails(): ?BankAccountPaymentDetails | setBankAccountDetails(?BankAccountPaymentDetails bankAccountDetails): void |
-| `externalDetails` | [`?ExternalPaymentDetails`](../../doc/models/external-payment-details.md) | Optional | Stores details about an external payment. Contains only non-confidential information.
For more information, see
[Take External Payments](https://developer.squareup.com/docs/payments-api/take-payments/external-payments). | getExternalDetails(): ?ExternalPaymentDetails | setExternalDetails(?ExternalPaymentDetails externalDetails): void |
-| `walletDetails` | [`?DigitalWalletDetails`](../../doc/models/digital-wallet-details.md) | Optional | Additional details about `WALLET` type payments. Contains only non-confidential information. | getWalletDetails(): ?DigitalWalletDetails | setWalletDetails(?DigitalWalletDetails walletDetails): void |
-| `buyNowPayLaterDetails` | [`?BuyNowPayLaterDetails`](../../doc/models/buy-now-pay-later-details.md) | Optional | Additional details about a Buy Now Pay Later payment type. | getBuyNowPayLaterDetails(): ?BuyNowPayLaterDetails | setBuyNowPayLaterDetails(?BuyNowPayLaterDetails buyNowPayLaterDetails): void |
-| `squareAccountDetails` | [`?SquareAccountDetails`](../../doc/models/square-account-details.md) | Optional | Additional details about Square Account payments. | getSquareAccountDetails(): ?SquareAccountDetails | setSquareAccountDetails(?SquareAccountDetails squareAccountDetails): void |
-| `locationId` | `?string` | Optional | The ID of the location associated with the payment.
**Constraints**: *Maximum Length*: `50` | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `orderId` | `?string` | Optional | The ID of the order associated with the payment.
**Constraints**: *Maximum Length*: `192` | getOrderId(): ?string | setOrderId(?string orderId): void |
-| `referenceId` | `?string` | Optional | An optional ID that associates the payment with an entity in
another system.
**Constraints**: *Maximum Length*: `40` | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `customerId` | `?string` | Optional | The ID of the customer associated with the payment. If the ID is
not provided in the `CreatePayment` request that was used to create the `Payment`,
Square may use information in the request
(such as the billing and shipping address, email address, and payment source)
to identify a matching customer profile in the Customer Directory.
If found, the profile ID is used. If a profile is not found, the
API attempts to create an
[instant profile](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles).
If the API cannot create an
instant profile (either because the seller has disabled it or the
seller's region prevents creating it), this field remains unset. Note that
this process is asynchronous and it may take some time before a
customer ID is added to the payment.
**Constraints**: *Maximum Length*: `191` | getCustomerId(): ?string | setCustomerId(?string customerId): void |
-| `employeeId` | `?string` | Optional | __Deprecated__: Use `Payment.team_member_id` instead.
An optional ID of the employee associated with taking the payment.
**Constraints**: *Maximum Length*: `192` | getEmployeeId(): ?string | setEmployeeId(?string employeeId): void |
-| `teamMemberId` | `?string` | Optional | An optional ID of the [TeamMember](entity:TeamMember) associated with taking the payment.
**Constraints**: *Maximum Length*: `192` | getTeamMemberId(): ?string | setTeamMemberId(?string teamMemberId): void |
-| `refundIds` | `?(string[])` | Optional | A list of `refund_id`s identifying refunds for the payment. | getRefundIds(): ?array | setRefundIds(?array refundIds): void |
-| `riskEvaluation` | [`?RiskEvaluation`](../../doc/models/risk-evaluation.md) | Optional | Represents fraud risk information for the associated payment.
When you take a payment through Square's Payments API (using the `CreatePayment`
endpoint), Square evaluates it and assigns a risk level to the payment. Sellers
can use this information to determine the course of action (for example,
provide the goods/services or refund the payment). | getRiskEvaluation(): ?RiskEvaluation | setRiskEvaluation(?RiskEvaluation riskEvaluation): void |
-| `terminalCheckoutId` | `?string` | Optional | An optional ID for a Terminal checkout that is associated with the payment. | getTerminalCheckoutId(): ?string | setTerminalCheckoutId(?string terminalCheckoutId): void |
-| `buyerEmailAddress` | `?string` | Optional | The buyer's email address.
**Constraints**: *Maximum Length*: `255` | getBuyerEmailAddress(): ?string | setBuyerEmailAddress(?string buyerEmailAddress): void |
-| `billingAddress` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getBillingAddress(): ?Address | setBillingAddress(?Address billingAddress): void |
-| `shippingAddress` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getShippingAddress(): ?Address | setShippingAddress(?Address shippingAddress): void |
-| `note` | `?string` | Optional | An optional note to include when creating a payment.
**Constraints**: *Maximum Length*: `500` | getNote(): ?string | setNote(?string note): void |
-| `statementDescriptionIdentifier` | `?string` | Optional | Additional payment information that gets added to the customer's card statement
as part of the statement description.
Note that the `statement_description_identifier` might get truncated on the statement description
to fit the required information including the Square identifier (SQ *) and the name of the
seller taking the payment. | getStatementDescriptionIdentifier(): ?string | setStatementDescriptionIdentifier(?string statementDescriptionIdentifier): void |
-| `capabilities` | `?(string[])` | Optional | Actions that can be performed on this payment:
- `EDIT_AMOUNT_UP` - The payment amount can be edited up.
- `EDIT_AMOUNT_DOWN` - The payment amount can be edited down.
- `EDIT_TIP_AMOUNT_UP` - The tip amount can be edited up.
- `EDIT_TIP_AMOUNT_DOWN` - The tip amount can be edited down.
- `EDIT_DELAY_ACTION` - The delay_action can be edited. | getCapabilities(): ?array | setCapabilities(?array capabilities): void |
-| `receiptNumber` | `?string` | Optional | The payment's receipt number.
The field is missing if a payment is canceled.
**Constraints**: *Maximum Length*: `4` | getReceiptNumber(): ?string | setReceiptNumber(?string receiptNumber): void |
-| `receiptUrl` | `?string` | Optional | The URL for the payment's receipt.
The field is only populated for COMPLETED payments.
**Constraints**: *Maximum Length*: `255` | getReceiptUrl(): ?string | setReceiptUrl(?string receiptUrl): void |
-| `deviceDetails` | [`?DeviceDetails`](../../doc/models/device-details.md) | Optional | Details about the device that took the payment. | getDeviceDetails(): ?DeviceDetails | setDeviceDetails(?DeviceDetails deviceDetails): void |
-| `applicationDetails` | [`?ApplicationDetails`](../../doc/models/application-details.md) | Optional | Details about the application that took the payment. | getApplicationDetails(): ?ApplicationDetails | setApplicationDetails(?ApplicationDetails applicationDetails): void |
-| `isOfflinePayment` | `?bool` | Optional | Whether or not this payment was taken offline. | getIsOfflinePayment(): ?bool | setIsOfflinePayment(?bool isOfflinePayment): void |
-| `offlinePaymentDetails` | [`?OfflinePaymentDetails`](../../doc/models/offline-payment-details.md) | Optional | Details specific to offline payments. | getOfflinePaymentDetails(): ?OfflinePaymentDetails | setOfflinePaymentDetails(?OfflinePaymentDetails offlinePaymentDetails): void |
-| `versionToken` | `?string` | Optional | Used for optimistic concurrency. This opaque token identifies a specific version of the
`Payment` object. | getVersionToken(): ?string | setVersionToken(?string versionToken): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id8",
- "created_at": "created_at6",
- "updated_at": "updated_at4",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "tip_money": {
- "amount": 190,
- "currency": "TWD"
- }
-}
-```
-
diff --git a/doc/models/payout-entry.md b/doc/models/payout-entry.md
deleted file mode 100644
index 807bafc7..00000000
--- a/doc/models/payout-entry.md
+++ /dev/null
@@ -1,70 +0,0 @@
-
-# Payout Entry
-
-One or more PayoutEntries that make up a Payout. Each one has a date, amount, and type of activity.
-The total amount of the payout will equal the sum of the payout entries for a batch payout
-
-## Structure
-
-`PayoutEntry`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `string` | Required | A unique ID for the payout entry.
**Constraints**: *Minimum Length*: `1` | getId(): string | setId(string id): void |
-| `payoutId` | `string` | Required | The ID of the payout entries’ associated payout.
**Constraints**: *Minimum Length*: `1` | getPayoutId(): string | setPayoutId(string payoutId): void |
-| `effectiveAt` | `?string` | Optional | The timestamp of when the payout entry affected the balance, in RFC 3339 format. | getEffectiveAt(): ?string | setEffectiveAt(?string effectiveAt): void |
-| `type` | [`?string(ActivityType)`](../../doc/models/activity-type.md) | Optional | - | getType(): ?string | setType(?string type): void |
-| `grossAmountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getGrossAmountMoney(): ?Money | setGrossAmountMoney(?Money grossAmountMoney): void |
-| `feeAmountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getFeeAmountMoney(): ?Money | setFeeAmountMoney(?Money feeAmountMoney): void |
-| `netAmountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getNetAmountMoney(): ?Money | setNetAmountMoney(?Money netAmountMoney): void |
-| `typeAppFeeRevenueDetails` | [`?PaymentBalanceActivityAppFeeRevenueDetail`](../../doc/models/payment-balance-activity-app-fee-revenue-detail.md) | Optional | - | getTypeAppFeeRevenueDetails(): ?PaymentBalanceActivityAppFeeRevenueDetail | setTypeAppFeeRevenueDetails(?PaymentBalanceActivityAppFeeRevenueDetail typeAppFeeRevenueDetails): void |
-| `typeAppFeeRefundDetails` | [`?PaymentBalanceActivityAppFeeRefundDetail`](../../doc/models/payment-balance-activity-app-fee-refund-detail.md) | Optional | - | getTypeAppFeeRefundDetails(): ?PaymentBalanceActivityAppFeeRefundDetail | setTypeAppFeeRefundDetails(?PaymentBalanceActivityAppFeeRefundDetail typeAppFeeRefundDetails): void |
-| `typeAutomaticSavingsDetails` | [`?PaymentBalanceActivityAutomaticSavingsDetail`](../../doc/models/payment-balance-activity-automatic-savings-detail.md) | Optional | - | getTypeAutomaticSavingsDetails(): ?PaymentBalanceActivityAutomaticSavingsDetail | setTypeAutomaticSavingsDetails(?PaymentBalanceActivityAutomaticSavingsDetail typeAutomaticSavingsDetails): void |
-| `typeAutomaticSavingsReversedDetails` | [`?PaymentBalanceActivityAutomaticSavingsReversedDetail`](../../doc/models/payment-balance-activity-automatic-savings-reversed-detail.md) | Optional | - | getTypeAutomaticSavingsReversedDetails(): ?PaymentBalanceActivityAutomaticSavingsReversedDetail | setTypeAutomaticSavingsReversedDetails(?PaymentBalanceActivityAutomaticSavingsReversedDetail typeAutomaticSavingsReversedDetails): void |
-| `typeChargeDetails` | [`?PaymentBalanceActivityChargeDetail`](../../doc/models/payment-balance-activity-charge-detail.md) | Optional | - | getTypeChargeDetails(): ?PaymentBalanceActivityChargeDetail | setTypeChargeDetails(?PaymentBalanceActivityChargeDetail typeChargeDetails): void |
-| `typeDepositFeeDetails` | [`?PaymentBalanceActivityDepositFeeDetail`](../../doc/models/payment-balance-activity-deposit-fee-detail.md) | Optional | - | getTypeDepositFeeDetails(): ?PaymentBalanceActivityDepositFeeDetail | setTypeDepositFeeDetails(?PaymentBalanceActivityDepositFeeDetail typeDepositFeeDetails): void |
-| `typeDepositFeeReversedDetails` | [`?PaymentBalanceActivityDepositFeeReversedDetail`](../../doc/models/payment-balance-activity-deposit-fee-reversed-detail.md) | Optional | - | getTypeDepositFeeReversedDetails(): ?PaymentBalanceActivityDepositFeeReversedDetail | setTypeDepositFeeReversedDetails(?PaymentBalanceActivityDepositFeeReversedDetail typeDepositFeeReversedDetails): void |
-| `typeDisputeDetails` | [`?PaymentBalanceActivityDisputeDetail`](../../doc/models/payment-balance-activity-dispute-detail.md) | Optional | - | getTypeDisputeDetails(): ?PaymentBalanceActivityDisputeDetail | setTypeDisputeDetails(?PaymentBalanceActivityDisputeDetail typeDisputeDetails): void |
-| `typeFeeDetails` | [`?PaymentBalanceActivityFeeDetail`](../../doc/models/payment-balance-activity-fee-detail.md) | Optional | - | getTypeFeeDetails(): ?PaymentBalanceActivityFeeDetail | setTypeFeeDetails(?PaymentBalanceActivityFeeDetail typeFeeDetails): void |
-| `typeFreeProcessingDetails` | [`?PaymentBalanceActivityFreeProcessingDetail`](../../doc/models/payment-balance-activity-free-processing-detail.md) | Optional | - | getTypeFreeProcessingDetails(): ?PaymentBalanceActivityFreeProcessingDetail | setTypeFreeProcessingDetails(?PaymentBalanceActivityFreeProcessingDetail typeFreeProcessingDetails): void |
-| `typeHoldAdjustmentDetails` | [`?PaymentBalanceActivityHoldAdjustmentDetail`](../../doc/models/payment-balance-activity-hold-adjustment-detail.md) | Optional | - | getTypeHoldAdjustmentDetails(): ?PaymentBalanceActivityHoldAdjustmentDetail | setTypeHoldAdjustmentDetails(?PaymentBalanceActivityHoldAdjustmentDetail typeHoldAdjustmentDetails): void |
-| `typeOpenDisputeDetails` | [`?PaymentBalanceActivityOpenDisputeDetail`](../../doc/models/payment-balance-activity-open-dispute-detail.md) | Optional | - | getTypeOpenDisputeDetails(): ?PaymentBalanceActivityOpenDisputeDetail | setTypeOpenDisputeDetails(?PaymentBalanceActivityOpenDisputeDetail typeOpenDisputeDetails): void |
-| `typeOtherDetails` | [`?PaymentBalanceActivityOtherDetail`](../../doc/models/payment-balance-activity-other-detail.md) | Optional | - | getTypeOtherDetails(): ?PaymentBalanceActivityOtherDetail | setTypeOtherDetails(?PaymentBalanceActivityOtherDetail typeOtherDetails): void |
-| `typeOtherAdjustmentDetails` | [`?PaymentBalanceActivityOtherAdjustmentDetail`](../../doc/models/payment-balance-activity-other-adjustment-detail.md) | Optional | - | getTypeOtherAdjustmentDetails(): ?PaymentBalanceActivityOtherAdjustmentDetail | setTypeOtherAdjustmentDetails(?PaymentBalanceActivityOtherAdjustmentDetail typeOtherAdjustmentDetails): void |
-| `typeRefundDetails` | [`?PaymentBalanceActivityRefundDetail`](../../doc/models/payment-balance-activity-refund-detail.md) | Optional | - | getTypeRefundDetails(): ?PaymentBalanceActivityRefundDetail | setTypeRefundDetails(?PaymentBalanceActivityRefundDetail typeRefundDetails): void |
-| `typeReleaseAdjustmentDetails` | [`?PaymentBalanceActivityReleaseAdjustmentDetail`](../../doc/models/payment-balance-activity-release-adjustment-detail.md) | Optional | - | getTypeReleaseAdjustmentDetails(): ?PaymentBalanceActivityReleaseAdjustmentDetail | setTypeReleaseAdjustmentDetails(?PaymentBalanceActivityReleaseAdjustmentDetail typeReleaseAdjustmentDetails): void |
-| `typeReserveHoldDetails` | [`?PaymentBalanceActivityReserveHoldDetail`](../../doc/models/payment-balance-activity-reserve-hold-detail.md) | Optional | - | getTypeReserveHoldDetails(): ?PaymentBalanceActivityReserveHoldDetail | setTypeReserveHoldDetails(?PaymentBalanceActivityReserveHoldDetail typeReserveHoldDetails): void |
-| `typeReserveReleaseDetails` | [`?PaymentBalanceActivityReserveReleaseDetail`](../../doc/models/payment-balance-activity-reserve-release-detail.md) | Optional | - | getTypeReserveReleaseDetails(): ?PaymentBalanceActivityReserveReleaseDetail | setTypeReserveReleaseDetails(?PaymentBalanceActivityReserveReleaseDetail typeReserveReleaseDetails): void |
-| `typeSquareCapitalPaymentDetails` | [`?PaymentBalanceActivitySquareCapitalPaymentDetail`](../../doc/models/payment-balance-activity-square-capital-payment-detail.md) | Optional | - | getTypeSquareCapitalPaymentDetails(): ?PaymentBalanceActivitySquareCapitalPaymentDetail | setTypeSquareCapitalPaymentDetails(?PaymentBalanceActivitySquareCapitalPaymentDetail typeSquareCapitalPaymentDetails): void |
-| `typeSquareCapitalReversedPaymentDetails` | [`?PaymentBalanceActivitySquareCapitalReversedPaymentDetail`](../../doc/models/payment-balance-activity-square-capital-reversed-payment-detail.md) | Optional | - | getTypeSquareCapitalReversedPaymentDetails(): ?PaymentBalanceActivitySquareCapitalReversedPaymentDetail | setTypeSquareCapitalReversedPaymentDetails(?PaymentBalanceActivitySquareCapitalReversedPaymentDetail typeSquareCapitalReversedPaymentDetails): void |
-| `typeTaxOnFeeDetails` | [`?PaymentBalanceActivityTaxOnFeeDetail`](../../doc/models/payment-balance-activity-tax-on-fee-detail.md) | Optional | - | getTypeTaxOnFeeDetails(): ?PaymentBalanceActivityTaxOnFeeDetail | setTypeTaxOnFeeDetails(?PaymentBalanceActivityTaxOnFeeDetail typeTaxOnFeeDetails): void |
-| `typeThirdPartyFeeDetails` | [`?PaymentBalanceActivityThirdPartyFeeDetail`](../../doc/models/payment-balance-activity-third-party-fee-detail.md) | Optional | - | getTypeThirdPartyFeeDetails(): ?PaymentBalanceActivityThirdPartyFeeDetail | setTypeThirdPartyFeeDetails(?PaymentBalanceActivityThirdPartyFeeDetail typeThirdPartyFeeDetails): void |
-| `typeThirdPartyFeeRefundDetails` | [`?PaymentBalanceActivityThirdPartyFeeRefundDetail`](../../doc/models/payment-balance-activity-third-party-fee-refund-detail.md) | Optional | - | getTypeThirdPartyFeeRefundDetails(): ?PaymentBalanceActivityThirdPartyFeeRefundDetail | setTypeThirdPartyFeeRefundDetails(?PaymentBalanceActivityThirdPartyFeeRefundDetail typeThirdPartyFeeRefundDetails): void |
-| `typeSquarePayrollTransferDetails` | [`?PaymentBalanceActivitySquarePayrollTransferDetail`](../../doc/models/payment-balance-activity-square-payroll-transfer-detail.md) | Optional | - | getTypeSquarePayrollTransferDetails(): ?PaymentBalanceActivitySquarePayrollTransferDetail | setTypeSquarePayrollTransferDetails(?PaymentBalanceActivitySquarePayrollTransferDetail typeSquarePayrollTransferDetails): void |
-| `typeSquarePayrollTransferReversedDetails` | [`?PaymentBalanceActivitySquarePayrollTransferReversedDetail`](../../doc/models/payment-balance-activity-square-payroll-transfer-reversed-detail.md) | Optional | - | getTypeSquarePayrollTransferReversedDetails(): ?PaymentBalanceActivitySquarePayrollTransferReversedDetail | setTypeSquarePayrollTransferReversedDetails(?PaymentBalanceActivitySquarePayrollTransferReversedDetail typeSquarePayrollTransferReversedDetails): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id8",
- "payout_id": "payout_id4",
- "effective_at": "effective_at8",
- "type": "AUTOMATIC_SAVINGS_REVERSED",
- "gross_amount_money": {
- "amount": 186,
- "currency": "MNT"
- },
- "fee_amount_money": {
- "amount": 126,
- "currency": "CHF"
- },
- "net_amount_money": {
- "amount": 6,
- "currency": "XPT"
- }
-}
-```
-
diff --git a/doc/models/payout-fee-type.md b/doc/models/payout-fee-type.md
deleted file mode 100644
index afc863d6..00000000
--- a/doc/models/payout-fee-type.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Payout Fee Type
-
-Represents the type of payout fee that can incur as part of a payout.
-
-## Enumeration
-
-`PayoutFeeType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `TRANSFER_FEE` | Fee type associated with transfers. |
-| `TAX_ON_TRANSFER_FEE` | Taxes associated with the transfer fee. |
-
diff --git a/doc/models/payout-fee.md b/doc/models/payout-fee.md
deleted file mode 100644
index 74ee3074..00000000
--- a/doc/models/payout-fee.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Payout Fee
-
-Represents a payout fee that can incur as part of a payout.
-
-## Structure
-
-`PayoutFee`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `amountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): ?Money | setAmountMoney(?Money amountMoney): void |
-| `effectiveAt` | `?string` | Optional | The timestamp of when the fee takes effect, in RFC 3339 format. | getEffectiveAt(): ?string | setEffectiveAt(?string effectiveAt): void |
-| `type` | [`?string(PayoutFeeType)`](../../doc/models/payout-fee-type.md) | Optional | Represents the type of payout fee that can incur as part of a payout. | getType(): ?string | setType(?string type): void |
-
-## Example (as JSON)
-
-```json
-{
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "effective_at": "effective_at0",
- "type": "TRANSFER_FEE"
-}
-```
-
diff --git a/doc/models/payout-status.md b/doc/models/payout-status.md
deleted file mode 100644
index c46bf5af..00000000
--- a/doc/models/payout-status.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Payout Status
-
-Payout status types
-
-## Enumeration
-
-`PayoutStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `SENT` | Indicates that the payout was successfully sent to the banking destination. |
-| `FAILED` | Indicates that the payout was rejected by the banking destination. |
-| `PAID` | Indicates that the payout has successfully completed. |
-
diff --git a/doc/models/payout-type.md b/doc/models/payout-type.md
deleted file mode 100644
index 88d9aff0..00000000
--- a/doc/models/payout-type.md
+++ /dev/null
@@ -1,19 +0,0 @@
-
-# Payout Type
-
-The type of payout: “BATCH” or “SIMPLE”.
-BATCH payouts include a list of payout entries that can be considered settled.
-SIMPLE payouts do not have any payout entries associated with them
-and will show up as one of the payout entries in a future BATCH payout.
-
-## Enumeration
-
-`PayoutType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `BATCH` | Payouts that include a list of payout entries that can be considered settled. |
-| `SIMPLE` | Payouts that do not have any payout entries associated with them and will
show up as one of the payout entries in a future BATCH payout. |
-
diff --git a/doc/models/payout.md b/doc/models/payout.md
deleted file mode 100644
index e4dda144..00000000
--- a/doc/models/payout.md
+++ /dev/null
@@ -1,47 +0,0 @@
-
-# Payout
-
-An accounting of the amount owed the seller and record of the actual transfer to their
-external bank account or to the Square balance.
-
-## Structure
-
-`Payout`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `string` | Required | A unique ID for the payout.
**Constraints**: *Minimum Length*: `1` | getId(): string | setId(string id): void |
-| `status` | [`?string(PayoutStatus)`](../../doc/models/payout-status.md) | Optional | Payout status types | getStatus(): ?string | setStatus(?string status): void |
-| `locationId` | `string` | Required | The ID of the location associated with the payout.
**Constraints**: *Minimum Length*: `1` | getLocationId(): string | setLocationId(string locationId): void |
-| `createdAt` | `?string` | Optional | The timestamp of when the payout was created and submitted for deposit to the seller's banking destination, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp of when the payout was last updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `amountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): ?Money | setAmountMoney(?Money amountMoney): void |
-| `destination` | [`?Destination`](../../doc/models/destination.md) | Optional | Information about the destination against which the payout was made. | getDestination(): ?Destination | setDestination(?Destination destination): void |
-| `version` | `?int` | Optional | The version number, which is incremented each time an update is made to this payout record.
The version number helps developers receive event notifications or feeds out of order. | getVersion(): ?int | setVersion(?int version): void |
-| `type` | [`?string(PayoutType)`](../../doc/models/payout-type.md) | Optional | The type of payout: “BATCH” or “SIMPLE”.
BATCH payouts include a list of payout entries that can be considered settled.
SIMPLE payouts do not have any payout entries associated with them
and will show up as one of the payout entries in a future BATCH payout. | getType(): ?string | setType(?string type): void |
-| `payoutFee` | [`?(PayoutFee[])`](../../doc/models/payout-fee.md) | Optional | A list of transfer fees and any taxes on the fees assessed by Square for this payout. | getPayoutFee(): ?array | setPayoutFee(?array payoutFee): void |
-| `arrivalDate` | `?string` | Optional | The calendar date, in ISO 8601 format (YYYY-MM-DD), when the payout is due to arrive in the seller’s banking destination. | getArrivalDate(): ?string | setArrivalDate(?string arrivalDate): void |
-| `endToEndId` | `?string` | Optional | A unique ID for each `Payout` object that might also appear on the seller’s bank statement. You can use this ID to automate the process of reconciling each payout with the corresponding line item on the bank statement. | getEndToEndId(): ?string | setEndToEndId(?string endToEndId): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id4",
- "status": "SENT",
- "location_id": "location_id8",
- "created_at": "created_at2",
- "updated_at": "updated_at0",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "destination": {
- "type": "BANK_ACCOUNT",
- "id": "id4"
- }
-}
-```
-
diff --git a/doc/models/phase-input.md b/doc/models/phase-input.md
deleted file mode 100644
index 8d7a4b62..00000000
--- a/doc/models/phase-input.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Phase Input
-
-Represents the arguments used to construct a new phase.
-
-## Structure
-
-`PhaseInput`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `ordinal` | `int` | Required | index of phase in total subscription plan | getOrdinal(): int | setOrdinal(int ordinal): void |
-| `orderTemplateId` | `?string` | Optional | id of order to be used in billing | getOrderTemplateId(): ?string | setOrderTemplateId(?string orderTemplateId): void |
-
-## Example (as JSON)
-
-```json
-{
- "ordinal": 234,
- "order_template_id": "order_template_id4"
-}
-```
-
diff --git a/doc/models/phase.md b/doc/models/phase.md
deleted file mode 100644
index 493940fa..00000000
--- a/doc/models/phase.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Phase
-
-Represents a phase, which can override subscription phases as defined by plan_id
-
-## Structure
-
-`Phase`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | id of subscription phase | getUid(): ?string | setUid(?string uid): void |
-| `ordinal` | `?int` | Optional | index of phase in total subscription plan | getOrdinal(): ?int | setOrdinal(?int ordinal): void |
-| `orderTemplateId` | `?string` | Optional | id of order to be used in billing | getOrderTemplateId(): ?string | setOrderTemplateId(?string orderTemplateId): void |
-| `planPhaseUid` | `?string` | Optional | the uid from the plan's phase in catalog | getPlanPhaseUid(): ?string | setPlanPhaseUid(?string planPhaseUid): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid4",
- "ordinal": 12,
- "order_template_id": "order_template_id6",
- "plan_phase_uid": "plan_phase_uid0"
-}
-```
-
diff --git a/doc/models/pre-populated-data.md b/doc/models/pre-populated-data.md
deleted file mode 100644
index 9873726e..00000000
--- a/doc/models/pre-populated-data.md
+++ /dev/null
@@ -1,35 +0,0 @@
-
-# Pre Populated Data
-
-Describes buyer data to prepopulate in the payment form.
-For more information,
-see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations).
-
-## Structure
-
-`PrePopulatedData`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `buyerEmail` | `?string` | Optional | The buyer email to prepopulate in the payment form.
**Constraints**: *Maximum Length*: `256` | getBuyerEmail(): ?string | setBuyerEmail(?string buyerEmail): void |
-| `buyerPhoneNumber` | `?string` | Optional | The buyer phone number to prepopulate in the payment form.
**Constraints**: *Maximum Length*: `17` | getBuyerPhoneNumber(): ?string | setBuyerPhoneNumber(?string buyerPhoneNumber): void |
-| `buyerAddress` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getBuyerAddress(): ?Address | setBuyerAddress(?Address buyerAddress): void |
-
-## Example (as JSON)
-
-```json
-{
- "buyer_email": "buyer_email8",
- "buyer_phone_number": "buyer_phone_number0",
- "buyer_address": {
- "address_line_1": "address_line_12",
- "address_line_2": "address_line_22",
- "address_line_3": "address_line_38",
- "locality": "locality2",
- "sublocality": "sublocality2"
- }
-}
-```
-
diff --git a/doc/models/processing-fee.md b/doc/models/processing-fee.md
deleted file mode 100644
index c9330e5a..00000000
--- a/doc/models/processing-fee.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Processing Fee
-
-Represents the Square processing fee.
-
-## Structure
-
-`ProcessingFee`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `effectiveAt` | `?string` | Optional | The timestamp of when the fee takes effect, in RFC 3339 format. | getEffectiveAt(): ?string | setEffectiveAt(?string effectiveAt): void |
-| `type` | `?string` | Optional | The type of fee assessed or adjusted. The fee type can be `INITIAL` or `ADJUSTMENT`. | getType(): ?string | setType(?string type): void |
-| `amountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): ?Money | setAmountMoney(?Money amountMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "effective_at": "effective_at2",
- "type": "type8",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- }
-}
-```
-
diff --git a/doc/models/product-type.md b/doc/models/product-type.md
deleted file mode 100644
index 650994b2..00000000
--- a/doc/models/product-type.md
+++ /dev/null
@@ -1,13 +0,0 @@
-
-# Product Type
-
-## Enumeration
-
-`ProductType`
-
-## Fields
-
-| Name |
-| --- |
-| `TERMINAL_API` |
-
diff --git a/doc/models/product.md b/doc/models/product.md
deleted file mode 100644
index 699d85d8..00000000
--- a/doc/models/product.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-# Product
-
-Indicates the Square product used to generate a change.
-
-## Enumeration
-
-`Product`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `SQUARE_POS` | Square Point of Sale application. |
-| `EXTERNAL_API` | Square Connect APIs (for example, Orders API or Checkout API). |
-| `BILLING` | A Square subscription (various products). |
-| `APPOINTMENTS` | Square Appointments. |
-| `INVOICES` | Square Invoices. |
-| `ONLINE_STORE` | Square Online Store. |
-| `PAYROLL` | Square Payroll. |
-| `DASHBOARD` | Square Dashboard. |
-| `ITEM_LIBRARY_IMPORT` | Item Library Import. |
-| `OTHER` | A Square product that does not match any other value. |
-
diff --git a/doc/models/publish-invoice-request.md b/doc/models/publish-invoice-request.md
deleted file mode 100644
index 60f185ba..00000000
--- a/doc/models/publish-invoice-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Publish Invoice Request
-
-Describes a `PublishInvoice` request.
-
-## Structure
-
-`PublishInvoiceRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `version` | `int` | Required | The version of the [invoice](entity:Invoice) to publish.
This must match the current version of the invoice; otherwise, the request is rejected. | getVersion(): int | setVersion(int version): void |
-| `idempotencyKey` | `?string` | Optional | A unique string that identifies the `PublishInvoice` request. If you do not
provide `idempotency_key` (or provide an empty string as the value), the endpoint
treats each request as independent.
For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `128` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "32da42d0-1997-41b0-826b-f09464fc2c2e",
- "version": 1
-}
-```
-
diff --git a/doc/models/publish-invoice-response.md b/doc/models/publish-invoice-response.md
deleted file mode 100644
index 37bb27fa..00000000
--- a/doc/models/publish-invoice-response.md
+++ /dev/null
@@ -1,107 +0,0 @@
-
-# Publish Invoice Response
-
-Describes a `PublishInvoice` response.
-
-## Structure
-
-`PublishInvoiceResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `invoice` | [`?Invoice`](../../doc/models/invoice.md) | Optional | Stores information about an invoice. You use the Invoices API to create and manage
invoices. For more information, see [Invoices API Overview](https://developer.squareup.com/docs/invoices-api/overview). | getInvoice(): ?Invoice | setInvoice(?Invoice invoice): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "invoice": {
- "accepted_payment_methods": {
- "bank_account": false,
- "buy_now_pay_later": false,
- "card": true,
- "cash_app_pay": false,
- "square_gift_card": false
- },
- "created_at": "2020-06-18T17:45:13Z",
- "custom_fields": [
- {
- "label": "Event Reference Number",
- "placement": "ABOVE_LINE_ITEMS",
- "value": "Ref. #1234"
- },
- {
- "label": "Terms of Service",
- "placement": "BELOW_LINE_ITEMS",
- "value": "The terms of service are..."
- }
- ],
- "delivery_method": "EMAIL",
- "description": "We appreciate your business!",
- "id": "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY",
- "invoice_number": "inv-100",
- "location_id": "ES0RJRZYEC39A",
- "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY",
- "payment_requests": [
- {
- "automatic_payment_source": "NONE",
- "computed_amount_money": {
- "amount": 10000,
- "currency": "USD"
- },
- "due_date": "2030-01-24",
- "reminders": [
- {
- "message": "Your invoice is due tomorrow",
- "relative_scheduled_days": -1,
- "status": "PENDING",
- "uid": "beebd363-e47f-4075-8785-c235aaa7df11"
- }
- ],
- "request_type": "BALANCE",
- "tipping_enabled": true,
- "total_completed_amount_money": {
- "amount": 0,
- "currency": "USD"
- },
- "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355"
- }
- ],
- "primary_recipient": {
- "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "email_address": "Amelia.Earhart@example.com",
- "family_name": "Earhart",
- "given_name": "Amelia",
- "phone_number": "1-212-555-4240",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- },
- "public_url": "https://squareup.com/pay-invoice/inv:0-ChCHu2mZEabLeeHahQnXDjZQECY",
- "sale_or_service_date": "2030-01-24",
- "scheduled_at": "2030-01-13T10:00:00Z",
- "status": "SCHEDULED",
- "store_payment_method_enabled": false,
- "timezone": "America/Los_Angeles",
- "title": "Event Planning Services",
- "updated_at": "2020-06-18T18:23:11Z",
- "version": 1
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/qr-code-options.md b/doc/models/qr-code-options.md
deleted file mode 100644
index 1629b40c..00000000
--- a/doc/models/qr-code-options.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Qr Code Options
-
-Fields to describe the action that displays QR-Codes.
-
-## Structure
-
-`QrCodeOptions`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `title` | `string` | Required | The title text to display in the QR code flow on the Terminal.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `250` | getTitle(): string | setTitle(string title): void |
-| `body` | `string` | Required | The body text to display in the QR code flow on the Terminal.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `10000` | getBody(): string | setBody(string body): void |
-| `barcodeContents` | `string` | Required | The text representation of the data to show in the QR code
as UTF8-encoded data.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `1024` | getBarcodeContents(): string | setBarcodeContents(string barcodeContents): void |
-
-## Example (as JSON)
-
-```json
-{
- "title": "title8",
- "body": "body8",
- "barcode_contents": "barcode_contents4"
-}
-```
-
diff --git a/doc/models/quantity-ratio.md b/doc/models/quantity-ratio.md
deleted file mode 100644
index 02443bf3..00000000
--- a/doc/models/quantity-ratio.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Quantity Ratio
-
-A whole number or unreduced fractional ratio.
-
-## Structure
-
-`QuantityRatio`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `quantity` | `?int` | Optional | The whole or fractional quantity as the numerator. | getQuantity(): ?int | setQuantity(?int quantity): void |
-| `quantityDenominator` | `?int` | Optional | The whole or fractional quantity as the denominator.
With fractional quantity this field is the denominator and quantity is the numerator.
The default value is `1`. For example, when `quantity=3` and `quantity_denominator` is unspecified,
the quantity ratio is `3` or `3/1`. | getQuantityDenominator(): ?int | setQuantityDenominator(?int quantityDenominator): void |
-
-## Example (as JSON)
-
-```json
-{
- "quantity": 86,
- "quantity_denominator": 18
-}
-```
-
diff --git a/doc/models/quick-pay.md b/doc/models/quick-pay.md
deleted file mode 100644
index 6f5a64b5..00000000
--- a/doc/models/quick-pay.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Quick Pay
-
-Describes an ad hoc item and price to generate a quick pay checkout link.
-For more information,
-see [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick-pay-checkout).
-
-## Structure
-
-`QuickPay`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `name` | `string` | Required | The ad hoc item name. In the resulting `Order`, this name appears as the line item name.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getName(): string | setName(string name): void |
-| `priceMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getPriceMoney(): Money | setPriceMoney(Money priceMoney): void |
-| `locationId` | `string` | Required | The ID of the business location the checkout is associated with. | getLocationId(): string | setLocationId(string locationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "name": "name8",
- "price_money": {
- "amount": 202,
- "currency": "GTQ"
- },
- "location_id": "location_id2"
-}
-```
-
diff --git a/doc/models/range.md b/doc/models/range.md
deleted file mode 100644
index f96bd5a0..00000000
--- a/doc/models/range.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Range
-
-The range of a number value between the specified lower and upper bounds.
-
-## Structure
-
-`Range`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `min` | `?string` | Optional | The lower bound of the number range. At least one of `min` or `max` must be specified.
If unspecified, the results will have no minimum value. | getMin(): ?string | setMin(?string min): void |
-| `max` | `?string` | Optional | The upper bound of the number range. At least one of `min` or `max` must be specified.
If unspecified, the results will have no maximum value. | getMax(): ?string | setMax(?string max): void |
-
-## Example (as JSON)
-
-```json
-{
- "min": "min8",
- "max": "max0"
-}
-```
-
diff --git a/doc/models/receipt-options.md b/doc/models/receipt-options.md
deleted file mode 100644
index 32cd3294..00000000
--- a/doc/models/receipt-options.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Receipt Options
-
-Describes receipt action fields.
-
-## Structure
-
-`ReceiptOptions`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentId` | `string` | Required | The reference to the Square payment ID for the receipt. | getPaymentId(): string | setPaymentId(string paymentId): void |
-| `printOnly` | `?bool` | Optional | Instructs the device to print the receipt without displaying the receipt selection screen.
Requires `printer_enabled` set to true.
Defaults to false. | getPrintOnly(): ?bool | setPrintOnly(?bool printOnly): void |
-| `isDuplicate` | `?bool` | Optional | Identify the receipt as a reprint rather than an original receipt.
Defaults to false. | getIsDuplicate(): ?bool | setIsDuplicate(?bool isDuplicate): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_id": "payment_id6",
- "print_only": false,
- "is_duplicate": false
-}
-```
-
diff --git a/doc/models/redeem-loyalty-reward-request.md b/doc/models/redeem-loyalty-reward-request.md
deleted file mode 100644
index 4bd64655..00000000
--- a/doc/models/redeem-loyalty-reward-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Redeem Loyalty Reward Request
-
-A request to redeem a loyalty reward.
-
-## Structure
-
-`RedeemLoyaltyRewardRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A unique string that identifies this `RedeemLoyaltyReward` request.
Keys can be any valid string, but must be unique for every request.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `locationId` | `string` | Required | The ID of the [location](entity:Location) where the reward is redeemed.
**Constraints**: *Minimum Length*: `1` | getLocationId(): string | setLocationId(string locationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "98adc7f7-6963-473b-b29c-f3c9cdd7d994",
- "location_id": "P034NEENMD09F"
-}
-```
-
diff --git a/doc/models/redeem-loyalty-reward-response.md b/doc/models/redeem-loyalty-reward-response.md
deleted file mode 100644
index 0487c53c..00000000
--- a/doc/models/redeem-loyalty-reward-response.md
+++ /dev/null
@@ -1,70 +0,0 @@
-
-# Redeem Loyalty Reward Response
-
-A response that includes the `LoyaltyEvent` published for redeeming the reward.
-
-## Structure
-
-`RedeemLoyaltyRewardResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `event` | [`?LoyaltyEvent`](../../doc/models/loyalty-event.md) | Optional | Provides information about a loyalty event.
For more information, see [Search for Balance-Changing Loyalty Events](https://developer.squareup.com/docs/loyalty-api/loyalty-events). | getEvent(): ?LoyaltyEvent | setEvent(?LoyaltyEvent event): void |
-
-## Example (as JSON)
-
-```json
-{
- "event": {
- "created_at": "2020-05-08T21:56:00Z",
- "id": "67377a6e-dbdc-369d-aa16-2e7ed422e71f",
- "location_id": "P034NEENMD09F",
- "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
- "redeem_reward": {
- "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
- "reward_id": "9f18ac21-233a-31c3-be77-b45840f5a810",
- "order_id": "order_id8"
- },
- "source": "LOYALTY_API",
- "type": "REDEEM_REWARD",
- "accumulate_points": {
- "loyalty_program_id": "loyalty_program_id8",
- "points": 118,
- "order_id": "order_id8"
- },
- "create_reward": {
- "loyalty_program_id": "loyalty_program_id2",
- "reward_id": "reward_id6",
- "points": 90
- },
- "delete_reward": {
- "loyalty_program_id": "loyalty_program_id4",
- "reward_id": "reward_id8",
- "points": 104
- },
- "adjust_points": {
- "loyalty_program_id": "loyalty_program_id2",
- "points": 96,
- "reason": "reason2"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/refund-payment-request.md b/doc/models/refund-payment-request.md
deleted file mode 100644
index b7d97d82..00000000
--- a/doc/models/refund-payment-request.md
+++ /dev/null
@@ -1,48 +0,0 @@
-
-# Refund Payment Request
-
-Describes a request to refund a payment using [RefundPayment](../../doc/apis/refunds.md#refund-payment).
-
-## Structure
-
-`RefundPaymentRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A unique string that identifies this `RefundPayment` request. The key can be any valid string
but must be unique for every `RefundPayment` request.
Keys are limited to a max of 45 characters - however, the number of allowed characters might be
less than 45, if multi-byte characters are used.
For more information, see [Idempotency](https://developer.squareup.com/docs/working-with-apis/idempotency).
**Constraints**: *Minimum Length*: `1` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-| `appFeeMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAppFeeMoney(): ?Money | setAppFeeMoney(?Money appFeeMoney): void |
-| `paymentId` | `?string` | Optional | The unique ID of the payment being refunded.
Required when unlinked=false, otherwise must not be set. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-| `destinationId` | `?string` | Optional | The ID indicating where funds will be refunded to. Required for unlinked refunds. For more
information, see [Process an Unlinked Refund](https://developer.squareup.com/docs/refunds-api/unlinked-refunds).
For refunds linked to Square payments, `destination_id` is usually omitted; in this case, funds
will be returned to the original payment source. The field may be specified in order to request
a cross-method refund to a gift card. For more information,
see [Cross-method refunds to gift cards](https://developer.squareup.com/docs/payments-api/refund-payments#cross-method-refunds-to-gift-cards). | getDestinationId(): ?string | setDestinationId(?string destinationId): void |
-| `unlinked` | `?bool` | Optional | Indicates that the refund is not linked to a Square payment.
If set to true, `destination_id` and `location_id` must be supplied while `payment_id` must not
be provided. | getUnlinked(): ?bool | setUnlinked(?bool unlinked): void |
-| `locationId` | `?string` | Optional | The location ID associated with the unlinked refund.
Required for requests specifying `unlinked=true`.
Otherwise, if included when `unlinked=false`, will throw an error.
**Constraints**: *Maximum Length*: `50` | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `customerId` | `?string` | Optional | The [Customer](entity:Customer) ID of the customer associated with the refund.
This is required if the `destination_id` refers to a card on file created using the Cards
API. Only allowed when `unlinked=true`. | getCustomerId(): ?string | setCustomerId(?string customerId): void |
-| `reason` | `?string` | Optional | A description of the reason for the refund.
**Constraints**: *Maximum Length*: `192` | getReason(): ?string | setReason(?string reason): void |
-| `paymentVersionToken` | `?string` | Optional | Used for optimistic concurrency. This opaque token identifies the current `Payment`
version that the caller expects. If the server has a different version of the Payment,
the update fails and a response with a VERSION_MISMATCH error is returned.
If the versions match, or the field is not provided, the refund proceeds as normal. | getPaymentVersionToken(): ?string | setPaymentVersionToken(?string paymentVersionToken): void |
-| `teamMemberId` | `?string` | Optional | An optional [TeamMember](entity:TeamMember) ID to associate with this refund.
**Constraints**: *Maximum Length*: `192` | getTeamMemberId(): ?string | setTeamMemberId(?string teamMemberId): void |
-| `cashDetails` | [`?DestinationDetailsCashRefundDetails`](../../doc/models/destination-details-cash-refund-details.md) | Optional | Stores details about a cash refund. Contains only non-confidential information. | getCashDetails(): ?DestinationDetailsCashRefundDetails | setCashDetails(?DestinationDetailsCashRefundDetails cashDetails): void |
-| `externalDetails` | [`?DestinationDetailsExternalRefundDetails`](../../doc/models/destination-details-external-refund-details.md) | Optional | Stores details about an external refund. Contains only non-confidential information. | getExternalDetails(): ?DestinationDetailsExternalRefundDetails | setExternalDetails(?DestinationDetailsExternalRefundDetails externalDetails): void |
-
-## Example (as JSON)
-
-```json
-{
- "amount_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "app_fee_money": {
- "amount": 10,
- "currency": "USD"
- },
- "idempotency_key": "9b7f2dcf-49da-4411-b23e-a2d6af21333a",
- "payment_id": "R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY",
- "reason": "Example",
- "destination_id": "destination_id6",
- "unlinked": false,
- "location_id": "location_id8"
-}
-```
-
diff --git a/doc/models/refund-payment-response.md b/doc/models/refund-payment-response.md
deleted file mode 100644
index 42c10e67..00000000
--- a/doc/models/refund-payment-response.md
+++ /dev/null
@@ -1,89 +0,0 @@
-
-# Refund Payment Response
-
-Defines the response returned by
-[RefundPayment](../../doc/apis/refunds.md#refund-payment).
-
-If there are errors processing the request, the `refund` field might not be
-present, or it might be present with a status of `FAILED`.
-
-## Structure
-
-`RefundPaymentResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `refund` | [`?PaymentRefund`](../../doc/models/payment-refund.md) | Optional | Represents a refund of a payment made using Square. Contains information about
the original payment and the amount of money refunded. | getRefund(): ?PaymentRefund | setRefund(?PaymentRefund refund): void |
-
-## Example (as JSON)
-
-```json
-{
- "refund": {
- "amount_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "app_fee_money": {
- "amount": 10,
- "currency": "USD"
- },
- "created_at": "2021-10-13T21:23:19.116Z",
- "id": "R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY_KlWP8IC1557ddwc9QWTKrCVU6m0JXDz15R2Qym5eQfR",
- "location_id": "L88917AVBK2S5",
- "order_id": "1JLEUZeEooAIX8HMqm9kvWd69aQZY",
- "payment_id": "R2B3Z8WMVt3EAmzYWLZvz7Y69EbZY",
- "reason": "Example",
- "status": "PENDING",
- "updated_at": "2021-10-13T21:23:19.508Z",
- "unlinked": false,
- "destination_type": "destination_type2",
- "destination_details": {
- "card_details": {
- "card": {
- "id": "id6",
- "card_brand": "OTHER_BRAND",
- "last_4": "last_48",
- "exp_month": 228,
- "exp_year": 68
- },
- "entry_method": "entry_method8",
- "auth_result_code": "auth_result_code0"
- },
- "cash_details": {
- "seller_supplied_money": {
- "amount": 36,
- "currency": "MKD"
- },
- "change_back_money": {
- "amount": 78,
- "currency": "XBD"
- }
- },
- "external_details": {
- "type": "type6",
- "source": "source0",
- "source_id": "source_id8"
- }
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/refund-status.md b/doc/models/refund-status.md
deleted file mode 100644
index c2ac2027..00000000
--- a/doc/models/refund-status.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# Refund Status
-
-Indicates a refund's current status.
-
-## Enumeration
-
-`RefundStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `PENDING` | The refund is pending. |
-| `APPROVED` | The refund has been approved by Square. |
-| `REJECTED` | The refund has been rejected by Square. |
-| `FAILED` | The refund failed. |
-
diff --git a/doc/models/refund.md b/doc/models/refund.md
deleted file mode 100644
index 2667ae3a..00000000
--- a/doc/models/refund.md
+++ /dev/null
@@ -1,75 +0,0 @@
-
-# Refund
-
-Represents a refund processed for a Square transaction.
-
-## Structure
-
-`Refund`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `string` | Required | The refund's unique ID.
**Constraints**: *Maximum Length*: `255` | getId(): string | setId(string id): void |
-| `locationId` | `string` | Required | The ID of the refund's associated location.
**Constraints**: *Maximum Length*: `50` | getLocationId(): string | setLocationId(string locationId): void |
-| `transactionId` | `?string` | Optional | The ID of the transaction that the refunded tender is part of.
**Constraints**: *Maximum Length*: `192` | getTransactionId(): ?string | setTransactionId(?string transactionId): void |
-| `tenderId` | `string` | Required | The ID of the refunded tender.
**Constraints**: *Maximum Length*: `192` | getTenderId(): string | setTenderId(string tenderId): void |
-| `createdAt` | `?string` | Optional | The timestamp for when the refund was created, in RFC 3339 format.
**Constraints**: *Maximum Length*: `32` | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `reason` | `string` | Required | The reason for the refund being issued.
**Constraints**: *Maximum Length*: `192` | getReason(): string | setReason(string reason): void |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-| `status` | [`string(RefundStatus)`](../../doc/models/refund-status.md) | Required | Indicates a refund's current status. | getStatus(): string | setStatus(string status): void |
-| `processingFeeMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getProcessingFeeMoney(): ?Money | setProcessingFeeMoney(?Money processingFeeMoney): void |
-| `additionalRecipients` | [`?(AdditionalRecipient[])`](../../doc/models/additional-recipient.md) | Optional | Additional recipients (other than the merchant) receiving a portion of this refund.
For example, fees assessed on a refund of a purchase by a third party integration. | getAdditionalRecipients(): ?array | setAdditionalRecipients(?array additionalRecipients): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id6",
- "location_id": "location_id0",
- "transaction_id": "transaction_id4",
- "tender_id": "tender_id4",
- "created_at": "created_at6",
- "reason": "reason8",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "status": "PENDING",
- "processing_fee_money": {
- "amount": 112,
- "currency": "DJF"
- },
- "additional_recipients": [
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- },
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- },
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- }
- ]
-}
-```
-
diff --git a/doc/models/register-domain-request.md b/doc/models/register-domain-request.md
deleted file mode 100644
index d8b699dd..00000000
--- a/doc/models/register-domain-request.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-# Register Domain Request
-
-Defines the parameters that can be included in the body of
-a request to the [RegisterDomain](../../doc/apis/apple-pay.md#register-domain) endpoint.
-
-## Structure
-
-`RegisterDomainRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `domainName` | `string` | Required | A domain name as described in RFC-1034 that will be registered with ApplePay.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getDomainName(): string | setDomainName(string domainName): void |
-
-## Example (as JSON)
-
-```json
-{
- "domain_name": "example.com"
-}
-```
-
diff --git a/doc/models/register-domain-response-status.md b/doc/models/register-domain-response-status.md
deleted file mode 100644
index ea00a86e..00000000
--- a/doc/models/register-domain-response-status.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Register Domain Response Status
-
-The status of the domain registration.
-
-## Enumeration
-
-`RegisterDomainResponseStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `PENDING` | The domain is added, but not verified. |
-| `VERIFIED` | The domain is added and verified. It can be used to accept Apple Pay transactions. |
-
diff --git a/doc/models/register-domain-response.md b/doc/models/register-domain-response.md
deleted file mode 100644
index 4112e8c3..00000000
--- a/doc/models/register-domain-response.md
+++ /dev/null
@@ -1,47 +0,0 @@
-
-# Register Domain Response
-
-Defines the fields that are included in the response body of
-a request to the [RegisterDomain](../../doc/apis/apple-pay.md#register-domain) endpoint.
-
-Either `errors` or `status` are present in a given response (never both).
-
-## Structure
-
-`RegisterDomainResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `status` | [`?string(RegisterDomainResponseStatus)`](../../doc/models/register-domain-response-status.md) | Optional | The status of the domain registration. | getStatus(): ?string | setStatus(?string status): void |
-
-## Example (as JSON)
-
-```json
-{
- "status": "VERIFIED",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/remove-group-from-customer-response.md b/doc/models/remove-group-from-customer-response.md
deleted file mode 100644
index 416da462..00000000
--- a/doc/models/remove-group-from-customer-response.md
+++ /dev/null
@@ -1,38 +0,0 @@
-
-# Remove Group From Customer Response
-
-Defines the fields that are included in the response body of
-a request to the [RemoveGroupFromCustomer](../../doc/apis/customers.md#remove-group-from-customer)
-endpoint.
-
-## Structure
-
-`RemoveGroupFromCustomerResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/resume-subscription-request.md b/doc/models/resume-subscription-request.md
deleted file mode 100644
index 905cca50..00000000
--- a/doc/models/resume-subscription-request.md
+++ /dev/null
@@ -1,26 +0,0 @@
-
-# Resume Subscription Request
-
-Defines input parameters in a request to the
-[ResumeSubscription](../../doc/apis/subscriptions.md#resume-subscription) endpoint.
-
-## Structure
-
-`ResumeSubscriptionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `resumeEffectiveDate` | `?string` | Optional | The `YYYY-MM-DD`-formatted date when the subscription reactivated. | getResumeEffectiveDate(): ?string | setResumeEffectiveDate(?string resumeEffectiveDate): void |
-| `resumeChangeTiming` | [`?string(ChangeTiming)`](../../doc/models/change-timing.md) | Optional | Supported timings when a pending change, as an action, takes place to a subscription. | getResumeChangeTiming(): ?string | setResumeChangeTiming(?string resumeChangeTiming): void |
-
-## Example (as JSON)
-
-```json
-{
- "resume_effective_date": "resume_effective_date8",
- "resume_change_timing": "IMMEDIATE"
-}
-```
-
diff --git a/doc/models/resume-subscription-response.md b/doc/models/resume-subscription-response.md
deleted file mode 100644
index 3e54f2cd..00000000
--- a/doc/models/resume-subscription-response.md
+++ /dev/null
@@ -1,84 +0,0 @@
-
-# Resume Subscription Response
-
-Defines output parameters in a response from the
-[ResumeSubscription](../../doc/apis/subscriptions.md#resume-subscription) endpoint.
-
-## Structure
-
-`ResumeSubscriptionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `subscription` | [`?Subscription`](../../doc/models/subscription.md) | Optional | Represents a subscription purchased by a customer.
For more information, see
[Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions). | getSubscription(): ?Subscription | setSubscription(?Subscription subscription): void |
-| `actions` | [`?(SubscriptionAction[])`](../../doc/models/subscription-action.md) | Optional | A list of `RESUME` actions created by the request and scheduled for the subscription. | getActions(): ?array | setActions(?array actions): void |
-
-## Example (as JSON)
-
-```json
-{
- "actions": [
- {
- "effective_date": "2023-09-01",
- "id": "18ff74f4-3da4-30c5-929f-7d6fca84f115",
- "type": "RESUME",
- "monthly_billing_anchor_date": 186,
- "phases": [
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- },
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- },
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- }
- ]
- }
- ],
- "subscription": {
- "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB",
- "created_at": "2023-06-20T21:53:10Z",
- "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
- "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f",
- "location_id": "S8GWD5R9QB376",
- "phases": [
- {
- "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY",
- "ordinal": 0,
- "plan_phase_uid": "X2Q2AONPB3RB64Y27S25QCZP",
- "uid": "873451e0-745b-4e87-ab0b-c574933fe616"
- }
- ],
- "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
- "source": {
- "name": "My Application"
- },
- "start_date": "2023-06-20",
- "status": "ACTIVE",
- "timezone": "America/Los_Angeles",
- "version": 1
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-booking-custom-attribute-definition-request.md b/doc/models/retrieve-booking-custom-attribute-definition-request.md
deleted file mode 100644
index b58f7f5a..00000000
--- a/doc/models/retrieve-booking-custom-attribute-definition-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Retrieve Booking Custom Attribute Definition Request
-
-Represents a [RetrieveBookingCustomAttributeDefinition](../../doc/apis/booking-custom-attributes.md#retrieve-booking-custom-attribute-definition) request.
-
-## Structure
-
-`RetrieveBookingCustomAttributeDefinitionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `version` | `?int` | Optional | The current version of the custom attribute definition, which is used for strongly consistent
reads to guarantee that you receive the most up-to-date data. When included in the request,
Square returns the specified version or a higher version if one exists. If the specified version
is higher than the current version, Square returns a `BAD_REQUEST` error. | getVersion(): ?int | setVersion(?int version): void |
-
-## Example (as JSON)
-
-```json
-{
- "version": 70
-}
-```
-
diff --git a/doc/models/retrieve-booking-custom-attribute-definition-response.md b/doc/models/retrieve-booking-custom-attribute-definition-response.md
deleted file mode 100644
index 6e0f14f9..00000000
--- a/doc/models/retrieve-booking-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,38 +0,0 @@
-
-# Retrieve Booking Custom Attribute Definition Response
-
-Represents a [RetrieveBookingCustomAttributeDefinition](../../doc/apis/booking-custom-attributes.md#retrieve-booking-custom-attribute-definition) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`RetrieveBookingCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`?CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Optional | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): ?CustomAttributeDefinition | setCustomAttributeDefinition(?CustomAttributeDefinition customAttributeDefinition): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "created_at": "2022-11-16T15:27:30Z",
- "description": "The favorite shampoo of the customer.",
- "key": "favoriteShampoo",
- "name": "Favorite shampoo",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-11-16T15:27:30Z",
- "version": 1,
- "visibility": "VISIBILITY_READ_WRITE_VALUES"
- },
- "errors": []
-}
-```
-
diff --git a/doc/models/retrieve-booking-custom-attribute-request.md b/doc/models/retrieve-booking-custom-attribute-request.md
deleted file mode 100644
index 89b68c09..00000000
--- a/doc/models/retrieve-booking-custom-attribute-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Retrieve Booking Custom Attribute Request
-
-Represents a [RetrieveBookingCustomAttribute](../../doc/apis/booking-custom-attributes.md#retrieve-booking-custom-attribute) request.
-
-## Structure
-
-`RetrieveBookingCustomAttributeRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `withDefinition` | `?bool` | Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of
the custom attribute. Set this parameter to `true` to get the name and description of the custom
attribute, information about the data type, or other definition details. The default value is `false`. | getWithDefinition(): ?bool | setWithDefinition(?bool withDefinition): void |
-| `version` | `?int` | Optional | The current version of the custom attribute, which is used for strongly consistent reads to
guarantee that you receive the most up-to-date data. When included in the request, Square
returns the specified version or a higher version if one exists. If the specified version is
higher than the current version, Square returns a `BAD_REQUEST` error. | getVersion(): ?int | setVersion(?int version): void |
-
-## Example (as JSON)
-
-```json
-{
- "with_definition": false,
- "version": 186
-}
-```
-
diff --git a/doc/models/retrieve-booking-custom-attribute-response.md b/doc/models/retrieve-booking-custom-attribute-response.md
deleted file mode 100644
index 72971c8f..00000000
--- a/doc/models/retrieve-booking-custom-attribute-response.md
+++ /dev/null
@@ -1,63 +0,0 @@
-
-# Retrieve Booking Custom Attribute Response
-
-Represents a [RetrieveBookingCustomAttribute](../../doc/apis/booking-custom-attributes.md#retrieve-booking-custom-attribute) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`RetrieveBookingCustomAttributeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttribute` | [`?CustomAttribute`](../../doc/models/custom-attribute.md) | Optional | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | getCustomAttribute(): ?CustomAttribute | setCustomAttribute(?CustomAttribute customAttribute): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute": {
- "key": "key2",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 102,
- "visibility": "VISIBILITY_READ_ONLY",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-booking-response.md b/doc/models/retrieve-booking-response.md
deleted file mode 100644
index ad67917f..00000000
--- a/doc/models/retrieve-booking-response.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-# Retrieve Booking Response
-
-## Structure
-
-`RetrieveBookingResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `booking` | [`?Booking`](../../doc/models/booking.md) | Optional | Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service
at a given location to a requesting customer in one or more appointment segments. | getBooking(): ?Booking | setBooking(?Booking booking): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "booking": {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMXUrsBWWcHTt79t"
- }
- ],
- "created_at": "2020-10-28T15:47:41Z",
- "customer_id": "EX2QSVGTZN4K1E5QE1CBFNVQ8M",
- "customer_note": "",
- "id": "zkras0xv0xwswx",
- "location_id": "LEQHH0YY8B42M",
- "seller_note": "",
- "start_at": "2020-11-26T13:00:00Z",
- "status": "ACCEPTED",
- "updated_at": "2020-10-28T15:49:25Z",
- "version": 1
- },
- "errors": []
-}
-```
-
diff --git a/doc/models/retrieve-business-booking-profile-response.md b/doc/models/retrieve-business-booking-profile-response.md
deleted file mode 100644
index 6afae13d..00000000
--- a/doc/models/retrieve-business-booking-profile-response.md
+++ /dev/null
@@ -1,45 +0,0 @@
-
-# Retrieve Business Booking Profile Response
-
-## Structure
-
-`RetrieveBusinessBookingProfileResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `businessBookingProfile` | [`?BusinessBookingProfile`](../../doc/models/business-booking-profile.md) | Optional | A seller's business booking profile, including booking policy, appointment settings, etc. | getBusinessBookingProfile(): ?BusinessBookingProfile | setBusinessBookingProfile(?BusinessBookingProfile businessBookingProfile): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "business_booking_profile": {
- "allow_user_cancel": true,
- "booking_enabled": true,
- "booking_policy": "ACCEPT_ALL",
- "business_appointment_settings": {
- "alignment_time": "HALF_HOURLY",
- "any_team_member_booking_enabled": true,
- "cancellation_fee_money": {
- "currency": "USD"
- },
- "cancellation_policy": "CUSTOM_POLICY",
- "location_types": [
- "BUSINESS_LOCATION"
- ],
- "max_booking_lead_time_seconds": 31536000,
- "min_booking_lead_time_seconds": 0,
- "multiple_service_booking_enabled": true,
- "skip_booking_flow_staff_selection": false
- },
- "created_at": "2020-09-10T21:40:38Z",
- "customer_timezone_choice": "CUSTOMER_CHOICE",
- "seller_id": "MLJQYZZRM0D3Y"
- },
- "errors": []
-}
-```
-
diff --git a/doc/models/retrieve-card-response.md b/doc/models/retrieve-card-response.md
deleted file mode 100644
index f40237ef..00000000
--- a/doc/models/retrieve-card-response.md
+++ /dev/null
@@ -1,66 +0,0 @@
-
-# Retrieve Card Response
-
-Defines the fields that are included in the response body of
-a request to the [RetrieveCard](../../doc/apis/cards.md#retrieve-card) endpoint.
-
-Note: if there are errors processing the request, the card field will not be
-present.
-
-## Structure
-
-`RetrieveCardResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `card` | [`?Card`](../../doc/models/card.md) | Optional | Represents the payment details of a card to be used for payments. These
details are determined by the payment token generated by Web Payments SDK. | getCard(): ?Card | setCard(?Card card): void |
-
-## Example (as JSON)
-
-```json
-{
- "card": {
- "billing_address": {
- "address_line_1": "500 Electric Ave",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "NY",
- "country": "US",
- "locality": "New York",
- "postal_code": "10003"
- },
- "bin": "411111",
- "card_brand": "VISA",
- "card_type": "CREDIT",
- "cardholder_name": "Amelia Earhart",
- "customer_id": "VDKXEEKPJN48QDG3BGGFAK05P8",
- "enabled": true,
- "exp_month": 11,
- "exp_year": 2022,
- "fingerprint": "ex-p-cs80EK9Flz7LsCMv-szbptQ_ssAGrhemzSTsPFgt9nzyE6t7okiLIQc-qw_quqKX4Q",
- "id": "ccof:uIbfJXhXETSP197M3GB",
- "last_4": "1111",
- "merchant_id": "6SSW7HV8K2ST5",
- "prepaid_type": "NOT_PREPAID",
- "reference_id": "user-id-1",
- "version": 1
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-cash-drawer-shift-request.md b/doc/models/retrieve-cash-drawer-shift-request.md
deleted file mode 100644
index 466a44d8..00000000
--- a/doc/models/retrieve-cash-drawer-shift-request.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Retrieve Cash Drawer Shift Request
-
-## Structure
-
-`RetrieveCashDrawerShiftRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationId` | `string` | Required | The ID of the location to retrieve cash drawer shifts from.
**Constraints**: *Minimum Length*: `1` | getLocationId(): string | setLocationId(string locationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_id": "location_id6"
-}
-```
-
diff --git a/doc/models/retrieve-cash-drawer-shift-response.md b/doc/models/retrieve-cash-drawer-shift-response.md
deleted file mode 100644
index 2083b8c3..00000000
--- a/doc/models/retrieve-cash-drawer-shift-response.md
+++ /dev/null
@@ -1,77 +0,0 @@
-
-# Retrieve Cash Drawer Shift Response
-
-## Structure
-
-`RetrieveCashDrawerShiftResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cashDrawerShift` | [`?CashDrawerShift`](../../doc/models/cash-drawer-shift.md) | Optional | This model gives the details of a cash drawer shift.
The cash_payment_money, cash_refund_money, cash_paid_in_money,
and cash_paid_out_money fields are all computed by summing their respective
event types. | getCashDrawerShift(): ?CashDrawerShift | setCashDrawerShift(?CashDrawerShift cashDrawerShift): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "cash_drawer_shift": {
- "cash_paid_in_money": {
- "amount": 10000,
- "currency": "USD"
- },
- "cash_paid_out_money": {
- "amount": -10000,
- "currency": "USD"
- },
- "cash_payment_money": {
- "amount": 100,
- "currency": "USD"
- },
- "cash_refunds_money": {
- "amount": -100,
- "currency": "USD"
- },
- "closed_at": "2019-11-22T00:44:49.000Z",
- "closed_cash_money": {
- "amount": 9970,
- "currency": "USD"
- },
- "closing_team_member_id": "",
- "description": "Misplaced some change",
- "device": {
- "name": "My iPad"
- },
- "ended_at": "2019-11-22T00:44:49.000Z",
- "ending_team_member_id": "",
- "expected_cash_money": {
- "amount": 10000,
- "currency": "USD"
- },
- "id": "DCC99978-09A6-4926-849F-300BE9C5793A",
- "opened_at": "2019-11-22T00:42:54.000Z",
- "opened_cash_money": {
- "amount": 10000,
- "currency": "USD"
- },
- "opening_team_member_id": "",
- "state": "CLOSED"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-catalog-object-request.md b/doc/models/retrieve-catalog-object-request.md
deleted file mode 100644
index 1271a5bb..00000000
--- a/doc/models/retrieve-catalog-object-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Retrieve Catalog Object Request
-
-## Structure
-
-`RetrieveCatalogObjectRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `includeRelatedObjects` | `?bool` | Optional | If `true`, the response will include additional objects that are related to the
requested objects. Related objects are defined as any objects referenced by ID by the results in the `objects` field
of the response. These objects are put in the `related_objects` field. Setting this to `true` is
helpful when the objects are needed for immediate display to a user.
This process only goes one level deep. Objects referenced by the related objects will not be included. For example,
if the `objects` field of the response contains a CatalogItem, its associated
CatalogCategory objects, CatalogTax objects, CatalogImage objects and
CatalogModifierLists will be returned in the `related_objects` field of the
response. If the `objects` field of the response contains a CatalogItemVariation,
its parent CatalogItem will be returned in the `related_objects` field of
the response.
Default value: `false` | getIncludeRelatedObjects(): ?bool | setIncludeRelatedObjects(?bool includeRelatedObjects): void |
-| `catalogVersion` | `?int` | Optional | Requests objects as of a specific version of the catalog. This allows you to retrieve historical
versions of objects. The value to retrieve a specific version of an object can be found
in the version field of [CatalogObject](../../doc/models/catalog-object.md)s. If not included, results will
be from the current version of the catalog. | getCatalogVersion(): ?int | setCatalogVersion(?int catalogVersion): void |
-| `includeCategoryPathToRoot` | `?bool` | Optional | Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists
of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category
and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned
in the response payload. | getIncludeCategoryPathToRoot(): ?bool | setIncludeCategoryPathToRoot(?bool includeCategoryPathToRoot): void |
-
-## Example (as JSON)
-
-```json
-{
- "include_related_objects": false,
- "catalog_version": 224,
- "include_category_path_to_root": false
-}
-```
-
diff --git a/doc/models/retrieve-catalog-object-response.md b/doc/models/retrieve-catalog-object-response.md
deleted file mode 100644
index 3adb206f..00000000
--- a/doc/models/retrieve-catalog-object-response.md
+++ /dev/null
@@ -1,171 +0,0 @@
-
-# Retrieve Catalog Object Response
-
-## Structure
-
-`RetrieveCatalogObjectResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `object` | [`?CatalogObject`](../../doc/models/catalog-object.md) | Optional | The wrapper object for the catalog entries of a given object type.
Depending on the `type` attribute value, a `CatalogObject` instance assumes a type-specific data to yield the corresponding type of catalog object.
For example, if `type=ITEM`, the `CatalogObject` instance must have the ITEM-specific data set on the `item_data` attribute. The resulting `CatalogObject` instance is also a `CatalogItem` instance.
In general, if `type=`, the `CatalogObject` instance must have the ``-specific data set on the `_data` attribute. The resulting `CatalogObject` instance is also a `Catalog` instance.
For a more detailed discussion of the Catalog data model, please see the
[Design a Catalog](https://developer.squareup.com/docs/catalog-api/design-a-catalog) guide. | getObject(): ?CatalogObject | setObject(?CatalogObject object): void |
-| `relatedObjects` | [`?(CatalogObject[])`](../../doc/models/catalog-object.md) | Optional | A list of `CatalogObject`s referenced by the object in the `object` field. | getRelatedObjects(): ?array | setRelatedObjects(?array relatedObjects): void |
-
-## Example (as JSON)
-
-```json
-{
- "object": {
- "id": "W62UWFY35CWMYGVWK6TWJDNI",
- "is_deleted": false,
- "item_data": {
- "categories": [
- {
- "id": "BJNQCF2FJ6S6UIDT65ABHLRX",
- "ordinal": 0
- }
- ],
- "description": "Hot Leaf Juice",
- "name": "Tea",
- "tax_ids": [
- "HURXQOOAIC4IZSI2BEXQRYFY"
- ],
- "variations": [
- {
- "id": "2TZFAOHWGG7PAK2QEXWYPZSP",
- "is_deleted": false,
- "item_variation_data": {
- "item_id": "W62UWFY35CWMYGVWK6TWJDNI",
- "name": "Mug",
- "ordinal": 0,
- "price_money": {
- "amount": 150,
- "currency": "USD"
- },
- "pricing_type": "FIXED_PRICING"
- },
- "present_at_all_locations": true,
- "type": "ITEM_VARIATION",
- "updated_at": "2016-11-16T22:25:24.878Z",
- "version": 1479335124878
- }
- ]
- },
- "present_at_all_locations": true,
- "type": "ITEM",
- "updated_at": "2016-11-16T22:25:24.878Z",
- "version": 1479335124878,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- },
- "related_objects": [
- {
- "category_data": {
- "name": "Beverages"
- },
- "id": "BJNQCF2FJ6S6UIDT65ABHLRX",
- "is_deleted": false,
- "present_at_all_locations": true,
- "type": "CATEGORY",
- "updated_at": "2016-11-16T22:25:24.878Z",
- "version": 1479335124878,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- },
- {
- "id": "HURXQOOAIC4IZSI2BEXQRYFY",
- "is_deleted": false,
- "present_at_all_locations": true,
- "tax_data": {
- "calculation_phase": "TAX_SUBTOTAL_PHASE",
- "enabled": true,
- "inclusion_type": "ADDITIVE",
- "name": "Sales Tax",
- "percentage": "5.0"
- },
- "type": "TAX",
- "updated_at": "2016-11-16T22:25:24.878Z",
- "version": 1479335124878,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-customer-custom-attribute-definition-request.md b/doc/models/retrieve-customer-custom-attribute-definition-request.md
deleted file mode 100644
index 78ee5c95..00000000
--- a/doc/models/retrieve-customer-custom-attribute-definition-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Retrieve Customer Custom Attribute Definition Request
-
-Represents a [RetrieveCustomerCustomAttributeDefinition](../../doc/apis/customer-custom-attributes.md#retrieve-customer-custom-attribute-definition) request.
-
-## Structure
-
-`RetrieveCustomerCustomAttributeDefinitionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `version` | `?int` | Optional | The current version of the custom attribute definition, which is used for strongly consistent
reads to guarantee that you receive the most up-to-date data. When included in the request,
Square returns the specified version or a higher version if one exists. If the specified version
is higher than the current version, Square returns a `BAD_REQUEST` error. | getVersion(): ?int | setVersion(?int version): void |
-
-## Example (as JSON)
-
-```json
-{
- "version": 38
-}
-```
-
diff --git a/doc/models/retrieve-customer-custom-attribute-definition-response.md b/doc/models/retrieve-customer-custom-attribute-definition-response.md
deleted file mode 100644
index 2d997952..00000000
--- a/doc/models/retrieve-customer-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,51 +0,0 @@
-
-# Retrieve Customer Custom Attribute Definition Response
-
-Represents a [RetrieveCustomerCustomAttributeDefinition](../../doc/apis/customer-custom-attributes.md#retrieve-customer-custom-attribute-definition) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`RetrieveCustomerCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`?CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Optional | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): ?CustomAttributeDefinition | setCustomAttributeDefinition(?CustomAttributeDefinition customAttributeDefinition): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "created_at": "2022-04-26T15:27:30Z",
- "description": "The favorite movie of the customer.",
- "key": "favoritemovie",
- "name": "Favorite Movie",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-04-26T15:27:30Z",
- "version": 1,
- "visibility": "VISIBILITY_READ_WRITE_VALUES"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-customer-custom-attribute-request.md b/doc/models/retrieve-customer-custom-attribute-request.md
deleted file mode 100644
index 6e77eccb..00000000
--- a/doc/models/retrieve-customer-custom-attribute-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Retrieve Customer Custom Attribute Request
-
-Represents a [RetrieveCustomerCustomAttribute](../../doc/apis/customer-custom-attributes.md#retrieve-customer-custom-attribute) request.
-
-## Structure
-
-`RetrieveCustomerCustomAttributeRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `withDefinition` | `?bool` | Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of
the custom attribute. Set this parameter to `true` to get the name and description of the custom
attribute, information about the data type, or other definition details. The default value is `false`. | getWithDefinition(): ?bool | setWithDefinition(?bool withDefinition): void |
-| `version` | `?int` | Optional | The current version of the custom attribute, which is used for strongly consistent reads to
guarantee that you receive the most up-to-date data. When included in the request, Square
returns the specified version or a higher version if one exists. If the specified version is
higher than the current version, Square returns a `BAD_REQUEST` error. | getVersion(): ?int | setVersion(?int version): void |
-
-## Example (as JSON)
-
-```json
-{
- "with_definition": false,
- "version": 232
-}
-```
-
diff --git a/doc/models/retrieve-customer-custom-attribute-response.md b/doc/models/retrieve-customer-custom-attribute-response.md
deleted file mode 100644
index 8783d509..00000000
--- a/doc/models/retrieve-customer-custom-attribute-response.md
+++ /dev/null
@@ -1,51 +0,0 @@
-
-# Retrieve Customer Custom Attribute Response
-
-Represents a [RetrieveCustomerCustomAttribute](../../doc/apis/customer-custom-attributes.md#retrieve-customer-custom-attribute) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`RetrieveCustomerCustomAttributeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttribute` | [`?CustomAttribute`](../../doc/models/custom-attribute.md) | Optional | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | getCustomAttribute(): ?CustomAttribute | setCustomAttribute(?CustomAttribute customAttribute): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute": {
- "key": "key2",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 102,
- "visibility": "VISIBILITY_READ_ONLY",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-customer-group-response.md b/doc/models/retrieve-customer-group-response.md
deleted file mode 100644
index fdb88026..00000000
--- a/doc/models/retrieve-customer-group-response.md
+++ /dev/null
@@ -1,40 +0,0 @@
-
-# Retrieve Customer Group Response
-
-Defines the fields that are included in the response body of
-a request to the [RetrieveCustomerGroup](../../doc/apis/customer-groups.md#retrieve-customer-group) endpoint.
-
-Either `errors` or `group` is present in a given response (never both).
-
-## Structure
-
-`RetrieveCustomerGroupResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `group` | [`?CustomerGroup`](../../doc/models/customer-group.md) | Optional | Represents a group of customer profiles.
Customer groups can be created, be modified, and have their membership defined using
the Customers API or within the Customer Directory in the Square Seller Dashboard or Point of Sale. | getGroup(): ?CustomerGroup | setGroup(?CustomerGroup group): void |
-
-## Example (as JSON)
-
-```json
-{
- "group": {
- "created_at": "2020-04-13T21:54:57.863Z",
- "id": "2TAT3CMH4Q0A9M87XJZED0WMR3",
- "name": "Loyal Customers",
- "updated_at": "2020-04-13T21:54:58Z"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-customer-response.md b/doc/models/retrieve-customer-response.md
deleted file mode 100644
index 7525d6d0..00000000
--- a/doc/models/retrieve-customer-response.md
+++ /dev/null
@@ -1,85 +0,0 @@
-
-# Retrieve Customer Response
-
-Defines the fields that are included in the response body of
-a request to the `RetrieveCustomer` endpoint.
-
-Either `errors` or `customer` is present in a given response (never both).
-
-## Structure
-
-`RetrieveCustomerResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `customer` | [`?Customer`](../../doc/models/customer.md) | Optional | Represents a Square customer profile in the Customer Directory of a Square seller. | getCustomer(): ?Customer | setCustomer(?Customer customer): void |
-
-## Example (as JSON)
-
-```json
-{
- "customer": {
- "address": {
- "address_line_1": "500 Electric Ave",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "NY",
- "country": "US",
- "locality": "New York",
- "postal_code": "10003"
- },
- "created_at": "2016-03-23T20:21:54.859Z",
- "creation_source": "THIRD_PARTY",
- "email_address": "Amelia.Earhart@example.com",
- "family_name": "Earhart",
- "given_name": "Amelia",
- "group_ids": [
- "545AXB44B4XXWMVQ4W8SBT3HHF"
- ],
- "id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "note": "a customer",
- "phone_number": "+1-212-555-4240",
- "preferences": {
- "email_unsubscribed": false
- },
- "reference_id": "YOUR_REFERENCE_ID",
- "segment_ids": [
- "1KB9JE5EGJXCW.REACHABLE"
- ],
- "updated_at": "2016-03-23T20:21:54.859Z",
- "version": 1,
- "cards": [
- {
- "id": "id8",
- "card_brand": "DISCOVER",
- "last_4": "last_40",
- "exp_month": 152,
- "exp_year": 144
- }
- ]
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-customer-segment-response.md b/doc/models/retrieve-customer-segment-response.md
deleted file mode 100644
index 998f6948..00000000
--- a/doc/models/retrieve-customer-segment-response.md
+++ /dev/null
@@ -1,45 +0,0 @@
-
-# Retrieve Customer Segment Response
-
-Defines the fields that are included in the response body for requests to the `RetrieveCustomerSegment` endpoint.
-
-Either `errors` or `segment` is present in a given response (never both).
-
-## Structure
-
-`RetrieveCustomerSegmentResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `segment` | [`?CustomerSegment`](../../doc/models/customer-segment.md) | Optional | Represents a group of customer profiles that match one or more predefined filter criteria.
Segments (also known as Smart Groups) are defined and created within the Customer Directory in the
Square Seller Dashboard or Point of Sale. | getSegment(): ?CustomerSegment | setSegment(?CustomerSegment segment): void |
-
-## Example (as JSON)
-
-```json
-{
- "segment": {
- "created_at": "2020-01-09T19:33:24.469Z",
- "id": "GMNXRZVEXNQDF.CHURN_RISK",
- "name": "Lapsed",
- "updated_at": "2020-04-13T23:01:13Z"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-dispute-evidence-response.md b/doc/models/retrieve-dispute-evidence-response.md
deleted file mode 100644
index 6d00662f..00000000
--- a/doc/models/retrieve-dispute-evidence-response.md
+++ /dev/null
@@ -1,43 +0,0 @@
-
-# Retrieve Dispute Evidence Response
-
-Defines the fields in a `RetrieveDisputeEvidence` response.
-
-## Structure
-
-`RetrieveDisputeEvidenceResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `evidence` | [`?DisputeEvidence`](../../doc/models/dispute-evidence.md) | Optional | - | getEvidence(): ?DisputeEvidence | setEvidence(?DisputeEvidence evidence): void |
-
-## Example (as JSON)
-
-```json
-{
- "evidence": {
- "dispute_id": "bVTprrwk0gygTLZ96VX1oB",
- "evidence_file": {
- "filename": "customer-interaction.jpg",
- "filetype": "image/jpeg"
- },
- "evidence_type": "CARDHOLDER_COMMUNICATION",
- "id": "TOomLInj6iWmP3N8qfCXrB",
- "uploaded_at": "2022-05-18T16:01:10.000Z",
- "evidence_id": "evidence_id0",
- "evidence_text": "evidence_text6"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-dispute-response.md b/doc/models/retrieve-dispute-response.md
deleted file mode 100644
index a48e7f8a..00000000
--- a/doc/models/retrieve-dispute-response.md
+++ /dev/null
@@ -1,52 +0,0 @@
-
-# Retrieve Dispute Response
-
-Defines fields in a `RetrieveDispute` response.
-
-## Structure
-
-`RetrieveDisputeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `dispute` | [`?Dispute`](../../doc/models/dispute.md) | Optional | Represents a [dispute](https://developer.squareup.com/docs/disputes-api/overview) a cardholder initiated with their bank. | getDispute(): ?Dispute | setDispute(?Dispute dispute): void |
-
-## Example (as JSON)
-
-```json
-{
- "dispute": {
- "amount_money": {
- "amount": 2500,
- "currency": "USD"
- },
- "brand_dispute_id": "100000809947",
- "card_brand": "VISA",
- "created_at": "2022-06-29T18:45:22.265Z",
- "disputed_payment": {
- "payment_id": "zhyh1ch64kRBrrlfVhwjCEjZWzNZY"
- },
- "due_at": "2022-07-13T00:00:00.000Z",
- "id": "XDgyFu7yo1E2S5lQGGpYn",
- "location_id": "L1HN3ZMQK64X9",
- "reason": "NO_KNOWLEDGE",
- "reported_at": "2022-06-29T00:00:00.000Z",
- "state": "ACCEPTED",
- "updated_at": "2022-07-07T19:14:42.650Z",
- "version": 2,
- "dispute_id": "dispute_id8"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-employee-response.md b/doc/models/retrieve-employee-response.md
deleted file mode 100644
index 55742fd3..00000000
--- a/doc/models/retrieve-employee-response.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-# Retrieve Employee Response
-
-## Structure
-
-`RetrieveEmployeeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `employee` | [`?Employee`](../../doc/models/employee.md) | Optional | An employee object that is used by the external API.
DEPRECATED at version 2020-08-26. Replaced by [TeamMember](entity:TeamMember). | getEmployee(): ?Employee | setEmployee(?Employee employee): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "employee": {
- "id": "id8",
- "first_name": "first_name8",
- "last_name": "last_name6",
- "email": "email8",
- "phone_number": "phone_number6"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-gift-card-from-gan-request.md b/doc/models/retrieve-gift-card-from-gan-request.md
deleted file mode 100644
index aa1505a2..00000000
--- a/doc/models/retrieve-gift-card-from-gan-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Retrieve Gift Card From GAN Request
-
-A request to retrieve gift cards by their GANs.
-
-## Structure
-
-`RetrieveGiftCardFromGANRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `gan` | `string` | Required | The gift card account number (GAN) of the gift card to retrieve.
The maximum length of a GAN is 255 digits to account for third-party GANs that have been imported.
Square-issued gift cards have 16-digit GANs.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | getGan(): string | setGan(string gan): void |
-
-## Example (as JSON)
-
-```json
-{
- "gan": "7783320001001635"
-}
-```
-
diff --git a/doc/models/retrieve-gift-card-from-gan-response.md b/doc/models/retrieve-gift-card-from-gan-response.md
deleted file mode 100644
index d521ed5a..00000000
--- a/doc/models/retrieve-gift-card-from-gan-response.md
+++ /dev/null
@@ -1,44 +0,0 @@
-
-# Retrieve Gift Card From GAN Response
-
-A response that contains a `GiftCard`. This response might contain a set of `Error` objects
-if the request resulted in errors.
-
-## Structure
-
-`RetrieveGiftCardFromGANResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `giftCard` | [`?GiftCard`](../../doc/models/gift-card.md) | Optional | Represents a Square gift card. | getGiftCard(): ?GiftCard | setGiftCard(?GiftCard giftCard): void |
-
-## Example (as JSON)
-
-```json
-{
- "gift_card": {
- "balance_money": {
- "amount": 5000,
- "currency": "USD"
- },
- "created_at": "2021-05-20T22:26:54.000Z",
- "gan": "7783320001001635",
- "gan_source": "SQUARE",
- "id": "gftc:6944163553804e439d89adb47caf806a",
- "state": "ACTIVE",
- "type": "DIGITAL"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-gift-card-from-nonce-request.md b/doc/models/retrieve-gift-card-from-nonce-request.md
deleted file mode 100644
index 9eaa1b36..00000000
--- a/doc/models/retrieve-gift-card-from-nonce-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Retrieve Gift Card From Nonce Request
-
-A request to retrieve a gift card by using a payment token.
-
-## Structure
-
-`RetrieveGiftCardFromNonceRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `nonce` | `string` | Required | The payment token of the gift card to retrieve. Payment tokens are generated by the
Web Payments SDK or In-App Payments SDK.
**Constraints**: *Minimum Length*: `1` | getNonce(): string | setNonce(string nonce): void |
-
-## Example (as JSON)
-
-```json
-{
- "nonce": "cnon:7783322135245171"
-}
-```
-
diff --git a/doc/models/retrieve-gift-card-from-nonce-response.md b/doc/models/retrieve-gift-card-from-nonce-response.md
deleted file mode 100644
index 35ca90c4..00000000
--- a/doc/models/retrieve-gift-card-from-nonce-response.md
+++ /dev/null
@@ -1,50 +0,0 @@
-
-# Retrieve Gift Card From Nonce Response
-
-A response that contains a `GiftCard` object. If the request resulted in errors,
-the response contains a set of `Error` objects.
-
-## Structure
-
-`RetrieveGiftCardFromNonceResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `giftCard` | [`?GiftCard`](../../doc/models/gift-card.md) | Optional | Represents a Square gift card. | getGiftCard(): ?GiftCard | setGiftCard(?GiftCard giftCard): void |
-
-## Example (as JSON)
-
-```json
-{
- "gift_card": {
- "balance_money": {
- "amount": 5000,
- "currency": "USD"
- },
- "created_at": "2021-05-20T22:26:54.000Z",
- "gan": "7783320001001635",
- "gan_source": "SQUARE",
- "id": "gftc:6944163553804e439d89adb47caf806a",
- "state": "ACTIVE",
- "type": "DIGITAL"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-gift-card-response.md b/doc/models/retrieve-gift-card-response.md
deleted file mode 100644
index df804752..00000000
--- a/doc/models/retrieve-gift-card-response.md
+++ /dev/null
@@ -1,50 +0,0 @@
-
-# Retrieve Gift Card Response
-
-A response that contains a `GiftCard`. The response might contain a set of `Error` objects
-if the request resulted in errors.
-
-## Structure
-
-`RetrieveGiftCardResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `giftCard` | [`?GiftCard`](../../doc/models/gift-card.md) | Optional | Represents a Square gift card. | getGiftCard(): ?GiftCard | setGiftCard(?GiftCard giftCard): void |
-
-## Example (as JSON)
-
-```json
-{
- "gift_card": {
- "balance_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "created_at": "2021-05-20T22:26:54.000Z",
- "gan": "7783320001001635",
- "gan_source": "SQUARE",
- "id": "gftc:00113070ba5745f0b2377c1b9570cb03",
- "state": "ACTIVE",
- "type": "DIGITAL"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-inventory-adjustment-response.md b/doc/models/retrieve-inventory-adjustment-response.md
deleted file mode 100644
index 530f9de8..00000000
--- a/doc/models/retrieve-inventory-adjustment-response.md
+++ /dev/null
@@ -1,44 +0,0 @@
-
-# Retrieve Inventory Adjustment Response
-
-## Structure
-
-`RetrieveInventoryAdjustmentResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `adjustment` | [`?InventoryAdjustment`](../../doc/models/inventory-adjustment.md) | Optional | Represents a change in state or quantity of product inventory at a
particular time and location. | getAdjustment(): ?InventoryAdjustment | setAdjustment(?InventoryAdjustment adjustment): void |
-
-## Example (as JSON)
-
-```json
-{
- "adjustment": {
- "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI",
- "catalog_object_type": "ITEM_VARIATION",
- "created_at": "2016-11-17T13:02:15.142Z",
- "from_state": "IN_STOCK",
- "id": "UDMOEO78BG6GYWA2XDRYX3KB",
- "location_id": "C6W5YS5QM06F5",
- "occurred_at": "2016-11-16T25:44:22.837Z",
- "quantity": "7",
- "reference_id": "4a366069-4096-47a2-99a5-0084ac879509",
- "source": {
- "application_id": "416ff29c-86c4-4feb-b58c-9705f21f3ea0",
- "name": "Square Point of Sale 4.37",
- "product": "SQUARE_POS"
- },
- "team_member_id": "LRK57NSQ5X7PUD05",
- "to_state": "SOLD",
- "total_price_money": {
- "amount": 4550,
- "currency": "USD"
- }
- },
- "errors": []
-}
-```
-
diff --git a/doc/models/retrieve-inventory-changes-request.md b/doc/models/retrieve-inventory-changes-request.md
deleted file mode 100644
index ee390e35..00000000
--- a/doc/models/retrieve-inventory-changes-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Retrieve Inventory Changes Request
-
-## Structure
-
-`RetrieveInventoryChangesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationIds` | `?string` | Optional | The [Location](entity:Location) IDs to look up as a comma-separated
list. An empty list queries all locations. | getLocationIds(): ?string | setLocationIds(?string locationIds): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this to retrieve the next set of results for the original query.
See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_ids": "location_ids2",
- "cursor": "cursor4"
-}
-```
-
diff --git a/doc/models/retrieve-inventory-changes-response.md b/doc/models/retrieve-inventory-changes-response.md
deleted file mode 100644
index 13b961af..00000000
--- a/doc/models/retrieve-inventory-changes-response.md
+++ /dev/null
@@ -1,79 +0,0 @@
-
-# Retrieve Inventory Changes Response
-
-## Structure
-
-`RetrieveInventoryChangesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `changes` | [`?(InventoryChange[])`](../../doc/models/inventory-change.md) | Optional | The set of inventory changes for the requested object and locations. | getChanges(): ?array | setChanges(?array changes): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request. If unset,
this is the final response.
See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "changes": [
- {
- "adjustment": {
- "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI",
- "catalog_object_type": "ITEM_VARIATION",
- "created_at": "2016-11-16T22:25:24.878Z",
- "from_state": "IN_STOCK",
- "id": "OJKJIUANKLMLQANZADNPLKAD",
- "location_id": "C6W5YS5QM06F5",
- "occurred_at": "2016-11-16T22:25:24.878Z",
- "quantity": "3",
- "reference_id": "d8207693-168f-4b44-a2fd-a7ff533ddd26",
- "source": {
- "application_id": "416ff29c-86c4-4feb-b58c-9705f21f3ea0",
- "name": "Square Point of Sale 4.37",
- "product": "SQUARE_POS"
- },
- "team_member_id": "AV7YRCGI2H1J5NQ8E1XIZCNA",
- "to_state": "SOLD",
- "total_price_money": {
- "amount": 5000,
- "currency": "USD"
- },
- "transaction_id": "5APV6JYK1SNCZD11AND2RX1Z"
- },
- "type": "ADJUSTMENT",
- "physical_count": {
- "id": "id2",
- "reference_id": "reference_id0",
- "catalog_object_id": "catalog_object_id6",
- "catalog_object_type": "catalog_object_type6",
- "state": "SUPPORTED_BY_NEWER_VERSION"
- },
- "transfer": {
- "id": "id8",
- "reference_id": "reference_id6",
- "state": "RESERVED_FOR_SALE",
- "from_location_id": "from_location_id0",
- "to_location_id": "to_location_id0"
- },
- "measurement_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 184
- }
- }
- ],
- "errors": [],
- "cursor": "cursor0"
-}
-```
-
diff --git a/doc/models/retrieve-inventory-count-request.md b/doc/models/retrieve-inventory-count-request.md
deleted file mode 100644
index fc4bc0da..00000000
--- a/doc/models/retrieve-inventory-count-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Retrieve Inventory Count Request
-
-## Structure
-
-`RetrieveInventoryCountRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationIds` | `?string` | Optional | The [Location](entity:Location) IDs to look up as a comma-separated
list. An empty list queries all locations. | getLocationIds(): ?string | setLocationIds(?string locationIds): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this to retrieve the next set of results for the original query.
See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_ids": "location_ids4",
- "cursor": "cursor8"
-}
-```
-
diff --git a/doc/models/retrieve-inventory-count-response.md b/doc/models/retrieve-inventory-count-response.md
deleted file mode 100644
index 5301f525..00000000
--- a/doc/models/retrieve-inventory-count-response.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Retrieve Inventory Count Response
-
-## Structure
-
-`RetrieveInventoryCountResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `counts` | [`?(InventoryCount[])`](../../doc/models/inventory-count.md) | Optional | The current calculated inventory counts for the requested object and
locations. | getCounts(): ?array | setCounts(?array counts): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request. If unset,
this is the final response.
See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "counts": [
- {
- "calculated_at": "2016-11-16T22:28:01.223Z",
- "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI",
- "catalog_object_type": "ITEM_VARIATION",
- "location_id": "C6W5YS5QM06F5",
- "quantity": "22",
- "state": "IN_STOCK"
- }
- ],
- "errors": [],
- "cursor": "cursor2"
-}
-```
-
diff --git a/doc/models/retrieve-inventory-physical-count-response.md b/doc/models/retrieve-inventory-physical-count-response.md
deleted file mode 100644
index a17381c1..00000000
--- a/doc/models/retrieve-inventory-physical-count-response.md
+++ /dev/null
@@ -1,39 +0,0 @@
-
-# Retrieve Inventory Physical Count Response
-
-## Structure
-
-`RetrieveInventoryPhysicalCountResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `count` | [`?InventoryPhysicalCount`](../../doc/models/inventory-physical-count.md) | Optional | Represents the quantity of an item variation that is physically present
at a specific location, verified by a seller or a seller's employee. For example,
a physical count might come from an employee counting the item variations on
hand or from syncing with an external system. | getCount(): ?InventoryPhysicalCount | setCount(?InventoryPhysicalCount count): void |
-
-## Example (as JSON)
-
-```json
-{
- "count": {
- "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI",
- "catalog_object_type": "ITEM_VARIATION",
- "created_at": "2016-11-16T22:25:24.878Z",
- "id": "ANZADNPLKADOJKJIUANKLMLQ",
- "location_id": "C6W5YS5QM06F5",
- "occurred_at": "2016-11-16T22:25:24.878Z",
- "quantity": "15",
- "reference_id": "f857ec37-f9a0-4458-8e23-5b5e0bea4e53",
- "source": {
- "application_id": "416ff29c-86c4-4feb-b58c-9705f21f3ea0",
- "name": "Square Point of Sale 4.37",
- "product": "SQUARE_POS"
- },
- "state": "IN_STOCK",
- "team_member_id": "LRK57NSQ5X7PUD05"
- },
- "errors": []
-}
-```
-
diff --git a/doc/models/retrieve-inventory-transfer-response.md b/doc/models/retrieve-inventory-transfer-response.md
deleted file mode 100644
index 344e0d6a..00000000
--- a/doc/models/retrieve-inventory-transfer-response.md
+++ /dev/null
@@ -1,40 +0,0 @@
-
-# Retrieve Inventory Transfer Response
-
-## Structure
-
-`RetrieveInventoryTransferResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `transfer` | [`?InventoryTransfer`](../../doc/models/inventory-transfer.md) | Optional | Represents the transfer of a quantity of product inventory at a
particular time from one location to another. | getTransfer(): ?InventoryTransfer | setTransfer(?InventoryTransfer transfer): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [],
- "transfer": {
- "catalog_object_id": "W62UWFY35CWMYGVWK6TWJDNI",
- "catalog_object_type": "ITEM_VARIATION",
- "created_at": "2016-11-17T13:02:15.142Z",
- "from_location_id": "C6W5YS5QM06F5",
- "id": "UDMOEO78BG6GYWA2XDRYX3KB",
- "occurred_at": "2016-11-16T25:44:22.837Z",
- "quantity": "7",
- "reference_id": "4a366069-4096-47a2-99a5-0084ac879509",
- "source": {
- "application_id": "416ff29c-86c4-4feb-b58c-9705f21f3ea0",
- "name": "Square Point of Sale 4.37",
- "product": "SQUARE_POS"
- },
- "state": "IN_STOCK",
- "team_member_id": "LRK57NSQ5X7PUD05",
- "to_location_id": "59TNP9SA8VGDA"
- }
-}
-```
-
diff --git a/doc/models/retrieve-job-response.md b/doc/models/retrieve-job-response.md
deleted file mode 100644
index 05df5b30..00000000
--- a/doc/models/retrieve-job-response.md
+++ /dev/null
@@ -1,46 +0,0 @@
-
-# Retrieve Job Response
-
-Represents a [RetrieveJob](../../doc/apis/team.md#retrieve-job) response. Either `job` or `errors`
-is present in the response.
-
-## Structure
-
-`RetrieveJobResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `job` | [`?Job`](../../doc/models/job.md) | Optional | Represents a job that can be assigned to [team members](../../doc/models/team-member.md). This object defines the
job's title and tip eligibility. Compensation is defined in a [job assignment](../../doc/models/job-assignment.md)
in a team member's wage setting. | getJob(): ?Job | setJob(?Job job): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | The errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "job": {
- "created_at": "2021-06-11T22:55:45Z",
- "id": "1yJlHapkseYnNPETIU1B",
- "is_tip_eligible": true,
- "title": "Cashier 1",
- "updated_at": "2021-06-11T22:55:45Z",
- "version": 2
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-location-booking-profile-response.md b/doc/models/retrieve-location-booking-profile-response.md
deleted file mode 100644
index ba83d810..00000000
--- a/doc/models/retrieve-location-booking-profile-response.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# Retrieve Location Booking Profile Response
-
-## Structure
-
-`RetrieveLocationBookingProfileResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationBookingProfile` | [`?LocationBookingProfile`](../../doc/models/location-booking-profile.md) | Optional | The booking profile of a seller's location, including the location's ID and whether the location is enabled for online booking. | getLocationBookingProfile(): ?LocationBookingProfile | setLocationBookingProfile(?LocationBookingProfile locationBookingProfile): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [],
- "location_booking_profile": {
- "booking_enabled": true,
- "booking_site_url": "https://square.site/book/L3HETDGYQ4A2C/prod-business",
- "location_id": "L3HETDGYQ4A2C",
- "online_booking_enabled": false
- }
-}
-```
-
diff --git a/doc/models/retrieve-location-custom-attribute-definition-request.md b/doc/models/retrieve-location-custom-attribute-definition-request.md
deleted file mode 100644
index ccfde32c..00000000
--- a/doc/models/retrieve-location-custom-attribute-definition-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Retrieve Location Custom Attribute Definition Request
-
-Represents a [RetrieveLocationCustomAttributeDefinition](../../doc/apis/location-custom-attributes.md#retrieve-location-custom-attribute-definition) request.
-
-## Structure
-
-`RetrieveLocationCustomAttributeDefinitionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `version` | `?int` | Optional | The current version of the custom attribute definition, which is used for strongly consistent
reads to guarantee that you receive the most up-to-date data. When included in the request,
Square returns the specified version or a higher version if one exists. If the specified version
is higher than the current version, Square returns a `BAD_REQUEST` error. | getVersion(): ?int | setVersion(?int version): void |
-
-## Example (as JSON)
-
-```json
-{
- "version": 50
-}
-```
-
diff --git a/doc/models/retrieve-location-custom-attribute-definition-response.md b/doc/models/retrieve-location-custom-attribute-definition-response.md
deleted file mode 100644
index 0ac58449..00000000
--- a/doc/models/retrieve-location-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,57 +0,0 @@
-
-# Retrieve Location Custom Attribute Definition Response
-
-Represents a [RetrieveLocationCustomAttributeDefinition](../../doc/apis/location-custom-attributes.md#retrieve-location-custom-attribute-definition) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`RetrieveLocationCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`?CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Optional | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): ?CustomAttributeDefinition | setCustomAttributeDefinition(?CustomAttributeDefinition customAttributeDefinition): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "created_at": "2022-12-02T19:06:36.559Z",
- "description": "Bestselling item at location",
- "key": "bestseller",
- "name": "Bestseller",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-12-02T19:06:36.559Z",
- "version": 1,
- "visibility": "VISIBILITY_READ_WRITE_VALUES"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-location-custom-attribute-request.md b/doc/models/retrieve-location-custom-attribute-request.md
deleted file mode 100644
index 1dc56e6c..00000000
--- a/doc/models/retrieve-location-custom-attribute-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Retrieve Location Custom Attribute Request
-
-Represents a [RetrieveLocationCustomAttribute](../../doc/apis/location-custom-attributes.md#retrieve-location-custom-attribute) request.
-
-## Structure
-
-`RetrieveLocationCustomAttributeRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `withDefinition` | `?bool` | Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of
the custom attribute. Set this parameter to `true` to get the name and description of the custom
attribute, information about the data type, or other definition details. The default value is `false`. | getWithDefinition(): ?bool | setWithDefinition(?bool withDefinition): void |
-| `version` | `?int` | Optional | The current version of the custom attribute, which is used for strongly consistent reads to
guarantee that you receive the most up-to-date data. When included in the request, Square
returns the specified version or a higher version if one exists. If the specified version is
higher than the current version, Square returns a `BAD_REQUEST` error. | getVersion(): ?int | setVersion(?int version): void |
-
-## Example (as JSON)
-
-```json
-{
- "with_definition": false,
- "version": 84
-}
-```
-
diff --git a/doc/models/retrieve-location-custom-attribute-response.md b/doc/models/retrieve-location-custom-attribute-response.md
deleted file mode 100644
index af9a3764..00000000
--- a/doc/models/retrieve-location-custom-attribute-response.md
+++ /dev/null
@@ -1,51 +0,0 @@
-
-# Retrieve Location Custom Attribute Response
-
-Represents a [RetrieveLocationCustomAttribute](../../doc/apis/location-custom-attributes.md#retrieve-location-custom-attribute) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`RetrieveLocationCustomAttributeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttribute` | [`?CustomAttribute`](../../doc/models/custom-attribute.md) | Optional | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | getCustomAttribute(): ?CustomAttribute | setCustomAttribute(?CustomAttribute customAttribute): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute": {
- "key": "key2",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 102,
- "visibility": "VISIBILITY_READ_ONLY",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-location-response.md b/doc/models/retrieve-location-response.md
deleted file mode 100644
index 1985076e..00000000
--- a/doc/models/retrieve-location-response.md
+++ /dev/null
@@ -1,58 +0,0 @@
-
-# Retrieve Location Response
-
-Defines the fields that the [RetrieveLocation](../../doc/apis/locations.md#retrieve-location)
-endpoint returns in a response.
-
-## Structure
-
-`RetrieveLocationResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `location` | [`?Location`](../../doc/models/location.md) | Optional | Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api). | getLocation(): ?Location | setLocation(?Location location): void |
-
-## Example (as JSON)
-
-```json
-{
- "location": {
- "address": {
- "address_line_1": "123 Main St",
- "administrative_district_level_1": "CA",
- "country": "US",
- "locality": "San Francisco",
- "postal_code": "94114",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "sublocality": "sublocality6"
- },
- "business_name": "Jet Fuel Coffee",
- "capabilities": [
- "CREDIT_CARD_PROCESSING"
- ],
- "country": "US",
- "created_at": "2016-09-19T17:33:12Z",
- "currency": "USD",
- "id": "18YC4JDH91E1H",
- "language_code": "en-US",
- "merchant_id": "3MYCJG5GVYQ8Q",
- "name": "Grant Park",
- "phone_number": "+1 650-354-7217",
- "status": "ACTIVE",
- "timezone": "America/Los_Angeles"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-location-settings-response.md b/doc/models/retrieve-location-settings-response.md
deleted file mode 100644
index d6a72c97..00000000
--- a/doc/models/retrieve-location-settings-response.md
+++ /dev/null
@@ -1,93 +0,0 @@
-
-# Retrieve Location Settings Response
-
-## Structure
-
-`RetrieveLocationSettingsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `locationSettings` | [`?CheckoutLocationSettings`](../../doc/models/checkout-location-settings.md) | Optional | - | getLocationSettings(): ?CheckoutLocationSettings | setLocationSettings(?CheckoutLocationSettings locationSettings): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_settings": {
- "branding": {
- "button_color": "#ffffff",
- "button_shape": "ROUNDED",
- "header_type": "FRAMED_LOGO"
- },
- "customer_notes_enabled": true,
- "location_id": "LOCATION_ID_1",
- "policies": [
- {
- "description": "This is my Return Policy",
- "title": "Return Policy",
- "uid": "POLICY_ID_1"
- }
- ],
- "tipping": {
- "default_percent": 15,
- "default_whole_amount_money": {
- "amount": 100,
- "currency": "USD"
- },
- "percentages": [
- 10,
- 15,
- 20
- ],
- "smart_tipping_enabled": true,
- "whole_amounts": [
- {
- "amount": 1000,
- "currency": "USD"
- },
- {
- "amount": 1500,
- "currency": "USD"
- },
- {
- "amount": 2000,
- "currency": "USD"
- }
- ],
- "smart_tips": [
- {
- "amount": 152,
- "currency": "GEL"
- },
- {
- "amount": 152,
- "currency": "GEL"
- }
- ],
- "default_smart_tip": {
- "amount": 58,
- "currency": "KWD"
- }
- },
- "updated_at": "2022-06-16T22:25:35Z"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-loyalty-account-response.md b/doc/models/retrieve-loyalty-account-response.md
deleted file mode 100644
index 27dfcac4..00000000
--- a/doc/models/retrieve-loyalty-account-response.md
+++ /dev/null
@@ -1,52 +0,0 @@
-
-# Retrieve Loyalty Account Response
-
-A response that includes the loyalty account.
-
-## Structure
-
-`RetrieveLoyaltyAccountResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `loyaltyAccount` | [`?LoyaltyAccount`](../../doc/models/loyalty-account.md) | Optional | Describes a loyalty account in a [loyalty program](../../doc/models/loyalty-program.md). For more information, see
[Create and Retrieve Loyalty Accounts](https://developer.squareup.com/docs/loyalty-api/loyalty-accounts). | getLoyaltyAccount(): ?LoyaltyAccount | setLoyaltyAccount(?LoyaltyAccount loyaltyAccount): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_account": {
- "balance": 10,
- "created_at": "2020-05-08T21:44:32Z",
- "customer_id": "Q8002FAM9V1EZ0ADB2T5609X6NET1H0",
- "id": "79b807d2-d786-46a9-933b-918028d7a8c5",
- "lifetime_points": 20,
- "mapping": {
- "created_at": "2020-05-08T21:44:32Z",
- "id": "66aaab3f-da99-49ed-8b19-b87f851c844f",
- "phone_number": "+14155551234"
- },
- "program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
- "updated_at": "2020-05-08T21:44:32Z",
- "enrolled_at": "enrolled_at6"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-loyalty-program-response.md b/doc/models/retrieve-loyalty-program-response.md
deleted file mode 100644
index b1dba5f0..00000000
--- a/doc/models/retrieve-loyalty-program-response.md
+++ /dev/null
@@ -1,96 +0,0 @@
-
-# Retrieve Loyalty Program Response
-
-A response that contains the loyalty program.
-
-## Structure
-
-`RetrieveLoyaltyProgramResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `program` | [`?LoyaltyProgram`](../../doc/models/loyalty-program.md) | Optional | Represents a Square loyalty program. Loyalty programs define how buyers can earn points and redeem points for rewards.
Square sellers can have only one loyalty program, which is created and managed from the Seller Dashboard.
For more information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). | getProgram(): ?LoyaltyProgram | setProgram(?LoyaltyProgram program): void |
-
-## Example (as JSON)
-
-```json
-{
- "program": {
- "accrual_rules": [
- {
- "accrual_type": "SPEND",
- "points": 1,
- "spend_data": {
- "amount_money": {
- "amount": 100,
- "currency": "USD"
- },
- "excluded_category_ids": [
- "7ZERJKO5PVYXCVUHV2JCZ2UG",
- "FQKAOJE5C4FIMF5A2URMLW6V"
- ],
- "excluded_item_variation_ids": [
- "CBZXBUVVTYUBZGQO44RHMR6B",
- "EDILT24Z2NISEXDKGY6HP7XV"
- ],
- "tax_mode": "BEFORE_TAX"
- }
- }
- ],
- "created_at": "2020-04-20T16:55:11Z",
- "id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
- "location_ids": [
- "P034NEENMD09F"
- ],
- "reward_tiers": [
- {
- "created_at": "2020-04-20T16:55:11Z",
- "definition": {
- "discount_type": "FIXED_PERCENTAGE",
- "percentage_discount": "10",
- "scope": "ORDER",
- "catalog_object_ids": [
- "catalog_object_ids6"
- ],
- "fixed_discount_money": {
- "amount": 36,
- "currency": "SLL"
- },
- "max_discount_money": {
- "amount": 84,
- "currency": "BOB"
- }
- },
- "id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f",
- "name": "10% off entire sale",
- "points": 10,
- "pricing_rule_reference": {
- "catalog_version": 1605486402527,
- "object_id": "74C4JSHESNLTB2A7ITO5HO6F"
- }
- }
- ],
- "status": "ACTIVE",
- "terminology": {
- "one": "Point",
- "other": "Points"
- },
- "updated_at": "2020-05-01T02:00:02Z",
- "expiration_policy": {
- "expiration_duration": "expiration_duration0"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-loyalty-promotion-response.md b/doc/models/retrieve-loyalty-promotion-response.md
deleted file mode 100644
index 0e1d3e61..00000000
--- a/doc/models/retrieve-loyalty-promotion-response.md
+++ /dev/null
@@ -1,75 +0,0 @@
-
-# Retrieve Loyalty Promotion Response
-
-Represents a [RetrieveLoyaltyPromotionPromotions](../../doc/apis/loyalty.md#retrieve-loyalty-promotion) response.
-
-## Structure
-
-`RetrieveLoyaltyPromotionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `loyaltyPromotion` | [`?LoyaltyPromotion`](../../doc/models/loyalty-promotion.md) | Optional | Represents a promotion for a [loyalty program](../../doc/models/loyalty-program.md). Loyalty promotions enable buyers
to earn extra points on top of those earned from the base program.
A loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` or `SCHEDULED` status. | getLoyaltyPromotion(): ?LoyaltyPromotion | setLoyaltyPromotion(?LoyaltyPromotion loyaltyPromotion): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_promotion": {
- "available_time": {
- "start_date": "2022-08-16",
- "time_periods": [
- "BEGIN:VEVENT\nDTSTART:20220816T160000\nDURATION:PT2H\nRRULE:FREQ=WEEKLY;BYDAY=TU\nEND:VEVENT"
- ],
- "end_date": "end_date8"
- },
- "created_at": "2022-08-16T08:38:54Z",
- "id": "loypromo_f0f9b849-725e-378d-b810-511237e07b67",
- "incentive": {
- "points_multiplier_data": {
- "multiplier": "3.000",
- "points_multiplier": 3
- },
- "type": "POINTS_MULTIPLIER",
- "points_addition_data": {
- "points_addition": 218
- }
- },
- "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
- "minimum_spend_amount_money": {
- "amount": 2000,
- "currency": "USD"
- },
- "name": "Tuesday Happy Hour Promo",
- "qualifying_item_variation_ids": [
- "CJ3RYL56ITAKMD4VRCM7XERS",
- "AT3RYLR3TUA9C34VRCB7X5RR"
- ],
- "status": "ACTIVE",
- "trigger_limit": {
- "interval": "DAY",
- "times": 1
- },
- "updated_at": "2022-08-16T08:38:54Z",
- "canceled_at": "canceled_at0"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-loyalty-reward-response.md b/doc/models/retrieve-loyalty-reward-response.md
deleted file mode 100644
index 0f24ca9c..00000000
--- a/doc/models/retrieve-loyalty-reward-response.md
+++ /dev/null
@@ -1,48 +0,0 @@
-
-# Retrieve Loyalty Reward Response
-
-A response that includes the loyalty reward.
-
-## Structure
-
-`RetrieveLoyaltyRewardResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `reward` | [`?LoyaltyReward`](../../doc/models/loyalty-reward.md) | Optional | Represents a contract to redeem loyalty points for a [reward tier](../../doc/models/loyalty-program-reward-tier.md) discount. Loyalty rewards can be in an ISSUED, REDEEMED, or DELETED state.
For more information, see [Manage loyalty rewards](https://developer.squareup.com/docs/loyalty-api/loyalty-rewards). | getReward(): ?LoyaltyReward | setReward(?LoyaltyReward reward): void |
-
-## Example (as JSON)
-
-```json
-{
- "reward": {
- "created_at": "2020-05-08T21:55:42Z",
- "id": "9f18ac21-233a-31c3-be77-b45840f5a810",
- "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
- "points": 10,
- "redeemed_at": "2020-05-08T21:56:00Z",
- "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f",
- "status": "REDEEMED",
- "updated_at": "2020-05-08T21:56:00Z",
- "order_id": "order_id4"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-merchant-custom-attribute-definition-request.md b/doc/models/retrieve-merchant-custom-attribute-definition-request.md
deleted file mode 100644
index c2dd9d8e..00000000
--- a/doc/models/retrieve-merchant-custom-attribute-definition-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Retrieve Merchant Custom Attribute Definition Request
-
-Represents a [RetrieveMerchantCustomAttributeDefinition](../../doc/apis/merchant-custom-attributes.md#retrieve-merchant-custom-attribute-definition) request.
-
-## Structure
-
-`RetrieveMerchantCustomAttributeDefinitionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `version` | `?int` | Optional | The current version of the custom attribute definition, which is used for strongly consistent
reads to guarantee that you receive the most up-to-date data. When included in the request,
Square returns the specified version or a higher version if one exists. If the specified version
is higher than the current version, Square returns a `BAD_REQUEST` error. | getVersion(): ?int | setVersion(?int version): void |
-
-## Example (as JSON)
-
-```json
-{
- "version": 162
-}
-```
-
diff --git a/doc/models/retrieve-merchant-custom-attribute-definition-response.md b/doc/models/retrieve-merchant-custom-attribute-definition-response.md
deleted file mode 100644
index 1153a2d1..00000000
--- a/doc/models/retrieve-merchant-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,45 +0,0 @@
-
-# Retrieve Merchant Custom Attribute Definition Response
-
-Represents a [RetrieveMerchantCustomAttributeDefinition](../../doc/apis/merchant-custom-attributes.md#retrieve-merchant-custom-attribute-definition) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`RetrieveMerchantCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`?CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Optional | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): ?CustomAttributeDefinition | setCustomAttributeDefinition(?CustomAttributeDefinition customAttributeDefinition): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "created_at": "2023-05-05T19:06:36.559Z",
- "description": "This is the other name this merchant goes by.",
- "key": "alternative_seller_name",
- "name": "Alternative Merchant Name",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2023-05-05T19:06:36.559Z",
- "version": 1,
- "visibility": "VISIBILITY_READ_ONLY"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-merchant-custom-attribute-request.md b/doc/models/retrieve-merchant-custom-attribute-request.md
deleted file mode 100644
index 5dd967ad..00000000
--- a/doc/models/retrieve-merchant-custom-attribute-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Retrieve Merchant Custom Attribute Request
-
-Represents a [RetrieveMerchantCustomAttribute](../../doc/apis/merchant-custom-attributes.md#retrieve-merchant-custom-attribute) request.
-
-## Structure
-
-`RetrieveMerchantCustomAttributeRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `withDefinition` | `?bool` | Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of
the custom attribute. Set this parameter to `true` to get the name and description of the custom
attribute, information about the data type, or other definition details. The default value is `false`. | getWithDefinition(): ?bool | setWithDefinition(?bool withDefinition): void |
-| `version` | `?int` | Optional | The current version of the custom attribute, which is used for strongly consistent reads to
guarantee that you receive the most up-to-date data. When included in the request, Square
returns the specified version or a higher version if one exists. If the specified version is
higher than the current version, Square returns a `BAD_REQUEST` error. | getVersion(): ?int | setVersion(?int version): void |
-
-## Example (as JSON)
-
-```json
-{
- "with_definition": false,
- "version": 52
-}
-```
-
diff --git a/doc/models/retrieve-merchant-custom-attribute-response.md b/doc/models/retrieve-merchant-custom-attribute-response.md
deleted file mode 100644
index acafecc1..00000000
--- a/doc/models/retrieve-merchant-custom-attribute-response.md
+++ /dev/null
@@ -1,57 +0,0 @@
-
-# Retrieve Merchant Custom Attribute Response
-
-Represents a [RetrieveMerchantCustomAttribute](../../doc/apis/merchant-custom-attributes.md#retrieve-merchant-custom-attribute) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`RetrieveMerchantCustomAttributeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttribute` | [`?CustomAttribute`](../../doc/models/custom-attribute.md) | Optional | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | getCustomAttribute(): ?CustomAttribute | setCustomAttribute(?CustomAttribute customAttribute): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute": {
- "key": "key2",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 102,
- "visibility": "VISIBILITY_READ_ONLY",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-merchant-response.md b/doc/models/retrieve-merchant-response.md
deleted file mode 100644
index fe9d149d..00000000
--- a/doc/models/retrieve-merchant-response.md
+++ /dev/null
@@ -1,47 +0,0 @@
-
-# Retrieve Merchant Response
-
-The response object returned by the [RetrieveMerchant](../../doc/apis/merchants.md#retrieve-merchant) endpoint.
-
-## Structure
-
-`RetrieveMerchantResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `merchant` | [`?Merchant`](../../doc/models/merchant.md) | Optional | Represents a business that sells with Square. | getMerchant(): ?Merchant | setMerchant(?Merchant merchant): void |
-
-## Example (as JSON)
-
-```json
-{
- "merchant": {
- "business_name": "Apple A Day",
- "country": "US",
- "created_at": "2021-12-10T19:25:52.484Z",
- "currency": "USD",
- "id": "DM7VKY8Q63GNP",
- "language_code": "en-US",
- "main_location_id": "9A65CGC72ZQG1",
- "status": "ACTIVE"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-merchant-settings-response.md b/doc/models/retrieve-merchant-settings-response.md
deleted file mode 100644
index 980288ef..00000000
--- a/doc/models/retrieve-merchant-settings-response.md
+++ /dev/null
@@ -1,76 +0,0 @@
-
-# Retrieve Merchant Settings Response
-
-## Structure
-
-`RetrieveMerchantSettingsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `merchantSettings` | [`?CheckoutMerchantSettings`](../../doc/models/checkout-merchant-settings.md) | Optional | - | getMerchantSettings(): ?CheckoutMerchantSettings | setMerchantSettings(?CheckoutMerchantSettings merchantSettings): void |
-
-## Example (as JSON)
-
-```json
-{
- "merchant_settings": {
- "merchant_id": "MERCHANT_ID",
- "payment_methods": {
- "afterpay_clearpay": {
- "enabled": true,
- "item_eligibility_range": {
- "max": {
- "amount": 10000,
- "currency": "USD"
- },
- "min": {
- "amount": 100,
- "currency": "USD"
- }
- },
- "order_eligibility_range": {
- "max": {
- "amount": 10000,
- "currency": "USD"
- },
- "min": {
- "amount": 100,
- "currency": "USD"
- }
- }
- },
- "apple_pay": {
- "enabled": true
- },
- "cash_app_pay": {
- "enabled": true
- },
- "google_pay": {
- "enabled": true
- },
- "cash_app": {
- "enabled": false
- }
- },
- "updated_at": "2022-06-16T22:25:35Z"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-order-custom-attribute-definition-request.md b/doc/models/retrieve-order-custom-attribute-definition-request.md
deleted file mode 100644
index 7bde12bc..00000000
--- a/doc/models/retrieve-order-custom-attribute-definition-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Retrieve Order Custom Attribute Definition Request
-
-Represents a get request for an order custom attribute definition.
-
-## Structure
-
-`RetrieveOrderCustomAttributeDefinitionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `version` | `?int` | Optional | To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)
control, include this optional field and specify the current version of the custom attribute. | getVersion(): ?int | setVersion(?int version): void |
-
-## Example (as JSON)
-
-```json
-{
- "version": 142
-}
-```
-
diff --git a/doc/models/retrieve-order-custom-attribute-definition-response.md b/doc/models/retrieve-order-custom-attribute-definition-response.md
deleted file mode 100644
index d3344331..00000000
--- a/doc/models/retrieve-order-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,44 +0,0 @@
-
-# Retrieve Order Custom Attribute Definition Response
-
-Represents a response from getting an order custom attribute definition.
-
-## Structure
-
-`RetrieveOrderCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`?CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Optional | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): ?CustomAttributeDefinition | setCustomAttributeDefinition(?CustomAttributeDefinition customAttributeDefinition): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "created_at": "2022-10-06T16:53:23.141Z",
- "description": "The number of people seated at a table",
- "key": "cover-count",
- "name": "Cover count",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-10-06T16:53:23.141Z",
- "version": 1,
- "visibility": "VISIBILITY_READ_WRITE_VALUES"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-order-custom-attribute-request.md b/doc/models/retrieve-order-custom-attribute-request.md
deleted file mode 100644
index d7de6bb5..00000000
--- a/doc/models/retrieve-order-custom-attribute-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Retrieve Order Custom Attribute Request
-
-Represents a get request for an order custom attribute.
-
-## Structure
-
-`RetrieveOrderCustomAttributeRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `version` | `?int` | Optional | To enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency)
control, include this optional field and specify the current version of the custom attribute. | getVersion(): ?int | setVersion(?int version): void |
-| `withDefinition` | `?bool` | Optional | Indicates whether to return the [custom attribute definition](entity:CustomAttributeDefinition) in the `definition` field of each
custom attribute. Set this parameter to `true` to get the name and description of each custom attribute,
information about the data type, or other definition details. The default value is `false`. | getWithDefinition(): ?bool | setWithDefinition(?bool withDefinition): void |
-
-## Example (as JSON)
-
-```json
-{
- "version": 110,
- "with_definition": false
-}
-```
-
diff --git a/doc/models/retrieve-order-custom-attribute-response.md b/doc/models/retrieve-order-custom-attribute-response.md
deleted file mode 100644
index 9fe83066..00000000
--- a/doc/models/retrieve-order-custom-attribute-response.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Retrieve Order Custom Attribute Response
-
-Represents a response from getting an order custom attribute.
-
-## Structure
-
-`RetrieveOrderCustomAttributeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttribute` | [`?CustomAttribute`](../../doc/models/custom-attribute.md) | Optional | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | getCustomAttribute(): ?CustomAttribute | setCustomAttribute(?CustomAttribute customAttribute): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute": {
- "key": "key2",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 102,
- "visibility": "VISIBILITY_READ_ONLY",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-order-response.md b/doc/models/retrieve-order-response.md
deleted file mode 100644
index 8be86e8f..00000000
--- a/doc/models/retrieve-order-response.md
+++ /dev/null
@@ -1,231 +0,0 @@
-
-# Retrieve Order Response
-
-## Structure
-
-`RetrieveOrderResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `order` | [`?Order`](../../doc/models/order.md) | Optional | Contains all information related to a single order to process with Square,
including line items that specify the products to purchase. `Order` objects also
include information about any associated tenders, refunds, and returns.
All Connect V2 Transactions have all been converted to Orders including all associated
itemization data. | getOrder(): ?Order | setOrder(?Order order): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "order": {
- "created_at": "2020-05-18T16:30:49.614Z",
- "discounts": [
- {
- "applied_money": {
- "amount": 550,
- "currency": "USD"
- },
- "name": "50% Off",
- "percentage": "50",
- "scope": "ORDER",
- "type": "FIXED_PERCENTAGE",
- "uid": "zGsRZP69aqSSR9lq9euSPB"
- }
- ],
- "id": "CAISENgvlJ6jLWAzERDzjyHVybY",
- "line_items": [
- {
- "applied_discounts": [
- {
- "applied_money": {
- "amount": 250,
- "currency": "USD"
- },
- "discount_uid": "zGsRZP69aqSSR9lq9euSPB",
- "uid": "9zr9S4dxvPAixvn0lpa1VC"
- }
- ],
- "base_price_money": {
- "amount": 500,
- "currency": "USD"
- },
- "gross_sales_money": {
- "amount": 500,
- "currency": "USD"
- },
- "name": "Item 1",
- "quantity": "1",
- "total_discount_money": {
- "amount": 250,
- "currency": "USD"
- },
- "total_money": {
- "amount": 250,
- "currency": "USD"
- },
- "total_service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 0,
- "currency": "USD"
- },
- "uid": "ULkg0tQTRK2bkU9fNv3IJD",
- "variation_total_price_money": {
- "amount": 500,
- "currency": "USD"
- },
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- },
- {
- "applied_discounts": [
- {
- "applied_money": {
- "amount": 300,
- "currency": "USD"
- },
- "discount_uid": "zGsRZP69aqSSR9lq9euSPB",
- "uid": "qa8LwwZK82FgSEkQc2HYVC"
- }
- ],
- "base_price_money": {
- "amount": 300,
- "currency": "USD"
- },
- "gross_sales_money": {
- "amount": 600,
- "currency": "USD"
- },
- "name": "Item 2",
- "quantity": "2",
- "total_discount_money": {
- "amount": 300,
- "currency": "USD"
- },
- "total_money": {
- "amount": 300,
- "currency": "USD"
- },
- "total_service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 0,
- "currency": "USD"
- },
- "uid": "mumY8Nun4BC5aKe2yyx5a",
- "variation_total_price_money": {
- "amount": 600,
- "currency": "USD"
- },
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- }
- ],
- "location_id": "D7AVYMEAPJ3A3",
- "net_amounts": {
- "discount_money": {
- "amount": 550,
- "currency": "USD"
- },
- "service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "tax_money": {
- "amount": 0,
- "currency": "USD"
- },
- "tip_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_money": {
- "amount": 550,
- "currency": "USD"
- }
- },
- "state": "OPEN",
- "total_discount_money": {
- "amount": 550,
- "currency": "USD"
- },
- "total_money": {
- "amount": 550,
- "currency": "USD"
- },
- "total_service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_tip_money": {
- "amount": 0,
- "currency": "USD"
- },
- "updated_at": "2020-05-18T16:30:49.614Z",
- "version": 1,
- "reference_id": "reference_id4",
- "source": {
- "name": "name4"
- },
- "customer_id": "customer_id4"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-payment-link-response.md b/doc/models/retrieve-payment-link-response.md
deleted file mode 100644
index e8453d04..00000000
--- a/doc/models/retrieve-payment-link-response.md
+++ /dev/null
@@ -1,69 +0,0 @@
-
-# Retrieve Payment Link Response
-
-## Structure
-
-`RetrievePaymentLinkResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `paymentLink` | [`?PaymentLink`](../../doc/models/payment-link.md) | Optional | - | getPaymentLink(): ?PaymentLink | setPaymentLink(?PaymentLink paymentLink): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_link": {
- "created_at": "2022-04-26T00:10:29Z",
- "id": "LLO5Q3FRCFICDB4B",
- "long_url": "https://checkout.square.site/EXAMPLE",
- "order_id": "4uKASDATqSd1QQ9jV86sPhMdVEbSJc4F",
- "url": "https://square.link/u/EXAMPLE",
- "version": 1,
- "description": "description2",
- "checkout_options": {
- "allow_tipping": false,
- "custom_fields": [
- {
- "title": "title8"
- },
- {
- "title": "title8"
- }
- ],
- "subscription_plan_id": "subscription_plan_id8",
- "redirect_url": "redirect_url2",
- "merchant_support_email": "merchant_support_email8"
- },
- "pre_populated_data": {
- "buyer_email": "buyer_email8",
- "buyer_phone_number": "buyer_phone_number0",
- "buyer_address": {
- "address_line_1": "address_line_12",
- "address_line_2": "address_line_22",
- "address_line_3": "address_line_38",
- "locality": "locality2",
- "sublocality": "sublocality2"
- }
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-snippet-response.md b/doc/models/retrieve-snippet-response.md
deleted file mode 100644
index 65c35698..00000000
--- a/doc/models/retrieve-snippet-response.md
+++ /dev/null
@@ -1,38 +0,0 @@
-
-# Retrieve Snippet Response
-
-Represents a `RetrieveSnippet` response. The response can include either `snippet` or `errors`.
-
-## Structure
-
-`RetrieveSnippetResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `snippet` | [`?Snippet`](../../doc/models/snippet.md) | Optional | Represents the snippet that is added to a Square Online site. The snippet code is injected into the `head` element of all pages on the site, except for checkout pages. | getSnippet(): ?Snippet | setSnippet(?Snippet snippet): void |
-
-## Example (as JSON)
-
-```json
-{
- "snippet": {
- "content": "",
- "created_at": "2021-03-11T25:40:09.000000Z",
- "id": "snippet_5d178150-a6c0-11eb-a9f1-437e6a2881e7",
- "site_id": "site_278075276488921835",
- "updated_at": "2021-03-11T25:40:09.000000Z"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-subscription-request.md b/doc/models/retrieve-subscription-request.md
deleted file mode 100644
index da406cd4..00000000
--- a/doc/models/retrieve-subscription-request.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-# Retrieve Subscription Request
-
-Defines input parameters in a request to the
-[RetrieveSubscription](../../doc/apis/subscriptions.md#retrieve-subscription) endpoint.
-
-## Structure
-
-`RetrieveSubscriptionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `include` | `?string` | Optional | A query parameter to specify related information to be included in the response.
The supported query parameter values are:
- `actions`: to include scheduled actions on the targeted subscription. | getInclude(): ?string | setInclude(?string include): void |
-
-## Example (as JSON)
-
-```json
-{
- "include": "include2"
-}
-```
-
diff --git a/doc/models/retrieve-subscription-response.md b/doc/models/retrieve-subscription-response.md
deleted file mode 100644
index 57db90ad..00000000
--- a/doc/models/retrieve-subscription-response.md
+++ /dev/null
@@ -1,62 +0,0 @@
-
-# Retrieve Subscription Response
-
-Defines output parameters in a response from the
-[RetrieveSubscription](../../doc/apis/subscriptions.md#retrieve-subscription) endpoint.
-
-## Structure
-
-`RetrieveSubscriptionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `subscription` | [`?Subscription`](../../doc/models/subscription.md) | Optional | Represents a subscription purchased by a customer.
For more information, see
[Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions). | getSubscription(): ?Subscription | setSubscription(?Subscription subscription): void |
-
-## Example (as JSON)
-
-```json
-{
- "subscription": {
- "card_id": "ccof:IkWfpLj4tNHMyFii3GB",
- "charged_through_date": "2023-11-20",
- "created_at": "2022-07-27T21:53:10Z",
- "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "id": "8151fc89-da15-4eb9-a685-1a70883cebfc",
- "invoice_ids": [
- "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY",
- "inv:0-ChrcX_i3sNmfsHTGKhI4Wg2mceA"
- ],
- "location_id": "S8GWD5R9QB376",
- "paid_until_date": "2024-08-01",
- "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
- "price_override_money": {
- "amount": 25000,
- "currency": "USD"
- },
- "source": {
- "name": "My Application"
- },
- "start_date": "2022-07-27",
- "status": "ACTIVE",
- "timezone": "America/Los_Angeles"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-team-member-booking-profile-response.md b/doc/models/retrieve-team-member-booking-profile-response.md
deleted file mode 100644
index fd016650..00000000
--- a/doc/models/retrieve-team-member-booking-profile-response.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Retrieve Team Member Booking Profile Response
-
-## Structure
-
-`RetrieveTeamMemberBookingProfileResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `teamMemberBookingProfile` | [`?TeamMemberBookingProfile`](../../doc/models/team-member-booking-profile.md) | Optional | The booking profile of a seller's team member, including the team member's ID, display name, description and whether the team member can be booked as a service provider. | getTeamMemberBookingProfile(): ?TeamMemberBookingProfile | setTeamMemberBookingProfile(?TeamMemberBookingProfile teamMemberBookingProfile): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [],
- "team_member_booking_profile": {
- "display_name": "Sandbox Staff",
- "is_bookable": true,
- "team_member_id": "TMaJcbiRqPIGZuS9",
- "description": "description2",
- "profile_image_url": "profile_image_url8"
- }
-}
-```
-
diff --git a/doc/models/retrieve-team-member-response.md b/doc/models/retrieve-team-member-response.md
deleted file mode 100644
index c3cd1ebe..00000000
--- a/doc/models/retrieve-team-member-response.md
+++ /dev/null
@@ -1,82 +0,0 @@
-
-# Retrieve Team Member Response
-
-Represents a response from a retrieve request containing a `TeamMember` object or error messages.
-
-## Structure
-
-`RetrieveTeamMemberResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `teamMember` | [`?TeamMember`](../../doc/models/team-member.md) | Optional | A record representing an individual team member for a business. | getTeamMember(): ?TeamMember | setTeamMember(?TeamMember teamMember): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | The errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "team_member": {
- "assigned_locations": {
- "assignment_type": "EXPLICIT_LOCATIONS",
- "location_ids": [
- "GA2Y9HSJ8KRYT",
- "YSGH2WBKG94QZ"
- ]
- },
- "created_at": "2021-06-11T22:55:45Z",
- "email_address": "joe_doe@example.com",
- "family_name": "Doe",
- "given_name": "Joe",
- "id": "1yJlHapkseYnNPETIU1B",
- "is_owner": false,
- "phone_number": "+14159283333",
- "reference_id": "reference_id_1",
- "status": "ACTIVE",
- "updated_at": "2021-06-15T17:38:05Z",
- "wage_setting": {
- "created_at": "2021-06-11T22:55:45Z",
- "is_overtime_exempt": true,
- "job_assignments": [
- {
- "annual_rate": {
- "amount": 3000000,
- "currency": "USD"
- },
- "hourly_rate": {
- "amount": 1443,
- "currency": "USD"
- },
- "job_id": "FjS8x95cqHiMenw4f1NAUH4P",
- "job_title": "Manager",
- "pay_type": "SALARY",
- "weekly_hours": 40
- },
- {
- "hourly_rate": {
- "amount": 2000,
- "currency": "USD"
- },
- "job_id": "VDNpRv8da51NU8qZFC5zDWpF",
- "job_title": "Cashier",
- "pay_type": "HOURLY"
- }
- ],
- "team_member_id": "1yJlHapkseYnNPETIU1B",
- "updated_at": "2021-06-11T22:55:45Z",
- "version": 1
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-token-status-response.md b/doc/models/retrieve-token-status-response.md
deleted file mode 100644
index f4bef6c2..00000000
--- a/doc/models/retrieve-token-status-response.md
+++ /dev/null
@@ -1,48 +0,0 @@
-
-# Retrieve Token Status Response
-
-Defines the fields that are included in the response body of
-a request to the `RetrieveTokenStatus` endpoint.
-
-## Structure
-
-`RetrieveTokenStatusResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `scopes` | `?(string[])` | Optional | The list of scopes associated with an access token. | getScopes(): ?array | setScopes(?array scopes): void |
-| `expiresAt` | `?string` | Optional | The date and time when the `access_token` expires, in RFC 3339 format. Empty if the token never expires. | getExpiresAt(): ?string | setExpiresAt(?string expiresAt): void |
-| `clientId` | `?string` | Optional | The Square-issued application ID associated with the access token. This is the same application ID used to obtain the token.
**Constraints**: *Maximum Length*: `191` | getClientId(): ?string | setClientId(?string clientId): void |
-| `merchantId` | `?string` | Optional | The ID of the authorizing merchant's business.
**Constraints**: *Minimum Length*: `8`, *Maximum Length*: `191` | getMerchantId(): ?string | setMerchantId(?string merchantId): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "client_id": "CLIENT_ID",
- "expires_at": "2022-10-14T14:44:00Z",
- "merchant_id": "MERCHANT_ID",
- "scopes": [
- "PAYMENTS_READ",
- "PAYMENTS_WRITE"
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-transaction-response.md b/doc/models/retrieve-transaction-response.md
deleted file mode 100644
index 37b1b4ce..00000000
--- a/doc/models/retrieve-transaction-response.md
+++ /dev/null
@@ -1,190 +0,0 @@
-
-# Retrieve Transaction Response
-
-Defines the fields that are included in the response body of
-a request to the [RetrieveTransaction](api-endpoint:Transactions-RetrieveTransaction) endpoint.
-
-One of `errors` or `transaction` is present in a given response (never both).
-
-## Structure
-
-`RetrieveTransactionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `transaction` | [`?Transaction`](../../doc/models/transaction.md) | Optional | Represents a transaction processed with Square, either with the
Connect API or with Square Point of Sale.
The `tenders` field of this object lists all methods of payment used to pay in
the transaction. | getTransaction(): ?Transaction | setTransaction(?Transaction transaction): void |
-
-## Example (as JSON)
-
-```json
-{
- "transaction": {
- "created_at": "2016-03-10T22:57:56Z",
- "id": "KnL67ZIwXCPtzOrqj0HrkxMF",
- "location_id": "18YC4JDH91E1H",
- "product": "EXTERNAL_API",
- "reference_id": "some optional reference id",
- "tenders": [
- {
- "additional_recipients": [
- {
- "amount_money": {
- "amount": 20,
- "currency": "USD"
- },
- "description": "Application fees",
- "location_id": "057P5VYJ4A5X1"
- }
- ],
- "amount_money": {
- "amount": 5000,
- "currency": "USD"
- },
- "card_details": {
- "card": {
- "card_brand": "VISA",
- "last_4": "1111"
- },
- "entry_method": "KEYED",
- "status": "CAPTURED"
- },
- "created_at": "2016-03-10T22:57:56Z",
- "id": "MtZRYYdDrYNQbOvV7nbuBvMF",
- "location_id": "18YC4JDH91E1H",
- "note": "some optional note",
- "processing_fee_money": {
- "amount": 138,
- "currency": "USD"
- },
- "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF",
- "type": "CARD"
- }
- ],
- "refunds": [
- {
- "id": "id8",
- "location_id": "location_id2",
- "transaction_id": "transaction_id6",
- "tender_id": "tender_id6",
- "created_at": "created_at6",
- "reason": "reason4",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "status": "PENDING",
- "processing_fee_money": {
- "amount": 112,
- "currency": "DJF"
- },
- "additional_recipients": [
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- },
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- }
- ]
- },
- {
- "id": "id8",
- "location_id": "location_id2",
- "transaction_id": "transaction_id6",
- "tender_id": "tender_id6",
- "created_at": "created_at6",
- "reason": "reason4",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "status": "PENDING",
- "processing_fee_money": {
- "amount": 112,
- "currency": "DJF"
- },
- "additional_recipients": [
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- },
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- }
- ]
- },
- {
- "id": "id8",
- "location_id": "location_id2",
- "transaction_id": "transaction_id6",
- "tender_id": "tender_id6",
- "created_at": "created_at6",
- "reason": "reason4",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "status": "PENDING",
- "processing_fee_money": {
- "amount": 112,
- "currency": "DJF"
- },
- "additional_recipients": [
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- },
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- }
- ]
- }
- ]
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-vendor-response.md b/doc/models/retrieve-vendor-response.md
deleted file mode 100644
index 44ef8376..00000000
--- a/doc/models/retrieve-vendor-response.md
+++ /dev/null
@@ -1,44 +0,0 @@
-
-# Retrieve Vendor Response
-
-Represents an output from a call to [RetrieveVendor](../../doc/apis/vendors.md#retrieve-vendor).
-
-## Structure
-
-`RetrieveVendorResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors encountered when the request fails. | getErrors(): ?array | setErrors(?array errors): void |
-| `vendor` | [`?Vendor`](../../doc/models/vendor.md) | Optional | Represents a supplier to a seller. | getVendor(): ?Vendor | setVendor(?Vendor vendor): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "vendor": {
- "id": "id6",
- "created_at": "created_at4",
- "updated_at": "updated_at2",
- "name": "name6",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- }
-}
-```
-
diff --git a/doc/models/retrieve-wage-setting-response.md b/doc/models/retrieve-wage-setting-response.md
deleted file mode 100644
index c95200f3..00000000
--- a/doc/models/retrieve-wage-setting-response.md
+++ /dev/null
@@ -1,66 +0,0 @@
-
-# Retrieve Wage Setting Response
-
-Represents a response from a retrieve request containing the specified `WageSetting` object or error messages.
-
-## Structure
-
-`RetrieveWageSettingResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `wageSetting` | [`?WageSetting`](../../doc/models/wage-setting.md) | Optional | Represents information about the overtime exemption status, job assignments, and compensation
for a [team member](../../doc/models/team-member.md). | getWageSetting(): ?WageSetting | setWageSetting(?WageSetting wageSetting): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | The errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "wage_setting": {
- "created_at": "2020-06-11T23:01:21+00:00",
- "is_overtime_exempt": false,
- "job_assignments": [
- {
- "annual_rate": {
- "amount": 4500000,
- "currency": "USD"
- },
- "hourly_rate": {
- "amount": 2164,
- "currency": "USD"
- },
- "job_title": "Manager",
- "pay_type": "SALARY",
- "weekly_hours": 40,
- "job_id": "job_id2"
- }
- ],
- "team_member_id": "1yJlHapkseYnNPETIU1B",
- "updated_at": "2020-06-11T23:01:21+00:00",
- "version": 1
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/retrieve-webhook-subscription-response.md b/doc/models/retrieve-webhook-subscription-response.md
deleted file mode 100644
index 4082ca37..00000000
--- a/doc/models/retrieve-webhook-subscription-response.md
+++ /dev/null
@@ -1,49 +0,0 @@
-
-# Retrieve Webhook Subscription Response
-
-Defines the fields that are included in the response body of
-a request to the [RetrieveWebhookSubscription](../../doc/apis/webhook-subscriptions.md#retrieve-webhook-subscription) endpoint.
-
-Note: if there are errors processing the request, the [Subscription](../../doc/models/webhook-subscription.md) will not be
-present.
-
-## Structure
-
-`RetrieveWebhookSubscriptionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `subscription` | [`?WebhookSubscription`](../../doc/models/webhook-subscription.md) | Optional | Represents the details of a webhook subscription, including notification URL,
event types, and signature key. | getSubscription(): ?WebhookSubscription | setSubscription(?WebhookSubscription subscription): void |
-
-## Example (as JSON)
-
-```json
-{
- "subscription": {
- "api_version": "2021-12-15",
- "created_at": "2022-01-10 23:29:48 +0000 UTC",
- "enabled": true,
- "event_types": [
- "payment.created",
- "payment.updated"
- ],
- "id": "wbhk_b35f6b3145074cf9ad513610786c19d5",
- "name": "Example Webhook Subscription",
- "notification_url": "https://example-webhook-url.com",
- "signature_key": "1k9bIJKCeTmSQwyagtNRLg",
- "updated_at": "2022-01-10 23:29:48 +0000 UTC"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/revoke-token-request.md b/doc/models/revoke-token-request.md
deleted file mode 100644
index fe35e80e..00000000
--- a/doc/models/revoke-token-request.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Revoke Token Request
-
-## Structure
-
-`RevokeTokenRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `clientId` | `?string` | Optional | The Square-issued ID for your application, which is available on the **OAuth** page in the
[Developer Dashboard](https://developer.squareup.com/apps).
**Constraints**: *Maximum Length*: `191` | getClientId(): ?string | setClientId(?string clientId): void |
-| `accessToken` | `?string` | Optional | The access token of the merchant whose token you want to revoke.
Do not provide a value for `merchant_id` if you provide this parameter.
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `1024` | getAccessToken(): ?string | setAccessToken(?string accessToken): void |
-| `merchantId` | `?string` | Optional | The ID of the merchant whose token you want to revoke.
Do not provide a value for `access_token` if you provide this parameter. | getMerchantId(): ?string | setMerchantId(?string merchantId): void |
-| `revokeOnlyAccessToken` | `?bool` | Optional | If `true`, terminate the given single access token, but do not
terminate the entire authorization.
Default: `false` | getRevokeOnlyAccessToken(): ?bool | setRevokeOnlyAccessToken(?bool revokeOnlyAccessToken): void |
-
-## Example (as JSON)
-
-```json
-{
- "access_token": "ACCESS_TOKEN",
- "client_id": "CLIENT_ID",
- "merchant_id": "merchant_id8",
- "revoke_only_access_token": false
-}
-```
-
diff --git a/doc/models/revoke-token-response.md b/doc/models/revoke-token-response.md
deleted file mode 100644
index dc5c8b61..00000000
--- a/doc/models/revoke-token-response.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Revoke Token Response
-
-## Structure
-
-`RevokeTokenResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `success` | `?bool` | Optional | If the request is successful, this is `true`. | getSuccess(): ?bool | setSuccess(?bool success): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "success": true,
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/risk-evaluation-risk-level.md b/doc/models/risk-evaluation-risk-level.md
deleted file mode 100644
index 618df328..00000000
--- a/doc/models/risk-evaluation-risk-level.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Risk Evaluation Risk Level
-
-## Enumeration
-
-`RiskEvaluationRiskLevel`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `PENDING` | Indicates Square is still evaluating the payment. |
-| `NORMAL` | Indicates payment risk is within the normal range. |
-| `MODERATE` | Indicates elevated risk level associated with the payment. |
-| `HIGH` | Indicates significantly elevated risk level with the payment. |
-
diff --git a/doc/models/risk-evaluation.md b/doc/models/risk-evaluation.md
deleted file mode 100644
index 9536c8d7..00000000
--- a/doc/models/risk-evaluation.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Risk Evaluation
-
-Represents fraud risk information for the associated payment.
-
-When you take a payment through Square's Payments API (using the `CreatePayment`
-endpoint), Square evaluates it and assigns a risk level to the payment. Sellers
-can use this information to determine the course of action (for example,
-provide the goods/services or refund the payment).
-
-## Structure
-
-`RiskEvaluation`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `createdAt` | `?string` | Optional | The timestamp when payment risk was evaluated, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `riskLevel` | [`?string(RiskEvaluationRiskLevel)`](../../doc/models/risk-evaluation-risk-level.md) | Optional | - | getRiskLevel(): ?string | setRiskLevel(?string riskLevel): void |
-
-## Example (as JSON)
-
-```json
-{
- "created_at": "created_at0",
- "risk_level": "MODERATE"
-}
-```
-
diff --git a/doc/models/save-card-options.md b/doc/models/save-card-options.md
deleted file mode 100644
index f08b2d33..00000000
--- a/doc/models/save-card-options.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Save Card Options
-
-Describes save-card action fields.
-
-## Structure
-
-`SaveCardOptions`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customerId` | `string` | Required | The square-assigned ID of the customer linked to the saved card. | getCustomerId(): string | setCustomerId(string customerId): void |
-| `cardId` | `?string` | Optional | The id of the created card-on-file.
**Constraints**: *Maximum Length*: `64` | getCardId(): ?string | setCardId(?string cardId): void |
-| `referenceId` | `?string` | Optional | An optional user-defined reference ID that can be used to associate
this `Card` to another entity in an external system. For example, a customer
ID generated by a third-party system.
**Constraints**: *Maximum Length*: `128` | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-
-## Example (as JSON)
-
-```json
-{
- "customer_id": "customer_id4",
- "card_id": "card_id8",
- "reference_id": "reference_id6"
-}
-```
-
diff --git a/doc/models/search-availability-filter.md b/doc/models/search-availability-filter.md
deleted file mode 100644
index c3e47966..00000000
--- a/doc/models/search-availability-filter.md
+++ /dev/null
@@ -1,71 +0,0 @@
-
-# Search Availability Filter
-
-A query filter to search for buyer-accessible availabilities by.
-
-## Structure
-
-`SearchAvailabilityFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `startAtRange` | [`TimeRange`](../../doc/models/time-range.md) | Required | Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled. | getStartAtRange(): TimeRange | setStartAtRange(TimeRange startAtRange): void |
-| `locationId` | `?string` | Optional | The query expression to search for buyer-accessible availabilities with their location IDs matching the specified location ID.
This query expression cannot be set if `booking_id` is set.
**Constraints**: *Maximum Length*: `32` | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `segmentFilters` | [`?(SegmentFilter[])`](../../doc/models/segment-filter.md) | Optional | The query expression to search for buyer-accessible availabilities matching the specified list of segment filters.
If the size of the `segment_filters` list is `n`, the search returns availabilities with `n` segments per availability.
This query expression cannot be set if `booking_id` is set. | getSegmentFilters(): ?array | setSegmentFilters(?array segmentFilters): void |
-| `bookingId` | `?string` | Optional | The query expression to search for buyer-accessible availabilities for an existing booking by matching the specified `booking_id` value.
This is commonly used to reschedule an appointment.
If this expression is set, the `location_id` and `segment_filters` expressions cannot be set.
**Constraints**: *Maximum Length*: `36` | getBookingId(): ?string | setBookingId(?string bookingId): void |
-
-## Example (as JSON)
-
-```json
-{
- "start_at_range": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- },
- "location_id": "location_id8",
- "segment_filters": [
- {
- "service_variation_id": "service_variation_id4",
- "team_member_id_filter": {
- "all": [
- "all5",
- "all6",
- "all7"
- ],
- "any": [
- "any2",
- "any3",
- "any4"
- ],
- "none": [
- "none7",
- "none8"
- ]
- }
- },
- {
- "service_variation_id": "service_variation_id4",
- "team_member_id_filter": {
- "all": [
- "all5",
- "all6",
- "all7"
- ],
- "any": [
- "any2",
- "any3",
- "any4"
- ],
- "none": [
- "none7",
- "none8"
- ]
- }
- }
- ],
- "booking_id": "booking_id8"
-}
-```
-
diff --git a/doc/models/search-availability-query.md b/doc/models/search-availability-query.md
deleted file mode 100644
index db8f7381..00000000
--- a/doc/models/search-availability-query.md
+++ /dev/null
@@ -1,89 +0,0 @@
-
-# Search Availability Query
-
-The query used to search for buyer-accessible availabilities of bookings.
-
-## Structure
-
-`SearchAvailabilityQuery`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `filter` | [`SearchAvailabilityFilter`](../../doc/models/search-availability-filter.md) | Required | A query filter to search for buyer-accessible availabilities by. | getFilter(): SearchAvailabilityFilter | setFilter(SearchAvailabilityFilter filter): void |
-
-## Example (as JSON)
-
-```json
-{
- "filter": {
- "start_at_range": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- },
- "location_id": "location_id8",
- "segment_filters": [
- {
- "service_variation_id": "service_variation_id4",
- "team_member_id_filter": {
- "all": [
- "all5",
- "all6",
- "all7"
- ],
- "any": [
- "any2",
- "any3",
- "any4"
- ],
- "none": [
- "none7",
- "none8"
- ]
- }
- },
- {
- "service_variation_id": "service_variation_id4",
- "team_member_id_filter": {
- "all": [
- "all5",
- "all6",
- "all7"
- ],
- "any": [
- "any2",
- "any3",
- "any4"
- ],
- "none": [
- "none7",
- "none8"
- ]
- }
- },
- {
- "service_variation_id": "service_variation_id4",
- "team_member_id_filter": {
- "all": [
- "all5",
- "all6",
- "all7"
- ],
- "any": [
- "any2",
- "any3",
- "any4"
- ],
- "none": [
- "none7",
- "none8"
- ]
- }
- }
- ],
- "booking_id": "booking_id8"
- }
-}
-```
-
diff --git a/doc/models/search-availability-request.md b/doc/models/search-availability-request.md
deleted file mode 100644
index 3ef5b4e9..00000000
--- a/doc/models/search-availability-request.md
+++ /dev/null
@@ -1,89 +0,0 @@
-
-# Search Availability Request
-
-## Structure
-
-`SearchAvailabilityRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `query` | [`SearchAvailabilityQuery`](../../doc/models/search-availability-query.md) | Required | The query used to search for buyer-accessible availabilities of bookings. | getQuery(): SearchAvailabilityQuery | setQuery(SearchAvailabilityQuery query): void |
-
-## Example (as JSON)
-
-```json
-{
- "query": {
- "filter": {
- "start_at_range": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- },
- "location_id": "location_id8",
- "segment_filters": [
- {
- "service_variation_id": "service_variation_id4",
- "team_member_id_filter": {
- "all": [
- "all5",
- "all6",
- "all7"
- ],
- "any": [
- "any2",
- "any3",
- "any4"
- ],
- "none": [
- "none7",
- "none8"
- ]
- }
- },
- {
- "service_variation_id": "service_variation_id4",
- "team_member_id_filter": {
- "all": [
- "all5",
- "all6",
- "all7"
- ],
- "any": [
- "any2",
- "any3",
- "any4"
- ],
- "none": [
- "none7",
- "none8"
- ]
- }
- },
- {
- "service_variation_id": "service_variation_id4",
- "team_member_id_filter": {
- "all": [
- "all5",
- "all6",
- "all7"
- ],
- "any": [
- "any2",
- "any3",
- "any4"
- ],
- "none": [
- "none7",
- "none8"
- ]
- }
- }
- ],
- "booking_id": "booking_id8"
- }
- }
-}
-```
-
diff --git a/doc/models/search-availability-response.md b/doc/models/search-availability-response.md
deleted file mode 100644
index fcf8fc51..00000000
--- a/doc/models/search-availability-response.md
+++ /dev/null
@@ -1,276 +0,0 @@
-
-# Search Availability Response
-
-## Structure
-
-`SearchAvailabilityResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `availabilities` | [`?(Availability[])`](../../doc/models/availability.md) | Optional | List of appointment slots available for booking. | getAvailabilities(): ?array | setAvailabilities(?array availabilities): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "availabilities": [
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMXUrsBWWcHTt79t",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-26T13:00:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMXUrsBWWcHTt79t",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-26T13:30:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMaJcbiRqPIGZuS9",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-26T14:00:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMaJcbiRqPIGZuS9",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-26T14:30:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMaJcbiRqPIGZuS9",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-26T15:00:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMaJcbiRqPIGZuS9",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-26T15:30:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMaJcbiRqPIGZuS9",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-26T16:00:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMXUrsBWWcHTt79t",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-27T09:00:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMaJcbiRqPIGZuS9",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-27T09:30:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMXUrsBWWcHTt79t",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-27T10:00:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMXUrsBWWcHTt79t",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-27T10:30:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMXUrsBWWcHTt79t",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-27T11:00:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMaJcbiRqPIGZuS9",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-27T11:30:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMaJcbiRqPIGZuS9",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-27T12:00:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMaJcbiRqPIGZuS9",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-27T12:30:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMXUrsBWWcHTt79t",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-27T13:00:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMXUrsBWWcHTt79t",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-27T13:30:00Z"
- },
- {
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMaJcbiRqPIGZuS9",
- "intermission_minutes": 54,
- "any_team_member": false
- }
- ],
- "location_id": "LEQHH0YY8B42M",
- "start_at": "2020-11-27T14:00:00Z"
- }
- ],
- "errors": []
-}
-```
-
diff --git a/doc/models/search-catalog-items-request-stock-level.md b/doc/models/search-catalog-items-request-stock-level.md
deleted file mode 100644
index e0a17df8..00000000
--- a/doc/models/search-catalog-items-request-stock-level.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Search Catalog Items Request Stock Level
-
-Defines supported stock levels of the item inventory.
-
-## Enumeration
-
-`SearchCatalogItemsRequestStockLevel`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `OUT` | The item inventory is empty. |
-| `LOW` | The item inventory is low. |
-
diff --git a/doc/models/search-catalog-items-request.md b/doc/models/search-catalog-items-request.md
deleted file mode 100644
index 77519e36..00000000
--- a/doc/models/search-catalog-items-request.md
+++ /dev/null
@@ -1,69 +0,0 @@
-
-# Search Catalog Items Request
-
-Defines the request body for the [SearchCatalogItems](../../doc/apis/catalog.md#search-catalog-items) endpoint.
-
-## Structure
-
-`SearchCatalogItemsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `textFilter` | `?string` | Optional | The text filter expression to return items or item variations containing specified text in
the `name`, `description`, or `abbreviation` attribute value of an item, or in
the `name`, `sku`, or `upc` attribute value of an item variation. | getTextFilter(): ?string | setTextFilter(?string textFilter): void |
-| `categoryIds` | `?(string[])` | Optional | The category id query expression to return items containing the specified category IDs. | getCategoryIds(): ?array | setCategoryIds(?array categoryIds): void |
-| `stockLevels` | [`?(string(SearchCatalogItemsRequestStockLevel)[])`](../../doc/models/search-catalog-items-request-stock-level.md) | Optional | The stock-level query expression to return item variations with the specified stock levels.
See [SearchCatalogItemsRequestStockLevel](#type-searchcatalogitemsrequeststocklevel) for possible values | getStockLevels(): ?array | setStockLevels(?array stockLevels): void |
-| `enabledLocationIds` | `?(string[])` | Optional | The enabled-location query expression to return items and item variations having specified enabled locations. | getEnabledLocationIds(): ?array | setEnabledLocationIds(?array enabledLocationIds): void |
-| `cursor` | `?string` | Optional | The pagination token, returned in the previous response, used to fetch the next batch of pending results. | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | The maximum number of results to return per page. The default value is 100.
**Constraints**: `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `sortOrder` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-| `productTypes` | [`?(string(CatalogItemProductType)[])`](../../doc/models/catalog-item-product-type.md) | Optional | The product types query expression to return items or item variations having the specified product types. | getProductTypes(): ?array | setProductTypes(?array productTypes): void |
-| `customAttributeFilters` | [`?(CustomAttributeFilter[])`](../../doc/models/custom-attribute-filter.md) | Optional | The customer-attribute filter to return items or item variations matching the specified
custom attribute expressions. A maximum number of 10 custom attribute expressions are supported in
a single call to the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint. | getCustomAttributeFilters(): ?array | setCustomAttributeFilters(?array customAttributeFilters): void |
-| `archivedState` | [`?string(ArchivedState)`](../../doc/models/archived-state.md) | Optional | Defines the values for the `archived_state` query expression
used in [SearchCatalogItems](../../doc/apis/catalog.md#search-catalog-items)
to return the archived, not archived or either type of catalog items. | getArchivedState(): ?string | setArchivedState(?string archivedState): void |
-
-## Example (as JSON)
-
-```json
-{
- "category_ids": [
- "WINE_CATEGORY_ID"
- ],
- "custom_attribute_filters": [
- {
- "bool_filter": true,
- "custom_attribute_definition_id": "VEGAN_DEFINITION_ID"
- },
- {
- "custom_attribute_definition_id": "BRAND_DEFINITION_ID",
- "string_filter": "Dark Horse"
- },
- {
- "key": "VINTAGE",
- "number_filter": {
- "max": "2018",
- "min": "2017"
- }
- },
- {
- "custom_attribute_definition_id": "VARIETAL_DEFINITION_ID",
- "selection_ids_filter": "MERLOT_SELECTION_ID"
- }
- ],
- "enabled_location_ids": [
- "ATL_LOCATION_ID"
- ],
- "limit": 100,
- "product_types": [
- "REGULAR"
- ],
- "sort_order": "ASC",
- "stock_levels": [
- "OUT",
- "LOW"
- ],
- "text_filter": "red",
- "cursor": "cursor4"
-}
-```
-
diff --git a/doc/models/search-catalog-items-response.md b/doc/models/search-catalog-items-response.md
deleted file mode 100644
index b08e576c..00000000
--- a/doc/models/search-catalog-items-response.md
+++ /dev/null
@@ -1,89 +0,0 @@
-
-# Search Catalog Items Response
-
-Defines the response body returned from the [SearchCatalogItems](../../doc/apis/catalog.md#search-catalog-items) endpoint.
-
-## Structure
-
-`SearchCatalogItemsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `items` | [`?(CatalogObject[])`](../../doc/models/catalog-object.md) | Optional | Returned items matching the specified query expressions. | getItems(): ?array | setItems(?array items): void |
-| `cursor` | `?string` | Optional | Pagination token used in the next request to return more of the search result. | getCursor(): ?string | setCursor(?string cursor): void |
-| `matchedVariationIds` | `?(string[])` | Optional | Ids of returned item variations matching the specified query expression. | getMatchedVariationIds(): ?array | setMatchedVariationIds(?array matchedVariationIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "items": [
- {
- "type": "SUBSCRIPTION_PLAN",
- "id": "id8",
- "updated_at": "updated_at6",
- "version": 38,
- "is_deleted": false,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key2": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- }
- ],
- "cursor": "cursor2",
- "matched_variation_ids": [
- "matched_variation_ids3"
- ]
-}
-```
-
diff --git a/doc/models/search-catalog-objects-request.md b/doc/models/search-catalog-objects-request.md
deleted file mode 100644
index a7f70bc9..00000000
--- a/doc/models/search-catalog-objects-request.md
+++ /dev/null
@@ -1,41 +0,0 @@
-
-# Search Catalog Objects Request
-
-## Structure
-
-`SearchCatalogObjectsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | The pagination cursor returned in the previous response. Leave unset for an initial request.
See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-| `objectTypes` | [`?(string(CatalogObjectType)[])`](../../doc/models/catalog-object-type.md) | Optional | The desired set of object types to appear in the search results.
If this is unspecified, the operation returns objects of all the top level types at the version
of the Square API used to make the request. Object types that are nested onto other object types
are not included in the defaults.
At the current API version the default object types are:
ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST,
PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,
SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.
Note that if you wish for the query to return objects belonging to nested types (i.e., COMPONENT, IMAGE,
ITEM_OPTION_VAL, ITEM_VARIATION, or MODIFIER), you must explicitly include all the types of interest
in this field. | getObjectTypes(): ?array | setObjectTypes(?array objectTypes): void |
-| `includeDeletedObjects` | `?bool` | Optional | If `true`, deleted objects will be included in the results. Deleted objects will have their
`is_deleted` field set to `true`. | getIncludeDeletedObjects(): ?bool | setIncludeDeletedObjects(?bool includeDeletedObjects): void |
-| `includeRelatedObjects` | `?bool` | Optional | If `true`, the response will include additional objects that are related to the
requested objects. Related objects are objects that are referenced by object ID by the objects
in the response. This is helpful if the objects are being fetched for immediate display to a user.
This process only goes one level deep. Objects referenced by the related objects will not be included.
For example:
If the `objects` field of the response contains a CatalogItem, its associated
CatalogCategory objects, CatalogTax objects, CatalogImage objects and
CatalogModifierLists will be returned in the `related_objects` field of the
response. If the `objects` field of the response contains a CatalogItemVariation,
its parent CatalogItem will be returned in the `related_objects` field of
the response.
Default value: `false` | getIncludeRelatedObjects(): ?bool | setIncludeRelatedObjects(?bool includeRelatedObjects): void |
-| `beginTime` | `?string` | Optional | Return objects modified after this [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), in RFC 3339
format, e.g., `2016-09-04T23:59:33.123Z`. The timestamp is exclusive - objects with a
timestamp equal to `begin_time` will not be included in the response. | getBeginTime(): ?string | setBeginTime(?string beginTime): void |
-| `query` | [`?CatalogQuery`](../../doc/models/catalog-query.md) | Optional | A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint.
Although a query can have multiple filters, only certain query types can be combined per call to [SearchCatalogObjects](../../doc/apis/catalog.md#search-catalog-objects).
Any combination of the following types may be used together:
- [exact_query](../../doc/models/catalog-query-exact.md)
- [prefix_query](../../doc/models/catalog-query-prefix.md)
- [range_query](../../doc/models/catalog-query-range.md)
- [sorted_attribute_query](../../doc/models/catalog-query-sorted-attribute.md)
- [text_query](../../doc/models/catalog-query-text.md)
All other query types cannot be combined with any others.
When a query filter is based on an attribute, the attribute must be searchable.
Searchable attributes are listed as follows, along their parent types that can be searched for with applicable query filters.
Searchable attribute and objects queryable by searchable attributes:
- `name`: `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, `CatalogTax`, `CatalogDiscount`, `CatalogModifier`, `CatalogModifierList`, `CatalogItemOption`, `CatalogItemOptionValue`
- `description`: `CatalogItem`, `CatalogItemOptionValue`
- `abbreviation`: `CatalogItem`
- `upc`: `CatalogItemVariation`
- `sku`: `CatalogItemVariation`
- `caption`: `CatalogImage`
- `display_name`: `CatalogItemOption`
For example, to search for [CatalogItem](../../doc/models/catalog-item.md) objects by searchable attributes, you can use
the `"name"`, `"description"`, or `"abbreviation"` attribute in an applicable query filter. | getQuery(): ?CatalogQuery | setQuery(?CatalogQuery query): void |
-| `limit` | `?int` | Optional | A limit on the number of results to be returned in a single page. The limit is advisory -
the implementation may return more or fewer results. If the supplied limit is negative, zero, or
is higher than the maximum limit of 1,000, it will be ignored. | getLimit(): ?int | setLimit(?int limit): void |
-| `includeCategoryPathToRoot` | `?bool` | Optional | Specifies whether or not to include the `path_to_root` list for each returned category instance. The `path_to_root` list consists
of `CategoryPathToRootNode` objects and specifies the path that starts with the immediate parent category of the returned category
and ends with its root category. If the returned category is a top-level category, the `path_to_root` list is empty and is not returned
in the response payload. | getIncludeCategoryPathToRoot(): ?bool | setIncludeCategoryPathToRoot(?bool includeCategoryPathToRoot): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 100,
- "object_types": [
- "ITEM"
- ],
- "query": {
- "prefix_query": {
- "attribute_name": "name",
- "attribute_prefix": "tea"
- }
- },
- "cursor": "cursor2",
- "include_deleted_objects": false,
- "include_related_objects": false,
- "begin_time": "begin_time2"
-}
-```
-
diff --git a/doc/models/search-catalog-objects-response.md b/doc/models/search-catalog-objects-response.md
deleted file mode 100644
index cbdf0ae5..00000000
--- a/doc/models/search-catalog-objects-response.md
+++ /dev/null
@@ -1,231 +0,0 @@
-
-# Search Catalog Objects Response
-
-## Structure
-
-`SearchCatalogObjectsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request. If unset, this is the final response.
See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-| `objects` | [`?(CatalogObject[])`](../../doc/models/catalog-object.md) | Optional | The CatalogObjects returned. | getObjects(): ?array | setObjects(?array objects): void |
-| `relatedObjects` | [`?(CatalogObject[])`](../../doc/models/catalog-object.md) | Optional | A list of CatalogObjects referenced by the objects in the `objects` field. | getRelatedObjects(): ?array | setRelatedObjects(?array relatedObjects): void |
-| `latestTime` | `?string` | Optional | When the associated product catalog was last updated. Will
match the value for `end_time` or `cursor` if either field is included in the `SearchCatalog` request. | getLatestTime(): ?string | setLatestTime(?string latestTime): void |
-
-## Example (as JSON)
-
-```json
-{
- "objects": [
- {
- "id": "X5DZ5NWWAQ44CKBLKIFQGOWK",
- "is_deleted": false,
- "item_data": {
- "categories": [
- {
- "id": "E7CLE5RZZ744BHWVQQEAHI2C",
- "ordinal": 0
- }
- ],
- "description": "A delicious blend of black tea.",
- "name": "Tea - Black",
- "product_type": "REGULAR",
- "tax_ids": [
- "ZXITPM6RWHZ7GZ7EIP3YKECM"
- ],
- "variations": [
- {
- "id": "5GSZPX6EU7MM75S57OONG3V5",
- "is_deleted": false,
- "item_variation_data": {
- "item_id": "X5DZ5NWWAQ44CKBLKIFQGOWK",
- "name": "Regular",
- "ordinal": 1,
- "price_money": {
- "amount": 150,
- "currency": "USD"
- },
- "pricing_type": "FIXED_PRICING"
- },
- "present_at_all_locations": true,
- "type": "ITEM_VARIATION",
- "updated_at": "2017-10-26T15:27:31.626Z",
- "version": 1509031651626
- },
- {
- "id": "XVLBN7DU6JTWHJTG5F265B43",
- "is_deleted": false,
- "item_variation_data": {
- "item_id": "X5DZ5NWWAQ44CKBLKIFQGOWK",
- "name": "Large",
- "ordinal": 2,
- "price_money": {
- "amount": 225,
- "currency": "USD"
- },
- "pricing_type": "FIXED_PRICING"
- },
- "present_at_all_locations": true,
- "type": "ITEM_VARIATION",
- "updated_at": "2017-10-26T15:27:31.626Z",
- "version": 1509031651626
- }
- ],
- "visibility": "PRIVATE"
- },
- "present_at_all_locations": true,
- "type": "ITEM",
- "updated_at": "2017-10-26T15:41:32.337Z",
- "version": 1509032492337,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- },
- {
- "id": "NNNEM3LA656Q46NXLWCNI7S5",
- "is_deleted": false,
- "item_data": {
- "categories": [
- {
- "id": "E7CLE5RZZ744BHWVQQEAHI2C",
- "ordinal": 0
- }
- ],
- "description": "Relaxing green herbal tea.",
- "name": "Tea - Green",
- "product_type": "REGULAR",
- "tax_ids": [
- "ZXITPM6RWHZ7GZ7EIP3YKECM"
- ],
- "variations": [
- {
- "id": "FHYBVIA6NVBCSOVETA62WEA4",
- "is_deleted": false,
- "item_variation_data": {
- "item_id": "NNNEM3LA656Q46NXLWCNI7S5",
- "name": "Regular",
- "ordinal": 1,
- "price_money": {
- "amount": 150,
- "currency": "USD"
- },
- "pricing_type": "FIXED_PRICING"
- },
- "present_at_all_locations": true,
- "type": "ITEM_VARIATION",
- "updated_at": "2017-10-26T15:29:00.524Z",
- "version": 1509031740524
- }
- ],
- "visibility": "PRIVATE"
- },
- "present_at_all_locations": true,
- "type": "ITEM",
- "updated_at": "2017-10-26T15:41:23.232Z",
- "version": 1509032483232,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor6",
- "related_objects": [
- {
- "type": "SUBSCRIPTION_PLAN_VARIATION",
- "id": "id2",
- "updated_at": "updated_at2",
- "version": 0,
- "is_deleted": false,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- }
- ],
- "latest_time": "latest_time2"
-}
-```
-
diff --git a/doc/models/search-customers-request.md b/doc/models/search-customers-request.md
deleted file mode 100644
index c9fcc233..00000000
--- a/doc/models/search-customers-request.md
+++ /dev/null
@@ -1,64 +0,0 @@
-
-# Search Customers Request
-
-Defines the fields that are included in the request body of a request to the
-`SearchCustomers` endpoint.
-
-## Structure
-
-`SearchCustomersRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | Include the pagination cursor in subsequent calls to this endpoint to retrieve
the next set of results associated with the original query.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.
If the specified limit is invalid, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error. The default value is 100.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `query` | [`?CustomerQuery`](../../doc/models/customer-query.md) | Optional | Represents filtering and sorting criteria for a [SearchCustomers](../../doc/apis/customers.md#search-customers) request. | getQuery(): ?CustomerQuery | setQuery(?CustomerQuery query): void |
-| `count` | `?bool` | Optional | Indicates whether to return the total count of matching customers in the `count` field of the response.
The default value is `false`. | getCount(): ?bool | setCount(?bool count): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 2,
- "query": {
- "filter": {
- "created_at": {
- "end_at": "2018-02-01T00:00:00-00:00",
- "start_at": "2018-01-01T00:00:00-00:00"
- },
- "creation_source": {
- "rule": "INCLUDE",
- "values": [
- "THIRD_PARTY"
- ]
- },
- "email_address": {
- "fuzzy": "example.com",
- "exact": "exact2"
- },
- "group_ids": {
- "all": [
- "545AXB44B4XXWMVQ4W8SBT3HHF"
- ]
- },
- "updated_at": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- },
- "phone_number": {
- "exact": "exact2",
- "fuzzy": "fuzzy8"
- }
- },
- "sort": {
- "field": "CREATED_AT",
- "order": "ASC"
- }
- },
- "cursor": "cursor0",
- "count": false
-}
-```
-
diff --git a/doc/models/search-customers-response.md b/doc/models/search-customers-response.md
deleted file mode 100644
index 234cff7f..00000000
--- a/doc/models/search-customers-response.md
+++ /dev/null
@@ -1,131 +0,0 @@
-
-# Search Customers Response
-
-Defines the fields that are included in the response body of
-a request to the `SearchCustomers` endpoint.
-
-Either `errors` or `customers` is present in a given response (never both).
-
-## Structure
-
-`SearchCustomersResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `customers` | [`?(Customer[])`](../../doc/models/customer.md) | Optional | The customer profiles that match the search query. If any search condition is not met, the result is an empty object (`{}`).
Only customer profiles with public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`)
are included in the response. | getCustomers(): ?array | setCustomers(?array customers): void |
-| `cursor` | `?string` | Optional | A pagination cursor that can be used during subsequent calls
to `SearchCustomers` to retrieve the next set of results associated
with the original query. Pagination cursors are only present when
a request succeeds and additional results are available.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `count` | `?int` | Optional | The total count of customers associated with the Square account that match the search query. Only customer profiles with
public information (`given_name`, `family_name`, `company_name`, `email_address`, or `phone_number`) are counted. This field is
present only if `count` is set to `true` in the request. | getCount(): ?int | setCount(?int count): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "9dpS093Uy12AzeE",
- "customers": [
- {
- "address": {
- "address_line_1": "505 Electric Ave",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "NY",
- "country": "US",
- "locality": "New York",
- "postal_code": "10003"
- },
- "created_at": "2018-01-23T20:21:54.859Z",
- "creation_source": "DIRECTORY",
- "email_address": "james.bond@example.com",
- "family_name": "Bond",
- "given_name": "James",
- "group_ids": [
- "545AXB44B4XXWMVQ4W8SBT3HHF"
- ],
- "id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "phone_number": "+1-212-555-4250",
- "preferences": {
- "email_unsubscribed": false
- },
- "reference_id": "YOUR_REFERENCE_ID_2",
- "segment_ids": [
- "1KB9JE5EGJXCW.REACHABLE"
- ],
- "updated_at": "2020-04-20T10:02:43.083Z",
- "version": 7,
- "cards": [
- {
- "id": "id8",
- "card_brand": "DISCOVER",
- "last_4": "last_40",
- "exp_month": 152,
- "exp_year": 144
- },
- {
- "id": "id8",
- "card_brand": "DISCOVER",
- "last_4": "last_40",
- "exp_month": 152,
- "exp_year": 144
- }
- ]
- },
- {
- "address": {
- "address_line_1": "500 Electric Ave",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "NY",
- "country": "US",
- "locality": "New York",
- "postal_code": "10003"
- },
- "created_at": "2018-01-30T14:10:54.859Z",
- "creation_source": "THIRD_PARTY",
- "email_address": "amelia.earhart@example.com",
- "family_name": "Earhart",
- "given_name": "Amelia",
- "group_ids": [
- "545AXB44B4XXWMVQ4W8SBT3HHF"
- ],
- "id": "A9641GZW2H7Z56YYSD41Q12HDW",
- "note": "a customer",
- "phone_number": "+1-212-555-9238",
- "preferences": {
- "email_unsubscribed": false
- },
- "reference_id": "YOUR_REFERENCE_ID_1",
- "segment_ids": [
- "1KB9JE5EGJXCW.REACHABLE"
- ],
- "updated_at": "2018-03-08T18:25:21.342Z",
- "version": 1,
- "cards": [
- {
- "id": "id8",
- "card_brand": "DISCOVER",
- "last_4": "last_40",
- "exp_month": 152,
- "exp_year": 144
- },
- {
- "id": "id8",
- "card_brand": "DISCOVER",
- "last_4": "last_40",
- "exp_month": 152,
- "exp_year": 144
- }
- ]
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "count": 90
-}
-```
-
diff --git a/doc/models/search-events-filter.md b/doc/models/search-events-filter.md
deleted file mode 100644
index 014ce762..00000000
--- a/doc/models/search-events-filter.md
+++ /dev/null
@@ -1,43 +0,0 @@
-
-# Search Events Filter
-
-Criteria to filter events by.
-
-## Structure
-
-`SearchEventsFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `eventTypes` | `?(string[])` | Optional | Filter events by event types. | getEventTypes(): ?array | setEventTypes(?array eventTypes): void |
-| `merchantIds` | `?(string[])` | Optional | Filter events by merchant. | getMerchantIds(): ?array | setMerchantIds(?array merchantIds): void |
-| `locationIds` | `?(string[])` | Optional | Filter events by location. | getLocationIds(): ?array | setLocationIds(?array locationIds): void |
-| `createdAt` | [`?TimeRange`](../../doc/models/time-range.md) | Optional | Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled. | getCreatedAt(): ?TimeRange | setCreatedAt(?TimeRange createdAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "event_types": [
- "event_types6",
- "event_types7",
- "event_types8"
- ],
- "merchant_ids": [
- "merchant_ids5",
- "merchant_ids6",
- "merchant_ids7"
- ],
- "location_ids": [
- "location_ids8",
- "location_ids9"
- ],
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- }
-}
-```
-
diff --git a/doc/models/search-events-query.md b/doc/models/search-events-query.md
deleted file mode 100644
index 0c02688f..00000000
--- a/doc/models/search-events-query.md
+++ /dev/null
@@ -1,44 +0,0 @@
-
-# Search Events Query
-
-Contains query criteria for the search.
-
-## Structure
-
-`SearchEventsQuery`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `filter` | [`?SearchEventsFilter`](../../doc/models/search-events-filter.md) | Optional | Criteria to filter events by. | getFilter(): ?SearchEventsFilter | setFilter(?SearchEventsFilter filter): void |
-| `sort` | [`?SearchEventsSort`](../../doc/models/search-events-sort.md) | Optional | Criteria to sort events by. | getSort(): ?SearchEventsSort | setSort(?SearchEventsSort sort): void |
-
-## Example (as JSON)
-
-```json
-{
- "filter": {
- "event_types": [
- "event_types2",
- "event_types3"
- ],
- "merchant_ids": [
- "merchant_ids1",
- "merchant_ids2"
- ],
- "location_ids": [
- "location_ids4"
- ],
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- }
- },
- "sort": {
- "field": "DEFAULT",
- "order": "DESC"
- }
-}
-```
-
diff --git a/doc/models/search-events-request.md b/doc/models/search-events-request.md
deleted file mode 100644
index 249b72db..00000000
--- a/doc/models/search-events-request.md
+++ /dev/null
@@ -1,49 +0,0 @@
-
-# Search Events Request
-
-Searches [Event](../../doc/models/event.md)s for your application.
-
-## Structure
-
-`SearchEventsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of events for your original query.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
**Constraints**: *Maximum Length*: `256` | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | The maximum number of events to return in a single page. The response might contain fewer events. The default value is 100, which is also the maximum allowed value.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).
Default: 100
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-| `query` | [`?SearchEventsQuery`](../../doc/models/search-events-query.md) | Optional | Contains query criteria for the search. | getQuery(): ?SearchEventsQuery | setQuery(?SearchEventsQuery query): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "cursor8",
- "limit": 176,
- "query": {
- "filter": {
- "event_types": [
- "event_types2",
- "event_types3"
- ],
- "merchant_ids": [
- "merchant_ids1",
- "merchant_ids2"
- ],
- "location_ids": [
- "location_ids4"
- ],
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- }
- },
- "sort": {
- "field": "DEFAULT",
- "order": "DESC"
- }
- }
-}
-```
-
diff --git a/doc/models/search-events-response.md b/doc/models/search-events-response.md
deleted file mode 100644
index cb70c0ed..00000000
--- a/doc/models/search-events-response.md
+++ /dev/null
@@ -1,85 +0,0 @@
-
-# Search Events Response
-
-Defines the fields that are included in the response body of
-a request to the [SearchEvents](../../doc/apis/events.md#search-events) endpoint.
-
-Note: if there are errors processing the request, the events field will not be
-present.
-
-## Structure
-
-`SearchEventsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `events` | [`?(Event[])`](../../doc/models/event.md) | Optional | The list of [Event](entity:Event)s returned by the search. | getEvents(): ?array | setEvents(?array events): void |
-| `metadata` | [`?(EventMetadata[])`](../../doc/models/event-metadata.md) | Optional | Contains the metadata of an event. For more information, see [Event](entity:Event). | getMetadata(): ?array | setMetadata(?array metadata): void |
-| `cursor` | `?string` | Optional | When a response is truncated, it includes a cursor that you can use in a subsequent request to fetch the next set of events. If empty, this is the final response.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "6b571fc9773647f=",
- "events": [
- {
- "created_at": "2022-04-26T10:08:40.454726",
- "data": {
- "id": "ORSEVtZAJxb37RA1EiGw",
- "object": {
- "dispute": {
- "amount_money": {
- "amount": 8801,
- "currency": "USD"
- },
- "brand_dispute_id": "r9rKGSBBQbywBNnWWIiGFg",
- "card_brand": "VISA",
- "created_at": "2020-02-19T21:24:53.258Z",
- "disputed_payment": {
- "payment_id": "fbmsaEOpoARDKxiSGH1fqPuqoqFZY"
- },
- "due_at": "2020-03-04T00:00:00.000Z",
- "id": "ORSEVtZAJxb37RA1EiGw",
- "location_id": "VJDQQP3CG14EY",
- "reason": "AMOUNT_DIFFERS",
- "reported_at": "2020-02-19T00:00:00.000Z",
- "state": "WON",
- "updated_at": "2020-02-19T21:34:41.851Z",
- "version": 6
- }
- },
- "type": "dispute"
- },
- "event_id": "73ecd468-0aba-424f-b862-583d44efe7c8",
- "location_id": "VJDQQP3CG14EY",
- "merchant_id": "0HPGX5JYE6EE1",
- "type": "dispute.state.updated"
- }
- ],
- "metadata": [
- {
- "api_version": "2022-12-13",
- "event_id": "73ecd468-0aba-424f-b862-583d44efe7c8"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/search-events-sort-field.md b/doc/models/search-events-sort-field.md
deleted file mode 100644
index a342344b..00000000
--- a/doc/models/search-events-sort-field.md
+++ /dev/null
@@ -1,15 +0,0 @@
-
-# Search Events Sort Field
-
-Specifies the sort key for events returned from a search.
-
-## Enumeration
-
-`SearchEventsSortField`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `DEFAULT` | Use the default sort key. The default behavior is to sort events by when they were created (`created_at`). |
-
diff --git a/doc/models/search-events-sort.md b/doc/models/search-events-sort.md
deleted file mode 100644
index ea60bf8a..00000000
--- a/doc/models/search-events-sort.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Search Events Sort
-
-Criteria to sort events by.
-
-## Structure
-
-`SearchEventsSort`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `field` | [`?string(SearchEventsSortField)`](../../doc/models/search-events-sort-field.md) | Optional | Specifies the sort key for events returned from a search. | getField(): ?string | setField(?string field): void |
-| `order` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getOrder(): ?string | setOrder(?string order): void |
-
-## Example (as JSON)
-
-```json
-{
- "field": "DEFAULT",
- "order": "DESC"
-}
-```
-
diff --git a/doc/models/search-invoices-request.md b/doc/models/search-invoices-request.md
deleted file mode 100644
index f558a16d..00000000
--- a/doc/models/search-invoices-request.md
+++ /dev/null
@@ -1,41 +0,0 @@
-
-# Search Invoices Request
-
-Describes a `SearchInvoices` request.
-
-## Structure
-
-`SearchInvoicesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `query` | [`InvoiceQuery`](../../doc/models/invoice-query.md) | Required | Describes query criteria for searching invoices. | getQuery(): InvoiceQuery | setQuery(InvoiceQuery query): void |
-| `limit` | `?int` | Optional | The maximum number of invoices to return (200 is the maximum `limit`).
If not provided, the server uses a default limit of 100 invoices. | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for your original query.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "query": {
- "filter": {
- "customer_ids": [
- "JDKYHBWT1D4F8MFH63DBMEN8Y4"
- ],
- "location_ids": [
- "ES0RJRZYEC39A"
- ]
- },
- "limit": 100,
- "sort": {
- "field": "INVOICE_SORT_DATE",
- "order": "DESC"
- }
- },
- "limit": 26,
- "cursor": "cursor4"
-}
-```
-
diff --git a/doc/models/search-invoices-response.md b/doc/models/search-invoices-response.md
deleted file mode 100644
index 9cf7224b..00000000
--- a/doc/models/search-invoices-response.md
+++ /dev/null
@@ -1,191 +0,0 @@
-
-# Search Invoices Response
-
-Describes a `SearchInvoices` response.
-
-## Structure
-
-`SearchInvoicesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `invoices` | [`?(Invoice[])`](../../doc/models/invoice.md) | Optional | The list of invoices returned by the search. | getInvoices(): ?array | setInvoices(?array invoices): void |
-| `cursor` | `?string` | Optional | When a response is truncated, it includes a cursor that you can use in a
subsequent request to fetch the next set of invoices. If empty, this is the final
response.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "ChoIDhIWVm54ZVRhLXhySFBOejBBM2xJb2daUQoFCI4IGAE",
- "invoices": [
- {
- "accepted_payment_methods": {
- "bank_account": false,
- "buy_now_pay_later": false,
- "card": true,
- "cash_app_pay": false,
- "square_gift_card": false
- },
- "created_at": "2020-06-18T17:45:13Z",
- "custom_fields": [
- {
- "label": "Event Reference Number",
- "placement": "ABOVE_LINE_ITEMS",
- "value": "Ref. #1234"
- },
- {
- "label": "Terms of Service",
- "placement": "BELOW_LINE_ITEMS",
- "value": "The terms of service are..."
- }
- ],
- "delivery_method": "EMAIL",
- "description": "We appreciate your business!",
- "id": "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY",
- "invoice_number": "inv-100",
- "location_id": "ES0RJRZYEC39A",
- "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY",
- "payment_requests": [
- {
- "automatic_payment_source": "NONE",
- "computed_amount_money": {
- "amount": 10000,
- "currency": "USD"
- },
- "due_date": "2030-01-24",
- "reminders": [
- {
- "message": "Your invoice is due tomorrow",
- "relative_scheduled_days": -1,
- "status": "PENDING",
- "uid": "beebd363-e47f-4075-8785-c235aaa7df11"
- }
- ],
- "request_type": "BALANCE",
- "tipping_enabled": true,
- "total_completed_amount_money": {
- "amount": 0,
- "currency": "USD"
- },
- "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355"
- }
- ],
- "primary_recipient": {
- "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "email_address": "Amelia.Earhart@example.com",
- "family_name": "Earhart",
- "given_name": "Amelia",
- "phone_number": "1-212-555-4240",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- },
- "sale_or_service_date": "2030-01-24",
- "scheduled_at": "2030-01-13T10:00:00Z",
- "status": "DRAFT",
- "store_payment_method_enabled": false,
- "timezone": "America/Los_Angeles",
- "title": "Event Planning Services",
- "updated_at": "2020-06-18T17:45:13Z",
- "version": 0
- },
- {
- "accepted_payment_methods": {
- "bank_account": false,
- "buy_now_pay_later": false,
- "card": true,
- "cash_app_pay": false,
- "square_gift_card": true
- },
- "created_at": "2021-01-23T15:29:12Z",
- "delivery_method": "EMAIL",
- "id": "inv:0-ChC366qAfskpGrBI_1bozs9mEA3",
- "invoice_number": "inv-455",
- "location_id": "ES0RJRZYEC39A",
- "next_payment_amount_money": {
- "amount": 3000,
- "currency": "USD"
- },
- "order_id": "a65jnS8NXbfprvGJzY9F4fQTuaB",
- "payment_requests": [
- {
- "automatic_payment_source": "CARD_ON_FILE",
- "card_id": "ccof:IkWfpLj4tNHMyFii3GB",
- "computed_amount_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "due_date": "2021-01-23",
- "percentage_requested": "25",
- "request_type": "DEPOSIT",
- "tipping_enabled": false,
- "total_completed_amount_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "uid": "66c3bdfd-5090-4ff9-a8a0-c1e1a2ffa176"
- },
- {
- "automatic_payment_source": "CARD_ON_FILE",
- "card_id": "ccof:IkWfpLj4tNHMyFii3GB",
- "computed_amount_money": {
- "amount": 3000,
- "currency": "USD"
- },
- "due_date": "2021-06-15",
- "request_type": "BALANCE",
- "tipping_enabled": false,
- "total_completed_amount_money": {
- "amount": 0,
- "currency": "USD"
- },
- "uid": "120c5e18-4f80-4f6b-b159-774cb9bf8f99"
- }
- ],
- "primary_recipient": {
- "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "email_address": "Amelia.Earhart@example.com",
- "family_name": "Earhart",
- "given_name": "Amelia",
- "phone_number": "1-212-555-4240",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- },
- "public_url": "https://squareup.com/pay-invoice/h9sfsfTGTSnYEhISUDBhEQ",
- "sale_or_service_date": "2030-01-24",
- "status": "PARTIALLY_PAID",
- "store_payment_method_enabled": false,
- "timezone": "America/Los_Angeles",
- "updated_at": "2021-01-23T15:29:56Z",
- "version": 3
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/search-loyalty-accounts-request-loyalty-account-query.md b/doc/models/search-loyalty-accounts-request-loyalty-account-query.md
deleted file mode 100644
index bd0c98c5..00000000
--- a/doc/models/search-loyalty-accounts-request-loyalty-account-query.md
+++ /dev/null
@@ -1,45 +0,0 @@
-
-# Search Loyalty Accounts Request Loyalty Account Query
-
-The search criteria for the loyalty accounts.
-
-## Structure
-
-`SearchLoyaltyAccountsRequestLoyaltyAccountQuery`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `mappings` | [`?(LoyaltyAccountMapping[])`](../../doc/models/loyalty-account-mapping.md) | Optional | The set of mappings to use in the loyalty account search.
This cannot be combined with `customer_ids`.
Max: 30 mappings | getMappings(): ?array | setMappings(?array mappings): void |
-| `customerIds` | `?(string[])` | Optional | The set of customer IDs to use in the loyalty account search.
This cannot be combined with `mappings`.
Max: 30 customer IDs | getCustomerIds(): ?array | setCustomerIds(?array customerIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "mappings": [
- {
- "id": "id8",
- "created_at": "created_at6",
- "phone_number": "phone_number4"
- },
- {
- "id": "id8",
- "created_at": "created_at6",
- "phone_number": "phone_number4"
- },
- {
- "id": "id8",
- "created_at": "created_at6",
- "phone_number": "phone_number4"
- }
- ],
- "customer_ids": [
- "customer_ids5",
- "customer_ids4",
- "customer_ids3"
- ]
-}
-```
-
diff --git a/doc/models/search-loyalty-accounts-request.md b/doc/models/search-loyalty-accounts-request.md
deleted file mode 100644
index f810e36c..00000000
--- a/doc/models/search-loyalty-accounts-request.md
+++ /dev/null
@@ -1,40 +0,0 @@
-
-# Search Loyalty Accounts Request
-
-A request to search for loyalty accounts.
-
-## Structure
-
-`SearchLoyaltyAccountsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `query` | [`?SearchLoyaltyAccountsRequestLoyaltyAccountQuery`](../../doc/models/search-loyalty-accounts-request-loyalty-account-query.md) | Optional | The search criteria for the loyalty accounts. | getQuery(): ?SearchLoyaltyAccountsRequestLoyaltyAccountQuery | setQuery(?SearchLoyaltyAccountsRequestLoyaltyAccountQuery query): void |
-| `limit` | `?int` | Optional | The maximum number of results to include in the response. The default value is 30.
**Constraints**: `>= 1`, `<= 200` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to
this endpoint. Provide this to retrieve the next set of
results for the original query.
For more information,
see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 10,
- "query": {
- "mappings": [
- {
- "phone_number": "+14155551234",
- "id": "id8",
- "created_at": "created_at6"
- }
- ],
- "customer_ids": [
- "customer_ids1",
- "customer_ids2",
- "customer_ids3"
- ]
- },
- "cursor": "cursor0"
-}
-```
-
diff --git a/doc/models/search-loyalty-accounts-response.md b/doc/models/search-loyalty-accounts-response.md
deleted file mode 100644
index 2a4534f3..00000000
--- a/doc/models/search-loyalty-accounts-response.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Search Loyalty Accounts Response
-
-A response that includes loyalty accounts that satisfy the search criteria.
-
-## Structure
-
-`SearchLoyaltyAccountsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `loyaltyAccounts` | [`?(LoyaltyAccount[])`](../../doc/models/loyalty-account.md) | Optional | The loyalty accounts that met the search criteria,
in order of creation date. | getLoyaltyAccounts(): ?array | setLoyaltyAccounts(?array loyaltyAccounts): void |
-| `cursor` | `?string` | Optional | The pagination cursor to use in a subsequent
request. If empty, this is the final response.
For more information,
see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_accounts": [
- {
- "balance": 10,
- "created_at": "2020-05-08T21:44:32Z",
- "customer_id": "Q8002FAM9V1EZ0ADB2T5609X6NET1H0",
- "id": "79b807d2-d786-46a9-933b-918028d7a8c5",
- "lifetime_points": 20,
- "mapping": {
- "created_at": "2020-05-08T21:44:32Z",
- "id": "66aaab3f-da99-49ed-8b19-b87f851c844f",
- "phone_number": "+14155551234"
- },
- "program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
- "updated_at": "2020-05-08T21:44:32Z",
- "enrolled_at": "enrolled_at4"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor8"
-}
-```
-
diff --git a/doc/models/search-loyalty-events-request.md b/doc/models/search-loyalty-events-request.md
deleted file mode 100644
index 0cc1fff5..00000000
--- a/doc/models/search-loyalty-events-request.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Search Loyalty Events Request
-
-A request to search for loyalty events.
-
-## Structure
-
-`SearchLoyaltyEventsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `query` | [`?LoyaltyEventQuery`](../../doc/models/loyalty-event-query.md) | Optional | Represents a query used to search for loyalty events. | getQuery(): ?LoyaltyEventQuery | setQuery(?LoyaltyEventQuery query): void |
-| `limit` | `?int` | Optional | The maximum number of results to include in the response.
The last page might contain fewer events.
The default is 30 events.
**Constraints**: `>= 1`, `<= 30` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this to retrieve the next set of results for your original query.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 30,
- "query": {
- "filter": {
- "order_filter": {
- "order_id": "PyATxhYLfsMqpVkcKJITPydgEYfZY"
- },
- "loyalty_account_filter": {
- "loyalty_account_id": "loyalty_account_id8"
- },
- "type_filter": {
- "types": [
- "ACCUMULATE_PROMOTION_POINTS",
- "ACCUMULATE_POINTS",
- "CREATE_REWARD"
- ]
- },
- "date_time_filter": {
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- }
- },
- "location_filter": {
- "location_ids": [
- "location_ids0",
- "location_ids1",
- "location_ids2"
- ]
- }
- }
- },
- "cursor": "cursor8"
-}
-```
-
diff --git a/doc/models/search-loyalty-events-response.md b/doc/models/search-loyalty-events-response.md
deleted file mode 100644
index 3abf9e4e..00000000
--- a/doc/models/search-loyalty-events-response.md
+++ /dev/null
@@ -1,146 +0,0 @@
-
-# Search Loyalty Events Response
-
-A response that contains loyalty events that satisfy the search
-criteria, in order by the `created_at` date.
-
-## Structure
-
-`SearchLoyaltyEventsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `events` | [`?(LoyaltyEvent[])`](../../doc/models/loyalty-event.md) | Optional | The loyalty events that satisfy the search criteria. | getEvents(): ?array | setEvents(?array events): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent
request. If empty, this is the final response.
For more information,
see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "events": [
- {
- "accumulate_points": {
- "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
- "order_id": "PyATxhYLfsMqpVkcKJITPydgEYfZY",
- "points": 5
- },
- "created_at": "2020-05-08T22:01:30Z",
- "id": "c27c8465-806e-36f2-b4b3-71f5887b5ba8",
- "location_id": "P034NEENMD09F",
- "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
- "source": "LOYALTY_API",
- "type": "ACCUMULATE_POINTS",
- "create_reward": {
- "loyalty_program_id": "loyalty_program_id2",
- "reward_id": "reward_id6",
- "points": 90
- },
- "redeem_reward": {
- "loyalty_program_id": "loyalty_program_id8",
- "reward_id": "reward_id2",
- "order_id": "order_id8"
- },
- "delete_reward": {
- "loyalty_program_id": "loyalty_program_id4",
- "reward_id": "reward_id8",
- "points": 104
- },
- "adjust_points": {
- "loyalty_program_id": "loyalty_program_id2",
- "points": 96,
- "reason": "reason2"
- }
- },
- {
- "created_at": "2020-05-08T22:01:15Z",
- "id": "e4a5cbc3-a4d0-3779-98e9-e578885d9430",
- "location_id": "P034NEENMD09F",
- "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
- "redeem_reward": {
- "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
- "order_id": "PyATxhYLfsMqpVkcKJITPydgEYfZY",
- "reward_id": "d03f79f4-815f-3500-b851-cc1e68a457f9"
- },
- "source": "LOYALTY_API",
- "type": "REDEEM_REWARD",
- "accumulate_points": {
- "loyalty_program_id": "loyalty_program_id8",
- "points": 118,
- "order_id": "order_id8"
- },
- "create_reward": {
- "loyalty_program_id": "loyalty_program_id2",
- "reward_id": "reward_id6",
- "points": 90
- },
- "delete_reward": {
- "loyalty_program_id": "loyalty_program_id4",
- "reward_id": "reward_id8",
- "points": 104
- },
- "adjust_points": {
- "loyalty_program_id": "loyalty_program_id2",
- "points": 96,
- "reason": "reason2"
- }
- },
- {
- "create_reward": {
- "loyalty_program_id": "d619f755-2d17-41f3-990d-c04ecedd64dd",
- "points": -10,
- "reward_id": "d03f79f4-815f-3500-b851-cc1e68a457f9"
- },
- "created_at": "2020-05-08T22:00:44Z",
- "id": "5e127479-0b03-3671-ab1e-15faea8b7188",
- "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
- "source": "LOYALTY_API",
- "type": "CREATE_REWARD",
- "accumulate_points": {
- "loyalty_program_id": "loyalty_program_id8",
- "points": 118,
- "order_id": "order_id8"
- },
- "redeem_reward": {
- "loyalty_program_id": "loyalty_program_id8",
- "reward_id": "reward_id2",
- "order_id": "order_id8"
- },
- "delete_reward": {
- "loyalty_program_id": "loyalty_program_id4",
- "reward_id": "reward_id8",
- "points": 104
- },
- "adjust_points": {
- "loyalty_program_id": "loyalty_program_id2",
- "points": 96,
- "reason": "reason2"
- }
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor4"
-}
-```
-
diff --git a/doc/models/search-loyalty-rewards-request-loyalty-reward-query.md b/doc/models/search-loyalty-rewards-request-loyalty-reward-query.md
deleted file mode 100644
index 8c3b5dc3..00000000
--- a/doc/models/search-loyalty-rewards-request-loyalty-reward-query.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Search Loyalty Rewards Request Loyalty Reward Query
-
-The set of search requirements.
-
-## Structure
-
-`SearchLoyaltyRewardsRequestLoyaltyRewardQuery`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `loyaltyAccountId` | `string` | Required | The ID of the [loyalty account](entity:LoyaltyAccount) to which the loyalty reward belongs.
**Constraints**: *Minimum Length*: `1` | getLoyaltyAccountId(): string | setLoyaltyAccountId(string loyaltyAccountId): void |
-| `status` | [`?string(LoyaltyRewardStatus)`](../../doc/models/loyalty-reward-status.md) | Optional | The status of the loyalty reward. | getStatus(): ?string | setStatus(?string status): void |
-
-## Example (as JSON)
-
-```json
-{
- "loyalty_account_id": "loyalty_account_id2",
- "status": "DELETED"
-}
-```
-
diff --git a/doc/models/search-loyalty-rewards-request.md b/doc/models/search-loyalty-rewards-request.md
deleted file mode 100644
index fed21e07..00000000
--- a/doc/models/search-loyalty-rewards-request.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Search Loyalty Rewards Request
-
-A request to search for loyalty rewards.
-
-## Structure
-
-`SearchLoyaltyRewardsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `query` | [`?SearchLoyaltyRewardsRequestLoyaltyRewardQuery`](../../doc/models/search-loyalty-rewards-request-loyalty-reward-query.md) | Optional | The set of search requirements. | getQuery(): ?SearchLoyaltyRewardsRequestLoyaltyRewardQuery | setQuery(?SearchLoyaltyRewardsRequestLoyaltyRewardQuery query): void |
-| `limit` | `?int` | Optional | The maximum number of results to return in the response. The default value is 30.
**Constraints**: `>= 1`, `<= 30` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to
this endpoint. Provide this to retrieve the next set of
results for the original query.
For more information,
see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 10,
- "query": {
- "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
- "status": "ISSUED"
- },
- "cursor": "cursor4"
-}
-```
-
diff --git a/doc/models/search-loyalty-rewards-response.md b/doc/models/search-loyalty-rewards-response.md
deleted file mode 100644
index bb80344b..00000000
--- a/doc/models/search-loyalty-rewards-response.md
+++ /dev/null
@@ -1,89 +0,0 @@
-
-# Search Loyalty Rewards Response
-
-A response that includes the loyalty rewards satisfying the search criteria.
-
-## Structure
-
-`SearchLoyaltyRewardsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `rewards` | [`?(LoyaltyReward[])`](../../doc/models/loyalty-reward.md) | Optional | The loyalty rewards that satisfy the search criteria.
These are returned in descending order by `updated_at`. | getRewards(): ?array | setRewards(?array rewards): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent
request. If empty, this is the final response. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "rewards": [
- {
- "created_at": "2020-05-08T22:00:44Z",
- "id": "d03f79f4-815f-3500-b851-cc1e68a457f9",
- "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
- "order_id": "PyATxhYLfsMqpVkcKJITPydgEYfZY",
- "points": 10,
- "redeemed_at": "2020-05-08T22:01:17Z",
- "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f",
- "status": "REDEEMED",
- "updated_at": "2020-05-08T22:01:17Z"
- },
- {
- "created_at": "2020-05-08T21:55:42Z",
- "id": "9f18ac21-233a-31c3-be77-b45840f5a810",
- "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
- "points": 10,
- "redeemed_at": "2020-05-08T21:56:00Z",
- "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f",
- "status": "REDEEMED",
- "updated_at": "2020-05-08T21:56:00Z",
- "order_id": "order_id4"
- },
- {
- "created_at": "2020-05-01T21:49:54Z",
- "id": "a8f43ebe-2ad6-3001-bdd5-7d7c2da08943",
- "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
- "order_id": "5NB69ZNh3FbsOs1ox43bh1xrli6YY",
- "points": 10,
- "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f",
- "status": "DELETED",
- "updated_at": "2020-05-08T21:55:10Z"
- },
- {
- "created_at": "2020-05-01T20:20:37Z",
- "id": "a051254c-f840-3b45-8cf1-50bcd38ff92a",
- "loyalty_account_id": "5adcb100-07f1-4ee7-b8c6-6bb9ebc474bd",
- "order_id": "LQQ16znvi2VIUKPVhUfJefzr1eEZY",
- "points": 10,
- "reward_tier_id": "e1b39225-9da5-43d1-a5db-782cdd8ad94f",
- "status": "ISSUED",
- "updated_at": "2020-05-01T20:20:40Z"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor4"
-}
-```
-
diff --git a/doc/models/search-orders-customer-filter.md b/doc/models/search-orders-customer-filter.md
deleted file mode 100644
index 19197c26..00000000
--- a/doc/models/search-orders-customer-filter.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Search Orders Customer Filter
-
-A filter based on the order `customer_id` and any tender `customer_id`
-associated with the order. It does not filter based on the
-[FulfillmentRecipient](../../doc/models/fulfillment-recipient.md) `customer_id`.
-
-## Structure
-
-`SearchOrdersCustomerFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customerIds` | `?(string[])` | Optional | A list of customer IDs to filter by.
Max: 10 customer ids. | getCustomerIds(): ?array | setCustomerIds(?array customerIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "customer_ids": [
- "customer_ids9",
- "customer_ids0",
- "customer_ids1"
- ]
-}
-```
-
diff --git a/doc/models/search-orders-date-time-filter.md b/doc/models/search-orders-date-time-filter.md
deleted file mode 100644
index 23ab921a..00000000
--- a/doc/models/search-orders-date-time-filter.md
+++ /dev/null
@@ -1,49 +0,0 @@
-
-# Search Orders Date Time Filter
-
-Filter for `Order` objects based on whether their `CREATED_AT`,
-`CLOSED_AT`, or `UPDATED_AT` timestamps fall within a specified time range.
-You can specify the time range and which timestamp to filter for. You can filter
-for only one time range at a time.
-
-For each time range, the start time and end time are inclusive. If the end time
-is absent, it defaults to the time of the first request for the cursor.
-
-__Important:__ If you use the `DateTimeFilter` in a `SearchOrders` query,
-you must set the `sort_field` in [OrdersSort](../../doc/models/search-orders-sort.md)
-to the same field you filter for. For example, if you set the `CLOSED_AT` field
-in `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` to
-`CLOSED_AT`. Otherwise, `SearchOrders` throws an error.
-[Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range)
-
-## Structure
-
-`SearchOrdersDateTimeFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `createdAt` | [`?TimeRange`](../../doc/models/time-range.md) | Optional | Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled. | getCreatedAt(): ?TimeRange | setCreatedAt(?TimeRange createdAt): void |
-| `updatedAt` | [`?TimeRange`](../../doc/models/time-range.md) | Optional | Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled. | getUpdatedAt(): ?TimeRange | setUpdatedAt(?TimeRange updatedAt): void |
-| `closedAt` | [`?TimeRange`](../../doc/models/time-range.md) | Optional | Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled. | getClosedAt(): ?TimeRange | setClosedAt(?TimeRange closedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- },
- "updated_at": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- },
- "closed_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- }
-}
-```
-
diff --git a/doc/models/search-orders-filter.md b/doc/models/search-orders-filter.md
deleted file mode 100644
index 3ba48a89..00000000
--- a/doc/models/search-orders-filter.md
+++ /dev/null
@@ -1,67 +0,0 @@
-
-# Search Orders Filter
-
-Filtering criteria to use for a `SearchOrders` request. Multiple filters
-are ANDed together.
-
-## Structure
-
-`SearchOrdersFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `stateFilter` | [`?SearchOrdersStateFilter`](../../doc/models/search-orders-state-filter.md) | Optional | Filter by the current order `state`. | getStateFilter(): ?SearchOrdersStateFilter | setStateFilter(?SearchOrdersStateFilter stateFilter): void |
-| `dateTimeFilter` | [`?SearchOrdersDateTimeFilter`](../../doc/models/search-orders-date-time-filter.md) | Optional | Filter for `Order` objects based on whether their `CREATED_AT`,
`CLOSED_AT`, or `UPDATED_AT` timestamps fall within a specified time range.
You can specify the time range and which timestamp to filter for. You can filter
for only one time range at a time.
For each time range, the start time and end time are inclusive. If the end time
is absent, it defaults to the time of the first request for the cursor.
__Important:__ If you use the `DateTimeFilter` in a `SearchOrders` query,
you must set the `sort_field` in [OrdersSort](../../doc/models/search-orders-sort.md)
to the same field you filter for. For example, if you set the `CLOSED_AT` field
in `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` to
`CLOSED_AT`. Otherwise, `SearchOrders` throws an error.
[Learn more about filtering orders by time range.](https://developer.squareup.com/docs/orders-api/manage-orders/search-orders#important-note-about-filtering-orders-by-time-range) | getDateTimeFilter(): ?SearchOrdersDateTimeFilter | setDateTimeFilter(?SearchOrdersDateTimeFilter dateTimeFilter): void |
-| `fulfillmentFilter` | [`?SearchOrdersFulfillmentFilter`](../../doc/models/search-orders-fulfillment-filter.md) | Optional | Filter based on [order fulfillment](../../doc/models/fulfillment.md) information. | getFulfillmentFilter(): ?SearchOrdersFulfillmentFilter | setFulfillmentFilter(?SearchOrdersFulfillmentFilter fulfillmentFilter): void |
-| `sourceFilter` | [`?SearchOrdersSourceFilter`](../../doc/models/search-orders-source-filter.md) | Optional | A filter based on order `source` information. | getSourceFilter(): ?SearchOrdersSourceFilter | setSourceFilter(?SearchOrdersSourceFilter sourceFilter): void |
-| `customerFilter` | [`?SearchOrdersCustomerFilter`](../../doc/models/search-orders-customer-filter.md) | Optional | A filter based on the order `customer_id` and any tender `customer_id`
associated with the order. It does not filter based on the
[FulfillmentRecipient](../../doc/models/fulfillment-recipient.md) `customer_id`. | getCustomerFilter(): ?SearchOrdersCustomerFilter | setCustomerFilter(?SearchOrdersCustomerFilter customerFilter): void |
-
-## Example (as JSON)
-
-```json
-{
- "state_filter": {
- "states": [
- "CANCELED",
- "DRAFT"
- ]
- },
- "date_time_filter": {
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- },
- "updated_at": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- },
- "closed_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- }
- },
- "fulfillment_filter": {
- "fulfillment_types": [
- "DELIVERY"
- ],
- "fulfillment_states": [
- "CANCELED",
- "FAILED"
- ]
- },
- "source_filter": {
- "source_names": [
- "source_names6"
- ]
- },
- "customer_filter": {
- "customer_ids": [
- "customer_ids3",
- "customer_ids4"
- ]
- }
-}
-```
-
diff --git a/doc/models/search-orders-fulfillment-filter.md b/doc/models/search-orders-fulfillment-filter.md
deleted file mode 100644
index f9a078b2..00000000
--- a/doc/models/search-orders-fulfillment-filter.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Search Orders Fulfillment Filter
-
-Filter based on [order fulfillment](../../doc/models/fulfillment.md) information.
-
-## Structure
-
-`SearchOrdersFulfillmentFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `fulfillmentTypes` | [`?(string(FulfillmentType)[])`](../../doc/models/fulfillment-type.md) | Optional | A list of [fulfillment types](entity:FulfillmentType) to filter
for. The list returns orders if any of its fulfillments match any of the fulfillment types
listed in this field.
See [FulfillmentType](#type-fulfillmenttype) for possible values | getFulfillmentTypes(): ?array | setFulfillmentTypes(?array fulfillmentTypes): void |
-| `fulfillmentStates` | [`?(string(FulfillmentState)[])`](../../doc/models/fulfillment-state.md) | Optional | A list of [fulfillment states](entity:FulfillmentState) to filter
for. The list returns orders if any of its fulfillments match any of the
fulfillment states listed in this field.
See [FulfillmentState](#type-fulfillmentstate) for possible values | getFulfillmentStates(): ?array | setFulfillmentStates(?array fulfillmentStates): void |
-
-## Example (as JSON)
-
-```json
-{
- "fulfillment_types": [
- "PICKUP",
- "SHIPMENT"
- ],
- "fulfillment_states": [
- "PROPOSED"
- ]
-}
-```
-
diff --git a/doc/models/search-orders-query.md b/doc/models/search-orders-query.md
deleted file mode 100644
index 84437f24..00000000
--- a/doc/models/search-orders-query.md
+++ /dev/null
@@ -1,69 +0,0 @@
-
-# Search Orders Query
-
-Contains query criteria for the search.
-
-## Structure
-
-`SearchOrdersQuery`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `filter` | [`?SearchOrdersFilter`](../../doc/models/search-orders-filter.md) | Optional | Filtering criteria to use for a `SearchOrders` request. Multiple filters
are ANDed together. | getFilter(): ?SearchOrdersFilter | setFilter(?SearchOrdersFilter filter): void |
-| `sort` | [`?SearchOrdersSort`](../../doc/models/search-orders-sort.md) | Optional | Sorting criteria for a `SearchOrders` request. Results can only be sorted
by a timestamp field. | getSort(): ?SearchOrdersSort | setSort(?SearchOrdersSort sort): void |
-
-## Example (as JSON)
-
-```json
-{
- "filter": {
- "state_filter": {
- "states": [
- "CANCELED",
- "DRAFT"
- ]
- },
- "date_time_filter": {
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- },
- "updated_at": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- },
- "closed_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- }
- },
- "fulfillment_filter": {
- "fulfillment_types": [
- "DELIVERY"
- ],
- "fulfillment_states": [
- "CANCELED",
- "FAILED"
- ]
- },
- "source_filter": {
- "source_names": [
- "source_names6"
- ]
- },
- "customer_filter": {
- "customer_ids": [
- "customer_ids3",
- "customer_ids4"
- ]
- }
- },
- "sort": {
- "sort_field": "UPDATED_AT",
- "sort_order": "DESC"
- }
-}
-```
-
diff --git a/doc/models/search-orders-request.md b/doc/models/search-orders-request.md
deleted file mode 100644
index dca014f7..00000000
--- a/doc/models/search-orders-request.md
+++ /dev/null
@@ -1,78 +0,0 @@
-
-# Search Orders Request
-
-## Structure
-
-`SearchOrdersRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationIds` | `?(string[])` | Optional | The location IDs for the orders to query. All locations must belong to
the same merchant.
Max: 10 location IDs. | getLocationIds(): ?array | setLocationIds(?array locationIds): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for your original query.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `query` | [`?SearchOrdersQuery`](../../doc/models/search-orders-query.md) | Optional | Contains query criteria for the search. | getQuery(): ?SearchOrdersQuery | setQuery(?SearchOrdersQuery query): void |
-| `limit` | `?int` | Optional | The maximum number of results to be returned in a single page.
Default: `500`
Max: `1000` | getLimit(): ?int | setLimit(?int limit): void |
-| `returnEntries` | `?bool` | Optional | A Boolean that controls the format of the search results. If `true`,
`SearchOrders` returns [OrderEntry](entity:OrderEntry) objects. If `false`, `SearchOrders`
returns complete order objects.
Default: `false`. | getReturnEntries(): ?bool | setReturnEntries(?bool returnEntries): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 3,
- "location_ids": [
- "057P5VYJ4A5X1",
- "18YC4JDH91E1H"
- ],
- "query": {
- "filter": {
- "date_time_filter": {
- "closed_at": {
- "end_at": "2019-03-04T21:54:45+00:00",
- "start_at": "2018-03-03T20:00:00+00:00"
- },
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- },
- "updated_at": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- }
- },
- "state_filter": {
- "states": [
- "COMPLETED"
- ]
- },
- "fulfillment_filter": {
- "fulfillment_types": [
- "DELIVERY"
- ],
- "fulfillment_states": [
- "CANCELED",
- "FAILED"
- ]
- },
- "source_filter": {
- "source_names": [
- "source_names6"
- ]
- },
- "customer_filter": {
- "customer_ids": [
- "customer_ids3",
- "customer_ids4"
- ]
- }
- },
- "sort": {
- "sort_field": "CLOSED_AT",
- "sort_order": "DESC"
- }
- },
- "return_entries": true,
- "cursor": "cursor4"
-}
-```
-
diff --git a/doc/models/search-orders-response.md b/doc/models/search-orders-response.md
deleted file mode 100644
index 544af0bc..00000000
--- a/doc/models/search-orders-response.md
+++ /dev/null
@@ -1,225 +0,0 @@
-
-# Search Orders Response
-
-Either the `order_entries` or `orders` field is set, depending on whether
-`return_entries` is set on the [SearchOrdersRequest](../../doc/apis/orders.md#search-orders).
-
-## Structure
-
-`SearchOrdersResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `orderEntries` | [`?(OrderEntry[])`](../../doc/models/order-entry.md) | Optional | A list of [OrderEntries](entity:OrderEntry) that fit the query
conditions. The list is populated only if `return_entries` is set to `true` in the request. | getOrderEntries(): ?array | setOrderEntries(?array orderEntries): void |
-| `orders` | [`?(Order[])`](../../doc/models/order.md) | Optional | A list of
[Order](entity:Order) objects that match the query conditions. The list is populated only if
`return_entries` is set to `false` in the request. | getOrders(): ?array | setOrders(?array orders): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request. If unset,
this is the final response.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | [Errors](entity:Error) encountered during the search. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "123",
- "order_entries": [
- {
- "location_id": "057P5VYJ4A5X1",
- "order_id": "CAISEM82RcpmcFBM0TfOyiHV3es",
- "version": 1
- },
- {
- "location_id": "18YC4JDH91E1H",
- "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY",
- "version": 182
- },
- {
- "location_id": "057P5VYJ4A5X1",
- "order_id": "CAISEM52YcpmcWAzERDOyiWS3ty",
- "version": 182
- }
- ],
- "orders": [
- {
- "id": "id2",
- "location_id": "location_id6",
- "reference_id": "reference_id0",
- "source": {
- "name": "name4"
- },
- "customer_id": "customer_id0",
- "line_items": [
- {
- "uid": "uid8",
- "name": "name8",
- "quantity": "quantity4",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- },
- {
- "uid": "uid8",
- "name": "name8",
- "quantity": "quantity4",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- }
- ]
- },
- {
- "id": "id2",
- "location_id": "location_id6",
- "reference_id": "reference_id0",
- "source": {
- "name": "name4"
- },
- "customer_id": "customer_id0",
- "line_items": [
- {
- "uid": "uid8",
- "name": "name8",
- "quantity": "quantity4",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- },
- {
- "uid": "uid8",
- "name": "name8",
- "quantity": "quantity4",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- }
- ]
- },
- {
- "id": "id2",
- "location_id": "location_id6",
- "reference_id": "reference_id0",
- "source": {
- "name": "name4"
- },
- "customer_id": "customer_id0",
- "line_items": [
- {
- "uid": "uid8",
- "name": "name8",
- "quantity": "quantity4",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- },
- {
- "uid": "uid8",
- "name": "name8",
- "quantity": "quantity4",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- }
- ]
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/search-orders-sort-field.md b/doc/models/search-orders-sort-field.md
deleted file mode 100644
index 6c556a9d..00000000
--- a/doc/models/search-orders-sort-field.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Search Orders Sort Field
-
-Specifies which timestamp to use to sort `SearchOrder` results.
-
-## Enumeration
-
-`SearchOrdersSortField`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `CREATED_AT` | The time when the order was created, in RFC-3339 format. If you are also
filtering for a time range in this query, you must set the `CREATED_AT`
field in your `DateTimeFilter`. |
-| `UPDATED_AT` | The time when the order last updated, in RFC-3339 format. If you are also
filtering for a time range in this query, you must set the `UPDATED_AT`
field in your `DateTimeFilter`. |
-| `CLOSED_AT` | The time when the order was closed, in RFC-3339 format. If you use this
value, you must also set a `StateFilter` with closed states. If you are also
filtering for a time range in this query, you must set the `CLOSED_AT`
field in your `DateTimeFilter`. |
-
diff --git a/doc/models/search-orders-sort.md b/doc/models/search-orders-sort.md
deleted file mode 100644
index 032ae776..00000000
--- a/doc/models/search-orders-sort.md
+++ /dev/null
@@ -1,26 +0,0 @@
-
-# Search Orders Sort
-
-Sorting criteria for a `SearchOrders` request. Results can only be sorted
-by a timestamp field.
-
-## Structure
-
-`SearchOrdersSort`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `sortField` | [`string(SearchOrdersSortField)`](../../doc/models/search-orders-sort-field.md) | Required | Specifies which timestamp to use to sort `SearchOrder` results. | getSortField(): string | setSortField(string sortField): void |
-| `sortOrder` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-
-## Example (as JSON)
-
-```json
-{
- "sort_field": "CREATED_AT",
- "sort_order": "DESC"
-}
-```
-
diff --git a/doc/models/search-orders-source-filter.md b/doc/models/search-orders-source-filter.md
deleted file mode 100644
index d8717d2f..00000000
--- a/doc/models/search-orders-source-filter.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Search Orders Source Filter
-
-A filter based on order `source` information.
-
-## Structure
-
-`SearchOrdersSourceFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `sourceNames` | `?(string[])` | Optional | Filters by the [Source](entity:OrderSource) `name`. The filter returns any orders
with a `source.name` that matches any of the listed source names.
Max: 10 source names. | getSourceNames(): ?array | setSourceNames(?array sourceNames): void |
-
-## Example (as JSON)
-
-```json
-{
- "source_names": [
- "source_names4",
- "source_names5",
- "source_names6"
- ]
-}
-```
-
diff --git a/doc/models/search-orders-state-filter.md b/doc/models/search-orders-state-filter.md
deleted file mode 100644
index a3c3be67..00000000
--- a/doc/models/search-orders-state-filter.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Search Orders State Filter
-
-Filter by the current order `state`.
-
-## Structure
-
-`SearchOrdersStateFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `states` | [`string(OrderState)[]`](../../doc/models/order-state.md) | Required | States to filter for.
See [OrderState](#type-orderstate) for possible values | getStates(): array | setStates(array states): void |
-
-## Example (as JSON)
-
-```json
-{
- "states": [
- "CANCELED",
- "DRAFT",
- "OPEN"
- ]
-}
-```
-
diff --git a/doc/models/search-shifts-request.md b/doc/models/search-shifts-request.md
deleted file mode 100644
index 459e6318..00000000
--- a/doc/models/search-shifts-request.md
+++ /dev/null
@@ -1,57 +0,0 @@
-
-# Search Shifts Request
-
-A request for a filtered and sorted set of `Shift` objects.
-
-## Structure
-
-`SearchShiftsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `query` | [`?ShiftQuery`](../../doc/models/shift-query.md) | Optional | The parameters of a `Shift` search query, which includes filter and sort options. | getQuery(): ?ShiftQuery | setQuery(?ShiftQuery query): void |
-| `limit` | `?int` | Optional | The number of resources in a page (200 by default).
**Constraints**: `>= 1`, `<= 200` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | An opaque cursor for fetching the next page. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 100,
- "query": {
- "filter": {
- "workday": {
- "date_range": {
- "end_date": "2019-02-03",
- "start_date": "2019-01-20"
- },
- "default_timezone": "America/Los_Angeles",
- "match_shifts_by": "START_AT"
- },
- "location_ids": [
- "location_ids4"
- ],
- "employee_ids": [
- "employee_ids9"
- ],
- "status": "OPEN",
- "start": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- },
- "end": {
- "start_at": "start_at0",
- "end_at": "end_at2"
- }
- },
- "sort": {
- "field": "START_AT",
- "order": "DESC"
- }
- },
- "cursor": "cursor2"
-}
-```
-
diff --git a/doc/models/search-shifts-response.md b/doc/models/search-shifts-response.md
deleted file mode 100644
index 83fe72ac..00000000
--- a/doc/models/search-shifts-response.md
+++ /dev/null
@@ -1,120 +0,0 @@
-
-# Search Shifts Response
-
-The response to a request for `Shift` objects. The response contains
-the requested `Shift` objects and might contain a set of `Error` objects if
-the request resulted in errors.
-
-## Structure
-
-`SearchShiftsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `shifts` | [`?(Shift[])`](../../doc/models/shift.md) | Optional | Shifts. | getShifts(): ?array | setShifts(?array shifts): void |
-| `cursor` | `?string` | Optional | An opaque cursor for fetching the next page. | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "shifts": [
- {
- "breaks": [
- {
- "break_type_id": "REGS1EQR1TPZ5",
- "end_at": "2019-01-21T06:11:00-05:00",
- "expected_duration": "PT10M",
- "id": "SJW7X6AKEJQ65",
- "is_paid": true,
- "name": "Tea Break",
- "start_at": "2019-01-21T06:11:00-05:00"
- }
- ],
- "created_at": "2019-01-24T01:12:03Z",
- "declared_cash_tip_money": {
- "amount": 500,
- "currency": "USD"
- },
- "employee_id": "ormj0jJJZ5OZIzxrZYJI",
- "end_at": "2019-01-21T13:11:00-05:00",
- "id": "X714F3HA6D1PT",
- "location_id": "PAA1RJZZKXBFG",
- "start_at": "2019-01-21T03:11:00-05:00",
- "status": "CLOSED",
- "team_member_id": "ormj0jJJZ5OZIzxrZYJI",
- "timezone": "America/New_York",
- "updated_at": "2019-02-07T22:21:08Z",
- "version": 6,
- "wage": {
- "hourly_rate": {
- "amount": 1100,
- "currency": "USD"
- },
- "job_id": "FzbJAtt9qEWncK1BWgVCxQ6M",
- "tip_eligible": true,
- "title": "Barista"
- }
- },
- {
- "breaks": [
- {
- "break_type_id": "WQX00VR99F53J",
- "end_at": "2019-01-23T14:40:00-05:00",
- "expected_duration": "PT10M",
- "id": "BKS6VR7WR748A",
- "is_paid": true,
- "name": "Tea Break",
- "start_at": "2019-01-23T14:30:00-05:00"
- },
- {
- "break_type_id": "P6Q468ZFRN1AC",
- "end_at": "2019-01-22T12:44:00-05:00",
- "expected_duration": "PT15M",
- "id": "BQFEZSHFZSC51",
- "is_paid": false,
- "name": "Coffee Break",
- "start_at": "2019-01-22T12:30:00-05:00"
- }
- ],
- "created_at": "2019-01-23T23:32:45Z",
- "declared_cash_tip_money": {
- "amount": 0,
- "currency": "USD"
- },
- "employee_id": "33fJchumvVdJwxV0H6L9",
- "end_at": "2019-01-22T13:02:00-05:00",
- "id": "GDHYBZYWK0P2V",
- "location_id": "PAA1RJZZKXBFG",
- "start_at": "2019-01-22T12:02:00-05:00",
- "status": "CLOSED",
- "team_member_id": "33fJchumvVdJwxV0H6L9",
- "timezone": "America/New_York",
- "updated_at": "2019-01-24T00:56:25Z",
- "version": 16,
- "wage": {
- "hourly_rate": {
- "amount": 1600,
- "currency": "USD"
- },
- "job_id": "gcbz15vKGnMKmaWJJ152kjim",
- "tip_eligible": true,
- "title": "Cook"
- }
- }
- ],
- "cursor": "cursor8",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/search-subscriptions-filter.md b/doc/models/search-subscriptions-filter.md
deleted file mode 100644
index da2450c3..00000000
--- a/doc/models/search-subscriptions-filter.md
+++ /dev/null
@@ -1,39 +0,0 @@
-
-# Search Subscriptions Filter
-
-Represents a set of query expressions (filters) to narrow the scope of targeted subscriptions returned by
-the [SearchSubscriptions](../../doc/apis/subscriptions.md#search-subscriptions) endpoint.
-
-## Structure
-
-`SearchSubscriptionsFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customerIds` | `?(string[])` | Optional | A filter to select subscriptions based on the subscribing customer IDs. | getCustomerIds(): ?array | setCustomerIds(?array customerIds): void |
-| `locationIds` | `?(string[])` | Optional | A filter to select subscriptions based on the location. | getLocationIds(): ?array | setLocationIds(?array locationIds): void |
-| `sourceNames` | `?(string[])` | Optional | A filter to select subscriptions based on the source application. | getSourceNames(): ?array | setSourceNames(?array sourceNames): void |
-
-## Example (as JSON)
-
-```json
-{
- "customer_ids": [
- "customer_ids1",
- "customer_ids2"
- ],
- "location_ids": [
- "location_ids4",
- "location_ids5",
- "location_ids6"
- ],
- "source_names": [
- "source_names2",
- "source_names3",
- "source_names4"
- ]
-}
-```
-
diff --git a/doc/models/search-subscriptions-query.md b/doc/models/search-subscriptions-query.md
deleted file mode 100644
index 1c636d5a..00000000
--- a/doc/models/search-subscriptions-query.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Search Subscriptions Query
-
-Represents a query, consisting of specified query expressions, used to search for subscriptions.
-
-## Structure
-
-`SearchSubscriptionsQuery`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `filter` | [`?SearchSubscriptionsFilter`](../../doc/models/search-subscriptions-filter.md) | Optional | Represents a set of query expressions (filters) to narrow the scope of targeted subscriptions returned by
the [SearchSubscriptions](../../doc/apis/subscriptions.md#search-subscriptions) endpoint. | getFilter(): ?SearchSubscriptionsFilter | setFilter(?SearchSubscriptionsFilter filter): void |
-
-## Example (as JSON)
-
-```json
-{
- "filter": {
- "customer_ids": [
- "customer_ids3",
- "customer_ids2"
- ],
- "location_ids": [
- "location_ids4"
- ],
- "source_names": [
- "source_names2"
- ]
- }
-}
-```
-
diff --git a/doc/models/search-subscriptions-request.md b/doc/models/search-subscriptions-request.md
deleted file mode 100644
index c593cdcd..00000000
--- a/doc/models/search-subscriptions-request.md
+++ /dev/null
@@ -1,44 +0,0 @@
-
-# Search Subscriptions Request
-
-Defines input parameters in a request to the
-[SearchSubscriptions](../../doc/apis/subscriptions.md#search-subscriptions) endpoint.
-
-## Structure
-
-`SearchSubscriptionsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `cursor` | `?string` | Optional | When the total number of resulting subscriptions exceeds the limit of a paged response,
specify the cursor returned from a preceding response here to fetch the next set of results.
If the cursor is unset, the response contains the last page of the results.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | The upper limit on the number of subscriptions to return
in a paged response.
**Constraints**: `>= 1` | getLimit(): ?int | setLimit(?int limit): void |
-| `query` | [`?SearchSubscriptionsQuery`](../../doc/models/search-subscriptions-query.md) | Optional | Represents a query, consisting of specified query expressions, used to search for subscriptions. | getQuery(): ?SearchSubscriptionsQuery | setQuery(?SearchSubscriptionsQuery query): void |
-| `include` | `?(string[])` | Optional | An option to include related information in the response.
The supported values are:
- `actions`: to include scheduled actions on the targeted subscriptions. | getInclude(): ?array | setInclude(?array include): void |
-
-## Example (as JSON)
-
-```json
-{
- "query": {
- "filter": {
- "customer_ids": [
- "CHFGVKYY8RSV93M5KCYTG4PN0G"
- ],
- "location_ids": [
- "S8GWD5R9QB376"
- ],
- "source_names": [
- "My App"
- ]
- }
- },
- "cursor": "cursor6",
- "limit": 230,
- "include": [
- "include8"
- ]
-}
-```
-
diff --git a/doc/models/search-subscriptions-response.md b/doc/models/search-subscriptions-response.md
deleted file mode 100644
index 0633c734..00000000
--- a/doc/models/search-subscriptions-response.md
+++ /dev/null
@@ -1,100 +0,0 @@
-
-# Search Subscriptions Response
-
-Defines output parameters in a response from the
-[SearchSubscriptions](../../doc/apis/subscriptions.md#search-subscriptions) endpoint.
-
-## Structure
-
-`SearchSubscriptionsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `subscriptions` | [`?(Subscription[])`](../../doc/models/subscription.md) | Optional | The subscriptions matching the specified query expressions. | getSubscriptions(): ?array | setSubscriptions(?array subscriptions): void |
-| `cursor` | `?string` | Optional | When the total number of resulting subscription exceeds the limit of a paged response,
the response includes a cursor for you to use in a subsequent request to fetch the next set of results.
If the cursor is unset, the response contains the last page of the results.
For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "subscriptions": [
- {
- "canceled_date": "2021-10-30",
- "card_id": "ccof:mueUsvgajChmjEbp4GB",
- "charged_through_date": "2021-11-20",
- "created_at": "2021-10-20T21:53:10Z",
- "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
- "id": "de86fc96-8664-474b-af1a-abbe59cacf0e",
- "location_id": "S8GWD5R9QB376",
- "paid_until_date": "2021-11-20",
- "plan_variation_id": "L3TJVDHVBEQEGQDEZL2JJM7R",
- "source": {
- "name": "My Application"
- },
- "start_date": "2021-10-20",
- "status": "CANCELED",
- "timezone": "UTC"
- },
- {
- "charged_through_date": "2022-08-19",
- "created_at": "2022-01-19T21:53:10Z",
- "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
- "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f",
- "invoice_ids": [
- "grebK0Q_l8H4fqoMMVvt-Q",
- "rcX_i3sNmHTGKhI4W2mceA"
- ],
- "location_id": "S8GWD5R9QB376",
- "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
- "price_override_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "source": {
- "name": "My Application"
- },
- "start_date": "2022-01-19",
- "status": "PAUSED",
- "tax_percentage": "5",
- "timezone": "America/Los_Angeles",
- "version": 2
- },
- {
- "card_id": "ccof:qy5x8hHGYsgLrp4Q4GB",
- "created_at": "2023-06-20T21:53:10Z",
- "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
- "id": "56214fb2-cc85-47a1-93bc-44f3766bb56f",
- "location_id": "S8GWD5R9QB376",
- "phases": [
- {
- "order_template_id": "U2NaowWxzXwpsZU697x7ZHOAnCNZY",
- "ordinal": 0,
- "plan_phase_uid": "X2Q2AONPB3RB64Y27S25QCZP",
- "uid": "873451e0-745b-4e87-ab0b-c574933fe616"
- }
- ],
- "plan_variation_id": "6JHXF3B2CW3YKHDV4XEM674H",
- "source": {
- "name": "My Application"
- },
- "start_date": "2023-06-20",
- "status": "ACTIVE",
- "timezone": "America/Los_Angeles",
- "version": 1
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor2"
-}
-```
-
diff --git a/doc/models/search-team-members-filter.md b/doc/models/search-team-members-filter.md
deleted file mode 100644
index 5b193914..00000000
--- a/doc/models/search-team-members-filter.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-# Search Team Members Filter
-
-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".
-
-## Structure
-
-`SearchTeamMembersFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationIds` | `?(string[])` | Optional | When present, filters by team members assigned to the specified locations.
When empty, includes team members assigned to any location. | getLocationIds(): ?array | setLocationIds(?array locationIds): void |
-| `status` | [`?string(TeamMemberStatus)`](../../doc/models/team-member-status.md) | Optional | Enumerates the possible statuses the team member can have within a business. | getStatus(): ?string | setStatus(?string status): void |
-| `isOwner` | `?bool` | Optional | When present and set to true, returns the team member who is the owner of the Square account. | getIsOwner(): ?bool | setIsOwner(?bool isOwner): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_ids": [
- "location_ids6"
- ],
- "status": "ACTIVE",
- "is_owner": false
-}
-```
-
diff --git a/doc/models/search-team-members-query.md b/doc/models/search-team-members-query.md
deleted file mode 100644
index 3ab75157..00000000
--- a/doc/models/search-team-members-query.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Search Team Members Query
-
-Represents the parameters in a search for `TeamMember` objects.
-
-## Structure
-
-`SearchTeamMembersQuery`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `filter` | [`?SearchTeamMembersFilter`](../../doc/models/search-team-members-filter.md) | Optional | 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". | getFilter(): ?SearchTeamMembersFilter | setFilter(?SearchTeamMembersFilter filter): void |
-
-## Example (as JSON)
-
-```json
-{
- "filter": {
- "location_ids": [
- "location_ids4"
- ],
- "status": "ACTIVE",
- "is_owner": false
- }
-}
-```
-
diff --git a/doc/models/search-team-members-request.md b/doc/models/search-team-members-request.md
deleted file mode 100644
index c0f0ca65..00000000
--- a/doc/models/search-team-members-request.md
+++ /dev/null
@@ -1,35 +0,0 @@
-
-# Search Team Members Request
-
-Represents a search request for a filtered list of `TeamMember` objects.
-
-## Structure
-
-`SearchTeamMembersRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `query` | [`?SearchTeamMembersQuery`](../../doc/models/search-team-members-query.md) | Optional | Represents the parameters in a search for `TeamMember` objects. | getQuery(): ?SearchTeamMembersQuery | setQuery(?SearchTeamMembersQuery query): void |
-| `limit` | `?int` | Optional | The maximum number of `TeamMember` objects in a page (100 by default).
**Constraints**: `>= 1`, `<= 200` | getLimit(): ?int | setLimit(?int limit): void |
-| `cursor` | `?string` | Optional | The opaque cursor for fetching the next page. For more information, see
[pagination](https://developer.squareup.com/docs/working-with-apis/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 10,
- "query": {
- "filter": {
- "location_ids": [
- "0G5P3VGACMMQZ"
- ],
- "status": "ACTIVE",
- "is_owner": false
- }
- },
- "cursor": "cursor8"
-}
-```
-
diff --git a/doc/models/search-team-members-response.md b/doc/models/search-team-members-response.md
deleted file mode 100644
index 8c5fa8be..00000000
--- a/doc/models/search-team-members-response.md
+++ /dev/null
@@ -1,284 +0,0 @@
-
-# Search Team Members Response
-
-Represents a response from a search request containing a filtered list of `TeamMember` objects.
-
-## Structure
-
-`SearchTeamMembersResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `teamMembers` | [`?(TeamMember[])`](../../doc/models/team-member.md) | Optional | The filtered list of `TeamMember` objects. | getTeamMembers(): ?array | setTeamMembers(?array teamMembers): void |
-| `cursor` | `?string` | Optional | The opaque cursor for fetching the next page. For more information, see
[pagination](https://developer.squareup.com/docs/working-with-apis/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | The errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "cursor": "N:9UglUjOXQ13-hMFypCft",
- "team_members": [
- {
- "assigned_locations": {
- "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
- },
- "created_at": "2019-07-10T17:26:48Z",
- "email_address": "johnny_cash@squareup.com",
- "family_name": "Cash",
- "given_name": "Johnny",
- "id": "-3oZQKPKVk6gUXU_V5Qa",
- "is_owner": false,
- "reference_id": "12345678",
- "status": "ACTIVE",
- "updated_at": "2020-04-28T21:49:28Z",
- "wage_setting": {
- "created_at": "2021-06-11T22:55:45Z",
- "is_overtime_exempt": true,
- "job_assignments": [
- {
- "annual_rate": {
- "amount": 3000000,
- "currency": "USD"
- },
- "hourly_rate": {
- "amount": 1443,
- "currency": "USD"
- },
- "job_id": "FjS8x95cqHiMenw4f1NAUH4P",
- "job_title": "Manager",
- "pay_type": "SALARY",
- "weekly_hours": 40
- },
- {
- "hourly_rate": {
- "amount": 2000,
- "currency": "USD"
- },
- "job_id": "VDNpRv8da51NU8qZFC5zDWpF",
- "job_title": "Cashier",
- "pay_type": "HOURLY"
- }
- ],
- "team_member_id": "-3oZQKPKVk6gUXU_V5Qa",
- "updated_at": "2021-06-11T22:55:45Z",
- "version": 1
- }
- },
- {
- "assigned_locations": {
- "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
- },
- "created_at": "2020-03-24T18:14:01Z",
- "family_name": "Smith",
- "given_name": "Lombard",
- "id": "1AVJj0DjkzbmbJw5r4KK",
- "is_owner": false,
- "phone_number": "+14155552671",
- "reference_id": "abcded",
- "status": "ACTIVE",
- "updated_at": "2020-06-09T17:38:05Z",
- "wage_setting": {
- "created_at": "2020-03-24T18:14:01Z",
- "is_overtime_exempt": true,
- "job_assignments": [
- {
- "hourly_rate": {
- "amount": 2400,
- "currency": "USD"
- },
- "job_id": "VDNpRv8da51NU8qZFC5zDWpF",
- "job_title": "Cashier",
- "pay_type": "HOURLY"
- }
- ],
- "team_member_id": "1AVJj0DjkzbmbJw5r4KK",
- "updated_at": "2020-06-09T17:38:05Z",
- "version": 2
- }
- },
- {
- "assigned_locations": {
- "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
- },
- "created_at": "2020-03-24T01:09:25Z",
- "family_name": "Sway",
- "given_name": "Monica",
- "id": "2JCmiJol_KKFs9z2Evim",
- "is_owner": false,
- "status": "ACTIVE",
- "updated_at": "2020-03-24T01:11:25Z",
- "wage_setting": {
- "created_at": "2020-03-24T01:09:25Z",
- "is_overtime_exempt": true,
- "job_assignments": [
- {
- "hourly_rate": {
- "amount": 2400,
- "currency": "USD"
- },
- "job_id": "VDNpRv8da51NU8qZFC5zDWpF",
- "job_title": "Cashier",
- "pay_type": "HOURLY"
- }
- ],
- "team_member_id": "2JCmiJol_KKFs9z2Evim",
- "updated_at": "2020-03-24T01:09:25Z",
- "version": 1
- },
- "reference_id": "reference_id4"
- },
- {
- "assigned_locations": {
- "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
- },
- "created_at": "2020-03-24T01:09:23Z",
- "family_name": "Ipsum",
- "given_name": "Elton",
- "id": "4uXcJQSLtbk3F0UQHFNQ",
- "is_owner": false,
- "status": "ACTIVE",
- "updated_at": "2020-03-24T01:15:23Z",
- "reference_id": "reference_id4"
- },
- {
- "assigned_locations": {
- "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
- },
- "created_at": "2020-03-24T01:09:23Z",
- "family_name": "Lo",
- "given_name": "Steven",
- "id": "5CoUpyrw1YwGWcRd-eDL",
- "is_owner": false,
- "status": "ACTIVE",
- "updated_at": "2020-03-24T01:19:23Z",
- "reference_id": "reference_id4"
- },
- {
- "assigned_locations": {
- "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
- },
- "created_at": "2020-03-24T18:14:03Z",
- "family_name": "Steward",
- "given_name": "Patrick",
- "id": "5MRPTTp8MMBLVSmzrGha",
- "is_owner": false,
- "phone_number": "+14155552671",
- "status": "ACTIVE",
- "updated_at": "2020-03-24T18:18:03Z",
- "wage_setting": {
- "created_at": "2020-03-24T18:14:03Z",
- "is_overtime_exempt": true,
- "job_assignments": [
- {
- "hourly_rate": {
- "amount": 2000,
- "currency": "USD"
- },
- "job_id": "VDNpRv8da51NU8qZFC5zDWpF",
- "job_title": "Cashier",
- "pay_type": "HOURLY"
- }
- ],
- "team_member_id": "5MRPTTp8MMBLVSmzrGha",
- "updated_at": "2020-03-24T18:14:03Z",
- "version": 1
- },
- "reference_id": "reference_id4"
- },
- {
- "assigned_locations": {
- "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
- },
- "created_at": "2020-03-24T01:09:25Z",
- "family_name": "Manny",
- "given_name": "Ivy",
- "id": "7F5ZxsfRnkexhu1PTbfh",
- "is_owner": false,
- "status": "ACTIVE",
- "updated_at": "2020-03-24T01:09:25Z",
- "reference_id": "reference_id4"
- },
- {
- "assigned_locations": {
- "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
- },
- "created_at": "2020-03-24T18:14:02Z",
- "email_address": "john_smith@example.com",
- "family_name": "Smith",
- "given_name": "John",
- "id": "808X9HR72yKvVaigQXf4",
- "is_owner": false,
- "phone_number": "+14155552671",
- "status": "ACTIVE",
- "updated_at": "2020-03-24T18:14:02Z",
- "reference_id": "reference_id4"
- },
- {
- "assigned_locations": {
- "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
- },
- "created_at": "2020-03-24T18:14:00Z",
- "email_address": "r_wen@example.com",
- "family_name": "Wen",
- "given_name": "Robert",
- "id": "9MVDVoY4hazkWKGo_OuZ",
- "is_owner": false,
- "phone_number": "+14155552671",
- "status": "ACTIVE",
- "updated_at": "2020-03-24T18:14:00Z",
- "reference_id": "reference_id4"
- },
- {
- "assigned_locations": {
- "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS"
- },
- "created_at": "2020-03-24T18:14:00Z",
- "email_address": "asimpson@example.com",
- "family_name": "Simpson",
- "given_name": "Ashley",
- "id": "9UglUjOXQ13-hMFypCft",
- "is_owner": false,
- "phone_number": "+14155552671",
- "status": "ACTIVE",
- "updated_at": "2020-03-24T18:18:00Z",
- "wage_setting": {
- "created_at": "2020-03-24T18:14:00Z",
- "is_overtime_exempt": true,
- "job_assignments": [
- {
- "hourly_rate": {
- "amount": 2000,
- "currency": "USD"
- },
- "job_id": "VDNpRv8da51NU8qZFC5zDWpF",
- "job_title": "Cashier",
- "pay_type": "HOURLY"
- }
- ],
- "team_member_id": "9UglUjOXQ13-hMFypCft",
- "updated_at": "2020-03-24T18:14:03Z",
- "version": 1
- },
- "reference_id": "reference_id4"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/search-terminal-actions-request.md b/doc/models/search-terminal-actions-request.md
deleted file mode 100644
index d265f16b..00000000
--- a/doc/models/search-terminal-actions-request.md
+++ /dev/null
@@ -1,38 +0,0 @@
-
-# Search Terminal Actions Request
-
-## Structure
-
-`SearchTerminalActionsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `query` | [`?TerminalActionQuery`](../../doc/models/terminal-action-query.md) | Optional | - | getQuery(): ?TerminalActionQuery | setQuery(?TerminalActionQuery query): void |
-| `cursor` | `?string` | Optional | 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/build-basics/common-api-patterns/pagination) for more
information. | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | Limit the number of results returned for a single request.
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 2,
- "query": {
- "filter": {
- "created_at": {
- "start_at": "2022-04-01T00:00:00.000Z",
- "end_at": "end_at8"
- },
- "device_id": "device_id0",
- "status": "status6",
- "type": "SAVE_CARD"
- },
- "sort": {
- "sort_order": "DESC"
- }
- },
- "cursor": "cursor4"
-}
-```
-
diff --git a/doc/models/search-terminal-actions-response.md b/doc/models/search-terminal-actions-response.md
deleted file mode 100644
index 7347a9d0..00000000
--- a/doc/models/search-terminal-actions-response.md
+++ /dev/null
@@ -1,66 +0,0 @@
-
-# Search Terminal Actions Response
-
-## Structure
-
-`SearchTerminalActionsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `action` | [`?(TerminalAction[])`](../../doc/models/terminal-action.md) | Optional | The requested search result of `TerminalAction`s. | getAction(): ?array | setAction(?array action): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request. If empty,
this is the final response.
See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more
information. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "action": [
- {
- "app_id": "APP_ID",
- "created_at": "2022-04-08T15:14:04.895Z",
- "deadline_duration": "PT5M",
- "device_id": "DEVICE_ID",
- "id": "termapia:oBGWlAats8xWCiCE",
- "location_id": "LOCATION_ID",
- "save_card_options": {
- "customer_id": "CUSTOMER_ID",
- "reference_id": "user-id-1"
- },
- "status": "IN_PROGRESS",
- "type": "SAVE_CARD",
- "updated_at": "2022-04-08T15:14:05.446Z",
- "cancel_reason": "TIMED_OUT"
- },
- {
- "app_id": "APP_ID",
- "created_at": "2022-04-08T15:14:01.210Z",
- "deadline_duration": "PT5M",
- "device_id": "DEVICE_ID",
- "id": "termapia:K2NY2YSSml3lTiCE",
- "location_id": "LOCATION_ID",
- "save_card_options": {
- "card_id": "ccof:CARD_ID",
- "customer_id": "CUSTOMER_ID",
- "reference_id": "user-id-1"
- },
- "status": "COMPLETED",
- "type": "SAVE_CARD",
- "updated_at": "2022-04-08T15:14:09.861Z",
- "cancel_reason": "TIMED_OUT"
- }
- ],
- "cursor": "CURSOR",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/search-terminal-checkouts-request.md b/doc/models/search-terminal-checkouts-request.md
deleted file mode 100644
index 2c83946b..00000000
--- a/doc/models/search-terminal-checkouts-request.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-# Search Terminal Checkouts Request
-
-## Structure
-
-`SearchTerminalCheckoutsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `query` | [`?TerminalCheckoutQuery`](../../doc/models/terminal-checkout-query.md) | Optional | - | getQuery(): ?TerminalCheckoutQuery | setQuery(?TerminalCheckoutQuery query): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query.
See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | Limits the number of results returned for a single request.
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 2,
- "query": {
- "filter": {
- "status": "COMPLETED",
- "device_id": "device_id0",
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- }
- },
- "sort": {
- "sort_order": "DESC"
- }
- },
- "cursor": "cursor4"
-}
-```
-
diff --git a/doc/models/search-terminal-checkouts-response.md b/doc/models/search-terminal-checkouts-response.md
deleted file mode 100644
index 0de4bf26..00000000
--- a/doc/models/search-terminal-checkouts-response.md
+++ /dev/null
@@ -1,123 +0,0 @@
-
-# Search Terminal Checkouts Response
-
-## Structure
-
-`SearchTerminalCheckoutsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `checkouts` | [`?(TerminalCheckout[])`](../../doc/models/terminal-checkout.md) | Optional | The requested search result of `TerminalCheckout` objects. | getCheckouts(): ?array | setCheckouts(?array checkouts): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request. If empty,
this is the final response.
See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "checkouts": [
- {
- "amount_money": {
- "amount": 2610,
- "currency": "USD"
- },
- "app_id": "APP_ID",
- "created_at": "2020-03-31T18:13:15.921Z",
- "deadline_duration": "PT5M",
- "device_options": {
- "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003",
- "skip_receipt_screen": false,
- "tip_settings": {
- "allow_tipping": false,
- "separate_tip_screen": false,
- "custom_tip_field": false,
- "tip_percentages": [
- 48
- ],
- "smart_tipping": false
- },
- "collect_signature": false,
- "show_itemized_cart": false
- },
- "id": "tsQPvzwBpMqqO",
- "note": "A brief note",
- "payment_ids": [
- "rXnhZzywrEk4vR6pw76fPZfgvaB"
- ],
- "reference_id": "id14467",
- "status": "COMPLETED",
- "updated_at": "2020-03-31T18:13:52.725Z",
- "order_id": "order_id2",
- "payment_options": {
- "autocomplete": false,
- "delay_duration": "delay_duration2",
- "accept_partial_authorization": false,
- "delay_action": "CANCEL"
- }
- },
- {
- "amount_money": {
- "amount": 2610,
- "currency": "USD"
- },
- "app_id": "APP_ID",
- "created_at": "2020-03-31T18:08:31.882Z",
- "deadline_duration": "PT5M",
- "device_options": {
- "device_id": "dbb5d83a-7838-11ea-bc55-0242ac130003",
- "skip_receipt_screen": true,
- "tip_settings": {
- "allow_tipping": false,
- "separate_tip_screen": false,
- "custom_tip_field": false,
- "tip_percentages": [
- 48
- ],
- "smart_tipping": false
- },
- "collect_signature": false,
- "show_itemized_cart": false
- },
- "id": "XlOPTgcEhrbqO",
- "note": "A brief note",
- "payment_ids": [
- "VYBF861PaoKPP7Pih0TlbZiNvaB"
- ],
- "reference_id": "id41623",
- "status": "COMPLETED",
- "updated_at": "2020-03-31T18:08:41.635Z",
- "order_id": "order_id2",
- "payment_options": {
- "autocomplete": false,
- "delay_duration": "delay_duration2",
- "accept_partial_authorization": false,
- "delay_action": "CANCEL"
- }
- }
- ],
- "cursor": "RiTJqBoTuXlbLmmrPvEkX9iG7XnQ4W4RjGnH",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/search-terminal-refunds-request.md b/doc/models/search-terminal-refunds-request.md
deleted file mode 100644
index ae4b69e4..00000000
--- a/doc/models/search-terminal-refunds-request.md
+++ /dev/null
@@ -1,37 +0,0 @@
-
-# Search Terminal Refunds Request
-
-## Structure
-
-`SearchTerminalRefundsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `query` | [`?TerminalRefundQuery`](../../doc/models/terminal-refund-query.md) | Optional | - | getQuery(): ?TerminalRefundQuery | setQuery(?TerminalRefundQuery query): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for the original query. | getCursor(): ?string | setCursor(?string cursor): void |
-| `limit` | `?int` | Optional | Limits the number of results returned for a single request.
**Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
-
-## Example (as JSON)
-
-```json
-{
- "limit": 1,
- "query": {
- "filter": {
- "status": "COMPLETED",
- "device_id": "device_id0",
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- }
- },
- "sort": {
- "sort_order": "sort_order8"
- }
- },
- "cursor": "cursor4"
-}
-```
-
diff --git a/doc/models/search-terminal-refunds-response.md b/doc/models/search-terminal-refunds-response.md
deleted file mode 100644
index dbf0f17c..00000000
--- a/doc/models/search-terminal-refunds-response.md
+++ /dev/null
@@ -1,72 +0,0 @@
-
-# Search Terminal Refunds Response
-
-## Structure
-
-`SearchTerminalRefundsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `refunds` | [`?(TerminalRefund[])`](../../doc/models/terminal-refund.md) | Optional | The requested search result of `TerminalRefund` objects. | getRefunds(): ?array | setRefunds(?array refunds): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request. If empty,
this is the final response.
See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "refunds": [
- {
- "amount_money": {
- "amount": 111,
- "currency": "CAD"
- },
- "app_id": "sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ",
- "card": {
- "bin": "411111",
- "card_brand": "INTERAC",
- "card_type": "CREDIT",
- "exp_month": 1,
- "exp_year": 2022,
- "fingerprint": "sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw",
- "last_4": "1111"
- },
- "created_at": "2020-09-29T15:21:46.771Z",
- "deadline_duration": "PT5M",
- "device_id": "f72dfb8e-4d65-4e56-aade-ec3fb8d33291",
- "id": "009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY",
- "location_id": "76C9W6K8CNNQ5",
- "order_id": "kcuKDKreRaI4gF4TjmEgZjHk8Z7YY",
- "payment_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY",
- "reason": "Returning item",
- "refund_id": "5O5OvgkcNUhl7JBuINflcjKqUzXZY_43Q4iGp7sNeATiWrUruA1EYeMRUXaddXXlDDJ1EQLvb",
- "status": "COMPLETED",
- "updated_at": "2020-09-29T15:21:48.675Z"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "cursor": "cursor8"
-}
-```
-
diff --git a/doc/models/search-vendors-request-filter.md b/doc/models/search-vendors-request-filter.md
deleted file mode 100644
index 761af71c..00000000
--- a/doc/models/search-vendors-request-filter.md
+++ /dev/null
@@ -1,33 +0,0 @@
-
-# Search Vendors Request Filter
-
-Defines supported query expressions to search for vendors by.
-
-## Structure
-
-`SearchVendorsRequestFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `name` | `?(string[])` | Optional | The names of the [Vendor](entity:Vendor) objects to retrieve. | getName(): ?array | setName(?array name): void |
-| `status` | [`?(string(VendorStatus)[])`](../../doc/models/vendor-status.md) | Optional | The statuses of the [Vendor](entity:Vendor) objects to retrieve.
See [VendorStatus](#type-vendorstatus) for possible values | getStatus(): ?array | setStatus(?array status): void |
-
-## Example (as JSON)
-
-```json
-{
- "name": [
- "name4",
- "name5",
- "name6"
- ],
- "status": [
- "ACTIVE",
- "INACTIVE",
- "ACTIVE"
- ]
-}
-```
-
diff --git a/doc/models/search-vendors-request-sort-field.md b/doc/models/search-vendors-request-sort-field.md
deleted file mode 100644
index 11f90af3..00000000
--- a/doc/models/search-vendors-request-sort-field.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Search Vendors Request Sort Field
-
-The field to sort the returned [Vendor](../../doc/models/vendor.md) objects by.
-
-## Enumeration
-
-`SearchVendorsRequestSortField`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `NAME` | To sort the result by the name of the [Vendor](../../doc/models/vendor.md) objects. |
-| `CREATED_AT` | To sort the result by the creation time of the [Vendor](../../doc/models/vendor.md) objects. |
-
diff --git a/doc/models/search-vendors-request-sort.md b/doc/models/search-vendors-request-sort.md
deleted file mode 100644
index 8a68dccc..00000000
--- a/doc/models/search-vendors-request-sort.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Search Vendors Request Sort
-
-Defines a sorter used to sort results from [SearchVendors](../../doc/apis/vendors.md#search-vendors).
-
-## Structure
-
-`SearchVendorsRequestSort`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `field` | [`?string(SearchVendorsRequestSortField)`](../../doc/models/search-vendors-request-sort-field.md) | Optional | The field to sort the returned [Vendor](../../doc/models/vendor.md) objects by. | getField(): ?string | setField(?string field): void |
-| `order` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getOrder(): ?string | setOrder(?string order): void |
-
-## Example (as JSON)
-
-```json
-{
- "field": "NAME",
- "order": "DESC"
-}
-```
-
diff --git a/doc/models/search-vendors-request.md b/doc/models/search-vendors-request.md
deleted file mode 100644
index 23e983a7..00000000
--- a/doc/models/search-vendors-request.md
+++ /dev/null
@@ -1,55 +0,0 @@
-
-# Search Vendors Request
-
-Represents an input into a call to [SearchVendors](../../doc/apis/vendors.md#search-vendors).
-
-## Structure
-
-`SearchVendorsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `filter` | [`?SearchVendorsRequestFilter`](../../doc/models/search-vendors-request-filter.md) | Optional | Defines supported query expressions to search for vendors by. | getFilter(): ?SearchVendorsRequestFilter | setFilter(?SearchVendorsRequestFilter filter): void |
-| `sort` | [`?SearchVendorsRequestSort`](../../doc/models/search-vendors-request-sort.md) | Optional | Defines a sorter used to sort results from [SearchVendors](../../doc/apis/vendors.md#search-vendors). | getSort(): ?SearchVendorsRequestSort | setSort(?SearchVendorsRequestSort sort): void |
-| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint.
Provide this to retrieve the next set of results for the original query.
See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "query": {
- "filter": {
- "name": [
- "Joe's Fresh Seafood",
- "Hannah's Bakery"
- ],
- "status": [
- "ACTIVE"
- ]
- },
- "sort": {
- "field": "CREATED_AT",
- "order": "ASC"
- }
- },
- "filter": {
- "name": [
- "name4",
- "name5",
- "name6"
- ],
- "status": [
- "ACTIVE",
- "INACTIVE"
- ]
- },
- "sort": {
- "field": "NAME",
- "order": "DESC"
- },
- "cursor": "cursor0"
-}
-```
-
diff --git a/doc/models/search-vendors-response.md b/doc/models/search-vendors-response.md
deleted file mode 100644
index 0c15d6d1..00000000
--- a/doc/models/search-vendors-response.md
+++ /dev/null
@@ -1,61 +0,0 @@
-
-# Search Vendors Response
-
-Represents an output from a call to [SearchVendors](../../doc/apis/vendors.md#search-vendors).
-
-## Structure
-
-`SearchVendorsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors encountered when the request fails. | getErrors(): ?array | setErrors(?array errors): void |
-| `vendors` | [`?(Vendor[])`](../../doc/models/vendor.md) | Optional | The [Vendor](entity:Vendor) objects matching the specified search filter. | getVendors(): ?array | setVendors(?array vendors): void |
-| `cursor` | `?string` | Optional | The pagination cursor to be used in a subsequent request. If unset,
this is the final response.
See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. | getCursor(): ?string | setCursor(?string cursor): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "vendors": [
- {
- "id": "id8",
- "created_at": "created_at6",
- "updated_at": "updated_at4",
- "name": "name8",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- },
- {
- "id": "id8",
- "created_at": "created_at6",
- "updated_at": "updated_at4",
- "name": "name8",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- }
- ],
- "cursor": "cursor8"
-}
-```
-
diff --git a/doc/models/segment-filter.md b/doc/models/segment-filter.md
deleted file mode 100644
index dde141be..00000000
--- a/doc/models/segment-filter.md
+++ /dev/null
@@ -1,40 +0,0 @@
-
-# Segment Filter
-
-A query filter to search for buyer-accessible appointment segments by.
-
-## Structure
-
-`SegmentFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `serviceVariationId` | `string` | Required | The ID of the [CatalogItemVariation](entity:CatalogItemVariation) object representing the service booked in this segment.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | getServiceVariationId(): string | setServiceVariationId(string serviceVariationId): void |
-| `teamMemberIdFilter` | [`?FilterValue`](../../doc/models/filter-value.md) | Optional | A filter to select resources based on an exact field value. For any given
value, the value can only be in one property. Depending on the field, either
all properties can be set or only a subset will be available.
Refer to the documentation of the field. | getTeamMemberIdFilter(): ?FilterValue | setTeamMemberIdFilter(?FilterValue teamMemberIdFilter): void |
-
-## Example (as JSON)
-
-```json
-{
- "service_variation_id": "service_variation_id0",
- "team_member_id_filter": {
- "all": [
- "all5",
- "all6",
- "all7"
- ],
- "any": [
- "any2",
- "any3",
- "any4"
- ],
- "none": [
- "none7",
- "none8"
- ]
- }
-}
-```
-
diff --git a/doc/models/select-option.md b/doc/models/select-option.md
deleted file mode 100644
index 3c6b291b..00000000
--- a/doc/models/select-option.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Select Option
-
-## Structure
-
-`SelectOption`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `referenceId` | `string` | Required | The reference id for the option.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getReferenceId(): string | setReferenceId(string referenceId): void |
-| `title` | `string` | Required | The title text that displays in the select option button.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `250` | getTitle(): string | setTitle(string title): void |
-
-## Example (as JSON)
-
-```json
-{
- "reference_id": "reference_id6",
- "title": "title8"
-}
-```
-
diff --git a/doc/models/select-options.md b/doc/models/select-options.md
deleted file mode 100644
index ff8a67ee..00000000
--- a/doc/models/select-options.md
+++ /dev/null
@@ -1,35 +0,0 @@
-
-# Select Options
-
-## Structure
-
-`SelectOptions`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `title` | `string` | Required | The title text to display in the select flow on the Terminal.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `250` | getTitle(): string | setTitle(string title): void |
-| `body` | `string` | Required | The body text to display in the select flow on the Terminal.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `10000` | getBody(): string | setBody(string body): void |
-| `options` | [`SelectOption[]`](../../doc/models/select-option.md) | Required | Represents the buttons/options that should be displayed in the select flow on the Terminal. | getOptions(): array | setOptions(array options): void |
-| `selectedOption` | [`?SelectOption`](../../doc/models/select-option.md) | Optional | - | getSelectedOption(): ?SelectOption | setSelectedOption(?SelectOption selectedOption): void |
-
-## Example (as JSON)
-
-```json
-{
- "title": "title0",
- "body": "body0",
- "options": [
- {
- "reference_id": "reference_id0",
- "title": "title2"
- }
- ],
- "selected_option": {
- "reference_id": "reference_id6",
- "title": "title8"
- }
-}
-```
-
diff --git a/doc/models/shift-filter-status.md b/doc/models/shift-filter-status.md
deleted file mode 100644
index 988934df..00000000
--- a/doc/models/shift-filter-status.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Shift Filter Status
-
-Specifies the `status` of `Shift` records to be returned.
-
-## Enumeration
-
-`ShiftFilterStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `OPEN` | Shifts that have been started and not ended. |
-| `CLOSED` | Shifts that have been started and ended. |
-
diff --git a/doc/models/shift-filter.md b/doc/models/shift-filter.md
deleted file mode 100644
index a31be986..00000000
--- a/doc/models/shift-filter.md
+++ /dev/null
@@ -1,48 +0,0 @@
-
-# Shift Filter
-
-Defines a filter used in a search for `Shift` records. `AND` logic is
-used by Square's servers to apply each filter property specified.
-
-## Structure
-
-`ShiftFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationIds` | `?(string[])` | Optional | Fetch shifts for the specified location. | getLocationIds(): ?array | setLocationIds(?array locationIds): void |
-| `employeeIds` | `?(string[])` | Optional | Fetch shifts for the specified employees. DEPRECATED at version 2020-08-26. Use `team_member_ids` instead. | getEmployeeIds(): ?array | setEmployeeIds(?array employeeIds): void |
-| `status` | [`?string(ShiftFilterStatus)`](../../doc/models/shift-filter-status.md) | Optional | Specifies the `status` of `Shift` records to be returned. | getStatus(): ?string | setStatus(?string status): void |
-| `start` | [`?TimeRange`](../../doc/models/time-range.md) | Optional | Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled. | getStart(): ?TimeRange | setStart(?TimeRange start): void |
-| `end` | [`?TimeRange`](../../doc/models/time-range.md) | Optional | Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled. | getEnd(): ?TimeRange | setEnd(?TimeRange end): void |
-| `workday` | [`?ShiftWorkday`](../../doc/models/shift-workday.md) | Optional | A `Shift` search query filter parameter that sets a range of days that
a `Shift` must start or end in before passing the filter condition. | getWorkday(): ?ShiftWorkday | setWorkday(?ShiftWorkday workday): void |
-| `teamMemberIds` | `?(string[])` | Optional | Fetch shifts for the specified team members. Replaced `employee_ids` at version "2020-08-26". | getTeamMemberIds(): ?array | setTeamMemberIds(?array teamMemberIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_ids": [
- "location_ids8",
- "location_ids9",
- "location_ids0"
- ],
- "employee_ids": [
- "employee_ids3",
- "employee_ids4",
- "employee_ids5"
- ],
- "status": "OPEN",
- "start": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- },
- "end": {
- "start_at": "start_at0",
- "end_at": "end_at2"
- }
-}
-```
-
diff --git a/doc/models/shift-query.md b/doc/models/shift-query.md
deleted file mode 100644
index 11346f9c..00000000
--- a/doc/models/shift-query.md
+++ /dev/null
@@ -1,44 +0,0 @@
-
-# Shift Query
-
-The parameters of a `Shift` search query, which includes filter and sort options.
-
-## Structure
-
-`ShiftQuery`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `filter` | [`?ShiftFilter`](../../doc/models/shift-filter.md) | Optional | Defines a filter used in a search for `Shift` records. `AND` logic is
used by Square's servers to apply each filter property specified. | getFilter(): ?ShiftFilter | setFilter(?ShiftFilter filter): void |
-| `sort` | [`?ShiftSort`](../../doc/models/shift-sort.md) | Optional | Sets the sort order of search results. | getSort(): ?ShiftSort | setSort(?ShiftSort sort): void |
-
-## Example (as JSON)
-
-```json
-{
- "filter": {
- "location_ids": [
- "location_ids4"
- ],
- "employee_ids": [
- "employee_ids9"
- ],
- "status": "OPEN",
- "start": {
- "start_at": "start_at6",
- "end_at": "end_at6"
- },
- "end": {
- "start_at": "start_at0",
- "end_at": "end_at2"
- }
- },
- "sort": {
- "field": "START_AT",
- "order": "DESC"
- }
-}
-```
-
diff --git a/doc/models/shift-sort-field.md b/doc/models/shift-sort-field.md
deleted file mode 100644
index eefd8b5c..00000000
--- a/doc/models/shift-sort-field.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# Shift Sort Field
-
-Enumerates the `Shift` fields to sort on.
-
-## Enumeration
-
-`ShiftSortField`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `START_AT` | The start date/time of a `Shift` |
-| `END_AT` | The end date/time of a `Shift` |
-| `CREATED_AT` | The date/time that a `Shift` is created |
-| `UPDATED_AT` | The most recent date/time that a `Shift` is updated |
-
diff --git a/doc/models/shift-sort.md b/doc/models/shift-sort.md
deleted file mode 100644
index 54f21776..00000000
--- a/doc/models/shift-sort.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Shift Sort
-
-Sets the sort order of search results.
-
-## Structure
-
-`ShiftSort`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `field` | [`?string(ShiftSortField)`](../../doc/models/shift-sort-field.md) | Optional | Enumerates the `Shift` fields to sort on. | getField(): ?string | setField(?string field): void |
-| `order` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getOrder(): ?string | setOrder(?string order): void |
-
-## Example (as JSON)
-
-```json
-{
- "field": "START_AT",
- "order": "DESC"
-}
-```
-
diff --git a/doc/models/shift-status.md b/doc/models/shift-status.md
deleted file mode 100644
index dbeaf3c6..00000000
--- a/doc/models/shift-status.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Shift Status
-
-Enumerates the possible status of a `Shift`.
-
-## Enumeration
-
-`ShiftStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `OPEN` | Employee started a work shift and the shift is not complete |
-| `CLOSED` | Employee started and ended a work shift. |
-
diff --git a/doc/models/shift-wage.md b/doc/models/shift-wage.md
deleted file mode 100644
index cdd1e9f6..00000000
--- a/doc/models/shift-wage.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Shift Wage
-
-The hourly wage rate used to compensate an employee for this shift.
-
-## Structure
-
-`ShiftWage`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `title` | `?string` | Optional | The name of the job performed during this shift. | getTitle(): ?string | setTitle(?string title): void |
-| `hourlyRate` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getHourlyRate(): ?Money | setHourlyRate(?Money hourlyRate): void |
-| `jobId` | `?string` | Optional | The id of the job performed during this shift. Square
labor-reporting UIs might group shifts together by id. This cannot be used to retrieve the job. | getJobId(): ?string | setJobId(?string jobId): void |
-| `tipEligible` | `?bool` | Optional | Whether team members are eligible for tips when working this job. | getTipEligible(): ?bool | setTipEligible(?bool tipEligible): void |
-
-## Example (as JSON)
-
-```json
-{
- "title": "title6",
- "hourly_rate": {
- "amount": 172,
- "currency": "LAK"
- },
- "job_id": "job_id2",
- "tip_eligible": false
-}
-```
-
diff --git a/doc/models/shift-workday-matcher.md b/doc/models/shift-workday-matcher.md
deleted file mode 100644
index 3d87afa5..00000000
--- a/doc/models/shift-workday-matcher.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Shift Workday Matcher
-
-Defines the logic used to apply a workday filter.
-
-## Enumeration
-
-`ShiftWorkdayMatcher`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `START_AT` | All shifts that start on or after the specified workday |
-| `END_AT` | All shifts that end on or before the specified workday |
-| `INTERSECTION` | All shifts that start between the start and end workdays (inclusive) |
-
diff --git a/doc/models/shift-workday.md b/doc/models/shift-workday.md
deleted file mode 100644
index ab6e779e..00000000
--- a/doc/models/shift-workday.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Shift Workday
-
-A `Shift` search query filter parameter that sets a range of days that
-a `Shift` must start or end in before passing the filter condition.
-
-## Structure
-
-`ShiftWorkday`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `dateRange` | [`?DateRange`](../../doc/models/date-range.md) | Optional | A range defined by two dates. Used for filtering a query for Connect v2
objects that have date properties. | getDateRange(): ?DateRange | setDateRange(?DateRange dateRange): void |
-| `matchShiftsBy` | [`?string(ShiftWorkdayMatcher)`](../../doc/models/shift-workday-matcher.md) | Optional | Defines the logic used to apply a workday filter. | getMatchShiftsBy(): ?string | setMatchShiftsBy(?string matchShiftsBy): void |
-| `defaultTimezone` | `?string` | Optional | Location-specific timezones convert workdays to datetime filters.
Every location included in the query must have a timezone or this field
must be provided as a fallback. Format: the IANA timezone database
identifier for the relevant timezone. | getDefaultTimezone(): ?string | setDefaultTimezone(?string defaultTimezone): void |
-
-## Example (as JSON)
-
-```json
-{
- "date_range": {
- "start_date": "start_date6",
- "end_date": "end_date2"
- },
- "match_shifts_by": "END_AT",
- "default_timezone": "default_timezone2"
-}
-```
-
diff --git a/doc/models/shift.md b/doc/models/shift.md
deleted file mode 100644
index 3bca4b1a..00000000
--- a/doc/models/shift.md
+++ /dev/null
@@ -1,52 +0,0 @@
-
-# Shift
-
-A record of the hourly rate, start, and end times for a single work shift
-for an employee. This might include a record of the start and end times for breaks
-taken during the shift.
-
-## Structure
-
-`Shift`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The UUID for this object.
**Constraints**: *Maximum Length*: `255` | getId(): ?string | setId(?string id): void |
-| `employeeId` | `?string` | Optional | The ID of the employee this shift belongs to. DEPRECATED at version 2020-08-26. Use `team_member_id` instead. | getEmployeeId(): ?string | setEmployeeId(?string employeeId): void |
-| `locationId` | `string` | Required | The ID of the location this shift occurred at. The location should be based on
where the employee clocked in.
**Constraints**: *Minimum Length*: `1` | getLocationId(): string | setLocationId(string locationId): void |
-| `timezone` | `?string` | Optional | The read-only convenience value that is calculated from the location based
on the `location_id`. Format: the IANA timezone database identifier for the
location timezone. | getTimezone(): ?string | setTimezone(?string timezone): void |
-| `startAt` | `string` | Required | RFC 3339; shifted to the location timezone + offset. Precision up to the
minute is respected; seconds are truncated.
**Constraints**: *Minimum Length*: `1` | getStartAt(): string | setStartAt(string startAt): void |
-| `endAt` | `?string` | Optional | RFC 3339; shifted to the timezone + offset. Precision up to the minute is
respected; seconds are truncated. | getEndAt(): ?string | setEndAt(?string endAt): void |
-| `wage` | [`?ShiftWage`](../../doc/models/shift-wage.md) | Optional | The hourly wage rate used to compensate an employee for this shift. | getWage(): ?ShiftWage | setWage(?ShiftWage wage): void |
-| `breaks` | [`?(MBreak[])`](../../doc/models/m-break.md) | Optional | A list of all the paid or unpaid breaks that were taken during this shift. | getBreaks(): ?array | setBreaks(?array breaks): void |
-| `status` | [`?string(ShiftStatus)`](../../doc/models/shift-status.md) | Optional | Enumerates the possible status of a `Shift`. | getStatus(): ?string | setStatus(?string status): void |
-| `version` | `?int` | Optional | Used for resolving concurrency issues. The request fails if the version
provided does not match the server version at the time of the request. If not provided,
Square executes a blind write; potentially overwriting data from another
write. | getVersion(): ?int | setVersion(?int version): void |
-| `createdAt` | `?string` | Optional | A read-only timestamp in RFC 3339 format; presented in UTC. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | A read-only timestamp in RFC 3339 format; presented in UTC. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `teamMemberId` | `?string` | Optional | The ID of the team member this shift belongs to. Replaced `employee_id` at version "2020-08-26". | getTeamMemberId(): ?string | setTeamMemberId(?string teamMemberId): void |
-| `declaredCashTipMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getDeclaredCashTipMoney(): ?Money | setDeclaredCashTipMoney(?Money declaredCashTipMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id0",
- "employee_id": "employee_id0",
- "location_id": "location_id4",
- "timezone": "timezone0",
- "start_at": "start_at2",
- "end_at": "end_at0",
- "wage": {
- "title": "title8",
- "hourly_rate": {
- "amount": 172,
- "currency": "LAK"
- },
- "job_id": "job_id0",
- "tip_eligible": false
- }
-}
-```
-
diff --git a/doc/models/shipping-fee.md b/doc/models/shipping-fee.md
deleted file mode 100644
index 81c5ed9d..00000000
--- a/doc/models/shipping-fee.md
+++ /dev/null
@@ -1,26 +0,0 @@
-
-# Shipping Fee
-
-## Structure
-
-`ShippingFee`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `name` | `?string` | Optional | The name for the shipping fee. | getName(): ?string | setName(?string name): void |
-| `charge` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getCharge(): Money | setCharge(Money charge): void |
-
-## Example (as JSON)
-
-```json
-{
- "name": "name6",
- "charge": {
- "amount": 80,
- "currency": "TTD"
- }
-}
-```
-
diff --git a/doc/models/signature-image.md b/doc/models/signature-image.md
deleted file mode 100644
index ad87fdb9..00000000
--- a/doc/models/signature-image.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Signature Image
-
-## Structure
-
-`SignatureImage`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `imageType` | `?string` | Optional | The mime/type of the image data.
Use `image/png;base64` for png. | getImageType(): ?string | setImageType(?string imageType): void |
-| `data` | `?string` | Optional | The base64 representation of the image. | getData(): ?string | setData(?string data): void |
-
-## Example (as JSON)
-
-```json
-{
- "image_type": "image_type4",
- "data": "data8"
-}
-```
-
diff --git a/doc/models/signature-options.md b/doc/models/signature-options.md
deleted file mode 100644
index a7df9ff3..00000000
--- a/doc/models/signature-options.md
+++ /dev/null
@@ -1,38 +0,0 @@
-
-# Signature Options
-
-## Structure
-
-`SignatureOptions`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `title` | `string` | Required | The title text to display in the signature capture flow on the Terminal.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `250` | getTitle(): string | setTitle(string title): void |
-| `body` | `string` | Required | The body text to display in the signature capture flow on the Terminal.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `10000` | getBody(): string | setBody(string body): void |
-| `signature` | [`?(SignatureImage[])`](../../doc/models/signature-image.md) | Optional | An image representation of the collected signature. | getSignature(): ?array | setSignature(?array signature): void |
-
-## Example (as JSON)
-
-```json
-{
- "title": "title2",
- "body": "body8",
- "signature": [
- {
- "image_type": "image_type4",
- "data": "data8"
- },
- {
- "image_type": "image_type4",
- "data": "data8"
- },
- {
- "image_type": "image_type4",
- "data": "data8"
- }
- ]
-}
-```
-
diff --git a/doc/models/site.md b/doc/models/site.md
deleted file mode 100644
index dde13cee..00000000
--- a/doc/models/site.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Site
-
-Represents a Square Online site, which is an online store for a Square seller.
-
-## Structure
-
-`Site`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The Square-assigned ID of the site.
**Constraints**: *Maximum Length*: `32` | getId(): ?string | setId(?string id): void |
-| `siteTitle` | `?string` | Optional | The title of the site. | getSiteTitle(): ?string | setSiteTitle(?string siteTitle): void |
-| `domain` | `?string` | Optional | The domain of the site (without the protocol). For example, `mysite1.square.site`. | getDomain(): ?string | setDomain(?string domain): void |
-| `isPublished` | `?bool` | Optional | Indicates whether the site is published. | getIsPublished(): ?bool | setIsPublished(?bool isPublished): void |
-| `createdAt` | `?string` | Optional | The timestamp of when the site was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp of when the site was last updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id0",
- "site_title": "site_title6",
- "domain": "domain6",
- "is_published": false,
- "created_at": "created_at8"
-}
-```
-
diff --git a/doc/models/snippet-response.md b/doc/models/snippet-response.md
deleted file mode 100644
index c9b9ed12..00000000
--- a/doc/models/snippet-response.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-# Snippet Response
-
-## Structure
-
-`SnippetResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `snippet` | [`?Snippet`](../../doc/models/snippet.md) | Optional | Represents the snippet that is added to a Square Online site. The snippet code is injected into the `head` element of all pages on the site, except for checkout pages. | getSnippet(): ?Snippet | setSnippet(?Snippet snippet): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "snippet": {
- "id": "id0",
- "site_id": "site_id6",
- "content": "content4",
- "created_at": "created_at8",
- "updated_at": "updated_at4"
- }
-}
-```
-
diff --git a/doc/models/snippet.md b/doc/models/snippet.md
deleted file mode 100644
index f81de782..00000000
--- a/doc/models/snippet.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Snippet
-
-Represents the snippet that is added to a Square Online site. The snippet code is injected into the `head` element of all pages on the site, except for checkout pages.
-
-## Structure
-
-`Snippet`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The Square-assigned ID for the snippet.
**Constraints**: *Maximum Length*: `48` | getId(): ?string | setId(?string id): void |
-| `siteId` | `?string` | Optional | The ID of the site that contains the snippet. | getSiteId(): ?string | setSiteId(?string siteId): void |
-| `content` | `string` | Required | The snippet code, which can contain valid HTML, JavaScript, or both.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `65535` | getContent(): string | setContent(string content): void |
-| `createdAt` | `?string` | Optional | The timestamp of when the snippet was initially added to the site, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp of when the snippet was last updated on the site, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id2",
- "site_id": "site_id8",
- "content": "content6",
- "created_at": "created_at0",
- "updated_at": "updated_at8"
-}
-```
-
diff --git a/doc/models/sort-order.md b/doc/models/sort-order.md
deleted file mode 100644
index b9e77cba..00000000
--- a/doc/models/sort-order.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Sort Order
-
-The order (e.g., chronological or alphabetical) in which results from a request are returned.
-
-## Enumeration
-
-`SortOrder`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `DESC` | The results are returned in descending (e.g., newest-first or Z-A) order. |
-| `ASC` | The results are returned in ascending (e.g., oldest-first or A-Z) order. |
-
diff --git a/doc/models/source-application.md b/doc/models/source-application.md
deleted file mode 100644
index 7b69fea7..00000000
--- a/doc/models/source-application.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Source Application
-
-Represents information about the application used to generate a change.
-
-## Structure
-
-`SourceApplication`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `product` | [`?string(Product)`](../../doc/models/product.md) | Optional | Indicates the Square product used to generate a change. | getProduct(): ?string | setProduct(?string product): void |
-| `applicationId` | `?string` | Optional | __Read only__ The Square-assigned ID of the application. This field is used only if the
[product](entity:Product) type is `EXTERNAL_API`. | getApplicationId(): ?string | setApplicationId(?string applicationId): void |
-| `name` | `?string` | Optional | __Read only__ The display name of the application
(for example, `"Custom Application"` or `"Square POS 4.74 for Android"`). | getName(): ?string | setName(?string name): void |
-
-## Example (as JSON)
-
-```json
-{
- "product": "INVOICES",
- "application_id": "application_id0",
- "name": "name4"
-}
-```
-
diff --git a/doc/models/square-account-details.md b/doc/models/square-account-details.md
deleted file mode 100644
index 1c9dd1b8..00000000
--- a/doc/models/square-account-details.md
+++ /dev/null
@@ -1,38 +0,0 @@
-
-# Square Account Details
-
-Additional details about Square Account payments.
-
-## Structure
-
-`SquareAccountDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentSourceToken` | `?string` | Optional | Unique identifier for the payment source used for this payment.
**Constraints**: *Maximum Length*: `255` | getPaymentSourceToken(): ?string | setPaymentSourceToken(?string paymentSourceToken): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_source_token": "payment_source_token8",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/standard-unit-description-group.md b/doc/models/standard-unit-description-group.md
deleted file mode 100644
index 48a77f1d..00000000
--- a/doc/models/standard-unit-description-group.md
+++ /dev/null
@@ -1,68 +0,0 @@
-
-# Standard Unit Description Group
-
-Group of standard measurement units.
-
-## Structure
-
-`StandardUnitDescriptionGroup`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `standardUnitDescriptions` | [`?(StandardUnitDescription[])`](../../doc/models/standard-unit-description.md) | Optional | List of standard (non-custom) measurement units in this description group. | getStandardUnitDescriptions(): ?array | setStandardUnitDescriptions(?array standardUnitDescriptions): void |
-| `languageCode` | `?string` | Optional | IETF language tag. | getLanguageCode(): ?string | setLanguageCode(?string languageCode): void |
-
-## Example (as JSON)
-
-```json
-{
- "standard_unit_descriptions": [
- {
- "unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_MILLILITER",
- "weight_unit": "IMPERIAL_STONE"
- },
- "name": "name4",
- "abbreviation": "abbreviation6"
- },
- {
- "unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_MILLILITER",
- "weight_unit": "IMPERIAL_STONE"
- },
- "name": "name4",
- "abbreviation": "abbreviation6"
- },
- {
- "unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_MILLILITER",
- "weight_unit": "IMPERIAL_STONE"
- },
- "name": "name4",
- "abbreviation": "abbreviation6"
- }
- ],
- "language_code": "language_code4"
-}
-```
-
diff --git a/doc/models/standard-unit-description.md b/doc/models/standard-unit-description.md
deleted file mode 100644
index b624b1d8..00000000
--- a/doc/models/standard-unit-description.md
+++ /dev/null
@@ -1,36 +0,0 @@
-
-# Standard Unit Description
-
-Contains the name and abbreviation for standard measurement unit.
-
-## Structure
-
-`StandardUnitDescription`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `unit` | [`?MeasurementUnit`](../../doc/models/measurement-unit.md) | Optional | Represents a unit of measurement to use with a quantity, such as ounces
or inches. Exactly one of the following fields are required: `custom_unit`,
`area_unit`, `length_unit`, `volume_unit`, and `weight_unit`. | getUnit(): ?MeasurementUnit | setUnit(?MeasurementUnit unit): void |
-| `name` | `?string` | Optional | UI display name of the measurement unit. For example, 'Pound'. | getName(): ?string | setName(?string name): void |
-| `abbreviation` | `?string` | Optional | UI display abbreviation for the measurement unit. For example, 'lb'. | getAbbreviation(): ?string | setAbbreviation(?string abbreviation): void |
-
-## Example (as JSON)
-
-```json
-{
- "unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_MILLILITER",
- "weight_unit": "IMPERIAL_STONE"
- },
- "name": "name4",
- "abbreviation": "abbreviation6"
-}
-```
-
diff --git a/doc/models/submit-evidence-response.md b/doc/models/submit-evidence-response.md
deleted file mode 100644
index dfac8e55..00000000
--- a/doc/models/submit-evidence-response.md
+++ /dev/null
@@ -1,64 +0,0 @@
-
-# Submit Evidence Response
-
-Defines the fields in a `SubmitEvidence` response.
-
-## Structure
-
-`SubmitEvidenceResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `dispute` | [`?Dispute`](../../doc/models/dispute.md) | Optional | Represents a [dispute](https://developer.squareup.com/docs/disputes-api/overview) a cardholder initiated with their bank. | getDispute(): ?Dispute | setDispute(?Dispute dispute): void |
-
-## Example (as JSON)
-
-```json
-{
- "dispute": {
- "amount_money": {
- "amount": 4350,
- "currency": "USD"
- },
- "brand_dispute_id": "100000399240",
- "card_brand": "VISA",
- "created_at": "2022-05-18T16:02:15.313Z",
- "disputed_payment": {
- "payment_id": "2yeBUWJzllJTpmnSqtMRAL19taB"
- },
- "due_at": "2022-06-01T00:00:00.000Z",
- "id": "EAZoK70gX3fyvibecLwIGB",
- "location_id": "LSY8XKGSMMX94",
- "reason": "CUSTOMER_REQUESTS_CREDIT",
- "reported_at": "2022-05-18T00:00:00.000Z",
- "state": "PROCESSING",
- "updated_at": "2022-05-18T16:02:15.313Z",
- "version": 4,
- "dispute_id": "dispute_id8"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/subscription-action-type.md b/doc/models/subscription-action-type.md
deleted file mode 100644
index bff9f231..00000000
--- a/doc/models/subscription-action-type.md
+++ /dev/null
@@ -1,19 +0,0 @@
-
-# Subscription Action Type
-
-Supported types of an action as a pending change to a subscription.
-
-## Enumeration
-
-`SubscriptionActionType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `CANCEL` | The action to execute a scheduled cancellation of a subscription. |
-| `PAUSE` | The action to execute a scheduled pause of a subscription. |
-| `RESUME` | The action to execute a scheduled resumption of a subscription. |
-| `SWAP_PLAN` | The action to execute a scheduled swap of a subscription plan in a subscription. |
-| `CHANGE_BILLING_ANCHOR_DATE` | A billing anchor date change action. |
-
diff --git a/doc/models/subscription-action.md b/doc/models/subscription-action.md
deleted file mode 100644
index 9fb4e066..00000000
--- a/doc/models/subscription-action.md
+++ /dev/null
@@ -1,45 +0,0 @@
-
-# Subscription Action
-
-Represents an action as a pending change to a subscription.
-
-## Structure
-
-`SubscriptionAction`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The ID of an action scoped to a subscription. | getId(): ?string | setId(?string id): void |
-| `type` | [`?string(SubscriptionActionType)`](../../doc/models/subscription-action-type.md) | Optional | Supported types of an action as a pending change to a subscription. | getType(): ?string | setType(?string type): void |
-| `effectiveDate` | `?string` | Optional | The `YYYY-MM-DD`-formatted date when the action occurs on the subscription. | getEffectiveDate(): ?string | setEffectiveDate(?string effectiveDate): void |
-| `monthlyBillingAnchorDate` | `?int` | Optional | The new billing anchor day value, for a `CHANGE_BILLING_ANCHOR_DATE` action. | getMonthlyBillingAnchorDate(): ?int | setMonthlyBillingAnchorDate(?int monthlyBillingAnchorDate): void |
-| `phases` | [`?(Phase[])`](../../doc/models/phase.md) | Optional | A list of Phases, to pass phase-specific information used in the swap. | getPhases(): ?array | setPhases(?array phases): void |
-| `newPlanVariationId` | `?string` | Optional | The target subscription plan variation that a subscription switches to, for a `SWAP_PLAN` action. | getNewPlanVariationId(): ?string | setNewPlanVariationId(?string newPlanVariationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id2",
- "type": "SWAP_PLAN",
- "effective_date": "effective_date2",
- "monthly_billing_anchor_date": 18,
- "phases": [
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- },
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- }
- ]
-}
-```
-
diff --git a/doc/models/subscription-cadence.md b/doc/models/subscription-cadence.md
deleted file mode 100644
index 0499ca72..00000000
--- a/doc/models/subscription-cadence.md
+++ /dev/null
@@ -1,27 +0,0 @@
-
-# Subscription Cadence
-
-Determines the billing cadence of a [Subscription](../../doc/models/subscription.md)
-
-## Enumeration
-
-`SubscriptionCadence`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `DAILY` | Once per day |
-| `WEEKLY` | Once per week |
-| `EVERY_TWO_WEEKS` | Every two weeks |
-| `THIRTY_DAYS` | Once every 30 days |
-| `SIXTY_DAYS` | Once every 60 days |
-| `NINETY_DAYS` | Once every 90 days |
-| `MONTHLY` | Once per month |
-| `EVERY_TWO_MONTHS` | Once every two months |
-| `QUARTERLY` | Once every three months |
-| `EVERY_FOUR_MONTHS` | Once every four months |
-| `EVERY_SIX_MONTHS` | Once every six months |
-| `ANNUAL` | Once per year |
-| `EVERY_TWO_YEARS` | Once every two years |
-
diff --git a/doc/models/subscription-event-info-code.md b/doc/models/subscription-event-info-code.md
deleted file mode 100644
index de7baf13..00000000
--- a/doc/models/subscription-event-info-code.md
+++ /dev/null
@@ -1,20 +0,0 @@
-
-# Subscription Event Info Code
-
-Supported info codes of a subscription event.
-
-## Enumeration
-
-`SubscriptionEventInfoCode`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `LOCATION_NOT_ACTIVE` | The location is not active. |
-| `LOCATION_CANNOT_ACCEPT_PAYMENT` | The location cannot accept payments. |
-| `CUSTOMER_DELETED` | The subscribing customer profile has been deleted. |
-| `CUSTOMER_NO_EMAIL` | The subscribing customer does not have an email. |
-| `CUSTOMER_NO_NAME` | The subscribing customer does not have a name. |
-| `USER_PROVIDED` | User-provided detail. |
-
diff --git a/doc/models/subscription-event-info.md b/doc/models/subscription-event-info.md
deleted file mode 100644
index ef0b9027..00000000
--- a/doc/models/subscription-event-info.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Subscription Event Info
-
-Provides information about the subscription event.
-
-## Structure
-
-`SubscriptionEventInfo`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `detail` | `?string` | Optional | A human-readable explanation for the event. | getDetail(): ?string | setDetail(?string detail): void |
-| `code` | [`?string(SubscriptionEventInfoCode)`](../../doc/models/subscription-event-info-code.md) | Optional | Supported info codes of a subscription event. | getCode(): ?string | setCode(?string code): void |
-
-## Example (as JSON)
-
-```json
-{
- "detail": "detail8",
- "code": "CUSTOMER_NO_NAME"
-}
-```
-
diff --git a/doc/models/subscription-event-subscription-event-type.md b/doc/models/subscription-event-subscription-event-type.md
deleted file mode 100644
index 8ca123a4..00000000
--- a/doc/models/subscription-event-subscription-event-type.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Subscription Event Subscription Event Type
-
-Supported types of an event occurred to a subscription.
-
-## Enumeration
-
-`SubscriptionEventSubscriptionEventType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `START_SUBSCRIPTION` | The subscription was started. |
-| `PLAN_CHANGE` | The subscription plan was changed. |
-| `STOP_SUBSCRIPTION` | The subscription was stopped. |
-| `DEACTIVATE_SUBSCRIPTION` | The subscription was deactivated |
-| `RESUME_SUBSCRIPTION` | The subscription was resumed. |
-| `PAUSE_SUBSCRIPTION` | The subscription was paused. |
-| `BILLING_ANCHOR_DATE_CHANGED` | The billing anchor date was changed. |
-
diff --git a/doc/models/subscription-event.md b/doc/models/subscription-event.md
deleted file mode 100644
index cb3dc9b5..00000000
--- a/doc/models/subscription-event.md
+++ /dev/null
@@ -1,51 +0,0 @@
-
-# Subscription Event
-
-Describes changes to a subscription and the subscription status.
-
-## Structure
-
-`SubscriptionEvent`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `string` | Required | The ID of the subscription event. | getId(): string | setId(string id): void |
-| `subscriptionEventType` | [`string(SubscriptionEventSubscriptionEventType)`](../../doc/models/subscription-event-subscription-event-type.md) | Required | Supported types of an event occurred to a subscription. | getSubscriptionEventType(): string | setSubscriptionEventType(string subscriptionEventType): void |
-| `effectiveDate` | `string` | Required | The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) when the subscription event occurred. | getEffectiveDate(): string | setEffectiveDate(string effectiveDate): void |
-| `monthlyBillingAnchorDate` | `?int` | Optional | The day-of-the-month the billing anchor date was changed to, if applicable. | getMonthlyBillingAnchorDate(): ?int | setMonthlyBillingAnchorDate(?int monthlyBillingAnchorDate): void |
-| `info` | [`?SubscriptionEventInfo`](../../doc/models/subscription-event-info.md) | Optional | Provides information about the subscription event. | getInfo(): ?SubscriptionEventInfo | setInfo(?SubscriptionEventInfo info): void |
-| `phases` | [`?(Phase[])`](../../doc/models/phase.md) | Optional | A list of Phases, to pass phase-specific information used in the swap. | getPhases(): ?array | setPhases(?array phases): void |
-| `planVariationId` | `string` | Required | The ID of the subscription plan variation associated with the subscription. | getPlanVariationId(): string | setPlanVariationId(string planVariationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id6",
- "subscription_event_type": "RESUME_SUBSCRIPTION",
- "effective_date": "effective_date4",
- "monthly_billing_anchor_date": 54,
- "info": {
- "detail": "detail6",
- "code": "CUSTOMER_DELETED"
- },
- "phases": [
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- },
- {
- "uid": "uid0",
- "ordinal": 78,
- "order_template_id": "order_template_id2",
- "plan_phase_uid": "plan_phase_uid6"
- }
- ],
- "plan_variation_id": "plan_variation_id0"
-}
-```
-
diff --git a/doc/models/subscription-phase.md b/doc/models/subscription-phase.md
deleted file mode 100644
index e0f214c9..00000000
--- a/doc/models/subscription-phase.md
+++ /dev/null
@@ -1,46 +0,0 @@
-
-# Subscription Phase
-
-Describes a phase in a subscription plan variation. For more information, see [Subscription Plans and Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).
-
-## Structure
-
-`SubscriptionPhase`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `uid` | `?string` | Optional | The Square-assigned ID of the subscription phase. This field cannot be changed after a `SubscriptionPhase` is created. | getUid(): ?string | setUid(?string uid): void |
-| `cadence` | [`string(SubscriptionCadence)`](../../doc/models/subscription-cadence.md) | Required | Determines the billing cadence of a [Subscription](../../doc/models/subscription.md) | getCadence(): string | setCadence(string cadence): void |
-| `periods` | `?int` | Optional | The number of `cadence`s the phase lasts. If not set, the phase never ends. Only the last phase can be indefinite. This field cannot be changed after a `SubscriptionPhase` is created. | getPeriods(): ?int | setPeriods(?int periods): void |
-| `recurringPriceMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getRecurringPriceMoney(): ?Money | setRecurringPriceMoney(?Money recurringPriceMoney): void |
-| `ordinal` | `?int` | Optional | The position this phase appears in the sequence of phases defined for the plan, indexed from 0. This field cannot be changed after a `SubscriptionPhase` is created. | getOrdinal(): ?int | setOrdinal(?int ordinal): void |
-| `pricing` | [`?SubscriptionPricing`](../../doc/models/subscription-pricing.md) | Optional | Describes the pricing for the subscription. | getPricing(): ?SubscriptionPricing | setPricing(?SubscriptionPricing pricing): void |
-
-## Example (as JSON)
-
-```json
-{
- "uid": "uid2",
- "cadence": "EVERY_SIX_MONTHS",
- "periods": 36,
- "recurring_price_money": {
- "amount": 66,
- "currency": "ZMW"
- },
- "ordinal": 2,
- "pricing": {
- "type": "STATIC",
- "discount_ids": [
- "discount_ids5",
- "discount_ids6"
- ],
- "price_money": {
- "amount": 202,
- "currency": "GTQ"
- }
- }
-}
-```
-
diff --git a/doc/models/subscription-pricing-type.md b/doc/models/subscription-pricing-type.md
deleted file mode 100644
index 105aa699..00000000
--- a/doc/models/subscription-pricing-type.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Subscription Pricing Type
-
-Determines the pricing of a [Subscription](../../doc/models/subscription.md)
-
-## Enumeration
-
-`SubscriptionPricingType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `STATIC` | Static pricing |
-| `RELATIVE` | Relative pricing |
-
diff --git a/doc/models/subscription-pricing.md b/doc/models/subscription-pricing.md
deleted file mode 100644
index d3c78640..00000000
--- a/doc/models/subscription-pricing.md
+++ /dev/null
@@ -1,33 +0,0 @@
-
-# Subscription Pricing
-
-Describes the pricing for the subscription.
-
-## Structure
-
-`SubscriptionPricing`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `type` | [`?string(SubscriptionPricingType)`](../../doc/models/subscription-pricing-type.md) | Optional | Determines the pricing of a [Subscription](../../doc/models/subscription.md) | getType(): ?string | setType(?string type): void |
-| `discountIds` | `?(string[])` | Optional | The ids of the discount catalog objects | getDiscountIds(): ?array | setDiscountIds(?array discountIds): void |
-| `priceMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getPriceMoney(): ?Money | setPriceMoney(?Money priceMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "type": "STATIC",
- "discount_ids": [
- "discount_ids9",
- "discount_ids0"
- ],
- "price_money": {
- "amount": 202,
- "currency": "GTQ"
- }
-}
-```
-
diff --git a/doc/models/subscription-source.md b/doc/models/subscription-source.md
deleted file mode 100644
index 331ad387..00000000
--- a/doc/models/subscription-source.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Subscription Source
-
-The origination details of the subscription.
-
-## Structure
-
-`SubscriptionSource`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `name` | `?string` | Optional | The name used to identify the place (physical or digital) that
a subscription originates. If unset, the name defaults to the name
of the application that created the subscription.
**Constraints**: *Maximum Length*: `255` | getName(): ?string | setName(?string name): void |
-
-## Example (as JSON)
-
-```json
-{
- "name": "name0"
-}
-```
-
diff --git a/doc/models/subscription-status.md b/doc/models/subscription-status.md
deleted file mode 100644
index 8693d786..00000000
--- a/doc/models/subscription-status.md
+++ /dev/null
@@ -1,19 +0,0 @@
-
-# Subscription Status
-
-Supported subscription statuses.
-
-## Enumeration
-
-`SubscriptionStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `PENDING` | The subscription is pending to start in the future. |
-| `ACTIVE` | The subscription is active. |
-| `CANCELED` | The subscription is canceled. |
-| `DEACTIVATED` | The subscription is deactivated. |
-| `PAUSED` | The subscription is paused. |
-
diff --git a/doc/models/subscription-test-result.md b/doc/models/subscription-test-result.md
deleted file mode 100644
index a2150633..00000000
--- a/doc/models/subscription-test-result.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Subscription Test Result
-
-Represents the details of a webhook subscription, including notification URL,
-event types, and signature key.
-
-## Structure
-
-`SubscriptionTestResult`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A Square-generated unique ID for the subscription test result.
**Constraints**: *Maximum Length*: `64` | getId(): ?string | setId(?string id): void |
-| `statusCode` | `?int` | Optional | The status code returned by the subscription notification URL. | getStatusCode(): ?int | setStatusCode(?int statusCode): void |
-| `payload` | `?string` | Optional | An object containing the payload of the test event. For example, a `payment.created` event. | getPayload(): ?string | setPayload(?string payload): void |
-| `createdAt` | `?string` | Optional | The timestamp of when the subscription was created, in RFC 3339 format.
For example, "2016-09-04T23:59:33.123Z". | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp of when the subscription was updated, in RFC 3339 format. For example, "2016-09-04T23:59:33.123Z".
Because a subscription test result is unique, this field is the same as the `created_at` field. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id0",
- "status_code": 208,
- "payload": "payload6",
- "created_at": "created_at8",
- "updated_at": "updated_at4"
-}
-```
-
diff --git a/doc/models/subscription.md b/doc/models/subscription.md
deleted file mode 100644
index 75e12179..00000000
--- a/doc/models/subscription.md
+++ /dev/null
@@ -1,48 +0,0 @@
-
-# Subscription
-
-Represents a subscription purchased by a customer.
-
-For more information, see
-[Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions).
-
-## Structure
-
-`Subscription`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The Square-assigned ID of the subscription.
**Constraints**: *Maximum Length*: `255` | getId(): ?string | setId(?string id): void |
-| `locationId` | `?string` | Optional | The ID of the location associated with the subscription. | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `planVariationId` | `?string` | Optional | The ID of the subscribed-to [subscription plan variation](entity:CatalogSubscriptionPlanVariation). | getPlanVariationId(): ?string | setPlanVariationId(?string planVariationId): void |
-| `customerId` | `?string` | Optional | The ID of the subscribing [customer](entity:Customer) profile. | getCustomerId(): ?string | setCustomerId(?string customerId): void |
-| `startDate` | `?string` | Optional | The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to start the subscription. | getStartDate(): ?string | setStartDate(?string startDate): void |
-| `canceledDate` | `?string` | Optional | The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to cancel the subscription,
when the subscription status changes to `CANCELED` and the subscription billing stops.
If this field is not set, the subscription ends according its subscription plan.
This field cannot be updated, other than being cleared. | getCanceledDate(): ?string | setCanceledDate(?string canceledDate): void |
-| `chargedThroughDate` | `?string` | Optional | The `YYYY-MM-DD`-formatted date up to when the subscriber is invoiced for the
subscription.
After the invoice is sent for a given billing period,
this date will be the last day of the billing period.
For example,
suppose for the month of May a subscriber gets an invoice
(or charged the card) on May 1. For the monthly billing scenario,
this date is then set to May 31. | getChargedThroughDate(): ?string | setChargedThroughDate(?string chargedThroughDate): void |
-| `status` | [`?string(SubscriptionStatus)`](../../doc/models/subscription-status.md) | Optional | Supported subscription statuses. | getStatus(): ?string | setStatus(?string status): void |
-| `taxPercentage` | `?string` | Optional | The tax amount applied when billing the subscription. The
percentage is expressed in decimal form, using a `'.'` as the decimal
separator and without a `'%'` sign. For example, a value of `7.5`
corresponds to 7.5%. | getTaxPercentage(): ?string | setTaxPercentage(?string taxPercentage): void |
-| `invoiceIds` | `?(string[])` | Optional | The IDs of the [invoices](entity:Invoice) created for the
subscription, listed in order when the invoices were created
(newest invoices appear first). | getInvoiceIds(): ?array | setInvoiceIds(?array invoiceIds): void |
-| `priceOverrideMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getPriceOverrideMoney(): ?Money | setPriceOverrideMoney(?Money priceOverrideMoney): void |
-| `version` | `?int` | Optional | 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. | getVersion(): ?int | setVersion(?int version): void |
-| `createdAt` | `?string` | Optional | The timestamp when the subscription was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `cardId` | `?string` | Optional | The ID of the [subscriber's](entity:Customer) [card](entity:Card)
used to charge for the subscription. | getCardId(): ?string | setCardId(?string cardId): void |
-| `timezone` | `?string` | Optional | Timezone that will be used in date calculations for the subscription.
Defaults to the timezone of the location based on `location_id`.
Format: the IANA Timezone Database identifier for the location timezone (for example, `America/Los_Angeles`). | getTimezone(): ?string | setTimezone(?string timezone): void |
-| `source` | [`?SubscriptionSource`](../../doc/models/subscription-source.md) | Optional | The origination details of the subscription. | getSource(): ?SubscriptionSource | setSource(?SubscriptionSource source): void |
-| `actions` | [`?(SubscriptionAction[])`](../../doc/models/subscription-action.md) | Optional | The list of scheduled actions on this subscription. It is set only in the response from
[RetrieveSubscription](../../doc/apis/subscriptions.md#retrieve-subscription) with the query parameter
of `include=actions` or from
[SearchSubscriptions](../../doc/apis/subscriptions.md#search-subscriptions) with the input parameter
of `include:["actions"]`. | getActions(): ?array | setActions(?array actions): void |
-| `monthlyBillingAnchorDate` | `?int` | Optional | The day of the month on which the subscription will issue invoices and publish orders. | getMonthlyBillingAnchorDate(): ?int | setMonthlyBillingAnchorDate(?int monthlyBillingAnchorDate): void |
-| `phases` | [`?(Phase[])`](../../doc/models/phase.md) | Optional | array of phases for this subscription | getPhases(): ?array | setPhases(?array phases): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id4",
- "location_id": "location_id8",
- "plan_variation_id": "plan_variation_id8",
- "customer_id": "customer_id2",
- "start_date": "start_date8"
-}
-```
-
diff --git a/doc/models/swap-plan-request.md b/doc/models/swap-plan-request.md
deleted file mode 100644
index 696eb972..00000000
--- a/doc/models/swap-plan-request.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Swap Plan Request
-
-Defines input parameters in a call to the
-[SwapPlan](../../doc/apis/subscriptions.md#swap-plan) endpoint.
-
-## Structure
-
-`SwapPlanRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `newPlanVariationId` | `?string` | Optional | The ID of the new subscription plan variation.
This field is required. | getNewPlanVariationId(): ?string | setNewPlanVariationId(?string newPlanVariationId): void |
-| `phases` | [`?(PhaseInput[])`](../../doc/models/phase-input.md) | Optional | A list of PhaseInputs, to pass phase-specific information used in the swap. | getPhases(): ?array | setPhases(?array phases): void |
-
-## Example (as JSON)
-
-```json
-{
- "new_plan_variation_id": "FQ7CDXXWSLUJRPM3GFJSJGZ7",
- "phases": [
- {
- "order_template_id": "uhhnjH9osVv3shUADwaC0b3hNxQZY",
- "ordinal": 0
- }
- ]
-}
-```
-
diff --git a/doc/models/swap-plan-response.md b/doc/models/swap-plan-response.md
deleted file mode 100644
index b644e5be..00000000
--- a/doc/models/swap-plan-response.md
+++ /dev/null
@@ -1,88 +0,0 @@
-
-# Swap Plan Response
-
-Defines output parameters in a response of the
-[SwapPlan](../../doc/apis/subscriptions.md#swap-plan) endpoint.
-
-## Structure
-
-`SwapPlanResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `subscription` | [`?Subscription`](../../doc/models/subscription.md) | Optional | Represents a subscription purchased by a customer.
For more information, see
[Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions). | getSubscription(): ?Subscription | setSubscription(?Subscription subscription): void |
-| `actions` | [`?(SubscriptionAction[])`](../../doc/models/subscription-action.md) | Optional | A list of a `SWAP_PLAN` action created by the request. | getActions(): ?array | setActions(?array actions): void |
-
-## Example (as JSON)
-
-```json
-{
- "actions": [
- {
- "effective_date": "2023-11-17",
- "id": "f0a1dfdc-675b-3a14-a640-99f7ac1cee83",
- "new_plan_variation_id": "FQ7CDXXWSLUJRPM3GFJSJGZ7",
- "phases": [
- {
- "order_template_id": "uhhnjH9osVv3shUADwaC0b3hNxQZY",
- "ordinal": 0,
- "uid": "uid0",
- "plan_phase_uid": "plan_phase_uid6"
- }
- ],
- "type": "SWAP_PLAN",
- "monthly_billing_anchor_date": 186
- }
- ],
- "subscription": {
- "created_at": "2023-06-20T21:53:10Z",
- "customer_id": "CHFGVKYY8RSV93M5KCYTG4PN0G",
- "id": "9ba40961-995a-4a3d-8c53-048c40cafc13",
- "location_id": "S8GWD5R9QB376",
- "phases": [
- {
- "order_template_id": "E6oBY5WfQ2eN4pkYZwq4ka6n7KeZY",
- "ordinal": 0,
- "plan_phase_uid": "C66BKH3ASTDYGJJCEZXQQSS7",
- "uid": "98d6f53b-40e1-4714-8827-032fd923be25"
- }
- ],
- "plan_variation_id": "FQ7CDXXWSLUJRPM3GFJSJGZ7",
- "price_override_money": {
- "amount": 2000,
- "currency": "USD"
- },
- "source": {
- "name": "My Application"
- },
- "status": "ACTIVE",
- "timezone": "America/Los_Angeles",
- "version": 3,
- "start_date": "start_date8"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/tax-calculation-phase.md b/doc/models/tax-calculation-phase.md
deleted file mode 100644
index 314d812b..00000000
--- a/doc/models/tax-calculation-phase.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Tax Calculation Phase
-
-When to calculate the taxes due on a cart.
-
-## Enumeration
-
-`TaxCalculationPhase`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `TAX_SUBTOTAL_PHASE` | The fee is calculated based on the payment's subtotal. |
-| `TAX_TOTAL_PHASE` | The fee is calculated based on the payment's total. |
-
diff --git a/doc/models/tax-ids.md b/doc/models/tax-ids.md
deleted file mode 100644
index 2bf86782..00000000
--- a/doc/models/tax-ids.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Tax Ids
-
-Identifiers for the location used by various governments for tax purposes.
-
-## Structure
-
-`TaxIds`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `euVat` | `?string` | Optional | The EU VAT number for this location. For example, `IE3426675K`.
If the EU VAT number is present, it is well-formed and has been
validated with VIES, the VAT Information Exchange System. | getEuVat(): ?string | setEuVat(?string euVat): void |
-| `frSiret` | `?string` | Optional | The SIRET (Système d'Identification du Répertoire des Entreprises et de leurs Etablissements)
number is a 14-digit code issued by the French INSEE. For example, `39922799000021`. | getFrSiret(): ?string | setFrSiret(?string frSiret): void |
-| `frNaf` | `?string` | Optional | The French government uses the NAF (Nomenclature des Activités Françaises) to display and
track economic statistical data. This is also called the APE (Activite Principale de l’Entreprise) code.
For example, `6910Z`. | getFrNaf(): ?string | setFrNaf(?string frNaf): void |
-| `esNif` | `?string` | Optional | The NIF (Numero de Identificacion Fiscal) number is a nine-character tax identifier used in Spain.
If it is present, it has been validated. For example, `73628495A`. | getEsNif(): ?string | setEsNif(?string esNif): void |
-| `jpQii` | `?string` | Optional | The QII (Qualified Invoice Issuer) number is a 14-character tax identifier used in Japan.
For example, `T1234567890123`. | getJpQii(): ?string | setJpQii(?string jpQii): void |
-
-## Example (as JSON)
-
-```json
-{
- "eu_vat": "eu_vat8",
- "fr_siret": "fr_siret0",
- "fr_naf": "fr_naf0",
- "es_nif": "es_nif4",
- "jp_qii": "jp_qii0"
-}
-```
-
diff --git a/doc/models/tax-inclusion-type.md b/doc/models/tax-inclusion-type.md
deleted file mode 100644
index d8f3c0d7..00000000
--- a/doc/models/tax-inclusion-type.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Tax Inclusion Type
-
-Whether to the tax amount should be additional to or included in the CatalogItem price.
-
-## Enumeration
-
-`TaxInclusionType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ADDITIVE` | The tax is an additive tax. The tax amount is added on top of the
CatalogItemVariation price. For example, a $1.00 item with a 10% additive
tax would have a total cost to the buyer of $1.10. |
-| `INCLUSIVE` | The tax is an inclusive tax. The tax amount is included in the
CatalogItemVariation price. For example, a $1.00 item with a 10% inclusive
tax would have a total cost to the buyer of $1.00, with $0.91 (91 cents) of
that total being the cost of the item and $0.09 (9 cents) being tax. |
-
diff --git a/doc/models/team-member-assigned-locations-assignment-type.md b/doc/models/team-member-assigned-locations-assignment-type.md
deleted file mode 100644
index 6f582ec6..00000000
--- a/doc/models/team-member-assigned-locations-assignment-type.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Team Member Assigned Locations Assignment Type
-
-Enumerates the possible assignment types that the team member can have.
-
-## Enumeration
-
-`TeamMemberAssignedLocationsAssignmentType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ALL_CURRENT_AND_FUTURE_LOCATIONS` | The team member is assigned to all current and future locations. The `location_ids` field
is empty if the team member has this assignment type. |
-| `EXPLICIT_LOCATIONS` | The team member is assigned to an explicit subset of locations. The `location_ids` field
is the list of locations that the team member is assigned to. |
-
diff --git a/doc/models/team-member-assigned-locations.md b/doc/models/team-member-assigned-locations.md
deleted file mode 100644
index 729d1118..00000000
--- a/doc/models/team-member-assigned-locations.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# Team Member Assigned Locations
-
-An object that represents a team member's assignment to locations.
-
-## Structure
-
-`TeamMemberAssignedLocations`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `assignmentType` | [`?string(TeamMemberAssignedLocationsAssignmentType)`](../../doc/models/team-member-assigned-locations-assignment-type.md) | Optional | Enumerates the possible assignment types that the team member can have. | getAssignmentType(): ?string | setAssignmentType(?string assignmentType): void |
-| `locationIds` | `?(string[])` | Optional | The explicit locations that the team member is assigned to. | getLocationIds(): ?array | setLocationIds(?array locationIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS",
- "location_ids": [
- "location_ids4",
- "location_ids5"
- ]
-}
-```
-
diff --git a/doc/models/team-member-booking-profile.md b/doc/models/team-member-booking-profile.md
deleted file mode 100644
index 395d82b2..00000000
--- a/doc/models/team-member-booking-profile.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Team Member Booking Profile
-
-The booking profile of a seller's team member, including the team member's ID, display name, description and whether the team member can be booked as a service provider.
-
-## Structure
-
-`TeamMemberBookingProfile`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `teamMemberId` | `?string` | Optional | The ID of the [TeamMember](entity:TeamMember) object for the team member associated with the booking profile.
**Constraints**: *Maximum Length*: `32` | getTeamMemberId(): ?string | setTeamMemberId(?string teamMemberId): void |
-| `description` | `?string` | Optional | The description of the team member.
**Constraints**: *Maximum Length*: `65536` | getDescription(): ?string | setDescription(?string description): void |
-| `displayName` | `?string` | Optional | The display name of the team member.
**Constraints**: *Maximum Length*: `512` | getDisplayName(): ?string | setDisplayName(?string displayName): void |
-| `isBookable` | `?bool` | Optional | Indicates whether the team member can be booked through the Bookings API or the seller's online booking channel or site (`true`) or not (`false`). | getIsBookable(): ?bool | setIsBookable(?bool isBookable): void |
-| `profileImageUrl` | `?string` | Optional | The URL of the team member's image for the bookings profile.
**Constraints**: *Maximum Length*: `2048` | getProfileImageUrl(): ?string | setProfileImageUrl(?string profileImageUrl): void |
-
-## Example (as JSON)
-
-```json
-{
- "team_member_id": "team_member_id0",
- "description": "description0",
- "display_name": "display_name0",
- "is_bookable": false,
- "profile_image_url": "profile_image_url6"
-}
-```
-
diff --git a/doc/models/team-member-invitation-status.md b/doc/models/team-member-invitation-status.md
deleted file mode 100644
index cd18b4cb..00000000
--- a/doc/models/team-member-invitation-status.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Team Member Invitation Status
-
-Enumerates the possible invitation statuses the team member can have within a business.
-
-## Enumeration
-
-`TeamMemberInvitationStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `UNINVITED` | The team member has not received an invitation. |
-| `PENDING` | The team member has received an invitation, but had not accepted it. |
-| `ACCEPTED` | The team member has both received and accepted an invitation. |
-
diff --git a/doc/models/team-member-status.md b/doc/models/team-member-status.md
deleted file mode 100644
index 93dacc25..00000000
--- a/doc/models/team-member-status.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Team Member Status
-
-Enumerates the possible statuses the team member can have within a business.
-
-## Enumeration
-
-`TeamMemberStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ACTIVE` | The team member can sign in to Point of Sale and the Seller Dashboard. |
-| `INACTIVE` | The team member can no longer sign in to Point of Sale or the Seller Dashboard,
but the team member's sales reports remain available. |
-
diff --git a/doc/models/team-member-wage.md b/doc/models/team-member-wage.md
deleted file mode 100644
index 724e6a43..00000000
--- a/doc/models/team-member-wage.md
+++ /dev/null
@@ -1,36 +0,0 @@
-
-# Team Member Wage
-
-The hourly wage rate that a team member earns on a `Shift` for doing the job
-specified by the `title` property of this object.
-
-## Structure
-
-`TeamMemberWage`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The UUID for this object. | getId(): ?string | setId(?string id): void |
-| `teamMemberId` | `?string` | Optional | The `TeamMember` that this wage is assigned to. | getTeamMemberId(): ?string | setTeamMemberId(?string teamMemberId): void |
-| `title` | `?string` | Optional | The job title that this wage relates to. | getTitle(): ?string | setTitle(?string title): void |
-| `hourlyRate` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getHourlyRate(): ?Money | setHourlyRate(?Money hourlyRate): void |
-| `jobId` | `?string` | Optional | An identifier for the job that this wage relates to. This cannot be
used to retrieve the job. | getJobId(): ?string | setJobId(?string jobId): void |
-| `tipEligible` | `?bool` | Optional | Whether team members are eligible for tips when working this job. | getTipEligible(): ?bool | setTipEligible(?bool tipEligible): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id2",
- "team_member_id": "team_member_id2",
- "title": "title8",
- "hourly_rate": {
- "amount": 172,
- "currency": "LAK"
- },
- "job_id": "job_id0"
-}
-```
-
diff --git a/doc/models/team-member.md b/doc/models/team-member.md
deleted file mode 100644
index 9a9b2cb1..00000000
--- a/doc/models/team-member.md
+++ /dev/null
@@ -1,38 +0,0 @@
-
-# Team Member
-
-A record representing an individual team member for a business.
-
-## Structure
-
-`TeamMember`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The unique ID for the team member. | getId(): ?string | setId(?string id): void |
-| `referenceId` | `?string` | Optional | A second ID used to associate the team member with an entity in another system. | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `isOwner` | `?bool` | Optional | Whether the team member is the owner of the Square account. | getIsOwner(): ?bool | setIsOwner(?bool isOwner): void |
-| `status` | [`?string(TeamMemberStatus)`](../../doc/models/team-member-status.md) | Optional | Enumerates the possible statuses the team member can have within a business. | getStatus(): ?string | setStatus(?string status): void |
-| `givenName` | `?string` | Optional | The given name (that is, the first name) associated with the team member. | getGivenName(): ?string | setGivenName(?string givenName): void |
-| `familyName` | `?string` | Optional | The family name (that is, the last name) associated with the team member. | getFamilyName(): ?string | setFamilyName(?string familyName): void |
-| `emailAddress` | `?string` | Optional | The email address associated with the team member. After accepting the invitation
from Square, only the team member can change this value. | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void |
-| `phoneNumber` | `?string` | Optional | The team member's phone number, in E.164 format. For example:
+14155552671 - the country code is 1 for US
+551155256325 - the country code is 55 for BR | getPhoneNumber(): ?string | setPhoneNumber(?string phoneNumber): void |
-| `createdAt` | `?string` | Optional | The timestamp when the team member was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp when the team member was last updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `assignedLocations` | [`?TeamMemberAssignedLocations`](../../doc/models/team-member-assigned-locations.md) | Optional | An object that represents a team member's assignment to locations. | getAssignedLocations(): ?TeamMemberAssignedLocations | setAssignedLocations(?TeamMemberAssignedLocations assignedLocations): void |
-| `wageSetting` | [`?WageSetting`](../../doc/models/wage-setting.md) | Optional | Represents information about the overtime exemption status, job assignments, and compensation
for a [team member](../../doc/models/team-member.md). | getWageSetting(): ?WageSetting | setWageSetting(?WageSetting wageSetting): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id4",
- "reference_id": "reference_id8",
- "is_owner": false,
- "status": "ACTIVE",
- "given_name": "given_name6"
-}
-```
-
diff --git a/doc/models/tender-bank-account-details-status.md b/doc/models/tender-bank-account-details-status.md
deleted file mode 100644
index 29b0c1f1..00000000
--- a/doc/models/tender-bank-account-details-status.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Tender Bank Account Details Status
-
-Indicates the bank account payment's current status.
-
-## Enumeration
-
-`TenderBankAccountDetailsStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `PENDING` | The bank account payment is in progress. |
-| `COMPLETED` | The bank account payment has been completed. |
-| `FAILED` | The bank account payment failed. |
-
diff --git a/doc/models/tender-bank-account-details.md b/doc/models/tender-bank-account-details.md
deleted file mode 100644
index 6b0059cd..00000000
--- a/doc/models/tender-bank-account-details.md
+++ /dev/null
@@ -1,26 +0,0 @@
-
-# Tender Bank Account Details
-
-Represents the details of a tender with `type` `BANK_ACCOUNT`.
-
-See [BankAccountPaymentDetails](../../doc/models/bank-account-payment-details.md)
-for more exposed details of a bank account payment.
-
-## Structure
-
-`TenderBankAccountDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `status` | [`?string(TenderBankAccountDetailsStatus)`](../../doc/models/tender-bank-account-details-status.md) | Optional | Indicates the bank account payment's current status. | getStatus(): ?string | setStatus(?string status): void |
-
-## Example (as JSON)
-
-```json
-{
- "status": "FAILED"
-}
-```
-
diff --git a/doc/models/tender-buy-now-pay-later-details-brand.md b/doc/models/tender-buy-now-pay-later-details-brand.md
deleted file mode 100644
index 49e6ff57..00000000
--- a/doc/models/tender-buy-now-pay-later-details-brand.md
+++ /dev/null
@@ -1,14 +0,0 @@
-
-# Tender Buy Now Pay Later Details Brand
-
-## Enumeration
-
-`TenderBuyNowPayLaterDetailsBrand`
-
-## Fields
-
-| Name |
-| --- |
-| `OTHER_BRAND` |
-| `AFTERPAY` |
-
diff --git a/doc/models/tender-buy-now-pay-later-details-status.md b/doc/models/tender-buy-now-pay-later-details-status.md
deleted file mode 100644
index 2dacca32..00000000
--- a/doc/models/tender-buy-now-pay-later-details-status.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Tender Buy Now Pay Later Details Status
-
-## Enumeration
-
-`TenderBuyNowPayLaterDetailsStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `AUTHORIZED` | The buy now pay later payment has been authorized but not yet captured. |
-| `CAPTURED` | The buy now pay later payment was authorized and subsequently captured (i.e., completed). |
-| `VOIDED` | The buy now pay later payment was authorized and subsequently voided (i.e., canceled). |
-| `FAILED` | The buy now pay later payment failed. |
-
diff --git a/doc/models/tender-buy-now-pay-later-details.md b/doc/models/tender-buy-now-pay-later-details.md
deleted file mode 100644
index d0d3e5ed..00000000
--- a/doc/models/tender-buy-now-pay-later-details.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# Tender Buy Now Pay Later Details
-
-Represents the details of a tender with `type` `BUY_NOW_PAY_LATER`.
-
-## Structure
-
-`TenderBuyNowPayLaterDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `buyNowPayLaterBrand` | [`?string(TenderBuyNowPayLaterDetailsBrand)`](../../doc/models/tender-buy-now-pay-later-details-brand.md) | Optional | - | getBuyNowPayLaterBrand(): ?string | setBuyNowPayLaterBrand(?string buyNowPayLaterBrand): void |
-| `status` | [`?string(TenderBuyNowPayLaterDetailsStatus)`](../../doc/models/tender-buy-now-pay-later-details-status.md) | Optional | - | getStatus(): ?string | setStatus(?string status): void |
-
-## Example (as JSON)
-
-```json
-{
- "buy_now_pay_later_brand": "OTHER_BRAND",
- "status": "AUTHORIZED"
-}
-```
-
diff --git a/doc/models/tender-card-details-entry-method.md b/doc/models/tender-card-details-entry-method.md
deleted file mode 100644
index 24603553..00000000
--- a/doc/models/tender-card-details-entry-method.md
+++ /dev/null
@@ -1,19 +0,0 @@
-
-# Tender Card Details Entry Method
-
-Indicates the method used to enter the card's details.
-
-## Enumeration
-
-`TenderCardDetailsEntryMethod`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `SWIPED` | The card was swiped through a Square reader or Square stand. |
-| `KEYED` | The card information was keyed manually into Square Point of Sale or a
Square-hosted web form. |
-| `EMV` | The card was processed via EMV with a Square reader. |
-| `ON_FILE` | The buyer's card details were already on file with Square. |
-| `CONTACTLESS` | The card was processed via a contactless (i.e., NFC) transaction
with a Square reader. |
-
diff --git a/doc/models/tender-card-details-status.md b/doc/models/tender-card-details-status.md
deleted file mode 100644
index fe05323a..00000000
--- a/doc/models/tender-card-details-status.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# Tender Card Details Status
-
-Indicates the card transaction's current status.
-
-## Enumeration
-
-`TenderCardDetailsStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `AUTHORIZED` | The card transaction has been authorized but not yet captured. |
-| `CAPTURED` | The card transaction was authorized and subsequently captured (i.e., completed). |
-| `VOIDED` | The card transaction was authorized and subsequently voided (i.e., canceled). |
-| `FAILED` | The card transaction failed. |
-
diff --git a/doc/models/tender-card-details.md b/doc/models/tender-card-details.md
deleted file mode 100644
index bf80866b..00000000
--- a/doc/models/tender-card-details.md
+++ /dev/null
@@ -1,33 +0,0 @@
-
-# Tender Card Details
-
-Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD`
-
-## Structure
-
-`TenderCardDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `status` | [`?string(TenderCardDetailsStatus)`](../../doc/models/tender-card-details-status.md) | Optional | Indicates the card transaction's current status. | getStatus(): ?string | setStatus(?string status): void |
-| `card` | [`?Card`](../../doc/models/card.md) | Optional | Represents the payment details of a card to be used for payments. These
details are determined by the payment token generated by Web Payments SDK. | getCard(): ?Card | setCard(?Card card): void |
-| `entryMethod` | [`?string(TenderCardDetailsEntryMethod)`](../../doc/models/tender-card-details-entry-method.md) | Optional | Indicates the method used to enter the card's details. | getEntryMethod(): ?string | setEntryMethod(?string entryMethod): void |
-
-## Example (as JSON)
-
-```json
-{
- "status": "VOIDED",
- "card": {
- "id": "id6",
- "card_brand": "OTHER_BRAND",
- "last_4": "last_48",
- "exp_month": 228,
- "exp_year": 68
- },
- "entry_method": "CONTACTLESS"
-}
-```
-
diff --git a/doc/models/tender-cash-details.md b/doc/models/tender-cash-details.md
deleted file mode 100644
index 4be002c6..00000000
--- a/doc/models/tender-cash-details.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# Tender Cash Details
-
-Represents the details of a tender with `type` `CASH`.
-
-## Structure
-
-`TenderCashDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `buyerTenderedMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getBuyerTenderedMoney(): ?Money | setBuyerTenderedMoney(?Money buyerTenderedMoney): void |
-| `changeBackMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getChangeBackMoney(): ?Money | setChangeBackMoney(?Money changeBackMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "buyer_tendered_money": {
- "amount": 238,
- "currency": "XOF"
- },
- "change_back_money": {
- "amount": 78,
- "currency": "XBD"
- }
-}
-```
-
diff --git a/doc/models/tender-square-account-details-status.md b/doc/models/tender-square-account-details-status.md
deleted file mode 100644
index 8c46abdf..00000000
--- a/doc/models/tender-square-account-details-status.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Tender Square Account Details Status
-
-## Enumeration
-
-`TenderSquareAccountDetailsStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `AUTHORIZED` | The Square Account payment has been authorized but not yet captured. |
-| `CAPTURED` | The Square Account payment was authorized and subsequently captured (i.e., completed). |
-| `VOIDED` | The Square Account payment was authorized and subsequently voided (i.e., canceled). |
-| `FAILED` | The Square Account payment failed. |
-
diff --git a/doc/models/tender-square-account-details.md b/doc/models/tender-square-account-details.md
deleted file mode 100644
index 83713689..00000000
--- a/doc/models/tender-square-account-details.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Tender Square Account Details
-
-Represents the details of a tender with `type` `SQUARE_ACCOUNT`.
-
-## Structure
-
-`TenderSquareAccountDetails`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `status` | [`?string(TenderSquareAccountDetailsStatus)`](../../doc/models/tender-square-account-details-status.md) | Optional | - | getStatus(): ?string | setStatus(?string status): void |
-
-## Example (as JSON)
-
-```json
-{
- "status": "AUTHORIZED"
-}
-```
-
diff --git a/doc/models/tender-type.md b/doc/models/tender-type.md
deleted file mode 100644
index 6771990f..00000000
--- a/doc/models/tender-type.md
+++ /dev/null
@@ -1,24 +0,0 @@
-
-# Tender Type
-
-Indicates a tender's type.
-
-## Enumeration
-
-`TenderType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `CARD` | A credit card. |
-| `CASH` | Cash. |
-| `THIRD_PARTY_CARD` | A credit card processed with a card processor other than Square.
This value applies only to merchants in countries where Square does not
yet provide card processing. |
-| `SQUARE_GIFT_CARD` | A Square gift card. |
-| `NO_SALE` | This tender represents the register being opened for a "no sale" event. |
-| `BANK_ACCOUNT` | A bank account payment. |
-| `WALLET` | A payment from a digital wallet, e.g. Cash App, Paypay, Rakuten Pay,
Au Pay, D Barai, Merpay, Wechat Pay, Alipay.
Note: Some "digital wallets", including Google Pay and Apple Pay, facilitate
card payments. Those payments have the `CARD` type. |
-| `BUY_NOW_PAY_LATER` | A Buy Now Pay Later payment. |
-| `SQUARE_ACCOUNT` | A Square House Account payment. |
-| `OTHER` | A form of tender that does not match any other value. |
-
diff --git a/doc/models/tender.md b/doc/models/tender.md
deleted file mode 100644
index b4a493f2..00000000
--- a/doc/models/tender.md
+++ /dev/null
@@ -1,44 +0,0 @@
-
-# Tender
-
-Represents a tender (i.e., a method of payment) used in a Square transaction.
-
-## Structure
-
-`Tender`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The tender's unique ID. It is the associated payment ID.
**Constraints**: *Maximum Length*: `192` | getId(): ?string | setId(?string id): void |
-| `locationId` | `?string` | Optional | The ID of the transaction's associated location.
**Constraints**: *Maximum Length*: `50` | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `transactionId` | `?string` | Optional | The ID of the tender's associated transaction.
**Constraints**: *Maximum Length*: `192` | getTransactionId(): ?string | setTransactionId(?string transactionId): void |
-| `createdAt` | `?string` | Optional | The timestamp for when the tender was created, in RFC 3339 format.
**Constraints**: *Maximum Length*: `32` | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `note` | `?string` | Optional | An optional note associated with the tender at the time of payment.
**Constraints**: *Maximum Length*: `500` | getNote(): ?string | setNote(?string note): void |
-| `amountMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): ?Money | setAmountMoney(?Money amountMoney): void |
-| `tipMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTipMoney(): ?Money | setTipMoney(?Money tipMoney): void |
-| `processingFeeMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getProcessingFeeMoney(): ?Money | setProcessingFeeMoney(?Money processingFeeMoney): void |
-| `customerId` | `?string` | Optional | If the tender is associated with a customer or represents a customer's card on file,
this is the ID of the associated customer.
**Constraints**: *Maximum Length*: `191` | getCustomerId(): ?string | setCustomerId(?string customerId): void |
-| `type` | [`string(TenderType)`](../../doc/models/tender-type.md) | Required | Indicates a tender's type. | getType(): string | setType(string type): void |
-| `cardDetails` | [`?TenderCardDetails`](../../doc/models/tender-card-details.md) | Optional | Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD` | getCardDetails(): ?TenderCardDetails | setCardDetails(?TenderCardDetails cardDetails): void |
-| `cashDetails` | [`?TenderCashDetails`](../../doc/models/tender-cash-details.md) | Optional | Represents the details of a tender with `type` `CASH`. | getCashDetails(): ?TenderCashDetails | setCashDetails(?TenderCashDetails cashDetails): void |
-| `bankAccountDetails` | [`?TenderBankAccountDetails`](../../doc/models/tender-bank-account-details.md) | Optional | Represents the details of a tender with `type` `BANK_ACCOUNT`.
See [BankAccountPaymentDetails](../../doc/models/bank-account-payment-details.md)
for more exposed details of a bank account payment. | getBankAccountDetails(): ?TenderBankAccountDetails | setBankAccountDetails(?TenderBankAccountDetails bankAccountDetails): void |
-| `buyNowPayLaterDetails` | [`?TenderBuyNowPayLaterDetails`](../../doc/models/tender-buy-now-pay-later-details.md) | Optional | Represents the details of a tender with `type` `BUY_NOW_PAY_LATER`. | getBuyNowPayLaterDetails(): ?TenderBuyNowPayLaterDetails | setBuyNowPayLaterDetails(?TenderBuyNowPayLaterDetails buyNowPayLaterDetails): void |
-| `squareAccountDetails` | [`?TenderSquareAccountDetails`](../../doc/models/tender-square-account-details.md) | Optional | Represents the details of a tender with `type` `SQUARE_ACCOUNT`. | getSquareAccountDetails(): ?TenderSquareAccountDetails | setSquareAccountDetails(?TenderSquareAccountDetails squareAccountDetails): void |
-| `additionalRecipients` | [`?(AdditionalRecipient[])`](../../doc/models/additional-recipient.md) | Optional | Additional recipients (other than the merchant) receiving a portion of this tender.
For example, fees assessed on the purchase by a third party integration. | getAdditionalRecipients(): ?array | setAdditionalRecipients(?array additionalRecipients): void |
-| `paymentId` | `?string` | Optional | The ID of the [Payment](entity:Payment) that corresponds to this tender.
This value is only present for payments created with the v2 Payments API.
**Constraints**: *Maximum Length*: `192` | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id8",
- "location_id": "location_id2",
- "transaction_id": "transaction_id6",
- "created_at": "created_at6",
- "note": "note4",
- "type": "SQUARE_ACCOUNT"
-}
-```
-
diff --git a/doc/models/terminal-action-action-type.md b/doc/models/terminal-action-action-type.md
deleted file mode 100644
index 09d26ffd..00000000
--- a/doc/models/terminal-action-action-type.md
+++ /dev/null
@@ -1,22 +0,0 @@
-
-# Terminal Action Action Type
-
-Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum.
-
-## Enumeration
-
-`TerminalActionActionType`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `QR_CODE` | The action represents a request to display a QR code. Details are contained in
the `qr_code_options` object. |
-| `PING` | The action represents a request to check if the specific device is
online or currently active with the merchant in question. Does not require an action options value. |
-| `SAVE_CARD` | Represents a request to save a card for future card-on-file use. Details are contained
in the `save_card_options` object. |
-| `SIGNATURE` | The action represents a request to capture a buyer's signature. Details are contained
in the `signature_options` object. |
-| `CONFIRMATION` | The action represents a request to collect a buyer's confirmation decision to the
displayed terms. Details are contained in the `confirmation_options` object. |
-| `RECEIPT` | The action represents a request to display the receipt screen options. Details are
contained in the `receipt_options` object. |
-| `DATA_COLLECTION` | The action represents a request to collect a buyer's text data. Details
are contained in the `data_collection_options` object. |
-| `SELECT` | The action represents a request to allow the buyer to select from provided options.
Details are contained in the `select_options` object. |
-
diff --git a/doc/models/terminal-action-query-filter.md b/doc/models/terminal-action-query-filter.md
deleted file mode 100644
index 84f17d07..00000000
--- a/doc/models/terminal-action-query-filter.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Terminal Action Query Filter
-
-## Structure
-
-`TerminalActionQueryFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `deviceId` | `?string` | Optional | `TerminalAction`s associated with a specific device. If no device is specified then all
`TerminalAction`s for the merchant will be displayed. | getDeviceId(): ?string | setDeviceId(?string deviceId): void |
-| `createdAt` | [`?TimeRange`](../../doc/models/time-range.md) | Optional | Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled. | getCreatedAt(): ?TimeRange | setCreatedAt(?TimeRange createdAt): void |
-| `status` | `?string` | Optional | Filter results with the desired status of the `TerminalAction`
Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` | getStatus(): ?string | setStatus(?string status): void |
-| `type` | [`?string(TerminalActionActionType)`](../../doc/models/terminal-action-action-type.md) | Optional | Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum. | getType(): ?string | setType(?string type): void |
-
-## Example (as JSON)
-
-```json
-{
- "device_id": "device_id4",
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- },
- "status": "status0",
- "type": "DATA_COLLECTION"
-}
-```
-
diff --git a/doc/models/terminal-action-query-sort.md b/doc/models/terminal-action-query-sort.md
deleted file mode 100644
index ab6ebb6d..00000000
--- a/doc/models/terminal-action-query-sort.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Terminal Action Query Sort
-
-## Structure
-
-`TerminalActionQuerySort`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `sortOrder` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-
-## Example (as JSON)
-
-```json
-{
- "sort_order": "DESC"
-}
-```
-
diff --git a/doc/models/terminal-action-query.md b/doc/models/terminal-action-query.md
deleted file mode 100644
index 01daa11a..00000000
--- a/doc/models/terminal-action-query.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-# Terminal Action Query
-
-## Structure
-
-`TerminalActionQuery`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `filter` | [`?TerminalActionQueryFilter`](../../doc/models/terminal-action-query-filter.md) | Optional | - | getFilter(): ?TerminalActionQueryFilter | setFilter(?TerminalActionQueryFilter filter): void |
-| `sort` | [`?TerminalActionQuerySort`](../../doc/models/terminal-action-query-sort.md) | Optional | - | getSort(): ?TerminalActionQuerySort | setSort(?TerminalActionQuerySort sort): void |
-
-## Example (as JSON)
-
-```json
-{
- "include": [
- "CUSTOMER"
- ],
- "limit": 2,
- "query": {
- "filter": {
- "status": "COMPLETED"
- }
- },
- "filter": {
- "device_id": "device_id0",
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- },
- "status": "status6",
- "type": "SAVE_CARD"
- },
- "sort": {
- "sort_order": "DESC"
- }
-}
-```
-
diff --git a/doc/models/terminal-action.md b/doc/models/terminal-action.md
deleted file mode 100644
index 40e5d289..00000000
--- a/doc/models/terminal-action.md
+++ /dev/null
@@ -1,46 +0,0 @@
-
-# Terminal Action
-
-Represents an action processed by the Square Terminal.
-
-## Structure
-
-`TerminalAction`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A unique ID for this `TerminalAction`.
**Constraints**: *Minimum Length*: `10`, *Maximum Length*: `255` | getId(): ?string | setId(?string id): void |
-| `deviceId` | `?string` | Optional | The unique Id of the device intended for this `TerminalAction`.
The Id can be retrieved from /v2/devices api. | getDeviceId(): ?string | setDeviceId(?string deviceId): void |
-| `deadlineDuration` | `?string` | Optional | The duration as an RFC 3339 duration, after which the action will be automatically canceled.
TerminalActions that are `PENDING` will be automatically `CANCELED` and have a cancellation reason
of `TIMED_OUT`
Default: 5 minutes from creation
Maximum: 5 minutes | getDeadlineDuration(): ?string | setDeadlineDuration(?string deadlineDuration): void |
-| `status` | `?string` | Optional | The status of the `TerminalAction`.
Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` | getStatus(): ?string | setStatus(?string status): void |
-| `cancelReason` | [`?string(ActionCancelReason)`](../../doc/models/action-cancel-reason.md) | Optional | - | getCancelReason(): ?string | setCancelReason(?string cancelReason): void |
-| `createdAt` | `?string` | Optional | The time when the `TerminalAction` was created as an RFC 3339 timestamp. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The time when the `TerminalAction` was last updated as an RFC 3339 timestamp. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `appId` | `?string` | Optional | The ID of the application that created the action. | getAppId(): ?string | setAppId(?string appId): void |
-| `locationId` | `?string` | Optional | The location id the action is attached to, if a link can be made.
**Constraints**: *Maximum Length*: `64` | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `type` | [`?string(TerminalActionActionType)`](../../doc/models/terminal-action-action-type.md) | Optional | Describes the type of this unit and indicates which field contains the unit information. This is an ‘open’ enum. | getType(): ?string | setType(?string type): void |
-| `qrCodeOptions` | [`?QrCodeOptions`](../../doc/models/qr-code-options.md) | Optional | Fields to describe the action that displays QR-Codes. | getQrCodeOptions(): ?QrCodeOptions | setQrCodeOptions(?QrCodeOptions qrCodeOptions): void |
-| `saveCardOptions` | [`?SaveCardOptions`](../../doc/models/save-card-options.md) | Optional | Describes save-card action fields. | getSaveCardOptions(): ?SaveCardOptions | setSaveCardOptions(?SaveCardOptions saveCardOptions): void |
-| `signatureOptions` | [`?SignatureOptions`](../../doc/models/signature-options.md) | Optional | - | getSignatureOptions(): ?SignatureOptions | setSignatureOptions(?SignatureOptions signatureOptions): void |
-| `confirmationOptions` | [`?ConfirmationOptions`](../../doc/models/confirmation-options.md) | Optional | - | getConfirmationOptions(): ?ConfirmationOptions | setConfirmationOptions(?ConfirmationOptions confirmationOptions): void |
-| `receiptOptions` | [`?ReceiptOptions`](../../doc/models/receipt-options.md) | Optional | Describes receipt action fields. | getReceiptOptions(): ?ReceiptOptions | setReceiptOptions(?ReceiptOptions receiptOptions): void |
-| `dataCollectionOptions` | [`?DataCollectionOptions`](../../doc/models/data-collection-options.md) | Optional | - | getDataCollectionOptions(): ?DataCollectionOptions | setDataCollectionOptions(?DataCollectionOptions dataCollectionOptions): void |
-| `selectOptions` | [`?SelectOptions`](../../doc/models/select-options.md) | Optional | - | getSelectOptions(): ?SelectOptions | setSelectOptions(?SelectOptions selectOptions): void |
-| `deviceMetadata` | [`?DeviceMetadata`](../../doc/models/device-metadata.md) | Optional | - | getDeviceMetadata(): ?DeviceMetadata | setDeviceMetadata(?DeviceMetadata deviceMetadata): void |
-| `awaitNextAction` | `?bool` | Optional | Indicates the action will be linked to another action and requires a waiting dialog to be
displayed instead of returning to the idle screen on completion of the action.
Only supported on SIGNATURE, CONFIRMATION, DATA_COLLECTION, and SELECT types. | getAwaitNextAction(): ?bool | setAwaitNextAction(?bool awaitNextAction): void |
-| `awaitNextActionDuration` | `?string` | Optional | The timeout duration of the waiting dialog as an RFC 3339 duration, after which the
waiting dialog will no longer be displayed and the Terminal will return to the idle screen.
Default: 5 minutes from when the waiting dialog is displayed
Maximum: 5 minutes | getAwaitNextActionDuration(): ?string | setAwaitNextActionDuration(?string awaitNextActionDuration): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id8",
- "device_id": "device_id4",
- "deadline_duration": "deadline_duration0",
- "status": "status0",
- "cancel_reason": "TIMED_OUT"
-}
-```
-
diff --git a/doc/models/terminal-checkout-query-filter.md b/doc/models/terminal-checkout-query-filter.md
deleted file mode 100644
index f3afb769..00000000
--- a/doc/models/terminal-checkout-query-filter.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# Terminal Checkout Query Filter
-
-## Structure
-
-`TerminalCheckoutQueryFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `deviceId` | `?string` | Optional | The `TerminalCheckout` objects associated with a specific device. If no device is specified, then all
`TerminalCheckout` objects for the merchant are displayed. | getDeviceId(): ?string | setDeviceId(?string deviceId): void |
-| `createdAt` | [`?TimeRange`](../../doc/models/time-range.md) | Optional | Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled. | getCreatedAt(): ?TimeRange | setCreatedAt(?TimeRange createdAt): void |
-| `status` | `?string` | Optional | Filtered results with the desired status of the `TerminalCheckout`.
Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` | getStatus(): ?string | setStatus(?string status): void |
-
-## Example (as JSON)
-
-```json
-{
- "device_id": "device_id4",
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- },
- "status": "status0"
-}
-```
-
diff --git a/doc/models/terminal-checkout-query-sort.md b/doc/models/terminal-checkout-query-sort.md
deleted file mode 100644
index a0b38b0a..00000000
--- a/doc/models/terminal-checkout-query-sort.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Terminal Checkout Query Sort
-
-## Structure
-
-`TerminalCheckoutQuerySort`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `sortOrder` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-
-## Example (as JSON)
-
-```json
-{
- "sort_order": "DESC"
-}
-```
-
diff --git a/doc/models/terminal-checkout-query.md b/doc/models/terminal-checkout-query.md
deleted file mode 100644
index c3e44b70..00000000
--- a/doc/models/terminal-checkout-query.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Terminal Checkout Query
-
-## Structure
-
-`TerminalCheckoutQuery`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `filter` | [`?TerminalCheckoutQueryFilter`](../../doc/models/terminal-checkout-query-filter.md) | Optional | - | getFilter(): ?TerminalCheckoutQueryFilter | setFilter(?TerminalCheckoutQueryFilter filter): void |
-| `sort` | [`?TerminalCheckoutQuerySort`](../../doc/models/terminal-checkout-query-sort.md) | Optional | - | getSort(): ?TerminalCheckoutQuerySort | setSort(?TerminalCheckoutQuerySort sort): void |
-
-## Example (as JSON)
-
-```json
-{
- "filter": {
- "device_id": "device_id0",
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- },
- "status": "status6"
- },
- "sort": {
- "sort_order": "DESC"
- }
-}
-```
-
diff --git a/doc/models/terminal-checkout.md b/doc/models/terminal-checkout.md
deleted file mode 100644
index 07d685f4..00000000
--- a/doc/models/terminal-checkout.md
+++ /dev/null
@@ -1,71 +0,0 @@
-
-# Terminal Checkout
-
-Represents a checkout processed by the Square Terminal.
-
-## Structure
-
-`TerminalCheckout`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A unique ID for this `TerminalCheckout`.
**Constraints**: *Minimum Length*: `10`, *Maximum Length*: `255` | getId(): ?string | setId(?string id): void |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-| `referenceId` | `?string` | Optional | An optional user-defined reference ID that can be used to associate
this `TerminalCheckout` to another entity in an external system. For example, an order
ID generated by a third-party shopping cart. The ID is also associated with any payments
used to complete the checkout.
**Constraints**: *Maximum Length*: `40` | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `note` | `?string` | Optional | An optional note to associate with the checkout, as well as with any payments used to complete the checkout.
Note: maximum 500 characters
**Constraints**: *Maximum Length*: `500` | getNote(): ?string | setNote(?string note): void |
-| `orderId` | `?string` | Optional | The reference to the Square order ID for the checkout request. Supported only in the US. | getOrderId(): ?string | setOrderId(?string orderId): void |
-| `paymentOptions` | [`?PaymentOptions`](../../doc/models/payment-options.md) | Optional | - | getPaymentOptions(): ?PaymentOptions | setPaymentOptions(?PaymentOptions paymentOptions): void |
-| `deviceOptions` | [`DeviceCheckoutOptions`](../../doc/models/device-checkout-options.md) | Required | - | getDeviceOptions(): DeviceCheckoutOptions | setDeviceOptions(DeviceCheckoutOptions deviceOptions): void |
-| `deadlineDuration` | `?string` | Optional | An RFC 3339 duration, after which the checkout is automatically canceled.
A `TerminalCheckout` that is `PENDING` is automatically `CANCELED` and has a cancellation reason
of `TIMED_OUT`.
Default: 5 minutes from creation
Maximum: 5 minutes | getDeadlineDuration(): ?string | setDeadlineDuration(?string deadlineDuration): void |
-| `status` | `?string` | Optional | The status of the `TerminalCheckout`.
Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, `COMPLETED` | getStatus(): ?string | setStatus(?string status): void |
-| `cancelReason` | [`?string(ActionCancelReason)`](../../doc/models/action-cancel-reason.md) | Optional | - | getCancelReason(): ?string | setCancelReason(?string cancelReason): void |
-| `paymentIds` | `?(string[])` | Optional | A list of IDs for payments created by this `TerminalCheckout`. | getPaymentIds(): ?array | setPaymentIds(?array paymentIds): void |
-| `createdAt` | `?string` | Optional | The time when the `TerminalCheckout` was created, as an RFC 3339 timestamp. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The time when the `TerminalCheckout` was last updated, as an RFC 3339 timestamp. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `appId` | `?string` | Optional | The ID of the application that created the checkout. | getAppId(): ?string | setAppId(?string appId): void |
-| `locationId` | `?string` | Optional | The location of the device where the `TerminalCheckout` was directed.
**Constraints**: *Maximum Length*: `64` | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `paymentType` | [`?string(CheckoutOptionsPaymentType)`](../../doc/models/checkout-options-payment-type.md) | Optional | - | getPaymentType(): ?string | setPaymentType(?string paymentType): void |
-| `teamMemberId` | `?string` | Optional | An optional ID of the team member associated with creating the checkout. | getTeamMemberId(): ?string | setTeamMemberId(?string teamMemberId): void |
-| `customerId` | `?string` | Optional | An optional ID of the customer associated with the checkout. | getCustomerId(): ?string | setCustomerId(?string customerId): void |
-| `appFeeMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAppFeeMoney(): ?Money | setAppFeeMoney(?Money appFeeMoney): void |
-| `statementDescriptionIdentifier` | `?string` | Optional | Optional additional payment information to include on the customer's card statement as
part of the statement description. This can be, for example, an invoice number, ticket number,
or short description that uniquely identifies the purchase. Supported only in the US.
**Constraints**: *Maximum Length*: `20` | getStatementDescriptionIdentifier(): ?string | setStatementDescriptionIdentifier(?string statementDescriptionIdentifier): void |
-| `tipMoney` | [`?Money`](../../doc/models/money.md) | Optional | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getTipMoney(): ?Money | setTipMoney(?Money tipMoney): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "reference_id": "reference_id6",
- "note": "note8",
- "order_id": "order_id0",
- "payment_options": {
- "autocomplete": false,
- "delay_duration": "delay_duration2",
- "accept_partial_authorization": false,
- "delay_action": "CANCEL"
- },
- "device_options": {
- "device_id": "device_id6",
- "skip_receipt_screen": false,
- "collect_signature": false,
- "tip_settings": {
- "allow_tipping": false,
- "separate_tip_screen": false,
- "custom_tip_field": false,
- "tip_percentages": [
- 48
- ],
- "smart_tipping": false
- },
- "show_itemized_cart": false
- }
-}
-```
-
diff --git a/doc/models/terminal-refund-query-filter.md b/doc/models/terminal-refund-query-filter.md
deleted file mode 100644
index fe64a3bf..00000000
--- a/doc/models/terminal-refund-query-filter.md
+++ /dev/null
@@ -1,28 +0,0 @@
-
-# Terminal Refund Query Filter
-
-## Structure
-
-`TerminalRefundQueryFilter`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `deviceId` | `?string` | Optional | `TerminalRefund` objects associated with a specific device. If no device is specified, then all
`TerminalRefund` objects for the signed-in account are displayed. | getDeviceId(): ?string | setDeviceId(?string deviceId): void |
-| `createdAt` | [`?TimeRange`](../../doc/models/time-range.md) | Optional | Represents a generic time range. The start and end values are
represented in RFC 3339 format. Time ranges are customized to be
inclusive or exclusive based on the needs of a particular endpoint.
Refer to the relevant endpoint-specific documentation to determine
how time ranges are handled. | getCreatedAt(): ?TimeRange | setCreatedAt(?TimeRange createdAt): void |
-| `status` | `?string` | Optional | Filtered results with the desired status of the `TerminalRefund`.
Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or `COMPLETED`. | getStatus(): ?string | setStatus(?string status): void |
-
-## Example (as JSON)
-
-```json
-{
- "device_id": "device_id4",
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- },
- "status": "status0"
-}
-```
-
diff --git a/doc/models/terminal-refund-query-sort.md b/doc/models/terminal-refund-query-sort.md
deleted file mode 100644
index ba3eab67..00000000
--- a/doc/models/terminal-refund-query-sort.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Terminal Refund Query Sort
-
-## Structure
-
-`TerminalRefundQuerySort`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `sortOrder` | `?string` | Optional | The order in which results are listed.
- `ASC` - Oldest to newest.
- `DESC` - Newest to oldest (default). | getSortOrder(): ?string | setSortOrder(?string sortOrder): void |
-
-## Example (as JSON)
-
-```json
-{
- "sort_order": "sort_order0"
-}
-```
-
diff --git a/doc/models/terminal-refund-query.md b/doc/models/terminal-refund-query.md
deleted file mode 100644
index f021b06b..00000000
--- a/doc/models/terminal-refund-query.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Terminal Refund Query
-
-## Structure
-
-`TerminalRefundQuery`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `filter` | [`?TerminalRefundQueryFilter`](../../doc/models/terminal-refund-query-filter.md) | Optional | - | getFilter(): ?TerminalRefundQueryFilter | setFilter(?TerminalRefundQueryFilter filter): void |
-| `sort` | [`?TerminalRefundQuerySort`](../../doc/models/terminal-refund-query-sort.md) | Optional | - | getSort(): ?TerminalRefundQuerySort | setSort(?TerminalRefundQuerySort sort): void |
-
-## Example (as JSON)
-
-```json
-{
- "filter": {
- "device_id": "device_id0",
- "created_at": {
- "start_at": "start_at4",
- "end_at": "end_at8"
- },
- "status": "status6"
- },
- "sort": {
- "sort_order": "sort_order8"
- }
-}
-```
-
diff --git a/doc/models/terminal-refund.md b/doc/models/terminal-refund.md
deleted file mode 100644
index 8291bc87..00000000
--- a/doc/models/terminal-refund.md
+++ /dev/null
@@ -1,47 +0,0 @@
-
-# Terminal Refund
-
-Represents a payment refund processed by the Square Terminal. Only supports Interac (Canadian debit network) payment refunds.
-
-## Structure
-
-`TerminalRefund`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A unique ID for this `TerminalRefund`.
**Constraints**: *Minimum Length*: `10`, *Maximum Length*: `255` | getId(): ?string | setId(?string id): void |
-| `refundId` | `?string` | Optional | The reference to the payment refund created by completing this `TerminalRefund`. | getRefundId(): ?string | setRefundId(?string refundId): void |
-| `paymentId` | `string` | Required | The unique ID of the payment being refunded.
**Constraints**: *Minimum Length*: `1` | getPaymentId(): string | setPaymentId(string paymentId): void |
-| `orderId` | `?string` | Optional | The reference to the Square order ID for the payment identified by the `payment_id`. | getOrderId(): ?string | setOrderId(?string orderId): void |
-| `amountMoney` | [`Money`](../../doc/models/money.md) | Required | Represents an amount of money. `Money` fields can be signed or unsigned.
Fields that do not explicitly define whether they are signed or unsigned are
considered unsigned and can only hold positive amounts. For signed fields, the
sign of the value indicates the purpose of the money transfer. See
[Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts)
for more information. | getAmountMoney(): Money | setAmountMoney(Money amountMoney): void |
-| `reason` | `string` | Required | A description of the reason for the refund.
**Constraints**: *Maximum Length*: `192` | getReason(): string | setReason(string reason): void |
-| `deviceId` | `string` | Required | The unique ID of the device intended for this `TerminalRefund`.
The Id can be retrieved from /v2/devices api. | getDeviceId(): string | setDeviceId(string deviceId): void |
-| `deadlineDuration` | `?string` | Optional | The RFC 3339 duration, after which the refund is automatically canceled.
A `TerminalRefund` that is `PENDING` is automatically `CANCELED` and has a cancellation reason
of `TIMED_OUT`.
Default: 5 minutes from creation.
Maximum: 5 minutes | getDeadlineDuration(): ?string | setDeadlineDuration(?string deadlineDuration): void |
-| `status` | `?string` | Optional | The status of the `TerminalRefund`.
Options: `PENDING`, `IN_PROGRESS`, `CANCEL_REQUESTED`, `CANCELED`, or `COMPLETED`. | getStatus(): ?string | setStatus(?string status): void |
-| `cancelReason` | [`?string(ActionCancelReason)`](../../doc/models/action-cancel-reason.md) | Optional | - | getCancelReason(): ?string | setCancelReason(?string cancelReason): void |
-| `createdAt` | `?string` | Optional | The time when the `TerminalRefund` was created, as an RFC 3339 timestamp. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The time when the `TerminalRefund` was last updated, as an RFC 3339 timestamp. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `appId` | `?string` | Optional | The ID of the application that created the refund. | getAppId(): ?string | setAppId(?string appId): void |
-| `locationId` | `?string` | Optional | The location of the device where the `TerminalRefund` was directed.
**Constraints**: *Maximum Length*: `64` | getLocationId(): ?string | setLocationId(?string locationId): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id8",
- "refund_id": "refund_id2",
- "payment_id": "payment_id8",
- "order_id": "order_id2",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "reason": "reason6",
- "device_id": "device_id4",
- "deadline_duration": "deadline_duration0",
- "status": "status0"
-}
-```
-
diff --git a/doc/models/test-webhook-subscription-request.md b/doc/models/test-webhook-subscription-request.md
deleted file mode 100644
index 15830394..00000000
--- a/doc/models/test-webhook-subscription-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Test Webhook Subscription Request
-
-Tests a [Subscription](../../doc/models/webhook-subscription.md) by sending a test event to its notification URL.
-
-## Structure
-
-`TestWebhookSubscriptionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `eventType` | `?string` | Optional | The event type that will be used to test the [Subscription](entity:WebhookSubscription). The event type must be
contained in the list of event types in the [Subscription](entity:WebhookSubscription). | getEventType(): ?string | setEventType(?string eventType): void |
-
-## Example (as JSON)
-
-```json
-{
- "event_type": "payment.created"
-}
-```
-
diff --git a/doc/models/test-webhook-subscription-response.md b/doc/models/test-webhook-subscription-response.md
deleted file mode 100644
index 0dae889d..00000000
--- a/doc/models/test-webhook-subscription-response.md
+++ /dev/null
@@ -1,48 +0,0 @@
-
-# Test Webhook Subscription Response
-
-Defines the fields that are included in the response body of
-a request to the [TestWebhookSubscription](../../doc/apis/webhook-subscriptions.md#test-webhook-subscription) endpoint.
-
-Note: If there are errors processing the request, the [SubscriptionTestResult](../../doc/models/subscription-test-result.md) field is not
-present.
-
-## Structure
-
-`TestWebhookSubscriptionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `subscriptionTestResult` | [`?SubscriptionTestResult`](../../doc/models/subscription-test-result.md) | Optional | Represents the details of a webhook subscription, including notification URL,
event types, and signature key. | getSubscriptionTestResult(): ?SubscriptionTestResult | setSubscriptionTestResult(?SubscriptionTestResult subscriptionTestResult): void |
-
-## Example (as JSON)
-
-```json
-{
- "subscription_test_result": {
- "created_at": "2022-01-11 00:06:48.322945116 +0000 UTC m=+3863.054453746",
- "id": "23eed5a9-2b12-403e-b212-7e2889aea0f6",
- "payload": "{\"merchant_id\":\"1ZYMKZY1YFGBW\",\"type\":\"payment.created\",\"event_id\":\"23eed5a9-2b12-403e-b212-7e2889aea0f6\",\"created_at\":\"2022-01-11T00:06:48.322945116Z\",\"data\":{\"type\":\"payment\",\"id\":\"KkAkhdMsgzn59SM8A89WgKwekxLZY\",\"object\":{\"payment\":{\"amount_money\":{\"amount\":100,\"currency\":\"USD\"},\"approved_money\":{\"amount\":100,\"currency\":\"USD\"},\"capabilities\":[\"EDIT_TIP_AMOUNT\",\"EDIT_TIP_AMOUNT_UP\",\"EDIT_TIP_AMOUNT_DOWN\"],\"card_details\":{\"avs_status\":\"AVS_ACCEPTED\",\"card\":{\"bin\":\"540988\",\"card_brand\":\"MASTERCARD\",\"card_type\":\"CREDIT\",\"exp_month\":11,\"exp_year\":2022,\"fingerprint\":\"sq-1-Tvruf3vPQxlvI6n0IcKYfBukrcv6IqWr8UyBdViWXU2yzGn5VMJvrsHMKpINMhPmVg\",\"last_4\":\"9029\",\"prepaid_type\":\"NOT_PREPAID\"},\"card_payment_timeline\":{\"authorized_at\":\"2020-11-22T21:16:51.198Z\"},\"cvv_status\":\"CVV_ACCEPTED\",\"entry_method\":\"KEYED\",\"statement_description\":\"SQ *DEFAULT TEST ACCOUNT\",\"status\":\"AUTHORIZED\"},\"created_at\":\"2020-11-22T21:16:51.086Z\",\"delay_action\":\"CANCEL\",\"delay_duration\":\"PT168H\",\"delayed_until\":\"2020-11-29T21:16:51.086Z\",\"id\":\"hYy9pRFVxpDsO1FB05SunFWUe9JZY\",\"location_id\":\"S8GWD5R9QB376\",\"order_id\":\"03O3USaPaAaFnI6kkwB1JxGgBsUZY\",\"receipt_number\":\"hYy9\",\"risk_evaluation\":{\"created_at\":\"2020-11-22T21:16:51.198Z\",\"risk_level\":\"NORMAL\"},\"source_type\":\"CARD\",\"status\":\"APPROVED\",\"total_money\":{\"amount\":100,\"currency\":\"USD\"},\"updated_at\":\"2020-11-22T21:16:51.198Z\",\"version_token\":\"FfQhQJf9r3VSQIgyWBk1oqhIwiznLwVwJbVVA0bdyEv6o\"}}}}",
- "status_code": 404,
- "updated_at": "2022-01-11 00:06:48.322945116 +0000 UTC m=+3863.054453746"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/time-range.md b/doc/models/time-range.md
deleted file mode 100644
index ea4fd3d8..00000000
--- a/doc/models/time-range.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Time Range
-
-Represents a generic time range. The start and end values are
-represented in RFC 3339 format. Time ranges are customized to be
-inclusive or exclusive based on the needs of a particular endpoint.
-Refer to the relevant endpoint-specific documentation to determine
-how time ranges are handled.
-
-## Structure
-
-`TimeRange`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `startAt` | `?string` | Optional | A datetime value in RFC 3339 format indicating when the time range
starts. | getStartAt(): ?string | setStartAt(?string startAt): void |
-| `endAt` | `?string` | Optional | A datetime value in RFC 3339 format indicating when the time range
ends. | getEndAt(): ?string | setEndAt(?string endAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "start_at": "start_at2",
- "end_at": "end_at0"
-}
-```
-
diff --git a/doc/models/tip-settings.md b/doc/models/tip-settings.md
deleted file mode 100644
index 0f1b340f..00000000
--- a/doc/models/tip-settings.md
+++ /dev/null
@@ -1,33 +0,0 @@
-
-# Tip Settings
-
-## Structure
-
-`TipSettings`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `allowTipping` | `?bool` | Optional | Indicates whether tipping is enabled for this checkout. Defaults to false. | getAllowTipping(): ?bool | setAllowTipping(?bool allowTipping): void |
-| `separateTipScreen` | `?bool` | Optional | Indicates whether tip options should be presented on the screen before presenting
the signature screen during card payment. Defaults to false. | getSeparateTipScreen(): ?bool | setSeparateTipScreen(?bool separateTipScreen): void |
-| `customTipField` | `?bool` | Optional | Indicates whether custom tip amounts are allowed during the checkout flow. Defaults to false. | getCustomTipField(): ?bool | setCustomTipField(?bool customTipField): void |
-| `tipPercentages` | `?(int[])` | Optional | A list of tip percentages that should be presented during the checkout flow, specified as
up to 3 non-negative integers from 0 to 100 (inclusive). Defaults to 15, 20, and 25. | getTipPercentages(): ?array | setTipPercentages(?array tipPercentages): void |
-| `smartTipping` | `?bool` | Optional | Enables the "Smart Tip Amounts" behavior.
Exact tipping options depend on the region in which the Square seller is active.
For payments under 10.00, in the Australia, Canada, Ireland, United Kingdom, and United States, tipping options are presented as no tip, .50, 1.00 or 2.00.
For payment amounts of 10.00 or greater, tipping options are presented as the following percentages: 0%, 5%, 10%, 15%.
If set to true, the `tip_percentages` settings is ignored.
Defaults to false.
To learn more about smart tipping, see [Accept Tips with the Square App](https://squareup.com/help/us/en/article/5069-accept-tips-with-the-square-app). | getSmartTipping(): ?bool | setSmartTipping(?bool smartTipping): void |
-
-## Example (as JSON)
-
-```json
-{
- "allow_tipping": false,
- "separate_tip_screen": false,
- "custom_tip_field": false,
- "tip_percentages": [
- 66,
- 67,
- 68
- ],
- "smart_tipping": false
-}
-```
-
diff --git a/doc/models/transaction-product.md b/doc/models/transaction-product.md
deleted file mode 100644
index d6237d9c..00000000
--- a/doc/models/transaction-product.md
+++ /dev/null
@@ -1,22 +0,0 @@
-
-# Transaction Product
-
-Indicates the Square product used to process a transaction.
-
-## Enumeration
-
-`TransactionProduct`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `REGISTER` | Square Point of Sale. |
-| `EXTERNAL_API` | The Square Connect API. |
-| `BILLING` | A Square subscription for one of multiple products. |
-| `APPOINTMENTS` | Square Appointments. |
-| `INVOICES` | Square Invoices. |
-| `ONLINE_STORE` | Square Online Store. |
-| `PAYROLL` | Square Payroll. |
-| `OTHER` | A Square product that does not match any other value. |
-
diff --git a/doc/models/transaction-type.md b/doc/models/transaction-type.md
deleted file mode 100644
index fdc3351a..00000000
--- a/doc/models/transaction-type.md
+++ /dev/null
@@ -1,16 +0,0 @@
-
-# Transaction Type
-
-The transaction type used in the disputed payment.
-
-## Enumeration
-
-`TransactionType`
-
-## Fields
-
-| Name |
-| --- |
-| `DEBIT` |
-| `CREDIT` |
-
diff --git a/doc/models/transaction.md b/doc/models/transaction.md
deleted file mode 100644
index 5472a223..00000000
--- a/doc/models/transaction.md
+++ /dev/null
@@ -1,177 +0,0 @@
-
-# Transaction
-
-Represents a transaction processed with Square, either with the
-Connect API or with Square Point of Sale.
-
-The `tenders` field of this object lists all methods of payment used to pay in
-the transaction.
-
-## Structure
-
-`Transaction`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The transaction's unique ID, issued by Square payments servers.
**Constraints**: *Maximum Length*: `192` | getId(): ?string | setId(?string id): void |
-| `locationId` | `?string` | Optional | The ID of the transaction's associated location.
**Constraints**: *Maximum Length*: `50` | getLocationId(): ?string | setLocationId(?string locationId): void |
-| `createdAt` | `?string` | Optional | The timestamp for when the transaction was created, in RFC 3339 format.
**Constraints**: *Maximum Length*: `32` | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `tenders` | [`?(Tender[])`](../../doc/models/tender.md) | Optional | The tenders used to pay in the transaction. | getTenders(): ?array | setTenders(?array tenders): void |
-| `refunds` | [`?(Refund[])`](../../doc/models/refund.md) | Optional | Refunds that have been applied to any tender in the transaction. | getRefunds(): ?array | setRefunds(?array refunds): void |
-| `referenceId` | `?string` | Optional | If the transaction was created with the [Charge](api-endpoint:Transactions-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.
**Constraints**: *Maximum Length*: `40` | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `product` | [`?string(TransactionProduct)`](../../doc/models/transaction-product.md) | Optional | Indicates the Square product used to process a transaction. | getProduct(): ?string | setProduct(?string product): void |
-| `clientId` | `?string` | Optional | If the transaction was created in the Square Point of Sale app, this value
is the ID generated for the transaction by Square Point of Sale.
This ID has no relationship to the transaction's canonical `id`, which is
generated by Square's backend servers. This value is generated for bookkeeping
purposes, in case the transaction cannot immediately be completed (for example,
if the transaction is processed in offline mode).
It is not currently possible with the Connect API to perform a transaction
lookup by this value.
**Constraints**: *Maximum Length*: `192` | getClientId(): ?string | setClientId(?string clientId): void |
-| `shippingAddress` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getShippingAddress(): ?Address | setShippingAddress(?Address shippingAddress): void |
-| `orderId` | `?string` | Optional | The order_id is an identifier for the order associated with this transaction, if any.
**Constraints**: *Maximum Length*: `192` | getOrderId(): ?string | setOrderId(?string orderId): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id4",
- "location_id": "location_id8",
- "created_at": "created_at8",
- "tenders": [
- {
- "id": "id8",
- "location_id": "location_id2",
- "transaction_id": "transaction_id6",
- "created_at": "created_at6",
- "note": "note4",
- "type": "THIRD_PARTY_CARD"
- },
- {
- "id": "id8",
- "location_id": "location_id2",
- "transaction_id": "transaction_id6",
- "created_at": "created_at6",
- "note": "note4",
- "type": "THIRD_PARTY_CARD"
- },
- {
- "id": "id8",
- "location_id": "location_id2",
- "transaction_id": "transaction_id6",
- "created_at": "created_at6",
- "note": "note4",
- "type": "THIRD_PARTY_CARD"
- }
- ],
- "refunds": [
- {
- "id": "id8",
- "location_id": "location_id2",
- "transaction_id": "transaction_id6",
- "tender_id": "tender_id6",
- "created_at": "created_at6",
- "reason": "reason4",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "status": "PENDING",
- "processing_fee_money": {
- "amount": 112,
- "currency": "DJF"
- },
- "additional_recipients": [
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- },
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- }
- ]
- },
- {
- "id": "id8",
- "location_id": "location_id2",
- "transaction_id": "transaction_id6",
- "tender_id": "tender_id6",
- "created_at": "created_at6",
- "reason": "reason4",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "status": "PENDING",
- "processing_fee_money": {
- "amount": 112,
- "currency": "DJF"
- },
- "additional_recipients": [
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- },
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- }
- ]
- },
- {
- "id": "id8",
- "location_id": "location_id2",
- "transaction_id": "transaction_id6",
- "tender_id": "tender_id6",
- "created_at": "created_at6",
- "reason": "reason4",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "status": "PENDING",
- "processing_fee_money": {
- "amount": 112,
- "currency": "DJF"
- },
- "additional_recipients": [
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- },
- {
- "location_id": "location_id0",
- "description": "description6",
- "amount_money": {
- "amount": 186,
- "currency": "AUD"
- },
- "receivable_id": "receivable_id6"
- }
- ]
- }
- ]
-}
-```
-
diff --git a/doc/models/unlink-customer-from-gift-card-request.md b/doc/models/unlink-customer-from-gift-card-request.md
deleted file mode 100644
index 0639ec6c..00000000
--- a/doc/models/unlink-customer-from-gift-card-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Unlink Customer From Gift Card Request
-
-A request to unlink a customer from a gift card.
-
-## Structure
-
-`UnlinkCustomerFromGiftCardRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customerId` | `string` | Required | The ID of the customer to unlink from the gift card.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `191` | getCustomerId(): string | setCustomerId(string customerId): void |
-
-## Example (as JSON)
-
-```json
-{
- "customer_id": "GKY0FZ3V717AH8Q2D821PNT2ZW"
-}
-```
-
diff --git a/doc/models/unlink-customer-from-gift-card-response.md b/doc/models/unlink-customer-from-gift-card-response.md
deleted file mode 100644
index e569fb0e..00000000
--- a/doc/models/unlink-customer-from-gift-card-response.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Unlink Customer From Gift Card Response
-
-A response that contains the unlinked `GiftCard` object. If the request resulted in errors,
-the response contains a set of `Error` objects.
-
-## Structure
-
-`UnlinkCustomerFromGiftCardResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `giftCard` | [`?GiftCard`](../../doc/models/gift-card.md) | Optional | Represents a Square gift card. | getGiftCard(): ?GiftCard | setGiftCard(?GiftCard giftCard): void |
-
-## Example (as JSON)
-
-```json
-{
- "gift_card": {
- "balance_money": {
- "amount": 2500,
- "currency": "USD"
- },
- "created_at": "2021-03-25T05:13:01Z",
- "gan": "7783320005440920",
- "gan_source": "SQUARE",
- "id": "gftc:71ea002277a34f8a945e284b04822edb",
- "state": "ACTIVE",
- "type": "DIGITAL"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-booking-custom-attribute-definition-request.md b/doc/models/update-booking-custom-attribute-definition-request.md
deleted file mode 100644
index bdf36f47..00000000
--- a/doc/models/update-booking-custom-attribute-definition-request.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Update Booking Custom Attribute Definition Request
-
-Represents an [UpdateBookingCustomAttributeDefinition](../../doc/apis/booking-custom-attributes.md#update-booking-custom-attribute-definition) request.
-
-## Structure
-
-`UpdateBookingCustomAttributeDefinitionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Required | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): CustomAttributeDefinition | setCustomAttributeDefinition(CustomAttributeDefinition customAttributeDefinition): void |
-| `idempotencyKey` | `?string` | Optional | A unique identifier for this request, used to ensure idempotency. For more information,
see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "key": "key2",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name2",
- "description": "description8",
- "visibility": "VISIBILITY_HIDDEN"
- },
- "idempotency_key": "idempotency_key2"
-}
-```
-
diff --git a/doc/models/update-booking-custom-attribute-definition-response.md b/doc/models/update-booking-custom-attribute-definition-response.md
deleted file mode 100644
index 5c4414ce..00000000
--- a/doc/models/update-booking-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,38 +0,0 @@
-
-# Update Booking Custom Attribute Definition Response
-
-Represents an [UpdateBookingCustomAttributeDefinition](../../doc/apis/booking-custom-attributes.md#update-booking-custom-attribute-definition) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`UpdateBookingCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`?CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Optional | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): ?CustomAttributeDefinition | setCustomAttributeDefinition(?CustomAttributeDefinition customAttributeDefinition): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "created_at": "2022-11-16T15:27:30Z",
- "description": "Update the description as desired.",
- "key": "favoriteShampoo",
- "name": "Favorite shampoo",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-11-16T15:39:38Z",
- "version": 2,
- "visibility": "VISIBILITY_READ_ONLY"
- },
- "errors": []
-}
-```
-
diff --git a/doc/models/update-booking-request.md b/doc/models/update-booking-request.md
deleted file mode 100644
index a8d0e059..00000000
--- a/doc/models/update-booking-request.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Update Booking Request
-
-## Structure
-
-`UpdateBookingRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `?string` | Optional | A unique key to make this request an idempotent operation.
**Constraints**: *Maximum Length*: `255` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-| `booking` | [`Booking`](../../doc/models/booking.md) | Required | Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service
at a given location to a requesting customer in one or more appointment segments. | getBooking(): Booking | setBooking(Booking booking): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "idempotency_key4",
- "booking": {
- "id": "id4",
- "version": 156,
- "status": "CANCELLED_BY_SELLER",
- "created_at": "created_at2",
- "updated_at": "updated_at0"
- }
-}
-```
-
diff --git a/doc/models/update-booking-response.md b/doc/models/update-booking-response.md
deleted file mode 100644
index ac22b344..00000000
--- a/doc/models/update-booking-response.md
+++ /dev/null
@@ -1,50 +0,0 @@
-
-# Update Booking Response
-
-## Structure
-
-`UpdateBookingResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `booking` | [`?Booking`](../../doc/models/booking.md) | Optional | Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service
at a given location to a requesting customer in one or more appointment segments. | getBooking(): ?Booking | setBooking(?Booking booking): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "booking": {
- "address": {
- "address_line_1": "1955 Broadway",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "CA",
- "locality": "Oakland",
- "postal_code": "94612"
- },
- "appointment_segments": [
- {
- "duration_minutes": 60,
- "service_variation_id": "RU3PBTZTK7DXZDQFCJHOK2MC",
- "service_variation_version": 1599775456731,
- "team_member_id": "TMXUrsBWWcHTt79t"
- }
- ],
- "created_at": "2020-10-28T15:47:41Z",
- "customer_id": "EX2QSVGTZN4K1E5QE1CBFNVQ8M",
- "customer_note": "I would like to sit near the window please",
- "id": "zkras0xv0xwswx",
- "location_id": "LEQHH0YY8B42M",
- "location_type": "CUSTOMER_LOCATION",
- "seller_note": "",
- "start_at": "2020-11-26T13:00:00Z",
- "status": "ACCEPTED",
- "updated_at": "2020-10-28T15:49:25Z",
- "version": 2
- },
- "errors": []
-}
-```
-
diff --git a/doc/models/update-break-type-request.md b/doc/models/update-break-type-request.md
deleted file mode 100644
index 4b143ad5..00000000
--- a/doc/models/update-break-type-request.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Update Break Type Request
-
-A request to update a `BreakType`.
-
-## Structure
-
-`UpdateBreakTypeRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `breakType` | [`BreakType`](../../doc/models/break-type.md) | Required | A defined break template that sets an expectation for possible `Break`
instances on a `Shift`. | getBreakType(): BreakType | setBreakType(BreakType breakType): void |
-
-## Example (as JSON)
-
-```json
-{
- "break_type": {
- "break_name": "Lunch",
- "expected_duration": "PT50M",
- "is_paid": true,
- "location_id": "26M7H24AZ9N6R",
- "version": 1,
- "id": "id8",
- "created_at": "created_at6",
- "updated_at": "updated_at4"
- }
-}
-```
-
diff --git a/doc/models/update-break-type-response.md b/doc/models/update-break-type-response.md
deleted file mode 100644
index 07c10a19..00000000
--- a/doc/models/update-break-type-response.md
+++ /dev/null
@@ -1,43 +0,0 @@
-
-# Update Break Type Response
-
-A response to a request to update a `BreakType`. The response contains
-the requested `BreakType` objects and might contain a set of `Error` objects if
-the request resulted in errors.
-
-## Structure
-
-`UpdateBreakTypeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `breakType` | [`?BreakType`](../../doc/models/break-type.md) | Optional | A defined break template that sets an expectation for possible `Break`
instances on a `Shift`. | getBreakType(): ?BreakType | setBreakType(?BreakType breakType): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "break_type": {
- "break_name": "Lunch",
- "created_at": "2018-06-12T20:19:12Z",
- "expected_duration": "PT50M",
- "id": "Q6JSJS6D4DBCH",
- "is_paid": true,
- "location_id": "26M7H24AZ9N6R",
- "updated_at": "2019-02-26T23:12:59Z",
- "version": 2
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-catalog-image-request.md b/doc/models/update-catalog-image-request.md
deleted file mode 100644
index 2eeb903f..00000000
--- a/doc/models/update-catalog-image-request.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Update Catalog Image Request
-
-## Structure
-
-`UpdateCatalogImageRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A unique string that identifies this UpdateCatalogImage request.
Keys can be any valid string but must be unique for every UpdateCatalogImage request.
See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
**Constraints**: *Minimum Length*: `1` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "528dea59-7bfb-43c1-bd48-4a6bba7dd61f86",
- "image": {
- "image_data": {
- "caption": "A picture of a cup of coffee",
- "name": "Coffee"
- },
- "type": "IMAGE"
- },
- "object_id": "ND6EA5AAJEO5WL3JNNIAQA32"
-}
-```
-
diff --git a/doc/models/update-catalog-image-response.md b/doc/models/update-catalog-image-response.md
deleted file mode 100644
index 7aeeb330..00000000
--- a/doc/models/update-catalog-image-response.md
+++ /dev/null
@@ -1,77 +0,0 @@
-
-# Update Catalog Image Response
-
-## Structure
-
-`UpdateCatalogImageResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `image` | [`?CatalogObject`](../../doc/models/catalog-object.md) | Optional | The wrapper object for the catalog entries of a given object type.
Depending on the `type` attribute value, a `CatalogObject` instance assumes a type-specific data to yield the corresponding type of catalog object.
For example, if `type=ITEM`, the `CatalogObject` instance must have the ITEM-specific data set on the `item_data` attribute. The resulting `CatalogObject` instance is also a `CatalogItem` instance.
In general, if `type=`, the `CatalogObject` instance must have the ``-specific data set on the `_data` attribute. The resulting `CatalogObject` instance is also a `Catalog` instance.
For a more detailed discussion of the Catalog data model, please see the
[Design a Catalog](https://developer.squareup.com/docs/catalog-api/design-a-catalog) guide. | getImage(): ?CatalogObject | setImage(?CatalogObject image): void |
-
-## Example (as JSON)
-
-```json
-{
- "image": {
- "id": "L52QOQN2SW3M5QTF9JOCQKNB",
- "image_data": {
- "caption": "A picture of a cup of coffee",
- "name": "Coffee",
- "url": "https://..."
- },
- "type": "IMAGE",
- "updated_at": "updated_at2",
- "version": 100,
- "is_deleted": false,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-customer-custom-attribute-definition-request.md b/doc/models/update-customer-custom-attribute-definition-request.md
deleted file mode 100644
index dbca16a0..00000000
--- a/doc/models/update-customer-custom-attribute-definition-request.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Update Customer Custom Attribute Definition Request
-
-Represents an [UpdateCustomerCustomAttributeDefinition](../../doc/apis/customer-custom-attributes.md#update-customer-custom-attribute-definition) request.
-
-## Structure
-
-`UpdateCustomerCustomAttributeDefinitionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Required | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): CustomAttributeDefinition | setCustomAttributeDefinition(CustomAttributeDefinition customAttributeDefinition): void |
-| `idempotencyKey` | `?string` | Optional | A unique identifier for this request, used to ensure idempotency. For more information,
see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "description": "Update the description as desired.",
- "visibility": "VISIBILITY_READ_ONLY",
- "key": "key2",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name2"
- },
- "idempotency_key": "idempotency_key2"
-}
-```
-
diff --git a/doc/models/update-customer-custom-attribute-definition-response.md b/doc/models/update-customer-custom-attribute-definition-response.md
deleted file mode 100644
index 2e20e805..00000000
--- a/doc/models/update-customer-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,57 +0,0 @@
-
-# Update Customer Custom Attribute Definition Response
-
-Represents an [UpdateCustomerCustomAttributeDefinition](../../doc/apis/customer-custom-attributes.md#update-customer-custom-attribute-definition) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`UpdateCustomerCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`?CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Optional | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): ?CustomAttributeDefinition | setCustomAttributeDefinition(?CustomAttributeDefinition customAttributeDefinition): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "created_at": "2022-04-26T15:27:30Z",
- "description": "Update the description as desired.",
- "key": "favoritemovie",
- "name": "Favorite Movie",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-04-26T15:39:38Z",
- "version": 2,
- "visibility": "VISIBILITY_READ_ONLY"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-customer-group-request.md b/doc/models/update-customer-group-request.md
deleted file mode 100644
index b06ce652..00000000
--- a/doc/models/update-customer-group-request.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Update Customer Group Request
-
-Defines the body parameters that can be included in a request to the
-[UpdateCustomerGroup](../../doc/apis/customer-groups.md#update-customer-group) endpoint.
-
-## Structure
-
-`UpdateCustomerGroupRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `group` | [`CustomerGroup`](../../doc/models/customer-group.md) | Required | Represents a group of customer profiles.
Customer groups can be created, be modified, and have their membership defined using
the Customers API or within the Customer Directory in the Square Seller Dashboard or Point of Sale. | getGroup(): CustomerGroup | setGroup(CustomerGroup group): void |
-
-## Example (as JSON)
-
-```json
-{
- "group": {
- "name": "Loyal Customers",
- "id": "id8",
- "created_at": "created_at4",
- "updated_at": "updated_at6"
- }
-}
-```
-
diff --git a/doc/models/update-customer-group-response.md b/doc/models/update-customer-group-response.md
deleted file mode 100644
index 5cec467e..00000000
--- a/doc/models/update-customer-group-response.md
+++ /dev/null
@@ -1,52 +0,0 @@
-
-# Update Customer Group Response
-
-Defines the fields that are included in the response body of
-a request to the [UpdateCustomerGroup](../../doc/apis/customer-groups.md#update-customer-group) endpoint.
-
-Either `errors` or `group` is present in a given response (never both).
-
-## Structure
-
-`UpdateCustomerGroupResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `group` | [`?CustomerGroup`](../../doc/models/customer-group.md) | Optional | Represents a group of customer profiles.
Customer groups can be created, be modified, and have their membership defined using
the Customers API or within the Customer Directory in the Square Seller Dashboard or Point of Sale. | getGroup(): ?CustomerGroup | setGroup(?CustomerGroup group): void |
-
-## Example (as JSON)
-
-```json
-{
- "group": {
- "created_at": "2020-04-13T21:54:57.863Z",
- "id": "2TAT3CMH4Q0A9M87XJZED0WMR3",
- "name": "Loyal Customers",
- "updated_at": "2020-04-13T21:54:58Z"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-customer-request.md b/doc/models/update-customer-request.md
deleted file mode 100644
index 366f22be..00000000
--- a/doc/models/update-customer-request.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-# Update Customer Request
-
-Defines the body parameters that can be included in a request to the
-`UpdateCustomer` endpoint.
-
-## Structure
-
-`UpdateCustomerRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `givenName` | `?string` | Optional | The given name (that is, the first name) associated with the customer profile.
The maximum length for this value is 300 characters. | getGivenName(): ?string | setGivenName(?string givenName): void |
-| `familyName` | `?string` | Optional | The family name (that is, the last name) associated with the customer profile.
The maximum length for this value is 300 characters. | getFamilyName(): ?string | setFamilyName(?string familyName): void |
-| `companyName` | `?string` | Optional | A business name associated with the customer profile.
The maximum length for this value is 500 characters. | getCompanyName(): ?string | setCompanyName(?string companyName): void |
-| `nickname` | `?string` | Optional | A nickname for the customer profile.
The maximum length for this value is 100 characters. | getNickname(): ?string | setNickname(?string nickname): void |
-| `emailAddress` | `?string` | Optional | The email address associated with the customer profile.
The maximum length for this value is 254 characters. | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void |
-| `address` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getAddress(): ?Address | setAddress(?Address address): void |
-| `phoneNumber` | `?string` | Optional | The phone number associated with the customer profile. The phone number must be valid and can contain
9–16 digits, with an optional `+` prefix and country code. For more information, see
[Customer phone numbers](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#phone-number). | getPhoneNumber(): ?string | setPhoneNumber(?string phoneNumber): void |
-| `referenceId` | `?string` | Optional | An optional second ID used to associate the customer profile with an
entity in another system.
The maximum length for this value is 100 characters. | getReferenceId(): ?string | setReferenceId(?string referenceId): void |
-| `note` | `?string` | Optional | A custom note associated with the customer profile. | getNote(): ?string | setNote(?string note): void |
-| `birthday` | `?string` | Optional | The birthday associated with the customer profile, in `YYYY-MM-DD` or `MM-DD` format. For example,
specify `1998-09-21` for September 21, 1998, or `09-21` for September 21. Birthdays are returned in `YYYY-MM-DD`
format, where `YYYY` is the specified birth year or `0000` if a birth year is not specified. | getBirthday(): ?string | setBirthday(?string birthday): void |
-| `version` | `?int` | Optional | The current version of the customer profile.
As a best practice, you should include this field to enable [optimistic concurrency](https://developer.squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control. For more information, see [Update a customer profile](https://developer.squareup.com/docs/customers-api/use-the-api/keep-records#update-a-customer-profile). | getVersion(): ?int | setVersion(?int version): void |
-| `taxIds` | [`?CustomerTaxIds`](../../doc/models/customer-tax-ids.md) | Optional | Represents the tax ID associated with a [customer profile](../../doc/models/customer.md). The corresponding `tax_ids` field is available only for customers of sellers in EU countries or the United Kingdom.
For more information, see [Customer tax IDs](https://developer.squareup.com/docs/customers-api/what-it-does#customer-tax-ids). | getTaxIds(): ?CustomerTaxIds | setTaxIds(?CustomerTaxIds taxIds): void |
-
-## Example (as JSON)
-
-```json
-{
- "email_address": "New.Amelia.Earhart@example.com",
- "note": "updated customer note",
- "phone_number": null,
- "version": 2,
- "given_name": "given_name0",
- "family_name": "family_name8",
- "company_name": "company_name4",
- "nickname": "nickname4"
-}
-```
-
diff --git a/doc/models/update-customer-response.md b/doc/models/update-customer-response.md
deleted file mode 100644
index 71f17208..00000000
--- a/doc/models/update-customer-response.md
+++ /dev/null
@@ -1,73 +0,0 @@
-
-# Update Customer Response
-
-Defines the fields that are included in the response body of
-a request to the [UpdateCustomer](../../doc/apis/customers.md#update-customer) or
-[BulkUpdateCustomers](../../doc/apis/customers.md#bulk-update-customers) endpoint.
-
-Either `errors` or `customer` is present in a given response (never both).
-
-## Structure
-
-`UpdateCustomerResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `customer` | [`?Customer`](../../doc/models/customer.md) | Optional | Represents a Square customer profile in the Customer Directory of a Square seller. | getCustomer(): ?Customer | setCustomer(?Customer customer): void |
-
-## Example (as JSON)
-
-```json
-{
- "customer": {
- "address": {
- "address_line_1": "500 Electric Ave",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "NY",
- "country": "US",
- "locality": "New York",
- "postal_code": "10003"
- },
- "created_at": "2016-03-23T20:21:54.859Z",
- "creation_source": "THIRD_PARTY",
- "email_address": "New.Amelia.Earhart@example.com",
- "family_name": "Earhart",
- "given_name": "Amelia",
- "id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "note": "updated customer note",
- "preferences": {
- "email_unsubscribed": false
- },
- "reference_id": "YOUR_REFERENCE_ID",
- "updated_at": "2016-05-15T20:21:55Z",
- "version": 3,
- "cards": [
- {
- "id": "id8",
- "card_brand": "DISCOVER",
- "last_4": "last_40",
- "exp_month": 152,
- "exp_year": 144
- }
- ]
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-invoice-request.md b/doc/models/update-invoice-request.md
deleted file mode 100644
index ba6701cf..00000000
--- a/doc/models/update-invoice-request.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Update Invoice Request
-
-Describes a `UpdateInvoice` request.
-
-## Structure
-
-`UpdateInvoiceRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `invoice` | [`Invoice`](../../doc/models/invoice.md) | Required | Stores information about an invoice. You use the Invoices API to create and manage
invoices. For more information, see [Invoices API Overview](https://developer.squareup.com/docs/invoices-api/overview). | getInvoice(): Invoice | setInvoice(Invoice invoice): void |
-| `idempotencyKey` | `?string` | Optional | A unique string that identifies the `UpdateInvoice` request. If you do not
provide `idempotency_key` (or provide an empty string as the value), the endpoint
treats each request as independent.
For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `128` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-| `fieldsToClear` | `?(string[])` | Optional | The list of fields to clear. Although this field is currently supported, we
recommend using null values or the `remove` field when possible. For examples, see
[Update an Invoice](https://developer.squareup.com/docs/invoices-api/update-invoices). | getFieldsToClear(): ?array | setFieldsToClear(?array fieldsToClear): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "4ee82288-0910-499e-ab4c-5d0071dad1be",
- "invoice": {
- "payment_requests": [
- {
- "reminders": null,
- "tipping_enabled": false,
- "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355"
- }
- ],
- "version": 1,
- "id": "id6",
- "location_id": "location_id0",
- "order_id": "order_id0",
- "primary_recipient": {
- "customer_id": "customer_id2",
- "given_name": "given_name6",
- "family_name": "family_name8",
- "email_address": "email_address2",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- }
- },
- "fields_to_clear": [
- "fields_to_clear1",
- "fields_to_clear2",
- "fields_to_clear3"
- ]
-}
-```
-
diff --git a/doc/models/update-invoice-response.md b/doc/models/update-invoice-response.md
deleted file mode 100644
index f7aa15bd..00000000
--- a/doc/models/update-invoice-response.md
+++ /dev/null
@@ -1,108 +0,0 @@
-
-# Update Invoice Response
-
-Describes a `UpdateInvoice` response.
-
-## Structure
-
-`UpdateInvoiceResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `invoice` | [`?Invoice`](../../doc/models/invoice.md) | Optional | Stores information about an invoice. You use the Invoices API to create and manage
invoices. For more information, see [Invoices API Overview](https://developer.squareup.com/docs/invoices-api/overview). | getInvoice(): ?Invoice | setInvoice(?Invoice invoice): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "invoice": {
- "accepted_payment_methods": {
- "bank_account": false,
- "buy_now_pay_later": false,
- "card": true,
- "cash_app_pay": false,
- "square_gift_card": false
- },
- "created_at": "2020-06-18T17:45:13Z",
- "custom_fields": [
- {
- "label": "Event Reference Number",
- "placement": "ABOVE_LINE_ITEMS",
- "value": "Ref. #1234"
- },
- {
- "label": "Terms of Service",
- "placement": "BELOW_LINE_ITEMS",
- "value": "The terms of service are..."
- }
- ],
- "delivery_method": "EMAIL",
- "description": "We appreciate your business!",
- "id": "inv:0-ChCHu2mZEabLeeHahQnXDjZQECY",
- "invoice_number": "inv-100",
- "location_id": "ES0RJRZYEC39A",
- "next_payment_amount_money": {
- "amount": 10000,
- "currency": "USD"
- },
- "order_id": "CAISENgvlJ6jLWAzERDzjyHVybY",
- "payment_requests": [
- {
- "automatic_payment_source": "NONE",
- "computed_amount_money": {
- "amount": 10000,
- "currency": "USD"
- },
- "due_date": "2030-01-24",
- "request_type": "BALANCE",
- "tipping_enabled": false,
- "total_completed_amount_money": {
- "amount": 0,
- "currency": "USD"
- },
- "uid": "2da7964f-f3d2-4f43-81e8-5aa220bf3355"
- }
- ],
- "primary_recipient": {
- "customer_id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "email_address": "Amelia.Earhart@example.com",
- "family_name": "Earhart",
- "given_name": "Amelia",
- "phone_number": "1-212-555-4240",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- },
- "sale_or_service_date": "2030-01-24",
- "scheduled_at": "2030-01-13T10:00:00Z",
- "status": "UNPAID",
- "store_payment_method_enabled": false,
- "timezone": "America/Los_Angeles",
- "title": "Event Planning Services",
- "updated_at": "2020-06-18T18:23:11Z",
- "version": 2
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-item-modifier-lists-request.md b/doc/models/update-item-modifier-lists-request.md
deleted file mode 100644
index 6e7fec61..00000000
--- a/doc/models/update-item-modifier-lists-request.md
+++ /dev/null
@@ -1,33 +0,0 @@
-
-# Update Item Modifier Lists Request
-
-## Structure
-
-`UpdateItemModifierListsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `itemIds` | `string[]` | Required | The IDs of the catalog items associated with the CatalogModifierList objects being updated. | getItemIds(): array | setItemIds(array itemIds): void |
-| `modifierListsToEnable` | `?(string[])` | Optional | The IDs of the CatalogModifierList objects to enable for the CatalogItem.
At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified. | getModifierListsToEnable(): ?array | setModifierListsToEnable(?array modifierListsToEnable): void |
-| `modifierListsToDisable` | `?(string[])` | Optional | The IDs of the CatalogModifierList objects to disable for the CatalogItem.
At least one of `modifier_lists_to_enable` or `modifier_lists_to_disable` must be specified. | getModifierListsToDisable(): ?array | setModifierListsToDisable(?array modifierListsToDisable): void |
-
-## Example (as JSON)
-
-```json
-{
- "item_ids": [
- "H42BRLUJ5KTZTTMPVSLFAACQ",
- "2JXOBJIHCWBQ4NZ3RIXQGJA6"
- ],
- "modifier_lists_to_disable": [
- "7WRC16CJZDVLSNDQ35PP6YAD"
- ],
- "modifier_lists_to_enable": [
- "H42BRLUJ5KTZTTMPVSLFAACQ",
- "2JXOBJIHCWBQ4NZ3RIXQGJA6"
- ]
-}
-```
-
diff --git a/doc/models/update-item-modifier-lists-response.md b/doc/models/update-item-modifier-lists-response.md
deleted file mode 100644
index 20fcbc3c..00000000
--- a/doc/models/update-item-modifier-lists-response.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-# Update Item Modifier Lists Response
-
-## Structure
-
-`UpdateItemModifierListsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `updatedAt` | `?string` | Optional | The database [timestamp](https://developer.squareup.com/docs/build-basics/common-data-types/working-with-dates) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "updated_at": "2016-11-16T22:25:24.878Z",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-item-taxes-request.md b/doc/models/update-item-taxes-request.md
deleted file mode 100644
index a8755901..00000000
--- a/doc/models/update-item-taxes-request.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Update Item Taxes Request
-
-## Structure
-
-`UpdateItemTaxesRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `itemIds` | `string[]` | Required | IDs for the CatalogItems associated with the CatalogTax objects being updated.
No more than 1,000 IDs may be provided. | getItemIds(): array | setItemIds(array itemIds): void |
-| `taxesToEnable` | `?(string[])` | Optional | IDs of the CatalogTax objects to enable.
At least one of `taxes_to_enable` or `taxes_to_disable` must be specified. | getTaxesToEnable(): ?array | setTaxesToEnable(?array taxesToEnable): void |
-| `taxesToDisable` | `?(string[])` | Optional | IDs of the CatalogTax objects to disable.
At least one of `taxes_to_enable` or `taxes_to_disable` must be specified. | getTaxesToDisable(): ?array | setTaxesToDisable(?array taxesToDisable): void |
-
-## Example (as JSON)
-
-```json
-{
- "item_ids": [
- "H42BRLUJ5KTZTTMPVSLFAACQ",
- "2JXOBJIHCWBQ4NZ3RIXQGJA6"
- ],
- "taxes_to_disable": [
- "AQCEGCEBBQONINDOHRGZISEX"
- ],
- "taxes_to_enable": [
- "4WRCNHCJZDVLSNDQ35PP6YAD"
- ]
-}
-```
-
diff --git a/doc/models/update-item-taxes-response.md b/doc/models/update-item-taxes-response.md
deleted file mode 100644
index dee8b924..00000000
--- a/doc/models/update-item-taxes-response.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-# Update Item Taxes Response
-
-## Structure
-
-`UpdateItemTaxesResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `updatedAt` | `?string` | Optional | The database [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) of this update in RFC 3339 format, e.g., `2016-09-04T23:59:33.123Z`. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "updated_at": "2016-11-16T22:25:24.878Z",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-job-request.md b/doc/models/update-job-request.md
deleted file mode 100644
index 0a8429b6..00000000
--- a/doc/models/update-job-request.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Update Job Request
-
-Represents an [UpdateJob](../../doc/apis/team.md#update-job) request.
-
-## Structure
-
-`UpdateJobRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `job` | [`Job`](../../doc/models/job.md) | Required | Represents a job that can be assigned to [team members](../../doc/models/team-member.md). This object defines the
job's title and tip eligibility. Compensation is defined in a [job assignment](../../doc/models/job-assignment.md)
in a team member's wage setting. | getJob(): Job | setJob(Job job): void |
-
-## Example (as JSON)
-
-```json
-{
- "job": {
- "is_tip_eligible": true,
- "title": "Cashier 1",
- "id": "id6",
- "created_at": "created_at4",
- "updated_at": "updated_at8"
- }
-}
-```
-
diff --git a/doc/models/update-job-response.md b/doc/models/update-job-response.md
deleted file mode 100644
index cceca940..00000000
--- a/doc/models/update-job-response.md
+++ /dev/null
@@ -1,52 +0,0 @@
-
-# Update Job Response
-
-Represents an [UpdateJob](../../doc/apis/team.md#update-job) response. Either `job` or `errors`
-is present in the response.
-
-## Structure
-
-`UpdateJobResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `job` | [`?Job`](../../doc/models/job.md) | Optional | Represents a job that can be assigned to [team members](../../doc/models/team-member.md). This object defines the
job's title and tip eligibility. Compensation is defined in a [job assignment](../../doc/models/job-assignment.md)
in a team member's wage setting. | getJob(): ?Job | setJob(?Job job): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | The errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "job": {
- "created_at": "2021-06-11T22:55:45Z",
- "id": "1yJlHapkseYnNPETIU1B",
- "is_tip_eligible": true,
- "title": "Cashier 1",
- "updated_at": "2021-06-13T12:55:45Z",
- "version": 2
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-location-custom-attribute-definition-request.md b/doc/models/update-location-custom-attribute-definition-request.md
deleted file mode 100644
index 6128b863..00000000
--- a/doc/models/update-location-custom-attribute-definition-request.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Update Location Custom Attribute Definition Request
-
-Represents an [UpdateLocationCustomAttributeDefinition](../../doc/apis/location-custom-attributes.md#update-location-custom-attribute-definition) request.
-
-## Structure
-
-`UpdateLocationCustomAttributeDefinitionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Required | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): CustomAttributeDefinition | setCustomAttributeDefinition(CustomAttributeDefinition customAttributeDefinition): void |
-| `idempotencyKey` | `?string` | Optional | A unique identifier for this request, used to ensure idempotency. For more information,
see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "description": "Update the description as desired.",
- "visibility": "VISIBILITY_READ_ONLY",
- "key": "key2",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name2"
- },
- "idempotency_key": "idempotency_key2"
-}
-```
-
diff --git a/doc/models/update-location-custom-attribute-definition-response.md b/doc/models/update-location-custom-attribute-definition-response.md
deleted file mode 100644
index 6a812993..00000000
--- a/doc/models/update-location-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,57 +0,0 @@
-
-# Update Location Custom Attribute Definition Response
-
-Represents an [UpdateLocationCustomAttributeDefinition](../../doc/apis/location-custom-attributes.md#update-location-custom-attribute-definition) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`UpdateLocationCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`?CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Optional | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): ?CustomAttributeDefinition | setCustomAttributeDefinition(?CustomAttributeDefinition customAttributeDefinition): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "created_at": "2022-12-02T19:06:36.559Z",
- "description": "Update the description as desired.",
- "key": "bestseller",
- "name": "Bestseller",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-12-02T19:34:10.181Z",
- "version": 2,
- "visibility": "VISIBILITY_READ_ONLY"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-location-request.md b/doc/models/update-location-request.md
deleted file mode 100644
index bab66f98..00000000
--- a/doc/models/update-location-request.md
+++ /dev/null
@@ -1,57 +0,0 @@
-
-# Update Location Request
-
-The request object for the [UpdateLocation](../../doc/apis/locations.md#update-location) endpoint.
-
-## Structure
-
-`UpdateLocationRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `location` | [`?Location`](../../doc/models/location.md) | Optional | Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api). | getLocation(): ?Location | setLocation(?Location location): void |
-
-## Example (as JSON)
-
-```json
-{
- "location": {
- "business_hours": {
- "periods": [
- {
- "day_of_week": "FRI",
- "end_local_time": "18:00",
- "start_local_time": "07:00"
- },
- {
- "day_of_week": "SAT",
- "end_local_time": "18:00",
- "start_local_time": "07:00"
- },
- {
- "day_of_week": "SUN",
- "end_local_time": "15:00",
- "start_local_time": "09:00"
- }
- ]
- },
- "description": "Midtown Atlanta store - Open weekends",
- "id": "id4",
- "name": "name4",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- },
- "timezone": "timezone6",
- "capabilities": [
- "CREDIT_CARD_PROCESSING"
- ]
- }
-}
-```
-
diff --git a/doc/models/update-location-response.md b/doc/models/update-location-response.md
deleted file mode 100644
index 7561a003..00000000
--- a/doc/models/update-location-response.md
+++ /dev/null
@@ -1,87 +0,0 @@
-
-# Update Location Response
-
-The response object returned by the [UpdateLocation](../../doc/apis/locations.md#update-location) endpoint.
-
-## Structure
-
-`UpdateLocationResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `location` | [`?Location`](../../doc/models/location.md) | Optional | Represents one of a business' [locations](https://developer.squareup.com/docs/locations-api). | getLocation(): ?Location | setLocation(?Location location): void |
-
-## Example (as JSON)
-
-```json
-{
- "location": {
- "address": {
- "address_line_1": "1234 Peachtree St. NE",
- "administrative_district_level_1": "GA",
- "locality": "Atlanta",
- "postal_code": "30309",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "sublocality": "sublocality6"
- },
- "business_hours": {
- "periods": [
- {
- "day_of_week": "FRI",
- "end_local_time": "18:00",
- "start_local_time": "07:00"
- },
- {
- "day_of_week": "SAT",
- "end_local_time": "18:00",
- "start_local_time": "07:00"
- },
- {
- "day_of_week": "SUN",
- "end_local_time": "15:00",
- "start_local_time": "09:00"
- }
- ]
- },
- "business_name": "Jet Fuel Coffee",
- "capabilities": [
- "CREDIT_CARD_PROCESSING"
- ],
- "coordinates": {
- "latitude": 33.7889,
- "longitude": -84.3841
- },
- "country": "US",
- "created_at": "2022-02-19T17:58:25Z",
- "currency": "USD",
- "description": "Midtown Atlanta store - Open weekends",
- "id": "3Z4V4WHQK64X9",
- "language_code": "en-US",
- "mcc": "7299",
- "merchant_id": "3MYCJG5GVYQ8Q",
- "name": "Midtown",
- "status": "ACTIVE",
- "timezone": "America/New_York",
- "type": "PHYSICAL"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-location-settings-request.md b/doc/models/update-location-settings-request.md
deleted file mode 100644
index 135165dc..00000000
--- a/doc/models/update-location-settings-request.md
+++ /dev/null
@@ -1,68 +0,0 @@
-
-# Update Location Settings Request
-
-## Structure
-
-`UpdateLocationSettingsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `locationSettings` | [`CheckoutLocationSettings`](../../doc/models/checkout-location-settings.md) | Required | - | getLocationSettings(): CheckoutLocationSettings | setLocationSettings(CheckoutLocationSettings locationSettings): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_settings": {
- "location_id": "location_id0",
- "customer_notes_enabled": false,
- "policies": [
- {
- "uid": "uid8",
- "title": "title4",
- "description": "description8"
- },
- {
- "uid": "uid8",
- "title": "title4",
- "description": "description8"
- },
- {
- "uid": "uid8",
- "title": "title4",
- "description": "description8"
- }
- ],
- "branding": {
- "header_type": "FULL_WIDTH_LOGO",
- "button_color": "button_color2",
- "button_shape": "PILL"
- },
- "tipping": {
- "percentages": [
- 246,
- 247
- ],
- "smart_tipping_enabled": false,
- "default_percent": 46,
- "smart_tips": [
- {
- "amount": 152,
- "currency": "GEL"
- },
- {
- "amount": 152,
- "currency": "GEL"
- }
- ],
- "default_smart_tip": {
- "amount": 58,
- "currency": "KWD"
- }
- }
- }
-}
-```
-
diff --git a/doc/models/update-location-settings-response.md b/doc/models/update-location-settings-response.md
deleted file mode 100644
index 89d4d6b8..00000000
--- a/doc/models/update-location-settings-response.md
+++ /dev/null
@@ -1,104 +0,0 @@
-
-# Update Location Settings Response
-
-## Structure
-
-`UpdateLocationSettingsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred when updating the location settings. | getErrors(): ?array | setErrors(?array errors): void |
-| `locationSettings` | [`?CheckoutLocationSettings`](../../doc/models/checkout-location-settings.md) | Optional | - | getLocationSettings(): ?CheckoutLocationSettings | setLocationSettings(?CheckoutLocationSettings locationSettings): void |
-
-## Example (as JSON)
-
-```json
-{
- "location_settings": {
- "branding": {
- "button_color": "#00b23b",
- "button_shape": "ROUNDED",
- "header_type": "FRAMED_LOGO"
- },
- "customer_notes_enabled": false,
- "location_id": "LOCATION_ID_1",
- "policies": [
- {
- "description": "This is my Return Policy",
- "title": "Return Policy",
- "uid": "POLICY_ID_1"
- },
- {
- "description": "Items may be returned within 30 days of purchase.",
- "title": "Return Policy",
- "uid": "POLICY_ID_2"
- }
- ],
- "tipping": {
- "default_percent": 20,
- "default_whole_amount_money": {
- "amount": 100,
- "currency": "USD"
- },
- "percentages": [
- 15,
- 20,
- 25
- ],
- "smart_tipping_enabled": true,
- "whole_amounts": [
- {
- "amount": 1000,
- "currency": "USD"
- },
- {
- "amount": 1500,
- "currency": "USD"
- },
- {
- "amount": 2000,
- "currency": "USD"
- }
- ],
- "smart_tips": [
- {
- "amount": 152,
- "currency": "GEL"
- },
- {
- "amount": 152,
- "currency": "GEL"
- }
- ],
- "default_smart_tip": {
- "amount": 58,
- "currency": "KWD"
- }
- },
- "updated_at": "2022-06-16T22:25:35Z"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-merchant-custom-attribute-definition-request.md b/doc/models/update-merchant-custom-attribute-definition-request.md
deleted file mode 100644
index add3b479..00000000
--- a/doc/models/update-merchant-custom-attribute-definition-request.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Update Merchant Custom Attribute Definition Request
-
-Represents an [UpdateMerchantCustomAttributeDefinition](../../doc/apis/merchant-custom-attributes.md#update-merchant-custom-attribute-definition) request.
-
-## Structure
-
-`UpdateMerchantCustomAttributeDefinitionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Required | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): CustomAttributeDefinition | setCustomAttributeDefinition(CustomAttributeDefinition customAttributeDefinition): void |
-| `idempotencyKey` | `?string` | Optional | A unique identifier for this request, used to ensure idempotency. For more information,
see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "description": "Update the description as desired.",
- "visibility": "VISIBILITY_READ_ONLY",
- "key": "key2",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name2"
- },
- "idempotency_key": "idempotency_key4"
-}
-```
-
diff --git a/doc/models/update-merchant-custom-attribute-definition-response.md b/doc/models/update-merchant-custom-attribute-definition-response.md
deleted file mode 100644
index 0300b5c3..00000000
--- a/doc/models/update-merchant-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,45 +0,0 @@
-
-# Update Merchant Custom Attribute Definition Response
-
-Represents an [UpdateMerchantCustomAttributeDefinition](../../doc/apis/merchant-custom-attributes.md#update-merchant-custom-attribute-definition) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`UpdateMerchantCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`?CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Optional | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): ?CustomAttributeDefinition | setCustomAttributeDefinition(?CustomAttributeDefinition customAttributeDefinition): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "created_at": "2023-05-05T19:06:36.559Z",
- "description": "Update the description as desired.",
- "key": "alternative_seller_name",
- "name": "Alternative Merchant Name",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2023-05-05T19:34:10.181Z",
- "version": 2,
- "visibility": "VISIBILITY_READ_ONLY"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-merchant-settings-request.md b/doc/models/update-merchant-settings-request.md
deleted file mode 100644
index eb887bad..00000000
--- a/doc/models/update-merchant-settings-request.md
+++ /dev/null
@@ -1,57 +0,0 @@
-
-# Update Merchant Settings Request
-
-## Structure
-
-`UpdateMerchantSettingsRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `merchantSettings` | [`CheckoutMerchantSettings`](../../doc/models/checkout-merchant-settings.md) | Required | - | getMerchantSettings(): CheckoutMerchantSettings | setMerchantSettings(CheckoutMerchantSettings merchantSettings): void |
-
-## Example (as JSON)
-
-```json
-{
- "merchant_settings": {
- "payment_methods": {
- "apple_pay": {
- "enabled": false
- },
- "google_pay": {
- "enabled": false
- },
- "cash_app": {
- "enabled": false
- },
- "afterpay_clearpay": {
- "order_eligibility_range": {
- "min": {
- "amount": 34,
- "currency": "OMR"
- },
- "max": {
- "amount": 140,
- "currency": "JPY"
- }
- },
- "item_eligibility_range": {
- "min": {
- "amount": 34,
- "currency": "OMR"
- },
- "max": {
- "amount": 140,
- "currency": "JPY"
- }
- },
- "enabled": false
- }
- },
- "updated_at": "updated_at6"
- }
-}
-```
-
diff --git a/doc/models/update-merchant-settings-response.md b/doc/models/update-merchant-settings-response.md
deleted file mode 100644
index a48d6b2b..00000000
--- a/doc/models/update-merchant-settings-response.md
+++ /dev/null
@@ -1,76 +0,0 @@
-
-# Update Merchant Settings Response
-
-## Structure
-
-`UpdateMerchantSettingsResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred when updating the merchant settings. | getErrors(): ?array | setErrors(?array errors): void |
-| `merchantSettings` | [`?CheckoutMerchantSettings`](../../doc/models/checkout-merchant-settings.md) | Optional | - | getMerchantSettings(): ?CheckoutMerchantSettings | setMerchantSettings(?CheckoutMerchantSettings merchantSettings): void |
-
-## Example (as JSON)
-
-```json
-{
- "merchant_settings": {
- "merchant_id": "MERCHANT_ID",
- "payment_methods": {
- "afterpay_clearpay": {
- "enabled": true,
- "item_eligibility_range": {
- "max": {
- "amount": 10000,
- "currency": "USD"
- },
- "min": {
- "amount": 100,
- "currency": "USD"
- }
- },
- "order_eligibility_range": {
- "max": {
- "amount": 10000,
- "currency": "USD"
- },
- "min": {
- "amount": 100,
- "currency": "USD"
- }
- }
- },
- "apple_pay": {
- "enabled": false
- },
- "cash_app_pay": {
- "enabled": true
- },
- "google_pay": {
- "enabled": true
- },
- "cash_app": {
- "enabled": false
- }
- },
- "updated_at": "2022-06-16T22:25:35Z"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-order-custom-attribute-definition-request.md b/doc/models/update-order-custom-attribute-definition-request.md
deleted file mode 100644
index f1d5bc99..00000000
--- a/doc/models/update-order-custom-attribute-definition-request.md
+++ /dev/null
@@ -1,35 +0,0 @@
-
-# Update Order Custom Attribute Definition Request
-
-Represents an update request for an order custom attribute definition.
-
-## Structure
-
-`UpdateOrderCustomAttributeDefinitionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Required | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): CustomAttributeDefinition | setCustomAttributeDefinition(CustomAttributeDefinition customAttributeDefinition): void |
-| `idempotencyKey` | `?string` | Optional | A unique identifier for this request, used to ensure idempotency.
For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "key": "cover-count",
- "version": 1,
- "visibility": "VISIBILITY_READ_ONLY",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name2",
- "description": "description8"
- },
- "idempotency_key": "IDEMPOTENCY_KEY"
-}
-```
-
diff --git a/doc/models/update-order-custom-attribute-definition-response.md b/doc/models/update-order-custom-attribute-definition-response.md
deleted file mode 100644
index 4aa67e6c..00000000
--- a/doc/models/update-order-custom-attribute-definition-response.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Update Order Custom Attribute Definition Response
-
-Represents a response from updating an order custom attribute definition.
-
-## Structure
-
-`UpdateOrderCustomAttributeDefinitionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttributeDefinition` | [`?CustomAttributeDefinition`](../../doc/models/custom-attribute-definition.md) | Optional | Represents a definition for custom attribute values. A custom attribute definition
specifies the key, visibility, schema, and other properties for a custom attribute. | getCustomAttributeDefinition(): ?CustomAttributeDefinition | setCustomAttributeDefinition(?CustomAttributeDefinition customAttributeDefinition): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute_definition": {
- "created_at": "2022-11-16T16:53:23.141Z",
- "description": "The number of people seated at a table",
- "key": "cover-count",
- "name": "Cover count",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "updated_at": "2022-11-16T17:44:11.436Z",
- "version": 2,
- "visibility": "VISIBILITY_READ_ONLY"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-order-request.md b/doc/models/update-order-request.md
deleted file mode 100644
index 57d00bf2..00000000
--- a/doc/models/update-order-request.md
+++ /dev/null
@@ -1,64 +0,0 @@
-
-# Update Order Request
-
-Defines the fields that are included in requests to the
-[UpdateOrder](../../doc/apis/orders.md#update-order) endpoint.
-
-## Structure
-
-`UpdateOrderRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `order` | [`?Order`](../../doc/models/order.md) | Optional | Contains all information related to a single order to process with Square,
including line items that specify the products to purchase. `Order` objects also
include information about any associated tenders, refunds, and returns.
All Connect V2 Transactions have all been converted to Orders including all associated
itemization data. | getOrder(): ?Order | setOrder(?Order order): void |
-| `fieldsToClear` | `?(string[])` | Optional | The [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#identifying-fields-to-delete)
fields to clear. For example, `line_items[uid].note`.
For more information, see [Deleting fields](https://developer.squareup.com/docs/orders-api/manage-orders/update-orders#deleting-fields). | getFieldsToClear(): ?array | setFieldsToClear(?array fieldsToClear): void |
-| `idempotencyKey` | `?string` | Optional | A value you specify that uniquely identifies this update request.
If you are unsure whether a particular update was applied to an order successfully,
you can reattempt it with the same idempotency key without
worrying about creating duplicate updates to the order.
The latest order version is returned.
For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `192` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "order": {
- "id": "id6",
- "location_id": "location_id0",
- "reference_id": "reference_id4",
- "source": {
- "name": "name4"
- },
- "customer_id": "customer_id4",
- "line_items": [
- {
- "uid": "uid8",
- "name": "name8",
- "quantity": "quantity4",
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- }
- ]
- },
- "fields_to_clear": [
- "fields_to_clear7",
- "fields_to_clear8",
- "fields_to_clear9"
- ],
- "idempotency_key": "idempotency_key2"
-}
-```
-
diff --git a/doc/models/update-order-response.md b/doc/models/update-order-response.md
deleted file mode 100644
index f9d9786e..00000000
--- a/doc/models/update-order-response.md
+++ /dev/null
@@ -1,187 +0,0 @@
-
-# Update Order Response
-
-Defines the fields that are included in the response body of
-a request to the [UpdateOrder](../../doc/apis/orders.md#update-order) endpoint.
-
-## Structure
-
-`UpdateOrderResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `order` | [`?Order`](../../doc/models/order.md) | Optional | Contains all information related to a single order to process with Square,
including line items that specify the products to purchase. `Order` objects also
include information about any associated tenders, refunds, and returns.
All Connect V2 Transactions have all been converted to Orders including all associated
itemization data. | getOrder(): ?Order | setOrder(?Order order): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "order": {
- "created_at": "2019-08-23T18:26:18.243Z",
- "id": "DREk7wJcyXNHqULq8JJ2iPAsluJZY",
- "line_items": [
- {
- "base_price_money": {
- "amount": 500,
- "currency": "USD"
- },
- "gross_sales_money": {
- "amount": 500,
- "currency": "USD"
- },
- "name": "Small Coffee",
- "quantity": "1",
- "total_discount_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_money": {
- "amount": 500,
- "currency": "USD"
- },
- "total_service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 0,
- "currency": "USD"
- },
- "uid": "EuYkakhmu3ksHIds5Hiot",
- "variation_total_price_money": {
- "amount": 500,
- "currency": "USD"
- },
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- },
- {
- "base_price_money": {
- "amount": 200,
- "currency": "USD"
- },
- "gross_sales_money": {
- "amount": 400,
- "currency": "USD"
- },
- "name": "COOKIE",
- "quantity": "2",
- "total_discount_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_money": {
- "amount": 400,
- "currency": "USD"
- },
- "total_service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 0,
- "currency": "USD"
- },
- "uid": "cookie_uid",
- "variation_total_price_money": {
- "amount": 400,
- "currency": "USD"
- },
- "quantity_unit": {
- "measurement_unit": {
- "custom_unit": {
- "name": "name2",
- "abbreviation": "abbreviation4"
- },
- "area_unit": "IMPERIAL_ACRE",
- "length_unit": "IMPERIAL_INCH",
- "volume_unit": "METRIC_LITER",
- "weight_unit": "IMPERIAL_WEIGHT_OUNCE"
- },
- "precision": 54,
- "catalog_object_id": "catalog_object_id0",
- "catalog_version": 12
- },
- "note": "note4",
- "catalog_object_id": "catalog_object_id2"
- }
- ],
- "location_id": "MXVQSVNDGN3C8",
- "net_amounts": {
- "discount_money": {
- "amount": 0,
- "currency": "USD"
- },
- "service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "tax_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_money": {
- "amount": 900,
- "currency": "USD"
- }
- },
- "source": {
- "name": "Cookies"
- },
- "state": "OPEN",
- "total_discount_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_money": {
- "amount": 900,
- "currency": "USD"
- },
- "total_service_charge_money": {
- "amount": 0,
- "currency": "USD"
- },
- "total_tax_money": {
- "amount": 0,
- "currency": "USD"
- },
- "updated_at": "2019-08-23T18:33:47.523Z",
- "version": 2,
- "reference_id": "reference_id4",
- "customer_id": "customer_id4"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-payment-link-request.md b/doc/models/update-payment-link-request.md
deleted file mode 100644
index 81b79215..00000000
--- a/doc/models/update-payment-link-request.md
+++ /dev/null
@@ -1,52 +0,0 @@
-
-# Update Payment Link Request
-
-## Structure
-
-`UpdatePaymentLinkRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `paymentLink` | [`PaymentLink`](../../doc/models/payment-link.md) | Required | - | getPaymentLink(): PaymentLink | setPaymentLink(PaymentLink paymentLink): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_link": {
- "checkout_options": {
- "ask_for_shipping_address": true,
- "allow_tipping": false,
- "custom_fields": [
- {
- "title": "title8"
- },
- {
- "title": "title8"
- }
- ],
- "subscription_plan_id": "subscription_plan_id8",
- "redirect_url": "redirect_url2",
- "merchant_support_email": "merchant_support_email8"
- },
- "version": 1,
- "id": "id2",
- "description": "description2",
- "order_id": "order_id6",
- "pre_populated_data": {
- "buyer_email": "buyer_email8",
- "buyer_phone_number": "buyer_phone_number0",
- "buyer_address": {
- "address_line_1": "address_line_12",
- "address_line_2": "address_line_22",
- "address_line_3": "address_line_38",
- "locality": "locality2",
- "sublocality": "sublocality2"
- }
- }
- }
-}
-```
-
diff --git a/doc/models/update-payment-link-response.md b/doc/models/update-payment-link-response.md
deleted file mode 100644
index 5a0ea5db..00000000
--- a/doc/models/update-payment-link-response.md
+++ /dev/null
@@ -1,78 +0,0 @@
-
-# Update Payment Link Response
-
-## Structure
-
-`UpdatePaymentLinkResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred when updating the payment link. | getErrors(): ?array | setErrors(?array errors): void |
-| `paymentLink` | [`?PaymentLink`](../../doc/models/payment-link.md) | Optional | - | getPaymentLink(): ?PaymentLink | setPaymentLink(?PaymentLink paymentLink): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment_link": {
- "checkout_options": {
- "ask_for_shipping_address": true,
- "allow_tipping": false,
- "custom_fields": [
- {
- "title": "title8"
- },
- {
- "title": "title8"
- }
- ],
- "subscription_plan_id": "subscription_plan_id8",
- "redirect_url": "redirect_url2",
- "merchant_support_email": "merchant_support_email8"
- },
- "created_at": "2022-04-26T00:15:15Z",
- "id": "TY4BWEDJ6AI5MBIV",
- "long_url": "https://checkout.square.site/EXAMPLE",
- "order_id": "Qqc8ypQGvxVwc46Cch4zHTaJqc4F",
- "payment_note": "test",
- "updated_at": "2022-04-26T00:18:24Z",
- "url": "https://square.link/u/EXAMPLE",
- "version": 2,
- "description": "description2",
- "pre_populated_data": {
- "buyer_email": "buyer_email8",
- "buyer_phone_number": "buyer_phone_number0",
- "buyer_address": {
- "address_line_1": "address_line_12",
- "address_line_2": "address_line_22",
- "address_line_3": "address_line_38",
- "locality": "locality2",
- "sublocality": "sublocality2"
- }
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-payment-request.md b/doc/models/update-payment-request.md
deleted file mode 100644
index 3f12741d..00000000
--- a/doc/models/update-payment-request.md
+++ /dev/null
@@ -1,39 +0,0 @@
-
-# Update Payment Request
-
-Describes a request to update a payment using
-[UpdatePayment](../../doc/apis/payments.md#update-payment).
-
-## Structure
-
-`UpdatePaymentRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `payment` | [`?Payment`](../../doc/models/payment.md) | Optional | Represents a payment processed by the Square API. | getPayment(): ?Payment | setPayment(?Payment payment): void |
-| `idempotencyKey` | `string` | Required | A unique string that identifies this `UpdatePayment` request. Keys can be any valid string
but must be unique for every `UpdatePayment` request.
For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `45` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "956f8b13-e4ec-45d6-85e8-d1d95ef0c5de",
- "payment": {
- "amount_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "tip_money": {
- "amount": 100,
- "currency": "USD"
- },
- "version_token": "ODhwVQ35xwlzRuoZEwKXucfu7583sPTzK48c5zoGd0g6o",
- "id": "id6",
- "created_at": "created_at4",
- "updated_at": "updated_at2"
- }
-}
-```
-
diff --git a/doc/models/update-payment-response.md b/doc/models/update-payment-response.md
deleted file mode 100644
index 4aead208..00000000
--- a/doc/models/update-payment-response.md
+++ /dev/null
@@ -1,111 +0,0 @@
-
-# Update Payment Response
-
-Defines the response returned by
-[UpdatePayment](../../doc/apis/payments.md#update-payment).
-
-## Structure
-
-`UpdatePaymentResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `payment` | [`?Payment`](../../doc/models/payment.md) | Optional | Represents a payment processed by the Square API. | getPayment(): ?Payment | setPayment(?Payment payment): void |
-
-## Example (as JSON)
-
-```json
-{
- "payment": {
- "amount_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "application_details": {
- "application_id": "sq0ids-TcgftTEtKxJTRF1lCFJ9TA",
- "square_product": "ECOMMERCE_API"
- },
- "approved_money": {
- "amount": 1000,
- "currency": "USD"
- },
- "capabilities": [
- "EDIT_AMOUNT_UP",
- "EDIT_AMOUNT_DOWN",
- "EDIT_TIP_AMOUNT_UP",
- "EDIT_TIP_AMOUNT_DOWN"
- ],
- "card_details": {
- "auth_result_code": "68aLBM",
- "avs_status": "AVS_ACCEPTED",
- "card": {
- "bin": "411111",
- "card_brand": "VISA",
- "card_type": "DEBIT",
- "exp_month": 11,
- "exp_year": 2022,
- "fingerprint": "sq-1-Hxim77tbdcbGejOejnoAklBVJed2YFLTmirfl8Q5XZzObTc8qY_U8RkwzoNL8dCEcQ",
- "last_4": "1111",
- "prepaid_type": "NOT_PREPAID"
- },
- "card_payment_timeline": {
- "authorized_at": "2021-10-13T20:26:44.364Z"
- },
- "cvv_status": "CVV_ACCEPTED",
- "entry_method": "ON_FILE",
- "statement_description": "SQ *EXAMPLE TEST GOSQ.C",
- "status": "AUTHORIZED"
- },
- "created_at": "2021-10-13T20:26:44.191Z",
- "customer_id": "W92WH6P11H4Z77CTET0RNTGFW8",
- "delay_action": "CANCEL",
- "delay_duration": "PT168H",
- "delayed_until": "2021-10-20T20:26:44.191Z",
- "id": "1QjqpBVyrI9S4H9sTGDWU9JeiWdZY",
- "location_id": "L88917AVBK2S5",
- "note": "Example Note",
- "order_id": "nUSN9TdxpiK3SrQg3wzmf6r8LP9YY",
- "receipt_number": "1Qjq",
- "risk_evaluation": {
- "created_at": "2021-10-13T20:26:45.271Z",
- "risk_level": "NORMAL"
- },
- "source_type": "CARD",
- "status": "APPROVED",
- "tip_money": {
- "amount": 100,
- "currency": "USD"
- },
- "total_money": {
- "amount": 1100,
- "currency": "USD"
- },
- "updated_at": "2021-10-13T20:26:44.364Z",
- "version_token": "rDrXnqiS7fJgexccgdpzmwqTiXui1aIKCp9EchZ7trE6o"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-shift-request.md b/doc/models/update-shift-request.md
deleted file mode 100644
index 9644e0c0..00000000
--- a/doc/models/update-shift-request.md
+++ /dev/null
@@ -1,56 +0,0 @@
-
-# Update Shift Request
-
-A request to update a `Shift` object.
-
-## Structure
-
-`UpdateShiftRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `shift` | [`Shift`](../../doc/models/shift.md) | Required | A record of the hourly rate, start, and end times for a single work shift
for an employee. This might include a record of the start and end times for breaks
taken during the shift. | getShift(): Shift | setShift(Shift shift): void |
-
-## Example (as JSON)
-
-```json
-{
- "shift": {
- "breaks": [
- {
- "break_type_id": "REGS1EQR1TPZ5",
- "end_at": "2019-01-25T06:16:00-05:00",
- "expected_duration": "PT5M",
- "id": "X7GAQYVVRRG6P",
- "is_paid": true,
- "name": "Tea Break",
- "start_at": "2019-01-25T06:11:00-05:00"
- }
- ],
- "declared_cash_tip_money": {
- "amount": 500,
- "currency": "USD"
- },
- "end_at": "2019-01-25T13:11:00-05:00",
- "location_id": "PAA1RJZZKXBFG",
- "start_at": "2019-01-25T03:11:00-05:00",
- "team_member_id": "ormj0jJJZ5OZIzxrZYJI",
- "version": 1,
- "wage": {
- "hourly_rate": {
- "amount": 1500,
- "currency": "USD"
- },
- "tip_eligible": true,
- "title": "Bartender",
- "job_id": "job_id0"
- },
- "id": "id4",
- "employee_id": "employee_id4",
- "timezone": "timezone4"
- }
-}
-```
-
diff --git a/doc/models/update-shift-response.md b/doc/models/update-shift-response.md
deleted file mode 100644
index ae1af642..00000000
--- a/doc/models/update-shift-response.md
+++ /dev/null
@@ -1,82 +0,0 @@
-
-# Update Shift Response
-
-The response to a request to update a `Shift`. The response contains
-the updated `Shift` object and might contain a set of `Error` objects if
-the request resulted in errors.
-
-## Structure
-
-`UpdateShiftResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `shift` | [`?Shift`](../../doc/models/shift.md) | Optional | A record of the hourly rate, start, and end times for a single work shift
for an employee. This might include a record of the start and end times for breaks
taken during the shift. | getShift(): ?Shift | setShift(?Shift shift): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "shift": {
- "breaks": [
- {
- "break_type_id": "REGS1EQR1TPZ5",
- "end_at": "2019-01-25T06:16:00-05:00",
- "expected_duration": "PT5M",
- "id": "X7GAQYVVRRG6P",
- "is_paid": true,
- "name": "Tea Break",
- "start_at": "2019-01-25T06:11:00-05:00"
- }
- ],
- "created_at": "2019-02-28T00:39:02Z",
- "declared_cash_tip_money": {
- "amount": 500,
- "currency": "USD"
- },
- "employee_id": "ormj0jJJZ5OZIzxrZYJI",
- "end_at": "2019-01-25T13:11:00-05:00",
- "id": "K0YH4CV5462JB",
- "location_id": "PAA1RJZZKXBFG",
- "start_at": "2019-01-25T03:11:00-05:00",
- "status": "CLOSED",
- "team_member_id": "ormj0jJJZ5OZIzxrZYJI",
- "timezone": "America/New_York",
- "updated_at": "2019-02-28T00:42:41Z",
- "version": 2,
- "wage": {
- "hourly_rate": {
- "amount": 1500,
- "currency": "USD"
- },
- "job_id": "dZtrPh5GSDGugyXGByesVp51",
- "tip_eligible": true,
- "title": "Bartender"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-subscription-request.md b/doc/models/update-subscription-request.md
deleted file mode 100644
index 184207cc..00000000
--- a/doc/models/update-subscription-request.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Update Subscription Request
-
-Defines input parameters in a request to the
-[UpdateSubscription](../../doc/apis/subscriptions.md#update-subscription) endpoint.
-
-## Structure
-
-`UpdateSubscriptionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `subscription` | [`?Subscription`](../../doc/models/subscription.md) | Optional | Represents a subscription purchased by a customer.
For more information, see
[Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions). | getSubscription(): ?Subscription | setSubscription(?Subscription subscription): void |
-
-## Example (as JSON)
-
-```json
-{
- "subscription": {
- "canceled_date": null,
- "card_id": "{NEW CARD ID}",
- "id": "id4",
- "location_id": "location_id8",
- "plan_variation_id": "plan_variation_id8",
- "customer_id": "customer_id2",
- "start_date": "start_date8"
- }
-}
-```
-
diff --git a/doc/models/update-subscription-response.md b/doc/models/update-subscription-response.md
deleted file mode 100644
index 1f012a92..00000000
--- a/doc/models/update-subscription-response.md
+++ /dev/null
@@ -1,58 +0,0 @@
-
-# Update Subscription Response
-
-Defines output parameters in a response from the
-[UpdateSubscription](../../doc/apis/subscriptions.md#update-subscription) endpoint.
-
-## Structure
-
-`UpdateSubscriptionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `subscription` | [`?Subscription`](../../doc/models/subscription.md) | Optional | Represents a subscription purchased by a customer.
For more information, see
[Manage Subscriptions](https://developer.squareup.com/docs/subscriptions-api/manage-subscriptions). | getSubscription(): ?Subscription | setSubscription(?Subscription subscription): void |
-
-## Example (as JSON)
-
-```json
-{
- "subscription": {
- "card_id": "{NEW CARD ID}",
- "charged_through_date": "2023-03-13",
- "created_at": "2023-01-30T19:27:32Z",
- "customer_id": "AM69AB81FT4479YH9HGWS1HZY8",
- "id": "7217d8ca-1fee-4446-a9e5-8540b5d8c9bb",
- "invoice_ids": [
- "inv:0-ChAPSfVYvNewckgf3x4iigN_ENMM",
- "inv:0-ChBQaCCLfjcm9WEUBGxvuydJENMM"
- ],
- "location_id": "LPJKHYR7WFDKN",
- "plan_variation_id": "XOUNEKCE6NSXQW5NTSQ73MMX",
- "source": {
- "name": "My Application"
- },
- "start_date": "2023-01-30",
- "status": "ACTIVE",
- "timezone": "UTC",
- "version": 3
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-team-member-request.md b/doc/models/update-team-member-request.md
deleted file mode 100644
index 8c24e190..00000000
--- a/doc/models/update-team-member-request.md
+++ /dev/null
@@ -1,61 +0,0 @@
-
-# Update Team Member Request
-
-Represents an update request for a `TeamMember` object.
-
-## Structure
-
-`UpdateTeamMemberRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `teamMember` | [`?TeamMember`](../../doc/models/team-member.md) | Optional | A record representing an individual team member for a business. | getTeamMember(): ?TeamMember | setTeamMember(?TeamMember teamMember): void |
-
-## Example (as JSON)
-
-```json
-{
- "team_member": {
- "assigned_locations": {
- "assignment_type": "EXPLICIT_LOCATIONS",
- "location_ids": [
- "YSGH2WBKG94QZ",
- "GA2Y9HSJ8KRYT"
- ],
- "wage_setting": {
- "is_overtime_exempt": true,
- "job_assignments": [
- {
- "annual_rate": {
- "amount": 3000000,
- "currency": "USD"
- },
- "job_id": "FjS8x95cqHiMenw4f1NAUH4P",
- "pay_type": "SALARY",
- "weekly_hours": 40
- },
- {
- "hourly_rate": {
- "amount": 1200,
- "currency": "USD"
- },
- "job_id": "VDNpRv8da51NU8qZFC5zDWpF",
- "pay_type": "HOURLY"
- }
- ]
- }
- },
- "email_address": "joe_doe@gmail.com",
- "family_name": "Doe",
- "given_name": "Joe",
- "phone_number": "+14159283333",
- "reference_id": "reference_id_1",
- "status": "ACTIVE",
- "id": "id6",
- "is_owner": false
- }
-}
-```
-
diff --git a/doc/models/update-team-member-response.md b/doc/models/update-team-member-response.md
deleted file mode 100644
index 538de70c..00000000
--- a/doc/models/update-team-member-response.md
+++ /dev/null
@@ -1,82 +0,0 @@
-
-# Update Team Member Response
-
-Represents a response from an update request containing the updated `TeamMember` object or error messages.
-
-## Structure
-
-`UpdateTeamMemberResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `teamMember` | [`?TeamMember`](../../doc/models/team-member.md) | Optional | A record representing an individual team member for a business. | getTeamMember(): ?TeamMember | setTeamMember(?TeamMember teamMember): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | The errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "team_member": {
- "assigned_locations": {
- "assignment_type": "EXPLICIT_LOCATIONS",
- "location_ids": [
- "GA2Y9HSJ8KRYT",
- "YSGH2WBKG94QZ"
- ]
- },
- "created_at": "2021-06-11T22:55:45Z",
- "email_address": "joe_doe@example.com",
- "family_name": "Doe",
- "given_name": "Joe",
- "id": "1yJlHapkseYnNPETIU1B",
- "is_owner": false,
- "phone_number": "+14159283333",
- "reference_id": "reference_id_1",
- "status": "ACTIVE",
- "updated_at": "2021-06-15T17:38:05Z",
- "wage_setting": {
- "created_at": "2021-06-11T22:55:45Z",
- "is_overtime_exempt": true,
- "job_assignments": [
- {
- "annual_rate": {
- "amount": 3000000,
- "currency": "USD"
- },
- "hourly_rate": {
- "amount": 1443,
- "currency": "USD"
- },
- "job_id": "FjS8x95cqHiMenw4f1NAUH4P",
- "job_title": "Manager",
- "pay_type": "SALARY",
- "weekly_hours": 40
- },
- {
- "hourly_rate": {
- "amount": 1200,
- "currency": "USD"
- },
- "job_id": "VDNpRv8da51NU8qZFC5zDWpF",
- "job_title": "Cashier",
- "pay_type": "HOURLY"
- }
- ],
- "team_member_id": "1yJlHapkseYnNPETIU1B",
- "updated_at": "2021-06-11T22:55:45Z",
- "version": 1
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-vendor-request.md b/doc/models/update-vendor-request.md
deleted file mode 100644
index daf12aad..00000000
--- a/doc/models/update-vendor-request.md
+++ /dev/null
@@ -1,39 +0,0 @@
-
-# Update Vendor Request
-
-Represents an input to a call to [UpdateVendor](../../doc/apis/vendors.md#update-vendor).
-
-## Structure
-
-`UpdateVendorRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `?string` | Optional | A client-supplied, universally unique identifier (UUID) for the
request.
See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) in the
[API Development 101](https://developer.squareup.com/docs/buildbasics) section for more
information.
**Constraints**: *Maximum Length*: `128` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-| `vendor` | [`Vendor`](../../doc/models/vendor.md) | Required | Represents a supplier to a seller. | getVendor(): Vendor | setVendor(Vendor vendor): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe",
- "vendor": {
- "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "name": "Jack's Chicken Shack",
- "status": "ACTIVE",
- "version": 1,
- "created_at": "created_at4",
- "updated_at": "updated_at2",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
- }
-}
-```
-
diff --git a/doc/models/update-vendor-response.md b/doc/models/update-vendor-response.md
deleted file mode 100644
index b5157754..00000000
--- a/doc/models/update-vendor-response.md
+++ /dev/null
@@ -1,71 +0,0 @@
-
-# Update Vendor Response
-
-Represents an output from a call to [UpdateVendor](../../doc/apis/vendors.md#update-vendor).
-
-## Structure
-
-`UpdateVendorResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Errors occurred when the request fails. | getErrors(): ?array | setErrors(?array errors): void |
-| `vendor` | [`?Vendor`](../../doc/models/vendor.md) | Optional | Represents a supplier to a seller. | getVendor(): ?Vendor | setVendor(?Vendor vendor): void |
-
-## Example (as JSON)
-
-```json
-{
- "vendor": {
- "account_number": "4025391",
- "address": {
- "address_line_1": "505 Electric Ave",
- "address_line_2": "Suite 600",
- "administrative_district_level_1": "NY",
- "country": "US",
- "locality": "New York",
- "postal_code": "10003",
- "address_line_3": "address_line_32",
- "sublocality": "sublocality6"
- },
- "contacts": [
- {
- "email_address": "joe@joesfreshseafood.com",
- "id": "INV_VC_FMCYHBWT1TPL8MFH52PBMEN92A",
- "name": "Joe Burrow",
- "ordinal": 0,
- "phone_number": "1-212-555-4250"
- }
- ],
- "created_at": "2022-03-16T10:21:54.859Z",
- "id": "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4",
- "name": "Jack's Chicken Shack",
- "status": "ACTIVE",
- "updated_at": "2022-03-16T20:21:54.859Z",
- "version": 2
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-wage-setting-request.md b/doc/models/update-wage-setting-request.md
deleted file mode 100644
index 5af7a1de..00000000
--- a/doc/models/update-wage-setting-request.md
+++ /dev/null
@@ -1,58 +0,0 @@
-
-# Update Wage Setting Request
-
-Represents an update request for the `WageSetting` object describing a `TeamMember`.
-
-## Structure
-
-`UpdateWageSettingRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `wageSetting` | [`WageSetting`](../../doc/models/wage-setting.md) | Required | Represents information about the overtime exemption status, job assignments, and compensation
for a [team member](../../doc/models/team-member.md). | getWageSetting(): WageSetting | setWageSetting(WageSetting wageSetting): void |
-
-## Example (as JSON)
-
-```json
-{
- "wage_setting": {
- "is_overtime_exempt": true,
- "job_assignments": [
- {
- "annual_rate": {
- "amount": 3000000,
- "currency": "USD"
- },
- "job_title": "Manager",
- "pay_type": "SALARY",
- "weekly_hours": 40,
- "hourly_rate": {
- "amount": 172,
- "currency": "LAK"
- },
- "job_id": "job_id2"
- },
- {
- "hourly_rate": {
- "amount": 2000,
- "currency": "USD"
- },
- "job_title": "Cashier",
- "pay_type": "HOURLY",
- "annual_rate": {
- "amount": 232,
- "currency": "NIO"
- },
- "weekly_hours": 98,
- "job_id": "job_id2"
- }
- ],
- "team_member_id": "team_member_id8",
- "version": 130,
- "created_at": "created_at6"
- }
-}
-```
-
diff --git a/doc/models/update-wage-setting-response.md b/doc/models/update-wage-setting-response.md
deleted file mode 100644
index 20e4097a..00000000
--- a/doc/models/update-wage-setting-response.md
+++ /dev/null
@@ -1,75 +0,0 @@
-
-# Update Wage Setting Response
-
-Represents a response from an update request containing the updated `WageSetting` object
-or error messages.
-
-## Structure
-
-`UpdateWageSettingResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `wageSetting` | [`?WageSetting`](../../doc/models/wage-setting.md) | Optional | Represents information about the overtime exemption status, job assignments, and compensation
for a [team member](../../doc/models/team-member.md). | getWageSetting(): ?WageSetting | setWageSetting(?WageSetting wageSetting): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | The errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "wage_setting": {
- "created_at": "2019-07-10T17:26:48+00:00",
- "is_overtime_exempt": true,
- "job_assignments": [
- {
- "annual_rate": {
- "amount": 3000000,
- "currency": "USD"
- },
- "hourly_rate": {
- "amount": 1443,
- "currency": "USD"
- },
- "job_title": "Manager",
- "pay_type": "SALARY",
- "weekly_hours": 40,
- "job_id": "job_id2"
- },
- {
- "hourly_rate": {
- "amount": 2000,
- "currency": "USD"
- },
- "job_title": "Cashier",
- "pay_type": "HOURLY",
- "annual_rate": {
- "amount": 232,
- "currency": "NIO"
- },
- "weekly_hours": 98,
- "job_id": "job_id2"
- }
- ],
- "team_member_id": "-3oZQKPKVk6gUXU_V5Qa",
- "updated_at": "2020-06-11T23:12:04+00:00",
- "version": 1
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-webhook-subscription-request.md b/doc/models/update-webhook-subscription-request.md
deleted file mode 100644
index faf40eb5..00000000
--- a/doc/models/update-webhook-subscription-request.md
+++ /dev/null
@@ -1,32 +0,0 @@
-
-# Update Webhook Subscription Request
-
-Updates a [Subscription](../../doc/models/webhook-subscription.md).
-
-## Structure
-
-`UpdateWebhookSubscriptionRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `subscription` | [`?WebhookSubscription`](../../doc/models/webhook-subscription.md) | Optional | Represents the details of a webhook subscription, including notification URL,
event types, and signature key. | getSubscription(): ?WebhookSubscription | setSubscription(?WebhookSubscription subscription): void |
-
-## Example (as JSON)
-
-```json
-{
- "subscription": {
- "enabled": false,
- "name": "Updated Example Webhook Subscription",
- "id": "id4",
- "event_types": [
- "event_types2",
- "event_types3"
- ],
- "notification_url": "notification_url8"
- }
-}
-```
-
diff --git a/doc/models/update-webhook-subscription-response.md b/doc/models/update-webhook-subscription-response.md
deleted file mode 100644
index c4bdbbb7..00000000
--- a/doc/models/update-webhook-subscription-response.md
+++ /dev/null
@@ -1,48 +0,0 @@
-
-# Update Webhook Subscription Response
-
-Defines the fields that are included in the response body of
-a request to the [UpdateWebhookSubscription](../../doc/apis/webhook-subscriptions.md#update-webhook-subscription) endpoint.
-
-Note: If there are errors processing the request, the [Subscription](../../doc/models/webhook-subscription.md) is not
-present.
-
-## Structure
-
-`UpdateWebhookSubscriptionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `subscription` | [`?WebhookSubscription`](../../doc/models/webhook-subscription.md) | Optional | Represents the details of a webhook subscription, including notification URL,
event types, and signature key. | getSubscription(): ?WebhookSubscription | setSubscription(?WebhookSubscription subscription): void |
-
-## Example (as JSON)
-
-```json
-{
- "subscription": {
- "api_version": "2021-12-15",
- "created_at": "2022-01-10 23:29:48 +0000 UTC",
- "enabled": false,
- "event_types": [
- "payment.created",
- "payment.updated"
- ],
- "id": "wbhk_b35f6b3145074cf9ad513610786c19d5",
- "name": "Updated Example Webhook Subscription",
- "notification_url": "https://example-webhook-url.com",
- "updated_at": "2022-01-10 23:45:51 +0000 UTC"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-webhook-subscription-signature-key-request.md b/doc/models/update-webhook-subscription-signature-key-request.md
deleted file mode 100644
index 7a3680d7..00000000
--- a/doc/models/update-webhook-subscription-signature-key-request.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# Update Webhook Subscription Signature Key Request
-
-Updates a [Subscription](../../doc/models/webhook-subscription.md) by replacing the existing signature key with a new one.
-
-## Structure
-
-`UpdateWebhookSubscriptionSignatureKeyRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `?string` | Optional | A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey) request.
**Constraints**: *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "ed80ae6b-0654-473b-bbab-a39aee89a60d"
-}
-```
-
diff --git a/doc/models/update-webhook-subscription-signature-key-response.md b/doc/models/update-webhook-subscription-signature-key-response.md
deleted file mode 100644
index 84cd4591..00000000
--- a/doc/models/update-webhook-subscription-signature-key-response.md
+++ /dev/null
@@ -1,48 +0,0 @@
-
-# Update Webhook Subscription Signature Key Response
-
-Defines the fields that are included in the response body of
-a request to the [UpdateWebhookSubscriptionSignatureKey](../../doc/apis/webhook-subscriptions.md#update-webhook-subscription-signature-key) endpoint.
-
-Note: If there are errors processing the request, the [Subscription](../../doc/models/webhook-subscription.md) is not
-present.
-
-## Structure
-
-`UpdateWebhookSubscriptionSignatureKeyResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `signatureKey` | `?string` | Optional | The new Square-generated signature key used to validate the origin of the webhook event. | getSignatureKey(): ?string | setSignatureKey(?string signatureKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "signature_key": "1k9bIJKCeTmSQwyagtNRLg",
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/update-workweek-config-request.md b/doc/models/update-workweek-config-request.md
deleted file mode 100644
index 9407d0be..00000000
--- a/doc/models/update-workweek-config-request.md
+++ /dev/null
@@ -1,30 +0,0 @@
-
-# Update Workweek Config Request
-
-A request to update a `WorkweekConfig` object.
-
-## Structure
-
-`UpdateWorkweekConfigRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `workweekConfig` | [`WorkweekConfig`](../../doc/models/workweek-config.md) | Required | Sets the day of the week and hour of the day that a business starts a
workweek. This is used to calculate overtime pay. | getWorkweekConfig(): WorkweekConfig | setWorkweekConfig(WorkweekConfig workweekConfig): void |
-
-## Example (as JSON)
-
-```json
-{
- "workweek_config": {
- "start_of_day_local_time": "10:00",
- "start_of_week": "MON",
- "version": 10,
- "id": "id0",
- "created_at": "created_at8",
- "updated_at": "updated_at6"
- }
-}
-```
-
diff --git a/doc/models/update-workweek-config-response.md b/doc/models/update-workweek-config-response.md
deleted file mode 100644
index 6fb97137..00000000
--- a/doc/models/update-workweek-config-response.md
+++ /dev/null
@@ -1,53 +0,0 @@
-
-# Update Workweek Config Response
-
-The response to a request to update a `WorkweekConfig` object. The response contains
-the updated `WorkweekConfig` object and might contain a set of `Error` objects if
-the request resulted in errors.
-
-## Structure
-
-`UpdateWorkweekConfigResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `workweekConfig` | [`?WorkweekConfig`](../../doc/models/workweek-config.md) | Optional | Sets the day of the week and hour of the day that a business starts a
workweek. This is used to calculate overtime pay. | getWorkweekConfig(): ?WorkweekConfig | setWorkweekConfig(?WorkweekConfig workweekConfig): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "workweek_config": {
- "created_at": "2016-02-04T00:58:24Z",
- "id": "FY4VCAQN700GM",
- "start_of_day_local_time": "10:00",
- "start_of_week": "MON",
- "updated_at": "2019-02-28T01:04:35Z",
- "version": 11
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/upsert-booking-custom-attribute-request.md b/doc/models/upsert-booking-custom-attribute-request.md
deleted file mode 100644
index 6c28dd38..00000000
--- a/doc/models/upsert-booking-custom-attribute-request.md
+++ /dev/null
@@ -1,43 +0,0 @@
-
-# Upsert Booking Custom Attribute Request
-
-Represents an [UpsertBookingCustomAttribute](../../doc/apis/booking-custom-attributes.md#upsert-booking-custom-attribute) request.
-
-## Structure
-
-`UpsertBookingCustomAttributeRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttribute` | [`CustomAttribute`](../../doc/models/custom-attribute.md) | Required | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | getCustomAttribute(): CustomAttribute | setCustomAttribute(CustomAttribute customAttribute): void |
-| `idempotencyKey` | `?string` | Optional | A unique identifier for this request, used to ensure idempotency. For more information,
see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute": {
- "key": "key2",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 102,
- "visibility": "VISIBILITY_READ_ONLY",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- "idempotency_key": "idempotency_key4"
-}
-```
-
diff --git a/doc/models/upsert-booking-custom-attribute-response.md b/doc/models/upsert-booking-custom-attribute-response.md
deleted file mode 100644
index 32daedce..00000000
--- a/doc/models/upsert-booking-custom-attribute-response.md
+++ /dev/null
@@ -1,63 +0,0 @@
-
-# Upsert Booking Custom Attribute Response
-
-Represents an [UpsertBookingCustomAttribute](../../doc/apis/booking-custom-attributes.md#upsert-booking-custom-attribute) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`UpsertBookingCustomAttributeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttribute` | [`?CustomAttribute`](../../doc/models/custom-attribute.md) | Optional | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | getCustomAttribute(): ?CustomAttribute | setCustomAttribute(?CustomAttribute customAttribute): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute": {
- "key": "key2",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 102,
- "visibility": "VISIBILITY_READ_ONLY",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/upsert-catalog-object-request.md b/doc/models/upsert-catalog-object-request.md
deleted file mode 100644
index 65627b27..00000000
--- a/doc/models/upsert-catalog-object-request.md
+++ /dev/null
@@ -1,80 +0,0 @@
-
-# Upsert Catalog Object Request
-
-## Structure
-
-`UpsertCatalogObjectRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `idempotencyKey` | `string` | Required | A value you specify that uniquely identifies this
request among all your requests. A common way to create
a valid idempotency key is to use a Universally unique
identifier (UUID).
If you're unsure whether a particular request was successful,
you can reattempt it with the same idempotency key without
worrying about creating duplicate objects.
See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information.
**Constraints**: *Minimum Length*: `1` | getIdempotencyKey(): string | setIdempotencyKey(string idempotencyKey): void |
-| `object` | [`CatalogObject`](../../doc/models/catalog-object.md) | Required | The wrapper object for the catalog entries of a given object type.
Depending on the `type` attribute value, a `CatalogObject` instance assumes a type-specific data to yield the corresponding type of catalog object.
For example, if `type=ITEM`, the `CatalogObject` instance must have the ITEM-specific data set on the `item_data` attribute. The resulting `CatalogObject` instance is also a `CatalogItem` instance.
In general, if `type=`, the `CatalogObject` instance must have the ``-specific data set on the `_data` attribute. The resulting `CatalogObject` instance is also a `Catalog` instance.
For a more detailed discussion of the Catalog data model, please see the
[Design a Catalog](https://developer.squareup.com/docs/catalog-api/design-a-catalog) guide. | getObject(): CatalogObject | setObject(CatalogObject object): void |
-
-## Example (as JSON)
-
-```json
-{
- "idempotency_key": "af3d1afc-7212-4300-b463-0bfc5314a5ae",
- "object": {
- "id": "#Cocoa",
- "item_data": {
- "abbreviation": "Ch",
- "description_html": "Hot Chocolate
",
- "name": "Cocoa",
- "variations": [
- {
- "id": "#Small",
- "item_variation_data": {
- "item_id": "#Cocoa",
- "name": "Small",
- "pricing_type": "VARIABLE_PRICING"
- },
- "type": "ITEM_VARIATION"
- },
- {
- "id": "#Large",
- "item_variation_data": {
- "item_id": "#Cocoa",
- "name": "Large",
- "price_money": {
- "amount": 400,
- "currency": "USD"
- },
- "pricing_type": "FIXED_PRICING"
- },
- "type": "ITEM_VARIATION"
- }
- ]
- },
- "type": "ITEM",
- "updated_at": "updated_at8",
- "version": 4,
- "is_deleted": false,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- }
-}
-```
-
diff --git a/doc/models/upsert-catalog-object-response.md b/doc/models/upsert-catalog-object-response.md
deleted file mode 100644
index dce2efec..00000000
--- a/doc/models/upsert-catalog-object-response.md
+++ /dev/null
@@ -1,139 +0,0 @@
-
-# Upsert Catalog Object Response
-
-## Structure
-
-`UpsertCatalogObjectResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `catalogObject` | [`?CatalogObject`](../../doc/models/catalog-object.md) | Optional | The wrapper object for the catalog entries of a given object type.
Depending on the `type` attribute value, a `CatalogObject` instance assumes a type-specific data to yield the corresponding type of catalog object.
For example, if `type=ITEM`, the `CatalogObject` instance must have the ITEM-specific data set on the `item_data` attribute. The resulting `CatalogObject` instance is also a `CatalogItem` instance.
In general, if `type=`, the `CatalogObject` instance must have the ``-specific data set on the `_data` attribute. The resulting `CatalogObject` instance is also a `Catalog` instance.
For a more detailed discussion of the Catalog data model, please see the
[Design a Catalog](https://developer.squareup.com/docs/catalog-api/design-a-catalog) guide. | getCatalogObject(): ?CatalogObject | setCatalogObject(?CatalogObject catalogObject): void |
-| `idMappings` | [`?(CatalogIdMapping[])`](../../doc/models/catalog-id-mapping.md) | Optional | The mapping between client and server IDs for this upsert. | getIdMappings(): ?array | setIdMappings(?array idMappings): void |
-
-## Example (as JSON)
-
-```json
-{
- "catalog_object": {
- "id": "R2TA2FOBUGCJZNIWJSOSNAI4",
- "is_deleted": false,
- "item_data": {
- "abbreviation": "Ch",
- "description": "Hot Chocolate",
- "description_html": "Hot Chocolate
",
- "description_plaintext": "Hot Chocolate",
- "name": "Cocoa",
- "product_type": "REGULAR",
- "variations": [
- {
- "id": "QRT53UP4LITLWGOGBZCUWP63",
- "is_deleted": false,
- "item_variation_data": {
- "item_id": "R2TA2FOBUGCJZNIWJSOSNAI4",
- "name": "Small",
- "ordinal": 0,
- "pricing_type": "VARIABLE_PRICING",
- "stockable": true
- },
- "present_at_all_locations": true,
- "type": "ITEM_VARIATION",
- "updated_at": "2021-06-14T15:51:39.021Z",
- "version": 1623685899021
- },
- {
- "id": "NS77DKEIQ3AEQTCP727DSA7U",
- "is_deleted": false,
- "item_variation_data": {
- "item_id": "R2TA2FOBUGCJZNIWJSOSNAI4",
- "name": "Large",
- "ordinal": 1,
- "price_money": {
- "amount": 400,
- "currency": "USD"
- },
- "pricing_type": "FIXED_PRICING",
- "stockable": true
- },
- "present_at_all_locations": true,
- "type": "ITEM_VARIATION",
- "updated_at": "2021-06-14T15:51:39.021Z",
- "version": 1623685899021
- }
- ]
- },
- "present_at_all_locations": true,
- "type": "ITEM",
- "updated_at": "2021-06-14T15:51:39.021Z",
- "version": 1623685899021,
- "custom_attribute_values": {
- "key0": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key1": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- },
- "key2": {
- "name": "name8",
- "string_value": "string_value2",
- "custom_attribute_definition_id": "custom_attribute_definition_id4",
- "type": "STRING",
- "number_value": "number_value8"
- }
- },
- "catalog_v1_ids": [
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- },
- {
- "catalog_v1_id": "catalog_v1_id4",
- "location_id": "location_id4"
- }
- ]
- },
- "id_mappings": [
- {
- "client_object_id": "#Cocoa",
- "object_id": "R2TA2FOBUGCJZNIWJSOSNAI4"
- },
- {
- "client_object_id": "#Small",
- "object_id": "QRT53UP4LITLWGOGBZCUWP63"
- },
- {
- "client_object_id": "#Large",
- "object_id": "NS77DKEIQ3AEQTCP727DSA7U"
- }
- ],
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/upsert-customer-custom-attribute-request.md b/doc/models/upsert-customer-custom-attribute-request.md
deleted file mode 100644
index f8203607..00000000
--- a/doc/models/upsert-customer-custom-attribute-request.md
+++ /dev/null
@@ -1,43 +0,0 @@
-
-# Upsert Customer Custom Attribute Request
-
-Represents an [UpsertCustomerCustomAttribute](../../doc/apis/customer-custom-attributes.md#upsert-customer-custom-attribute) request.
-
-## Structure
-
-`UpsertCustomerCustomAttributeRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttribute` | [`CustomAttribute`](../../doc/models/custom-attribute.md) | Required | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | getCustomAttribute(): CustomAttribute | setCustomAttribute(CustomAttribute customAttribute): void |
-| `idempotencyKey` | `?string` | Optional | A unique identifier for this request, used to ensure idempotency. For more information,
see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute": {
- "key": "key2",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 102,
- "visibility": "VISIBILITY_READ_ONLY",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- "idempotency_key": "idempotency_key6"
-}
-```
-
diff --git a/doc/models/upsert-customer-custom-attribute-response.md b/doc/models/upsert-customer-custom-attribute-response.md
deleted file mode 100644
index b1d8c024..00000000
--- a/doc/models/upsert-customer-custom-attribute-response.md
+++ /dev/null
@@ -1,51 +0,0 @@
-
-# Upsert Customer Custom Attribute Response
-
-Represents an [UpsertCustomerCustomAttribute](../../doc/apis/customer-custom-attributes.md#upsert-customer-custom-attribute) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`UpsertCustomerCustomAttributeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttribute` | [`?CustomAttribute`](../../doc/models/custom-attribute.md) | Optional | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | getCustomAttribute(): ?CustomAttribute | setCustomAttribute(?CustomAttribute customAttribute): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute": {
- "key": "key2",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 102,
- "visibility": "VISIBILITY_READ_ONLY",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/upsert-location-custom-attribute-request.md b/doc/models/upsert-location-custom-attribute-request.md
deleted file mode 100644
index 0b94baca..00000000
--- a/doc/models/upsert-location-custom-attribute-request.md
+++ /dev/null
@@ -1,43 +0,0 @@
-
-# Upsert Location Custom Attribute Request
-
-Represents an [UpsertLocationCustomAttribute](../../doc/apis/location-custom-attributes.md#upsert-location-custom-attribute) request.
-
-## Structure
-
-`UpsertLocationCustomAttributeRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttribute` | [`CustomAttribute`](../../doc/models/custom-attribute.md) | Required | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | getCustomAttribute(): CustomAttribute | setCustomAttribute(CustomAttribute customAttribute): void |
-| `idempotencyKey` | `?string` | Optional | A unique identifier for this request, used to ensure idempotency. For more information,
see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute": {
- "key": "key2",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 102,
- "visibility": "VISIBILITY_READ_ONLY",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- "idempotency_key": "idempotency_key8"
-}
-```
-
diff --git a/doc/models/upsert-location-custom-attribute-response.md b/doc/models/upsert-location-custom-attribute-response.md
deleted file mode 100644
index afada6ed..00000000
--- a/doc/models/upsert-location-custom-attribute-response.md
+++ /dev/null
@@ -1,57 +0,0 @@
-
-# Upsert Location Custom Attribute Response
-
-Represents an [UpsertLocationCustomAttribute](../../doc/apis/location-custom-attributes.md#upsert-location-custom-attribute) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`UpsertLocationCustomAttributeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttribute` | [`?CustomAttribute`](../../doc/models/custom-attribute.md) | Optional | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | getCustomAttribute(): ?CustomAttribute | setCustomAttribute(?CustomAttribute customAttribute): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute": {
- "key": "key2",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 102,
- "visibility": "VISIBILITY_READ_ONLY",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/upsert-merchant-custom-attribute-request.md b/doc/models/upsert-merchant-custom-attribute-request.md
deleted file mode 100644
index 9a0a503c..00000000
--- a/doc/models/upsert-merchant-custom-attribute-request.md
+++ /dev/null
@@ -1,43 +0,0 @@
-
-# Upsert Merchant Custom Attribute Request
-
-Represents an [UpsertMerchantCustomAttribute](../../doc/apis/merchant-custom-attributes.md#upsert-merchant-custom-attribute) request.
-
-## Structure
-
-`UpsertMerchantCustomAttributeRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttribute` | [`CustomAttribute`](../../doc/models/custom-attribute.md) | Required | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | getCustomAttribute(): CustomAttribute | setCustomAttribute(CustomAttribute customAttribute): void |
-| `idempotencyKey` | `?string` | Optional | A unique identifier for this request, used to ensure idempotency. For more information,
see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute": {
- "key": "key2",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 102,
- "visibility": "VISIBILITY_READ_ONLY",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- "idempotency_key": "idempotency_key6"
-}
-```
-
diff --git a/doc/models/upsert-merchant-custom-attribute-response.md b/doc/models/upsert-merchant-custom-attribute-response.md
deleted file mode 100644
index 1c8bc27c..00000000
--- a/doc/models/upsert-merchant-custom-attribute-response.md
+++ /dev/null
@@ -1,51 +0,0 @@
-
-# Upsert Merchant Custom Attribute Response
-
-Represents an [UpsertMerchantCustomAttribute](../../doc/apis/merchant-custom-attributes.md#upsert-merchant-custom-attribute) response.
-Either `custom_attribute_definition` or `errors` is present in the response.
-
-## Structure
-
-`UpsertMerchantCustomAttributeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttribute` | [`?CustomAttribute`](../../doc/models/custom-attribute.md) | Optional | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | getCustomAttribute(): ?CustomAttribute | setCustomAttribute(?CustomAttribute customAttribute): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute": {
- "key": "key2",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 102,
- "visibility": "VISIBILITY_READ_ONLY",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/upsert-order-custom-attribute-request.md b/doc/models/upsert-order-custom-attribute-request.md
deleted file mode 100644
index 3f32476c..00000000
--- a/doc/models/upsert-order-custom-attribute-request.md
+++ /dev/null
@@ -1,43 +0,0 @@
-
-# Upsert Order Custom Attribute Request
-
-Represents an upsert request for an order custom attribute.
-
-## Structure
-
-`UpsertOrderCustomAttributeRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttribute` | [`CustomAttribute`](../../doc/models/custom-attribute.md) | Required | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | getCustomAttribute(): CustomAttribute | setCustomAttribute(CustomAttribute customAttribute): void |
-| `idempotencyKey` | `?string` | Optional | A unique identifier for this request, used to ensure idempotency.
For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `45` | getIdempotencyKey(): ?string | setIdempotencyKey(?string idempotencyKey): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute": {
- "key": "key2",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 102,
- "visibility": "VISIBILITY_READ_ONLY",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- "idempotency_key": "idempotency_key4"
-}
-```
-
diff --git a/doc/models/upsert-order-custom-attribute-response.md b/doc/models/upsert-order-custom-attribute-response.md
deleted file mode 100644
index c352736b..00000000
--- a/doc/models/upsert-order-custom-attribute-response.md
+++ /dev/null
@@ -1,62 +0,0 @@
-
-# Upsert Order Custom Attribute Response
-
-Represents a response from upserting order custom attribute definitions.
-
-## Structure
-
-`UpsertOrderCustomAttributeResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `customAttribute` | [`?CustomAttribute`](../../doc/models/custom-attribute.md) | Optional | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | getCustomAttribute(): ?CustomAttribute | setCustomAttribute(?CustomAttribute customAttribute): void |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "custom_attribute": {
- "key": "key2",
- "value": {
- "key1": "val1",
- "key2": "val2"
- },
- "version": 102,
- "visibility": "VISIBILITY_READ_ONLY",
- "definition": {
- "key": "key0",
- "schema": {
- "key1": "val1",
- "key2": "val2"
- },
- "name": "name0",
- "description": "description0",
- "visibility": "VISIBILITY_HIDDEN"
- }
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/upsert-snippet-request.md b/doc/models/upsert-snippet-request.md
deleted file mode 100644
index 61ce68b2..00000000
--- a/doc/models/upsert-snippet-request.md
+++ /dev/null
@@ -1,29 +0,0 @@
-
-# Upsert Snippet Request
-
-Represents an `UpsertSnippet` request.
-
-## Structure
-
-`UpsertSnippetRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `snippet` | [`Snippet`](../../doc/models/snippet.md) | Required | Represents the snippet that is added to a Square Online site. The snippet code is injected into the `head` element of all pages on the site, except for checkout pages. | getSnippet(): Snippet | setSnippet(Snippet snippet): void |
-
-## Example (as JSON)
-
-```json
-{
- "snippet": {
- "content": "",
- "id": "id0",
- "site_id": "site_id6",
- "created_at": "created_at8",
- "updated_at": "updated_at4"
- }
-}
-```
-
diff --git a/doc/models/upsert-snippet-response.md b/doc/models/upsert-snippet-response.md
deleted file mode 100644
index 2f91eff5..00000000
--- a/doc/models/upsert-snippet-response.md
+++ /dev/null
@@ -1,44 +0,0 @@
-
-# Upsert Snippet Response
-
-Represents an `UpsertSnippet` response. The response can include either `snippet` or `errors`.
-
-## Structure
-
-`UpsertSnippetResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `snippet` | [`?Snippet`](../../doc/models/snippet.md) | Optional | Represents the snippet that is added to a Square Online site. The snippet code is injected into the `head` element of all pages on the site, except for checkout pages. | getSnippet(): ?Snippet | setSnippet(?Snippet snippet): void |
-
-## Example (as JSON)
-
-```json
-{
- "snippet": {
- "content": "",
- "created_at": "2021-03-11T25:40:09.000000Z",
- "id": "snippet_5d178150-a6c0-11eb-a9f1-437e6a2881e7",
- "site_id": "site_278075276488921835",
- "updated_at": "2021-03-11T25:40:09.000000Z"
- },
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/v1-device.md b/doc/models/v1-device.md
deleted file mode 100644
index 5040bbe0..00000000
--- a/doc/models/v1-device.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# V1 Device
-
-## Structure
-
-`V1Device`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The device's Square-issued ID. | getId(): ?string | setId(?string id): void |
-| `name` | `?string` | Optional | The device's merchant-specified name. | getName(): ?string | setName(?string name): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id6",
- "name": "name6"
-}
-```
-
diff --git a/doc/models/v1-list-orders-request.md b/doc/models/v1-list-orders-request.md
deleted file mode 100644
index 8e3b4ff2..00000000
--- a/doc/models/v1-list-orders-request.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# V1 List Orders Request
-
-## Structure
-
-`V1ListOrdersRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `order` | [`?string(SortOrder)`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | getOrder(): ?string | setOrder(?string order): void |
-| `limit` | `?int` | Optional | The maximum number of payments to return in a single response. This value cannot exceed 200. | getLimit(): ?int | setLimit(?int limit): void |
-| `batchToken` | `?string` | Optional | A pagination cursor to retrieve the next set of results for your
original query to the endpoint. | getBatchToken(): ?string | setBatchToken(?string batchToken): void |
-
-## Example (as JSON)
-
-```json
-{
- "order": "DESC",
- "limit": 24,
- "batch_token": "batch_token4"
-}
-```
-
diff --git a/doc/models/v1-list-orders-response.md b/doc/models/v1-list-orders-response.md
deleted file mode 100644
index 245a7a1c..00000000
--- a/doc/models/v1-list-orders-response.md
+++ /dev/null
@@ -1,50 +0,0 @@
-
-# V1 List Orders Response
-
-## Structure
-
-`V1ListOrdersResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `items` | [`?(V1Order[])`](../../doc/models/v1-order.md) | Optional | - | getItems(): ?array | setItems(?array items): void |
-
-## Example (as JSON)
-
-```json
-{
- "items": [
- {
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "id": "id8",
- "buyer_email": "buyer_email0",
- "recipient_name": "recipient_name6",
- "recipient_phone_number": "recipient_phone_number6"
- },
- {
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "id": "id8",
- "buyer_email": "buyer_email0",
- "recipient_name": "recipient_name6",
- "recipient_phone_number": "recipient_phone_number6"
- }
- ]
-}
-```
-
diff --git a/doc/models/v1-money.md b/doc/models/v1-money.md
deleted file mode 100644
index ab2426cd..00000000
--- a/doc/models/v1-money.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# V1 Money
-
-## Structure
-
-`V1Money`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `amount` | `?int` | Optional | Amount in the lowest denominated value of this Currency. E.g. in USD
these are cents, in JPY they are Yen (which do not have a 'cent' concept). | getAmount(): ?int | setAmount(?int amount): void |
-| `currencyCode` | [`?string(Currency)`](../../doc/models/currency.md) | Optional | Indicates the associated currency for an amount of money. Values correspond
to [ISO 4217](https://wikipedia.org/wiki/ISO_4217). | getCurrencyCode(): ?string | setCurrencyCode(?string currencyCode): void |
-
-## Example (as JSON)
-
-```json
-{
- "amount": 24,
- "currency_code": "XPT"
-}
-```
-
diff --git a/doc/models/v1-order-history-entry-action.md b/doc/models/v1-order-history-entry-action.md
deleted file mode 100644
index 1d9f6752..00000000
--- a/doc/models/v1-order-history-entry-action.md
+++ /dev/null
@@ -1,19 +0,0 @@
-
-# V1 Order History Entry Action
-
-## Enumeration
-
-`V1OrderHistoryEntryAction`
-
-## Fields
-
-| Name |
-| --- |
-| `ORDER_PLACED` |
-| `DECLINED` |
-| `PAYMENT_RECEIVED` |
-| `CANCELED` |
-| `COMPLETED` |
-| `REFUNDED` |
-| `EXPIRED` |
-
diff --git a/doc/models/v1-order-history-entry.md b/doc/models/v1-order-history-entry.md
deleted file mode 100644
index dc0f7707..00000000
--- a/doc/models/v1-order-history-entry.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# V1 Order History Entry
-
-V1OrderHistoryEntry
-
-## Structure
-
-`V1OrderHistoryEntry`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `action` | [`?string(V1OrderHistoryEntryAction)`](../../doc/models/v1-order-history-entry-action.md) | Optional | - | getAction(): ?string | setAction(?string action): void |
-| `createdAt` | `?string` | Optional | The time when the action was performed, in ISO 8601 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "action": "EXPIRED",
- "created_at": "created_at8"
-}
-```
-
diff --git a/doc/models/v1-order-state.md b/doc/models/v1-order-state.md
deleted file mode 100644
index ed04b532..00000000
--- a/doc/models/v1-order-state.md
+++ /dev/null
@@ -1,18 +0,0 @@
-
-# V1 Order State
-
-## Enumeration
-
-`V1OrderState`
-
-## Fields
-
-| Name |
-| --- |
-| `PENDING` |
-| `OPEN` |
-| `COMPLETED` |
-| `CANCELED` |
-| `REFUNDED` |
-| `REJECTED` |
-
diff --git a/doc/models/v1-order.md b/doc/models/v1-order.md
deleted file mode 100644
index 677f5c31..00000000
--- a/doc/models/v1-order.md
+++ /dev/null
@@ -1,64 +0,0 @@
-
-# V1 Order
-
-V1Order
-
-## Structure
-
-`V1Order`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-| `id` | `?string` | Optional | The order's unique identifier. | getId(): ?string | setId(?string id): void |
-| `buyerEmail` | `?string` | Optional | The email address of the order's buyer. | getBuyerEmail(): ?string | setBuyerEmail(?string buyerEmail): void |
-| `recipientName` | `?string` | Optional | The name of the order's buyer. | getRecipientName(): ?string | setRecipientName(?string recipientName): void |
-| `recipientPhoneNumber` | `?string` | Optional | The phone number to use for the order's delivery. | getRecipientPhoneNumber(): ?string | setRecipientPhoneNumber(?string recipientPhoneNumber): void |
-| `state` | [`?string(V1OrderState)`](../../doc/models/v1-order-state.md) | Optional | - | getState(): ?string | setState(?string state): void |
-| `shippingAddress` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getShippingAddress(): ?Address | setShippingAddress(?Address shippingAddress): void |
-| `subtotalMoney` | [`?V1Money`](../../doc/models/v1-money.md) | Optional | - | getSubtotalMoney(): ?V1Money | setSubtotalMoney(?V1Money subtotalMoney): void |
-| `totalShippingMoney` | [`?V1Money`](../../doc/models/v1-money.md) | Optional | - | getTotalShippingMoney(): ?V1Money | setTotalShippingMoney(?V1Money totalShippingMoney): void |
-| `totalTaxMoney` | [`?V1Money`](../../doc/models/v1-money.md) | Optional | - | getTotalTaxMoney(): ?V1Money | setTotalTaxMoney(?V1Money totalTaxMoney): void |
-| `totalPriceMoney` | [`?V1Money`](../../doc/models/v1-money.md) | Optional | - | getTotalPriceMoney(): ?V1Money | setTotalPriceMoney(?V1Money totalPriceMoney): void |
-| `totalDiscountMoney` | [`?V1Money`](../../doc/models/v1-money.md) | Optional | - | getTotalDiscountMoney(): ?V1Money | setTotalDiscountMoney(?V1Money totalDiscountMoney): void |
-| `createdAt` | `?string` | Optional | The time when the order was created, in ISO 8601 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The time when the order was last modified, in ISO 8601 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `expiresAt` | `?string` | Optional | The time when the order expires if no action is taken, in ISO 8601 format. | getExpiresAt(): ?string | setExpiresAt(?string expiresAt): void |
-| `paymentId` | `?string` | Optional | The unique identifier of the payment associated with the order. | getPaymentId(): ?string | setPaymentId(?string paymentId): void |
-| `buyerNote` | `?string` | Optional | A note provided by the buyer when the order was created, if any. | getBuyerNote(): ?string | setBuyerNote(?string buyerNote): void |
-| `completedNote` | `?string` | Optional | A note provided by the merchant when the order's state was set to COMPLETED, if any | getCompletedNote(): ?string | setCompletedNote(?string completedNote): void |
-| `refundedNote` | `?string` | Optional | A note provided by the merchant when the order's state was set to REFUNDED, if any. | getRefundedNote(): ?string | setRefundedNote(?string refundedNote): void |
-| `canceledNote` | `?string` | Optional | A note provided by the merchant when the order's state was set to CANCELED, if any. | getCanceledNote(): ?string | setCanceledNote(?string canceledNote): void |
-| `tender` | [`?V1Tender`](../../doc/models/v1-tender.md) | Optional | A tender represents a discrete monetary exchange. Square represents this
exchange as a money object with a specific currency and amount, where the
amount is given in the smallest denomination of the given currency.
Square POS can accept more than one form of tender for a single payment (such
as by splitting a bill between a credit card and a gift card). The `tender`
field of the Payment object lists all forms of tender used for the payment.
Split tender payments behave slightly differently from single tender payments:
The receipt_url for a split tender corresponds only to the first tender listed
in the tender field. To get the receipt URLs for the remaining tenders, use
the receipt_url fields of the corresponding Tender objects.
*A note on gift cards**: when a customer purchases a Square gift card from a
merchant, the merchant receives the full amount of the gift card in the
associated payment.
When that gift card is used as a tender, the balance of the gift card is
reduced and the merchant receives no funds. A `Tender` object with a type of
`SQUARE_GIFT_CARD` indicates a gift card was used for some or all of the
associated payment. | getTender(): ?V1Tender | setTender(?V1Tender tender): void |
-| `orderHistory` | [`?(V1OrderHistoryEntry[])`](../../doc/models/v1-order-history-entry.md) | Optional | The history of actions associated with the order. | getOrderHistory(): ?array | setOrderHistory(?array orderHistory): void |
-| `promoCode` | `?string` | Optional | The promo code provided by the buyer, if any. | getPromoCode(): ?string | setPromoCode(?string promoCode): void |
-| `btcReceiveAddress` | `?string` | Optional | For Bitcoin transactions, the address that the buyer sent Bitcoin to. | getBtcReceiveAddress(): ?string | setBtcReceiveAddress(?string btcReceiveAddress): void |
-| `btcPriceSatoshi` | `?float` | Optional | For Bitcoin transactions, the price of the buyer's order in satoshi (100 million satoshi equals 1 BTC). | getBtcPriceSatoshi(): ?float | setBtcPriceSatoshi(?float btcPriceSatoshi): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ],
- "id": "id0",
- "buyer_email": "buyer_email8",
- "recipient_name": "recipient_name8",
- "recipient_phone_number": "recipient_phone_number4"
-}
-```
-
diff --git a/doc/models/v1-phone-number.md b/doc/models/v1-phone-number.md
deleted file mode 100644
index 0a9fb8f1..00000000
--- a/doc/models/v1-phone-number.md
+++ /dev/null
@@ -1,25 +0,0 @@
-
-# V1 Phone Number
-
-Represents a phone number.
-
-## Structure
-
-`V1PhoneNumber`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `callingCode` | `string` | Required | The phone number's international calling code. For US phone numbers, this value is +1. | getCallingCode(): string | setCallingCode(string callingCode): void |
-| `number` | `string` | Required | The phone number. | getNumber(): string | setNumber(string number): void |
-
-## Example (as JSON)
-
-```json
-{
- "calling_code": "calling_code0",
- "number": "number4"
-}
-```
-
diff --git a/doc/models/v1-tender-card-brand.md b/doc/models/v1-tender-card-brand.md
deleted file mode 100644
index cf0508a9..00000000
--- a/doc/models/v1-tender-card-brand.md
+++ /dev/null
@@ -1,23 +0,0 @@
-
-# V1 Tender Card Brand
-
-The brand of a credit card.
-
-## Enumeration
-
-`V1TenderCardBrand`
-
-## Fields
-
-| Name |
-| --- |
-| `OTHER_BRAND` |
-| `VISA` |
-| `MASTER_CARD` |
-| `AMERICAN_EXPRESS` |
-| `DISCOVER` |
-| `DISCOVER_DINERS` |
-| `JCB` |
-| `CHINA_UNIONPAY` |
-| `SQUARE_GIFT_CARD` |
-
diff --git a/doc/models/v1-tender-entry-method.md b/doc/models/v1-tender-entry-method.md
deleted file mode 100644
index 749c522f..00000000
--- a/doc/models/v1-tender-entry-method.md
+++ /dev/null
@@ -1,19 +0,0 @@
-
-# V1 Tender Entry Method
-
-## Enumeration
-
-`V1TenderEntryMethod`
-
-## Fields
-
-| Name |
-| --- |
-| `MANUAL` |
-| `SCANNED` |
-| `SQUARE_CASH` |
-| `SQUARE_WALLET` |
-| `SWIPED` |
-| `WEB_FORM` |
-| `OTHER` |
-
diff --git a/doc/models/v1-tender-type.md b/doc/models/v1-tender-type.md
deleted file mode 100644
index df7b569b..00000000
--- a/doc/models/v1-tender-type.md
+++ /dev/null
@@ -1,20 +0,0 @@
-
-# V1 Tender Type
-
-## Enumeration
-
-`V1TenderType`
-
-## Fields
-
-| Name |
-| --- |
-| `CREDIT_CARD` |
-| `CASH` |
-| `THIRD_PARTY_CARD` |
-| `NO_SALE` |
-| `SQUARE_WALLET` |
-| `SQUARE_GIFT_CARD` |
-| `UNKNOWN` |
-| `OTHER` |
-
diff --git a/doc/models/v1-tender.md b/doc/models/v1-tender.md
deleted file mode 100644
index 36d707e0..00000000
--- a/doc/models/v1-tender.md
+++ /dev/null
@@ -1,63 +0,0 @@
-
-# V1 Tender
-
-A tender represents a discrete monetary exchange. Square represents this
-exchange as a money object with a specific currency and amount, where the
-amount is given in the smallest denomination of the given currency.
-
-Square POS can accept more than one form of tender for a single payment (such
-as by splitting a bill between a credit card and a gift card). The `tender`
-field of the Payment object lists all forms of tender used for the payment.
-
-Split tender payments behave slightly differently from single tender payments:
-
-The receipt_url for a split tender corresponds only to the first tender listed
-in the tender field. To get the receipt URLs for the remaining tenders, use
-the receipt_url fields of the corresponding Tender objects.
-
-*A note on gift cards**: when a customer purchases a Square gift card from a
-merchant, the merchant receives the full amount of the gift card in the
-associated payment.
-
-When that gift card is used as a tender, the balance of the gift card is
-reduced and the merchant receives no funds. A `Tender` object with a type of
-`SQUARE_GIFT_CARD` indicates a gift card was used for some or all of the
-associated payment.
-
-## Structure
-
-`V1Tender`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The tender's unique ID. | getId(): ?string | setId(?string id): void |
-| `type` | [`?string(V1TenderType)`](../../doc/models/v1-tender-type.md) | Optional | - | getType(): ?string | setType(?string type): void |
-| `name` | `?string` | Optional | A human-readable description of the tender. | getName(): ?string | setName(?string name): void |
-| `employeeId` | `?string` | Optional | The ID of the employee that processed the tender. | getEmployeeId(): ?string | setEmployeeId(?string employeeId): void |
-| `receiptUrl` | `?string` | Optional | The URL of the receipt for the tender. | getReceiptUrl(): ?string | setReceiptUrl(?string receiptUrl): void |
-| `cardBrand` | [`?string(V1TenderCardBrand)`](../../doc/models/v1-tender-card-brand.md) | Optional | The brand of a credit card. | getCardBrand(): ?string | setCardBrand(?string cardBrand): void |
-| `panSuffix` | `?string` | Optional | The last four digits of the provided credit card's account number. | getPanSuffix(): ?string | setPanSuffix(?string panSuffix): void |
-| `entryMethod` | [`?string(V1TenderEntryMethod)`](../../doc/models/v1-tender-entry-method.md) | Optional | - | getEntryMethod(): ?string | setEntryMethod(?string entryMethod): void |
-| `paymentNote` | `?string` | Optional | Notes entered by the merchant about the tender at the time of payment, if any. Typically only present for tender with the type: OTHER. | getPaymentNote(): ?string | setPaymentNote(?string paymentNote): void |
-| `totalMoney` | [`?V1Money`](../../doc/models/v1-money.md) | Optional | - | getTotalMoney(): ?V1Money | setTotalMoney(?V1Money totalMoney): void |
-| `tenderedMoney` | [`?V1Money`](../../doc/models/v1-money.md) | Optional | - | getTenderedMoney(): ?V1Money | setTenderedMoney(?V1Money tenderedMoney): void |
-| `tenderedAt` | `?string` | Optional | The time when the tender was created, in ISO 8601 format. | getTenderedAt(): ?string | setTenderedAt(?string tenderedAt): void |
-| `settledAt` | `?string` | Optional | The time when the tender was settled, in ISO 8601 format. | getSettledAt(): ?string | setSettledAt(?string settledAt): void |
-| `changeBackMoney` | [`?V1Money`](../../doc/models/v1-money.md) | Optional | - | getChangeBackMoney(): ?V1Money | setChangeBackMoney(?V1Money changeBackMoney): void |
-| `refundedMoney` | [`?V1Money`](../../doc/models/v1-money.md) | Optional | - | getRefundedMoney(): ?V1Money | setRefundedMoney(?V1Money refundedMoney): void |
-| `isExchange` | `?bool` | Optional | Indicates whether or not the tender is associated with an exchange. If is_exchange is true, the tender represents the value of goods returned in an exchange not the actual money paid. The exchange value reduces the tender amounts needed to pay for items purchased in the exchange. | getIsExchange(): ?bool | setIsExchange(?bool isExchange): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id6",
- "type": "SQUARE_WALLET",
- "name": "name6",
- "employee_id": "employee_id4",
- "receipt_url": "receipt_url2"
-}
-```
-
diff --git a/doc/models/v1-update-order-request-action.md b/doc/models/v1-update-order-request-action.md
deleted file mode 100644
index 6fd004a5..00000000
--- a/doc/models/v1-update-order-request-action.md
+++ /dev/null
@@ -1,15 +0,0 @@
-
-# V1 Update Order Request Action
-
-## Enumeration
-
-`V1UpdateOrderRequestAction`
-
-## Fields
-
-| Name |
-| --- |
-| `COMPLETE` |
-| `CANCEL` |
-| `REFUND` |
-
diff --git a/doc/models/v1-update-order-request.md b/doc/models/v1-update-order-request.md
deleted file mode 100644
index b9f59623..00000000
--- a/doc/models/v1-update-order-request.md
+++ /dev/null
@@ -1,31 +0,0 @@
-
-# V1 Update Order Request
-
-V1UpdateOrderRequest
-
-## Structure
-
-`V1UpdateOrderRequest`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `action` | [`string(V1UpdateOrderRequestAction)`](../../doc/models/v1-update-order-request-action.md) | Required | - | getAction(): string | setAction(string action): void |
-| `shippedTrackingNumber` | `?string` | Optional | The tracking number of the shipment associated with the order. Only valid if action is COMPLETE. | getShippedTrackingNumber(): ?string | setShippedTrackingNumber(?string shippedTrackingNumber): void |
-| `completedNote` | `?string` | Optional | A merchant-specified note about the completion of the order. Only valid if action is COMPLETE. | getCompletedNote(): ?string | setCompletedNote(?string completedNote): void |
-| `refundedNote` | `?string` | Optional | A merchant-specified note about the refunding of the order. Only valid if action is REFUND. | getRefundedNote(): ?string | setRefundedNote(?string refundedNote): void |
-| `canceledNote` | `?string` | Optional | A merchant-specified note about the canceling of the order. Only valid if action is CANCEL. | getCanceledNote(): ?string | setCanceledNote(?string canceledNote): void |
-
-## Example (as JSON)
-
-```json
-{
- "action": "COMPLETE",
- "shipped_tracking_number": "shipped_tracking_number4",
- "completed_note": "completed_note4",
- "refunded_note": "refunded_note8",
- "canceled_note": "canceled_note6"
-}
-```
-
diff --git a/doc/models/vendor-contact.md b/doc/models/vendor-contact.md
deleted file mode 100644
index c5c4b171..00000000
--- a/doc/models/vendor-contact.md
+++ /dev/null
@@ -1,33 +0,0 @@
-
-# Vendor Contact
-
-Represents a contact of a [Vendor](../../doc/models/vendor.md).
-
-## Structure
-
-`VendorContact`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A unique Square-generated ID for the [VendorContact](entity:VendorContact).
This field is required when attempting to update a [VendorContact](entity:VendorContact).
**Constraints**: *Maximum Length*: `100` | getId(): ?string | setId(?string id): void |
-| `name` | `?string` | Optional | The name of the [VendorContact](entity:VendorContact).
This field is required when attempting to create a [Vendor](entity:Vendor).
**Constraints**: *Maximum Length*: `255` | getName(): ?string | setName(?string name): void |
-| `emailAddress` | `?string` | Optional | The email address of the [VendorContact](entity:VendorContact).
**Constraints**: *Maximum Length*: `255` | getEmailAddress(): ?string | setEmailAddress(?string emailAddress): void |
-| `phoneNumber` | `?string` | Optional | The phone number of the [VendorContact](entity:VendorContact).
**Constraints**: *Maximum Length*: `255` | getPhoneNumber(): ?string | setPhoneNumber(?string phoneNumber): void |
-| `removed` | `?bool` | Optional | The state of the [VendorContact](entity:VendorContact). | getRemoved(): ?bool | setRemoved(?bool removed): void |
-| `ordinal` | `int` | Required | The ordinal of the [VendorContact](entity:VendorContact). | getOrdinal(): int | setOrdinal(int ordinal): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id0",
- "name": "name0",
- "email_address": "email_address8",
- "phone_number": "phone_number8",
- "removed": false,
- "ordinal": 244
-}
-```
-
diff --git a/doc/models/vendor-status.md b/doc/models/vendor-status.md
deleted file mode 100644
index 11bb2813..00000000
--- a/doc/models/vendor-status.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Vendor Status
-
-The status of the [Vendor](../../doc/models/vendor.md),
-whether a [Vendor](../../doc/models/vendor.md) is active or inactive.
-
-## Enumeration
-
-`VendorStatus`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ACTIVE` | Vendor is active and can receive purchase orders. |
-| `INACTIVE` | Vendor is inactive and cannot receive purchase orders. |
-
diff --git a/doc/models/vendor.md b/doc/models/vendor.md
deleted file mode 100644
index 048b4625..00000000
--- a/doc/models/vendor.md
+++ /dev/null
@@ -1,42 +0,0 @@
-
-# Vendor
-
-Represents a supplier to a seller.
-
-## Structure
-
-`Vendor`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A unique Square-generated ID for the [Vendor](entity:Vendor).
This field is required when attempting to update a [Vendor](entity:Vendor).
**Constraints**: *Maximum Length*: `100` | getId(): ?string | setId(?string id): void |
-| `createdAt` | `?string` | Optional | An RFC 3339-formatted timestamp that indicates when the
[Vendor](entity:Vendor) was created.
**Constraints**: *Maximum Length*: `34` | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | An RFC 3339-formatted timestamp that indicates when the
[Vendor](entity:Vendor) was last updated.
**Constraints**: *Maximum Length*: `34` | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-| `name` | `?string` | Optional | The name of the [Vendor](entity:Vendor).
This field is required when attempting to create or update a [Vendor](entity:Vendor).
**Constraints**: *Maximum Length*: `100` | getName(): ?string | setName(?string name): void |
-| `address` | [`?Address`](../../doc/models/address.md) | Optional | Represents a postal address in a country.
For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). | getAddress(): ?Address | setAddress(?Address address): void |
-| `contacts` | [`?(VendorContact[])`](../../doc/models/vendor-contact.md) | Optional | The contacts of the [Vendor](entity:Vendor). | getContacts(): ?array | setContacts(?array contacts): void |
-| `accountNumber` | `?string` | Optional | The account number of the [Vendor](entity:Vendor).
**Constraints**: *Maximum Length*: `100` | getAccountNumber(): ?string | setAccountNumber(?string accountNumber): void |
-| `note` | `?string` | Optional | A note detailing information about the [Vendor](entity:Vendor).
**Constraints**: *Maximum Length*: `4096` | getNote(): ?string | setNote(?string note): void |
-| `version` | `?int` | Optional | The version of the [Vendor](entity:Vendor). | getVersion(): ?int | setVersion(?int version): void |
-| `status` | [`?string(VendorStatus)`](../../doc/models/vendor-status.md) | Optional | The status of the [Vendor](../../doc/models/vendor.md),
whether a [Vendor](../../doc/models/vendor.md) is active or inactive. | getStatus(): ?string | setStatus(?string status): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id8",
- "created_at": "created_at6",
- "updated_at": "updated_at4",
- "name": "name8",
- "address": {
- "address_line_1": "address_line_16",
- "address_line_2": "address_line_26",
- "address_line_3": "address_line_32",
- "locality": "locality6",
- "sublocality": "sublocality6"
- }
-}
-```
-
diff --git a/doc/models/visibility-filter.md b/doc/models/visibility-filter.md
deleted file mode 100644
index d39343bc..00000000
--- a/doc/models/visibility-filter.md
+++ /dev/null
@@ -1,17 +0,0 @@
-
-# Visibility Filter
-
-Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions.
-
-## Enumeration
-
-`VisibilityFilter`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `ALL` | All custom attributes or custom attribute definitions. |
-| `READ` | All custom attributes or custom attribute definitions with the `visibility` field set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. |
-| `READ_WRITE` | All custom attributes or custom attribute definitions with the `visibility` field set to `VISIBILITY_READ_WRITE_VALUES`. |
-
diff --git a/doc/models/void-transaction-response.md b/doc/models/void-transaction-response.md
deleted file mode 100644
index aa6ac83b..00000000
--- a/doc/models/void-transaction-response.md
+++ /dev/null
@@ -1,43 +0,0 @@
-
-# Void Transaction Response
-
-Defines the fields that are included in the response body of
-a request to the [VoidTransaction](api-endpoint:Transactions-VoidTransaction) endpoint.
-
-## Structure
-
-`VoidTransactionResponse`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `errors` | [`?(Error[])`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | getErrors(): ?array | setErrors(?array errors): void |
-
-## Example (as JSON)
-
-```json
-{
- "errors": [
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- },
- {
- "category": "MERCHANT_SUBSCRIPTION_ERROR",
- "code": "INVALID_EXPIRATION",
- "detail": "detail6",
- "field": "field4"
- }
- ]
-}
-```
-
diff --git a/doc/models/wage-setting.md b/doc/models/wage-setting.md
deleted file mode 100644
index af6ae50b..00000000
--- a/doc/models/wage-setting.md
+++ /dev/null
@@ -1,76 +0,0 @@
-
-# Wage Setting
-
-Represents information about the overtime exemption status, job assignments, and compensation
-for a [team member](../../doc/models/team-member.md).
-
-## Structure
-
-`WageSetting`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `teamMemberId` | `?string` | Optional | The ID of the team member associated with the wage setting. | getTeamMemberId(): ?string | setTeamMemberId(?string teamMemberId): void |
-| `jobAssignments` | [`?(JobAssignment[])`](../../doc/models/job-assignment.md) | Optional | **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. | getJobAssignments(): ?array | setJobAssignments(?array jobAssignments): void |
-| `isOvertimeExempt` | `?bool` | Optional | Whether the team member is exempt from the overtime rules of the seller's country. | getIsOvertimeExempt(): ?bool | setIsOvertimeExempt(?bool isOvertimeExempt): void |
-| `version` | `?int` | Optional | **Read only** Used for resolving concurrency issues. The request fails if the version
provided does not match the server version at the time of the request. If not provided,
Square executes a blind write, potentially overwriting data from another write. For more information,
see [optimistic concurrency](https://developer.squareup.com/docs/working-with-apis/optimistic-concurrency). | getVersion(): ?int | setVersion(?int version): void |
-| `createdAt` | `?string` | Optional | The timestamp when the wage setting was created, in RFC 3339 format. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp when the wage setting was last updated, in RFC 3339 format. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "team_member_id": "team_member_id2",
- "job_assignments": [
- {
- "job_title": "job_title6",
- "pay_type": "SALARY",
- "hourly_rate": {
- "amount": 172,
- "currency": "LAK"
- },
- "annual_rate": {
- "amount": 232,
- "currency": "NIO"
- },
- "weekly_hours": 98,
- "job_id": "job_id2"
- },
- {
- "job_title": "job_title6",
- "pay_type": "SALARY",
- "hourly_rate": {
- "amount": 172,
- "currency": "LAK"
- },
- "annual_rate": {
- "amount": 232,
- "currency": "NIO"
- },
- "weekly_hours": 98,
- "job_id": "job_id2"
- },
- {
- "job_title": "job_title6",
- "pay_type": "SALARY",
- "hourly_rate": {
- "amount": 172,
- "currency": "LAK"
- },
- "annual_rate": {
- "amount": 232,
- "currency": "NIO"
- },
- "weekly_hours": 98,
- "job_id": "job_id2"
- }
- ],
- "is_overtime_exempt": false,
- "version": 140,
- "created_at": "created_at0"
-}
-```
-
diff --git a/doc/models/webhook-subscription.md b/doc/models/webhook-subscription.md
deleted file mode 100644
index f71b7dfa..00000000
--- a/doc/models/webhook-subscription.md
+++ /dev/null
@@ -1,38 +0,0 @@
-
-# Webhook Subscription
-
-Represents the details of a webhook subscription, including notification URL,
-event types, and signature key.
-
-## Structure
-
-`WebhookSubscription`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | A Square-generated unique ID for the subscription.
**Constraints**: *Maximum Length*: `64` | getId(): ?string | setId(?string id): void |
-| `name` | `?string` | Optional | The name of this subscription.
**Constraints**: *Maximum Length*: `64` | getName(): ?string | setName(?string name): void |
-| `enabled` | `?bool` | Optional | Indicates whether the subscription is enabled (`true`) or not (`false`). | getEnabled(): ?bool | setEnabled(?bool enabled): void |
-| `eventTypes` | `?(string[])` | Optional | The event types associated with this subscription. | getEventTypes(): ?array | setEventTypes(?array eventTypes): void |
-| `notificationUrl` | `?string` | Optional | The URL to which webhooks are sent. | getNotificationUrl(): ?string | setNotificationUrl(?string notificationUrl): void |
-| `apiVersion` | `?string` | Optional | The API version of the subscription.
This field is optional for `CreateWebhookSubscription`.
The value defaults to the API version used by the application. | getApiVersion(): ?string | setApiVersion(?string apiVersion): void |
-| `signatureKey` | `?string` | Optional | The Square-generated signature key used to validate the origin of the webhook event. | getSignatureKey(): ?string | setSignatureKey(?string signatureKey): void |
-| `createdAt` | `?string` | Optional | The timestamp of when the subscription was created, in RFC 3339 format. For example, "2016-09-04T23:59:33.123Z". | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | The timestamp of when the subscription was last updated, in RFC 3339 format.
For example, "2016-09-04T23:59:33.123Z". | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id8",
- "name": "name8",
- "enabled": false,
- "event_types": [
- "event_types6"
- ],
- "notification_url": "notification_url2"
-}
-```
-
diff --git a/doc/models/weekday.md b/doc/models/weekday.md
deleted file mode 100644
index 308543ff..00000000
--- a/doc/models/weekday.md
+++ /dev/null
@@ -1,21 +0,0 @@
-
-# Weekday
-
-The days of the week.
-
-## Enumeration
-
-`Weekday`
-
-## Fields
-
-| Name | Description |
-| --- | --- |
-| `MON` | Monday |
-| `TUE` | Tuesday |
-| `WED` | Wednesday |
-| `THU` | Thursday |
-| `FRI` | Friday |
-| `SAT` | Saturday |
-| `SUN` | Sunday |
-
diff --git a/doc/models/workweek-config.md b/doc/models/workweek-config.md
deleted file mode 100644
index aa949d8f..00000000
--- a/doc/models/workweek-config.md
+++ /dev/null
@@ -1,34 +0,0 @@
-
-# Workweek Config
-
-Sets the day of the week and hour of the day that a business starts a
-workweek. This is used to calculate overtime pay.
-
-## Structure
-
-`WorkweekConfig`
-
-## Fields
-
-| Name | Type | Tags | Description | Getter | Setter |
-| --- | --- | --- | --- | --- | --- |
-| `id` | `?string` | Optional | The UUID for this object. | getId(): ?string | setId(?string id): void |
-| `startOfWeek` | [`string(Weekday)`](../../doc/models/weekday.md) | Required | The days of the week. | getStartOfWeek(): string | setStartOfWeek(string startOfWeek): void |
-| `startOfDayLocalTime` | `string` | Required | The local time at which a business week starts. Represented as a
string in `HH:MM` format (`HH:MM:SS` is also accepted, but seconds are
truncated).
**Constraints**: *Minimum Length*: `1` | getStartOfDayLocalTime(): string | setStartOfDayLocalTime(string startOfDayLocalTime): void |
-| `version` | `?int` | Optional | Used for resolving concurrency issues. The request fails if the version
provided does not match the server version at the time of the request. If not provided,
Square executes a blind write; potentially overwriting data from another
write. | getVersion(): ?int | setVersion(?int version): void |
-| `createdAt` | `?string` | Optional | A read-only timestamp in RFC 3339 format; presented in UTC. | getCreatedAt(): ?string | setCreatedAt(?string createdAt): void |
-| `updatedAt` | `?string` | Optional | A read-only timestamp in RFC 3339 format; presented in UTC. | getUpdatedAt(): ?string | setUpdatedAt(?string updatedAt): void |
-
-## Example (as JSON)
-
-```json
-{
- "id": "id4",
- "start_of_week": "SUN",
- "start_of_day_local_time": "start_of_day_local_time0",
- "version": 104,
- "created_at": "created_at2",
- "updated_at": "updated_at0"
-}
-```
-
diff --git a/doc/utility-classes.md b/doc/utility-classes.md
deleted file mode 100644
index b2554877..00000000
--- a/doc/utility-classes.md
+++ /dev/null
@@ -1,22 +0,0 @@
-
-# Utility Classes Documentation
-
-## FileWrapper
-
-Wraps file with mime-type and filename to be sent as part of an HTTP request.
-
-## Constructor Args
-
-| Name | Type | Description |
-| --- | --- | --- |
-| $realFilePath | string | The path of the file to wrap. |
-| $mimeType | ?mimeType | The mime-type to be sent with the file. |
-| $filename | ?string | The name to be used when sending the file. |
-
-## Methods
-
-| Name | Type | Description |
-| --- | --- | --- |
-| getFilename() | ?string | Get name of the file to be used in the upload data. |
-| getMimeType() | ?string | Get the mime-type to be sent with the file. |
-
diff --git a/example-autoload.php b/example-autoload.php
deleted file mode 100644
index 2ad06b19..00000000
--- a/example-autoload.php
+++ /dev/null
@@ -1,62 +0,0 @@
- "/square-php-sdk/src/",
- "apimatic\\jsonmapper\\" => "/jsonmapper/src/",
- "Unirest\\" => "/unirest-php/src/",
- "Core\\" => "/core-lib-php/src/",
- "CoreInterfaces\\" => "/core-interfaces-php/src/",
- ];
-
- $matchingPrefix;
- foreach ($prefixToLocation as $prefix => $location) {
- $len = strlen($prefix);
- if (strncmp($prefix, $class, $len) !== 0) {
- // no, move to the next registered autoloader
- continue;
- } else {
- $matchingPrefix = $prefix;
- }
- }
-
- if (!$matchingPrefix) return; // ClassPrefix was not found return
-
- // base directory for the namespace prefix
- $base_dir = (__DIR__ . $prefixToLocation[$matchingPrefix]);
-
- // get the relative class name
- $relative_class = substr($class, strlen($matchingPrefix));
-
- // replace the namespace prefix with the base directory, replace namespace
- // separators with directory separators in the relative class name, append
- // with .php
- $file = $base_dir . str_replace('\\', '/', $relative_class) . '.php';
-
- // if the file exists, require it
- if (file_exists($file)) {
- require $file;
- }else {
- echo("Error loading: " . $file . "\r\n");
- }
-});
diff --git a/phpcs-ruleset.xml b/phpcs-ruleset.xml
deleted file mode 100644
index 6f78d30f..00000000
--- a/phpcs-ruleset.xml
+++ /dev/null
@@ -1,5 +0,0 @@
-
-
-
-
-
diff --git a/phpstan.neon b/phpstan.neon
new file mode 100644
index 00000000..780706b8
--- /dev/null
+++ b/phpstan.neon
@@ -0,0 +1,6 @@
+parameters:
+ level: max
+ reportUnmatchedIgnoredErrors: false
+ paths:
+ - src
+ - tests
\ No newline at end of file
diff --git a/phpunit.xml b/phpunit.xml
index 8a72c924..54630a51 100644
--- a/phpunit.xml
+++ b/phpunit.xml
@@ -1,25 +1,7 @@
-
-
+
-
- ./tests
+
+ tests
-
-
- src
-
-
-
+
\ No newline at end of file
diff --git a/src/ApiHelper.php b/src/ApiHelper.php
deleted file mode 100644
index cf2b86be..00000000
--- a/src/ApiHelper.php
+++ /dev/null
@@ -1,174 +0,0 @@
- $val) {
- $headerKeys[\strtolower($headerName)] = $headerName;
- }
-
- // Override headers with new values
- foreach ($newHeaders as $headerName => $headerValue) {
- $lowerCasedName = \strtolower($headerName);
- if (isset($headerKeys[$lowerCasedName])) {
- unset($headers[$headerKeys[$lowerCasedName]]);
- }
- $headerKeys[$lowerCasedName] = $headerName;
- $headers[$headerName] = $headerValue;
- }
-
- return $headers;
- }
-
- /**
- * Assert if headers array is valid.
- *
- * @throws InvalidArgumentException
- */
- public static function assertHeaders(array $headers): void
- {
- foreach ($headers as $header => $value) {
- // Validate header name (must be string, must use allowed chars)
- // Ref: https://tools.ietf.org/html/rfc7230#section-3.2
- if (!is_string($header)) {
- throw new InvalidArgumentException(sprintf(
- 'Header name must be a string but %s provided.',
- is_object($header) ? get_class($header) : gettype($header)
- ));
- }
-
- if (preg_match('/^[a-zA-Z0-9\'`#$%&*+.^_|~!-]+$/', $header) !== 1) {
- throw new InvalidArgumentException(
- sprintf(
- '"%s" is not a valid header name.',
- $header
- )
- );
- }
-
- // Validate value (must be scalar)
- if (!is_scalar($value) || null === $value) {
- throw new InvalidArgumentException(sprintf(
- 'Header value must be scalar but %s provided for header "%s".',
- is_object($value) ? get_class($value) : gettype($value),
- $header
- ));
- }
- }
- }
-
- /**
- * Decodes a valid json string into an array to send in Api calls.
- *
- * @param mixed $json Must be null or array or a valid string json to be translated into a php array.
- * @param string $name Name of the argument whose value is being validated in $json parameter.
- * @param bool $associative Should check for associative? Default: true.
- *
- * @return array|null Returns an array made up of key-value pairs in the provided json string
- * or throws exception, if the provided json is not valid.
- * @throws InvalidArgumentException
- */
- public static function decodeJson($json, string $name, bool $associative = true): ?array
- {
- if (is_null($json) || (is_array($json) && (!$associative || CoreHelper::isAssociative($json)))) {
- return $json;
- }
- if ($json instanceof stdClass) {
- $json = json_encode($json);
- }
- if (is_string($json)) {
- $decoded = json_decode($json, true);
- if (is_array($decoded) && (!$associative || CoreHelper::isAssociative($decoded))) {
- return $decoded;
- }
- }
- throw new InvalidArgumentException("Invalid json value for argument: '$name'");
- }
-
- /**
- * Decodes a valid jsonArray string into an array to send in Api calls.
- *
- * @param mixed $json Must be null or array or a valid string jsonArray to be translated into a php array.
- * @param string $name Name of the argument whose value is being validated in $json parameter.
- * @param bool $asMap Should decode as map? Default: false.
- *
- * @return array|null Returns an array made up of key-value pairs in the provided jsonArray string
- * or throws exception, if the provided json is not valid.
- * @throws InvalidArgumentException
- */
- public static function decodeJsonArray($json, string $name, bool $asMap = false): ?array
- {
- $decoded = self::decodeJson($json, $name, false);
- if (is_null($decoded)) {
- return null;
- }
- $isAssociative = CoreHelper::isAssociative($decoded);
- if (($asMap && $isAssociative) || (!$asMap && !$isAssociative)) {
- return array_map(function ($v) use ($name) {
- return self::decodeJson($v, $name);
- }, $decoded);
- }
- $type = $asMap ? 'map' : 'array';
- throw new InvalidArgumentException("Invalid json $type value for argument: '$name'");
- }
-}
diff --git a/src/Apis/ApplePayApi.php b/src/Apis/ApplePayApi.php
deleted file mode 100644
index 232fd833..00000000
--- a/src/Apis/ApplePayApi.php
+++ /dev/null
@@ -1,51 +0,0 @@
-requestBuilder(RequestMethod::POST, '/v2/apple-pay/domains')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(RegisterDomainResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/BankAccountsApi.php b/src/Apis/BankAccountsApi.php
deleted file mode 100644
index 837c1800..00000000
--- a/src/Apis/BankAccountsApi.php
+++ /dev/null
@@ -1,93 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/bank-accounts')
- ->auth('global')
- ->parameters(
- QueryParam::init('cursor', $cursor),
- QueryParam::init('limit', $limit),
- QueryParam::init('location_id', $locationId)
- );
-
- $_resHandler = $this->responseHandler()->type(ListBankAccountsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns details of a [BankAccount]($m/BankAccount) identified by V1 bank account ID.
- *
- * @param string $v1BankAccountId Connect V1 ID of the desired `BankAccount`. For more
- * information, see
- * [Retrieve a bank account by using an ID issued by V1 Bank Accounts API](https:
- * //developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank-account-by-using-an-
- * id-issued-by-v1-bank-accounts-api).
- *
- * @return ApiResponse Response from the API call
- */
- public function getBankAccountByV1Id(string $v1BankAccountId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/bank-accounts/by-v1-id/{v1_bank_account_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('v1_bank_account_id', $v1BankAccountId));
-
- $_resHandler = $this->responseHandler()->type(GetBankAccountByV1IdResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns details of a [BankAccount]($m/BankAccount)
- * linked to a Square account.
- *
- * @param string $bankAccountId Square-issued ID of the desired `BankAccount`.
- *
- * @return ApiResponse Response from the API call
- */
- public function getBankAccount(string $bankAccountId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/bank-accounts/{bank_account_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('bank_account_id', $bankAccountId));
-
- $_resHandler = $this->responseHandler()->type(GetBankAccountResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/BaseApi.php b/src/Apis/BaseApi.php
deleted file mode 100644
index a39f912e..00000000
--- a/src/Apis/BaseApi.php
+++ /dev/null
@@ -1,46 +0,0 @@
-client = $client;
- }
-
- protected function execute(RequestBuilder $requestBuilder, ?ResponseHandler $responseHandler = null)
- {
- return (new ApiCall($this->client))
- ->requestBuilder($requestBuilder)
- ->responseHandler($responseHandler ?? $this->responseHandler())
- ->execute();
- }
-
- protected function requestBuilder(string $requestMethod, string $path): RequestBuilder
- {
- return new RequestBuilder($requestMethod, $path);
- }
-
- protected function responseHandler(): ResponseHandler
- {
- return $this->client->getGlobalResponseHandler();
- }
-}
diff --git a/src/Apis/BookingCustomAttributesApi.php b/src/Apis/BookingCustomAttributesApi.php
deleted file mode 100644
index 33ddddee..00000000
--- a/src/Apis/BookingCustomAttributesApi.php
+++ /dev/null
@@ -1,444 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/bookings/custom-attribute-definitions')
- ->auth('global')
- ->parameters(QueryParam::init('limit', $limit), QueryParam::init('cursor', $cursor));
-
- $_resHandler = $this->responseHandler()
- ->type(ListBookingCustomAttributeDefinitionsResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a bookings custom attribute definition.
- *
- * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
- * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and
- * `APPOINTMENTS_WRITE` for the OAuth scope.
- *
- * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed
- * to *Appointments Plus*
- * or *Appointments Premium*.
- *
- * @param CreateBookingCustomAttributeDefinitionRequest $body An object containing the fields to
- * POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createBookingCustomAttributeDefinition(
- CreateBookingCustomAttributeDefinitionRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/bookings/custom-attribute-definitions')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(CreateBookingCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a bookings custom attribute definition.
- *
- * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
- * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and
- * `APPOINTMENTS_WRITE` for the OAuth scope.
- *
- * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed
- * to *Appointments Plus*
- * or *Appointments Premium*.
- *
- * @param string $key The key of the custom attribute definition to delete.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteBookingCustomAttributeDefinition(string $key): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::DELETE,
- '/v2/bookings/custom-attribute-definitions/{key}'
- )->auth('global')->parameters(TemplateParam::init('key', $key));
-
- $_resHandler = $this->responseHandler()
- ->type(DeleteBookingCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a bookings custom attribute definition.
- *
- * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
- * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and
- * `APPOINTMENTS_READ` for the OAuth scope.
- *
- * @param string $key The key of the custom attribute definition to retrieve. If the requesting
- * application
- * is not the definition owner, you must use the qualified key.
- * @param int|null $version The current version of the custom attribute definition, which is
- * used for strongly consistent
- * reads to guarantee that you receive the most up-to-date data. When included in the
- * request,
- * Square returns the specified version or a higher version if one exists. If the
- * specified version
- * is higher than the current version, Square returns a `BAD_REQUEST` error.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveBookingCustomAttributeDefinition(string $key, ?int $version = null): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/bookings/custom-attribute-definitions/{key}')
- ->auth('global')
- ->parameters(TemplateParam::init('key', $key), QueryParam::init('version', $version));
-
- $_resHandler = $this->responseHandler()
- ->type(RetrieveBookingCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates a bookings custom attribute definition.
- *
- * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
- * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and
- * `APPOINTMENTS_WRITE` for the OAuth scope.
- *
- * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed
- * to *Appointments Plus*
- * or *Appointments Premium*.
- *
- * @param string $key The key of the custom attribute definition to update.
- * @param UpdateBookingCustomAttributeDefinitionRequest $body An object containing the fields to
- * POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateBookingCustomAttributeDefinition(
- string $key,
- UpdateBookingCustomAttributeDefinitionRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/bookings/custom-attribute-definitions/{key}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('key', $key),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(UpdateBookingCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Bulk deletes bookings custom attributes.
- *
- * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
- * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and
- * `APPOINTMENTS_WRITE` for the OAuth scope.
- *
- * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed
- * to *Appointments Plus*
- * or *Appointments Premium*.
- *
- * @param BulkDeleteBookingCustomAttributesRequest $body An object containing the fields to POST
- * for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkDeleteBookingCustomAttributes(BulkDeleteBookingCustomAttributesRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/bookings/custom-attributes/bulk-delete')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(BulkDeleteBookingCustomAttributesResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Bulk upserts bookings custom attributes.
- *
- * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
- * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and
- * `APPOINTMENTS_WRITE` for the OAuth scope.
- *
- * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed
- * to *Appointments Plus*
- * or *Appointments Premium*.
- *
- * @param BulkUpsertBookingCustomAttributesRequest $body An object containing the fields to POST
- * for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkUpsertBookingCustomAttributes(BulkUpsertBookingCustomAttributesRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/bookings/custom-attributes/bulk-upsert')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(BulkUpsertBookingCustomAttributesResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Lists a booking's custom attributes.
- *
- * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
- * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and
- * `APPOINTMENTS_READ` for the OAuth scope.
- *
- * @param string $bookingId The ID of the target [booking](entity:Booking).
- * @param int|null $limit The maximum number of results to return in a single paged response.
- * This limit is advisory.
- * The response might contain more or fewer results. The minimum value is 1 and the
- * maximum value is 100.
- * The default value is 20. For more information, see [Pagination](https://developer.
- * squareup.com/docs/build-basics/common-api-patterns/pagination).
- * @param string|null $cursor The cursor returned in the paged response from the previous call
- * to this endpoint.
- * Provide this cursor to retrieve the next page of results for your original request.
- * For more
- * information, see [Pagination](https://developer.squareup.com/docs/build-
- * basics/common-api-patterns/pagination).
- * @param bool|null $withDefinitions Indicates whether to return the [custom attribute
- * definition](entity:CustomAttributeDefinition) in the `definition` field of each
- * custom attribute. Set this parameter to `true` to get the name and description of
- * each custom
- * attribute, information about the data type, or other definition details. The default
- * value is `false`.
- *
- * @return ApiResponse Response from the API call
- */
- public function listBookingCustomAttributes(
- string $bookingId,
- ?int $limit = null,
- ?string $cursor = null,
- ?bool $withDefinitions = false
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/bookings/{booking_id}/custom-attributes')
- ->auth('global')
- ->parameters(
- TemplateParam::init('booking_id', $bookingId),
- QueryParam::init('limit', $limit),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('with_definitions', $withDefinitions)
- );
-
- $_resHandler = $this->responseHandler()->type(ListBookingCustomAttributesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a bookings custom attribute.
- *
- * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
- * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and
- * `APPOINTMENTS_WRITE` for the OAuth scope.
- *
- * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed
- * to *Appointments Plus*
- * or *Appointments Premium*.
- *
- * @param string $bookingId The ID of the target [booking](entity:Booking).
- * @param string $key The key of the custom attribute to delete. This key must match the `key`
- * of a custom
- * attribute definition in the Square seller account. If the requesting application is
- * not the
- * definition owner, you must use the qualified key.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteBookingCustomAttribute(string $bookingId, string $key): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::DELETE,
- '/v2/bookings/{booking_id}/custom-attributes/{key}'
- )->auth('global')->parameters(TemplateParam::init('booking_id', $bookingId), TemplateParam::init('key', $key));
-
- $_resHandler = $this->responseHandler()
- ->type(DeleteBookingCustomAttributeResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a bookings custom attribute.
- *
- * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
- * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and
- * `APPOINTMENTS_READ` for the OAuth scope.
- *
- * @param string $bookingId The ID of the target [booking](entity:Booking).
- * @param string $key The key of the custom attribute to retrieve. This key must match the `key`
- * of a custom
- * attribute definition in the Square seller account. If the requesting application is
- * not the
- * definition owner, you must use the qualified key.
- * @param bool|null $withDefinition Indicates whether to return the [custom attribute
- * definition](entity:CustomAttributeDefinition) in the `definition` field of
- * the custom attribute. Set this parameter to `true` to get the name and description
- * of the custom
- * attribute, information about the data type, or other definition details. The default
- * value is `false`.
- * @param int|null $version The current version of the custom attribute, which is used for
- * strongly consistent reads to
- * guarantee that you receive the most up-to-date data. When included in the request,
- * Square
- * returns the specified version or a higher version if one exists. If the specified
- * version is
- * higher than the current version, Square returns a `BAD_REQUEST` error.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveBookingCustomAttribute(
- string $bookingId,
- string $key,
- ?bool $withDefinition = false,
- ?int $version = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::GET,
- '/v2/bookings/{booking_id}/custom-attributes/{key}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('booking_id', $bookingId),
- TemplateParam::init('key', $key),
- QueryParam::init('with_definition', $withDefinition),
- QueryParam::init('version', $version)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(RetrieveBookingCustomAttributeResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Upserts a bookings custom attribute.
- *
- * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
- * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and
- * `APPOINTMENTS_WRITE` for the OAuth scope.
- *
- * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed
- * to *Appointments Plus*
- * or *Appointments Premium*.
- *
- * @param string $bookingId The ID of the target [booking](entity:Booking).
- * @param string $key The key of the custom attribute to create or update. This key must match
- * the `key` of a
- * custom attribute definition in the Square seller account. If the requesting
- * application is not
- * the definition owner, you must use the qualified key.
- * @param UpsertBookingCustomAttributeRequest $body An object containing the fields to POST for
- * the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function upsertBookingCustomAttribute(
- string $bookingId,
- string $key,
- UpsertBookingCustomAttributeRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::PUT,
- '/v2/bookings/{booking_id}/custom-attributes/{key}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('booking_id', $bookingId),
- TemplateParam::init('key', $key),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(UpsertBookingCustomAttributeResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/BookingsApi.php b/src/Apis/BookingsApi.php
deleted file mode 100644
index 58a2c90a..00000000
--- a/src/Apis/BookingsApi.php
+++ /dev/null
@@ -1,398 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/bookings')
- ->auth('global')
- ->parameters(
- QueryParam::init('limit', $limit),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('customer_id', $customerId),
- QueryParam::init('team_member_id', $teamMemberId),
- QueryParam::init('location_id', $locationId),
- QueryParam::init('start_at_min', $startAtMin),
- QueryParam::init('start_at_max', $startAtMax)
- );
-
- $_resHandler = $this->responseHandler()->type(ListBookingsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a booking.
- *
- * The required input must include the following:
- * - `Booking.location_id`
- * - `Booking.start_at`
- * - `Booking.AppointmentSegment.team_member_id`
- * - `Booking.AppointmentSegment.service_variation_id`
- * - `Booking.AppointmentSegment.service_variation_version`
- *
- * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
- * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and
- * `APPOINTMENTS_WRITE` for the OAuth scope.
- *
- * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed
- * to *Appointments Plus*
- * or *Appointments Premium*.
- *
- * @param CreateBookingRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createBooking(CreateBookingRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/bookings')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateBookingResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Searches for availabilities for booking.
- *
- * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
- * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and
- * `APPOINTMENTS_READ` for the OAuth scope.
- *
- * @param SearchAvailabilityRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function searchAvailability(SearchAvailabilityRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/bookings/availability/search')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchAvailabilityResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Bulk-Retrieves a list of bookings by booking IDs.
- *
- * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
- * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and
- * `APPOINTMENTS_READ` for the OAuth scope.
- *
- * @param BulkRetrieveBookingsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkRetrieveBookings(BulkRetrieveBookingsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/bookings/bulk-retrieve')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BulkRetrieveBookingsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a seller's booking profile.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveBusinessBookingProfile(): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/bookings/business-booking-profile')
- ->auth('global');
-
- $_resHandler = $this->responseHandler()
- ->type(RetrieveBusinessBookingProfileResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Lists location booking profiles of a seller.
- *
- * @param int|null $limit The maximum number of results to return in a paged response.
- * @param string|null $cursor The pagination cursor from the preceding response to return the
- * next page of the results. Do not set this when retrieving the first page of the
- * results.
- *
- * @return ApiResponse Response from the API call
- */
- public function listLocationBookingProfiles(?int $limit = null, ?string $cursor = null): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/bookings/location-booking-profiles')
- ->auth('global')
- ->parameters(QueryParam::init('limit', $limit), QueryParam::init('cursor', $cursor));
-
- $_resHandler = $this->responseHandler()->type(ListLocationBookingProfilesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a seller's location booking profile.
- *
- * @param string $locationId The ID of the location to retrieve the booking profile.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveLocationBookingProfile(string $locationId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::GET,
- '/v2/bookings/location-booking-profiles/{location_id}'
- )->auth('global')->parameters(TemplateParam::init('location_id', $locationId));
-
- $_resHandler = $this->responseHandler()
- ->type(RetrieveLocationBookingProfileResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Lists booking profiles for team members.
- *
- * @param bool|null $bookableOnly Indicates whether to include only bookable team members in the
- * returned result (`true`) or not (`false`).
- * @param int|null $limit The maximum number of results to return in a paged response.
- * @param string|null $cursor The pagination cursor from the preceding response to return the
- * next page of the results. Do not set this when retrieving the first page of the
- * results.
- * @param string|null $locationId Indicates whether to include only team members enabled at the
- * given location in the returned result.
- *
- * @return ApiResponse Response from the API call
- */
- public function listTeamMemberBookingProfiles(
- ?bool $bookableOnly = false,
- ?int $limit = null,
- ?string $cursor = null,
- ?string $locationId = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/bookings/team-member-booking-profiles')
- ->auth('global')
- ->parameters(
- QueryParam::init('bookable_only', $bookableOnly),
- QueryParam::init('limit', $limit),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('location_id', $locationId)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(ListTeamMemberBookingProfilesResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves one or more team members' booking profiles.
- *
- * @param BulkRetrieveTeamMemberBookingProfilesRequest $body An object containing the fields to
- * POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkRetrieveTeamMemberBookingProfiles(
- BulkRetrieveTeamMemberBookingProfilesRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::POST,
- '/v2/bookings/team-member-booking-profiles/bulk-retrieve'
- )->auth('global')->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(BulkRetrieveTeamMemberBookingProfilesResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a team member's booking profile.
- *
- * @param string $teamMemberId The ID of the team member to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveTeamMemberBookingProfile(string $teamMemberId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::GET,
- '/v2/bookings/team-member-booking-profiles/{team_member_id}'
- )->auth('global')->parameters(TemplateParam::init('team_member_id', $teamMemberId));
-
- $_resHandler = $this->responseHandler()
- ->type(RetrieveTeamMemberBookingProfileResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a booking.
- *
- * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
- * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and
- * `APPOINTMENTS_READ` for the OAuth scope.
- *
- * @param string $bookingId The ID of the [Booking](entity:Booking) object representing the
- * to-be-retrieved booking.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveBooking(string $bookingId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/bookings/{booking_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('booking_id', $bookingId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveBookingResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates a booking.
- *
- * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
- * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and
- * `APPOINTMENTS_WRITE` for the OAuth scope.
- *
- * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed
- * to *Appointments Plus*
- * or *Appointments Premium*.
- *
- * @param string $bookingId The ID of the [Booking](entity:Booking) object representing the
- * to-be-updated booking.
- * @param UpdateBookingRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateBooking(string $bookingId, UpdateBookingRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/bookings/{booking_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('booking_id', $bookingId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateBookingResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Cancels an existing booking.
- *
- * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
- * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and
- * `APPOINTMENTS_WRITE` for the OAuth scope.
- *
- * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed
- * to *Appointments Plus*
- * or *Appointments Premium*.
- *
- * @param string $bookingId The ID of the [Booking](entity:Booking) object representing the
- * to-be-cancelled booking.
- * @param CancelBookingRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function cancelBooking(string $bookingId, CancelBookingRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/bookings/{booking_id}/cancel')
- ->auth('global')
- ->parameters(
- TemplateParam::init('booking_id', $bookingId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(CancelBookingResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/CardsApi.php b/src/Apis/CardsApi.php
deleted file mode 100644
index 9541c23c..00000000
--- a/src/Apis/CardsApi.php
+++ /dev/null
@@ -1,119 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/cards')
- ->auth('global')
- ->parameters(
- QueryParam::init('cursor', $cursor),
- QueryParam::init('customer_id', $customerId),
- QueryParam::init('include_disabled', $includeDisabled),
- QueryParam::init('reference_id', $referenceId),
- QueryParam::init('sort_order', $sortOrder)
- );
-
- $_resHandler = $this->responseHandler()->type(ListCardsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Adds a card on file to an existing merchant.
- *
- * @param CreateCardRequest $body An object containing the fields to POST for the request. See
- * the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createCard(CreateCardRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/cards')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateCardResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves details for a specific Card.
- *
- * @param string $cardId Unique ID for the desired Card.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveCard(string $cardId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/cards/{card_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('card_id', $cardId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveCardResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Disables the card, preventing any further updates or charges.
- * Disabling an already disabled card is allowed but has no effect.
- *
- * @param string $cardId Unique ID for the desired Card.
- *
- * @return ApiResponse Response from the API call
- */
- public function disableCard(string $cardId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/cards/{card_id}/disable')
- ->auth('global')
- ->parameters(TemplateParam::init('card_id', $cardId));
-
- $_resHandler = $this->responseHandler()->type(DisableCardResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/CashDrawersApi.php b/src/Apis/CashDrawersApi.php
deleted file mode 100644
index dca7f87b..00000000
--- a/src/Apis/CashDrawersApi.php
+++ /dev/null
@@ -1,110 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/cash-drawers/shifts')
- ->auth('global')
- ->parameters(
- QueryParam::init('location_id', $locationId),
- QueryParam::init('sort_order', $sortOrder),
- QueryParam::init('begin_time', $beginTime),
- QueryParam::init('end_time', $endTime),
- QueryParam::init('limit', $limit),
- QueryParam::init('cursor', $cursor)
- );
-
- $_resHandler = $this->responseHandler()->type(ListCashDrawerShiftsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Provides the summary details for a single cash drawer shift. See
- * [ListCashDrawerShiftEvents]($e/CashDrawers/ListCashDrawerShiftEvents) for a list of cash drawer
- * shift events.
- *
- * @param string $locationId The ID of the location to retrieve cash drawer shifts from.
- * @param string $shiftId The shift ID.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveCashDrawerShift(string $locationId, string $shiftId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/cash-drawers/shifts/{shift_id}')
- ->auth('global')
- ->parameters(QueryParam::init('location_id', $locationId), TemplateParam::init('shift_id', $shiftId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveCashDrawerShiftResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Provides a paginated list of events for a single cash drawer shift.
- *
- * @param string $locationId The ID of the location to list cash drawer shifts for.
- * @param string $shiftId The shift ID.
- * @param int|null $limit Number of resources to be returned in a page of results (200 by
- * default, 1000 max).
- * @param string|null $cursor Opaque cursor for fetching the next page of results.
- *
- * @return ApiResponse Response from the API call
- */
- public function listCashDrawerShiftEvents(
- string $locationId,
- string $shiftId,
- ?int $limit = null,
- ?string $cursor = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/cash-drawers/shifts/{shift_id}/events')
- ->auth('global')
- ->parameters(
- QueryParam::init('location_id', $locationId),
- TemplateParam::init('shift_id', $shiftId),
- QueryParam::init('limit', $limit),
- QueryParam::init('cursor', $cursor)
- );
-
- $_resHandler = $this->responseHandler()->type(ListCashDrawerShiftEventsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/CatalogApi.php b/src/Apis/CatalogApi.php
deleted file mode 100644
index acd80812..00000000
--- a/src/Apis/CatalogApi.php
+++ /dev/null
@@ -1,516 +0,0 @@
-requestBuilder(RequestMethod::POST, '/v2/catalog/batch-delete')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BatchDeleteCatalogObjectsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns a set of objects based on the provided ID.
- * Each [CatalogItem]($m/CatalogItem) returned in the set includes all of its
- * child information including: all of its
- * [CatalogItemVariation]($m/CatalogItemVariation) objects, references to
- * its [CatalogModifierList]($m/CatalogModifierList) objects, and the ids of
- * any [CatalogTax]($m/CatalogTax) objects that apply to it.
- *
- * @param BatchRetrieveCatalogObjectsRequest $body An object containing the fields to POST for
- * the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function batchRetrieveCatalogObjects(BatchRetrieveCatalogObjectsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/catalog/batch-retrieve')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BatchRetrieveCatalogObjectsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates or updates up to 10,000 target objects based on the provided
- * list of objects. The target objects are grouped into batches and each batch is
- * inserted/updated in an all-or-nothing manner. If an object within a batch is
- * malformed in some way, or violates a database constraint, the entire batch
- * containing that item will be disregarded. However, other batches in the same
- * request may still succeed. Each batch may contain up to 1,000 objects, and
- * batches will be processed in order as long as the total object count for the
- * request (items, variations, modifier lists, discounts, and taxes) is no more
- * than 10,000.
- *
- * To ensure consistency, only one update request is processed at a time per seller account.
- * While one (batch or non-batch) update request is being processed, other (batched and non-batched)
- * update requests are rejected with the `429` error code.
- *
- * @param BatchUpsertCatalogObjectsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function batchUpsertCatalogObjects(BatchUpsertCatalogObjectsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/catalog/batch-upsert')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BatchUpsertCatalogObjectsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Uploads an image file to be represented by a [CatalogImage]($m/CatalogImage) object that can be
- * linked to an existing
- * [CatalogObject]($m/CatalogObject) instance. The resulting `CatalogImage` is unattached to any
- * `CatalogObject` if the `object_id`
- * is not specified.
- *
- * This `CreateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an
- * image file part in
- * JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB.
- *
- * @param CreateCatalogImageRequest|null $request
- * @param FileWrapper|null $imageFile
- *
- * @return ApiResponse Response from the API call
- */
- public function createCatalogImage(
- ?CreateCatalogImageRequest $request = null,
- ?FileWrapper $imageFile = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/catalog/images')
- ->auth('global')
- ->parameters(
- FormParam::init('request', $request)
- ->encodingHeader('Content-Type', 'application/json; charset=utf-8'),
- FormParam::init('image_file', $imageFile)->encodingHeader('Content-Type', 'image/jpeg')
- );
-
- $_resHandler = $this->responseHandler()->type(CreateCatalogImageResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Uploads a new image file to replace the existing one in the specified
- * [CatalogImage]($m/CatalogImage) object.
- *
- * This `UpdateCatalogImage` endpoint accepts HTTP multipart/form-data requests with a JSON part and an
- * image file part in
- * JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB.
- *
- * @param string $imageId The ID of the `CatalogImage` object to update the encapsulated image
- * file.
- * @param UpdateCatalogImageRequest|null $request
- * @param FileWrapper|null $imageFile
- *
- * @return ApiResponse Response from the API call
- */
- public function updateCatalogImage(
- string $imageId,
- ?UpdateCatalogImageRequest $request = null,
- ?FileWrapper $imageFile = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/catalog/images/{image_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('image_id', $imageId),
- FormParam::init('request', $request)
- ->encodingHeader('Content-Type', 'application/json; charset=utf-8'),
- FormParam::init('image_file', $imageFile)->encodingHeader('Content-Type', 'image/jpeg')
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateCatalogImageResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves information about the Square Catalog API, such as batch size
- * limits that can be used by the `BatchUpsertCatalogObjects` endpoint.
- *
- * @return ApiResponse Response from the API call
- */
- public function catalogInfo(): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/catalog/info')->auth('global');
-
- $_resHandler = $this->responseHandler()->type(CatalogInfoResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns a list of all [CatalogObject]($m/CatalogObject)s of the specified types in the catalog.
- *
- * The `types` parameter is specified as a comma-separated list of the
- * [CatalogObjectType]($m/CatalogObjectType) values,
- * for example, "`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]($e/Catalog/SearchCatalogObjects)
- * and set the `include_deleted_objects` attribute value to `true`.
- *
- * @param string|null $cursor The pagination cursor returned in the previous response. Leave
- * unset for an initial request.
- * The page size is currently set to be 100.
- * See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-
- * patterns/pagination) for more information.
- * @param string|null $types An optional case-insensitive, comma-separated list of object types
- * to retrieve.
- *
- * The valid values are defined in the [CatalogObjectType](entity:CatalogObjectType)
- * enum, for example,
- * `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`,
- * `MODIFIER`, `MODIFIER_LIST`, `IMAGE`, etc.
- *
- * If this is unspecified, the operation returns objects of all the top level types at
- * the version
- * of the Square API used to make the request. Object types that are nested onto other
- * object types
- * are not included in the defaults.
- *
- * At the current API version the default object types are:
- * ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST,
- * PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT,
- * SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.
- * @param int|null $catalogVersion The specific version of the catalog objects to be included in
- * the response.
- * This allows you to retrieve historical versions of objects. The specified version
- * value is matched against
- * the [CatalogObject]($m/CatalogObject)s' `version` attribute. If not included,
- * results will be from the
- * current version of the catalog.
- *
- * @return ApiResponse Response from the API call
- */
- public function listCatalog(
- ?string $cursor = null,
- ?string $types = null,
- ?int $catalogVersion = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/catalog/list')
- ->auth('global')
- ->parameters(
- QueryParam::init('cursor', $cursor),
- QueryParam::init('types', $types),
- QueryParam::init('catalog_version', $catalogVersion)
- );
-
- $_resHandler = $this->responseHandler()->type(ListCatalogResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a new or updates the specified [CatalogObject]($m/CatalogObject).
- *
- * To ensure consistency, only one update request is processed at a time per seller account.
- * While one (batch or non-batch) update request is being processed, other (batched and non-batched)
- * update requests are rejected with the `429` error code.
- *
- * @param UpsertCatalogObjectRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function upsertCatalogObject(UpsertCatalogObjectRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/catalog/object')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(UpsertCatalogObjectResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a single [CatalogObject]($m/CatalogObject) based on the
- * provided ID and returns the set of successfully deleted IDs in the response.
- * Deletion is a cascading event such that all children of the targeted object
- * are also deleted. For example, deleting a [CatalogItem]($m/CatalogItem)
- * will also delete all of its
- * [CatalogItemVariation]($m/CatalogItemVariation) children.
- *
- * To ensure consistency, only one delete request is processed at a time per seller account.
- * While one (batch or non-batch) delete request is being processed, other (batched and non-batched)
- * delete requests are rejected with the `429` error code.
- *
- * @param string $objectId The ID of the catalog object to be deleted. When an object is
- * deleted, other
- * objects in the graph that depend on that object will be deleted as well (for example,
- * deleting a
- * catalog item will delete its catalog item variations).
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteCatalogObject(string $objectId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v2/catalog/object/{object_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('object_id', $objectId));
-
- $_resHandler = $this->responseHandler()->type(DeleteCatalogObjectResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns a single [CatalogItem]($m/CatalogItem) as a
- * [CatalogObject]($m/CatalogObject) based on the provided ID. The returned
- * object includes all of the relevant [CatalogItem]($m/CatalogItem)
- * information including: [CatalogItemVariation]($m/CatalogItemVariation)
- * children, references to its
- * [CatalogModifierList]($m/CatalogModifierList) objects, and the ids of
- * any [CatalogTax]($m/CatalogTax) objects that apply to it.
- *
- * @param string $objectId The object ID of any type of catalog objects to be retrieved.
- * @param bool|null $includeRelatedObjects If `true`, the response will include additional
- * objects that are related to the
- * requested objects. Related objects are defined as any objects referenced by ID by
- * the results in the `objects` field
- * of the response. These objects are put in the `related_objects` field. Setting this
- * to `true` is
- * helpful when the objects are needed for immediate display to a user.
- * This process only goes one level deep. Objects referenced by the related objects
- * will not be included. For example,
- *
- * if the `objects` field of the response contains a CatalogItem, its associated
- * CatalogCategory objects, CatalogTax objects, CatalogImage objects and
- * CatalogModifierLists will be returned in the `related_objects` field of the
- * response. If the `objects` field of the response contains a CatalogItemVariation,
- * its parent CatalogItem will be returned in the `related_objects` field of
- * the response.
- *
- * Default value: `false`
- * @param int|null $catalogVersion Requests objects as of a specific version of the catalog.
- * This allows you to retrieve historical
- * versions of objects. The value to retrieve a specific version of an object can be
- * found
- * in the version field of [CatalogObject]($m/CatalogObject)s. If not included, results
- * will
- * be from the current version of the catalog.
- * @param bool|null $includeCategoryPathToRoot Specifies whether or not to include the
- * `path_to_root` list for each returned category instance. The `path_to_root` list
- * consists
- * of `CategoryPathToRootNode` objects and specifies the path that starts with the
- * immediate parent category of the returned category
- * and ends with its root category. If the returned category is a top-level category,
- * the `path_to_root` list is empty and is not returned
- * in the response payload.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveCatalogObject(
- string $objectId,
- ?bool $includeRelatedObjects = false,
- ?int $catalogVersion = null,
- ?bool $includeCategoryPathToRoot = false
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/catalog/object/{object_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('object_id', $objectId),
- QueryParam::init('include_related_objects', $includeRelatedObjects),
- QueryParam::init('catalog_version', $catalogVersion),
- QueryParam::init('include_category_path_to_root', $includeCategoryPathToRoot)
- );
-
- $_resHandler = $this->responseHandler()->type(RetrieveCatalogObjectResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Searches for [CatalogObject]($m/CatalogObject) of any type by matching supported search attribute
- * values,
- * excluding custom attribute values on items or item variations, against one or more of the specified
- * query filters.
- *
- * This (`SearchCatalogObjects`) endpoint differs from the
- * [SearchCatalogItems]($e/Catalog/SearchCatalogItems)
- * endpoint in the following aspects:
- *
- * - `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects`
- * can search for any type of catalog objects.
- * - `SearchCatalogItems` supports the custom attribute query filters to return items or item
- * variations that contain custom attribute values, where `SearchCatalogObjects` does not.
- * - `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted
- * items or item variations, whereas `SearchCatalogObjects` does.
- * - The both endpoints have different call conventions, including the query filter formats.
- *
- * @param SearchCatalogObjectsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function searchCatalogObjects(SearchCatalogObjectsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/catalog/search')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchCatalogObjectsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Searches for catalog items or item variations by matching supported search attribute values,
- * including
- * custom attribute values, against one or more of the specified query filters.
- *
- * This (`SearchCatalogItems`) endpoint differs from the
- * [SearchCatalogObjects]($e/Catalog/SearchCatalogObjects)
- * endpoint in the following aspects:
- *
- * - `SearchCatalogItems` can only search for items or item variations, whereas `SearchCatalogObjects`
- * can search for any type of catalog objects.
- * - `SearchCatalogItems` supports the custom attribute query filters to return items or item
- * variations that contain custom attribute values, where `SearchCatalogObjects` does not.
- * - `SearchCatalogItems` does not support the `include_deleted_objects` filter to search for deleted
- * items or item variations, whereas `SearchCatalogObjects` does.
- * - The both endpoints use different call conventions, including the query filter formats.
- *
- * @param SearchCatalogItemsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function searchCatalogItems(SearchCatalogItemsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/catalog/search-catalog-items')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchCatalogItemsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates the [CatalogModifierList]($m/CatalogModifierList) objects
- * that apply to the targeted [CatalogItem]($m/CatalogItem) without having
- * to perform an upsert on the entire item.
- *
- * @param UpdateItemModifierListsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateItemModifierLists(UpdateItemModifierListsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/catalog/update-item-modifier-lists')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(UpdateItemModifierListsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates the [CatalogTax]($m/CatalogTax) objects that apply to the
- * targeted [CatalogItem]($m/CatalogItem) without having to perform an
- * upsert on the entire item.
- *
- * @param UpdateItemTaxesRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateItemTaxes(UpdateItemTaxesRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/catalog/update-item-taxes')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(UpdateItemTaxesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/CheckoutApi.php b/src/Apis/CheckoutApi.php
deleted file mode 100644
index 42cc2ab7..00000000
--- a/src/Apis/CheckoutApi.php
+++ /dev/null
@@ -1,264 +0,0 @@
-requestBuilder(RequestMethod::POST, '/v2/locations/{location_id}/checkouts')
- ->auth('global')
- ->parameters(
- TemplateParam::init('location_id', $locationId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(CreateCheckoutResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves the location-level settings for a Square-hosted checkout page.
- *
- * @param string $locationId The ID of the location for which to retrieve settings.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveLocationSettings(string $locationId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::GET,
- '/v2/online-checkout/location-settings/{location_id}'
- )->auth('global')->parameters(TemplateParam::init('location_id', $locationId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveLocationSettingsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates the location-level settings for a Square-hosted checkout page.
- *
- * @param string $locationId The ID of the location for which to retrieve settings.
- * @param UpdateLocationSettingsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateLocationSettings(string $locationId, UpdateLocationSettingsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::PUT,
- '/v2/online-checkout/location-settings/{location_id}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('location_id', $locationId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateLocationSettingsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves the merchant-level settings for a Square-hosted checkout page.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveMerchantSettings(): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/online-checkout/merchant-settings')
- ->auth('global');
-
- $_resHandler = $this->responseHandler()->type(RetrieveMerchantSettingsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates the merchant-level settings for a Square-hosted checkout page.
- *
- * @param UpdateMerchantSettingsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateMerchantSettings(UpdateMerchantSettingsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/online-checkout/merchant-settings')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(UpdateMerchantSettingsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Lists all payment links.
- *
- * @param string|null $cursor A pagination cursor returned by a previous call to this endpoint.
- * Provide this cursor to retrieve the next set of results for the original query.
- * If a cursor is not provided, the endpoint returns the first page of the results.
- * For more information, see [Pagination](https://developer.squareup.com/docs/build-
- * basics/common-api-patterns/pagination).
- * @param int|null $limit A limit on the number of results to return per page. The limit is
- * advisory and
- * the implementation might return more or less results. If the supplied limit is
- * negative, zero, or
- * greater than the maximum limit of 1000, it is ignored.
- *
- * Default value: `100`
- *
- * @return ApiResponse Response from the API call
- */
- public function listPaymentLinks(?string $cursor = null, ?int $limit = null): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/online-checkout/payment-links')
- ->auth('global')
- ->parameters(QueryParam::init('cursor', $cursor), QueryParam::init('limit', $limit));
-
- $_resHandler = $this->responseHandler()->type(ListPaymentLinksResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a Square-hosted checkout page. Applications can share the resulting payment link with their
- * buyer to pay for goods and services.
- *
- * @param CreatePaymentLinkRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createPaymentLink(CreatePaymentLinkRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/online-checkout/payment-links')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreatePaymentLinkResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a payment link.
- *
- * @param string $id The ID of the payment link to delete.
- *
- * @return ApiResponse Response from the API call
- */
- public function deletePaymentLink(string $id): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v2/online-checkout/payment-links/{id}')
- ->auth('global')
- ->parameters(TemplateParam::init('id', $id));
-
- $_resHandler = $this->responseHandler()->type(DeletePaymentLinkResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a payment link.
- *
- * @param string $id The ID of link to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrievePaymentLink(string $id): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/online-checkout/payment-links/{id}')
- ->auth('global')
- ->parameters(TemplateParam::init('id', $id));
-
- $_resHandler = $this->responseHandler()->type(RetrievePaymentLinkResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates a payment link. You can update the `payment_link` fields such as
- * `description`, `checkout_options`, and `pre_populated_data`.
- * You cannot update other fields such as the `order_id`, `version`, `URL`, or `timestamp` field.
- *
- * @param string $id The ID of the payment link to update.
- * @param UpdatePaymentLinkRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updatePaymentLink(string $id, UpdatePaymentLinkRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/online-checkout/payment-links/{id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('id', $id),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdatePaymentLinkResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/CustomerCustomAttributesApi.php b/src/Apis/CustomerCustomAttributesApi.php
deleted file mode 100644
index c6a60662..00000000
--- a/src/Apis/CustomerCustomAttributesApi.php
+++ /dev/null
@@ -1,437 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/customers/custom-attribute-definitions')
- ->auth('global')
- ->parameters(QueryParam::init('limit', $limit), QueryParam::init('cursor', $cursor));
-
- $_resHandler = $this->responseHandler()
- ->type(ListCustomerCustomAttributeDefinitionsResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a customer-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square
- * seller account.
- * Use this endpoint to define a custom attribute that can be associated with customer profiles.
- *
- * A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties
- * for a custom attribute. After the definition is created, you can call
- * [UpsertCustomerCustomAttribute]($e/CustomerCustomAttributes/UpsertCustomerCustomAttribute) or
- * [BulkUpsertCustomerCustomAttributes]($e/CustomerCustomAttributes/BulkUpsertCustomerCustomAttributes)
- * to set the custom attribute for customer profiles in the seller's Customer Directory.
- *
- * Sellers can view all custom attributes in exported customer data, including those set to
- * `VISIBILITY_HIDDEN`.
- *
- * @param CreateCustomerCustomAttributeDefinitionRequest $body An object containing the fields
- * to POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createCustomerCustomAttributeDefinition(
- CreateCustomerCustomAttributeDefinitionRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/customers/custom-attribute-definitions')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(CreateCustomerCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a customer-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square
- * seller account.
- *
- * Deleting a custom attribute definition also deletes the corresponding custom attribute from
- * all customer profiles in the seller's Customer Directory.
- *
- * Only the definition owner can delete a custom attribute definition.
- *
- * @param string $key The key of the custom attribute definition to delete.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteCustomerCustomAttributeDefinition(string $key): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::DELETE,
- '/v2/customers/custom-attribute-definitions/{key}'
- )->auth('global')->parameters(TemplateParam::init('key', $key));
-
- $_resHandler = $this->responseHandler()
- ->type(DeleteCustomerCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a customer-related [custom attribute definition]($m/CustomAttributeDefinition) from a
- * Square seller account.
- *
- * To retrieve a custom attribute definition created by another application, the `visibility`
- * setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined
- * custom attributes
- * (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $key The key of the custom attribute definition to retrieve. If the requesting
- * application
- * is not the definition owner, you must use the qualified key.
- * @param int|null $version The current version of the custom attribute definition, which is
- * used for strongly consistent
- * reads to guarantee that you receive the most up-to-date data. When included in the
- * request,
- * Square returns the specified version or a higher version if one exists. If the
- * specified version
- * is higher than the current version, Square returns a `BAD_REQUEST` error.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveCustomerCustomAttributeDefinition(string $key, ?int $version = null): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::GET,
- '/v2/customers/custom-attribute-definitions/{key}'
- )->auth('global')->parameters(TemplateParam::init('key', $key), QueryParam::init('version', $version));
-
- $_resHandler = $this->responseHandler()
- ->type(RetrieveCustomerCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates a customer-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square
- * seller account.
- *
- * Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the
- * `schema` for a `Selection` data type.
- *
- * Only the definition owner can update a custom attribute definition. Note that sellers can view
- * all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.
- *
- * @param string $key The key of the custom attribute definition to update.
- * @param UpdateCustomerCustomAttributeDefinitionRequest $body An object containing the fields
- * to POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateCustomerCustomAttributeDefinition(
- string $key,
- UpdateCustomerCustomAttributeDefinitionRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::PUT,
- '/v2/customers/custom-attribute-definitions/{key}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('key', $key),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(UpdateCustomerCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates or updates [custom attributes]($m/CustomAttribute) for customer profiles as a bulk operation.
- *
- * Use this endpoint to set the value of one or more custom attributes for one or more customer
- * profiles.
- * A custom attribute is based on a custom attribute definition in a Square seller account, which is
- * created using the
- * [CreateCustomerCustomAttributeDefinition]($e/CustomerCustomAttributes/CreateCustomerCustomAttributeD
- * efinition) endpoint.
- *
- * This `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert
- * requests and returns a map of individual upsert responses. Each upsert request has a unique ID
- * and provides a customer ID and custom attribute. Each upsert response is returned with the ID
- * of the corresponding request.
- *
- * To create or update a custom attribute owned by another application, the `visibility` setting
- * must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes
- * (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param BulkUpsertCustomerCustomAttributesRequest $body An object containing the fields to
- * POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkUpsertCustomerCustomAttributes(BulkUpsertCustomerCustomAttributesRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/customers/custom-attributes/bulk-upsert')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(BulkUpsertCustomerCustomAttributesResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Lists the [custom attributes]($m/CustomAttribute) associated with a customer profile.
- *
- * You can use the `with_definitions` query parameter to also retrieve custom attribute definitions
- * in the same call.
- *
- * When all response pages are retrieved, the results include all custom attributes that are
- * visible to the requesting application, including those that are owned by other applications
- * and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $customerId The ID of the target [customer profile](entity:Customer).
- * @param int|null $limit The maximum number of results to return in a single paged response.
- * This limit is advisory.
- * The response might contain more or fewer results. The minimum value is 1 and the
- * maximum value is 100.
- * The default value is 20. For more information, see [Pagination](https://developer.
- * squareup.com/docs/build-basics/common-api-patterns/pagination).
- * @param string|null $cursor The cursor returned in the paged response from the previous call
- * to this endpoint.
- * Provide this cursor to retrieve the next page of results for your original request.
- * For more
- * information, see [Pagination](https://developer.squareup.com/docs/build-
- * basics/common-api-patterns/pagination).
- * @param bool|null $withDefinitions Indicates whether to return the [custom attribute
- * definition](entity:CustomAttributeDefinition) in the `definition` field of each
- * custom attribute. Set this parameter to `true` to get the name and description of
- * each custom
- * attribute, information about the data type, or other definition details. The default
- * value is `false`.
- *
- * @return ApiResponse Response from the API call
- */
- public function listCustomerCustomAttributes(
- string $customerId,
- ?int $limit = null,
- ?string $cursor = null,
- ?bool $withDefinitions = false
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/customers/{customer_id}/custom-attributes')
- ->auth('global')
- ->parameters(
- TemplateParam::init('customer_id', $customerId),
- QueryParam::init('limit', $limit),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('with_definitions', $withDefinitions)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(ListCustomerCustomAttributesResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a [custom attribute]($m/CustomAttribute) associated with a customer profile.
- *
- * To delete a custom attribute owned by another application, the `visibility` setting must be
- * `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes
- * (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $customerId The ID of the target [customer profile](entity:Customer).
- * @param string $key The key of the custom attribute to delete. This key must match the `key`
- * of a custom
- * attribute definition in the Square seller account. If the requesting application is
- * not the
- * definition owner, you must use the qualified key.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteCustomerCustomAttribute(string $customerId, string $key): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::DELETE,
- '/v2/customers/{customer_id}/custom-attributes/{key}'
- )
- ->auth('global')
- ->parameters(TemplateParam::init('customer_id', $customerId), TemplateParam::init('key', $key));
-
- $_resHandler = $this->responseHandler()
- ->type(DeleteCustomerCustomAttributeResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a [custom attribute]($m/CustomAttribute) associated with a customer profile.
- *
- * You can use the `with_definition` query parameter to also retrieve the custom attribute definition
- * in the same call.
- *
- * To retrieve a custom attribute owned by another application, the `visibility` setting must be
- * `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom
- * attributes
- * (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $customerId The ID of the target [customer profile](entity:Customer).
- * @param string $key The key of the custom attribute to retrieve. This key must match the `key`
- * of a custom
- * attribute definition in the Square seller account. If the requesting application is
- * not the
- * definition owner, you must use the qualified key.
- * @param bool|null $withDefinition Indicates whether to return the [custom attribute
- * definition](entity:CustomAttributeDefinition) in the `definition` field of
- * the custom attribute. Set this parameter to `true` to get the name and description
- * of the custom
- * attribute, information about the data type, or other definition details. The default
- * value is `false`.
- * @param int|null $version The current version of the custom attribute, which is used for
- * strongly consistent reads to
- * guarantee that you receive the most up-to-date data. When included in the request,
- * Square
- * returns the specified version or a higher version if one exists. If the specified
- * version is
- * higher than the current version, Square returns a `BAD_REQUEST` error.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveCustomerCustomAttribute(
- string $customerId,
- string $key,
- ?bool $withDefinition = false,
- ?int $version = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::GET,
- '/v2/customers/{customer_id}/custom-attributes/{key}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('customer_id', $customerId),
- TemplateParam::init('key', $key),
- QueryParam::init('with_definition', $withDefinition),
- QueryParam::init('version', $version)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(RetrieveCustomerCustomAttributeResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates or updates a [custom attribute]($m/CustomAttribute) for a customer profile.
- *
- * Use this endpoint to set the value of a custom attribute for a specified customer profile.
- * A custom attribute is based on a custom attribute definition in a Square seller account, which
- * is created using the
- * [CreateCustomerCustomAttributeDefinition]($e/CustomerCustomAttributes/CreateCustomerCustomAttributeD
- * efinition) endpoint.
- *
- * To create or update a custom attribute owned by another application, the `visibility` setting
- * must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes
- * (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $customerId The ID of the target [customer profile](entity:Customer).
- * @param string $key The key of the custom attribute to create or update. This key must match
- * the `key` of a
- * custom attribute definition in the Square seller account. If the requesting
- * application is not
- * the definition owner, you must use the qualified key.
- * @param UpsertCustomerCustomAttributeRequest $body An object containing the fields to POST for
- * the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function upsertCustomerCustomAttribute(
- string $customerId,
- string $key,
- UpsertCustomerCustomAttributeRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::POST,
- '/v2/customers/{customer_id}/custom-attributes/{key}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('customer_id', $customerId),
- TemplateParam::init('key', $key),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(UpsertCustomerCustomAttributeResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/CustomerGroupsApi.php b/src/Apis/CustomerGroupsApi.php
deleted file mode 100644
index f100096d..00000000
--- a/src/Apis/CustomerGroupsApi.php
+++ /dev/null
@@ -1,136 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/customers/groups')
- ->auth('global')
- ->parameters(QueryParam::init('cursor', $cursor), QueryParam::init('limit', $limit));
-
- $_resHandler = $this->responseHandler()->type(ListCustomerGroupsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a new customer group for a business.
- *
- * The request must include the `name` value of the group.
- *
- * @param CreateCustomerGroupRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createCustomerGroup(CreateCustomerGroupRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/customers/groups')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateCustomerGroupResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a customer group as identified by the `group_id` value.
- *
- * @param string $groupId The ID of the customer group to delete.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteCustomerGroup(string $groupId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v2/customers/groups/{group_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('group_id', $groupId));
-
- $_resHandler = $this->responseHandler()->type(DeleteCustomerGroupResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a specific customer group as identified by the `group_id` value.
- *
- * @param string $groupId The ID of the customer group to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveCustomerGroup(string $groupId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/customers/groups/{group_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('group_id', $groupId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveCustomerGroupResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates a customer group as identified by the `group_id` value.
- *
- * @param string $groupId The ID of the customer group to update.
- * @param UpdateCustomerGroupRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateCustomerGroup(string $groupId, UpdateCustomerGroupRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/customers/groups/{group_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('group_id', $groupId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateCustomerGroupResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/CustomerSegmentsApi.php b/src/Apis/CustomerSegmentsApi.php
deleted file mode 100644
index 7670e969..00000000
--- a/src/Apis/CustomerSegmentsApi.php
+++ /dev/null
@@ -1,63 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/customers/segments')
- ->auth('global')
- ->parameters(QueryParam::init('cursor', $cursor), QueryParam::init('limit', $limit));
-
- $_resHandler = $this->responseHandler()->type(ListCustomerSegmentsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a specific customer segment as identified by the `segment_id` value.
- *
- * @param string $segmentId The Square-issued ID of the customer segment.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveCustomerSegment(string $segmentId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/customers/segments/{segment_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('segment_id', $segmentId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveCustomerSegmentResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/CustomersApi.php b/src/Apis/CustomersApi.php
deleted file mode 100644
index c91549dd..00000000
--- a/src/Apis/CustomersApi.php
+++ /dev/null
@@ -1,437 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/customers')
- ->auth('global')
- ->parameters(
- QueryParam::init('cursor', $cursor),
- QueryParam::init('limit', $limit),
- QueryParam::init('sort_field', $sortField),
- QueryParam::init('sort_order', $sortOrder),
- QueryParam::init('count', $count)
- );
-
- $_resHandler = $this->responseHandler()->type(ListCustomersResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a new customer for a business.
- *
- * You must provide at least one of the following values in your request to this
- * endpoint:
- *
- * - `given_name`
- * - `family_name`
- * - `company_name`
- * - `email_address`
- * - `phone_number`
- *
- * @param CreateCustomerRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createCustomer(CreateCustomerRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/customers')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateCustomerResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates multiple [customer profiles]($m/Customer) for a business.
- *
- * This endpoint takes a map of individual create requests and returns a map of responses.
- *
- * You must provide at least one of the following values in each create request:
- *
- * - `given_name`
- * - `family_name`
- * - `company_name`
- * - `email_address`
- * - `phone_number`
- *
- * @param BulkCreateCustomersRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkCreateCustomers(BulkCreateCustomersRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/customers/bulk-create')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BulkCreateCustomersResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes multiple customer profiles.
- *
- * The endpoint takes a list of customer IDs and returns a map of responses.
- *
- * @param BulkDeleteCustomersRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkDeleteCustomers(BulkDeleteCustomersRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/customers/bulk-delete')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BulkDeleteCustomersResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves multiple customer profiles.
- *
- * This endpoint takes a list of customer IDs and returns a map of responses.
- *
- * @param BulkRetrieveCustomersRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkRetrieveCustomers(BulkRetrieveCustomersRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/customers/bulk-retrieve')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BulkRetrieveCustomersResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates multiple customer profiles.
- *
- * This endpoint takes a map of individual update requests and returns a map of responses.
- *
- * You cannot use this endpoint to change cards on file. To make changes, use the [Cards API]($e/Cards)
- * or [Gift Cards API]($e/GiftCards).
- *
- * @param BulkUpdateCustomersRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkUpdateCustomers(BulkUpdateCustomersRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/customers/bulk-update')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BulkUpdateCustomersResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Searches the customer profiles associated with a Square account using one or more supported query
- * filters.
- *
- * Calling `SearchCustomers` without any explicit query filter returns all
- * customer profiles ordered alphabetically based on `given_name` and
- * `family_name`.
- *
- * Under normal operating conditions, newly created or updated customer profiles become available
- * for the search operation in well under 30 seconds. Occasionally, propagation of the new or updated
- * profiles can take closer to one minute or longer, especially during network incidents and outages.
- *
- * @param SearchCustomersRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function searchCustomers(SearchCustomersRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/customers/search')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchCustomersResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a customer profile from a business. This operation also unlinks any associated cards on file.
- *
- * To delete a customer profile that was created by merging existing profiles, you must use the ID of
- * the newly created profile.
- *
- * @param string $customerId The ID of the customer to delete.
- * @param int|null $version The current version of the customer profile. As a best practice, you
- * should include this parameter to enable [optimistic concurrency](https://developer.
- * squareup.com/docs/build-basics/common-api-patterns/optimistic-concurrency) control.
- * For more information, see [Delete a customer profile](https://developer.squareup.
- * com/docs/customers-api/use-the-api/keep-records#delete-customer-profile).
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteCustomer(string $customerId, ?int $version = null): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v2/customers/{customer_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('customer_id', $customerId), QueryParam::init('version', $version));
-
- $_resHandler = $this->responseHandler()->type(DeleteCustomerResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns details for a single customer.
- *
- * @param string $customerId The ID of the customer to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveCustomer(string $customerId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/customers/{customer_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('customer_id', $customerId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveCustomerResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates a customer profile. This endpoint supports sparse updates, so only new or changed fields are
- * required in the request.
- * To add or update a field, specify the new value. To remove a field, specify `null`.
- *
- * To update a customer profile that was created by merging existing profiles, you must use the ID of
- * the newly created profile.
- *
- * You cannot use this endpoint to change cards on file. To make changes, use the [Cards API]($e/Cards)
- * or [Gift Cards API]($e/GiftCards).
- *
- * @param string $customerId The ID of the customer to update.
- * @param UpdateCustomerRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateCustomer(string $customerId, UpdateCustomerRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/customers/{customer_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('customer_id', $customerId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateCustomerResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Adds a card on file to an existing customer.
- *
- * As with charges, calls to `CreateCustomerCard` are idempotent. Multiple
- * calls with the same card nonce return the same card record that was created
- * with the provided nonce during the _first_ call.
- *
- * @deprecated
- *
- * @param string $customerId The Square ID of the customer profile the card is linked to.
- * @param CreateCustomerCardRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createCustomerCard(string $customerId, CreateCustomerCardRequest $body): ApiResponse
- {
- trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
-
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/customers/{customer_id}/cards')
- ->auth('global')
- ->parameters(
- TemplateParam::init('customer_id', $customerId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(CreateCustomerCardResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Removes a card on file from a customer.
- *
- * @deprecated
- *
- * @param string $customerId The ID of the customer that the card on file belongs to.
- * @param string $cardId The ID of the card on file to delete.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteCustomerCard(string $customerId, string $cardId): ApiResponse
- {
- trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
-
- $_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v2/customers/{customer_id}/cards/{card_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('customer_id', $customerId), TemplateParam::init('card_id', $cardId));
-
- $_resHandler = $this->responseHandler()->type(DeleteCustomerCardResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Removes a group membership from a customer.
- *
- * The customer is identified by the `customer_id` value
- * and the customer group is identified by the `group_id` value.
- *
- * @param string $customerId The ID of the customer to remove from the group.
- * @param string $groupId The ID of the customer group to remove the customer from.
- *
- * @return ApiResponse Response from the API call
- */
- public function removeGroupFromCustomer(string $customerId, string $groupId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::DELETE,
- '/v2/customers/{customer_id}/groups/{group_id}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('customer_id', $customerId),
- TemplateParam::init('group_id', $groupId)
- );
-
- $_resHandler = $this->responseHandler()->type(RemoveGroupFromCustomerResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Adds a group membership to a customer.
- *
- * The customer is identified by the `customer_id` value
- * and the customer group is identified by the `group_id` value.
- *
- * @param string $customerId The ID of the customer to add to a group.
- * @param string $groupId The ID of the customer group to add the customer to.
- *
- * @return ApiResponse Response from the API call
- */
- public function addGroupToCustomer(string $customerId, string $groupId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/customers/{customer_id}/groups/{group_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('customer_id', $customerId),
- TemplateParam::init('group_id', $groupId)
- );
-
- $_resHandler = $this->responseHandler()->type(AddGroupToCustomerResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/DevicesApi.php b/src/Apis/DevicesApi.php
deleted file mode 100644
index 69c81748..00000000
--- a/src/Apis/DevicesApi.php
+++ /dev/null
@@ -1,152 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/devices')
- ->auth('global')
- ->parameters(
- QueryParam::init('cursor', $cursor),
- QueryParam::init('sort_order', $sortOrder),
- QueryParam::init('limit', $limit),
- QueryParam::init('location_id', $locationId)
- );
-
- $_resHandler = $this->responseHandler()->type(ListDevicesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Lists all DeviceCodes associated with the merchant.
- *
- * @param string|null $cursor A pagination cursor returned by a previous call to this endpoint.
- * Provide this to retrieve the next set of results for your original query.
- *
- * See [Paginating results](https://developer.squareup.com/docs/working-with-
- * apis/pagination) for more information.
- * @param string|null $locationId If specified, only returns DeviceCodes of the specified
- * location.
- * Returns DeviceCodes of all locations if empty.
- * @param string|null $productType If specified, only returns DeviceCodes targeting the
- * specified product type.
- * Returns DeviceCodes of all product types if empty.
- * @param string|null $status If specified, returns DeviceCodes with the specified statuses.
- * Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty.
- *
- * @return ApiResponse Response from the API call
- */
- public function listDeviceCodes(
- ?string $cursor = null,
- ?string $locationId = null,
- ?string $productType = null,
- ?string $status = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/devices/codes')
- ->auth('global')
- ->parameters(
- QueryParam::init('cursor', $cursor),
- QueryParam::init('location_id', $locationId),
- QueryParam::init('product_type', $productType),
- QueryParam::init('status', $status)
- );
-
- $_resHandler = $this->responseHandler()->type(ListDeviceCodesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a DeviceCode that can be used to login to a Square Terminal device to enter the connected
- * terminal mode.
- *
- * @param CreateDeviceCodeRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createDeviceCode(CreateDeviceCodeRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/devices/codes')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateDeviceCodeResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves DeviceCode with the associated ID.
- *
- * @param string $id The unique identifier for the device code.
- *
- * @return ApiResponse Response from the API call
- */
- public function getDeviceCode(string $id): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/devices/codes/{id}')
- ->auth('global')
- ->parameters(TemplateParam::init('id', $id));
-
- $_resHandler = $this->responseHandler()->type(GetDeviceCodeResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves Device with the associated `device_id`.
- *
- * @param string $deviceId The unique ID for the desired `Device`.
- *
- * @return ApiResponse Response from the API call
- */
- public function getDevice(string $deviceId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/devices/{device_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('device_id', $deviceId));
-
- $_resHandler = $this->responseHandler()->type(GetDeviceResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/DisputesApi.php b/src/Apis/DisputesApi.php
deleted file mode 100644
index 382c8c9c..00000000
--- a/src/Apis/DisputesApi.php
+++ /dev/null
@@ -1,257 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/disputes')
- ->auth('global')
- ->parameters(
- QueryParam::init('cursor', $cursor),
- QueryParam::init('states', $states),
- QueryParam::init('location_id', $locationId)
- );
-
- $_resHandler = $this->responseHandler()->type(ListDisputesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns details about a specific dispute.
- *
- * @param string $disputeId The ID of the dispute you want more details about.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveDispute(string $disputeId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/disputes/{dispute_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('dispute_id', $disputeId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveDisputeResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and
- * updates the dispute state to ACCEPTED.
- *
- * Square debits the disputed amount from the seller’s Square account. If the Square account
- * does not have sufficient funds, Square debits the associated bank account.
- *
- * @param string $disputeId The ID of the dispute you want to accept.
- *
- * @return ApiResponse Response from the API call
- */
- public function acceptDispute(string $disputeId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/disputes/{dispute_id}/accept')
- ->auth('global')
- ->parameters(TemplateParam::init('dispute_id', $disputeId));
-
- $_resHandler = $this->responseHandler()->type(AcceptDisputeResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns a list of evidence associated with a dispute.
- *
- * @param string $disputeId The ID of the dispute.
- * @param string|null $cursor A pagination cursor returned by a previous call to this endpoint.
- * Provide this cursor to retrieve the next set of results for the original query.
- * For more information, see [Pagination](https://developer.squareup.com/docs/build-
- * basics/common-api-patterns/pagination).
- *
- * @return ApiResponse Response from the API call
- */
- public function listDisputeEvidence(string $disputeId, ?string $cursor = null): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/disputes/{dispute_id}/evidence')
- ->auth('global')
- ->parameters(TemplateParam::init('dispute_id', $disputeId), QueryParam::init('cursor', $cursor));
-
- $_resHandler = $this->responseHandler()->type(ListDisputeEvidenceResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Uploads a file to use as evidence in a dispute challenge. The endpoint accepts HTTP
- * multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF formats.
- *
- * @param string $disputeId The ID of the dispute for which you want to upload evidence.
- * @param CreateDisputeEvidenceFileRequest|null $request Defines the parameters for a
- * `CreateDisputeEvidenceFile` request.
- * @param FileWrapper|null $imageFile
- *
- * @return ApiResponse Response from the API call
- */
- public function createDisputeEvidenceFile(
- string $disputeId,
- ?CreateDisputeEvidenceFileRequest $request = null,
- ?FileWrapper $imageFile = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/disputes/{dispute_id}/evidence-files')
- ->auth('global')
- ->parameters(
- TemplateParam::init('dispute_id', $disputeId),
- FormParam::init('request', $request)
- ->encodingHeader('Content-Type', 'application/json; charset=utf-8'),
- FormParam::init('image_file', $imageFile)->encodingHeader('Content-Type', 'image/jpeg')
- );
-
- $_resHandler = $this->responseHandler()->type(CreateDisputeEvidenceFileResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Uploads text to use as evidence for a dispute challenge.
- *
- * @param string $disputeId The ID of the dispute for which you want to upload evidence.
- * @param CreateDisputeEvidenceTextRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createDisputeEvidenceText(string $disputeId, CreateDisputeEvidenceTextRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/disputes/{dispute_id}/evidence-text')
- ->auth('global')
- ->parameters(
- TemplateParam::init('dispute_id', $disputeId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(CreateDisputeEvidenceTextResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Removes specified evidence from a dispute.
- * Square does not send the bank any evidence that is removed.
- *
- * @param string $disputeId The ID of the dispute from which you want to remove evidence.
- * @param string $evidenceId The ID of the evidence you want to remove.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteDisputeEvidence(string $disputeId, string $evidenceId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::DELETE,
- '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('dispute_id', $disputeId),
- TemplateParam::init('evidence_id', $evidenceId)
- );
-
- $_resHandler = $this->responseHandler()->type(DeleteDisputeEvidenceResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns the metadata for the evidence specified in the request URL path.
- *
- * You must maintain a copy of any evidence uploaded if you want to reference it later. Evidence cannot
- * be downloaded after you upload it.
- *
- * @param string $disputeId The ID of the dispute from which you want to retrieve evidence
- * metadata.
- * @param string $evidenceId The ID of the evidence to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveDisputeEvidence(string $disputeId, string $evidenceId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::GET,
- '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('dispute_id', $disputeId),
- TemplateParam::init('evidence_id', $evidenceId)
- );
-
- $_resHandler = $this->responseHandler()->type(RetrieveDisputeEvidenceResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Submits evidence to the cardholder's bank.
- *
- * The evidence submitted by this endpoint includes evidence uploaded
- * using the [CreateDisputeEvidenceFile]($e/Disputes/CreateDisputeEvidenceFile) and
- * [CreateDisputeEvidenceText]($e/Disputes/CreateDisputeEvidenceText) endpoints and
- * evidence automatically provided by Square, when available. Evidence cannot be removed from
- * a dispute after submission.
- *
- * @param string $disputeId The ID of the dispute for which you want to submit evidence.
- *
- * @return ApiResponse Response from the API call
- */
- public function submitEvidence(string $disputeId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/disputes/{dispute_id}/submit-evidence')
- ->auth('global')
- ->parameters(TemplateParam::init('dispute_id', $disputeId));
-
- $_resHandler = $this->responseHandler()->type(SubmitEvidenceResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/EmployeesApi.php b/src/Apis/EmployeesApi.php
deleted file mode 100644
index a41602bf..00000000
--- a/src/Apis/EmployeesApi.php
+++ /dev/null
@@ -1,67 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/employees')
- ->auth('global')
- ->parameters(
- QueryParam::init('location_id', $locationId),
- QueryParam::init('status', $status),
- QueryParam::init('limit', $limit),
- QueryParam::init('cursor', $cursor)
- );
-
- $_resHandler = $this->responseHandler()->type(ListEmployeesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * @deprecated
- *
- * @param string $id UUID for the employee that was requested.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveEmployee(string $id): ApiResponse
- {
- trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
-
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/employees/{id}')
- ->auth('global')
- ->parameters(TemplateParam::init('id', $id));
-
- $_resHandler = $this->responseHandler()->type(RetrieveEmployeeResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/EventsApi.php b/src/Apis/EventsApi.php
deleted file mode 100644
index eefb48a0..00000000
--- a/src/Apis/EventsApi.php
+++ /dev/null
@@ -1,89 +0,0 @@
-requestBuilder(RequestMethod::POST, '/v2/events')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchEventsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Disables events to prevent them from being searchable.
- * All events are disabled by default. You must enable events to make them searchable.
- * Disabling events for a specific time period prevents them from being searchable, even if you re-
- * enable them later.
- *
- * @return ApiResponse Response from the API call
- */
- public function disableEvents(): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/events/disable')->auth('global');
-
- $_resHandler = $this->responseHandler()->type(DisableEventsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Enables events to make them searchable. Only events that occur while in the enabled state are
- * searchable.
- *
- * @return ApiResponse Response from the API call
- */
- public function enableEvents(): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/events/enable')->auth('global');
-
- $_resHandler = $this->responseHandler()->type(EnableEventsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Lists all event types that you can subscribe to as webhooks or query using the Events API.
- *
- * @param string|null $apiVersion The API version for which to list event types. Setting this
- * field overrides the default version used by the application.
- *
- * @return ApiResponse Response from the API call
- */
- public function listEventTypes(?string $apiVersion = null): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/events/types')
- ->auth('global')
- ->parameters(QueryParam::init('api_version', $apiVersion));
-
- $_resHandler = $this->responseHandler()->type(ListEventTypesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/GiftCardActivitiesApi.php b/src/Apis/GiftCardActivitiesApi.php
deleted file mode 100644
index 718247e4..00000000
--- a/src/Apis/GiftCardActivitiesApi.php
+++ /dev/null
@@ -1,107 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/gift-cards/activities')
- ->auth('global')
- ->parameters(
- QueryParam::init('gift_card_id', $giftCardId),
- QueryParam::init('type', $type),
- QueryParam::init('location_id', $locationId),
- QueryParam::init('begin_time', $beginTime),
- QueryParam::init('end_time', $endTime),
- QueryParam::init('limit', $limit),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('sort_order', $sortOrder)
- );
-
- $_resHandler = $this->responseHandler()->type(ListGiftCardActivitiesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a gift card activity to manage the balance or state of a [gift card]($m/GiftCard).
- * For example, create an `ACTIVATE` activity to activate a gift card with an initial balance before
- * first use.
- *
- * @param CreateGiftCardActivityRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createGiftCardActivity(CreateGiftCardActivityRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/gift-cards/activities')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateGiftCardActivityResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/GiftCardsApi.php b/src/Apis/GiftCardsApi.php
deleted file mode 100644
index c689a91e..00000000
--- a/src/Apis/GiftCardsApi.php
+++ /dev/null
@@ -1,212 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/gift-cards')
- ->auth('global')
- ->parameters(
- QueryParam::init('type', $type),
- QueryParam::init('state', $state),
- QueryParam::init('limit', $limit),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('customer_id', $customerId)
- );
-
- $_resHandler = $this->responseHandler()->type(ListGiftCardsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a digital gift card or registers a physical (plastic) gift card. The resulting gift card
- * has a `PENDING` state. To activate a gift card so that it can be redeemed for purchases, call
- * [CreateGiftCardActivity]($e/GiftCardActivities/CreateGiftCardActivity) and create an `ACTIVATE`
- * activity with the initial balance. Alternatively, you can use
- * [RefundPayment]($e/Refunds/RefundPayment)
- * to refund a payment to the new gift card.
- *
- * @param CreateGiftCardRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createGiftCard(CreateGiftCardRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/gift-cards')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateGiftCardResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a gift card using the gift card account number (GAN).
- *
- * @param RetrieveGiftCardFromGANRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveGiftCardFromGAN(RetrieveGiftCardFromGANRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/gift-cards/from-gan')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(RetrieveGiftCardFromGANResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a gift card using a secure payment token that represents the gift card.
- *
- * @param RetrieveGiftCardFromNonceRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveGiftCardFromNonce(RetrieveGiftCardFromNonceRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/gift-cards/from-nonce')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(RetrieveGiftCardFromNonceResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Links a customer to a gift card, which is also referred to as adding a card on file.
- *
- * @param string $giftCardId The ID of the gift card to be linked.
- * @param LinkCustomerToGiftCardRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function linkCustomerToGiftCard(string $giftCardId, LinkCustomerToGiftCardRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/gift-cards/{gift_card_id}/link-customer')
- ->auth('global')
- ->parameters(
- TemplateParam::init('gift_card_id', $giftCardId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(LinkCustomerToGiftCardResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Unlinks a customer from a gift card, which is also referred to as removing a card on file.
- *
- * @param string $giftCardId The ID of the gift card to be unlinked.
- * @param UnlinkCustomerFromGiftCardRequest $body An object containing the fields to POST for
- * the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function unlinkCustomerFromGiftCard(
- string $giftCardId,
- UnlinkCustomerFromGiftCardRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/gift-cards/{gift_card_id}/unlink-customer')
- ->auth('global')
- ->parameters(
- TemplateParam::init('gift_card_id', $giftCardId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UnlinkCustomerFromGiftCardResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a gift card using the gift card ID.
- *
- * @param string $id The ID of the gift card to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveGiftCard(string $id): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/gift-cards/{id}')
- ->auth('global')
- ->parameters(TemplateParam::init('id', $id));
-
- $_resHandler = $this->responseHandler()->type(RetrieveGiftCardResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/InventoryApi.php b/src/Apis/InventoryApi.php
deleted file mode 100644
index 38ec18b7..00000000
--- a/src/Apis/InventoryApi.php
+++ /dev/null
@@ -1,401 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/inventory/adjustment/{adjustment_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('adjustment_id', $adjustmentId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveInventoryAdjustmentResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns the [InventoryAdjustment]($m/InventoryAdjustment) object
- * with the provided `adjustment_id`.
- *
- * @param string $adjustmentId ID of the [InventoryAdjustment](entity:InventoryAdjustment) to
- * retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveInventoryAdjustment(string $adjustmentId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/inventory/adjustments/{adjustment_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('adjustment_id', $adjustmentId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveInventoryAdjustmentResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deprecated version of [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) after the
- * endpoint URL
- * is updated to conform to the standard convention.
- *
- * @deprecated
- *
- * @param BatchChangeInventoryRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function deprecatedBatchChangeInventory(BatchChangeInventoryRequest $body): ApiResponse
- {
- trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
-
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/inventory/batch-change')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BatchChangeInventoryResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deprecated version of [BatchRetrieveInventoryChanges](api-endpoint:Inventory-
- * BatchRetrieveInventoryChanges) after the endpoint URL
- * is updated to conform to the standard convention.
- *
- * @deprecated
- *
- * @param BatchRetrieveInventoryChangesRequest $body An object containing the fields to POST for
- * the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function deprecatedBatchRetrieveInventoryChanges(BatchRetrieveInventoryChangesRequest $body): ApiResponse
- {
- trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
-
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/inventory/batch-retrieve-changes')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(BatchRetrieveInventoryChangesResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deprecated version of [BatchRetrieveInventoryCounts](api-endpoint:Inventory-
- * BatchRetrieveInventoryCounts) after the endpoint URL
- * is updated to conform to the standard convention.
- *
- * @deprecated
- *
- * @param BatchRetrieveInventoryCountsRequest $body An object containing the fields to POST for
- * the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function deprecatedBatchRetrieveInventoryCounts(BatchRetrieveInventoryCountsRequest $body): ApiResponse
- {
- trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
-
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/inventory/batch-retrieve-counts')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(BatchRetrieveInventoryCountsResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Applies adjustments and counts to the provided item quantities.
- *
- * On success: returns the current calculated counts for all objects
- * referenced in the request.
- * On failure: returns a list of related errors.
- *
- * @param BatchChangeInventoryRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function batchChangeInventory(BatchChangeInventoryRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/inventory/changes/batch-create')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BatchChangeInventoryResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns historical physical counts and adjustments based on the
- * provided filter criteria.
- *
- * Results are paginated and sorted in ascending order according their
- * `occurred_at` timestamp (oldest first).
- *
- * BatchRetrieveInventoryChanges is a catch-all query endpoint for queries
- * that cannot be handled by other, simpler endpoints.
- *
- * @param BatchRetrieveInventoryChangesRequest $body An object containing the fields to POST for
- * the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function batchRetrieveInventoryChanges(BatchRetrieveInventoryChangesRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/inventory/changes/batch-retrieve')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(BatchRetrieveInventoryChangesResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns current counts for the provided
- * [CatalogObject]($m/CatalogObject)s at the requested
- * [Location]($m/Location)s.
- *
- * Results are paginated and sorted in descending order according to their
- * `calculated_at` timestamp (newest first).
- *
- * When `updated_after` is specified, only counts that have changed since that
- * time (based on the server timestamp for the most recent change) are
- * returned. This allows clients to perform a "sync" operation, for example
- * in response to receiving a Webhook notification.
- *
- * @param BatchRetrieveInventoryCountsRequest $body An object containing the fields to POST for
- * the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function batchRetrieveInventoryCounts(BatchRetrieveInventoryCountsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/inventory/counts/batch-retrieve')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(BatchRetrieveInventoryCountsResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deprecated version of [RetrieveInventoryPhysicalCount](api-endpoint:Inventory-
- * RetrieveInventoryPhysicalCount) after the endpoint URL
- * is updated to conform to the standard convention.
- *
- * @deprecated
- *
- * @param string $physicalCountId ID of the
- * [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function deprecatedRetrieveInventoryPhysicalCount(string $physicalCountId): ApiResponse
- {
- trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
-
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::GET,
- '/v2/inventory/physical-count/{physical_count_id}'
- )->auth('global')->parameters(TemplateParam::init('physical_count_id', $physicalCountId));
-
- $_resHandler = $this->responseHandler()
- ->type(RetrieveInventoryPhysicalCountResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns the [InventoryPhysicalCount]($m/InventoryPhysicalCount)
- * object with the provided `physical_count_id`.
- *
- * @param string $physicalCountId ID of the
- * [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveInventoryPhysicalCount(string $physicalCountId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::GET,
- '/v2/inventory/physical-counts/{physical_count_id}'
- )->auth('global')->parameters(TemplateParam::init('physical_count_id', $physicalCountId));
-
- $_resHandler = $this->responseHandler()
- ->type(RetrieveInventoryPhysicalCountResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns the [InventoryTransfer]($m/InventoryTransfer) object
- * with the provided `transfer_id`.
- *
- * @param string $transferId ID of the [InventoryTransfer](entity:InventoryTransfer) to
- * retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveInventoryTransfer(string $transferId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/inventory/transfers/{transfer_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('transfer_id', $transferId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveInventoryTransferResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves the current calculated stock count for a given
- * [CatalogObject]($m/CatalogObject) at a given set of
- * [Location]($m/Location)s. Responses are paginated and unsorted.
- * For more sophisticated queries, use a batch endpoint.
- *
- * @param string $catalogObjectId ID of the [CatalogObject](entity:CatalogObject) to retrieve.
- * @param string|null $locationIds The [Location](entity:Location) IDs to look up as a
- * comma-separated
- * list. An empty list queries all locations.
- * @param string|null $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 the [Pagination](https://developer.squareup.com/docs/working-with-
- * apis/pagination) guide for more information.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveInventoryCount(
- string $catalogObjectId,
- ?string $locationIds = null,
- ?string $cursor = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/inventory/{catalog_object_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('catalog_object_id', $catalogObjectId),
- QueryParam::init('location_ids', $locationIds),
- QueryParam::init('cursor', $cursor)
- );
-
- $_resHandler = $this->responseHandler()->type(RetrieveInventoryCountResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns a set of physical counts and inventory adjustments for the
- * provided [CatalogObject](entity:CatalogObject) at the requested
- * [Location](entity:Location)s.
- *
- * You can achieve the same result by calling [BatchRetrieveInventoryChanges](api-endpoint:Inventory-
- * BatchRetrieveInventoryChanges)
- * and having the `catalog_object_ids` list contain a single element of the `CatalogObject` ID.
- *
- * Results are paginated and sorted in descending order according to their
- * `occurred_at` timestamp (newest first).
- *
- * There are no limits on how far back the caller can page. This endpoint can be
- * used to display recent changes for a specific item. For more
- * sophisticated queries, use a batch endpoint.
- *
- * @deprecated
- *
- * @param string $catalogObjectId ID of the [CatalogObject](entity:CatalogObject) to retrieve.
- * @param string|null $locationIds The [Location](entity:Location) IDs to look up as a
- * comma-separated
- * list. An empty list queries all locations.
- * @param string|null $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 the [Pagination](https://developer.squareup.com/docs/working-with-
- * apis/pagination) guide for more information.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveInventoryChanges(
- string $catalogObjectId,
- ?string $locationIds = null,
- ?string $cursor = null
- ): ApiResponse {
- trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
-
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/inventory/{catalog_object_id}/changes')
- ->auth('global')
- ->parameters(
- TemplateParam::init('catalog_object_id', $catalogObjectId),
- QueryParam::init('location_ids', $locationIds),
- QueryParam::init('cursor', $cursor)
- );
-
- $_resHandler = $this->responseHandler()->type(RetrieveInventoryChangesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/InvoicesApi.php b/src/Apis/InvoicesApi.php
deleted file mode 100644
index 085fc1e6..00000000
--- a/src/Apis/InvoicesApi.php
+++ /dev/null
@@ -1,311 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/invoices')
- ->auth('global')
- ->parameters(
- QueryParam::init('location_id', $locationId),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('limit', $limit)
- );
-
- $_resHandler = $this->responseHandler()->type(ListInvoicesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a draft [invoice]($m/Invoice)
- * for an order created using the Orders API.
- *
- * A draft invoice remains in your account and no action is taken.
- * You must publish the invoice before Square can process it (send it to the customer's email address
- * or charge the customer’s card on file).
- *
- * @param CreateInvoiceRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createInvoice(CreateInvoiceRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/invoices')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateInvoiceResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Searches for invoices from a location specified in
- * the filter. You can optionally specify customers in the filter for whom to
- * retrieve invoices. In the current implementation, you can only specify one location and
- * optionally one customer.
- *
- * The response is paginated. If truncated, the response includes a `cursor`
- * that you use in a subsequent request to retrieve the next set of invoices.
- *
- * @param SearchInvoicesRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function searchInvoices(SearchInvoicesRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/invoices/search')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchInvoicesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes the specified invoice. When an invoice is deleted, the
- * associated order status changes to CANCELED. You can only delete a draft
- * invoice (you cannot delete a published invoice, including one that is scheduled for processing).
- *
- * @param string $invoiceId The ID of the invoice to delete.
- * @param int|null $version The version of the [invoice](entity:Invoice) to delete. If you do
- * not know the version, you can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or
- * [ListInvoices](api-endpoint:Invoices-ListInvoices).
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteInvoice(string $invoiceId, ?int $version = null): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v2/invoices/{invoice_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('invoice_id', $invoiceId), QueryParam::init('version', $version));
-
- $_resHandler = $this->responseHandler()->type(DeleteInvoiceResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves an invoice by invoice ID.
- *
- * @param string $invoiceId The ID of the invoice to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function getInvoice(string $invoiceId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/invoices/{invoice_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('invoice_id', $invoiceId));
-
- $_resHandler = $this->responseHandler()->type(GetInvoiceResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates an invoice. This endpoint supports sparse updates, so you only need
- * to specify the fields you want to change along with the required `version` field.
- * Some restrictions apply to updating invoices. For example, you cannot change the
- * `order_id` or `location_id` field.
- *
- * @param string $invoiceId The ID of the invoice to update.
- * @param UpdateInvoiceRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateInvoice(string $invoiceId, UpdateInvoiceRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/invoices/{invoice_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('invoice_id', $invoiceId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateInvoiceResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Uploads a file and attaches it to an invoice. This endpoint accepts HTTP multipart/form-data file
- * uploads
- * with a JSON `request` part and a `file` part. The `file` part must be a `readable stream` that
- * contains a file
- * in a supported format: GIF, JPEG, PNG, TIFF, BMP, or PDF.
- *
- * Invoices can have up to 10 attachments with a total file size of 25 MB. Attachments can be added
- * only to invoices
- * in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state.
- *
- * @param string $invoiceId The ID of the [invoice](entity:Invoice) to attach the file to.
- * @param CreateInvoiceAttachmentRequest|null $request Represents a
- * [CreateInvoiceAttachment]($e/Invoices/CreateInvoiceAttachment) request.
- * @param FileWrapper|null $imageFile
- *
- * @return ApiResponse Response from the API call
- */
- public function createInvoiceAttachment(
- string $invoiceId,
- ?CreateInvoiceAttachmentRequest $request = null,
- ?FileWrapper $imageFile = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/invoices/{invoice_id}/attachments')
- ->auth('global')
- ->parameters(
- TemplateParam::init('invoice_id', $invoiceId),
- FormParam::init('request', $request)
- ->encodingHeader('Content-Type', 'application/json; charset=utf-8'),
- FormParam::init('image_file', $imageFile)->encodingHeader('Content-Type', 'image/jpeg')
- );
-
- $_resHandler = $this->responseHandler()->type(CreateInvoiceAttachmentResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Removes an attachment from an invoice and permanently deletes the file. Attachments can be removed
- * only
- * from invoices in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state.
- *
- * @param string $invoiceId The ID of the [invoice](entity:Invoice) to delete the attachment
- * from.
- * @param string $attachmentId The ID of the [attachment](entity:InvoiceAttachment) to delete.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteInvoiceAttachment(string $invoiceId, string $attachmentId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::DELETE,
- '/v2/invoices/{invoice_id}/attachments/{attachment_id}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('invoice_id', $invoiceId),
- TemplateParam::init('attachment_id', $attachmentId)
- );
-
- $_resHandler = $this->responseHandler()->type(DeleteInvoiceAttachmentResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Cancels an invoice. The seller cannot collect payments for
- * the canceled invoice.
- *
- * You cannot cancel an invoice in the `DRAFT` state or in a terminal state: `PAID`, `REFUNDED`,
- * `CANCELED`, or `FAILED`.
- *
- * @param string $invoiceId The ID of the [invoice](entity:Invoice) to cancel.
- * @param CancelInvoiceRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function cancelInvoice(string $invoiceId, CancelInvoiceRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/invoices/{invoice_id}/cancel')
- ->auth('global')
- ->parameters(
- TemplateParam::init('invoice_id', $invoiceId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(CancelInvoiceResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Publishes the specified draft invoice.
- *
- * After an invoice is published, Square
- * follows up based on the invoice configuration. For example, Square
- * sends the invoice to the customer's email address, charges the customer's card on file, or does
- * nothing. Square also makes the invoice available on a Square-hosted invoice page.
- *
- * The invoice `status` also changes from `DRAFT` to a status
- * based on the invoice configuration. For example, the status changes to `UNPAID` if
- * Square emails the invoice or `PARTIALLY_PAID` if Square charges a card on file for a portion of the
- * invoice amount.
- *
- * In addition to the required `ORDERS_WRITE` and `INVOICES_WRITE` permissions, `CUSTOMERS_READ`
- * and `PAYMENTS_WRITE` are required when publishing invoices configured for card-on-file payments.
- *
- * @param string $invoiceId The ID of the invoice to publish.
- * @param PublishInvoiceRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function publishInvoice(string $invoiceId, PublishInvoiceRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/invoices/{invoice_id}/publish')
- ->auth('global')
- ->parameters(
- TemplateParam::init('invoice_id', $invoiceId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(PublishInvoiceResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/LaborApi.php b/src/Apis/LaborApi.php
deleted file mode 100644
index 05e232e8..00000000
--- a/src/Apis/LaborApi.php
+++ /dev/null
@@ -1,443 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/labor/break-types')
- ->auth('global')
- ->parameters(
- QueryParam::init('location_id', $locationId),
- QueryParam::init('limit', $limit),
- QueryParam::init('cursor', $cursor)
- );
-
- $_resHandler = $this->responseHandler()->type(ListBreakTypesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a new `BreakType`.
- *
- * A `BreakType` is a template for creating `Break` objects.
- * You must provide the following values in your request to this
- * endpoint:
- *
- * - `location_id`
- * - `break_name`
- * - `expected_duration`
- * - `is_paid`
- *
- * You can only have three `BreakType` instances per location. If you attempt to add a fourth
- * `BreakType` for a location, an `INVALID_REQUEST_ERROR` "Exceeded limit of 3 breaks per location."
- * is returned.
- *
- * @param CreateBreakTypeRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createBreakType(CreateBreakTypeRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/labor/break-types')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateBreakTypeResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes an existing `BreakType`.
- *
- * A `BreakType` can be deleted even if it is referenced from a `Shift`.
- *
- * @param string $id The UUID for the `BreakType` being deleted.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteBreakType(string $id): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v2/labor/break-types/{id}')
- ->auth('global')
- ->parameters(TemplateParam::init('id', $id));
-
- $_resHandler = $this->responseHandler()->type(DeleteBreakTypeResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns a single `BreakType` specified by `id`.
- *
- * @param string $id The UUID for the `BreakType` being retrieved.
- *
- * @return ApiResponse Response from the API call
- */
- public function getBreakType(string $id): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/labor/break-types/{id}')
- ->auth('global')
- ->parameters(TemplateParam::init('id', $id));
-
- $_resHandler = $this->responseHandler()->type(GetBreakTypeResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates an existing `BreakType`.
- *
- * @param string $id The UUID for the `BreakType` being updated.
- * @param UpdateBreakTypeRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateBreakType(string $id, UpdateBreakTypeRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/labor/break-types/{id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('id', $id),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateBreakTypeResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns a paginated list of `EmployeeWage` instances for a business.
- *
- * @deprecated
- *
- * @param string|null $employeeId Filter the returned wages to only those that are associated
- * with the specified employee.
- * @param int|null $limit The maximum number of `EmployeeWage` results to return per page. The
- * number can range between
- * 1 and 200. The default is 200.
- * @param string|null $cursor A pointer to the next page of `EmployeeWage` results to fetch.
- *
- * @return ApiResponse Response from the API call
- */
- public function listEmployeeWages(
- ?string $employeeId = null,
- ?int $limit = null,
- ?string $cursor = null
- ): ApiResponse {
- trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
-
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/labor/employee-wages')
- ->auth('global')
- ->parameters(
- QueryParam::init('employee_id', $employeeId),
- QueryParam::init('limit', $limit),
- QueryParam::init('cursor', $cursor)
- );
-
- $_resHandler = $this->responseHandler()->type(ListEmployeeWagesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns a single `EmployeeWage` specified by `id`.
- *
- * @deprecated
- *
- * @param string $id The UUID for the `EmployeeWage` being retrieved.
- *
- * @return ApiResponse Response from the API call
- */
- public function getEmployeeWage(string $id): ApiResponse
- {
- trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
-
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/labor/employee-wages/{id}')
- ->auth('global')
- ->parameters(TemplateParam::init('id', $id));
-
- $_resHandler = $this->responseHandler()->type(GetEmployeeWageResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a new `Shift`.
- *
- * A `Shift` represents a complete workday for a single team member.
- * You must provide the following values in your request to this
- * endpoint:
- *
- * - `location_id`
- * - `team_member_id`
- * - `start_at`
- *
- * An attempt to create a new `Shift` can result in a `BAD_REQUEST` error when:
- * - The `status` of the new `Shift` is `OPEN` and the team member has another
- * shift with an `OPEN` status.
- * - The `start_at` date is in the future.
- * - The `start_at` or `end_at` date overlaps another shift for the same team member.
- * - The `Break` instances are set in the request and a break `start_at`
- * is before the `Shift.start_at`, a break `end_at` is after
- * the `Shift.end_at`, or both.
- *
- * @param CreateShiftRequest $body An object containing the fields to POST for the request. See
- * the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createShift(CreateShiftRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/labor/shifts')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateShiftResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns a paginated list of `Shift` records for a business.
- * The list to be returned can be filtered by:
- * - Location IDs
- * - Team member IDs
- * - Shift status (`OPEN` or `CLOSED`)
- * - Shift start
- * - Shift end
- * - Workday details
- *
- * The list can be sorted by:
- * - `START_AT`
- * - `END_AT`
- * - `CREATED_AT`
- * - `UPDATED_AT`
- *
- * @param SearchShiftsRequest $body An object containing the fields to POST for the request. See
- * the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function searchShifts(SearchShiftsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/labor/shifts/search')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchShiftsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a `Shift`.
- *
- * @param string $id The UUID for the `Shift` being deleted.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteShift(string $id): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v2/labor/shifts/{id}')
- ->auth('global')
- ->parameters(TemplateParam::init('id', $id));
-
- $_resHandler = $this->responseHandler()->type(DeleteShiftResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns a single `Shift` specified by `id`.
- *
- * @param string $id The UUID for the `Shift` being retrieved.
- *
- * @return ApiResponse Response from the API call
- */
- public function getShift(string $id): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/labor/shifts/{id}')
- ->auth('global')
- ->parameters(TemplateParam::init('id', $id));
-
- $_resHandler = $this->responseHandler()->type(GetShiftResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates an existing `Shift`.
- *
- * When adding a `Break` to a `Shift`, any earlier `Break` instances in the `Shift` have
- * the `end_at` property set to a valid RFC-3339 datetime string.
- *
- * When closing a `Shift`, all `Break` instances in the `Shift` must be complete with `end_at`
- * set on each `Break`.
- *
- * @param string $id The ID of the object being updated.
- * @param UpdateShiftRequest $body An object containing the fields to POST for the request. See
- * the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateShift(string $id, UpdateShiftRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/labor/shifts/{id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('id', $id),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateShiftResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns a paginated list of `TeamMemberWage` instances for a business.
- *
- * @param string|null $teamMemberId Filter the returned wages to only those that are associated
- * with the
- * specified team member.
- * @param int|null $limit The maximum number of `TeamMemberWage` results to return per page. The
- * number can range between
- * 1 and 200. The default is 200.
- * @param string|null $cursor A pointer to the next page of `EmployeeWage` results to fetch.
- *
- * @return ApiResponse Response from the API call
- */
- public function listTeamMemberWages(
- ?string $teamMemberId = null,
- ?int $limit = null,
- ?string $cursor = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/labor/team-member-wages')
- ->auth('global')
- ->parameters(
- QueryParam::init('team_member_id', $teamMemberId),
- QueryParam::init('limit', $limit),
- QueryParam::init('cursor', $cursor)
- );
-
- $_resHandler = $this->responseHandler()->type(ListTeamMemberWagesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns a single `TeamMemberWage` specified by `id`.
- *
- * @param string $id The UUID for the `TeamMemberWage` being retrieved.
- *
- * @return ApiResponse Response from the API call
- */
- public function getTeamMemberWage(string $id): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/labor/team-member-wages/{id}')
- ->auth('global')
- ->parameters(TemplateParam::init('id', $id));
-
- $_resHandler = $this->responseHandler()->type(GetTeamMemberWageResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns a list of `WorkweekConfig` instances for a business.
- *
- * @param int|null $limit The maximum number of `WorkweekConfigs` results to return per page.
- * @param string|null $cursor A pointer to the next page of `WorkweekConfig` results to fetch.
- *
- * @return ApiResponse Response from the API call
- */
- public function listWorkweekConfigs(?int $limit = null, ?string $cursor = null): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/labor/workweek-configs')
- ->auth('global')
- ->parameters(QueryParam::init('limit', $limit), QueryParam::init('cursor', $cursor));
-
- $_resHandler = $this->responseHandler()->type(ListWorkweekConfigsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates a `WorkweekConfig`.
- *
- * @param string $id The UUID for the `WorkweekConfig` object being updated.
- * @param UpdateWorkweekConfigRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateWorkweekConfig(string $id, UpdateWorkweekConfigRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/labor/workweek-configs/{id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('id', $id),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateWorkweekConfigResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/LocationCustomAttributesApi.php b/src/Apis/LocationCustomAttributesApi.php
deleted file mode 100644
index c1d6d4a6..00000000
--- a/src/Apis/LocationCustomAttributesApi.php
+++ /dev/null
@@ -1,446 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/locations/custom-attribute-definitions')
- ->auth('global')
- ->parameters(
- QueryParam::init('visibility_filter', $visibilityFilter),
- QueryParam::init('limit', $limit),
- QueryParam::init('cursor', $cursor)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(ListLocationCustomAttributeDefinitionsResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a location-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square
- * seller account.
- * Use this endpoint to define a custom attribute that can be associated with locations.
- * A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties
- * for a custom attribute. After the definition is created, you can call
- * [UpsertLocationCustomAttribute]($e/LocationCustomAttributes/UpsertLocationCustomAttribute) or
- * [BulkUpsertLocationCustomAttributes]($e/LocationCustomAttributes/BulkUpsertLocationCustomAttributes)
- * to set the custom attribute for locations.
- *
- * @param CreateLocationCustomAttributeDefinitionRequest $body An object containing the fields
- * to POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createLocationCustomAttributeDefinition(
- CreateLocationCustomAttributeDefinitionRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/locations/custom-attribute-definitions')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(CreateLocationCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a location-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square
- * seller account.
- * Deleting a custom attribute definition also deletes the corresponding custom attribute from
- * all locations.
- * Only the definition owner can delete a custom attribute definition.
- *
- * @param string $key The key of the custom attribute definition to delete.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteLocationCustomAttributeDefinition(string $key): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::DELETE,
- '/v2/locations/custom-attribute-definitions/{key}'
- )->auth('global')->parameters(TemplateParam::init('key', $key));
-
- $_resHandler = $this->responseHandler()
- ->type(DeleteLocationCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a location-related [custom attribute definition]($m/CustomAttributeDefinition) from a
- * Square seller account.
- * To retrieve a custom attribute definition created by another application, the `visibility`
- * setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $key The key of the custom attribute definition to retrieve. If the requesting
- * application
- * is not the definition owner, you must use the qualified key.
- * @param int|null $version The current version of the custom attribute definition, which is
- * used for strongly consistent
- * reads to guarantee that you receive the most up-to-date data. When included in the
- * request,
- * Square returns the specified version or a higher version if one exists. If the
- * specified version
- * is higher than the current version, Square returns a `BAD_REQUEST` error.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveLocationCustomAttributeDefinition(string $key, ?int $version = null): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::GET,
- '/v2/locations/custom-attribute-definitions/{key}'
- )->auth('global')->parameters(TemplateParam::init('key', $key), QueryParam::init('version', $version));
-
- $_resHandler = $this->responseHandler()
- ->type(RetrieveLocationCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates a location-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square
- * seller account.
- * Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the
- * `schema` for a `Selection` data type.
- * Only the definition owner can update a custom attribute definition.
- *
- * @param string $key The key of the custom attribute definition to update.
- * @param UpdateLocationCustomAttributeDefinitionRequest $body An object containing the fields
- * to POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateLocationCustomAttributeDefinition(
- string $key,
- UpdateLocationCustomAttributeDefinitionRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::PUT,
- '/v2/locations/custom-attribute-definitions/{key}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('key', $key),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(UpdateLocationCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes [custom attributes]($m/CustomAttribute) for locations as a bulk operation.
- * To delete a custom attribute owned by another application, the `visibility` setting must be
- * `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param BulkDeleteLocationCustomAttributesRequest $body An object containing the fields to
- * POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkDeleteLocationCustomAttributes(BulkDeleteLocationCustomAttributesRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/locations/custom-attributes/bulk-delete')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(BulkDeleteLocationCustomAttributesResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates or updates [custom attributes]($m/CustomAttribute) for locations as a bulk operation.
- * Use this endpoint to set the value of one or more custom attributes for one or more locations.
- * A custom attribute is based on a custom attribute definition in a Square seller account, which is
- * created using the
- * [CreateLocationCustomAttributeDefinition]($e/LocationCustomAttributes/CreateLocationCustomAttributeD
- * efinition) endpoint.
- * This `BulkUpsertLocationCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert
- * requests and returns a map of individual upsert responses. Each upsert request has a unique ID
- * and provides a location ID and custom attribute. Each upsert response is returned with the ID
- * of the corresponding request.
- * To create or update a custom attribute owned by another application, the `visibility` setting
- * must be `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param BulkUpsertLocationCustomAttributesRequest $body An object containing the fields to
- * POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkUpsertLocationCustomAttributes(BulkUpsertLocationCustomAttributesRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/locations/custom-attributes/bulk-upsert')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(BulkUpsertLocationCustomAttributesResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Lists the [custom attributes]($m/CustomAttribute) associated with a location.
- * You can use the `with_definitions` query parameter to also retrieve custom attribute definitions
- * in the same call.
- * When all response pages are retrieved, the results include all custom attributes that are
- * visible to the requesting application, including those that are owned by other applications
- * and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $locationId The ID of the target [location](entity:Location).
- * @param string|null $visibilityFilter Filters the `CustomAttributeDefinition` results by their
- * `visibility` values.
- * @param int|null $limit The maximum number of results to return in a single paged response.
- * This limit is advisory.
- * The response might contain more or fewer results. The minimum value is 1 and the
- * maximum value is 100.
- * The default value is 20. For more information, see [Pagination](https://developer.
- * squareup.com/docs/build-basics/common-api-patterns/pagination).
- * @param string|null $cursor The cursor returned in the paged response from the previous call
- * to this endpoint.
- * Provide this cursor to retrieve the next page of results for your original request.
- * For more
- * information, see [Pagination](https://developer.squareup.com/docs/build-
- * basics/common-api-patterns/pagination).
- * @param bool|null $withDefinitions Indicates whether to return the [custom attribute
- * definition](entity:CustomAttributeDefinition) in the `definition` field of each
- * custom attribute. Set this parameter to `true` to get the name and description of
- * each custom
- * attribute, information about the data type, or other definition details. The default
- * value is `false`.
- *
- * @return ApiResponse Response from the API call
- */
- public function listLocationCustomAttributes(
- string $locationId,
- ?string $visibilityFilter = null,
- ?int $limit = null,
- ?string $cursor = null,
- ?bool $withDefinitions = false
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/locations/{location_id}/custom-attributes')
- ->auth('global')
- ->parameters(
- TemplateParam::init('location_id', $locationId),
- QueryParam::init('visibility_filter', $visibilityFilter),
- QueryParam::init('limit', $limit),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('with_definitions', $withDefinitions)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(ListLocationCustomAttributesResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a [custom attribute]($m/CustomAttribute) associated with a location.
- * To delete a custom attribute owned by another application, the `visibility` setting must be
- * `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $locationId The ID of the target [location](entity:Location).
- * @param string $key The key of the custom attribute to delete. This key must match the `key`
- * of a custom
- * attribute definition in the Square seller account. If the requesting application is
- * not the
- * definition owner, you must use the qualified key.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteLocationCustomAttribute(string $locationId, string $key): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::DELETE,
- '/v2/locations/{location_id}/custom-attributes/{key}'
- )
- ->auth('global')
- ->parameters(TemplateParam::init('location_id', $locationId), TemplateParam::init('key', $key));
-
- $_resHandler = $this->responseHandler()
- ->type(DeleteLocationCustomAttributeResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a [custom attribute]($m/CustomAttribute) associated with a location.
- * You can use the `with_definition` query parameter to also retrieve the custom attribute definition
- * in the same call.
- * To retrieve a custom attribute owned by another application, the `visibility` setting must be
- * `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $locationId The ID of the target [location](entity:Location).
- * @param string $key The key of the custom attribute to retrieve. This key must match the `key`
- * of a custom
- * attribute definition in the Square seller account. If the requesting application is
- * not the
- * definition owner, you must use the qualified key.
- * @param bool|null $withDefinition Indicates whether to return the [custom attribute
- * definition](entity:CustomAttributeDefinition) in the `definition` field of
- * the custom attribute. Set this parameter to `true` to get the name and description
- * of the custom
- * attribute, information about the data type, or other definition details. The default
- * value is `false`.
- * @param int|null $version The current version of the custom attribute, which is used for
- * strongly consistent reads to
- * guarantee that you receive the most up-to-date data. When included in the request,
- * Square
- * returns the specified version or a higher version if one exists. If the specified
- * version is
- * higher than the current version, Square returns a `BAD_REQUEST` error.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveLocationCustomAttribute(
- string $locationId,
- string $key,
- ?bool $withDefinition = false,
- ?int $version = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::GET,
- '/v2/locations/{location_id}/custom-attributes/{key}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('location_id', $locationId),
- TemplateParam::init('key', $key),
- QueryParam::init('with_definition', $withDefinition),
- QueryParam::init('version', $version)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(RetrieveLocationCustomAttributeResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates or updates a [custom attribute]($m/CustomAttribute) for a location.
- * Use this endpoint to set the value of a custom attribute for a specified location.
- * A custom attribute is based on a custom attribute definition in a Square seller account, which
- * is created using the
- * [CreateLocationCustomAttributeDefinition]($e/LocationCustomAttributes/CreateLocationCustomAttributeD
- * efinition) endpoint.
- * To create or update a custom attribute owned by another application, the `visibility` setting
- * must be `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $locationId The ID of the target [location](entity:Location).
- * @param string $key The key of the custom attribute to create or update. This key must match
- * the `key` of a
- * custom attribute definition in the Square seller account. If the requesting
- * application is not
- * the definition owner, you must use the qualified key.
- * @param UpsertLocationCustomAttributeRequest $body An object containing the fields to POST for
- * the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function upsertLocationCustomAttribute(
- string $locationId,
- string $key,
- UpsertLocationCustomAttributeRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::POST,
- '/v2/locations/{location_id}/custom-attributes/{key}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('location_id', $locationId),
- TemplateParam::init('key', $key),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(UpsertLocationCustomAttributeResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/LocationsApi.php b/src/Apis/LocationsApi.php
deleted file mode 100644
index f87dda87..00000000
--- a/src/Apis/LocationsApi.php
+++ /dev/null
@@ -1,106 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/locations')->auth('global');
-
- $_resHandler = $this->responseHandler()->type(ListLocationsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a [location](https://developer.squareup.com/docs/locations-api).
- * Creating new locations allows for separate configuration of receipt layouts, item prices,
- * and sales reports. Developers can use locations to separate sales activity through applications
- * that integrate with Square from sales activity elsewhere in a seller's account.
- * Locations created programmatically with the Locations API last forever and
- * are visible to the seller for their own management. Therefore, ensure that
- * each location has a sensible and unique name.
- *
- * @param CreateLocationRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createLocation(CreateLocationRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/locations')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateLocationResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves details of a single location. Specify "main"
- * as the location ID to retrieve details of the [main location](https://developer.squareup.
- * com/docs/locations-api#about-the-main-location).
- *
- * @param string $locationId The ID of the location to retrieve. Specify the string "main" to
- * return the main location.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveLocation(string $locationId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/locations/{location_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('location_id', $locationId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveLocationResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates a [location](https://developer.squareup.com/docs/locations-api).
- *
- * @param string $locationId The ID of the location to update.
- * @param UpdateLocationRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateLocation(string $locationId, UpdateLocationRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/locations/{location_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('location_id', $locationId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateLocationResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/LoyaltyApi.php b/src/Apis/LoyaltyApi.php
deleted file mode 100644
index 4cd75cae..00000000
--- a/src/Apis/LoyaltyApi.php
+++ /dev/null
@@ -1,586 +0,0 @@
-requestBuilder(RequestMethod::POST, '/v2/loyalty/accounts')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateLoyaltyAccountResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Searches for loyalty accounts in a loyalty program.
- *
- * You can search for a loyalty account using the phone number or customer ID associated with the
- * account. To return all loyalty accounts, specify an empty `query` object or omit it entirely.
- *
- * Search results are sorted by `created_at` in ascending order.
- *
- * @param SearchLoyaltyAccountsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function searchLoyaltyAccounts(SearchLoyaltyAccountsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/loyalty/accounts/search')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchLoyaltyAccountsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a loyalty account.
- *
- * @param string $accountId The ID of the [loyalty account](entity:LoyaltyAccount) to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveLoyaltyAccount(string $accountId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/loyalty/accounts/{account_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('account_id', $accountId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveLoyaltyAccountResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Adds points earned from a purchase to a [loyalty account]($m/LoyaltyAccount).
- *
- * - If you are using the Orders API to manage orders, provide the `order_id`. Square reads the order
- * to compute the points earned from both the base loyalty program and an associated
- * [loyalty promotion]($m/LoyaltyPromotion). For purchases that qualify for multiple accrual
- * rules, Square computes points based on the accrual rule that grants the most points.
- * For purchases that qualify for multiple promotions, Square computes points based on the most
- * recently created promotion. A purchase must first qualify for program points to be eligible for
- * promotion points.
- *
- * - If you are not using the Orders API to manage orders, provide `points` with the number of points
- * to add.
- * You must first perform a client-side computation of the points earned from the loyalty program and
- * loyalty promotion. For spend-based and visit-based programs, you can call
- * [CalculateLoyaltyPoints]($e/Loyalty/CalculateLoyaltyPoints)
- * to compute the points earned from the base loyalty program. For information about computing points
- * earned from a loyalty promotion, see
- * [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-
- * promotions#calculate-promotion-points).
- *
- * @param string $accountId The ID of the target [loyalty account](entity:LoyaltyAccount).
- * @param AccumulateLoyaltyPointsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function accumulateLoyaltyPoints(string $accountId, AccumulateLoyaltyPointsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/loyalty/accounts/{account_id}/accumulate')
- ->auth('global')
- ->parameters(
- TemplateParam::init('account_id', $accountId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(AccumulateLoyaltyPointsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Adds points to or subtracts points from a buyer's account.
- *
- * Use this endpoint only when you need to manually adjust points. Otherwise, in your application flow,
- * you call
- * [AccumulateLoyaltyPoints]($e/Loyalty/AccumulateLoyaltyPoints)
- * to add points when a buyer pays for the purchase.
- *
- * @param string $accountId The ID of the target [loyalty account](entity:LoyaltyAccount).
- * @param AdjustLoyaltyPointsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function adjustLoyaltyPoints(string $accountId, AdjustLoyaltyPointsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/loyalty/accounts/{account_id}/adjust')
- ->auth('global')
- ->parameters(
- TemplateParam::init('account_id', $accountId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(AdjustLoyaltyPointsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Searches for loyalty events.
- *
- * A Square loyalty program maintains a ledger of events that occur during the lifetime of a
- * buyer's loyalty account. Each change in the point balance
- * (for example, points earned, points redeemed, and points expired) is
- * recorded in the ledger. Using this endpoint, you can search the ledger for events.
- *
- * Search results are sorted by `created_at` in descending order.
- *
- * @param SearchLoyaltyEventsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function searchLoyaltyEvents(SearchLoyaltyEventsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/loyalty/events/search')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchLoyaltyEventsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns a list of loyalty programs in the seller's account.
- * Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can
- * have only one loyalty program, which is created and managed from the Seller Dashboard. For more
- * information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).
- *
- *
- * Replaced with [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when used with
- * the keyword `main`.
- *
- * @deprecated
- *
- * @return ApiResponse Response from the API call
- */
- public function listLoyaltyPrograms(): ApiResponse
- {
- trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
-
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/loyalty/programs')->auth('global');
-
- $_resHandler = $this->responseHandler()->type(ListLoyaltyProgramsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves the loyalty program in a seller's account, specified by the program ID or the keyword
- * `main`.
- *
- * Loyalty programs define how buyers can earn points and redeem points for rewards. Square sellers can
- * have only one loyalty program, which is created and managed from the Seller Dashboard. For more
- * information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview).
- *
- * @param string $programId The ID of the loyalty program or the keyword `main`. Either value
- * can be used to retrieve the single loyalty program that belongs to the seller.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveLoyaltyProgram(string $programId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/loyalty/programs/{program_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('program_id', $programId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveLoyaltyProgramResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Calculates the number of points a buyer can earn from a purchase. Applications might call this
- * endpoint
- * to display the points to the buyer.
- *
- * - If you are using the Orders API to manage orders, provide the `order_id` and (optional)
- * `loyalty_account_id`.
- * Square reads the order to compute the points earned from the base loyalty program and an associated
- * [loyalty promotion]($m/LoyaltyPromotion).
- *
- * - If you are not using the Orders API to manage orders, provide `transaction_amount_money` with the
- * purchase amount. Square uses this amount to calculate the points earned from the base loyalty
- * program,
- * but not points earned from a loyalty promotion. For spend-based and visit-based programs, the
- * `tax_mode`
- * setting of the accrual rule indicates how taxes should be treated for loyalty points accrual.
- * If the purchase qualifies for program points, call
- * [ListLoyaltyPromotions]($e/Loyalty/ListLoyaltyPromotions) and perform a client-side computation
- * to calculate whether the purchase also qualifies for promotion points. For more information, see
- * [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty-
- * promotions#calculate-promotion-points).
- *
- * @param string $programId The ID of the [loyalty program](entity:LoyaltyProgram), which
- * defines the rules for accruing points.
- * @param CalculateLoyaltyPointsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function calculateLoyaltyPoints(string $programId, CalculateLoyaltyPointsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/loyalty/programs/{program_id}/calculate')
- ->auth('global')
- ->parameters(
- TemplateParam::init('program_id', $programId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(CalculateLoyaltyPointsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Lists the loyalty promotions associated with a [loyalty program]($m/LoyaltyProgram).
- * Results are sorted by the `created_at` date in descending order (newest to oldest).
- *
- * @param string $programId The ID of the base [loyalty program](entity:LoyaltyProgram). To get
- * the program ID,
- * call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the
- * `main` keyword.
- * @param string|null $status The status to filter the results by. If a status is provided, only
- * loyalty promotions
- * with the specified status are returned. Otherwise, all loyalty promotions associated
- * with
- * the loyalty program are returned.
- * @param string|null $cursor The cursor returned in the paged response from the previous call
- * to this endpoint.
- * Provide this cursor to retrieve the next page of results for your original request.
- * For more information, see [Pagination](https://developer.squareup.com/docs/build-
- * basics/common-api-patterns/pagination).
- * @param int|null $limit The maximum number of results to return in a single paged response.
- * The minimum value is 1 and the maximum value is 30. The default value is 30.
- * For more information, see [Pagination](https://developer.squareup.com/docs/build-
- * basics/common-api-patterns/pagination).
- *
- * @return ApiResponse Response from the API call
- */
- public function listLoyaltyPromotions(
- string $programId,
- ?string $status = null,
- ?string $cursor = null,
- ?int $limit = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/loyalty/programs/{program_id}/promotions')
- ->auth('global')
- ->parameters(
- TemplateParam::init('program_id', $programId),
- QueryParam::init('status', $status),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('limit', $limit)
- );
-
- $_resHandler = $this->responseHandler()->type(ListLoyaltyPromotionsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a loyalty promotion for a [loyalty program]($m/LoyaltyProgram). A loyalty promotion
- * enables buyers to earn points in addition to those earned from the base loyalty program.
- *
- * This endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED` status, depending on the
- * `available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an
- * `ACTIVE` or `SCHEDULED` status.
- *
- * @param string $programId The ID of the [loyalty program](entity:LoyaltyProgram) to associate
- * with the promotion.
- * To get the program ID, call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-
- * RetrieveLoyaltyProgram)
- * using the `main` keyword.
- * @param CreateLoyaltyPromotionRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createLoyaltyPromotion(string $programId, CreateLoyaltyPromotionRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/loyalty/programs/{program_id}/promotions')
- ->auth('global')
- ->parameters(
- TemplateParam::init('program_id', $programId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(CreateLoyaltyPromotionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a loyalty promotion.
- *
- * @param string $promotionId The ID of the [loyalty promotion](entity:LoyaltyPromotion) to
- * retrieve.
- * @param string $programId The ID of the base [loyalty program](entity:LoyaltyProgram). To get
- * the program ID,
- * call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the
- * `main` keyword.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveLoyaltyPromotion(string $promotionId, string $programId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::GET,
- '/v2/loyalty/programs/{program_id}/promotions/{promotion_id}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('promotion_id', $promotionId),
- TemplateParam::init('program_id', $programId)
- );
-
- $_resHandler = $this->responseHandler()->type(RetrieveLoyaltyPromotionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Cancels a loyalty promotion. Use this endpoint to cancel an `ACTIVE` promotion earlier than the
- * end date, cancel an `ACTIVE` promotion when an end date is not specified, or cancel a `SCHEDULED`
- * promotion.
- * Because updating a promotion is not supported, you can also use this endpoint to cancel a promotion
- * before
- * you create a new one.
- *
- * This endpoint sets the loyalty promotion to the `CANCELED` state
- *
- * @param string $promotionId The ID of the [loyalty promotion](entity:LoyaltyPromotion) to
- * cancel. You can cancel a
- * promotion that has an `ACTIVE` or `SCHEDULED` status.
- * @param string $programId The ID of the base [loyalty program](entity:LoyaltyProgram).
- *
- * @return ApiResponse Response from the API call
- */
- public function cancelLoyaltyPromotion(string $promotionId, string $programId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::POST,
- '/v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('promotion_id', $promotionId),
- TemplateParam::init('program_id', $programId)
- );
-
- $_resHandler = $this->responseHandler()->type(CancelLoyaltyPromotionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a loyalty reward. In the process, the endpoint does following:
- *
- * - Uses the `reward_tier_id` in the request to determine the number of points
- * to lock for this reward.
- * - If the request includes `order_id`, it adds the reward and related discount to the order.
- *
- * After a reward is created, the points are locked and
- * not available for the buyer to redeem another reward.
- *
- * @param CreateLoyaltyRewardRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createLoyaltyReward(CreateLoyaltyRewardRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/loyalty/rewards')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateLoyaltyRewardResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Searches for loyalty rewards. This endpoint accepts a request with no query filters and returns
- * results for all loyalty accounts.
- * If you include a `query` object, `loyalty_account_id` is required and `status` is optional.
- *
- * If you know a reward ID, use the
- * [RetrieveLoyaltyReward]($e/Loyalty/RetrieveLoyaltyReward) endpoint.
- *
- * Search results are sorted by `updated_at` in descending order.
- *
- * @param SearchLoyaltyRewardsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function searchLoyaltyRewards(SearchLoyaltyRewardsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/loyalty/rewards/search')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchLoyaltyRewardsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a loyalty reward by doing the following:
- *
- * - Returns the loyalty points back to the loyalty account.
- * - If an order ID was specified when the reward was created
- * (see [CreateLoyaltyReward]($e/Loyalty/CreateLoyaltyReward)),
- * it updates the order by removing the reward and related
- * discounts.
- *
- * You cannot delete a reward that has reached the terminal state (REDEEMED).
- *
- * @param string $rewardId The ID of the [loyalty reward](entity:LoyaltyReward) to delete.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteLoyaltyReward(string $rewardId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v2/loyalty/rewards/{reward_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('reward_id', $rewardId));
-
- $_resHandler = $this->responseHandler()->type(DeleteLoyaltyRewardResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a loyalty reward.
- *
- * @param string $rewardId The ID of the [loyalty reward](entity:LoyaltyReward) to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveLoyaltyReward(string $rewardId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/loyalty/rewards/{reward_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('reward_id', $rewardId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveLoyaltyRewardResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Redeems a loyalty reward.
- *
- * The endpoint sets the reward to the `REDEEMED` terminal state.
- *
- * If you are using your own order processing system (not using the
- * Orders API), you call this endpoint after the buyer paid for the
- * purchase.
- *
- * After the reward reaches the terminal state, it cannot be deleted.
- * In other words, points used for the reward cannot be returned
- * to the account.
- *
- * @param string $rewardId The ID of the [loyalty reward](entity:LoyaltyReward) to redeem.
- * @param RedeemLoyaltyRewardRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function redeemLoyaltyReward(string $rewardId, RedeemLoyaltyRewardRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/loyalty/rewards/{reward_id}/redeem')
- ->auth('global')
- ->parameters(
- TemplateParam::init('reward_id', $rewardId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(RedeemLoyaltyRewardResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/MerchantCustomAttributesApi.php b/src/Apis/MerchantCustomAttributesApi.php
deleted file mode 100644
index 2bd4474f..00000000
--- a/src/Apis/MerchantCustomAttributesApi.php
+++ /dev/null
@@ -1,447 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/merchants/custom-attribute-definitions')
- ->auth('global')
- ->parameters(
- QueryParam::init('visibility_filter', $visibilityFilter),
- QueryParam::init('limit', $limit),
- QueryParam::init('cursor', $cursor)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(ListMerchantCustomAttributeDefinitionsResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square
- * seller account.
- * Use this endpoint to define a custom attribute that can be associated with a merchant connecting to
- * your application.
- * A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties
- * for a custom attribute. After the definition is created, you can call
- * [UpsertMerchantCustomAttribute]($e/MerchantCustomAttributes/UpsertMerchantCustomAttribute) or
- * [BulkUpsertMerchantCustomAttributes]($e/MerchantCustomAttributes/BulkUpsertMerchantCustomAttributes)
- * to set the custom attribute for a merchant.
- *
- * @param CreateMerchantCustomAttributeDefinitionRequest $body An object containing the fields
- * to POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createMerchantCustomAttributeDefinition(
- CreateMerchantCustomAttributeDefinitionRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/merchants/custom-attribute-definitions')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(CreateMerchantCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square
- * seller account.
- * Deleting a custom attribute definition also deletes the corresponding custom attribute from
- * the merchant.
- * Only the definition owner can delete a custom attribute definition.
- *
- * @param string $key The key of the custom attribute definition to delete.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteMerchantCustomAttributeDefinition(string $key): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::DELETE,
- '/v2/merchants/custom-attribute-definitions/{key}'
- )->auth('global')->parameters(TemplateParam::init('key', $key));
-
- $_resHandler = $this->responseHandler()
- ->type(DeleteMerchantCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) from a
- * Square seller account.
- * To retrieve a custom attribute definition created by another application, the `visibility`
- * setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $key The key of the custom attribute definition to retrieve. If the requesting
- * application
- * is not the definition owner, you must use the qualified key.
- * @param int|null $version The current version of the custom attribute definition, which is
- * used for strongly consistent
- * reads to guarantee that you receive the most up-to-date data. When included in the
- * request,
- * Square returns the specified version or a higher version if one exists. If the
- * specified version
- * is higher than the current version, Square returns a `BAD_REQUEST` error.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveMerchantCustomAttributeDefinition(string $key, ?int $version = null): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::GET,
- '/v2/merchants/custom-attribute-definitions/{key}'
- )->auth('global')->parameters(TemplateParam::init('key', $key), QueryParam::init('version', $version));
-
- $_resHandler = $this->responseHandler()
- ->type(RetrieveMerchantCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates a merchant-related [custom attribute definition]($m/CustomAttributeDefinition) for a Square
- * seller account.
- * Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the
- * `schema` for a `Selection` data type.
- * Only the definition owner can update a custom attribute definition.
- *
- * @param string $key The key of the custom attribute definition to update.
- * @param UpdateMerchantCustomAttributeDefinitionRequest $body An object containing the fields
- * to POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateMerchantCustomAttributeDefinition(
- string $key,
- UpdateMerchantCustomAttributeDefinitionRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::PUT,
- '/v2/merchants/custom-attribute-definitions/{key}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('key', $key),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(UpdateMerchantCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes [custom attributes]($m/CustomAttribute) for a merchant as a bulk operation.
- * To delete a custom attribute owned by another application, the `visibility` setting must be
- * `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param BulkDeleteMerchantCustomAttributesRequest $body An object containing the fields to
- * POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkDeleteMerchantCustomAttributes(BulkDeleteMerchantCustomAttributesRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/merchants/custom-attributes/bulk-delete')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(BulkDeleteMerchantCustomAttributesResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates or updates [custom attributes]($m/CustomAttribute) for a merchant as a bulk operation.
- * Use this endpoint to set the value of one or more custom attributes for a merchant.
- * A custom attribute is based on a custom attribute definition in a Square seller account, which is
- * created using the
- * [CreateMerchantCustomAttributeDefinition]($e/MerchantCustomAttributes/CreateMerchantCustomAttributeD
- * efinition) endpoint.
- * This `BulkUpsertMerchantCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert
- * requests and returns a map of individual upsert responses. Each upsert request has a unique ID
- * and provides a merchant ID and custom attribute. Each upsert response is returned with the ID
- * of the corresponding request.
- * To create or update a custom attribute owned by another application, the `visibility` setting
- * must be `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param BulkUpsertMerchantCustomAttributesRequest $body An object containing the fields to
- * POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkUpsertMerchantCustomAttributes(BulkUpsertMerchantCustomAttributesRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/merchants/custom-attributes/bulk-upsert')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(BulkUpsertMerchantCustomAttributesResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Lists the [custom attributes]($m/CustomAttribute) associated with a merchant.
- * You can use the `with_definitions` query parameter to also retrieve custom attribute definitions
- * in the same call.
- * When all response pages are retrieved, the results include all custom attributes that are
- * visible to the requesting application, including those that are owned by other applications
- * and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $merchantId The ID of the target [merchant](entity:Merchant).
- * @param string|null $visibilityFilter Filters the `CustomAttributeDefinition` results by their
- * `visibility` values.
- * @param int|null $limit The maximum number of results to return in a single paged response.
- * This limit is advisory.
- * The response might contain more or fewer results. The minimum value is 1 and the
- * maximum value is 100.
- * The default value is 20. For more information, see [Pagination](https://developer.
- * squareup.com/docs/build-basics/common-api-patterns/pagination).
- * @param string|null $cursor The cursor returned in the paged response from the previous call
- * to this endpoint.
- * Provide this cursor to retrieve the next page of results for your original request.
- * For more
- * information, see [Pagination](https://developer.squareup.com/docs/build-
- * basics/common-api-patterns/pagination).
- * @param bool|null $withDefinitions Indicates whether to return the [custom attribute
- * definition](entity:CustomAttributeDefinition) in the `definition` field of each
- * custom attribute. Set this parameter to `true` to get the name and description of
- * each custom
- * attribute, information about the data type, or other definition details. The default
- * value is `false`.
- *
- * @return ApiResponse Response from the API call
- */
- public function listMerchantCustomAttributes(
- string $merchantId,
- ?string $visibilityFilter = null,
- ?int $limit = null,
- ?string $cursor = null,
- ?bool $withDefinitions = false
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/merchants/{merchant_id}/custom-attributes')
- ->auth('global')
- ->parameters(
- TemplateParam::init('merchant_id', $merchantId),
- QueryParam::init('visibility_filter', $visibilityFilter),
- QueryParam::init('limit', $limit),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('with_definitions', $withDefinitions)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(ListMerchantCustomAttributesResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a [custom attribute]($m/CustomAttribute) associated with a merchant.
- * To delete a custom attribute owned by another application, the `visibility` setting must be
- * `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $merchantId The ID of the target [merchant](entity:Merchant).
- * @param string $key The key of the custom attribute to delete. This key must match the `key`
- * of a custom
- * attribute definition in the Square seller account. If the requesting application is
- * not the
- * definition owner, you must use the qualified key.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteMerchantCustomAttribute(string $merchantId, string $key): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::DELETE,
- '/v2/merchants/{merchant_id}/custom-attributes/{key}'
- )
- ->auth('global')
- ->parameters(TemplateParam::init('merchant_id', $merchantId), TemplateParam::init('key', $key));
-
- $_resHandler = $this->responseHandler()
- ->type(DeleteMerchantCustomAttributeResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a [custom attribute]($m/CustomAttribute) associated with a merchant.
- * You can use the `with_definition` query parameter to also retrieve the custom attribute definition
- * in the same call.
- * To retrieve a custom attribute owned by another application, the `visibility` setting must be
- * `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $merchantId The ID of the target [merchant](entity:Merchant).
- * @param string $key The key of the custom attribute to retrieve. This key must match the `key`
- * of a custom
- * attribute definition in the Square seller account. If the requesting application is
- * not the
- * definition owner, you must use the qualified key.
- * @param bool|null $withDefinition Indicates whether to return the [custom attribute
- * definition](entity:CustomAttributeDefinition) in the `definition` field of
- * the custom attribute. Set this parameter to `true` to get the name and description
- * of the custom
- * attribute, information about the data type, or other definition details. The default
- * value is `false`.
- * @param int|null $version The current version of the custom attribute, which is used for
- * strongly consistent reads to
- * guarantee that you receive the most up-to-date data. When included in the request,
- * Square
- * returns the specified version or a higher version if one exists. If the specified
- * version is
- * higher than the current version, Square returns a `BAD_REQUEST` error.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveMerchantCustomAttribute(
- string $merchantId,
- string $key,
- ?bool $withDefinition = false,
- ?int $version = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::GET,
- '/v2/merchants/{merchant_id}/custom-attributes/{key}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('merchant_id', $merchantId),
- TemplateParam::init('key', $key),
- QueryParam::init('with_definition', $withDefinition),
- QueryParam::init('version', $version)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(RetrieveMerchantCustomAttributeResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates or updates a [custom attribute]($m/CustomAttribute) for a merchant.
- * Use this endpoint to set the value of a custom attribute for a specified merchant.
- * A custom attribute is based on a custom attribute definition in a Square seller account, which
- * is created using the
- * [CreateMerchantCustomAttributeDefinition]($e/MerchantCustomAttributes/CreateMerchantCustomAttributeD
- * efinition) endpoint.
- * To create or update a custom attribute owned by another application, the `visibility` setting
- * must be `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $merchantId The ID of the target [merchant](entity:Merchant).
- * @param string $key The key of the custom attribute to create or update. This key must match
- * the `key` of a
- * custom attribute definition in the Square seller account. If the requesting
- * application is not
- * the definition owner, you must use the qualified key.
- * @param UpsertMerchantCustomAttributeRequest $body An object containing the fields to POST for
- * the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function upsertMerchantCustomAttribute(
- string $merchantId,
- string $key,
- UpsertMerchantCustomAttributeRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::POST,
- '/v2/merchants/{merchant_id}/custom-attributes/{key}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('merchant_id', $merchantId),
- TemplateParam::init('key', $key),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(UpsertMerchantCustomAttributeResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/MerchantsApi.php b/src/Apis/MerchantsApi.php
deleted file mode 100644
index 584d586d..00000000
--- a/src/Apis/MerchantsApi.php
+++ /dev/null
@@ -1,62 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/merchants')
- ->auth('global')
- ->parameters(QueryParam::init('cursor', $cursor));
-
- $_resHandler = $this->responseHandler()->type(ListMerchantsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves the `Merchant` object for the given `merchant_id`.
- *
- * @param string $merchantId The ID of the merchant to retrieve. If the string "me" is supplied
- * as the ID,
- * then retrieve the merchant that is currently accessible to this call.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveMerchant(string $merchantId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/merchants/{merchant_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('merchant_id', $merchantId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveMerchantResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/MobileAuthorizationApi.php b/src/Apis/MobileAuthorizationApi.php
deleted file mode 100644
index 76539c99..00000000
--- a/src/Apis/MobileAuthorizationApi.php
+++ /dev/null
@@ -1,51 +0,0 @@
-requestBuilder(RequestMethod::POST, '/mobile/authorization-code')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(CreateMobileAuthorizationCodeResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/OAuthApi.php b/src/Apis/OAuthApi.php
deleted file mode 100644
index d32d3658..00000000
--- a/src/Apis/OAuthApi.php
+++ /dev/null
@@ -1,120 +0,0 @@
-requestBuilder(RequestMethod::POST, '/oauth2/revoke')
- ->parameters(
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body),
- HeaderParam::init('Authorization', $authorization)
- );
-
- $_resHandler = $this->responseHandler()->type(RevokeTokenResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns an OAuth access token and a refresh token unless the
- * `short_lived` parameter is set to `true`, in which case the endpoint
- * returns only an access token.
- *
- * The `grant_type` parameter specifies the type of OAuth request. If
- * `grant_type` is `authorization_code`, you must include the authorization
- * code you received when a seller granted you authorization. If `grant_type`
- * is `refresh_token`, you must provide a valid refresh token. If you're using
- * an old version of the Square APIs (prior to March 13, 2019), `grant_type`
- * can be `migration_token` and you must provide a valid migration token.
- *
- * You can use the `scopes` parameter to limit the set of permissions granted
- * to the access token and refresh token. You can use the `short_lived` parameter
- * to create an access token that expires in 24 hours.
- *
- * __Note:__ OAuth tokens should be encrypted and stored on a secure server.
- * Application clients should never interact directly with OAuth tokens.
- *
- * @param ObtainTokenRequest $body An object containing the fields to POST for the request. See
- * the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function obtainToken(ObtainTokenRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/oauth2/token')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(ObtainTokenResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns information about an [OAuth access token](https://developer.squareup.com/docs/build-
- * basics/access-tokens#get-an-oauth-access-token) or an application’s [personal access token](https:
- * //developer.squareup.com/docs/build-basics/access-tokens#get-a-personal-access-token).
- *
- * Add the access token to the Authorization header of the request.
- *
- * __Important:__ The `Authorization` header you provide to this endpoint must have the following
- * format:
- *
- * ```
- * Authorization: Bearer ACCESS_TOKEN
- * ```
- *
- * where `ACCESS_TOKEN` is a
- * [valid production authorization credential](https://developer.squareup.com/docs/build-basics/access-
- * tokens).
- *
- * If the access token is expired or not a valid access token, the endpoint returns an `UNAUTHORIZED`
- * error.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveTokenStatus(): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/oauth2/token/status')->auth('global');
-
- $_resHandler = $this->responseHandler()->type(RetrieveTokenStatusResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/OrderCustomAttributesApi.php b/src/Apis/OrderCustomAttributesApi.php
deleted file mode 100644
index 45ffb534..00000000
--- a/src/Apis/OrderCustomAttributesApi.php
+++ /dev/null
@@ -1,460 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/orders/custom-attribute-definitions')
- ->auth('global')
- ->parameters(
- QueryParam::init('visibility_filter', $visibilityFilter),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('limit', $limit)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(ListOrderCustomAttributeDefinitionsResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates an order-related custom attribute definition. Use this endpoint to
- * define a custom attribute that can be associated with orders.
- *
- * After creating a custom attribute definition, you can set the custom attribute for orders
- * in the Square seller account.
- *
- * @param CreateOrderCustomAttributeDefinitionRequest $body An object containing the fields to
- * POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createOrderCustomAttributeDefinition(
- CreateOrderCustomAttributeDefinitionRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/orders/custom-attribute-definitions')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(CreateOrderCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes an order-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square
- * seller account.
- *
- * Only the definition owner can delete a custom attribute definition.
- *
- * @param string $key The key of the custom attribute definition to delete.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteOrderCustomAttributeDefinition(string $key): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::DELETE,
- '/v2/orders/custom-attribute-definitions/{key}'
- )->auth('global')->parameters(TemplateParam::init('key', $key));
-
- $_resHandler = $this->responseHandler()
- ->type(DeleteOrderCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves an order-related [custom attribute definition]($m/CustomAttributeDefinition) from a Square
- * seller account.
- *
- * To retrieve a custom attribute definition created by another application, the `visibility`
- * setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined
- * custom attributes
- * (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $key The key of the custom attribute definition to retrieve.
- * @param int|null $version To enable [optimistic
- * concurrency](https://developer.squareup.com/docs/build-basics/common-api-
- * patterns/optimistic-concurrency)
- * control, include this optional field and specify the current version of the custom
- * attribute.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveOrderCustomAttributeDefinition(string $key, ?int $version = null): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/orders/custom-attribute-definitions/{key}')
- ->auth('global')
- ->parameters(TemplateParam::init('key', $key), QueryParam::init('version', $version));
-
- $_resHandler = $this->responseHandler()
- ->type(RetrieveOrderCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates an order-related custom attribute definition for a Square seller account.
- *
- * Only the definition owner can update a custom attribute definition. Note that sellers can view all
- * custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.
- *
- * @param string $key The key of the custom attribute definition to update.
- * @param UpdateOrderCustomAttributeDefinitionRequest $body An object containing the fields to
- * POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateOrderCustomAttributeDefinition(
- string $key,
- UpdateOrderCustomAttributeDefinitionRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/orders/custom-attribute-definitions/{key}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('key', $key),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(UpdateOrderCustomAttributeDefinitionResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes order [custom attributes]($m/CustomAttribute) as a bulk operation.
- *
- * Use this endpoint to delete one or more custom attributes from one or more orders.
- * A custom attribute is based on a custom attribute definition in a Square seller account. (To create
- * a
- * custom attribute definition, use the
- * [CreateOrderCustomAttributeDefinition]($e/OrderCustomAttributes/CreateOrderCustomAttributeDefinition
- * ) endpoint.)
- *
- * This `BulkDeleteOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual delete
- * requests and returns a map of individual delete responses. Each delete request has a unique ID
- * and provides an order ID and custom attribute. Each delete response is returned with the ID
- * of the corresponding request.
- *
- * To delete a custom attribute owned by another application, the `visibility` setting
- * must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes
- * (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param BulkDeleteOrderCustomAttributesRequest $body An object containing the fields to POST
- * for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkDeleteOrderCustomAttributes(BulkDeleteOrderCustomAttributesRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/orders/custom-attributes/bulk-delete')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(BulkDeleteOrderCustomAttributesResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates or updates order [custom attributes]($m/CustomAttribute) as a bulk operation.
- *
- * Use this endpoint to delete one or more custom attributes from one or more orders.
- * A custom attribute is based on a custom attribute definition in a Square seller account. (To create
- * a
- * custom attribute definition, use the
- * [CreateOrderCustomAttributeDefinition]($e/OrderCustomAttributes/CreateOrderCustomAttributeDefinition
- * ) endpoint.)
- *
- * This `BulkUpsertOrderCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert
- * requests and returns a map of individual upsert responses. Each upsert request has a unique ID
- * and provides an order ID and custom attribute. Each upsert response is returned with the ID
- * of the corresponding request.
- *
- * To create or update a custom attribute owned by another application, the `visibility` setting
- * must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes
- * (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param BulkUpsertOrderCustomAttributesRequest $body An object containing the fields to POST
- * for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkUpsertOrderCustomAttributes(BulkUpsertOrderCustomAttributesRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/orders/custom-attributes/bulk-upsert')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(BulkUpsertOrderCustomAttributesResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Lists the [custom attributes]($m/CustomAttribute) associated with an order.
- *
- * You can use the `with_definitions` query parameter to also retrieve custom attribute definitions
- * in the same call.
- *
- * When all response pages are retrieved, the results include all custom attributes that are
- * visible to the requesting application, including those that are owned by other applications
- * and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $orderId The ID of the target [order](entity:Order).
- * @param string|null $visibilityFilter Requests that all of the custom attributes be returned,
- * or only those that are read-only or read-write.
- * @param string|null $cursor The cursor returned in the paged response from the previous call
- * to this endpoint.
- * Provide this cursor to retrieve the next page of results for your original request.
- * For more information, see [Pagination](https://developer.squareup.com/docs/working-
- * with-apis/pagination).
- * @param int|null $limit The maximum number of results to return in a single paged response.
- * This limit is advisory.
- * The response might contain more or fewer results. The minimum value is 1 and the
- * maximum value is 100.
- * The default value is 20.
- * For more information, see [Pagination](https://developer.squareup.com/docs/working-
- * with-apis/pagination).
- * @param bool|null $withDefinitions Indicates whether to return the [custom attribute
- * definition](entity:CustomAttributeDefinition) in the `definition` field of each
- * custom attribute. Set this parameter to `true` to get the name and description of
- * each custom attribute,
- * information about the data type, or other definition details. The default value is
- * `false`.
- *
- * @return ApiResponse Response from the API call
- */
- public function listOrderCustomAttributes(
- string $orderId,
- ?string $visibilityFilter = null,
- ?string $cursor = null,
- ?int $limit = null,
- ?bool $withDefinitions = false
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/orders/{order_id}/custom-attributes')
- ->auth('global')
- ->parameters(
- TemplateParam::init('order_id', $orderId),
- QueryParam::init('visibility_filter', $visibilityFilter),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('limit', $limit),
- QueryParam::init('with_definitions', $withDefinitions)
- );
-
- $_resHandler = $this->responseHandler()->type(ListOrderCustomAttributesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a [custom attribute]($m/CustomAttribute) associated with a customer profile.
- *
- * To delete a custom attribute owned by another application, the `visibility` setting must be
- * `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes
- * (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $orderId The ID of the target [order](entity:Order).
- * @param string $customAttributeKey The key of the custom attribute to delete. This key must
- * match the key of an
- * existing custom attribute definition.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteOrderCustomAttribute(string $orderId, string $customAttributeKey): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::DELETE,
- '/v2/orders/{order_id}/custom-attributes/{custom_attribute_key}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('order_id', $orderId),
- TemplateParam::init('custom_attribute_key', $customAttributeKey)
- );
-
- $_resHandler = $this->responseHandler()->type(DeleteOrderCustomAttributeResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a [custom attribute]($m/CustomAttribute) associated with an order.
- *
- * You can use the `with_definition` query parameter to also retrieve the custom attribute definition
- * in the same call.
- *
- * To retrieve a custom attribute owned by another application, the `visibility` setting must be
- * `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom
- * attributes
- * also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $orderId The ID of the target [order](entity:Order).
- * @param string $customAttributeKey The key of the custom attribute to retrieve. This key must
- * match the key of an
- * existing custom attribute definition.
- * @param int|null $version To enable [optimistic
- * concurrency](https://developer.squareup.com/docs/build-basics/common-api-
- * patterns/optimistic-concurrency)
- * control, include this optional field and specify the current version of the custom
- * attribute.
- * @param bool|null $withDefinition Indicates whether to return the [custom attribute
- * definition](entity:CustomAttributeDefinition) in the `definition` field of each
- * custom attribute. Set this parameter to `true` to get the name and description of
- * each custom attribute,
- * information about the data type, or other definition details. The default value is
- * `false`.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveOrderCustomAttribute(
- string $orderId,
- string $customAttributeKey,
- ?int $version = null,
- ?bool $withDefinition = false
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::GET,
- '/v2/orders/{order_id}/custom-attributes/{custom_attribute_key}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('order_id', $orderId),
- TemplateParam::init('custom_attribute_key', $customAttributeKey),
- QueryParam::init('version', $version),
- QueryParam::init('with_definition', $withDefinition)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(RetrieveOrderCustomAttributeResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates or updates a [custom attribute]($m/CustomAttribute) for an order.
- *
- * Use this endpoint to set the value of a custom attribute for a specific order.
- * A custom attribute is based on a custom attribute definition in a Square seller account. (To create
- * a
- * custom attribute definition, use the
- * [CreateOrderCustomAttributeDefinition]($e/OrderCustomAttributes/CreateOrderCustomAttributeDefinition
- * ) endpoint.)
- *
- * To create or update a custom attribute owned by another application, the `visibility` setting
- * must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes
- * (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.
- *
- * @param string $orderId The ID of the target [order](entity:Order).
- * @param string $customAttributeKey The key of the custom attribute to create or update. This
- * key must match the key
- * of an existing custom attribute definition.
- * @param UpsertOrderCustomAttributeRequest $body An object containing the fields to POST for
- * the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function upsertOrderCustomAttribute(
- string $orderId,
- string $customAttributeKey,
- UpsertOrderCustomAttributeRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::POST,
- '/v2/orders/{order_id}/custom-attributes/{custom_attribute_key}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('order_id', $orderId),
- TemplateParam::init('custom_attribute_key', $customAttributeKey),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpsertOrderCustomAttributeResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/OrdersApi.php b/src/Apis/OrdersApi.php
deleted file mode 100644
index d7b28b64..00000000
--- a/src/Apis/OrdersApi.php
+++ /dev/null
@@ -1,249 +0,0 @@
-requestBuilder(RequestMethod::POST, '/v2/orders')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateOrderResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a set of [orders]($m/Order) by their IDs.
- *
- * If a given order ID does not exist, the ID is ignored instead of generating an error.
- *
- * @param BatchRetrieveOrdersRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function batchRetrieveOrders(BatchRetrieveOrdersRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/orders/batch-retrieve')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BatchRetrieveOrdersResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Enables applications to preview order pricing without creating an order.
- *
- * @param CalculateOrderRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function calculateOrder(CalculateOrderRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/orders/calculate')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CalculateOrderResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a new order, in the `DRAFT` state, by duplicating an existing order. The newly created order
- * has
- * only the core fields (such as line items, taxes, and discounts) copied from the original order.
- *
- * @param CloneOrderRequest $body An object containing the fields to POST for the request. See
- * the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function cloneOrder(CloneOrderRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/orders/clone')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CloneOrderResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Search all orders for one or more locations. Orders include all sales,
- * returns, and exchanges regardless of how or when they entered the Square
- * ecosystem (such as Point of Sale, Invoices, and Connect APIs).
- *
- * `SearchOrders` requests need to specify which locations to search and define a
- * [SearchOrdersQuery]($m/SearchOrdersQuery) object that controls
- * how to sort or filter the results. Your `SearchOrdersQuery` can:
- *
- * Set filter criteria.
- * Set the sort order.
- * Determine whether to return results as complete `Order` objects or as
- * [OrderEntry]($m/OrderEntry) objects.
- *
- * Note that details for orders processed with Square Point of Sale while in
- * offline mode might not be transmitted to Square for up to 72 hours. Offline
- * orders have a `created_at` value that reflects the time the order was created,
- * not the time it was subsequently transmitted to Square.
- *
- * @param SearchOrdersRequest $body An object containing the fields to POST for the request. See
- * the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function searchOrders(SearchOrdersRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/orders/search')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchOrdersResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves an [Order]($m/Order) by ID.
- *
- * @param string $orderId The ID of the order to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveOrder(string $orderId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/orders/{order_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('order_id', $orderId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveOrderResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates an open [order]($m/Order) by adding, replacing, or deleting
- * fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.
- *
- * An `UpdateOrder` request requires the following:
- *
- * - The `order_id` in the endpoint path, identifying the order to update.
- * - The latest `version` of the order to update.
- * - The [sparse order](https://developer.squareup.com/docs/orders-api/manage-orders/update-
- * orders#sparse-order-objects)
- * containing only the fields to update and the version to which the update is
- * being applied.
- * - If deleting fields, the [dot notation paths](https://developer.squareup.com/docs/orders-api/manage-
- * orders/update-orders#identifying-fields-to-delete)
- * identifying the fields to clear.
- *
- * To pay for an order, see
- * [Pay for Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders).
- *
- * @param string $orderId The ID of the order to update.
- * @param UpdateOrderRequest $body An object containing the fields to POST for the request. See
- * the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateOrder(string $orderId, UpdateOrderRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/orders/{order_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('order_id', $orderId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateOrderResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Pay for an [order]($m/Order) using one or more approved [payments]($m/Payment)
- * or settle an order with a total of `0`.
- *
- * The total of the `payment_ids` listed in the request must be equal to the order
- * total. Orders with a total amount of `0` can be marked as paid by specifying an empty
- * array of `payment_ids` in the request.
- *
- * To be used with `PayOrder`, a payment must:
- *
- * - Reference the order by specifying the `order_id` when [creating the
- * payment]($e/Payments/CreatePayment).
- * Any approved payments that reference the same `order_id` not specified in the
- * `payment_ids` is canceled.
- * - Be approved with [delayed capture](https://developer.squareup.com/docs/payments-api/take-
- * payments/card-payments/delayed-capture).
- * Using a delayed capture payment with `PayOrder` completes the approved payment.
- *
- * @param string $orderId The ID of the order being paid.
- * @param PayOrderRequest $body An object containing the fields to POST for the request. See the
- * corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function payOrder(string $orderId, PayOrderRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/orders/{order_id}/pay')
- ->auth('global')
- ->parameters(
- TemplateParam::init('order_id', $orderId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(PayOrderResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/PaymentsApi.php b/src/Apis/PaymentsApi.php
deleted file mode 100644
index 51bfa4fe..00000000
--- a/src/Apis/PaymentsApi.php
+++ /dev/null
@@ -1,285 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/payments')
- ->auth('global')
- ->parameters(
- QueryParam::init('begin_time', $beginTime),
- QueryParam::init('end_time', $endTime),
- QueryParam::init('sort_order', $sortOrder),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('location_id', $locationId),
- QueryParam::init('total', $total),
- QueryParam::init('last_4', $last4),
- QueryParam::init('card_brand', $cardBrand),
- QueryParam::init('limit', $limit),
- QueryParam::init('is_offline_payment', $isOfflinePayment),
- QueryParam::init('offline_begin_time', $offlineBeginTime),
- QueryParam::init('offline_end_time', $offlineEndTime),
- QueryParam::init('updated_at_begin_time', $updatedAtBeginTime),
- QueryParam::init('updated_at_end_time', $updatedAtEndTime),
- QueryParam::init('sort_field', $sortField)
- );
-
- $_resHandler = $this->responseHandler()->type(ListPaymentsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a payment using the provided source. You can use this endpoint
- * to charge a card (credit/debit card or
- * Square gift card) or record a payment that the seller received outside of Square
- * (cash payment from a buyer or a payment that an external entity
- * processed on behalf of the seller).
- *
- * The endpoint creates a
- * `Payment` object and returns it in the response.
- *
- * @param CreatePaymentRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createPayment(CreatePaymentRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/payments')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreatePaymentResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Cancels (voids) a payment identified by the idempotency key that is specified in the
- * request.
- *
- * Use this method when the status of a `CreatePayment` request is unknown (for example, after you send
- * a
- * `CreatePayment` request, a network error occurs and you do not get a response). In this case, you
- * can
- * direct Square to cancel the payment using this endpoint. In the request, you provide the same
- * idempotency key that you provided in your `CreatePayment` request that you want to cancel. After
- * canceling the payment, you can submit your `CreatePayment` request again.
- *
- * Note that if no payment with the specified idempotency key is found, no action is taken and the
- * endpoint
- * returns successfully.
- *
- * @param CancelPaymentByIdempotencyKeyRequest $body An object containing the fields to POST for
- * the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function cancelPaymentByIdempotencyKey(CancelPaymentByIdempotencyKeyRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/payments/cancel')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()
- ->type(CancelPaymentByIdempotencyKeyResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves details for a specific payment.
- *
- * @param string $paymentId A unique ID for the desired payment.
- *
- * @return ApiResponse Response from the API call
- */
- public function getPayment(string $paymentId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payments/{payment_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('payment_id', $paymentId));
-
- $_resHandler = $this->responseHandler()->type(GetPaymentResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates a payment with the APPROVED status.
- * You can update the `amount_money` and `tip_money` using this endpoint.
- *
- * @param string $paymentId The ID of the payment to update.
- * @param UpdatePaymentRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updatePayment(string $paymentId, UpdatePaymentRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/payments/{payment_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('payment_id', $paymentId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdatePaymentResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Cancels (voids) a payment. You can use this endpoint to cancel a payment with
- * the APPROVED `status`.
- *
- * @param string $paymentId The ID of the payment to cancel.
- *
- * @return ApiResponse Response from the API call
- */
- public function cancelPayment(string $paymentId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/payments/{payment_id}/cancel')
- ->auth('global')
- ->parameters(TemplateParam::init('payment_id', $paymentId));
-
- $_resHandler = $this->responseHandler()->type(CancelPaymentResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Completes (captures) a payment.
- * By default, payments are set to complete immediately after they are created.
- *
- * You can use this endpoint to complete a payment with the APPROVED `status`.
- *
- * @param string $paymentId The unique ID identifying the payment to be completed.
- * @param CompletePaymentRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function completePayment(string $paymentId, CompletePaymentRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/payments/{payment_id}/complete')
- ->auth('global')
- ->parameters(
- TemplateParam::init('payment_id', $paymentId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(CompletePaymentResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/PayoutsApi.php b/src/Apis/PayoutsApi.php
deleted file mode 100644
index 3c5ba11e..00000000
--- a/src/Apis/PayoutsApi.php
+++ /dev/null
@@ -1,134 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/payouts')
- ->auth('global')
- ->parameters(
- QueryParam::init('location_id', $locationId),
- QueryParam::init('status', $status),
- QueryParam::init('begin_time', $beginTime),
- QueryParam::init('end_time', $endTime),
- QueryParam::init('sort_order', $sortOrder),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('limit', $limit)
- );
-
- $_resHandler = $this->responseHandler()->type(ListPayoutsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves details of a specific payout identified by a payout ID.
- * To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.
- *
- * @param string $payoutId The ID of the payout to retrieve the information for.
- *
- * @return ApiResponse Response from the API call
- */
- public function getPayout(string $payoutId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payouts/{payout_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('payout_id', $payoutId));
-
- $_resHandler = $this->responseHandler()->type(GetPayoutResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a list of all payout entries for a specific payout.
- * To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.
- *
- * @param string $payoutId The ID of the payout to retrieve the information for.
- * @param string|null $sortOrder The order in which payout entries are listed.
- * @param string|null $cursor A pagination cursor returned by a previous call to this endpoint.
- * Provide this cursor to retrieve the next set of results for the original query.
- * For more information, see [Pagination](https://developer.squareup.com/docs/build-
- * basics/common-api-patterns/pagination).
- * If request parameters change between requests, subsequent results may contain
- * duplicates or missing records.
- * @param int|null $limit The maximum number of results to be returned in a single page. It is
- * possible to receive fewer results than the specified limit on a given page.
- * The default value of 100 is also the maximum allowed value. If the provided value
- * is
- * greater than 100, it is ignored and the default value is used instead.
- * Default: `100`
- *
- * @return ApiResponse Response from the API call
- */
- public function listPayoutEntries(
- string $payoutId,
- ?string $sortOrder = null,
- ?string $cursor = null,
- ?int $limit = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/payouts/{payout_id}/payout-entries')
- ->auth('global')
- ->parameters(
- TemplateParam::init('payout_id', $payoutId),
- QueryParam::init('sort_order', $sortOrder),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('limit', $limit)
- );
-
- $_resHandler = $this->responseHandler()->type(ListPayoutEntriesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/RefundsApi.php b/src/Apis/RefundsApi.php
deleted file mode 100644
index 32a2b851..00000000
--- a/src/Apis/RefundsApi.php
+++ /dev/null
@@ -1,139 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/refunds')
- ->auth('global')
- ->parameters(
- QueryParam::init('begin_time', $beginTime),
- QueryParam::init('end_time', $endTime),
- QueryParam::init('sort_order', $sortOrder),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('location_id', $locationId),
- QueryParam::init('status', $status),
- QueryParam::init('source_type', $sourceType),
- QueryParam::init('limit', $limit)
- );
-
- $_resHandler = $this->responseHandler()->type(ListPaymentRefundsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Refunds a payment. You can refund the entire payment amount or a
- * portion of it. You can use this endpoint to refund a card payment or record a
- * refund of a cash or external payment. For more information, see
- * [Refund Payment](https://developer.squareup.com/docs/payments-api/refund-payments).
- *
- * @param RefundPaymentRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function refundPayment(RefundPaymentRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/refunds')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(RefundPaymentResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a specific refund using the `refund_id`.
- *
- * @param string $refundId The unique ID for the desired `PaymentRefund`.
- *
- * @return ApiResponse Response from the API call
- */
- public function getPaymentRefund(string $refundId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/refunds/{refund_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('refund_id', $refundId));
-
- $_resHandler = $this->responseHandler()->type(GetPaymentRefundResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/SitesApi.php b/src/Apis/SitesApi.php
deleted file mode 100644
index 29487c1f..00000000
--- a/src/Apis/SitesApi.php
+++ /dev/null
@@ -1,32 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/sites')->auth('global');
-
- $_resHandler = $this->responseHandler()->type(ListSitesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/SnippetsApi.php b/src/Apis/SnippetsApi.php
deleted file mode 100644
index 3dd87866..00000000
--- a/src/Apis/SnippetsApi.php
+++ /dev/null
@@ -1,102 +0,0 @@
-requestBuilder(RequestMethod::DELETE, '/v2/sites/{site_id}/snippet')
- ->auth('global')
- ->parameters(TemplateParam::init('site_id', $siteId));
-
- $_resHandler = $this->responseHandler()->type(DeleteSnippetResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves your snippet from a Square Online site. A site can contain snippets from multiple snippet
- * applications, but you can retrieve only the snippet that was added by your application.
- *
- * You can call [ListSites]($e/Sites/ListSites) to get the IDs of the sites that belong to a seller.
- *
- *
- * __Note:__ Square Online APIs are publicly available as part of an early access program. For more
- * information, see [Early access program for Square Online APIs](https://developer.squareup.
- * com/docs/online-api#early-access-program-for-square-online-apis).
- *
- * @param string $siteId The ID of the site that contains the snippet.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveSnippet(string $siteId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/sites/{site_id}/snippet')
- ->auth('global')
- ->parameters(TemplateParam::init('site_id', $siteId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveSnippetResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Adds a snippet to a Square Online site or updates the existing snippet on the site.
- * The snippet code is appended to the end of the `head` element on every page of the site, except
- * checkout pages. A snippet application can add one snippet to a given site.
- *
- * You can call [ListSites]($e/Sites/ListSites) to get the IDs of the sites that belong to a seller.
- *
- *
- * __Note:__ Square Online APIs are publicly available as part of an early access program. For more
- * information, see [Early access program for Square Online APIs](https://developer.squareup.
- * com/docs/online-api#early-access-program-for-square-online-apis).
- *
- * @param string $siteId The ID of the site where you want to add or update the snippet.
- * @param UpsertSnippetRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function upsertSnippet(string $siteId, UpsertSnippetRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/sites/{site_id}/snippet')
- ->auth('global')
- ->parameters(
- TemplateParam::init('site_id', $siteId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpsertSnippetResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/SubscriptionsApi.php b/src/Apis/SubscriptionsApi.php
deleted file mode 100644
index 04507e74..00000000
--- a/src/Apis/SubscriptionsApi.php
+++ /dev/null
@@ -1,363 +0,0 @@
-requestBuilder(RequestMethod::POST, '/v2/subscriptions')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateSubscriptionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Schedules a plan variation change for all active subscriptions under a given plan
- * variation. For more information, see [Swap Subscription Plan Variations](https://developer.squareup.
- * com/docs/subscriptions-api/swap-plan-variations).
- *
- * @param BulkSwapPlanRequest $body An object containing the fields to POST for the request. See
- * the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkSwapPlan(BulkSwapPlanRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/subscriptions/bulk-swap-plan')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BulkSwapPlanResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Searches for subscriptions.
- *
- * Results are ordered chronologically by subscription creation date. If
- * the request specifies more than one location ID,
- * the endpoint orders the result
- * by location ID, and then by creation date within each location. If no locations are given
- * in the query, all locations are searched.
- *
- * You can also optionally specify `customer_ids` to search by customer.
- * If left unset, all customers
- * associated with the specified locations are returned.
- * If the request specifies customer IDs, the endpoint orders results
- * first by location, within location by customer ID, and within
- * customer by subscription creation date.
- *
- * @param SearchSubscriptionsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function searchSubscriptions(SearchSubscriptionsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/subscriptions/search')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchSubscriptionsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a specific subscription.
- *
- * @param string $subscriptionId The ID of the subscription to retrieve.
- * @param string|null $mInclude A query parameter to specify related information to be included
- * in the response.
- *
- * The supported query parameter values are:
- *
- * - `actions`: to include scheduled actions on the targeted subscription.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveSubscription(string $subscriptionId, ?string $mInclude = null): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/subscriptions/{subscription_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('subscription_id', $subscriptionId),
- QueryParam::init('include', $mInclude)
- );
-
- $_resHandler = $this->responseHandler()->type(RetrieveSubscriptionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates a subscription by modifying or clearing `subscription` field values.
- * To clear a field, set its value to `null`.
- *
- * @param string $subscriptionId The ID of the subscription to update.
- * @param UpdateSubscriptionRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateSubscription(string $subscriptionId, UpdateSubscriptionRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/subscriptions/{subscription_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('subscription_id', $subscriptionId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateSubscriptionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a scheduled action for a subscription.
- *
- * @param string $subscriptionId The ID of the subscription the targeted action is to act upon.
- * @param string $actionId The ID of the targeted action to be deleted.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteSubscriptionAction(string $subscriptionId, string $actionId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::DELETE,
- '/v2/subscriptions/{subscription_id}/actions/{action_id}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('subscription_id', $subscriptionId),
- TemplateParam::init('action_id', $actionId)
- );
-
- $_resHandler = $this->responseHandler()->type(DeleteSubscriptionActionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Changes the [billing anchor date](https://developer.squareup.com/docs/subscriptions-api/subscription-
- * billing#billing-dates)
- * for a subscription.
- *
- * @param string $subscriptionId The ID of the subscription to update the billing anchor date.
- * @param ChangeBillingAnchorDateRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function changeBillingAnchorDate(string $subscriptionId, ChangeBillingAnchorDateRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::POST,
- '/v2/subscriptions/{subscription_id}/billing-anchor'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('subscription_id', $subscriptionId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(ChangeBillingAnchorDateResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Schedules a `CANCEL` action to cancel an active subscription. This
- * sets the `canceled_date` field to the end of the active billing period. After this date,
- * the subscription status changes from ACTIVE to CANCELED.
- *
- * @param string $subscriptionId The ID of the subscription to cancel.
- *
- * @return ApiResponse Response from the API call
- */
- public function cancelSubscription(string $subscriptionId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/subscriptions/{subscription_id}/cancel')
- ->auth('global')
- ->parameters(TemplateParam::init('subscription_id', $subscriptionId));
-
- $_resHandler = $this->responseHandler()->type(CancelSubscriptionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Lists all [events](https://developer.squareup.com/docs/subscriptions-api/actions-events) for a
- * specific subscription.
- *
- * @param string $subscriptionId The ID of the subscription to retrieve the events for.
- * @param string|null $cursor When the total number of resulting subscription events exceeds the
- * limit of a paged response,
- * specify the cursor returned from a preceding response here to fetch the next set of
- * results.
- * If the cursor is unset, the response contains the last page of the results.
- *
- * For more information, see [Pagination](https://developer.squareup.com/docs/build-
- * basics/common-api-patterns/pagination).
- * @param int|null $limit The upper limit on the number of subscription events to return in a
- * paged response.
- *
- * @return ApiResponse Response from the API call
- */
- public function listSubscriptionEvents(
- string $subscriptionId,
- ?string $cursor = null,
- ?int $limit = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/subscriptions/{subscription_id}/events')
- ->auth('global')
- ->parameters(
- TemplateParam::init('subscription_id', $subscriptionId),
- QueryParam::init('cursor', $cursor),
- QueryParam::init('limit', $limit)
- );
-
- $_resHandler = $this->responseHandler()->type(ListSubscriptionEventsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Schedules a `PAUSE` action to pause an active subscription.
- *
- * @param string $subscriptionId The ID of the subscription to pause.
- * @param PauseSubscriptionRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function pauseSubscription(string $subscriptionId, PauseSubscriptionRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/subscriptions/{subscription_id}/pause')
- ->auth('global')
- ->parameters(
- TemplateParam::init('subscription_id', $subscriptionId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(PauseSubscriptionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Schedules a `RESUME` action to resume a paused or a deactivated subscription.
- *
- * @param string $subscriptionId The ID of the subscription to resume.
- * @param ResumeSubscriptionRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function resumeSubscription(string $subscriptionId, ResumeSubscriptionRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/subscriptions/{subscription_id}/resume')
- ->auth('global')
- ->parameters(
- TemplateParam::init('subscription_id', $subscriptionId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(ResumeSubscriptionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an existing subscription.
- * For more information, see [Swap Subscription Plan Variations](https://developer.squareup.
- * com/docs/subscriptions-api/swap-plan-variations).
- *
- * @param string $subscriptionId The ID of the subscription to swap the subscription plan for.
- * @param SwapPlanRequest $body An object containing the fields to POST for the request. See the
- * corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function swapPlan(string $subscriptionId, SwapPlanRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/subscriptions/{subscription_id}/swap-plan')
- ->auth('global')
- ->parameters(
- TemplateParam::init('subscription_id', $subscriptionId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(SwapPlanResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/TeamApi.php b/src/Apis/TeamApi.php
deleted file mode 100644
index 50c9893a..00000000
--- a/src/Apis/TeamApi.php
+++ /dev/null
@@ -1,336 +0,0 @@
-requestBuilder(RequestMethod::POST, '/v2/team-members')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateTeamMemberResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates multiple `TeamMember` objects. The created `TeamMember` objects are returned on successful
- * creates.
- * This process is non-transactional and processes as much of the request as possible. If one of the
- * creates in
- * the request cannot be successfully processed, the request is not marked as failed, but the body of
- * the response
- * contains explicit error information for the failed create.
- *
- * Learn about [Troubleshooting the Team API](https://developer.squareup.
- * com/docs/team/troubleshooting#bulk-create-team-members).
- *
- * @param BulkCreateTeamMembersRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkCreateTeamMembers(BulkCreateTeamMembersRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/team-members/bulk-create')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BulkCreateTeamMembersResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates multiple `TeamMember` objects. The updated `TeamMember` objects are returned on successful
- * updates.
- * This process is non-transactional and processes as much of the request as possible. If one of the
- * updates in
- * the request cannot be successfully processed, the request is not marked as failed, but the body of
- * the response
- * contains explicit error information for the failed update.
- * Learn about [Troubleshooting the Team API](https://developer.squareup.
- * com/docs/team/troubleshooting#bulk-update-team-members).
- *
- * @param BulkUpdateTeamMembersRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkUpdateTeamMembers(BulkUpdateTeamMembersRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/team-members/bulk-update')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BulkUpdateTeamMembersResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Lists jobs in a seller account. Results are sorted by title in ascending order.
- *
- * @param string|null $cursor The pagination cursor returned by the previous call to this
- * endpoint. Provide this
- * cursor to retrieve the next page of results for your original request. For more
- * information,
- * see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-
- * patterns/pagination).
- *
- * @return ApiResponse Response from the API call
- */
- public function listJobs(?string $cursor = null): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/team-members/jobs')
- ->auth('global')
- ->parameters(QueryParam::init('cursor', $cursor));
-
- $_resHandler = $this->responseHandler()->type(ListJobsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a job in a seller account. A job defines a title and tip eligibility. Note that
- * compensation is defined in a [job assignment]($m/JobAssignment) in a team member's wage setting.
- *
- * @param CreateJobRequest $body An object containing the fields to POST for the request. See
- * the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createJob(CreateJobRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/team-members/jobs')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateJobResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a specified job.
- *
- * @param string $jobId The ID of the job to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveJob(string $jobId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/team-members/jobs/{job_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('job_id', $jobId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveJobResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates the title or tip eligibility of a job. Changes to the title propagate to all
- * `JobAssignment`, `Shift`, and `TeamMemberWage` objects that reference the job ID. Changes to
- * tip eligibility propagate to all `TeamMemberWage` objects that reference the job ID.
- *
- * @param string $jobId The ID of the job to update.
- * @param UpdateJobRequest $body An object containing the fields to POST for the request. See
- * the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateJob(string $jobId, UpdateJobRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/team-members/jobs/{job_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('job_id', $jobId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateJobResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns a paginated list of `TeamMember` objects for a business.
- * The list can be filtered by location IDs, `ACTIVE` or `INACTIVE` status, or whether
- * the team member is the Square account owner.
- *
- * @param SearchTeamMembersRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function searchTeamMembers(SearchTeamMembersRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/team-members/search')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchTeamMembersResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a `TeamMember` object for the given `TeamMember.id`.
- * Learn about [Troubleshooting the Team API](https://developer.squareup.
- * com/docs/team/troubleshooting#retrieve-a-team-member).
- *
- * @param string $teamMemberId The ID of the team member to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveTeamMember(string $teamMemberId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/team-members/{team_member_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('team_member_id', $teamMemberId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveTeamMemberResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates a single `TeamMember` object. The `TeamMember` object is returned on successful updates.
- * Learn about [Troubleshooting the Team API](https://developer.squareup.
- * com/docs/team/troubleshooting#update-a-team-member).
- *
- * @param string $teamMemberId The ID of the team member to update.
- * @param UpdateTeamMemberRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateTeamMember(string $teamMemberId, UpdateTeamMemberRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/team-members/{team_member_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('team_member_id', $teamMemberId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateTeamMemberResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a `WageSetting` object for a team member specified
- * by `TeamMember.id`. For more information, see
- * [Troubleshooting the Team API](https://developer.squareup.
- * com/docs/team/troubleshooting#retrievewagesetting).
- *
- * Square recommends using [RetrieveTeamMember]($e/Team/RetrieveTeamMember) or
- * [SearchTeamMembers]($e/Team/SearchTeamMembers)
- * to get this information directly from the `TeamMember.wage_setting` field.
- *
- * @param string $teamMemberId The ID of the team member for which to retrieve the wage setting.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveWageSetting(string $teamMemberId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/team-members/{team_member_id}/wage-setting')
- ->auth('global')
- ->parameters(TemplateParam::init('team_member_id', $teamMemberId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveWageSettingResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates or updates a `WageSetting` object. The object is created if a
- * `WageSetting` with the specified `team_member_id` doesn't exist. Otherwise,
- * it fully replaces the `WageSetting` object for the team member.
- * The `WageSetting` is returned on a successful update. For more information, see
- * [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#create-or-
- * update-a-wage-setting).
- *
- * Square recommends using [CreateTeamMember]($e/Team/CreateTeamMember) or
- * [UpdateTeamMember]($e/Team/UpdateTeamMember)
- * to manage the `TeamMember.wage_setting` field directly.
- *
- * @param string $teamMemberId The ID of the team member for which to update the `WageSetting`
- * object.
- * @param UpdateWageSettingRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateWageSetting(string $teamMemberId, UpdateWageSettingRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/team-members/{team_member_id}/wage-setting')
- ->auth('global')
- ->parameters(
- TemplateParam::init('team_member_id', $teamMemberId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateWageSettingResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/TerminalApi.php b/src/Apis/TerminalApi.php
deleted file mode 100644
index 620e1a87..00000000
--- a/src/Apis/TerminalApi.php
+++ /dev/null
@@ -1,342 +0,0 @@
-requestBuilder(RequestMethod::POST, '/v2/terminals/actions')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateTerminalActionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a filtered list of Terminal action requests created by the account making the request.
- * Terminal action requests are available for 30 days.
- *
- * @param SearchTerminalActionsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function searchTerminalActions(SearchTerminalActionsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/terminals/actions/search')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchTerminalActionsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a Terminal action request by `action_id`. Terminal action requests are available for 30
- * days.
- *
- * @param string $actionId Unique ID for the desired `TerminalAction`.
- *
- * @return ApiResponse Response from the API call
- */
- public function getTerminalAction(string $actionId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/terminals/actions/{action_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('action_id', $actionId));
-
- $_resHandler = $this->responseHandler()->type(GetTerminalActionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Cancels a Terminal action request if the status of the request permits it.
- *
- * @param string $actionId Unique ID for the desired `TerminalAction`.
- *
- * @return ApiResponse Response from the API call
- */
- public function cancelTerminalAction(string $actionId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/terminals/actions/{action_id}/cancel')
- ->auth('global')
- ->parameters(TemplateParam::init('action_id', $actionId));
-
- $_resHandler = $this->responseHandler()->type(CancelTerminalActionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Dismisses a Terminal action request if the status and type of the request permits it.
- *
- * See [Link and Dismiss Actions](https://developer.squareup.com/docs/terminal-api/advanced-
- * features/custom-workflows/link-and-dismiss-actions) for more details.
- *
- * @param string $actionId Unique ID for the `TerminalAction` associated with the action to be
- * dismissed.
- *
- * @return ApiResponse Response from the API call
- */
- public function dismissTerminalAction(string $actionId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/terminals/actions/{action_id}/dismiss')
- ->auth('global')
- ->parameters(TemplateParam::init('action_id', $actionId));
-
- $_resHandler = $this->responseHandler()->type(DismissTerminalActionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a Terminal checkout request and sends it to the specified device to take a payment
- * for the requested amount.
- *
- * @param CreateTerminalCheckoutRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createTerminalCheckout(CreateTerminalCheckoutRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/terminals/checkouts')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateTerminalCheckoutResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Returns a filtered list of Terminal checkout requests created by the application making the request.
- * Only Terminal checkout requests created for the merchant scoped to the OAuth token are returned.
- * Terminal checkout requests are available for 30 days.
- *
- * @param SearchTerminalCheckoutsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function searchTerminalCheckouts(SearchTerminalCheckoutsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/terminals/checkouts/search')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchTerminalCheckoutsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout requests are available for
- * 30 days.
- *
- * @param string $checkoutId The unique ID for the desired `TerminalCheckout`.
- *
- * @return ApiResponse Response from the API call
- */
- public function getTerminalCheckout(string $checkoutId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/terminals/checkouts/{checkout_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('checkout_id', $checkoutId));
-
- $_resHandler = $this->responseHandler()->type(GetTerminalCheckoutResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Cancels a Terminal checkout request if the status of the request permits it.
- *
- * @param string $checkoutId The unique ID for the desired `TerminalCheckout`.
- *
- * @return ApiResponse Response from the API call
- */
- public function cancelTerminalCheckout(string $checkoutId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/terminals/checkouts/{checkout_id}/cancel')
- ->auth('global')
- ->parameters(TemplateParam::init('checkout_id', $checkoutId));
-
- $_resHandler = $this->responseHandler()->type(CancelTerminalCheckoutResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Dismisses a Terminal checkout request if the status and type of the request permits it.
- *
- * @param string $checkoutId Unique ID for the `TerminalCheckout` associated with the checkout
- * to be dismissed.
- *
- * @return ApiResponse Response from the API call
- */
- public function dismissTerminalCheckout(string $checkoutId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/terminals/checkouts/{checkout_id}/dismiss')
- ->auth('global')
- ->parameters(TemplateParam::init('checkout_id', $checkoutId));
-
- $_resHandler = $this->responseHandler()->type(DismissTerminalCheckoutResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a request to refund an Interac payment completed on a Square Terminal. Refunds for Interac
- * payments on a Square Terminal are supported only for Interac debit cards in Canada. Other refunds
- * for Terminal payments should use the Refunds API. For more information, see [Refunds
- * API]($e/Refunds).
- *
- * @param CreateTerminalRefundRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createTerminalRefund(CreateTerminalRefundRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/terminals/refunds')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateTerminalRefundResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a filtered list of Interac Terminal refund requests created by the seller making the
- * request. Terminal refund requests are available for 30 days.
- *
- * @param SearchTerminalRefundsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function searchTerminalRefunds(SearchTerminalRefundsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/terminals/refunds/search')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchTerminalRefundsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves an Interac Terminal refund object by ID. Terminal refund objects are available for 30 days.
- *
- * @param string $terminalRefundId The unique ID for the desired `TerminalRefund`.
- *
- * @return ApiResponse Response from the API call
- */
- public function getTerminalRefund(string $terminalRefundId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/terminals/refunds/{terminal_refund_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('terminal_refund_id', $terminalRefundId));
-
- $_resHandler = $this->responseHandler()->type(GetTerminalRefundResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Cancels an Interac Terminal refund request by refund request ID if the status of the request permits
- * it.
- *
- * @param string $terminalRefundId The unique ID for the desired `TerminalRefund`.
- *
- * @return ApiResponse Response from the API call
- */
- public function cancelTerminalRefund(string $terminalRefundId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::POST,
- '/v2/terminals/refunds/{terminal_refund_id}/cancel'
- )->auth('global')->parameters(TemplateParam::init('terminal_refund_id', $terminalRefundId));
-
- $_resHandler = $this->responseHandler()->type(CancelTerminalRefundResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Dismisses a Terminal refund request if the status and type of the request permits it.
- *
- * @param string $terminalRefundId Unique ID for the `TerminalRefund` associated with the refund
- * to be dismissed.
- *
- * @return ApiResponse Response from the API call
- */
- public function dismissTerminalRefund(string $terminalRefundId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::POST,
- '/v2/terminals/refunds/{terminal_refund_id}/dismiss'
- )->auth('global')->parameters(TemplateParam::init('terminal_refund_id', $terminalRefundId));
-
- $_resHandler = $this->responseHandler()->type(DismissTerminalRefundResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/TransactionsApi.php b/src/Apis/TransactionsApi.php
deleted file mode 100644
index 1b59687c..00000000
--- a/src/Apis/TransactionsApi.php
+++ /dev/null
@@ -1,176 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/locations/{location_id}/transactions')
- ->auth('global')
- ->parameters(
- TemplateParam::init('location_id', $locationId),
- QueryParam::init('begin_time', $beginTime),
- QueryParam::init('end_time', $endTime),
- QueryParam::init('sort_order', $sortOrder),
- QueryParam::init('cursor', $cursor)
- );
-
- $_resHandler = $this->responseHandler()->type(ListTransactionsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves details for a single transaction.
- *
- * @deprecated
- *
- * @param string $locationId The ID of the transaction's associated location.
- * @param string $transactionId The ID of the transaction to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveTransaction(string $locationId, string $transactionId): ApiResponse
- {
- trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
-
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::GET,
- '/v2/locations/{location_id}/transactions/{transaction_id}'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('location_id', $locationId),
- TemplateParam::init('transaction_id', $transactionId)
- );
-
- $_resHandler = $this->responseHandler()->type(RetrieveTransactionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Captures a transaction that was created with the [Charge](api-endpoint:Transactions-Charge)
- * endpoint with a `delay_capture` value of `true`.
- *
- *
- * See [Delayed capture transactions](https://developer.squareup.
- * com/docs/payments/transactions/overview#delayed-capture)
- * for more information.
- *
- * @deprecated
- *
- * @param string $locationId
- * @param string $transactionId
- *
- * @return ApiResponse Response from the API call
- */
- public function captureTransaction(string $locationId, string $transactionId): ApiResponse
- {
- trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
-
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::POST,
- '/v2/locations/{location_id}/transactions/{transaction_id}/capture'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('location_id', $locationId),
- TemplateParam::init('transaction_id', $transactionId)
- );
-
- $_resHandler = $this->responseHandler()->type(CaptureTransactionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Cancels a transaction that was created with the [Charge](api-endpoint:Transactions-Charge)
- * endpoint with a `delay_capture` value of `true`.
- *
- *
- * See [Delayed capture transactions](https://developer.squareup.
- * com/docs/payments/transactions/overview#delayed-capture)
- * for more information.
- *
- * @deprecated
- *
- * @param string $locationId
- * @param string $transactionId
- *
- * @return ApiResponse Response from the API call
- */
- public function voidTransaction(string $locationId, string $transactionId): ApiResponse
- {
- trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
-
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::POST,
- '/v2/locations/{location_id}/transactions/{transaction_id}/void'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('location_id', $locationId),
- TemplateParam::init('transaction_id', $transactionId)
- );
-
- $_resHandler = $this->responseHandler()->type(VoidTransactionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/V1TransactionsApi.php b/src/Apis/V1TransactionsApi.php
deleted file mode 100644
index 5f099029..00000000
--- a/src/Apis/V1TransactionsApi.php
+++ /dev/null
@@ -1,113 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v1/{location_id}/orders')
- ->auth('global')
- ->parameters(
- TemplateParam::init('location_id', $locationId),
- QueryParam::init('order', $order),
- QueryParam::init('limit', $limit),
- QueryParam::init('batch_token', $batchToken)
- );
-
- $_resHandler = $this->responseHandler()->type(V1Order::class, 1)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Provides comprehensive information for a single online store order, including the order's history.
- *
- * @deprecated
- *
- * @param string $locationId The ID of the order's associated location.
- * @param string $orderId The order's Square-issued ID. You obtain this value from Order objects
- * returned by the List Orders endpoint
- *
- * @return ApiResponse Response from the API call
- */
- public function v1RetrieveOrder(string $locationId, string $orderId): ApiResponse
- {
- trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
-
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v1/{location_id}/orders/{order_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('location_id', $locationId),
- TemplateParam::init('order_id', $orderId)
- );
-
- $_resHandler = $this->responseHandler()->type(V1Order::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates the details of an online store order. Every update you perform on an order corresponds to
- * one of three actions:
- *
- * @deprecated
- *
- * @param string $locationId The ID of the order's associated location.
- * @param string $orderId The order's Square-issued ID. You obtain this value from Order objects
- * returned by the List Orders endpoint
- * @param V1UpdateOrderRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function v1UpdateOrder(string $locationId, string $orderId, V1UpdateOrderRequest $body): ApiResponse
- {
- trigger_error('Method ' . __METHOD__ . ' is deprecated.', E_USER_DEPRECATED);
-
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v1/{location_id}/orders/{order_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('location_id', $locationId),
- TemplateParam::init('order_id', $orderId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(V1Order::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/VendorsApi.php b/src/Apis/VendorsApi.php
deleted file mode 100644
index fb0b6fa4..00000000
--- a/src/Apis/VendorsApi.php
+++ /dev/null
@@ -1,171 +0,0 @@
-requestBuilder(RequestMethod::POST, '/v2/vendors/bulk-create')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BulkCreateVendorsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves one or more vendors of specified [Vendor]($m/Vendor) IDs.
- *
- * @param BulkRetrieveVendorsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkRetrieveVendors(BulkRetrieveVendorsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/vendors/bulk-retrieve')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BulkRetrieveVendorsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates one or more of existing [Vendor]($m/Vendor) objects as suppliers to a seller.
- *
- * @param BulkUpdateVendorsRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function bulkUpdateVendors(BulkUpdateVendorsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/vendors/bulk-update')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(BulkUpdateVendorsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a single [Vendor]($m/Vendor) object to represent a supplier to a seller.
- *
- * @param CreateVendorRequest $body An object containing the fields to POST for the request. See
- * the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createVendor(CreateVendorRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/vendors/create')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateVendorResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Searches for vendors using a filter against supported [Vendor]($m/Vendor) properties and a supported
- * sorter.
- *
- * @param SearchVendorsRequest $body An object containing the fields to POST for the request.
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function searchVendors(SearchVendorsRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/vendors/search')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(SearchVendorsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves the vendor of a specified [Vendor]($m/Vendor) ID.
- *
- * @param string $vendorId ID of the [Vendor](entity:Vendor) to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveVendor(string $vendorId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/vendors/{vendor_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('vendor_id', $vendorId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveVendorResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates an existing [Vendor]($m/Vendor) object as a supplier to a seller.
- *
- * @param UpdateVendorRequest $body An object containing the fields to POST for the request. See
- * the corresponding object definition for field details.
- * @param string $vendorId
- *
- * @return ApiResponse Response from the API call
- */
- public function updateVendor(UpdateVendorRequest $body, string $vendorId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/vendors/{vendor_id}')
- ->auth('global')
- ->parameters(
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body),
- TemplateParam::init('vendor_id', $vendorId)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateVendorResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/Apis/WebhookSubscriptionsApi.php b/src/Apis/WebhookSubscriptionsApi.php
deleted file mode 100644
index b0ae6787..00000000
--- a/src/Apis/WebhookSubscriptionsApi.php
+++ /dev/null
@@ -1,240 +0,0 @@
-requestBuilder(RequestMethod::GET, '/v2/webhooks/event-types')
- ->auth('global')
- ->parameters(QueryParam::init('api_version', $apiVersion));
-
- $_resHandler = $this->responseHandler()->type(ListWebhookEventTypesResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Lists all webhook subscriptions owned by your application.
- *
- * @param string|null $cursor A pagination cursor returned by a previous call to this endpoint.
- * Provide this to retrieve the next set of results for your original query.
- *
- * For more information, see [Pagination](https://developer.squareup.com/docs/build-
- * basics/common-api-patterns/pagination).
- * @param bool|null $includeDisabled Includes disabled
- * [Subscription](entity:WebhookSubscription)s.
- * By default, all enabled [Subscription](entity:WebhookSubscription)s are returned.
- * @param string|null $sortOrder Sorts the returned list by when the
- * [Subscription](entity:WebhookSubscription) was created with the specified order.
- * This field defaults to ASC.
- * @param int|null $limit The maximum number of results to be returned in a single page. It is
- * possible to receive fewer results than the specified limit on a given page.
- * The default value of 100 is also the maximum allowed value.
- *
- * Default: 100
- *
- * @return ApiResponse Response from the API call
- */
- public function listWebhookSubscriptions(
- ?string $cursor = null,
- ?bool $includeDisabled = false,
- ?string $sortOrder = null,
- ?int $limit = null
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/webhooks/subscriptions')
- ->auth('global')
- ->parameters(
- QueryParam::init('cursor', $cursor),
- QueryParam::init('include_disabled', $includeDisabled),
- QueryParam::init('sort_order', $sortOrder),
- QueryParam::init('limit', $limit)
- );
-
- $_resHandler = $this->responseHandler()->type(ListWebhookSubscriptionsResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Creates a webhook subscription.
- *
- * @param CreateWebhookSubscriptionRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function createWebhookSubscription(CreateWebhookSubscriptionRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/webhooks/subscriptions')
- ->auth('global')
- ->parameters(HeaderParam::init('Content-Type', 'application/json'), BodyParam::init($body));
-
- $_resHandler = $this->responseHandler()->type(CreateWebhookSubscriptionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Deletes a webhook subscription.
- *
- * @param string $subscriptionId [REQUIRED] The ID of the
- * [Subscription](entity:WebhookSubscription) to delete.
- *
- * @return ApiResponse Response from the API call
- */
- public function deleteWebhookSubscription(string $subscriptionId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::DELETE, '/v2/webhooks/subscriptions/{subscription_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('subscription_id', $subscriptionId));
-
- $_resHandler = $this->responseHandler()->type(DeleteWebhookSubscriptionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Retrieves a webhook subscription identified by its ID.
- *
- * @param string $subscriptionId [REQUIRED] The ID of the
- * [Subscription](entity:WebhookSubscription) to retrieve.
- *
- * @return ApiResponse Response from the API call
- */
- public function retrieveWebhookSubscription(string $subscriptionId): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/webhooks/subscriptions/{subscription_id}')
- ->auth('global')
- ->parameters(TemplateParam::init('subscription_id', $subscriptionId));
-
- $_resHandler = $this->responseHandler()->type(RetrieveWebhookSubscriptionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates a webhook subscription.
- *
- * @param string $subscriptionId [REQUIRED] The ID of the
- * [Subscription](entity:WebhookSubscription) to update.
- * @param UpdateWebhookSubscriptionRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateWebhookSubscription(
- string $subscriptionId,
- UpdateWebhookSubscriptionRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(RequestMethod::PUT, '/v2/webhooks/subscriptions/{subscription_id}')
- ->auth('global')
- ->parameters(
- TemplateParam::init('subscription_id', $subscriptionId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(UpdateWebhookSubscriptionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Updates a webhook subscription by replacing the existing signature key with a new one.
- *
- * @param string $subscriptionId [REQUIRED] The ID of the
- * [Subscription](entity:WebhookSubscription) to update.
- * @param UpdateWebhookSubscriptionSignatureKeyRequest $body An object containing the fields to
- * POST for the request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function updateWebhookSubscriptionSignatureKey(
- string $subscriptionId,
- UpdateWebhookSubscriptionSignatureKeyRequest $body
- ): ApiResponse {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::POST,
- '/v2/webhooks/subscriptions/{subscription_id}/signature-key'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('subscription_id', $subscriptionId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()
- ->type(UpdateWebhookSubscriptionSignatureKeyResponse::class)
- ->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-
- /**
- * Tests a webhook subscription by sending a test event to the notification URL.
- *
- * @param string $subscriptionId [REQUIRED] The ID of the
- * [Subscription](entity:WebhookSubscription) to test.
- * @param TestWebhookSubscriptionRequest $body An object containing the fields to POST for the
- * request.
- *
- * See the corresponding object definition for field details.
- *
- * @return ApiResponse Response from the API call
- */
- public function testWebhookSubscription(string $subscriptionId, TestWebhookSubscriptionRequest $body): ApiResponse
- {
- $_reqBuilder = $this->requestBuilder(
- RequestMethod::POST,
- '/v2/webhooks/subscriptions/{subscription_id}/test'
- )
- ->auth('global')
- ->parameters(
- TemplateParam::init('subscription_id', $subscriptionId),
- HeaderParam::init('Content-Type', 'application/json'),
- BodyParam::init($body)
- );
-
- $_resHandler = $this->responseHandler()->type(TestWebhookSubscriptionResponse::class)->returnApiResponse();
-
- return $this->execute($_reqBuilder, $_resHandler);
- }
-}
diff --git a/src/ApplePay/ApplePayClient.php b/src/ApplePay/ApplePayClient.php
new file mode 100644
index 00000000..c9baba06
--- /dev/null
+++ b/src/ApplePay/ApplePayClient.php
@@ -0,0 +1,122 @@
+,
+ * } $options
+ */
+ private array $options;
+
+ /**
+ * @var RawClient $client
+ */
+ private RawClient $client;
+
+ /**
+ * @param RawClient $client
+ * @param ?array{
+ * baseUrl?: string,
+ * client?: ClientInterface,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * } $options
+ */
+ public function __construct(
+ RawClient $client,
+ ?array $options = null,
+ ) {
+ $this->client = $client;
+ $this->options = $options ?? [];
+ }
+
+ /**
+ * Activates a domain for use with Apple Pay on the Web and Square. A validation
+ * is performed on this domain by Apple to ensure that it is properly set up as
+ * an Apple Pay enabled domain.
+ *
+ * This endpoint provides an easy way for platform developers to bulk activate
+ * Apple Pay on the Web with Square for merchants using their platform.
+ *
+ * Note: You will need to host a valid domain verification file on your domain to support Apple Pay. The
+ * current version of this file is always available at https://app.squareup.com/digital-wallets/apple-pay/apple-developer-merchantid-domain-association,
+ * and should be hosted at `.well_known/apple-developer-merchantid-domain-association` on your
+ * domain. This file is subject to change; we strongly recommend checking for updates regularly and avoiding
+ * long-lived caches that might not keep in sync with the correct file version.
+ *
+ * To learn more about the Web Payments SDK and how to add Apple Pay, see [Take an Apple Pay Payment](https://developer.squareup.com/docs/web-payments/apple-pay).
+ *
+ * @param RegisterDomainRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return RegisterDomainResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function registerDomain(RegisterDomainRequest $request, ?array $options = null): RegisterDomainResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/apple-pay/domains",
+ method: HttpMethod::POST,
+ body: $request,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return RegisterDomainResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+}
diff --git a/src/ApplePay/Requests/RegisterDomainRequest.php b/src/ApplePay/Requests/RegisterDomainRequest.php
new file mode 100644
index 00000000..420f29ed
--- /dev/null
+++ b/src/ApplePay/Requests/RegisterDomainRequest.php
@@ -0,0 +1,43 @@
+domainName = $values['domainName'];
+ }
+
+ /**
+ * @return string
+ */
+ public function getDomainName(): string
+ {
+ return $this->domainName;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setDomainName(string $value): self
+ {
+ $this->domainName = $value;
+ return $this;
+ }
+}
diff --git a/src/Authentication/BearerAuthCredentialsBuilder.php b/src/Authentication/BearerAuthCredentialsBuilder.php
deleted file mode 100644
index 38c8b1ca..00000000
--- a/src/Authentication/BearerAuthCredentialsBuilder.php
+++ /dev/null
@@ -1,51 +0,0 @@
-config = $config;
- }
-
- /**
- * Initializer for BearerAuthCredentialsBuilder
- *
- * @param string $accessToken
- */
- public static function init(string $accessToken): self
- {
- return new self(['accessToken' => $accessToken]);
- }
-
- /**
- * Setter for AccessToken.
- *
- * @param string $accessToken
- *
- * @return $this
- */
- public function accessToken(string $accessToken): self
- {
- $this->config['accessToken'] = $accessToken;
- return $this;
- }
-
- public function getConfiguration(): array
- {
- return CoreHelper::clone($this->config);
- }
-}
diff --git a/src/Authentication/BearerAuthManager.php b/src/Authentication/BearerAuthManager.php
deleted file mode 100644
index 0416449d..00000000
--- a/src/Authentication/BearerAuthManager.php
+++ /dev/null
@@ -1,49 +0,0 @@
-config = $config;
- parent::__construct(
- HeaderParam::init('Authorization', CoreHelper::getBearerAuthString($this->getAccessToken()))
- ->requiredNonEmpty()
- );
- }
-
- /**
- * String value for accessToken.
- */
- public function getAccessToken(): string
- {
- return $this->config['accessToken'] ?? ConfigurationDefaults::ACCESS_TOKEN;
- }
-
- /**
- * Checks if provided credentials match with existing ones.
- *
- * @param string $accessToken The OAuth 2.0 Access Token to use for API requests.
- */
- public function equals(string $accessToken): bool
- {
- return $accessToken == $this->getAccessToken();
- }
-}
diff --git a/src/BankAccounts/BankAccountsClient.php b/src/BankAccounts/BankAccountsClient.php
new file mode 100644
index 00000000..b050feba
--- /dev/null
+++ b/src/BankAccounts/BankAccountsClient.php
@@ -0,0 +1,266 @@
+,
+ * } $options
+ */
+ private array $options;
+
+ /**
+ * @var RawClient $client
+ */
+ private RawClient $client;
+
+ /**
+ * @param RawClient $client
+ * @param ?array{
+ * baseUrl?: string,
+ * client?: ClientInterface,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * } $options
+ */
+ public function __construct(
+ RawClient $client,
+ ?array $options = null,
+ ) {
+ $this->client = $client;
+ $this->options = $options ?? [];
+ }
+
+ /**
+ * Returns a list of [BankAccount](entity:BankAccount) objects linked to a Square account.
+ *
+ * @param ListBankAccountsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return Pager
+ */
+ public function list(ListBankAccountsRequest $request = new ListBankAccountsRequest(), ?array $options = null): Pager
+ {
+ return new CursorPager(
+ request: $request,
+ getNextPage: fn (ListBankAccountsRequest $request) => $this->_list($request, $options),
+ setCursor: function (ListBankAccountsRequest $request, ?string $cursor) {
+ $request->setCursor($cursor);
+ },
+ /* @phpstan-ignore-next-line */
+ getNextCursor: fn (ListBankAccountsResponse $response) => $response?->getCursor() ?? null,
+ /* @phpstan-ignore-next-line */
+ getItems: fn (ListBankAccountsResponse $response) => $response?->getBankAccounts() ?? [],
+ );
+ }
+
+ /**
+ * Returns details of a [BankAccount](entity:BankAccount) identified by V1 bank account ID.
+ *
+ * @param GetByV1IdBankAccountsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return GetBankAccountByV1IdResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function getByV1Id(GetByV1IdBankAccountsRequest $request, ?array $options = null): GetBankAccountByV1IdResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bank-accounts/by-v1-id/{$request->getV1BankAccountId()}",
+ method: HttpMethod::GET,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return GetBankAccountByV1IdResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Returns details of a [BankAccount](entity:BankAccount)
+ * linked to a Square account.
+ *
+ * @param GetBankAccountsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return GetBankAccountResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function get(GetBankAccountsRequest $request, ?array $options = null): GetBankAccountResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bank-accounts/{$request->getBankAccountId()}",
+ method: HttpMethod::GET,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return GetBankAccountResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Returns a list of [BankAccount](entity:BankAccount) objects linked to a Square account.
+ *
+ * @param ListBankAccountsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return ListBankAccountsResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ private function _list(ListBankAccountsRequest $request = new ListBankAccountsRequest(), ?array $options = null): ListBankAccountsResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ $query = [];
+ if ($request->getCursor() != null) {
+ $query['cursor'] = $request->getCursor();
+ }
+ if ($request->getLimit() != null) {
+ $query['limit'] = $request->getLimit();
+ }
+ if ($request->getLocationId() != null) {
+ $query['location_id'] = $request->getLocationId();
+ }
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bank-accounts",
+ method: HttpMethod::GET,
+ query: $query,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return ListBankAccountsResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+}
diff --git a/src/BankAccounts/Requests/GetBankAccountsRequest.php b/src/BankAccounts/Requests/GetBankAccountsRequest.php
new file mode 100644
index 00000000..e74007da
--- /dev/null
+++ b/src/BankAccounts/Requests/GetBankAccountsRequest.php
@@ -0,0 +1,41 @@
+bankAccountId = $values['bankAccountId'];
+ }
+
+ /**
+ * @return string
+ */
+ public function getBankAccountId(): string
+ {
+ return $this->bankAccountId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setBankAccountId(string $value): self
+ {
+ $this->bankAccountId = $value;
+ return $this;
+ }
+}
diff --git a/src/BankAccounts/Requests/GetByV1IdBankAccountsRequest.php b/src/BankAccounts/Requests/GetByV1IdBankAccountsRequest.php
new file mode 100644
index 00000000..1b5e020b
--- /dev/null
+++ b/src/BankAccounts/Requests/GetByV1IdBankAccountsRequest.php
@@ -0,0 +1,44 @@
+v1BankAccountId = $values['v1BankAccountId'];
+ }
+
+ /**
+ * @return string
+ */
+ public function getV1BankAccountId(): string
+ {
+ return $this->v1BankAccountId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setV1BankAccountId(string $value): self
+ {
+ $this->v1BankAccountId = $value;
+ return $this;
+ }
+}
diff --git a/src/BankAccounts/Requests/ListBankAccountsRequest.php b/src/BankAccounts/Requests/ListBankAccountsRequest.php
new file mode 100644
index 00000000..a627afdf
--- /dev/null
+++ b/src/BankAccounts/Requests/ListBankAccountsRequest.php
@@ -0,0 +1,102 @@
+cursor = $values['cursor'] ?? null;
+ $this->limit = $values['limit'] ?? null;
+ $this->locationId = $values['locationId'] ?? null;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getCursor(): ?string
+ {
+ return $this->cursor;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setCursor(?string $value = null): self
+ {
+ $this->cursor = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?int
+ */
+ public function getLimit(): ?int
+ {
+ return $this->limit;
+ }
+
+ /**
+ * @param ?int $value
+ */
+ public function setLimit(?int $value = null): self
+ {
+ $this->limit = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getLocationId(): ?string
+ {
+ return $this->locationId;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setLocationId(?string $value = null): self
+ {
+ $this->locationId = $value;
+ return $this;
+ }
+}
diff --git a/src/BearerAuthCredentials.php b/src/BearerAuthCredentials.php
deleted file mode 100644
index 29045785..00000000
--- a/src/BearerAuthCredentials.php
+++ /dev/null
@@ -1,23 +0,0 @@
-,
+ * } $options
+ */
+ private array $options;
+
+ /**
+ * @var RawClient $client
+ */
+ private RawClient $client;
+
+ /**
+ * @param RawClient $client
+ * @param ?array{
+ * baseUrl?: string,
+ * client?: ClientInterface,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * } $options
+ */
+ public function __construct(
+ RawClient $client,
+ ?array $options = null,
+ ) {
+ $this->client = $client;
+ $this->options = $options ?? [];
+ $this->customAttributeDefinitions = new CustomAttributeDefinitionsClient($this->client, $this->options);
+ $this->customAttributes = new CustomAttributesClient($this->client, $this->options);
+ $this->locationProfiles = new LocationProfilesClient($this->client, $this->options);
+ $this->teamMemberProfiles = new TeamMemberProfilesClient($this->client, $this->options);
+ }
+
+ /**
+ * Retrieve a collection of bookings.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
+ *
+ * @param ListBookingsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return Pager
+ */
+ public function list(ListBookingsRequest $request = new ListBookingsRequest(), ?array $options = null): Pager
+ {
+ return new CursorPager(
+ request: $request,
+ getNextPage: fn (ListBookingsRequest $request) => $this->_list($request, $options),
+ setCursor: function (ListBookingsRequest $request, ?string $cursor) {
+ $request->setCursor($cursor);
+ },
+ /* @phpstan-ignore-next-line */
+ getNextCursor: fn (ListBookingsResponse $response) => $response?->getCursor() ?? null,
+ /* @phpstan-ignore-next-line */
+ getItems: fn (ListBookingsResponse $response) => $response?->getBookings() ?? [],
+ );
+ }
+
+ /**
+ * Creates a booking.
+ *
+ * The required input must include the following:
+ * - `Booking.location_id`
+ * - `Booking.start_at`
+ * - `Booking.AppointmentSegment.team_member_id`
+ * - `Booking.AppointmentSegment.service_variation_id`
+ * - `Booking.AppointmentSegment.service_variation_version`
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+ *
+ * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*
+ * or *Appointments Premium*.
+ *
+ * @param CreateBookingRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return CreateBookingResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function create(CreateBookingRequest $request, ?array $options = null): CreateBookingResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings",
+ method: HttpMethod::POST,
+ body: $request,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return CreateBookingResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Searches for availabilities for booking.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
+ *
+ * @param SearchAvailabilityRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return SearchAvailabilityResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function searchAvailability(SearchAvailabilityRequest $request, ?array $options = null): SearchAvailabilityResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/availability/search",
+ method: HttpMethod::POST,
+ body: $request,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return SearchAvailabilityResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Bulk-Retrieves a list of bookings by booking IDs.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
+ *
+ * @param BulkRetrieveBookingsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return BulkRetrieveBookingsResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function bulkRetrieveBookings(BulkRetrieveBookingsRequest $request, ?array $options = null): BulkRetrieveBookingsResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/bulk-retrieve",
+ method: HttpMethod::POST,
+ body: $request,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return BulkRetrieveBookingsResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Retrieves a seller's booking profile.
+ *
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return GetBusinessBookingProfileResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function getBusinessProfile(?array $options = null): GetBusinessBookingProfileResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/business-booking-profile",
+ method: HttpMethod::GET,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return GetBusinessBookingProfileResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Retrieves a seller's location booking profile.
+ *
+ * @param RetrieveLocationBookingProfileRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return RetrieveLocationBookingProfileResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function retrieveLocationBookingProfile(RetrieveLocationBookingProfileRequest $request, ?array $options = null): RetrieveLocationBookingProfileResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/location-booking-profiles/{$request->getLocationId()}",
+ method: HttpMethod::GET,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return RetrieveLocationBookingProfileResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Retrieves one or more team members' booking profiles.
+ *
+ * @param BulkRetrieveTeamMemberBookingProfilesRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return BulkRetrieveTeamMemberBookingProfilesResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function bulkRetrieveTeamMemberBookingProfiles(BulkRetrieveTeamMemberBookingProfilesRequest $request, ?array $options = null): BulkRetrieveTeamMemberBookingProfilesResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/team-member-booking-profiles/bulk-retrieve",
+ method: HttpMethod::POST,
+ body: $request,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return BulkRetrieveTeamMemberBookingProfilesResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Retrieves a booking.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
+ *
+ * @param GetBookingsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return GetBookingResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function get(GetBookingsRequest $request, ?array $options = null): GetBookingResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/{$request->getBookingId()}",
+ method: HttpMethod::GET,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return GetBookingResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Updates a booking.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+ *
+ * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*
+ * or *Appointments Premium*.
+ *
+ * @param UpdateBookingRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return UpdateBookingResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function update(UpdateBookingRequest $request, ?array $options = null): UpdateBookingResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/{$request->getBookingId()}",
+ method: HttpMethod::PUT,
+ body: $request,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return UpdateBookingResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Cancels an existing booking.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+ *
+ * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*
+ * or *Appointments Premium*.
+ *
+ * @param CancelBookingRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return CancelBookingResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function cancel(CancelBookingRequest $request, ?array $options = null): CancelBookingResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/{$request->getBookingId()}/cancel",
+ method: HttpMethod::POST,
+ body: $request,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return CancelBookingResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Retrieve a collection of bookings.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
+ *
+ * @param ListBookingsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return ListBookingsResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ private function _list(ListBookingsRequest $request = new ListBookingsRequest(), ?array $options = null): ListBookingsResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ $query = [];
+ if ($request->getLimit() != null) {
+ $query['limit'] = $request->getLimit();
+ }
+ if ($request->getCursor() != null) {
+ $query['cursor'] = $request->getCursor();
+ }
+ if ($request->getCustomerId() != null) {
+ $query['customer_id'] = $request->getCustomerId();
+ }
+ if ($request->getTeamMemberId() != null) {
+ $query['team_member_id'] = $request->getTeamMemberId();
+ }
+ if ($request->getLocationId() != null) {
+ $query['location_id'] = $request->getLocationId();
+ }
+ if ($request->getStartAtMin() != null) {
+ $query['start_at_min'] = $request->getStartAtMin();
+ }
+ if ($request->getStartAtMax() != null) {
+ $query['start_at_max'] = $request->getStartAtMax();
+ }
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings",
+ method: HttpMethod::GET,
+ query: $query,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return ListBookingsResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+}
diff --git a/src/Bookings/CustomAttributeDefinitions/CustomAttributeDefinitionsClient.php b/src/Bookings/CustomAttributeDefinitions/CustomAttributeDefinitionsClient.php
new file mode 100644
index 00000000..f2cf45bf
--- /dev/null
+++ b/src/Bookings/CustomAttributeDefinitions/CustomAttributeDefinitionsClient.php
@@ -0,0 +1,410 @@
+,
+ * } $options
+ */
+ private array $options;
+
+ /**
+ * @var RawClient $client
+ */
+ private RawClient $client;
+
+ /**
+ * @param RawClient $client
+ * @param ?array{
+ * baseUrl?: string,
+ * client?: ClientInterface,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * } $options
+ */
+ public function __construct(
+ RawClient $client,
+ ?array $options = null,
+ ) {
+ $this->client = $client;
+ $this->options = $options ?? [];
+ }
+
+ /**
+ * Get all bookings custom attribute definitions.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
+ *
+ * @param ListCustomAttributeDefinitionsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return Pager
+ */
+ public function list(ListCustomAttributeDefinitionsRequest $request = new ListCustomAttributeDefinitionsRequest(), ?array $options = null): Pager
+ {
+ return new CursorPager(
+ request: $request,
+ getNextPage: fn (ListCustomAttributeDefinitionsRequest $request) => $this->_list($request, $options),
+ setCursor: function (ListCustomAttributeDefinitionsRequest $request, ?string $cursor) {
+ $request->setCursor($cursor);
+ },
+ /* @phpstan-ignore-next-line */
+ getNextCursor: fn (ListBookingCustomAttributeDefinitionsResponse $response) => $response?->getCursor() ?? null,
+ /* @phpstan-ignore-next-line */
+ getItems: fn (ListBookingCustomAttributeDefinitionsResponse $response) => $response?->getCustomAttributeDefinitions() ?? [],
+ );
+ }
+
+ /**
+ * Creates a bookings custom attribute definition.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+ *
+ * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*
+ * or *Appointments Premium*.
+ *
+ * @param CreateBookingCustomAttributeDefinitionRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return CreateBookingCustomAttributeDefinitionResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function create(CreateBookingCustomAttributeDefinitionRequest $request, ?array $options = null): CreateBookingCustomAttributeDefinitionResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/custom-attribute-definitions",
+ method: HttpMethod::POST,
+ body: $request,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return CreateBookingCustomAttributeDefinitionResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Retrieves a bookings custom attribute definition.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
+ *
+ * @param GetCustomAttributeDefinitionsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return RetrieveBookingCustomAttributeDefinitionResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function get(GetCustomAttributeDefinitionsRequest $request, ?array $options = null): RetrieveBookingCustomAttributeDefinitionResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ $query = [];
+ if ($request->getVersion() != null) {
+ $query['version'] = $request->getVersion();
+ }
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/custom-attribute-definitions/{$request->getKey()}",
+ method: HttpMethod::GET,
+ query: $query,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return RetrieveBookingCustomAttributeDefinitionResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Updates a bookings custom attribute definition.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+ *
+ * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*
+ * or *Appointments Premium*.
+ *
+ * @param UpdateBookingCustomAttributeDefinitionRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return UpdateBookingCustomAttributeDefinitionResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function update(UpdateBookingCustomAttributeDefinitionRequest $request, ?array $options = null): UpdateBookingCustomAttributeDefinitionResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/custom-attribute-definitions/{$request->getKey()}",
+ method: HttpMethod::PUT,
+ body: $request,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return UpdateBookingCustomAttributeDefinitionResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Deletes a bookings custom attribute definition.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+ *
+ * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*
+ * or *Appointments Premium*.
+ *
+ * @param DeleteCustomAttributeDefinitionsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return DeleteBookingCustomAttributeDefinitionResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function delete(DeleteCustomAttributeDefinitionsRequest $request, ?array $options = null): DeleteBookingCustomAttributeDefinitionResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/custom-attribute-definitions/{$request->getKey()}",
+ method: HttpMethod::DELETE,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return DeleteBookingCustomAttributeDefinitionResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Get all bookings custom attribute definitions.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
+ *
+ * @param ListCustomAttributeDefinitionsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return ListBookingCustomAttributeDefinitionsResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ private function _list(ListCustomAttributeDefinitionsRequest $request = new ListCustomAttributeDefinitionsRequest(), ?array $options = null): ListBookingCustomAttributeDefinitionsResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ $query = [];
+ if ($request->getLimit() != null) {
+ $query['limit'] = $request->getLimit();
+ }
+ if ($request->getCursor() != null) {
+ $query['cursor'] = $request->getCursor();
+ }
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/custom-attribute-definitions",
+ method: HttpMethod::GET,
+ query: $query,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return ListBookingCustomAttributeDefinitionsResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+}
diff --git a/src/Bookings/CustomAttributeDefinitions/Requests/CreateBookingCustomAttributeDefinitionRequest.php b/src/Bookings/CustomAttributeDefinitions/Requests/CreateBookingCustomAttributeDefinitionRequest.php
new file mode 100644
index 00000000..09760d6f
--- /dev/null
+++ b/src/Bookings/CustomAttributeDefinitions/Requests/CreateBookingCustomAttributeDefinitionRequest.php
@@ -0,0 +1,88 @@
+customAttributeDefinition = $values['customAttributeDefinition'];
+ $this->idempotencyKey = $values['idempotencyKey'] ?? null;
+ }
+
+ /**
+ * @return CustomAttributeDefinition
+ */
+ public function getCustomAttributeDefinition(): CustomAttributeDefinition
+ {
+ return $this->customAttributeDefinition;
+ }
+
+ /**
+ * @param CustomAttributeDefinition $value
+ */
+ public function setCustomAttributeDefinition(CustomAttributeDefinition $value): self
+ {
+ $this->customAttributeDefinition = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getIdempotencyKey(): ?string
+ {
+ return $this->idempotencyKey;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setIdempotencyKey(?string $value = null): self
+ {
+ $this->idempotencyKey = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/CustomAttributeDefinitions/Requests/DeleteCustomAttributeDefinitionsRequest.php b/src/Bookings/CustomAttributeDefinitions/Requests/DeleteCustomAttributeDefinitionsRequest.php
new file mode 100644
index 00000000..3e8c7754
--- /dev/null
+++ b/src/Bookings/CustomAttributeDefinitions/Requests/DeleteCustomAttributeDefinitionsRequest.php
@@ -0,0 +1,41 @@
+key = $values['key'];
+ }
+
+ /**
+ * @return string
+ */
+ public function getKey(): string
+ {
+ return $this->key;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setKey(string $value): self
+ {
+ $this->key = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/CustomAttributeDefinitions/Requests/GetCustomAttributeDefinitionsRequest.php b/src/Bookings/CustomAttributeDefinitions/Requests/GetCustomAttributeDefinitionsRequest.php
new file mode 100644
index 00000000..5040e4d4
--- /dev/null
+++ b/src/Bookings/CustomAttributeDefinitions/Requests/GetCustomAttributeDefinitionsRequest.php
@@ -0,0 +1,73 @@
+key = $values['key'];
+ $this->version = $values['version'] ?? null;
+ }
+
+ /**
+ * @return string
+ */
+ public function getKey(): string
+ {
+ return $this->key;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setKey(string $value): self
+ {
+ $this->key = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?int
+ */
+ public function getVersion(): ?int
+ {
+ return $this->version;
+ }
+
+ /**
+ * @param ?int $value
+ */
+ public function setVersion(?int $value = null): self
+ {
+ $this->version = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/CustomAttributeDefinitions/Requests/ListCustomAttributeDefinitionsRequest.php b/src/Bookings/CustomAttributeDefinitions/Requests/ListCustomAttributeDefinitionsRequest.php
new file mode 100644
index 00000000..59c44c9b
--- /dev/null
+++ b/src/Bookings/CustomAttributeDefinitions/Requests/ListCustomAttributeDefinitionsRequest.php
@@ -0,0 +1,73 @@
+limit = $values['limit'] ?? null;
+ $this->cursor = $values['cursor'] ?? null;
+ }
+
+ /**
+ * @return ?int
+ */
+ public function getLimit(): ?int
+ {
+ return $this->limit;
+ }
+
+ /**
+ * @param ?int $value
+ */
+ public function setLimit(?int $value = null): self
+ {
+ $this->limit = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getCursor(): ?string
+ {
+ return $this->cursor;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setCursor(?string $value = null): self
+ {
+ $this->cursor = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/CustomAttributeDefinitions/Requests/UpdateBookingCustomAttributeDefinitionRequest.php b/src/Bookings/CustomAttributeDefinitions/Requests/UpdateBookingCustomAttributeDefinitionRequest.php
new file mode 100644
index 00000000..66edb7b5
--- /dev/null
+++ b/src/Bookings/CustomAttributeDefinitions/Requests/UpdateBookingCustomAttributeDefinitionRequest.php
@@ -0,0 +1,109 @@
+key = $values['key'];
+ $this->customAttributeDefinition = $values['customAttributeDefinition'];
+ $this->idempotencyKey = $values['idempotencyKey'] ?? null;
+ }
+
+ /**
+ * @return string
+ */
+ public function getKey(): string
+ {
+ return $this->key;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setKey(string $value): self
+ {
+ $this->key = $value;
+ return $this;
+ }
+
+ /**
+ * @return CustomAttributeDefinition
+ */
+ public function getCustomAttributeDefinition(): CustomAttributeDefinition
+ {
+ return $this->customAttributeDefinition;
+ }
+
+ /**
+ * @param CustomAttributeDefinition $value
+ */
+ public function setCustomAttributeDefinition(CustomAttributeDefinition $value): self
+ {
+ $this->customAttributeDefinition = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getIdempotencyKey(): ?string
+ {
+ return $this->idempotencyKey;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setIdempotencyKey(?string $value = null): self
+ {
+ $this->idempotencyKey = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/CustomAttributes/CustomAttributesClient.php b/src/Bookings/CustomAttributes/CustomAttributesClient.php
new file mode 100644
index 00000000..0c5fbacb
--- /dev/null
+++ b/src/Bookings/CustomAttributes/CustomAttributesClient.php
@@ -0,0 +1,480 @@
+,
+ * } $options
+ */
+ private array $options;
+
+ /**
+ * @var RawClient $client
+ */
+ private RawClient $client;
+
+ /**
+ * @param RawClient $client
+ * @param ?array{
+ * baseUrl?: string,
+ * client?: ClientInterface,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * } $options
+ */
+ public function __construct(
+ RawClient $client,
+ ?array $options = null,
+ ) {
+ $this->client = $client;
+ $this->options = $options ?? [];
+ }
+
+ /**
+ * Bulk deletes bookings custom attributes.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+ *
+ * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*
+ * or *Appointments Premium*.
+ *
+ * @param BulkDeleteBookingCustomAttributesRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return BulkDeleteBookingCustomAttributesResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function batchDelete(BulkDeleteBookingCustomAttributesRequest $request, ?array $options = null): BulkDeleteBookingCustomAttributesResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/custom-attributes/bulk-delete",
+ method: HttpMethod::POST,
+ body: $request,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return BulkDeleteBookingCustomAttributesResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Bulk upserts bookings custom attributes.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+ *
+ * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*
+ * or *Appointments Premium*.
+ *
+ * @param BulkUpsertBookingCustomAttributesRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return BulkUpsertBookingCustomAttributesResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function batchUpsert(BulkUpsertBookingCustomAttributesRequest $request, ?array $options = null): BulkUpsertBookingCustomAttributesResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/custom-attributes/bulk-upsert",
+ method: HttpMethod::POST,
+ body: $request,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return BulkUpsertBookingCustomAttributesResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Lists a booking's custom attributes.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
+ *
+ * @param ListCustomAttributesRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return Pager
+ */
+ public function list(ListCustomAttributesRequest $request, ?array $options = null): Pager
+ {
+ return new CursorPager(
+ request: $request,
+ getNextPage: fn (ListCustomAttributesRequest $request) => $this->_list($request, $options),
+ setCursor: function (ListCustomAttributesRequest $request, ?string $cursor) {
+ $request->setCursor($cursor);
+ },
+ /* @phpstan-ignore-next-line */
+ getNextCursor: fn (ListBookingCustomAttributesResponse $response) => $response?->getCursor() ?? null,
+ /* @phpstan-ignore-next-line */
+ getItems: fn (ListBookingCustomAttributesResponse $response) => $response?->getCustomAttributes() ?? [],
+ );
+ }
+
+ /**
+ * Retrieves a bookings custom attribute.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
+ *
+ * @param GetCustomAttributesRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return RetrieveBookingCustomAttributeResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function get(GetCustomAttributesRequest $request, ?array $options = null): RetrieveBookingCustomAttributeResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ $query = [];
+ if ($request->getWithDefinition() != null) {
+ $query['with_definition'] = $request->getWithDefinition();
+ }
+ if ($request->getVersion() != null) {
+ $query['version'] = $request->getVersion();
+ }
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/{$request->getBookingId()}/custom-attributes/{$request->getKey()}",
+ method: HttpMethod::GET,
+ query: $query,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return RetrieveBookingCustomAttributeResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Upserts a bookings custom attribute.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+ *
+ * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*
+ * or *Appointments Premium*.
+ *
+ * @param UpsertBookingCustomAttributeRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return UpsertBookingCustomAttributeResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function upsert(UpsertBookingCustomAttributeRequest $request, ?array $options = null): UpsertBookingCustomAttributeResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/{$request->getBookingId()}/custom-attributes/{$request->getKey()}",
+ method: HttpMethod::PUT,
+ body: $request,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return UpsertBookingCustomAttributeResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Deletes a bookings custom attribute.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_WRITE` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_WRITE` and `APPOINTMENTS_WRITE` for the OAuth scope.
+ *
+ * For calls to this endpoint with seller-level permissions to succeed, the seller must have subscribed to *Appointments Plus*
+ * or *Appointments Premium*.
+ *
+ * @param DeleteCustomAttributesRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return DeleteBookingCustomAttributeResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function delete(DeleteCustomAttributesRequest $request, ?array $options = null): DeleteBookingCustomAttributeResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/{$request->getBookingId()}/custom-attributes/{$request->getKey()}",
+ method: HttpMethod::DELETE,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return DeleteBookingCustomAttributeResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Lists a booking's custom attributes.
+ *
+ * To call this endpoint with buyer-level permissions, set `APPOINTMENTS_READ` for the OAuth scope.
+ * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and `APPOINTMENTS_READ` for the OAuth scope.
+ *
+ * @param ListCustomAttributesRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return ListBookingCustomAttributesResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ private function _list(ListCustomAttributesRequest $request, ?array $options = null): ListBookingCustomAttributesResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ $query = [];
+ if ($request->getLimit() != null) {
+ $query['limit'] = $request->getLimit();
+ }
+ if ($request->getCursor() != null) {
+ $query['cursor'] = $request->getCursor();
+ }
+ if ($request->getWithDefinitions() != null) {
+ $query['with_definitions'] = $request->getWithDefinitions();
+ }
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/{$request->getBookingId()}/custom-attributes",
+ method: HttpMethod::GET,
+ query: $query,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return ListBookingCustomAttributesResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+}
diff --git a/src/Bookings/CustomAttributes/Requests/BulkDeleteBookingCustomAttributesRequest.php b/src/Bookings/CustomAttributes/Requests/BulkDeleteBookingCustomAttributesRequest.php
new file mode 100644
index 00000000..7c07711d
--- /dev/null
+++ b/src/Bookings/CustomAttributes/Requests/BulkDeleteBookingCustomAttributesRequest.php
@@ -0,0 +1,49 @@
+ $values
+ */
+ #[JsonProperty('values'), ArrayType(['string' => BookingCustomAttributeDeleteRequest::class])]
+ private array $values;
+
+ /**
+ * @param array{
+ * values: array,
+ * } $values
+ */
+ public function __construct(
+ array $values,
+ ) {
+ $this->values = $values['values'];
+ }
+
+ /**
+ * @return array
+ */
+ public function getValues(): array
+ {
+ return $this->values;
+ }
+
+ /**
+ * @param array $value
+ */
+ public function setValues(array $value): self
+ {
+ $this->values = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/CustomAttributes/Requests/BulkUpsertBookingCustomAttributesRequest.php b/src/Bookings/CustomAttributes/Requests/BulkUpsertBookingCustomAttributesRequest.php
new file mode 100644
index 00000000..524a8e00
--- /dev/null
+++ b/src/Bookings/CustomAttributes/Requests/BulkUpsertBookingCustomAttributesRequest.php
@@ -0,0 +1,49 @@
+ $values
+ */
+ #[JsonProperty('values'), ArrayType(['string' => BookingCustomAttributeUpsertRequest::class])]
+ private array $values;
+
+ /**
+ * @param array{
+ * values: array,
+ * } $values
+ */
+ public function __construct(
+ array $values,
+ ) {
+ $this->values = $values['values'];
+ }
+
+ /**
+ * @return array
+ */
+ public function getValues(): array
+ {
+ return $this->values;
+ }
+
+ /**
+ * @param array $value
+ */
+ public function setValues(array $value): self
+ {
+ $this->values = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/CustomAttributes/Requests/DeleteCustomAttributesRequest.php b/src/Bookings/CustomAttributes/Requests/DeleteCustomAttributesRequest.php
new file mode 100644
index 00000000..b3568a70
--- /dev/null
+++ b/src/Bookings/CustomAttributes/Requests/DeleteCustomAttributesRequest.php
@@ -0,0 +1,69 @@
+bookingId = $values['bookingId'];
+ $this->key = $values['key'];
+ }
+
+ /**
+ * @return string
+ */
+ public function getBookingId(): string
+ {
+ return $this->bookingId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setBookingId(string $value): self
+ {
+ $this->bookingId = $value;
+ return $this;
+ }
+
+ /**
+ * @return string
+ */
+ public function getKey(): string
+ {
+ return $this->key;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setKey(string $value): self
+ {
+ $this->key = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/CustomAttributes/Requests/GetCustomAttributesRequest.php b/src/Bookings/CustomAttributes/Requests/GetCustomAttributesRequest.php
new file mode 100644
index 00000000..a3fe3f1d
--- /dev/null
+++ b/src/Bookings/CustomAttributes/Requests/GetCustomAttributesRequest.php
@@ -0,0 +1,126 @@
+bookingId = $values['bookingId'];
+ $this->key = $values['key'];
+ $this->withDefinition = $values['withDefinition'] ?? null;
+ $this->version = $values['version'] ?? null;
+ }
+
+ /**
+ * @return string
+ */
+ public function getBookingId(): string
+ {
+ return $this->bookingId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setBookingId(string $value): self
+ {
+ $this->bookingId = $value;
+ return $this;
+ }
+
+ /**
+ * @return string
+ */
+ public function getKey(): string
+ {
+ return $this->key;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setKey(string $value): self
+ {
+ $this->key = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?bool
+ */
+ public function getWithDefinition(): ?bool
+ {
+ return $this->withDefinition;
+ }
+
+ /**
+ * @param ?bool $value
+ */
+ public function setWithDefinition(?bool $value = null): self
+ {
+ $this->withDefinition = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?int
+ */
+ public function getVersion(): ?int
+ {
+ return $this->version;
+ }
+
+ /**
+ * @param ?int $value
+ */
+ public function setVersion(?int $value = null): self
+ {
+ $this->version = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/CustomAttributes/Requests/ListCustomAttributesRequest.php b/src/Bookings/CustomAttributes/Requests/ListCustomAttributesRequest.php
new file mode 100644
index 00000000..0e514c4f
--- /dev/null
+++ b/src/Bookings/CustomAttributes/Requests/ListCustomAttributesRequest.php
@@ -0,0 +1,125 @@
+bookingId = $values['bookingId'];
+ $this->limit = $values['limit'] ?? null;
+ $this->cursor = $values['cursor'] ?? null;
+ $this->withDefinitions = $values['withDefinitions'] ?? null;
+ }
+
+ /**
+ * @return string
+ */
+ public function getBookingId(): string
+ {
+ return $this->bookingId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setBookingId(string $value): self
+ {
+ $this->bookingId = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?int
+ */
+ public function getLimit(): ?int
+ {
+ return $this->limit;
+ }
+
+ /**
+ * @param ?int $value
+ */
+ public function setLimit(?int $value = null): self
+ {
+ $this->limit = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getCursor(): ?string
+ {
+ return $this->cursor;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setCursor(?string $value = null): self
+ {
+ $this->cursor = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?bool
+ */
+ public function getWithDefinitions(): ?bool
+ {
+ return $this->withDefinitions;
+ }
+
+ /**
+ * @param ?bool $value
+ */
+ public function setWithDefinitions(?bool $value = null): self
+ {
+ $this->withDefinitions = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/CustomAttributes/Requests/UpsertBookingCustomAttributeRequest.php b/src/Bookings/CustomAttributes/Requests/UpsertBookingCustomAttributeRequest.php
new file mode 100644
index 00000000..3d2a4941
--- /dev/null
+++ b/src/Bookings/CustomAttributes/Requests/UpsertBookingCustomAttributeRequest.php
@@ -0,0 +1,133 @@
+bookingId = $values['bookingId'];
+ $this->key = $values['key'];
+ $this->customAttribute = $values['customAttribute'];
+ $this->idempotencyKey = $values['idempotencyKey'] ?? null;
+ }
+
+ /**
+ * @return string
+ */
+ public function getBookingId(): string
+ {
+ return $this->bookingId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setBookingId(string $value): self
+ {
+ $this->bookingId = $value;
+ return $this;
+ }
+
+ /**
+ * @return string
+ */
+ public function getKey(): string
+ {
+ return $this->key;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setKey(string $value): self
+ {
+ $this->key = $value;
+ return $this;
+ }
+
+ /**
+ * @return CustomAttribute
+ */
+ public function getCustomAttribute(): CustomAttribute
+ {
+ return $this->customAttribute;
+ }
+
+ /**
+ * @param CustomAttribute $value
+ */
+ public function setCustomAttribute(CustomAttribute $value): self
+ {
+ $this->customAttribute = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getIdempotencyKey(): ?string
+ {
+ return $this->idempotencyKey;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setIdempotencyKey(?string $value = null): self
+ {
+ $this->idempotencyKey = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/LocationProfiles/LocationProfilesClient.php b/src/Bookings/LocationProfiles/LocationProfilesClient.php
new file mode 100644
index 00000000..ec6a8366
--- /dev/null
+++ b/src/Bookings/LocationProfiles/LocationProfilesClient.php
@@ -0,0 +1,148 @@
+,
+ * } $options
+ */
+ private array $options;
+
+ /**
+ * @var RawClient $client
+ */
+ private RawClient $client;
+
+ /**
+ * @param RawClient $client
+ * @param ?array{
+ * baseUrl?: string,
+ * client?: ClientInterface,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * } $options
+ */
+ public function __construct(
+ RawClient $client,
+ ?array $options = null,
+ ) {
+ $this->client = $client;
+ $this->options = $options ?? [];
+ }
+
+ /**
+ * Lists location booking profiles of a seller.
+ *
+ * @param ListLocationProfilesRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return Pager
+ */
+ public function list(ListLocationProfilesRequest $request = new ListLocationProfilesRequest(), ?array $options = null): Pager
+ {
+ return new CursorPager(
+ request: $request,
+ getNextPage: fn (ListLocationProfilesRequest $request) => $this->_list($request, $options),
+ setCursor: function (ListLocationProfilesRequest $request, ?string $cursor) {
+ $request->setCursor($cursor);
+ },
+ /* @phpstan-ignore-next-line */
+ getNextCursor: fn (ListLocationBookingProfilesResponse $response) => $response?->getCursor() ?? null,
+ /* @phpstan-ignore-next-line */
+ getItems: fn (ListLocationBookingProfilesResponse $response) => $response?->getLocationBookingProfiles() ?? [],
+ );
+ }
+
+ /**
+ * Lists location booking profiles of a seller.
+ *
+ * @param ListLocationProfilesRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return ListLocationBookingProfilesResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ private function _list(ListLocationProfilesRequest $request = new ListLocationProfilesRequest(), ?array $options = null): ListLocationBookingProfilesResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ $query = [];
+ if ($request->getLimit() != null) {
+ $query['limit'] = $request->getLimit();
+ }
+ if ($request->getCursor() != null) {
+ $query['cursor'] = $request->getCursor();
+ }
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/location-booking-profiles",
+ method: HttpMethod::GET,
+ query: $query,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return ListLocationBookingProfilesResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+}
diff --git a/src/Bookings/LocationProfiles/Requests/ListLocationProfilesRequest.php b/src/Bookings/LocationProfiles/Requests/ListLocationProfilesRequest.php
new file mode 100644
index 00000000..560c67af
--- /dev/null
+++ b/src/Bookings/LocationProfiles/Requests/ListLocationProfilesRequest.php
@@ -0,0 +1,65 @@
+limit = $values['limit'] ?? null;
+ $this->cursor = $values['cursor'] ?? null;
+ }
+
+ /**
+ * @return ?int
+ */
+ public function getLimit(): ?int
+ {
+ return $this->limit;
+ }
+
+ /**
+ * @param ?int $value
+ */
+ public function setLimit(?int $value = null): self
+ {
+ $this->limit = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getCursor(): ?string
+ {
+ return $this->cursor;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setCursor(?string $value = null): self
+ {
+ $this->cursor = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/Requests/BulkRetrieveBookingsRequest.php b/src/Bookings/Requests/BulkRetrieveBookingsRequest.php
new file mode 100644
index 00000000..d60b3ad7
--- /dev/null
+++ b/src/Bookings/Requests/BulkRetrieveBookingsRequest.php
@@ -0,0 +1,44 @@
+ $bookingIds A non-empty list of [Booking](entity:Booking) IDs specifying bookings to retrieve.
+ */
+ #[JsonProperty('booking_ids'), ArrayType(['string'])]
+ private array $bookingIds;
+
+ /**
+ * @param array{
+ * bookingIds: array,
+ * } $values
+ */
+ public function __construct(
+ array $values,
+ ) {
+ $this->bookingIds = $values['bookingIds'];
+ }
+
+ /**
+ * @return array
+ */
+ public function getBookingIds(): array
+ {
+ return $this->bookingIds;
+ }
+
+ /**
+ * @param array $value
+ */
+ public function setBookingIds(array $value): self
+ {
+ $this->bookingIds = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/Requests/BulkRetrieveTeamMemberBookingProfilesRequest.php b/src/Bookings/Requests/BulkRetrieveTeamMemberBookingProfilesRequest.php
new file mode 100644
index 00000000..e953cda6
--- /dev/null
+++ b/src/Bookings/Requests/BulkRetrieveTeamMemberBookingProfilesRequest.php
@@ -0,0 +1,44 @@
+ $teamMemberIds A non-empty list of IDs of team members whose booking profiles you want to retrieve.
+ */
+ #[JsonProperty('team_member_ids'), ArrayType(['string'])]
+ private array $teamMemberIds;
+
+ /**
+ * @param array{
+ * teamMemberIds: array,
+ * } $values
+ */
+ public function __construct(
+ array $values,
+ ) {
+ $this->teamMemberIds = $values['teamMemberIds'];
+ }
+
+ /**
+ * @return array
+ */
+ public function getTeamMemberIds(): array
+ {
+ return $this->teamMemberIds;
+ }
+
+ /**
+ * @param array $value
+ */
+ public function setTeamMemberIds(array $value): self
+ {
+ $this->teamMemberIds = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/Requests/CancelBookingRequest.php b/src/Bookings/Requests/CancelBookingRequest.php
new file mode 100644
index 00000000..62c29d96
--- /dev/null
+++ b/src/Bookings/Requests/CancelBookingRequest.php
@@ -0,0 +1,92 @@
+bookingId = $values['bookingId'];
+ $this->idempotencyKey = $values['idempotencyKey'] ?? null;
+ $this->bookingVersion = $values['bookingVersion'] ?? null;
+ }
+
+ /**
+ * @return string
+ */
+ public function getBookingId(): string
+ {
+ return $this->bookingId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setBookingId(string $value): self
+ {
+ $this->bookingId = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getIdempotencyKey(): ?string
+ {
+ return $this->idempotencyKey;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setIdempotencyKey(?string $value = null): self
+ {
+ $this->idempotencyKey = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?int
+ */
+ public function getBookingVersion(): ?int
+ {
+ return $this->bookingVersion;
+ }
+
+ /**
+ * @param ?int $value
+ */
+ public function setBookingVersion(?int $value = null): self
+ {
+ $this->bookingVersion = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/Requests/CreateBookingRequest.php b/src/Bookings/Requests/CreateBookingRequest.php
new file mode 100644
index 00000000..8b17d6fe
--- /dev/null
+++ b/src/Bookings/Requests/CreateBookingRequest.php
@@ -0,0 +1,69 @@
+idempotencyKey = $values['idempotencyKey'] ?? null;
+ $this->booking = $values['booking'];
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getIdempotencyKey(): ?string
+ {
+ return $this->idempotencyKey;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setIdempotencyKey(?string $value = null): self
+ {
+ $this->idempotencyKey = $value;
+ return $this;
+ }
+
+ /**
+ * @return Booking
+ */
+ public function getBooking(): Booking
+ {
+ return $this->booking;
+ }
+
+ /**
+ * @param Booking $value
+ */
+ public function setBooking(Booking $value): self
+ {
+ $this->booking = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/Requests/GetBookingsRequest.php b/src/Bookings/Requests/GetBookingsRequest.php
new file mode 100644
index 00000000..95634c1e
--- /dev/null
+++ b/src/Bookings/Requests/GetBookingsRequest.php
@@ -0,0 +1,41 @@
+bookingId = $values['bookingId'];
+ }
+
+ /**
+ * @return string
+ */
+ public function getBookingId(): string
+ {
+ return $this->bookingId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setBookingId(string $value): self
+ {
+ $this->bookingId = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/Requests/ListBookingsRequest.php b/src/Bookings/Requests/ListBookingsRequest.php
new file mode 100644
index 00000000..a585b3ed
--- /dev/null
+++ b/src/Bookings/Requests/ListBookingsRequest.php
@@ -0,0 +1,185 @@
+limit = $values['limit'] ?? null;
+ $this->cursor = $values['cursor'] ?? null;
+ $this->customerId = $values['customerId'] ?? null;
+ $this->teamMemberId = $values['teamMemberId'] ?? null;
+ $this->locationId = $values['locationId'] ?? null;
+ $this->startAtMin = $values['startAtMin'] ?? null;
+ $this->startAtMax = $values['startAtMax'] ?? null;
+ }
+
+ /**
+ * @return ?int
+ */
+ public function getLimit(): ?int
+ {
+ return $this->limit;
+ }
+
+ /**
+ * @param ?int $value
+ */
+ public function setLimit(?int $value = null): self
+ {
+ $this->limit = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getCursor(): ?string
+ {
+ return $this->cursor;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setCursor(?string $value = null): self
+ {
+ $this->cursor = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getCustomerId(): ?string
+ {
+ return $this->customerId;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setCustomerId(?string $value = null): self
+ {
+ $this->customerId = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getTeamMemberId(): ?string
+ {
+ return $this->teamMemberId;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setTeamMemberId(?string $value = null): self
+ {
+ $this->teamMemberId = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getLocationId(): ?string
+ {
+ return $this->locationId;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setLocationId(?string $value = null): self
+ {
+ $this->locationId = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getStartAtMin(): ?string
+ {
+ return $this->startAtMin;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setStartAtMin(?string $value = null): self
+ {
+ $this->startAtMin = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getStartAtMax(): ?string
+ {
+ return $this->startAtMax;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setStartAtMax(?string $value = null): self
+ {
+ $this->startAtMax = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/Requests/RetrieveLocationBookingProfileRequest.php b/src/Bookings/Requests/RetrieveLocationBookingProfileRequest.php
new file mode 100644
index 00000000..ea45b46b
--- /dev/null
+++ b/src/Bookings/Requests/RetrieveLocationBookingProfileRequest.php
@@ -0,0 +1,41 @@
+locationId = $values['locationId'];
+ }
+
+ /**
+ * @return string
+ */
+ public function getLocationId(): string
+ {
+ return $this->locationId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setLocationId(string $value): self
+ {
+ $this->locationId = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/Requests/SearchAvailabilityRequest.php b/src/Bookings/Requests/SearchAvailabilityRequest.php
new file mode 100644
index 00000000..f9fba8e6
--- /dev/null
+++ b/src/Bookings/Requests/SearchAvailabilityRequest.php
@@ -0,0 +1,44 @@
+query = $values['query'];
+ }
+
+ /**
+ * @return SearchAvailabilityQuery
+ */
+ public function getQuery(): SearchAvailabilityQuery
+ {
+ return $this->query;
+ }
+
+ /**
+ * @param SearchAvailabilityQuery $value
+ */
+ public function setQuery(SearchAvailabilityQuery $value): self
+ {
+ $this->query = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/Requests/UpdateBookingRequest.php b/src/Bookings/Requests/UpdateBookingRequest.php
new file mode 100644
index 00000000..e76b01e3
--- /dev/null
+++ b/src/Bookings/Requests/UpdateBookingRequest.php
@@ -0,0 +1,93 @@
+bookingId = $values['bookingId'];
+ $this->idempotencyKey = $values['idempotencyKey'] ?? null;
+ $this->booking = $values['booking'];
+ }
+
+ /**
+ * @return string
+ */
+ public function getBookingId(): string
+ {
+ return $this->bookingId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setBookingId(string $value): self
+ {
+ $this->bookingId = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getIdempotencyKey(): ?string
+ {
+ return $this->idempotencyKey;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setIdempotencyKey(?string $value = null): self
+ {
+ $this->idempotencyKey = $value;
+ return $this;
+ }
+
+ /**
+ * @return Booking
+ */
+ public function getBooking(): Booking
+ {
+ return $this->booking;
+ }
+
+ /**
+ * @param Booking $value
+ */
+ public function setBooking(Booking $value): self
+ {
+ $this->booking = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/TeamMemberProfiles/Requests/GetTeamMemberProfilesRequest.php b/src/Bookings/TeamMemberProfiles/Requests/GetTeamMemberProfilesRequest.php
new file mode 100644
index 00000000..0525133f
--- /dev/null
+++ b/src/Bookings/TeamMemberProfiles/Requests/GetTeamMemberProfilesRequest.php
@@ -0,0 +1,41 @@
+teamMemberId = $values['teamMemberId'];
+ }
+
+ /**
+ * @return string
+ */
+ public function getTeamMemberId(): string
+ {
+ return $this->teamMemberId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setTeamMemberId(string $value): self
+ {
+ $this->teamMemberId = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/TeamMemberProfiles/Requests/ListTeamMemberProfilesRequest.php b/src/Bookings/TeamMemberProfiles/Requests/ListTeamMemberProfilesRequest.php
new file mode 100644
index 00000000..012c1f25
--- /dev/null
+++ b/src/Bookings/TeamMemberProfiles/Requests/ListTeamMemberProfilesRequest.php
@@ -0,0 +1,113 @@
+bookableOnly = $values['bookableOnly'] ?? null;
+ $this->limit = $values['limit'] ?? null;
+ $this->cursor = $values['cursor'] ?? null;
+ $this->locationId = $values['locationId'] ?? null;
+ }
+
+ /**
+ * @return ?bool
+ */
+ public function getBookableOnly(): ?bool
+ {
+ return $this->bookableOnly;
+ }
+
+ /**
+ * @param ?bool $value
+ */
+ public function setBookableOnly(?bool $value = null): self
+ {
+ $this->bookableOnly = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?int
+ */
+ public function getLimit(): ?int
+ {
+ return $this->limit;
+ }
+
+ /**
+ * @param ?int $value
+ */
+ public function setLimit(?int $value = null): self
+ {
+ $this->limit = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getCursor(): ?string
+ {
+ return $this->cursor;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setCursor(?string $value = null): self
+ {
+ $this->cursor = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getLocationId(): ?string
+ {
+ return $this->locationId;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setLocationId(?string $value = null): self
+ {
+ $this->locationId = $value;
+ return $this;
+ }
+}
diff --git a/src/Bookings/TeamMemberProfiles/TeamMemberProfilesClient.php b/src/Bookings/TeamMemberProfiles/TeamMemberProfilesClient.php
new file mode 100644
index 00000000..c0d68dae
--- /dev/null
+++ b/src/Bookings/TeamMemberProfiles/TeamMemberProfilesClient.php
@@ -0,0 +1,211 @@
+,
+ * } $options
+ */
+ private array $options;
+
+ /**
+ * @var RawClient $client
+ */
+ private RawClient $client;
+
+ /**
+ * @param RawClient $client
+ * @param ?array{
+ * baseUrl?: string,
+ * client?: ClientInterface,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * } $options
+ */
+ public function __construct(
+ RawClient $client,
+ ?array $options = null,
+ ) {
+ $this->client = $client;
+ $this->options = $options ?? [];
+ }
+
+ /**
+ * Lists booking profiles for team members.
+ *
+ * @param ListTeamMemberProfilesRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return Pager
+ */
+ public function list(ListTeamMemberProfilesRequest $request = new ListTeamMemberProfilesRequest(), ?array $options = null): Pager
+ {
+ return new CursorPager(
+ request: $request,
+ getNextPage: fn (ListTeamMemberProfilesRequest $request) => $this->_list($request, $options),
+ setCursor: function (ListTeamMemberProfilesRequest $request, ?string $cursor) {
+ $request->setCursor($cursor);
+ },
+ /* @phpstan-ignore-next-line */
+ getNextCursor: fn (ListTeamMemberBookingProfilesResponse $response) => $response?->getCursor() ?? null,
+ /* @phpstan-ignore-next-line */
+ getItems: fn (ListTeamMemberBookingProfilesResponse $response) => $response?->getTeamMemberBookingProfiles() ?? [],
+ );
+ }
+
+ /**
+ * Retrieves a team member's booking profile.
+ *
+ * @param GetTeamMemberProfilesRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return GetTeamMemberBookingProfileResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function get(GetTeamMemberProfilesRequest $request, ?array $options = null): GetTeamMemberBookingProfileResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/team-member-booking-profiles/{$request->getTeamMemberId()}",
+ method: HttpMethod::GET,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return GetTeamMemberBookingProfileResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Lists booking profiles for team members.
+ *
+ * @param ListTeamMemberProfilesRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return ListTeamMemberBookingProfilesResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ private function _list(ListTeamMemberProfilesRequest $request = new ListTeamMemberProfilesRequest(), ?array $options = null): ListTeamMemberBookingProfilesResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ $query = [];
+ if ($request->getBookableOnly() != null) {
+ $query['bookable_only'] = $request->getBookableOnly();
+ }
+ if ($request->getLimit() != null) {
+ $query['limit'] = $request->getLimit();
+ }
+ if ($request->getCursor() != null) {
+ $query['cursor'] = $request->getCursor();
+ }
+ if ($request->getLocationId() != null) {
+ $query['location_id'] = $request->getLocationId();
+ }
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/bookings/team-member-booking-profiles",
+ method: HttpMethod::GET,
+ query: $query,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return ListTeamMemberBookingProfilesResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+}
diff --git a/src/Cards/CardsClient.php b/src/Cards/CardsClient.php
new file mode 100644
index 00000000..215833dc
--- /dev/null
+++ b/src/Cards/CardsClient.php
@@ -0,0 +1,332 @@
+,
+ * } $options
+ */
+ private array $options;
+
+ /**
+ * @var RawClient $client
+ */
+ private RawClient $client;
+
+ /**
+ * @param RawClient $client
+ * @param ?array{
+ * baseUrl?: string,
+ * client?: ClientInterface,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * } $options
+ */
+ public function __construct(
+ RawClient $client,
+ ?array $options = null,
+ ) {
+ $this->client = $client;
+ $this->options = $options ?? [];
+ }
+
+ /**
+ * Retrieves a list of cards owned by the account making the request.
+ * A max of 25 cards will be returned.
+ *
+ * @param ListCardsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return Pager
+ */
+ public function list(ListCardsRequest $request = new ListCardsRequest(), ?array $options = null): Pager
+ {
+ return new CursorPager(
+ request: $request,
+ getNextPage: fn (ListCardsRequest $request) => $this->_list($request, $options),
+ setCursor: function (ListCardsRequest $request, ?string $cursor) {
+ $request->setCursor($cursor);
+ },
+ /* @phpstan-ignore-next-line */
+ getNextCursor: fn (ListCardsResponse $response) => $response?->getCursor() ?? null,
+ /* @phpstan-ignore-next-line */
+ getItems: fn (ListCardsResponse $response) => $response?->getCards() ?? [],
+ );
+ }
+
+ /**
+ * Adds a card on file to an existing merchant.
+ *
+ * @param CreateCardRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return CreateCardResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function create(CreateCardRequest $request, ?array $options = null): CreateCardResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/cards",
+ method: HttpMethod::POST,
+ body: $request,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return CreateCardResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Retrieves details for a specific Card.
+ *
+ * @param GetCardsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return GetCardResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function get(GetCardsRequest $request, ?array $options = null): GetCardResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/cards/{$request->getCardId()}",
+ method: HttpMethod::GET,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return GetCardResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Disables the card, preventing any further updates or charges.
+ * Disabling an already disabled card is allowed but has no effect.
+ *
+ * @param DisableCardsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return DisableCardResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function disable(DisableCardsRequest $request, ?array $options = null): DisableCardResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/cards/{$request->getCardId()}/disable",
+ method: HttpMethod::POST,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return DisableCardResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Retrieves a list of cards owned by the account making the request.
+ * A max of 25 cards will be returned.
+ *
+ * @param ListCardsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return ListCardsResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ private function _list(ListCardsRequest $request = new ListCardsRequest(), ?array $options = null): ListCardsResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ $query = [];
+ if ($request->getCursor() != null) {
+ $query['cursor'] = $request->getCursor();
+ }
+ if ($request->getCustomerId() != null) {
+ $query['customer_id'] = $request->getCustomerId();
+ }
+ if ($request->getIncludeDisabled() != null) {
+ $query['include_disabled'] = $request->getIncludeDisabled();
+ }
+ if ($request->getReferenceId() != null) {
+ $query['reference_id'] = $request->getReferenceId();
+ }
+ if ($request->getSortOrder() != null) {
+ $query['sort_order'] = $request->getSortOrder();
+ }
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/cards",
+ method: HttpMethod::GET,
+ query: $query,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return ListCardsResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+}
diff --git a/src/Cards/Requests/CreateCardRequest.php b/src/Cards/Requests/CreateCardRequest.php
new file mode 100644
index 00000000..835af530
--- /dev/null
+++ b/src/Cards/Requests/CreateCardRequest.php
@@ -0,0 +1,132 @@
+idempotencyKey = $values['idempotencyKey'];
+ $this->sourceId = $values['sourceId'];
+ $this->verificationToken = $values['verificationToken'] ?? null;
+ $this->card = $values['card'];
+ }
+
+ /**
+ * @return string
+ */
+ public function getIdempotencyKey(): string
+ {
+ return $this->idempotencyKey;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setIdempotencyKey(string $value): self
+ {
+ $this->idempotencyKey = $value;
+ return $this;
+ }
+
+ /**
+ * @return string
+ */
+ public function getSourceId(): string
+ {
+ return $this->sourceId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setSourceId(string $value): self
+ {
+ $this->sourceId = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getVerificationToken(): ?string
+ {
+ return $this->verificationToken;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setVerificationToken(?string $value = null): self
+ {
+ $this->verificationToken = $value;
+ return $this;
+ }
+
+ /**
+ * @return Card
+ */
+ public function getCard(): Card
+ {
+ return $this->card;
+ }
+
+ /**
+ * @param Card $value
+ */
+ public function setCard(Card $value): self
+ {
+ $this->card = $value;
+ return $this;
+ }
+}
diff --git a/src/Cards/Requests/DisableCardsRequest.php b/src/Cards/Requests/DisableCardsRequest.php
new file mode 100644
index 00000000..a7e29f50
--- /dev/null
+++ b/src/Cards/Requests/DisableCardsRequest.php
@@ -0,0 +1,41 @@
+cardId = $values['cardId'];
+ }
+
+ /**
+ * @return string
+ */
+ public function getCardId(): string
+ {
+ return $this->cardId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setCardId(string $value): self
+ {
+ $this->cardId = $value;
+ return $this;
+ }
+}
diff --git a/src/Cards/Requests/GetCardsRequest.php b/src/Cards/Requests/GetCardsRequest.php
new file mode 100644
index 00000000..61110c87
--- /dev/null
+++ b/src/Cards/Requests/GetCardsRequest.php
@@ -0,0 +1,41 @@
+cardId = $values['cardId'];
+ }
+
+ /**
+ * @return string
+ */
+ public function getCardId(): string
+ {
+ return $this->cardId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setCardId(string $value): self
+ {
+ $this->cardId = $value;
+ return $this;
+ }
+}
diff --git a/src/Cards/Requests/ListCardsRequest.php b/src/Cards/Requests/ListCardsRequest.php
new file mode 100644
index 00000000..692747d4
--- /dev/null
+++ b/src/Cards/Requests/ListCardsRequest.php
@@ -0,0 +1,152 @@
+ $sortOrder
+ */
+ private ?string $sortOrder;
+
+ /**
+ * @param array{
+ * cursor?: ?string,
+ * customerId?: ?string,
+ * includeDisabled?: ?bool,
+ * referenceId?: ?string,
+ * sortOrder?: ?value-of,
+ * } $values
+ */
+ public function __construct(
+ array $values = [],
+ ) {
+ $this->cursor = $values['cursor'] ?? null;
+ $this->customerId = $values['customerId'] ?? null;
+ $this->includeDisabled = $values['includeDisabled'] ?? null;
+ $this->referenceId = $values['referenceId'] ?? null;
+ $this->sortOrder = $values['sortOrder'] ?? null;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getCursor(): ?string
+ {
+ return $this->cursor;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setCursor(?string $value = null): self
+ {
+ $this->cursor = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getCustomerId(): ?string
+ {
+ return $this->customerId;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setCustomerId(?string $value = null): self
+ {
+ $this->customerId = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?bool
+ */
+ public function getIncludeDisabled(): ?bool
+ {
+ return $this->includeDisabled;
+ }
+
+ /**
+ * @param ?bool $value
+ */
+ public function setIncludeDisabled(?bool $value = null): self
+ {
+ $this->includeDisabled = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getReferenceId(): ?string
+ {
+ return $this->referenceId;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setReferenceId(?string $value = null): self
+ {
+ $this->referenceId = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?value-of
+ */
+ public function getSortOrder(): ?string
+ {
+ return $this->sortOrder;
+ }
+
+ /**
+ * @param ?value-of $value
+ */
+ public function setSortOrder(?string $value = null): self
+ {
+ $this->sortOrder = $value;
+ return $this;
+ }
+}
diff --git a/src/CashDrawers/CashDrawersClient.php b/src/CashDrawers/CashDrawersClient.php
new file mode 100644
index 00000000..f1e06b41
--- /dev/null
+++ b/src/CashDrawers/CashDrawersClient.php
@@ -0,0 +1,50 @@
+,
+ * } $options
+ */
+ private array $options;
+
+ /**
+ * @var RawClient $client
+ */
+ private RawClient $client;
+
+ /**
+ * @param RawClient $client
+ * @param ?array{
+ * baseUrl?: string,
+ * client?: ClientInterface,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * } $options
+ */
+ public function __construct(
+ RawClient $client,
+ ?array $options = null,
+ ) {
+ $this->client = $client;
+ $this->options = $options ?? [];
+ $this->shifts = new ShiftsClient($this->client, $this->options);
+ }
+}
diff --git a/src/CashDrawers/Shifts/Requests/GetShiftsRequest.php b/src/CashDrawers/Shifts/Requests/GetShiftsRequest.php
new file mode 100644
index 00000000..104cd72e
--- /dev/null
+++ b/src/CashDrawers/Shifts/Requests/GetShiftsRequest.php
@@ -0,0 +1,65 @@
+shiftId = $values['shiftId'];
+ $this->locationId = $values['locationId'];
+ }
+
+ /**
+ * @return string
+ */
+ public function getShiftId(): string
+ {
+ return $this->shiftId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setShiftId(string $value): self
+ {
+ $this->shiftId = $value;
+ return $this;
+ }
+
+ /**
+ * @return string
+ */
+ public function getLocationId(): string
+ {
+ return $this->locationId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setLocationId(string $value): self
+ {
+ $this->locationId = $value;
+ return $this;
+ }
+}
diff --git a/src/CashDrawers/Shifts/Requests/ListEventsShiftsRequest.php b/src/CashDrawers/Shifts/Requests/ListEventsShiftsRequest.php
new file mode 100644
index 00000000..1b971e0d
--- /dev/null
+++ b/src/CashDrawers/Shifts/Requests/ListEventsShiftsRequest.php
@@ -0,0 +1,116 @@
+shiftId = $values['shiftId'];
+ $this->locationId = $values['locationId'];
+ $this->limit = $values['limit'] ?? null;
+ $this->cursor = $values['cursor'] ?? null;
+ }
+
+ /**
+ * @return string
+ */
+ public function getShiftId(): string
+ {
+ return $this->shiftId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setShiftId(string $value): self
+ {
+ $this->shiftId = $value;
+ return $this;
+ }
+
+ /**
+ * @return string
+ */
+ public function getLocationId(): string
+ {
+ return $this->locationId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setLocationId(string $value): self
+ {
+ $this->locationId = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?int
+ */
+ public function getLimit(): ?int
+ {
+ return $this->limit;
+ }
+
+ /**
+ * @param ?int $value
+ */
+ public function setLimit(?int $value = null): self
+ {
+ $this->limit = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getCursor(): ?string
+ {
+ return $this->cursor;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setCursor(?string $value = null): self
+ {
+ $this->cursor = $value;
+ return $this;
+ }
+}
diff --git a/src/CashDrawers/Shifts/Requests/ListShiftsRequest.php b/src/CashDrawers/Shifts/Requests/ListShiftsRequest.php
new file mode 100644
index 00000000..6d37a85d
--- /dev/null
+++ b/src/CashDrawers/Shifts/Requests/ListShiftsRequest.php
@@ -0,0 +1,168 @@
+ $sortOrder
+ */
+ private ?string $sortOrder;
+
+ /**
+ * @var ?string $beginTime The inclusive start time of the query on opened_at, in ISO 8601 format.
+ */
+ private ?string $beginTime;
+
+ /**
+ * @var ?string $endTime The exclusive end date of the query on opened_at, in ISO 8601 format.
+ */
+ private ?string $endTime;
+
+ /**
+ * Number of cash drawer shift events in a page of results (200 by
+ * default, 1000 max).
+ *
+ * @var ?int $limit
+ */
+ private ?int $limit;
+
+ /**
+ * @var ?string $cursor Opaque cursor for fetching the next page of results.
+ */
+ private ?string $cursor;
+
+ /**
+ * @param array{
+ * locationId: string,
+ * sortOrder?: ?value-of,
+ * beginTime?: ?string,
+ * endTime?: ?string,
+ * limit?: ?int,
+ * cursor?: ?string,
+ * } $values
+ */
+ public function __construct(
+ array $values,
+ ) {
+ $this->locationId = $values['locationId'];
+ $this->sortOrder = $values['sortOrder'] ?? null;
+ $this->beginTime = $values['beginTime'] ?? null;
+ $this->endTime = $values['endTime'] ?? null;
+ $this->limit = $values['limit'] ?? null;
+ $this->cursor = $values['cursor'] ?? null;
+ }
+
+ /**
+ * @return string
+ */
+ public function getLocationId(): string
+ {
+ return $this->locationId;
+ }
+
+ /**
+ * @param string $value
+ */
+ public function setLocationId(string $value): self
+ {
+ $this->locationId = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?value-of
+ */
+ public function getSortOrder(): ?string
+ {
+ return $this->sortOrder;
+ }
+
+ /**
+ * @param ?value-of $value
+ */
+ public function setSortOrder(?string $value = null): self
+ {
+ $this->sortOrder = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getBeginTime(): ?string
+ {
+ return $this->beginTime;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setBeginTime(?string $value = null): self
+ {
+ $this->beginTime = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getEndTime(): ?string
+ {
+ return $this->endTime;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setEndTime(?string $value = null): self
+ {
+ $this->endTime = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?int
+ */
+ public function getLimit(): ?int
+ {
+ return $this->limit;
+ }
+
+ /**
+ * @param ?int $value
+ */
+ public function setLimit(?int $value = null): self
+ {
+ $this->limit = $value;
+ return $this;
+ }
+
+ /**
+ * @return ?string
+ */
+ public function getCursor(): ?string
+ {
+ return $this->cursor;
+ }
+
+ /**
+ * @param ?string $value
+ */
+ public function setCursor(?string $value = null): self
+ {
+ $this->cursor = $value;
+ return $this;
+ }
+}
diff --git a/src/CashDrawers/Shifts/ShiftsClient.php b/src/CashDrawers/Shifts/ShiftsClient.php
new file mode 100644
index 00000000..ea978aa6
--- /dev/null
+++ b/src/CashDrawers/Shifts/ShiftsClient.php
@@ -0,0 +1,317 @@
+,
+ * } $options
+ */
+ private array $options;
+
+ /**
+ * @var RawClient $client
+ */
+ private RawClient $client;
+
+ /**
+ * @param RawClient $client
+ * @param ?array{
+ * baseUrl?: string,
+ * client?: ClientInterface,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * } $options
+ */
+ public function __construct(
+ RawClient $client,
+ ?array $options = null,
+ ) {
+ $this->client = $client;
+ $this->options = $options ?? [];
+ }
+
+ /**
+ * Provides the details for all of the cash drawer shifts for a location
+ * in a date range.
+ *
+ * @param ListShiftsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return Pager
+ */
+ public function list(ListShiftsRequest $request, ?array $options = null): Pager
+ {
+ return new CursorPager(
+ request: $request,
+ getNextPage: fn (ListShiftsRequest $request) => $this->_list($request, $options),
+ setCursor: function (ListShiftsRequest $request, ?string $cursor) {
+ $request->setCursor($cursor);
+ },
+ /* @phpstan-ignore-next-line */
+ getNextCursor: fn (ListCashDrawerShiftsResponse $response) => $response?->getCursor() ?? null,
+ /* @phpstan-ignore-next-line */
+ getItems: fn (ListCashDrawerShiftsResponse $response) => $response?->getCashDrawerShifts() ?? [],
+ );
+ }
+
+ /**
+ * Provides the summary details for a single cash drawer shift. See
+ * [ListCashDrawerShiftEvents](api-endpoint:CashDrawers-ListCashDrawerShiftEvents) for a list of cash drawer shift events.
+ *
+ * @param GetShiftsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return GetCashDrawerShiftResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function get(GetShiftsRequest $request, ?array $options = null): GetCashDrawerShiftResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ $query = [];
+ $query['location_id'] = $request->getLocationId();
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/cash-drawers/shifts/{$request->getShiftId()}",
+ method: HttpMethod::GET,
+ query: $query,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return GetCashDrawerShiftResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Provides a paginated list of events for a single cash drawer shift.
+ *
+ * @param ListEventsShiftsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return Pager
+ */
+ public function listEvents(ListEventsShiftsRequest $request, ?array $options = null): Pager
+ {
+ return new CursorPager(
+ request: $request,
+ getNextPage: fn (ListEventsShiftsRequest $request) => $this->_listEvents($request, $options),
+ setCursor: function (ListEventsShiftsRequest $request, ?string $cursor) {
+ $request->setCursor($cursor);
+ },
+ /* @phpstan-ignore-next-line */
+ getNextCursor: fn (ListCashDrawerShiftEventsResponse $response) => $response?->getCursor() ?? null,
+ /* @phpstan-ignore-next-line */
+ getItems: fn (ListCashDrawerShiftEventsResponse $response) => $response?->getCashDrawerShiftEvents() ?? [],
+ );
+ }
+
+ /**
+ * Provides the details for all of the cash drawer shifts for a location
+ * in a date range.
+ *
+ * @param ListShiftsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return ListCashDrawerShiftsResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ private function _list(ListShiftsRequest $request, ?array $options = null): ListCashDrawerShiftsResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ $query = [];
+ $query['location_id'] = $request->getLocationId();
+ if ($request->getSortOrder() != null) {
+ $query['sort_order'] = $request->getSortOrder();
+ }
+ if ($request->getBeginTime() != null) {
+ $query['begin_time'] = $request->getBeginTime();
+ }
+ if ($request->getEndTime() != null) {
+ $query['end_time'] = $request->getEndTime();
+ }
+ if ($request->getLimit() != null) {
+ $query['limit'] = $request->getLimit();
+ }
+ if ($request->getCursor() != null) {
+ $query['cursor'] = $request->getCursor();
+ }
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/cash-drawers/shifts",
+ method: HttpMethod::GET,
+ query: $query,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return ListCashDrawerShiftsResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Provides a paginated list of events for a single cash drawer shift.
+ *
+ * @param ListEventsShiftsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return ListCashDrawerShiftEventsResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ private function _listEvents(ListEventsShiftsRequest $request, ?array $options = null): ListCashDrawerShiftEventsResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ $query = [];
+ $query['location_id'] = $request->getLocationId();
+ if ($request->getLimit() != null) {
+ $query['limit'] = $request->getLimit();
+ }
+ if ($request->getCursor() != null) {
+ $query['cursor'] = $request->getCursor();
+ }
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/cash-drawers/shifts/{$request->getShiftId()}/events",
+ method: HttpMethod::GET,
+ query: $query,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return ListCashDrawerShiftEventsResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+}
diff --git a/src/Catalog/CatalogClient.php b/src/Catalog/CatalogClient.php
new file mode 100644
index 00000000..68119489
--- /dev/null
+++ b/src/Catalog/CatalogClient.php
@@ -0,0 +1,693 @@
+,
+ * } $options
+ */
+ private array $options;
+
+ /**
+ * @var RawClient $client
+ */
+ private RawClient $client;
+
+ /**
+ * @param RawClient $client
+ * @param ?array{
+ * baseUrl?: string,
+ * client?: ClientInterface,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * } $options
+ */
+ public function __construct(
+ RawClient $client,
+ ?array $options = null,
+ ) {
+ $this->client = $client;
+ $this->options = $options ?? [];
+ $this->images = new ImagesClient($this->client, $this->options);
+ $this->object = new ObjectClient($this->client, $this->options);
+ }
+
+ /**
+ * Deletes a set of [CatalogItem](entity:CatalogItem)s based on the
+ * provided list of target IDs and returns a set of successfully deleted IDs in
+ * the response. Deletion is a cascading event such that all children of the
+ * targeted object are also deleted. For example, deleting a CatalogItem will
+ * also delete all of its [CatalogItemVariation](entity:CatalogItemVariation)
+ * children.
+ *
+ * `BatchDeleteCatalogObjects` succeeds even if only a portion of the targeted
+ * IDs can be deleted. The response will only include IDs that were
+ * actually deleted.
+ *
+ * To ensure consistency, only one delete request is processed at a time per seller account.
+ * While one (batch or non-batch) delete request is being processed, other (batched and non-batched)
+ * delete requests are rejected with the `429` error code.
+ *
+ * @param BatchDeleteCatalogObjectsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return BatchDeleteCatalogObjectsResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function batchDelete(BatchDeleteCatalogObjectsRequest $request = new BatchDeleteCatalogObjectsRequest(), ?array $options = null): BatchDeleteCatalogObjectsResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/catalog/batch-delete",
+ method: HttpMethod::POST,
+ body: $request,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return BatchDeleteCatalogObjectsResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Returns a set of objects based on the provided ID.
+ * Each [CatalogItem](entity:CatalogItem) returned in the set includes all of its
+ * child information including: all of its
+ * [CatalogItemVariation](entity:CatalogItemVariation) objects, references to
+ * its [CatalogModifierList](entity:CatalogModifierList) objects, and the ids of
+ * any [CatalogTax](entity:CatalogTax) objects that apply to it.
+ *
+ * @param BatchGetCatalogObjectsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return BatchGetCatalogObjectsResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function batchGet(BatchGetCatalogObjectsRequest $request, ?array $options = null): BatchGetCatalogObjectsResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/catalog/batch-retrieve",
+ method: HttpMethod::POST,
+ body: $request,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return BatchGetCatalogObjectsResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Creates or updates up to 10,000 target objects based on the provided
+ * list of objects. The target objects are grouped into batches and each batch is
+ * inserted/updated in an all-or-nothing manner. If an object within a batch is
+ * malformed in some way, or violates a database constraint, the entire batch
+ * containing that item will be disregarded. However, other batches in the same
+ * request may still succeed. Each batch may contain up to 1,000 objects, and
+ * batches will be processed in order as long as the total object count for the
+ * request (items, variations, modifier lists, discounts, and taxes) is no more
+ * than 10,000.
+ *
+ * To ensure consistency, only one update request is processed at a time per seller account.
+ * While one (batch or non-batch) update request is being processed, other (batched and non-batched)
+ * update requests are rejected with the `429` error code.
+ *
+ * @param BatchUpsertCatalogObjectsRequest $request
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array,
+ * bodyProperties?: array,
+ * } $options
+ * @return BatchUpsertCatalogObjectsResponse
+ * @throws SquareException
+ * @throws SquareApiException
+ */
+ public function batchUpsert(BatchUpsertCatalogObjectsRequest $request, ?array $options = null): BatchUpsertCatalogObjectsResponse
+ {
+ $options = array_merge($this->options, $options ?? []);
+ try {
+ $response = $this->client->sendRequest(
+ new JsonApiRequest(
+ baseUrl: $options['baseUrl'] ?? $this->client->options['baseUrl'] ?? Environments::Production->value,
+ path: "v2/catalog/batch-upsert",
+ method: HttpMethod::POST,
+ body: $request,
+ ),
+ $options,
+ );
+ $statusCode = $response->getStatusCode();
+ if ($statusCode >= 200 && $statusCode < 400) {
+ $json = $response->getBody()->getContents();
+ return BatchUpsertCatalogObjectsResponse::fromJson($json);
+ }
+ } catch (JsonException $e) {
+ throw new SquareException(message: "Failed to deserialize response: {$e->getMessage()}", previous: $e);
+ } catch (RequestException $e) {
+ $response = $e->getResponse();
+ if ($response === null) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: "API request failed",
+ statusCode: $response->getStatusCode(),
+ body: $response->getBody()->getContents(),
+ );
+ } catch (ClientExceptionInterface $e) {
+ throw new SquareException(message: $e->getMessage(), previous: $e);
+ }
+ throw new SquareApiException(
+ message: 'API request failed',
+ statusCode: $statusCode,
+ body: $response->getBody()->getContents(),
+ );
+ }
+
+ /**
+ * Retrieves information about the Square Catalog API, such as batch size
+ * limits that can be used by the `BatchUpsertCatalogObjects` endpoint.
+ *
+ * @param ?array{
+ * baseUrl?: string,
+ * maxRetries?: int,
+ * timeout?: float,
+ * headers?: array,
+ * queryParameters?: array