From 7d5c06797b9052957a04fce64a3dcf00e07f94bf Mon Sep 17 00:00:00 2001 From: autobot Date: Tue, 18 Apr 2023 19:51:44 +0000 Subject: [PATCH] Generated PR for Release: 26.0.0 --- README.md | 3 + doc/api/booking-custom-attributes.md | 12 +- doc/api/bookings.md | 10 +- doc/api/cards.md | 2 +- doc/api/catalog.md | 9 +- doc/api/checkout.md | 14 +- doc/api/customer-custom-attributes.md | 12 +- doc/api/disputes.md | 2 +- doc/api/gift-card-activities.md | 2 +- doc/api/gift-cards.md | 4 +- doc/api/inventory.md | 34 +- doc/api/invoices.md | 4 +- doc/api/location-custom-attributes.md | 12 +- doc/api/loyalty.md | 28 +- doc/api/order-custom-attributes.md | 12 +- doc/api/orders.md | 14 +- doc/api/payments.md | 10 +- doc/api/payouts.md | 4 +- doc/api/refunds.md | 10 +- doc/api/subscriptions.md | 3 + doc/api/transactions.md | 4 +- doc/api/vendors.md | 2 +- doc/api/webhook-subscriptions.md | 14 +- doc/client.md | 6 +- doc/models/accepted-payment-methods.md | 8 +- .../accumulate-loyalty-points-request.md | 2 +- doc/models/ach-details.md | 6 +- doc/models/additional-recipient.md | 8 +- doc/models/address.md | 28 +- doc/models/afterpay-details.md | 2 +- doc/models/application-details.md | 4 +- doc/models/appointment-segment.md | 19 +- doc/models/availability.md | 19 +- doc/models/bank-account-payment-details.md | 39 +- doc/models/bank-account.md | 14 +- doc/models/batch-change-inventory-request.md | 2 +- ...batch-retrieve-catalog-objects-response.md | 4 +- ...atch-retrieve-inventory-changes-request.md | 2 +- ...batch-retrieve-inventory-counts-request.md | 2 +- .../batch-upsert-catalog-objects-request.md | 2 +- doc/models/booking-creator-details.md | 6 +- ...booking-custom-attribute-delete-request.md | 2 +- ...ooking-custom-attribute-delete-response.md | 2 +- ...booking-custom-attribute-upsert-request.md | 33 +- ...ooking-custom-attribute-upsert-response.md | 50 +- doc/models/booking.md | 57 +- doc/models/break-type.md | 8 +- doc/models/break.md | 4 +- .../bulk-create-team-members-request.md | 2 +- doc/models/bulk-create-vendors-request.md | 158 +- doc/models/bulk-create-vendors-response.md | 2 +- ...ocation-custom-attribute-delete-request.md | 2 +- ...ributes-request-delete-custom-attribute.md | 6 +- doc/models/bulk-retrieve-vendors-request.md | 2 +- doc/models/bulk-retrieve-vendors-response.md | 2 +- .../bulk-update-team-members-request.md | 2 +- doc/models/bulk-update-vendors-request.md | 164 +- doc/models/bulk-update-vendors-response.md | 2 +- ...psert-booking-custom-attributes-request.md | 93 +- ...sert-booking-custom-attributes-response.md | 147 +- ...ustomer-custom-attribute-upsert-request.md | 33 +- ...sert-customer-custom-attributes-request.md | 93 +- ...stomer-custom-attribute-upsert-response.md | 48 +- ...ert-customer-custom-attributes-response.md | 147 +- ...ocation-custom-attribute-upsert-request.md | 33 +- ...sert-location-custom-attributes-request.md | 93 +- ...cation-custom-attribute-upsert-response.md | 48 +- ...ert-location-custom-attributes-response.md | 147 +- ...ributes-request-upsert-custom-attribute.md | 35 +- ...-upsert-order-custom-attributes-request.md | 93 +- ...upsert-order-custom-attributes-response.md | 141 +- doc/models/business-appointment-settings.md | 32 +- doc/models/business-booking-profile.md | 37 +- doc/models/business-hours-period.md | 6 +- doc/models/business-hours.md | 18 +- doc/models/buy-now-pay-later-details.md | 10 +- .../calculate-loyalty-points-request.md | 4 +- doc/models/cancel-booking-request.md | 4 +- doc/models/cancel-invoice-request.md | 2 +- doc/models/capture-transaction-response.md | 2 +- doc/models/card-payment-details.md | 92 +- doc/models/card-payment-timeline.md | 6 +- doc/models/card.md | 49 +- doc/models/cash-app-details.md | 8 +- doc/models/cash-drawer-device.md | 4 +- doc/models/cash-drawer-shift-event.md | 15 +- doc/models/cash-drawer-shift-summary.md | 27 +- doc/models/cash-drawer-shift.md | 62 +- doc/models/cash-payment-details.md | 9 +- ...stom-attribute-definition-number-config.md | 2 +- ...ction-config-custom-attribute-selection.md | 2 +- ...m-attribute-definition-selection-config.md | 17 +- ...stom-attribute-definition-string-config.md | 2 +- .../catalog-custom-attribute-definition.md | 40 +- doc/models/catalog-custom-attribute-value.md | 22 +- doc/models/catalog-id-mapping.md | 4 +- doc/models/catalog-image.md | 14 +- doc/models/catalog-info-response-limits.md | 22 +- doc/models/catalog-item-modifier-list-info.md | 13 +- doc/models/catalog-item-option-for-item.md | 2 +- ...og-item-option-value-for-item-variation.md | 4 +- doc/models/catalog-item-option-value.md | 10 +- doc/models/catalog-item-option.md | 3014 +++++++++- doc/models/catalog-item-variation.md | 113 +- doc/models/catalog-item.md | 6 +- doc/models/catalog-measurement-unit.md | 16 +- doc/models/catalog-modifier-override.md | 2 +- doc/models/catalog-object-batch.md | 170 +- doc/models/catalog-object-reference.md | 4 +- doc/models/catalog-object.md | 141 +- doc/models/catalog-pricing-rule.md | 37 +- doc/models/catalog-product-set.md | 20 +- ...-item-variations-for-item-option-values.md | 5 +- .../catalog-query-items-for-item-options.md | 4 +- doc/models/catalog-query-range.md | 4 +- doc/models/catalog-query-sorted-attribute.md | 4 +- doc/models/catalog-query.md | 66 +- doc/models/catalog-quick-amount.md | 8 +- doc/models/catalog-quick-amounts-settings.md | 23 +- doc/models/catalog-stock-conversion.md | 4 +- doc/models/catalog-subscription-plan.md | 25 +- doc/models/catalog-time-period.md | 2 +- doc/models/catalog-v1-id.md | 4 +- .../charge-request-additional-recipient.md | 4 +- doc/models/charge-request.md | 6 +- doc/models/charge-response.md | 2 +- doc/models/checkout-options.md | 42 +- doc/models/checkout.md | 1425 ++++- doc/models/clearpay-details.md | 2 +- doc/models/coordinates.md | 4 +- ...ing-custom-attribute-definition-request.md | 21 +- doc/models/create-booking-request.md | 63 +- doc/models/create-card-request.md | 4 +- doc/models/create-card-response.md | 2 +- doc/models/create-catalog-image-request.md | 2 +- .../create-dispute-evidence-file-request.md | 4 +- doc/models/create-gift-card-request.md | 2 +- ...der-custom-attribute-definition-request.md | 2 +- doc/models/create-payment-link-response.md | 4029 ++++++++++++- doc/models/create-payment-request.md | 6 +- doc/models/create-refund-request.md | 6 +- doc/models/create-refund-response.md | 2 +- doc/models/create-subscription-request.md | 4 +- doc/models/create-vendor-request.md | 39 +- doc/models/create-vendor-response.md | 58 +- .../create-webhook-subscription-request.md | 2 +- doc/models/custom-attribute-definition.md | 19 +- doc/models/custom-attribute-filter.md | 18 +- doc/models/custom-attribute.md | 29 +- doc/models/customer-address-filter.md | 7 +- doc/models/customer-creation-source-filter.md | 8 +- .../customer-custom-attribute-filter-value.md | 48 +- .../customer-custom-attribute-filter.md | 44 +- .../customer-custom-attribute-filters.md | 46 +- doc/models/customer-filter.md | 208 +- doc/models/customer-group.md | 6 +- doc/models/customer-preferences.md | 2 +- doc/models/customer-query.md | 122 +- doc/models/customer-segment.md | 6 +- doc/models/customer-sort.md | 4 +- doc/models/customer-tax-ids.md | 2 +- doc/models/customer-text-filter.md | 4 +- doc/models/customer.md | 144 +- doc/models/date-range.md | 4 +- doc/models/delete-customer-request.md | 2 +- doc/models/delete-invoice-request.md | 4 +- ...ed-create-dispute-evidence-file-request.md | 4 +- ...destination-details-card-refund-details.md | 37 +- doc/models/destination-details.md | 38 +- doc/models/destination.md | 4 +- doc/models/device-checkout-options.md | 16 +- doc/models/device-details.md | 6 +- doc/models/device-metadata.md | 24 +- doc/models/device.md | 4 +- doc/models/digital-wallet-details.md | 10 +- doc/models/dispute-evidence-file.md | 4 +- doc/models/dispute-evidence.md | 17 +- doc/models/dispute.md | 40 +- doc/models/disputed-payment.md | 2 +- doc/models/employee-wage.md | 11 +- doc/models/employee.md | 22 +- doc/models/error.md | 4 +- doc/models/event-type-metadata.md | 6 +- doc/models/external-payment-details.md | 7 +- doc/models/filter-value.md | 15 +- doc/models/float-number-range.md | 4 +- doc/models/fulfillment-delivery-details.md | 67 +- doc/models/fulfillment-fulfillment-entry.md | 8 +- ...-pickup-details-curbside-pickup-details.md | 4 +- doc/models/fulfillment-pickup-details.md | 60 +- doc/models/fulfillment-recipient.md | 25 +- doc/models/fulfillment-shipment-details.md | 51 +- doc/models/fulfillment.md | 158 +- doc/models/gift-card-activity-activate.md | 21 +- .../gift-card-activity-adjust-decrement.md | 4 +- .../gift-card-activity-adjust-increment.md | 4 +- .../gift-card-activity-import-reversal.md | 4 +- doc/models/gift-card-activity-import.md | 4 +- doc/models/gift-card-activity-load.md | 21 +- doc/models/gift-card-activity-redeem.md | 10 +- doc/models/gift-card-activity-refund.md | 13 +- ...ift-card-activity-transfer-balance-from.md | 4 +- .../gift-card-activity-transfer-balance-to.md | 4 +- ...-card-activity-unlinked-activity-refund.md | 8 +- doc/models/gift-card-activity.md | 134 +- doc/models/gift-card.md | 22 +- doc/models/inventory-adjustment-group.md | 8 +- doc/models/inventory-adjustment.md | 64 +- doc/models/inventory-change.md | 96 +- doc/models/inventory-count.md | 20 +- doc/models/inventory-physical-count.md | 42 +- doc/models/inventory-transfer.md | 42 +- .../invoice-accepted-payment-methods.md | 8 +- doc/models/invoice-custom-field.md | 6 +- doc/models/invoice-filter.md | 5 +- doc/models/invoice-payment-reminder.md | 10 +- doc/models/invoice-payment-request.md | 64 +- doc/models/invoice-query.md | 10 +- doc/models/invoice-recipient-tax-ids.md | 2 +- doc/models/invoice-recipient.md | 33 +- doc/models/invoice-request-method.md | 4 +- doc/models/invoice.md | 144 +- .../item-variation-location-overrides.md | 19 +- doc/models/job-assignment.md | 12 +- doc/models/list-bank-accounts-request.md | 6 +- ...ng-custom-attribute-definitions-request.md | 4 +- .../list-booking-custom-attributes-request.md | 8 +- ...list-booking-custom-attributes-response.md | 98 +- doc/models/list-bookings-request.md | 12 +- doc/models/list-bookings-response.md | 61 +- doc/models/list-break-types-request.md | 6 +- doc/models/list-cards-request.md | 2 +- doc/models/list-cards-response.md | 50 +- .../list-cash-drawer-shift-events-request.md | 4 +- doc/models/list-cash-drawer-shifts-request.md | 10 +- doc/models/list-catalog-request.md | 10 +- doc/models/list-catalog-response.md | 2 +- ...er-custom-attribute-definitions-request.md | 4 +- ...list-customer-custom-attributes-request.md | 8 +- ...ist-customer-custom-attributes-response.md | 98 +- doc/models/list-customers-request.md | 8 +- doc/models/list-dispute-evidence-response.md | 50 +- doc/models/list-disputes-request.md | 2 +- doc/models/list-disputes-response.md | 2 +- doc/models/list-employee-wages-request.md | 6 +- doc/models/list-employees-request.md | 8 +- doc/models/list-employees-response.md | 40 +- .../list-gift-card-activities-request.md | 2 +- doc/models/list-gift-cards-request.md | 14 +- doc/models/list-invoices-request.md | 4 +- ...on-custom-attribute-definitions-request.md | 6 +- ...list-location-custom-attributes-request.md | 10 +- ...ist-location-custom-attributes-response.md | 98 +- doc/models/list-merchants-request.md | 2 +- ...er-custom-attribute-definitions-request.md | 8 +- ...r-custom-attribute-definitions-response.md | 2 +- .../list-order-custom-attributes-request.md | 12 +- .../list-order-custom-attributes-response.md | 100 +- doc/models/list-payment-links-request.md | 4 +- doc/models/list-payment-refunds-request.md | 10 +- doc/models/list-payment-refunds-response.md | 2 +- doc/models/list-payments-request.md | 8 +- doc/models/list-payments-response.md | 2 +- doc/models/list-payout-entries-request.md | 2 +- doc/models/list-payout-entries-response.md | 2 +- doc/models/list-payouts-request.md | 2 +- doc/models/list-payouts-response.md | 2 +- doc/models/list-refunds-request.md | 12 +- doc/models/list-refunds-response.md | 2 +- .../list-subscription-events-request.md | 4 +- ...st-team-member-booking-profiles-request.md | 8 +- doc/models/list-team-member-wages-request.md | 6 +- doc/models/list-transactions-request.md | 12 +- doc/models/list-transactions-response.md | 2 +- .../list-webhook-event-types-request.md | 2 +- .../list-webhook-event-types-response.md | 2 +- .../list-webhook-subscriptions-request.md | 10 +- .../list-webhook-subscriptions-response.md | 2 +- doc/models/list-workweek-configs-request.md | 4 +- doc/models/location.md | 99 +- doc/models/loyalty-account-mapping.md | 6 +- doc/models/loyalty-account.md | 31 +- doc/models/loyalty-event-accumulate-points.md | 10 +- ...yalty-event-accumulate-promotion-points.md | 10 +- doc/models/loyalty-event-adjust-points.md | 6 +- doc/models/loyalty-event-create-reward.md | 6 +- doc/models/loyalty-event-date-time-filter.md | 4 +- doc/models/loyalty-event-delete-reward.md | 6 +- doc/models/loyalty-event-expire-points.md | 2 +- doc/models/loyalty-event-filter.md | 31 +- doc/models/loyalty-event-location-filter.md | 2 +- .../loyalty-event-loyalty-account-filter.md | 2 +- doc/models/loyalty-event-order-filter.md | 2 +- doc/models/loyalty-event-other.md | 2 +- doc/models/loyalty-event-query.md | 29 +- doc/models/loyalty-event-redeem-reward.md | 10 +- doc/models/loyalty-event.md | 53 +- ...alty-program-accrual-rule-category-data.md | 2 +- ...rogram-accrual-rule-item-variation-data.md | 2 +- ...loyalty-program-accrual-rule-spend-data.md | 19 +- ...loyalty-program-accrual-rule-visit-data.md | 5 +- doc/models/loyalty-program-accrual-rule.md | 33 +- .../loyalty-program-reward-definition.md | 18 +- doc/models/loyalty-program-reward-tier.md | 27 +- doc/models/loyalty-program.md | 150 +- .../loyalty-promotion-available-time-data.md | 4 +- doc/models/loyalty-promotion-incentive.md | 8 +- doc/models/loyalty-promotion-trigger-limit.md | 2 +- doc/models/loyalty-promotion.md | 51 +- doc/models/loyalty-reward.md | 20 +- doc/models/measurement-unit.md | 19 +- doc/models/merchant.md | 14 +- doc/models/money.md | 4 +- doc/models/order-created-object.md | 8 +- doc/models/order-created.md | 10 +- doc/models/order-entry.md | 6 +- .../order-fulfillment-delivery-details.md | 67 +- .../order-fulfillment-fulfillment-entry.md | 8 +- ...-pickup-details-curbside-pickup-details.md | 4 +- .../order-fulfillment-pickup-details.md | 60 +- doc/models/order-fulfillment-recipient.md | 25 +- .../order-fulfillment-shipment-details.md | 51 +- .../order-fulfillment-updated-object.md | 16 +- .../order-fulfillment-updated-update.md | 6 +- doc/models/order-fulfillment-updated.md | 30 +- doc/models/order-fulfillment.md | 158 +- .../order-line-item-applied-discount.md | 7 +- .../order-line-item-applied-service-charge.md | 28 + doc/models/order-line-item-applied-tax.md | 7 +- doc/models/order-line-item-discount.md | 40 +- doc/models/order-line-item-modifier.md | 28 +- ...tem-pricing-blocklists-blocked-discount.md | 6 +- ...ine-item-pricing-blocklists-blocked-tax.md | 6 +- .../order-line-item-pricing-blocklists.md | 16 +- doc/models/order-line-item-tax.md | 29 +- doc/models/order-line-item.md | 210 +- doc/models/order-money-amounts.md | 25 +- doc/models/order-pricing-options.md | 4 +- doc/models/order-quantity-unit.md | 22 +- doc/models/order-return-discount.md | 28 +- doc/models/order-return-line-item-modifier.md | 24 +- doc/models/order-return-line-item.md | 166 +- doc/models/order-return-service-charge.md | 61 +- doc/models/order-return-tax.md | 23 +- doc/models/order-return.md | 470 +- doc/models/order-rounding-adjustment.md | 9 +- .../order-service-charge-calculation-phase.md | 2 + doc/models/order-service-charge-scope.md | 18 + .../order-service-charge-treatment-type.md | 17 + doc/models/order-service-charge.md | 67 +- doc/models/order-source.md | 2 +- doc/models/order-updated-object.md | 9 +- doc/models/order-updated.md | 12 +- doc/models/order.md | 1931 +++++- doc/models/pause-subscription-request.md | 10 +- doc/models/pay-order-request.md | 2 +- ...-balance-activity-app-fee-refund-detail.md | 6 +- ...balance-activity-app-fee-revenue-detail.md | 4 +- ...lance-activity-automatic-savings-detail.md | 4 +- ...ivity-automatic-savings-reversed-detail.md | 4 +- .../payment-balance-activity-charge-detail.md | 2 +- ...ent-balance-activity-deposit-fee-detail.md | 2 +- ...payment-balance-activity-dispute-detail.md | 4 +- .../payment-balance-activity-fee-detail.md | 2 +- ...balance-activity-free-processing-detail.md | 2 +- ...balance-activity-hold-adjustment-detail.md | 2 +- ...nt-balance-activity-open-dispute-detail.md | 4 +- ...alance-activity-other-adjustment-detail.md | 2 +- .../payment-balance-activity-other-detail.md | 2 +- .../payment-balance-activity-refund-detail.md | 4 +- ...ance-activity-release-adjustment-detail.md | 2 +- ...nt-balance-activity-reserve-hold-detail.md | 2 +- ...balance-activity-reserve-release-detail.md | 2 +- ...-activity-square-capital-payment-detail.md | 2 +- ...-square-capital-reversed-payment-detail.md | 2 +- ...ment-balance-activity-tax-on-fee-detail.md | 4 +- ...balance-activity-third-party-fee-detail.md | 2 +- ...-activity-third-party-fee-refund-detail.md | 4 +- doc/models/payment-link-related-resources.md | 5158 ++++++++++++++++- doc/models/payment-link.md | 72 +- doc/models/payment-options-delay-action.md | 17 + doc/models/payment-options.md | 10 +- doc/models/payment-refund.md | 96 +- doc/models/payment.md | 293 +- doc/models/payout-entry.md | 117 +- doc/models/payout-fee.md | 9 +- doc/models/payout.md | 51 +- doc/models/pre-populated-data.md | 21 +- doc/models/processing-fee.md | 9 +- doc/models/publish-invoice-request.md | 2 +- doc/models/quantity-ratio.md | 4 +- doc/models/quick-pay.md | 4 +- doc/models/range.md | 4 +- doc/models/receipt-options.md | 4 +- doc/models/redeem-loyalty-reward-request.md | 2 +- doc/models/refund-payment-request.md | 4 +- doc/models/refund.md | 43 +- doc/models/resume-subscription-request.md | 4 +- ...ing-custom-attribute-definition-request.md | 2 +- ...trieve-booking-custom-attribute-request.md | 6 +- ...rieve-booking-custom-attribute-response.md | 46 +- doc/models/retrieve-catalog-object-request.md | 4 +- ...mer-custom-attribute-definition-request.md | 2 +- ...rieve-customer-custom-attribute-request.md | 6 +- ...ieve-customer-custom-attribute-response.md | 46 +- doc/models/retrieve-employee-response.md | 38 +- .../retrieve-inventory-changes-request.md | 6 +- .../retrieve-inventory-count-request.md | 6 +- ...ion-custom-attribute-definition-request.md | 2 +- ...rieve-location-custom-attribute-request.md | 6 +- ...ieve-location-custom-attribute-response.md | 46 +- ...der-custom-attribute-definition-request.md | 2 +- ...retrieve-order-custom-attribute-request.md | 6 +- ...etrieve-order-custom-attribute-response.md | 46 +- doc/models/retrieve-payment-link-response.md | 1 + doc/models/retrieve-subscription-request.md | 2 +- doc/models/retrieve-transaction-response.md | 2 +- doc/models/retrieve-vendor-response.md | 58 +- doc/models/risk-evaluation.md | 4 +- doc/models/save-card-options.md | 4 +- doc/models/search-availability-filter.md | 45 +- doc/models/search-availability-query.md | 62 +- doc/models/search-availability-request.md | 26 +- doc/models/search-catalog-items-request.md | 2 +- doc/models/search-catalog-items-response.md | 2372 +++++++- doc/models/search-catalog-objects-request.md | 4 +- doc/models/search-catalog-objects-response.md | 2 +- ...-accounts-request-loyalty-account-query.md | 13 +- doc/models/search-loyalty-accounts-request.md | 4 +- .../search-loyalty-accounts-response.md | 2 +- doc/models/search-loyalty-events-request.md | 2 +- doc/models/search-loyalty-events-response.md | 2 +- ...ty-rewards-request-loyalty-reward-query.md | 4 +- doc/models/search-loyalty-rewards-request.md | 2 +- doc/models/search-orders-customer-filter.md | 5 +- doc/models/search-orders-date-time-filter.md | 15 +- doc/models/search-orders-filter.md | 42 +- .../search-orders-fulfillment-filter.md | 13 +- doc/models/search-orders-query.md | 48 +- doc/models/search-orders-request.md | 4 +- doc/models/search-orders-response.md | 8 +- doc/models/search-orders-sort.md | 2 +- doc/models/search-orders-source-filter.md | 6 +- doc/models/search-subscriptions-filter.md | 13 +- doc/models/search-subscriptions-query.md | 13 +- doc/models/search-team-members-filter.md | 8 +- doc/models/search-team-members-query.md | 8 +- doc/models/search-terminal-actions-request.md | 2 +- .../search-terminal-actions-response.md | 2 +- .../search-terminal-checkouts-request.md | 2 +- .../search-terminal-checkouts-response.md | 2 +- .../search-terminal-refunds-response.md | 2 +- doc/models/search-vendors-request-filter.md | 16 +- doc/models/search-vendors-request-sort.md | 4 +- doc/models/search-vendors-request.md | 1 + doc/models/search-vendors-response.md | 160 +- doc/models/segment-filter.md | 19 +- doc/models/shift-filter.md | 34 +- doc/models/shift-query.md | 35 +- doc/models/shift-sort.md | 4 +- doc/models/shift-wage.md | 7 +- doc/models/shift-workday.md | 9 +- doc/models/shift.md | 58 +- doc/models/shipping-fee.md | 6 +- doc/models/site.md | 12 +- doc/models/snippet-response.md | 29 +- doc/models/snippet.md | 8 +- doc/models/source-application.md | 8 +- doc/models/square-event-data.md | 11 +- doc/models/square-event.md | 20 +- doc/models/standard-unit-description-group.md | 56 +- doc/models/standard-unit-description.md | 18 +- doc/models/subscription-action.md | 8 +- doc/models/subscription-event-info.md | 4 +- doc/models/subscription-event.md | 5 +- doc/models/subscription-phase.md | 11 +- doc/models/subscription-source.md | 2 +- doc/models/subscription-test-result.md | 10 +- doc/models/subscription.md | 70 +- doc/models/tax-ids.md | 8 +- doc/models/team-member-assigned-locations.md | 8 +- doc/models/team-member-booking-profile.md | 12 +- doc/models/team-member-wage.md | 11 +- doc/models/team-member.md | 29 +- doc/models/tender-card-details.md | 39 +- doc/models/tender-cash-details.md | 10 +- doc/models/tender.md | 111 +- doc/models/terminal-action-query-filter.md | 11 +- doc/models/terminal-action-query-sort.md | 2 +- doc/models/terminal-action.md | 45 +- doc/models/terminal-checkout-query-filter.md | 9 +- doc/models/terminal-checkout-query-sort.md | 2 +- doc/models/terminal-checkout-query.md | 13 +- doc/models/terminal-checkout.md | 73 +- doc/models/terminal-refund-query-filter.md | 9 +- doc/models/terminal-refund-query-sort.md | 2 +- doc/models/terminal-refund-query.md | 13 +- doc/models/terminal-refund.md | 24 +- .../test-webhook-subscription-request.md | 2 +- doc/models/time-range.md | 4 +- doc/models/tip-settings.md | 13 +- doc/models/transaction.md | 357 +- ...ing-custom-attribute-definition-request.md | 21 +- doc/models/update-booking-request.md | 63 +- doc/models/update-catalog-image-request.md | 2 +- ...der-custom-attribute-definition-request.md | 2 +- doc/models/update-order-request.md | 1370 ++++- doc/models/update-payment-link-response.md | 1 + doc/models/update-vendor-request.md | 2 +- ...hook-subscription-signature-key-request.md | 2 +- ...upsert-booking-custom-attribute-request.md | 31 +- ...psert-booking-custom-attribute-response.md | 46 +- doc/models/upsert-catalog-object-request.md | 2 +- ...psert-customer-custom-attribute-request.md | 31 +- ...sert-customer-custom-attribute-response.md | 46 +- ...psert-location-custom-attribute-request.md | 31 +- ...sert-location-custom-attribute-response.md | 46 +- .../upsert-order-custom-attribute-request.md | 33 +- .../upsert-order-custom-attribute-response.md | 46 +- doc/models/v1-create-refund-request.md | 7 +- doc/models/v1-list-orders-request.md | 6 +- doc/models/v1-list-orders-response.md | 173 +- doc/models/v1-list-payments-request.md | 12 +- doc/models/v1-list-payments-response.md | 756 ++- doc/models/v1-list-refunds-request.md | 10 +- doc/models/v1-list-refunds-response.md | 179 +- doc/models/v1-list-settlements-request.md | 12 +- doc/models/v1-list-settlements-response.md | 63 +- doc/models/v1-money.md | 4 +- doc/models/v1-order-history-entry.md | 4 +- doc/models/v1-order.md | 127 +- doc/models/v1-payment-discount.md | 9 +- doc/models/v1-payment-item-detail.md | 8 +- doc/models/v1-payment-itemization.md | 145 +- doc/models/v1-payment-modifier.md | 9 +- doc/models/v1-payment-surcharge.md | 77 +- doc/models/v1-payment-tax.md | 34 +- doc/models/v1-payment.md | 864 ++- doc/models/v1-refund.md | 182 +- doc/models/v1-settlement-entry.md | 14 +- doc/models/v1-settlement.md | 28 +- doc/models/v1-tender.md | 44 +- doc/models/v1-update-order-request.md | 8 +- doc/models/vendor-contact.md | 22 +- doc/models/vendor.md | 68 +- doc/models/void-transaction-response.md | 2 +- doc/models/wage-setting.md | 52 +- doc/models/webhook-subscription.md | 21 +- doc/models/workweek-config.md | 8 +- package.json | 12 +- src/api/bookingCustomAttributesApi.ts | 28 +- src/api/bookingsApi.ts | 15 +- src/api/cardsApi.ts | 4 +- src/api/catalogApi.ts | 5 +- src/api/checkoutApi.ts | 2 +- src/api/customerCustomAttributesApi.ts | 30 +- src/api/disputesApi.ts | 4 +- src/api/giftCardActivitiesApi.ts | 6 +- src/api/giftCardsApi.ts | 6 +- src/api/inventoryApi.ts | 50 +- src/api/invoicesApi.ts | 8 +- src/api/locationCustomAttributesApi.ts | 29 +- src/api/loyaltyApi.ts | 54 +- src/api/orderCustomAttributesApi.ts | 29 +- src/api/paymentsApi.ts | 16 +- src/api/payoutsApi.ts | 14 +- src/api/refundsApi.ts | 22 +- src/api/transactionsApi.ts | 4 +- src/api/vendorsApi.ts | 2 +- src/api/webhookSubscriptionsApi.ts | 24 +- src/client.ts | 4 +- src/defaultConfiguration.ts | 2 +- src/index.ts | 1663 +++--- src/models/accumulateLoyaltyPointsRequest.ts | 2 +- src/models/appointmentSegment.ts | 4 +- src/models/batchChangeInventoryRequest.ts | 4 +- .../batchRetrieveCatalogObjectsResponse.ts | 4 +- .../batchRetrieveInventoryChangesRequest.ts | 2 +- .../batchRetrieveInventoryCountsRequest.ts | 2 +- .../batchUpsertCatalogObjectsRequest.ts | 2 +- src/models/booking.ts | 8 +- .../bookingCustomAttributeDeleteRequest.ts | 2 +- .../bookingCustomAttributeDeleteResponse.ts | 2 +- .../bookingCustomAttributeUpsertRequest.ts | 2 +- .../bookingCustomAttributeUpsertResponse.ts | 2 +- src/models/bulkCreateTeamMembersRequest.ts | 2 +- src/models/bulkCreateVendorsRequest.ts | 2 +- src/models/bulkCreateVendorsResponse.ts | 2 +- ...mAttributesRequestDeleteCustomAttribute.ts | 2 +- src/models/bulkRetrieveVendorsRequest.ts | 2 +- src/models/bulkRetrieveVendorsResponse.ts | 2 +- src/models/bulkUpdateTeamMembersRequest.ts | 2 +- src/models/bulkUpdateVendorsRequest.ts | 2 +- src/models/bulkUpdateVendorsResponse.ts | 2 +- ...estCustomerCustomAttributeUpsertRequest.ts | 2 +- ...estLocationCustomAttributeUpsertRequest.ts | 2 +- ...mAttributesRequestUpsertCustomAttribute.ts | 2 +- src/models/calculateLoyaltyPointsRequest.ts | 4 +- src/models/cancelInvoiceRequest.ts | 4 +- src/models/captureTransactionResponse.ts | 2 +- src/models/cashAppDetails.ts | 2 +- .../catalogCustomAttributeDefinition.ts | 4 +- src/models/catalogCustomAttributeValue.ts | 8 +- src/models/catalogImage.ts | 6 +- src/models/catalogItem.ts | 5 +- src/models/catalogItemVariation.ts | 9 + src/models/catalogObject.ts | 4 +- src/models/catalogStockConversion.ts | 6 +- src/models/catalogSubscriptionPlan.ts | 2 +- src/models/chargeRequest.ts | 8 +- src/models/chargeResponse.ts | 2 +- src/models/createCardRequest.ts | 4 +- src/models/createCardResponse.ts | 2 +- src/models/createCatalogImageRequest.ts | 2 +- src/models/createGiftCardRequest.ts | 2 +- src/models/createPaymentRequest.ts | 8 +- src/models/createRefundRequest.ts | 6 +- src/models/createRefundResponse.ts | 2 +- src/models/createSubscriptionRequest.ts | 4 +- src/models/createVendorRequest.ts | 6 +- .../createWebhookSubscriptionRequest.ts | 2 +- src/models/customer.ts | 12 +- src/models/customerCustomAttributeFilter.ts | 4 +- src/models/deleteInvoiceRequest.ts | 6 +- src/models/giftCard.ts | 2 +- src/models/giftCardActivity.ts | 2 +- src/models/giftCardActivityActivate.ts | 8 +- src/models/giftCardActivityLoad.ts | 8 +- src/models/giftCardActivityRefund.ts | 2 +- src/models/inventoryAdjustment.ts | 14 +- src/models/inventoryChange.ts | 2 +- src/models/inventoryCount.ts | 6 +- src/models/inventoryPhysicalCount.ts | 14 +- src/models/inventoryTransfer.ts | 12 +- src/models/invoice.ts | 6 +- src/models/invoicePaymentRequest.ts | 4 +- .../listBookingCustomAttributesRequest.ts | 2 +- src/models/listCardsRequest.ts | 2 +- src/models/listCardsResponse.ts | 2 +- src/models/listCatalogRequest.ts | 4 +- src/models/listCatalogResponse.ts | 2 +- .../listCustomerCustomAttributesRequest.ts | 2 +- src/models/listDisputesRequest.ts | 2 +- src/models/listDisputesResponse.ts | 2 +- src/models/listGiftCardActivitiesRequest.ts | 2 +- src/models/listGiftCardsRequest.ts | 4 +- .../listLocationCustomAttributesRequest.ts | 2 +- .../listOrderCustomAttributesRequest.ts | 2 +- src/models/listPaymentRefundsRequest.ts | 12 +- src/models/listPaymentRefundsResponse.ts | 2 +- src/models/listPaymentsRequest.ts | 10 +- src/models/listPaymentsResponse.ts | 2 +- src/models/listPayoutEntriesRequest.ts | 2 +- src/models/listPayoutEntriesResponse.ts | 2 +- src/models/listPayoutsRequest.ts | 2 +- src/models/listPayoutsResponse.ts | 2 +- src/models/listRefundsRequest.ts | 4 +- src/models/listRefundsResponse.ts | 2 +- src/models/listTransactionsRequest.ts | 4 +- src/models/listTransactionsResponse.ts | 2 +- src/models/listWebhookEventTypesResponse.ts | 2 +- src/models/listWebhookSubscriptionsRequest.ts | 4 +- .../listWebhookSubscriptionsResponse.ts | 2 +- src/models/location.ts | 2 +- src/models/loyaltyAccount.ts | 4 +- src/models/loyaltyEvent.ts | 4 +- src/models/loyaltyEventAccumulatePoints.ts | 4 +- .../loyaltyEventAccumulatePromotionPoints.ts | 6 +- src/models/loyaltyEventAdjustPoints.ts | 2 +- src/models/loyaltyEventCreateReward.ts | 4 +- src/models/loyaltyEventDeleteReward.ts | 4 +- src/models/loyaltyEventExpirePoints.ts | 2 +- src/models/loyaltyEventLocationFilter.ts | 2 +- .../loyaltyEventLoyaltyAccountFilter.ts | 2 +- src/models/loyaltyEventOrderFilter.ts | 2 +- src/models/loyaltyEventOther.ts | 2 +- src/models/loyaltyEventRedeemReward.ts | 6 +- src/models/loyaltyProgram.ts | 6 +- .../loyaltyProgramAccrualRuleCategoryData.ts | 2 +- ...altyProgramAccrualRuleItemVariationData.ts | 2 +- .../loyaltyProgramAccrualRuleSpendData.ts | 4 +- src/models/loyaltyPromotion.ts | 6 +- src/models/loyaltyReward.ts | 6 +- src/models/order.ts | 9 +- src/models/orderLineItem.ts | 35 +- .../orderLineItemAppliedServiceCharge.ts | 31 + src/models/orderLineItemDiscount.ts | 4 +- src/models/orderLineItemModifier.ts | 2 +- src/models/orderLineItemTax.ts | 2 +- src/models/orderQuantityUnit.ts | 2 +- src/models/orderReturnDiscount.ts | 2 +- src/models/orderReturnLineItem.ts | 34 +- src/models/orderReturnLineItemModifier.ts | 13 +- src/models/orderReturnServiceCharge.ts | 14 +- src/models/orderReturnTax.ts | 2 +- src/models/orderServiceCharge.ts | 14 +- src/models/payOrderRequest.ts | 2 +- src/models/payment.ts | 2 +- src/models/paymentLink.ts | 5 +- src/models/paymentOptions.ts | 8 +- src/models/payout.ts | 2 +- src/models/publishInvoiceRequest.ts | 2 +- src/models/redeemLoyaltyRewardRequest.ts | 2 +- src/models/refundPaymentRequest.ts | 4 +- .../retrieveBookingCustomAttributeRequest.ts | 2 +- .../retrieveCustomerCustomAttributeRequest.ts | 2 +- src/models/retrieveInventoryChangesRequest.ts | 2 +- src/models/retrieveInventoryCountRequest.ts | 2 +- .../retrieveLocationCustomAttributeRequest.ts | 2 +- .../retrieveOrderCustomAttributeRequest.ts | 2 +- src/models/retrieveTransactionResponse.ts | 2 +- src/models/searchCatalogItemsRequest.ts | 2 +- src/models/searchCatalogObjectsRequest.ts | 5 +- src/models/searchCatalogObjectsResponse.ts | 2 +- src/models/searchLoyaltyAccountsRequest.ts | 2 +- src/models/searchLoyaltyAccountsResponse.ts | 2 +- src/models/searchLoyaltyEventsRequest.ts | 2 +- src/models/searchLoyaltyEventsResponse.ts | 2 +- src/models/searchLoyaltyRewardsRequest.ts | 2 +- ...LoyaltyRewardsRequestLoyaltyRewardQuery.ts | 2 +- src/models/searchOrdersFulfillmentFilter.ts | 4 +- src/models/searchOrdersRequest.ts | 4 +- src/models/searchOrdersResponse.ts | 8 +- src/models/searchOrdersSourceFilter.ts | 2 +- src/models/searchTerminalActionsRequest.ts | 2 +- src/models/searchTerminalActionsResponse.ts | 2 +- src/models/searchTerminalCheckoutsRequest.ts | 2 +- src/models/searchTerminalCheckoutsResponse.ts | 2 +- src/models/searchTerminalRefundsResponse.ts | 2 +- src/models/searchVendorsRequest.ts | 5 +- src/models/searchVendorsRequestFilter.ts | 4 +- src/models/searchVendorsResponse.ts | 2 +- src/models/segmentFilter.ts | 2 +- src/models/sourceApplication.ts | 2 +- src/models/subscription.ts | 8 +- src/models/teamMemberAssignedLocations.ts | 2 +- src/models/teamMemberBookingProfile.ts | 2 +- src/models/tender.ts | 2 +- src/models/terminalCheckout.ts | 23 + src/models/testWebhookSubscriptionRequest.ts | 4 +- src/models/transaction.ts | 2 +- src/models/updateCatalogImageRequest.ts | 2 +- src/models/updateVendorRequest.ts | 4 +- ...eWebhookSubscriptionSignatureKeyRequest.ts | 2 +- src/models/upsertCatalogObjectRequest.ts | 2 +- src/models/vendor.ts | 20 +- src/models/vendorContact.ts | 16 +- src/models/voidTransactionResponse.ts | 2 +- 748 files changed, 33410 insertions(+), 4102 deletions(-) create mode 100644 doc/models/order-line-item-applied-service-charge.md create mode 100644 doc/models/order-service-charge-scope.md create mode 100644 doc/models/order-service-charge-treatment-type.md create mode 100644 doc/models/payment-options-delay-action.md create mode 100644 src/models/orderLineItemAppliedServiceCharge.ts diff --git a/README.md b/README.md index bc14df1e..260c6837 100644 --- a/README.md +++ b/README.md @@ -126,6 +126,8 @@ npm test * [Mobile Authorization] * [OAuth] +### Webhook Subscriptions +* [Webhook Subscriptions] ## Deprecated APIs The following Square APIs are [deprecated](https://developer.squareup.com/docs/build-basics/api-lifecycle): @@ -176,3 +178,4 @@ The following Square APIs are [deprecated](https://developer.squareup.com/docs/b [Gift Card Activities]: doc/api/gift-card-activities.md [Employees]: doc/api/employees.md [Transactions]: doc/api/transactions.md +[Webhook Subscriptions]: doc/api/webhook-subscriptions.md diff --git a/doc/api/booking-custom-attributes.md b/doc/api/booking-custom-attributes.md index 1d99c9b0..b548859b 100644 --- a/doc/api/booking-custom-attributes.md +++ b/doc/api/booking-custom-attributes.md @@ -381,10 +381,10 @@ async listBookingCustomAttributes( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `bookingId` | `string` | Template, Required | The ID of the target [booking](../../doc/models/booking.md). | +| `bookingId` | `string` | Template, Required | The ID of the target [booking](entity:Booking). | | `limit` | `number \| undefined` | Query, 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). | | `cursor` | `string \| undefined` | Query, 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). | -| `withDefinitions` | `boolean \| undefined` | Query, Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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`.
**Default**: `false` | +| `withDefinitions` | `boolean \| undefined` | Query, 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`.
**Default**: `false` | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -431,7 +431,7 @@ async deleteBookingCustomAttribute( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `bookingId` | `string` | Template, Required | The ID of the target [booking](../../doc/models/booking.md). | +| `bookingId` | `string` | Template, Required | The ID of the target [booking](entity:Booking). | | `key` | `string` | Template, Required | 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. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -478,9 +478,9 @@ async retrieveBookingCustomAttribute( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `bookingId` | `string` | Template, Required | The ID of the target [booking](../../doc/models/booking.md). | +| `bookingId` | `string` | Template, Required | The ID of the target [booking](entity:Booking). | | `key` | `string` | Template, Required | 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. | -| `withDefinition` | `boolean \| undefined` | Query, Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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`.
**Default**: `false` | +| `withDefinition` | `boolean \| undefined` | Query, 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`.
**Default**: `false` | | `version` | `number \| undefined` | Query, 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. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -530,7 +530,7 @@ async upsertBookingCustomAttribute( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `bookingId` | `string` | Template, Required | The ID of the target [booking](../../doc/models/booking.md). | +| `bookingId` | `string` | Template, Required | The ID of the target [booking](entity:Booking). | | `key` | `string` | Template, Required | 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. | | `body` | [`UpsertBookingCustomAttributeRequest`](../../doc/models/upsert-booking-custom-attribute-request.md) | Body, Required | An object containing the fields to POST for the request.

See the corresponding object definition for field details. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | diff --git a/doc/api/bookings.md b/doc/api/bookings.md index 7dff65c0..94b89878 100644 --- a/doc/api/bookings.md +++ b/doc/api/bookings.md @@ -78,8 +78,8 @@ Creates a booking. The required input must include the following: -- `Booking.location_id`, -- `Booking.start_at`, +- `Booking.location_id` +- `Booking.start_at` - `Booking.team_member_id` - `Booking.AppointmentSegment.service_variation_id` - `Booking.AppointmentSegment.service_variation_version` @@ -325,7 +325,7 @@ async retrieveBooking( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `bookingId` | `string` | Template, Required | The ID of the [Booking](../../doc/models/booking.md) object representing the to-be-retrieved booking. | +| `bookingId` | `string` | Template, Required | The ID of the [Booking](entity:Booking) object representing the to-be-retrieved booking. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -371,7 +371,7 @@ async updateBooking( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `bookingId` | `string` | Template, Required | The ID of the [Booking](../../doc/models/booking.md) object representing the to-be-updated booking. | +| `bookingId` | `string` | Template, Required | The ID of the [Booking](entity:Booking) object representing the to-be-updated booking. | | `body` | [`UpdateBookingRequest`](../../doc/models/update-booking-request.md) | Body, Required | An object containing the fields to POST for the request.

See the corresponding object definition for field details. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -425,7 +425,7 @@ async cancelBooking( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `bookingId` | `string` | Template, Required | The ID of the [Booking](../../doc/models/booking.md) object representing the to-be-cancelled booking. | +| `bookingId` | `string` | Template, Required | The ID of the [Booking](entity:Booking) object representing the to-be-cancelled booking. | | `body` | [`CancelBookingRequest`](../../doc/models/cancel-booking-request.md) | Body, Required | An object containing the fields to POST for the request.

See the corresponding object definition for field details. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | diff --git a/doc/api/cards.md b/doc/api/cards.md index e190a501..71af0070 100644 --- a/doc/api/cards.md +++ b/doc/api/cards.md @@ -36,7 +36,7 @@ async listCards( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `cursor` | `string \| undefined` | Query, 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/basics/api101/pagination) for more information. | +| `cursor` | `string \| undefined` | Query, 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. | | `customerId` | `string \| undefined` | Query, Optional | Limit results to cards associated with the customer supplied.
By default, all cards owned by the merchant are returned. | | `includeDisabled` | `boolean \| undefined` | Query, Optional | Includes disabled cards.
By default, all enabled cards owned by the merchant are returned.
**Default**: `false` | | `referenceId` | `string \| undefined` | Query, Optional | Limit results to cards associated with the reference_id supplied. | diff --git a/doc/api/catalog.md b/doc/api/catalog.md index 1ae932d9..0dcce39c 100644 --- a/doc/api/catalog.md +++ b/doc/api/catalog.md @@ -478,8 +478,8 @@ async listCatalog( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `cursor` | `string \| undefined` | Query, 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/basics/api101/pagination) for more information. | -| `types` | `string \| undefined` | Query, Optional | An optional case-insensitive, comma-separated list of object types to retrieve.

The valid values are defined in the [CatalogObjectType](../../doc/models/catalog-object-type.md) 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. | +| `cursor` | `string \| undefined` | Query, 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. | +| `types` | `string \| undefined` | Query, 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. | | `catalogVersion` | `bigint \| undefined` | Query, 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. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -548,10 +548,15 @@ bodyObjectItemDatavariations0.itemVariationData = bodyObjectItemDatavariations0I bodyObjectItemDataVariations[0] = bodyObjectItemDatavariations0; +const bodyObjectItemDatavariations1ItemVariationDataPriceMoney: Money = {}; +bodyObjectItemDatavariations1ItemVariationDataPriceMoney.amount = BigInt(400); +bodyObjectItemDatavariations1ItemVariationDataPriceMoney.currency = 'USD'; + const bodyObjectItemDatavariations1ItemVariationData: CatalogItemVariation = {}; bodyObjectItemDatavariations1ItemVariationData.itemId = '#Cocoa'; bodyObjectItemDatavariations1ItemVariationData.name = 'Large'; bodyObjectItemDatavariations1ItemVariationData.pricingType = 'FIXED_PRICING'; +bodyObjectItemDatavariations1ItemVariationData.priceMoney = bodyObjectItemDatavariations1ItemVariationDataPriceMoney; const bodyObjectItemDatavariations1: CatalogObject = { type: 'ITEM_VARIATION', diff --git a/doc/api/checkout.md b/doc/api/checkout.md index c3bb7ce3..7015ddf8 100644 --- a/doc/api/checkout.md +++ b/doc/api/checkout.md @@ -28,7 +28,7 @@ payment processing workflow hosted on connect.squareup.com. NOTE: The Checkout API has been updated with new features. For more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights). -We recommend that you use the new [CreatePaymentLink](../../doc/api/checkout.md#create-payment-link)  +We recommend that you use the new [CreatePaymentLink](api-endpoint:Checkout-CreatePaymentLink)  endpoint in place of this previously released endpoint. ```ts @@ -74,26 +74,35 @@ const bodyOrderOrderlineItems0appliedDiscounts0: OrderLineItemAppliedDiscount = bodyOrderOrderlineItems0AppliedDiscounts[0] = bodyOrderOrderlineItems0appliedDiscounts0; +const bodyOrderOrderlineItems0BasePriceMoney: Money = {}; + const bodyOrderOrderlineItems0: OrderLineItem = { quantity: '2', }; bodyOrderOrderlineItems0.name = 'Printed T Shirt'; bodyOrderOrderlineItems0.appliedTaxes = bodyOrderOrderlineItems0AppliedTaxes; bodyOrderOrderlineItems0.appliedDiscounts = bodyOrderOrderlineItems0AppliedDiscounts; +bodyOrderOrderlineItems0.basePriceMoney = bodyOrderOrderlineItems0BasePriceMoney; bodyOrderOrderLineItems[0] = bodyOrderOrderlineItems0; +const bodyOrderOrderlineItems1BasePriceMoney: Money = {}; + const bodyOrderOrderlineItems1: OrderLineItem = { quantity: '1', }; bodyOrderOrderlineItems1.name = 'Slim Jeans'; +bodyOrderOrderlineItems1.basePriceMoney = bodyOrderOrderlineItems1BasePriceMoney; bodyOrderOrderLineItems[1] = bodyOrderOrderlineItems1; +const bodyOrderOrderlineItems2BasePriceMoney: Money = {}; + const bodyOrderOrderlineItems2: OrderLineItem = { quantity: '3', }; bodyOrderOrderlineItems2.name = 'Woven Sweater'; +bodyOrderOrderlineItems2.basePriceMoney = bodyOrderOrderlineItems2BasePriceMoney; bodyOrderOrderLineItems[2] = bodyOrderOrderlineItems2; @@ -109,9 +118,12 @@ bodyOrderOrderTaxes[0] = bodyOrderOrdertaxes0; const bodyOrderOrderDiscounts: OrderLineItemDiscount[] = []; +const bodyOrderOrderdiscounts0AmountMoney: Money = {}; + const bodyOrderOrderdiscounts0: OrderLineItemDiscount = {}; bodyOrderOrderdiscounts0.uid = '56ae1696-z1e3-9328-af6d-f1e04d947gd4'; bodyOrderOrderdiscounts0.type = 'FIXED_AMOUNT'; +bodyOrderOrderdiscounts0.amountMoney = bodyOrderOrderdiscounts0AmountMoney; bodyOrderOrderdiscounts0.scope = 'LINE_ITEM'; bodyOrderOrderDiscounts[0] = bodyOrderOrderdiscounts0; diff --git a/doc/api/customer-custom-attributes.md b/doc/api/customer-custom-attributes.md index 3cee296d..1019782b 100644 --- a/doc/api/customer-custom-attributes.md +++ b/doc/api/customer-custom-attributes.md @@ -353,10 +353,10 @@ async listCustomerCustomAttributes( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `customerId` | `string` | Template, Required | The ID of the target [customer profile](../../doc/models/customer.md). | +| `customerId` | `string` | Template, Required | The ID of the target [customer profile](entity:Customer). | | `limit` | `number \| undefined` | Query, 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). | | `cursor` | `string \| undefined` | Query, 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). | -| `withDefinitions` | `boolean \| undefined` | Query, Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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`.
**Default**: `false` | +| `withDefinitions` | `boolean \| undefined` | Query, 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`.
**Default**: `false` | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -401,7 +401,7 @@ async deleteCustomerCustomAttribute( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `customerId` | `string` | Template, Required | The ID of the target [customer profile](../../doc/models/customer.md). | +| `customerId` | `string` | Template, Required | The ID of the target [customer profile](entity:Customer). | | `key` | `string` | Template, Required | 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. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -452,9 +452,9 @@ async retrieveCustomerCustomAttribute( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `customerId` | `string` | Template, Required | The ID of the target [customer profile](../../doc/models/customer.md). | +| `customerId` | `string` | Template, Required | The ID of the target [customer profile](entity:Customer). | | `key` | `string` | Template, Required | 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. | -| `withDefinition` | `boolean \| undefined` | Query, Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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`.
**Default**: `false` | +| `withDefinition` | `boolean \| undefined` | Query, 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`.
**Default**: `false` | | `version` | `number \| undefined` | Query, 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. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -506,7 +506,7 @@ async upsertCustomerCustomAttribute( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `customerId` | `string` | Template, Required | The ID of the target [customer profile](../../doc/models/customer.md). | +| `customerId` | `string` | Template, Required | The ID of the target [customer profile](entity:Customer). | | `key` | `string` | Template, Required | 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. | | `body` | [`UpsertCustomerCustomAttributeRequest`](../../doc/models/upsert-customer-custom-attribute-request.md) | Body, Required | An object containing the fields to POST for the request.

See the corresponding object definition for field details. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | diff --git a/doc/api/disputes.md b/doc/api/disputes.md index 3c5e1a4c..17c4c66f 100644 --- a/doc/api/disputes.md +++ b/doc/api/disputes.md @@ -38,7 +38,7 @@ async listDisputes( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `cursor` | `string \| undefined` | Query, 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/basics/api101/pagination). | +| `cursor` | `string \| undefined` | Query, 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). | | `states` | [`string \| undefined`](../../doc/models/dispute-state.md) | Query, Optional | The dispute states used to filter the result. If not specified, the endpoint returns all disputes. | | `locationId` | `string \| undefined` | Query, 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. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | diff --git a/doc/api/gift-card-activities.md b/doc/api/gift-card-activities.md index f2804877..b4aa4b8f 100644 --- a/doc/api/gift-card-activities.md +++ b/doc/api/gift-card-activities.md @@ -40,7 +40,7 @@ async listGiftCardActivities( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `giftCardId` | `string \| undefined` | Query, 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. | -| `type` | `string \| undefined` | Query, Optional | If a [type](../../doc/models/gift-card-activity-type.md) is provided, the endpoint returns gift card activities of the specified type.
Otherwise, the endpoint returns all types of gift card activities. | +| `type` | `string \| undefined` | Query, 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. | | `locationId` | `string \| undefined` | Query, 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. | | `beginTime` | `string \| undefined` | Query, 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. | | `endTime` | `string \| undefined` | Query, 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. | diff --git a/doc/api/gift-cards.md b/doc/api/gift-cards.md index 0deb7927..19d9fc6a 100644 --- a/doc/api/gift-cards.md +++ b/doc/api/gift-cards.md @@ -39,8 +39,8 @@ async listGiftCards( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `type` | `string \| undefined` | Query, Optional | If a [type](../../doc/models/gift-card-type.md) is provided, the endpoint returns gift cards of the specified type.
Otherwise, the endpoint returns gift cards of all types. | -| `state` | `string \| undefined` | Query, Optional | If a [state](../../doc/models/gift-card-status.md) is provided, the endpoint returns the gift cards in the specified state.
Otherwise, the endpoint returns the gift cards of all states. | +| `type` | `string \| undefined` | Query, 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. | +| `state` | `string \| undefined` | Query, 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. | | `limit` | `number \| undefined` | Query, Optional | If a limit is provided, the endpoint returns only the specified number of results per page.
The maximum value is 50. The default value is 30.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). | | `cursor` | `string \| undefined` | Query, 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). | | `customerId` | `string \| undefined` | Query, Optional | If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer. | diff --git a/doc/api/inventory.md b/doc/api/inventory.md index 437ad32f..474ddf51 100644 --- a/doc/api/inventory.md +++ b/doc/api/inventory.md @@ -29,7 +29,7 @@ const inventoryApi = client.inventoryApi; **This endpoint is deprecated.** -Deprecated version of [RetrieveInventoryAdjustment](../../doc/api/inventory.md#retrieve-inventory-adjustment) after the endpoint URL +Deprecated version of [RetrieveInventoryAdjustment](api-endpoint:Inventory-RetrieveInventoryAdjustment) after the endpoint URL is updated to conform to the standard convention. ```ts @@ -43,7 +43,7 @@ async deprecatedRetrieveInventoryAdjustment( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `adjustmentId` | `string` | Template, Required | ID of the [InventoryAdjustment](../../doc/models/inventory-adjustment.md) to retrieve. | +| `adjustmentId` | `string` | Template, Required | ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -83,7 +83,7 @@ async retrieveInventoryAdjustment( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `adjustmentId` | `string` | Template, Required | ID of the [InventoryAdjustment](../../doc/models/inventory-adjustment.md) to retrieve. | +| `adjustmentId` | `string` | Template, Required | ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -111,7 +111,7 @@ try { **This endpoint is deprecated.** -Deprecated version of [BatchChangeInventory](../../doc/api/inventory.md#batch-change-inventory) after the endpoint URL +Deprecated version of [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) after the endpoint URL is updated to conform to the standard convention. ```ts @@ -176,7 +176,7 @@ try { **This endpoint is deprecated.** -Deprecated version of [BatchRetrieveInventoryChanges](../../doc/api/inventory.md#batch-retrieve-inventory-changes) after the endpoint URL +Deprecated version of [BatchRetrieveInventoryChanges](api-endpoint:Inventory-BatchRetrieveInventoryChanges) after the endpoint URL is updated to conform to the standard convention. ```ts @@ -230,7 +230,7 @@ try { **This endpoint is deprecated.** -Deprecated version of [BatchRetrieveInventoryCounts](../../doc/api/inventory.md#batch-retrieve-inventory-counts) after the endpoint URL +Deprecated version of [BatchRetrieveInventoryCounts](api-endpoint:Inventory-BatchRetrieveInventoryCounts) after the endpoint URL is updated to conform to the standard convention. ```ts @@ -459,7 +459,7 @@ try { **This endpoint is deprecated.** -Deprecated version of [RetrieveInventoryPhysicalCount](../../doc/api/inventory.md#retrieve-inventory-physical-count) after the endpoint URL +Deprecated version of [RetrieveInventoryPhysicalCount](api-endpoint:Inventory-RetrieveInventoryPhysicalCount) after the endpoint URL is updated to conform to the standard convention. ```ts @@ -473,7 +473,7 @@ async deprecatedRetrieveInventoryPhysicalCount( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `physicalCountId` | `string` | Template, Required | ID of the
[InventoryPhysicalCount](../../doc/models/inventory-physical-count.md) to retrieve. | +| `physicalCountId` | `string` | Template, Required | ID of the
[InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -513,7 +513,7 @@ async retrieveInventoryPhysicalCount( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `physicalCountId` | `string` | Template, Required | ID of the
[InventoryPhysicalCount](../../doc/models/inventory-physical-count.md) to retrieve. | +| `physicalCountId` | `string` | Template, Required | ID of the
[InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -553,7 +553,7 @@ async retrieveInventoryTransfer( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `transferId` | `string` | Template, Required | ID of the [InventoryTransfer](../../doc/models/inventory-transfer.md) to retrieve. | +| `transferId` | `string` | Template, Required | ID of the [InventoryTransfer](entity:InventoryTransfer) to retrieve. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -597,8 +597,8 @@ async retrieveInventoryCount( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `catalogObjectId` | `string` | Template, Required | ID of the [CatalogObject](../../doc/models/catalog-object.md) to retrieve. | -| `locationIds` | `string \| undefined` | Query, Optional | The [Location](../../doc/models/location.md) IDs to look up as a comma-separated
list. An empty list queries all locations. | +| `catalogObjectId` | `string` | Template, Required | ID of the [CatalogObject](entity:CatalogObject) to retrieve. | +| `locationIds` | `string \| undefined` | Query, Optional | The [Location](entity:Location) IDs to look up as a comma-separated
list. An empty list queries all locations. | | `cursor` | `string \| undefined` | Query, 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. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -628,10 +628,10 @@ try { **This endpoint is deprecated.** Returns a set of physical counts and inventory adjustments for the -provided [CatalogObject](../../doc/models/catalog-object.md) at the requested -[Location](../../doc/models/location.md)s. +provided [CatalogObject](entity:CatalogObject) at the requested +[Location](entity:Location)s. -You can achieve the same result by calling [BatchRetrieveInventoryChanges](../../doc/api/inventory.md#batch-retrieve-inventory-changes) +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 @@ -654,8 +654,8 @@ async retrieveInventoryChanges( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `catalogObjectId` | `string` | Template, Required | ID of the [CatalogObject](../../doc/models/catalog-object.md) to retrieve. | -| `locationIds` | `string \| undefined` | Query, Optional | The [Location](../../doc/models/location.md) IDs to look up as a comma-separated
list. An empty list queries all locations. | +| `catalogObjectId` | `string` | Template, Required | ID of the [CatalogObject](entity:CatalogObject) to retrieve. | +| `locationIds` | `string \| undefined` | Query, Optional | The [Location](entity:Location) IDs to look up as a comma-separated
list. An empty list queries all locations. | | `cursor` | `string \| undefined` | Query, 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. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | diff --git a/doc/api/invoices.md b/doc/api/invoices.md index 85f8a1af..dad53b6f 100644 --- a/doc/api/invoices.md +++ b/doc/api/invoices.md @@ -257,7 +257,7 @@ async deleteInvoice( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `invoiceId` | `string` | Template, Required | The ID of the invoice to delete. | -| `version` | `number \| undefined` | Query, Optional | The version of the [invoice](../../doc/models/invoice.md) to delete.
If you do not know the version, you can call [GetInvoice](../../doc/api/invoices.md#get-invoice) or
[ListInvoices](../../doc/api/invoices.md#list-invoices). | +| `version` | `number \| undefined` | Query, 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). | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -403,7 +403,7 @@ async cancelInvoice( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `invoiceId` | `string` | Template, Required | The ID of the [invoice](../../doc/models/invoice.md) to cancel. | +| `invoiceId` | `string` | Template, Required | The ID of the [invoice](entity:Invoice) to cancel. | | `body` | [`CancelInvoiceRequest`](../../doc/models/cancel-invoice-request.md) | Body, Required | An object containing the fields to POST for the request.

See the corresponding object definition for field details. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | diff --git a/doc/api/location-custom-attributes.md b/doc/api/location-custom-attributes.md index 5f3cf0e4..4633265f 100644 --- a/doc/api/location-custom-attributes.md +++ b/doc/api/location-custom-attributes.md @@ -384,11 +384,11 @@ async listLocationCustomAttributes( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `locationId` | `string` | Template, Required | The ID of the target [location](../../doc/models/location.md). | +| `locationId` | `string` | Template, Required | The ID of the target [location](entity:Location). | | `visibilityFilter` | [`string \| undefined`](../../doc/models/visibility-filter.md) | Query, Optional | Filters the `CustomAttributeDefinition` results by their `visibility` values. | | `limit` | `number \| undefined` | Query, 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). | | `cursor` | `string \| undefined` | Query, 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). | -| `withDefinitions` | `boolean \| undefined` | Query, Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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`.
**Default**: `false` | +| `withDefinitions` | `boolean \| undefined` | Query, 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`.
**Default**: `false` | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -431,7 +431,7 @@ async deleteLocationCustomAttribute( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `locationId` | `string` | Template, Required | The ID of the target [location](../../doc/models/location.md). | +| `locationId` | `string` | Template, Required | The ID of the target [location](entity:Location). | | `key` | `string` | Template, Required | 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. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -479,9 +479,9 @@ async retrieveLocationCustomAttribute( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `locationId` | `string` | Template, Required | The ID of the target [location](../../doc/models/location.md). | +| `locationId` | `string` | Template, Required | The ID of the target [location](entity:Location). | | `key` | `string` | Template, Required | 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. | -| `withDefinition` | `boolean \| undefined` | Query, Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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`.
**Default**: `false` | +| `withDefinition` | `boolean \| undefined` | Query, 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`.
**Default**: `false` | | `version` | `number \| undefined` | Query, 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. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -530,7 +530,7 @@ async upsertLocationCustomAttribute( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `locationId` | `string` | Template, Required | The ID of the target [location](../../doc/models/location.md). | +| `locationId` | `string` | Template, Required | The ID of the target [location](entity:Location). | | `key` | `string` | Template, Required | 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. | | `body` | [`UpsertLocationCustomAttributeRequest`](../../doc/models/upsert-location-custom-attribute-request.md) | Body, Required | An object containing the fields to POST for the request.

See the corresponding object definition for field details. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | diff --git a/doc/api/loyalty.md b/doc/api/loyalty.md index ec4bf31c..5e14a4b0 100644 --- a/doc/api/loyalty.md +++ b/doc/api/loyalty.md @@ -154,7 +154,7 @@ async retrieveLoyaltyAccount( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `accountId` | `string` | Template, Required | The ID of the [loyalty account](../../doc/models/loyalty-account.md) to retrieve. | +| `accountId` | `string` | Template, Required | The ID of the [loyalty account](entity:LoyaltyAccount) to retrieve. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -207,7 +207,7 @@ async accumulateLoyaltyPoints( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `accountId` | `string` | Template, Required | The ID of the target [loyalty account](../../doc/models/loyalty-account.md). | +| `accountId` | `string` | Template, Required | The ID of the target [loyalty account](entity:LoyaltyAccount). | | `body` | [`AccumulateLoyaltyPointsRequest`](../../doc/models/accumulate-loyalty-points-request.md) | Body, Required | An object containing the fields to POST for the request.

See the corresponding object definition for field details. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -262,7 +262,7 @@ async adjustLoyaltyPoints( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `accountId` | `string` | Template, Required | The ID of the target [loyalty account](../../doc/models/loyalty-account.md). | +| `accountId` | `string` | Template, Required | The ID of the target [loyalty account](entity:LoyaltyAccount). | | `body` | [`AdjustLoyaltyPointsRequest`](../../doc/models/adjust-loyalty-points-request.md) | Body, Required | An object containing the fields to POST for the request.

See the corresponding object definition for field details. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -365,7 +365,7 @@ try { 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](../../doc/api/loyalty.md#retrieve-loyalty-program) when used with the keyword `main`. +Replaced with [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when used with the keyword `main`. ```ts async listLoyaltyPrograms( @@ -470,7 +470,7 @@ async calculateLoyaltyPoints( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `programId` | `string` | Template, Required | The ID of the [loyalty program](../../doc/models/loyalty-program.md), which defines the rules for accruing points. | +| `programId` | `string` | Template, Required | The ID of the [loyalty program](entity:LoyaltyProgram), which defines the rules for accruing points. | | `body` | [`CalculateLoyaltyPointsRequest`](../../doc/models/calculate-loyalty-points-request.md) | Body, Required | An object containing the fields to POST for the request.

See the corresponding object definition for field details. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -519,7 +519,7 @@ async listLoyaltyPromotions( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `programId` | `string` | Template, Required | The ID of the base [loyalty program](../../doc/models/loyalty-program.md). To get the program ID,
call [RetrieveLoyaltyProgram](../../doc/api/loyalty.md#retrieve-loyalty-program) using the `main` keyword. | +| `programId` | `string` | Template, Required | The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID,
call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword. | | `status` | [`string \| undefined`](../../doc/models/loyalty-promotion-status.md) | Query, Optional | 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. | | `cursor` | `string \| undefined` | Query, 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). | | `limit` | `number \| undefined` | Query, 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). | @@ -567,7 +567,7 @@ async createLoyaltyPromotion( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `programId` | `string` | Template, Required | The ID of the [loyalty program](../../doc/models/loyalty-program.md) to associate with the promotion.
To get the program ID, call [RetrieveLoyaltyProgram](../../doc/api/loyalty.md#retrieve-loyalty-program)
using the `main` keyword. | +| `programId` | `string` | Template, Required | 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. | | `body` | [`CreateLoyaltyPromotionRequest`](../../doc/models/create-loyalty-promotion-request.md) | Body, Required | An object containing the fields to POST for the request.

See the corresponding object definition for field details. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -647,8 +647,8 @@ async retrieveLoyaltyPromotion( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `promotionId` | `string` | Template, Required | The ID of the [loyalty promotion](../../doc/models/loyalty-promotion.md) to retrieve. | -| `programId` | `string` | Template, Required | The ID of the base [loyalty program](../../doc/models/loyalty-program.md). To get the program ID,
call [RetrieveLoyaltyProgram](../../doc/api/loyalty.md#retrieve-loyalty-program) using the `main` keyword. | +| `promotionId` | `string` | Template, Required | The ID of the [loyalty promotion](entity:LoyaltyPromotion) to retrieve. | +| `programId` | `string` | Template, Required | The ID of the base [loyalty program](entity:LoyaltyProgram). To get the program ID,
call [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) using the `main` keyword. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -694,8 +694,8 @@ async cancelLoyaltyPromotion( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `promotionId` | `string` | Template, Required | The ID of the [loyalty promotion](../../doc/models/loyalty-promotion.md) to cancel. You can cancel a
promotion that has an `ACTIVE` or `SCHEDULED` status. | -| `programId` | `string` | Template, Required | The ID of the base [loyalty program](../../doc/models/loyalty-program.md). | +| `promotionId` | `string` | Template, Required | The ID of the [loyalty promotion](entity:LoyaltyPromotion) to cancel. You can cancel a
promotion that has an `ACTIVE` or `SCHEDULED` status. | +| `programId` | `string` | Template, Required | The ID of the base [loyalty program](entity:LoyaltyProgram). | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -853,7 +853,7 @@ async deleteLoyaltyReward( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `rewardId` | `string` | Template, Required | The ID of the [loyalty reward](../../doc/models/loyalty-reward.md) to delete. | +| `rewardId` | `string` | Template, Required | The ID of the [loyalty reward](entity:LoyaltyReward) to delete. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -892,7 +892,7 @@ async retrieveLoyaltyReward( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `rewardId` | `string` | Template, Required | The ID of the [loyalty reward](../../doc/models/loyalty-reward.md) to retrieve. | +| `rewardId` | `string` | Template, Required | The ID of the [loyalty reward](entity:LoyaltyReward) to retrieve. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -942,7 +942,7 @@ async redeemLoyaltyReward( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `rewardId` | `string` | Template, Required | The ID of the [loyalty reward](../../doc/models/loyalty-reward.md) to redeem. | +| `rewardId` | `string` | Template, Required | The ID of the [loyalty reward](entity:LoyaltyReward) to redeem. | | `body` | [`RedeemLoyaltyRewardRequest`](../../doc/models/redeem-loyalty-reward-request.md) | Body, Required | An object containing the fields to POST for the request.

See the corresponding object definition for field details. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | diff --git a/doc/api/order-custom-attributes.md b/doc/api/order-custom-attributes.md index 5ba2b51a..c5ebd8ad 100644 --- a/doc/api/order-custom-attributes.md +++ b/doc/api/order-custom-attributes.md @@ -404,11 +404,11 @@ async listOrderCustomAttributes( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `orderId` | `string` | Template, Required | The ID of the target [order](../../doc/models/order.md). | +| `orderId` | `string` | Template, Required | The ID of the target [order](entity:Order). | | `visibilityFilter` | [`string \| undefined`](../../doc/models/visibility-filter.md) | Query, Optional | Requests that all of the custom attributes be returned, or only those that are read-only or read-write. | | `cursor` | `string \| undefined` | Query, 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). | | `limit` | `number \| undefined` | Query, 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). | -| `withDefinitions` | `boolean \| undefined` | Query, Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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`.
**Default**: `false` | +| `withDefinitions` | `boolean \| undefined` | Query, 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`.
**Default**: `false` | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -453,7 +453,7 @@ async deleteOrderCustomAttribute( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `orderId` | `string` | Template, Required | The ID of the target [order](../../doc/models/order.md). | +| `orderId` | `string` | Template, Required | The ID of the target [order](entity:Order). | | `customAttributeKey` | `string` | Template, Required | The key of the custom attribute to delete. This key must match the key of an
existing custom attribute definition. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -504,10 +504,10 @@ async retrieveOrderCustomAttribute( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `orderId` | `string` | Template, Required | The ID of the target [order](../../doc/models/order.md). | +| `orderId` | `string` | Template, Required | The ID of the target [order](entity:Order). | | `customAttributeKey` | `string` | Template, Required | The key of the custom attribute to retrieve. This key must match the key of an
existing custom attribute definition. | | `version` | `number \| undefined` | Query, 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. | -| `withDefinition` | `boolean \| undefined` | Query, Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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`.
**Default**: `false` | +| `withDefinition` | `boolean \| undefined` | Query, 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`.
**Default**: `false` | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -558,7 +558,7 @@ async upsertOrderCustomAttribute( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `orderId` | `string` | Template, Required | The ID of the target [order](../../doc/models/order.md). | +| `orderId` | `string` | Template, Required | The ID of the target [order](entity:Order). | | `customAttributeKey` | `string` | Template, Required | The key of the custom attribute to create or update. This key must match the key
of an existing custom attribute definition. | | `body` | [`UpsertOrderCustomAttributeRequest`](../../doc/models/upsert-order-custom-attribute-request.md) | Body, Required | An object containing the fields to POST for the request.

See the corresponding object definition for field details. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | diff --git a/doc/api/orders.md b/doc/api/orders.md index 0ae4a63c..19d39cd2 100644 --- a/doc/api/orders.md +++ b/doc/api/orders.md @@ -54,10 +54,13 @@ async createOrder( const contentType = null; const bodyOrderLineItems: OrderLineItem[] = []; +const bodyOrderlineItems0BasePriceMoney: Money = {}; + const bodyOrderlineItems0: OrderLineItem = { quantity: '1', }; bodyOrderlineItems0.name = 'New York Strip Steak'; +bodyOrderlineItems0.basePriceMoney = bodyOrderlineItems0BasePriceMoney; bodyOrderLineItems[0] = bodyOrderlineItems0; @@ -112,9 +115,12 @@ bodyOrderdiscounts1.scope = 'ORDER'; bodyOrderDiscounts[1] = bodyOrderdiscounts1; +const bodyOrderdiscounts2AmountMoney: Money = {}; + const bodyOrderdiscounts2: OrderLineItemDiscount = {}; bodyOrderdiscounts2.uid = 'one-dollar-off'; bodyOrderdiscounts2.name = 'Sale - $1.00 off'; +bodyOrderdiscounts2.amountMoney = bodyOrderdiscounts2AmountMoney; bodyOrderdiscounts2.scope = 'LINE_ITEM'; bodyOrderDiscounts[2] = bodyOrderdiscounts2; @@ -219,17 +225,23 @@ async calculateOrder( const contentType = null; const bodyOrderLineItems: OrderLineItem[] = []; +const bodyOrderlineItems0BasePriceMoney: Money = {}; + const bodyOrderlineItems0: OrderLineItem = { quantity: '1', }; bodyOrderlineItems0.name = 'Item 1'; +bodyOrderlineItems0.basePriceMoney = bodyOrderlineItems0BasePriceMoney; bodyOrderLineItems[0] = bodyOrderlineItems0; +const bodyOrderlineItems1BasePriceMoney: Money = {}; + const bodyOrderlineItems1: OrderLineItem = { quantity: '2', }; bodyOrderlineItems1.name = 'Item 2'; +bodyOrderlineItems1.basePriceMoney = bodyOrderlineItems1BasePriceMoney; bodyOrderLineItems[1] = bodyOrderlineItems1; @@ -360,8 +372,6 @@ const bodyQueryFilterStateFilter: SearchOrdersStateFilter = { }; const bodyQueryFilterDateTimeFilterClosedAt: TimeRange = {}; -bodyQueryFilterDateTimeFilterClosedAt.startAt = '2018-03-03T20:00:00+00:00'; -bodyQueryFilterDateTimeFilterClosedAt.endAt = '2019-03-04T21:54:45+00:00'; const bodyQueryFilterDateTimeFilter: SearchOrdersDateTimeFilter = {}; bodyQueryFilterDateTimeFilter.closedAt = bodyQueryFilterDateTimeFilterClosedAt; diff --git a/doc/api/payments.md b/doc/api/payments.md index 05f92372..88596a03 100644 --- a/doc/api/payments.md +++ b/doc/api/payments.md @@ -47,10 +47,10 @@ async listPayments( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `beginTime` | `string \| undefined` | Query, Optional | The timestamp for the beginning of the reporting period, in RFC 3339 format.
Inclusive. Default: The current time minus one year. | -| `endTime` | `string \| undefined` | Query, Optional | The timestamp for the end of the reporting period, in RFC 3339 format.

Default: The current time. | -| `sortOrder` | `string \| undefined` | Query, Optional | The order in which results are listed:

- `ASC` - Oldest to newest.
- `DESC` - Newest to oldest (default). | -| `cursor` | `string \| undefined` | Query, 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/basics/api101/pagination). | +| `beginTime` | `string \| undefined` | Query, 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. | +| `endTime` | `string \| undefined` | Query, 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. | +| `sortOrder` | `string \| undefined` | Query, Optional | The order in which results are listed by `Payment.created_at`:

- `ASC` - Oldest to newest.
- `DESC` - Newest to oldest (default). | +| `cursor` | `string \| undefined` | Query, 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). | | `locationId` | `string \| undefined` | Query, Optional | Limit results to the location supplied. By default, results are returned
for the default (main) location associated with the seller. | | `total` | `bigint \| undefined` | Query, Optional | The exact amount in the `total_money` for a payment. | | `last4` | `string \| undefined` | Query, Optional | The last four digits of a payment card. | @@ -122,8 +122,8 @@ bodyAppFeeMoney.currency = 'USD'; const body: CreatePaymentRequest = { sourceId: 'ccof:GaJGNaZa8x4OgDJn4GB', idempotencyKey: '7b0f3ec5-086a-4871-8f13-3c81b3875218', - amountMoney: bodyAmountMoney, }; +body.amountMoney = bodyAmountMoney; body.appFeeMoney = bodyAppFeeMoney; body.autocomplete = true; body.customerId = 'W92WH6P11H4Z77CTET0RNTGFW8'; diff --git a/doc/api/payouts.md b/doc/api/payouts.md index b69c8fb3..a2f8a32b 100644 --- a/doc/api/payouts.md +++ b/doc/api/payouts.md @@ -43,7 +43,7 @@ async listPayouts( | `beginTime` | `string \| undefined` | Query, Optional | The timestamp for the beginning of the payout creation time, in RFC 3339 format.
Inclusive. Default: The current time minus one year. | | `endTime` | `string \| undefined` | Query, Optional | The timestamp for the end of the payout creation time, in RFC 3339 format.
Default: The current time. | | `sortOrder` | [`string \| undefined`](../../doc/models/sort-order.md) | Query, Optional | The order in which payouts are listed. | -| `cursor` | `string \| undefined` | Query, 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/basics/api101/pagination).
If request parameters change between requests, subsequent results may contain duplicates or missing records. | +| `cursor` | `string \| undefined` | Query, 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. | | `limit` | `number \| undefined` | Query, 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` | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -128,7 +128,7 @@ async listPayoutEntries( | --- | --- | --- | --- | | `payoutId` | `string` | Template, Required | The ID of the payout to retrieve the information for. | | `sortOrder` | [`string \| undefined`](../../doc/models/sort-order.md) | Query, Optional | The order in which payout entries are listed. | -| `cursor` | `string \| undefined` | Query, 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/basics/api101/pagination).
If request parameters change between requests, subsequent results may contain duplicates or missing records. | +| `cursor` | `string \| undefined` | Query, 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. | | `limit` | `number \| undefined` | Query, 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` | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | diff --git a/doc/api/refunds.md b/doc/api/refunds.md index 01e5a87f..f1ace2a5 100644 --- a/doc/api/refunds.md +++ b/doc/api/refunds.md @@ -42,12 +42,12 @@ async listPaymentRefunds( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `beginTime` | `string \| undefined` | Query, Optional | The timestamp for the beginning of the requested reporting period, in RFC 3339 format.

Default: The current time minus one year. | -| `endTime` | `string \| undefined` | Query, Optional | The timestamp for the end of the requested reporting period, in RFC 3339 format.

Default: The current time. | -| `sortOrder` | `string \| undefined` | Query, Optional | The order in which results are listed:

- `ASC` - Oldest to newest.
- `DESC` - Newest to oldest (default). | -| `cursor` | `string \| undefined` | Query, 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/basics/api101/pagination). | +| `beginTime` | `string \| undefined` | Query, 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. | +| `endTime` | `string \| undefined` | Query, 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. | +| `sortOrder` | `string \| undefined` | Query, Optional | The order in which results are listed by `PaymentRefund.created_at`:

- `ASC` - Oldest to newest.
- `DESC` - Newest to oldest (default). | +| `cursor` | `string \| undefined` | Query, 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). | | `locationId` | `string \| undefined` | Query, Optional | Limit results to the location supplied. By default, results are returned
for all locations associated with the seller. | -| `status` | `string \| undefined` | Query, Optional | If provided, only refunds with the given status are returned.
For a list of refund status values, see [PaymentRefund](../../doc/models/payment-refund.md).

Default: If omitted, refunds are returned regardless of their status. | +| `status` | `string \| undefined` | Query, 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. | | `sourceType` | `string \| undefined` | Query, 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. | | `limit` | `number \| undefined` | Query, 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 | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | diff --git a/doc/api/subscriptions.md b/doc/api/subscriptions.md index 47da8f62..0e286b64 100644 --- a/doc/api/subscriptions.md +++ b/doc/api/subscriptions.md @@ -57,6 +57,8 @@ const bodyPriceOverrideMoney: Money = {}; bodyPriceOverrideMoney.amount = BigInt(100); bodyPriceOverrideMoney.currency = 'USD'; +const bodySource: SubscriptionSource = {}; + const body: CreateSubscriptionRequest = { locationId: 'S8GWD5R9QB376', planId: '6JHXF3B2CW3YKHDV4XEM674H', @@ -68,6 +70,7 @@ body.taxPercentage = '5'; body.priceOverrideMoney = bodyPriceOverrideMoney; body.cardId = 'ccof:qy5x8hHGYsgLrp4Q4GB'; body.timezone = 'America/Los_Angeles'; +body.source = bodySource; try { const { result, ...httpResponse } = await subscriptionsApi.createSubscription(body); diff --git a/doc/api/transactions.md b/doc/api/transactions.md index cbd4243a..71f4a8e0 100644 --- a/doc/api/transactions.md +++ b/doc/api/transactions.md @@ -118,7 +118,7 @@ try { **This endpoint is deprecated.** -Captures a transaction that was created with the [Charge]($e/Transactions/Charge) +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) @@ -166,7 +166,7 @@ try { **This endpoint is deprecated.** -Cancels a transaction that was created with the [Charge]($e/Transactions/Charge) +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) diff --git a/doc/api/vendors.md b/doc/api/vendors.md index f2b1833a..33615b54 100644 --- a/doc/api/vendors.md +++ b/doc/api/vendors.md @@ -249,7 +249,7 @@ async retrieveVendor( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `vendorId` | `string` | Template, Required | ID of the [Vendor](../../doc/models/vendor.md) to retrieve. | +| `vendorId` | `string` | Template, Required | ID of the [Vendor](entity:Vendor) to retrieve. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type diff --git a/doc/api/webhook-subscriptions.md b/doc/api/webhook-subscriptions.md index 8bee1e35..6d3d0a59 100644 --- a/doc/api/webhook-subscriptions.md +++ b/doc/api/webhook-subscriptions.md @@ -77,8 +77,8 @@ async listWebhookSubscriptions( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | | `cursor` | `string \| undefined` | Query, 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/basics/api101/pagination). | -| `includeDisabled` | `boolean \| undefined` | Query, Optional | Includes disabled [Subscription](../../doc/models/webhook-subscription.md)s.
By default, all enabled [Subscription](../../doc/models/webhook-subscription.md)s are returned.
**Default**: `false` | -| `sortOrder` | [`string \| undefined`](../../doc/models/sort-order.md) | Query, Optional | Sorts the returned list by when the [Subscription](../../doc/models/webhook-subscription.md) was created with the specified order.
This field defaults to ASC. | +| `includeDisabled` | `boolean \| undefined` | Query, Optional | Includes disabled [Subscription](entity:WebhookSubscription)s.
By default, all enabled [Subscription](entity:WebhookSubscription)s are returned.
**Default**: `false` | +| `sortOrder` | [`string \| undefined`](../../doc/models/sort-order.md) | Query, Optional | Sorts the returned list by when the [Subscription](entity:WebhookSubscription) was created with the specified order.
This field defaults to ASC. | | `limit` | `number \| undefined` | Query, 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 | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -169,7 +169,7 @@ async deleteWebhookSubscription( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `subscriptionId` | `string` | Template, Required | [REQUIRED] The ID of the [Subscription](../../doc/models/webhook-subscription.md) to delete. | +| `subscriptionId` | `string` | Template, Required | [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -208,7 +208,7 @@ async retrieveWebhookSubscription( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `subscriptionId` | `string` | Template, Required | [REQUIRED] The ID of the [Subscription](../../doc/models/webhook-subscription.md) to retrieve. | +| `subscriptionId` | `string` | Template, Required | [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to retrieve. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | ## Response Type @@ -248,7 +248,7 @@ async updateWebhookSubscription( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `subscriptionId` | `string` | Template, Required | [REQUIRED] The ID of the [Subscription](../../doc/models/webhook-subscription.md) to update. | +| `subscriptionId` | `string` | Template, Required | [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update. | | `body` | [`UpdateWebhookSubscriptionRequest`](../../doc/models/update-webhook-subscription-request.md) | Body, Required | An object containing the fields to POST for the request.

See the corresponding object definition for field details. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -297,7 +297,7 @@ async updateWebhookSubscriptionSignatureKey( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `subscriptionId` | `string` | Template, Required | [REQUIRED] The ID of the [Subscription](../../doc/models/webhook-subscription.md) to update. | +| `subscriptionId` | `string` | Template, Required | [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to update. | | `body` | [`UpdateWebhookSubscriptionSignatureKeyRequest`](../../doc/models/update-webhook-subscription-signature-key-request.md) | Body, Required | An object containing the fields to POST for the request.

See the corresponding object definition for field details. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | @@ -342,7 +342,7 @@ async testWebhookSubscription( | Parameter | Type | Tags | Description | | --- | --- | --- | --- | -| `subscriptionId` | `string` | Template, Required | [REQUIRED] The ID of the [Subscription](../../doc/models/webhook-subscription.md) to test. | +| `subscriptionId` | `string` | Template, Required | [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to test. | | `body` | [`TestWebhookSubscriptionRequest`](../../doc/models/test-webhook-subscription-request.md) | Body, Required | An object containing the fields to POST for the request.

See the corresponding object definition for field details. | | `requestOptions` | `RequestOptions \| undefined` | Optional | Pass additional request options. | diff --git a/doc/client.md b/doc/client.md index 20e19692..4b398a6e 100644 --- a/doc/client.md +++ b/doc/client.md @@ -5,7 +5,7 @@ The following parameters are configurable for the API Client: | Parameter | Type | Description | | --- | --- | --- | -| `squareVersion` | `string` | Square Connect API versions
*Default*: `'2023-03-15'` | +| `squareVersion` | `string` | Square Connect API versions
*Default*: `'2023-04-19'` | | `customUrl` | `string` | Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
*Default*: `'https://connect.squareup.com'` | | `environment` | `string` | The API environment.
**Default: `production`** | | `additionalHeaders` | `Readonly>` | Additional headers to add to each API call
*Default*: `{}` | @@ -40,7 +40,7 @@ The API client can be initialized as follows: ```ts const client = new Client({ - squareVersion: '2023-03-15', + squareVersion: '2023-04-19', timeout: 60000, additionalHeaders: {}, userAgentDetail: '', @@ -55,7 +55,7 @@ const client = new Client({ import { ApiError, Client } from 'square'; const client = new Client({ - squareVersion: '2023-03-15', + squareVersion: '2023-04-19', timeout: 60000, additionalHeaders: {}, userAgentDetail: '', diff --git a/doc/models/accepted-payment-methods.md b/doc/models/accepted-payment-methods.md index 92e1d169..fc0287c8 100644 --- a/doc/models/accepted-payment-methods.md +++ b/doc/models/accepted-payment-methods.md @@ -18,10 +18,10 @@ ```json { - "apple_pay": null, - "google_pay": null, - "cash_app_pay": null, - "afterpay_clearpay": null + "apple_pay": false, + "google_pay": false, + "cash_app_pay": false, + "afterpay_clearpay": false } ``` diff --git a/doc/models/accumulate-loyalty-points-request.md b/doc/models/accumulate-loyalty-points-request.md index ecb502ca..7e39b4c3 100644 --- a/doc/models/accumulate-loyalty-points-request.md +++ b/doc/models/accumulate-loyalty-points-request.md @@ -13,7 +13,7 @@ Represents an [AccumulateLoyaltyPoints](../../doc/api/loyalty.md#accumulate-loya | --- | --- | --- | --- | | `accumulatePoints` | [`LoyaltyEventAccumulatePoints`](../../doc/models/loyalty-event-accumulate-points.md) | Required | Provides metadata when the event `type` is `ACCUMULATE_POINTS`. | | `idempotencyKey` | `string` | Required | A unique string that identifies the `AccumulateLoyaltyPoints` request.
Keys can be any valid string but must be unique for every request.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | -| `locationId` | `string` | Required | The [location](../../doc/models/location.md) where the purchase was made. | +| `locationId` | `string` | Required | The [location](entity:Location) where the purchase was made. | ## Example (as JSON) diff --git a/doc/models/ach-details.md b/doc/models/ach-details.md index a48686de..af1f689f 100644 --- a/doc/models/ach-details.md +++ b/doc/models/ach-details.md @@ -19,9 +19,9 @@ ACH-specific details about `BANK_ACCOUNT` type payments with the `transfer_type` ```json { - "routing_number": null, - "account_number_suffix": null, - "account_type": null + "routing_number": "routing_number4", + "account_number_suffix": "account_number_suffix8", + "account_type": "account_type4" } ``` diff --git a/doc/models/additional-recipient.md b/doc/models/additional-recipient.md index 977a6520..ad83eb62 100644 --- a/doc/models/additional-recipient.md +++ b/doc/models/additional-recipient.md @@ -21,12 +21,12 @@ Represents an additional recipient (other than the merchant) receiving a portion ```json { "location_id": "location_id4", - "description": null, + "description": "description0", "amount_money": { - "amount": null, - "currency": null + "amount": 186, + "currency": "NGN" }, - "receivable_id": null + "receivable_id": "receivable_id0" } ``` diff --git a/doc/models/address.md b/doc/models/address.md index b21c840e..c78aa42f 100644 --- a/doc/models/address.md +++ b/doc/models/address.md @@ -31,20 +31,20 @@ For more information, see [Working with Addresses](https://developer.squareup.co ```json { - "address_line_1": null, - "address_line_2": null, - "address_line_3": null, - "locality": null, - "sublocality": null, - "sublocality_2": null, - "sublocality_3": null, - "administrative_district_level_1": null, - "administrative_district_level_2": null, - "administrative_district_level_3": null, - "postal_code": null, - "country": null, - "first_name": null, - "last_name": null + "address_line_1": "address_line_10", + "address_line_2": "address_line_20", + "address_line_3": "address_line_36", + "locality": "locality0", + "sublocality": "sublocality0", + "sublocality_2": "sublocality_28", + "sublocality_3": "sublocality_30", + "administrative_district_level_1": "administrative_district_level_14", + "administrative_district_level_2": "administrative_district_level_24", + "administrative_district_level_3": "administrative_district_level_38", + "postal_code": "postal_code2", + "country": "FO", + "first_name": "first_name0", + "last_name": "last_name8" } ``` diff --git a/doc/models/afterpay-details.md b/doc/models/afterpay-details.md index 101fc4c2..ba2b9e26 100644 --- a/doc/models/afterpay-details.md +++ b/doc/models/afterpay-details.md @@ -17,7 +17,7 @@ Additional details about Afterpay payments. ```json { - "email_address": null + "email_address": "email_address2" } ``` diff --git a/doc/models/application-details.md b/doc/models/application-details.md index 1b8eb45e..573015e8 100644 --- a/doc/models/application-details.md +++ b/doc/models/application-details.md @@ -18,8 +18,8 @@ Details about the application that took the payment. ```json { - "square_product": null, - "application_id": null + "square_product": "TERMINAL_API", + "application_id": "application_id4" } ``` diff --git a/doc/models/appointment-segment.md b/doc/models/appointment-segment.md index 00c54f9e..acbabb87 100644 --- a/doc/models/appointment-segment.md +++ b/doc/models/appointment-segment.md @@ -12,8 +12,8 @@ Defines an appointment segment of a booking. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `durationMinutes` | `number \| undefined` | Optional | The time span in minutes of an appointment segment.
**Constraints**: `<= 1500` | -| `serviceVariationId` | `string \| undefined` | Optional | The ID of the [CatalogItemVariation](../../doc/models/catalog-item-variation.md) object representing the service booked in this segment.
**Constraints**: *Maximum Length*: `36` | -| `teamMemberId` | `string` | Required | The ID of the [TeamMember](../../doc/models/team-member.md) object representing the team member booked in this segment.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `32` | +| `serviceVariationId` | `string \| undefined` | Optional | The ID of the [CatalogItemVariation](entity:CatalogItemVariation) object representing the service booked in this segment.
**Constraints**: *Maximum Length*: `36` | +| `teamMemberId` | `string` | Required | The ID of the [TeamMember](entity:TeamMember) object representing the team member booked in this segment.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `32` | | `serviceVariationVersion` | `bigint \| undefined` | Optional | The current version of the item variation representing the service booked in this segment. | | `intermissionMinutes` | `number \| undefined` | Optional | Time between the end of this segment and the beginning of the subsequent segment. | | `anyTeamMember` | `boolean \| undefined` | Optional | Whether the customer accepts any team member, instead of a specific one, to serve this segment. | @@ -23,13 +23,16 @@ Defines an appointment segment of a booking. ```json { - "duration_minutes": null, - "service_variation_id": null, + "duration_minutes": 144, + "service_variation_id": "service_variation_id6", "team_member_id": "team_member_id0", - "service_variation_version": null, - "intermission_minutes": null, - "any_team_member": null, - "resource_ids": null + "service_variation_version": 56, + "intermission_minutes": 62, + "any_team_member": false, + "resource_ids": [ + "resource_ids0", + "resource_ids1" + ] } ``` diff --git a/doc/models/availability.md b/doc/models/availability.md index 6a5728f0..0daa397b 100644 --- a/doc/models/availability.md +++ b/doc/models/availability.md @@ -19,9 +19,22 @@ Defines an appointment slot that encapsulates the appointment segments, location ```json { - "start_at": null, - "location_id": null, - "appointment_segments": null + "start_at": "start_at2", + "location_id": "location_id4", + "appointment_segments": [ + { + "duration_minutes": 4, + "service_variation_id": "service_variation_id4", + "team_member_id": "team_member_id0", + "service_variation_version": 172, + "intermission_minutes": 178, + "any_team_member": false, + "resource_ids": [ + "resource_ids0", + "resource_ids1" + ] + } + ] } ``` diff --git a/doc/models/bank-account-payment-details.md b/doc/models/bank-account-payment-details.md index 681a54e4..4a984fc0 100644 --- a/doc/models/bank-account-payment-details.md +++ b/doc/models/bank-account-payment-details.md @@ -24,14 +24,37 @@ Additional details about BANK_ACCOUNT type payments. ```json { - "bank_name": null, - "transfer_type": null, - "account_ownership_type": null, - "fingerprint": null, - "country": null, - "statement_description": null, - "ach_details": null, - "errors": null + "bank_name": "bank_name4", + "transfer_type": "transfer_type8", + "account_ownership_type": "account_ownership_type8", + "fingerprint": "fingerprint6", + "country": "country4", + "statement_description": "statement_description4", + "ach_details": { + "routing_number": "routing_number0", + "account_number_suffix": "account_number_suffix2", + "account_type": "account_type2" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/bank-account.md b/doc/models/bank-account.md index bdc8dc7d..3f4e2ad4 100644 --- a/doc/models/bank-account.md +++ b/doc/models/bank-account.md @@ -42,16 +42,16 @@ linking a bank account to a Square account, see "account_type": "BUSINESS_CHECKING", "holder_name": "holder_name4", "primary_bank_identification_number": "primary_bank_identification_number8", - "secondary_bank_identification_number": null, - "debit_mandate_reference_id": null, - "reference_id": null, - "location_id": null, + "secondary_bank_identification_number": "secondary_bank_identification_number0", + "debit_mandate_reference_id": "debit_mandate_reference_id4", + "reference_id": "reference_id2", + "location_id": "location_id4", "status": "DISABLED", "creditable": false, "debitable": false, - "fingerprint": null, - "version": null, - "bank_name": null + "fingerprint": "fingerprint6", + "version": 172, + "bank_name": "bank_name4" } ``` diff --git a/doc/models/batch-change-inventory-request.md b/doc/models/batch-change-inventory-request.md index 93114088..f96b6ca9 100644 --- a/doc/models/batch-change-inventory-request.md +++ b/doc/models/batch-change-inventory-request.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `idempotencyKey` | `string` | Required | A client-supplied, universally unique identifier (UUID) for the
request.

See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the
[API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more
information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | +| `idempotencyKey` | `string` | Required | 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**: *Minimum Length*: `1`, *Maximum Length*: `128` | | `changes` | [`InventoryChange[] \| undefined`](../../doc/models/inventory-change.md) | Optional | The set of physical counts and inventory adjustments to be made.
Changes are applied based on the client-supplied timestamp and may be sent
out of order. | | `ignoreUnchangedCounts` | `boolean \| undefined` | Optional | Indicates whether the current physical count should be ignored if
the quantity is unchanged since the last physical count. Default: `true`. | diff --git a/doc/models/batch-retrieve-catalog-objects-response.md b/doc/models/batch-retrieve-catalog-objects-response.md index dac5cbd0..e9d95b34 100644 --- a/doc/models/batch-retrieve-catalog-objects-response.md +++ b/doc/models/batch-retrieve-catalog-objects-response.md @@ -10,8 +10,8 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | -| `objects` | [`CatalogObject[] \| undefined`](../../doc/models/catalog-object.md) | Optional | A list of [CatalogObject](../../doc/models/catalog-object.md)s returned. | -| `relatedObjects` | [`CatalogObject[] \| undefined`](../../doc/models/catalog-object.md) | Optional | A list of [CatalogObject](../../doc/models/catalog-object.md)s referenced by the object in the `objects` field. | +| `objects` | [`CatalogObject[] \| undefined`](../../doc/models/catalog-object.md) | Optional | A list of [CatalogObject](entity:CatalogObject)s returned. | +| `relatedObjects` | [`CatalogObject[] \| undefined`](../../doc/models/catalog-object.md) | Optional | A list of [CatalogObject](entity:CatalogObject)s referenced by the object in the `objects` field. | ## Example (as JSON) diff --git a/doc/models/batch-retrieve-inventory-changes-request.md b/doc/models/batch-retrieve-inventory-changes-request.md index c0d78758..fe09e1c7 100644 --- a/doc/models/batch-retrieve-inventory-changes-request.md +++ b/doc/models/batch-retrieve-inventory-changes-request.md @@ -16,7 +16,7 @@ | `updatedAfter` | `string \| undefined` | Optional | The filter to return results with their `calculated_at` value
after the given time as specified in an RFC 3339 timestamp.
The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). | | `updatedBefore` | `string \| undefined` | Optional | The filter to return results with their `created_at` or `calculated_at` value
strictly before the given time as specified in an RFC 3339 timestamp.
The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). | | `cursor` | `string \| undefined` | 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. | -| `limit` | `number \| undefined` | Optional | The number of [records](../../doc/models/inventory-change.md) to return.
**Constraints**: `>= 1`, `<= 1000` | +| `limit` | `number \| undefined` | Optional | The number of [records](entity:InventoryChange) to return.
**Constraints**: `>= 1`, `<= 1000` | ## Example (as JSON) diff --git a/doc/models/batch-retrieve-inventory-counts-request.md b/doc/models/batch-retrieve-inventory-counts-request.md index a982566f..5f71bc9a 100644 --- a/doc/models/batch-retrieve-inventory-counts-request.md +++ b/doc/models/batch-retrieve-inventory-counts-request.md @@ -14,7 +14,7 @@ | `updatedAfter` | `string \| undefined` | Optional | The filter to return results with their `calculated_at` value
after the given time as specified in an RFC 3339 timestamp.
The default value is the UNIX epoch of (`1970-01-01T00:00:00Z`). | | `cursor` | `string \| undefined` | 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. | | `states` | [`string[] \| undefined`](../../doc/models/inventory-state.md) | Optional | The filter to return results by `InventoryState`. The filter is only applicable when set.
Ignored are untracked states of `NONE`, `SOLD`, and `UNLINKED_RETURN`.
The default is null. | -| `limit` | `number \| undefined` | Optional | The number of [records](../../doc/models/inventory-count.md) to return.
**Constraints**: `>= 1`, `<= 1000` | +| `limit` | `number \| undefined` | Optional | The number of [records](entity:InventoryCount) to return.
**Constraints**: `>= 1`, `<= 1000` | ## Example (as JSON) diff --git a/doc/models/batch-upsert-catalog-objects-request.md b/doc/models/batch-upsert-catalog-objects-request.md index 5f569baa..bdad6a49 100644 --- a/doc/models/batch-upsert-catalog-objects-request.md +++ b/doc/models/batch-upsert-catalog-objects-request.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `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/basics/api101/idempotency) for more information.
**Constraints**: *Minimum Length*: `1` | +| `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` | | `batches` | [`CatalogObjectBatch[]`](../../doc/models/catalog-object-batch.md) | Required | A batch of CatalogObjects to be inserted/updated atomically.
The objects within a batch will be inserted in an all-or-nothing fashion, i.e., if an error occurs
attempting to insert or update an object within a batch, the entire batch will be rejected. However, an error
in one batch will not affect other batches within the same request.

For each object, its `updated_at` field is ignored and replaced with a current [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates), and its
`is_deleted` field must not be set to `true`.

To modify an existing object, supply its ID. To create a new object, use an ID starting
with `#`. These IDs may be used to create relationships between an object and attributes of
other objects that reference it. For example, you can create a CatalogItem with
ID `#ABC` and a CatalogItemVariation with its `item_id` attribute set to
`#ABC` in order to associate the CatalogItemVariation with its parent
CatalogItem.

Any `#`-prefixed IDs are valid only within a single atomic batch, and will be replaced by server-generated IDs.

Each batch may contain up to 1,000 objects. The total number of objects across all batches for a single request
may not exceed 10,000. If either of these limits is violated, an error will be returned and no objects will
be inserted or updated. | ## Example (as JSON) diff --git a/doc/models/booking-creator-details.md b/doc/models/booking-creator-details.md index 252d8516..66fd4c11 100644 --- a/doc/models/booking-creator-details.md +++ b/doc/models/booking-creator-details.md @@ -19,9 +19,9 @@ Information about a booking creator. ```json { - "creator_type": null, - "team_member_id": null, - "customer_id": null + "creator_type": "TEAM_MEMBER", + "team_member_id": "team_member_id0", + "customer_id": "customer_id8" } ``` diff --git a/doc/models/booking-custom-attribute-delete-request.md b/doc/models/booking-custom-attribute-delete-request.md index 4fa69e17..b84766ae 100644 --- a/doc/models/booking-custom-attribute-delete-request.md +++ b/doc/models/booking-custom-attribute-delete-request.md @@ -12,7 +12,7 @@ request. An individual request contains a booking ID, the custom attribute to de | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `bookingId` | `string` | Required | The ID of the target [booking](../../doc/models/booking.md).
**Constraints**: *Minimum Length*: `1` | +| `bookingId` | `string` | Required | The ID of the target [booking](entity:Booking).
**Constraints**: *Minimum Length*: `1` | | `key` | `string` | Required | 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.
**Constraints**: *Minimum Length*: `1` | ## Example (as JSON) diff --git a/doc/models/booking-custom-attribute-delete-response.md b/doc/models/booking-custom-attribute-delete-response.md index ab23ea20..e8910315 100644 --- a/doc/models/booking-custom-attribute-delete-response.md +++ b/doc/models/booking-custom-attribute-delete-response.md @@ -11,7 +11,7 @@ Represents a response for an individual upsert request in a [BulkDeleteBookingCu | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `bookingId` | `string \| undefined` | Optional | The ID of the [booking](../../doc/models/booking.md) associated with the custom attribute. | +| `bookingId` | `string \| undefined` | Optional | The ID of the [booking](entity:Booking) associated with the custom attribute. | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Any errors that occurred while processing the individual request. | ## Example (as JSON) diff --git a/doc/models/booking-custom-attribute-upsert-request.md b/doc/models/booking-custom-attribute-upsert-request.md index ea5960e9..9530718a 100644 --- a/doc/models/booking-custom-attribute-upsert-request.md +++ b/doc/models/booking-custom-attribute-upsert-request.md @@ -13,7 +13,7 @@ and an optional idempotency key. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `bookingId` | `string` | Required | The ID of the target [booking](../../doc/models/booking.md).
**Constraints**: *Minimum Length*: `1` | +| `bookingId` | `string` | Required | The ID of the target [booking](entity:Booking).
**Constraints**: *Minimum Length*: `1` | | `customAttribute` | [`CustomAttribute`](../../doc/models/custom-attribute.md) | Required | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | | `idempotencyKey` | `string \| undefined` | Optional | A unique identifier for this individual upsert 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` | @@ -23,15 +23,30 @@ and an optional idempotency key. { "booking_id": "booking_id4", "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" }, - "idempotency_key": null + "idempotency_key": "idempotency_key6" } ``` diff --git a/doc/models/booking-custom-attribute-upsert-response.md b/doc/models/booking-custom-attribute-upsert-response.md index c72a724c..f9f1eb46 100644 --- a/doc/models/booking-custom-attribute-upsert-response.md +++ b/doc/models/booking-custom-attribute-upsert-response.md @@ -11,7 +11,7 @@ Represents a response for an individual upsert request in a [BulkUpsertBookingCu | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `bookingId` | `string \| undefined` | Optional | The ID of the [booking](../../doc/models/booking.md) associated with the custom attribute. | +| `bookingId` | `string \| undefined` | Optional | The ID of the [booking](entity:Booking) associated with the custom attribute. | | `customAttribute` | [`CustomAttribute \| undefined`](../../doc/models/custom-attribute.md) | Optional | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Any errors that occurred while processing the individual request. | @@ -19,9 +19,51 @@ Represents a response for an individual upsert request in a [BulkUpsertBookingCu ```json { - "booking_id": null, - "custom_attribute": null, - "errors": null + "booking_id": "booking_id4", + "custom_attribute": { + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/booking.md b/doc/models/booking.md index 2afb52ee..7bc66f68 100644 --- a/doc/models/booking.md +++ b/doc/models/booking.md @@ -18,10 +18,10 @@ at a given location to a requesting customer in one or more appointment segments | `createdAt` | `string \| undefined` | Optional | The RFC 3339 timestamp specifying the creation time of this booking. | | `updatedAt` | `string \| undefined` | Optional | The RFC 3339 timestamp specifying the most recent update time of this booking. | | `startAt` | `string \| undefined` | Optional | The RFC 3339 timestamp specifying the starting time of this booking. | -| `locationId` | `string \| undefined` | Optional | The ID of the [Location](../../doc/models/location.md) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed.
**Constraints**: *Maximum Length*: `32` | -| `customerId` | `string \| undefined` | Optional | The ID of the [Customer](../../doc/models/customer.md) object representing the customer receiving the booked service.
**Constraints**: *Maximum Length*: `192` | -| `customerNote` | `string \| undefined` | Optional | The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](../../doc/models/catalog-object.md) instance.
**Constraints**: *Maximum Length*: `4096` | -| `sellerNote` | `string \| undefined` | Optional | The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](../../doc/models/catalog-object.md) instance.
This field should not be visible to customers.
**Constraints**: *Maximum Length*: `4096` | +| `locationId` | `string \| undefined` | Optional | The ID of the [Location](entity:Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed.
**Constraints**: *Maximum Length*: `32` | +| `customerId` | `string \| undefined` | Optional | The ID of the [Customer](entity:Customer) object representing the customer receiving the booked service.
**Constraints**: *Maximum Length*: `192` | +| `customerNote` | `string \| undefined` | Optional | The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](entity:CatalogObject) instance.
**Constraints**: *Maximum Length*: `4096` | +| `sellerNote` | `string \| undefined` | Optional | The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](entity:CatalogObject) instance.
This field should not be visible to customers.
**Constraints**: *Maximum Length*: `4096` | | `appointmentSegments` | [`AppointmentSegment[] \| undefined`](../../doc/models/appointment-segment.md) | Optional | A list of appointment segments for this booking. | | `transitionTimeMinutes` | `number \| undefined` | Optional | Additional time at the end of a booking.
Applications should not make this field visible to customers of a seller. | | `allDay` | `boolean \| undefined` | Optional | Whether the booking is of a full business day. | @@ -33,22 +33,39 @@ at a given location to a requesting customer in one or more appointment segments ```json { - "id": null, - "version": null, - "status": null, - "created_at": null, - "updated_at": null, - "start_at": null, - "location_id": null, - "customer_id": null, - "customer_note": null, - "seller_note": null, - "appointment_segments": null, - "transition_time_minutes": null, - "all_day": null, - "location_type": null, - "creator_details": null, - "source": null + "id": "id0", + "version": 172, + "status": "CANCELLED_BY_SELLER", + "created_at": "created_at2", + "updated_at": "updated_at4", + "start_at": "start_at2", + "location_id": "location_id4", + "customer_id": "customer_id8", + "customer_note": "customer_note2", + "seller_note": "seller_note8", + "appointment_segments": [ + { + "duration_minutes": 4, + "service_variation_id": "service_variation_id4", + "team_member_id": "team_member_id0", + "service_variation_version": 172, + "intermission_minutes": 178, + "any_team_member": false, + "resource_ids": [ + "resource_ids0", + "resource_ids1" + ] + } + ], + "transition_time_minutes": 248, + "all_day": false, + "location_type": "BUSINESS_LOCATION", + "creator_details": { + "creator_type": "TEAM_MEMBER", + "team_member_id": "team_member_id4", + "customer_id": "customer_id2" + }, + "source": "FIRST_PARTY_MERCHANT" } ``` diff --git a/doc/models/break-type.md b/doc/models/break-type.md index a8b0e029..21c6279b 100644 --- a/doc/models/break-type.md +++ b/doc/models/break-type.md @@ -25,14 +25,14 @@ instances on a `Shift`. ```json { - "id": null, + "id": "id0", "location_id": "location_id4", "break_name": "break_name8", "expected_duration": "expected_duration4", "is_paid": false, - "version": null, - "created_at": null, - "updated_at": null + "version": 172, + "created_at": "created_at2", + "updated_at": "updated_at4" } ``` diff --git a/doc/models/break.md b/doc/models/break.md index 748f300a..34d87a43 100644 --- a/doc/models/break.md +++ b/doc/models/break.md @@ -23,9 +23,9 @@ A record of an employee's break during a shift. ```json { - "id": null, + "id": "id0", "start_at": "start_at2", - "end_at": null, + "end_at": "end_at0", "break_type_id": "break_type_id6", "name": "name0", "expected_duration": "expected_duration4", diff --git a/doc/models/bulk-create-team-members-request.md b/doc/models/bulk-create-team-members-request.md index ad7f2d38..1358ed5f 100644 --- a/doc/models/bulk-create-team-members-request.md +++ b/doc/models/bulk-create-team-members-request.md @@ -11,7 +11,7 @@ Represents a bulk create request for `TeamMember` objects. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `teamMembers` | [`Record`](../../doc/models/create-team-member-request.md) | Required | The data used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. | +| `teamMembers` | [`Record`](../../doc/models/create-team-member-request.md) | Required | The data used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. The maximum number of create objects is 25. | ## Example (as JSON) diff --git a/doc/models/bulk-create-vendors-request.md b/doc/models/bulk-create-vendors-request.md index f8c1c3b0..6b30d40c 100644 --- a/doc/models/bulk-create-vendors-request.md +++ b/doc/models/bulk-create-vendors-request.md @@ -11,7 +11,7 @@ Represents an input to a call to [BulkCreateVendors](../../doc/api/vendors.md#bu | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `vendors` | [`Record`](../../doc/models/vendor.md) | Required | Specifies a set of new [Vendor](../../doc/models/vendor.md) objects as represented by a collection of idempotency-key/`Vendor`-object pairs. | +| `vendors` | [`Record`](../../doc/models/vendor.md) | Required | Specifies a set of new [Vendor](entity:Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs. | ## Example (as JSON) @@ -19,40 +19,136 @@ Represents an input to a call to [BulkCreateVendors](../../doc/api/vendors.md#bu { "vendors": { "key0": { - "id": null, - "created_at": null, - "updated_at": null, - "name": null, - "address": null, - "contacts": null, - "account_number": null, - "note": null, - "version": null, - "status": null + "id": "id9", + "created_at": "created_at7", + "updated_at": "updated_at5", + "name": "name9", + "address": { + "address_line_1": "address_line_15", + "address_line_2": "address_line_25", + "address_line_3": "address_line_31", + "locality": "locality5", + "sublocality": "sublocality5", + "sublocality_2": "sublocality_23", + "sublocality_3": "sublocality_35", + "administrative_district_level_1": "administrative_district_level_19", + "administrative_district_level_2": "administrative_district_level_21", + "administrative_district_level_3": "administrative_district_level_33", + "postal_code": "postal_code7", + "country": "HT", + "first_name": "first_name5", + "last_name": "last_name3" + }, + "contacts": [ + { + "id": "id6", + "name": "name6", + "email_address": "email_address4", + "phone_number": "phone_number4", + "removed": false, + "ordinal": 232 + }, + { + "id": "id7", + "name": "name7", + "email_address": "email_address5", + "phone_number": "phone_number5", + "removed": true, + "ordinal": 233 + }, + { + "id": "id8", + "name": "name8", + "email_address": "email_address6", + "phone_number": "phone_number6", + "removed": false, + "ordinal": 234 + } + ], + "account_number": "account_number1", + "note": "note5", + "version": 41, + "status": "INACTIVE" }, "key1": { - "id": null, - "created_at": null, - "updated_at": null, - "name": null, - "address": null, - "contacts": null, - "account_number": null, - "note": null, - "version": null, - "status": null + "id": "id0", + "created_at": "created_at8", + "updated_at": "updated_at4", + "name": "name0", + "address": { + "address_line_1": "address_line_16", + "address_line_2": "address_line_26", + "address_line_3": "address_line_32", + "locality": "locality6", + "sublocality": "sublocality6", + "sublocality_2": "sublocality_24", + "sublocality_3": "sublocality_36", + "administrative_district_level_1": "administrative_district_level_10", + "administrative_district_level_2": "administrative_district_level_22", + "administrative_district_level_3": "administrative_district_level_34", + "postal_code": "postal_code8", + "country": "HU", + "first_name": "first_name6", + "last_name": "last_name4" + }, + "contacts": [ + { + "id": "id7", + "name": "name7", + "email_address": "email_address5", + "phone_number": "phone_number5", + "removed": true, + "ordinal": 233 + } + ], + "account_number": "account_number0", + "note": "note4", + "version": 42, + "status": "ACTIVE" }, "key2": { - "id": null, - "created_at": null, - "updated_at": null, - "name": null, - "address": null, - "contacts": null, - "account_number": null, - "note": null, - "version": null, - "status": null + "id": "id1", + "created_at": "created_at9", + "updated_at": "updated_at3", + "name": "name1", + "address": { + "address_line_1": "address_line_17", + "address_line_2": "address_line_27", + "address_line_3": "address_line_33", + "locality": "locality7", + "sublocality": "sublocality7", + "sublocality_2": "sublocality_25", + "sublocality_3": "sublocality_37", + "administrative_district_level_1": "administrative_district_level_11", + "administrative_district_level_2": "administrative_district_level_23", + "administrative_district_level_3": "administrative_district_level_35", + "postal_code": "postal_code9", + "country": "ID", + "first_name": "first_name7", + "last_name": "last_name5" + }, + "contacts": [ + { + "id": "id8", + "name": "name8", + "email_address": "email_address6", + "phone_number": "phone_number6", + "removed": false, + "ordinal": 234 + }, + { + "id": "id9", + "name": "name9", + "email_address": "email_address7", + "phone_number": "phone_number7", + "removed": true, + "ordinal": 235 + } + ], + "account_number": "account_number9", + "note": "note3", + "version": 43, + "status": "INACTIVE" } } } diff --git a/doc/models/bulk-create-vendors-response.md b/doc/models/bulk-create-vendors-response.md index c2acaa1c..3876ccdc 100644 --- a/doc/models/bulk-create-vendors-response.md +++ b/doc/models/bulk-create-vendors-response.md @@ -12,7 +12,7 @@ Represents an output from a call to [BulkCreateVendors](../../doc/api/vendors.md | Name | Type | Tags | Description | | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | -| `responses` | [`Record \| undefined`](../../doc/models/create-vendor-response.md) | Optional | A set of [CreateVendorResponse](../../doc/models/create-vendor-response.md) objects encapsulating successfully created [Vendor](../../doc/models/vendor.md)
objects or error responses for failed attempts. The set is represented by
a collection of idempotency-key/`Vendor`-object or idempotency-key/error-object pairs. The idempotency keys correspond to those specified
in the input. | +| `responses` | [`Record \| undefined`](../../doc/models/create-vendor-response.md) | Optional | A set of [CreateVendorResponse](entity:CreateVendorResponse) objects encapsulating successfully created [Vendor](entity:Vendor)
objects or error responses for failed attempts. The set is represented by
a collection of idempotency-key/`Vendor`-object or idempotency-key/error-object pairs. The idempotency keys correspond to those specified
in the input. | ## Example (as JSON) diff --git a/doc/models/bulk-delete-location-custom-attributes-request-location-custom-attribute-delete-request.md b/doc/models/bulk-delete-location-custom-attributes-request-location-custom-attribute-delete-request.md index 3ca99eec..0b87a0bf 100644 --- a/doc/models/bulk-delete-location-custom-attributes-request-location-custom-attribute-delete-request.md +++ b/doc/models/bulk-delete-location-custom-attributes-request-location-custom-attribute-delete-request.md @@ -19,7 +19,7 @@ and optional key of the associated custom attribute definition. ```json { - "key": null + "key": "key0" } ``` diff --git a/doc/models/bulk-delete-order-custom-attributes-request-delete-custom-attribute.md b/doc/models/bulk-delete-order-custom-attributes-request-delete-custom-attribute.md index 617f29d0..7736f50d 100644 --- a/doc/models/bulk-delete-order-custom-attributes-request-delete-custom-attribute.md +++ b/doc/models/bulk-delete-order-custom-attributes-request-delete-custom-attribute.md @@ -11,14 +11,14 @@ Represents one delete within the bulk operation. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `key` | `string \| undefined` | Optional | The key of the custom attribute to delete. This key must match the key
of an existing custom attribute definition.
**Constraints**: *Pattern*: `^([a-zA-Z0-9_-]+:)?[a-zA-Z0-9_-]{1,60}$` | -| `orderId` | `string` | Required | The ID of the target [order](../../doc/models/order.md). | +| `key` | `string \| undefined` | Optional | The key of the custom attribute to delete. This key must match the key
of an existing custom attribute definition.
**Constraints**: *Minimum Length*: `1`, *Pattern*: `^([a-zA-Z0-9_-]+:)?[a-zA-Z0-9_-]{1,60}$` | +| `orderId` | `string` | Required | The ID of the target [order](entity:Order).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | ## Example (as JSON) ```json { - "key": null, + "key": "key0", "order_id": "order_id6" } ``` diff --git a/doc/models/bulk-retrieve-vendors-request.md b/doc/models/bulk-retrieve-vendors-request.md index 761542c4..38091df6 100644 --- a/doc/models/bulk-retrieve-vendors-request.md +++ b/doc/models/bulk-retrieve-vendors-request.md @@ -11,7 +11,7 @@ Represents an input to a call to [BulkRetrieveVendors](../../doc/api/vendors.md# | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `vendorIds` | `string[] \| undefined` | Optional | IDs of the [Vendor](../../doc/models/vendor.md) objects to retrieve. | +| `vendorIds` | `string[] \| undefined` | Optional | IDs of the [Vendor](entity:Vendor) objects to retrieve. | ## Example (as JSON) diff --git a/doc/models/bulk-retrieve-vendors-response.md b/doc/models/bulk-retrieve-vendors-response.md index 07d9f2a2..916cfb4d 100644 --- a/doc/models/bulk-retrieve-vendors-response.md +++ b/doc/models/bulk-retrieve-vendors-response.md @@ -12,7 +12,7 @@ Represents an output from a call to [BulkRetrieveVendors](../../doc/api/vendors. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | -| `responses` | [`Record \| undefined`](../../doc/models/retrieve-vendor-response.md) | Optional | The set of [RetrieveVendorResponse](../../doc/models/retrieve-vendor-response.md) objects encapsulating successfully retrieved [Vendor](../../doc/models/vendor.md)
objects or error responses for failed attempts. The set is represented by
a collection of `Vendor`-ID/`Vendor`-object or `Vendor`-ID/error-object pairs. | +| `responses` | [`Record \| undefined`](../../doc/models/retrieve-vendor-response.md) | Optional | The set of [RetrieveVendorResponse](entity:RetrieveVendorResponse) objects encapsulating successfully retrieved [Vendor](entity:Vendor)
objects or error responses for failed attempts. The set is represented by
a collection of `Vendor`-ID/`Vendor`-object or `Vendor`-ID/error-object pairs. | ## Example (as JSON) diff --git a/doc/models/bulk-update-team-members-request.md b/doc/models/bulk-update-team-members-request.md index 1c639a2d..66e58358 100644 --- a/doc/models/bulk-update-team-members-request.md +++ b/doc/models/bulk-update-team-members-request.md @@ -11,7 +11,7 @@ Represents a bulk update request for `TeamMember` objects. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `teamMembers` | [`Record`](../../doc/models/update-team-member-request.md) | Required | The data used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. | +| `teamMembers` | [`Record`](../../doc/models/update-team-member-request.md) | Required | The data used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. The maximum number of update objects is 25. | ## Example (as JSON) diff --git a/doc/models/bulk-update-vendors-request.md b/doc/models/bulk-update-vendors-request.md index cd05804d..3aac6fad 100644 --- a/doc/models/bulk-update-vendors-request.md +++ b/doc/models/bulk-update-vendors-request.md @@ -11,7 +11,7 @@ Represents an input to a call to [BulkUpdateVendors](../../doc/api/vendors.md#bu | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `vendors` | [`Record`](../../doc/models/update-vendor-request.md) | Required | A set of [UpdateVendorRequest](../../doc/models/update-vendor-request.md) objects encapsulating to-be-updated [Vendor](../../doc/models/vendor.md)
objects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs. | +| `vendors` | [`Record`](../../doc/models/update-vendor-request.md) | Required | A set of [UpdateVendorRequest](entity:UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](entity:Vendor)
objects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs. | ## Example (as JSON) @@ -19,48 +19,144 @@ Represents an input to a call to [BulkUpdateVendors](../../doc/api/vendors.md#bu { "vendors": { "key0": { - "idempotency_key": null, + "idempotency_key": "idempotency_key5", "vendor": { - "id": null, - "created_at": null, - "updated_at": null, - "name": null, - "address": null, - "contacts": null, - "account_number": null, - "note": null, - "version": null, - "status": null + "id": "id5", + "created_at": "created_at3", + "updated_at": "updated_at1", + "name": "name5", + "address": { + "address_line_1": "address_line_11", + "address_line_2": "address_line_21", + "address_line_3": "address_line_37", + "locality": "locality1", + "sublocality": "sublocality1", + "sublocality_2": "sublocality_29", + "sublocality_3": "sublocality_31", + "administrative_district_level_1": "administrative_district_level_15", + "administrative_district_level_2": "administrative_district_level_27", + "administrative_district_level_3": "administrative_district_level_39", + "postal_code": "postal_code3", + "country": "YE", + "first_name": "first_name1", + "last_name": "last_name9" + }, + "contacts": [ + { + "id": "id2", + "name": "name2", + "email_address": "email_address0", + "phone_number": "phone_number0", + "removed": false, + "ordinal": 224 + }, + { + "id": "id3", + "name": "name3", + "email_address": "email_address1", + "phone_number": "phone_number1", + "removed": true, + "ordinal": 225 + } + ], + "account_number": "account_number5", + "note": "note1", + "version": 33, + "status": "INACTIVE" } }, "key1": { - "idempotency_key": null, + "idempotency_key": "idempotency_key6", "vendor": { - "id": null, - "created_at": null, - "updated_at": null, - "name": null, - "address": null, - "contacts": null, - "account_number": null, - "note": null, - "version": null, - "status": null + "id": "id6", + "created_at": "created_at4", + "updated_at": "updated_at2", + "name": "name6", + "address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_22", + "address_line_3": "address_line_38", + "locality": "locality2", + "sublocality": "sublocality2", + "sublocality_2": "sublocality_20", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_16", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_30", + "postal_code": "postal_code4", + "country": "YT", + "first_name": "first_name2", + "last_name": "last_name0" + }, + "contacts": [ + { + "id": "id3", + "name": "name3", + "email_address": "email_address1", + "phone_number": "phone_number1", + "removed": true, + "ordinal": 225 + }, + { + "id": "id4", + "name": "name4", + "email_address": "email_address2", + "phone_number": "phone_number2", + "removed": false, + "ordinal": 226 + }, + { + "id": "id5", + "name": "name5", + "email_address": "email_address3", + "phone_number": "phone_number3", + "removed": true, + "ordinal": 227 + } + ], + "account_number": "account_number6", + "note": "note2", + "version": 34, + "status": "ACTIVE" } }, "key2": { - "idempotency_key": null, + "idempotency_key": "idempotency_key7", "vendor": { - "id": null, - "created_at": null, - "updated_at": null, - "name": null, - "address": null, - "contacts": null, - "account_number": null, - "note": null, - "version": null, - "status": null + "id": "id7", + "created_at": "created_at5", + "updated_at": "updated_at3", + "name": "name7", + "address": { + "address_line_1": "address_line_13", + "address_line_2": "address_line_23", + "address_line_3": "address_line_39", + "locality": "locality3", + "sublocality": "sublocality3", + "sublocality_2": "sublocality_21", + "sublocality_3": "sublocality_33", + "administrative_district_level_1": "administrative_district_level_17", + "administrative_district_level_2": "administrative_district_level_29", + "administrative_district_level_3": "administrative_district_level_31", + "postal_code": "postal_code5", + "country": "ZA", + "first_name": "first_name3", + "last_name": "last_name1" + }, + "contacts": [ + { + "id": "id4", + "name": "name4", + "email_address": "email_address2", + "phone_number": "phone_number2", + "removed": false, + "ordinal": 226 + } + ], + "account_number": "account_number7", + "note": "note3", + "version": 35, + "status": "INACTIVE" } } } diff --git a/doc/models/bulk-update-vendors-response.md b/doc/models/bulk-update-vendors-response.md index 18d894b7..4d2a77d4 100644 --- a/doc/models/bulk-update-vendors-response.md +++ b/doc/models/bulk-update-vendors-response.md @@ -12,7 +12,7 @@ Represents an output from a call to [BulkUpdateVendors](../../doc/api/vendors.md | Name | Type | Tags | Description | | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Errors encountered when the request fails. | -| `responses` | [`Record \| undefined`](../../doc/models/update-vendor-response.md) | Optional | A set of [UpdateVendorResponse](../../doc/models/update-vendor-response.md) objects encapsulating successfully created [Vendor](../../doc/models/vendor.md)
objects or error responses for failed attempts. The set is represented by a collection of `Vendor`-ID/`UpdateVendorResponse`-object or
`Vendor`-ID/error-object pairs. | +| `responses` | [`Record \| undefined`](../../doc/models/update-vendor-response.md) | Optional | A set of [UpdateVendorResponse](entity:UpdateVendorResponse) objects encapsulating successfully created [Vendor](entity:Vendor)
objects or error responses for failed attempts. The set is represented by a collection of `Vendor`-ID/`UpdateVendorResponse`-object or
`Vendor`-ID/error-object pairs. | ## Example (as JSON) diff --git a/doc/models/bulk-upsert-booking-custom-attributes-request.md b/doc/models/bulk-upsert-booking-custom-attributes-request.md index d8a61439..1488b15a 100644 --- a/doc/models/bulk-upsert-booking-custom-attributes-request.md +++ b/doc/models/bulk-upsert-booking-custom-attributes-request.md @@ -21,41 +21,86 @@ Represents a [BulkUpsertBookingCustomAttributes](../../doc/api/booking-custom-at "key0": { "booking_id": "booking_id4", "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key8", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 82, + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "definition": { + "key": "key8", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name8", + "description": "description8", + "visibility": "VISIBILITY_HIDDEN", + "version": 178, + "updated_at": "updated_at4", + "created_at": "created_at6" + }, + "updated_at": "updated_at6", + "created_at": "created_at4" }, - "idempotency_key": null + "idempotency_key": "idempotency_key6" }, "key1": { "booking_id": "booking_id5", "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key9", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 83, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key9", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name9", + "description": "description9", + "visibility": "VISIBILITY_READ_ONLY", + "version": 179, + "updated_at": "updated_at5", + "created_at": "created_at7" + }, + "updated_at": "updated_at5", + "created_at": "created_at3" }, - "idempotency_key": null + "idempotency_key": "idempotency_key7" }, "key2": { "booking_id": "booking_id6", "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key0", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 84, + "visibility": "VISIBILITY_HIDDEN", + "definition": { + "key": "key0", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name0", + "description": "description0", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "version": 180, + "updated_at": "updated_at6", + "created_at": "created_at8" + }, + "updated_at": "updated_at4", + "created_at": "created_at2" }, - "idempotency_key": null + "idempotency_key": "idempotency_key8" } } } diff --git a/doc/models/bulk-upsert-booking-custom-attributes-response.md b/doc/models/bulk-upsert-booking-custom-attributes-response.md index 4916033c..e8c12bf5 100644 --- a/doc/models/bulk-upsert-booking-custom-attributes-response.md +++ b/doc/models/bulk-upsert-booking-custom-attributes-response.md @@ -19,8 +19,151 @@ which contains a map of responses that each corresponds to an individual upsert ```json { - "values": null, - "errors": null + "values": { + "key0": { + "booking_id": "booking_id4", + "custom_attribute": { + "key": "key8", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 82, + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "definition": { + "key": "key8", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name8", + "description": "description8", + "visibility": "VISIBILITY_HIDDEN", + "version": 178, + "updated_at": "updated_at4", + "created_at": "created_at6" + }, + "updated_at": "updated_at6", + "created_at": "created_at4" + }, + "errors": [ + { + "category": "API_ERROR", + "code": "INVALID_FEES", + "detail": "detail1", + "field": "field9" + } + ] + }, + "key1": { + "booking_id": "booking_id5", + "custom_attribute": { + "key": "key9", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 83, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key9", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name9", + "description": "description9", + "visibility": "VISIBILITY_READ_ONLY", + "version": 179, + "updated_at": "updated_at5", + "created_at": "created_at7" + }, + "updated_at": "updated_at5", + "created_at": "created_at3" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", + "detail": "detail2", + "field": "field0" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_LIMIT_EXCEEDED", + "detail": "detail3", + "field": "field1" + } + ] + }, + "key2": { + "booking_id": "booking_id6", + "custom_attribute": { + "key": "key0", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 84, + "visibility": "VISIBILITY_HIDDEN", + "definition": { + "key": "key0", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name0", + "description": "description0", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "version": 180, + "updated_at": "updated_at6", + "created_at": "created_at8" + }, + "updated_at": "updated_at4", + "created_at": "created_at2" + }, + "errors": [ + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_LIMIT_EXCEEDED", + "detail": "detail3", + "field": "field1" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "GIFT_CARD_AVAILABLE_AMOUNT", + "detail": "detail4", + "field": "field2" + }, + { + "category": "PAYMENT_METHOD_ERROR", + "code": "ACCOUNT_UNUSABLE", + "detail": "detail5", + "field": "field3" + } + ] + } + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/bulk-upsert-customer-custom-attributes-request-customer-custom-attribute-upsert-request.md b/doc/models/bulk-upsert-customer-custom-attributes-request-customer-custom-attribute-upsert-request.md index 9165dc6a..2630d15a 100644 --- a/doc/models/bulk-upsert-customer-custom-attributes-request-customer-custom-attribute-upsert-request.md +++ b/doc/models/bulk-upsert-customer-custom-attributes-request-customer-custom-attribute-upsert-request.md @@ -13,7 +13,7 @@ and an optional idempotency key. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `customerId` | `string` | Required | The ID of the target [customer profile](../../doc/models/customer.md).
**Constraints**: *Minimum Length*: `1` | +| `customerId` | `string` | Required | The ID of the target [customer profile](entity:Customer).
**Constraints**: *Minimum Length*: `1` | | `customAttribute` | [`CustomAttribute`](../../doc/models/custom-attribute.md) | Required | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | | `idempotencyKey` | `string \| undefined` | Optional | A unique identifier for this individual upsert 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` | @@ -23,15 +23,30 @@ and an optional idempotency key. { "customer_id": "customer_id8", "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" }, - "idempotency_key": null + "idempotency_key": "idempotency_key6" } ``` diff --git a/doc/models/bulk-upsert-customer-custom-attributes-request.md b/doc/models/bulk-upsert-customer-custom-attributes-request.md index 1fc174f7..d15c9a79 100644 --- a/doc/models/bulk-upsert-customer-custom-attributes-request.md +++ b/doc/models/bulk-upsert-customer-custom-attributes-request.md @@ -21,41 +21,86 @@ Represents a [BulkUpsertCustomerCustomAttributes](../../doc/api/customer-custom- "key0": { "customer_id": "customer_id8", "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key8", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 82, + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "definition": { + "key": "key8", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name8", + "description": "description8", + "visibility": "VISIBILITY_HIDDEN", + "version": 178, + "updated_at": "updated_at4", + "created_at": "created_at6" + }, + "updated_at": "updated_at6", + "created_at": "created_at4" }, - "idempotency_key": null + "idempotency_key": "idempotency_key6" }, "key1": { "customer_id": "customer_id9", "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key9", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 83, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key9", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name9", + "description": "description9", + "visibility": "VISIBILITY_READ_ONLY", + "version": 179, + "updated_at": "updated_at5", + "created_at": "created_at7" + }, + "updated_at": "updated_at5", + "created_at": "created_at3" }, - "idempotency_key": null + "idempotency_key": "idempotency_key7" }, "key2": { "customer_id": "customer_id0", "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key0", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 84, + "visibility": "VISIBILITY_HIDDEN", + "definition": { + "key": "key0", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name0", + "description": "description0", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "version": 180, + "updated_at": "updated_at6", + "created_at": "created_at8" + }, + "updated_at": "updated_at4", + "created_at": "created_at2" }, - "idempotency_key": null + "idempotency_key": "idempotency_key8" } } } diff --git a/doc/models/bulk-upsert-customer-custom-attributes-response-customer-custom-attribute-upsert-response.md b/doc/models/bulk-upsert-customer-custom-attributes-response-customer-custom-attribute-upsert-response.md index 95871ffb..0e86de42 100644 --- a/doc/models/bulk-upsert-customer-custom-attributes-response-customer-custom-attribute-upsert-response.md +++ b/doc/models/bulk-upsert-customer-custom-attributes-response-customer-custom-attribute-upsert-response.md @@ -19,9 +19,51 @@ Represents a response for an individual upsert request in a [BulkUpsertCustomerC ```json { - "customer_id": null, - "custom_attribute": null, - "errors": null + "customer_id": "customer_id8", + "custom_attribute": { + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/bulk-upsert-customer-custom-attributes-response.md b/doc/models/bulk-upsert-customer-custom-attributes-response.md index 83cbcc67..135e872b 100644 --- a/doc/models/bulk-upsert-customer-custom-attributes-response.md +++ b/doc/models/bulk-upsert-customer-custom-attributes-response.md @@ -19,8 +19,151 @@ which contains a map of responses that each corresponds to an individual upsert ```json { - "values": null, - "errors": null + "values": { + "key0": { + "customer_id": "customer_id8", + "custom_attribute": { + "key": "key8", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 82, + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "definition": { + "key": "key8", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name8", + "description": "description8", + "visibility": "VISIBILITY_HIDDEN", + "version": 178, + "updated_at": "updated_at4", + "created_at": "created_at6" + }, + "updated_at": "updated_at6", + "created_at": "created_at4" + }, + "errors": [ + { + "category": "API_ERROR", + "code": "INVALID_FEES", + "detail": "detail1", + "field": "field9" + } + ] + }, + "key1": { + "customer_id": "customer_id9", + "custom_attribute": { + "key": "key9", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 83, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key9", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name9", + "description": "description9", + "visibility": "VISIBILITY_READ_ONLY", + "version": 179, + "updated_at": "updated_at5", + "created_at": "created_at7" + }, + "updated_at": "updated_at5", + "created_at": "created_at3" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", + "detail": "detail2", + "field": "field0" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_LIMIT_EXCEEDED", + "detail": "detail3", + "field": "field1" + } + ] + }, + "key2": { + "customer_id": "customer_id0", + "custom_attribute": { + "key": "key0", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 84, + "visibility": "VISIBILITY_HIDDEN", + "definition": { + "key": "key0", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name0", + "description": "description0", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "version": 180, + "updated_at": "updated_at6", + "created_at": "created_at8" + }, + "updated_at": "updated_at4", + "created_at": "created_at2" + }, + "errors": [ + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_LIMIT_EXCEEDED", + "detail": "detail3", + "field": "field1" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "GIFT_CARD_AVAILABLE_AMOUNT", + "detail": "detail4", + "field": "field2" + }, + { + "category": "PAYMENT_METHOD_ERROR", + "code": "ACCOUNT_UNUSABLE", + "detail": "detail5", + "field": "field3" + } + ] + } + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/bulk-upsert-location-custom-attributes-request-location-custom-attribute-upsert-request.md b/doc/models/bulk-upsert-location-custom-attributes-request-location-custom-attribute-upsert-request.md index 32b5e89a..0be51540 100644 --- a/doc/models/bulk-upsert-location-custom-attributes-request-location-custom-attribute-upsert-request.md +++ b/doc/models/bulk-upsert-location-custom-attributes-request-location-custom-attribute-upsert-request.md @@ -13,7 +13,7 @@ and an optional idempotency key. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `locationId` | `string` | Required | The ID of the target [location](../../doc/models/location.md).
**Constraints**: *Minimum Length*: `1` | +| `locationId` | `string` | Required | The ID of the target [location](entity:Location).
**Constraints**: *Minimum Length*: `1` | | `customAttribute` | [`CustomAttribute`](../../doc/models/custom-attribute.md) | Required | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | | `idempotencyKey` | `string \| undefined` | Optional | A unique identifier for this individual upsert 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` | @@ -23,15 +23,30 @@ and an optional idempotency key. { "location_id": "location_id4", "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" }, - "idempotency_key": null + "idempotency_key": "idempotency_key6" } ``` diff --git a/doc/models/bulk-upsert-location-custom-attributes-request.md b/doc/models/bulk-upsert-location-custom-attributes-request.md index dccbe2c7..23f00e40 100644 --- a/doc/models/bulk-upsert-location-custom-attributes-request.md +++ b/doc/models/bulk-upsert-location-custom-attributes-request.md @@ -21,41 +21,86 @@ Represents a [BulkUpsertLocationCustomAttributes](../../doc/api/location-custom- "key0": { "location_id": "location_id4", "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key8", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 82, + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "definition": { + "key": "key8", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name8", + "description": "description8", + "visibility": "VISIBILITY_HIDDEN", + "version": 178, + "updated_at": "updated_at4", + "created_at": "created_at6" + }, + "updated_at": "updated_at6", + "created_at": "created_at4" }, - "idempotency_key": null + "idempotency_key": "idempotency_key6" }, "key1": { "location_id": "location_id5", "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key9", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 83, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key9", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name9", + "description": "description9", + "visibility": "VISIBILITY_READ_ONLY", + "version": 179, + "updated_at": "updated_at5", + "created_at": "created_at7" + }, + "updated_at": "updated_at5", + "created_at": "created_at3" }, - "idempotency_key": null + "idempotency_key": "idempotency_key7" }, "key2": { "location_id": "location_id6", "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key0", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 84, + "visibility": "VISIBILITY_HIDDEN", + "definition": { + "key": "key0", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name0", + "description": "description0", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "version": 180, + "updated_at": "updated_at6", + "created_at": "created_at8" + }, + "updated_at": "updated_at4", + "created_at": "created_at2" }, - "idempotency_key": null + "idempotency_key": "idempotency_key8" } } } diff --git a/doc/models/bulk-upsert-location-custom-attributes-response-location-custom-attribute-upsert-response.md b/doc/models/bulk-upsert-location-custom-attributes-response-location-custom-attribute-upsert-response.md index 4091431e..e6dca96b 100644 --- a/doc/models/bulk-upsert-location-custom-attributes-response-location-custom-attribute-upsert-response.md +++ b/doc/models/bulk-upsert-location-custom-attributes-response-location-custom-attribute-upsert-response.md @@ -19,9 +19,51 @@ Represents a response for an individual upsert request in a [BulkUpsertLocationC ```json { - "location_id": null, - "custom_attribute": null, - "errors": null + "location_id": "location_id4", + "custom_attribute": { + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/bulk-upsert-location-custom-attributes-response.md b/doc/models/bulk-upsert-location-custom-attributes-response.md index bde8e307..46ba5bb3 100644 --- a/doc/models/bulk-upsert-location-custom-attributes-response.md +++ b/doc/models/bulk-upsert-location-custom-attributes-response.md @@ -19,8 +19,151 @@ which contains a map of responses that each corresponds to an individual upsert ```json { - "values": null, - "errors": null + "values": { + "key0": { + "location_id": "location_id4", + "custom_attribute": { + "key": "key8", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 82, + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "definition": { + "key": "key8", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name8", + "description": "description8", + "visibility": "VISIBILITY_HIDDEN", + "version": 178, + "updated_at": "updated_at4", + "created_at": "created_at6" + }, + "updated_at": "updated_at6", + "created_at": "created_at4" + }, + "errors": [ + { + "category": "API_ERROR", + "code": "INVALID_FEES", + "detail": "detail1", + "field": "field9" + } + ] + }, + "key1": { + "location_id": "location_id5", + "custom_attribute": { + "key": "key9", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 83, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key9", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name9", + "description": "description9", + "visibility": "VISIBILITY_READ_ONLY", + "version": 179, + "updated_at": "updated_at5", + "created_at": "created_at7" + }, + "updated_at": "updated_at5", + "created_at": "created_at3" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", + "detail": "detail2", + "field": "field0" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_LIMIT_EXCEEDED", + "detail": "detail3", + "field": "field1" + } + ] + }, + "key2": { + "location_id": "location_id6", + "custom_attribute": { + "key": "key0", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 84, + "visibility": "VISIBILITY_HIDDEN", + "definition": { + "key": "key0", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name0", + "description": "description0", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "version": 180, + "updated_at": "updated_at6", + "created_at": "created_at8" + }, + "updated_at": "updated_at4", + "created_at": "created_at2" + }, + "errors": [ + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_LIMIT_EXCEEDED", + "detail": "detail3", + "field": "field1" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "GIFT_CARD_AVAILABLE_AMOUNT", + "detail": "detail4", + "field": "field2" + }, + { + "category": "PAYMENT_METHOD_ERROR", + "code": "ACCOUNT_UNUSABLE", + "detail": "detail5", + "field": "field3" + } + ] + } + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/bulk-upsert-order-custom-attributes-request-upsert-custom-attribute.md b/doc/models/bulk-upsert-order-custom-attributes-request-upsert-custom-attribute.md index 3c5fd50f..8f125107 100644 --- a/doc/models/bulk-upsert-order-custom-attributes-request-upsert-custom-attribute.md +++ b/doc/models/bulk-upsert-order-custom-attributes-request-upsert-custom-attribute.md @@ -12,23 +12,38 @@ Represents one upsert within the bulk operation. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `customAttribute` | [`CustomAttribute`](../../doc/models/custom-attribute.md) | Required | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | -| `idempotencyKey` | `string \| undefined` | Optional | A unique identifier for this request, used to ensure idempotency.
For more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency).
**Constraints**: *Maximum Length*: `45` | -| `orderId` | `string` | Required | The ID of the target [order](../../doc/models/order.md). | +| `idempotencyKey` | `string \| undefined` | Optional | A unique identifier for this request, used to ensure idempotency.
For more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `45` | +| `orderId` | `string` | Required | The ID of the target [order](entity:Order).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | ## Example (as JSON) ```json { "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" }, - "idempotency_key": null, + "idempotency_key": "idempotency_key6", "order_id": "order_id6" } ``` diff --git a/doc/models/bulk-upsert-order-custom-attributes-request.md b/doc/models/bulk-upsert-order-custom-attributes-request.md index 1ac7d258..717dde92 100644 --- a/doc/models/bulk-upsert-order-custom-attributes-request.md +++ b/doc/models/bulk-upsert-order-custom-attributes-request.md @@ -20,41 +20,86 @@ Represents a bulk upsert request for one or more order custom attributes. "values": { "key0": { "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key8", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 82, + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "definition": { + "key": "key8", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name8", + "description": "description8", + "visibility": "VISIBILITY_HIDDEN", + "version": 178, + "updated_at": "updated_at4", + "created_at": "created_at6" + }, + "updated_at": "updated_at6", + "created_at": "created_at4" }, - "idempotency_key": null, + "idempotency_key": "idempotency_key6", "order_id": "order_id4" }, "key1": { "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key9", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 83, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key9", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name9", + "description": "description9", + "visibility": "VISIBILITY_READ_ONLY", + "version": 179, + "updated_at": "updated_at5", + "created_at": "created_at7" + }, + "updated_at": "updated_at5", + "created_at": "created_at3" }, - "idempotency_key": null, + "idempotency_key": "idempotency_key7", "order_id": "order_id5" }, "key2": { "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key0", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 84, + "visibility": "VISIBILITY_HIDDEN", + "definition": { + "key": "key0", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name0", + "description": "description0", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "version": 180, + "updated_at": "updated_at6", + "created_at": "created_at8" + }, + "updated_at": "updated_at4", + "created_at": "created_at2" }, - "idempotency_key": null, + "idempotency_key": "idempotency_key8", "order_id": "order_id6" } } diff --git a/doc/models/bulk-upsert-order-custom-attributes-response.md b/doc/models/bulk-upsert-order-custom-attributes-response.md index 0344ddbd..4b16464a 100644 --- a/doc/models/bulk-upsert-order-custom-attributes-response.md +++ b/doc/models/bulk-upsert-order-custom-attributes-response.md @@ -18,19 +18,146 @@ Represents a response from a bulk upsert of order custom attributes. ```json { - "errors": null, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ], "values": { "key0": { - "custom_attribute": null, - "errors": null + "custom_attribute": { + "key": "key8", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 82, + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "definition": { + "key": "key8", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name8", + "description": "description8", + "visibility": "VISIBILITY_HIDDEN", + "version": 178, + "updated_at": "updated_at4", + "created_at": "created_at6" + }, + "updated_at": "updated_at6", + "created_at": "created_at4" + }, + "errors": [ + { + "category": "API_ERROR", + "code": "INVALID_FEES", + "detail": "detail1", + "field": "field9" + } + ] }, "key1": { - "custom_attribute": null, - "errors": null + "custom_attribute": { + "key": "key9", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 83, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key9", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name9", + "description": "description9", + "visibility": "VISIBILITY_READ_ONLY", + "version": 179, + "updated_at": "updated_at5", + "created_at": "created_at7" + }, + "updated_at": "updated_at5", + "created_at": "created_at3" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED", + "detail": "detail2", + "field": "field0" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_LIMIT_EXCEEDED", + "detail": "detail3", + "field": "field1" + } + ] }, "key2": { - "custom_attribute": null, - "errors": null + "custom_attribute": { + "key": "key0", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 84, + "visibility": "VISIBILITY_HIDDEN", + "definition": { + "key": "key0", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name0", + "description": "description0", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "version": 180, + "updated_at": "updated_at6", + "created_at": "created_at8" + }, + "updated_at": "updated_at4", + "created_at": "created_at2" + }, + "errors": [ + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_LIMIT_EXCEEDED", + "detail": "detail3", + "field": "field1" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "GIFT_CARD_AVAILABLE_AMOUNT", + "detail": "detail4", + "field": "field2" + }, + { + "category": "PAYMENT_METHOD_ERROR", + "code": "ACCOUNT_UNUSABLE", + "detail": "detail5", + "field": "field3" + } + ] } } } diff --git a/doc/models/business-appointment-settings.md b/doc/models/business-appointment-settings.md index 31dfdbbc..fbf9dbb4 100644 --- a/doc/models/business-appointment-settings.md +++ b/doc/models/business-appointment-settings.md @@ -29,19 +29,25 @@ The service appointment settings, including where and how the service is provide ```json { - "location_types": null, - "alignment_time": null, - "min_booking_lead_time_seconds": null, - "max_booking_lead_time_seconds": null, - "any_team_member_booking_enabled": null, - "multiple_service_booking_enabled": null, - "max_appointments_per_day_limit_type": null, - "max_appointments_per_day_limit": null, - "cancellation_window_seconds": null, - "cancellation_fee_money": null, - "cancellation_policy": null, - "cancellation_policy_text": null, - "skip_booking_flow_staff_selection": null + "location_types": [ + "BUSINESS_LOCATION", + "CUSTOMER_LOCATION" + ], + "alignment_time": "HALF_HOURLY", + "min_booking_lead_time_seconds": 38, + "max_booking_lead_time_seconds": 48, + "any_team_member_booking_enabled": false, + "multiple_service_booking_enabled": false, + "max_appointments_per_day_limit_type": "PER_TEAM_MEMBER", + "max_appointments_per_day_limit": 178, + "cancellation_window_seconds": 72, + "cancellation_fee_money": { + "amount": 72, + "currency": "COU" + }, + "cancellation_policy": "CANCELLATION_TREATED_AS_NO_SHOW", + "cancellation_policy_text": "cancellation_policy_text2", + "skip_booking_flow_staff_selection": false } ``` diff --git a/doc/models/business-booking-profile.md b/doc/models/business-booking-profile.md index 614ded0b..1024b799 100644 --- a/doc/models/business-booking-profile.md +++ b/doc/models/business-booking-profile.md @@ -22,14 +22,35 @@ ```json { - "seller_id": null, - "created_at": null, - "booking_enabled": null, - "customer_timezone_choice": null, - "booking_policy": null, - "allow_user_cancel": null, - "business_appointment_settings": null, - "support_seller_level_writes": null + "seller_id": "seller_id8", + "created_at": "created_at2", + "booking_enabled": false, + "customer_timezone_choice": "BUSINESS_LOCATION_TIMEZONE", + "booking_policy": "ACCEPT_ALL", + "allow_user_cancel": false, + "business_appointment_settings": { + "location_types": [ + "CUSTOMER_LOCATION", + "PHONE", + "BUSINESS_LOCATION" + ], + "alignment_time": "SERVICE_DURATION", + "min_booking_lead_time_seconds": 68, + "max_booking_lead_time_seconds": 78, + "any_team_member_booking_enabled": false, + "multiple_service_booking_enabled": false, + "max_appointments_per_day_limit_type": "PER_TEAM_MEMBER", + "max_appointments_per_day_limit": 108, + "cancellation_window_seconds": 102, + "cancellation_fee_money": { + "amount": 102, + "currency": "QAR" + }, + "cancellation_policy": "CANCELLATION_TREATED_AS_NO_SHOW", + "cancellation_policy_text": "cancellation_policy_text2", + "skip_booking_flow_staff_selection": false + }, + "support_seller_level_writes": false } ``` diff --git a/doc/models/business-hours-period.md b/doc/models/business-hours-period.md index e8c48f0f..f39d83f9 100644 --- a/doc/models/business-hours-period.md +++ b/doc/models/business-hours-period.md @@ -19,9 +19,9 @@ Represents a period of time during which a business location is open. ```json { - "day_of_week": null, - "start_local_time": null, - "end_local_time": null + "day_of_week": "SAT", + "start_local_time": "start_local_time6", + "end_local_time": "end_local_time8" } ``` diff --git a/doc/models/business-hours.md b/doc/models/business-hours.md index 35fd0d5e..283572d9 100644 --- a/doc/models/business-hours.md +++ b/doc/models/business-hours.md @@ -17,7 +17,23 @@ The hours of operation for a location. ```json { - "periods": null + "periods": [ + { + "day_of_week": "MON", + "start_local_time": "start_local_time5", + "end_local_time": "end_local_time7" + }, + { + "day_of_week": "SUN", + "start_local_time": "start_local_time6", + "end_local_time": "end_local_time8" + }, + { + "day_of_week": "SAT", + "start_local_time": "start_local_time7", + "end_local_time": "end_local_time9" + } + ] } ``` diff --git a/doc/models/buy-now-pay-later-details.md b/doc/models/buy-now-pay-later-details.md index 68f269ea..507ccdb9 100644 --- a/doc/models/buy-now-pay-later-details.md +++ b/doc/models/buy-now-pay-later-details.md @@ -19,9 +19,13 @@ Additional details about a Buy Now Pay Later payment type. ```json { - "brand": null, - "afterpay_details": null, - "clearpay_details": null + "brand": "brand4", + "afterpay_details": { + "email_address": "email_address4" + }, + "clearpay_details": { + "email_address": "email_address4" + } } ``` diff --git a/doc/models/calculate-loyalty-points-request.md b/doc/models/calculate-loyalty-points-request.md index aa24677f..4a76f114 100644 --- a/doc/models/calculate-loyalty-points-request.md +++ b/doc/models/calculate-loyalty-points-request.md @@ -11,9 +11,9 @@ Represents a [CalculateLoyaltyPoints](../../doc/api/loyalty.md#calculate-loyalty | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `orderId` | `string \| undefined` | Optional | The [order](../../doc/models/order.md) ID for which to calculate the points.
Specify this field if your application uses the Orders API to process orders.
Otherwise, specify the `transaction_amount_money`. | +| `orderId` | `string \| undefined` | Optional | The [order](entity:Order) ID for which to calculate the points.
Specify this field if your application uses the Orders API to process orders.
Otherwise, specify the `transaction_amount_money`. | | `transactionAmountMoney` | [`Money \| undefined`](../../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. | -| `loyaltyAccountId` | `string \| undefined` | Optional | The ID of the target [loyalty account](../../doc/models/loyalty-account.md). Optionally specify this field
if your application uses the Orders API to process orders.

If specified, the `promotion_points` field in the response shows the number of points the buyer would
earn from the purchase. In this case, Square uses the account ID to determine whether the promotion's
`trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached.
If not specified, the `promotion_points` field shows the number of points the purchase qualifies
for regardless of the trigger limit.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | +| `loyaltyAccountId` | `string \| undefined` | Optional | The ID of the target [loyalty account](entity:LoyaltyAccount). Optionally specify this field
if your application uses the Orders API to process orders.

If specified, the `promotion_points` field in the response shows the number of points the buyer would
earn from the purchase. In this case, Square uses the account ID to determine whether the promotion's
`trigger_limit` (the maximum number of times that a buyer can trigger the promotion) has been reached.
If not specified, the `promotion_points` field shows the number of points the purchase qualifies
for regardless of the trigger limit.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | ## Example (as JSON) diff --git a/doc/models/cancel-booking-request.md b/doc/models/cancel-booking-request.md index b1f7e656..b0e837de 100644 --- a/doc/models/cancel-booking-request.md +++ b/doc/models/cancel-booking-request.md @@ -16,8 +16,8 @@ ```json { - "idempotency_key": null, - "booking_version": null + "idempotency_key": "idempotency_key6", + "booking_version": 0 } ``` diff --git a/doc/models/cancel-invoice-request.md b/doc/models/cancel-invoice-request.md index 0ea64cd1..0c58a056 100644 --- a/doc/models/cancel-invoice-request.md +++ b/doc/models/cancel-invoice-request.md @@ -11,7 +11,7 @@ Describes a `CancelInvoice` request. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `version` | `number` | Required | The version of the [invoice](../../doc/models/invoice.md) to cancel.
If you do not know the version, you can call
[GetInvoice](../../doc/api/invoices.md#get-invoice) or [ListInvoices](../../doc/api/invoices.md#list-invoices). | +| `version` | `number` | Required | The version of the [invoice](entity:Invoice) to cancel.
If you do not know the version, you can call
[GetInvoice](api-endpoint:Invoices-GetInvoice) or [ListInvoices](api-endpoint:Invoices-ListInvoices). | ## Example (as JSON) diff --git a/doc/models/capture-transaction-response.md b/doc/models/capture-transaction-response.md index c2a4e014..ba251f49 100644 --- a/doc/models/capture-transaction-response.md +++ b/doc/models/capture-transaction-response.md @@ -2,7 +2,7 @@ # Capture Transaction Response Defines the fields that are included in the response body of -a request to the [CaptureTransaction](../../doc/api/transactions.md#capture-transaction) endpoint. +a request to the [CaptureTransaction](api-endpoint:Transactions-CaptureTransaction) endpoint. ## Structure diff --git a/doc/models/card-payment-details.md b/doc/models/card-payment-details.md index a0d4c29a..7d249a76 100644 --- a/doc/models/card-payment-details.md +++ b/doc/models/card-payment-details.md @@ -32,22 +32,82 @@ Reflects the current status of a card payment. Contains only non-confidential in ```json { - "status": null, - "card": null, - "entry_method": null, - "cvv_status": null, - "avs_status": null, - "auth_result_code": null, - "application_identifier": null, - "application_name": null, - "application_cryptogram": null, - "verification_method": null, - "verification_results": null, - "statement_description": null, - "device_details": null, - "card_payment_timeline": null, - "refund_requires_card_presence": null, - "errors": null + "status": "status8", + "card": { + "id": "id6", + "card_brand": "OTHER_BRAND", + "last_4": "last_48", + "exp_month": 228, + "exp_year": 68, + "cardholder_name": "cardholder_name8", + "billing_address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_28", + "address_line_3": "address_line_34", + "locality": "locality2", + "sublocality": "sublocality8", + "sublocality_2": "sublocality_26", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_12", + "administrative_district_level_2": "administrative_district_level_26", + "administrative_district_level_3": "administrative_district_level_36", + "postal_code": "postal_code0", + "country": "KR", + "first_name": "first_name8", + "last_name": "last_name6" + }, + "fingerprint": "fingerprint2", + "customer_id": "customer_id4", + "merchant_id": "merchant_id6", + "reference_id": "reference_id6", + "enabled": false, + "card_type": "UNKNOWN_CARD_TYPE", + "prepaid_type": "PREPAID", + "bin": "bin6", + "version": 154, + "card_co_brand": "AFTERPAY" + }, + "entry_method": "entry_method6", + "cvv_status": "cvv_status8", + "avs_status": "avs_status4", + "auth_result_code": "auth_result_code8", + "application_identifier": "application_identifier2", + "application_name": "application_name4", + "application_cryptogram": "application_cryptogram4", + "verification_method": "verification_method0", + "verification_results": "verification_results8", + "statement_description": "statement_description4", + "device_details": { + "device_id": "device_id2", + "device_installation_id": "device_installation_id4", + "device_name": "device_name6" + }, + "card_payment_timeline": { + "authorized_at": "authorized_at6", + "captured_at": "captured_at6", + "voided_at": "voided_at0" + }, + "refund_requires_card_presence": false, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/card-payment-timeline.md b/doc/models/card-payment-timeline.md index 6bede21d..83c07185 100644 --- a/doc/models/card-payment-timeline.md +++ b/doc/models/card-payment-timeline.md @@ -19,9 +19,9 @@ The timeline for card payments. ```json { - "authorized_at": null, - "captured_at": null, - "voided_at": null + "authorized_at": "authorized_at4", + "captured_at": "captured_at4", + "voided_at": "voided_at8" } ``` diff --git a/doc/models/card.md b/doc/models/card.md index d852c460..1f146c7c 100644 --- a/doc/models/card.md +++ b/doc/models/card.md @@ -34,23 +34,38 @@ details are determined by the payment token generated by Web Payments SDK. ```json { - "id": null, - "card_brand": null, - "last_4": null, - "exp_month": null, - "exp_year": null, - "cardholder_name": null, - "billing_address": null, - "fingerprint": null, - "customer_id": null, - "merchant_id": null, - "reference_id": null, - "enabled": null, - "card_type": null, - "prepaid_type": null, - "bin": null, - "version": null, - "card_co_brand": null + "id": "id0", + "card_brand": "OTHER_BRAND", + "last_4": "last_42", + "exp_month": 42, + "exp_year": 254, + "cardholder_name": "cardholder_name4", + "billing_address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_28", + "address_line_3": "address_line_34", + "locality": "locality8", + "sublocality": "sublocality8", + "sublocality_2": "sublocality_26", + "sublocality_3": "sublocality_38", + "administrative_district_level_1": "administrative_district_level_12", + "administrative_district_level_2": "administrative_district_level_26", + "administrative_district_level_3": "administrative_district_level_36", + "postal_code": "postal_code0", + "country": "MG", + "first_name": "first_name8", + "last_name": "last_name6" + }, + "fingerprint": "fingerprint6", + "customer_id": "customer_id8", + "merchant_id": "merchant_id0", + "reference_id": "reference_id2", + "enabled": false, + "card_type": "DEBIT", + "prepaid_type": "UNKNOWN_PREPAID_TYPE", + "bin": "bin0", + "version": 172, + "card_co_brand": "UNKNOWN" } ``` diff --git a/doc/models/cash-app-details.md b/doc/models/cash-app-details.md index 468efed6..b7ce349d 100644 --- a/doc/models/cash-app-details.md +++ b/doc/models/cash-app-details.md @@ -12,16 +12,16 @@ Additional details about `WALLET` type payments with the `brand` of `CASH_APP`. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `buyerFullName` | `string \| undefined` | Optional | The name of the Cash App account holder.
**Constraints**: *Maximum Length*: `255` | -| `buyerCountryCode` | `string \| undefined` | Optional | The country of the Cash App account holder, in ISO 3166-1-alpha-2 format.

For possible values, see [Country](../../doc/models/country.md).
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2` | +| `buyerCountryCode` | `string \| undefined` | Optional | The country of the Cash App account holder, in ISO 3166-1-alpha-2 format.

For possible values, see [Country](entity:Country).
**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `2` | | `buyerCashtag` | `string \| undefined` | Optional | $Cashtag of the Cash App account holder.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `21` | ## Example (as JSON) ```json { - "buyer_full_name": null, - "buyer_country_code": null, - "buyer_cashtag": null + "buyer_full_name": "buyer_full_name4", + "buyer_country_code": "buyer_country_code4", + "buyer_cashtag": "buyer_cashtag6" } ``` diff --git a/doc/models/cash-drawer-device.md b/doc/models/cash-drawer-device.md index 3dfdc1d7..064e7257 100644 --- a/doc/models/cash-drawer-device.md +++ b/doc/models/cash-drawer-device.md @@ -16,8 +16,8 @@ ```json { - "id": null, - "name": null + "id": "id0", + "name": "name0" } ``` diff --git a/doc/models/cash-drawer-shift-event.md b/doc/models/cash-drawer-shift-event.md index faaaaa67..42545271 100644 --- a/doc/models/cash-drawer-shift-event.md +++ b/doc/models/cash-drawer-shift-event.md @@ -20,12 +20,15 @@ ```json { - "id": null, - "employee_id": null, - "event_type": null, - "event_money": null, - "created_at": null, - "description": null + "id": "id0", + "employee_id": "employee_id0", + "event_type": "OTHER_TENDER_CANCELLED_PAYMENT", + "event_money": { + "amount": 148, + "currency": "HTG" + }, + "created_at": "created_at2", + "description": "description0" } ``` diff --git a/doc/models/cash-drawer-shift-summary.md b/doc/models/cash-drawer-shift-summary.md index d2d4bc76..9ee71d05 100644 --- a/doc/models/cash-drawer-shift-summary.md +++ b/doc/models/cash-drawer-shift-summary.md @@ -28,15 +28,24 @@ end based on summing all cash drawer shift events. ```json { - "id": null, - "state": null, - "opened_at": null, - "ended_at": null, - "closed_at": null, - "description": null, - "opened_cash_money": null, - "expected_cash_money": null, - "closed_cash_money": null + "id": "id0", + "state": "CLOSED", + "opened_at": "opened_at8", + "ended_at": "ended_at2", + "closed_at": "closed_at2", + "description": "description0", + "opened_cash_money": { + "amount": 158, + "currency": "SBD" + }, + "expected_cash_money": { + "amount": 68, + "currency": "CHF" + }, + "closed_cash_money": { + "amount": 12, + "currency": "MRO" + } } ``` diff --git a/doc/models/cash-drawer-shift.md b/doc/models/cash-drawer-shift.md index 37b4a930..722922af 100644 --- a/doc/models/cash-drawer-shift.md +++ b/doc/models/cash-drawer-shift.md @@ -37,24 +37,50 @@ event types. ```json { - "id": null, - "state": null, - "opened_at": null, - "ended_at": null, - "closed_at": null, - "employee_ids": null, - "opening_employee_id": null, - "ending_employee_id": null, - "closing_employee_id": null, - "description": null, - "opened_cash_money": null, - "cash_payment_money": null, - "cash_refunds_money": null, - "cash_paid_in_money": null, - "cash_paid_out_money": null, - "expected_cash_money": null, - "closed_cash_money": null, - "device": null + "id": "id0", + "state": "CLOSED", + "opened_at": "opened_at8", + "ended_at": "ended_at2", + "closed_at": "closed_at2", + "employee_ids": [ + "employee_ids5" + ], + "opening_employee_id": "opening_employee_id2", + "ending_employee_id": "ending_employee_id8", + "closing_employee_id": "closing_employee_id4", + "description": "description0", + "opened_cash_money": { + "amount": 158, + "currency": "SBD" + }, + "cash_payment_money": { + "amount": 92, + "currency": "CLF" + }, + "cash_refunds_money": { + "amount": 8, + "currency": "LAK" + }, + "cash_paid_in_money": { + "amount": 122, + "currency": "USS" + }, + "cash_paid_out_money": { + "amount": 128, + "currency": "COP" + }, + "expected_cash_money": { + "amount": 68, + "currency": "CHF" + }, + "closed_cash_money": { + "amount": 12, + "currency": "MRO" + }, + "device": { + "id": "id6", + "name": "name6" + } } ``` diff --git a/doc/models/cash-payment-details.md b/doc/models/cash-payment-details.md index 0c3f2953..8143ebf2 100644 --- a/doc/models/cash-payment-details.md +++ b/doc/models/cash-payment-details.md @@ -20,10 +20,13 @@ Stores details about a cash payment. Contains only non-confidential information. ```json { "buyer_supplied_money": { - "amount": null, - "currency": null + "amount": 114, + "currency": "UNKNOWN_CURRENCY" }, - "change_back_money": null + "change_back_money": { + "amount": 78, + "currency": "MUR" + } } ``` diff --git a/doc/models/catalog-custom-attribute-definition-number-config.md b/doc/models/catalog-custom-attribute-definition-number-config.md index c1e38bed..9c6c5aa6 100644 --- a/doc/models/catalog-custom-attribute-definition-number-config.md +++ b/doc/models/catalog-custom-attribute-definition-number-config.md @@ -15,7 +15,7 @@ ```json { - "precision": null + "precision": 196 } ``` diff --git a/doc/models/catalog-custom-attribute-definition-selection-config-custom-attribute-selection.md b/doc/models/catalog-custom-attribute-definition-selection-config-custom-attribute-selection.md index ce00af69..9d87d764 100644 --- a/doc/models/catalog-custom-attribute-definition-selection-config-custom-attribute-selection.md +++ b/doc/models/catalog-custom-attribute-definition-selection-config-custom-attribute-selection.md @@ -18,7 +18,7 @@ A named selection for this `SELECTION`-type custom attribute definition. ```json { - "uid": null, + "uid": "uid0", "name": "name0" } ``` diff --git a/doc/models/catalog-custom-attribute-definition-selection-config.md b/doc/models/catalog-custom-attribute-definition-selection-config.md index 417bc36b..9eb80aab 100644 --- a/doc/models/catalog-custom-attribute-definition-selection-config.md +++ b/doc/models/catalog-custom-attribute-definition-selection-config.md @@ -18,8 +18,21 @@ Configuration associated with `SELECTION`-type custom attribute definitions. ```json { - "max_allowed_selections": null, - "allowed_selections": null + "max_allowed_selections": 86, + "allowed_selections": [ + { + "uid": "uid5", + "name": "name5" + }, + { + "uid": "uid6", + "name": "name6" + }, + { + "uid": "uid7", + "name": "name7" + } + ] } ``` diff --git a/doc/models/catalog-custom-attribute-definition-string-config.md b/doc/models/catalog-custom-attribute-definition-string-config.md index af758016..aa2a3391 100644 --- a/doc/models/catalog-custom-attribute-definition-string-config.md +++ b/doc/models/catalog-custom-attribute-definition-string-config.md @@ -17,7 +17,7 @@ Configuration associated with Custom Attribute Definitions of type `STRING`. ```json { - "enforce_uniqueness": null + "enforce_uniqueness": false } ``` diff --git a/doc/models/catalog-custom-attribute-definition.md b/doc/models/catalog-custom-attribute-definition.md index b056894b..6af85789 100644 --- a/doc/models/catalog-custom-attribute-definition.md +++ b/doc/models/catalog-custom-attribute-definition.md @@ -19,7 +19,7 @@ to store any sensitive information (personally identifiable information, card de | `name` | `string` | Required | The name of this definition for API and seller-facing UI purposes.
The name must be unique within the (merchant, application) pair. Required.
May not be empty and may not exceed 255 characters. Can be modified after creation.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | | `description` | `string \| undefined` | Optional | Seller-oriented description of the meaning of this Custom Attribute,
any constraints that the seller should observe, etc. May be displayed as a tooltip in Square UIs.
**Constraints**: *Maximum Length*: `255` | | `sourceApplication` | [`SourceApplication \| undefined`](../../doc/models/source-application.md) | Optional | Represents information about the application used to generate a change. | -| `allowedObjectTypes` | [`string[]`](../../doc/models/catalog-object-type.md) | Required | The set of Catalog Object Types that this Custom Attribute may be applied to.
Currently, only `ITEM` and `ITEM_VARIATION` are allowed. At least one type must be included.
See [CatalogObjectType](#type-catalogobjecttype) for possible values | +| `allowedObjectTypes` | [`string[]`](../../doc/models/catalog-object-type.md) | Required | The set of `CatalogObject` types that this custom atttribute may be applied to.
Currently, only `ITEM`, `ITEM_VARIATION`, and `MODIFIER` are allowed. At least one type must be included.
See [CatalogObjectType](#type-catalogobjecttype) for possible values | | `sellerVisibility` | [`string \| undefined`](../../doc/models/catalog-custom-attribute-definition-seller-visibility.md) | Optional | Defines the visibility of a custom attribute to sellers in Square
client applications, Square APIs or in Square UIs (including Square Point
of Sale applications and Square Dashboard). | | `appVisibility` | [`string \| undefined`](../../doc/models/catalog-custom-attribute-definition-app-visibility.md) | Optional | Defines the visibility of a custom attribute to applications other than their
creating application. | | `stringConfig` | [`CatalogCustomAttributeDefinitionStringConfig \| undefined`](../../doc/models/catalog-custom-attribute-definition-string-config.md) | Optional | Configuration associated with Custom Attribute Definitions of type `STRING`. | @@ -34,20 +34,40 @@ to store any sensitive information (personally identifiable information, card de { "type": "NUMBER", "name": "name0", - "description": null, - "source_application": null, + "description": "description0", + "source_application": { + "product": "BILLING", + "application_id": "application_id8", + "name": "name2" + }, "allowed_object_types": [ "PRICING_RULE", "PRODUCT_SET", "TIME_PERIOD" ], - "seller_visibility": null, - "app_visibility": null, - "string_config": null, - "number_config": null, - "selection_config": null, - "custom_attribute_usage_count": null, - "key": null + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_HIDDEN", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 12 + }, + "selection_config": { + "max_allowed_selections": 44, + "allowed_selections": [ + { + "uid": "uid1", + "name": "name1" + }, + { + "uid": "uid2", + "name": "name2" + } + ] + }, + "custom_attribute_usage_count": 220, + "key": "key0" } ``` diff --git a/doc/models/catalog-custom-attribute-value.md b/doc/models/catalog-custom-attribute-value.md index 2a2af3b3..68903847 100644 --- a/doc/models/catalog-custom-attribute-value.md +++ b/doc/models/catalog-custom-attribute-value.md @@ -15,25 +15,27 @@ added to `ITEM` and `ITEM_VARIATION` type catalog objects. | --- | --- | --- | --- | | `name` | `string \| undefined` | Optional | The name of the custom attribute. | | `stringValue` | `string \| undefined` | Optional | The string value of the custom attribute. Populated if `type` = `STRING`. | -| `customAttributeDefinitionId` | `string \| undefined` | Optional | The id of the [CatalogCustomAttributeDefinition](../../doc/models/catalog-custom-attribute-definition.md) this value belongs to. | +| `customAttributeDefinitionId` | `string \| undefined` | Optional | The id of the [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) this value belongs to. | | `type` | [`string \| undefined`](../../doc/models/catalog-custom-attribute-definition-type.md) | Optional | Defines the possible types for a custom attribute. | | `numberValue` | `string \| undefined` | Optional | Populated if `type` = `NUMBER`. Contains a string
representation of a decimal number, using a `.` as the decimal separator. | | `booleanValue` | `boolean \| undefined` | Optional | A `true` or `false` value. Populated if `type` = `BOOLEAN`. | | `selectionUidValues` | `string[] \| undefined` | Optional | One or more choices from `allowed_selections`. Populated if `type` = `SELECTION`. | -| `key` | `string \| undefined` | Optional | A copy of key from the associated `CatalogCustomAttributeDefinition`. | +| `key` | `string \| undefined` | Optional | If the associated `CatalogCustomAttributeDefinition` object is defined by another application, this key 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", this key is "abcd1234:cocoa_brand"
when the application making the request is different from the application defining the custom attribute definition. Otherwise, the key is simply "cocoa_brand". | ## Example (as JSON) ```json { - "name": null, - "string_value": null, - "custom_attribute_definition_id": null, - "type": null, - "number_value": null, - "boolean_value": null, - "selection_uid_values": null, - "key": null + "name": "name0", + "string_value": "string_value4", + "custom_attribute_definition_id": "custom_attribute_definition_id2", + "type": "NUMBER", + "number_value": "number_value0", + "boolean_value": false, + "selection_uid_values": [ + "selection_uid_values7" + ], + "key": "key0" } ``` diff --git a/doc/models/catalog-id-mapping.md b/doc/models/catalog-id-mapping.md index 4cbb85bb..07c7d4e7 100644 --- a/doc/models/catalog-id-mapping.md +++ b/doc/models/catalog-id-mapping.md @@ -28,8 +28,8 @@ to the new object. The permanent ID is unique across the Square catalog. ```json { - "client_object_id": null, - "object_id": null + "client_object_id": "client_object_id0", + "object_id": "object_id8" } ``` diff --git a/doc/models/catalog-image.md b/doc/models/catalog-image.md index bb6da627..7cb4f050 100644 --- a/doc/models/catalog-image.md +++ b/doc/models/catalog-image.md @@ -16,19 +16,19 @@ Images on other object types are for use by 3rd party application developers. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `name` | `string \| undefined` | Optional | The internal name to identify this image in calls to the Square API.
This is a searchable attribute for use in applicable query filters
using the [SearchCatalogObjects](../../doc/api/catalog.md#search-catalog-objects).
It is not unique and should not be shown in a buyer facing context. | -| `url` | `string \| undefined` | Optional | The URL of this image, generated by Square after an image is uploaded
using the [CreateCatalogImage](../../doc/api/catalog.md#create-catalog-image) endpoint.
To modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field. | -| `caption` | `string \| undefined` | Optional | A caption that describes what is shown in the image. Displayed in the
Square Online Store. This is a searchable attribute for use in applicable query filters
using the [SearchCatalogObjects](../../doc/api/catalog.md#search-catalog-objects). | +| `name` | `string \| undefined` | Optional | The internal name to identify this image in calls to the Square API.
This is a searchable attribute for use in applicable query filters
using the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects).
It is not unique and should not be shown in a buyer facing context. | +| `url` | `string \| undefined` | Optional | The URL of this image, generated by Square after an image is uploaded
using the [CreateCatalogImage](api-endpoint:Catalog-CreateCatalogImage) endpoint.
To modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field. | +| `caption` | `string \| undefined` | Optional | A caption that describes what is shown in the image. Displayed in the
Square Online Store. This is a searchable attribute for use in applicable query filters
using the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects). | | `photoStudioOrderId` | `string \| undefined` | Optional | The immutable order ID for this image object created by the Photo Studio service in Square Online Store. | ## Example (as JSON) ```json { - "name": null, - "url": null, - "caption": null, - "photo_studio_order_id": null + "name": "name0", + "url": "url4", + "caption": "caption4", + "photo_studio_order_id": "photo_studio_order_id2" } ``` diff --git a/doc/models/catalog-info-response-limits.md b/doc/models/catalog-info-response-limits.md index b8f02903..71b51125 100644 --- a/doc/models/catalog-info-response-limits.md +++ b/doc/models/catalog-info-response-limits.md @@ -25,17 +25,17 @@ ```json { - "batch_upsert_max_objects_per_batch": null, - "batch_upsert_max_total_objects": null, - "batch_retrieve_max_object_ids": null, - "search_max_page_limit": null, - "batch_delete_max_object_ids": null, - "update_item_taxes_max_item_ids": null, - "update_item_taxes_max_taxes_to_enable": null, - "update_item_taxes_max_taxes_to_disable": null, - "update_item_modifier_lists_max_item_ids": null, - "update_item_modifier_lists_max_modifier_lists_to_enable": null, - "update_item_modifier_lists_max_modifier_lists_to_disable": null + "batch_upsert_max_objects_per_batch": 126, + "batch_upsert_max_total_objects": 214, + "batch_retrieve_max_object_ids": 230, + "search_max_page_limit": 192, + "batch_delete_max_object_ids": 216, + "update_item_taxes_max_item_ids": 80, + "update_item_taxes_max_taxes_to_enable": 34, + "update_item_taxes_max_taxes_to_disable": 116, + "update_item_modifier_lists_max_item_ids": 160, + "update_item_modifier_lists_max_modifier_lists_to_enable": 106, + "update_item_modifier_lists_max_modifier_lists_to_disable": 92 } ``` diff --git a/doc/models/catalog-item-modifier-list-info.md b/doc/models/catalog-item-modifier-list-info.md index 4aeafdfe..2640c6d9 100644 --- a/doc/models/catalog-item-modifier-list-info.md +++ b/doc/models/catalog-item-modifier-list-info.md @@ -22,10 +22,15 @@ Options to control the properties of a `CatalogModifierList` applied to a `Catal ```json { "modifier_list_id": "modifier_list_id6", - "modifier_overrides": null, - "min_selected_modifiers": null, - "max_selected_modifiers": null, - "enabled": null + "modifier_overrides": [ + { + "modifier_id": "modifier_id1", + "on_by_default": true + } + ], + "min_selected_modifiers": 38, + "max_selected_modifiers": 198, + "enabled": false } ``` diff --git a/doc/models/catalog-item-option-for-item.md b/doc/models/catalog-item-option-for-item.md index 93717ec9..05a4f87c 100644 --- a/doc/models/catalog-item-option-for-item.md +++ b/doc/models/catalog-item-option-for-item.md @@ -18,7 +18,7 @@ For example, a t-shirt item may offer a color option or a size option. ```json { - "item_option_id": null + "item_option_id": "item_option_id2" } ``` diff --git a/doc/models/catalog-item-option-value-for-item-variation.md b/doc/models/catalog-item-option-value-for-item-variation.md index 6c7deb3e..c6fed680 100644 --- a/doc/models/catalog-item-option-value-for-item-variation.md +++ b/doc/models/catalog-item-option-value-for-item-variation.md @@ -21,8 +21,8 @@ For example, "Color:Red, Size:Small" or "Color:Blue, Size:Medium". ```json { - "item_option_id": null, - "item_option_value_id": null + "item_option_id": "item_option_id2", + "item_option_value_id": "item_option_value_id0" } ``` diff --git a/doc/models/catalog-item-option-value.md b/doc/models/catalog-item-option-value.md index 221de490..97ba6635 100644 --- a/doc/models/catalog-item-option-value.md +++ b/doc/models/catalog-item-option-value.md @@ -23,11 +23,11 @@ its item option values. ```json { - "item_option_id": null, - "name": null, - "description": null, - "color": null, - "ordinal": null + "item_option_id": "item_option_id2", + "name": "name0", + "description": "description0", + "color": "color6", + "ordinal": 80 } ``` diff --git a/doc/models/catalog-item-option.md b/doc/models/catalog-item-option.md index 2afb1771..96c3aea8 100644 --- a/doc/models/catalog-item-option.md +++ b/doc/models/catalog-item-option.md @@ -21,11 +21,3015 @@ A group of variations for a `CatalogItem`. ```json { - "name": null, - "display_name": null, - "description": null, - "show_colors": null, - "values": null + "name": "name0", + "display_name": "display_name0", + "description": "description0", + "show_colors": false, + "values": [ + { + "type": "MODIFIER", + "id": "id0", + "updated_at": "updated_at6", + "version": 100, + "is_deleted": false, + "custom_attribute_values": { + "key0": { + "name": "name1", + "string_value": "string_value5", + "custom_attribute_definition_id": "custom_attribute_definition_id1", + "type": "SELECTION", + "number_value": "number_value1", + "boolean_value": true, + "selection_uid_values": [ + "selection_uid_values8", + "selection_uid_values9" + ], + "key": "key1" + }, + "key1": { + "name": "name0", + "string_value": "string_value4", + "custom_attribute_definition_id": "custom_attribute_definition_id2", + "type": "STRING", + "number_value": "number_value0", + "boolean_value": false, + "selection_uid_values": [ + "selection_uid_values7" + ], + "key": "key0" + }, + "key2": { + "name": "name9", + "string_value": "string_value3", + "custom_attribute_definition_id": "custom_attribute_definition_id3", + "type": "BOOLEAN", + "number_value": "number_value9", + "boolean_value": true, + "selection_uid_values": [ + "selection_uid_values6", + "selection_uid_values7", + "selection_uid_values8" + ], + "key": "key9" + } + }, + "catalog_v1_ids": [ + { + "catalog_v1_id": "catalog_v1_id4", + "location_id": "location_id4" + }, + { + "catalog_v1_id": "catalog_v1_id5", + "location_id": "location_id5" + }, + { + "catalog_v1_id": "catalog_v1_id6", + "location_id": "location_id6" + } + ], + "present_at_all_locations": false, + "present_at_location_ids": [ + "present_at_location_ids0", + "present_at_location_ids1" + ], + "absent_at_location_ids": [ + "absent_at_location_ids1", + "absent_at_location_ids2", + "absent_at_location_ids3" + ], + "item_data": { + "name": "name8", + "description": "description8", + "abbreviation": "abbreviation0", + "label_color": "label_color0", + "available_online": false, + "available_for_pickup": false, + "available_electronically": false, + "category_id": "category_id0", + "tax_ids": [ + "tax_ids9" + ], + "modifier_list_info": [ + { + "modifier_list_id": "modifier_list_id8", + "modifier_overrides": [ + { + "modifier_id": "modifier_id1", + "on_by_default": true + } + ], + "min_selected_modifiers": 60, + "max_selected_modifiers": 40, + "enabled": false + }, + { + "modifier_list_id": "modifier_list_id9", + "modifier_overrides": [ + { + "modifier_id": "modifier_id2", + "on_by_default": false + }, + { + "modifier_id": "modifier_id3", + "on_by_default": true + } + ], + "min_selected_modifiers": 61, + "max_selected_modifiers": 41, + "enabled": true + } + ], + "variations": [ + { + "type": "ITEM", + "id": "id9", + "updated_at": "updated_at5", + "version": 203, + "is_deleted": true, + "custom_attribute_values": { + "key0": {}, + "key1": {}, + "key2": {} + }, + "catalog_v1_ids": [ + {}, + {}, + {} + ], + "present_at_all_locations": true, + "present_at_location_ids": [ + "present_at_location_ids9", + "present_at_location_ids0" + ], + "absent_at_location_ids": [ + "absent_at_location_ids0", + "absent_at_location_ids1", + "absent_at_location_ids2" + ], + "item_data": { + "name": "name9", + "description": "description9", + "abbreviation": "abbreviation1", + "label_color": "label_color1", + "available_online": true, + "available_for_pickup": true, + "available_electronically": true, + "category_id": "category_id9", + "tax_ids": [ + "tax_ids2" + ], + "modifier_list_info": [ + {}, + {} + ], + "variations": [ + {}, + {}, + {} + ], + "product_type": "REGULAR", + "skip_modifier_screen": true, + "item_options": [ + { + "item_option_id": "item_option_id2" + } + ], + "image_ids": [ + "image_ids6", + "image_ids5" + ], + "sort_name": "sort_name9", + "description_html": "description_html9", + "description_plaintext": "description_plaintext9" + }, + "category_data": { + "name": "name3", + "image_ids": [ + "image_ids8", + "image_ids9" + ] + }, + "item_variation_data": { + "item_id": "item_id5", + "name": "name5", + "sku": "sku9", + "upc": "upc7", + "ordinal": 253, + "pricing_type": "VARIABLE_PRICING", + "price_money": { + "amount": 29, + "currency": "SDG" + }, + "location_overrides": [ + { + "location_id": "location_id0", + "price_money": { + "amount": 72, + "currency": "RWF" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 192, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until4" + }, + { + "location_id": "location_id1", + "price_money": { + "amount": 73, + "currency": "SAR" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 193, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until5" + } + ], + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 1, + "user_data": "user_data1", + "service_duration": 87, + "available_for_booking": true, + "item_option_values": [ + { + "item_option_id": "item_option_id6", + "item_option_value_id": "item_option_value_id6" + } + ], + "measurement_unit_id": "measurement_unit_id5", + "sellable": true, + "stockable": true, + "image_ids": [ + "image_ids0" + ], + "team_member_ids": [ + "team_member_ids2" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id7", + "stockable_quantity": "stockable_quantity5", + "nonstockable_quantity": "nonstockable_quantity7" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids4", + "item_variation_vendor_info_ids5", + "item_variation_vendor_info_ids6" + ] + }, + "tax_data": { + "name": "name7", + "calculation_phase": "TAX_TOTAL_PHASE", + "inclusion_type": "INCLUSIVE", + "percentage": "percentage5", + "applies_to_custom_amounts": true, + "enabled": true + }, + "discount_data": { + "name": "name3", + "discount_type": "VARIABLE_AMOUNT", + "percentage": "percentage1", + "amount_money": {}, + "pin_required": true, + "label_color": "label_color5", + "modify_tax_basis": "DO_NOT_MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name7", + "ordinal": 67, + "selection_type": "MULTIPLE", + "modifiers": [ + {}, + {} + ], + "image_ids": [ + "image_ids8", + "image_ids7" + ] + }, + "modifier_data": { + "name": "name3", + "price_money": {}, + "ordinal": 45, + "modifier_list_id": "modifier_list_id9", + "image_id": "image_id7" + }, + "time_period_data": { + "event": "event7" + }, + "product_set_data": { + "name": "name7", + "product_ids_any": [ + "product_ids_any9" + ], + "product_ids_all": [ + "product_ids_all8" + ], + "quantity_exact": 95, + "quantity_min": 229, + "quantity_max": 203, + "all_products": true + }, + "pricing_rule_data": { + "name": "name1", + "time_period_ids": [ + "time_period_ids3", + "time_period_ids4", + "time_period_ids5" + ], + "discount_id": "discount_id9", + "match_products_id": "match_products_id1", + "apply_products_id": "apply_products_id5", + "exclude_products_id": "exclude_products_id7", + "valid_from_date": "valid_from_date1", + "valid_from_local_time": "valid_from_local_time9", + "valid_until_date": "valid_until_date3", + "valid_until_local_time": "valid_until_local_time3", + "exclude_strategy": "MOST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any0", + "customer_group_ids_any1", + "customer_group_ids_any2" + ] + }, + "image_data": { + "name": "name9", + "url": "url3", + "caption": "caption3", + "photo_studio_order_id": "photo_studio_order_id1" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name5", + "abbreviation": "abbreviation7" + }, + "area_unit": "METRIC_SQUARE_CENTIMETER", + "length_unit": "IMPERIAL_MILE", + "volume_unit": "GENERIC_PINT", + "weight_unit": "METRIC_MILLIGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_SECOND", + "type": "TYPE_VOLUME" + }, + "precision": 185 + }, + "subscription_plan_data": { + "name": "name1", + "phases": [ + { + "uid": "uid4", + "cadence": "EVERY_TWO_YEARS", + "periods": 202, + "recurring_price_money": {}, + "ordinal": 168 + }, + { + "uid": "uid3", + "cadence": "DAILY", + "periods": 201, + "recurring_price_money": {}, + "ordinal": 167 + } + ] + }, + "item_option_data": { + "name": "name7", + "display_name": "display_name7", + "description": "description3", + "show_colors": true, + "values": [ + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id1", + "name": "name9", + "description": "description9", + "color": "color3", + "ordinal": 179 + }, + "custom_attribute_definition_data": { + "type": "BOOLEAN", + "name": "name7", + "description": "description7", + "source_application": { + "product": "OTHER", + "application_id": "application_id5", + "name": "name9" + }, + "allowed_object_types": [ + "PRODUCT_SET", + "PRICING_RULE", + "MODIFIER" + ], + "seller_visibility": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "app_visibility": "APP_VISIBILITY_READ_ONLY", + "string_config": { + "enforce_uniqueness": true + }, + "number_config": { + "precision": 227 + }, + "selection_config": { + "max_allowed_selections": 169, + "allowed_selections": [ + { + "uid": "uid6", + "name": "name6" + }, + { + "uid": "uid7", + "name": "name7" + } + ] + }, + "custom_attribute_usage_count": 5, + "key": "key7" + }, + "quick_amounts_settings_data": { + "option": "MANUAL", + "eligible_for_auto_amounts": true, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 95, + "ordinal": 27 + } + ] + } + }, + { + "type": "SUBSCRIPTION_PLAN", + "id": "id0", + "updated_at": "updated_at4", + "version": 204, + "is_deleted": false, + "custom_attribute_values": { + "key0": {}, + "key1": {} + }, + "catalog_v1_ids": [ + {} + ], + "present_at_all_locations": false, + "present_at_location_ids": [ + "present_at_location_ids0", + "present_at_location_ids1", + "present_at_location_ids2" + ], + "absent_at_location_ids": [ + "absent_at_location_ids1" + ], + "item_data": { + "name": "name8", + "description": "description8", + "abbreviation": "abbreviation0", + "label_color": "label_color0", + "available_online": false, + "available_for_pickup": false, + "available_electronically": false, + "category_id": "category_id0", + "tax_ids": [ + "tax_ids1", + "tax_ids0" + ], + "modifier_list_info": [ + {} + ], + "variations": [ + {} + ], + "product_type": "APPOINTMENTS_SERVICE", + "skip_modifier_screen": false, + "item_options": [ + { + "item_option_id": "item_option_id3" + }, + { + "item_option_id": "item_option_id2" + }, + { + "item_option_id": "item_option_id1" + } + ], + "image_ids": [ + "image_ids7" + ], + "sort_name": "sort_name0", + "description_html": "description_html8", + "description_plaintext": "description_plaintext8" + }, + "category_data": { + "name": "name4", + "image_ids": [ + "image_ids9", + "image_ids0", + "image_ids1" + ] + }, + "item_variation_data": { + "item_id": "item_id4", + "name": "name6", + "sku": "sku8", + "upc": "upc6", + "ordinal": 254, + "pricing_type": "FIXED_PRICING", + "price_money": { + "amount": 28, + "currency": "SCR" + }, + "location_overrides": [ + { + "location_id": "location_id1", + "price_money": { + "amount": 73, + "currency": "SAR" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 193, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until5" + }, + { + "location_id": "location_id2", + "price_money": { + "amount": 74, + "currency": "SBD" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 194, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until6" + }, + { + "location_id": "location_id3", + "price_money": { + "amount": 75, + "currency": "SCR" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 195, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until7" + } + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 0, + "user_data": "user_data0", + "service_duration": 88, + "available_for_booking": false, + "item_option_values": [ + { + "item_option_id": "item_option_id5", + "item_option_value_id": "item_option_value_id7" + }, + { + "item_option_id": "item_option_id6", + "item_option_value_id": "item_option_value_id6" + }, + { + "item_option_id": "item_option_id7", + "item_option_value_id": "item_option_value_id5" + } + ], + "measurement_unit_id": "measurement_unit_id4", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids9", + "image_ids0", + "image_ids1" + ], + "team_member_ids": [ + "team_member_ids3", + "team_member_ids4" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id6", + "stockable_quantity": "stockable_quantity6", + "nonstockable_quantity": "nonstockable_quantity8" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids5" + ] + }, + "tax_data": { + "name": "name6", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "percentage4", + "applies_to_custom_amounts": false, + "enabled": false + }, + "discount_data": { + "name": "name2", + "discount_type": "VARIABLE_PERCENTAGE", + "percentage": "percentage0", + "amount_money": {}, + "pin_required": false, + "label_color": "label_color4", + "modify_tax_basis": "MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name6", + "ordinal": 66, + "selection_type": "SINGLE", + "modifiers": [ + {} + ], + "image_ids": [ + "image_ids9" + ] + }, + "modifier_data": { + "name": "name2", + "price_money": {}, + "ordinal": 44, + "modifier_list_id": "modifier_list_id8", + "image_id": "image_id6" + }, + "time_period_data": { + "event": "event6" + }, + "product_set_data": { + "name": "name8", + "product_ids_any": [ + "product_ids_any0", + "product_ids_any9", + "product_ids_any8" + ], + "product_ids_all": [ + "product_ids_all9", + "product_ids_all8", + "product_ids_all7" + ], + "quantity_exact": 96, + "quantity_min": 230, + "quantity_max": 204, + "all_products": false + }, + "pricing_rule_data": { + "name": "name0", + "time_period_ids": [ + "time_period_ids2", + "time_period_ids3" + ], + "discount_id": "discount_id8", + "match_products_id": "match_products_id2", + "apply_products_id": "apply_products_id6", + "exclude_products_id": "exclude_products_id6", + "valid_from_date": "valid_from_date2", + "valid_from_local_time": "valid_from_local_time0", + "valid_until_date": "valid_until_date4", + "valid_until_local_time": "valid_until_local_time4", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any9", + "customer_group_ids_any0" + ] + }, + "image_data": { + "name": "name0", + "url": "url4", + "caption": "caption4", + "photo_studio_order_id": "photo_studio_order_id2" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name4", + "abbreviation": "abbreviation6" + }, + "area_unit": "IMPERIAL_SQUARE_MILE", + "length_unit": "METRIC_MILLIMETER", + "volume_unit": "GENERIC_CUP", + "weight_unit": "METRIC_GRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MILLISECOND", + "type": "TYPE_WEIGHT" + }, + "precision": 184 + }, + "subscription_plan_data": { + "name": "name0", + "phases": [ + { + "uid": "uid5", + "cadence": "ANNUAL", + "periods": 203, + "recurring_price_money": {}, + "ordinal": 169 + } + ] + }, + "item_option_data": { + "name": "name6", + "display_name": "display_name6", + "description": "description4", + "show_colors": false, + "values": [ + {}, + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id2", + "name": "name0", + "description": "description0", + "color": "color4", + "ordinal": 180 + }, + "custom_attribute_definition_data": { + "type": "STRING", + "name": "name8", + "description": "description8", + "source_application": { + "product": "SQUARE_POS", + "application_id": "application_id6", + "name": "name0" + }, + "allowed_object_types": [ + "PRICING_RULE" + ], + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_READ_WRITE_VALUES", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 226 + }, + "selection_config": { + "max_allowed_selections": 170, + "allowed_selections": [ + { + "uid": "uid7", + "name": "name7" + }, + { + "uid": "uid8", + "name": "name8" + }, + { + "uid": "uid9", + "name": "name9" + } + ] + }, + "custom_attribute_usage_count": 6, + "key": "key8" + }, + "quick_amounts_settings_data": { + "option": "AUTO", + "eligible_for_auto_amounts": false, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 96, + "ordinal": 28 + }, + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 97, + "ordinal": 29 + } + ] + } + }, + { + "type": "QUICK_AMOUNTS_SETTINGS", + "id": "id1", + "updated_at": "updated_at3", + "version": 205, + "is_deleted": true, + "custom_attribute_values": { + "key0": {} + }, + "catalog_v1_ids": [ + {}, + {} + ], + "present_at_all_locations": true, + "present_at_location_ids": [ + "present_at_location_ids1" + ], + "absent_at_location_ids": [ + "absent_at_location_ids2", + "absent_at_location_ids3" + ], + "item_data": { + "name": "name7", + "description": "description7", + "abbreviation": "abbreviation9", + "label_color": "label_color9", + "available_online": true, + "available_for_pickup": true, + "available_electronically": true, + "category_id": "category_id1", + "tax_ids": [ + "tax_ids0", + "tax_ids9", + "tax_ids8" + ], + "modifier_list_info": [ + {}, + {}, + {} + ], + "variations": [ + {}, + {} + ], + "product_type": "GIFT_CARD", + "skip_modifier_screen": true, + "item_options": [ + { + "item_option_id": "item_option_id4" + }, + { + "item_option_id": "item_option_id3" + } + ], + "image_ids": [ + "image_ids8", + "image_ids7", + "image_ids6" + ], + "sort_name": "sort_name1", + "description_html": "description_html7", + "description_plaintext": "description_plaintext7" + }, + "category_data": { + "name": "name5", + "image_ids": [ + "image_ids0" + ] + }, + "item_variation_data": { + "item_id": "item_id3", + "name": "name7", + "sku": "sku7", + "upc": "upc5", + "ordinal": 255, + "pricing_type": "VARIABLE_PRICING", + "price_money": { + "amount": 27, + "currency": "SBD" + }, + "location_overrides": [ + { + "location_id": "location_id2", + "price_money": { + "amount": 74, + "currency": "SBD" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 194, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until6" + } + ], + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 255, + "user_data": "user_data9", + "service_duration": 89, + "available_for_booking": true, + "item_option_values": [ + { + "item_option_id": "item_option_id4", + "item_option_value_id": "item_option_value_id8" + }, + { + "item_option_id": "item_option_id5", + "item_option_value_id": "item_option_value_id7" + } + ], + "measurement_unit_id": "measurement_unit_id3", + "sellable": true, + "stockable": true, + "image_ids": [ + "image_ids8", + "image_ids9" + ], + "team_member_ids": [ + "team_member_ids4", + "team_member_ids5", + "team_member_ids6" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id5", + "stockable_quantity": "stockable_quantity7", + "nonstockable_quantity": "nonstockable_quantity9" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids6", + "item_variation_vendor_info_ids7" + ] + }, + "tax_data": { + "name": "name5", + "calculation_phase": "TAX_TOTAL_PHASE", + "inclusion_type": "INCLUSIVE", + "percentage": "percentage3", + "applies_to_custom_amounts": true, + "enabled": true + }, + "discount_data": { + "name": "name1", + "discount_type": "FIXED_AMOUNT", + "percentage": "percentage9", + "amount_money": {}, + "pin_required": true, + "label_color": "label_color3", + "modify_tax_basis": "DO_NOT_MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name5", + "ordinal": 65, + "selection_type": "MULTIPLE", + "modifiers": [ + {}, + {}, + {} + ], + "image_ids": [ + "image_ids0", + "image_ids9", + "image_ids8" + ] + }, + "modifier_data": { + "name": "name1", + "price_money": {}, + "ordinal": 43, + "modifier_list_id": "modifier_list_id7", + "image_id": "image_id5" + }, + "time_period_data": { + "event": "event5" + }, + "product_set_data": { + "name": "name9", + "product_ids_any": [ + "product_ids_any1", + "product_ids_any0" + ], + "product_ids_all": [ + "product_ids_all0", + "product_ids_all9" + ], + "quantity_exact": 97, + "quantity_min": 231, + "quantity_max": 205, + "all_products": true + }, + "pricing_rule_data": { + "name": "name9", + "time_period_ids": [ + "time_period_ids1" + ], + "discount_id": "discount_id7", + "match_products_id": "match_products_id3", + "apply_products_id": "apply_products_id7", + "exclude_products_id": "exclude_products_id5", + "valid_from_date": "valid_from_date3", + "valid_from_local_time": "valid_from_local_time1", + "valid_until_date": "valid_until_date5", + "valid_until_local_time": "valid_until_local_time5", + "exclude_strategy": "MOST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any8" + ] + }, + "image_data": { + "name": "name1", + "url": "url5", + "caption": "caption5", + "photo_studio_order_id": "photo_studio_order_id3" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name3", + "abbreviation": "abbreviation5" + }, + "area_unit": "IMPERIAL_SQUARE_YARD", + "length_unit": "METRIC_CENTIMETER", + "volume_unit": "GENERIC_SHOT", + "weight_unit": "METRIC_KILOGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_DAY", + "type": "TYPE_GENERIC" + }, + "precision": 183 + }, + "subscription_plan_data": { + "name": "name9", + "phases": [ + { + "uid": "uid6", + "cadence": "EVERY_SIX_MONTHS", + "periods": 204, + "recurring_price_money": {}, + "ordinal": 170 + }, + { + "uid": "uid5", + "cadence": "ANNUAL", + "periods": 203, + "recurring_price_money": {}, + "ordinal": 169 + }, + { + "uid": "uid4", + "cadence": "EVERY_TWO_YEARS", + "periods": 202, + "recurring_price_money": {}, + "ordinal": 168 + } + ] + }, + "item_option_data": { + "name": "name5", + "display_name": "display_name5", + "description": "description5", + "show_colors": true, + "values": [ + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id3", + "name": "name1", + "description": "description1", + "color": "color5", + "ordinal": 181 + }, + "custom_attribute_definition_data": { + "type": "SELECTION", + "name": "name9", + "description": "description9", + "source_application": { + "product": "EXTERNAL_API", + "application_id": "application_id7", + "name": "name1" + }, + "allowed_object_types": [ + "MODIFIER", + "MODIFIER_LIST" + ], + "seller_visibility": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "app_visibility": "APP_VISIBILITY_HIDDEN", + "string_config": { + "enforce_uniqueness": true + }, + "number_config": { + "precision": 225 + }, + "selection_config": { + "max_allowed_selections": 171, + "allowed_selections": [ + { + "uid": "uid8", + "name": "name8" + } + ] + }, + "custom_attribute_usage_count": 7, + "key": "key9" + }, + "quick_amounts_settings_data": { + "option": "DISABLED", + "eligible_for_auto_amounts": true, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 97, + "ordinal": 29 + }, + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 98, + "ordinal": 30 + }, + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 99, + "ordinal": 31 + } + ] + } + } + ], + "product_type": "REGULAR", + "skip_modifier_screen": false, + "item_options": [ + {} + ], + "image_ids": [ + "image_ids3", + "image_ids2", + "image_ids1" + ], + "sort_name": "sort_name0", + "description_html": "description_html8", + "description_plaintext": "description_plaintext8" + }, + "category_data": { + "name": "name4", + "image_ids": [ + "image_ids9", + "image_ids0" + ] + }, + "item_variation_data": { + "item_id": "item_id4", + "name": "name6", + "sku": "sku2", + "upc": "upc6", + "ordinal": 150, + "pricing_type": "FIXED_PRICING", + "price_money": {}, + "location_overrides": [ + {}, + {} + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 152, + "user_data": "user_data0", + "service_duration": 240, + "available_for_booking": false, + "item_option_values": [ + {} + ], + "measurement_unit_id": "measurement_unit_id4", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids9" + ], + "team_member_ids": [ + "team_member_ids3" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id4", + "stockable_quantity": "stockable_quantity6", + "nonstockable_quantity": "nonstockable_quantity8" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids5", + "item_variation_vendor_info_ids6", + "item_variation_vendor_info_ids7" + ] + }, + "tax_data": { + "name": "name4", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "percentage2", + "applies_to_custom_amounts": false, + "enabled": false + }, + "discount_data": { + "name": "name8", + "discount_type": "VARIABLE_PERCENTAGE", + "percentage": "percentage6", + "amount_money": {}, + "pin_required": false, + "label_color": "label_color0", + "modify_tax_basis": "MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name6", + "ordinal": 170, + "selection_type": "SINGLE", + "modifiers": [ + {}, + {} + ], + "image_ids": [ + "image_ids9", + "image_ids0", + "image_ids1" + ] + }, + "modifier_data": { + "name": "name8", + "price_money": {}, + "ordinal": 12, + "modifier_list_id": "modifier_list_id4", + "image_id": "image_id2" + }, + "time_period_data": { + "event": "event6" + }, + "product_set_data": { + "name": "name8", + "product_ids_any": [ + "product_ids_any6" + ], + "product_ids_all": [ + "product_ids_all1" + ], + "quantity_exact": 248, + "quantity_min": 126, + "quantity_max": 100, + "all_products": false + }, + "pricing_rule_data": { + "name": "name0", + "time_period_ids": [ + "time_period_ids2", + "time_period_ids3", + "time_period_ids4" + ], + "discount_id": "discount_id8", + "match_products_id": "match_products_id2", + "apply_products_id": "apply_products_id6", + "exclude_products_id": "exclude_products_id6", + "valid_from_date": "valid_from_date2", + "valid_from_local_time": "valid_from_local_time0", + "valid_until_date": "valid_until_date4", + "valid_until_local_time": "valid_until_local_time4", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any9", + "customer_group_ids_any0", + "customer_group_ids_any1" + ] + }, + "image_data": { + "name": "name0", + "url": "url4", + "caption": "caption4", + "photo_studio_order_id": "photo_studio_order_id2" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name4", + "abbreviation": "abbreviation6" + }, + "area_unit": "IMPERIAL_SQUARE_MILE", + "length_unit": "METRIC_MILLIMETER", + "volume_unit": "GENERIC_SHOT", + "weight_unit": "IMPERIAL_WEIGHT_OUNCE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MILLISECOND", + "type": "TYPE_CUSTOM" + }, + "precision": 32 + }, + "subscription_plan_data": { + "name": "name0", + "phases": [ + {}, + {}, + {} + ] + }, + "item_option_data": { + "name": "name4", + "display_name": "display_name4", + "description": "description6", + "show_colors": false, + "values": [ + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id2", + "name": "name0", + "description": "description0", + "color": "color4", + "ordinal": 76 + }, + "custom_attribute_definition_data": { + "type": "STRING", + "name": "name8", + "description": "description8", + "source_application": { + "product": "SQUARE_POS", + "application_id": "application_id6", + "name": "name0" + }, + "allowed_object_types": [ + "IMAGE", + "CATEGORY", + "ITEM_VARIATION" + ], + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_READ_ONLY", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 74 + }, + "selection_config": { + "max_allowed_selections": 66, + "allowed_selections": [ + {}, + {} + ] + }, + "custom_attribute_usage_count": 158, + "key": "key8" + }, + "quick_amounts_settings_data": { + "option": "MANUAL", + "eligible_for_auto_amounts": false, + "amounts": [ + {} + ] + } + }, + { + "type": "MODIFIER_LIST", + "id": "id1", + "updated_at": "updated_at7", + "version": 101, + "is_deleted": true, + "custom_attribute_values": { + "key0": { + "name": "name2", + "string_value": "string_value6", + "custom_attribute_definition_id": "custom_attribute_definition_id0", + "type": "NUMBER", + "number_value": "number_value2", + "boolean_value": false, + "selection_uid_values": [ + "selection_uid_values9", + "selection_uid_values0", + "selection_uid_values1" + ], + "key": "key2" + }, + "key1": { + "name": "name1", + "string_value": "string_value5", + "custom_attribute_definition_id": "custom_attribute_definition_id1", + "type": "SELECTION", + "number_value": "number_value1", + "boolean_value": true, + "selection_uid_values": [ + "selection_uid_values8", + "selection_uid_values9" + ], + "key": "key1" + } + }, + "catalog_v1_ids": [ + { + "catalog_v1_id": "catalog_v1_id5", + "location_id": "location_id5" + } + ], + "present_at_all_locations": true, + "present_at_location_ids": [ + "present_at_location_ids1", + "present_at_location_ids2", + "present_at_location_ids3" + ], + "absent_at_location_ids": [ + "absent_at_location_ids2" + ], + "item_data": { + "name": "name7", + "description": "description7", + "abbreviation": "abbreviation9", + "label_color": "label_color9", + "available_online": true, + "available_for_pickup": true, + "available_electronically": true, + "category_id": "category_id1", + "tax_ids": [ + "tax_ids0", + "tax_ids1" + ], + "modifier_list_info": [ + { + "modifier_list_id": "modifier_list_id7", + "modifier_overrides": [ + { + "modifier_id": "modifier_id0", + "on_by_default": false + }, + { + "modifier_id": "modifier_id1", + "on_by_default": true + }, + { + "modifier_id": "modifier_id2", + "on_by_default": false + } + ], + "min_selected_modifiers": 59, + "max_selected_modifiers": 39, + "enabled": true + } + ], + "variations": [ + { + "type": "SUBSCRIPTION_PLAN", + "id": "id0", + "updated_at": "updated_at4", + "version": 204, + "is_deleted": false, + "custom_attribute_values": { + "key0": {}, + "key1": {} + }, + "catalog_v1_ids": [ + {} + ], + "present_at_all_locations": false, + "present_at_location_ids": [ + "present_at_location_ids0", + "present_at_location_ids1", + "present_at_location_ids2" + ], + "absent_at_location_ids": [ + "absent_at_location_ids1" + ], + "item_data": { + "name": "name8", + "description": "description8", + "abbreviation": "abbreviation0", + "label_color": "label_color0", + "available_online": false, + "available_for_pickup": false, + "available_electronically": false, + "category_id": "category_id0", + "tax_ids": [ + "tax_ids1", + "tax_ids0" + ], + "modifier_list_info": [ + {} + ], + "variations": [ + {} + ], + "product_type": "APPOINTMENTS_SERVICE", + "skip_modifier_screen": false, + "item_options": [ + { + "item_option_id": "item_option_id3" + }, + { + "item_option_id": "item_option_id2" + }, + { + "item_option_id": "item_option_id1" + } + ], + "image_ids": [ + "image_ids7" + ], + "sort_name": "sort_name0", + "description_html": "description_html8", + "description_plaintext": "description_plaintext8" + }, + "category_data": { + "name": "name4", + "image_ids": [ + "image_ids9", + "image_ids0", + "image_ids1" + ] + }, + "item_variation_data": { + "item_id": "item_id4", + "name": "name6", + "sku": "sku8", + "upc": "upc6", + "ordinal": 254, + "pricing_type": "FIXED_PRICING", + "price_money": { + "amount": 28, + "currency": "SCR" + }, + "location_overrides": [ + { + "location_id": "location_id1", + "price_money": { + "amount": 73, + "currency": "SAR" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 193, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until5" + }, + { + "location_id": "location_id2", + "price_money": { + "amount": 74, + "currency": "SBD" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 194, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until6" + }, + { + "location_id": "location_id3", + "price_money": { + "amount": 75, + "currency": "SCR" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 195, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until7" + } + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 0, + "user_data": "user_data0", + "service_duration": 88, + "available_for_booking": false, + "item_option_values": [ + { + "item_option_id": "item_option_id5", + "item_option_value_id": "item_option_value_id7" + }, + { + "item_option_id": "item_option_id6", + "item_option_value_id": "item_option_value_id6" + }, + { + "item_option_id": "item_option_id7", + "item_option_value_id": "item_option_value_id5" + } + ], + "measurement_unit_id": "measurement_unit_id4", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids9", + "image_ids0", + "image_ids1" + ], + "team_member_ids": [ + "team_member_ids3", + "team_member_ids4" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id6", + "stockable_quantity": "stockable_quantity6", + "nonstockable_quantity": "nonstockable_quantity8" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids5" + ] + }, + "tax_data": { + "name": "name6", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "percentage4", + "applies_to_custom_amounts": false, + "enabled": false + }, + "discount_data": { + "name": "name2", + "discount_type": "VARIABLE_PERCENTAGE", + "percentage": "percentage0", + "amount_money": {}, + "pin_required": false, + "label_color": "label_color4", + "modify_tax_basis": "MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name6", + "ordinal": 66, + "selection_type": "SINGLE", + "modifiers": [ + {} + ], + "image_ids": [ + "image_ids9" + ] + }, + "modifier_data": { + "name": "name2", + "price_money": {}, + "ordinal": 44, + "modifier_list_id": "modifier_list_id8", + "image_id": "image_id6" + }, + "time_period_data": { + "event": "event6" + }, + "product_set_data": { + "name": "name8", + "product_ids_any": [ + "product_ids_any0", + "product_ids_any9", + "product_ids_any8" + ], + "product_ids_all": [ + "product_ids_all9", + "product_ids_all8", + "product_ids_all7" + ], + "quantity_exact": 96, + "quantity_min": 230, + "quantity_max": 204, + "all_products": false + }, + "pricing_rule_data": { + "name": "name0", + "time_period_ids": [ + "time_period_ids2", + "time_period_ids3" + ], + "discount_id": "discount_id8", + "match_products_id": "match_products_id2", + "apply_products_id": "apply_products_id6", + "exclude_products_id": "exclude_products_id6", + "valid_from_date": "valid_from_date2", + "valid_from_local_time": "valid_from_local_time0", + "valid_until_date": "valid_until_date4", + "valid_until_local_time": "valid_until_local_time4", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any9", + "customer_group_ids_any0" + ] + }, + "image_data": { + "name": "name0", + "url": "url4", + "caption": "caption4", + "photo_studio_order_id": "photo_studio_order_id2" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name4", + "abbreviation": "abbreviation6" + }, + "area_unit": "IMPERIAL_SQUARE_MILE", + "length_unit": "METRIC_MILLIMETER", + "volume_unit": "GENERIC_CUP", + "weight_unit": "METRIC_GRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MILLISECOND", + "type": "TYPE_WEIGHT" + }, + "precision": 184 + }, + "subscription_plan_data": { + "name": "name0", + "phases": [ + { + "uid": "uid5", + "cadence": "ANNUAL", + "periods": 203, + "recurring_price_money": {}, + "ordinal": 169 + } + ] + }, + "item_option_data": { + "name": "name6", + "display_name": "display_name6", + "description": "description4", + "show_colors": false, + "values": [ + {}, + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id2", + "name": "name0", + "description": "description0", + "color": "color4", + "ordinal": 180 + }, + "custom_attribute_definition_data": { + "type": "STRING", + "name": "name8", + "description": "description8", + "source_application": { + "product": "SQUARE_POS", + "application_id": "application_id6", + "name": "name0" + }, + "allowed_object_types": [ + "PRICING_RULE" + ], + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_READ_WRITE_VALUES", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 226 + }, + "selection_config": { + "max_allowed_selections": 170, + "allowed_selections": [ + { + "uid": "uid7", + "name": "name7" + }, + { + "uid": "uid8", + "name": "name8" + }, + { + "uid": "uid9", + "name": "name9" + } + ] + }, + "custom_attribute_usage_count": 6, + "key": "key8" + }, + "quick_amounts_settings_data": { + "option": "AUTO", + "eligible_for_auto_amounts": false, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 96, + "ordinal": 28 + }, + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 97, + "ordinal": 29 + } + ] + } + } + ], + "product_type": "APPOINTMENTS_SERVICE", + "skip_modifier_screen": true, + "item_options": [ + {}, + {} + ], + "image_ids": [ + "image_ids2" + ], + "sort_name": "sort_name1", + "description_html": "description_html7", + "description_plaintext": "description_plaintext7" + }, + "category_data": { + "name": "name5", + "image_ids": [ + "image_ids0", + "image_ids1", + "image_ids2" + ] + }, + "item_variation_data": { + "item_id": "item_id3", + "name": "name7", + "sku": "sku3", + "upc": "upc5", + "ordinal": 151, + "pricing_type": "VARIABLE_PRICING", + "price_money": {}, + "location_overrides": [ + {}, + {}, + {} + ], + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 153, + "user_data": "user_data9", + "service_duration": 241, + "available_for_booking": true, + "item_option_values": [ + {}, + {}, + {} + ], + "measurement_unit_id": "measurement_unit_id3", + "sellable": true, + "stockable": true, + "image_ids": [ + "image_ids8", + "image_ids7" + ], + "team_member_ids": [ + "team_member_ids4", + "team_member_ids5" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id5", + "stockable_quantity": "stockable_quantity7", + "nonstockable_quantity": "nonstockable_quantity9" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids6" + ] + }, + "tax_data": { + "name": "name5", + "calculation_phase": "TAX_TOTAL_PHASE", + "inclusion_type": "INCLUSIVE", + "percentage": "percentage3", + "applies_to_custom_amounts": true, + "enabled": true + }, + "discount_data": { + "name": "name9", + "discount_type": "VARIABLE_AMOUNT", + "percentage": "percentage7", + "amount_money": {}, + "pin_required": true, + "label_color": "label_color1", + "modify_tax_basis": "DO_NOT_MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name5", + "ordinal": 169, + "selection_type": "MULTIPLE", + "modifiers": [ + {} + ], + "image_ids": [ + "image_ids0" + ] + }, + "modifier_data": { + "name": "name9", + "price_money": {}, + "ordinal": 13, + "modifier_list_id": "modifier_list_id5", + "image_id": "image_id3" + }, + "time_period_data": { + "event": "event5" + }, + "product_set_data": { + "name": "name9", + "product_ids_any": [ + "product_ids_any5", + "product_ids_any4" + ], + "product_ids_all": [ + "product_ids_all2", + "product_ids_all3" + ], + "quantity_exact": 249, + "quantity_min": 127, + "quantity_max": 101, + "all_products": true + }, + "pricing_rule_data": { + "name": "name1", + "time_period_ids": [ + "time_period_ids3" + ], + "discount_id": "discount_id9", + "match_products_id": "match_products_id1", + "apply_products_id": "apply_products_id5", + "exclude_products_id": "exclude_products_id7", + "valid_from_date": "valid_from_date1", + "valid_from_local_time": "valid_from_local_time9", + "valid_until_date": "valid_until_date3", + "valid_until_local_time": "valid_until_local_time3", + "exclude_strategy": "MOST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any0" + ] + }, + "image_data": { + "name": "name1", + "url": "url5", + "caption": "caption5", + "photo_studio_order_id": "photo_studio_order_id3" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name3", + "abbreviation": "abbreviation5" + }, + "area_unit": "IMPERIAL_SQUARE_YARD", + "length_unit": "METRIC_CENTIMETER", + "volume_unit": "GENERIC_FLUID_OUNCE", + "weight_unit": "IMPERIAL_POUND", + "generic_unit": "UNIT", + "time_unit": "GENERIC_SECOND", + "type": "TYPE_AREA" + }, + "precision": 31 + }, + "subscription_plan_data": { + "name": "name9", + "phases": [ + {} + ] + }, + "item_option_data": { + "name": "name5", + "display_name": "display_name5", + "description": "description5", + "show_colors": true, + "values": [ + {}, + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id3", + "name": "name1", + "description": "description1", + "color": "color5", + "ordinal": 77 + }, + "custom_attribute_definition_data": { + "type": "BOOLEAN", + "name": "name9", + "description": "description9", + "source_application": { + "product": "EXTERNAL_API", + "application_id": "application_id7", + "name": "name1" + }, + "allowed_object_types": [ + "CATEGORY" + ], + "seller_visibility": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "app_visibility": "APP_VISIBILITY_READ_WRITE_VALUES", + "string_config": { + "enforce_uniqueness": true + }, + "number_config": { + "precision": 73 + }, + "selection_config": { + "max_allowed_selections": 67, + "allowed_selections": [ + {}, + {}, + {} + ] + }, + "custom_attribute_usage_count": 159, + "key": "key9" + }, + "quick_amounts_settings_data": { + "option": "AUTO", + "eligible_for_auto_amounts": true, + "amounts": [ + {}, + {} + ] + } + }, + { + "type": "DISCOUNT", + "id": "id2", + "updated_at": "updated_at8", + "version": 102, + "is_deleted": false, + "custom_attribute_values": { + "key0": { + "name": "name3", + "string_value": "string_value7", + "custom_attribute_definition_id": "custom_attribute_definition_id9", + "type": "BOOLEAN", + "number_value": "number_value3", + "boolean_value": true, + "selection_uid_values": [ + "selection_uid_values0" + ], + "key": "key3" + } + }, + "catalog_v1_ids": [ + { + "catalog_v1_id": "catalog_v1_id6", + "location_id": "location_id6" + }, + { + "catalog_v1_id": "catalog_v1_id7", + "location_id": "location_id7" + } + ], + "present_at_all_locations": false, + "present_at_location_ids": [ + "present_at_location_ids2" + ], + "absent_at_location_ids": [ + "absent_at_location_ids3", + "absent_at_location_ids4" + ], + "item_data": { + "name": "name6", + "description": "description6", + "abbreviation": "abbreviation8", + "label_color": "label_color8", + "available_online": false, + "available_for_pickup": false, + "available_electronically": false, + "category_id": "category_id2", + "tax_ids": [ + "tax_ids1", + "tax_ids2", + "tax_ids3" + ], + "modifier_list_info": [ + { + "modifier_list_id": "modifier_list_id6", + "modifier_overrides": [ + { + "modifier_id": "modifier_id9", + "on_by_default": true + }, + { + "modifier_id": "modifier_id0", + "on_by_default": false + } + ], + "min_selected_modifiers": 58, + "max_selected_modifiers": 38, + "enabled": false + }, + { + "modifier_list_id": "modifier_list_id7", + "modifier_overrides": [ + { + "modifier_id": "modifier_id0", + "on_by_default": false + }, + { + "modifier_id": "modifier_id1", + "on_by_default": true + }, + { + "modifier_id": "modifier_id2", + "on_by_default": false + } + ], + "min_selected_modifiers": 59, + "max_selected_modifiers": 39, + "enabled": true + }, + { + "modifier_list_id": "modifier_list_id8", + "modifier_overrides": [ + { + "modifier_id": "modifier_id1", + "on_by_default": true + } + ], + "min_selected_modifiers": 60, + "max_selected_modifiers": 40, + "enabled": false + } + ], + "variations": [ + { + "type": "QUICK_AMOUNTS_SETTINGS", + "id": "id1", + "updated_at": "updated_at3", + "version": 205, + "is_deleted": true, + "custom_attribute_values": { + "key0": {} + }, + "catalog_v1_ids": [ + {}, + {} + ], + "present_at_all_locations": true, + "present_at_location_ids": [ + "present_at_location_ids1" + ], + "absent_at_location_ids": [ + "absent_at_location_ids2", + "absent_at_location_ids3" + ], + "item_data": { + "name": "name7", + "description": "description7", + "abbreviation": "abbreviation9", + "label_color": "label_color9", + "available_online": true, + "available_for_pickup": true, + "available_electronically": true, + "category_id": "category_id1", + "tax_ids": [ + "tax_ids0", + "tax_ids9", + "tax_ids8" + ], + "modifier_list_info": [ + {}, + {}, + {} + ], + "variations": [ + {}, + {} + ], + "product_type": "GIFT_CARD", + "skip_modifier_screen": true, + "item_options": [ + { + "item_option_id": "item_option_id4" + }, + { + "item_option_id": "item_option_id3" + } + ], + "image_ids": [ + "image_ids8", + "image_ids7", + "image_ids6" + ], + "sort_name": "sort_name1", + "description_html": "description_html7", + "description_plaintext": "description_plaintext7" + }, + "category_data": { + "name": "name5", + "image_ids": [ + "image_ids0" + ] + }, + "item_variation_data": { + "item_id": "item_id3", + "name": "name7", + "sku": "sku7", + "upc": "upc5", + "ordinal": 255, + "pricing_type": "VARIABLE_PRICING", + "price_money": { + "amount": 27, + "currency": "SBD" + }, + "location_overrides": [ + { + "location_id": "location_id2", + "price_money": { + "amount": 74, + "currency": "SBD" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 194, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until6" + } + ], + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 255, + "user_data": "user_data9", + "service_duration": 89, + "available_for_booking": true, + "item_option_values": [ + { + "item_option_id": "item_option_id4", + "item_option_value_id": "item_option_value_id8" + }, + { + "item_option_id": "item_option_id5", + "item_option_value_id": "item_option_value_id7" + } + ], + "measurement_unit_id": "measurement_unit_id3", + "sellable": true, + "stockable": true, + "image_ids": [ + "image_ids8", + "image_ids9" + ], + "team_member_ids": [ + "team_member_ids4", + "team_member_ids5", + "team_member_ids6" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id5", + "stockable_quantity": "stockable_quantity7", + "nonstockable_quantity": "nonstockable_quantity9" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids6", + "item_variation_vendor_info_ids7" + ] + }, + "tax_data": { + "name": "name5", + "calculation_phase": "TAX_TOTAL_PHASE", + "inclusion_type": "INCLUSIVE", + "percentage": "percentage3", + "applies_to_custom_amounts": true, + "enabled": true + }, + "discount_data": { + "name": "name1", + "discount_type": "FIXED_AMOUNT", + "percentage": "percentage9", + "amount_money": {}, + "pin_required": true, + "label_color": "label_color3", + "modify_tax_basis": "DO_NOT_MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name5", + "ordinal": 65, + "selection_type": "MULTIPLE", + "modifiers": [ + {}, + {}, + {} + ], + "image_ids": [ + "image_ids0", + "image_ids9", + "image_ids8" + ] + }, + "modifier_data": { + "name": "name1", + "price_money": {}, + "ordinal": 43, + "modifier_list_id": "modifier_list_id7", + "image_id": "image_id5" + }, + "time_period_data": { + "event": "event5" + }, + "product_set_data": { + "name": "name9", + "product_ids_any": [ + "product_ids_any1", + "product_ids_any0" + ], + "product_ids_all": [ + "product_ids_all0", + "product_ids_all9" + ], + "quantity_exact": 97, + "quantity_min": 231, + "quantity_max": 205, + "all_products": true + }, + "pricing_rule_data": { + "name": "name9", + "time_period_ids": [ + "time_period_ids1" + ], + "discount_id": "discount_id7", + "match_products_id": "match_products_id3", + "apply_products_id": "apply_products_id7", + "exclude_products_id": "exclude_products_id5", + "valid_from_date": "valid_from_date3", + "valid_from_local_time": "valid_from_local_time1", + "valid_until_date": "valid_until_date5", + "valid_until_local_time": "valid_until_local_time5", + "exclude_strategy": "MOST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any8" + ] + }, + "image_data": { + "name": "name1", + "url": "url5", + "caption": "caption5", + "photo_studio_order_id": "photo_studio_order_id3" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name3", + "abbreviation": "abbreviation5" + }, + "area_unit": "IMPERIAL_SQUARE_YARD", + "length_unit": "METRIC_CENTIMETER", + "volume_unit": "GENERIC_SHOT", + "weight_unit": "METRIC_KILOGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_DAY", + "type": "TYPE_GENERIC" + }, + "precision": 183 + }, + "subscription_plan_data": { + "name": "name9", + "phases": [ + { + "uid": "uid6", + "cadence": "EVERY_SIX_MONTHS", + "periods": 204, + "recurring_price_money": {}, + "ordinal": 170 + }, + { + "uid": "uid5", + "cadence": "ANNUAL", + "periods": 203, + "recurring_price_money": {}, + "ordinal": 169 + }, + { + "uid": "uid4", + "cadence": "EVERY_TWO_YEARS", + "periods": 202, + "recurring_price_money": {}, + "ordinal": 168 + } + ] + }, + "item_option_data": { + "name": "name5", + "display_name": "display_name5", + "description": "description5", + "show_colors": true, + "values": [ + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id3", + "name": "name1", + "description": "description1", + "color": "color5", + "ordinal": 181 + }, + "custom_attribute_definition_data": { + "type": "SELECTION", + "name": "name9", + "description": "description9", + "source_application": { + "product": "EXTERNAL_API", + "application_id": "application_id7", + "name": "name1" + }, + "allowed_object_types": [ + "MODIFIER", + "MODIFIER_LIST" + ], + "seller_visibility": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "app_visibility": "APP_VISIBILITY_HIDDEN", + "string_config": { + "enforce_uniqueness": true + }, + "number_config": { + "precision": 225 + }, + "selection_config": { + "max_allowed_selections": 171, + "allowed_selections": [ + { + "uid": "uid8", + "name": "name8" + } + ] + }, + "custom_attribute_usage_count": 7, + "key": "key9" + }, + "quick_amounts_settings_data": { + "option": "DISABLED", + "eligible_for_auto_amounts": true, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 97, + "ordinal": 29 + }, + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 98, + "ordinal": 30 + }, + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 99, + "ordinal": 31 + } + ] + } + }, + { + "type": "CUSTOM_ATTRIBUTE_DEFINITION", + "id": "id2", + "updated_at": "updated_at2", + "version": 206, + "is_deleted": false, + "custom_attribute_values": { + "key0": {}, + "key1": {}, + "key2": {} + }, + "catalog_v1_ids": [ + {}, + {}, + {} + ], + "present_at_all_locations": false, + "present_at_location_ids": [ + "present_at_location_ids2", + "present_at_location_ids3" + ], + "absent_at_location_ids": [ + "absent_at_location_ids3", + "absent_at_location_ids4", + "absent_at_location_ids5" + ], + "item_data": { + "name": "name6", + "description": "description6", + "abbreviation": "abbreviation8", + "label_color": "label_color8", + "available_online": false, + "available_for_pickup": false, + "available_electronically": false, + "category_id": "category_id2", + "tax_ids": [ + "tax_ids9" + ], + "modifier_list_info": [ + {}, + {} + ], + "variations": [ + {}, + {}, + {} + ], + "product_type": "REGULAR", + "skip_modifier_screen": false, + "item_options": [ + { + "item_option_id": "item_option_id5" + } + ], + "image_ids": [ + "image_ids9", + "image_ids8" + ], + "sort_name": "sort_name2", + "description_html": "description_html6", + "description_plaintext": "description_plaintext6" + }, + "category_data": { + "name": "name6", + "image_ids": [ + "image_ids1", + "image_ids2" + ] + }, + "item_variation_data": { + "item_id": "item_id2", + "name": "name8", + "sku": "sku6", + "upc": "upc4", + "ordinal": 0, + "pricing_type": "FIXED_PRICING", + "price_money": { + "amount": 26, + "currency": "SAR" + }, + "location_overrides": [ + { + "location_id": "location_id3", + "price_money": { + "amount": 75, + "currency": "SCR" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 195, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until7" + }, + { + "location_id": "location_id4", + "price_money": { + "amount": 76, + "currency": "SDG" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 196, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until8" + } + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 254, + "user_data": "user_data8", + "service_duration": 90, + "available_for_booking": false, + "item_option_values": [ + { + "item_option_id": "item_option_id3", + "item_option_value_id": "item_option_value_id9" + } + ], + "measurement_unit_id": "measurement_unit_id2", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids7" + ], + "team_member_ids": [ + "team_member_ids5" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id4", + "stockable_quantity": "stockable_quantity8", + "nonstockable_quantity": "nonstockable_quantity0" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids7", + "item_variation_vendor_info_ids8", + "item_variation_vendor_info_ids9" + ] + }, + "tax_data": { + "name": "name4", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "percentage2", + "applies_to_custom_amounts": false, + "enabled": false + }, + "discount_data": { + "name": "name0", + "discount_type": "FIXED_PERCENTAGE", + "percentage": "percentage8", + "amount_money": {}, + "pin_required": false, + "label_color": "label_color2", + "modify_tax_basis": "MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name4", + "ordinal": 64, + "selection_type": "SINGLE", + "modifiers": [ + {}, + {} + ], + "image_ids": [ + "image_ids1", + "image_ids0" + ] + }, + "modifier_data": { + "name": "name0", + "price_money": {}, + "ordinal": 42, + "modifier_list_id": "modifier_list_id6", + "image_id": "image_id4" + }, + "time_period_data": { + "event": "event4" + }, + "product_set_data": { + "name": "name0", + "product_ids_any": [ + "product_ids_any2" + ], + "product_ids_all": [ + "product_ids_all1" + ], + "quantity_exact": 98, + "quantity_min": 232, + "quantity_max": 206, + "all_products": false + }, + "pricing_rule_data": { + "name": "name8", + "time_period_ids": [ + "time_period_ids0", + "time_period_ids1", + "time_period_ids2" + ], + "discount_id": "discount_id6", + "match_products_id": "match_products_id4", + "apply_products_id": "apply_products_id8", + "exclude_products_id": "exclude_products_id4", + "valid_from_date": "valid_from_date4", + "valid_from_local_time": "valid_from_local_time2", + "valid_until_date": "valid_until_date6", + "valid_until_local_time": "valid_until_local_time6", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any7", + "customer_group_ids_any8", + "customer_group_ids_any9" + ] + }, + "image_data": { + "name": "name2", + "url": "url6", + "caption": "caption6", + "photo_studio_order_id": "photo_studio_order_id4" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name2", + "abbreviation": "abbreviation4" + }, + "area_unit": "IMPERIAL_SQUARE_FOOT", + "length_unit": "METRIC_METER", + "volume_unit": "GENERIC_FLUID_OUNCE", + "weight_unit": "IMPERIAL_WEIGHT_OUNCE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_HOUR", + "type": "TYPE_CUSTOM" + }, + "precision": 182 + }, + "subscription_plan_data": { + "name": "name8", + "phases": [ + { + "uid": "uid7", + "cadence": "EVERY_FOUR_MONTHS", + "periods": 205, + "recurring_price_money": {}, + "ordinal": 171 + }, + { + "uid": "uid6", + "cadence": "EVERY_SIX_MONTHS", + "periods": 204, + "recurring_price_money": {}, + "ordinal": 170 + } + ] + }, + "item_option_data": { + "name": "name4", + "display_name": "display_name4", + "description": "description6", + "show_colors": false, + "values": [ + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id4", + "name": "name2", + "description": "description2", + "color": "color6", + "ordinal": 182 + }, + "custom_attribute_definition_data": { + "type": "NUMBER", + "name": "name0", + "description": "description0", + "source_application": { + "product": "BILLING", + "application_id": "application_id8", + "name": "name2" + }, + "allowed_object_types": [ + "MODIFIER_LIST", + "DISCOUNT", + "TAX" + ], + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_READ_ONLY", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 224 + }, + "selection_config": { + "max_allowed_selections": 172, + "allowed_selections": [ + { + "uid": "uid9", + "name": "name9" + }, + { + "uid": "uid0", + "name": "name0" + } + ] + }, + "custom_attribute_usage_count": 8, + "key": "key0" + }, + "quick_amounts_settings_data": { + "option": "MANUAL", + "eligible_for_auto_amounts": false, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 98, + "ordinal": 30 + } + ] + } + } + ], + "product_type": "GIFT_CARD", + "skip_modifier_screen": false, + "item_options": [ + {}, + {}, + {} + ], + "image_ids": [ + "image_ids1", + "image_ids0" + ], + "sort_name": "sort_name2", + "description_html": "description_html6", + "description_plaintext": "description_plaintext6" + }, + "category_data": { + "name": "name6", + "image_ids": [ + "image_ids1" + ] + }, + "item_variation_data": { + "item_id": "item_id2", + "name": "name8", + "sku": "sku4", + "upc": "upc4", + "ordinal": 152, + "pricing_type": "FIXED_PRICING", + "price_money": {}, + "location_overrides": [ + {} + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 154, + "user_data": "user_data8", + "service_duration": 242, + "available_for_booking": false, + "item_option_values": [ + {}, + {} + ], + "measurement_unit_id": "measurement_unit_id2", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids7", + "image_ids6", + "image_ids5" + ], + "team_member_ids": [ + "team_member_ids5", + "team_member_ids6", + "team_member_ids7" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id6", + "stockable_quantity": "stockable_quantity8", + "nonstockable_quantity": "nonstockable_quantity0" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids7", + "item_variation_vendor_info_ids8" + ] + }, + "tax_data": { + "name": "name6", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "percentage4", + "applies_to_custom_amounts": false, + "enabled": false + }, + "discount_data": { + "name": "name0", + "discount_type": "FIXED_PERCENTAGE", + "percentage": "percentage8", + "amount_money": {}, + "pin_required": false, + "label_color": "label_color2", + "modify_tax_basis": "MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name4", + "ordinal": 168, + "selection_type": "SINGLE", + "modifiers": [ + {}, + {}, + {} + ], + "image_ids": [ + "image_ids1", + "image_ids2" + ] + }, + "modifier_data": { + "name": "name0", + "price_money": {}, + "ordinal": 14, + "modifier_list_id": "modifier_list_id6", + "image_id": "image_id4" + }, + "time_period_data": { + "event": "event4" + }, + "product_set_data": { + "name": "name0", + "product_ids_any": [ + "product_ids_any4", + "product_ids_any3", + "product_ids_any2" + ], + "product_ids_all": [ + "product_ids_all3", + "product_ids_all4", + "product_ids_all5" + ], + "quantity_exact": 250, + "quantity_min": 128, + "quantity_max": 102, + "all_products": false + }, + "pricing_rule_data": { + "name": "name2", + "time_period_ids": [ + "time_period_ids4", + "time_period_ids5" + ], + "discount_id": "discount_id0", + "match_products_id": "match_products_id0", + "apply_products_id": "apply_products_id4", + "exclude_products_id": "exclude_products_id8", + "valid_from_date": "valid_from_date0", + "valid_from_local_time": "valid_from_local_time8", + "valid_until_date": "valid_until_date2", + "valid_until_local_time": "valid_until_local_time2", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any1", + "customer_group_ids_any2" + ] + }, + "image_data": { + "name": "name2", + "url": "url6", + "caption": "caption6", + "photo_studio_order_id": "photo_studio_order_id4" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name2", + "abbreviation": "abbreviation4" + }, + "area_unit": "IMPERIAL_SQUARE_FOOT", + "length_unit": "METRIC_METER", + "volume_unit": "METRIC_LITER", + "weight_unit": "IMPERIAL_STONE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MINUTE", + "type": "TYPE_LENGTH" + }, + "precision": 30 + }, + "subscription_plan_data": { + "name": "name8", + "phases": [ + {}, + {} + ] + }, + "item_option_data": { + "name": "name6", + "display_name": "display_name6", + "description": "description4", + "show_colors": false, + "values": [ + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id4", + "name": "name2", + "description": "description2", + "color": "color6", + "ordinal": 78 + }, + "custom_attribute_definition_data": { + "type": "NUMBER", + "name": "name0", + "description": "description0", + "source_application": { + "product": "BILLING", + "application_id": "application_id8", + "name": "name2" + }, + "allowed_object_types": [ + "ITEM_VARIATION", + "TAX" + ], + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_HIDDEN", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 72 + }, + "selection_config": { + "max_allowed_selections": 68, + "allowed_selections": [ + {} + ] + }, + "custom_attribute_usage_count": 160, + "key": "key0" + }, + "quick_amounts_settings_data": { + "option": "DISABLED", + "eligible_for_auto_amounts": false, + "amounts": [ + {}, + {}, + {} + ] + } + } + ] } ``` diff --git a/doc/models/catalog-item-variation.md b/doc/models/catalog-item-variation.md index 2545717a..5f400502 100644 --- a/doc/models/catalog-item-variation.md +++ b/doc/models/catalog-item-variation.md @@ -41,32 +41,103 @@ decreases by 2, and the stockable count automatically decreases by 0.4 bottle ac | `imageIds` | `string[] \| undefined` | Optional | The IDs of images associated with this `CatalogItemVariation` instance.
These images will be shown to customers in Square Online Store. | | `teamMemberIds` | `string[] \| undefined` | Optional | Tokens of employees that can perform the service represented by this variation. Only valid for
variations of type `APPOINTMENTS_SERVICE`. | | `stockableConversion` | [`CatalogStockConversion \| undefined`](../../doc/models/catalog-stock-conversion.md) | Optional | 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. | +| `itemVariationVendorInfoIds` | `string[] \| undefined` | Optional | A list of ids of [CatalogItemVariationVendorInfo](entity:CatalogItemVariationVendorInfo) objects that
reference this ItemVariation. (Deprecated in favor of item_variation_vendor_infos) | ## Example (as JSON) ```json { - "item_id": null, - "name": null, - "sku": null, - "upc": null, - "ordinal": null, - "pricing_type": null, - "price_money": null, - "location_overrides": null, - "track_inventory": null, - "inventory_alert_type": null, - "inventory_alert_threshold": null, - "user_data": null, - "service_duration": null, - "available_for_booking": null, - "item_option_values": null, - "measurement_unit_id": null, - "sellable": null, - "stockable": null, - "image_ids": null, - "team_member_ids": null, - "stockable_conversion": null + "item_id": "item_id0", + "name": "name0", + "sku": "sku4", + "upc": "upc2", + "ordinal": 80, + "pricing_type": "FIXED_PRICING", + "price_money": { + "amount": 202, + "currency": "BBD" + }, + "location_overrides": [ + { + "location_id": "location_id5", + "price_money": { + "amount": 155, + "currency": "GYD" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 19, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until9" + }, + { + "location_id": "location_id6", + "price_money": { + "amount": 156, + "currency": "HKD" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 20, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until0" + }, + { + "location_id": "location_id7", + "price_money": { + "amount": 157, + "currency": "HNL" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 21, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until1" + } + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 174, + "user_data": "user_data6", + "service_duration": 86, + "available_for_booking": false, + "item_option_values": [ + { + "item_option_id": "item_option_id1", + "item_option_value_id": "item_option_value_id1" + }, + { + "item_option_id": "item_option_id2", + "item_option_value_id": "item_option_value_id0" + }, + { + "item_option_id": "item_option_id3", + "item_option_value_id": "item_option_value_id9" + } + ], + "measurement_unit_id": "measurement_unit_id0", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids5", + "image_ids6", + "image_ids7" + ], + "team_member_ids": [ + "team_member_ids7", + "team_member_ids8" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id2", + "stockable_quantity": "stockable_quantity0", + "nonstockable_quantity": "nonstockable_quantity2" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids9" + ] } ``` diff --git a/doc/models/catalog-item.md b/doc/models/catalog-item.md index c0d35e7c..d01061b7 100644 --- a/doc/models/catalog-item.md +++ b/doc/models/catalog-item.md @@ -12,7 +12,7 @@ A [CatalogObject](../../doc/models/catalog-object.md) instance of the `ITEM` typ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `name` | `string \| undefined` | Optional | The item's name. This is a searchable attribute for use in applicable query filters, its value must not be empty, and the length is of Unicode code points.
**Constraints**: *Maximum Length*: `512` | -| `description` | `string \| undefined` | Optional | The item's description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.

Deprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description
of the [CatalogItem](../../doc/models/catalog-item.md) instance. The `description` and `description_html` field values are kept in sync. If you try to
set the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other,
except for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null
does not nullify `description_html`.
**Constraints**: *Maximum Length*: `4096` | +| `description` | `string \| undefined` | Optional | The item's description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.

Deprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description
of the [CatalogItem](entity:CatalogItem) instance. The `description` and `description_html` field values are kept in sync. If you try to
set the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other,
except for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null
does not nullify `description_html`.
**Constraints**: *Maximum Length*: `4096` | | `abbreviation` | `string \| undefined` | Optional | The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used.
This attribute is searchable, and its value length is of Unicode code points.
**Constraints**: *Maximum Length*: `24` | | `labelColor` | `string \| undefined` | Optional | The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code. | | `availableOnline` | `boolean \| undefined` | Optional | If `true`, the item can be added to shipping orders from the merchant's online store. | @@ -21,12 +21,12 @@ A [CatalogObject](../../doc/models/catalog-object.md) instance of the `ITEM` typ | `categoryId` | `string \| undefined` | Optional | The ID of the item's category, if any. | | `taxIds` | `string[] \| undefined` | Optional | A set of IDs indicating the taxes enabled for
this item. When updating an item, any taxes listed here will be added to the item.
Taxes may also be added to or deleted from an item using `UpdateItemTaxes`. | | `modifierListInfo` | [`CatalogItemModifierListInfo[] \| undefined`](../../doc/models/catalog-item-modifier-list-info.md) | Optional | A set of `CatalogItemModifierListInfo` objects
representing the modifier lists that apply to this item, along with the overrides and min
and max limits that are specific to this item. Modifier lists
may also be added to or deleted from an item using `UpdateItemModifierLists`. | -| `variations` | [`CatalogObject[] \| undefined`](../../doc/models/catalog-object.md) | Optional | A list of [CatalogItemVariation](../../doc/models/catalog-item-variation.md) objects for this item. An item must have
at least one variation. | +| `variations` | [`CatalogObject[] \| undefined`](../../doc/models/catalog-object.md) | Optional | A list of [CatalogItemVariation](entity:CatalogItemVariation) objects for this item. An item must have
at least one variation. | | `productType` | [`string \| undefined`](../../doc/models/catalog-item-product-type.md) | Optional | The type of a CatalogItem. Connect V2 only allows the creation of `REGULAR` or `APPOINTMENTS_SERVICE` items. | | `skipModifierScreen` | `boolean \| undefined` | Optional | If `false`, the Square Point of Sale app will present the `CatalogItem`'s
details screen immediately, allowing the merchant to choose `CatalogModifier`s
before adding the item to the cart. This is the default behavior.

If `true`, the Square Point of Sale app will immediately add the item to the cart with the pre-selected
modifiers, and merchants can edit modifiers by drilling down onto the item's details.

Third-party clients are encouraged to implement similar behaviors. | | `itemOptions` | [`CatalogItemOptionForItem[] \| undefined`](../../doc/models/catalog-item-option-for-item.md) | Optional | List of item options IDs for this item. Used to manage and group item
variations in a specified order.

Maximum: 6 item options. | | `imageIds` | `string[] \| undefined` | Optional | The IDs of images associated with this `CatalogItem` instance.
These images will be shown to customers in Square Online Store.
The first image will show up as the icon for this item in POS. | -| `sortName` | `string \| undefined` | Optional | A name to sort the item by. If this name is unspecified, namely, the `sort_name` field is absent, the regular `name` field is used for sorting.

It is currently supported for sellers of the Japanese locale only. | +| `sortName` | `string \| undefined` | Optional | A name to sort the item by. If this name is unspecified, namely, the `sort_name` field is absent, the regular `name` field is used for sorting.
Its value must not be empty.

It is currently supported for sellers of the Japanese locale only. | | `descriptionHtml` | `string \| undefined` | Optional | The item's description as expressed in valid HTML elements. The length of this field value, including those of HTML tags,
is of Unicode points. With application query filters, the text values of the HTML elements and attributes are searchable. Invalid or
unsupported HTML elements or attributes are ignored.

Supported HTML elements include:

- `a`: Link. Supports linking to website URLs, email address, and telephone numbers.
- `b`, `strong`: Bold text
- `br`: Line break
- `code`: Computer code
- `div`: Section
- `h1-h6`: Headings
- `i`, `em`: Italics
- `li`: List element
- `ol`: Numbered list
- `p`: Paragraph
- `ul`: Bullet list
- `u`: Underline

Supported HTML attributes include:

- `align`: Alignment of the text content
- `href`: Link destination
- `rel`: Relationship between link's target and source
- `target`: Place to open the linked document
**Constraints**: *Maximum Length*: `65535` | | `descriptionPlaintext` | `string \| undefined` | Optional | A server-generated plaintext version of the `description_html` field, without formatting tags.
**Constraints**: *Maximum Length*: `65535` | diff --git a/doc/models/catalog-measurement-unit.md b/doc/models/catalog-measurement-unit.md index 4f73ad6c..ceb06b0b 100644 --- a/doc/models/catalog-measurement-unit.md +++ b/doc/models/catalog-measurement-unit.md @@ -19,8 +19,20 @@ specifies the precision for decimal quantities. ```json { - "measurement_unit": null, - "precision": null + "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", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MINUTE", + "type": "TYPE_CUSTOM" + }, + "precision": 196 } ``` diff --git a/doc/models/catalog-modifier-override.md b/doc/models/catalog-modifier-override.md index 22ae5273..d67a29eb 100644 --- a/doc/models/catalog-modifier-override.md +++ b/doc/models/catalog-modifier-override.md @@ -19,7 +19,7 @@ Options to control how to override the default behavior of the specified modifie ```json { "modifier_id": "modifier_id2", - "on_by_default": null + "on_by_default": false } ``` diff --git a/doc/models/catalog-object-batch.md b/doc/models/catalog-object-batch.md index f7e0f5a8..19ff1031 100644 --- a/doc/models/catalog-object-batch.md +++ b/doc/models/catalog-object-batch.md @@ -17,66 +17,120 @@ A batch of catalog objects. ```json { - "objects": [ - { - "type": "CUSTOM_ATTRIBUTE_DEFINITION", - "id": "id8", - "updated_at": null, - "version": null, - "is_deleted": null, - "custom_attribute_values": null, - "catalog_v1_ids": null, - "present_at_all_locations": null, - "present_at_location_ids": null, - "absent_at_location_ids": null, - "item_data": null, - "category_data": null, - "item_variation_data": null, - "tax_data": null, - "discount_data": null, - "modifier_list_data": null, - "modifier_data": null, - "time_period_data": null, - "product_set_data": null, - "pricing_rule_data": null, - "image_data": null, - "measurement_unit_data": null, - "subscription_plan_data": null, - "item_option_data": null, - "item_option_value_data": null, - "custom_attribute_definition_data": null, - "quick_amounts_settings_data": null + "objects": { + "type": null, + "id": null, + "item_data": { + "object": { + "id": "#Cocoa", + "item_data": { + "abbreviation": "Ch", + "description": "Hot chocolate", + "name": "Cocoa", + "visibility": "PRIVATE" + }, + "present_at_all_locations": true, + "type": "ITEM" + } }, - { - "type": "ITEM_OPTION_VAL", - "id": "id9", - "updated_at": null, - "version": null, - "is_deleted": null, - "custom_attribute_values": null, - "catalog_v1_ids": null, - "present_at_all_locations": null, - "present_at_location_ids": null, - "absent_at_location_ids": null, - "item_data": null, - "category_data": null, - "item_variation_data": null, - "tax_data": null, - "discount_data": null, - "modifier_list_data": null, - "modifier_data": null, - "time_period_data": null, - "product_set_data": null, - "pricing_rule_data": null, - "image_data": null, - "measurement_unit_data": null, - "subscription_plan_data": null, - "item_option_data": null, - "item_option_value_data": null, - "custom_attribute_definition_data": null, - "quick_amounts_settings_data": null + "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_list_data": { + "id": "#MilkType", + "modifier_list_data": { + "allow_quantities": false, + "modifiers": [ + { + "modifier_data": { + "name": "Whole Milk", + "price_money": { + "amount": 0, + "currency": "USD" + } + }, + "present_at_all_locations": true, + "type": "MODIFIER" + }, + { + "modifier_data": { + "name": "Almond Milk", + "price_money": { + "amount": 250, + "currency": "USD" + } + }, + "present_at_all_locations": true, + "type": "MODIFIER" + }, + { + "modifier_data": { + "name": "Soy Milk", + "price_money": { + "amount": 250, + "currency": "USD" + } + }, + "present_at_all_locations": true, + "type": "MODIFIER" + } + ], + "name": "Milk Type", + "selection_type": "SINGLE" + }, + "present_at_all_locations": true, + "type": "MODIFIER_LIST" + }, + "modifier_data": { + "object": { + "modifier_data": { + "name": "Almond Milk", + "price_money": { + "amount": 250, + "currency": "USD" + } + }, + "present_at_all_locations": true, + "type": "MODIFIER" + } } - ] + } } ``` diff --git a/doc/models/catalog-object-reference.md b/doc/models/catalog-object-reference.md index 6420e61a..9eedc1dd 100644 --- a/doc/models/catalog-object-reference.md +++ b/doc/models/catalog-object-reference.md @@ -20,8 +20,8 @@ at a specific version. ```json { - "object_id": null, - "catalog_version": null + "object_id": "object_id8", + "catalog_version": 126 } ``` diff --git a/doc/models/catalog-object.md b/doc/models/catalog-object.md index 16705d63..06e6cc01 100644 --- a/doc/models/catalog-object.md +++ b/doc/models/catalog-object.md @@ -25,7 +25,7 @@ For a more detailed discussion of the Catalog data model, please see the | `updatedAt` | `string \| undefined` | Optional | Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `"2016-08-15T23:59:33.123Z"`
would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds. | | `version` | `bigint \| undefined` | 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. | | `isDeleted` | `boolean \| undefined` | Optional | If `true`, the object has been deleted from the database. Must be `false` for new objects
being inserted. When deleted, the `updated_at` field will equal the deletion time. | -| `customAttributeValues` | [`Record \| undefined`](../../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](../../doc/models/catalog-custom-attribute-value.md) object. The key is the `key` attribute
value defined in the associated [CatalogCustomAttributeDefinition](../../doc/models/catalog-custom-attribute-definition.md)
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.). | +| `customAttributeValues` | [`Record \| undefined`](../../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.). | | `catalogV1Ids` | [`CatalogV1Id[] \| undefined`](../../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. | | `presentAtAllLocations` | `boolean \| undefined` | 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`. | | `presentAtLocationIds` | `string[] \| undefined` | 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. | @@ -52,33 +52,118 @@ For a more detailed discussion of the Catalog data model, please see the ```json { - "type": "ITEM_VARIATION", - "id": "id0", - "updated_at": null, - "version": null, - "is_deleted": null, - "custom_attribute_values": null, - "catalog_v1_ids": null, - "present_at_all_locations": null, - "present_at_location_ids": null, - "absent_at_location_ids": null, - "item_data": null, - "category_data": null, - "item_variation_data": null, - "tax_data": null, - "discount_data": null, - "modifier_list_data": null, - "modifier_data": null, - "time_period_data": null, - "product_set_data": null, - "pricing_rule_data": null, - "image_data": null, - "measurement_unit_data": null, - "subscription_plan_data": null, - "item_option_data": null, - "item_option_value_data": null, - "custom_attribute_definition_data": null, - "quick_amounts_settings_data": null + "type": null, + "id": null, + "item_data": { + "object": { + "id": "#Cocoa", + "item_data": { + "abbreviation": "Ch", + "description": "Hot chocolate", + "name": "Cocoa", + "visibility": "PRIVATE" + }, + "present_at_all_locations": true, + "type": "ITEM" + } + }, + "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_list_data": { + "id": "#MilkType", + "modifier_list_data": { + "allow_quantities": false, + "modifiers": [ + { + "modifier_data": { + "name": "Whole Milk", + "price_money": { + "amount": 0, + "currency": "USD" + } + }, + "present_at_all_locations": true, + "type": "MODIFIER" + }, + { + "modifier_data": { + "name": "Almond Milk", + "price_money": { + "amount": 250, + "currency": "USD" + } + }, + "present_at_all_locations": true, + "type": "MODIFIER" + }, + { + "modifier_data": { + "name": "Soy Milk", + "price_money": { + "amount": 250, + "currency": "USD" + } + }, + "present_at_all_locations": true, + "type": "MODIFIER" + } + ], + "name": "Milk Type", + "selection_type": "SINGLE" + }, + "present_at_all_locations": true, + "type": "MODIFIER_LIST" + }, + "modifier_data": { + "object": { + "modifier_data": { + "name": "Almond Milk", + "price_money": { + "amount": 250, + "currency": "USD" + } + }, + "present_at_all_locations": true, + "type": "MODIFIER" + } + } } ``` diff --git a/doc/models/catalog-pricing-rule.md b/doc/models/catalog-pricing-rule.md index 498fd49f..a4510090 100644 --- a/doc/models/catalog-pricing-rule.md +++ b/doc/models/catalog-pricing-rule.md @@ -30,19 +30,30 @@ during the active time period. ```json { - "name": null, - "time_period_ids": null, - "discount_id": null, - "match_products_id": null, - "apply_products_id": null, - "exclude_products_id": null, - "valid_from_date": null, - "valid_from_local_time": null, - "valid_until_date": null, - "valid_until_local_time": null, - "exclude_strategy": null, - "minimum_order_subtotal_money": null, - "customer_group_ids_any": null + "name": "name0", + "time_period_ids": [ + "time_period_ids2", + "time_period_ids3", + "time_period_ids4" + ], + "discount_id": "discount_id8", + "match_products_id": "match_products_id2", + "apply_products_id": "apply_products_id6", + "exclude_products_id": "exclude_products_id6", + "valid_from_date": "valid_from_date2", + "valid_from_local_time": "valid_from_local_time0", + "valid_until_date": "valid_until_date4", + "valid_until_local_time": "valid_until_local_time4", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": { + "amount": 248, + "currency": "BIF" + }, + "customer_group_ids_any": [ + "customer_group_ids_any9", + "customer_group_ids_any0", + "customer_group_ids_any1" + ] } ``` diff --git a/doc/models/catalog-product-set.md b/doc/models/catalog-product-set.md index c2e59a62..9d0ff158 100644 --- a/doc/models/catalog-product-set.md +++ b/doc/models/catalog-product-set.md @@ -27,13 +27,19 @@ a product set will also include its item variations. ```json { - "name": null, - "product_ids_any": null, - "product_ids_all": null, - "quantity_exact": null, - "quantity_min": null, - "quantity_max": null, - "all_products": null + "name": "name0", + "product_ids_any": [ + "product_ids_any8", + "product_ids_any9" + ], + "product_ids_all": [ + "product_ids_all9", + "product_ids_all0" + ], + "quantity_exact": 90, + "quantity_min": 44, + "quantity_max": 238, + "all_products": false } ``` 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 index 549cd5cd..c610794b 100644 --- a/doc/models/catalog-query-item-variations-for-item-option-values.md +++ b/doc/models/catalog-query-item-variations-for-item-option-values.md @@ -17,7 +17,10 @@ The query filter to return the item variations containing the specified item opt ```json { - "item_option_value_ids": null + "item_option_value_ids": [ + "item_option_value_ids0", + "item_option_value_ids1" + ] } ``` diff --git a/doc/models/catalog-query-items-for-item-options.md b/doc/models/catalog-query-items-for-item-options.md index 399c7159..ac51c247 100644 --- a/doc/models/catalog-query-items-for-item-options.md +++ b/doc/models/catalog-query-items-for-item-options.md @@ -17,7 +17,9 @@ The query filter to return the items containing the specified item option IDs. ```json { - "item_option_ids": null + "item_option_ids": [ + "item_option_ids9" + ] } ``` diff --git a/doc/models/catalog-query-range.md b/doc/models/catalog-query-range.md index 43438f7e..8d52119a 100644 --- a/doc/models/catalog-query-range.md +++ b/doc/models/catalog-query-range.md @@ -20,8 +20,8 @@ The query filter to return the search result whose named attribute values fall b ```json { "attribute_name": "attribute_name4", - "attribute_min_value": null, - "attribute_max_value": null + "attribute_min_value": 232, + "attribute_max_value": 114 } ``` diff --git a/doc/models/catalog-query-sorted-attribute.md b/doc/models/catalog-query-sorted-attribute.md index 232b62bc..ec2f5d4a 100644 --- a/doc/models/catalog-query-sorted-attribute.md +++ b/doc/models/catalog-query-sorted-attribute.md @@ -20,8 +20,8 @@ The query expression to specify the key to sort search results. ```json { "attribute_name": "attribute_name4", - "initial_attribute_value": null, - "sort_order": null + "initial_attribute_value": "initial_attribute_value6", + "sort_order": "DESC" } ``` diff --git a/doc/models/catalog-query.md b/doc/models/catalog-query.md index ff29c7df..b44c08a8 100644 --- a/doc/models/catalog-query.md +++ b/doc/models/catalog-query.md @@ -52,16 +52,62 @@ the `"name"`, `"description"`, or `"abbreviation"` attribute in an applicable qu ```json { - "sorted_attribute_query": null, - "exact_query": null, - "set_query": null, - "prefix_query": null, - "range_query": null, - "text_query": null, - "items_for_tax_query": null, - "items_for_modifier_list_query": null, - "items_for_item_options_query": null, - "item_variations_for_item_option_values_query": null + "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 + }, + "text_query": { + "keywords": [ + "keywords3", + "keywords4", + "keywords5" + ] + }, + "items_for_tax_query": { + "tax_ids": [ + "tax_ids3" + ] + }, + "items_for_modifier_list_query": { + "modifier_list_ids": [ + "modifier_list_ids6", + "modifier_list_ids7", + "modifier_list_ids8" + ] + }, + "items_for_item_options_query": { + "item_option_ids": [ + "item_option_ids9", + "item_option_ids0" + ] + }, + "item_variations_for_item_option_values_query": { + "item_option_value_ids": [ + "item_option_value_ids8", + "item_option_value_ids9", + "item_option_value_ids0" + ] + } } ``` diff --git a/doc/models/catalog-quick-amount.md b/doc/models/catalog-quick-amount.md index 28680bea..9df1497b 100644 --- a/doc/models/catalog-quick-amount.md +++ b/doc/models/catalog-quick-amount.md @@ -22,11 +22,11 @@ Represents a Quick Amount in the Catalog. { "type": "QUICK_AMOUNT_TYPE_MANUAL", "amount": { - "amount": null, - "currency": null + "amount": 0, + "currency": "NOK" }, - "score": null, - "ordinal": null + "score": 148, + "ordinal": 80 } ``` diff --git a/doc/models/catalog-quick-amounts-settings.md b/doc/models/catalog-quick-amounts-settings.md index 66697ef0..6cb42851 100644 --- a/doc/models/catalog-quick-amounts-settings.md +++ b/doc/models/catalog-quick-amounts-settings.md @@ -20,8 +20,27 @@ A parent Catalog Object model represents a set of Quick Amounts and the settings ```json { "option": "AUTO", - "eligible_for_auto_amounts": null, - "amounts": null + "eligible_for_auto_amounts": false, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": { + "amount": 244, + "currency": "AWG" + }, + "score": 228, + "ordinal": 160 + }, + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": { + "amount": 245, + "currency": "AZN" + }, + "score": 229, + "ordinal": 161 + } + ] } ``` diff --git a/doc/models/catalog-stock-conversion.md b/doc/models/catalog-stock-conversion.md index 5bcdeb78..2ff73cae 100644 --- a/doc/models/catalog-stock-conversion.md +++ b/doc/models/catalog-stock-conversion.md @@ -13,9 +13,9 @@ share the same underlying stock. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `stockableItemVariationId` | `string` | Required | References to the stockable [CatalogItemVariation](../../doc/models/catalog-item-variation.md)
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](../../doc/models/catalog-item.md) of the converted `CatalogItemVariation.`
**Constraints**: *Minimum Length*: `1` | +| `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` | | `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` | -| `nonstockableQuantity` | `string` | Required | The converted equivalent quantity of the non-stockable [CatalogItemVariation](../../doc/models/catalog-item-variation.md)
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` | +| `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` | ## Example (as JSON) diff --git a/doc/models/catalog-subscription-plan.md b/doc/models/catalog-subscription-plan.md index 50ad1b9e..4ecff280 100644 --- a/doc/models/catalog-subscription-plan.md +++ b/doc/models/catalog-subscription-plan.md @@ -13,14 +13,35 @@ Describes a subscription plan. For more information, see | Name | Type | Tags | Description | | --- | --- | --- | --- | | `name` | `string` | Required | The name of the plan. | -| `phases` | [`SubscriptionPhase[] \| undefined`](../../doc/models/subscription-phase.md) | Optional | A list of SubscriptionPhase containing the [SubscriptionPhase](../../doc/models/subscription-phase.md) for this plan.
This field it required. Not including this field will throw a REQUIRED_FIELD_MISSING error | +| `phases` | [`SubscriptionPhase[] \| undefined`](../../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 | ## Example (as JSON) ```json { "name": "name0", - "phases": null + "phases": [ + { + "uid": "uid5", + "cadence": "EVERY_FOUR_MONTHS", + "periods": 241, + "recurring_price_money": { + "amount": 193, + "currency": "MOP" + }, + "ordinal": 207 + }, + { + "uid": "uid6", + "cadence": "QUARTERLY", + "periods": 242, + "recurring_price_money": { + "amount": 194, + "currency": "MRO" + }, + "ordinal": 208 + } + ] } ``` diff --git a/doc/models/catalog-time-period.md b/doc/models/catalog-time-period.md index ec685eb1..7a3f8774 100644 --- a/doc/models/catalog-time-period.md +++ b/doc/models/catalog-time-period.md @@ -17,7 +17,7 @@ Represents a time period - either a single period or a repeating period. ```json { - "event": null + "event": "event0" } ``` diff --git a/doc/models/catalog-v1-id.md b/doc/models/catalog-v1-id.md index 9bb0bf2c..c60a187f 100644 --- a/doc/models/catalog-v1-id.md +++ b/doc/models/catalog-v1-id.md @@ -18,8 +18,8 @@ A Square API V1 identifier of an item, including the object ID and its associate ```json { - "catalog_v1_id": null, - "location_id": null + "catalog_v1_id": "catalog_v1_id4", + "location_id": "location_id4" } ``` diff --git a/doc/models/charge-request-additional-recipient.md b/doc/models/charge-request-additional-recipient.md index 747b78de..71eec654 100644 --- a/doc/models/charge-request-additional-recipient.md +++ b/doc/models/charge-request-additional-recipient.md @@ -23,8 +23,8 @@ Support is currently limited to USD, CAD and GBP currencies "location_id": "location_id4", "description": "description0", "amount_money": { - "amount": null, - "currency": null + "amount": 186, + "currency": "NGN" } } ``` diff --git a/doc/models/charge-request.md b/doc/models/charge-request.md index 445596e2..ac37310e 100644 --- a/doc/models/charge-request.md +++ b/doc/models/charge-request.md @@ -2,9 +2,9 @@ # Charge Request Defines the parameters that can be included in the body of -a request to the [Charge]($e/Transactions/Charge) endpoint. +a request to the [Charge](api-endpoint:Transactions-Charge) endpoint. -Deprecated - recommend using [CreatePayment](../../doc/api/payments.md#create-payment) +Deprecated - recommend using [CreatePayment](api-endpoint:Payments-CreatePayment) ## Structure @@ -18,7 +18,7 @@ Deprecated - recommend using [CreatePayment](../../doc/api/payments.md#create-pa | `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. | | `cardNonce` | `string \| undefined` | 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` | | `customerCardId` | `string \| undefined` | 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` | -| `delayCapture` | `boolean \| undefined` | 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](../../doc/api/transactions.md#capture-transaction) endpoint) or a Void
(with the [VoidTransaction](../../doc/api/transactions.md#void-transaction) endpoint).

Default value: `false` | +| `delayCapture` | `boolean \| undefined` | 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` | | `referenceId` | `string \| undefined` | 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` | | `note` | `string \| undefined` | Optional | An optional note to associate with the transaction.

This value cannot exceed 60 characters.
**Constraints**: *Maximum Length*: `60` | | `customerId` | `string \| undefined` | 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` | diff --git a/doc/models/charge-response.md b/doc/models/charge-response.md index 3862653b..9ba34fab 100644 --- a/doc/models/charge-response.md +++ b/doc/models/charge-response.md @@ -2,7 +2,7 @@ # Charge Response Defines the fields that are included in the response body of -a request to the [Charge]($e/Transactions/Charge) endpoint. +a request to the [Charge](api-endpoint:Transactions-Charge) endpoint. One of `errors` or `transaction` is present in a given response (never both). diff --git a/doc/models/checkout-options.md b/doc/models/checkout-options.md index 7baca928..21279bf3 100644 --- a/doc/models/checkout-options.md +++ b/doc/models/checkout-options.md @@ -23,15 +23,39 @@ ```json { - "allow_tipping": null, - "custom_fields": null, - "subscription_plan_id": null, - "redirect_url": null, - "merchant_support_email": null, - "ask_for_shipping_address": null, - "accepted_payment_methods": null, - "app_fee_money": null, - "shipping_fee": null + "allow_tipping": false, + "custom_fields": [ + { + "title": "title9" + }, + { + "title": "title0" + }, + { + "title": "title1" + } + ], + "subscription_plan_id": "subscription_plan_id2", + "redirect_url": "redirect_url2", + "merchant_support_email": "merchant_support_email8", + "ask_for_shipping_address": false, + "accepted_payment_methods": { + "apple_pay": false, + "google_pay": false, + "cash_app_pay": false, + "afterpay_clearpay": false + }, + "app_fee_money": { + "amount": 106, + "currency": "GBP" + }, + "shipping_fee": { + "name": "name2", + "charge": { + "amount": 176, + "currency": "PYG" + } + } } ``` diff --git a/doc/models/checkout.md b/doc/models/checkout.md index fffec2b4..763418f2 100644 --- a/doc/models/checkout.md +++ b/doc/models/checkout.md @@ -27,16 +27,1421 @@ payment types using a checkout workflow hosted on squareup.com. ```json { - "id": null, - "checkout_page_url": null, - "ask_for_shipping_address": null, - "merchant_support_email": null, - "pre_populate_buyer_email": null, - "pre_populate_shipping_address": null, - "redirect_url": null, - "order": null, - "created_at": null, - "additional_recipients": null + "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", + "pre_populate_shipping_address": { + "address_line_1": "address_line_14", + "address_line_2": "address_line_26", + "address_line_3": "address_line_32", + "locality": "locality6", + "sublocality": "sublocality6", + "sublocality_2": "sublocality_24", + "sublocality_3": "sublocality_36", + "administrative_district_level_1": "administrative_district_level_10", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_34", + "postal_code": "postal_code8", + "country": "SI", + "first_name": "first_name6", + "last_name": "last_name4" + }, + "redirect_url": "redirect_url2", + "order": { + "id": "id6", + "location_id": "location_id0", + "reference_id": "reference_id4", + "source": { + "name": "name2" + }, + "customer_id": "customer_id4", + "line_items": [ + { + "uid": "uid1", + "name": "name1", + "quantity": "quantity7", + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name9", + "abbreviation": "abbreviation1" + }, + "area_unit": "METRIC_SQUARE_CENTIMETER", + "length_unit": "IMPERIAL_MILE", + "volume_unit": "GENERIC_FLUID_OUNCE", + "weight_unit": "METRIC_KILOGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MILLISECOND", + "type": "TYPE_GENERIC" + }, + "precision": 201, + "catalog_object_id": "catalog_object_id1", + "catalog_version": 135 + }, + "note": "note3", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 235, + "variation_name": "variation_name1", + "item_type": "CUSTOM_AMOUNT", + "metadata": { + "key0": "metadata2", + "key1": "metadata3" + }, + "modifiers": [ + { + "uid": "uid2", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 82, + "name": "name2", + "quantity": "quantity8", + "base_price_money": { + "amount": 66, + "currency": "ETB" + }, + "total_price_money": { + "amount": 64, + "currency": "SLL" + }, + "metadata": { + "key0": "metadata9", + "key1": "metadata8" + } + }, + { + "uid": "uid3", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 83, + "name": "name3", + "quantity": "quantity9", + "base_price_money": { + "amount": 67, + "currency": "EUR" + }, + "total_price_money": { + "amount": 65, + "currency": "SOS" + }, + "metadata": { + "key0": "metadata0" + } + }, + { + "uid": "uid4", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 84, + "name": "name4", + "quantity": "quantity0", + "base_price_money": { + "amount": 68, + "currency": "FJD" + }, + "total_price_money": { + "amount": 66, + "currency": "SRD" + }, + "metadata": { + "key0": "metadata1", + "key1": "metadata0", + "key2": "metadata9" + } + } + ], + "applied_taxes": [ + { + "uid": "uid1", + "tax_uid": "tax_uid7", + "applied_money": {} + }, + { + "uid": "uid2", + "tax_uid": "tax_uid8", + "applied_money": {} + }, + { + "uid": "uid3", + "tax_uid": "tax_uid9", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid5", + "discount_uid": "discount_uid9", + "applied_money": {} + } + ], + "applied_service_charges": [ + { + "uid": "uid0", + "service_charge_uid": "service_charge_uid0", + "applied_money": {} + }, + { + "uid": "uid9", + "service_charge_uid": "service_charge_uid9", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_sales_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "pricing_blocklists": { + "blocked_discounts": [ + { + "uid": "uid4", + "discount_uid": "discount_uid0", + "discount_catalog_object_id": "discount_catalog_object_id6" + }, + { + "uid": "uid5", + "discount_uid": "discount_uid1", + "discount_catalog_object_id": "discount_catalog_object_id7" + } + ], + "blocked_taxes": [ + { + "uid": "uid2", + "tax_uid": "tax_uid8", + "tax_catalog_object_id": "tax_catalog_object_id6" + }, + { + "uid": "uid1", + "tax_uid": "tax_uid7", + "tax_catalog_object_id": "tax_catalog_object_id5" + } + ] + }, + "total_service_charge_money": {} + } + ], + "taxes": [ + { + "uid": "uid9", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 153, + "name": "name9", + "type": "ADDITIVE", + "percentage": "percentage7", + "metadata": { + "key0": "metadata4", + "key1": "metadata5" + }, + "applied_money": {}, + "scope": "LINE_ITEM", + "auto_applied": true + }, + { + "uid": "uid8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 154, + "name": "name8", + "type": "INCLUSIVE", + "percentage": "percentage6", + "metadata": { + "key0": "metadata5", + "key1": "metadata6", + "key2": "metadata7" + }, + "applied_money": {}, + "scope": "ORDER", + "auto_applied": false + } + ], + "discounts": [ + { + "uid": "uid7", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 97, + "name": "name7", + "type": "FIXED_AMOUNT", + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "metadata": { + "key0": "metadata8" + }, + "scope": "OTHER_DISCOUNT_SCOPE", + "reward_ids": [ + "reward_ids4", + "reward_ids5", + "reward_ids6" + ], + "pricing_rule_id": "pricing_rule_id9" + }, + { + "uid": "uid8", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 98, + "name": "name8", + "type": "VARIABLE_PERCENTAGE", + "percentage": "percentage6", + "amount_money": {}, + "applied_money": {}, + "metadata": { + "key0": "metadata9", + "key1": "metadata0" + }, + "scope": "LINE_ITEM", + "reward_ids": [ + "reward_ids5" + ], + "pricing_rule_id": "pricing_rule_id0" + } + ], + "service_charges": [ + { + "uid": "uid9", + "name": "name9", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 213, + "percentage": "percentage7", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_AMOUNT_PHASE", + "taxable": true, + "applied_taxes": [ + {} + ], + "metadata": { + "key0": "metadata4" + }, + "type": "CUSTOM", + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "OTHER_SERVICE_CHARGE_SCOPE" + } + ], + "fulfillments": [ + { + "uid": "uid2", + "type": "PICKUP", + "state": "PROPOSED", + "line_item_application": "ALL", + "entries": [ + { + "uid": "uid7", + "line_item_uid": "line_item_uid7", + "quantity": "quantity3", + "metadata": { + "key0": "metadata4" + } + }, + { + "uid": "uid8", + "line_item_uid": "line_item_uid8", + "quantity": "quantity4", + "metadata": { + "key0": "metadata5", + "key1": "metadata4", + "key2": "metadata3" + } + }, + { + "uid": "uid9", + "line_item_uid": "line_item_uid9", + "quantity": "quantity5", + "metadata": { + "key0": "metadata6", + "key1": "metadata5" + } + } + ], + "metadata": { + "key0": "metadata7" + }, + "pickup_details": { + "recipient": { + "customer_id": "customer_id0", + "display_name": "display_name2", + "email_address": "email_address0", + "phone_number": "phone_number0", + "address": { + "address_line_1": "address_line_18", + "address_line_2": "address_line_28", + "address_line_3": "address_line_34", + "locality": "locality8", + "sublocality": "sublocality8", + "sublocality_2": "sublocality_26", + "sublocality_3": "sublocality_38", + "administrative_district_level_1": "administrative_district_level_12", + "administrative_district_level_2": "administrative_district_level_24", + "administrative_district_level_3": "administrative_district_level_36", + "postal_code": "postal_code0", + "country": "SY", + "first_name": "first_name8", + "last_name": "last_name6" + } + }, + "expires_at": "expires_at4", + "auto_complete_duration": "auto_complete_duration4", + "schedule_type": "SCHEDULED", + "pickup_at": "pickup_at6", + "pickup_window_duration": "pickup_window_duration0", + "prep_time_duration": "prep_time_duration2", + "note": "note6", + "placed_at": "placed_at0", + "accepted_at": "accepted_at4", + "rejected_at": "rejected_at2", + "ready_at": "ready_at0", + "expired_at": "expired_at0", + "picked_up_at": "picked_up_at0", + "canceled_at": "canceled_at6", + "cancel_reason": "cancel_reason6", + "is_curbside_pickup": false, + "curbside_pickup_details": { + "curbside_details": "curbside_details2", + "buyer_arrived_at": "buyer_arrived_at8" + } + }, + "shipment_details": { + "recipient": { + "customer_id": "customer_id4", + "display_name": "display_name6", + "email_address": "email_address4", + "phone_number": "phone_number4", + "address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_22", + "address_line_3": "address_line_38", + "locality": "locality2", + "sublocality": "sublocality2", + "sublocality_2": "sublocality_20", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_16", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_30", + "postal_code": "postal_code4", + "country": "VA", + "first_name": "first_name2", + "last_name": "last_name0" + } + }, + "carrier": "carrier6", + "shipping_note": "shipping_note0", + "shipping_type": "shipping_type8", + "tracking_number": "tracking_number2", + "tracking_url": "tracking_url4", + "placed_at": "placed_at4", + "in_progress_at": "in_progress_at0", + "packaged_at": "packaged_at8", + "expected_shipped_at": "expected_shipped_at8", + "shipped_at": "shipped_at2", + "canceled_at": "canceled_at0", + "cancel_reason": "cancel_reason0", + "failed_at": "failed_at8", + "failure_reason": "failure_reason4" + }, + "delivery_details": { + "recipient": {}, + "schedule_type": "SCHEDULED", + "placed_at": "placed_at8", + "deliver_at": "deliver_at6", + "prep_time_duration": "prep_time_duration0", + "delivery_window_duration": "delivery_window_duration2", + "note": "note4", + "completed_at": "completed_at0", + "in_progress_at": "in_progress_at4", + "rejected_at": "rejected_at0", + "ready_at": "ready_at8", + "delivered_at": "delivered_at6", + "canceled_at": "canceled_at4", + "cancel_reason": "cancel_reason4", + "courier_pickup_at": "courier_pickup_at0", + "courier_pickup_window_duration": "courier_pickup_window_duration2", + "is_no_contact_delivery": false, + "dropoff_notes": "dropoff_notes2", + "courier_provider_name": "courier_provider_name6", + "courier_support_phone_number": "courier_support_phone_number4", + "square_delivery_id": "square_delivery_id8", + "external_delivery_id": "external_delivery_id2", + "managed_delivery": false + } + }, + { + "uid": "uid3", + "type": "SHIPMENT", + "state": "RESERVED", + "line_item_application": "ENTRY_LIST", + "entries": [ + { + "uid": "uid8", + "line_item_uid": "line_item_uid8", + "quantity": "quantity4", + "metadata": { + "key0": "metadata5", + "key1": "metadata4", + "key2": "metadata3" + } + } + ], + "metadata": { + "key0": "metadata6", + "key1": "metadata5" + }, + "pickup_details": { + "recipient": { + "customer_id": "customer_id1", + "display_name": "display_name3", + "email_address": "email_address1", + "phone_number": "phone_number1", + "address": { + "address_line_1": "address_line_19", + "address_line_2": "address_line_29", + "address_line_3": "address_line_35", + "locality": "locality9", + "sublocality": "sublocality9", + "sublocality_2": "sublocality_27", + "sublocality_3": "sublocality_39", + "administrative_district_level_1": "administrative_district_level_13", + "administrative_district_level_2": "administrative_district_level_25", + "administrative_district_level_3": "administrative_district_level_37", + "postal_code": "postal_code1", + "country": "SZ", + "first_name": "first_name9", + "last_name": "last_name7" + } + }, + "expires_at": "expires_at5", + "auto_complete_duration": "auto_complete_duration5", + "schedule_type": "ASAP", + "pickup_at": "pickup_at7", + "pickup_window_duration": "pickup_window_duration1", + "prep_time_duration": "prep_time_duration3", + "note": "note7", + "placed_at": "placed_at1", + "accepted_at": "accepted_at5", + "rejected_at": "rejected_at3", + "ready_at": "ready_at1", + "expired_at": "expired_at1", + "picked_up_at": "picked_up_at1", + "canceled_at": "canceled_at7", + "cancel_reason": "cancel_reason7", + "is_curbside_pickup": true, + "curbside_pickup_details": { + "curbside_details": "curbside_details3", + "buyer_arrived_at": "buyer_arrived_at9" + } + }, + "shipment_details": { + "recipient": { + "customer_id": "customer_id5", + "display_name": "display_name7", + "email_address": "email_address5", + "phone_number": "phone_number5", + "address": { + "address_line_1": "address_line_13", + "address_line_2": "address_line_23", + "address_line_3": "address_line_39", + "locality": "locality3", + "sublocality": "sublocality3", + "sublocality_2": "sublocality_21", + "sublocality_3": "sublocality_33", + "administrative_district_level_1": "administrative_district_level_17", + "administrative_district_level_2": "administrative_district_level_29", + "administrative_district_level_3": "administrative_district_level_31", + "postal_code": "postal_code5", + "country": "VC", + "first_name": "first_name3", + "last_name": "last_name1" + } + }, + "carrier": "carrier7", + "shipping_note": "shipping_note1", + "shipping_type": "shipping_type9", + "tracking_number": "tracking_number3", + "tracking_url": "tracking_url5", + "placed_at": "placed_at5", + "in_progress_at": "in_progress_at1", + "packaged_at": "packaged_at9", + "expected_shipped_at": "expected_shipped_at9", + "shipped_at": "shipped_at3", + "canceled_at": "canceled_at1", + "cancel_reason": "cancel_reason1", + "failed_at": "failed_at9", + "failure_reason": "failure_reason5" + }, + "delivery_details": { + "recipient": {}, + "schedule_type": "ASAP", + "placed_at": "placed_at9", + "deliver_at": "deliver_at7", + "prep_time_duration": "prep_time_duration1", + "delivery_window_duration": "delivery_window_duration3", + "note": "note5", + "completed_at": "completed_at1", + "in_progress_at": "in_progress_at5", + "rejected_at": "rejected_at1", + "ready_at": "ready_at9", + "delivered_at": "delivered_at7", + "canceled_at": "canceled_at5", + "cancel_reason": "cancel_reason5", + "courier_pickup_at": "courier_pickup_at1", + "courier_pickup_window_duration": "courier_pickup_window_duration3", + "is_no_contact_delivery": true, + "dropoff_notes": "dropoff_notes3", + "courier_provider_name": "courier_provider_name7", + "courier_support_phone_number": "courier_support_phone_number5", + "square_delivery_id": "square_delivery_id9", + "external_delivery_id": "external_delivery_id3", + "managed_delivery": true + } + } + ], + "returns": [ + { + "uid": "uid9", + "source_order_id": "source_order_id7", + "return_line_items": [ + { + "uid": "uid4", + "source_line_item_uid": "source_line_item_uid2", + "name": "name4", + "quantity": "quantity0", + "quantity_unit": {}, + "note": "note0", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 26, + "variation_name": "variation_name4", + "item_type": "GIFT_CARD", + "return_modifiers": [ + { + "uid": "uid3", + "source_modifier_uid": "source_modifier_uid3", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 79, + "name": "name3", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity9" + }, + { + "uid": "uid2", + "source_modifier_uid": "source_modifier_uid4", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 80, + "name": "name2", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity8" + } + ], + "applied_taxes": [ + {} + ], + "applied_discounts": [ + {}, + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {} + ], + "total_service_charge_money": {} + } + ], + "return_service_charges": [ + { + "uid": "uid0", + "source_service_charge_uid": "source_service_charge_uid6", + "name": "name0", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 12, + "percentage": "percentage8", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "SUBTOTAL_PHASE", + "taxable": false, + "applied_taxes": [ + {} + ], + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "OTHER_SERVICE_CHARGE_SCOPE" + }, + { + "uid": "uid1", + "source_service_charge_uid": "source_service_charge_uid5", + "name": "name1", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 11, + "percentage": "percentage9", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "TOTAL_PHASE", + "taxable": true, + "applied_taxes": [ + {}, + {} + ], + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "ORDER" + } + ], + "return_taxes": [ + { + "uid": "uid1", + "source_tax_uid": "source_tax_uid9", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 255, + "name": "name1", + "type": "UNKNOWN_TAX", + "percentage": "percentage9", + "applied_money": {}, + "scope": "OTHER_TAX_SCOPE" + }, + { + "uid": "uid2", + "source_tax_uid": "source_tax_uid0", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 254, + "name": "name2", + "type": "INCLUSIVE", + "percentage": "percentage0", + "applied_money": {}, + "scope": "ORDER" + }, + { + "uid": "uid3", + "source_tax_uid": "source_tax_uid1", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 253, + "name": "name3", + "type": "ADDITIVE", + "percentage": "percentage1", + "applied_money": {}, + "scope": "LINE_ITEM" + } + ], + "return_discounts": [ + { + "uid": "uid9", + "source_discount_uid": "source_discount_uid9", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 79, + "name": "name9", + "type": "FIXED_PERCENTAGE", + "percentage": "percentage7", + "amount_money": {}, + "applied_money": {}, + "scope": "LINE_ITEM" + }, + { + "uid": "uid8", + "source_discount_uid": "source_discount_uid8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 80, + "name": "name8", + "type": "FIXED_AMOUNT", + "percentage": "percentage6", + "amount_money": {}, + "applied_money": {}, + "scope": "ORDER" + } + ], + "rounding_adjustment": { + "uid": "uid1", + "name": "name1", + "amount_money": {} + }, + "return_amounts": { + "total_money": {}, + "tax_money": {}, + "discount_money": {}, + "tip_money": {}, + "service_charge_money": {} + } + }, + { + "uid": "uid0", + "source_order_id": "source_order_id8", + "return_line_items": [ + { + "uid": "uid5", + "source_line_item_uid": "source_line_item_uid3", + "name": "name5", + "quantity": "quantity1", + "quantity_unit": {}, + "note": "note1", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 25, + "variation_name": "variation_name5", + "item_type": "ITEM", + "return_modifiers": [ + { + "uid": "uid4", + "source_modifier_uid": "source_modifier_uid2", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 78, + "name": "name4", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity0" + } + ], + "applied_taxes": [ + {}, + {} + ], + "applied_discounts": [ + {}, + {}, + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {}, + {} + ], + "total_service_charge_money": {} + }, + { + "uid": "uid6", + "source_line_item_uid": "source_line_item_uid4", + "name": "name6", + "quantity": "quantity2", + "quantity_unit": {}, + "note": "note2", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 24, + "variation_name": "variation_name6", + "item_type": "CUSTOM_AMOUNT", + "return_modifiers": [ + { + "uid": "uid5", + "source_modifier_uid": "source_modifier_uid1", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 77, + "name": "name5", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity1" + }, + { + "uid": "uid4", + "source_modifier_uid": "source_modifier_uid2", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 78, + "name": "name4", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity0" + }, + { + "uid": "uid3", + "source_modifier_uid": "source_modifier_uid3", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 79, + "name": "name3", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity9" + } + ], + "applied_taxes": [ + {}, + {}, + {} + ], + "applied_discounts": [ + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {}, + {}, + {} + ], + "total_service_charge_money": {} + } + ], + "return_service_charges": [ + { + "uid": "uid1", + "source_service_charge_uid": "source_service_charge_uid5", + "name": "name1", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 11, + "percentage": "percentage9", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "TOTAL_PHASE", + "taxable": true, + "applied_taxes": [ + {}, + {} + ], + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "ORDER" + }, + { + "uid": "uid2", + "source_service_charge_uid": "source_service_charge_uid4", + "name": "name2", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 10, + "percentage": "percentage0", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_PERCENTAGE_PHASE", + "taxable": false, + "applied_taxes": [ + {}, + {}, + {} + ], + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "LINE_ITEM" + }, + { + "uid": "uid3", + "source_service_charge_uid": "source_service_charge_uid3", + "name": "name3", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 9, + "percentage": "percentage1", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_AMOUNT_PHASE", + "taxable": true, + "applied_taxes": [ + {} + ], + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "OTHER_SERVICE_CHARGE_SCOPE" + } + ], + "return_taxes": [ + { + "uid": "uid2", + "source_tax_uid": "source_tax_uid0", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 254, + "name": "name2", + "type": "INCLUSIVE", + "percentage": "percentage0", + "applied_money": {}, + "scope": "ORDER" + } + ], + "return_discounts": [ + { + "uid": "uid8", + "source_discount_uid": "source_discount_uid8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 80, + "name": "name8", + "type": "FIXED_AMOUNT", + "percentage": "percentage6", + "amount_money": {}, + "applied_money": {}, + "scope": "ORDER" + }, + { + "uid": "uid7", + "source_discount_uid": "source_discount_uid7", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 81, + "name": "name7", + "type": "VARIABLE_PERCENTAGE", + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "scope": "OTHER_DISCOUNT_SCOPE" + }, + { + "uid": "uid6", + "source_discount_uid": "source_discount_uid6", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 82, + "name": "name6", + "type": "VARIABLE_AMOUNT", + "percentage": "percentage4", + "amount_money": {}, + "applied_money": {}, + "scope": "LINE_ITEM" + } + ], + "rounding_adjustment": { + "uid": "uid2", + "name": "name2", + "amount_money": {} + }, + "return_amounts": { + "total_money": {}, + "tax_money": {}, + "discount_money": {}, + "tip_money": {}, + "service_charge_money": {} + } + }, + { + "uid": "uid1", + "source_order_id": "source_order_id9", + "return_line_items": [ + { + "uid": "uid6", + "source_line_item_uid": "source_line_item_uid4", + "name": "name6", + "quantity": "quantity2", + "quantity_unit": {}, + "note": "note2", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 24, + "variation_name": "variation_name6", + "item_type": "CUSTOM_AMOUNT", + "return_modifiers": [ + { + "uid": "uid5", + "source_modifier_uid": "source_modifier_uid1", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 77, + "name": "name5", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity1" + }, + { + "uid": "uid4", + "source_modifier_uid": "source_modifier_uid2", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 78, + "name": "name4", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity0" + }, + { + "uid": "uid3", + "source_modifier_uid": "source_modifier_uid3", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 79, + "name": "name3", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity9" + } + ], + "applied_taxes": [ + {}, + {}, + {} + ], + "applied_discounts": [ + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {}, + {}, + {} + ], + "total_service_charge_money": {} + }, + { + "uid": "uid7", + "source_line_item_uid": "source_line_item_uid5", + "name": "name7", + "quantity": "quantity3", + "quantity_unit": {}, + "note": "note3", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 23, + "variation_name": "variation_name7", + "item_type": "GIFT_CARD", + "return_modifiers": [ + { + "uid": "uid6", + "source_modifier_uid": "source_modifier_uid0", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 76, + "name": "name6", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity2" + }, + { + "uid": "uid5", + "source_modifier_uid": "source_modifier_uid1", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 77, + "name": "name5", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity1" + } + ], + "applied_taxes": [ + {} + ], + "applied_discounts": [ + {}, + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {} + ], + "total_service_charge_money": {} + }, + { + "uid": "uid8", + "source_line_item_uid": "source_line_item_uid6", + "name": "name8", + "quantity": "quantity4", + "quantity_unit": {}, + "note": "note4", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 22, + "variation_name": "variation_name8", + "item_type": "ITEM", + "return_modifiers": [ + { + "uid": "uid7", + "source_modifier_uid": "source_modifier_uid9", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 75, + "name": "name7", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity3" + } + ], + "applied_taxes": [ + {}, + {} + ], + "applied_discounts": [ + {}, + {}, + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {}, + {} + ], + "total_service_charge_money": {} + } + ], + "return_service_charges": [ + { + "uid": "uid2", + "source_service_charge_uid": "source_service_charge_uid4", + "name": "name2", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 10, + "percentage": "percentage0", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_PERCENTAGE_PHASE", + "taxable": false, + "applied_taxes": [ + {}, + {}, + {} + ], + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "LINE_ITEM" + } + ], + "return_taxes": [ + { + "uid": "uid3", + "source_tax_uid": "source_tax_uid1", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 253, + "name": "name3", + "type": "ADDITIVE", + "percentage": "percentage1", + "applied_money": {}, + "scope": "LINE_ITEM" + }, + { + "uid": "uid4", + "source_tax_uid": "source_tax_uid2", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 252, + "name": "name4", + "type": "UNKNOWN_TAX", + "percentage": "percentage2", + "applied_money": {}, + "scope": "OTHER_TAX_SCOPE" + } + ], + "return_discounts": [ + { + "uid": "uid7", + "source_discount_uid": "source_discount_uid7", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 81, + "name": "name7", + "type": "VARIABLE_PERCENTAGE", + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "scope": "OTHER_DISCOUNT_SCOPE" + } + ], + "rounding_adjustment": { + "uid": "uid3", + "name": "name3", + "amount_money": {} + }, + "return_amounts": { + "total_money": {}, + "tax_money": {}, + "discount_money": {}, + "tip_money": {}, + "service_charge_money": {} + } + } + ], + "return_amounts": {}, + "net_amounts": {}, + "rounding_adjustment": {}, + "tenders": [ + { + "id": "id8", + "location_id": "location_id2", + "transaction_id": "transaction_id6", + "created_at": "created_at6", + "note": "note4", + "amount_money": {}, + "tip_money": {}, + "processing_fee_money": {}, + "customer_id": "customer_id6", + "type": "SQUARE_GIFT_CARD", + "card_details": { + "status": "AUTHORIZED", + "card": { + "id": "id0", + "card_brand": "OTHER_BRAND", + "last_4": "last_42", + "exp_month": 160, + "exp_year": 136, + "cardholder_name": "cardholder_name4", + "billing_address": {}, + "fingerprint": "fingerprint6", + "customer_id": "customer_id8", + "merchant_id": "merchant_id0", + "reference_id": "reference_id8", + "enabled": false, + "card_type": "UNKNOWN_CARD_TYPE", + "prepaid_type": "PREPAID", + "bin": "bin0", + "version": 222, + "card_co_brand": "AFTERPAY" + }, + "entry_method": "EMV" + }, + "cash_details": { + "buyer_tendered_money": {}, + "change_back_money": {} + }, + "additional_recipients": [ + { + "location_id": "location_id1", + "description": "description7", + "amount_money": {}, + "receivable_id": "receivable_id7" + }, + { + "location_id": "location_id2", + "description": "description8", + "amount_money": {}, + "receivable_id": "receivable_id8" + } + ], + "payment_id": "payment_id8" + }, + { + "id": "id9", + "location_id": "location_id3", + "transaction_id": "transaction_id7", + "created_at": "created_at7", + "note": "note5", + "amount_money": {}, + "tip_money": {}, + "processing_fee_money": {}, + "customer_id": "customer_id7", + "type": "NO_SALE", + "card_details": { + "status": "CAPTURED", + "card": { + "id": "id1", + "card_brand": "EBT", + "last_4": "last_43", + "exp_month": 159, + "exp_year": 137, + "cardholder_name": "cardholder_name3", + "billing_address": {}, + "fingerprint": "fingerprint7", + "customer_id": "customer_id9", + "merchant_id": "merchant_id1", + "reference_id": "reference_id9", + "enabled": true, + "card_type": "DEBIT", + "prepaid_type": "UNKNOWN_PREPAID_TYPE", + "bin": "bin1", + "version": 223, + "card_co_brand": "UNKNOWN" + }, + "entry_method": "ON_FILE" + }, + "cash_details": { + "buyer_tendered_money": {}, + "change_back_money": {} + }, + "additional_recipients": [ + { + "location_id": "location_id2", + "description": "description8", + "amount_money": {}, + "receivable_id": "receivable_id8" + }, + { + "location_id": "location_id3", + "description": "description9", + "amount_money": {}, + "receivable_id": "receivable_id9" + }, + { + "location_id": "location_id4", + "description": "description0", + "amount_money": {}, + "receivable_id": "receivable_id0" + } + ], + "payment_id": "payment_id9" + } + ], + "refunds": [ + { + "id": "id2", + "location_id": "location_id6", + "transaction_id": "transaction_id0", + "tender_id": "tender_id0", + "created_at": "created_at0", + "reason": "reason2", + "amount_money": {}, + "status": "PENDING", + "processing_fee_money": {}, + "additional_recipients": [ + {} + ] + } + ], + "metadata": { + "key0": "metadata3" + }, + "created_at": "created_at4", + "updated_at": "updated_at2", + "closed_at": "closed_at8", + "state": "OPEN", + "version": 116, + "total_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_tip_money": {}, + "total_service_charge_money": {}, + "ticket_name": "ticket_name0", + "pricing_options": { + "auto_apply_discounts": false, + "auto_apply_taxes": false + }, + "rewards": [ + { + "id": "id1", + "reward_tier_id": "reward_tier_id7" + }, + { + "id": "id2", + "reward_tier_id": "reward_tier_id8" + }, + { + "id": "id3", + "reward_tier_id": "reward_tier_id9" + } + ], + "net_amount_due_money": {} + }, + "created_at": "created_at2", + "additional_recipients": [ + { + "location_id": "location_id3", + "description": "description9", + "amount_money": { + "amount": 83, + "currency": "ALL" + }, + "receivable_id": "receivable_id9" + }, + { + "location_id": "location_id4", + "description": "description0", + "amount_money": { + "amount": 84, + "currency": "AMD" + }, + "receivable_id": "receivable_id0" + }, + { + "location_id": "location_id5", + "description": "description1", + "amount_money": { + "amount": 85, + "currency": "ANG" + }, + "receivable_id": "receivable_id1" + } + ] } ``` diff --git a/doc/models/clearpay-details.md b/doc/models/clearpay-details.md index 574a1b22..42557722 100644 --- a/doc/models/clearpay-details.md +++ b/doc/models/clearpay-details.md @@ -17,7 +17,7 @@ Additional details about Clearpay payments. ```json { - "email_address": null + "email_address": "email_address2" } ``` diff --git a/doc/models/coordinates.md b/doc/models/coordinates.md index b94df150..3a72e40e 100644 --- a/doc/models/coordinates.md +++ b/doc/models/coordinates.md @@ -18,8 +18,8 @@ Latitude and longitude coordinates. ```json { - "latitude": null, - "longitude": null + "latitude": 65.76, + "longitude": 188.04 } ``` diff --git a/doc/models/create-booking-custom-attribute-definition-request.md b/doc/models/create-booking-custom-attribute-definition-request.md index f8726e8e..34aa5086 100644 --- a/doc/models/create-booking-custom-attribute-definition-request.md +++ b/doc/models/create-booking-custom-attribute-definition-request.md @@ -19,16 +19,19 @@ Represents a [CreateBookingCustomAttributeDefinition](../../doc/api/booking-cust ```json { "custom_attribute_definition": { - "key": null, - "schema": null, - "name": null, - "description": null, - "visibility": null, - "version": null, - "updated_at": null, - "created_at": null + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description8", + "visibility": "VISIBILITY_HIDDEN", + "version": 20, + "updated_at": "updated_at2", + "created_at": "created_at0" }, - "idempotency_key": null + "idempotency_key": "idempotency_key6" } ``` diff --git a/doc/models/create-booking-request.md b/doc/models/create-booking-request.md index 292500c2..42e05fa5 100644 --- a/doc/models/create-booking-request.md +++ b/doc/models/create-booking-request.md @@ -16,24 +16,53 @@ ```json { - "idempotency_key": null, + "idempotency_key": "idempotency_key6", "booking": { - "id": null, - "version": null, - "status": null, - "created_at": null, - "updated_at": null, - "start_at": null, - "location_id": null, - "customer_id": null, - "customer_note": null, - "seller_note": null, - "appointment_segments": null, - "transition_time_minutes": null, - "all_day": null, - "location_type": null, - "creator_details": null, - "source": null + "id": "id4", + "version": 156, + "status": "CANCELLED_BY_SELLER", + "created_at": "created_at2", + "updated_at": "updated_at0", + "start_at": "start_at6", + "location_id": "location_id8", + "customer_id": "customer_id2", + "customer_note": "customer_note6", + "seller_note": "seller_note6", + "appointment_segments": [ + { + "duration_minutes": 76, + "service_variation_id": "service_variation_id8", + "team_member_id": "team_member_id4", + "service_variation_version": 244, + "intermission_minutes": 250, + "any_team_member": false, + "resource_ids": [ + "resource_ids4", + "resource_ids5", + "resource_ids6" + ] + }, + { + "duration_minutes": 77, + "service_variation_id": "service_variation_id9", + "team_member_id": "team_member_id5", + "service_variation_version": 245, + "intermission_minutes": 251, + "any_team_member": true, + "resource_ids": [ + "resource_ids5" + ] + } + ], + "transition_time_minutes": 64, + "all_day": false, + "location_type": "CUSTOMER_LOCATION", + "creator_details": { + "creator_type": "TEAM_MEMBER", + "team_member_id": "team_member_id0", + "customer_id": "customer_id8" + }, + "source": "FIRST_PARTY_MERCHANT" } } ``` diff --git a/doc/models/create-card-request.md b/doc/models/create-card-request.md index ba16828a..9ed59a6a 100644 --- a/doc/models/create-card-request.md +++ b/doc/models/create-card-request.md @@ -1,7 +1,7 @@ # Create Card Request -Creates a card from the source (nonce, payment id, etc). Accessible via +Creates a card from the source (payment token or payment id). Accessible via HTTP requests at POST https://connect.squareup.com/v2/cards ## Structure @@ -12,7 +12,7 @@ HTTP requests at POST https://connect.squareup.com/v2/cards | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `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/basics/api101/idempotency) for more information.
**Constraints**: *Minimum Length*: `1` | +| `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` | | `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` | | `verificationToken` | `string \| undefined` | 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). | | `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. | diff --git a/doc/models/create-card-response.md b/doc/models/create-card-response.md index 00e55a2d..8e890b8f 100644 --- a/doc/models/create-card-response.md +++ b/doc/models/create-card-response.md @@ -15,7 +15,7 @@ present. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | +| `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Errors resulting from the request. | | `card` | [`Card \| undefined`](../../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. | ## Example (as JSON) diff --git a/doc/models/create-catalog-image-request.md b/doc/models/create-catalog-image-request.md index cc89dd7a..fd5a4540 100644 --- a/doc/models/create-catalog-image-request.md +++ b/doc/models/create-catalog-image-request.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `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/basics/api101/idempotency) for more information.
**Constraints**: *Minimum Length*: `1` | +| `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` | | `objectId` | `string \| undefined` | 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. | | `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. | | `isPrimary` | `boolean \| undefined` | 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`. | diff --git a/doc/models/create-dispute-evidence-file-request.md b/doc/models/create-dispute-evidence-file-request.md index 7ae6e30b..9bfe4796 100644 --- a/doc/models/create-dispute-evidence-file-request.md +++ b/doc/models/create-dispute-evidence-file-request.md @@ -20,8 +20,8 @@ Defines the parameters for a `CreateDisputeEvidenceFile` request. ```json { "idempotency_key": "idempotency_key6", - "evidence_type": null, - "content_type": null + "evidence_type": "RECEIPT", + "content_type": "content_type6" } ``` diff --git a/doc/models/create-gift-card-request.md b/doc/models/create-gift-card-request.md index 191977d0..19afc5d4 100644 --- a/doc/models/create-gift-card-request.md +++ b/doc/models/create-gift-card-request.md @@ -12,7 +12,7 @@ Represents a [CreateGiftCard](../../doc/api/gift-cards.md#create-gift-card) requ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `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` | -| `locationId` | `string` | Required | The ID of the [location](../../doc/models/location.md) 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` | +| `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` | | `giftCard` | [`GiftCard`](../../doc/models/gift-card.md) | Required | Represents a Square gift card. | ## Example (as JSON) diff --git a/doc/models/create-order-custom-attribute-definition-request.md b/doc/models/create-order-custom-attribute-definition-request.md index 15168ee0..76e6c7a7 100644 --- a/doc/models/create-order-custom-attribute-definition-request.md +++ b/doc/models/create-order-custom-attribute-definition-request.md @@ -12,7 +12,7 @@ Represents a create request for an order custom attribute definition. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `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. | -| `idempotencyKey` | `string \| undefined` | Optional | A unique identifier for this request, used to ensure idempotency.
For more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency).
**Constraints**: *Maximum Length*: `45` | +| `idempotencyKey` | `string \| undefined` | Optional | A unique identifier for this request, used to ensure idempotency.
For more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `45` | ## Example (as JSON) diff --git a/doc/models/create-payment-link-response.md b/doc/models/create-payment-link-response.md index 5ed6adf2..da272521 100644 --- a/doc/models/create-payment-link-response.md +++ b/doc/models/create-payment-link-response.md @@ -17,9 +17,4032 @@ ```json { - "errors": null, - "payment_link": null, - "related_resources": null + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ], + "payment_link": { + "id": "id2", + "version": 184, + "description": "description2", + "order_id": "order_id6", + "checkout_options": { + "allow_tipping": false, + "custom_fields": [ + { + "title": "title1" + }, + { + "title": "title2" + } + ], + "subscription_plan_id": "subscription_plan_id0", + "redirect_url": "redirect_url4", + "merchant_support_email": "merchant_support_email0", + "ask_for_shipping_address": false, + "accepted_payment_methods": { + "apple_pay": false, + "google_pay": false, + "cash_app_pay": false, + "afterpay_clearpay": false + }, + "app_fee_money": { + "amount": 38, + "currency": "MZN" + }, + "shipping_fee": { + "name": "name4", + "charge": { + "amount": 108, + "currency": "XPF" + } + } + }, + "pre_populated_data": { + "buyer_email": "buyer_email6", + "buyer_phone_number": "buyer_phone_number8", + "buyer_address": { + "address_line_1": "address_line_14", + "address_line_2": "address_line_24", + "address_line_3": "address_line_30", + "locality": "locality4", + "sublocality": "sublocality4", + "sublocality_2": "sublocality_22", + "sublocality_3": "sublocality_34", + "administrative_district_level_1": "administrative_district_level_18", + "administrative_district_level_2": "administrative_district_level_20", + "administrative_district_level_3": "administrative_district_level_32", + "postal_code": "postal_code6", + "country": "AO", + "first_name": "first_name4", + "last_name": "last_name2" + } + }, + "url": "url6", + "long_url": "long_url8", + "created_at": "created_at0", + "updated_at": "updated_at2", + "payment_note": "payment_note0" + }, + "related_resources": { + "orders": [ + { + "id": "id6", + "location_id": "location_id0", + "reference_id": "reference_id6", + "source": { + "name": "name8" + }, + "customer_id": "customer_id4", + "line_items": [ + { + "uid": "uid3", + "name": "name3", + "quantity": "quantity9", + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name1", + "abbreviation": "abbreviation3" + }, + "area_unit": "METRIC_SQUARE_KILOMETER", + "length_unit": "IMPERIAL_FOOT", + "volume_unit": "GENERIC_PINT", + "weight_unit": "METRIC_MILLIGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_HOUR", + "type": "TYPE_VOLUME" + }, + "precision": 99, + "catalog_object_id": "catalog_object_id7", + "catalog_version": 223 + }, + "note": "note1", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 81, + "variation_name": "variation_name3", + "item_type": "ITEM", + "metadata": { + "key0": "metadata0", + "key1": "metadata1", + "key2": "metadata2" + }, + "modifiers": [ + { + "uid": "uid4", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 236, + "name": "name4", + "quantity": "quantity0", + "base_price_money": { + "amount": 220, + "currency": "UYU" + }, + "total_price_money": { + "amount": 218, + "currency": "GTQ" + }, + "metadata": { + "key0": "metadata1", + "key1": "metadata0", + "key2": "metadata9" + } + }, + { + "uid": "uid5", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 237, + "name": "name5", + "quantity": "quantity1", + "base_price_money": { + "amount": 221, + "currency": "UZS" + }, + "total_price_money": { + "amount": 219, + "currency": "GYD" + }, + "metadata": { + "key0": "metadata2", + "key1": "metadata1" + } + } + ], + "applied_taxes": [ + { + "uid": "uid3", + "tax_uid": "tax_uid1", + "applied_money": {} + }, + { + "uid": "uid4", + "tax_uid": "tax_uid0", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid7", + "discount_uid": "discount_uid7", + "applied_money": {} + }, + { + "uid": "uid8", + "discount_uid": "discount_uid6", + "applied_money": {} + }, + { + "uid": "uid9", + "discount_uid": "discount_uid5", + "applied_money": {} + } + ], + "applied_service_charges": [ + { + "uid": "uid8", + "service_charge_uid": "service_charge_uid8", + "applied_money": {} + }, + { + "uid": "uid9", + "service_charge_uid": "service_charge_uid9", + "applied_money": {} + }, + { + "uid": "uid0", + "service_charge_uid": "service_charge_uid0", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_sales_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "pricing_blocklists": { + "blocked_discounts": [ + { + "uid": "uid6", + "discount_uid": "discount_uid2", + "discount_catalog_object_id": "discount_catalog_object_id8" + } + ], + "blocked_taxes": [ + { + "uid": "uid4", + "tax_uid": "tax_uid0", + "tax_catalog_object_id": "tax_catalog_object_id8" + } + ] + }, + "total_service_charge_money": {} + }, + { + "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": "GENERIC_QUART", + "weight_unit": "IMPERIAL_STONE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MINUTE", + "type": "TYPE_LENGTH" + }, + "precision": 100, + "catalog_object_id": "catalog_object_id6", + "catalog_version": 222 + }, + "note": "note0", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 80, + "variation_name": "variation_name4", + "item_type": "CUSTOM_AMOUNT", + "metadata": { + "key0": "metadata9", + "key1": "metadata0" + }, + "modifiers": [ + { + "uid": "uid5", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 237, + "name": "name5", + "quantity": "quantity1", + "base_price_money": { + "amount": 221, + "currency": "UZS" + }, + "total_price_money": { + "amount": 219, + "currency": "GYD" + }, + "metadata": { + "key0": "metadata2", + "key1": "metadata1" + } + }, + { + "uid": "uid6", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 238, + "name": "name6", + "quantity": "quantity2", + "base_price_money": { + "amount": 222, + "currency": "VEF" + }, + "total_price_money": { + "amount": 220, + "currency": "HKD" + }, + "metadata": { + "key0": "metadata3" + } + }, + { + "uid": "uid7", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 239, + "name": "name7", + "quantity": "quantity3", + "base_price_money": { + "amount": 223, + "currency": "VND" + }, + "total_price_money": { + "amount": 221, + "currency": "HNL" + }, + "metadata": { + "key0": "metadata4", + "key1": "metadata3", + "key2": "metadata2" + } + } + ], + "applied_taxes": [ + { + "uid": "uid4", + "tax_uid": "tax_uid0", + "applied_money": {} + }, + { + "uid": "uid5", + "tax_uid": "tax_uid9", + "applied_money": {} + }, + { + "uid": "uid6", + "tax_uid": "tax_uid8", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid8", + "discount_uid": "discount_uid6", + "applied_money": {} + } + ], + "applied_service_charges": [ + { + "uid": "uid7", + "service_charge_uid": "service_charge_uid7", + "applied_money": {} + }, + { + "uid": "uid8", + "service_charge_uid": "service_charge_uid8", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_sales_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "pricing_blocklists": { + "blocked_discounts": [ + { + "uid": "uid7", + "discount_uid": "discount_uid3", + "discount_catalog_object_id": "discount_catalog_object_id9" + }, + { + "uid": "uid8", + "discount_uid": "discount_uid4", + "discount_catalog_object_id": "discount_catalog_object_id0" + } + ], + "blocked_taxes": [ + { + "uid": "uid5", + "tax_uid": "tax_uid9", + "tax_catalog_object_id": "tax_catalog_object_id9" + }, + { + "uid": "uid4", + "tax_uid": "tax_uid0", + "tax_catalog_object_id": "tax_catalog_object_id8" + }, + { + "uid": "uid3", + "tax_uid": "tax_uid1", + "tax_catalog_object_id": "tax_catalog_object_id7" + } + ] + }, + "total_service_charge_money": {} + } + ], + "taxes": [ + { + "uid": "uid9", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 139, + "name": "name9", + "type": "ADDITIVE", + "percentage": "percentage7", + "metadata": { + "key0": "metadata4", + "key1": "metadata5" + }, + "applied_money": {}, + "scope": "LINE_ITEM", + "auto_applied": true + } + ], + "discounts": [ + { + "uid": "uid7", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 165, + "name": "name7", + "type": "FIXED_AMOUNT", + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "metadata": { + "key0": "metadata2", + "key1": "metadata1", + "key2": "metadata0" + }, + "scope": "ORDER", + "reward_ids": [ + "reward_ids4", + "reward_ids5" + ], + "pricing_rule_id": "pricing_rule_id9" + } + ], + "service_charges": [ + { + "uid": "uid7", + "name": "name7", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 151, + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "TOTAL_PHASE", + "taxable": true, + "applied_taxes": [ + {}, + {} + ], + "metadata": { + "key0": "metadata6", + "key1": "metadata7", + "key2": "metadata8" + }, + "type": "CUSTOM", + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "ORDER" + }, + { + "uid": "uid6", + "name": "name6", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 152, + "percentage": "percentage4", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "SUBTOTAL_PHASE", + "taxable": false, + "applied_taxes": [ + {} + ], + "metadata": { + "key0": "metadata7" + }, + "type": "AUTO_GRATUITY", + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "OTHER_SERVICE_CHARGE_SCOPE" + } + ], + "fulfillments": [ + { + "uid": "uid2", + "type": "SHIPMENT", + "state": "PREPARED", + "line_item_application": "ALL", + "entries": [ + { + "uid": "uid7", + "line_item_uid": "line_item_uid7", + "quantity": "quantity3", + "metadata": { + "key0": "metadata6", + "key1": "metadata7" + } + }, + { + "uid": "uid8", + "line_item_uid": "line_item_uid8", + "quantity": "quantity4", + "metadata": { + "key0": "metadata5" + } + } + ], + "metadata": { + "key0": "metadata9", + "key1": "metadata8" + }, + "pickup_details": { + "recipient": { + "customer_id": "customer_id0", + "display_name": "display_name2", + "email_address": "email_address0", + "phone_number": "phone_number0", + "address": { + "address_line_1": "address_line_18", + "address_line_2": "address_line_28", + "address_line_3": "address_line_34", + "locality": "locality8", + "sublocality": "sublocality8", + "sublocality_2": "sublocality_26", + "sublocality_3": "sublocality_38", + "administrative_district_level_1": "administrative_district_level_12", + "administrative_district_level_2": "administrative_district_level_24", + "administrative_district_level_3": "administrative_district_level_36", + "postal_code": "postal_code0", + "country": "SK", + "first_name": "first_name8", + "last_name": "last_name6" + } + }, + "expires_at": "expires_at4", + "auto_complete_duration": "auto_complete_duration4", + "schedule_type": "SCHEDULED", + "pickup_at": "pickup_at6", + "pickup_window_duration": "pickup_window_duration0", + "prep_time_duration": "prep_time_duration2", + "note": "note6", + "placed_at": "placed_at0", + "accepted_at": "accepted_at4", + "rejected_at": "rejected_at2", + "ready_at": "ready_at0", + "expired_at": "expired_at0", + "picked_up_at": "picked_up_at0", + "canceled_at": "canceled_at6", + "cancel_reason": "cancel_reason6", + "is_curbside_pickup": false, + "curbside_pickup_details": { + "curbside_details": "curbside_details2", + "buyer_arrived_at": "buyer_arrived_at8" + } + }, + "shipment_details": { + "recipient": { + "customer_id": "customer_id4", + "display_name": "display_name6", + "email_address": "email_address6", + "phone_number": "phone_number6", + "address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_22", + "address_line_3": "address_line_38", + "locality": "locality2", + "sublocality": "sublocality2", + "sublocality_2": "sublocality_20", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_16", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_30", + "postal_code": "postal_code4", + "country": "TT", + "first_name": "first_name2", + "last_name": "last_name0" + } + }, + "carrier": "carrier6", + "shipping_note": "shipping_note0", + "shipping_type": "shipping_type2", + "tracking_number": "tracking_number2", + "tracking_url": "tracking_url6", + "placed_at": "placed_at6", + "in_progress_at": "in_progress_at0", + "packaged_at": "packaged_at8", + "expected_shipped_at": "expected_shipped_at8", + "shipped_at": "shipped_at2", + "canceled_at": "canceled_at0", + "cancel_reason": "cancel_reason0", + "failed_at": "failed_at8", + "failure_reason": "failure_reason6" + }, + "delivery_details": { + "recipient": {}, + "schedule_type": "SCHEDULED", + "placed_at": "placed_at8", + "deliver_at": "deliver_at6", + "prep_time_duration": "prep_time_duration0", + "delivery_window_duration": "delivery_window_duration2", + "note": "note4", + "completed_at": "completed_at0", + "in_progress_at": "in_progress_at4", + "rejected_at": "rejected_at0", + "ready_at": "ready_at8", + "delivered_at": "delivered_at6", + "canceled_at": "canceled_at4", + "cancel_reason": "cancel_reason4", + "courier_pickup_at": "courier_pickup_at0", + "courier_pickup_window_duration": "courier_pickup_window_duration2", + "is_no_contact_delivery": false, + "dropoff_notes": "dropoff_notes2", + "courier_provider_name": "courier_provider_name6", + "courier_support_phone_number": "courier_support_phone_number4", + "square_delivery_id": "square_delivery_id8", + "external_delivery_id": "external_delivery_id2", + "managed_delivery": false + } + } + ], + "returns": [ + { + "uid": "uid9", + "source_order_id": "source_order_id3", + "return_line_items": [ + { + "uid": "uid6", + "source_line_item_uid": "source_line_item_uid6", + "name": "name6", + "quantity": "quantity2", + "quantity_unit": {}, + "note": "note8", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 38, + "variation_name": "variation_name6", + "item_type": "GIFT_CARD", + "return_modifiers": [ + { + "uid": "uid5", + "source_modifier_uid": "source_modifier_uid1", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 161, + "name": "name5", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity1" + }, + { + "uid": "uid6", + "source_modifier_uid": "source_modifier_uid0", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 160, + "name": "name6", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity2" + } + ], + "applied_taxes": [ + {} + ], + "applied_discounts": [ + {}, + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {} + ], + "total_service_charge_money": {} + }, + { + "uid": "uid5", + "source_line_item_uid": "source_line_item_uid7", + "name": "name5", + "quantity": "quantity1", + "quantity_unit": {}, + "note": "note9", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 39, + "variation_name": "variation_name5", + "item_type": "CUSTOM_AMOUNT", + "return_modifiers": [ + { + "uid": "uid6", + "source_modifier_uid": "source_modifier_uid0", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 160, + "name": "name6", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity2" + }, + { + "uid": "uid7", + "source_modifier_uid": "source_modifier_uid9", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 159, + "name": "name7", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity3" + }, + { + "uid": "uid8", + "source_modifier_uid": "source_modifier_uid8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 158, + "name": "name8", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity4" + } + ], + "applied_taxes": [ + {}, + {}, + {} + ], + "applied_discounts": [ + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {}, + {} + ], + "total_service_charge_money": {} + }, + { + "uid": "uid4", + "source_line_item_uid": "source_line_item_uid8", + "name": "name4", + "quantity": "quantity0", + "quantity_unit": {}, + "note": "note0", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 40, + "variation_name": "variation_name4", + "item_type": "ITEM", + "return_modifiers": [ + { + "uid": "uid7", + "source_modifier_uid": "source_modifier_uid9", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 159, + "name": "name7", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity3" + } + ], + "applied_taxes": [ + {}, + {} + ], + "applied_discounts": [ + {}, + {}, + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {}, + {}, + {} + ], + "total_service_charge_money": {} + } + ], + "return_service_charges": [ + { + "uid": "uid0", + "source_service_charge_uid": "source_service_charge_uid6", + "name": "name0", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 52, + "percentage": "percentage8", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "SUBTOTAL_PHASE", + "taxable": false, + "applied_taxes": [ + {} + ], + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "OTHER_SERVICE_CHARGE_SCOPE" + } + ], + "return_taxes": [ + { + "uid": "uid3", + "source_tax_uid": "source_tax_uid1", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 167, + "name": "name3", + "type": "ADDITIVE", + "percentage": "percentage1", + "applied_money": {}, + "scope": "LINE_ITEM" + }, + { + "uid": "uid2", + "source_tax_uid": "source_tax_uid0", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 168, + "name": "name2", + "type": "INCLUSIVE", + "percentage": "percentage0", + "applied_money": {}, + "scope": "ORDER" + }, + { + "uid": "uid1", + "source_tax_uid": "source_tax_uid9", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 169, + "name": "name1", + "type": "UNKNOWN_TAX", + "percentage": "percentage9", + "applied_money": {}, + "scope": "OTHER_TAX_SCOPE" + } + ], + "return_discounts": [ + { + "uid": "uid7", + "source_discount_uid": "source_discount_uid3", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 27, + "name": "name7", + "type": "VARIABLE_PERCENTAGE", + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "scope": "LINE_ITEM" + } + ], + "rounding_adjustment": { + "uid": "uid1", + "name": "name1", + "amount_money": {} + }, + "return_amounts": { + "total_money": {}, + "tax_money": {}, + "discount_money": {}, + "tip_money": {}, + "service_charge_money": {} + } + }, + { + "uid": "uid0", + "source_order_id": "source_order_id2", + "return_line_items": [ + { + "uid": "uid5", + "source_line_item_uid": "source_line_item_uid7", + "name": "name5", + "quantity": "quantity1", + "quantity_unit": {}, + "note": "note9", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 39, + "variation_name": "variation_name5", + "item_type": "CUSTOM_AMOUNT", + "return_modifiers": [ + { + "uid": "uid6", + "source_modifier_uid": "source_modifier_uid0", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 160, + "name": "name6", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity2" + }, + { + "uid": "uid7", + "source_modifier_uid": "source_modifier_uid9", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 159, + "name": "name7", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity3" + }, + { + "uid": "uid8", + "source_modifier_uid": "source_modifier_uid8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 158, + "name": "name8", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity4" + } + ], + "applied_taxes": [ + {}, + {}, + {} + ], + "applied_discounts": [ + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {}, + {} + ], + "total_service_charge_money": {} + } + ], + "return_service_charges": [ + { + "uid": "uid9", + "source_service_charge_uid": "source_service_charge_uid7", + "name": "name9", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 53, + "percentage": "percentage7", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_AMOUNT_PHASE", + "taxable": true, + "applied_taxes": [ + {}, + {}, + {} + ], + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "LINE_ITEM" + }, + { + "uid": "uid8", + "source_service_charge_uid": "source_service_charge_uid8", + "name": "name8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 54, + "percentage": "percentage6", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_PERCENTAGE_PHASE", + "taxable": false, + "applied_taxes": [ + {}, + {} + ], + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "ORDER" + } + ], + "return_taxes": [ + { + "uid": "uid4", + "source_tax_uid": "source_tax_uid2", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 166, + "name": "name4", + "type": "UNKNOWN_TAX", + "percentage": "percentage2", + "applied_money": {}, + "scope": "OTHER_TAX_SCOPE" + }, + { + "uid": "uid3", + "source_tax_uid": "source_tax_uid1", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 167, + "name": "name3", + "type": "ADDITIVE", + "percentage": "percentage1", + "applied_money": {}, + "scope": "LINE_ITEM" + } + ], + "return_discounts": [ + { + "uid": "uid6", + "source_discount_uid": "source_discount_uid4", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 28, + "name": "name6", + "type": "VARIABLE_AMOUNT", + "percentage": "percentage4", + "amount_money": {}, + "applied_money": {}, + "scope": "ORDER" + }, + { + "uid": "uid7", + "source_discount_uid": "source_discount_uid3", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 27, + "name": "name7", + "type": "VARIABLE_PERCENTAGE", + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "scope": "LINE_ITEM" + }, + { + "uid": "uid8", + "source_discount_uid": "source_discount_uid2", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 26, + "name": "name8", + "type": "FIXED_AMOUNT", + "percentage": "percentage6", + "amount_money": {}, + "applied_money": {}, + "scope": "OTHER_DISCOUNT_SCOPE" + } + ], + "rounding_adjustment": { + "uid": "uid2", + "name": "name2", + "amount_money": {} + }, + "return_amounts": { + "total_money": {}, + "tax_money": {}, + "discount_money": {}, + "tip_money": {}, + "service_charge_money": {} + } + } + ], + "return_amounts": {}, + "net_amounts": {}, + "rounding_adjustment": {}, + "tenders": [ + { + "id": "id8", + "location_id": "location_id2", + "transaction_id": "transaction_id6", + "created_at": "created_at6", + "note": "note4", + "amount_money": {}, + "tip_money": {}, + "processing_fee_money": {}, + "customer_id": "customer_id6", + "type": "THIRD_PARTY_CARD", + "card_details": { + "status": "AUTHORIZED", + "card": { + "id": "id0", + "card_brand": "JCB", + "last_4": "last_42", + "exp_month": 248, + "exp_year": 48, + "cardholder_name": "cardholder_name4", + "billing_address": {}, + "fingerprint": "fingerprint6", + "customer_id": "customer_id8", + "merchant_id": "merchant_id0", + "reference_id": "reference_id2", + "enabled": false, + "card_type": "UNKNOWN_CARD_TYPE", + "prepaid_type": "PREPAID", + "bin": "bin0", + "version": 122, + "card_co_brand": "AFTERPAY" + }, + "entry_method": "EMV" + }, + "cash_details": { + "buyer_tendered_money": {}, + "change_back_money": {} + }, + "additional_recipients": [ + { + "location_id": "location_id1", + "description": "description7", + "amount_money": {}, + "receivable_id": "receivable_id7" + } + ], + "payment_id": "payment_id8" + } + ], + "refunds": [ + { + "id": "id8", + "location_id": "location_id2", + "transaction_id": "transaction_id6", + "tender_id": "tender_id6", + "created_at": "created_at6", + "reason": "reason6", + "amount_money": {}, + "status": "PENDING", + "processing_fee_money": {}, + "additional_recipients": [ + {}, + {}, + {} + ] + }, + { + "id": "id9", + "location_id": "location_id3", + "transaction_id": "transaction_id7", + "tender_id": "tender_id7", + "created_at": "created_at7", + "reason": "reason5", + "amount_money": {}, + "status": "FAILED", + "processing_fee_money": {}, + "additional_recipients": [ + {} + ] + } + ], + "metadata": { + "key0": "metadata7", + "key1": "metadata8" + }, + "created_at": "created_at4", + "updated_at": "updated_at8", + "closed_at": "closed_at8", + "state": "OPEN", + "version": 184, + "total_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_tip_money": {}, + "total_service_charge_money": {}, + "ticket_name": "ticket_name0", + "pricing_options": { + "auto_apply_discounts": false, + "auto_apply_taxes": false + }, + "rewards": [ + { + "id": "id1", + "reward_tier_id": "reward_tier_id7" + }, + { + "id": "id2", + "reward_tier_id": "reward_tier_id8" + } + ], + "net_amount_due_money": {} + } + ], + "subscription_plans": [ + { + "type": "TAX", + "id": "id0", + "updated_at": "updated_at6", + "version": 172, + "is_deleted": false, + "custom_attribute_values": { + "key0": { + "name": "name3", + "string_value": "string_value7", + "custom_attribute_definition_id": "custom_attribute_definition_id9", + "type": "BOOLEAN", + "number_value": "number_value3", + "boolean_value": true, + "selection_uid_values": [ + "selection_uid_values0", + "selection_uid_values1" + ], + "key": "key3" + }, + "key1": { + "name": "name4", + "string_value": "string_value8", + "custom_attribute_definition_id": "custom_attribute_definition_id8", + "type": "STRING", + "number_value": "number_value4", + "boolean_value": false, + "selection_uid_values": [ + "selection_uid_values1", + "selection_uid_values2", + "selection_uid_values3" + ], + "key": "key4" + } + }, + "catalog_v1_ids": [ + { + "catalog_v1_id": "catalog_v1_id4", + "location_id": "location_id4" + }, + { + "catalog_v1_id": "catalog_v1_id5", + "location_id": "location_id5" + }, + { + "catalog_v1_id": "catalog_v1_id6", + "location_id": "location_id6" + } + ], + "present_at_all_locations": false, + "present_at_location_ids": [ + "present_at_location_ids0", + "present_at_location_ids1" + ], + "absent_at_location_ids": [ + "absent_at_location_ids1", + "absent_at_location_ids2", + "absent_at_location_ids3" + ], + "item_data": { + "name": "name2", + "description": "description2", + "abbreviation": "abbreviation4", + "label_color": "label_color4", + "available_online": false, + "available_for_pickup": false, + "available_electronically": false, + "category_id": "category_id6", + "tax_ids": [ + "tax_ids5" + ], + "modifier_list_info": [ + { + "modifier_list_id": "modifier_list_id2", + "modifier_overrides": [ + { + "modifier_id": "modifier_id5", + "on_by_default": true + } + ], + "min_selected_modifiers": 188, + "max_selected_modifiers": 168, + "enabled": false + }, + { + "modifier_list_id": "modifier_list_id3", + "modifier_overrides": [ + { + "modifier_id": "modifier_id6", + "on_by_default": false + }, + { + "modifier_id": "modifier_id7", + "on_by_default": true + } + ], + "min_selected_modifiers": 189, + "max_selected_modifiers": 169, + "enabled": true + } + ], + "variations": [ + { + "type": "TAX", + "id": "id5", + "updated_at": "updated_at9", + "version": 93, + "is_deleted": true, + "custom_attribute_values": { + "key0": {}, + "key1": {} + }, + "catalog_v1_ids": [ + {} + ], + "present_at_all_locations": true, + "present_at_location_ids": [ + "present_at_location_ids5", + "present_at_location_ids6", + "present_at_location_ids7" + ], + "absent_at_location_ids": [ + "absent_at_location_ids6" + ], + "item_data": { + "name": "name3", + "description": "description3", + "abbreviation": "abbreviation5", + "label_color": "label_color5", + "available_online": true, + "available_for_pickup": true, + "available_electronically": true, + "category_id": "category_id5", + "tax_ids": [ + "tax_ids6", + "tax_ids5" + ], + "modifier_list_info": [ + {} + ], + "variations": [ + {} + ], + "product_type": "APPOINTMENTS_SERVICE", + "skip_modifier_screen": true, + "item_options": [ + { + "item_option_id": "item_option_id8" + }, + { + "item_option_id": "item_option_id7" + }, + { + "item_option_id": "item_option_id6" + } + ], + "image_ids": [ + "image_ids2" + ], + "sort_name": "sort_name5", + "description_html": "description_html3", + "description_plaintext": "description_plaintext3" + }, + "category_data": { + "name": "name9", + "image_ids": [ + "image_ids4", + "image_ids5", + "image_ids6" + ] + }, + "item_variation_data": { + "item_id": "item_id9", + "name": "name1", + "sku": "sku3", + "upc": "upc1", + "ordinal": 143, + "pricing_type": "VARIABLE_PRICING", + "price_money": {}, + "location_overrides": [ + { + "location_id": "location_id6", + "price_money": {}, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 82, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until0" + }, + { + "location_id": "location_id7", + "price_money": {}, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 83, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until1" + }, + { + "location_id": "location_id8", + "price_money": {}, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 84, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until2" + } + ], + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 111, + "user_data": "user_data5", + "service_duration": 233, + "available_for_booking": true, + "item_option_values": [ + { + "item_option_id": "item_option_id0", + "item_option_value_id": "item_option_value_id2" + }, + { + "item_option_id": "item_option_id1", + "item_option_value_id": "item_option_value_id1" + }, + { + "item_option_id": "item_option_id2", + "item_option_value_id": "item_option_value_id0" + } + ], + "measurement_unit_id": "measurement_unit_id9", + "sellable": true, + "stockable": true, + "image_ids": [ + "image_ids6", + "image_ids5", + "image_ids4" + ], + "team_member_ids": [ + "team_member_ids8", + "team_member_ids9" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id9", + "stockable_quantity": "stockable_quantity1", + "nonstockable_quantity": "nonstockable_quantity3" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids0" + ] + }, + "tax_data": { + "name": "name9", + "calculation_phase": "TAX_TOTAL_PHASE", + "inclusion_type": "INCLUSIVE", + "percentage": "percentage7", + "applies_to_custom_amounts": true, + "enabled": true + }, + "discount_data": { + "name": "name7", + "discount_type": "FIXED_AMOUNT", + "percentage": "percentage5", + "amount_money": {}, + "pin_required": true, + "label_color": "label_color9", + "modify_tax_basis": "DO_NOT_MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name1", + "ordinal": 177, + "selection_type": "MULTIPLE", + "modifiers": [ + {} + ], + "image_ids": [ + "image_ids6" + ] + }, + "modifier_data": { + "name": "name7", + "price_money": {}, + "ordinal": 155, + "modifier_list_id": "modifier_list_id3", + "image_id": "image_id1" + }, + "time_period_data": { + "event": "event1" + }, + "product_set_data": { + "name": "name3", + "product_ids_any": [ + "product_ids_any1", + "product_ids_any0" + ], + "product_ids_all": [ + "product_ids_all4", + "product_ids_all3" + ], + "quantity_exact": 241, + "quantity_min": 119, + "quantity_max": 93, + "all_products": true + }, + "pricing_rule_data": { + "name": "name5", + "time_period_ids": [ + "time_period_ids7", + "time_period_ids8" + ], + "discount_id": "discount_id3", + "match_products_id": "match_products_id7", + "apply_products_id": "apply_products_id1", + "exclude_products_id": "exclude_products_id1", + "valid_from_date": "valid_from_date7", + "valid_from_local_time": "valid_from_local_time5", + "valid_until_date": "valid_until_date9", + "valid_until_local_time": "valid_until_local_time9", + "exclude_strategy": "MOST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any4", + "customer_group_ids_any5" + ] + }, + "image_data": { + "name": "name5", + "url": "url9", + "caption": "caption9", + "photo_studio_order_id": "photo_studio_order_id7" + }, + "measurement_unit_data": { + "measurement_unit": {}, + "precision": 39 + }, + "subscription_plan_data": { + "name": "name5", + "phases": [ + { + "uid": "uid0", + "cadence": "ANNUAL", + "periods": 92, + "recurring_price_money": {}, + "ordinal": 58 + } + ] + }, + "item_option_data": { + "name": "name1", + "display_name": "display_name1", + "description": "description9", + "show_colors": true, + "values": [ + {}, + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id7", + "name": "name5", + "description": "description5", + "color": "color9", + "ordinal": 69 + }, + "custom_attribute_definition_data": { + "type": "SELECTION", + "name": "name3", + "description": "description3", + "source_application": { + "product": "ONLINE_STORE", + "application_id": "application_id1", + "name": "name5" + }, + "allowed_object_types": [ + "ITEM_OPTION_VAL" + ], + "seller_visibility": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "app_visibility": "APP_VISIBILITY_READ_WRITE_VALUES", + "string_config": { + "enforce_uniqueness": true + }, + "number_config": { + "precision": 81 + }, + "selection_config": { + "max_allowed_selections": 59, + "allowed_selections": [ + { + "uid": "uid2", + "name": "name2" + }, + { + "uid": "uid3", + "name": "name3" + }, + { + "uid": "uid4", + "name": "name4" + } + ] + }, + "custom_attribute_usage_count": 151, + "key": "key3" + }, + "quick_amounts_settings_data": { + "option": "AUTO", + "eligible_for_auto_amounts": true, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 241, + "ordinal": 173 + }, + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 242, + "ordinal": 174 + } + ] + } + }, + { + "type": "DISCOUNT", + "id": "id4", + "updated_at": "updated_at0", + "version": 92, + "is_deleted": false, + "custom_attribute_values": { + "key0": {}, + "key1": {}, + "key2": {} + }, + "catalog_v1_ids": [ + {}, + {}, + {} + ], + "present_at_all_locations": false, + "present_at_location_ids": [ + "present_at_location_ids4", + "present_at_location_ids5" + ], + "absent_at_location_ids": [ + "absent_at_location_ids5", + "absent_at_location_ids6", + "absent_at_location_ids7" + ], + "item_data": { + "name": "name4", + "description": "description4", + "abbreviation": "abbreviation6", + "label_color": "label_color6", + "available_online": false, + "available_for_pickup": false, + "available_electronically": false, + "category_id": "category_id4", + "tax_ids": [ + "tax_ids7" + ], + "modifier_list_info": [ + {}, + {} + ], + "variations": [ + {}, + {}, + {} + ], + "product_type": "REGULAR", + "skip_modifier_screen": false, + "item_options": [ + { + "item_option_id": "item_option_id7" + } + ], + "image_ids": [ + "image_ids1", + "image_ids0" + ], + "sort_name": "sort_name4", + "description_html": "description_html4", + "description_plaintext": "description_plaintext4" + }, + "category_data": { + "name": "name8", + "image_ids": [ + "image_ids3", + "image_ids4" + ] + }, + "item_variation_data": { + "item_id": "item_id0", + "name": "name0", + "sku": "sku4", + "upc": "upc2", + "ordinal": 142, + "pricing_type": "FIXED_PRICING", + "price_money": {}, + "location_overrides": [ + { + "location_id": "location_id5", + "price_money": {}, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 81, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until9" + }, + { + "location_id": "location_id6", + "price_money": {}, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 82, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until0" + } + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 112, + "user_data": "user_data6", + "service_duration": 232, + "available_for_booking": false, + "item_option_values": [ + { + "item_option_id": "item_option_id1", + "item_option_value_id": "item_option_value_id1" + } + ], + "measurement_unit_id": "measurement_unit_id0", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids5" + ], + "team_member_ids": [ + "team_member_ids7" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id8", + "stockable_quantity": "stockable_quantity0", + "nonstockable_quantity": "nonstockable_quantity2" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids9", + "item_variation_vendor_info_ids0", + "item_variation_vendor_info_ids1" + ] + }, + "tax_data": { + "name": "name8", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "percentage6", + "applies_to_custom_amounts": false, + "enabled": false + }, + "discount_data": { + "name": "name8", + "discount_type": "VARIABLE_PERCENTAGE", + "percentage": "percentage6", + "amount_money": {}, + "pin_required": false, + "label_color": "label_color0", + "modify_tax_basis": "MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name2", + "ordinal": 178, + "selection_type": "SINGLE", + "modifiers": [ + {}, + {} + ], + "image_ids": [ + "image_ids7", + "image_ids6", + "image_ids5" + ] + }, + "modifier_data": { + "name": "name8", + "price_money": {}, + "ordinal": 156, + "modifier_list_id": "modifier_list_id4", + "image_id": "image_id2" + }, + "time_period_data": { + "event": "event2" + }, + "product_set_data": { + "name": "name2", + "product_ids_any": [ + "product_ids_any2" + ], + "product_ids_all": [ + "product_ids_all5" + ], + "quantity_exact": 240, + "quantity_min": 118, + "quantity_max": 92, + "all_products": false + }, + "pricing_rule_data": { + "name": "name6", + "time_period_ids": [ + "time_period_ids8", + "time_period_ids9", + "time_period_ids0" + ], + "discount_id": "discount_id4", + "match_products_id": "match_products_id6", + "apply_products_id": "apply_products_id0", + "exclude_products_id": "exclude_products_id2", + "valid_from_date": "valid_from_date6", + "valid_from_local_time": "valid_from_local_time4", + "valid_until_date": "valid_until_date8", + "valid_until_local_time": "valid_until_local_time8", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any5", + "customer_group_ids_any6", + "customer_group_ids_any7" + ] + }, + "image_data": { + "name": "name4", + "url": "url8", + "caption": "caption8", + "photo_studio_order_id": "photo_studio_order_id6" + }, + "measurement_unit_data": { + "measurement_unit": {}, + "precision": 40 + }, + "subscription_plan_data": { + "name": "name6", + "phases": [ + { + "uid": "uid9", + "cadence": "EVERY_TWO_YEARS", + "periods": 91, + "recurring_price_money": {}, + "ordinal": 57 + }, + { + "uid": "uid8", + "cadence": "DAILY", + "periods": 90, + "recurring_price_money": {}, + "ordinal": 56 + } + ] + }, + "item_option_data": { + "name": "name2", + "display_name": "display_name2", + "description": "description8", + "show_colors": false, + "values": [ + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id6", + "name": "name4", + "description": "description4", + "color": "color8", + "ordinal": 68 + }, + "custom_attribute_definition_data": { + "type": "STRING", + "name": "name2", + "description": "description2", + "source_application": { + "product": "INVOICES", + "application_id": "application_id0", + "name": "name4" + }, + "allowed_object_types": [ + "CUSTOM_ATTRIBUTE_DEFINITION", + "ITEM_OPTION_VAL", + "ITEM_OPTION" + ], + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_READ_ONLY", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 82 + }, + "selection_config": { + "max_allowed_selections": 58, + "allowed_selections": [ + { + "uid": "uid1", + "name": "name1" + }, + { + "uid": "uid2", + "name": "name2" + } + ] + }, + "custom_attribute_usage_count": 150, + "key": "key2" + }, + "quick_amounts_settings_data": { + "option": "MANUAL", + "eligible_for_auto_amounts": false, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 240, + "ordinal": 172 + } + ] + } + }, + { + "type": "MODIFIER_LIST", + "id": "id3", + "updated_at": "updated_at1", + "version": 91, + "is_deleted": true, + "custom_attribute_values": { + "key0": {} + }, + "catalog_v1_ids": [ + {}, + {} + ], + "present_at_all_locations": true, + "present_at_location_ids": [ + "present_at_location_ids3" + ], + "absent_at_location_ids": [ + "absent_at_location_ids4", + "absent_at_location_ids5" + ], + "item_data": { + "name": "name5", + "description": "description5", + "abbreviation": "abbreviation7", + "label_color": "label_color7", + "available_online": true, + "available_for_pickup": true, + "available_electronically": true, + "category_id": "category_id3", + "tax_ids": [ + "tax_ids8", + "tax_ids7", + "tax_ids6" + ], + "modifier_list_info": [ + {}, + {}, + {} + ], + "variations": [ + {}, + {} + ], + "product_type": "GIFT_CARD", + "skip_modifier_screen": true, + "item_options": [ + { + "item_option_id": "item_option_id6" + }, + { + "item_option_id": "item_option_id5" + } + ], + "image_ids": [ + "image_ids0", + "image_ids9", + "image_ids8" + ], + "sort_name": "sort_name3", + "description_html": "description_html5", + "description_plaintext": "description_plaintext5" + }, + "category_data": { + "name": "name7", + "image_ids": [ + "image_ids2" + ] + }, + "item_variation_data": { + "item_id": "item_id1", + "name": "name9", + "sku": "sku5", + "upc": "upc3", + "ordinal": 141, + "pricing_type": "VARIABLE_PRICING", + "price_money": {}, + "location_overrides": [ + { + "location_id": "location_id4", + "price_money": {}, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 80, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until8" + } + ], + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 113, + "user_data": "user_data7", + "service_duration": 231, + "available_for_booking": true, + "item_option_values": [ + { + "item_option_id": "item_option_id2", + "item_option_value_id": "item_option_value_id0" + }, + { + "item_option_id": "item_option_id3", + "item_option_value_id": "item_option_value_id9" + } + ], + "measurement_unit_id": "measurement_unit_id1", + "sellable": true, + "stockable": true, + "image_ids": [ + "image_ids4", + "image_ids3" + ], + "team_member_ids": [ + "team_member_ids6", + "team_member_ids7", + "team_member_ids8" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id7", + "stockable_quantity": "stockable_quantity9", + "nonstockable_quantity": "nonstockable_quantity1" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids8", + "item_variation_vendor_info_ids9" + ] + }, + "tax_data": { + "name": "name7", + "calculation_phase": "TAX_TOTAL_PHASE", + "inclusion_type": "INCLUSIVE", + "percentage": "percentage5", + "applies_to_custom_amounts": true, + "enabled": true + }, + "discount_data": { + "name": "name9", + "discount_type": "VARIABLE_AMOUNT", + "percentage": "percentage7", + "amount_money": {}, + "pin_required": true, + "label_color": "label_color1", + "modify_tax_basis": "DO_NOT_MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name3", + "ordinal": 179, + "selection_type": "MULTIPLE", + "modifiers": [ + {}, + {}, + {} + ], + "image_ids": [ + "image_ids8", + "image_ids7" + ] + }, + "modifier_data": { + "name": "name9", + "price_money": {}, + "ordinal": 157, + "modifier_list_id": "modifier_list_id5", + "image_id": "image_id3" + }, + "time_period_data": { + "event": "event3" + }, + "product_set_data": { + "name": "name1", + "product_ids_any": [ + "product_ids_any3", + "product_ids_any2", + "product_ids_any1" + ], + "product_ids_all": [ + "product_ids_all6", + "product_ids_all5", + "product_ids_all4" + ], + "quantity_exact": 239, + "quantity_min": 117, + "quantity_max": 91, + "all_products": true + }, + "pricing_rule_data": { + "name": "name7", + "time_period_ids": [ + "time_period_ids9" + ], + "discount_id": "discount_id5", + "match_products_id": "match_products_id5", + "apply_products_id": "apply_products_id9", + "exclude_products_id": "exclude_products_id3", + "valid_from_date": "valid_from_date5", + "valid_from_local_time": "valid_from_local_time3", + "valid_until_date": "valid_until_date7", + "valid_until_local_time": "valid_until_local_time7", + "exclude_strategy": "MOST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any6" + ] + }, + "image_data": { + "name": "name3", + "url": "url7", + "caption": "caption7", + "photo_studio_order_id": "photo_studio_order_id5" + }, + "measurement_unit_data": { + "measurement_unit": {}, + "precision": 41 + }, + "subscription_plan_data": { + "name": "name7", + "phases": [ + { + "uid": "uid8", + "cadence": "DAILY", + "periods": 90, + "recurring_price_money": {}, + "ordinal": 56 + }, + { + "uid": "uid7", + "cadence": "WEEKLY", + "periods": 89, + "recurring_price_money": {}, + "ordinal": 55 + }, + { + "uid": "uid6", + "cadence": "EVERY_TWO_WEEKS", + "periods": 88, + "recurring_price_money": {}, + "ordinal": 54 + } + ] + }, + "item_option_data": { + "name": "name3", + "display_name": "display_name3", + "description": "description7", + "show_colors": true, + "values": [ + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id5", + "name": "name3", + "description": "description3", + "color": "color7", + "ordinal": 67 + }, + "custom_attribute_definition_data": { + "type": "BOOLEAN", + "name": "name1", + "description": "description1", + "source_application": { + "product": "APPOINTMENTS", + "application_id": "application_id9", + "name": "name3" + }, + "allowed_object_types": [ + "QUICK_AMOUNTS_SETTINGS", + "CUSTOM_ATTRIBUTE_DEFINITION" + ], + "seller_visibility": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "app_visibility": "APP_VISIBILITY_HIDDEN", + "string_config": { + "enforce_uniqueness": true + }, + "number_config": { + "precision": 83 + }, + "selection_config": { + "max_allowed_selections": 57, + "allowed_selections": [ + { + "uid": "uid0", + "name": "name0" + } + ] + }, + "custom_attribute_usage_count": 149, + "key": "key1" + }, + "quick_amounts_settings_data": { + "option": "DISABLED", + "eligible_for_auto_amounts": true, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 239, + "ordinal": 171 + }, + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 240, + "ordinal": 172 + }, + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 241, + "ordinal": 173 + } + ] + } + } + ], + "product_type": "REGULAR", + "skip_modifier_screen": false, + "item_options": [ + {} + ], + "image_ids": [ + "image_ids3", + "image_ids2" + ], + "sort_name": "sort_name6", + "description_html": "description_html2", + "description_plaintext": "description_plaintext2" + }, + "category_data": { + "name": "name4", + "image_ids": [ + "image_ids9", + "image_ids0" + ] + }, + "item_variation_data": { + "item_id": "item_id6", + "name": "name6", + "sku": "sku2", + "upc": "upc4", + "ordinal": 222, + "pricing_type": "FIXED_PRICING", + "price_money": {}, + "location_overrides": [ + {}, + {} + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 224, + "user_data": "user_data0", + "service_duration": 56, + "available_for_booking": false, + "item_option_values": [ + {} + ], + "measurement_unit_id": "measurement_unit_id6", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids1" + ], + "team_member_ids": [ + "team_member_ids3" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id4", + "stockable_quantity": "stockable_quantity6", + "nonstockable_quantity": "nonstockable_quantity8" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids5", + "item_variation_vendor_info_ids6", + "item_variation_vendor_info_ids7" + ] + }, + "tax_data": { + "name": "name4", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "percentage2", + "applies_to_custom_amounts": false, + "enabled": false + }, + "discount_data": { + "name": "name8", + "discount_type": "VARIABLE_PERCENTAGE", + "percentage": "percentage6", + "amount_money": {}, + "pin_required": false, + "label_color": "label_color0", + "modify_tax_basis": "MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name4", + "ordinal": 62, + "selection_type": "SINGLE", + "modifiers": [ + {}, + {} + ], + "image_ids": [ + "image_ids9", + "image_ids0" + ] + }, + "modifier_data": { + "name": "name8", + "price_money": {}, + "ordinal": 84, + "modifier_list_id": "modifier_list_id4", + "image_id": "image_id2" + }, + "time_period_data": { + "event": "event4" + }, + "product_set_data": { + "name": "name8", + "product_ids_any": [ + "product_ids_any4" + ], + "product_ids_all": [ + "product_ids_all1" + ], + "quantity_exact": 64, + "quantity_min": 198, + "quantity_max": 172, + "all_products": false + }, + "pricing_rule_data": { + "name": "name0", + "time_period_ids": [ + "time_period_ids2", + "time_period_ids3", + "time_period_ids4" + ], + "discount_id": "discount_id8", + "match_products_id": "match_products_id8", + "apply_products_id": "apply_products_id4", + "exclude_products_id": "exclude_products_id6", + "valid_from_date": "valid_from_date8", + "valid_from_local_time": "valid_from_local_time0", + "valid_until_date": "valid_until_date6", + "valid_until_local_time": "valid_until_local_time6", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any9", + "customer_group_ids_any0", + "customer_group_ids_any1" + ] + }, + "image_data": { + "name": "name0", + "url": "url4", + "caption": "caption4", + "photo_studio_order_id": "photo_studio_order_id2" + }, + "measurement_unit_data": { + "measurement_unit": {}, + "precision": 176 + }, + "subscription_plan_data": { + "name": "name0", + "phases": [ + {} + ] + }, + "item_option_data": { + "name": "name4", + "display_name": "display_name4", + "description": "description4", + "show_colors": false, + "values": [ + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id2", + "name": "name0", + "description": "description0", + "color": "color4", + "ordinal": 148 + }, + "custom_attribute_definition_data": { + "type": "STRING", + "name": "name8", + "description": "description8", + "source_application": { + "product": "SQUARE_POS", + "application_id": "application_id6", + "name": "name0" + }, + "allowed_object_types": [ + "ITEM_OPTION", + "ITEM_OPTION_VAL", + "CUSTOM_ATTRIBUTE_DEFINITION" + ], + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_READ_ONLY", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 134 + }, + "selection_config": { + "max_allowed_selections": 138, + "allowed_selections": [ + {}, + {} + ] + }, + "custom_attribute_usage_count": 230, + "key": "key8" + }, + "quick_amounts_settings_data": { + "option": "MANUAL", + "eligible_for_auto_amounts": false, + "amounts": [ + {} + ] + } + }, + { + "type": "DISCOUNT", + "id": "id1", + "updated_at": "updated_at7", + "version": 173, + "is_deleted": true, + "custom_attribute_values": { + "key0": { + "name": "name4", + "string_value": "string_value8", + "custom_attribute_definition_id": "custom_attribute_definition_id8", + "type": "STRING", + "number_value": "number_value4", + "boolean_value": false, + "selection_uid_values": [ + "selection_uid_values1", + "selection_uid_values2", + "selection_uid_values3" + ], + "key": "key4" + }, + "key1": { + "name": "name5", + "string_value": "string_value9", + "custom_attribute_definition_id": "custom_attribute_definition_id7", + "type": "SELECTION", + "number_value": "number_value5", + "boolean_value": true, + "selection_uid_values": [ + "selection_uid_values2" + ], + "key": "key5" + }, + "key2": { + "name": "name6", + "string_value": "string_value0", + "custom_attribute_definition_id": "custom_attribute_definition_id6", + "type": "NUMBER", + "number_value": "number_value6", + "boolean_value": false, + "selection_uid_values": [ + "selection_uid_values3", + "selection_uid_values4" + ], + "key": "key6" + } + }, + "catalog_v1_ids": [ + { + "catalog_v1_id": "catalog_v1_id5", + "location_id": "location_id5" + } + ], + "present_at_all_locations": true, + "present_at_location_ids": [ + "present_at_location_ids1", + "present_at_location_ids2", + "present_at_location_ids3" + ], + "absent_at_location_ids": [ + "absent_at_location_ids2" + ], + "item_data": { + "name": "name3", + "description": "description3", + "abbreviation": "abbreviation5", + "label_color": "label_color5", + "available_online": true, + "available_for_pickup": true, + "available_electronically": true, + "category_id": "category_id5", + "tax_ids": [ + "tax_ids6", + "tax_ids5", + "tax_ids4" + ], + "modifier_list_info": [ + { + "modifier_list_id": "modifier_list_id3", + "modifier_overrides": [ + { + "modifier_id": "modifier_id6", + "on_by_default": false + }, + { + "modifier_id": "modifier_id7", + "on_by_default": true + } + ], + "min_selected_modifiers": 189, + "max_selected_modifiers": 169, + "enabled": true + }, + { + "modifier_list_id": "modifier_list_id4", + "modifier_overrides": [ + { + "modifier_id": "modifier_id7", + "on_by_default": true + }, + { + "modifier_id": "modifier_id8", + "on_by_default": false + }, + { + "modifier_id": "modifier_id9", + "on_by_default": true + } + ], + "min_selected_modifiers": 190, + "max_selected_modifiers": 170, + "enabled": false + }, + { + "modifier_list_id": "modifier_list_id5", + "modifier_overrides": [ + { + "modifier_id": "modifier_id8", + "on_by_default": false + } + ], + "min_selected_modifiers": 191, + "max_selected_modifiers": 171, + "enabled": true + } + ], + "variations": [ + { + "type": "ITEM_VARIATION", + "id": "id6", + "updated_at": "updated_at8", + "version": 94, + "is_deleted": false, + "custom_attribute_values": { + "key0": {} + }, + "catalog_v1_ids": [ + {}, + {} + ], + "present_at_all_locations": false, + "present_at_location_ids": [ + "present_at_location_ids6" + ], + "absent_at_location_ids": [ + "absent_at_location_ids7", + "absent_at_location_ids8" + ], + "item_data": { + "name": "name2", + "description": "description2", + "abbreviation": "abbreviation4", + "label_color": "label_color4", + "available_online": false, + "available_for_pickup": false, + "available_electronically": false, + "category_id": "category_id6", + "tax_ids": [ + "tax_ids5", + "tax_ids4", + "tax_ids3" + ], + "modifier_list_info": [ + {}, + {}, + {} + ], + "variations": [ + {}, + {} + ], + "product_type": "GIFT_CARD", + "skip_modifier_screen": false, + "item_options": [ + { + "item_option_id": "item_option_id9" + }, + { + "item_option_id": "item_option_id8" + } + ], + "image_ids": [ + "image_ids3", + "image_ids2", + "image_ids1" + ], + "sort_name": "sort_name6", + "description_html": "description_html2", + "description_plaintext": "description_plaintext2" + }, + "category_data": { + "name": "name0", + "image_ids": [ + "image_ids5" + ] + }, + "item_variation_data": { + "item_id": "item_id8", + "name": "name2", + "sku": "sku2", + "upc": "upc0", + "ordinal": 144, + "pricing_type": "FIXED_PRICING", + "price_money": {}, + "location_overrides": [ + { + "location_id": "location_id7", + "price_money": {}, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 83, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until1" + } + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 110, + "user_data": "user_data4", + "service_duration": 234, + "available_for_booking": false, + "item_option_values": [ + { + "item_option_id": "item_option_id9", + "item_option_value_id": "item_option_value_id3" + }, + { + "item_option_id": "item_option_id0", + "item_option_value_id": "item_option_value_id2" + } + ], + "measurement_unit_id": "measurement_unit_id8", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids7", + "image_ids6" + ], + "team_member_ids": [ + "team_member_ids9", + "team_member_ids0", + "team_member_ids1" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id0", + "stockable_quantity": "stockable_quantity2", + "nonstockable_quantity": "nonstockable_quantity4" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids1", + "item_variation_vendor_info_ids2" + ] + }, + "tax_data": { + "name": "name0", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "percentage8", + "applies_to_custom_amounts": false, + "enabled": false + }, + "discount_data": { + "name": "name6", + "discount_type": "FIXED_PERCENTAGE", + "percentage": "percentage4", + "amount_money": {}, + "pin_required": false, + "label_color": "label_color8", + "modify_tax_basis": "MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name0", + "ordinal": 176, + "selection_type": "SINGLE", + "modifiers": [ + {}, + {}, + {} + ], + "image_ids": [ + "image_ids5", + "image_ids4" + ] + }, + "modifier_data": { + "name": "name6", + "price_money": {}, + "ordinal": 154, + "modifier_list_id": "modifier_list_id2", + "image_id": "image_id0" + }, + "time_period_data": { + "event": "event0" + }, + "product_set_data": { + "name": "name4", + "product_ids_any": [ + "product_ids_any0", + "product_ids_any9", + "product_ids_any8" + ], + "product_ids_all": [ + "product_ids_all3", + "product_ids_all2", + "product_ids_all1" + ], + "quantity_exact": 242, + "quantity_min": 120, + "quantity_max": 94, + "all_products": false + }, + "pricing_rule_data": { + "name": "name4", + "time_period_ids": [ + "time_period_ids6" + ], + "discount_id": "discount_id2", + "match_products_id": "match_products_id8", + "apply_products_id": "apply_products_id2", + "exclude_products_id": "exclude_products_id0", + "valid_from_date": "valid_from_date8", + "valid_from_local_time": "valid_from_local_time6", + "valid_until_date": "valid_until_date0", + "valid_until_local_time": "valid_until_local_time0", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any3" + ] + }, + "image_data": { + "name": "name6", + "url": "url0", + "caption": "caption0", + "photo_studio_order_id": "photo_studio_order_id8" + }, + "measurement_unit_data": { + "measurement_unit": {}, + "precision": 38 + }, + "subscription_plan_data": { + "name": "name4", + "phases": [ + { + "uid": "uid1", + "cadence": "EVERY_SIX_MONTHS", + "periods": 93, + "recurring_price_money": {}, + "ordinal": 59 + }, + { + "uid": "uid0", + "cadence": "ANNUAL", + "periods": 92, + "recurring_price_money": {}, + "ordinal": 58 + }, + { + "uid": "uid9", + "cadence": "EVERY_TWO_YEARS", + "periods": 91, + "recurring_price_money": {}, + "ordinal": 57 + } + ] + }, + "item_option_data": { + "name": "name0", + "display_name": "display_name0", + "description": "description0", + "show_colors": false, + "values": [ + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id8", + "name": "name6", + "description": "description6", + "color": "color0", + "ordinal": 70 + }, + "custom_attribute_definition_data": { + "type": "NUMBER", + "name": "name4", + "description": "description4", + "source_application": { + "product": "PAYROLL", + "application_id": "application_id2", + "name": "name6" + }, + "allowed_object_types": [ + "ITEM_OPTION", + "MEASUREMENT_UNIT" + ], + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_HIDDEN", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 80 + }, + "selection_config": { + "max_allowed_selections": 60, + "allowed_selections": [ + { + "uid": "uid3", + "name": "name3" + } + ] + }, + "custom_attribute_usage_count": 152, + "key": "key4" + }, + "quick_amounts_settings_data": { + "option": "DISABLED", + "eligible_for_auto_amounts": false, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 242, + "ordinal": 174 + }, + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 243, + "ordinal": 175 + }, + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 244, + "ordinal": 176 + } + ] + } + }, + { + "type": "TAX", + "id": "id5", + "updated_at": "updated_at9", + "version": 93, + "is_deleted": true, + "custom_attribute_values": { + "key0": {}, + "key1": {} + }, + "catalog_v1_ids": [ + {} + ], + "present_at_all_locations": true, + "present_at_location_ids": [ + "present_at_location_ids5", + "present_at_location_ids6", + "present_at_location_ids7" + ], + "absent_at_location_ids": [ + "absent_at_location_ids6" + ], + "item_data": { + "name": "name3", + "description": "description3", + "abbreviation": "abbreviation5", + "label_color": "label_color5", + "available_online": true, + "available_for_pickup": true, + "available_electronically": true, + "category_id": "category_id5", + "tax_ids": [ + "tax_ids6", + "tax_ids5" + ], + "modifier_list_info": [ + {} + ], + "variations": [ + {} + ], + "product_type": "APPOINTMENTS_SERVICE", + "skip_modifier_screen": true, + "item_options": [ + { + "item_option_id": "item_option_id8" + }, + { + "item_option_id": "item_option_id7" + }, + { + "item_option_id": "item_option_id6" + } + ], + "image_ids": [ + "image_ids2" + ], + "sort_name": "sort_name5", + "description_html": "description_html3", + "description_plaintext": "description_plaintext3" + }, + "category_data": { + "name": "name9", + "image_ids": [ + "image_ids4", + "image_ids5", + "image_ids6" + ] + }, + "item_variation_data": { + "item_id": "item_id9", + "name": "name1", + "sku": "sku3", + "upc": "upc1", + "ordinal": 143, + "pricing_type": "VARIABLE_PRICING", + "price_money": {}, + "location_overrides": [ + { + "location_id": "location_id6", + "price_money": {}, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 82, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until0" + }, + { + "location_id": "location_id7", + "price_money": {}, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 83, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until1" + }, + { + "location_id": "location_id8", + "price_money": {}, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 84, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until2" + } + ], + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 111, + "user_data": "user_data5", + "service_duration": 233, + "available_for_booking": true, + "item_option_values": [ + { + "item_option_id": "item_option_id0", + "item_option_value_id": "item_option_value_id2" + }, + { + "item_option_id": "item_option_id1", + "item_option_value_id": "item_option_value_id1" + }, + { + "item_option_id": "item_option_id2", + "item_option_value_id": "item_option_value_id0" + } + ], + "measurement_unit_id": "measurement_unit_id9", + "sellable": true, + "stockable": true, + "image_ids": [ + "image_ids6", + "image_ids5", + "image_ids4" + ], + "team_member_ids": [ + "team_member_ids8", + "team_member_ids9" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id9", + "stockable_quantity": "stockable_quantity1", + "nonstockable_quantity": "nonstockable_quantity3" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids0" + ] + }, + "tax_data": { + "name": "name9", + "calculation_phase": "TAX_TOTAL_PHASE", + "inclusion_type": "INCLUSIVE", + "percentage": "percentage7", + "applies_to_custom_amounts": true, + "enabled": true + }, + "discount_data": { + "name": "name7", + "discount_type": "FIXED_AMOUNT", + "percentage": "percentage5", + "amount_money": {}, + "pin_required": true, + "label_color": "label_color9", + "modify_tax_basis": "DO_NOT_MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name1", + "ordinal": 177, + "selection_type": "MULTIPLE", + "modifiers": [ + {} + ], + "image_ids": [ + "image_ids6" + ] + }, + "modifier_data": { + "name": "name7", + "price_money": {}, + "ordinal": 155, + "modifier_list_id": "modifier_list_id3", + "image_id": "image_id1" + }, + "time_period_data": { + "event": "event1" + }, + "product_set_data": { + "name": "name3", + "product_ids_any": [ + "product_ids_any1", + "product_ids_any0" + ], + "product_ids_all": [ + "product_ids_all4", + "product_ids_all3" + ], + "quantity_exact": 241, + "quantity_min": 119, + "quantity_max": 93, + "all_products": true + }, + "pricing_rule_data": { + "name": "name5", + "time_period_ids": [ + "time_period_ids7", + "time_period_ids8" + ], + "discount_id": "discount_id3", + "match_products_id": "match_products_id7", + "apply_products_id": "apply_products_id1", + "exclude_products_id": "exclude_products_id1", + "valid_from_date": "valid_from_date7", + "valid_from_local_time": "valid_from_local_time5", + "valid_until_date": "valid_until_date9", + "valid_until_local_time": "valid_until_local_time9", + "exclude_strategy": "MOST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any4", + "customer_group_ids_any5" + ] + }, + "image_data": { + "name": "name5", + "url": "url9", + "caption": "caption9", + "photo_studio_order_id": "photo_studio_order_id7" + }, + "measurement_unit_data": { + "measurement_unit": {}, + "precision": 39 + }, + "subscription_plan_data": { + "name": "name5", + "phases": [ + { + "uid": "uid0", + "cadence": "ANNUAL", + "periods": 92, + "recurring_price_money": {}, + "ordinal": 58 + } + ] + }, + "item_option_data": { + "name": "name1", + "display_name": "display_name1", + "description": "description9", + "show_colors": true, + "values": [ + {}, + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id7", + "name": "name5", + "description": "description5", + "color": "color9", + "ordinal": 69 + }, + "custom_attribute_definition_data": { + "type": "SELECTION", + "name": "name3", + "description": "description3", + "source_application": { + "product": "ONLINE_STORE", + "application_id": "application_id1", + "name": "name5" + }, + "allowed_object_types": [ + "ITEM_OPTION_VAL" + ], + "seller_visibility": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "app_visibility": "APP_VISIBILITY_READ_WRITE_VALUES", + "string_config": { + "enforce_uniqueness": true + }, + "number_config": { + "precision": 81 + }, + "selection_config": { + "max_allowed_selections": 59, + "allowed_selections": [ + { + "uid": "uid2", + "name": "name2" + }, + { + "uid": "uid3", + "name": "name3" + }, + { + "uid": "uid4", + "name": "name4" + } + ] + }, + "custom_attribute_usage_count": 151, + "key": "key3" + }, + "quick_amounts_settings_data": { + "option": "AUTO", + "eligible_for_auto_amounts": true, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 241, + "ordinal": 173 + }, + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 242, + "ordinal": 174 + } + ] + } + } + ], + "product_type": "GIFT_CARD", + "skip_modifier_screen": true, + "item_options": [ + {}, + {} + ], + "image_ids": [ + "image_ids2", + "image_ids1", + "image_ids0" + ], + "sort_name": "sort_name5", + "description_html": "description_html3", + "description_plaintext": "description_plaintext3" + }, + "category_data": { + "name": "name5", + "image_ids": [ + "image_ids0", + "image_ids1", + "image_ids2" + ] + }, + "item_variation_data": { + "item_id": "item_id7", + "name": "name7", + "sku": "sku3", + "upc": "upc5", + "ordinal": 223, + "pricing_type": "VARIABLE_PRICING", + "price_money": {}, + "location_overrides": [ + {}, + {}, + {} + ], + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 225, + "user_data": "user_data1", + "service_duration": 57, + "available_for_booking": true, + "item_option_values": [ + {}, + {} + ], + "measurement_unit_id": "measurement_unit_id7", + "sellable": true, + "stockable": true, + "image_ids": [ + "image_ids2", + "image_ids3" + ], + "team_member_ids": [ + "team_member_ids4", + "team_member_ids5" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id5", + "stockable_quantity": "stockable_quantity7", + "nonstockable_quantity": "nonstockable_quantity9" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids6" + ] + }, + "tax_data": { + "name": "name5", + "calculation_phase": "TAX_TOTAL_PHASE", + "inclusion_type": "INCLUSIVE", + "percentage": "percentage3", + "applies_to_custom_amounts": true, + "enabled": true + }, + "discount_data": { + "name": "name9", + "discount_type": "VARIABLE_AMOUNT", + "percentage": "percentage7", + "amount_money": {}, + "pin_required": true, + "label_color": "label_color1", + "modify_tax_basis": "DO_NOT_MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name5", + "ordinal": 63, + "selection_type": "MULTIPLE", + "modifiers": [ + {}, + {}, + {} + ], + "image_ids": [ + "image_ids0", + "image_ids1", + "image_ids2" + ] + }, + "modifier_data": { + "name": "name9", + "price_money": {}, + "ordinal": 85, + "modifier_list_id": "modifier_list_id5", + "image_id": "image_id3" + }, + "time_period_data": { + "event": "event5" + }, + "product_set_data": { + "name": "name9", + "product_ids_any": [ + "product_ids_any5", + "product_ids_any6" + ], + "product_ids_all": [ + "product_ids_all2", + "product_ids_all3" + ], + "quantity_exact": 65, + "quantity_min": 199, + "quantity_max": 173, + "all_products": true + }, + "pricing_rule_data": { + "name": "name1", + "time_period_ids": [ + "time_period_ids3" + ], + "discount_id": "discount_id9", + "match_products_id": "match_products_id9", + "apply_products_id": "apply_products_id5", + "exclude_products_id": "exclude_products_id7", + "valid_from_date": "valid_from_date9", + "valid_from_local_time": "valid_from_local_time1", + "valid_until_date": "valid_until_date7", + "valid_until_local_time": "valid_until_local_time7", + "exclude_strategy": "MOST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any0" + ] + }, + "image_data": { + "name": "name1", + "url": "url5", + "caption": "caption5", + "photo_studio_order_id": "photo_studio_order_id3" + }, + "measurement_unit_data": { + "measurement_unit": {}, + "precision": 177 + }, + "subscription_plan_data": { + "name": "name1", + "phases": [ + {}, + {}, + {} + ] + }, + "item_option_data": { + "name": "name5", + "display_name": "display_name5", + "description": "description5", + "show_colors": true, + "values": [ + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id3", + "name": "name1", + "description": "description1", + "color": "color5", + "ordinal": 149 + }, + "custom_attribute_definition_data": { + "type": "BOOLEAN", + "name": "name9", + "description": "description9", + "source_application": { + "product": "EXTERNAL_API", + "application_id": "application_id7", + "name": "name1" + }, + "allowed_object_types": [ + "ITEM_OPTION_VAL" + ], + "seller_visibility": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "app_visibility": "APP_VISIBILITY_READ_WRITE_VALUES", + "string_config": { + "enforce_uniqueness": true + }, + "number_config": { + "precision": 135 + }, + "selection_config": { + "max_allowed_selections": 139, + "allowed_selections": [ + {}, + {}, + {} + ] + }, + "custom_attribute_usage_count": 231, + "key": "key9" + }, + "quick_amounts_settings_data": { + "option": "AUTO", + "eligible_for_auto_amounts": true, + "amounts": [ + {}, + {} + ] + } + }, + { + "type": "MODIFIER_LIST", + "id": "id2", + "updated_at": "updated_at8", + "version": 174, + "is_deleted": false, + "custom_attribute_values": { + "key0": { + "name": "name5", + "string_value": "string_value9", + "custom_attribute_definition_id": "custom_attribute_definition_id7", + "type": "SELECTION", + "number_value": "number_value5", + "boolean_value": true, + "selection_uid_values": [ + "selection_uid_values2" + ], + "key": "key5" + } + }, + "catalog_v1_ids": [ + { + "catalog_v1_id": "catalog_v1_id6", + "location_id": "location_id6" + }, + { + "catalog_v1_id": "catalog_v1_id7", + "location_id": "location_id7" + } + ], + "present_at_all_locations": false, + "present_at_location_ids": [ + "present_at_location_ids2" + ], + "absent_at_location_ids": [ + "absent_at_location_ids3", + "absent_at_location_ids4" + ], + "item_data": { + "name": "name4", + "description": "description4", + "abbreviation": "abbreviation6", + "label_color": "label_color6", + "available_online": false, + "available_for_pickup": false, + "available_electronically": false, + "category_id": "category_id4", + "tax_ids": [ + "tax_ids7", + "tax_ids6" + ], + "modifier_list_info": [ + { + "modifier_list_id": "modifier_list_id4", + "modifier_overrides": [ + { + "modifier_id": "modifier_id7", + "on_by_default": true + }, + { + "modifier_id": "modifier_id8", + "on_by_default": false + }, + { + "modifier_id": "modifier_id9", + "on_by_default": true + } + ], + "min_selected_modifiers": 190, + "max_selected_modifiers": 170, + "enabled": false + } + ], + "variations": [ + { + "type": "CATEGORY", + "id": "id7", + "updated_at": "updated_at7", + "version": 95, + "is_deleted": true, + "custom_attribute_values": { + "key0": {}, + "key1": {}, + "key2": {} + }, + "catalog_v1_ids": [ + {}, + {}, + {} + ], + "present_at_all_locations": true, + "present_at_location_ids": [ + "present_at_location_ids7", + "present_at_location_ids8" + ], + "absent_at_location_ids": [ + "absent_at_location_ids8", + "absent_at_location_ids9", + "absent_at_location_ids0" + ], + "item_data": { + "name": "name1", + "description": "description1", + "abbreviation": "abbreviation3", + "label_color": "label_color3", + "available_online": true, + "available_for_pickup": true, + "available_electronically": true, + "category_id": "category_id7", + "tax_ids": [ + "tax_ids4" + ], + "modifier_list_info": [ + {}, + {} + ], + "variations": [ + {}, + {}, + {} + ], + "product_type": "REGULAR", + "skip_modifier_screen": true, + "item_options": [ + { + "item_option_id": "item_option_id0" + } + ], + "image_ids": [ + "image_ids4", + "image_ids3" + ], + "sort_name": "sort_name7", + "description_html": "description_html1", + "description_plaintext": "description_plaintext1" + }, + "category_data": { + "name": "name1", + "image_ids": [ + "image_ids6", + "image_ids7" + ] + }, + "item_variation_data": { + "item_id": "item_id7", + "name": "name3", + "sku": "sku1", + "upc": "upc9", + "ordinal": 145, + "pricing_type": "VARIABLE_PRICING", + "price_money": {}, + "location_overrides": [ + { + "location_id": "location_id8", + "price_money": {}, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 84, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until2" + }, + { + "location_id": "location_id9", + "price_money": {}, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 85, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until3" + } + ], + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 109, + "user_data": "user_data3", + "service_duration": 235, + "available_for_booking": true, + "item_option_values": [ + { + "item_option_id": "item_option_id8", + "item_option_value_id": "item_option_value_id4" + } + ], + "measurement_unit_id": "measurement_unit_id7", + "sellable": true, + "stockable": true, + "image_ids": [ + "image_ids8" + ], + "team_member_ids": [ + "team_member_ids0" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id1", + "stockable_quantity": "stockable_quantity3", + "nonstockable_quantity": "nonstockable_quantity5" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids2", + "item_variation_vendor_info_ids3", + "item_variation_vendor_info_ids4" + ] + }, + "tax_data": { + "name": "name1", + "calculation_phase": "TAX_TOTAL_PHASE", + "inclusion_type": "INCLUSIVE", + "percentage": "percentage9", + "applies_to_custom_amounts": true, + "enabled": true + }, + "discount_data": { + "name": "name5", + "discount_type": "VARIABLE_AMOUNT", + "percentage": "percentage3", + "amount_money": {}, + "pin_required": true, + "label_color": "label_color7", + "modify_tax_basis": "DO_NOT_MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name9", + "ordinal": 175, + "selection_type": "MULTIPLE", + "modifiers": [ + {}, + {} + ], + "image_ids": [ + "image_ids4", + "image_ids3", + "image_ids2" + ] + }, + "modifier_data": { + "name": "name5", + "price_money": {}, + "ordinal": 153, + "modifier_list_id": "modifier_list_id1", + "image_id": "image_id9" + }, + "time_period_data": { + "event": "event9" + }, + "product_set_data": { + "name": "name5", + "product_ids_any": [ + "product_ids_any9" + ], + "product_ids_all": [ + "product_ids_all2" + ], + "quantity_exact": 243, + "quantity_min": 121, + "quantity_max": 95, + "all_products": true + }, + "pricing_rule_data": { + "name": "name3", + "time_period_ids": [ + "time_period_ids5", + "time_period_ids6", + "time_period_ids7" + ], + "discount_id": "discount_id1", + "match_products_id": "match_products_id9", + "apply_products_id": "apply_products_id3", + "exclude_products_id": "exclude_products_id9", + "valid_from_date": "valid_from_date9", + "valid_from_local_time": "valid_from_local_time7", + "valid_until_date": "valid_until_date1", + "valid_until_local_time": "valid_until_local_time1", + "exclude_strategy": "MOST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any2", + "customer_group_ids_any3", + "customer_group_ids_any4" + ] + }, + "image_data": { + "name": "name7", + "url": "url1", + "caption": "caption1", + "photo_studio_order_id": "photo_studio_order_id9" + }, + "measurement_unit_data": { + "measurement_unit": {}, + "precision": 37 + }, + "subscription_plan_data": { + "name": "name3", + "phases": [ + { + "uid": "uid2", + "cadence": "EVERY_FOUR_MONTHS", + "periods": 94, + "recurring_price_money": {}, + "ordinal": 60 + }, + { + "uid": "uid1", + "cadence": "EVERY_SIX_MONTHS", + "periods": 93, + "recurring_price_money": {}, + "ordinal": 59 + } + ] + }, + "item_option_data": { + "name": "name9", + "display_name": "display_name9", + "description": "description1", + "show_colors": true, + "values": [ + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id9", + "name": "name7", + "description": "description7", + "color": "color1", + "ordinal": 71 + }, + "custom_attribute_definition_data": { + "type": "BOOLEAN", + "name": "name5", + "description": "description5", + "source_application": { + "product": "DASHBOARD", + "application_id": "application_id3", + "name": "name7" + }, + "allowed_object_types": [ + "MEASUREMENT_UNIT", + "TIME_PERIOD", + "PRODUCT_SET" + ], + "seller_visibility": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "app_visibility": "APP_VISIBILITY_READ_ONLY", + "string_config": { + "enforce_uniqueness": true + }, + "number_config": { + "precision": 79 + }, + "selection_config": { + "max_allowed_selections": 61, + "allowed_selections": [ + { + "uid": "uid4", + "name": "name4" + }, + { + "uid": "uid5", + "name": "name5" + } + ] + }, + "custom_attribute_usage_count": 153, + "key": "key5" + }, + "quick_amounts_settings_data": { + "option": "MANUAL", + "eligible_for_auto_amounts": true, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 243, + "ordinal": 175 + } + ] + } + } + ], + "product_type": "APPOINTMENTS_SERVICE", + "skip_modifier_screen": false, + "item_options": [ + {}, + {}, + {} + ], + "image_ids": [ + "image_ids1" + ], + "sort_name": "sort_name4", + "description_html": "description_html4", + "description_plaintext": "description_plaintext4" + }, + "category_data": { + "name": "name6", + "image_ids": [ + "image_ids1" + ] + }, + "item_variation_data": { + "item_id": "item_id8", + "name": "name8", + "sku": "sku4", + "upc": "upc6", + "ordinal": 224, + "pricing_type": "FIXED_PRICING", + "price_money": {}, + "location_overrides": [ + {} + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 226, + "user_data": "user_data2", + "service_duration": 58, + "available_for_booking": false, + "item_option_values": [ + {}, + {}, + {} + ], + "measurement_unit_id": "measurement_unit_id8", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids3", + "image_ids4", + "image_ids5" + ], + "team_member_ids": [ + "team_member_ids5", + "team_member_ids6", + "team_member_ids7" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id6", + "stockable_quantity": "stockable_quantity8", + "nonstockable_quantity": "nonstockable_quantity0" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids7", + "item_variation_vendor_info_ids8" + ] + }, + "tax_data": { + "name": "name6", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "percentage4", + "applies_to_custom_amounts": false, + "enabled": false + }, + "discount_data": { + "name": "name0", + "discount_type": "FIXED_PERCENTAGE", + "percentage": "percentage8", + "amount_money": {}, + "pin_required": false, + "label_color": "label_color2", + "modify_tax_basis": "MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name6", + "ordinal": 64, + "selection_type": "SINGLE", + "modifiers": [ + {} + ], + "image_ids": [ + "image_ids1" + ] + }, + "modifier_data": { + "name": "name0", + "price_money": {}, + "ordinal": 86, + "modifier_list_id": "modifier_list_id6", + "image_id": "image_id4" + }, + "time_period_data": { + "event": "event6" + }, + "product_set_data": { + "name": "name0", + "product_ids_any": [ + "product_ids_any6", + "product_ids_any7", + "product_ids_any8" + ], + "product_ids_all": [ + "product_ids_all3", + "product_ids_all4", + "product_ids_all5" + ], + "quantity_exact": 66, + "quantity_min": 200, + "quantity_max": 174, + "all_products": false + }, + "pricing_rule_data": { + "name": "name2", + "time_period_ids": [ + "time_period_ids4", + "time_period_ids5" + ], + "discount_id": "discount_id0", + "match_products_id": "match_products_id0", + "apply_products_id": "apply_products_id6", + "exclude_products_id": "exclude_products_id8", + "valid_from_date": "valid_from_date0", + "valid_from_local_time": "valid_from_local_time2", + "valid_until_date": "valid_until_date8", + "valid_until_local_time": "valid_until_local_time8", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any1", + "customer_group_ids_any2" + ] + }, + "image_data": { + "name": "name2", + "url": "url6", + "caption": "caption6", + "photo_studio_order_id": "photo_studio_order_id4" + }, + "measurement_unit_data": { + "measurement_unit": {}, + "precision": 178 + }, + "subscription_plan_data": { + "name": "name2", + "phases": [ + {}, + {} + ] + }, + "item_option_data": { + "name": "name6", + "display_name": "display_name6", + "description": "description6", + "show_colors": false, + "values": [ + {}, + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id4", + "name": "name2", + "description": "description2", + "color": "color6", + "ordinal": 150 + }, + "custom_attribute_definition_data": { + "type": "NUMBER", + "name": "name0", + "description": "description0", + "source_application": { + "product": "BILLING", + "application_id": "application_id8", + "name": "name2" + }, + "allowed_object_types": [ + "CUSTOM_ATTRIBUTE_DEFINITION", + "QUICK_AMOUNTS_SETTINGS" + ], + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_HIDDEN", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 136 + }, + "selection_config": { + "max_allowed_selections": 140, + "allowed_selections": [ + {} + ] + }, + "custom_attribute_usage_count": 232, + "key": "key0" + }, + "quick_amounts_settings_data": { + "option": "DISABLED", + "eligible_for_auto_amounts": false, + "amounts": [ + {}, + {}, + {} + ] + } + } + ] + } } ``` diff --git a/doc/models/create-payment-request.md b/doc/models/create-payment-request.md index e80b95a3..78ac198d 100644 --- a/doc/models/create-payment-request.md +++ b/doc/models/create-payment-request.md @@ -14,16 +14,16 @@ Describes a request to create a payment using | --- | --- | --- | --- | | `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` | | `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` | -| `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. | +| `amountMoney` | [`Money \| undefined`](../../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. | | `tipMoney` | [`Money \| undefined`](../../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. | | `appFeeMoney` | [`Money \| undefined`](../../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. | | `delayDuration` | `string \| undefined` | 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. | | `delayAction` | `string \| undefined` | 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 | | `autocomplete` | `boolean \| undefined` | 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 | | `orderId` | `string \| undefined` | Optional | Associates a previously created order with this payment. | -| `customerId` | `string \| undefined` | Optional | The [Customer](../../doc/models/customer.md) 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. | +| `customerId` | `string \| undefined` | 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. | | `locationId` | `string \| undefined` | 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. | -| `teamMemberId` | `string \| undefined` | Optional | An optional [TeamMember](../../doc/models/team-member.md) ID to associate with
this payment. | +| `teamMemberId` | `string \| undefined` | Optional | An optional [TeamMember](entity:TeamMember) ID to associate with
this payment. | | `referenceId` | `string \| undefined` | 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` | | `verificationToken` | `string \| undefined` | 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). | | `acceptPartialAuthorization` | `boolean \| undefined` | 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 | diff --git a/doc/models/create-refund-request.md b/doc/models/create-refund-request.md index 7294f37e..a754edb7 100644 --- a/doc/models/create-refund-request.md +++ b/doc/models/create-refund-request.md @@ -2,9 +2,9 @@ # Create Refund Request Defines the body parameters that can be included in -a request to the [CreateRefund]($e/Transactions/CreateRefund) endpoint. +a request to the [CreateRefund](api-endpoint:Transactions-CreateRefund) endpoint. -Deprecated - recommend using [RefundPayment](../../doc/api/refunds.md#refund-payment) +Deprecated - recommend using [RefundPayment](api-endpoint:Refunds-RefundPayment) ## Structure @@ -15,7 +15,7 @@ Deprecated - recommend using [RefundPayment](../../doc/api/refunds.md#refund-pay | Name | Type | Tags | Description | | --- | --- | --- | --- | | `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` | -| `tenderId` | `string` | Required | The ID of the tender to refund.

A [`Transaction`](../../doc/models/transaction.md) 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` | +| `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` | | `reason` | `string \| undefined` | Optional | A description of the reason for the refund.

Default value: `Refund via API`
**Constraints**: *Maximum Length*: `192` | | `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. | diff --git a/doc/models/create-refund-response.md b/doc/models/create-refund-response.md index 7e72a456..677ce5c7 100644 --- a/doc/models/create-refund-response.md +++ b/doc/models/create-refund-response.md @@ -2,7 +2,7 @@ # Create Refund Response Defines the fields that are included in the response body of -a request to the [CreateRefund]($e/Transactions/CreateRefund) endpoint. +a request to the [CreateRefund](api-endpoint:Transactions-CreateRefund) endpoint. One of `errors` or `refund` is present in a given response (never both). diff --git a/doc/models/create-subscription-request.md b/doc/models/create-subscription-request.md index 10ae2b6c..7fcd2f35 100644 --- a/doc/models/create-subscription-request.md +++ b/doc/models/create-subscription-request.md @@ -15,12 +15,12 @@ Defines input parameters in a request to the | `idempotencyKey` | `string \| undefined` | 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/working-with-apis/idempotency). | | `locationId` | `string` | Required | The ID of the location the subscription is associated with.
**Constraints**: *Minimum Length*: `1` | | `planId` | `string` | Required | The ID of the subscription plan created using the Catalog API.
For more information, see
[Set Up and Manage a Subscription Plan](https://developer.squareup.com/docs/subscriptions-api/setup-plan) and
[Subscriptions Walkthrough](https://developer.squareup.com/docs/subscriptions-api/walkthrough).
**Constraints**: *Minimum Length*: `1` | -| `customerId` | `string` | Required | The ID of the [customer](../../doc/models/customer.md) subscribing to the subscription plan.
**Constraints**: *Minimum Length*: `1` | +| `customerId` | `string` | Required | The ID of the [customer](entity:Customer) subscribing to the subscription plan.
**Constraints**: *Minimum Length*: `1` | | `startDate` | `string \| undefined` | Optional | The `YYYY-MM-DD`-formatted date to start the subscription.
If it is unspecified, the subscription starts immediately. | | `canceledDate` | `string \| undefined` | 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 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. | | `taxPercentage` | `string \| undefined` | 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` | | `priceOverrideMoney` | [`Money \| undefined`](../../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. | -| `cardId` | `string \| undefined` | Optional | The ID of the [subscriber's](../../doc/models/customer.md) [card](../../doc/models/card.md) to charge.
If it is not specified, the subscriber receives an invoice via email. For an example to
create a customer profile for a subscriber and add a card on file, see [Subscriptions Walkthrough](https://developer.squareup.com/docs/subscriptions-api/walkthrough). | +| `cardId` | `string \| undefined` | 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. For an example to
create a customer profile for a subscriber and add a card on file, see [Subscriptions Walkthrough](https://developer.squareup.com/docs/subscriptions-api/walkthrough). | | `timezone` | `string \| undefined` | 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). | | `source` | [`SubscriptionSource \| undefined`](../../doc/models/subscription-source.md) | Optional | The origination details of the subscription. | diff --git a/doc/models/create-vendor-request.md b/doc/models/create-vendor-request.md index 3f0cc4d8..7db4cdfd 100644 --- a/doc/models/create-vendor-request.md +++ b/doc/models/create-vendor-request.md @@ -11,7 +11,7 @@ Represents an input to a call to [CreateVendor](../../doc/api/vendors.md#create- | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `idempotencyKey` | `string` | Required | A client-supplied, universally unique identifier (UUID) to make this [CreateVendor](../../doc/api/vendors.md#create-vendor) call idempotent.

See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the
[API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more
information.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `128` | +| `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` | | `vendor` | [`Vendor \| undefined`](../../doc/models/vendor.md) | Optional | Represents a supplier to a seller. | ## Example (as JSON) @@ -19,7 +19,42 @@ Represents an input to a call to [CreateVendor](../../doc/api/vendors.md#create- ```json { "idempotency_key": "idempotency_key6", - "vendor": null + "vendor": { + "id": "id6", + "created_at": "created_at4", + "updated_at": "updated_at2", + "name": "name6", + "address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_22", + "address_line_3": "address_line_38", + "locality": "locality2", + "sublocality": "sublocality2", + "sublocality_2": "sublocality_20", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_16", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_30", + "postal_code": "postal_code4", + "country": "NL", + "first_name": "first_name2", + "last_name": "last_name0" + }, + "contacts": [ + { + "id": "id3", + "name": "name3", + "email_address": "email_address1", + "phone_number": "phone_number1", + "removed": true, + "ordinal": 11 + } + ], + "account_number": "account_number6", + "note": "note2", + "version": 76, + "status": "ACTIVE" + } } ``` diff --git a/doc/models/create-vendor-response.md b/doc/models/create-vendor-response.md index 470e5d97..ce6efa54 100644 --- a/doc/models/create-vendor-response.md +++ b/doc/models/create-vendor-response.md @@ -18,8 +18,62 @@ Represents an output from a call to [CreateVendor](../../doc/api/vendors.md#crea ```json { - "errors": null, - "vendor": null + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ], + "vendor": { + "id": "id6", + "created_at": "created_at4", + "updated_at": "updated_at2", + "name": "name6", + "address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_22", + "address_line_3": "address_line_38", + "locality": "locality2", + "sublocality": "sublocality2", + "sublocality_2": "sublocality_20", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_16", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_30", + "postal_code": "postal_code4", + "country": "NL", + "first_name": "first_name2", + "last_name": "last_name0" + }, + "contacts": [ + { + "id": "id3", + "name": "name3", + "email_address": "email_address1", + "phone_number": "phone_number1", + "removed": true, + "ordinal": 11 + } + ], + "account_number": "account_number6", + "note": "note2", + "version": 76, + "status": "ACTIVE" + } } ``` diff --git a/doc/models/create-webhook-subscription-request.md b/doc/models/create-webhook-subscription-request.md index 3566838c..739cb5e0 100644 --- a/doc/models/create-webhook-subscription-request.md +++ b/doc/models/create-webhook-subscription-request.md @@ -11,7 +11,7 @@ Creates a [Subscription](../../doc/models/webhook-subscription.md). | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `idempotencyKey` | `string \| undefined` | Optional | A unique string that identifies the [CreateWebhookSubscription](../../doc/api/webhook-subscriptions.md#create-webhook-subscription) request.
**Constraints**: *Maximum Length*: `45` | +| `idempotencyKey` | `string \| undefined` | Optional | A unique string that identifies the [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscription) request.
**Constraints**: *Maximum Length*: `45` | | `subscription` | [`WebhookSubscription`](../../doc/models/webhook-subscription.md) | Required | Represents the details of a webhook subscription, including notification URL,
event types, and signature key. | ## Example (as JSON) diff --git a/doc/models/custom-attribute-definition.md b/doc/models/custom-attribute-definition.md index ebad7e2b..511374b6 100644 --- a/doc/models/custom-attribute-definition.md +++ b/doc/models/custom-attribute-definition.md @@ -25,14 +25,17 @@ specifies the key, visibility, schema, and other properties for a custom attribu ```json { - "key": null, - "schema": null, - "name": null, - "description": null, - "visibility": null, - "version": null, - "updated_at": null, - "created_at": null + "key": "key0", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name0", + "description": "description0", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "version": 172, + "updated_at": "updated_at4", + "created_at": "created_at2" } ``` diff --git a/doc/models/custom-attribute-filter.md b/doc/models/custom-attribute-filter.md index d9bdbc67..5c7d1b6c 100644 --- a/doc/models/custom-attribute-filter.md +++ b/doc/models/custom-attribute-filter.md @@ -24,12 +24,18 @@ endpoint to search for items or item variations. ```json { - "custom_attribute_definition_id": null, - "key": null, - "string_filter": null, - "number_filter": null, - "selection_uids_filter": null, - "bool_filter": null + "custom_attribute_definition_id": "custom_attribute_definition_id2", + "key": "key0", + "string_filter": "string_filter2", + "number_filter": { + "min": "min8", + "max": "max4" + }, + "selection_uids_filter": [ + "selection_uids_filter4", + "selection_uids_filter5" + ], + "bool_filter": false } ``` diff --git a/doc/models/custom-attribute.md b/doc/models/custom-attribute.md index 424e7ae1..f6e6540f 100644 --- a/doc/models/custom-attribute.md +++ b/doc/models/custom-attribute.md @@ -24,13 +24,28 @@ A custom attribute value. Each custom attribute value has a corresponding ```json { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key0", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 172, + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "definition": { + "key": "key0", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name0", + "description": "description0", + "visibility": "VISIBILITY_HIDDEN", + "version": 180, + "updated_at": "updated_at6", + "created_at": "created_at8" + }, + "updated_at": "updated_at4", + "created_at": "created_at2" } ``` diff --git a/doc/models/customer-address-filter.md b/doc/models/customer-address-filter.md index 45ef2abb..8e643185 100644 --- a/doc/models/customer-address-filter.md +++ b/doc/models/customer-address-filter.md @@ -19,8 +19,11 @@ searching by an `Address`-type custom attribute. ```json { - "postal_code": null, - "country": null + "postal_code": { + "exact": "exact2", + "fuzzy": "fuzzy2" + }, + "country": "FO" } ``` diff --git a/doc/models/customer-creation-source-filter.md b/doc/models/customer-creation-source-filter.md index 8e67fd86..12d576fa 100644 --- a/doc/models/customer-creation-source-filter.md +++ b/doc/models/customer-creation-source-filter.md @@ -21,8 +21,12 @@ or excluded from, the result if they match at least one of the filter criteria. ```json { - "values": null, - "rule": null + "values": [ + "INSTANT_PROFILE", + "TERMINAL", + "THIRD_PARTY" + ], + "rule": "INCLUDE" } ``` diff --git a/doc/models/customer-custom-attribute-filter-value.md b/doc/models/customer-custom-attribute-filter-value.md index 11246860..dfd2835a 100644 --- a/doc/models/customer-custom-attribute-filter-value.md +++ b/doc/models/customer-custom-attribute-filter-value.md @@ -25,14 +25,46 @@ of a customer-related [custom attribute](../../doc/models/custom-attribute.md). ```json { - "email": null, - "phone": null, - "text": null, - "selection": null, - "date": null, - "number": null, - "boolean": null, - "address": null + "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" + }, + "number": { + "start_at": "start_at4", + "end_at": "end_at8" + }, + "boolean": false, + "address": { + "postal_code": { + "exact": "exact8", + "fuzzy": "fuzzy4" + }, + "country": "BE" + } } ``` diff --git a/doc/models/customer-custom-attribute-filter.md b/doc/models/customer-custom-attribute-filter.md index 71443dd8..5f9edf2d 100644 --- a/doc/models/customer-custom-attribute-filter.md +++ b/doc/models/customer-custom-attribute-filter.md @@ -12,7 +12,7 @@ based on the value or last updated date of a customer-related [custom attribute] | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `key` | `string` | Required | The `key` of the [custom attribute](../../doc/models/custom-attribute.md) 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](../../doc/api/customer-custom-attributes.md). | +| `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). | | `filter` | [`CustomerCustomAttributeFilterValue \| undefined`](../../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). | | `updatedAt` | [`TimeRange \| undefined`](../../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. | @@ -21,8 +21,46 @@ based on the value or last updated date of a customer-related [custom attribute] ```json { "key": "key0", - "filter": null, - "updated_at": null + "filter": { + "email": { + "exact": "exact2", + "fuzzy": "fuzzy8" + }, + "phone": { + "exact": "exact6", + "fuzzy": "fuzzy2" + }, + "text": {}, + "selection": { + "all": [ + "all7" + ], + "any": [ + "any2", + "any3" + ], + "none": [ + "none7" + ] + }, + "date": { + "start_at": "start_at2", + "end_at": "end_at0" + }, + "number": { + "start_at": "start_at0", + "end_at": "end_at2" + }, + "boolean": false, + "address": { + "postal_code": {}, + "country": "FO" + } + }, + "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 index 96a803cf..a17d2d88 100644 --- a/doc/models/customer-custom-attribute-filters.md +++ b/doc/models/customer-custom-attribute-filters.md @@ -19,7 +19,51 @@ to search based on [custom attributes](../../doc/models/custom-attribute.md) tha ```json { - "filters": null + "filters": [ + { + "key": "key0", + "filter": { + "email": { + "exact": "exact2", + "fuzzy": "fuzzy8" + }, + "phone": { + "exact": "exact6", + "fuzzy": "fuzzy2" + }, + "text": {}, + "selection": { + "all": [ + "all5" + ], + "any": [ + "any2", + "any3" + ], + "none": [ + "none7" + ] + }, + "date": { + "start_at": "start_at2", + "end_at": "end_at0" + }, + "number": { + "start_at": "start_at0", + "end_at": "end_at2" + }, + "boolean": false, + "address": { + "postal_code": {}, + "country": "WS" + } + }, + "updated_at": { + "start_at": "start_at8", + "end_at": "end_at4" + } + } + ] } ``` diff --git a/doc/models/customer-filter.md b/doc/models/customer-filter.md index 97df42a2..db198833 100644 --- a/doc/models/customer-filter.md +++ b/doc/models/customer-filter.md @@ -26,15 +26,205 @@ customer profiles returned in [SearchCustomers](../../doc/api/customers.md#searc ```json { - "creation_source": null, - "created_at": null, - "updated_at": null, - "email_address": null, - "phone_number": null, - "reference_id": null, - "group_ids": null, - "custom_attribute": null, - "segment_ids": null + "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" + }, + "reference_id": { + "exact": "exact2", + "fuzzy": "fuzzy8" + }, + "group_ids": { + "all": [ + "all5", + "all4", + "all3" + ], + "any": [ + "any2", + "any3", + "any4" + ], + "none": [ + "none7", + "none8" + ] + }, + "custom_attribute": { + "filters": [ + { + "key": "key8", + "filter": { + "email": { + "exact": "exact0", + "fuzzy": "fuzzy6" + }, + "phone": { + "exact": "exact4", + "fuzzy": "fuzzy0" + }, + "text": {}, + "selection": { + "all": [ + "all5", + "all4" + ], + "any": [ + "any4", + "any5", + "any6" + ], + "none": [ + "none9", + "none0" + ] + }, + "date": { + "start_at": "start_at0", + "end_at": "end_at2" + }, + "number": { + "start_at": "start_at8", + "end_at": "end_at4" + }, + "boolean": false, + "address": { + "postal_code": {}, + "country": "VA" + } + }, + "updated_at": { + "start_at": "start_at8", + "end_at": "end_at4" + } + }, + { + "key": "key9", + "filter": { + "email": { + "exact": "exact1", + "fuzzy": "fuzzy7" + }, + "phone": { + "exact": "exact5", + "fuzzy": "fuzzy1" + }, + "text": {}, + "selection": { + "all": [ + "all6" + ], + "any": [ + "any3", + "any4" + ], + "none": [ + "none8" + ] + }, + "date": { + "start_at": "start_at1", + "end_at": "end_at1" + }, + "number": { + "start_at": "start_at9", + "end_at": "end_at3" + }, + "boolean": true, + "address": { + "postal_code": {}, + "country": "UZ" + } + }, + "updated_at": { + "start_at": "start_at7", + "end_at": "end_at5" + } + }, + { + "key": "key0", + "filter": { + "email": { + "exact": "exact2", + "fuzzy": "fuzzy8" + }, + "phone": { + "exact": "exact6", + "fuzzy": "fuzzy2" + }, + "text": {}, + "selection": { + "all": [ + "all7", + "all6", + "all5" + ], + "any": [ + "any2" + ], + "none": [ + "none7", + "none8", + "none9" + ] + }, + "date": { + "start_at": "start_at2", + "end_at": "end_at0" + }, + "number": { + "start_at": "start_at0", + "end_at": "end_at2" + }, + "boolean": false, + "address": { + "postal_code": {}, + "country": "UY" + } + }, + "updated_at": { + "start_at": "start_at6", + "end_at": "end_at6" + } + } + ] + }, + "segment_ids": { + "all": [ + "all9", + "all8", + "all7" + ], + "any": [ + "any6", + "any7", + "any8" + ], + "none": [ + "none1", + "none2" + ] + } } ``` diff --git a/doc/models/customer-group.md b/doc/models/customer-group.md index fc247d75..57c4c611 100644 --- a/doc/models/customer-group.md +++ b/doc/models/customer-group.md @@ -23,10 +23,10 @@ the Customers API or within the Customer Directory in the Square Seller Dashboar ```json { - "id": null, + "id": "id0", "name": "name0", - "created_at": null, - "updated_at": null + "created_at": "created_at2", + "updated_at": "updated_at4" } ``` diff --git a/doc/models/customer-preferences.md b/doc/models/customer-preferences.md index a747269e..2d4efc67 100644 --- a/doc/models/customer-preferences.md +++ b/doc/models/customer-preferences.md @@ -17,7 +17,7 @@ Represents communication preferences for the customer profile. ```json { - "email_unsubscribed": null + "email_unsubscribed": false } ``` diff --git a/doc/models/customer-query.md b/doc/models/customer-query.md index d905f483..361b1682 100644 --- a/doc/models/customer-query.md +++ b/doc/models/customer-query.md @@ -18,8 +18,126 @@ Represents filtering and sorting criteria for a [SearchCustomers](../../doc/api/ ```json { - "filter": null, - "sort": null + "filter": { + "creation_source": { + "values": [ + "INVOICES", + "LOYALTY", + "MARKETING" + ], + "rule": "INCLUDE" + }, + "created_at": { + "start_at": "start_at4", + "end_at": "end_at8" + }, + "updated_at": { + "start_at": "start_at2", + "end_at": "end_at0" + }, + "email_address": { + "exact": "exact2", + "fuzzy": "fuzzy2" + }, + "phone_number": { + "exact": "exact8", + "fuzzy": "fuzzy6" + }, + "reference_id": {}, + "group_ids": { + "all": [ + "all9", + "all0", + "all1" + ], + "any": [ + "any8", + "any9", + "any0" + ], + "none": [ + "none3", + "none4" + ] + }, + "custom_attribute": { + "filters": [ + { + "key": "key8", + "filter": { + "email": {}, + "phone": {}, + "text": {}, + "selection": { + "all": [ + "all7", + "all6" + ], + "any": [ + "any4" + ], + "none": [ + "none9", + "none0", + "none1" + ] + }, + "date": {}, + "number": { + "start_at": "start_at8", + "end_at": "end_at4" + }, + "boolean": false, + "address": { + "postal_code": {}, + "country": "CZ" + } + }, + "updated_at": {} + }, + { + "key": "key9", + "filter": { + "email": {}, + "phone": {}, + "text": {}, + "selection": { + "all": [ + "all6", + "all5", + "all4" + ], + "any": [ + "any3", + "any4", + "any5" + ], + "none": [ + "none8", + "none9" + ] + }, + "date": {}, + "number": { + "start_at": "start_at9", + "end_at": "end_at3" + }, + "boolean": true, + "address": { + "postal_code": {}, + "country": "CY" + } + }, + "updated_at": {} + } + ] + }, + "segment_ids": {} + }, + "sort": { + "field": "DEFAULT", + "order": "DESC" + } } ``` diff --git a/doc/models/customer-segment.md b/doc/models/customer-segment.md index c5b58a42..92d8c8c3 100644 --- a/doc/models/customer-segment.md +++ b/doc/models/customer-segment.md @@ -23,10 +23,10 @@ Square Seller Dashboard or Point of Sale. ```json { - "id": null, + "id": "id0", "name": "name0", - "created_at": null, - "updated_at": null + "created_at": "created_at2", + "updated_at": "updated_at4" } ``` diff --git a/doc/models/customer-sort.md b/doc/models/customer-sort.md index 6fc42774..4139db24 100644 --- a/doc/models/customer-sort.md +++ b/doc/models/customer-sort.md @@ -19,8 +19,8 @@ customer profiles returned in [SearchCustomers](../../doc/api/customers.md#searc ```json { - "field": null, - "order": null + "field": "DEFAULT", + "order": "DESC" } ``` diff --git a/doc/models/customer-tax-ids.md b/doc/models/customer-tax-ids.md index a1d0a3b7..bd50b361 100644 --- a/doc/models/customer-tax-ids.md +++ b/doc/models/customer-tax-ids.md @@ -18,7 +18,7 @@ For more information, see [Customer tax IDs](https://developer.squareup.com/docs ```json { - "eu_vat": null + "eu_vat": "eu_vat2" } ``` diff --git a/doc/models/customer-text-filter.md b/doc/models/customer-text-filter.md index db0da279..2d76650e 100644 --- a/doc/models/customer-text-filter.md +++ b/doc/models/customer-text-filter.md @@ -20,8 +20,8 @@ the filter can be case-sensitive. This filter can be exact or fuzzy, but it cann ```json { - "exact": null, - "fuzzy": null + "exact": "exact0", + "fuzzy": "fuzzy4" } ``` diff --git a/doc/models/customer.md b/doc/models/customer.md index f79a557d..1361a309 100644 --- a/doc/models/customer.md +++ b/doc/models/customer.md @@ -11,10 +11,10 @@ Represents a Square customer profile in the Customer Directory of a Square selle | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `string \| undefined` | 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](../../doc/api/customers.md#search-customers)
or [ListCustomers](../../doc/api/customers.md#list-customers) endpoint. | +| `id` | `string \| undefined` | 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. | | `createdAt` | `string \| undefined` | Optional | The timestamp when the customer profile was created, in RFC 3339 format. | | `updatedAt` | `string \| undefined` | Optional | The timestamp when the customer profile was last updated, in RFC 3339 format. | -| `cards` | [`Card[] \| undefined`](../../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. Replaced by calling [ListCards](../../doc/api/cards.md#list-cards) (for credit and debit cards on file)
or [ListGiftCards](../../doc/api/gift-cards.md#list-gift-cards) (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). | +| `cards` | [`Card[] \| undefined`](../../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. 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). | | `givenName` | `string \| undefined` | Optional | The given name (that is, the first name) associated with the customer profile. | | `familyName` | `string \| undefined` | Optional | The family name (that is, the last name) associated with the customer profile. | | `nickname` | `string \| undefined` | Optional | A nickname for the customer profile. | @@ -27,8 +27,8 @@ Represents a Square customer profile in the Customer Directory of a Square selle | `note` | `string \| undefined` | Optional | A custom note associated with the customer profile. | | `preferences` | [`CustomerPreferences \| undefined`](../../doc/models/customer-preferences.md) | Optional | Represents communication preferences for the customer profile. | | `creationSource` | [`string \| undefined`](../../doc/models/customer-creation-source.md) | Optional | Indicates the method used to create the customer profile. | -| `groupIds` | `string[] \| undefined` | Optional | The IDs of [customer groups](../../doc/models/customer-group.md) the customer belongs to. | -| `segmentIds` | `string[] \| undefined` | Optional | The IDs of [customer segments](../../doc/models/customer-segment.md) the customer belongs to. | +| `groupIds` | `string[] \| undefined` | Optional | The IDs of [customer groups](entity:CustomerGroup) the customer belongs to. | +| `segmentIds` | `string[] \| undefined` | Optional | The IDs of [customer segments](entity:CustomerSegment) the customer belongs to. | | `version` | `bigint \| undefined` | 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. | | `taxIds` | [`CustomerTaxIds \| undefined`](../../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). | @@ -36,26 +36,122 @@ Represents a Square customer profile in the Customer Directory of a Square selle ```json { - "id": null, - "created_at": null, - "updated_at": null, - "cards": null, - "given_name": null, - "family_name": null, - "nickname": null, - "company_name": null, - "email_address": null, - "address": null, - "phone_number": null, - "birthday": null, - "reference_id": null, - "note": null, - "preferences": null, - "creation_source": null, - "group_ids": null, - "segment_ids": null, - "version": null, - "tax_ids": null + "id": "id0", + "created_at": "created_at2", + "updated_at": "updated_at4", + "cards": [ + { + "id": "id7", + "card_brand": "EBT", + "last_4": "last_49", + "exp_month": 79, + "exp_year": 217, + "cardholder_name": "cardholder_name7", + "billing_address": { + "address_line_1": "address_line_11", + "address_line_2": "address_line_29", + "address_line_3": "address_line_35", + "locality": "locality9", + "sublocality": "sublocality9", + "sublocality_2": "sublocality_27", + "sublocality_3": "sublocality_39", + "administrative_district_level_1": "administrative_district_level_13", + "administrative_district_level_2": "administrative_district_level_25", + "administrative_district_level_3": "administrative_district_level_37", + "postal_code": "postal_code1", + "country": "CW", + "first_name": "first_name9", + "last_name": "last_name7" + }, + "fingerprint": "fingerprint3", + "customer_id": "customer_id5", + "merchant_id": "merchant_id7", + "reference_id": "reference_id5", + "enabled": true, + "card_type": "DEBIT", + "prepaid_type": "UNKNOWN_PREPAID_TYPE", + "bin": "bin7", + "version": 47, + "card_co_brand": "UNKNOWN" + }, + { + "id": "id8", + "card_brand": "FELICA", + "last_4": "last_40", + "exp_month": 78, + "exp_year": 218, + "cardholder_name": "cardholder_name6", + "billing_address": { + "address_line_1": "address_line_10", + "address_line_2": "address_line_20", + "address_line_3": "address_line_36", + "locality": "locality0", + "sublocality": "sublocality0", + "sublocality_2": "sublocality_28", + "sublocality_3": "sublocality_30", + "administrative_district_level_1": "administrative_district_level_14", + "administrative_district_level_2": "administrative_district_level_24", + "administrative_district_level_3": "administrative_district_level_38", + "postal_code": "postal_code2", + "country": "CX", + "first_name": "first_name0", + "last_name": "last_name8" + }, + "fingerprint": "fingerprint4", + "customer_id": "customer_id6", + "merchant_id": "merchant_id8", + "reference_id": "reference_id6", + "enabled": false, + "card_type": "CREDIT", + "prepaid_type": "NOT_PREPAID", + "bin": "bin8", + "version": 48, + "card_co_brand": "CLEARPAY" + } + ], + "given_name": "given_name2", + "family_name": "family_name6", + "nickname": "nickname6", + "company_name": "company_name6", + "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", + "sublocality_2": "sublocality_24", + "sublocality_3": "sublocality_36", + "administrative_district_level_1": "administrative_district_level_10", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_34", + "postal_code": "postal_code8", + "country": "BE", + "first_name": "first_name6", + "last_name": "last_name4" + }, + "phone_number": "phone_number2", + "birthday": "birthday0", + "reference_id": "reference_id2", + "note": "note4", + "preferences": { + "email_unsubscribed": false + }, + "creation_source": "MERGE", + "group_ids": [ + "group_ids3", + "group_ids4", + "group_ids5" + ], + "segment_ids": [ + "segment_ids0", + "segment_ids1", + "segment_ids2" + ], + "version": 172, + "tax_ids": { + "eu_vat": "eu_vat2" + } } ``` diff --git a/doc/models/date-range.md b/doc/models/date-range.md index 14efa4a1..87465e54 100644 --- a/doc/models/date-range.md +++ b/doc/models/date-range.md @@ -19,8 +19,8 @@ objects that have date properties. ```json { - "start_date": null, - "end_date": null + "start_date": "start_date6", + "end_date": "end_date0" } ``` diff --git a/doc/models/delete-customer-request.md b/doc/models/delete-customer-request.md index 95c82b5c..042b514d 100644 --- a/doc/models/delete-customer-request.md +++ b/doc/models/delete-customer-request.md @@ -18,7 +18,7 @@ endpoint. ```json { - "version": null + "version": 172 } ``` diff --git a/doc/models/delete-invoice-request.md b/doc/models/delete-invoice-request.md index eb0a5048..525cbcad 100644 --- a/doc/models/delete-invoice-request.md +++ b/doc/models/delete-invoice-request.md @@ -11,13 +11,13 @@ Describes a `DeleteInvoice` request. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `version` | `number \| undefined` | Optional | The version of the [invoice](../../doc/models/invoice.md) to delete.
If you do not know the version, you can call [GetInvoice](../../doc/api/invoices.md#get-invoice) or
[ListInvoices](../../doc/api/invoices.md#list-invoices). | +| `version` | `number \| undefined` | 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). | ## Example (as JSON) ```json { - "version": null + "version": 172 } ``` diff --git a/doc/models/deprecated-create-dispute-evidence-file-request.md b/doc/models/deprecated-create-dispute-evidence-file-request.md index 427ed1cb..eac3b672 100644 --- a/doc/models/deprecated-create-dispute-evidence-file-request.md +++ b/doc/models/deprecated-create-dispute-evidence-file-request.md @@ -20,8 +20,8 @@ Defines the parameters for a `DeprecatedCreateDisputeEvidenceFile` request. ```json { "idempotency_key": "idempotency_key6", - "evidence_type": null, - "content_type": null + "evidence_type": "RECEIPT", + "content_type": "content_type6" } ``` diff --git a/doc/models/destination-details-card-refund-details.md b/doc/models/destination-details-card-refund-details.md index 8b3374f7..1057a816 100644 --- a/doc/models/destination-details-card-refund-details.md +++ b/doc/models/destination-details-card-refund-details.md @@ -16,8 +16,41 @@ ```json { - "card": null, - "entry_method": null + "card": { + "id": "id6", + "card_brand": "OTHER_BRAND", + "last_4": "last_48", + "exp_month": 228, + "exp_year": 68, + "cardholder_name": "cardholder_name8", + "billing_address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_28", + "address_line_3": "address_line_34", + "locality": "locality2", + "sublocality": "sublocality8", + "sublocality_2": "sublocality_26", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_12", + "administrative_district_level_2": "administrative_district_level_26", + "administrative_district_level_3": "administrative_district_level_36", + "postal_code": "postal_code0", + "country": "KR", + "first_name": "first_name8", + "last_name": "last_name6" + }, + "fingerprint": "fingerprint2", + "customer_id": "customer_id4", + "merchant_id": "merchant_id6", + "reference_id": "reference_id6", + "enabled": false, + "card_type": "UNKNOWN_CARD_TYPE", + "prepaid_type": "PREPAID", + "bin": "bin6", + "version": 154, + "card_co_brand": "AFTERPAY" + }, + "entry_method": "entry_method6" } ``` diff --git a/doc/models/destination-details.md b/doc/models/destination-details.md index cce61387..0f9e4a5a 100644 --- a/doc/models/destination-details.md +++ b/doc/models/destination-details.md @@ -17,7 +17,43 @@ Details about a refund's destination. ```json { - "card_details": null + "card_details": { + "card": { + "id": "id6", + "card_brand": "JCB", + "last_4": "last_48", + "exp_month": 4, + "exp_year": 36, + "cardholder_name": "cardholder_name8", + "billing_address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_28", + "address_line_3": "address_line_34", + "locality": "locality2", + "sublocality": "sublocality8", + "sublocality_2": "sublocality_26", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_12", + "administrative_district_level_2": "administrative_district_level_26", + "administrative_district_level_3": "administrative_district_level_36", + "postal_code": "postal_code0", + "country": "RW", + "first_name": "first_name8", + "last_name": "last_name6" + }, + "fingerprint": "fingerprint2", + "customer_id": "customer_id4", + "merchant_id": "merchant_id6", + "reference_id": "reference_id4", + "enabled": false, + "card_type": "UNKNOWN_CARD_TYPE", + "prepaid_type": "PREPAID", + "bin": "bin6", + "version": 122, + "card_co_brand": "AFTERPAY" + }, + "entry_method": "entry_method8" + } } ``` diff --git a/doc/models/destination.md b/doc/models/destination.md index f6320aef..b07989c2 100644 --- a/doc/models/destination.md +++ b/doc/models/destination.md @@ -18,8 +18,8 @@ Information about the destination against which the payout was made. ```json { - "type": null, - "id": null + "type": "SQUARE_BALANCE", + "id": "id0" } ``` diff --git a/doc/models/device-checkout-options.md b/doc/models/device-checkout-options.md index 3184b882..b9378555 100644 --- a/doc/models/device-checkout-options.md +++ b/doc/models/device-checkout-options.md @@ -20,10 +20,18 @@ ```json { "device_id": "device_id6", - "skip_receipt_screen": null, - "collect_signature": null, - "tip_settings": null, - "show_itemized_cart": null + "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-details.md b/doc/models/device-details.md index 97a031da..d1598792 100644 --- a/doc/models/device-details.md +++ b/doc/models/device-details.md @@ -19,9 +19,9 @@ Details about the device that took the payment. ```json { - "device_id": null, - "device_installation_id": null, - "device_name": null + "device_id": "device_id6", + "device_installation_id": "device_installation_id8", + "device_name": "device_name2" } ``` diff --git a/doc/models/device-metadata.md b/doc/models/device-metadata.md index 1a92ad7b..1da46203 100644 --- a/doc/models/device-metadata.md +++ b/doc/models/device-metadata.md @@ -26,18 +26,18 @@ ```json { - "battery_percentage": null, - "charging_state": null, - "location_id": null, - "merchant_id": null, - "network_connection_type": null, - "payment_region": null, - "serial_number": null, - "os_version": null, - "app_version": null, - "wifi_network_name": null, - "wifi_network_strength": null, - "ip_address": null + "battery_percentage": "battery_percentage6", + "charging_state": "charging_state2", + "location_id": "location_id4", + "merchant_id": "merchant_id0", + "network_connection_type": "network_connection_type0", + "payment_region": "payment_region8", + "serial_number": "serial_number6", + "os_version": "os_version8", + "app_version": "app_version0", + "wifi_network_name": "wifi_network_name4", + "wifi_network_strength": "wifi_network_strength0", + "ip_address": "ip_address0" } ``` diff --git a/doc/models/device.md b/doc/models/device.md index 26b88b97..852d12fd 100644 --- a/doc/models/device.md +++ b/doc/models/device.md @@ -16,8 +16,8 @@ ```json { - "id": null, - "name": null + "id": "id0", + "name": "name0" } ``` diff --git a/doc/models/digital-wallet-details.md b/doc/models/digital-wallet-details.md index b0e161d1..93644716 100644 --- a/doc/models/digital-wallet-details.md +++ b/doc/models/digital-wallet-details.md @@ -19,9 +19,13 @@ Additional details about `WALLET` type payments. Contains only non-confidential ```json { - "status": null, - "brand": null, - "cash_app_details": null + "status": "status8", + "brand": "brand4", + "cash_app_details": { + "buyer_full_name": "buyer_full_name2", + "buyer_country_code": "buyer_country_code8", + "buyer_cashtag": "buyer_cashtag4" + } } ``` diff --git a/doc/models/dispute-evidence-file.md b/doc/models/dispute-evidence-file.md index f3c0e5c2..cfeb0145 100644 --- a/doc/models/dispute-evidence-file.md +++ b/doc/models/dispute-evidence-file.md @@ -18,8 +18,8 @@ A file to be uploaded as dispute evidence. ```json { - "filename": null, - "filetype": null + "filename": "filename2", + "filetype": "filetype2" } ``` diff --git a/doc/models/dispute-evidence.md b/doc/models/dispute-evidence.md index 926d4701..a123f8e7 100644 --- a/doc/models/dispute-evidence.md +++ b/doc/models/dispute-evidence.md @@ -21,13 +21,16 @@ ```json { - "evidence_id": null, - "id": null, - "dispute_id": null, - "evidence_file": null, - "evidence_text": null, - "uploaded_at": null, - "evidence_type": null + "evidence_id": "evidence_id2", + "id": "id0", + "dispute_id": "dispute_id2", + "evidence_file": { + "filename": "filename8", + "filetype": "filetype8" + }, + "evidence_text": "evidence_text6", + "uploaded_at": "uploaded_at4", + "evidence_type": "RECEIPT" } ``` diff --git a/doc/models/dispute.md b/doc/models/dispute.md index fb5a6a10..342804aa 100644 --- a/doc/models/dispute.md +++ b/doc/models/dispute.md @@ -32,22 +32,30 @@ Represents a [dispute](https://developer.squareup.com/docs/disputes-api/overview ```json { - "dispute_id": null, - "id": null, - "amount_money": null, - "reason": null, - "state": null, - "due_at": null, - "disputed_payment": null, - "evidence_ids": null, - "card_brand": null, - "created_at": null, - "updated_at": null, - "brand_dispute_id": null, - "reported_date": null, - "reported_at": null, - "version": null, - "location_id": null + "dispute_id": "dispute_id2", + "id": "id0", + "amount_money": { + "amount": 186, + "currency": "NGN" + }, + "reason": "NOT_AS_DESCRIBED", + "state": "PROCESSING", + "due_at": "due_at2", + "disputed_payment": { + "payment_id": "payment_id8" + }, + "evidence_ids": [ + "evidence_ids3", + "evidence_ids4" + ], + "card_brand": "OTHER_BRAND", + "created_at": "created_at2", + "updated_at": "updated_at4", + "brand_dispute_id": "brand_dispute_id0", + "reported_date": "reported_date8", + "reported_at": "reported_at2", + "version": 172, + "location_id": "location_id4" } ``` diff --git a/doc/models/disputed-payment.md b/doc/models/disputed-payment.md index 36b8757a..922cda30 100644 --- a/doc/models/disputed-payment.md +++ b/doc/models/disputed-payment.md @@ -17,7 +17,7 @@ The payment the cardholder disputed. ```json { - "payment_id": null + "payment_id": "payment_id0" } ``` diff --git a/doc/models/employee-wage.md b/doc/models/employee-wage.md index dc7bb43f..67c0f469 100644 --- a/doc/models/employee-wage.md +++ b/doc/models/employee-wage.md @@ -21,10 +21,13 @@ specified by the `title` property of this object. Deprecated at version 2020-08- ```json { - "id": null, - "employee_id": null, - "title": null, - "hourly_rate": null + "id": "id0", + "employee_id": "employee_id0", + "title": "title4", + "hourly_rate": { + "amount": 172, + "currency": "TJS" + } } ``` diff --git a/doc/models/employee.md b/doc/models/employee.md index 690ed77d..d406292c 100644 --- a/doc/models/employee.md +++ b/doc/models/employee.md @@ -26,16 +26,18 @@ An employee object that is used by the external API. ```json { - "id": null, - "first_name": null, - "last_name": null, - "email": null, - "phone_number": null, - "location_ids": null, - "status": null, - "is_owner": null, - "created_at": null, - "updated_at": null + "id": "id0", + "first_name": "first_name0", + "last_name": "last_name8", + "email": "email6", + "phone_number": "phone_number2", + "location_ids": [ + "location_ids0" + ], + "status": "ACTIVE", + "is_owner": false, + "created_at": "created_at2", + "updated_at": "updated_at4" } ``` diff --git a/doc/models/error.md b/doc/models/error.md index 58f99848..b53a0a17 100644 --- a/doc/models/error.md +++ b/doc/models/error.md @@ -24,8 +24,8 @@ See [Handling errors](https://developer.squareup.com/docs/build-basics/handling- { "category": "RATE_LIMIT_ERROR", "code": "UNEXPECTED_VALUE", - "detail": null, - "field": null + "detail": "detail6", + "field": "field6" } ``` diff --git a/doc/models/event-type-metadata.md b/doc/models/event-type-metadata.md index 8117b390..0bb84120 100644 --- a/doc/models/event-type-metadata.md +++ b/doc/models/event-type-metadata.md @@ -19,9 +19,9 @@ Contains the metadata of a webhook event type. ```json { - "event_type": null, - "api_version_introduced": null, - "release_status": null + "event_type": "event_type0", + "api_version_introduced": "api_version_introduced0", + "release_status": "release_status4" } ``` diff --git a/doc/models/external-payment-details.md b/doc/models/external-payment-details.md index 345d36f0..f509cd60 100644 --- a/doc/models/external-payment-details.md +++ b/doc/models/external-payment-details.md @@ -24,8 +24,11 @@ For more information, see { "type": "type0", "source": "source4", - "source_id": null, - "source_fee_money": null + "source_id": "source_id6", + "source_fee_money": { + "amount": 130, + "currency": "JMD" + } } ``` diff --git a/doc/models/filter-value.md b/doc/models/filter-value.md index de23ecda..dc5392f8 100644 --- a/doc/models/filter-value.md +++ b/doc/models/filter-value.md @@ -23,9 +23,18 @@ Refer to the documentation of the field. ```json { - "all": null, - "any": null, - "none": null + "all": [ + "all1", + "all2" + ], + "any": [ + "any6" + ], + "none": [ + "none1", + "none2", + "none3" + ] } ``` diff --git a/doc/models/float-number-range.md b/doc/models/float-number-range.md index 7313c044..e4091341 100644 --- a/doc/models/float-number-range.md +++ b/doc/models/float-number-range.md @@ -18,8 +18,8 @@ Specifies a decimal number range. ```json { - "start_at": null, - "end_at": null + "start_at": "start_at2", + "end_at": "end_at0" } ``` diff --git a/doc/models/fulfillment-delivery-details.md b/doc/models/fulfillment-delivery-details.md index 74f53342..e837cd71 100644 --- a/doc/models/fulfillment-delivery-details.md +++ b/doc/models/fulfillment-delivery-details.md @@ -39,29 +39,50 @@ Describes delivery details of an order fulfillment. ```json { - "recipient": null, - "schedule_type": null, - "placed_at": null, - "deliver_at": null, - "prep_time_duration": null, - "delivery_window_duration": null, - "note": null, - "completed_at": null, - "in_progress_at": null, - "rejected_at": null, - "ready_at": null, - "delivered_at": null, - "canceled_at": null, - "cancel_reason": null, - "courier_pickup_at": null, - "courier_pickup_window_duration": null, - "is_no_contact_delivery": null, - "dropoff_notes": null, - "courier_provider_name": null, - "courier_support_phone_number": null, - "square_delivery_id": null, - "external_delivery_id": null, - "managed_delivery": null + "recipient": { + "customer_id": "customer_id6", + "display_name": "display_name8", + "email_address": "email_address4", + "phone_number": "phone_number4", + "address": { + "address_line_1": "address_line_14", + "address_line_2": "address_line_24", + "address_line_3": "address_line_30", + "locality": "locality4", + "sublocality": "sublocality4", + "sublocality_2": "sublocality_22", + "sublocality_3": "sublocality_34", + "administrative_district_level_1": "administrative_district_level_18", + "administrative_district_level_2": "administrative_district_level_20", + "administrative_district_level_3": "administrative_district_level_32", + "postal_code": "postal_code6", + "country": "PK", + "first_name": "first_name4", + "last_name": "last_name2" + } + }, + "schedule_type": "SCHEDULED", + "placed_at": "placed_at0", + "deliver_at": "deliver_at8", + "prep_time_duration": "prep_time_duration2", + "delivery_window_duration": "delivery_window_duration4", + "note": "note4", + "completed_at": "completed_at2", + "in_progress_at": "in_progress_at4", + "rejected_at": "rejected_at8", + "ready_at": "ready_at0", + "delivered_at": "delivered_at8", + "canceled_at": "canceled_at4", + "cancel_reason": "cancel_reason4", + "courier_pickup_at": "courier_pickup_at8", + "courier_pickup_window_duration": "courier_pickup_window_duration6", + "is_no_contact_delivery": false, + "dropoff_notes": "dropoff_notes6", + "courier_provider_name": "courier_provider_name2", + "courier_support_phone_number": "courier_support_phone_number4", + "square_delivery_id": "square_delivery_id0", + "external_delivery_id": "external_delivery_id6", + "managed_delivery": false } ``` diff --git a/doc/models/fulfillment-fulfillment-entry.md b/doc/models/fulfillment-fulfillment-entry.md index 41779a5f..a5ed4a45 100644 --- a/doc/models/fulfillment-fulfillment-entry.md +++ b/doc/models/fulfillment-fulfillment-entry.md @@ -22,10 +22,14 @@ fulfill. ```json { - "uid": null, + "uid": "uid0", "line_item_uid": "line_item_uid0", "quantity": "quantity6", - "metadata": null + "metadata": { + "key0": "metadata3", + "key1": "metadata4", + "key2": "metadata5" + } } ``` diff --git a/doc/models/fulfillment-pickup-details-curbside-pickup-details.md b/doc/models/fulfillment-pickup-details-curbside-pickup-details.md index 026115b1..4adad113 100644 --- a/doc/models/fulfillment-pickup-details-curbside-pickup-details.md +++ b/doc/models/fulfillment-pickup-details-curbside-pickup-details.md @@ -18,8 +18,8 @@ Specific details for curbside pickup. ```json { - "curbside_details": null, - "buyer_arrived_at": null + "curbside_details": "curbside_details6", + "buyer_arrived_at": "buyer_arrived_at2" } ``` diff --git a/doc/models/fulfillment-pickup-details.md b/doc/models/fulfillment-pickup-details.md index 0e2348ac..1a0c9524 100644 --- a/doc/models/fulfillment-pickup-details.md +++ b/doc/models/fulfillment-pickup-details.md @@ -34,24 +34,48 @@ Contains details necessary to fulfill a pickup order. ```json { - "recipient": null, - "expires_at": null, - "auto_complete_duration": null, - "schedule_type": null, - "pickup_at": null, - "pickup_window_duration": null, - "prep_time_duration": null, - "note": null, - "placed_at": null, - "accepted_at": null, - "rejected_at": null, - "ready_at": null, - "expired_at": null, - "picked_up_at": null, - "canceled_at": null, - "cancel_reason": null, - "is_curbside_pickup": null, - "curbside_pickup_details": null + "recipient": { + "customer_id": "customer_id6", + "display_name": "display_name8", + "email_address": "email_address4", + "phone_number": "phone_number4", + "address": { + "address_line_1": "address_line_14", + "address_line_2": "address_line_24", + "address_line_3": "address_line_30", + "locality": "locality4", + "sublocality": "sublocality4", + "sublocality_2": "sublocality_22", + "sublocality_3": "sublocality_34", + "administrative_district_level_1": "administrative_district_level_18", + "administrative_district_level_2": "administrative_district_level_20", + "administrative_district_level_3": "administrative_district_level_32", + "postal_code": "postal_code6", + "country": "PK", + "first_name": "first_name4", + "last_name": "last_name2" + } + }, + "expires_at": "expires_at6", + "auto_complete_duration": "auto_complete_duration4", + "schedule_type": "SCHEDULED", + "pickup_at": "pickup_at4", + "pickup_window_duration": "pickup_window_duration0", + "prep_time_duration": "prep_time_duration2", + "note": "note4", + "placed_at": "placed_at0", + "accepted_at": "accepted_at6", + "rejected_at": "rejected_at8", + "ready_at": "ready_at0", + "expired_at": "expired_at0", + "picked_up_at": "picked_up_at0", + "canceled_at": "canceled_at4", + "cancel_reason": "cancel_reason4", + "is_curbside_pickup": false, + "curbside_pickup_details": { + "curbside_details": "curbside_details2", + "buyer_arrived_at": "buyer_arrived_at8" + } } ``` diff --git a/doc/models/fulfillment-recipient.md b/doc/models/fulfillment-recipient.md index 1818afe2..b217bc1f 100644 --- a/doc/models/fulfillment-recipient.md +++ b/doc/models/fulfillment-recipient.md @@ -21,11 +21,26 @@ Information about the fulfillment recipient. ```json { - "customer_id": null, - "display_name": null, - "email_address": null, - "phone_number": null, - "address": null + "customer_id": "customer_id8", + "display_name": "display_name0", + "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", + "sublocality_2": "sublocality_24", + "sublocality_3": "sublocality_36", + "administrative_district_level_1": "administrative_district_level_10", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_34", + "postal_code": "postal_code8", + "country": "BE", + "first_name": "first_name6", + "last_name": "last_name4" + } } ``` diff --git a/doc/models/fulfillment-shipment-details.md b/doc/models/fulfillment-shipment-details.md index 6049f753..20370eab 100644 --- a/doc/models/fulfillment-shipment-details.md +++ b/doc/models/fulfillment-shipment-details.md @@ -31,21 +31,42 @@ Contains the details necessary to fulfill a shipment order. ```json { - "recipient": null, - "carrier": null, - "shipping_note": null, - "shipping_type": null, - "tracking_number": null, - "tracking_url": null, - "placed_at": null, - "in_progress_at": null, - "packaged_at": null, - "expected_shipped_at": null, - "shipped_at": null, - "canceled_at": null, - "cancel_reason": null, - "failed_at": null, - "failure_reason": null + "recipient": { + "customer_id": "customer_id6", + "display_name": "display_name8", + "email_address": "email_address4", + "phone_number": "phone_number4", + "address": { + "address_line_1": "address_line_14", + "address_line_2": "address_line_24", + "address_line_3": "address_line_30", + "locality": "locality4", + "sublocality": "sublocality4", + "sublocality_2": "sublocality_22", + "sublocality_3": "sublocality_34", + "administrative_district_level_1": "administrative_district_level_18", + "administrative_district_level_2": "administrative_district_level_20", + "administrative_district_level_3": "administrative_district_level_32", + "postal_code": "postal_code6", + "country": "PK", + "first_name": "first_name4", + "last_name": "last_name2" + } + }, + "carrier": "carrier2", + "shipping_note": "shipping_note6", + "shipping_type": "shipping_type6", + "tracking_number": "tracking_number8", + "tracking_url": "tracking_url0", + "placed_at": "placed_at0", + "in_progress_at": "in_progress_at4", + "packaged_at": "packaged_at4", + "expected_shipped_at": "expected_shipped_at4", + "shipped_at": "shipped_at8", + "canceled_at": "canceled_at4", + "cancel_reason": "cancel_reason4", + "failed_at": "failed_at4", + "failure_reason": "failure_reason0" } ``` diff --git a/doc/models/fulfillment.md b/doc/models/fulfillment.md index ece9f473..70682f5b 100644 --- a/doc/models/fulfillment.md +++ b/doc/models/fulfillment.md @@ -27,15 +27,155 @@ However, orders returned by the Orders API might contain multiple fulfillments b ```json { - "uid": null, - "type": null, - "state": null, - "line_item_application": null, - "entries": null, - "metadata": null, - "pickup_details": null, - "shipment_details": null, - "delivery_details": null + "uid": "uid0", + "type": "DELIVERY", + "state": "PREPARED", + "line_item_application": "ALL", + "entries": [ + { + "uid": "uid5", + "line_item_uid": "line_item_uid5", + "quantity": "quantity1", + "metadata": { + "key0": "metadata8", + "key1": "metadata9", + "key2": "metadata0" + } + } + ], + "metadata": { + "key0": "metadata3", + "key1": "metadata4", + "key2": "metadata5" + }, + "pickup_details": { + "recipient": { + "customer_id": "customer_id8", + "display_name": "display_name0", + "email_address": "email_address8", + "phone_number": "phone_number8", + "address": { + "address_line_1": "address_line_16", + "address_line_2": "address_line_26", + "address_line_3": "address_line_32", + "locality": "locality6", + "sublocality": "sublocality6", + "sublocality_2": "sublocality_24", + "sublocality_3": "sublocality_36", + "administrative_district_level_1": "administrative_district_level_10", + "administrative_district_level_2": "administrative_district_level_22", + "administrative_district_level_3": "administrative_district_level_34", + "postal_code": "postal_code8", + "country": "TK", + "first_name": "first_name6", + "last_name": "last_name4" + } + }, + "expires_at": "expires_at2", + "auto_complete_duration": "auto_complete_duration2", + "schedule_type": "SCHEDULED", + "pickup_at": "pickup_at6", + "pickup_window_duration": "pickup_window_duration8", + "prep_time_duration": "prep_time_duration0", + "note": "note4", + "placed_at": "placed_at2", + "accepted_at": "accepted_at2", + "rejected_at": "rejected_at0", + "ready_at": "ready_at8", + "expired_at": "expired_at8", + "picked_up_at": "picked_up_at8", + "canceled_at": "canceled_at4", + "cancel_reason": "cancel_reason4", + "is_curbside_pickup": false, + "curbside_pickup_details": { + "curbside_details": "curbside_details0", + "buyer_arrived_at": "buyer_arrived_at6" + } + }, + "shipment_details": { + "recipient": { + "customer_id": "customer_id8", + "display_name": "display_name0", + "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", + "sublocality_2": "sublocality_24", + "sublocality_3": "sublocality_36", + "administrative_district_level_1": "administrative_district_level_10", + "administrative_district_level_2": "administrative_district_level_22", + "administrative_district_level_3": "administrative_district_level_34", + "postal_code": "postal_code8", + "country": "UA", + "first_name": "first_name6", + "last_name": "last_name4" + } + }, + "carrier": "carrier0", + "shipping_note": "shipping_note4", + "shipping_type": "shipping_type8", + "tracking_number": "tracking_number6", + "tracking_url": "tracking_url2", + "placed_at": "placed_at2", + "in_progress_at": "in_progress_at6", + "packaged_at": "packaged_at2", + "expected_shipped_at": "expected_shipped_at2", + "shipped_at": "shipped_at6", + "canceled_at": "canceled_at4", + "cancel_reason": "cancel_reason6", + "failed_at": "failed_at2", + "failure_reason": "failure_reason2" + }, + "delivery_details": { + "recipient": { + "customer_id": "customer_id6", + "display_name": "display_name8", + "email_address": "email_address6", + "phone_number": "phone_number6", + "address": { + "address_line_1": "address_line_14", + "address_line_2": "address_line_24", + "address_line_3": "address_line_30", + "locality": "locality4", + "sublocality": "sublocality4", + "sublocality_2": "sublocality_22", + "sublocality_3": "sublocality_34", + "administrative_district_level_1": "administrative_district_level_18", + "administrative_district_level_2": "administrative_district_level_20", + "administrative_district_level_3": "administrative_district_level_32", + "postal_code": "postal_code6", + "country": "AO", + "first_name": "first_name4", + "last_name": "last_name2" + } + }, + "schedule_type": "SCHEDULED", + "placed_at": "placed_at4", + "deliver_at": "deliver_at4", + "prep_time_duration": "prep_time_duration8", + "delivery_window_duration": "delivery_window_duration0", + "note": "note2", + "completed_at": "completed_at8", + "in_progress_at": "in_progress_at8", + "rejected_at": "rejected_at8", + "ready_at": "ready_at6", + "delivered_at": "delivered_at4", + "canceled_at": "canceled_at2", + "cancel_reason": "cancel_reason2", + "courier_pickup_at": "courier_pickup_at2", + "courier_pickup_window_duration": "courier_pickup_window_duration0", + "is_no_contact_delivery": false, + "dropoff_notes": "dropoff_notes0", + "courier_provider_name": "courier_provider_name6", + "courier_support_phone_number": "courier_support_phone_number2", + "square_delivery_id": "square_delivery_id6", + "external_delivery_id": "external_delivery_id0", + "managed_delivery": false + } } ``` diff --git a/doc/models/gift-card-activity-activate.md b/doc/models/gift-card-activity-activate.md index 5ae290dc..a77fb029 100644 --- a/doc/models/gift-card-activity-activate.md +++ b/doc/models/gift-card-activity-activate.md @@ -12,20 +12,25 @@ Represents details about an `ACTIVATE` [gift card activity type](../../doc/model | Name | Type | Tags | Description | | --- | --- | --- | --- | | `amountMoney` | [`Money \| undefined`](../../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. | -| `orderId` | `string \| undefined` | Optional | The ID of the [order](../../doc/models/order.md) that contains the `GIFT_CARD` line item.

Applications that use the Square Orders API to process orders must specify the order ID
[CreateGiftCardActivity](../../doc/api/gift-card-activities.md#create-gift-card-activity) request. | -| `lineItemUid` | `string \| undefined` | 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](../../doc/api/gift-card-activities.md#create-gift-card-activity) request. | +| `orderId` | `string \| undefined` | 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. | +| `lineItemUid` | `string \| undefined` | 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. | | `referenceId` | `string \| undefined` | 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. | -| `buyerPaymentInstrumentIds` | `string[] \| undefined` | 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](../../doc/api/gift-card-activities.md#create-gift-card-activity) 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. | +| `buyerPaymentInstrumentIds` | `string[] \| undefined` | 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. | ## Example (as JSON) ```json { - "amount_money": null, - "order_id": null, - "line_item_uid": null, - "reference_id": null, - "buyer_payment_instrument_ids": null + "amount_money": { + "amount": 186, + "currency": "NGN" + }, + "order_id": "order_id6", + "line_item_uid": "line_item_uid0", + "reference_id": "reference_id2", + "buyer_payment_instrument_ids": [ + "buyer_payment_instrument_ids6" + ] } ``` diff --git a/doc/models/gift-card-activity-adjust-decrement.md b/doc/models/gift-card-activity-adjust-decrement.md index edeb3b2d..52de6702 100644 --- a/doc/models/gift-card-activity-adjust-decrement.md +++ b/doc/models/gift-card-activity-adjust-decrement.md @@ -19,8 +19,8 @@ Represents details about an `ADJUST_DECREMENT` [gift card activity type](../../d ```json { "amount_money": { - "amount": null, - "currency": null + "amount": 186, + "currency": "NGN" }, "reason": "SUSPICIOUS_ACTIVITY" } diff --git a/doc/models/gift-card-activity-adjust-increment.md b/doc/models/gift-card-activity-adjust-increment.md index 2cecd142..e4669cf5 100644 --- a/doc/models/gift-card-activity-adjust-increment.md +++ b/doc/models/gift-card-activity-adjust-increment.md @@ -19,8 +19,8 @@ Represents details about an `ADJUST_INCREMENT` [gift card activity type](../../d ```json { "amount_money": { - "amount": null, - "currency": null + "amount": 186, + "currency": "NGN" }, "reason": "SUPPORT_ISSUE" } diff --git a/doc/models/gift-card-activity-import-reversal.md b/doc/models/gift-card-activity-import-reversal.md index 4a5644eb..2ac219e5 100644 --- a/doc/models/gift-card-activity-import-reversal.md +++ b/doc/models/gift-card-activity-import-reversal.md @@ -18,8 +18,8 @@ Represents details about an `IMPORT_REVERSAL` [gift card activity type](../../do ```json { "amount_money": { - "amount": null, - "currency": null + "amount": 186, + "currency": "NGN" } } ``` diff --git a/doc/models/gift-card-activity-import.md b/doc/models/gift-card-activity-import.md index c84c5509..a7b11abb 100644 --- a/doc/models/gift-card-activity-import.md +++ b/doc/models/gift-card-activity-import.md @@ -20,8 +20,8 @@ This activity type is used when Square imports a third-party gift card, in which ```json { "amount_money": { - "amount": null, - "currency": null + "amount": 186, + "currency": "NGN" } } ``` diff --git a/doc/models/gift-card-activity-load.md b/doc/models/gift-card-activity-load.md index d5cddd21..8982b6ba 100644 --- a/doc/models/gift-card-activity-load.md +++ b/doc/models/gift-card-activity-load.md @@ -12,20 +12,25 @@ Represents details about a `LOAD` [gift card activity type](../../doc/models/gif | Name | Type | Tags | Description | | --- | --- | --- | --- | | `amountMoney` | [`Money \| undefined`](../../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. | -| `orderId` | `string \| undefined` | Optional | The ID of the [order](../../doc/models/order.md) 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](../../doc/api/gift-card-activities.md#create-gift-card-activity) request. | -| `lineItemUid` | `string \| undefined` | 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](../../doc/api/gift-card-activities.md#create-gift-card-activity) request. | +| `orderId` | `string \| undefined` | 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. | +| `lineItemUid` | `string \| undefined` | 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. | | `referenceId` | `string \| undefined` | 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. | -| `buyerPaymentInstrumentIds` | `string[] \| undefined` | 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](../../doc/api/gift-card-activities.md#create-gift-card-activity) 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. | +| `buyerPaymentInstrumentIds` | `string[] \| undefined` | 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. | ## Example (as JSON) ```json { - "amount_money": null, - "order_id": null, - "line_item_uid": null, - "reference_id": null, - "buyer_payment_instrument_ids": null + "amount_money": { + "amount": 186, + "currency": "NGN" + }, + "order_id": "order_id6", + "line_item_uid": "line_item_uid0", + "reference_id": "reference_id2", + "buyer_payment_instrument_ids": [ + "buyer_payment_instrument_ids6" + ] } ``` diff --git a/doc/models/gift-card-activity-redeem.md b/doc/models/gift-card-activity-redeem.md index aef2faa1..e34facb6 100644 --- a/doc/models/gift-card-activity-redeem.md +++ b/doc/models/gift-card-activity-redeem.md @@ -21,12 +21,12 @@ Represents details about a `REDEEM` [gift card activity type](../../doc/models/g ```json { "amount_money": { - "amount": null, - "currency": null + "amount": 186, + "currency": "NGN" }, - "payment_id": null, - "reference_id": null, - "status": null + "payment_id": "payment_id0", + "reference_id": "reference_id2", + "status": "CANCELED" } ``` diff --git a/doc/models/gift-card-activity-refund.md b/doc/models/gift-card-activity-refund.md index 68cdcd32..7444353f 100644 --- a/doc/models/gift-card-activity-refund.md +++ b/doc/models/gift-card-activity-refund.md @@ -11,7 +11,7 @@ Represents details about a `REFUND` [gift card activity type](../../doc/models/g | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `redeemActivityId` | `string \| undefined` | Optional | The ID of the refunded `REDEEM` gift card activity. Square populates this field if the
`payment_id` in the corresponding [RefundPayment](../../doc/api/refunds.md#refund-payment) request
represents a redemption made by the same gift card. Note that you must use `RefundPayment`
to refund a gift card payment to the same gift card if the payment was processed by Square.

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. | +| `redeemActivityId` | `string \| undefined` | 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 redemption made by the same gift card. Note that you must use `RefundPayment`
to refund a gift card payment to the same gift card if the payment was processed by Square.

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. | | `amountMoney` | [`Money \| undefined`](../../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. | | `referenceId` | `string \| undefined` | Optional | A client-specified ID that associates the gift card activity with an entity in another system. | | `paymentId` | `string \| undefined` | Optional | The ID of the refunded payment. Square populates this field if the refund is for a
payment processed by Square and one of the following conditions is true:

- The Refunds API is used to refund a gift card payment to the same gift card.
- A seller initiated the refund from Square Point of Sale or the Seller Dashboard. The payment source can be the
same gift card or a cross-tender payment from a credit card or a different gift card. | @@ -20,10 +20,13 @@ Represents details about a `REFUND` [gift card activity type](../../doc/models/g ```json { - "redeem_activity_id": null, - "amount_money": null, - "reference_id": null, - "payment_id": null + "redeem_activity_id": "redeem_activity_id0", + "amount_money": { + "amount": 186, + "currency": "NGN" + }, + "reference_id": "reference_id2", + "payment_id": "payment_id0" } ``` diff --git a/doc/models/gift-card-activity-transfer-balance-from.md b/doc/models/gift-card-activity-transfer-balance-from.md index e7961216..9400c78b 100644 --- a/doc/models/gift-card-activity-transfer-balance-from.md +++ b/doc/models/gift-card-activity-transfer-balance-from.md @@ -20,8 +20,8 @@ Represents details about a `TRANSFER_BALANCE_FROM` [gift card activity type](../ { "transfer_to_gift_card_id": "transfer_to_gift_card_id6", "amount_money": { - "amount": null, - "currency": null + "amount": 186, + "currency": "NGN" } } ``` diff --git a/doc/models/gift-card-activity-transfer-balance-to.md b/doc/models/gift-card-activity-transfer-balance-to.md index caaa47a0..98bb12fd 100644 --- a/doc/models/gift-card-activity-transfer-balance-to.md +++ b/doc/models/gift-card-activity-transfer-balance-to.md @@ -20,8 +20,8 @@ Represents details about a `TRANSFER_BALANCE_TO` [gift card activity type](../.. { "transfer_from_gift_card_id": "transfer_from_gift_card_id0", "amount_money": { - "amount": null, - "currency": null + "amount": 186, + "currency": "NGN" } } ``` diff --git a/doc/models/gift-card-activity-unlinked-activity-refund.md b/doc/models/gift-card-activity-unlinked-activity-refund.md index df9509ee..8f05bb63 100644 --- a/doc/models/gift-card-activity-unlinked-activity-refund.md +++ b/doc/models/gift-card-activity-unlinked-activity-refund.md @@ -20,11 +20,11 @@ Represents details about an `UNLINKED_ACTIVITY_REFUND` [gift card activity type] ```json { "amount_money": { - "amount": null, - "currency": null + "amount": 186, + "currency": "NGN" }, - "reference_id": null, - "payment_id": null + "reference_id": "reference_id2", + "payment_id": "payment_id0" } ``` diff --git a/doc/models/gift-card-activity.md b/doc/models/gift-card-activity.md index 276d29c1..53d8ac38 100644 --- a/doc/models/gift-card-activity.md +++ b/doc/models/gift-card-activity.md @@ -15,7 +15,7 @@ includes a `redeem_activity_details` field that contains information about the r | --- | --- | --- | --- | | `id` | `string \| undefined` | Optional | The Square-assigned ID of the gift card activity. | | `type` | [`string`](../../doc/models/gift-card-activity-type.md) | Required | Indicates the type of [gift card activity](../../doc/models/gift-card-activity.md). | -| `locationId` | `string` | Required | The ID of the [business location](../../doc/models/location.md) where the activity occurred. | +| `locationId` | `string` | Required | The ID of the [business location](entity:Location) where the activity occurred. | | `createdAt` | `string \| undefined` | Optional | The timestamp when the gift card activity was created, in RFC 3339 format. | | `giftCardId` | `string \| undefined` | Optional | The gift card ID. When creating a gift card activity, `gift_card_id` is not required if
`gift_card_gan` is specified. | | `giftCardGan` | `string \| undefined` | 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. | @@ -40,28 +40,120 @@ includes a `redeem_activity_details` field that contains information about the r ```json { - "id": null, + "id": "id0", "type": "ADJUST_INCREMENT", "location_id": "location_id4", - "created_at": null, - "gift_card_id": null, - "gift_card_gan": null, - "gift_card_balance_money": null, - "load_activity_details": null, - "activate_activity_details": null, - "redeem_activity_details": null, - "clear_balance_activity_details": null, - "deactivate_activity_details": null, - "adjust_increment_activity_details": null, - "adjust_decrement_activity_details": null, - "refund_activity_details": null, - "unlinked_activity_refund_activity_details": null, - "import_activity_details": null, - "block_activity_details": null, - "unblock_activity_details": null, - "import_reversal_activity_details": null, - "transfer_balance_to_activity_details": null, - "transfer_balance_from_activity_details": null + "created_at": "created_at2", + "gift_card_id": "gift_card_id8", + "gift_card_gan": "gift_card_gan6", + "gift_card_balance_money": { + "amount": 82, + "currency": "LSL" + }, + "load_activity_details": { + "amount_money": { + "amount": 244, + "currency": "BRL" + }, + "order_id": "order_id4", + "line_item_uid": "line_item_uid0", + "reference_id": "reference_id8", + "buyer_payment_instrument_ids": [ + "buyer_payment_instrument_ids6", + "buyer_payment_instrument_ids7" + ] + }, + "activate_activity_details": { + "amount_money": { + "amount": 16, + "currency": "AMD" + }, + "order_id": "order_id4", + "line_item_uid": "line_item_uid0", + "reference_id": "reference_id8", + "buyer_payment_instrument_ids": [ + "buyer_payment_instrument_ids6", + "buyer_payment_instrument_ids7" + ] + }, + "redeem_activity_details": { + "amount_money": { + "amount": 128, + "currency": "MNT" + }, + "payment_id": "payment_id4", + "reference_id": "reference_id8", + "status": "COMPLETED" + }, + "clear_balance_activity_details": { + "reason": "REUSE_GIFTCARD" + }, + "deactivate_activity_details": { + "reason": "CHARGEBACK_DEACTIVATE" + }, + "adjust_increment_activity_details": { + "amount_money": { + "amount": 240, + "currency": "PGK" + }, + "reason": "TRANSACTION_VOIDED" + }, + "adjust_decrement_activity_details": { + "amount_money": { + "amount": 92, + "currency": "QAR" + }, + "reason": "SUPPORT_ISSUE" + }, + "refund_activity_details": { + "redeem_activity_id": "redeem_activity_id0", + "amount_money": { + "amount": 90, + "currency": "BTC" + }, + "reference_id": "reference_id8", + "payment_id": "payment_id0" + }, + "unlinked_activity_refund_activity_details": { + "amount_money": { + "amount": 46, + "currency": "DKK" + }, + "reference_id": "reference_id0", + "payment_id": "payment_id2" + }, + "import_activity_details": { + "amount_money": { + "amount": 170, + "currency": "LBP" + } + }, + "block_activity_details": { + "reason": "reason2" + }, + "unblock_activity_details": { + "reason": "reason0" + }, + "import_reversal_activity_details": { + "amount_money": { + "amount": 106, + "currency": "BHD" + } + }, + "transfer_balance_to_activity_details": { + "transfer_from_gift_card_id": "transfer_from_gift_card_id4", + "amount_money": { + "amount": 224, + "currency": "DJF" + } + }, + "transfer_balance_from_activity_details": { + "transfer_to_gift_card_id": "transfer_to_gift_card_id6", + "amount_money": { + "amount": 42, + "currency": "MAD" + } + } } ``` diff --git a/doc/models/gift-card.md b/doc/models/gift-card.md index 20e6fc40..144d327a 100644 --- a/doc/models/gift-card.md +++ b/doc/models/gift-card.md @@ -18,20 +18,26 @@ Represents a Square gift card. | `balanceMoney` | [`Money \| undefined`](../../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. | | `gan` | `string \| undefined` | Optional | The gift card account number (GAN). Buyers can use the GAN to make purchases or check
the gift card balance. | | `createdAt` | `string \| undefined` | 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. | -| `customerIds` | `string[] \| undefined` | Optional | The IDs of the [customer profiles](../../doc/models/customer.md) to whom this gift card is linked. | +| `customerIds` | `string[] \| undefined` | Optional | The IDs of the [customer profiles](entity:Customer) to whom this gift card is linked. | ## Example (as JSON) ```json { - "id": null, + "id": "id0", "type": "PHYSICAL", - "gan_source": null, - "state": null, - "balance_money": null, - "gan": null, - "created_at": null, - "customer_ids": null + "gan_source": "SQUARE", + "state": "ACTIVE", + "balance_money": { + "amount": 146, + "currency": "ARS" + }, + "gan": "gan6", + "created_at": "created_at2", + "customer_ids": [ + "customer_ids1", + "customer_ids2" + ] } ``` diff --git a/doc/models/inventory-adjustment-group.md b/doc/models/inventory-adjustment-group.md index 7758cb49..68417db8 100644 --- a/doc/models/inventory-adjustment-group.md +++ b/doc/models/inventory-adjustment-group.md @@ -18,10 +18,10 @@ ```json { - "id": null, - "root_adjustment_id": null, - "from_state": null, - "to_state": null + "id": "id0", + "root_adjustment_id": "root_adjustment_id0", + "from_state": "UNLINKED_RETURN", + "to_state": "SUPPORTED_BY_NEWER_VERSION" } ``` diff --git a/doc/models/inventory-adjustment.md b/doc/models/inventory-adjustment.md index 58ac115e..389a2724 100644 --- a/doc/models/inventory-adjustment.md +++ b/doc/models/inventory-adjustment.md @@ -16,18 +16,18 @@ particular time and location. | `referenceId` | `string \| undefined` | Optional | An optional ID provided by the application to tie the
`InventoryAdjustment` to an external
system.
**Constraints**: *Maximum Length*: `255` | | `fromState` | [`string \| undefined`](../../doc/models/inventory-state.md) | Optional | Indicates the state of a tracked item quantity in the lifecycle of goods. | | `toState` | [`string \| undefined`](../../doc/models/inventory-state.md) | Optional | Indicates the state of a tracked item quantity in the lifecycle of goods. | -| `locationId` | `string \| undefined` | Optional | The Square-generated ID of the [Location](../../doc/models/location.md) where the related
quantity of items is being tracked.
**Constraints**: *Maximum Length*: `100` | -| `catalogObjectId` | `string \| undefined` | Optional | The Square-generated ID of the
[CatalogObject](../../doc/models/catalog-object.md) being tracked.
**Constraints**: *Maximum Length*: `100` | -| `catalogObjectType` | `string \| undefined` | Optional | The [type](../../doc/models/catalog-object-type.md) of the [CatalogObject](../../doc/models/catalog-object.md) 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` | +| `locationId` | `string \| undefined` | Optional | The Square-generated ID of the [Location](entity:Location) where the related
quantity of items is being tracked.
**Constraints**: *Maximum Length*: `100` | +| `catalogObjectId` | `string \| undefined` | Optional | The Square-generated ID of the
[CatalogObject](entity:CatalogObject) being tracked.
**Constraints**: *Maximum Length*: `100` | +| `catalogObjectType` | `string \| undefined` | 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` | | `quantity` | `string \| undefined` | 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` | | `totalPriceMoney` | [`Money \| undefined`](../../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. | | `occurredAt` | `string \| undefined` | 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` | | `createdAt` | `string \| undefined` | Optional | An RFC 3339-formatted timestamp that indicates when the inventory adjustment is received.
**Constraints**: *Maximum Length*: `34` | | `source` | [`SourceApplication \| undefined`](../../doc/models/source-application.md) | Optional | Represents information about the application used to generate a change. | -| `employeeId` | `string \| undefined` | Optional | The Square-generated ID of the [Employee](../../doc/models/employee.md) responsible for the
inventory adjustment.
**Constraints**: *Maximum Length*: `100` | -| `teamMemberId` | `string \| undefined` | Optional | The Square-generated ID of the [Team Member](../../doc/models/team-member.md) responsible for the
inventory adjustment.
**Constraints**: *Maximum Length*: `100` | -| `transactionId` | `string \| undefined` | Optional | The Square-generated ID of the [Transaction](../../doc/models/transaction.md) that
caused the adjustment. Only relevant for payment-related state
transitions.
**Constraints**: *Maximum Length*: `255` | -| `refundId` | `string \| undefined` | Optional | The Square-generated ID of the [Refund](../../doc/models/refund.md) that
caused the adjustment. Only relevant for refund-related state
transitions.
**Constraints**: *Maximum Length*: `255` | +| `employeeId` | `string \| undefined` | Optional | The Square-generated ID of the [Employee](entity:Employee) responsible for the
inventory adjustment.
**Constraints**: *Maximum Length*: `100` | +| `teamMemberId` | `string \| undefined` | Optional | The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the
inventory adjustment.
**Constraints**: *Maximum Length*: `100` | +| `transactionId` | `string \| undefined` | 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` | +| `refundId` | `string \| undefined` | 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` | | `purchaseOrderId` | `string \| undefined` | 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` | | `goodsReceiptId` | `string \| undefined` | 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` | | `adjustmentGroup` | [`InventoryAdjustmentGroup \| undefined`](../../doc/models/inventory-adjustment-group.md) | Optional | - | @@ -36,25 +36,37 @@ particular time and location. ```json { - "id": null, - "reference_id": null, - "from_state": null, - "to_state": null, - "location_id": null, - "catalog_object_id": null, - "catalog_object_type": null, - "quantity": null, - "total_price_money": null, - "occurred_at": null, - "created_at": null, - "source": null, - "employee_id": null, - "team_member_id": null, - "transaction_id": null, - "refund_id": null, - "purchase_order_id": null, - "goods_receipt_id": null, - "adjustment_group": null + "id": "id0", + "reference_id": "reference_id2", + "from_state": "UNLINKED_RETURN", + "to_state": "SUPPORTED_BY_NEWER_VERSION", + "location_id": "location_id4", + "catalog_object_id": "catalog_object_id6", + "catalog_object_type": "catalog_object_type6", + "quantity": "quantity6", + "total_price_money": { + "amount": 52, + "currency": "MYR" + }, + "occurred_at": "occurred_at4", + "created_at": "created_at2", + "source": { + "product": "PAYROLL", + "application_id": "application_id0", + "name": "name4" + }, + "employee_id": "employee_id0", + "team_member_id": "team_member_id0", + "transaction_id": "transaction_id8", + "refund_id": "refund_id4", + "purchase_order_id": "purchase_order_id0", + "goods_receipt_id": "goods_receipt_id8", + "adjustment_group": { + "id": "id2", + "root_adjustment_id": "root_adjustment_id2", + "from_state": "IN_TRANSIT_TO", + "to_state": "UNLINKED_RETURN" + } } ``` diff --git a/doc/models/inventory-change.md b/doc/models/inventory-change.md index f103f8b3..cc865d72 100644 --- a/doc/models/inventory-change.md +++ b/doc/models/inventory-change.md @@ -18,18 +18,100 @@ that is part of the history of inventory changes for a particular | `adjustment` | [`InventoryAdjustment \| undefined`](../../doc/models/inventory-adjustment.md) | Optional | Represents a change in state or quantity of product inventory at a
particular time and location. | | `transfer` | [`InventoryTransfer \| undefined`](../../doc/models/inventory-transfer.md) | Optional | Represents the transfer of a quantity of product inventory at a
particular time from one location to another. | | `measurementUnit` | [`CatalogMeasurementUnit \| undefined`](../../doc/models/catalog-measurement-unit.md) | Optional | Represents the unit used to measure a `CatalogItemVariation` and
specifies the precision for decimal quantities. | -| `measurementUnitId` | `string \| undefined` | Optional | The ID of the [CatalogMeasurementUnit](../../doc/models/catalog-measurement-unit.md) object representing the catalog measurement unit associated with the inventory change. | +| `measurementUnitId` | `string \| undefined` | Optional | The ID of the [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change. | ## Example (as JSON) ```json { - "type": null, - "physical_count": null, - "adjustment": null, - "transfer": null, - "measurement_unit": null, - "measurement_unit_id": null + "type": "TRANSFER", + "physical_count": { + "id": "id2", + "reference_id": "reference_id0", + "catalog_object_id": "catalog_object_id6", + "catalog_object_type": "catalog_object_type6", + "state": "RETURNED_BY_CUSTOMER", + "location_id": "location_id6", + "quantity": "quantity8", + "source": { + "product": "BILLING", + "application_id": "application_id6", + "name": "name8" + }, + "employee_id": "employee_id2", + "team_member_id": "team_member_id2", + "occurred_at": "occurred_at6", + "created_at": "created_at0" + }, + "adjustment": { + "id": "id4", + "reference_id": "reference_id2", + "from_state": "WASTE", + "to_state": "DECOMPOSED", + "location_id": "location_id8", + "catalog_object_id": "catalog_object_id8", + "catalog_object_type": "catalog_object_type8", + "quantity": "quantity0", + "total_price_money": { + "amount": 84, + "currency": "GNF" + }, + "occurred_at": "occurred_at8", + "created_at": "created_at2", + "source": { + "product": "SQUARE_POS", + "application_id": "application_id4", + "name": "name0" + }, + "employee_id": "employee_id4", + "team_member_id": "team_member_id4", + "transaction_id": "transaction_id2", + "refund_id": "refund_id8", + "purchase_order_id": "purchase_order_id4", + "goods_receipt_id": "goods_receipt_id2", + "adjustment_group": { + "id": "id6", + "root_adjustment_id": "root_adjustment_id6", + "from_state": "RECEIVED_FROM_VENDOR", + "to_state": "WASTE" + } + }, + "transfer": { + "id": "id8", + "reference_id": "reference_id6", + "state": "RESERVED_FOR_SALE", + "from_location_id": "from_location_id0", + "to_location_id": "to_location_id0", + "catalog_object_id": "catalog_object_id2", + "catalog_object_type": "catalog_object_type2", + "quantity": "quantity4", + "occurred_at": "occurred_at2", + "created_at": "created_at6", + "source": { + "product": "PAYROLL", + "application_id": "application_id0", + "name": "name4" + }, + "employee_id": "employee_id8", + "team_member_id": "team_member_id8" + }, + "measurement_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name2", + "abbreviation": "abbreviation4" + }, + "area_unit": "IMPERIAL_SQUARE_MILE", + "length_unit": "METRIC_MILLIMETER", + "volume_unit": "GENERIC_CUP", + "weight_unit": "IMPERIAL_STONE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MINUTE", + "type": "TYPE_LENGTH" + }, + "precision": 184 + }, + "measurement_unit_id": "measurement_unit_id0" } ``` diff --git a/doc/models/inventory-count.md b/doc/models/inventory-count.md index cf2b3bc7..6d07055d 100644 --- a/doc/models/inventory-count.md +++ b/doc/models/inventory-count.md @@ -13,10 +13,10 @@ inventory adjustments. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `catalogObjectId` | `string \| undefined` | Optional | The Square-generated ID of the
[CatalogObject](../../doc/models/catalog-object.md) being tracked.
**Constraints**: *Maximum Length*: `100` | -| `catalogObjectType` | `string \| undefined` | Optional | The [type](../../doc/models/catalog-object-type.md) of the [CatalogObject](../../doc/models/catalog-object.md) 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` | +| `catalogObjectId` | `string \| undefined` | Optional | The Square-generated ID of the
[CatalogObject](entity:CatalogObject) being tracked.
**Constraints**: *Maximum Length*: `100` | +| `catalogObjectType` | `string \| undefined` | 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` | | `state` | [`string \| undefined`](../../doc/models/inventory-state.md) | Optional | Indicates the state of a tracked item quantity in the lifecycle of goods. | -| `locationId` | `string \| undefined` | Optional | The Square-generated ID of the [Location](../../doc/models/location.md) where the related
quantity of items is being tracked.
**Constraints**: *Maximum Length*: `100` | +| `locationId` | `string \| undefined` | Optional | The Square-generated ID of the [Location](entity:Location) where the related
quantity of items is being tracked.
**Constraints**: *Maximum Length*: `100` | | `quantity` | `string \| undefined` | 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` | | `calculatedAt` | `string \| undefined` | 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` | | `isEstimated` | `boolean \| undefined` | 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/api/inventory.md#batch-change-inventory),
[BatchRetrieveInventoryChanges](../../doc/api/inventory.md#batch-retrieve-inventory-changes),
[BatchRetrieveInventoryCounts](../../doc/api/inventory.md#batch-retrieve-inventory-counts), and
[RetrieveInventoryChanges](../../doc/api/inventory.md#retrieve-inventory-changes). | @@ -25,13 +25,13 @@ inventory adjustments. ```json { - "catalog_object_id": null, - "catalog_object_type": null, - "state": null, - "location_id": null, - "quantity": null, - "calculated_at": null, - "is_estimated": null + "catalog_object_id": "catalog_object_id6", + "catalog_object_type": "catalog_object_type6", + "state": "SUPPORTED_BY_NEWER_VERSION", + "location_id": "location_id4", + "quantity": "quantity6", + "calculated_at": "calculated_at2", + "is_estimated": false } ``` diff --git a/doc/models/inventory-physical-count.md b/doc/models/inventory-physical-count.md index d4045442..857ebfe1 100644 --- a/doc/models/inventory-physical-count.md +++ b/doc/models/inventory-physical-count.md @@ -14,16 +14,16 @@ hand or from syncing with an external system. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `string \| undefined` | Optional | A unique Square-generated ID for the
[InventoryPhysicalCount](../../doc/models/inventory-physical-count.md).
**Constraints**: *Maximum Length*: `100` | -| `referenceId` | `string \| undefined` | Optional | An optional ID provided by the application to tie the
[InventoryPhysicalCount](../../doc/models/inventory-physical-count.md) to an external
system.
**Constraints**: *Maximum Length*: `255` | -| `catalogObjectId` | `string \| undefined` | Optional | The Square-generated ID of the
[CatalogObject](../../doc/models/catalog-object.md) being tracked.
**Constraints**: *Maximum Length*: `100` | -| `catalogObjectType` | `string \| undefined` | Optional | The [type](../../doc/models/catalog-object-type.md) of the [CatalogObject](../../doc/models/catalog-object.md) 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` | +| `id` | `string \| undefined` | Optional | A unique Square-generated ID for the
[InventoryPhysicalCount](entity:InventoryPhysicalCount).
**Constraints**: *Maximum Length*: `100` | +| `referenceId` | `string \| undefined` | Optional | An optional ID provided by the application to tie the
[InventoryPhysicalCount](entity:InventoryPhysicalCount) to an external
system.
**Constraints**: *Maximum Length*: `255` | +| `catalogObjectId` | `string \| undefined` | Optional | The Square-generated ID of the
[CatalogObject](entity:CatalogObject) being tracked.
**Constraints**: *Maximum Length*: `100` | +| `catalogObjectType` | `string \| undefined` | 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` | | `state` | [`string \| undefined`](../../doc/models/inventory-state.md) | Optional | Indicates the state of a tracked item quantity in the lifecycle of goods. | -| `locationId` | `string \| undefined` | Optional | The Square-generated ID of the [Location](../../doc/models/location.md) where the related
quantity of items is being tracked.
**Constraints**: *Maximum Length*: `100` | +| `locationId` | `string \| undefined` | Optional | The Square-generated ID of the [Location](entity:Location) where the related
quantity of items is being tracked.
**Constraints**: *Maximum Length*: `100` | | `quantity` | `string \| undefined` | 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` | | `source` | [`SourceApplication \| undefined`](../../doc/models/source-application.md) | Optional | Represents information about the application used to generate a change. | -| `employeeId` | `string \| undefined` | Optional | The Square-generated ID of the [Employee](../../doc/models/employee.md) responsible for the
physical count.
**Constraints**: *Maximum Length*: `100` | -| `teamMemberId` | `string \| undefined` | Optional | The Square-generated ID of the [Team Member](../../doc/models/team-member.md) responsible for the
physical count.
**Constraints**: *Maximum Length*: `100` | +| `employeeId` | `string \| undefined` | Optional | The Square-generated ID of the [Employee](entity:Employee) responsible for the
physical count.
**Constraints**: *Maximum Length*: `100` | +| `teamMemberId` | `string \| undefined` | Optional | The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the
physical count.
**Constraints**: *Maximum Length*: `100` | | `occurredAt` | `string \| undefined` | 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` | | `createdAt` | `string \| undefined` | Optional | An RFC 3339-formatted timestamp that indicates when the physical count is received.
**Constraints**: *Maximum Length*: `34` | @@ -31,18 +31,22 @@ hand or from syncing with an external system. ```json { - "id": null, - "reference_id": null, - "catalog_object_id": null, - "catalog_object_type": null, - "state": null, - "location_id": null, - "quantity": null, - "source": null, - "employee_id": null, - "team_member_id": null, - "occurred_at": null, - "created_at": null + "id": "id0", + "reference_id": "reference_id2", + "catalog_object_id": "catalog_object_id6", + "catalog_object_type": "catalog_object_type6", + "state": "SUPPORTED_BY_NEWER_VERSION", + "location_id": "location_id4", + "quantity": "quantity6", + "source": { + "product": "PAYROLL", + "application_id": "application_id0", + "name": "name4" + }, + "employee_id": "employee_id0", + "team_member_id": "team_member_id0", + "occurred_at": "occurred_at4", + "created_at": "created_at2" } ``` diff --git a/doc/models/inventory-transfer.md b/doc/models/inventory-transfer.md index 315509a0..c8d80486 100644 --- a/doc/models/inventory-transfer.md +++ b/doc/models/inventory-transfer.md @@ -15,34 +15,38 @@ particular time from one location to another. | `id` | `string \| undefined` | Optional | A unique ID generated by Square for the
`InventoryTransfer`.
**Constraints**: *Maximum Length*: `100` | | `referenceId` | `string \| undefined` | Optional | An optional ID provided by the application to tie the
`InventoryTransfer` to an external system.
**Constraints**: *Maximum Length*: `255` | | `state` | [`string \| undefined`](../../doc/models/inventory-state.md) | Optional | Indicates the state of a tracked item quantity in the lifecycle of goods. | -| `fromLocationId` | `string \| undefined` | Optional | The Square-generated ID of the [Location](../../doc/models/location.md) where the related
quantity of items was tracked before the transfer.
**Constraints**: *Maximum Length*: `100` | -| `toLocationId` | `string \| undefined` | Optional | The Square-generated ID of the [Location](../../doc/models/location.md) where the related
quantity of items was tracked after the transfer.
**Constraints**: *Maximum Length*: `100` | -| `catalogObjectId` | `string \| undefined` | Optional | The Square-generated ID of the
[CatalogObject](../../doc/models/catalog-object.md) being tracked.
**Constraints**: *Maximum Length*: `100` | -| `catalogObjectType` | `string \| undefined` | Optional | The [type](../../doc/models/catalog-object-type.md) of the [CatalogObject](../../doc/models/catalog-object.md) 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` | +| `fromLocationId` | `string \| undefined` | 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` | +| `toLocationId` | `string \| undefined` | 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` | +| `catalogObjectId` | `string \| undefined` | Optional | The Square-generated ID of the
[CatalogObject](entity:CatalogObject) being tracked.
**Constraints**: *Maximum Length*: `100` | +| `catalogObjectType` | `string \| undefined` | 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` | | `quantity` | `string \| undefined` | 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` | | `occurredAt` | `string \| undefined` | 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` | | `createdAt` | `string \| undefined` | Optional | An RFC 3339-formatted timestamp that indicates when Square
received the transfer request.
**Constraints**: *Maximum Length*: `34` | | `source` | [`SourceApplication \| undefined`](../../doc/models/source-application.md) | Optional | Represents information about the application used to generate a change. | -| `employeeId` | `string \| undefined` | Optional | The Square-generated ID of the [Employee](../../doc/models/employee.md) responsible for the
inventory transfer.
**Constraints**: *Maximum Length*: `100` | -| `teamMemberId` | `string \| undefined` | Optional | The Square-generated ID of the [Team Member](../../doc/models/team-member.md) responsible for the
inventory transfer.
**Constraints**: *Maximum Length*: `100` | +| `employeeId` | `string \| undefined` | Optional | The Square-generated ID of the [Employee](entity:Employee) responsible for the
inventory transfer.
**Constraints**: *Maximum Length*: `100` | +| `teamMemberId` | `string \| undefined` | Optional | The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the
inventory transfer.
**Constraints**: *Maximum Length*: `100` | ## Example (as JSON) ```json { - "id": null, - "reference_id": null, - "state": null, - "from_location_id": null, - "to_location_id": null, - "catalog_object_id": null, - "catalog_object_type": null, - "quantity": null, - "occurred_at": null, - "created_at": null, - "source": null, - "employee_id": null, - "team_member_id": null + "id": "id0", + "reference_id": "reference_id2", + "state": "SUPPORTED_BY_NEWER_VERSION", + "from_location_id": "from_location_id2", + "to_location_id": "to_location_id8", + "catalog_object_id": "catalog_object_id6", + "catalog_object_type": "catalog_object_type6", + "quantity": "quantity6", + "occurred_at": "occurred_at4", + "created_at": "created_at2", + "source": { + "product": "PAYROLL", + "application_id": "application_id0", + "name": "name4" + }, + "employee_id": "employee_id0", + "team_member_id": "team_member_id0" } ``` diff --git a/doc/models/invoice-accepted-payment-methods.md b/doc/models/invoice-accepted-payment-methods.md index 3a487901..75de30ee 100644 --- a/doc/models/invoice-accepted-payment-methods.md +++ b/doc/models/invoice-accepted-payment-methods.md @@ -20,10 +20,10 @@ The payment methods that customers can use to pay an [invoice](../../doc/models/ ```json { - "card": null, - "square_gift_card": null, - "bank_account": null, - "buy_now_pay_later": null + "card": false, + "square_gift_card": false, + "bank_account": false, + "buy_now_pay_later": false } ``` diff --git a/doc/models/invoice-custom-field.md b/doc/models/invoice-custom-field.md index 71918bc4..a7fcea75 100644 --- a/doc/models/invoice-custom-field.md +++ b/doc/models/invoice-custom-field.md @@ -23,9 +23,9 @@ Adding custom fields to an invoice requires an ```json { - "label": null, - "value": null, - "placement": null + "label": "label0", + "value": "value2", + "placement": "ABOVE_LINE_ITEMS" } ``` diff --git a/doc/models/invoice-filter.md b/doc/models/invoice-filter.md index 5ed63feb..938eaff6 100644 --- a/doc/models/invoice-filter.md +++ b/doc/models/invoice-filter.md @@ -21,7 +21,10 @@ Describes query filters to apply. "location_ids": [ "location_ids0" ], - "customer_ids": null + "customer_ids": [ + "customer_ids1", + "customer_ids2" + ] } ``` diff --git a/doc/models/invoice-payment-reminder.md b/doc/models/invoice-payment-reminder.md index b6aaf6a6..c65f0bc2 100644 --- a/doc/models/invoice-payment-reminder.md +++ b/doc/models/invoice-payment-reminder.md @@ -23,11 +23,11 @@ to the customer. You configure a reminder relative to the payment request ```json { - "uid": null, - "relative_scheduled_days": null, - "message": null, - "status": null, - "sent_at": null + "uid": "uid0", + "relative_scheduled_days": 0, + "message": "message0", + "status": "SENT", + "sent_at": "sent_at0" } ``` diff --git a/doc/models/invoice-payment-request.md b/doc/models/invoice-payment-request.md index 98e4123d..46c52127 100644 --- a/doc/models/invoice-payment-request.md +++ b/doc/models/invoice-payment-request.md @@ -16,7 +16,7 @@ Adding `INSTALLMENT` payment requests to an invoice requires an | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `uid` | `string \| undefined` | Optional | The Square-generated ID of the payment request in an [invoice](../../doc/models/invoice.md).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | +| `uid` | `string \| undefined` | Optional | The Square-generated ID of the payment request in an [invoice](entity:Invoice).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | | `requestMethod` | [`string \| undefined`](../../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. | | `requestType` | [`string \| undefined`](../../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). | | `dueDate` | `string \| undefined` | 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). | @@ -24,7 +24,7 @@ Adding `INSTALLMENT` payment requests to an invoice requires an | `percentageRequested` | `string \| undefined` | 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. | | `tippingEnabled` | `boolean \| undefined` | 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`. | | `automaticPaymentSource` | [`string \| undefined`](../../doc/models/invoice-automatic-payment-source.md) | Optional | Indicates the automatic payment method for an [invoice payment request](../../doc/models/invoice-payment-request.md). | -| `cardId` | `string \| undefined` | 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](../../doc/api/cards.md#list-cards) and include the `customer_id` of the invoice recipient.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | +| `cardId` | `string \| undefined` | 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` | | `reminders` | [`InvoicePaymentReminder[] \| undefined`](../../doc/models/invoice-payment-reminder.md) | Optional | A list of one or more reminders to send for the payment request. | | `computedAmountMoney` | [`Money \| undefined`](../../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. | | `totalCompletedAmountMoney` | [`Money \| undefined`](../../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. | @@ -34,19 +34,53 @@ Adding `INSTALLMENT` payment requests to an invoice requires an ```json { - "uid": null, - "request_method": null, - "request_type": null, - "due_date": null, - "fixed_amount_requested_money": null, - "percentage_requested": null, - "tipping_enabled": null, - "automatic_payment_source": null, - "card_id": null, - "reminders": null, - "computed_amount_money": null, - "total_completed_amount_money": null, - "rounding_adjustment_included_money": null + "uid": "uid0", + "request_method": "CHARGE_CARD_ON_FILE", + "request_type": "BALANCE", + "due_date": "due_date8", + "fixed_amount_requested_money": { + "amount": 162, + "currency": "TOP" + }, + "percentage_requested": "percentage_requested2", + "tipping_enabled": false, + "automatic_payment_source": "CARD_ON_FILE", + "card_id": "card_id4", + "reminders": [ + { + "uid": "uid6", + "relative_scheduled_days": 86, + "message": "message6", + "status": "NOT_APPLICABLE", + "sent_at": "sent_at6" + }, + { + "uid": "uid7", + "relative_scheduled_days": 87, + "message": "message7", + "status": "PENDING", + "sent_at": "sent_at7" + }, + { + "uid": "uid8", + "relative_scheduled_days": 88, + "message": "message8", + "status": "SENT", + "sent_at": "sent_at8" + } + ], + "computed_amount_money": { + "amount": 32, + "currency": "ETB" + }, + "total_completed_amount_money": { + "amount": 168, + "currency": "BIF" + }, + "rounding_adjustment_included_money": { + "amount": 232, + "currency": "SEK" + } } ``` diff --git a/doc/models/invoice-query.md b/doc/models/invoice-query.md index b2cebe10..e1daf637 100644 --- a/doc/models/invoice-query.md +++ b/doc/models/invoice-query.md @@ -22,9 +22,15 @@ Describes query criteria for searching invoices. "location_ids": [ "location_ids4" ], - "customer_ids": null + "customer_ids": [ + "customer_ids3", + "customer_ids2" + ] }, - "sort": null + "sort": { + "field": "field2", + "order": "DESC" + } } ``` diff --git a/doc/models/invoice-recipient-tax-ids.md b/doc/models/invoice-recipient-tax-ids.md index a95f7bf6..3e763ee2 100644 --- a/doc/models/invoice-recipient-tax-ids.md +++ b/doc/models/invoice-recipient-tax-ids.md @@ -19,7 +19,7 @@ see [Invoice recipient tax IDs](https://developer.squareup.com/docs/invoices-api ```json { - "eu_vat": null + "eu_vat": "eu_vat2" } ``` diff --git a/doc/models/invoice-recipient.md b/doc/models/invoice-recipient.md index 676e4666..6468271b 100644 --- a/doc/models/invoice-recipient.md +++ b/doc/models/invoice-recipient.md @@ -29,14 +29,31 @@ Square updates the customer ID in response to a merge operation, but does not up ```json { - "customer_id": null, - "given_name": null, - "family_name": null, - "email_address": null, - "address": null, - "phone_number": null, - "company_name": null, - "tax_ids": null + "customer_id": "customer_id8", + "given_name": "given_name2", + "family_name": "family_name6", + "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", + "sublocality_2": "sublocality_24", + "sublocality_3": "sublocality_36", + "administrative_district_level_1": "administrative_district_level_10", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_34", + "postal_code": "postal_code8", + "country": "BE", + "first_name": "first_name6", + "last_name": "last_name4" + }, + "phone_number": "phone_number2", + "company_name": "company_name6", + "tax_ids": { + "eu_vat": "eu_vat2" + } } ``` diff --git a/doc/models/invoice-request-method.md b/doc/models/invoice-request-method.md index ea353ceb..5cc9e397 100644 --- a/doc/models/invoice-request-method.md +++ b/doc/models/invoice-request-method.md @@ -14,11 +14,11 @@ version 2021-01-21. The corresponding `request_method` field is replaced by the | 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](../../doc/models/invoice.md)). | +| `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 bank account on file on the `due_date` specified in the
payment request and to use email to send invoices, reminders, and receipts.

The bank on file payment method applies only to recurring invoices that sellers create in the Seller Dashboard or other
Square first-party applications. 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](../../doc/models/invoice.md)).

You cannot set `SMS` 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 bank account on file on the `due_date` specified in the payment request
and to use SMS (text message) to send invoices and receipts.

The bank on file payment method applies only to recurring invoices that sellers create in the Seller Dashboard
or other Square first-party applications. 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.md b/doc/models/invoice.md index 3825fc7d..139d3865 100644 --- a/doc/models/invoice.md +++ b/doc/models/invoice.md @@ -15,7 +15,7 @@ invoices. For more information, see [Invoices API Overview](https://developer.sq | `id` | `string \| undefined` | Optional | The Square-assigned ID of the invoice. | | `version` | `number \| undefined` | Optional | The Square-assigned version number, which is incremented each time an update is committed to the invoice. | | `locationId` | `string \| undefined` | 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` | -| `orderId` | `string \| undefined` | Optional | The ID of the [order](../../doc/models/order.md) 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](../../doc/api/orders.md#retrieve-order) endpoint using the order ID.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | +| `orderId` | `string \| undefined` | 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` | | `primaryRecipient` | [`InvoiceRecipient \| undefined`](../../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. | | `paymentRequests` | [`InvoicePaymentRequest[] \| undefined`](../../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). | | `deliveryMethod` | [`string \| undefined`](../../doc/models/invoice-delivery-method.md) | Optional | Indicates how Square delivers the [invoice](../../doc/models/invoice.md) to the customer. | @@ -31,7 +31,7 @@ invoices. For more information, see [Invoices API Overview](https://developer.sq | `updatedAt` | `string \| undefined` | Optional | The timestamp when the invoice was last updated, in RFC 3339 format. | | `acceptedPaymentMethods` | [`InvoiceAcceptedPaymentMethods \| undefined`](../../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. | | `customFields` | [`InvoiceCustomField[] \| undefined`](../../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 | -| `subscriptionId` | `string \| undefined` | Optional | The ID of the [subscription](../../doc/models/subscription.md) associated with the invoice.
This field is present only on subscription billing invoices. | +| `subscriptionId` | `string \| undefined` | Optional | The ID of the [subscription](entity:Subscription) associated with the invoice.
This field is present only on subscription billing invoices. | | `saleOrServiceDate` | `string \| undefined` | 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. | | `paymentConditions` | `string \| undefined` | 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` | | `storePaymentMethodEnabled` | `boolean \| undefined` | 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`. | @@ -40,29 +40,123 @@ invoices. For more information, see [Invoices API Overview](https://developer.sq ```json { - "id": null, - "version": null, - "location_id": null, - "order_id": null, - "primary_recipient": null, - "payment_requests": null, - "delivery_method": null, - "invoice_number": null, - "title": null, - "description": null, - "scheduled_at": null, - "public_url": null, - "next_payment_amount_money": null, - "status": null, - "timezone": null, - "created_at": null, - "updated_at": null, - "accepted_payment_methods": null, - "custom_fields": null, - "subscription_id": null, - "sale_or_service_date": null, - "payment_conditions": null, - "store_payment_method_enabled": null + "id": "id0", + "version": 172, + "location_id": "location_id4", + "order_id": "order_id6", + "primary_recipient": { + "customer_id": "customer_id2", + "given_name": "given_name6", + "family_name": "family_name8", + "email_address": "email_address2", + "address": { + "address_line_1": "address_line_10", + "address_line_2": "address_line_20", + "address_line_3": "address_line_36", + "locality": "locality0", + "sublocality": "sublocality0", + "sublocality_2": "sublocality_28", + "sublocality_3": "sublocality_30", + "administrative_district_level_1": "administrative_district_level_14", + "administrative_district_level_2": "administrative_district_level_26", + "administrative_district_level_3": "administrative_district_level_38", + "postal_code": "postal_code2", + "country": "TO", + "first_name": "first_name0", + "last_name": "last_name8" + }, + "phone_number": "phone_number2", + "company_name": "company_name0", + "tax_ids": { + "eu_vat": "eu_vat2" + } + }, + "payment_requests": [ + { + "uid": "uid4", + "request_method": "SMS", + "request_type": "BALANCE", + "due_date": "due_date2", + "fixed_amount_requested_money": { + "amount": 6, + "currency": "MZN" + }, + "percentage_requested": "percentage_requested8", + "tipping_enabled": false, + "automatic_payment_source": "CARD_ON_FILE", + "card_id": "card_id0", + "reminders": [ + { + "uid": "uid2", + "relative_scheduled_days": 242, + "message": "message8", + "status": "NOT_APPLICABLE", + "sent_at": "sent_at2" + }, + { + "uid": "uid3", + "relative_scheduled_days": 243, + "message": "message7", + "status": "PENDING", + "sent_at": "sent_at3" + }, + { + "uid": "uid4", + "relative_scheduled_days": 244, + "message": "message6", + "status": "SENT", + "sent_at": "sent_at4" + } + ], + "computed_amount_money": { + "amount": 132, + "currency": "AWG" + }, + "total_completed_amount_money": {}, + "rounding_adjustment_included_money": {} + } + ], + "delivery_method": "SHARE_MANUALLY", + "invoice_number": "invoice_number4", + "title": "title4", + "description": "description0", + "scheduled_at": "scheduled_at6", + "public_url": "public_url8", + "next_payment_amount_money": { + "amount": 236, + "currency": "PAB" + }, + "status": "FAILED", + "timezone": "timezone0", + "created_at": "created_at2", + "updated_at": "updated_at4", + "accepted_payment_methods": { + "card": false, + "square_gift_card": false, + "bank_account": false, + "buy_now_pay_later": false + }, + "custom_fields": [ + { + "label": "label3", + "value": "value5", + "placement": "BELOW_LINE_ITEMS" + }, + { + "label": "label4", + "value": "value6", + "placement": "ABOVE_LINE_ITEMS" + }, + { + "label": "label5", + "value": "value7", + "placement": "BELOW_LINE_ITEMS" + } + ], + "subscription_id": "subscription_id0", + "sale_or_service_date": "sale_or_service_date6", + "payment_conditions": "payment_conditions4", + "store_payment_method_enabled": false } ``` diff --git a/doc/models/item-variation-location-overrides.md b/doc/models/item-variation-location-overrides.md index 57a7caac..0061f18d 100644 --- a/doc/models/item-variation-location-overrides.md +++ b/doc/models/item-variation-location-overrides.md @@ -24,14 +24,17 @@ Price and inventory alerting overrides for a `CatalogItemVariation` at a specifi ```json { - "location_id": null, - "price_money": null, - "pricing_type": null, - "track_inventory": null, - "inventory_alert_type": null, - "inventory_alert_threshold": null, - "sold_out": null, - "sold_out_valid_until": null + "location_id": "location_id4", + "price_money": { + "amount": 202, + "currency": "BBD" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 174, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until8" } ``` diff --git a/doc/models/job-assignment.md b/doc/models/job-assignment.md index 047d8072..2a46e3da 100644 --- a/doc/models/job-assignment.md +++ b/doc/models/job-assignment.md @@ -23,9 +23,15 @@ An object describing a job that a team member is assigned to. { "job_title": "job_title4", "pay_type": "NONE", - "hourly_rate": null, - "annual_rate": null, - "weekly_hours": null + "hourly_rate": { + "amount": 172, + "currency": "TJS" + }, + "annual_rate": { + "amount": 232, + "currency": "TOP" + }, + "weekly_hours": 156 } ``` diff --git a/doc/models/list-bank-accounts-request.md b/doc/models/list-bank-accounts-request.md index 4bab78eb..b6a5a08d 100644 --- a/doc/models/list-bank-accounts-request.md +++ b/doc/models/list-bank-accounts-request.md @@ -20,9 +20,9 @@ objects linked to a account. ```json { - "cursor": null, - "limit": null, - "location_id": null + "cursor": "cursor6", + "limit": 172, + "location_id": "location_id4" } ``` diff --git a/doc/models/list-booking-custom-attribute-definitions-request.md b/doc/models/list-booking-custom-attribute-definitions-request.md index 30ef89fe..ac04a08f 100644 --- a/doc/models/list-booking-custom-attribute-definitions-request.md +++ b/doc/models/list-booking-custom-attribute-definitions-request.md @@ -18,8 +18,8 @@ Represents a [ListBookingCustomAttributeDefinitions](../../doc/api/booking-custo ```json { - "limit": null, - "cursor": null + "limit": 172, + "cursor": "cursor6" } ``` diff --git a/doc/models/list-booking-custom-attributes-request.md b/doc/models/list-booking-custom-attributes-request.md index 4165b7f3..6dbece83 100644 --- a/doc/models/list-booking-custom-attributes-request.md +++ b/doc/models/list-booking-custom-attributes-request.md @@ -13,15 +13,15 @@ Represents a [ListBookingCustomAttributes](../../doc/api/booking-custom-attribut | --- | --- | --- | --- | | `limit` | `number \| undefined` | 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` | | `cursor` | `string \| undefined` | 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). | -| `withDefinitions` | `boolean \| undefined` | Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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`. | +| `withDefinitions` | `boolean \| undefined` | 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`. | ## Example (as JSON) ```json { - "limit": null, - "cursor": null, - "with_definitions": null + "limit": 172, + "cursor": "cursor6", + "with_definitions": false } ``` diff --git a/doc/models/list-booking-custom-attributes-response.md b/doc/models/list-booking-custom-attributes-response.md index 04479ebb..3173aa8d 100644 --- a/doc/models/list-booking-custom-attributes-response.md +++ b/doc/models/list-booking-custom-attributes-response.md @@ -21,9 +21,101 @@ results are available, the `cursor` field is also present along with `custom_att ```json { - "custom_attributes": null, - "cursor": null, - "errors": null + "custom_attributes": [ + { + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 228, + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_HIDDEN", + "version": 68, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + { + "key": "key3", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 229, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key3", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name3", + "description": "description3", + "visibility": "VISIBILITY_READ_ONLY", + "version": 69, + "updated_at": "updated_at9", + "created_at": "created_at1" + }, + "updated_at": "updated_at9", + "created_at": "created_at1" + }, + { + "key": "key4", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 230, + "visibility": "VISIBILITY_HIDDEN", + "definition": { + "key": "key4", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name4", + "description": "description4", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "version": 70, + "updated_at": "updated_at0", + "created_at": "created_at2" + }, + "updated_at": "updated_at0", + "created_at": "created_at2" + } + ], + "cursor": "cursor6", + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/list-bookings-request.md b/doc/models/list-bookings-request.md index d5678b22..9b83a6f5 100644 --- a/doc/models/list-bookings-request.md +++ b/doc/models/list-bookings-request.md @@ -20,12 +20,12 @@ ```json { - "limit": null, - "cursor": null, - "team_member_id": null, - "location_id": null, - "start_at_min": null, - "start_at_max": null + "limit": 172, + "cursor": "cursor6", + "team_member_id": "team_member_id0", + "location_id": "location_id4", + "start_at_min": "start_at_min8", + "start_at_max": "start_at_max8" } ``` diff --git a/doc/models/list-bookings-response.md b/doc/models/list-bookings-response.md index 3cf083f6..d34fe63f 100644 --- a/doc/models/list-bookings-response.md +++ b/doc/models/list-bookings-response.md @@ -17,9 +17,64 @@ ```json { - "bookings": null, - "cursor": null, - "errors": null + "bookings": [ + { + "id": "id1", + "version": 157, + "status": "CANCELLED_BY_CUSTOMER", + "created_at": "created_at9", + "updated_at": "updated_at7", + "start_at": "start_at3", + "location_id": "location_id5", + "customer_id": "customer_id9", + "customer_note": "customer_note3", + "seller_note": "seller_note3", + "appointment_segments": [ + { + "duration_minutes": 77, + "service_variation_id": "service_variation_id5", + "team_member_id": "team_member_id1", + "service_variation_version": 245, + "intermission_minutes": 251, + "any_team_member": true, + "resource_ids": [ + "resource_ids1", + "resource_ids2" + ] + } + ], + "transition_time_minutes": 65, + "all_day": true, + "location_type": "BUSINESS_LOCATION", + "creator_details": { + "creator_type": "CUSTOMER", + "team_member_id": "team_member_id3", + "customer_id": "customer_id5" + }, + "source": "FIRST_PARTY_BUYER" + } + ], + "cursor": "cursor6", + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/list-break-types-request.md b/doc/models/list-break-types-request.md index c66b0973..f158402f 100644 --- a/doc/models/list-break-types-request.md +++ b/doc/models/list-break-types-request.md @@ -19,9 +19,9 @@ A request for a filtered set of `BreakType` objects. ```json { - "location_id": null, - "limit": null, - "cursor": null + "location_id": "location_id4", + "limit": 172, + "cursor": "cursor6" } ``` diff --git a/doc/models/list-cards-request.md b/doc/models/list-cards-request.md index a4ece409..dbb501cb 100644 --- a/doc/models/list-cards-request.md +++ b/doc/models/list-cards-request.md @@ -12,7 +12,7 @@ HTTP requests at GET https://connect.squareup.com/v2/cards | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination) for more information.
**Constraints**: *Maximum Length*: `256` | +| `cursor` | `string \| undefined` | 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` | | `customerId` | `string \| undefined` | Optional | Limit results to cards associated with the customer supplied.
By default, all cards owned by the merchant are returned. | | `includeDisabled` | `boolean \| undefined` | Optional | Includes disabled cards.
By default, all enabled cards owned by the merchant are returned. | | `referenceId` | `string \| undefined` | Optional | Limit results to cards associated with the reference_id supplied. | diff --git a/doc/models/list-cards-response.md b/doc/models/list-cards-response.md index 2e42b2cb..0f7f4fd0 100644 --- a/doc/models/list-cards-response.md +++ b/doc/models/list-cards-response.md @@ -17,7 +17,7 @@ present. | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | | `cards` | [`Card[] \| undefined`](../../doc/models/card.md) | Optional | The requested list of `Card`s. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination) for more information. | +| `cursor` | `string \| undefined` | 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. | ## Example (as JSON) @@ -25,31 +25,29 @@ present. { "cards": [ { - "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 - } + "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 } ] } diff --git a/doc/models/list-cash-drawer-shift-events-request.md b/doc/models/list-cash-drawer-shift-events-request.md index 199af93f..f00440c6 100644 --- a/doc/models/list-cash-drawer-shift-events-request.md +++ b/doc/models/list-cash-drawer-shift-events-request.md @@ -18,8 +18,8 @@ ```json { "location_id": "location_id4", - "limit": null, - "cursor": null + "limit": 172, + "cursor": "cursor6" } ``` diff --git a/doc/models/list-cash-drawer-shifts-request.md b/doc/models/list-cash-drawer-shifts-request.md index 7235e15b..6a3c622b 100644 --- a/doc/models/list-cash-drawer-shifts-request.md +++ b/doc/models/list-cash-drawer-shifts-request.md @@ -21,11 +21,11 @@ ```json { "location_id": "location_id4", - "sort_order": null, - "begin_time": null, - "end_time": null, - "limit": null, - "cursor": null + "sort_order": "DESC", + "begin_time": "begin_time2", + "end_time": "end_time2", + "limit": 172, + "cursor": "cursor6" } ``` diff --git a/doc/models/list-catalog-request.md b/doc/models/list-catalog-request.md index 878d792c..d36fb5c3 100644 --- a/doc/models/list-catalog-request.md +++ b/doc/models/list-catalog-request.md @@ -9,17 +9,17 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination) for more information. | -| `types` | `string \| undefined` | Optional | An optional case-insensitive, comma-separated list of object types to retrieve.

The valid values are defined in the [CatalogObjectType](../../doc/models/catalog-object-type.md) 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. | +| `cursor` | `string \| undefined` | 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. | +| `types` | `string \| undefined` | 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. | | `catalogVersion` | `bigint \| undefined` | 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. | ## Example (as JSON) ```json { - "cursor": null, - "types": null, - "catalog_version": null + "cursor": "cursor6", + "types": "types6", + "catalog_version": 126 } ``` diff --git a/doc/models/list-catalog-response.md b/doc/models/list-catalog-response.md index 6cfdb1ba..4d4917e1 100644 --- a/doc/models/list-catalog-response.md +++ b/doc/models/list-catalog-response.md @@ -10,7 +10,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination) for more information. | +| `cursor` | `string \| undefined` | 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. | | `objects` | [`CatalogObject[] \| undefined`](../../doc/models/catalog-object.md) | Optional | The CatalogObjects returned. | ## Example (as JSON) diff --git a/doc/models/list-customer-custom-attribute-definitions-request.md b/doc/models/list-customer-custom-attribute-definitions-request.md index 36d72481..e6737e7d 100644 --- a/doc/models/list-customer-custom-attribute-definitions-request.md +++ b/doc/models/list-customer-custom-attribute-definitions-request.md @@ -18,8 +18,8 @@ Represents a [ListCustomerCustomAttributeDefinitions](../../doc/api/customer-cus ```json { - "limit": null, - "cursor": null + "limit": 172, + "cursor": "cursor6" } ``` diff --git a/doc/models/list-customer-custom-attributes-request.md b/doc/models/list-customer-custom-attributes-request.md index 464d8347..406e73f8 100644 --- a/doc/models/list-customer-custom-attributes-request.md +++ b/doc/models/list-customer-custom-attributes-request.md @@ -13,15 +13,15 @@ Represents a [ListCustomerCustomAttributes](../../doc/api/customer-custom-attrib | --- | --- | --- | --- | | `limit` | `number \| undefined` | 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` | | `cursor` | `string \| undefined` | 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). | -| `withDefinitions` | `boolean \| undefined` | Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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`. | +| `withDefinitions` | `boolean \| undefined` | 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`. | ## Example (as JSON) ```json { - "limit": null, - "cursor": null, - "with_definitions": null + "limit": 172, + "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 index f90dcb62..2d35681f 100644 --- a/doc/models/list-customer-custom-attributes-response.md +++ b/doc/models/list-customer-custom-attributes-response.md @@ -21,9 +21,101 @@ results are available, the `cursor` field is also present along with `custom_att ```json { - "custom_attributes": null, - "cursor": null, - "errors": null + "custom_attributes": [ + { + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 228, + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_HIDDEN", + "version": 68, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + { + "key": "key3", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 229, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key3", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name3", + "description": "description3", + "visibility": "VISIBILITY_READ_ONLY", + "version": 69, + "updated_at": "updated_at9", + "created_at": "created_at1" + }, + "updated_at": "updated_at9", + "created_at": "created_at1" + }, + { + "key": "key4", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 230, + "visibility": "VISIBILITY_HIDDEN", + "definition": { + "key": "key4", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name4", + "description": "description4", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "version": 70, + "updated_at": "updated_at0", + "created_at": "created_at2" + }, + "updated_at": "updated_at0", + "created_at": "created_at2" + } + ], + "cursor": "cursor6", + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/list-customers-request.md b/doc/models/list-customers-request.md index ad7ff2af..d3b57a0f 100644 --- a/doc/models/list-customers-request.md +++ b/doc/models/list-customers-request.md @@ -21,10 +21,10 @@ Defines the query parameters that can be included in a request to the ```json { - "cursor": null, - "limit": null, - "sort_field": null, - "sort_order": null + "cursor": "cursor6", + "limit": 172, + "sort_field": "DEFAULT", + "sort_order": "DESC" } ``` diff --git a/doc/models/list-dispute-evidence-response.md b/doc/models/list-dispute-evidence-response.md index 01a5f98d..7b4483d1 100644 --- a/doc/models/list-dispute-evidence-response.md +++ b/doc/models/list-dispute-evidence-response.md @@ -19,9 +19,53 @@ Defines the fields in a `ListDisputeEvidence` response. ```json { - "evidence": null, - "errors": null, - "cursor": null + "evidence": [ + { + "evidence_id": "evidence_id6", + "id": "id6", + "dispute_id": "dispute_id8", + "evidence_file": { + "filename": "filename4", + "filetype": "filetype4" + }, + "evidence_text": "evidence_text0", + "uploaded_at": "uploaded_at0", + "evidence_type": "REBUTTAL_EXPLANATION" + }, + { + "evidence_id": "evidence_id5", + "id": "id7", + "dispute_id": "dispute_id9", + "evidence_file": { + "filename": "filename5", + "filetype": "filetype5" + }, + "evidence_text": "evidence_text1", + "uploaded_at": "uploaded_at1", + "evidence_type": "RELATED_TRANSACTION_DOCUMENTATION" + } + ], + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ], + "cursor": "cursor6" } ``` diff --git a/doc/models/list-disputes-request.md b/doc/models/list-disputes-request.md index d68c5c73..177e949f 100644 --- a/doc/models/list-disputes-request.md +++ b/doc/models/list-disputes-request.md @@ -11,7 +11,7 @@ Defines the request parameters for the `ListDisputes` endpoint. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination). | +| `cursor` | `string \| undefined` | 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). | | `states` | [`string[] \| undefined`](../../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 | | `locationId` | `string \| undefined` | 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` | diff --git a/doc/models/list-disputes-response.md b/doc/models/list-disputes-response.md index c7d546c7..9035fc4c 100644 --- a/doc/models/list-disputes-response.md +++ b/doc/models/list-disputes-response.md @@ -13,7 +13,7 @@ Defines fields in a `ListDisputes` response. | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | | `disputes` | [`Dispute[] \| undefined`](../../doc/models/dispute.md) | Optional | The list of disputes. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination). | +| `cursor` | `string \| undefined` | 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). | ## Example (as JSON) diff --git a/doc/models/list-employee-wages-request.md b/doc/models/list-employee-wages-request.md index ed26f20a..0128c18a 100644 --- a/doc/models/list-employee-wages-request.md +++ b/doc/models/list-employee-wages-request.md @@ -19,9 +19,9 @@ A request for a set of `EmployeeWage` objects. ```json { - "employee_id": null, - "limit": null, - "cursor": null + "employee_id": "employee_id0", + "limit": 172, + "cursor": "cursor6" } ``` diff --git a/doc/models/list-employees-request.md b/doc/models/list-employees-request.md index 6725e5ac..4b6ac1ed 100644 --- a/doc/models/list-employees-request.md +++ b/doc/models/list-employees-request.md @@ -18,10 +18,10 @@ ```json { - "location_id": null, - "status": null, - "limit": null, - "cursor": null + "location_id": "location_id4", + "status": "ACTIVE", + "limit": 172, + "cursor": "cursor6" } ``` diff --git a/doc/models/list-employees-response.md b/doc/models/list-employees-response.md index 80fedb61..44ff8144 100644 --- a/doc/models/list-employees-response.md +++ b/doc/models/list-employees-response.md @@ -17,9 +17,43 @@ ```json { - "employees": null, - "cursor": null, - "errors": null + "employees": [ + { + "id": "id6", + "first_name": "first_name6", + "last_name": "last_name4", + "email": "email0", + "phone_number": "phone_number4", + "location_ids": [ + "location_ids6" + ], + "status": "ACTIVE", + "is_owner": false, + "created_at": "created_at4", + "updated_at": "updated_at2" + } + ], + "cursor": "cursor6", + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/list-gift-card-activities-request.md b/doc/models/list-gift-card-activities-request.md index c97b9405..e292964f 100644 --- a/doc/models/list-gift-card-activities-request.md +++ b/doc/models/list-gift-card-activities-request.md @@ -13,7 +13,7 @@ subset of activites. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `giftCardId` | `string \| undefined` | 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` | -| `type` | `string \| undefined` | Optional | If a [type](../../doc/models/gift-card-activity-type.md) is provided, the endpoint returns gift card activities of the specified type.
Otherwise, the endpoint returns all types of gift card activities. | +| `type` | `string \| undefined` | 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. | | `locationId` | `string \| undefined` | 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. | | `beginTime` | `string \| undefined` | 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. | | `endTime` | `string \| undefined` | 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. | diff --git a/doc/models/list-gift-cards-request.md b/doc/models/list-gift-cards-request.md index 7cc95394..87e915ea 100644 --- a/doc/models/list-gift-cards-request.md +++ b/doc/models/list-gift-cards-request.md @@ -12,8 +12,8 @@ gift cards. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `type` | `string \| undefined` | Optional | If a [type](../../doc/models/gift-card-type.md) is provided, the endpoint returns gift cards of the specified type.
Otherwise, the endpoint returns gift cards of all types. | -| `state` | `string \| undefined` | Optional | If a [state](../../doc/models/gift-card-status.md) is provided, the endpoint returns the gift cards in the specified state.
Otherwise, the endpoint returns the gift cards of all states. | +| `type` | `string \| undefined` | 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. | +| `state` | `string \| undefined` | 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. | | `limit` | `number \| undefined` | Optional | If a limit is provided, the endpoint returns only the specified number of results per page.
The maximum value is 50. The default value is 30.
For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
**Constraints**: `>= 1`, `<= 50` | | `cursor` | `string \| undefined` | 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). | | `customerId` | `string \| undefined` | Optional | If a customer ID is provided, the endpoint returns only the gift cards linked to the specified customer.
**Constraints**: *Maximum Length*: `191` | @@ -22,11 +22,11 @@ gift cards. ```json { - "type": null, - "state": null, - "limit": null, - "cursor": null, - "customer_id": null + "type": "type0", + "state": "state4", + "limit": 172, + "cursor": "cursor6", + "customer_id": "customer_id8" } ``` diff --git a/doc/models/list-invoices-request.md b/doc/models/list-invoices-request.md index e415e1cf..468b6ec6 100644 --- a/doc/models/list-invoices-request.md +++ b/doc/models/list-invoices-request.md @@ -20,8 +20,8 @@ Describes a `ListInvoice` request. ```json { "location_id": "location_id4", - "cursor": null, - "limit": null + "cursor": "cursor6", + "limit": 172 } ``` diff --git a/doc/models/list-location-custom-attribute-definitions-request.md b/doc/models/list-location-custom-attribute-definitions-request.md index bbe1521a..d7f06d43 100644 --- a/doc/models/list-location-custom-attribute-definitions-request.md +++ b/doc/models/list-location-custom-attribute-definitions-request.md @@ -19,9 +19,9 @@ Represents a [ListLocationCustomAttributeDefinitions](../../doc/api/location-cus ```json { - "visibility_filter": null, - "limit": null, - "cursor": null + "visibility_filter": "ALL", + "limit": 172, + "cursor": "cursor6" } ``` diff --git a/doc/models/list-location-custom-attributes-request.md b/doc/models/list-location-custom-attributes-request.md index adf0d819..6cba4b8a 100644 --- a/doc/models/list-location-custom-attributes-request.md +++ b/doc/models/list-location-custom-attributes-request.md @@ -14,16 +14,16 @@ Represents a [ListLocationCustomAttributes](../../doc/api/location-custom-attrib | `visibilityFilter` | [`string \| undefined`](../../doc/models/visibility-filter.md) | Optional | Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions. | | `limit` | `number \| undefined` | 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` | | `cursor` | `string \| undefined` | 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). | -| `withDefinitions` | `boolean \| undefined` | Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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`. | +| `withDefinitions` | `boolean \| undefined` | 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`. | ## Example (as JSON) ```json { - "visibility_filter": null, - "limit": null, - "cursor": null, - "with_definitions": null + "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 index a0bf08cf..6c7edd36 100644 --- a/doc/models/list-location-custom-attributes-response.md +++ b/doc/models/list-location-custom-attributes-response.md @@ -21,9 +21,101 @@ results are available, the `cursor` field is also present along with `custom_att ```json { - "custom_attributes": null, - "cursor": null, - "errors": null + "custom_attributes": [ + { + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 228, + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_HIDDEN", + "version": 68, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + { + "key": "key3", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 229, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key3", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name3", + "description": "description3", + "visibility": "VISIBILITY_READ_ONLY", + "version": 69, + "updated_at": "updated_at9", + "created_at": "created_at1" + }, + "updated_at": "updated_at9", + "created_at": "created_at1" + }, + { + "key": "key4", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 230, + "visibility": "VISIBILITY_HIDDEN", + "definition": { + "key": "key4", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name4", + "description": "description4", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "version": 70, + "updated_at": "updated_at0", + "created_at": "created_at2" + }, + "updated_at": "updated_at0", + "created_at": "created_at2" + } + ], + "cursor": "cursor6", + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/list-merchants-request.md b/doc/models/list-merchants-request.md index a8ec2360..a85c80bc 100644 --- a/doc/models/list-merchants-request.md +++ b/doc/models/list-merchants-request.md @@ -17,7 +17,7 @@ Request object for the [ListMerchant](../../doc/api/merchants.md#list-merchants) ```json { - "cursor": null + "cursor": 210 } ``` diff --git a/doc/models/list-order-custom-attribute-definitions-request.md b/doc/models/list-order-custom-attribute-definitions-request.md index d8408935..5f46a8eb 100644 --- a/doc/models/list-order-custom-attribute-definitions-request.md +++ b/doc/models/list-order-custom-attribute-definitions-request.md @@ -12,16 +12,16 @@ Represents a list request for order custom attribute definitions. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `visibilityFilter` | [`string \| undefined`](../../doc/models/visibility-filter.md) | Optional | Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions. | -| `cursor` | `string \| undefined` | 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). | +| `cursor` | `string \| undefined` | 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` | | `limit` | `number \| undefined` | 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` | ## Example (as JSON) ```json { - "visibility_filter": null, - "cursor": null, - "limit": null + "visibility_filter": "ALL", + "cursor": "cursor6", + "limit": 172 } ``` diff --git a/doc/models/list-order-custom-attribute-definitions-response.md b/doc/models/list-order-custom-attribute-definitions-response.md index 95575907..fb2dd301 100644 --- a/doc/models/list-order-custom-attribute-definitions-response.md +++ b/doc/models/list-order-custom-attribute-definitions-response.md @@ -12,7 +12,7 @@ Represents a response from listing order custom attribute definitions. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `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 (`{}`). | -| `cursor` | `string \| undefined` | 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). | +| `cursor` | `string \| undefined` | 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` | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | ## Example (as JSON) diff --git a/doc/models/list-order-custom-attributes-request.md b/doc/models/list-order-custom-attributes-request.md index f5419cb4..e04b02bd 100644 --- a/doc/models/list-order-custom-attributes-request.md +++ b/doc/models/list-order-custom-attributes-request.md @@ -12,18 +12,18 @@ Represents a list request for order custom attributes. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `visibilityFilter` | [`string \| undefined`](../../doc/models/visibility-filter.md) | Optional | Enumeration of visibility-filter values used to set the ability to view custom attributes or custom attribute definitions. | -| `cursor` | `string \| undefined` | 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). | +| `cursor` | `string \| undefined` | 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` | | `limit` | `number \| undefined` | 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` | -| `withDefinitions` | `boolean \| undefined` | Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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`. | +| `withDefinitions` | `boolean \| undefined` | 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`. | ## Example (as JSON) ```json { - "visibility_filter": null, - "cursor": null, - "limit": null, - "with_definitions": null + "visibility_filter": "ALL", + "cursor": "cursor6", + "limit": 172, + "with_definitions": false } ``` diff --git a/doc/models/list-order-custom-attributes-response.md b/doc/models/list-order-custom-attributes-response.md index 6b730f6d..bf340c51 100644 --- a/doc/models/list-order-custom-attributes-response.md +++ b/doc/models/list-order-custom-attributes-response.md @@ -12,16 +12,108 @@ Represents a response from listing order custom attributes. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `customAttributes` | [`CustomAttribute[] \| undefined`](../../doc/models/custom-attribute.md) | Optional | The retrieved custom attributes. If no custom attribute are found, Square returns an empty object (`{}`). | -| `cursor` | `string \| undefined` | 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). | +| `cursor` | `string \| undefined` | 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` | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | ## Example (as JSON) ```json { - "custom_attributes": null, - "cursor": null, - "errors": null + "custom_attributes": [ + { + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 228, + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_HIDDEN", + "version": 68, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + { + "key": "key3", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 229, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key3", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name3", + "description": "description3", + "visibility": "VISIBILITY_READ_ONLY", + "version": 69, + "updated_at": "updated_at9", + "created_at": "created_at1" + }, + "updated_at": "updated_at9", + "created_at": "created_at1" + }, + { + "key": "key4", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 230, + "visibility": "VISIBILITY_HIDDEN", + "definition": { + "key": "key4", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name4", + "description": "description4", + "visibility": "VISIBILITY_READ_WRITE_VALUES", + "version": 70, + "updated_at": "updated_at0", + "created_at": "created_at2" + }, + "updated_at": "updated_at0", + "created_at": "created_at2" + } + ], + "cursor": "cursor6", + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/list-payment-links-request.md b/doc/models/list-payment-links-request.md index 32d55954..7324d982 100644 --- a/doc/models/list-payment-links-request.md +++ b/doc/models/list-payment-links-request.md @@ -16,8 +16,8 @@ ```json { - "cursor": null, - "limit": null + "cursor": "cursor6", + "limit": 172 } ``` diff --git a/doc/models/list-payment-refunds-request.md b/doc/models/list-payment-refunds-request.md index 4618df0c..46971b7a 100644 --- a/doc/models/list-payment-refunds-request.md +++ b/doc/models/list-payment-refunds-request.md @@ -14,12 +14,12 @@ The maximum results per page is 100. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `beginTime` | `string \| undefined` | Optional | The timestamp for the beginning of the requested reporting period, in RFC 3339 format.

Default: The current time minus one year. | -| `endTime` | `string \| undefined` | Optional | The timestamp for the end of the requested reporting period, in RFC 3339 format.

Default: The current time. | -| `sortOrder` | `string \| undefined` | Optional | The order in which results are listed:

- `ASC` - Oldest to newest.
- `DESC` - Newest to oldest (default). | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination). | +| `beginTime` | `string \| undefined` | 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. | +| `endTime` | `string \| undefined` | 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. | +| `sortOrder` | `string \| undefined` | Optional | The order in which results are listed by `PaymentRefund.created_at`:

- `ASC` - Oldest to newest.
- `DESC` - Newest to oldest (default). | +| `cursor` | `string \| undefined` | 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). | | `locationId` | `string \| undefined` | Optional | Limit results to the location supplied. By default, results are returned
for all locations associated with the seller. | -| `status` | `string \| undefined` | Optional | If provided, only refunds with the given status are returned.
For a list of refund status values, see [PaymentRefund](../../doc/models/payment-refund.md).

Default: If omitted, refunds are returned regardless of their status. | +| `status` | `string \| undefined` | 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. | | `sourceType` | `string \| undefined` | 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. | | `limit` | `number \| undefined` | 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 | diff --git a/doc/models/list-payment-refunds-response.md b/doc/models/list-payment-refunds-response.md index 426dd574..6f6367d6 100644 --- a/doc/models/list-payment-refunds-response.md +++ b/doc/models/list-payment-refunds-response.md @@ -15,7 +15,7 @@ Either `errors` or `refunds` is present in a given response (never both). | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | | `refunds` | [`PaymentRefund[] \| undefined`](../../doc/models/payment-refund.md) | Optional | The list of requested refunds. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination). | +| `cursor` | `string \| undefined` | 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). | ## Example (as JSON) diff --git a/doc/models/list-payments-request.md b/doc/models/list-payments-request.md index 7ce05116..d2491887 100644 --- a/doc/models/list-payments-request.md +++ b/doc/models/list-payments-request.md @@ -14,10 +14,10 @@ The maximum results per page is 100. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `beginTime` | `string \| undefined` | Optional | The timestamp for the beginning of the reporting period, in RFC 3339 format.
Inclusive. Default: The current time minus one year. | -| `endTime` | `string \| undefined` | Optional | The timestamp for the end of the reporting period, in RFC 3339 format.

Default: The current time. | -| `sortOrder` | `string \| undefined` | Optional | The order in which results are listed:

- `ASC` - Oldest to newest.
- `DESC` - Newest to oldest (default). | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination). | +| `beginTime` | `string \| undefined` | 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. | +| `endTime` | `string \| undefined` | 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. | +| `sortOrder` | `string \| undefined` | Optional | The order in which results are listed by `Payment.created_at`:

- `ASC` - Oldest to newest.
- `DESC` - Newest to oldest (default). | +| `cursor` | `string \| undefined` | 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). | | `locationId` | `string \| undefined` | Optional | Limit results to the location supplied. By default, results are returned
for the default (main) location associated with the seller. | | `total` | `bigint \| undefined` | Optional | The exact amount in the `total_money` for a payment. | | `last4` | `string \| undefined` | Optional | The last four digits of a payment card. | diff --git a/doc/models/list-payments-response.md b/doc/models/list-payments-response.md index b69e810d..f06ef172 100644 --- a/doc/models/list-payments-response.md +++ b/doc/models/list-payments-response.md @@ -13,7 +13,7 @@ Defines the response returned by [ListPayments](../../doc/api/payments.md#list-p | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | | `payments` | [`Payment[] \| undefined`](../../doc/models/payment.md) | Optional | The requested list of payments. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination). | +| `cursor` | `string \| undefined` | 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). | ## Example (as JSON) diff --git a/doc/models/list-payout-entries-request.md b/doc/models/list-payout-entries-request.md index 9f64b499..db2d400b 100644 --- a/doc/models/list-payout-entries-request.md +++ b/doc/models/list-payout-entries-request.md @@ -10,7 +10,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `sortOrder` | [`string \| undefined`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination).
If request parameters change between requests, subsequent results may contain duplicates or missing records. | +| `cursor` | `string \| undefined` | 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. | | `limit` | `number \| undefined` | 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` | ## Example (as JSON) diff --git a/doc/models/list-payout-entries-response.md b/doc/models/list-payout-entries-response.md index eefa7cd2..5b95fb3c 100644 --- a/doc/models/list-payout-entries-response.md +++ b/doc/models/list-payout-entries-response.md @@ -12,7 +12,7 @@ The response to retrieve payout records entries. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `payoutEntries` | [`PayoutEntry[] \| undefined`](../../doc/models/payout-entry.md) | Optional | The requested list of payout entries, ordered with the given or default sort order. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination). | +| `cursor` | `string \| undefined` | 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). | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | ## Example (as JSON) diff --git a/doc/models/list-payouts-request.md b/doc/models/list-payouts-request.md index 931d27da..0b0590dd 100644 --- a/doc/models/list-payouts-request.md +++ b/doc/models/list-payouts-request.md @@ -16,7 +16,7 @@ A request to retrieve payout records. | `beginTime` | `string \| undefined` | Optional | The timestamp for the beginning of the payout creation time, in RFC 3339 format.
Inclusive. Default: The current time minus one year. | | `endTime` | `string \| undefined` | Optional | The timestamp for the end of the payout creation time, in RFC 3339 format.
Default: The current time. | | `sortOrder` | [`string \| undefined`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination).
If request parameters change between requests, subsequent results may contain duplicates or missing records. | +| `cursor` | `string \| undefined` | 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. | | `limit` | `number \| undefined` | 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` | ## Example (as JSON) diff --git a/doc/models/list-payouts-response.md b/doc/models/list-payouts-response.md index ce3d2fbf..70193c9b 100644 --- a/doc/models/list-payouts-response.md +++ b/doc/models/list-payouts-response.md @@ -12,7 +12,7 @@ The response to retrieve payout records entries. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `payouts` | [`Payout[] \| undefined`](../../doc/models/payout.md) | Optional | The requested list of payouts. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination). | +| `cursor` | `string \| undefined` | 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). | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | ## Example (as JSON) diff --git a/doc/models/list-refunds-request.md b/doc/models/list-refunds-request.md index 2a4862ae..51cc9a2e 100644 --- a/doc/models/list-refunds-request.md +++ b/doc/models/list-refunds-request.md @@ -2,9 +2,9 @@ # List Refunds Request Defines the query parameters that can be included in -a request to the [ListRefunds]($e/Transactions/ListRefunds) endpoint. +a request to the [ListRefunds](api-endpoint:Transactions-ListRefunds) endpoint. -Deprecated - recommend using [SearchOrders](../../doc/api/orders.md#search-orders) +Deprecated - recommend using [SearchOrders](api-endpoint:Orders-SearchOrders) ## Structure @@ -23,10 +23,10 @@ Deprecated - recommend using [SearchOrders](../../doc/api/orders.md#search-order ```json { - "begin_time": null, - "end_time": null, - "sort_order": null, - "cursor": null + "begin_time": "begin_time2", + "end_time": "end_time2", + "sort_order": "DESC", + "cursor": "cursor6" } ``` diff --git a/doc/models/list-refunds-response.md b/doc/models/list-refunds-response.md index d7ecc51f..043056f4 100644 --- a/doc/models/list-refunds-response.md +++ b/doc/models/list-refunds-response.md @@ -2,7 +2,7 @@ # List Refunds Response Defines the fields that are included in the response body of -a request to the [ListRefunds]($e/Transactions/ListRefunds) endpoint. +a request to the [ListRefunds](api-endpoint:Transactions-ListRefunds) endpoint. One of `errors` or `refunds` is present in a given response (never both). diff --git a/doc/models/list-subscription-events-request.md b/doc/models/list-subscription-events-request.md index 206e8bf2..c627ee4f 100644 --- a/doc/models/list-subscription-events-request.md +++ b/doc/models/list-subscription-events-request.md @@ -20,8 +20,8 @@ endpoint. ```json { - "cursor": null, - "limit": null + "cursor": "cursor6", + "limit": 172 } ``` diff --git a/doc/models/list-team-member-booking-profiles-request.md b/doc/models/list-team-member-booking-profiles-request.md index 6ce1cae9..41f876a1 100644 --- a/doc/models/list-team-member-booking-profiles-request.md +++ b/doc/models/list-team-member-booking-profiles-request.md @@ -18,10 +18,10 @@ ```json { - "bookable_only": null, - "limit": null, - "cursor": null, - "location_id": null + "bookable_only": false, + "limit": 172, + "cursor": "cursor6", + "location_id": "location_id4" } ``` diff --git a/doc/models/list-team-member-wages-request.md b/doc/models/list-team-member-wages-request.md index 9af0e60a..f3f3d64b 100644 --- a/doc/models/list-team-member-wages-request.md +++ b/doc/models/list-team-member-wages-request.md @@ -19,9 +19,9 @@ A request for a set of `TeamMemberWage` objects. ```json { - "team_member_id": null, - "limit": null, - "cursor": null + "team_member_id": "team_member_id0", + "limit": 172, + "cursor": "cursor6" } ``` diff --git a/doc/models/list-transactions-request.md b/doc/models/list-transactions-request.md index 753f6db8..50eda9bf 100644 --- a/doc/models/list-transactions-request.md +++ b/doc/models/list-transactions-request.md @@ -2,9 +2,9 @@ # List Transactions Request Defines the query parameters that can be included in -a request to the [ListTransactions](../../doc/api/transactions.md#list-transactions) endpoint. +a request to the [ListTransactions](api-endpoint:Transactions-ListTransactions) endpoint. -Deprecated - recommend using [SearchOrders](../../doc/api/orders.md#search-orders) +Deprecated - recommend using [SearchOrders](api-endpoint:Orders-SearchOrders) ## Structure @@ -23,10 +23,10 @@ Deprecated - recommend using [SearchOrders](../../doc/api/orders.md#search-order ```json { - "begin_time": null, - "end_time": null, - "sort_order": null, - "cursor": null + "begin_time": "begin_time2", + "end_time": "end_time2", + "sort_order": "DESC", + "cursor": "cursor6" } ``` diff --git a/doc/models/list-transactions-response.md b/doc/models/list-transactions-response.md index 41a6850b..cd7ee8a0 100644 --- a/doc/models/list-transactions-response.md +++ b/doc/models/list-transactions-response.md @@ -2,7 +2,7 @@ # List Transactions Response Defines the fields that are included in the response body of -a request to the [ListTransactions](../../doc/api/transactions.md#list-transactions) endpoint. +a request to the [ListTransactions](api-endpoint:Transactions-ListTransactions) endpoint. One of `errors` or `transactions` is present in a given response (never both). diff --git a/doc/models/list-webhook-event-types-request.md b/doc/models/list-webhook-event-types-request.md index 53b18fc8..93a1acb5 100644 --- a/doc/models/list-webhook-event-types-request.md +++ b/doc/models/list-webhook-event-types-request.md @@ -17,7 +17,7 @@ Lists all webhook event types that can be subscribed to. ```json { - "api_version": null + "api_version": "api_version8" } ``` diff --git a/doc/models/list-webhook-event-types-response.md b/doc/models/list-webhook-event-types-response.md index eae2ecad..fb7577b1 100644 --- a/doc/models/list-webhook-event-types-response.md +++ b/doc/models/list-webhook-event-types-response.md @@ -17,7 +17,7 @@ present. | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | | `eventTypes` | `string[] \| undefined` | Optional | The list of event types. | -| `metadata` | [`EventTypeMetadata[] \| undefined`](../../doc/models/event-type-metadata.md) | Optional | Contains the metadata of a webhook event type. For more information, see [EventTypeMetadata](../../doc/models/event-type-metadata.md). | +| `metadata` | [`EventTypeMetadata[] \| undefined`](../../doc/models/event-type-metadata.md) | Optional | Contains the metadata of a webhook event type. For more information, see [EventTypeMetadata](entity:EventTypeMetadata). | ## Example (as JSON) diff --git a/doc/models/list-webhook-subscriptions-request.md b/doc/models/list-webhook-subscriptions-request.md index 9470daac..8e1fcc3d 100644 --- a/doc/models/list-webhook-subscriptions-request.md +++ b/doc/models/list-webhook-subscriptions-request.md @@ -12,7 +12,7 @@ Lists all [Subscription](../../doc/models/webhook-subscription.md)s owned by you | Name | Type | Tags | Description | | --- | --- | --- | --- | | `cursor` | `string \| undefined` | 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/basics/api101/pagination).
**Constraints**: *Maximum Length*: `256` | -| `includeDisabled` | `boolean \| undefined` | Optional | Includes disabled [Subscription](../../doc/models/webhook-subscription.md)s.
By default, all enabled [Subscription](../../doc/models/webhook-subscription.md)s are returned. | +| `includeDisabled` | `boolean \| undefined` | Optional | Includes disabled [Subscription](entity:WebhookSubscription)s.
By default, all enabled [Subscription](entity:WebhookSubscription)s are returned. | | `sortOrder` | [`string \| undefined`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | | `limit` | `number \| undefined` | 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` | @@ -20,10 +20,10 @@ Lists all [Subscription](../../doc/models/webhook-subscription.md)s owned by you ```json { - "cursor": null, - "include_disabled": null, - "sort_order": null, - "limit": null + "cursor": "cursor6", + "include_disabled": false, + "sort_order": "DESC", + "limit": 172 } ``` diff --git a/doc/models/list-webhook-subscriptions-response.md b/doc/models/list-webhook-subscriptions-response.md index 568f4d06..e17a5d8c 100644 --- a/doc/models/list-webhook-subscriptions-response.md +++ b/doc/models/list-webhook-subscriptions-response.md @@ -16,7 +16,7 @@ present. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | -| `subscriptions` | [`WebhookSubscription[] \| undefined`](../../doc/models/webhook-subscription.md) | Optional | The requested list of [Subscription](../../doc/models/webhook-subscription.md)s. | +| `subscriptions` | [`WebhookSubscription[] \| undefined`](../../doc/models/webhook-subscription.md) | Optional | The requested list of [Subscription](entity:WebhookSubscription)s. | | `cursor` | `string \| undefined` | 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/basics/api101/pagination). | ## Example (as JSON) diff --git a/doc/models/list-workweek-configs-request.md b/doc/models/list-workweek-configs-request.md index 5b86e1e1..2acd0df9 100644 --- a/doc/models/list-workweek-configs-request.md +++ b/doc/models/list-workweek-configs-request.md @@ -18,8 +18,8 @@ A request for a set of `WorkweekConfig` objects. ```json { - "limit": null, - "cursor": null + "limit": 172, + "cursor": "cursor6" } ``` diff --git a/doc/models/location.md b/doc/models/location.md index ca322798..b3857cf7 100644 --- a/doc/models/location.md +++ b/doc/models/location.md @@ -15,7 +15,7 @@ Represents one of a business' [locations](https://developer.squareup.com/docs/lo | `name` | `string \| undefined` | 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` | | `address` | [`Address \| undefined`](../../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). | | `timezone` | `string \| undefined` | 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` | -| `capabilities` | [`string[] \| undefined`](../../doc/models/location-capability.md) | Optional | The Square features that are enabled for the location.
See [LocationCapability](../../doc/models/location-capability.md) for possible values.
See [LocationCapability](#type-locationcapability) for possible values | +| `capabilities` | [`string[] \| undefined`](../../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 | | `status` | [`string \| undefined`](../../doc/models/location-status.md) | Optional | A location's status. | | `createdAt` | `string \| undefined` | 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` | | `merchantId` | `string \| undefined` | Optional | The ID of the merchant that owns the location.
**Constraints**: *Maximum Length*: `32` | @@ -43,33 +43,76 @@ Represents one of a business' [locations](https://developer.squareup.com/docs/lo ```json { - "id": null, - "name": null, - "address": null, - "timezone": null, - "capabilities": null, - "status": null, - "created_at": null, - "merchant_id": null, - "country": null, - "language_code": null, - "currency": null, - "phone_number": null, - "business_name": null, - "type": null, - "website_url": null, - "business_hours": null, - "business_email": null, - "description": null, - "twitter_username": null, - "instagram_username": null, - "facebook_url": null, - "coordinates": null, - "logo_url": null, - "pos_background_url": null, - "mcc": null, - "full_format_logo_url": null, - "tax_ids": null + "id": "id0", + "name": "name0", + "address": { + "address_line_1": "address_line_16", + "address_line_2": "address_line_26", + "address_line_3": "address_line_32", + "locality": "locality6", + "sublocality": "sublocality6", + "sublocality_2": "sublocality_24", + "sublocality_3": "sublocality_36", + "administrative_district_level_1": "administrative_district_level_10", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_34", + "postal_code": "postal_code8", + "country": "BE", + "first_name": "first_name6", + "last_name": "last_name4" + }, + "timezone": "timezone0", + "capabilities": [ + "CREDIT_CARD_PROCESSING" + ], + "status": "ACTIVE", + "created_at": "created_at2", + "merchant_id": "merchant_id0", + "country": "FO", + "language_code": "language_code8", + "currency": "YER", + "phone_number": "phone_number2", + "business_name": "business_name4", + "type": "PHYSICAL", + "website_url": "website_url8", + "business_hours": { + "periods": [ + { + "day_of_week": "SUN", + "start_local_time": "start_local_time3", + "end_local_time": "end_local_time5" + }, + { + "day_of_week": "SAT", + "start_local_time": "start_local_time4", + "end_local_time": "end_local_time6" + }, + { + "day_of_week": "FRI", + "start_local_time": "start_local_time5", + "end_local_time": "end_local_time7" + } + ] + }, + "business_email": "business_email4", + "description": "description0", + "twitter_username": "twitter_username2", + "instagram_username": "instagram_username4", + "facebook_url": "facebook_url2", + "coordinates": { + "latitude": 39.14, + "longitude": 36.94 + }, + "logo_url": "logo_url0", + "pos_background_url": "pos_background_url2", + "mcc": "mcc0", + "full_format_logo_url": "full_format_logo_url4", + "tax_ids": { + "eu_vat": "eu_vat2", + "fr_siret": "fr_siret4", + "fr_naf": "fr_naf4", + "es_nif": "es_nif8" + } } ``` diff --git a/doc/models/loyalty-account-mapping.md b/doc/models/loyalty-account-mapping.md index 93ad7fe5..c9b86d48 100644 --- a/doc/models/loyalty-account-mapping.md +++ b/doc/models/loyalty-account-mapping.md @@ -22,9 +22,9 @@ Currently, a loyalty account can only be mapped to a buyer by phone number. For ```json { - "id": null, - "created_at": null, - "phone_number": null + "id": "id0", + "created_at": "created_at2", + "phone_number": "phone_number2" } ``` diff --git a/doc/models/loyalty-account.md b/doc/models/loyalty-account.md index a1e58507..c4107089 100644 --- a/doc/models/loyalty-account.md +++ b/doc/models/loyalty-account.md @@ -13,10 +13,10 @@ Describes a loyalty account in a [loyalty program](../../doc/models/loyalty-prog | Name | Type | Tags | Description | | --- | --- | --- | --- | | `id` | `string \| undefined` | Optional | The Square-assigned ID of the loyalty account.
**Constraints**: *Maximum Length*: `36` | -| `programId` | `string` | Required | The Square-assigned ID of the [loyalty program](../../doc/models/loyalty-program.md) to which the account belongs.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | +| `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` | | `balance` | `number \| undefined` | 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. | | `lifetimePoints` | `number \| undefined` | Optional | The total points accrued during the lifetime of the account. | -| `customerId` | `string \| undefined` | Optional | The Square-assigned ID of the [customer](../../doc/models/customer.md) that is associated with the account. | +| `customerId` | `string \| undefined` | Optional | The Square-assigned ID of the [customer](entity:Customer) that is associated with the account. | | `enrolledAt` | `string \| undefined` | 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. | | `createdAt` | `string \| undefined` | Optional | The timestamp when the loyalty account was created, in RFC 3339 format. | | `updatedAt` | `string \| undefined` | Optional | The timestamp when the loyalty account was last updated, in RFC 3339 format. | @@ -27,16 +27,25 @@ Describes a loyalty account in a [loyalty program](../../doc/models/loyalty-prog ```json { - "id": null, + "id": "id0", "program_id": "program_id0", - "balance": null, - "lifetime_points": null, - "customer_id": null, - "enrolled_at": null, - "created_at": null, - "updated_at": null, - "mapping": null, - "expiring_point_deadlines": null + "balance": 64, + "lifetime_points": 88, + "customer_id": "customer_id8", + "enrolled_at": "enrolled_at0", + "created_at": "created_at2", + "updated_at": "updated_at4", + "mapping": { + "id": "id4", + "created_at": "created_at2", + "phone_number": "phone_number2" + }, + "expiring_point_deadlines": [ + { + "points": 209, + "expires_at": "expires_at3" + } + ] } ``` diff --git a/doc/models/loyalty-event-accumulate-points.md b/doc/models/loyalty-event-accumulate-points.md index 564649bc..60b002a2 100644 --- a/doc/models/loyalty-event-accumulate-points.md +++ b/doc/models/loyalty-event-accumulate-points.md @@ -11,17 +11,17 @@ Provides metadata when the event `type` is `ACCUMULATE_POINTS`. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `loyaltyProgramId` | `string \| undefined` | Optional | The ID of the [loyalty program](../../doc/models/loyalty-program.md).
**Constraints**: *Maximum Length*: `36` | +| `loyaltyProgramId` | `string \| undefined` | Optional | The ID of the [loyalty program](entity:LoyaltyProgram).
**Constraints**: *Maximum Length*: `36` | | `points` | `number \| undefined` | Optional | The number of points accumulated by the event.
**Constraints**: `>= 1` | -| `orderId` | `string \| undefined` | Optional | The ID of the [order](../../doc/models/order.md) for which the buyer accumulated the points.
This field is returned only if the Orders API is used to process orders. | +| `orderId` | `string \| undefined` | 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. | ## Example (as JSON) ```json { - "loyalty_program_id": null, - "points": null, - "order_id": null + "loyalty_program_id": "loyalty_program_id0", + "points": 236, + "order_id": "order_id6" } ``` diff --git a/doc/models/loyalty-event-accumulate-promotion-points.md b/doc/models/loyalty-event-accumulate-promotion-points.md index bc301db2..1af710f1 100644 --- a/doc/models/loyalty-event-accumulate-promotion-points.md +++ b/doc/models/loyalty-event-accumulate-promotion-points.md @@ -11,17 +11,17 @@ Provides metadata when the event `type` is `ACCUMULATE_PROMOTION_POINTS`. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `loyaltyProgramId` | `string \| undefined` | Optional | The Square-assigned ID of the [loyalty program](../../doc/models/loyalty-program.md).
**Constraints**: *Maximum Length*: `36` | -| `loyaltyPromotionId` | `string \| undefined` | Optional | The Square-assigned ID of the [loyalty promotion](../../doc/models/loyalty-promotion.md).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | +| `loyaltyProgramId` | `string \| undefined` | Optional | The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).
**Constraints**: *Maximum Length*: `36` | +| `loyaltyPromotionId` | `string \| undefined` | Optional | The Square-assigned ID of the [loyalty promotion](entity:LoyaltyPromotion).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `255` | | `points` | `number` | Required | The number of points earned by the event. | -| `orderId` | `string` | Required | The ID of the [order](../../doc/models/order.md) 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` | +| `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` | ## Example (as JSON) ```json { - "loyalty_program_id": null, - "loyalty_promotion_id": null, + "loyalty_program_id": "loyalty_program_id0", + "loyalty_promotion_id": "loyalty_promotion_id8", "points": 236, "order_id": "order_id6" } diff --git a/doc/models/loyalty-event-adjust-points.md b/doc/models/loyalty-event-adjust-points.md index f36f465b..68592902 100644 --- a/doc/models/loyalty-event-adjust-points.md +++ b/doc/models/loyalty-event-adjust-points.md @@ -11,7 +11,7 @@ Provides metadata when the event `type` is `ADJUST_POINTS`. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `loyaltyProgramId` | `string \| undefined` | Optional | The Square-assigned ID of the [loyalty program](../../doc/models/loyalty-program.md).
**Constraints**: *Maximum Length*: `36` | +| `loyaltyProgramId` | `string \| undefined` | Optional | The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).
**Constraints**: *Maximum Length*: `36` | | `points` | `number` | Required | The number of points added or removed. | | `reason` | `string \| undefined` | Optional | The reason for the adjustment of points. | @@ -19,9 +19,9 @@ Provides metadata when the event `type` is `ADJUST_POINTS`. ```json { - "loyalty_program_id": null, + "loyalty_program_id": "loyalty_program_id0", "points": 236, - "reason": null + "reason": "reason4" } ``` diff --git a/doc/models/loyalty-event-create-reward.md b/doc/models/loyalty-event-create-reward.md index b5eb7711..7c9fe14d 100644 --- a/doc/models/loyalty-event-create-reward.md +++ b/doc/models/loyalty-event-create-reward.md @@ -11,8 +11,8 @@ Provides metadata when the event `type` is `CREATE_REWARD`. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `loyaltyProgramId` | `string` | Required | The ID of the [loyalty program](../../doc/models/loyalty-program.md).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | -| `rewardId` | `string \| undefined` | Optional | The Square-assigned ID of the created [loyalty reward](../../doc/models/loyalty-reward.md).
This field is returned only if the event source is `LOYALTY_API`.
**Constraints**: *Maximum Length*: `36` | +| `loyaltyProgramId` | `string` | Required | The ID of the [loyalty program](entity:LoyaltyProgram).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | +| `rewardId` | `string \| undefined` | 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` | | `points` | `number` | Required | The loyalty points used to create the reward. | ## Example (as JSON) @@ -20,7 +20,7 @@ Provides metadata when the event `type` is `CREATE_REWARD`. ```json { "loyalty_program_id": "loyalty_program_id0", - "reward_id": null, + "reward_id": "reward_id4", "points": 236 } ``` diff --git a/doc/models/loyalty-event-date-time-filter.md b/doc/models/loyalty-event-date-time-filter.md index 988477e1..57dc6e39 100644 --- a/doc/models/loyalty-event-date-time-filter.md +++ b/doc/models/loyalty-event-date-time-filter.md @@ -18,8 +18,8 @@ Filter events by date time range. ```json { "created_at": { - "start_at": null, - "end_at": null + "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 index 5ed171e0..9c4c5767 100644 --- a/doc/models/loyalty-event-delete-reward.md +++ b/doc/models/loyalty-event-delete-reward.md @@ -11,8 +11,8 @@ Provides metadata when the event `type` is `DELETE_REWARD`. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `loyaltyProgramId` | `string` | Required | The ID of the [loyalty program](../../doc/models/loyalty-program.md).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | -| `rewardId` | `string \| undefined` | Optional | The ID of the deleted [loyalty reward](../../doc/models/loyalty-reward.md).
This field is returned only if the event source is `LOYALTY_API`.
**Constraints**: *Maximum Length*: `36` | +| `loyaltyProgramId` | `string` | Required | The ID of the [loyalty program](entity:LoyaltyProgram).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | +| `rewardId` | `string \| undefined` | 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` | | `points` | `number` | Required | The number of points returned to the loyalty account. | ## Example (as JSON) @@ -20,7 +20,7 @@ Provides metadata when the event `type` is `DELETE_REWARD`. ```json { "loyalty_program_id": "loyalty_program_id0", - "reward_id": null, + "reward_id": "reward_id4", "points": 236 } ``` diff --git a/doc/models/loyalty-event-expire-points.md b/doc/models/loyalty-event-expire-points.md index 2cbfd2f7..9206c137 100644 --- a/doc/models/loyalty-event-expire-points.md +++ b/doc/models/loyalty-event-expire-points.md @@ -11,7 +11,7 @@ Provides metadata when the event `type` is `EXPIRE_POINTS`. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `loyaltyProgramId` | `string` | Required | The Square-assigned ID of the [loyalty program](../../doc/models/loyalty-program.md).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | +| `loyaltyProgramId` | `string` | Required | The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | | `points` | `number` | Required | The number of points expired. | ## Example (as JSON) diff --git a/doc/models/loyalty-event-filter.md b/doc/models/loyalty-event-filter.md index 664ce00c..a1987a95 100644 --- a/doc/models/loyalty-event-filter.md +++ b/doc/models/loyalty-event-filter.md @@ -22,11 +22,32 @@ the endpoint uses a logical AND to evaluate them. ```json { - "loyalty_account_filter": null, - "type_filter": null, - "date_time_filter": null, - "location_filter": null, - "order_filter": null + "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_at0", + "end_at": "end_at2" + } + }, + "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 index 25e817eb..7f461744 100644 --- a/doc/models/loyalty-event-location-filter.md +++ b/doc/models/loyalty-event-location-filter.md @@ -11,7 +11,7 @@ Filter events by location. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `locationIds` | `string[]` | Required | The [location](../../doc/models/location.md) IDs for loyalty events to query.
If multiple values are specified, the endpoint uses
a logical OR to combine them. | +| `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. | ## Example (as JSON) diff --git a/doc/models/loyalty-event-loyalty-account-filter.md b/doc/models/loyalty-event-loyalty-account-filter.md index fd74bbbf..27292dcf 100644 --- a/doc/models/loyalty-event-loyalty-account-filter.md +++ b/doc/models/loyalty-event-loyalty-account-filter.md @@ -11,7 +11,7 @@ Filter events by loyalty account. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `loyaltyAccountId` | `string` | Required | The ID of the [loyalty account](../../doc/models/loyalty-account.md) associated with loyalty events.
**Constraints**: *Minimum Length*: `1` | +| `loyaltyAccountId` | `string` | Required | The ID of the [loyalty account](entity:LoyaltyAccount) associated with loyalty events.
**Constraints**: *Minimum Length*: `1` | ## Example (as JSON) diff --git a/doc/models/loyalty-event-order-filter.md b/doc/models/loyalty-event-order-filter.md index 51762af2..224db89b 100644 --- a/doc/models/loyalty-event-order-filter.md +++ b/doc/models/loyalty-event-order-filter.md @@ -11,7 +11,7 @@ Filter events by the order associated with the event. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `orderId` | `string` | Required | The ID of the [order](../../doc/models/order.md) associated with the event.
**Constraints**: *Minimum Length*: `1` | +| `orderId` | `string` | Required | The ID of the [order](entity:Order) associated with the event.
**Constraints**: *Minimum Length*: `1` | ## Example (as JSON) diff --git a/doc/models/loyalty-event-other.md b/doc/models/loyalty-event-other.md index 890bea8b..4a52b95a 100644 --- a/doc/models/loyalty-event-other.md +++ b/doc/models/loyalty-event-other.md @@ -11,7 +11,7 @@ Provides metadata when the event `type` is `OTHER`. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `loyaltyProgramId` | `string` | Required | The Square-assigned ID of the [loyalty program](../../doc/models/loyalty-program.md).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | +| `loyaltyProgramId` | `string` | Required | The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | | `points` | `number` | Required | The number of points added or removed. | ## Example (as JSON) diff --git a/doc/models/loyalty-event-query.md b/doc/models/loyalty-event-query.md index 4c9b2ad3..54fc1084 100644 --- a/doc/models/loyalty-event-query.md +++ b/doc/models/loyalty-event-query.md @@ -17,7 +17,34 @@ Represents a query used to search for loyalty events. ```json { - "filter": null + "filter": { + "loyalty_account_filter": { + "loyalty_account_id": "loyalty_account_id4" + }, + "type_filter": { + "types": [ + "DELETE_REWARD", + "ADJUST_POINTS", + "EXPIRE_POINTS" + ] + }, + "date_time_filter": { + "created_at": { + "start_at": "start_at6", + "end_at": "end_at6" + } + }, + "location_filter": { + "location_ids": [ + "location_ids4", + "location_ids5", + "location_ids6" + ] + }, + "order_filter": { + "order_id": "order_id6" + } + } } ``` diff --git a/doc/models/loyalty-event-redeem-reward.md b/doc/models/loyalty-event-redeem-reward.md index 1894a72a..f359cd45 100644 --- a/doc/models/loyalty-event-redeem-reward.md +++ b/doc/models/loyalty-event-redeem-reward.md @@ -11,17 +11,17 @@ Provides metadata when the event `type` is `REDEEM_REWARD`. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `loyaltyProgramId` | `string` | Required | The ID of the [loyalty program](../../doc/models/loyalty-program.md).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | -| `rewardId` | `string \| undefined` | Optional | The ID of the redeemed [loyalty reward](../../doc/models/loyalty-reward.md).
This field is returned only if the event source is `LOYALTY_API`.
**Constraints**: *Maximum Length*: `36` | -| `orderId` | `string \| undefined` | Optional | The ID of the [order](../../doc/models/order.md) that redeemed the reward.
This field is returned only if the Orders API is used to process orders. | +| `loyaltyProgramId` | `string` | Required | The ID of the [loyalty program](entity:LoyaltyProgram).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | +| `rewardId` | `string \| undefined` | 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` | +| `orderId` | `string \| undefined` | 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. | ## Example (as JSON) ```json { "loyalty_program_id": "loyalty_program_id0", - "reward_id": null, - "order_id": null + "reward_id": "reward_id4", + "order_id": "order_id6" } ``` diff --git a/doc/models/loyalty-event.md b/doc/models/loyalty-event.md index 0e2f33f7..6dac5472 100644 --- a/doc/models/loyalty-event.md +++ b/doc/models/loyalty-event.md @@ -20,8 +20,8 @@ For more information, see [Search for Balance-Changing Loyalty Events](https://d | `redeemReward` | [`LoyaltyEventRedeemReward \| undefined`](../../doc/models/loyalty-event-redeem-reward.md) | Optional | Provides metadata when the event `type` is `REDEEM_REWARD`. | | `deleteReward` | [`LoyaltyEventDeleteReward \| undefined`](../../doc/models/loyalty-event-delete-reward.md) | Optional | Provides metadata when the event `type` is `DELETE_REWARD`. | | `adjustPoints` | [`LoyaltyEventAdjustPoints \| undefined`](../../doc/models/loyalty-event-adjust-points.md) | Optional | Provides metadata when the event `type` is `ADJUST_POINTS`. | -| `loyaltyAccountId` | `string` | Required | The ID of the [loyalty account](../../doc/models/loyalty-account.md) associated with the event.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | -| `locationId` | `string \| undefined` | Optional | The ID of the [location](../../doc/models/location.md) where the event occurred. | +| `loyaltyAccountId` | `string` | Required | The ID of the [loyalty account](entity:LoyaltyAccount) associated with the event.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | +| `locationId` | `string \| undefined` | Optional | The ID of the [location](entity:Location) where the event occurred. | | `source` | [`string`](../../doc/models/loyalty-event-source.md) | Required | Defines whether the event was generated by the Square Point of Sale. | | `expirePoints` | [`LoyaltyEventExpirePoints \| undefined`](../../doc/models/loyalty-event-expire-points.md) | Optional | Provides metadata when the event `type` is `EXPIRE_POINTS`. | | `otherEvent` | [`LoyaltyEventOther \| undefined`](../../doc/models/loyalty-event-other.md) | Optional | Provides metadata when the event `type` is `OTHER`. | @@ -34,17 +34,48 @@ For more information, see [Search for Balance-Changing Loyalty Events](https://d "id": "id0", "type": "OTHER", "created_at": "created_at2", - "accumulate_points": null, - "create_reward": null, - "redeem_reward": null, - "delete_reward": null, - "adjust_points": null, + "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", - "location_id": null, + "location_id": "location_id4", "source": "SQUARE", - "expire_points": null, - "other_event": null, - "accumulate_promotion_points": null + "expire_points": { + "loyalty_program_id": "loyalty_program_id2", + "points": 38 + }, + "other_event": { + "loyalty_program_id": "loyalty_program_id2", + "points": 70 + }, + "accumulate_promotion_points": { + "loyalty_program_id": "loyalty_program_id0", + "loyalty_promotion_id": "loyalty_promotion_id8", + "points": 62, + "order_id": "order_id4" + } } ``` diff --git a/doc/models/loyalty-program-accrual-rule-category-data.md b/doc/models/loyalty-program-accrual-rule-category-data.md index e8fcd989..78c5e067 100644 --- a/doc/models/loyalty-program-accrual-rule-category-data.md +++ b/doc/models/loyalty-program-accrual-rule-category-data.md @@ -11,7 +11,7 @@ Represents additional data for rules with the `CATEGORY` accrual type. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `categoryId` | `string` | Required | The ID of the `CATEGORY` [catalog object](../../doc/models/catalog-object.md) that buyers can purchase to earn
points.
**Constraints**: *Minimum Length*: `1` | +| `categoryId` | `string` | Required | The ID of the `CATEGORY` [catalog object](entity:CatalogObject) that buyers can purchase to earn
points.
**Constraints**: *Minimum Length*: `1` | ## Example (as JSON) diff --git a/doc/models/loyalty-program-accrual-rule-item-variation-data.md b/doc/models/loyalty-program-accrual-rule-item-variation-data.md index 9c66e43d..a8ffc35e 100644 --- a/doc/models/loyalty-program-accrual-rule-item-variation-data.md +++ b/doc/models/loyalty-program-accrual-rule-item-variation-data.md @@ -11,7 +11,7 @@ Represents additional data for rules with the `ITEM_VARIATION` accrual type. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `itemVariationId` | `string` | Required | The ID of the `ITEM_VARIATION` [catalog object](../../doc/models/catalog-object.md) that buyers can purchase to earn
points.
**Constraints**: *Minimum Length*: `1` | +| `itemVariationId` | `string` | Required | The ID of the `ITEM_VARIATION` [catalog object](entity:CatalogObject) that buyers can purchase to earn
points.
**Constraints**: *Minimum Length*: `1` | ## Example (as JSON) diff --git a/doc/models/loyalty-program-accrual-rule-spend-data.md b/doc/models/loyalty-program-accrual-rule-spend-data.md index d040c511..e8f18d69 100644 --- a/doc/models/loyalty-program-accrual-rule-spend-data.md +++ b/doc/models/loyalty-program-accrual-rule-spend-data.md @@ -12,8 +12,8 @@ Represents additional data for rules with the `SPEND` accrual type. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `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. | -| `excludedCategoryIds` | `string[] \| undefined` | Optional | The IDs of any `CATEGORY` catalog objects that are excluded from points accrual.

You can use the [BatchRetrieveCatalogObjects](../../doc/api/catalog.md#batch-retrieve-catalog-objects)
endpoint to retrieve information about the excluded categories. | -| `excludedItemVariationIds` | `string[] \| undefined` | Optional | The IDs of any `ITEM_VARIATION` catalog objects that are excluded from points accrual.

You can use the [BatchRetrieveCatalogObjects](../../doc/api/catalog.md#batch-retrieve-catalog-objects)
endpoint to retrieve information about the excluded item variations. | +| `excludedCategoryIds` | `string[] \| undefined` | 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. | +| `excludedItemVariationIds` | `string[] \| undefined` | 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. | | `taxMode` | [`string`](../../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. | ## Example (as JSON) @@ -21,11 +21,18 @@ Represents additional data for rules with the `SPEND` accrual type. ```json { "amount_money": { - "amount": null, - "currency": null + "amount": 186, + "currency": "NGN" }, - "excluded_category_ids": null, - "excluded_item_variation_ids": null, + "excluded_category_ids": [ + "excluded_category_ids8", + "excluded_category_ids9" + ], + "excluded_item_variation_ids": [ + "excluded_item_variation_ids1", + "excluded_item_variation_ids2", + "excluded_item_variation_ids3" + ], "tax_mode": "BEFORE_TAX" } ``` diff --git a/doc/models/loyalty-program-accrual-rule-visit-data.md b/doc/models/loyalty-program-accrual-rule-visit-data.md index 082fcdb2..51204036 100644 --- a/doc/models/loyalty-program-accrual-rule-visit-data.md +++ b/doc/models/loyalty-program-accrual-rule-visit-data.md @@ -18,7 +18,10 @@ Represents additional data for rules with the `VISIT` accrual type. ```json { - "minimum_amount_money": null, + "minimum_amount_money": { + "amount": 146, + "currency": "UYI" + }, "tax_mode": "BEFORE_TAX" } ``` diff --git a/doc/models/loyalty-program-accrual-rule.md b/doc/models/loyalty-program-accrual-rule.md index e548eee4..b93d9992 100644 --- a/doc/models/loyalty-program-accrual-rule.md +++ b/doc/models/loyalty-program-accrual-rule.md @@ -23,11 +23,34 @@ Represents an accrual rule, which defines how buyers can earn points from the ba ```json { "accrual_type": "ITEM_VARIATION", - "points": null, - "visit_data": null, - "spend_data": null, - "item_variation_data": null, - "category_data": null + "points": 236, + "visit_data": { + "minimum_amount_money": { + "amount": 24, + "currency": "GEL" + }, + "tax_mode": "BEFORE_TAX" + }, + "spend_data": { + "amount_money": { + "amount": 248, + "currency": "MXV" + }, + "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-reward-definition.md b/doc/models/loyalty-program-reward-definition.md index 9ec8c70f..e577d4e5 100644 --- a/doc/models/loyalty-program-reward-definition.md +++ b/doc/models/loyalty-program-reward-definition.md @@ -26,10 +26,20 @@ are now defined using a catalog pricing rule and other catalog objects. For more { "scope": "CATEGORY", "discount_type": "FIXED_AMOUNT", - "percentage_discount": null, - "catalog_object_ids": null, - "fixed_discount_money": null, - "max_discount_money": null + "percentage_discount": "percentage_discount8", + "catalog_object_ids": [ + "catalog_object_ids2", + "catalog_object_ids3", + "catalog_object_ids4" + ], + "fixed_discount_money": { + "amount": 36, + "currency": "WST" + }, + "max_discount_money": { + "amount": 84, + "currency": "JOD" + } } ``` diff --git a/doc/models/loyalty-program-reward-tier.md b/doc/models/loyalty-program-reward-tier.md index 3a2be228..56fddafa 100644 --- a/doc/models/loyalty-program-reward-tier.md +++ b/doc/models/loyalty-program-reward-tier.md @@ -22,14 +22,29 @@ Represents a reward tier in a loyalty program. A reward tier defines how buyers ```json { - "id": null, + "id": "id0", "points": 236, - "name": null, - "definition": null, - "created_at": null, + "name": "name0", + "definition": { + "scope": "ORDER", + "discount_type": "FIXED_AMOUNT", + "percentage_discount": "percentage_discount2", + "catalog_object_ids": [ + "catalog_object_ids6" + ], + "fixed_discount_money": { + "amount": 132, + "currency": "TRY" + }, + "max_discount_money": { + "amount": 176, + "currency": "MYR" + } + }, + "created_at": "created_at2", "pricing_rule_reference": { - "object_id": null, - "catalog_version": null + "object_id": "object_id0", + "catalog_version": 218 } } ``` diff --git a/doc/models/loyalty-program.md b/doc/models/loyalty-program.md index 4f4cbe4a..ce5ea09a 100644 --- a/doc/models/loyalty-program.md +++ b/doc/models/loyalty-program.md @@ -18,24 +18,152 @@ For more information, see [Loyalty Program Overview](https://developer.squareup. | `rewardTiers` | [`LoyaltyProgramRewardTier[] \| undefined`](../../doc/models/loyalty-program-reward-tier.md) | Optional | The list of rewards for buyers, sorted by ascending points. | | `expirationPolicy` | [`LoyaltyProgramExpirationPolicy \| undefined`](../../doc/models/loyalty-program-expiration-policy.md) | Optional | Describes when the loyalty program expires. | | `terminology` | [`LoyaltyProgramTerminology \| undefined`](../../doc/models/loyalty-program-terminology.md) | Optional | Represents the naming used for loyalty points. | -| `locationIds` | `string[] \| undefined` | Optional | The [locations](../../doc/models/location.md) at which the program is active. | +| `locationIds` | `string[] \| undefined` | Optional | The [locations](entity:Location) at which the program is active. | | `createdAt` | `string \| undefined` | Optional | The timestamp when the program was created, in RFC 3339 format. | | `updatedAt` | `string \| undefined` | Optional | The timestamp when the reward was last updated, in RFC 3339 format. | -| `accrualRules` | [`LoyaltyProgramAccrualRule[] \| undefined`](../../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](../../doc/models/loyalty-promotion.md) that enable
buyers to earn extra points, call [ListLoyaltyPromotions](../../doc/api/loyalty.md#list-loyalty-promotions). | +| `accrualRules` | [`LoyaltyProgramAccrualRule[] \| undefined`](../../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). | ## Example (as JSON) ```json { - "id": null, - "status": null, - "reward_tiers": null, - "expiration_policy": null, - "terminology": null, - "location_ids": null, - "created_at": null, - "updated_at": null, - "accrual_rules": null + "id": "id0", + "status": "INACTIVE", + "reward_tiers": [ + { + "id": "id9", + "points": 249, + "name": "name9", + "definition": { + "scope": "CATEGORY", + "discount_type": "FIXED_PERCENTAGE", + "percentage_discount": "percentage_discount1", + "catalog_object_ids": [ + "catalog_object_ids3", + "catalog_object_ids4", + "catalog_object_ids5" + ], + "fixed_discount_money": { + "amount": 119, + "currency": "CUC" + }, + "max_discount_money": { + "amount": 163, + "currency": "ZMK" + } + }, + "created_at": "created_at7", + "pricing_rule_reference": { + "object_id": "object_id9", + "catalog_version": 205 + } + }, + { + "id": "id0", + "points": 248, + "name": "name0", + "definition": { + "scope": "ORDER", + "discount_type": "FIXED_AMOUNT", + "percentage_discount": "percentage_discount2", + "catalog_object_ids": [ + "catalog_object_ids4" + ], + "fixed_discount_money": { + "amount": 120, + "currency": "CUP" + }, + "max_discount_money": { + "amount": 164, + "currency": "ZMW" + } + }, + "created_at": "created_at8", + "pricing_rule_reference": { + "object_id": "object_id0", + "catalog_version": 206 + } + } + ], + "expiration_policy": { + "expiration_duration": "expiration_duration0" + }, + "terminology": { + "one": "one0", + "other": "other6" + }, + "location_ids": [ + "location_ids0" + ], + "created_at": "created_at2", + "updated_at": "updated_at4", + "accrual_rules": [ + { + "accrual_type": "ITEM_VARIATION", + "points": 100, + "visit_data": { + "minimum_amount_money": { + "amount": 160, + "currency": "TTD" + }, + "tax_mode": "BEFORE_TAX" + }, + "spend_data": { + "amount_money": { + "amount": 128, + "currency": "BHD" + }, + "excluded_category_ids": [ + "excluded_category_ids2", + "excluded_category_ids3", + "excluded_category_ids4" + ], + "excluded_item_variation_ids": [ + "excluded_item_variation_ids5", + "excluded_item_variation_ids4", + "excluded_item_variation_ids3" + ], + "tax_mode": "BEFORE_TAX" + }, + "item_variation_data": { + "item_variation_id": "item_variation_id8" + }, + "category_data": { + "category_id": "category_id4" + } + }, + { + "accrual_type": "SPEND", + "points": 99, + "visit_data": { + "minimum_amount_money": { + "amount": 161, + "currency": "TWD" + }, + "tax_mode": "AFTER_TAX" + }, + "spend_data": { + "amount_money": { + "amount": 129, + "currency": "BIF" + }, + "excluded_category_ids": [ + "excluded_category_ids3" + ], + "excluded_item_variation_ids": [ + "excluded_item_variation_ids6", + "excluded_item_variation_ids5" + ], + "tax_mode": "AFTER_TAX" + }, + "item_variation_data": { + "item_variation_id": "item_variation_id9" + }, + "category_data": { + "category_id": "category_id5" + } + } + ] } ``` diff --git a/doc/models/loyalty-promotion-available-time-data.md b/doc/models/loyalty-promotion-available-time-data.md index d3925f83..bac5b476 100644 --- a/doc/models/loyalty-promotion-available-time-data.md +++ b/doc/models/loyalty-promotion-available-time-data.md @@ -20,8 +20,8 @@ from a [loyalty promotion](../../doc/models/loyalty-promotion.md). ```json { - "start_date": null, - "end_date": null, + "start_date": "start_date6", + "end_date": "end_date0", "time_periods": [ "time_periods1", "time_periods2" diff --git a/doc/models/loyalty-promotion-incentive.md b/doc/models/loyalty-promotion-incentive.md index c3b96442..e8a4d816 100644 --- a/doc/models/loyalty-promotion-incentive.md +++ b/doc/models/loyalty-promotion-incentive.md @@ -22,8 +22,12 @@ of points to the points earned from the base program. ```json { "type": "POINTS_MULTIPLIER", - "points_multiplier_data": null, - "points_addition_data": null + "points_multiplier_data": { + "points_multiplier": 134 + }, + "points_addition_data": { + "points_addition": 218 + } } ``` diff --git a/doc/models/loyalty-promotion-trigger-limit.md b/doc/models/loyalty-promotion-trigger-limit.md index 7f9b8382..89decf97 100644 --- a/doc/models/loyalty-promotion-trigger-limit.md +++ b/doc/models/loyalty-promotion-trigger-limit.md @@ -23,7 +23,7 @@ A purchase that is disqualified from earning points because of this limit might ```json { "times": 28, - "interval": null + "interval": "ALL_TIME" } ``` diff --git a/doc/models/loyalty-promotion.md b/doc/models/loyalty-promotion.md index dac59f34..ce29af07 100644 --- a/doc/models/loyalty-promotion.md +++ b/doc/models/loyalty-promotion.md @@ -23,38 +23,55 @@ A loyalty program can have a maximum of 10 loyalty promotions with an `ACTIVE` o | `createdAt` | `string \| undefined` | Optional | The timestamp of when the promotion was created, in RFC 3339 format. | | `canceledAt` | `string \| undefined` | Optional | The timestamp of when the promotion was canceled, in RFC 3339 format. | | `updatedAt` | `string \| undefined` | Optional | The timestamp when the promotion was last updated, in RFC 3339 format. | -| `loyaltyProgramId` | `string \| undefined` | Optional | The ID of the [loyalty program](../../doc/models/loyalty-program.md) associated with the promotion. | +| `loyaltyProgramId` | `string \| undefined` | Optional | The ID of the [loyalty program](entity:LoyaltyProgram) associated with the promotion. | | `minimumSpendAmountMoney` | [`Money \| undefined`](../../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. | -| `qualifyingItemVariationIds` | `string[] \| undefined` | Optional | The IDs of any qualifying `ITEM_VARIATION` [catalog objects](../../doc/models/catalog-object.md). 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. | -| `qualifyingCategoryIds` | `string[] \| undefined` | Optional | The IDs of any qualifying `CATEGORY` [catalog objects](../../doc/models/catalog-object.md). 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. | +| `qualifyingItemVariationIds` | `string[] \| undefined` | 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. | +| `qualifyingCategoryIds` | `string[] \| undefined` | 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. | ## Example (as JSON) ```json { - "id": null, + "id": "id0", "name": "name0", "incentive": { "type": "POINTS_MULTIPLIER", - "points_multiplier_data": null, - "points_addition_data": null + "points_multiplier_data": { + "points_multiplier": 16 + }, + "points_addition_data": { + "points_addition": 16 + } }, "available_time": { - "start_date": null, - "end_date": null, + "start_date": "start_date4", + "end_date": "end_date8", "time_periods": [ "time_periods9" ] }, - "trigger_limit": null, - "status": null, - "created_at": null, - "canceled_at": null, - "updated_at": null, - "loyalty_program_id": null, - "minimum_spend_amount_money": null, - "qualifying_item_variation_ids": null, - "qualifying_category_ids": null + "trigger_limit": { + "times": 26, + "interval": "ALL_TIME" + }, + "status": "ACTIVE", + "created_at": "created_at2", + "canceled_at": "canceled_at4", + "updated_at": "updated_at4", + "loyalty_program_id": "loyalty_program_id0", + "minimum_spend_amount_money": { + "amount": 228, + "currency": "ZMW" + }, + "qualifying_item_variation_ids": [ + "qualifying_item_variation_ids5", + "qualifying_item_variation_ids6" + ], + "qualifying_category_ids": [ + "qualifying_category_ids2", + "qualifying_category_ids3", + "qualifying_category_ids4" + ] } ``` diff --git a/doc/models/loyalty-reward.md b/doc/models/loyalty-reward.md index 60be0dcf..3e5155cb 100644 --- a/doc/models/loyalty-reward.md +++ b/doc/models/loyalty-reward.md @@ -14,10 +14,10 @@ For more information, see [Manage loyalty rewards](https://developer.squareup.co | --- | --- | --- | --- | | `id` | `string \| undefined` | Optional | The Square-assigned ID of the loyalty reward.
**Constraints**: *Maximum Length*: `36` | | `status` | [`string \| undefined`](../../doc/models/loyalty-reward-status.md) | Optional | The status of the loyalty reward. | -| `loyaltyAccountId` | `string` | Required | The Square-assigned ID of the [loyalty account](../../doc/models/loyalty-account.md) to which the reward belongs.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | -| `rewardTierId` | `string` | Required | The Square-assigned ID of the [reward tier](../../doc/models/loyalty-program-reward-tier.md) used to create the reward.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | +| `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` | +| `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` | | `points` | `number \| undefined` | Optional | The number of loyalty points used for the reward.
**Constraints**: `>= 1` | -| `orderId` | `string \| undefined` | Optional | The Square-assigned ID of the [order](../../doc/models/order.md) to which the reward is attached. | +| `orderId` | `string \| undefined` | Optional | The Square-assigned ID of the [order](entity:Order) to which the reward is attached. | | `createdAt` | `string \| undefined` | Optional | The timestamp when the reward was created, in RFC 3339 format. | | `updatedAt` | `string \| undefined` | Optional | The timestamp when the reward was last updated, in RFC 3339 format. | | `redeemedAt` | `string \| undefined` | Optional | The timestamp when the reward was redeemed, in RFC 3339 format. | @@ -26,15 +26,15 @@ For more information, see [Manage loyalty rewards](https://developer.squareup.co ```json { - "id": null, - "status": null, + "id": "id0", + "status": "DELETED", "loyalty_account_id": "loyalty_account_id0", "reward_tier_id": "reward_tier_id6", - "points": null, - "order_id": null, - "created_at": null, - "updated_at": null, - "redeemed_at": null + "points": 236, + "order_id": "order_id6", + "created_at": "created_at2", + "updated_at": "updated_at4", + "redeemed_at": "redeemed_at2" } ``` diff --git a/doc/models/measurement-unit.md b/doc/models/measurement-unit.md index 623e63ef..c3db39e0 100644 --- a/doc/models/measurement-unit.md +++ b/doc/models/measurement-unit.md @@ -26,14 +26,17 @@ or inches. Exactly one of the following fields are required: `custom_unit`, ```json { - "custom_unit": null, - "area_unit": null, - "length_unit": null, - "volume_unit": null, - "weight_unit": null, - "generic_unit": null, - "time_unit": null, - "type": null + "custom_unit": { + "name": "name2", + "abbreviation": "abbreviation4" + }, + "area_unit": "IMPERIAL_SQUARE_MILE", + "length_unit": "METRIC_MILLIMETER", + "volume_unit": "GENERIC_CUP", + "weight_unit": "IMPERIAL_STONE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MINUTE", + "type": "TYPE_LENGTH" } ``` diff --git a/doc/models/merchant.md b/doc/models/merchant.md index 80576c2d..f579e6fd 100644 --- a/doc/models/merchant.md +++ b/doc/models/merchant.md @@ -24,14 +24,14 @@ Represents a business that sells with Square. ```json { - "id": null, - "business_name": null, + "id": "id0", + "business_name": "business_name4", "country": "FO", - "language_code": null, - "currency": null, - "status": null, - "main_location_id": null, - "created_at": null + "language_code": "language_code8", + "currency": "YER", + "status": "ACTIVE", + "main_location_id": "main_location_id0", + "created_at": "created_at2" } ``` diff --git a/doc/models/money.md b/doc/models/money.md index 9c8af60d..252a6935 100644 --- a/doc/models/money.md +++ b/doc/models/money.md @@ -23,8 +23,8 @@ for more information. ```json { - "amount": null, - "currency": null + "amount": 46, + "currency": "YER" } ``` diff --git a/doc/models/order-created-object.md b/doc/models/order-created-object.md index 9c7ceb94..54dabf25 100644 --- a/doc/models/order-created-object.md +++ b/doc/models/order-created-object.md @@ -15,7 +15,13 @@ ```json { - "order_created": null + "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 index f3948f7a..8edc8e47 100644 --- a/doc/models/order-created.md +++ b/doc/models/order-created.md @@ -19,11 +19,11 @@ ```json { - "order_id": null, - "version": null, - "location_id": null, - "state": null, - "created_at": null + "order_id": "order_id6", + "version": 172, + "location_id": "location_id4", + "state": "OPEN", + "created_at": "created_at2" } ``` diff --git a/doc/models/order-entry.md b/doc/models/order-entry.md index 31ef8b48..a03a4975 100644 --- a/doc/models/order-entry.md +++ b/doc/models/order-entry.md @@ -20,9 +20,9 @@ A lightweight description of an [order](../../doc/models/order.md) that is retur ```json { - "order_id": null, - "version": null, - "location_id": null + "order_id": "order_id6", + "version": 172, + "location_id": "location_id4" } ``` diff --git a/doc/models/order-fulfillment-delivery-details.md b/doc/models/order-fulfillment-delivery-details.md index 4a9707d7..3bc6afcf 100644 --- a/doc/models/order-fulfillment-delivery-details.md +++ b/doc/models/order-fulfillment-delivery-details.md @@ -39,29 +39,50 @@ Describes delivery details of an order fulfillment. ```json { - "recipient": null, - "schedule_type": null, - "placed_at": null, - "deliver_at": null, - "prep_time_duration": null, - "delivery_window_duration": null, - "note": null, - "completed_at": null, - "in_progress_at": null, - "rejected_at": null, - "ready_at": null, - "delivered_at": null, - "canceled_at": null, - "cancel_reason": null, - "courier_pickup_at": null, - "courier_pickup_window_duration": null, - "is_no_contact_delivery": null, - "dropoff_notes": null, - "courier_provider_name": null, - "courier_support_phone_number": null, - "square_delivery_id": null, - "external_delivery_id": null, - "managed_delivery": null + "recipient": { + "customer_id": "customer_id6", + "display_name": "display_name8", + "email_address": "email_address4", + "phone_number": "phone_number4", + "address": { + "address_line_1": "address_line_14", + "address_line_2": "address_line_24", + "address_line_3": "address_line_30", + "locality": "locality4", + "sublocality": "sublocality4", + "sublocality_2": "sublocality_22", + "sublocality_3": "sublocality_34", + "administrative_district_level_1": "administrative_district_level_18", + "administrative_district_level_2": "administrative_district_level_20", + "administrative_district_level_3": "administrative_district_level_32", + "postal_code": "postal_code6", + "country": "PK", + "first_name": "first_name4", + "last_name": "last_name2" + } + }, + "schedule_type": "SCHEDULED", + "placed_at": "placed_at0", + "deliver_at": "deliver_at8", + "prep_time_duration": "prep_time_duration2", + "delivery_window_duration": "delivery_window_duration4", + "note": "note4", + "completed_at": "completed_at2", + "in_progress_at": "in_progress_at4", + "rejected_at": "rejected_at8", + "ready_at": "ready_at0", + "delivered_at": "delivered_at8", + "canceled_at": "canceled_at4", + "cancel_reason": "cancel_reason4", + "courier_pickup_at": "courier_pickup_at8", + "courier_pickup_window_duration": "courier_pickup_window_duration6", + "is_no_contact_delivery": false, + "dropoff_notes": "dropoff_notes6", + "courier_provider_name": "courier_provider_name2", + "courier_support_phone_number": "courier_support_phone_number4", + "square_delivery_id": "square_delivery_id0", + "external_delivery_id": "external_delivery_id6", + "managed_delivery": false } ``` diff --git a/doc/models/order-fulfillment-fulfillment-entry.md b/doc/models/order-fulfillment-fulfillment-entry.md index b109a561..3930588b 100644 --- a/doc/models/order-fulfillment-fulfillment-entry.md +++ b/doc/models/order-fulfillment-fulfillment-entry.md @@ -22,10 +22,14 @@ fulfill. ```json { - "uid": null, + "uid": "uid0", "line_item_uid": "line_item_uid0", "quantity": "quantity6", - "metadata": null + "metadata": { + "key0": "metadata3", + "key1": "metadata4", + "key2": "metadata5" + } } ``` diff --git a/doc/models/order-fulfillment-pickup-details-curbside-pickup-details.md b/doc/models/order-fulfillment-pickup-details-curbside-pickup-details.md index 8fb9a100..64a08841 100644 --- a/doc/models/order-fulfillment-pickup-details-curbside-pickup-details.md +++ b/doc/models/order-fulfillment-pickup-details-curbside-pickup-details.md @@ -18,8 +18,8 @@ Specific details for curbside pickup. ```json { - "curbside_details": null, - "buyer_arrived_at": null + "curbside_details": "curbside_details6", + "buyer_arrived_at": "buyer_arrived_at2" } ``` diff --git a/doc/models/order-fulfillment-pickup-details.md b/doc/models/order-fulfillment-pickup-details.md index b079bbde..be144b7e 100644 --- a/doc/models/order-fulfillment-pickup-details.md +++ b/doc/models/order-fulfillment-pickup-details.md @@ -34,24 +34,48 @@ Contains details necessary to fulfill a pickup order. ```json { - "recipient": null, - "expires_at": null, - "auto_complete_duration": null, - "schedule_type": null, - "pickup_at": null, - "pickup_window_duration": null, - "prep_time_duration": null, - "note": null, - "placed_at": null, - "accepted_at": null, - "rejected_at": null, - "ready_at": null, - "expired_at": null, - "picked_up_at": null, - "canceled_at": null, - "cancel_reason": null, - "is_curbside_pickup": null, - "curbside_pickup_details": null + "recipient": { + "customer_id": "customer_id6", + "display_name": "display_name8", + "email_address": "email_address4", + "phone_number": "phone_number4", + "address": { + "address_line_1": "address_line_14", + "address_line_2": "address_line_24", + "address_line_3": "address_line_30", + "locality": "locality4", + "sublocality": "sublocality4", + "sublocality_2": "sublocality_22", + "sublocality_3": "sublocality_34", + "administrative_district_level_1": "administrative_district_level_18", + "administrative_district_level_2": "administrative_district_level_20", + "administrative_district_level_3": "administrative_district_level_32", + "postal_code": "postal_code6", + "country": "PK", + "first_name": "first_name4", + "last_name": "last_name2" + } + }, + "expires_at": "expires_at6", + "auto_complete_duration": "auto_complete_duration4", + "schedule_type": "SCHEDULED", + "pickup_at": "pickup_at4", + "pickup_window_duration": "pickup_window_duration0", + "prep_time_duration": "prep_time_duration2", + "note": "note4", + "placed_at": "placed_at0", + "accepted_at": "accepted_at6", + "rejected_at": "rejected_at8", + "ready_at": "ready_at0", + "expired_at": "expired_at0", + "picked_up_at": "picked_up_at0", + "canceled_at": "canceled_at4", + "cancel_reason": "cancel_reason4", + "is_curbside_pickup": false, + "curbside_pickup_details": { + "curbside_details": "curbside_details2", + "buyer_arrived_at": "buyer_arrived_at8" + } } ``` diff --git a/doc/models/order-fulfillment-recipient.md b/doc/models/order-fulfillment-recipient.md index e1079ae9..bf2a157f 100644 --- a/doc/models/order-fulfillment-recipient.md +++ b/doc/models/order-fulfillment-recipient.md @@ -21,11 +21,26 @@ Information about the fulfillment recipient. ```json { - "customer_id": null, - "display_name": null, - "email_address": null, - "phone_number": null, - "address": null + "customer_id": "customer_id8", + "display_name": "display_name0", + "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", + "sublocality_2": "sublocality_24", + "sublocality_3": "sublocality_36", + "administrative_district_level_1": "administrative_district_level_10", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_34", + "postal_code": "postal_code8", + "country": "BE", + "first_name": "first_name6", + "last_name": "last_name4" + } } ``` diff --git a/doc/models/order-fulfillment-shipment-details.md b/doc/models/order-fulfillment-shipment-details.md index 79c342ad..2e87b839 100644 --- a/doc/models/order-fulfillment-shipment-details.md +++ b/doc/models/order-fulfillment-shipment-details.md @@ -31,21 +31,42 @@ Contains the details necessary to fulfill a shipment order. ```json { - "recipient": null, - "carrier": null, - "shipping_note": null, - "shipping_type": null, - "tracking_number": null, - "tracking_url": null, - "placed_at": null, - "in_progress_at": null, - "packaged_at": null, - "expected_shipped_at": null, - "shipped_at": null, - "canceled_at": null, - "cancel_reason": null, - "failed_at": null, - "failure_reason": null + "recipient": { + "customer_id": "customer_id6", + "display_name": "display_name8", + "email_address": "email_address4", + "phone_number": "phone_number4", + "address": { + "address_line_1": "address_line_14", + "address_line_2": "address_line_24", + "address_line_3": "address_line_30", + "locality": "locality4", + "sublocality": "sublocality4", + "sublocality_2": "sublocality_22", + "sublocality_3": "sublocality_34", + "administrative_district_level_1": "administrative_district_level_18", + "administrative_district_level_2": "administrative_district_level_20", + "administrative_district_level_3": "administrative_district_level_32", + "postal_code": "postal_code6", + "country": "PK", + "first_name": "first_name4", + "last_name": "last_name2" + } + }, + "carrier": "carrier2", + "shipping_note": "shipping_note6", + "shipping_type": "shipping_type6", + "tracking_number": "tracking_number8", + "tracking_url": "tracking_url0", + "placed_at": "placed_at0", + "in_progress_at": "in_progress_at4", + "packaged_at": "packaged_at4", + "expected_shipped_at": "expected_shipped_at4", + "shipped_at": "shipped_at8", + "canceled_at": "canceled_at4", + "cancel_reason": "cancel_reason4", + "failed_at": "failed_at4", + "failure_reason": "failure_reason0" } ``` diff --git a/doc/models/order-fulfillment-updated-object.md b/doc/models/order-fulfillment-updated-object.md index bbf9951e..78cf156d 100644 --- a/doc/models/order-fulfillment-updated-object.md +++ b/doc/models/order-fulfillment-updated-object.md @@ -15,7 +15,21 @@ ```json { - "order_fulfillment_updated": null + "order_fulfillment_updated": { + "order_id": "order_id8", + "version": 174, + "location_id": "location_id8", + "state": "CANCELED", + "created_at": "created_at2", + "updated_at": "updated_at0", + "fulfillment_update": [ + { + "fulfillment_uid": "fulfillment_uid0", + "old_state": "PREPARED", + "new_state": "PROPOSED" + } + ] + } } ``` diff --git a/doc/models/order-fulfillment-updated-update.md b/doc/models/order-fulfillment-updated-update.md index 5735e146..862fe7cd 100644 --- a/doc/models/order-fulfillment-updated-update.md +++ b/doc/models/order-fulfillment-updated-update.md @@ -19,9 +19,9 @@ Information about fulfillment updates. ```json { - "fulfillment_uid": null, - "old_state": null, - "new_state": null + "fulfillment_uid": "fulfillment_uid4", + "old_state": "PREPARED", + "new_state": "PREPARED" } ``` diff --git a/doc/models/order-fulfillment-updated.md b/doc/models/order-fulfillment-updated.md index 43567062..06cd22ac 100644 --- a/doc/models/order-fulfillment-updated.md +++ b/doc/models/order-fulfillment-updated.md @@ -21,13 +21,29 @@ ```json { - "order_id": null, - "version": null, - "location_id": null, - "state": null, - "created_at": null, - "updated_at": null, - "fulfillment_update": null + "order_id": "order_id6", + "version": 172, + "location_id": "location_id4", + "state": "OPEN", + "created_at": "created_at2", + "updated_at": "updated_at4", + "fulfillment_update": [ + { + "fulfillment_uid": "fulfillment_uid6", + "old_state": "CANCELED", + "new_state": "PREPARED" + }, + { + "fulfillment_uid": "fulfillment_uid7", + "old_state": "FAILED", + "new_state": "COMPLETED" + }, + { + "fulfillment_uid": "fulfillment_uid8", + "old_state": "PROPOSED", + "new_state": "CANCELED" + } + ] } ``` diff --git a/doc/models/order-fulfillment.md b/doc/models/order-fulfillment.md index 04383f73..e1d308ea 100644 --- a/doc/models/order-fulfillment.md +++ b/doc/models/order-fulfillment.md @@ -27,15 +27,155 @@ However, orders returned by the Orders API might contain multiple fulfillments b ```json { - "uid": null, - "type": null, - "state": null, - "line_item_application": null, - "entries": null, - "metadata": null, - "pickup_details": null, - "shipment_details": null, - "delivery_details": null + "uid": "uid0", + "type": "DELIVERY", + "state": "PREPARED", + "line_item_application": "ALL", + "entries": [ + { + "uid": "uid5", + "line_item_uid": "line_item_uid5", + "quantity": "quantity1", + "metadata": { + "key0": "metadata8", + "key1": "metadata9", + "key2": "metadata0" + } + } + ], + "metadata": { + "key0": "metadata3", + "key1": "metadata4", + "key2": "metadata5" + }, + "pickup_details": { + "recipient": { + "customer_id": "customer_id8", + "display_name": "display_name0", + "email_address": "email_address8", + "phone_number": "phone_number8", + "address": { + "address_line_1": "address_line_16", + "address_line_2": "address_line_26", + "address_line_3": "address_line_32", + "locality": "locality6", + "sublocality": "sublocality6", + "sublocality_2": "sublocality_24", + "sublocality_3": "sublocality_36", + "administrative_district_level_1": "administrative_district_level_10", + "administrative_district_level_2": "administrative_district_level_22", + "administrative_district_level_3": "administrative_district_level_34", + "postal_code": "postal_code8", + "country": "TK", + "first_name": "first_name6", + "last_name": "last_name4" + } + }, + "expires_at": "expires_at2", + "auto_complete_duration": "auto_complete_duration2", + "schedule_type": "SCHEDULED", + "pickup_at": "pickup_at6", + "pickup_window_duration": "pickup_window_duration8", + "prep_time_duration": "prep_time_duration0", + "note": "note4", + "placed_at": "placed_at2", + "accepted_at": "accepted_at2", + "rejected_at": "rejected_at0", + "ready_at": "ready_at8", + "expired_at": "expired_at8", + "picked_up_at": "picked_up_at8", + "canceled_at": "canceled_at4", + "cancel_reason": "cancel_reason4", + "is_curbside_pickup": false, + "curbside_pickup_details": { + "curbside_details": "curbside_details0", + "buyer_arrived_at": "buyer_arrived_at6" + } + }, + "shipment_details": { + "recipient": { + "customer_id": "customer_id8", + "display_name": "display_name0", + "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", + "sublocality_2": "sublocality_24", + "sublocality_3": "sublocality_36", + "administrative_district_level_1": "administrative_district_level_10", + "administrative_district_level_2": "administrative_district_level_22", + "administrative_district_level_3": "administrative_district_level_34", + "postal_code": "postal_code8", + "country": "UA", + "first_name": "first_name6", + "last_name": "last_name4" + } + }, + "carrier": "carrier0", + "shipping_note": "shipping_note4", + "shipping_type": "shipping_type8", + "tracking_number": "tracking_number6", + "tracking_url": "tracking_url2", + "placed_at": "placed_at2", + "in_progress_at": "in_progress_at6", + "packaged_at": "packaged_at2", + "expected_shipped_at": "expected_shipped_at2", + "shipped_at": "shipped_at6", + "canceled_at": "canceled_at4", + "cancel_reason": "cancel_reason6", + "failed_at": "failed_at2", + "failure_reason": "failure_reason2" + }, + "delivery_details": { + "recipient": { + "customer_id": "customer_id6", + "display_name": "display_name8", + "email_address": "email_address6", + "phone_number": "phone_number6", + "address": { + "address_line_1": "address_line_14", + "address_line_2": "address_line_24", + "address_line_3": "address_line_30", + "locality": "locality4", + "sublocality": "sublocality4", + "sublocality_2": "sublocality_22", + "sublocality_3": "sublocality_34", + "administrative_district_level_1": "administrative_district_level_18", + "administrative_district_level_2": "administrative_district_level_20", + "administrative_district_level_3": "administrative_district_level_32", + "postal_code": "postal_code6", + "country": "AO", + "first_name": "first_name4", + "last_name": "last_name2" + } + }, + "schedule_type": "SCHEDULED", + "placed_at": "placed_at4", + "deliver_at": "deliver_at4", + "prep_time_duration": "prep_time_duration8", + "delivery_window_duration": "delivery_window_duration0", + "note": "note2", + "completed_at": "completed_at8", + "in_progress_at": "in_progress_at8", + "rejected_at": "rejected_at8", + "ready_at": "ready_at6", + "delivered_at": "delivered_at4", + "canceled_at": "canceled_at2", + "cancel_reason": "cancel_reason2", + "courier_pickup_at": "courier_pickup_at2", + "courier_pickup_window_duration": "courier_pickup_window_duration0", + "is_no_contact_delivery": false, + "dropoff_notes": "dropoff_notes0", + "courier_provider_name": "courier_provider_name6", + "courier_support_phone_number": "courier_support_phone_number2", + "square_delivery_id": "square_delivery_id6", + "external_delivery_id": "external_delivery_id0", + "managed_delivery": false + } } ``` diff --git a/doc/models/order-line-item-applied-discount.md b/doc/models/order-line-item-applied-discount.md index 94a58cb5..58d5f94d 100644 --- a/doc/models/order-line-item-applied-discount.md +++ b/doc/models/order-line-item-applied-discount.md @@ -24,9 +24,12 @@ line items. ```json { - "uid": null, + "uid": "uid0", "discount_uid": "discount_uid4", - "applied_money": null + "applied_money": { + "amount": 196, + "currency": "PLN" + } } ``` diff --git a/doc/models/order-line-item-applied-service-charge.md b/doc/models/order-line-item-applied-service-charge.md new file mode 100644 index 00000000..bd80f7e8 --- /dev/null +++ b/doc/models/order-line-item-applied-service-charge.md @@ -0,0 +1,28 @@ + +# Order Line Item Applied Service Charge + +## Structure + +`OrderLineItemAppliedServiceCharge` + +## Fields + +| Name | Type | Tags | Description | +| --- | --- | --- | --- | +| `uid` | `string \| undefined` | Optional | A unique ID that identifies the applied service charge only within this order.
**Constraints**: *Maximum Length*: `60` | +| `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` | +| `appliedMoney` | [`Money \| undefined`](../../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. | + +## Example (as JSON) + +```json +{ + "uid": "uid0", + "service_charge_uid": "service_charge_uid0", + "applied_money": { + "amount": 196, + "currency": "PLN" + } +} +``` + diff --git a/doc/models/order-line-item-applied-tax.md b/doc/models/order-line-item-applied-tax.md index c3d8e61a..033d768e 100644 --- a/doc/models/order-line-item-applied-tax.md +++ b/doc/models/order-line-item-applied-tax.md @@ -24,9 +24,12 @@ set of participating line items. ```json { - "uid": null, + "uid": "uid0", "tax_uid": "tax_uid4", - "applied_money": null + "applied_money": { + "amount": 196, + "currency": "PLN" + } } ``` diff --git a/doc/models/order-line-item-discount.md b/doc/models/order-line-item-discount.md index 4d44d986..6c6b1016 100644 --- a/doc/models/order-line-item-discount.md +++ b/doc/models/order-line-item-discount.md @@ -17,7 +17,7 @@ amount contributed by the item to the order subtotal. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `uid` | `string \| undefined` | Optional | A unique ID that identifies the discount only within this order.
**Constraints**: *Maximum Length*: `60` | -| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID referencing [CatalogDiscount](../../doc/models/catalog-discount.md).
**Constraints**: *Maximum Length*: `192` | +| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).
**Constraints**: *Maximum Length*: `192` | | `catalogVersion` | `bigint \| undefined` | Optional | The version of the catalog object that this discount references. | | `name` | `string \| undefined` | Optional | The discount's name.
**Constraints**: *Maximum Length*: `255` | | `type` | [`string \| undefined`](../../doc/models/order-line-item-discount-type.md) | Optional | Indicates how the discount is applied to the associated line item or order. | @@ -27,24 +27,36 @@ amount contributed by the item to the order subtotal. | `metadata` | `Record \| undefined` | 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). | | `scope` | [`string \| undefined`](../../doc/models/order-line-item-discount-scope.md) | Optional | Indicates whether this is a line-item or order-level discount. | | `rewardIds` | `string[] \| undefined` | 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. | -| `pricingRuleId` | `string \| undefined` | Optional | The object ID of a [pricing rule](../../doc/models/catalog-pricing-rule.md) 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. | +| `pricingRuleId` | `string \| undefined` | 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. | ## Example (as JSON) ```json { - "uid": null, - "catalog_object_id": null, - "catalog_version": null, - "name": null, - "type": null, - "percentage": null, - "amount_money": null, - "applied_money": null, - "metadata": null, - "scope": null, - "reward_ids": null, - "pricing_rule_id": null + "uid": "uid0", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 126, + "name": "name0", + "type": "UNKNOWN_DISCOUNT", + "percentage": "percentage8", + "amount_money": { + "amount": 186, + "currency": "NGN" + }, + "applied_money": { + "amount": 196, + "currency": "PLN" + }, + "metadata": { + "key0": "metadata3", + "key1": "metadata4", + "key2": "metadata5" + }, + "scope": "ORDER", + "reward_ids": [ + "reward_ids7" + ], + "pricing_rule_id": "pricing_rule_id8" } ``` diff --git a/doc/models/order-line-item-modifier.md b/doc/models/order-line-item-modifier.md index 437ec552..7294be5c 100644 --- a/doc/models/order-line-item-modifier.md +++ b/doc/models/order-line-item-modifier.md @@ -12,7 +12,7 @@ A [CatalogModifier](../../doc/models/catalog-modifier.md). | Name | Type | Tags | Description | | --- | --- | --- | --- | | `uid` | `string \| undefined` | Optional | A unique ID that identifies the modifier only within this order.
**Constraints**: *Maximum Length*: `60` | -| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID referencing [CatalogModifier](../../doc/models/catalog-modifier.md).
**Constraints**: *Maximum Length*: `192` | +| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).
**Constraints**: *Maximum Length*: `192` | | `catalogVersion` | `bigint \| undefined` | Optional | The version of the catalog object that this modifier references. | | `name` | `string \| undefined` | Optional | The name of the item modifier.
**Constraints**: *Maximum Length*: `255` | | `quantity` | `string \| undefined` | 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. | @@ -24,14 +24,24 @@ A [CatalogModifier](../../doc/models/catalog-modifier.md). ```json { - "uid": null, - "catalog_object_id": null, - "catalog_version": null, - "name": null, - "quantity": null, - "base_price_money": null, - "total_price_money": null, - "metadata": null + "uid": "uid0", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 126, + "name": "name0", + "quantity": "quantity6", + "base_price_money": { + "amount": 114, + "currency": "ALL" + }, + "total_price_money": { + "amount": 52, + "currency": "MYR" + }, + "metadata": { + "key0": "metadata3", + "key1": "metadata4", + "key2": "metadata5" + } } ``` diff --git a/doc/models/order-line-item-pricing-blocklists-blocked-discount.md b/doc/models/order-line-item-pricing-blocklists-blocked-discount.md index 0fd2917e..c663c6ce 100644 --- a/doc/models/order-line-item-pricing-blocklists-blocked-discount.md +++ b/doc/models/order-line-item-pricing-blocklists-blocked-discount.md @@ -20,9 +20,9 @@ identified by either `discount_uid` or `discount_catalog_object_id`, but not bot ```json { - "uid": null, - "discount_uid": null, - "discount_catalog_object_id": null + "uid": "uid0", + "discount_uid": "discount_uid4", + "discount_catalog_object_id": "discount_catalog_object_id2" } ``` diff --git a/doc/models/order-line-item-pricing-blocklists-blocked-tax.md b/doc/models/order-line-item-pricing-blocklists-blocked-tax.md index 5cca80fc..de81bd4f 100644 --- a/doc/models/order-line-item-pricing-blocklists-blocked-tax.md +++ b/doc/models/order-line-item-pricing-blocklists-blocked-tax.md @@ -20,9 +20,9 @@ identified by either `tax_uid` or `tax_catalog_object_id`, but not both. ```json { - "uid": null, - "tax_uid": null, - "tax_catalog_object_id": null + "uid": "uid0", + "tax_uid": "tax_uid4", + "tax_catalog_object_id": "tax_catalog_object_id4" } ``` diff --git a/doc/models/order-line-item-pricing-blocklists.md b/doc/models/order-line-item-pricing-blocklists.md index 960f0043..6cff0955 100644 --- a/doc/models/order-line-item-pricing-blocklists.md +++ b/doc/models/order-line-item-pricing-blocklists.md @@ -20,8 +20,20 @@ application to a line item. For more information, see ```json { - "blocked_discounts": null, - "blocked_taxes": null + "blocked_discounts": [ + { + "uid": "uid5", + "discount_uid": "discount_uid1", + "discount_catalog_object_id": "discount_catalog_object_id7" + } + ], + "blocked_taxes": [ + { + "uid": "uid7", + "tax_uid": "tax_uid3", + "tax_catalog_object_id": "tax_catalog_object_id1" + } + ] } ``` diff --git a/doc/models/order-line-item-tax.md b/doc/models/order-line-item-tax.md index 183a6cf7..97186c1d 100644 --- a/doc/models/order-line-item-tax.md +++ b/doc/models/order-line-item-tax.md @@ -16,7 +16,7 @@ contributes to the order subtotal. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `uid` | `string \| undefined` | Optional | A unique ID that identifies the tax only within this order.
**Constraints**: *Maximum Length*: `60` | -| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID referencing [CatalogTax](../../doc/models/catalog-tax.md).
**Constraints**: *Maximum Length*: `192` | +| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID referencing [CatalogTax](entity:CatalogTax).
**Constraints**: *Maximum Length*: `192` | | `catalogVersion` | `bigint \| undefined` | Optional | The version of the catalog object that this tax references. | | `name` | `string \| undefined` | Optional | The tax's name.
**Constraints**: *Maximum Length*: `255` | | `type` | [`string \| undefined`](../../doc/models/order-line-item-tax-type.md) | Optional | Indicates how the tax is applied to the associated line item or order. | @@ -30,16 +30,23 @@ contributes to the order subtotal. ```json { - "uid": null, - "catalog_object_id": null, - "catalog_version": null, - "name": null, - "type": null, - "percentage": null, - "metadata": null, - "applied_money": null, - "scope": null, - "auto_applied": null + "uid": "uid0", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 126, + "name": "name0", + "type": "INCLUSIVE", + "percentage": "percentage8", + "metadata": { + "key0": "metadata3", + "key1": "metadata4", + "key2": "metadata5" + }, + "applied_money": { + "amount": 196, + "currency": "PLN" + }, + "scope": "ORDER", + "auto_applied": false } ``` diff --git a/doc/models/order-line-item.md b/doc/models/order-line-item.md index f8fe757d..877adc4b 100644 --- a/doc/models/order-line-item.md +++ b/doc/models/order-line-item.md @@ -17,14 +17,15 @@ product to purchase, with its own quantity and price details. | `quantity` | `string` | Required | The quantity purchased, formatted as a decimal number.
For example, `"3"`.

Line items with a quantity of `"0"` are automatically removed
when paying for or otherwise completing the order.

Line items with a `quantity_unit` can have non-integer quantities.
For example, `"1.70000"`.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `12` | | `quantityUnit` | [`OrderQuantityUnit \| undefined`](../../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. | | `note` | `string \| undefined` | Optional | The note of the line item.
**Constraints**: *Maximum Length*: `2000` | -| `catalogObjectId` | `string \| undefined` | Optional | The [CatalogItemVariation](../../doc/models/catalog-item-variation.md) ID applied to this line item.
**Constraints**: *Maximum Length*: `192` | +| `catalogObjectId` | `string \| undefined` | Optional | The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this line item.
**Constraints**: *Maximum Length*: `192` | | `catalogVersion` | `bigint \| undefined` | Optional | The version of the catalog object that this line item references. | | `variationName` | `string \| undefined` | Optional | The name of the variation applied to this line item.
**Constraints**: *Maximum Length*: `400` | | `itemType` | [`string \| undefined`](../../doc/models/order-line-item-item-type.md) | Optional | Represents the line item type. | | `metadata` | `Record \| undefined` | 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). | -| `modifiers` | [`OrderLineItemModifier[] \| undefined`](../../doc/models/order-line-item-modifier.md) | Optional | The [CatalogModifier](../../doc/models/catalog-modifier.md)s applied to this line item. | +| `modifiers` | [`OrderLineItemModifier[] \| undefined`](../../doc/models/order-line-item-modifier.md) | Optional | The [CatalogModifier](entity:CatalogModifier)s applied to this line item. | | `appliedTaxes` | [`OrderLineItemAppliedTax[] \| undefined`](../../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. | | `appliedDiscounts` | [`OrderLineItemAppliedDiscount[] \| undefined`](../../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. | +| `appliedServiceCharges` | [`OrderLineItemAppliedServiceCharge[] \| undefined`](../../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. | | `basePriceMoney` | [`Money \| undefined`](../../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. | | `variationTotalPriceMoney` | [`Money \| undefined`](../../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. | | `grossSalesMoney` | [`Money \| undefined`](../../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. | @@ -32,31 +33,198 @@ product to purchase, with its own quantity and price details. | `totalDiscountMoney` | [`Money \| undefined`](../../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. | | `totalMoney` | [`Money \| undefined`](../../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. | | `pricingBlocklists` | [`OrderLineItemPricingBlocklists \| undefined`](../../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). | +| `totalServiceChargeMoney` | [`Money \| undefined`](../../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. | ## Example (as JSON) ```json { - "uid": null, - "name": null, + "uid": "uid0", + "name": "name0", "quantity": "quantity6", - "quantity_unit": null, - "note": null, - "catalog_object_id": null, - "catalog_version": null, - "variation_name": null, - "item_type": null, - "metadata": null, - "modifiers": null, - "applied_taxes": null, - "applied_discounts": null, - "base_price_money": null, - "variation_total_price_money": null, - "gross_sales_money": null, - "total_tax_money": null, - "total_discount_money": null, - "total_money": null, - "pricing_blocklists": null + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name8", + "abbreviation": "abbreviation0" + }, + "area_unit": "IMPERIAL_SQUARE_FOOT", + "length_unit": "METRIC_METER", + "volume_unit": "GENERIC_CUP", + "weight_unit": "IMPERIAL_WEIGHT_OUNCE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_SECOND", + "type": "TYPE_CUSTOM" + }, + "precision": 54, + "catalog_object_id": "catalog_object_id0", + "catalog_version": 12 + }, + "note": "note4", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 126, + "variation_name": "variation_name0", + "item_type": "ITEM", + "metadata": { + "key0": "metadata3", + "key1": "metadata4", + "key2": "metadata5" + }, + "modifiers": [ + { + "uid": "uid1", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 65, + "name": "name1", + "quantity": "quantity7", + "base_price_money": { + "amount": 175, + "currency": "XDR" + }, + "total_price_money": { + "amount": 173, + "currency": "JOD" + }, + "metadata": { + "key0": "metadata2", + "key1": "metadata3", + "key2": "metadata4" + } + }, + { + "uid": "uid2", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 64, + "name": "name2", + "quantity": "quantity8", + "base_price_money": { + "amount": 176, + "currency": "XOF" + }, + "total_price_money": { + "amount": 174, + "currency": "JPY" + }, + "metadata": { + "key0": "metadata1", + "key1": "metadata2" + } + } + ], + "applied_taxes": [ + { + "uid": "uid0", + "tax_uid": "tax_uid4", + "applied_money": { + "amount": 190, + "currency": "XAF" + } + }, + { + "uid": "uid1", + "tax_uid": "tax_uid3", + "applied_money": { + "amount": 189, + "currency": "WST" + } + } + ], + "applied_discounts": [ + { + "uid": "uid4", + "discount_uid": "discount_uid0", + "applied_money": { + "amount": 42, + "currency": "BHD" + } + }, + { + "uid": "uid5", + "discount_uid": "discount_uid9", + "applied_money": { + "amount": 41, + "currency": "BGN" + } + }, + { + "uid": "uid6", + "discount_uid": "discount_uid8", + "applied_money": { + "amount": 40, + "currency": "BDT" + } + } + ], + "applied_service_charges": [ + { + "uid": "uid1", + "service_charge_uid": "service_charge_uid1", + "applied_money": { + "amount": 141, + "currency": "KPW" + } + }, + { + "uid": "uid2", + "service_charge_uid": "service_charge_uid2", + "applied_money": { + "amount": 140, + "currency": "KMF" + } + }, + { + "uid": "uid3", + "service_charge_uid": "service_charge_uid3", + "applied_money": { + "amount": 139, + "currency": "KHR" + } + } + ], + "base_price_money": { + "amount": 114, + "currency": "ALL" + }, + "variation_total_price_money": { + "amount": 98, + "currency": "SGD" + }, + "gross_sales_money": { + "amount": 198, + "currency": "LTL" + }, + "total_tax_money": { + "amount": 58, + "currency": "SDG" + }, + "total_discount_money": { + "amount": 132, + "currency": "TRY" + }, + "total_money": { + "amount": 250, + "currency": "UNKNOWN_CURRENCY" + }, + "pricing_blocklists": { + "blocked_discounts": [ + { + "uid": "uid3", + "discount_uid": "discount_uid9", + "discount_catalog_object_id": "discount_catalog_object_id5" + } + ], + "blocked_taxes": [ + { + "uid": "uid1", + "tax_uid": "tax_uid3", + "tax_catalog_object_id": "tax_catalog_object_id5" + } + ] + }, + "total_service_charge_money": { + "amount": 62, + "currency": "NZD" + } } ``` diff --git a/doc/models/order-money-amounts.md b/doc/models/order-money-amounts.md index 77eb8e49..c91459ec 100644 --- a/doc/models/order-money-amounts.md +++ b/doc/models/order-money-amounts.md @@ -21,11 +21,26 @@ A collection of various money amounts. ```json { - "total_money": null, - "tax_money": null, - "discount_money": null, - "tip_money": null, - "service_charge_money": null + "total_money": { + "amount": 250, + "currency": "UNKNOWN_CURRENCY" + }, + "tax_money": { + "amount": 58, + "currency": "KZT" + }, + "discount_money": { + "amount": 92, + "currency": "XBD" + }, + "tip_money": { + "amount": 190, + "currency": "CHE" + }, + "service_charge_money": { + "amount": 160, + "currency": "BZD" + } } ``` diff --git a/doc/models/order-pricing-options.md b/doc/models/order-pricing-options.md index 57b5430f..2b298e75 100644 --- a/doc/models/order-pricing-options.md +++ b/doc/models/order-pricing-options.md @@ -20,8 +20,8 @@ They can be used, for example, to apply automatic price adjustments that are bas ```json { - "auto_apply_discounts": null, - "auto_apply_taxes": null + "auto_apply_discounts": false, + "auto_apply_taxes": false } ``` diff --git a/doc/models/order-quantity-unit.md b/doc/models/order-quantity-unit.md index 3b849bef..f5f6efc4 100644 --- a/doc/models/order-quantity-unit.md +++ b/doc/models/order-quantity-unit.md @@ -14,17 +14,29 @@ specifies the number of digits after the decimal point for decimal quantities. | --- | --- | --- | --- | | `measurementUnit` | [`MeasurementUnit \| undefined`](../../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`. | | `precision` | `number \| undefined` | 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. | -| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID referencing the
[CatalogMeasurementUnit](../../doc/models/catalog-measurement-unit.md).

This field is set when this is a catalog-backed measurement unit. | +| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID referencing the
[CatalogMeasurementUnit](entity:CatalogMeasurementUnit).

This field is set when this is a catalog-backed measurement unit. | | `catalogVersion` | `bigint \| undefined` | Optional | The version of the catalog object that this measurement unit references.

This field is set when this is a catalog-backed measurement unit. | ## Example (as JSON) ```json { - "measurement_unit": null, - "precision": null, - "catalog_object_id": null, - "catalog_version": null + "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", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MINUTE", + "type": "TYPE_CUSTOM" + }, + "precision": 196, + "catalog_object_id": "catalog_object_id6", + "catalog_version": 126 } ``` diff --git a/doc/models/order-return-discount.md b/doc/models/order-return-discount.md index 4da59f24..8714a963 100644 --- a/doc/models/order-return-discount.md +++ b/doc/models/order-return-discount.md @@ -18,7 +18,7 @@ order subtotal. | --- | --- | --- | --- | | `uid` | `string \| undefined` | Optional | A unique ID that identifies the returned discount only within this order.
**Constraints**: *Maximum Length*: `60` | | `sourceDiscountUid` | `string \| undefined` | Optional | The discount `uid` from the order that contains the original application of this discount.
**Constraints**: *Maximum Length*: `60` | -| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID referencing [CatalogDiscount](../../doc/models/catalog-discount.md).
**Constraints**: *Maximum Length*: `192` | +| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount).
**Constraints**: *Maximum Length*: `192` | | `catalogVersion` | `bigint \| undefined` | Optional | The version of the catalog object that this discount references. | | `name` | `string \| undefined` | Optional | The discount's name.
**Constraints**: *Maximum Length*: `255` | | `type` | [`string \| undefined`](../../doc/models/order-line-item-discount-type.md) | Optional | Indicates how the discount is applied to the associated line item or order. | @@ -31,16 +31,22 @@ order subtotal. ```json { - "uid": null, - "source_discount_uid": null, - "catalog_object_id": null, - "catalog_version": null, - "name": null, - "type": null, - "percentage": null, - "amount_money": null, - "applied_money": null, - "scope": null + "uid": "uid0", + "source_discount_uid": "source_discount_uid0", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 126, + "name": "name0", + "type": "UNKNOWN_DISCOUNT", + "percentage": "percentage8", + "amount_money": { + "amount": 186, + "currency": "NGN" + }, + "applied_money": { + "amount": 196, + "currency": "PLN" + }, + "scope": "ORDER" } ``` diff --git a/doc/models/order-return-line-item-modifier.md b/doc/models/order-return-line-item-modifier.md index 0def2714..a03456a4 100644 --- a/doc/models/order-return-line-item-modifier.md +++ b/doc/models/order-return-line-item-modifier.md @@ -13,23 +13,31 @@ A line item modifier being returned. | --- | --- | --- | --- | | `uid` | `string \| undefined` | Optional | A unique ID that identifies the return modifier only within this order.
**Constraints**: *Maximum Length*: `60` | | `sourceModifierUid` | `string \| undefined` | Optional | The modifier `uid` from the order's line item that contains the
original sale of this line item modifier.
**Constraints**: *Maximum Length*: `60` | -| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID referencing [CatalogModifier](../../doc/models/catalog-modifier.md).
**Constraints**: *Maximum Length*: `192` | +| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID referencing [CatalogModifier](entity:CatalogModifier).
**Constraints**: *Maximum Length*: `192` | | `catalogVersion` | `bigint \| undefined` | Optional | The version of the catalog object that this line item modifier references. | | `name` | `string \| undefined` | Optional | The name of the item modifier.
**Constraints**: *Maximum Length*: `255` | | `basePriceMoney` | [`Money \| undefined`](../../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. | | `totalPriceMoney` | [`Money \| undefined`](../../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. | +| `quantity` | `string \| undefined` | 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. | ## Example (as JSON) ```json { - "uid": null, - "source_modifier_uid": null, - "catalog_object_id": null, - "catalog_version": null, - "name": null, - "base_price_money": null, - "total_price_money": null + "uid": "uid0", + "source_modifier_uid": "source_modifier_uid6", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 126, + "name": "name0", + "base_price_money": { + "amount": 114, + "currency": "ALL" + }, + "total_price_money": { + "amount": 52, + "currency": "MYR" + }, + "quantity": "quantity6" } ``` diff --git a/doc/models/order-return-line-item.md b/doc/models/order-return-line-item.md index a373d175..45ed61d9 100644 --- a/doc/models/order-return-line-item.md +++ b/doc/models/order-return-line-item.md @@ -17,11 +17,11 @@ The line item being returned in an order. | `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` | | `quantityUnit` | [`OrderQuantityUnit \| undefined`](../../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. | | `note` | `string \| undefined` | Optional | The note of the return line item.
**Constraints**: *Maximum Length*: `2000` | -| `catalogObjectId` | `string \| undefined` | Optional | The [CatalogItemVariation](../../doc/models/catalog-item-variation.md) ID applied to this return line item.
**Constraints**: *Maximum Length*: `192` | +| `catalogObjectId` | `string \| undefined` | Optional | The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this return line item.
**Constraints**: *Maximum Length*: `192` | | `catalogVersion` | `bigint \| undefined` | Optional | The version of the catalog object that this line item references. | | `variationName` | `string \| undefined` | Optional | The name of the variation applied to this return line item.
**Constraints**: *Maximum Length*: `400` | | `itemType` | [`string \| undefined`](../../doc/models/order-line-item-item-type.md) | Optional | Represents the line item type. | -| `returnModifiers` | [`OrderReturnLineItemModifier[] \| undefined`](../../doc/models/order-return-line-item-modifier.md) | Optional | The [CatalogModifier](../../doc/models/catalog-modifier.md)s applied to this line item. | +| `returnModifiers` | [`OrderReturnLineItemModifier[] \| undefined`](../../doc/models/order-return-line-item-modifier.md) | Optional | The [CatalogModifier](entity:CatalogModifier)s applied to this line item. | | `appliedTaxes` | [`OrderLineItemAppliedTax[] \| undefined`](../../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. | | `appliedDiscounts` | [`OrderLineItemAppliedDiscount[] \| undefined`](../../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. | | `basePriceMoney` | [`Money \| undefined`](../../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. | @@ -30,30 +30,156 @@ The line item being returned in an order. | `totalTaxMoney` | [`Money \| undefined`](../../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. | | `totalDiscountMoney` | [`Money \| undefined`](../../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. | | `totalMoney` | [`Money \| undefined`](../../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. | +| `appliedServiceCharges` | [`OrderLineItemAppliedServiceCharge[] \| undefined`](../../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. | +| `totalServiceChargeMoney` | [`Money \| undefined`](../../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. | ## Example (as JSON) ```json { - "uid": null, - "source_line_item_uid": null, - "name": null, + "uid": "uid0", + "source_line_item_uid": "source_line_item_uid2", + "name": "name0", "quantity": "quantity6", - "quantity_unit": null, - "note": null, - "catalog_object_id": null, - "catalog_version": null, - "variation_name": null, - "item_type": null, - "return_modifiers": null, - "applied_taxes": null, - "applied_discounts": null, - "base_price_money": null, - "variation_total_price_money": null, - "gross_return_money": null, - "total_tax_money": null, - "total_discount_money": null, - "total_money": null + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name8", + "abbreviation": "abbreviation0" + }, + "area_unit": "IMPERIAL_SQUARE_FOOT", + "length_unit": "METRIC_METER", + "volume_unit": "GENERIC_CUP", + "weight_unit": "IMPERIAL_WEIGHT_OUNCE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_SECOND", + "type": "TYPE_CUSTOM" + }, + "precision": 54, + "catalog_object_id": "catalog_object_id0", + "catalog_version": 12 + }, + "note": "note4", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 126, + "variation_name": "variation_name0", + "item_type": "ITEM", + "return_modifiers": [ + { + "uid": "uid1", + "source_modifier_uid": "source_modifier_uid5", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 73, + "name": "name1", + "base_price_money": { + "amount": 167, + "currency": "MWK" + }, + "total_price_money": { + "amount": 91, + "currency": "ZAR" + }, + "quantity": "quantity7" + } + ], + "applied_taxes": [ + { + "uid": "uid0", + "tax_uid": "tax_uid4", + "applied_money": { + "amount": 190, + "currency": "XAF" + } + }, + { + "uid": "uid1", + "tax_uid": "tax_uid3", + "applied_money": { + "amount": 189, + "currency": "WST" + } + } + ], + "applied_discounts": [ + { + "uid": "uid4", + "discount_uid": "discount_uid0", + "applied_money": { + "amount": 42, + "currency": "BHD" + } + }, + { + "uid": "uid5", + "discount_uid": "discount_uid9", + "applied_money": { + "amount": 41, + "currency": "BGN" + } + }, + { + "uid": "uid6", + "discount_uid": "discount_uid8", + "applied_money": { + "amount": 40, + "currency": "BDT" + } + } + ], + "base_price_money": { + "amount": 114, + "currency": "ALL" + }, + "variation_total_price_money": { + "amount": 98, + "currency": "SGD" + }, + "gross_return_money": { + "amount": 218, + "currency": "KYD" + }, + "total_tax_money": { + "amount": 58, + "currency": "SDG" + }, + "total_discount_money": { + "amount": 132, + "currency": "TRY" + }, + "total_money": { + "amount": 250, + "currency": "UNKNOWN_CURRENCY" + }, + "applied_service_charges": [ + { + "uid": "uid1", + "service_charge_uid": "service_charge_uid1", + "applied_money": { + "amount": 141, + "currency": "KPW" + } + }, + { + "uid": "uid2", + "service_charge_uid": "service_charge_uid2", + "applied_money": { + "amount": 140, + "currency": "KMF" + } + }, + { + "uid": "uid3", + "service_charge_uid": "service_charge_uid3", + "applied_money": { + "amount": 139, + "currency": "KHR" + } + } + ], + "total_service_charge_money": { + "amount": 62, + "currency": "NZD" + } } ``` diff --git a/doc/models/order-return-service-charge.md b/doc/models/order-return-service-charge.md index ded17f4e..c3c2d8ee 100644 --- a/doc/models/order-return-service-charge.md +++ b/doc/models/order-return-service-charge.md @@ -14,7 +14,7 @@ Represents the service charge applied to the original order. | `uid` | `string \| undefined` | Optional | A unique ID that identifies the return service charge only within this order.
**Constraints**: *Maximum Length*: `60` | | `sourceServiceChargeUid` | `string \| undefined` | 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` | | `name` | `string \| undefined` | Optional | The name of the service charge.
**Constraints**: *Maximum Length*: `255` | -| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID of the associated [OrderServiceCharge](../../doc/models/order-service-charge.md).
**Constraints**: *Maximum Length*: `192` | +| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID of the associated [OrderServiceCharge](entity:OrderServiceCharge).
**Constraints**: *Maximum Length*: `192` | | `catalogVersion` | `bigint \| undefined` | Optional | The version of the catalog object that this service charge references. | | `percentage` | `string \| undefined` | 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` | | `amountMoney` | [`Money \| undefined`](../../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. | @@ -24,24 +24,57 @@ Represents the service charge applied to the original order. | `calculationPhase` | [`string \| undefined`](../../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) | | `taxable` | `boolean \| undefined` | Optional | Indicates whether the surcharge can be taxed. Service charges
calculated in the `TOTAL_PHASE` cannot be marked as taxable. | | `appliedTaxes` | [`OrderLineItemAppliedTax[] \| undefined`](../../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. | +| `treatmentType` | [`string \| undefined`](../../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. | +| `scope` | [`string \| undefined`](../../doc/models/order-service-charge-scope.md) | Optional | Indicates whether this is a line-item or order-level apportioned
service charge. | ## Example (as JSON) ```json { - "uid": null, - "source_service_charge_uid": null, - "name": null, - "catalog_object_id": null, - "catalog_version": null, - "percentage": null, - "amount_money": null, - "applied_money": null, - "total_money": null, - "total_tax_money": null, - "calculation_phase": null, - "taxable": null, - "applied_taxes": null + "uid": "uid0", + "source_service_charge_uid": "source_service_charge_uid6", + "name": "name0", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 126, + "percentage": "percentage8", + "amount_money": { + "amount": 186, + "currency": "NGN" + }, + "applied_money": { + "amount": 196, + "currency": "PLN" + }, + "total_money": { + "amount": 250, + "currency": "UNKNOWN_CURRENCY" + }, + "total_tax_money": { + "amount": 58, + "currency": "SDG" + }, + "calculation_phase": "APPORTIONED_PERCENTAGE_PHASE", + "taxable": false, + "applied_taxes": [ + { + "uid": "uid0", + "tax_uid": "tax_uid4", + "applied_money": { + "amount": 190, + "currency": "XAF" + } + }, + { + "uid": "uid1", + "tax_uid": "tax_uid3", + "applied_money": { + "amount": 189, + "currency": "WST" + } + } + ], + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "ORDER" } ``` diff --git a/doc/models/order-return-tax.md b/doc/models/order-return-tax.md index 3dd81b19..4e5045f3 100644 --- a/doc/models/order-return-tax.md +++ b/doc/models/order-return-tax.md @@ -17,7 +17,7 @@ order subtotal. | --- | --- | --- | --- | | `uid` | `string \| undefined` | Optional | A unique ID that identifies the returned tax only within this order.
**Constraints**: *Maximum Length*: `60` | | `sourceTaxUid` | `string \| undefined` | Optional | The tax `uid` from the order that contains the original tax charge.
**Constraints**: *Maximum Length*: `60` | -| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID referencing [CatalogTax](../../doc/models/catalog-tax.md).
**Constraints**: *Maximum Length*: `192` | +| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID referencing [CatalogTax](entity:CatalogTax).
**Constraints**: *Maximum Length*: `192` | | `catalogVersion` | `bigint \| undefined` | Optional | The version of the catalog object that this tax references. | | `name` | `string \| undefined` | Optional | The tax's name.
**Constraints**: *Maximum Length*: `255` | | `type` | [`string \| undefined`](../../doc/models/order-line-item-tax-type.md) | Optional | Indicates how the tax is applied to the associated line item or order. | @@ -29,15 +29,18 @@ order subtotal. ```json { - "uid": null, - "source_tax_uid": null, - "catalog_object_id": null, - "catalog_version": null, - "name": null, - "type": null, - "percentage": null, - "applied_money": null, - "scope": null + "uid": "uid0", + "source_tax_uid": "source_tax_uid2", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 126, + "name": "name0", + "type": "INCLUSIVE", + "percentage": "percentage8", + "applied_money": { + "amount": 196, + "currency": "PLN" + }, + "scope": "ORDER" } ``` diff --git a/doc/models/order-return.md b/doc/models/order-return.md index 221a49f1..9548b735 100644 --- a/doc/models/order-return.md +++ b/doc/models/order-return.md @@ -24,14 +24,468 @@ The set of line items, service charges, taxes, discounts, tips, and other items ```json { - "uid": null, - "source_order_id": null, - "return_line_items": null, - "return_service_charges": null, - "return_taxes": null, - "return_discounts": null, - "rounding_adjustment": null, - "return_amounts": null + "uid": "uid0", + "source_order_id": "source_order_id2", + "return_line_items": [ + { + "uid": "uid5", + "source_line_item_uid": "source_line_item_uid7", + "name": "name5", + "quantity": "quantity1", + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name3", + "abbreviation": "abbreviation5" + }, + "area_unit": "METRIC_SQUARE_CENTIMETER", + "length_unit": "IMPERIAL_MILE", + "volume_unit": "IMPERIAL_CUBIC_FOOT", + "weight_unit": "METRIC_KILOGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_SECOND", + "type": "TYPE_GENERIC" + }, + "precision": 73, + "catalog_object_id": "catalog_object_id5", + "catalog_version": 249 + }, + "note": "note9", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 107, + "variation_name": "variation_name5", + "item_type": "CUSTOM_AMOUNT", + "return_modifiers": [ + { + "uid": "uid6", + "source_modifier_uid": "source_modifier_uid0", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 92, + "name": "name6", + "base_price_money": { + "amount": 148, + "currency": "STD" + }, + "total_price_money": { + "amount": 238, + "currency": "CHE" + }, + "quantity": "quantity2" + }, + { + "uid": "uid7", + "source_modifier_uid": "source_modifier_uid9", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 91, + "name": "name7", + "base_price_money": { + "amount": 149, + "currency": "SVC" + }, + "total_price_money": { + "amount": 239, + "currency": "CHF" + }, + "quantity": "quantity3" + }, + { + "uid": "uid8", + "source_modifier_uid": "source_modifier_uid8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 90, + "name": "name8", + "base_price_money": { + "amount": 150, + "currency": "SYP" + }, + "total_price_money": { + "amount": 240, + "currency": "CHW" + }, + "quantity": "quantity4" + } + ], + "applied_taxes": [ + { + "uid": "uid5", + "tax_uid": "tax_uid9", + "applied_money": {} + }, + { + "uid": "uid6", + "tax_uid": "tax_uid8", + "applied_money": {} + }, + { + "uid": "uid7", + "tax_uid": "tax_uid7", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid9", + "discount_uid": "discount_uid5", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + { + "uid": "uid6", + "service_charge_uid": "service_charge_uid6", + "applied_money": {} + }, + { + "uid": "uid7", + "service_charge_uid": "service_charge_uid7", + "applied_money": {} + } + ], + "total_service_charge_money": {} + }, + { + "uid": "uid6", + "source_line_item_uid": "source_line_item_uid6", + "name": "name6", + "quantity": "quantity2", + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name4", + "abbreviation": "abbreviation6" + }, + "area_unit": "METRIC_SQUARE_METER", + "length_unit": "IMPERIAL_YARD", + "volume_unit": "IMPERIAL_CUBIC_YARD", + "weight_unit": "METRIC_GRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MILLISECOND", + "type": "TYPE_WEIGHT" + }, + "precision": 74, + "catalog_object_id": "catalog_object_id4", + "catalog_version": 248 + }, + "note": "note8", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 106, + "variation_name": "variation_name6", + "item_type": "GIFT_CARD", + "return_modifiers": [ + { + "uid": "uid5", + "source_modifier_uid": "source_modifier_uid1", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 93, + "name": "name5", + "base_price_money": { + "amount": 147, + "currency": "SSP" + }, + "total_price_money": { + "amount": 237, + "currency": "CDF" + }, + "quantity": "quantity1" + }, + { + "uid": "uid6", + "source_modifier_uid": "source_modifier_uid0", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 92, + "name": "name6", + "base_price_money": { + "amount": 148, + "currency": "STD" + }, + "total_price_money": { + "amount": 238, + "currency": "CHE" + }, + "quantity": "quantity2" + } + ], + "applied_taxes": [ + { + "uid": "uid6", + "tax_uid": "tax_uid8", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid0", + "discount_uid": "discount_uid4", + "applied_money": {} + }, + { + "uid": "uid1", + "discount_uid": "discount_uid3", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + { + "uid": "uid5", + "service_charge_uid": "service_charge_uid5", + "applied_money": {} + } + ], + "total_service_charge_money": {} + }, + { + "uid": "uid7", + "source_line_item_uid": "source_line_item_uid5", + "name": "name7", + "quantity": "quantity3", + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name5", + "abbreviation": "abbreviation7" + }, + "area_unit": "METRIC_SQUARE_KILOMETER", + "length_unit": "IMPERIAL_FOOT", + "volume_unit": "METRIC_MILLILITER", + "weight_unit": "METRIC_MILLIGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_DAY", + "type": "TYPE_VOLUME" + }, + "precision": 75, + "catalog_object_id": "catalog_object_id3", + "catalog_version": 247 + }, + "note": "note7", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 105, + "variation_name": "variation_name7", + "item_type": "ITEM", + "return_modifiers": [ + { + "uid": "uid4", + "source_modifier_uid": "source_modifier_uid2", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 94, + "name": "name4", + "base_price_money": { + "amount": 146, + "currency": "SRD" + }, + "total_price_money": { + "amount": 236, + "currency": "CAD" + }, + "quantity": "quantity0" + } + ], + "applied_taxes": [ + { + "uid": "uid7", + "tax_uid": "tax_uid7", + "applied_money": {} + }, + { + "uid": "uid8", + "tax_uid": "tax_uid6", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid1", + "discount_uid": "discount_uid3", + "applied_money": {} + }, + { + "uid": "uid2", + "discount_uid": "discount_uid2", + "applied_money": {} + }, + { + "uid": "uid3", + "discount_uid": "discount_uid1", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + { + "uid": "uid4", + "service_charge_uid": "service_charge_uid4", + "applied_money": {} + }, + { + "uid": "uid5", + "service_charge_uid": "service_charge_uid5", + "applied_money": {} + }, + { + "uid": "uid6", + "service_charge_uid": "service_charge_uid6", + "applied_money": {} + } + ], + "total_service_charge_money": {} + } + ], + "return_service_charges": [ + { + "uid": "uid3", + "source_service_charge_uid": "source_service_charge_uid3", + "name": "name3", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 197, + "percentage": "percentage1", + "amount_money": { + "amount": 115, + "currency": "BDT" + }, + "applied_money": { + "amount": 11, + "currency": "CHW" + }, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_AMOUNT_PHASE", + "taxable": true, + "applied_taxes": [ + { + "uid": "uid3", + "tax_uid": "tax_uid1", + "applied_money": {} + } + ], + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "OTHER_SERVICE_CHARGE_SCOPE" + }, + { + "uid": "uid4", + "source_service_charge_uid": "source_service_charge_uid2", + "name": "name4", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 196, + "percentage": "percentage2", + "amount_money": { + "amount": 116, + "currency": "BGN" + }, + "applied_money": { + "amount": 10, + "currency": "CHF" + }, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "SUBTOTAL_PHASE", + "taxable": false, + "applied_taxes": [ + { + "uid": "uid4", + "tax_uid": "tax_uid0", + "applied_money": {} + }, + { + "uid": "uid5", + "tax_uid": "tax_uid9", + "applied_money": {} + } + ], + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "ORDER" + } + ], + "return_taxes": [ + { + "uid": "uid6", + "source_tax_uid": "source_tax_uid4", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 116, + "name": "name6", + "type": "INCLUSIVE", + "percentage": "percentage4", + "applied_money": { + "amount": 186, + "currency": "UAH" + }, + "scope": "ORDER" + } + ], + "return_discounts": [ + { + "uid": "uid6", + "source_discount_uid": "source_discount_uid6", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 58, + "name": "name6", + "type": "VARIABLE_AMOUNT", + "percentage": "percentage4", + "amount_money": { + "amount": 254, + "currency": "GBP" + }, + "applied_money": { + "amount": 128, + "currency": "XPT" + }, + "scope": "OTHER_DISCOUNT_SCOPE" + }, + { + "uid": "uid7", + "source_discount_uid": "source_discount_uid7", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 57, + "name": "name7", + "type": "VARIABLE_PERCENTAGE", + "percentage": "percentage5", + "amount_money": { + "amount": 255, + "currency": "GEL" + }, + "applied_money": { + "amount": 127, + "currency": "XPF" + }, + "scope": "ORDER" + } + ], + "rounding_adjustment": { + "uid": "uid2", + "name": "name2", + "amount_money": { + "amount": 142, + "currency": "TJS" + } + }, + "return_amounts": { + "total_money": { + "amount": 196, + "currency": "NIO" + }, + "tax_money": { + "amount": 4, + "currency": "AWG" + }, + "discount_money": {}, + "tip_money": {}, + "service_charge_money": {} + } } ``` diff --git a/doc/models/order-rounding-adjustment.md b/doc/models/order-rounding-adjustment.md index f8e4b297..7ed1d8a9 100644 --- a/doc/models/order-rounding-adjustment.md +++ b/doc/models/order-rounding-adjustment.md @@ -20,9 +20,12 @@ when the minimum unit of the account is smaller than the lowest physical denomin ```json { - "uid": null, - "name": null, - "amount_money": null + "uid": "uid0", + "name": "name0", + "amount_money": { + "amount": 186, + "currency": "NGN" + } } ``` diff --git a/doc/models/order-service-charge-calculation-phase.md b/doc/models/order-service-charge-calculation-phase.md index bcefc4c6..f1a054a9 100644 --- a/doc/models/order-service-charge-calculation-phase.md +++ b/doc/models/order-service-charge-calculation-phase.md @@ -16,4 +16,6 @@ Service charges are applied after the indicated phase. | --- | --- | | `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 new file mode 100644 index 00000000..646680f4 --- /dev/null +++ b/doc/models/order-service-charge-scope.md @@ -0,0 +1,18 @@ + +# 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 new file mode 100644 index 00000000..f54d58b5 --- /dev/null +++ b/doc/models/order-service-charge-treatment-type.md @@ -0,0 +1,17 @@ + +# 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.md b/doc/models/order-service-charge.md index 261f5d58..4d9cf3b5 100644 --- a/doc/models/order-service-charge.md +++ b/doc/models/order-service-charge.md @@ -13,7 +13,7 @@ Represents a service charge applied to an order. | --- | --- | --- | --- | | `uid` | `string \| undefined` | Optional | A unique ID that identifies the service charge only within this order.
**Constraints**: *Maximum Length*: `60` | | `name` | `string \| undefined` | Optional | The name of the service charge.
**Constraints**: *Maximum Length*: `512` | -| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID referencing the service charge [CatalogObject](../../doc/models/catalog-object.md).
**Constraints**: *Maximum Length*: `192` | +| `catalogObjectId` | `string \| undefined` | Optional | The catalog object ID referencing the service charge [CatalogObject](entity:CatalogObject).
**Constraints**: *Maximum Length*: `192` | | `catalogVersion` | `bigint \| undefined` | Optional | The version of the catalog object that this service charge references. | | `percentage` | `string \| undefined` | 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` | | `amountMoney` | [`Money \| undefined`](../../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. | @@ -25,25 +25,62 @@ Represents a service charge applied to an order. | `appliedTaxes` | [`OrderLineItemAppliedTax[] \| undefined`](../../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. | | `metadata` | `Record \| undefined` | 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). | | `type` | [`string \| undefined`](../../doc/models/order-service-charge-type.md) | Optional | - | +| `treatmentType` | [`string \| undefined`](../../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. | +| `scope` | [`string \| undefined`](../../doc/models/order-service-charge-scope.md) | Optional | Indicates whether this is a line-item or order-level apportioned
service charge. | ## Example (as JSON) ```json { - "uid": null, - "name": null, - "catalog_object_id": null, - "catalog_version": null, - "percentage": null, - "amount_money": null, - "applied_money": null, - "total_money": null, - "total_tax_money": null, - "calculation_phase": null, - "taxable": null, - "applied_taxes": null, - "metadata": null, - "type": null + "uid": "uid0", + "name": "name0", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 126, + "percentage": "percentage8", + "amount_money": { + "amount": 186, + "currency": "NGN" + }, + "applied_money": { + "amount": 196, + "currency": "PLN" + }, + "total_money": { + "amount": 250, + "currency": "UNKNOWN_CURRENCY" + }, + "total_tax_money": { + "amount": 58, + "currency": "SDG" + }, + "calculation_phase": "APPORTIONED_PERCENTAGE_PHASE", + "taxable": false, + "applied_taxes": [ + { + "uid": "uid0", + "tax_uid": "tax_uid4", + "applied_money": { + "amount": 190, + "currency": "XAF" + } + }, + { + "uid": "uid1", + "tax_uid": "tax_uid3", + "applied_money": { + "amount": 189, + "currency": "WST" + } + } + ], + "metadata": { + "key0": "metadata3", + "key1": "metadata4", + "key2": "metadata5" + }, + "type": "AUTO_GRATUITY", + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "ORDER" } ``` diff --git a/doc/models/order-source.md b/doc/models/order-source.md index 4253447a..85748e93 100644 --- a/doc/models/order-source.md +++ b/doc/models/order-source.md @@ -17,7 +17,7 @@ Represents the origination details of an order. ```json { - "name": null + "name": "name0" } ``` diff --git a/doc/models/order-updated-object.md b/doc/models/order-updated-object.md index a230847d..b3bc7505 100644 --- a/doc/models/order-updated-object.md +++ b/doc/models/order-updated-object.md @@ -15,7 +15,14 @@ ```json { - "order_updated": null + "order_updated": { + "order_id": "order_id6", + "version": 176, + "location_id": "location_id4", + "state": "OPEN", + "created_at": "created_at2", + "updated_at": "updated_at4" + } } ``` diff --git a/doc/models/order-updated.md b/doc/models/order-updated.md index 87ec41c4..7980cad6 100644 --- a/doc/models/order-updated.md +++ b/doc/models/order-updated.md @@ -20,12 +20,12 @@ ```json { - "order_id": null, - "version": null, - "location_id": null, - "state": null, - "created_at": null, - "updated_at": null + "order_id": "order_id6", + "version": 172, + "location_id": "location_id4", + "state": "OPEN", + "created_at": "created_at2", + "updated_at": "updated_at4" } ``` diff --git a/doc/models/order.md b/doc/models/order.md index 1e7c1e1d..eee23e5d 100644 --- a/doc/models/order.md +++ b/doc/models/order.md @@ -20,7 +20,7 @@ itemization data. | `locationId` | `string` | Required | The ID of the seller location that this order is associated with.
**Constraints**: *Minimum Length*: `1` | | `referenceId` | `string \| undefined` | Optional | A client-specified ID to associate an entity in another system
with this order.
**Constraints**: *Maximum Length*: `40` | | `source` | [`OrderSource \| undefined`](../../doc/models/order-source.md) | Optional | Represents the origination details of an order. | -| `customerId` | `string \| undefined` | Optional | The ID of the [customer](../../doc/models/customer.md) associated with the order.

__IMPORTANT:__ You should specify a `customer_id` if you want the corresponding payment transactions
to be explicitly linked to the customer in the Seller Dashboard. If this field is omitted, the
`customer_id` assigned to any underlying `Payment` objects is ignored and 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` | +| `customerId` | `string \| undefined` | 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` | | `lineItems` | [`OrderLineItem[] \| undefined`](../../doc/models/order-line-item.md) | Optional | The line items included in the order. | | `taxes` | [`OrderLineItemTax[] \| undefined`](../../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. | | `discounts` | [`OrderLineItemDiscount[] \| undefined`](../../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. | @@ -35,7 +35,7 @@ itemization data. | `metadata` | `Record \| undefined` | 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). | | `createdAt` | `string \| undefined` | Optional | The timestamp for when the order was created, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | | `updatedAt` | `string \| undefined` | Optional | The timestamp for when the order was last updated, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). | -| `closedAt` | `string \| undefined` | Optional | The timestamp for when the order reached a terminal [state](../../doc/models/order-state.md), in RFC 3339 format (for example "2016-09-04T23:59:33.123Z"). | +| `closedAt` | `string \| undefined` | 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"). | | `state` | [`string \| undefined`](../../doc/models/order-state.md) | Optional | The state of the order. | | `version` | `number \| undefined` | 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). | | `totalMoney` | [`Money \| undefined`](../../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. | @@ -52,37 +52,1904 @@ itemization data. ```json { - "id": null, + "id": "id0", "location_id": "location_id4", - "reference_id": null, - "source": null, - "customer_id": null, - "line_items": null, - "taxes": null, - "discounts": null, - "service_charges": null, - "fulfillments": null, - "returns": null, - "return_amounts": null, - "net_amounts": null, - "rounding_adjustment": null, - "tenders": null, - "refunds": null, - "metadata": null, - "created_at": null, - "updated_at": null, - "closed_at": null, - "state": null, - "version": null, - "total_money": null, - "total_tax_money": null, - "total_discount_money": null, - "total_tip_money": null, - "total_service_charge_money": null, - "ticket_name": null, - "pricing_options": null, - "rewards": null, - "net_amount_due_money": null + "reference_id": "reference_id2", + "source": { + "name": "name4" + }, + "customer_id": "customer_id8", + "line_items": [ + { + "uid": "uid9", + "name": "name9", + "quantity": "quantity5", + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name7", + "abbreviation": "abbreviation9" + }, + "area_unit": "IMPERIAL_SQUARE_YARD", + "length_unit": "METRIC_CENTIMETER", + "volume_unit": "GENERIC_PINT", + "weight_unit": "METRIC_KILOGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MINUTE", + "type": "TYPE_GENERIC" + }, + "precision": 199, + "catalog_object_id": "catalog_object_id9", + "catalog_version": 133 + }, + "note": "note5", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 237, + "variation_name": "variation_name9", + "item_type": "CUSTOM_AMOUNT", + "metadata": { + "key0": "metadata4", + "key1": "metadata5" + }, + "modifiers": [ + { + "uid": "uid0", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 80, + "name": "name0", + "quantity": "quantity6", + "base_price_money": { + "amount": 64, + "currency": "MRO" + }, + "total_price_money": { + "amount": 62, + "currency": "AED" + }, + "metadata": { + "key0": "metadata7", + "key1": "metadata6" + } + }, + { + "uid": "uid1", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 81, + "name": "name1", + "quantity": "quantity7", + "base_price_money": { + "amount": 65, + "currency": "MUR" + }, + "total_price_money": { + "amount": 63, + "currency": "AFN" + }, + "metadata": { + "key0": "metadata8" + } + }, + { + "uid": "uid2", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 82, + "name": "name2", + "quantity": "quantity8", + "base_price_money": { + "amount": 66, + "currency": "MVR" + }, + "total_price_money": { + "amount": 64, + "currency": "ALL" + }, + "metadata": { + "key0": "metadata9", + "key1": "metadata8", + "key2": "metadata7" + } + } + ], + "applied_taxes": [ + { + "uid": "uid9", + "tax_uid": "tax_uid5", + "applied_money": {} + }, + { + "uid": "uid0", + "tax_uid": "tax_uid6", + "applied_money": {} + }, + { + "uid": "uid1", + "tax_uid": "tax_uid7", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid3", + "discount_uid": "discount_uid1", + "applied_money": {} + } + ], + "applied_service_charges": [ + { + "uid": "uid4", + "service_charge_uid": "service_charge_uid4", + "applied_money": {} + }, + { + "uid": "uid3", + "service_charge_uid": "service_charge_uid3", + "applied_money": {} + }, + { + "uid": "uid2", + "service_charge_uid": "service_charge_uid2", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_sales_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "pricing_blocklists": { + "blocked_discounts": [ + { + "uid": "uid2", + "discount_uid": "discount_uid8", + "discount_catalog_object_id": "discount_catalog_object_id4" + }, + { + "uid": "uid3", + "discount_uid": "discount_uid9", + "discount_catalog_object_id": "discount_catalog_object_id5" + } + ], + "blocked_taxes": [ + { + "uid": "uid4", + "tax_uid": "tax_uid0", + "tax_catalog_object_id": "tax_catalog_object_id8" + }, + { + "uid": "uid3", + "tax_uid": "tax_uid1", + "tax_catalog_object_id": "tax_catalog_object_id7" + } + ] + }, + "total_service_charge_money": {} + }, + { + "uid": "uid0", + "name": "name0", + "quantity": "quantity6", + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name8", + "abbreviation": "abbreviation0" + }, + "area_unit": "IMPERIAL_SQUARE_MILE", + "length_unit": "METRIC_MILLIMETER", + "volume_unit": "GENERIC_QUART", + "weight_unit": "METRIC_GRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_SECOND", + "type": "TYPE_WEIGHT" + }, + "precision": 200, + "catalog_object_id": "catalog_object_id0", + "catalog_version": 134 + }, + "note": "note6", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 236, + "variation_name": "variation_name0", + "item_type": "GIFT_CARD", + "metadata": { + "key0": "metadata3" + }, + "modifiers": [ + { + "uid": "uid1", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 81, + "name": "name1", + "quantity": "quantity7", + "base_price_money": { + "amount": 65, + "currency": "MUR" + }, + "total_price_money": { + "amount": 63, + "currency": "AFN" + }, + "metadata": { + "key0": "metadata8" + } + } + ], + "applied_taxes": [ + { + "uid": "uid0", + "tax_uid": "tax_uid6", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid4", + "discount_uid": "discount_uid0", + "applied_money": {} + }, + { + "uid": "uid5", + "discount_uid": "discount_uid9", + "applied_money": {} + } + ], + "applied_service_charges": [ + { + "uid": "uid3", + "service_charge_uid": "service_charge_uid3", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_sales_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "pricing_blocklists": { + "blocked_discounts": [ + { + "uid": "uid3", + "discount_uid": "discount_uid9", + "discount_catalog_object_id": "discount_catalog_object_id5" + }, + { + "uid": "uid4", + "discount_uid": "discount_uid0", + "discount_catalog_object_id": "discount_catalog_object_id6" + }, + { + "uid": "uid5", + "discount_uid": "discount_uid1", + "discount_catalog_object_id": "discount_catalog_object_id7" + } + ], + "blocked_taxes": [ + { + "uid": "uid3", + "tax_uid": "tax_uid1", + "tax_catalog_object_id": "tax_catalog_object_id7" + }, + { + "uid": "uid2", + "tax_uid": "tax_uid2", + "tax_catalog_object_id": "tax_catalog_object_id6" + }, + { + "uid": "uid1", + "tax_uid": "tax_uid3", + "tax_catalog_object_id": "tax_catalog_object_id5" + } + ] + }, + "total_service_charge_money": {} + }, + { + "uid": "uid1", + "name": "name1", + "quantity": "quantity7", + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name9", + "abbreviation": "abbreviation1" + }, + "area_unit": "METRIC_SQUARE_CENTIMETER", + "length_unit": "IMPERIAL_MILE", + "volume_unit": "GENERIC_GALLON", + "weight_unit": "METRIC_MILLIGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MILLISECOND", + "type": "TYPE_VOLUME" + }, + "precision": 201, + "catalog_object_id": "catalog_object_id1", + "catalog_version": 135 + }, + "note": "note7", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 235, + "variation_name": "variation_name1", + "item_type": "ITEM", + "metadata": { + "key0": "metadata2", + "key1": "metadata3", + "key2": "metadata4" + }, + "modifiers": [ + { + "uid": "uid2", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 82, + "name": "name2", + "quantity": "quantity8", + "base_price_money": { + "amount": 66, + "currency": "MVR" + }, + "total_price_money": { + "amount": 64, + "currency": "ALL" + }, + "metadata": { + "key0": "metadata9", + "key1": "metadata8", + "key2": "metadata7" + } + }, + { + "uid": "uid3", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 83, + "name": "name3", + "quantity": "quantity9", + "base_price_money": { + "amount": 67, + "currency": "MWK" + }, + "total_price_money": { + "amount": 65, + "currency": "AMD" + }, + "metadata": { + "key0": "metadata0", + "key1": "metadata9" + } + } + ], + "applied_taxes": [ + { + "uid": "uid1", + "tax_uid": "tax_uid7", + "applied_money": {} + }, + { + "uid": "uid2", + "tax_uid": "tax_uid8", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid5", + "discount_uid": "discount_uid9", + "applied_money": {} + }, + { + "uid": "uid6", + "discount_uid": "discount_uid8", + "applied_money": {} + }, + { + "uid": "uid7", + "discount_uid": "discount_uid7", + "applied_money": {} + } + ], + "applied_service_charges": [ + { + "uid": "uid2", + "service_charge_uid": "service_charge_uid2", + "applied_money": {} + }, + { + "uid": "uid1", + "service_charge_uid": "service_charge_uid1", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_sales_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "pricing_blocklists": { + "blocked_discounts": [ + { + "uid": "uid4", + "discount_uid": "discount_uid0", + "discount_catalog_object_id": "discount_catalog_object_id6" + } + ], + "blocked_taxes": [ + { + "uid": "uid2", + "tax_uid": "tax_uid2", + "tax_catalog_object_id": "tax_catalog_object_id6" + } + ] + }, + "total_service_charge_money": {} + } + ], + "taxes": [ + { + "uid": "uid5", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 39, + "name": "name5", + "type": "UNKNOWN_TAX", + "percentage": "percentage3", + "metadata": { + "key0": "metadata8" + }, + "applied_money": { + "amount": 109, + "currency": "BTC" + }, + "scope": "OTHER_TAX_SCOPE", + "auto_applied": true + }, + { + "uid": "uid6", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 38, + "name": "name6", + "type": "INCLUSIVE", + "percentage": "percentage4", + "metadata": { + "key0": "metadata7", + "key1": "metadata8", + "key2": "metadata9" + }, + "applied_money": { + "amount": 108, + "currency": "ZMW" + }, + "scope": "ORDER", + "auto_applied": false + } + ], + "discounts": [ + { + "uid": "uid1", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 65, + "name": "name1", + "type": "FIXED_PERCENTAGE", + "percentage": "percentage9", + "amount_money": { + "amount": 121, + "currency": "NGN" + }, + "applied_money": { + "amount": 97, + "currency": "NIO" + }, + "metadata": { + "key0": "metadata8", + "key1": "metadata7", + "key2": "metadata6" + }, + "scope": "LINE_ITEM", + "reward_ids": [ + "reward_ids8" + ], + "pricing_rule_id": "pricing_rule_id3" + }, + { + "uid": "uid2", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 66, + "name": "name2", + "type": "FIXED_AMOUNT", + "percentage": "percentage0", + "amount_money": { + "amount": 122, + "currency": "NIO" + }, + "applied_money": { + "amount": 96, + "currency": "NGN" + }, + "metadata": { + "key0": "metadata9", + "key1": "metadata8" + }, + "scope": "ORDER", + "reward_ids": [ + "reward_ids9", + "reward_ids0" + ], + "pricing_rule_id": "pricing_rule_id4" + }, + { + "uid": "uid3", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 67, + "name": "name3", + "type": "VARIABLE_PERCENTAGE", + "percentage": "percentage1", + "amount_money": { + "amount": 123, + "currency": "NOK" + }, + "applied_money": { + "amount": 95, + "currency": "NAD" + }, + "metadata": { + "key0": "metadata0" + }, + "scope": "OTHER_DISCOUNT_SCOPE", + "reward_ids": [ + "reward_ids0", + "reward_ids1", + "reward_ids2" + ], + "pricing_rule_id": "pricing_rule_id5" + } + ], + "service_charges": [ + { + "uid": "uid9", + "name": "name9", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 1, + "percentage": "percentage7", + "amount_money": { + "amount": 55, + "currency": "MGA" + }, + "applied_money": { + "amount": 71, + "currency": "SLL" + }, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_AMOUNT_PHASE", + "taxable": true, + "applied_taxes": [ + { + "uid": "uid9", + "tax_uid": "tax_uid5", + "applied_money": {} + }, + { + "uid": "uid0", + "tax_uid": "tax_uid4", + "applied_money": {} + }, + { + "uid": "uid1", + "tax_uid": "tax_uid3", + "applied_money": {} + } + ], + "metadata": { + "key0": "metadata4", + "key1": "metadata5" + }, + "type": "CUSTOM", + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "LINE_ITEM" + }, + { + "uid": "uid0", + "name": "name0", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 0, + "percentage": "percentage8", + "amount_money": { + "amount": 56, + "currency": "MKD" + }, + "applied_money": { + "amount": 70, + "currency": "SHP" + }, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "SUBTOTAL_PHASE", + "taxable": false, + "applied_taxes": [ + { + "uid": "uid0", + "tax_uid": "tax_uid4", + "applied_money": {} + } + ], + "metadata": { + "key0": "metadata3" + }, + "type": "AUTO_GRATUITY", + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "OTHER_SERVICE_CHARGE_SCOPE" + }, + { + "uid": "uid1", + "name": "name1", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 255, + "percentage": "percentage9", + "amount_money": { + "amount": 57, + "currency": "MMK" + }, + "applied_money": { + "amount": 69, + "currency": "SGD" + }, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "TOTAL_PHASE", + "taxable": true, + "applied_taxes": [ + { + "uid": "uid1", + "tax_uid": "tax_uid3", + "applied_money": {} + }, + { + "uid": "uid2", + "tax_uid": "tax_uid2", + "applied_money": {} + } + ], + "metadata": { + "key0": "metadata2", + "key1": "metadata3", + "key2": "metadata4" + }, + "type": "CUSTOM", + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "ORDER" + } + ], + "fulfillments": [ + { + "uid": "uid6", + "type": "DELIVERY", + "state": "CANCELED", + "line_item_application": "ALL", + "entries": [ + { + "uid": "uid9", + "line_item_uid": "line_item_uid9", + "quantity": "quantity5", + "metadata": { + "key0": "metadata4", + "key1": "metadata5", + "key2": "metadata6" + } + } + ], + "metadata": { + "key0": "metadata3", + "key1": "metadata2", + "key2": "metadata1" + }, + "pickup_details": { + "recipient": { + "customer_id": "customer_id4", + "display_name": "display_name6", + "email_address": "email_address4", + "phone_number": "phone_number4", + "address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_22", + "address_line_3": "address_line_38", + "locality": "locality2", + "sublocality": "sublocality2", + "sublocality_2": "sublocality_20", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_16", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_30", + "postal_code": "postal_code4", + "country": "CL", + "first_name": "first_name2", + "last_name": "last_name0" + } + }, + "expires_at": "expires_at8", + "auto_complete_duration": "auto_complete_duration8", + "schedule_type": "SCHEDULED", + "pickup_at": "pickup_at0", + "pickup_window_duration": "pickup_window_duration4", + "prep_time_duration": "prep_time_duration6", + "note": "note0", + "placed_at": "placed_at4", + "accepted_at": "accepted_at8", + "rejected_at": "rejected_at6", + "ready_at": "ready_at4", + "expired_at": "expired_at4", + "picked_up_at": "picked_up_at4", + "canceled_at": "canceled_at0", + "cancel_reason": "cancel_reason0", + "is_curbside_pickup": false, + "curbside_pickup_details": { + "curbside_details": "curbside_details6", + "buyer_arrived_at": "buyer_arrived_at2" + } + }, + "shipment_details": { + "recipient": { + "customer_id": "customer_id8", + "display_name": "display_name0", + "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", + "sublocality_2": "sublocality_24", + "sublocality_3": "sublocality_36", + "administrative_district_level_1": "administrative_district_level_10", + "administrative_district_level_2": "administrative_district_level_22", + "administrative_district_level_3": "administrative_district_level_34", + "postal_code": "postal_code8", + "country": "FI", + "first_name": "first_name6", + "last_name": "last_name4" + } + }, + "carrier": "carrier0", + "shipping_note": "shipping_note4", + "shipping_type": "shipping_type8", + "tracking_number": "tracking_number6", + "tracking_url": "tracking_url2", + "placed_at": "placed_at2", + "in_progress_at": "in_progress_at6", + "packaged_at": "packaged_at2", + "expected_shipped_at": "expected_shipped_at2", + "shipped_at": "shipped_at6", + "canceled_at": "canceled_at6", + "cancel_reason": "cancel_reason6", + "failed_at": "failed_at2", + "failure_reason": "failure_reason2" + }, + "delivery_details": { + "recipient": {}, + "schedule_type": "SCHEDULED", + "placed_at": "placed_at2", + "deliver_at": "deliver_at0", + "prep_time_duration": "prep_time_duration4", + "delivery_window_duration": "delivery_window_duration6", + "note": "note8", + "completed_at": "completed_at4", + "in_progress_at": "in_progress_at8", + "rejected_at": "rejected_at4", + "ready_at": "ready_at2", + "delivered_at": "delivered_at0", + "canceled_at": "canceled_at8", + "cancel_reason": "cancel_reason8", + "courier_pickup_at": "courier_pickup_at4", + "courier_pickup_window_duration": "courier_pickup_window_duration6", + "is_no_contact_delivery": false, + "dropoff_notes": "dropoff_notes6", + "courier_provider_name": "courier_provider_name0", + "courier_support_phone_number": "courier_support_phone_number8", + "square_delivery_id": "square_delivery_id2", + "external_delivery_id": "external_delivery_id6", + "managed_delivery": false + } + }, + { + "uid": "uid7", + "type": "SHIPMENT", + "state": "FAILED", + "line_item_application": "ENTRY_LIST", + "entries": [ + { + "uid": "uid8", + "line_item_uid": "line_item_uid8", + "quantity": "quantity4", + "metadata": { + "key0": "metadata5" + } + }, + { + "uid": "uid7", + "line_item_uid": "line_item_uid7", + "quantity": "quantity3", + "metadata": { + "key0": "metadata6", + "key1": "metadata7" + } + } + ], + "metadata": { + "key0": "metadata4", + "key1": "metadata3" + }, + "pickup_details": { + "recipient": { + "customer_id": "customer_id5", + "display_name": "display_name7", + "email_address": "email_address5", + "phone_number": "phone_number5", + "address": { + "address_line_1": "address_line_13", + "address_line_2": "address_line_23", + "address_line_3": "address_line_39", + "locality": "locality3", + "sublocality": "sublocality3", + "sublocality_2": "sublocality_21", + "sublocality_3": "sublocality_33", + "administrative_district_level_1": "administrative_district_level_17", + "administrative_district_level_2": "administrative_district_level_29", + "administrative_district_level_3": "administrative_district_level_31", + "postal_code": "postal_code5", + "country": "CM", + "first_name": "first_name3", + "last_name": "last_name1" + } + }, + "expires_at": "expires_at9", + "auto_complete_duration": "auto_complete_duration9", + "schedule_type": "ASAP", + "pickup_at": "pickup_at1", + "pickup_window_duration": "pickup_window_duration5", + "prep_time_duration": "prep_time_duration7", + "note": "note1", + "placed_at": "placed_at5", + "accepted_at": "accepted_at9", + "rejected_at": "rejected_at7", + "ready_at": "ready_at5", + "expired_at": "expired_at5", + "picked_up_at": "picked_up_at5", + "canceled_at": "canceled_at1", + "cancel_reason": "cancel_reason1", + "is_curbside_pickup": true, + "curbside_pickup_details": { + "curbside_details": "curbside_details7", + "buyer_arrived_at": "buyer_arrived_at3" + } + }, + "shipment_details": { + "recipient": { + "customer_id": "customer_id9", + "display_name": "display_name1", + "email_address": "email_address1", + "phone_number": "phone_number1", + "address": { + "address_line_1": "address_line_17", + "address_line_2": "address_line_27", + "address_line_3": "address_line_33", + "locality": "locality7", + "sublocality": "sublocality7", + "sublocality_2": "sublocality_25", + "sublocality_3": "sublocality_37", + "administrative_district_level_1": "administrative_district_level_11", + "administrative_district_level_2": "administrative_district_level_23", + "administrative_district_level_3": "administrative_district_level_35", + "postal_code": "postal_code9", + "country": "FJ", + "first_name": "first_name7", + "last_name": "last_name5" + } + }, + "carrier": "carrier1", + "shipping_note": "shipping_note5", + "shipping_type": "shipping_type7", + "tracking_number": "tracking_number7", + "tracking_url": "tracking_url1", + "placed_at": "placed_at1", + "in_progress_at": "in_progress_at5", + "packaged_at": "packaged_at3", + "expected_shipped_at": "expected_shipped_at3", + "shipped_at": "shipped_at7", + "canceled_at": "canceled_at5", + "cancel_reason": "cancel_reason5", + "failed_at": "failed_at3", + "failure_reason": "failure_reason1" + }, + "delivery_details": { + "recipient": {}, + "schedule_type": "ASAP", + "placed_at": "placed_at3", + "deliver_at": "deliver_at1", + "prep_time_duration": "prep_time_duration5", + "delivery_window_duration": "delivery_window_duration7", + "note": "note9", + "completed_at": "completed_at5", + "in_progress_at": "in_progress_at9", + "rejected_at": "rejected_at5", + "ready_at": "ready_at3", + "delivered_at": "delivered_at1", + "canceled_at": "canceled_at9", + "cancel_reason": "cancel_reason9", + "courier_pickup_at": "courier_pickup_at5", + "courier_pickup_window_duration": "courier_pickup_window_duration7", + "is_no_contact_delivery": true, + "dropoff_notes": "dropoff_notes7", + "courier_provider_name": "courier_provider_name1", + "courier_support_phone_number": "courier_support_phone_number9", + "square_delivery_id": "square_delivery_id3", + "external_delivery_id": "external_delivery_id7", + "managed_delivery": true + } + }, + { + "uid": "uid8", + "type": "PICKUP", + "state": "PROPOSED", + "line_item_application": "ALL", + "entries": [ + { + "uid": "uid7", + "line_item_uid": "line_item_uid7", + "quantity": "quantity3", + "metadata": { + "key0": "metadata6", + "key1": "metadata7" + } + }, + { + "uid": "uid6", + "line_item_uid": "line_item_uid6", + "quantity": "quantity2", + "metadata": { + "key0": "metadata7", + "key1": "metadata8", + "key2": "metadata9" + } + }, + { + "uid": "uid5", + "line_item_uid": "line_item_uid5", + "quantity": "quantity1", + "metadata": { + "key0": "metadata8" + } + } + ], + "metadata": { + "key0": "metadata5" + }, + "pickup_details": { + "recipient": { + "customer_id": "customer_id6", + "display_name": "display_name8", + "email_address": "email_address6", + "phone_number": "phone_number6", + "address": { + "address_line_1": "address_line_14", + "address_line_2": "address_line_24", + "address_line_3": "address_line_30", + "locality": "locality4", + "sublocality": "sublocality4", + "sublocality_2": "sublocality_22", + "sublocality_3": "sublocality_34", + "administrative_district_level_1": "administrative_district_level_18", + "administrative_district_level_2": "administrative_district_level_20", + "administrative_district_level_3": "administrative_district_level_32", + "postal_code": "postal_code6", + "country": "CN", + "first_name": "first_name4", + "last_name": "last_name2" + } + }, + "expires_at": "expires_at0", + "auto_complete_duration": "auto_complete_duration0", + "schedule_type": "SCHEDULED", + "pickup_at": "pickup_at2", + "pickup_window_duration": "pickup_window_duration6", + "prep_time_duration": "prep_time_duration8", + "note": "note2", + "placed_at": "placed_at6", + "accepted_at": "accepted_at0", + "rejected_at": "rejected_at8", + "ready_at": "ready_at6", + "expired_at": "expired_at6", + "picked_up_at": "picked_up_at6", + "canceled_at": "canceled_at2", + "cancel_reason": "cancel_reason2", + "is_curbside_pickup": false, + "curbside_pickup_details": { + "curbside_details": "curbside_details8", + "buyer_arrived_at": "buyer_arrived_at4" + } + }, + "shipment_details": { + "recipient": { + "customer_id": "customer_id0", + "display_name": "display_name2", + "email_address": "email_address0", + "phone_number": "phone_number0", + "address": { + "address_line_1": "address_line_18", + "address_line_2": "address_line_28", + "address_line_3": "address_line_34", + "locality": "locality8", + "sublocality": "sublocality8", + "sublocality_2": "sublocality_26", + "sublocality_3": "sublocality_38", + "administrative_district_level_1": "administrative_district_level_12", + "administrative_district_level_2": "administrative_district_level_24", + "administrative_district_level_3": "administrative_district_level_36", + "postal_code": "postal_code0", + "country": "FK", + "first_name": "first_name8", + "last_name": "last_name6" + } + }, + "carrier": "carrier2", + "shipping_note": "shipping_note6", + "shipping_type": "shipping_type6", + "tracking_number": "tracking_number8", + "tracking_url": "tracking_url0", + "placed_at": "placed_at0", + "in_progress_at": "in_progress_at4", + "packaged_at": "packaged_at4", + "expected_shipped_at": "expected_shipped_at4", + "shipped_at": "shipped_at8", + "canceled_at": "canceled_at4", + "cancel_reason": "cancel_reason4", + "failed_at": "failed_at4", + "failure_reason": "failure_reason0" + }, + "delivery_details": { + "recipient": {}, + "schedule_type": "SCHEDULED", + "placed_at": "placed_at4", + "deliver_at": "deliver_at2", + "prep_time_duration": "prep_time_duration6", + "delivery_window_duration": "delivery_window_duration8", + "note": "note0", + "completed_at": "completed_at6", + "in_progress_at": "in_progress_at0", + "rejected_at": "rejected_at6", + "ready_at": "ready_at4", + "delivered_at": "delivered_at2", + "canceled_at": "canceled_at0", + "cancel_reason": "cancel_reason0", + "courier_pickup_at": "courier_pickup_at6", + "courier_pickup_window_duration": "courier_pickup_window_duration8", + "is_no_contact_delivery": false, + "dropoff_notes": "dropoff_notes8", + "courier_provider_name": "courier_provider_name2", + "courier_support_phone_number": "courier_support_phone_number0", + "square_delivery_id": "square_delivery_id4", + "external_delivery_id": "external_delivery_id8", + "managed_delivery": false + } + } + ], + "returns": [ + { + "uid": "uid9", + "source_order_id": "source_order_id3", + "return_line_items": [ + { + "uid": "uid6", + "source_line_item_uid": "source_line_item_uid6", + "name": "name6", + "quantity": "quantity2", + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name4", + "abbreviation": "abbreviation6" + }, + "area_unit": "IMPERIAL_SQUARE_MILE", + "length_unit": "METRIC_MILLIMETER", + "volume_unit": "METRIC_LITER", + "weight_unit": "IMPERIAL_STONE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MILLISECOND", + "type": "TYPE_LENGTH" + }, + "precision": 200, + "catalog_object_id": "catalog_object_id4", + "catalog_version": 122 + }, + "note": "note8", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 236, + "variation_name": "variation_name6", + "item_type": "CUSTOM_AMOUNT", + "return_modifiers": [ + { + "uid": "uid5", + "source_modifier_uid": "source_modifier_uid1", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 219, + "name": "name5", + "base_price_money": { + "amount": 21, + "currency": "LBP" + }, + "total_price_money": { + "amount": 111, + "currency": "VND" + }, + "quantity": "quantity1" + }, + { + "uid": "uid6", + "source_modifier_uid": "source_modifier_uid0", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 218, + "name": "name6", + "base_price_money": { + "amount": 22, + "currency": "LKR" + }, + "total_price_money": { + "amount": 112, + "currency": "VUV" + }, + "quantity": "quantity2" + }, + { + "uid": "uid7", + "source_modifier_uid": "source_modifier_uid9", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 217, + "name": "name7", + "base_price_money": { + "amount": 23, + "currency": "LRD" + }, + "total_price_money": { + "amount": 113, + "currency": "WST" + }, + "quantity": "quantity3" + } + ], + "applied_taxes": [ + { + "uid": "uid6", + "tax_uid": "tax_uid8", + "applied_money": {} + }, + { + "uid": "uid7", + "tax_uid": "tax_uid7", + "applied_money": {} + }, + { + "uid": "uid8", + "tax_uid": "tax_uid6", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid0", + "discount_uid": "discount_uid4", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + { + "uid": "uid5", + "service_charge_uid": "service_charge_uid5", + "applied_money": {} + }, + { + "uid": "uid6", + "service_charge_uid": "service_charge_uid6", + "applied_money": {} + } + ], + "total_service_charge_money": {} + }, + { + "uid": "uid7", + "source_line_item_uid": "source_line_item_uid5", + "name": "name7", + "quantity": "quantity3", + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name5", + "abbreviation": "abbreviation7" + }, + "area_unit": "METRIC_SQUARE_CENTIMETER", + "length_unit": "IMPERIAL_MILE", + "volume_unit": "GENERIC_FLUID_OUNCE", + "weight_unit": "IMPERIAL_POUND", + "generic_unit": "UNIT", + "time_unit": "GENERIC_DAY", + "type": "TYPE_AREA" + }, + "precision": 201, + "catalog_object_id": "catalog_object_id3", + "catalog_version": 121 + }, + "note": "note7", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 235, + "variation_name": "variation_name7", + "item_type": "GIFT_CARD", + "return_modifiers": [ + { + "uid": "uid4", + "source_modifier_uid": "source_modifier_uid2", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 220, + "name": "name4", + "base_price_money": { + "amount": 20, + "currency": "LAK" + }, + "total_price_money": { + "amount": 110, + "currency": "VEF" + }, + "quantity": "quantity0" + }, + { + "uid": "uid5", + "source_modifier_uid": "source_modifier_uid1", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 219, + "name": "name5", + "base_price_money": { + "amount": 21, + "currency": "LBP" + }, + "total_price_money": { + "amount": 111, + "currency": "VND" + }, + "quantity": "quantity1" + } + ], + "applied_taxes": [ + { + "uid": "uid7", + "tax_uid": "tax_uid7", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid1", + "discount_uid": "discount_uid3", + "applied_money": {} + }, + { + "uid": "uid2", + "discount_uid": "discount_uid2", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + { + "uid": "uid4", + "service_charge_uid": "service_charge_uid4", + "applied_money": {} + } + ], + "total_service_charge_money": {} + }, + { + "uid": "uid8", + "source_line_item_uid": "source_line_item_uid4", + "name": "name8", + "quantity": "quantity4", + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name6", + "abbreviation": "abbreviation8" + }, + "area_unit": "METRIC_SQUARE_METER", + "length_unit": "IMPERIAL_YARD", + "volume_unit": "GENERIC_SHOT", + "weight_unit": "IMPERIAL_WEIGHT_OUNCE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_HOUR", + "type": "TYPE_CUSTOM" + }, + "precision": 202, + "catalog_object_id": "catalog_object_id2", + "catalog_version": 120 + }, + "note": "note6", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 234, + "variation_name": "variation_name8", + "item_type": "ITEM", + "return_modifiers": [ + { + "uid": "uid3", + "source_modifier_uid": "source_modifier_uid3", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 221, + "name": "name3", + "base_price_money": { + "amount": 19, + "currency": "KZT" + }, + "total_price_money": { + "amount": 109, + "currency": "UZS" + }, + "quantity": "quantity9" + } + ], + "applied_taxes": [ + { + "uid": "uid8", + "tax_uid": "tax_uid6", + "applied_money": {} + }, + { + "uid": "uid9", + "tax_uid": "tax_uid5", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid2", + "discount_uid": "discount_uid2", + "applied_money": {} + }, + { + "uid": "uid3", + "discount_uid": "discount_uid1", + "applied_money": {} + }, + { + "uid": "uid4", + "discount_uid": "discount_uid0", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + { + "uid": "uid3", + "service_charge_uid": "service_charge_uid3", + "applied_money": {} + }, + { + "uid": "uid4", + "service_charge_uid": "service_charge_uid4", + "applied_money": {} + }, + { + "uid": "uid5", + "service_charge_uid": "service_charge_uid5", + "applied_money": {} + } + ], + "total_service_charge_money": {} + } + ], + "return_service_charges": [ + { + "uid": "uid4", + "source_service_charge_uid": "source_service_charge_uid2", + "name": "name4", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 70, + "percentage": "percentage2", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_PERCENTAGE_PHASE", + "taxable": false, + "applied_taxes": [ + {} + ], + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "OTHER_SERVICE_CHARGE_SCOPE" + }, + { + "uid": "uid5", + "source_service_charge_uid": "source_service_charge_uid1", + "name": "name5", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 69, + "percentage": "percentage3", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_AMOUNT_PHASE", + "taxable": true, + "applied_taxes": [ + {}, + {} + ], + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "ORDER" + } + ], + "return_taxes": [ + { + "uid": "uid7", + "source_tax_uid": "source_tax_uid5", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 245, + "name": "name7", + "type": "INCLUSIVE", + "percentage": "percentage5", + "applied_money": {}, + "scope": "ORDER" + } + ], + "return_discounts": [ + { + "uid": "uid7", + "source_discount_uid": "source_discount_uid7", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 187, + "name": "name7", + "type": "VARIABLE_PERCENTAGE", + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "scope": "OTHER_DISCOUNT_SCOPE" + }, + { + "uid": "uid8", + "source_discount_uid": "source_discount_uid8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 186, + "name": "name8", + "type": "FIXED_AMOUNT", + "percentage": "percentage6", + "amount_money": {}, + "applied_money": {}, + "scope": "ORDER" + } + ], + "rounding_adjustment": { + "uid": "uid1", + "name": "name1", + "amount_money": {} + }, + "return_amounts": { + "total_money": {}, + "tax_money": {}, + "discount_money": {}, + "tip_money": {}, + "service_charge_money": {} + } + } + ], + "return_amounts": { + "total_money": { + "amount": 196, + "currency": "NIO" + }, + "tax_money": { + "amount": 4, + "currency": "AWG" + }, + "discount_money": {}, + "tip_money": {}, + "service_charge_money": {} + }, + "net_amounts": { + "total_money": { + "amount": 228, + "currency": "PAB" + }, + "tax_money": { + "amount": 36, + "currency": "BGN" + }, + "discount_money": {}, + "tip_money": {}, + "service_charge_money": {} + }, + "rounding_adjustment": { + "uid": "uid2", + "name": "name2", + "amount_money": { + "amount": 142, + "currency": "TJS" + } + }, + "tenders": [ + { + "id": "id2", + "location_id": "location_id6", + "transaction_id": "transaction_id0", + "created_at": "created_at0", + "note": "note8", + "amount_money": { + "amount": 214, + "currency": "TJS" + }, + "tip_money": { + "amount": 218, + "currency": "HTG" + }, + "processing_fee_money": {}, + "customer_id": "customer_id0", + "type": "OTHER", + "card_details": { + "status": "AUTHORIZED", + "card": { + "id": "id6", + "card_brand": "INTERAC", + "last_4": "last_48", + "exp_month": 148, + "exp_year": 148, + "cardholder_name": "cardholder_name8", + "billing_address": { + "address_line_1": "address_line_18", + "address_line_2": "address_line_22", + "address_line_3": "address_line_38", + "locality": "locality8", + "sublocality": "sublocality2", + "sublocality_2": "sublocality_20", + "sublocality_3": "sublocality_38", + "administrative_district_level_1": "administrative_district_level_16", + "administrative_district_level_2": "administrative_district_level_22", + "administrative_district_level_3": "administrative_district_level_30", + "postal_code": "postal_code4", + "country": "PY", + "first_name": "first_name2", + "last_name": "last_name0" + }, + "fingerprint": "fingerprint2", + "customer_id": "customer_id4", + "merchant_id": "merchant_id6", + "reference_id": "reference_id6", + "enabled": false, + "card_type": "DEBIT", + "prepaid_type": "UNKNOWN_PREPAID_TYPE", + "bin": "bin6", + "version": 234, + "card_co_brand": "UNKNOWN" + }, + "entry_method": "KEYED" + }, + "cash_details": { + "buyer_tendered_money": {}, + "change_back_money": {} + }, + "additional_recipients": [ + { + "location_id": "location_id5", + "description": "description1", + "amount_money": {}, + "receivable_id": "receivable_id1" + }, + { + "location_id": "location_id6", + "description": "description2", + "amount_money": {}, + "receivable_id": "receivable_id2" + }, + { + "location_id": "location_id7", + "description": "description3", + "amount_money": {}, + "receivable_id": "receivable_id3" + } + ], + "payment_id": "payment_id2" + }, + { + "id": "id3", + "location_id": "location_id7", + "transaction_id": "transaction_id1", + "created_at": "created_at1", + "note": "note9", + "amount_money": { + "amount": 215, + "currency": "TMT" + }, + "tip_money": { + "amount": 219, + "currency": "HUF" + }, + "processing_fee_money": {}, + "customer_id": "customer_id1", + "type": "CARD", + "card_details": { + "status": "FAILED", + "card": { + "id": "id5", + "card_brand": "EFTPOS", + "last_4": "last_47", + "exp_month": 149, + "exp_year": 147, + "cardholder_name": "cardholder_name9", + "billing_address": { + "address_line_1": "address_line_17", + "address_line_2": "address_line_23", + "address_line_3": "address_line_39", + "locality": "locality7", + "sublocality": "sublocality3", + "sublocality_2": "sublocality_21", + "sublocality_3": "sublocality_37", + "administrative_district_level_1": "administrative_district_level_17", + "administrative_district_level_2": "administrative_district_level_21", + "administrative_district_level_3": "administrative_district_level_31", + "postal_code": "postal_code5", + "country": "QA", + "first_name": "first_name3", + "last_name": "last_name1" + }, + "fingerprint": "fingerprint1", + "customer_id": "customer_id3", + "merchant_id": "merchant_id5", + "reference_id": "reference_id7", + "enabled": true, + "card_type": "UNKNOWN_CARD_TYPE", + "prepaid_type": "PREPAID", + "bin": "bin5", + "version": 233, + "card_co_brand": "AFTERPAY" + }, + "entry_method": "EMV" + }, + "cash_details": { + "buyer_tendered_money": {}, + "change_back_money": {} + }, + "additional_recipients": [ + { + "location_id": "location_id6", + "description": "description2", + "amount_money": {}, + "receivable_id": "receivable_id2" + } + ], + "payment_id": "payment_id3" + }, + { + "id": "id4", + "location_id": "location_id8", + "transaction_id": "transaction_id2", + "created_at": "created_at2", + "note": "note0", + "amount_money": { + "amount": 216, + "currency": "TND" + }, + "tip_money": { + "amount": 220, + "currency": "IDR" + }, + "processing_fee_money": {}, + "customer_id": "customer_id2", + "type": "CASH", + "card_details": { + "status": "VOIDED", + "card": { + "id": "id4", + "card_brand": "FELICA", + "last_4": "last_46", + "exp_month": 150, + "exp_year": 146, + "cardholder_name": "cardholder_name0", + "billing_address": { + "address_line_1": "address_line_16", + "address_line_2": "address_line_24", + "address_line_3": "address_line_30", + "locality": "locality6", + "sublocality": "sublocality4", + "sublocality_2": "sublocality_22", + "sublocality_3": "sublocality_36", + "administrative_district_level_1": "administrative_district_level_18", + "administrative_district_level_2": "administrative_district_level_20", + "administrative_district_level_3": "administrative_district_level_32", + "postal_code": "postal_code6", + "country": "RE", + "first_name": "first_name4", + "last_name": "last_name2" + }, + "fingerprint": "fingerprint0", + "customer_id": "customer_id2", + "merchant_id": "merchant_id4", + "reference_id": "reference_id8", + "enabled": false, + "card_type": "CREDIT", + "prepaid_type": "NOT_PREPAID", + "bin": "bin4", + "version": 232, + "card_co_brand": "CLEARPAY" + }, + "entry_method": "ON_FILE" + }, + "cash_details": { + "buyer_tendered_money": {}, + "change_back_money": {} + }, + "additional_recipients": [ + { + "location_id": "location_id7", + "description": "description3", + "amount_money": {}, + "receivable_id": "receivable_id3" + }, + { + "location_id": "location_id8", + "description": "description4", + "amount_money": {}, + "receivable_id": "receivable_id4" + } + ], + "payment_id": "payment_id4" + } + ], + "refunds": [ + { + "id": "id4", + "location_id": "location_id8", + "transaction_id": "transaction_id2", + "tender_id": "tender_id2", + "created_at": "created_at2", + "reason": "reason0", + "amount_money": { + "amount": 186, + "currency": "YER" + }, + "status": "PENDING", + "processing_fee_money": { + "amount": 112, + "currency": "GEL" + }, + "additional_recipients": [ + { + "location_id": "location_id7", + "description": "description3", + "amount_money": {}, + "receivable_id": "receivable_id3" + } + ] + }, + { + "id": "id5", + "location_id": "location_id9", + "transaction_id": "transaction_id3", + "tender_id": "tender_id3", + "created_at": "created_at3", + "reason": "reason9", + "amount_money": { + "amount": 187, + "currency": "ZAR" + }, + "status": "APPROVED", + "processing_fee_money": { + "amount": 113, + "currency": "GHS" + }, + "additional_recipients": [ + { + "location_id": "location_id8", + "description": "description4", + "amount_money": {}, + "receivable_id": "receivable_id4" + }, + { + "location_id": "location_id9", + "description": "description5", + "amount_money": {}, + "receivable_id": "receivable_id5" + } + ] + }, + { + "id": "id6", + "location_id": "location_id0", + "transaction_id": "transaction_id4", + "tender_id": "tender_id4", + "created_at": "created_at4", + "reason": "reason8", + "amount_money": { + "amount": 188, + "currency": "ZMK" + }, + "status": "REJECTED", + "processing_fee_money": { + "amount": 114, + "currency": "GIP" + }, + "additional_recipients": [ + { + "location_id": "location_id9", + "description": "description5", + "amount_money": {}, + "receivable_id": "receivable_id5" + }, + { + "location_id": "location_id0", + "description": "description6", + "amount_money": {}, + "receivable_id": "receivable_id6" + }, + { + "location_id": "location_id1", + "description": "description7", + "amount_money": {}, + "receivable_id": "receivable_id7" + } + ] + } + ], + "metadata": { + "key0": "metadata3", + "key1": "metadata4", + "key2": "metadata5" + }, + "created_at": "created_at2", + "updated_at": "updated_at4", + "closed_at": "closed_at2", + "state": "OPEN", + "version": 172, + "total_money": { + "amount": 250, + "currency": "UNKNOWN_CURRENCY" + }, + "total_tax_money": { + "amount": 58, + "currency": "SDG" + }, + "total_discount_money": { + "amount": 132, + "currency": "TRY" + }, + "total_tip_money": { + "amount": 216, + "currency": "KES" + }, + "total_service_charge_money": { + "amount": 62, + "currency": "NZD" + }, + "ticket_name": "ticket_name6", + "pricing_options": { + "auto_apply_discounts": false, + "auto_apply_taxes": false + }, + "rewards": [ + { + "id": "id5", + "reward_tier_id": "reward_tier_id1" + } + ], + "net_amount_due_money": { + "amount": 174, + "currency": "MKD" + } } ``` diff --git a/doc/models/pause-subscription-request.md b/doc/models/pause-subscription-request.md index 79020f20..1ce08d1b 100644 --- a/doc/models/pause-subscription-request.md +++ b/doc/models/pause-subscription-request.md @@ -22,11 +22,11 @@ Defines input parameters in a request to the ```json { - "pause_effective_date": null, - "pause_cycle_duration": null, - "resume_effective_date": null, - "resume_change_timing": null, - "pause_reason": null + "pause_effective_date": "pause_effective_date0", + "pause_cycle_duration": 86, + "resume_effective_date": "resume_effective_date2", + "resume_change_timing": "IMMEDIATE", + "pause_reason": "pause_reason8" } ``` diff --git a/doc/models/pay-order-request.md b/doc/models/pay-order-request.md index cb00dcab..e4a0b390 100644 --- a/doc/models/pay-order-request.md +++ b/doc/models/pay-order-request.md @@ -14,7 +14,7 @@ Defines the fields that are included in requests to the | --- | --- | --- | --- | | `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` | | `orderVersion` | `number \| undefined` | Optional | The version of the order being paid. If not supplied, the latest version will be paid. | -| `paymentIds` | `string[] \| undefined` | Optional | The IDs of the [payments](../../doc/models/payment.md) to collect.
The payment total must match the order total. | +| `paymentIds` | `string[] \| undefined` | Optional | The IDs of the [payments](entity:Payment) to collect.
The payment total must match the order total. | ## Example (as JSON) diff --git a/doc/models/payment-balance-activity-app-fee-refund-detail.md b/doc/models/payment-balance-activity-app-fee-refund-detail.md index b9eb37b7..a762ca34 100644 --- a/doc/models/payment-balance-activity-app-fee-refund-detail.md +++ b/doc/models/payment-balance-activity-app-fee-refund-detail.md @@ -17,9 +17,9 @@ ```json { - "payment_id": null, - "refund_id": null, - "location_id": null + "payment_id": "payment_id0", + "refund_id": "refund_id4", + "location_id": "location_id4" } ``` diff --git a/doc/models/payment-balance-activity-app-fee-revenue-detail.md b/doc/models/payment-balance-activity-app-fee-revenue-detail.md index 3f26a3a4..c71ef680 100644 --- a/doc/models/payment-balance-activity-app-fee-revenue-detail.md +++ b/doc/models/payment-balance-activity-app-fee-revenue-detail.md @@ -16,8 +16,8 @@ ```json { - "payment_id": null, - "location_id": null + "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 index 25b7e971..b786728d 100644 --- a/doc/models/payment-balance-activity-automatic-savings-detail.md +++ b/doc/models/payment-balance-activity-automatic-savings-detail.md @@ -16,8 +16,8 @@ ```json { - "payment_id": null, - "payout_id": null + "payment_id": "payment_id0", + "payout_id": "payout_id6" } ``` diff --git a/doc/models/payment-balance-activity-automatic-savings-reversed-detail.md b/doc/models/payment-balance-activity-automatic-savings-reversed-detail.md index f1362601..7a3644e7 100644 --- a/doc/models/payment-balance-activity-automatic-savings-reversed-detail.md +++ b/doc/models/payment-balance-activity-automatic-savings-reversed-detail.md @@ -16,8 +16,8 @@ ```json { - "payment_id": null, - "payout_id": null + "payment_id": "payment_id0", + "payout_id": "payout_id6" } ``` diff --git a/doc/models/payment-balance-activity-charge-detail.md b/doc/models/payment-balance-activity-charge-detail.md index 8b979d3d..a1569d4c 100644 --- a/doc/models/payment-balance-activity-charge-detail.md +++ b/doc/models/payment-balance-activity-charge-detail.md @@ -15,7 +15,7 @@ ```json { - "payment_id": null + "payment_id": "payment_id0" } ``` diff --git a/doc/models/payment-balance-activity-deposit-fee-detail.md b/doc/models/payment-balance-activity-deposit-fee-detail.md index dd337526..4edcb299 100644 --- a/doc/models/payment-balance-activity-deposit-fee-detail.md +++ b/doc/models/payment-balance-activity-deposit-fee-detail.md @@ -15,7 +15,7 @@ ```json { - "payout_id": null + "payout_id": "payout_id6" } ``` diff --git a/doc/models/payment-balance-activity-dispute-detail.md b/doc/models/payment-balance-activity-dispute-detail.md index ac7190a6..d0b32a9f 100644 --- a/doc/models/payment-balance-activity-dispute-detail.md +++ b/doc/models/payment-balance-activity-dispute-detail.md @@ -16,8 +16,8 @@ ```json { - "payment_id": null, - "dispute_id": null + "payment_id": "payment_id0", + "dispute_id": "dispute_id2" } ``` diff --git a/doc/models/payment-balance-activity-fee-detail.md b/doc/models/payment-balance-activity-fee-detail.md index 4452d223..9fb8c85c 100644 --- a/doc/models/payment-balance-activity-fee-detail.md +++ b/doc/models/payment-balance-activity-fee-detail.md @@ -15,7 +15,7 @@ ```json { - "payment_id": null + "payment_id": "payment_id0" } ``` diff --git a/doc/models/payment-balance-activity-free-processing-detail.md b/doc/models/payment-balance-activity-free-processing-detail.md index 3f05d558..e546f5a6 100644 --- a/doc/models/payment-balance-activity-free-processing-detail.md +++ b/doc/models/payment-balance-activity-free-processing-detail.md @@ -15,7 +15,7 @@ ```json { - "payment_id": null + "payment_id": "payment_id0" } ``` diff --git a/doc/models/payment-balance-activity-hold-adjustment-detail.md b/doc/models/payment-balance-activity-hold-adjustment-detail.md index 650ea17b..62ea7c20 100644 --- a/doc/models/payment-balance-activity-hold-adjustment-detail.md +++ b/doc/models/payment-balance-activity-hold-adjustment-detail.md @@ -15,7 +15,7 @@ ```json { - "payment_id": null + "payment_id": "payment_id0" } ``` diff --git a/doc/models/payment-balance-activity-open-dispute-detail.md b/doc/models/payment-balance-activity-open-dispute-detail.md index ff887154..f410b099 100644 --- a/doc/models/payment-balance-activity-open-dispute-detail.md +++ b/doc/models/payment-balance-activity-open-dispute-detail.md @@ -16,8 +16,8 @@ ```json { - "payment_id": null, - "dispute_id": null + "payment_id": "payment_id0", + "dispute_id": "dispute_id2" } ``` diff --git a/doc/models/payment-balance-activity-other-adjustment-detail.md b/doc/models/payment-balance-activity-other-adjustment-detail.md index d24b62ad..922aa377 100644 --- a/doc/models/payment-balance-activity-other-adjustment-detail.md +++ b/doc/models/payment-balance-activity-other-adjustment-detail.md @@ -15,7 +15,7 @@ ```json { - "payment_id": null + "payment_id": "payment_id0" } ``` diff --git a/doc/models/payment-balance-activity-other-detail.md b/doc/models/payment-balance-activity-other-detail.md index 87b128ee..ba34a80b 100644 --- a/doc/models/payment-balance-activity-other-detail.md +++ b/doc/models/payment-balance-activity-other-detail.md @@ -15,7 +15,7 @@ ```json { - "payment_id": null + "payment_id": "payment_id0" } ``` diff --git a/doc/models/payment-balance-activity-refund-detail.md b/doc/models/payment-balance-activity-refund-detail.md index 6d27dab5..95a47b20 100644 --- a/doc/models/payment-balance-activity-refund-detail.md +++ b/doc/models/payment-balance-activity-refund-detail.md @@ -16,8 +16,8 @@ ```json { - "payment_id": null, - "refund_id": null + "payment_id": "payment_id0", + "refund_id": "refund_id4" } ``` diff --git a/doc/models/payment-balance-activity-release-adjustment-detail.md b/doc/models/payment-balance-activity-release-adjustment-detail.md index ddf555ad..9f30c90b 100644 --- a/doc/models/payment-balance-activity-release-adjustment-detail.md +++ b/doc/models/payment-balance-activity-release-adjustment-detail.md @@ -15,7 +15,7 @@ ```json { - "payment_id": null + "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 index 5beb7ef4..3435889a 100644 --- a/doc/models/payment-balance-activity-reserve-hold-detail.md +++ b/doc/models/payment-balance-activity-reserve-hold-detail.md @@ -15,7 +15,7 @@ ```json { - "payment_id": null + "payment_id": "payment_id0" } ``` diff --git a/doc/models/payment-balance-activity-reserve-release-detail.md b/doc/models/payment-balance-activity-reserve-release-detail.md index 7fa9fccd..d8dfb464 100644 --- a/doc/models/payment-balance-activity-reserve-release-detail.md +++ b/doc/models/payment-balance-activity-reserve-release-detail.md @@ -15,7 +15,7 @@ ```json { - "payment_id": null + "payment_id": "payment_id0" } ``` diff --git a/doc/models/payment-balance-activity-square-capital-payment-detail.md b/doc/models/payment-balance-activity-square-capital-payment-detail.md index 80486c13..905cbca0 100644 --- a/doc/models/payment-balance-activity-square-capital-payment-detail.md +++ b/doc/models/payment-balance-activity-square-capital-payment-detail.md @@ -15,7 +15,7 @@ ```json { - "payment_id": null + "payment_id": "payment_id0" } ``` 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 index 701871a2..46e44811 100644 --- a/doc/models/payment-balance-activity-square-capital-reversed-payment-detail.md +++ b/doc/models/payment-balance-activity-square-capital-reversed-payment-detail.md @@ -15,7 +15,7 @@ ```json { - "payment_id": null + "payment_id": "payment_id0" } ``` diff --git a/doc/models/payment-balance-activity-tax-on-fee-detail.md b/doc/models/payment-balance-activity-tax-on-fee-detail.md index 81f31089..7713fe78 100644 --- a/doc/models/payment-balance-activity-tax-on-fee-detail.md +++ b/doc/models/payment-balance-activity-tax-on-fee-detail.md @@ -16,8 +16,8 @@ ```json { - "payment_id": null, - "tax_rate_description": null + "payment_id": "payment_id0", + "tax_rate_description": "tax_rate_description2" } ``` diff --git a/doc/models/payment-balance-activity-third-party-fee-detail.md b/doc/models/payment-balance-activity-third-party-fee-detail.md index 699cf901..20c5459d 100644 --- a/doc/models/payment-balance-activity-third-party-fee-detail.md +++ b/doc/models/payment-balance-activity-third-party-fee-detail.md @@ -15,7 +15,7 @@ ```json { - "payment_id": null + "payment_id": "payment_id0" } ``` 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 index a4c21ec5..b91281a8 100644 --- a/doc/models/payment-balance-activity-third-party-fee-refund-detail.md +++ b/doc/models/payment-balance-activity-third-party-fee-refund-detail.md @@ -16,8 +16,8 @@ ```json { - "payment_id": null, - "refund_id": null + "payment_id": "payment_id0", + "refund_id": "refund_id4" } ``` diff --git a/doc/models/payment-link-related-resources.md b/doc/models/payment-link-related-resources.md index 466ba4ba..b66d952d 100644 --- a/doc/models/payment-link-related-resources.md +++ b/doc/models/payment-link-related-resources.md @@ -16,8 +16,5162 @@ ```json { - "orders": null, - "subscription_plans": null + "orders": [ + { + "id": "id6", + "location_id": "location_id0", + "reference_id": "reference_id6", + "source": { + "name": "name8" + }, + "customer_id": "customer_id4", + "line_items": [ + { + "uid": "uid3", + "name": "name3", + "quantity": "quantity9", + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name1", + "abbreviation": "abbreviation3" + }, + "area_unit": "METRIC_SQUARE_CENTIMETER", + "length_unit": "IMPERIAL_MILE", + "volume_unit": "METRIC_MILLILITER", + "weight_unit": "IMPERIAL_POUND", + "generic_unit": "UNIT", + "time_unit": "GENERIC_HOUR", + "type": "TYPE_AREA" + }, + "precision": 217, + "catalog_object_id": "catalog_object_id7", + "catalog_version": 105 + }, + "note": "note1", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 219, + "variation_name": "variation_name3", + "item_type": "GIFT_CARD", + "metadata": { + "key0": "metadata0" + }, + "modifiers": [ + { + "uid": "uid4", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 158, + "name": "name4", + "quantity": "quantity0", + "base_price_money": { + "amount": 82, + "currency": "COP" + }, + "total_price_money": { + "amount": 80, + "currency": "PYG" + }, + "metadata": { + "key0": "metadata1" + } + } + ], + "applied_taxes": [ + { + "uid": "uid3", + "tax_uid": "tax_uid1", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid7", + "discount_uid": "discount_uid7", + "applied_money": {} + }, + { + "uid": "uid8", + "discount_uid": "discount_uid6", + "applied_money": {} + } + ], + "applied_service_charges": [ + { + "uid": "uid8", + "service_charge_uid": "service_charge_uid8", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_sales_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "pricing_blocklists": { + "blocked_discounts": [ + { + "uid": "uid6", + "discount_uid": "discount_uid2", + "discount_catalog_object_id": "discount_catalog_object_id8" + }, + { + "uid": "uid7", + "discount_uid": "discount_uid3", + "discount_catalog_object_id": "discount_catalog_object_id9" + }, + { + "uid": "uid8", + "discount_uid": "discount_uid4", + "discount_catalog_object_id": "discount_catalog_object_id0" + } + ], + "blocked_taxes": [ + { + "uid": "uid4", + "tax_uid": "tax_uid0", + "tax_catalog_object_id": "tax_catalog_object_id8" + }, + { + "uid": "uid3", + "tax_uid": "tax_uid1", + "tax_catalog_object_id": "tax_catalog_object_id7" + } + ] + }, + "total_service_charge_money": {} + } + ], + "taxes": [ + { + "uid": "uid9", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 21, + "name": "name9", + "type": "INCLUSIVE", + "percentage": "percentage7", + "metadata": { + "key0": "metadata4", + "key1": "metadata5", + "key2": "metadata6" + }, + "applied_money": {}, + "scope": "ORDER", + "auto_applied": true + }, + { + "uid": "uid0", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 20, + "name": "name0", + "type": "ADDITIVE", + "percentage": "percentage8", + "metadata": { + "key0": "metadata3", + "key1": "metadata4" + }, + "applied_money": {}, + "scope": "LINE_ITEM", + "auto_applied": false + }, + { + "uid": "uid1", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 19, + "name": "name1", + "type": "UNKNOWN_TAX", + "percentage": "percentage9", + "metadata": { + "key0": "metadata2" + }, + "applied_money": {}, + "scope": "OTHER_TAX_SCOPE", + "auto_applied": true + } + ], + "discounts": [ + { + "uid": "uid7", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 47, + "name": "name7", + "type": "FIXED_AMOUNT", + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "metadata": { + "key0": "metadata2" + }, + "scope": "OTHER_DISCOUNT_SCOPE", + "reward_ids": [ + "reward_ids4", + "reward_ids5", + "reward_ids6" + ], + "pricing_rule_id": "pricing_rule_id9" + }, + { + "uid": "uid8", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 48, + "name": "name8", + "type": "VARIABLE_PERCENTAGE", + "percentage": "percentage6", + "amount_money": {}, + "applied_money": {}, + "metadata": { + "key0": "metadata1", + "key1": "metadata0" + }, + "scope": "LINE_ITEM", + "reward_ids": [ + "reward_ids5" + ], + "pricing_rule_id": "pricing_rule_id0" + } + ], + "service_charges": [ + { + "uid": "uid7", + "name": "name7", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 13, + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_AMOUNT_PHASE", + "taxable": true, + "applied_taxes": [ + {}, + {}, + {} + ], + "metadata": { + "key0": "metadata6", + "key1": "metadata7" + }, + "type": "CUSTOM", + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "LINE_ITEM" + } + ], + "fulfillments": [ + { + "uid": "uid2", + "type": "PICKUP", + "state": "PROPOSED", + "line_item_application": "ALL", + "entries": [ + { + "uid": "uid7", + "line_item_uid": "line_item_uid7", + "quantity": "quantity3", + "metadata": { + "key0": "metadata6" + } + }, + { + "uid": "uid8", + "line_item_uid": "line_item_uid8", + "quantity": "quantity4", + "metadata": { + "key0": "metadata5", + "key1": "metadata6", + "key2": "metadata7" + } + }, + { + "uid": "uid9", + "line_item_uid": "line_item_uid9", + "quantity": "quantity5", + "metadata": { + "key0": "metadata4", + "key1": "metadata5" + } + } + ], + "metadata": { + "key0": "metadata9" + }, + "pickup_details": { + "recipient": { + "customer_id": "customer_id0", + "display_name": "display_name2", + "email_address": "email_address0", + "phone_number": "phone_number0", + "address": { + "address_line_1": "address_line_18", + "address_line_2": "address_line_28", + "address_line_3": "address_line_34", + "locality": "locality8", + "sublocality": "sublocality8", + "sublocality_2": "sublocality_26", + "sublocality_3": "sublocality_38", + "administrative_district_level_1": "administrative_district_level_12", + "administrative_district_level_2": "administrative_district_level_24", + "administrative_district_level_3": "administrative_district_level_36", + "postal_code": "postal_code0", + "country": "LS", + "first_name": "first_name8", + "last_name": "last_name6" + } + }, + "expires_at": "expires_at4", + "auto_complete_duration": "auto_complete_duration4", + "schedule_type": "SCHEDULED", + "pickup_at": "pickup_at6", + "pickup_window_duration": "pickup_window_duration0", + "prep_time_duration": "prep_time_duration2", + "note": "note6", + "placed_at": "placed_at0", + "accepted_at": "accepted_at4", + "rejected_at": "rejected_at2", + "ready_at": "ready_at0", + "expired_at": "expired_at0", + "picked_up_at": "picked_up_at0", + "canceled_at": "canceled_at6", + "cancel_reason": "cancel_reason6", + "is_curbside_pickup": false, + "curbside_pickup_details": { + "curbside_details": "curbside_details2", + "buyer_arrived_at": "buyer_arrived_at8" + } + }, + "shipment_details": { + "recipient": { + "customer_id": "customer_id4", + "display_name": "display_name6", + "email_address": "email_address4", + "phone_number": "phone_number6", + "address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_22", + "address_line_3": "address_line_38", + "locality": "locality2", + "sublocality": "sublocality2", + "sublocality_2": "sublocality_20", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_16", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_30", + "postal_code": "postal_code4", + "country": "MW", + "first_name": "first_name2", + "last_name": "last_name0" + } + }, + "carrier": "carrier6", + "shipping_note": "shipping_note0", + "shipping_type": "shipping_type2", + "tracking_number": "tracking_number2", + "tracking_url": "tracking_url4", + "placed_at": "placed_at6", + "in_progress_at": "in_progress_at0", + "packaged_at": "packaged_at8", + "expected_shipped_at": "expected_shipped_at8", + "shipped_at": "shipped_at2", + "canceled_at": "canceled_at0", + "cancel_reason": "cancel_reason0", + "failed_at": "failed_at8", + "failure_reason": "failure_reason6" + }, + "delivery_details": { + "recipient": {}, + "schedule_type": "SCHEDULED", + "placed_at": "placed_at8", + "deliver_at": "deliver_at6", + "prep_time_duration": "prep_time_duration0", + "delivery_window_duration": "delivery_window_duration2", + "note": "note4", + "completed_at": "completed_at0", + "in_progress_at": "in_progress_at4", + "rejected_at": "rejected_at0", + "ready_at": "ready_at8", + "delivered_at": "delivered_at6", + "canceled_at": "canceled_at4", + "cancel_reason": "cancel_reason4", + "courier_pickup_at": "courier_pickup_at0", + "courier_pickup_window_duration": "courier_pickup_window_duration2", + "is_no_contact_delivery": false, + "dropoff_notes": "dropoff_notes2", + "courier_provider_name": "courier_provider_name6", + "courier_support_phone_number": "courier_support_phone_number4", + "square_delivery_id": "square_delivery_id8", + "external_delivery_id": "external_delivery_id2", + "managed_delivery": false + } + }, + { + "uid": "uid3", + "type": "SHIPMENT", + "state": "RESERVED", + "line_item_application": "ENTRY_LIST", + "entries": [ + { + "uid": "uid8", + "line_item_uid": "line_item_uid8", + "quantity": "quantity4", + "metadata": { + "key0": "metadata5", + "key1": "metadata6", + "key2": "metadata7" + } + } + ], + "metadata": { + "key0": "metadata0", + "key1": "metadata9", + "key2": "metadata8" + }, + "pickup_details": { + "recipient": { + "customer_id": "customer_id1", + "display_name": "display_name3", + "email_address": "email_address1", + "phone_number": "phone_number1", + "address": { + "address_line_1": "address_line_19", + "address_line_2": "address_line_29", + "address_line_3": "address_line_35", + "locality": "locality9", + "sublocality": "sublocality9", + "sublocality_2": "sublocality_27", + "sublocality_3": "sublocality_39", + "administrative_district_level_1": "administrative_district_level_13", + "administrative_district_level_2": "administrative_district_level_25", + "administrative_district_level_3": "administrative_district_level_37", + "postal_code": "postal_code1", + "country": "LT", + "first_name": "first_name9", + "last_name": "last_name7" + } + }, + "expires_at": "expires_at5", + "auto_complete_duration": "auto_complete_duration5", + "schedule_type": "ASAP", + "pickup_at": "pickup_at7", + "pickup_window_duration": "pickup_window_duration1", + "prep_time_duration": "prep_time_duration3", + "note": "note7", + "placed_at": "placed_at1", + "accepted_at": "accepted_at5", + "rejected_at": "rejected_at3", + "ready_at": "ready_at1", + "expired_at": "expired_at1", + "picked_up_at": "picked_up_at1", + "canceled_at": "canceled_at7", + "cancel_reason": "cancel_reason7", + "is_curbside_pickup": true, + "curbside_pickup_details": { + "curbside_details": "curbside_details3", + "buyer_arrived_at": "buyer_arrived_at9" + } + }, + "shipment_details": { + "recipient": { + "customer_id": "customer_id5", + "display_name": "display_name7", + "email_address": "email_address5", + "phone_number": "phone_number5", + "address": { + "address_line_1": "address_line_13", + "address_line_2": "address_line_23", + "address_line_3": "address_line_39", + "locality": "locality3", + "sublocality": "sublocality3", + "sublocality_2": "sublocality_21", + "sublocality_3": "sublocality_33", + "administrative_district_level_1": "administrative_district_level_17", + "administrative_district_level_2": "administrative_district_level_29", + "administrative_district_level_3": "administrative_district_level_31", + "postal_code": "postal_code5", + "country": "MX", + "first_name": "first_name3", + "last_name": "last_name1" + } + }, + "carrier": "carrier7", + "shipping_note": "shipping_note1", + "shipping_type": "shipping_type1", + "tracking_number": "tracking_number3", + "tracking_url": "tracking_url5", + "placed_at": "placed_at5", + "in_progress_at": "in_progress_at9", + "packaged_at": "packaged_at9", + "expected_shipped_at": "expected_shipped_at9", + "shipped_at": "shipped_at3", + "canceled_at": "canceled_at1", + "cancel_reason": "cancel_reason1", + "failed_at": "failed_at9", + "failure_reason": "failure_reason5" + }, + "delivery_details": { + "recipient": {}, + "schedule_type": "ASAP", + "placed_at": "placed_at9", + "deliver_at": "deliver_at7", + "prep_time_duration": "prep_time_duration1", + "delivery_window_duration": "delivery_window_duration3", + "note": "note5", + "completed_at": "completed_at1", + "in_progress_at": "in_progress_at5", + "rejected_at": "rejected_at1", + "ready_at": "ready_at9", + "delivered_at": "delivered_at7", + "canceled_at": "canceled_at5", + "cancel_reason": "cancel_reason5", + "courier_pickup_at": "courier_pickup_at1", + "courier_pickup_window_duration": "courier_pickup_window_duration3", + "is_no_contact_delivery": true, + "dropoff_notes": "dropoff_notes3", + "courier_provider_name": "courier_provider_name7", + "courier_support_phone_number": "courier_support_phone_number5", + "square_delivery_id": "square_delivery_id9", + "external_delivery_id": "external_delivery_id3", + "managed_delivery": true + } + } + ], + "returns": [ + { + "uid": "uid9", + "source_order_id": "source_order_id3", + "return_line_items": [ + { + "uid": "uid6", + "source_line_item_uid": "source_line_item_uid6", + "name": "name6", + "quantity": "quantity2", + "quantity_unit": {}, + "note": "note8", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 176, + "variation_name": "variation_name6", + "item_type": "CUSTOM_AMOUNT", + "return_modifiers": [ + { + "uid": "uid5", + "source_modifier_uid": "source_modifier_uid1", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 23, + "name": "name5", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity1" + }, + { + "uid": "uid6", + "source_modifier_uid": "source_modifier_uid0", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 22, + "name": "name6", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity2" + }, + { + "uid": "uid7", + "source_modifier_uid": "source_modifier_uid9", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 21, + "name": "name7", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity3" + } + ], + "applied_taxes": [ + {}, + {}, + {} + ], + "applied_discounts": [ + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {}, + {} + ], + "total_service_charge_money": {} + } + ], + "return_service_charges": [ + { + "uid": "uid0", + "source_service_charge_uid": "source_service_charge_uid6", + "name": "name0", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 62, + "percentage": "percentage8", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_PERCENTAGE_PHASE", + "taxable": false, + "applied_taxes": [ + {} + ], + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "OTHER_SERVICE_CHARGE_SCOPE" + }, + { + "uid": "uid1", + "source_service_charge_uid": "source_service_charge_uid5", + "name": "name1", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 61, + "percentage": "percentage9", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_AMOUNT_PHASE", + "taxable": true, + "applied_taxes": [ + {}, + {} + ], + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "ORDER" + } + ], + "return_taxes": [ + { + "uid": "uid9", + "source_tax_uid": "source_tax_uid7", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 203, + "name": "name9", + "type": "ADDITIVE", + "percentage": "percentage7", + "applied_money": {}, + "scope": "LINE_ITEM" + }, + { + "uid": "uid8", + "source_tax_uid": "source_tax_uid6", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 204, + "name": "name8", + "type": "INCLUSIVE", + "percentage": "percentage6", + "applied_money": {}, + "scope": "ORDER" + }, + { + "uid": "uid7", + "source_tax_uid": "source_tax_uid5", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 205, + "name": "name7", + "type": "UNKNOWN_TAX", + "percentage": "percentage5", + "applied_money": {}, + "scope": "OTHER_TAX_SCOPE" + } + ], + "return_discounts": [ + { + "uid": "uid7", + "source_discount_uid": "source_discount_uid3", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 165, + "name": "name7", + "type": "VARIABLE_PERCENTAGE", + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "scope": "ORDER" + }, + { + "uid": "uid8", + "source_discount_uid": "source_discount_uid2", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 164, + "name": "name8", + "type": "FIXED_AMOUNT", + "percentage": "percentage6", + "amount_money": {}, + "applied_money": {}, + "scope": "LINE_ITEM" + }, + { + "uid": "uid9", + "source_discount_uid": "source_discount_uid1", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 163, + "name": "name9", + "type": "FIXED_PERCENTAGE", + "percentage": "percentage7", + "amount_money": {}, + "applied_money": {}, + "scope": "OTHER_DISCOUNT_SCOPE" + } + ], + "rounding_adjustment": { + "uid": "uid1", + "name": "name1", + "amount_money": {} + }, + "return_amounts": { + "total_money": {}, + "tax_money": {}, + "discount_money": {}, + "tip_money": {}, + "service_charge_money": {} + } + }, + { + "uid": "uid0", + "source_order_id": "source_order_id2", + "return_line_items": [ + { + "uid": "uid5", + "source_line_item_uid": "source_line_item_uid7", + "name": "name5", + "quantity": "quantity1", + "quantity_unit": {}, + "note": "note9", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 177, + "variation_name": "variation_name5", + "item_type": "ITEM", + "return_modifiers": [ + { + "uid": "uid6", + "source_modifier_uid": "source_modifier_uid0", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 22, + "name": "name6", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity2" + } + ], + "applied_taxes": [ + {}, + {} + ], + "applied_discounts": [ + {}, + {}, + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {}, + {}, + {} + ], + "total_service_charge_money": {} + }, + { + "uid": "uid4", + "source_line_item_uid": "source_line_item_uid8", + "name": "name4", + "quantity": "quantity0", + "quantity_unit": {}, + "note": "note0", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 178, + "variation_name": "variation_name4", + "item_type": "GIFT_CARD", + "return_modifiers": [ + { + "uid": "uid7", + "source_modifier_uid": "source_modifier_uid9", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 21, + "name": "name7", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity3" + }, + { + "uid": "uid8", + "source_modifier_uid": "source_modifier_uid8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 20, + "name": "name8", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity4" + } + ], + "applied_taxes": [ + {} + ], + "applied_discounts": [ + {}, + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {} + ], + "total_service_charge_money": {} + } + ], + "return_service_charges": [ + { + "uid": "uid1", + "source_service_charge_uid": "source_service_charge_uid5", + "name": "name1", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 61, + "percentage": "percentage9", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_AMOUNT_PHASE", + "taxable": true, + "applied_taxes": [ + {}, + {} + ], + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "ORDER" + }, + { + "uid": "uid2", + "source_service_charge_uid": "source_service_charge_uid4", + "name": "name2", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 60, + "percentage": "percentage0", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "SUBTOTAL_PHASE", + "taxable": false, + "applied_taxes": [ + {}, + {}, + {} + ], + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "LINE_ITEM" + }, + { + "uid": "uid3", + "source_service_charge_uid": "source_service_charge_uid3", + "name": "name3", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 59, + "percentage": "percentage1", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "TOTAL_PHASE", + "taxable": true, + "applied_taxes": [ + {} + ], + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "OTHER_SERVICE_CHARGE_SCOPE" + } + ], + "return_taxes": [ + { + "uid": "uid8", + "source_tax_uid": "source_tax_uid6", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 204, + "name": "name8", + "type": "INCLUSIVE", + "percentage": "percentage6", + "applied_money": {}, + "scope": "ORDER" + } + ], + "return_discounts": [ + { + "uid": "uid6", + "source_discount_uid": "source_discount_uid4", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 166, + "name": "name6", + "type": "VARIABLE_AMOUNT", + "percentage": "percentage4", + "amount_money": {}, + "applied_money": {}, + "scope": "OTHER_DISCOUNT_SCOPE" + }, + { + "uid": "uid7", + "source_discount_uid": "source_discount_uid3", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 165, + "name": "name7", + "type": "VARIABLE_PERCENTAGE", + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "scope": "ORDER" + } + ], + "rounding_adjustment": { + "uid": "uid2", + "name": "name2", + "amount_money": {} + }, + "return_amounts": { + "total_money": {}, + "tax_money": {}, + "discount_money": {}, + "tip_money": {}, + "service_charge_money": {} + } + }, + { + "uid": "uid1", + "source_order_id": "source_order_id1", + "return_line_items": [ + { + "uid": "uid4", + "source_line_item_uid": "source_line_item_uid8", + "name": "name4", + "quantity": "quantity0", + "quantity_unit": {}, + "note": "note0", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 178, + "variation_name": "variation_name4", + "item_type": "GIFT_CARD", + "return_modifiers": [ + { + "uid": "uid7", + "source_modifier_uid": "source_modifier_uid9", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 21, + "name": "name7", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity3" + }, + { + "uid": "uid8", + "source_modifier_uid": "source_modifier_uid8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 20, + "name": "name8", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity4" + } + ], + "applied_taxes": [ + {} + ], + "applied_discounts": [ + {}, + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {} + ], + "total_service_charge_money": {} + }, + { + "uid": "uid3", + "source_line_item_uid": "source_line_item_uid9", + "name": "name3", + "quantity": "quantity9", + "quantity_unit": {}, + "note": "note1", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 179, + "variation_name": "variation_name3", + "item_type": "CUSTOM_AMOUNT", + "return_modifiers": [ + { + "uid": "uid8", + "source_modifier_uid": "source_modifier_uid8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 20, + "name": "name8", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity4" + }, + { + "uid": "uid9", + "source_modifier_uid": "source_modifier_uid7", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 19, + "name": "name9", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity5" + }, + { + "uid": "uid0", + "source_modifier_uid": "source_modifier_uid6", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 18, + "name": "name0", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity6" + } + ], + "applied_taxes": [ + {}, + {}, + {} + ], + "applied_discounts": [ + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {}, + {} + ], + "total_service_charge_money": {} + }, + { + "uid": "uid2", + "source_line_item_uid": "source_line_item_uid0", + "name": "name2", + "quantity": "quantity8", + "quantity_unit": {}, + "note": "note2", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 180, + "variation_name": "variation_name2", + "item_type": "ITEM", + "return_modifiers": [ + { + "uid": "uid9", + "source_modifier_uid": "source_modifier_uid7", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 19, + "name": "name9", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity5" + } + ], + "applied_taxes": [ + {}, + {} + ], + "applied_discounts": [ + {}, + {}, + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {}, + {}, + {} + ], + "total_service_charge_money": {} + } + ], + "return_service_charges": [ + { + "uid": "uid2", + "source_service_charge_uid": "source_service_charge_uid4", + "name": "name2", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 60, + "percentage": "percentage0", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "SUBTOTAL_PHASE", + "taxable": false, + "applied_taxes": [ + {}, + {}, + {} + ], + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "LINE_ITEM" + } + ], + "return_taxes": [ + { + "uid": "uid7", + "source_tax_uid": "source_tax_uid5", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 205, + "name": "name7", + "type": "UNKNOWN_TAX", + "percentage": "percentage5", + "applied_money": {}, + "scope": "OTHER_TAX_SCOPE" + }, + { + "uid": "uid6", + "source_tax_uid": "source_tax_uid4", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 206, + "name": "name6", + "type": "ADDITIVE", + "percentage": "percentage4", + "applied_money": {}, + "scope": "LINE_ITEM" + } + ], + "return_discounts": [ + { + "uid": "uid5", + "source_discount_uid": "source_discount_uid5", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 167, + "name": "name5", + "type": "UNKNOWN_DISCOUNT", + "percentage": "percentage3", + "amount_money": {}, + "applied_money": {}, + "scope": "LINE_ITEM" + } + ], + "rounding_adjustment": { + "uid": "uid3", + "name": "name3", + "amount_money": {} + }, + "return_amounts": { + "total_money": {}, + "tax_money": {}, + "discount_money": {}, + "tip_money": {}, + "service_charge_money": {} + } + } + ], + "return_amounts": {}, + "net_amounts": {}, + "rounding_adjustment": {}, + "tenders": [ + { + "id": "id8", + "location_id": "location_id2", + "transaction_id": "transaction_id6", + "created_at": "created_at6", + "note": "note4", + "amount_money": {}, + "tip_money": {}, + "processing_fee_money": {}, + "customer_id": "customer_id6", + "type": "CARD", + "card_details": { + "status": "VOIDED", + "card": { + "id": "id0", + "card_brand": "INTERAC", + "last_4": "last_42", + "exp_month": 210, + "exp_year": 86, + "cardholder_name": "cardholder_name4", + "billing_address": {}, + "fingerprint": "fingerprint6", + "customer_id": "customer_id8", + "merchant_id": "merchant_id0", + "reference_id": "reference_id2", + "enabled": false, + "card_type": "UNKNOWN_CARD_TYPE", + "prepaid_type": "PREPAID", + "bin": "bin0", + "version": 84, + "card_co_brand": "AFTERPAY" + }, + "entry_method": "EMV" + }, + "cash_details": { + "buyer_tendered_money": {}, + "change_back_money": {} + }, + "additional_recipients": [ + { + "location_id": "location_id1", + "description": "description7", + "amount_money": {}, + "receivable_id": "receivable_id7" + }, + { + "location_id": "location_id2", + "description": "description8", + "amount_money": {}, + "receivable_id": "receivable_id8" + } + ], + "payment_id": "payment_id8" + }, + { + "id": "id9", + "location_id": "location_id3", + "transaction_id": "transaction_id7", + "created_at": "created_at7", + "note": "note5", + "amount_money": {}, + "tip_money": {}, + "processing_fee_money": {}, + "customer_id": "customer_id7", + "type": "CASH", + "card_details": { + "status": "CAPTURED", + "card": { + "id": "id1", + "card_brand": "SQUARE_CAPITAL_CARD", + "last_4": "last_43", + "exp_month": 209, + "exp_year": 87, + "cardholder_name": "cardholder_name3", + "billing_address": {}, + "fingerprint": "fingerprint7", + "customer_id": "customer_id9", + "merchant_id": "merchant_id1", + "reference_id": "reference_id1", + "enabled": true, + "card_type": "DEBIT", + "prepaid_type": "UNKNOWN_PREPAID_TYPE", + "bin": "bin1", + "version": 83, + "card_co_brand": "UNKNOWN" + }, + "entry_method": "ON_FILE" + }, + "cash_details": { + "buyer_tendered_money": {}, + "change_back_money": {} + }, + "additional_recipients": [ + { + "location_id": "location_id2", + "description": "description8", + "amount_money": {}, + "receivable_id": "receivable_id8" + }, + { + "location_id": "location_id3", + "description": "description9", + "amount_money": {}, + "receivable_id": "receivable_id9" + }, + { + "location_id": "location_id4", + "description": "description0", + "amount_money": {}, + "receivable_id": "receivable_id0" + } + ], + "payment_id": "payment_id9" + } + ], + "refunds": [ + { + "id": "id8", + "location_id": "location_id2", + "transaction_id": "transaction_id6", + "tender_id": "tender_id6", + "created_at": "created_at6", + "reason": "reason6", + "amount_money": {}, + "status": "REJECTED", + "processing_fee_money": {}, + "additional_recipients": [ + {}, + {} + ] + } + ], + "metadata": { + "key0": "metadata7" + }, + "created_at": "created_at4", + "updated_at": "updated_at8", + "closed_at": "closed_at8", + "state": "CANCELED", + "version": 66, + "total_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_tip_money": {}, + "total_service_charge_money": {}, + "ticket_name": "ticket_name0", + "pricing_options": { + "auto_apply_discounts": false, + "auto_apply_taxes": false + }, + "rewards": [ + { + "id": "id1", + "reward_tier_id": "reward_tier_id7" + }, + { + "id": "id2", + "reward_tier_id": "reward_tier_id8" + }, + { + "id": "id3", + "reward_tier_id": "reward_tier_id9" + } + ], + "net_amount_due_money": {} + }, + { + "id": "id7", + "location_id": "location_id1", + "reference_id": "reference_id5", + "source": { + "name": "name7" + }, + "customer_id": "customer_id5", + "line_items": [ + { + "uid": "uid2", + "name": "name2", + "quantity": "quantity8", + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name0", + "abbreviation": "abbreviation2" + }, + "area_unit": "IMPERIAL_SQUARE_MILE", + "length_unit": "METRIC_MILLIMETER", + "volume_unit": "IMPERIAL_CUBIC_YARD", + "weight_unit": "IMPERIAL_STONE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_DAY", + "type": "TYPE_LENGTH" + }, + "precision": 216, + "catalog_object_id": "catalog_object_id8", + "catalog_version": 106 + }, + "note": "note2", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 220, + "variation_name": "variation_name2", + "item_type": "CUSTOM_AMOUNT", + "metadata": { + "key0": "metadata1", + "key1": "metadata2" + }, + "modifiers": [ + { + "uid": "uid3", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 159, + "name": "name3", + "quantity": "quantity9", + "base_price_money": { + "amount": 81, + "currency": "CNY" + }, + "total_price_money": { + "amount": 79, + "currency": "PLN" + }, + "metadata": { + "key0": "metadata0", + "key1": "metadata9" + } + }, + { + "uid": "uid4", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 158, + "name": "name4", + "quantity": "quantity0", + "base_price_money": { + "amount": 82, + "currency": "COP" + }, + "total_price_money": { + "amount": 80, + "currency": "PYG" + }, + "metadata": { + "key0": "metadata1" + } + }, + { + "uid": "uid5", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 157, + "name": "name5", + "quantity": "quantity1", + "base_price_money": { + "amount": 83, + "currency": "COU" + }, + "total_price_money": { + "amount": 81, + "currency": "QAR" + }, + "metadata": { + "key0": "metadata2", + "key1": "metadata1", + "key2": "metadata0" + } + } + ], + "applied_taxes": [ + { + "uid": "uid2", + "tax_uid": "tax_uid2", + "applied_money": {} + }, + { + "uid": "uid3", + "tax_uid": "tax_uid1", + "applied_money": {} + }, + { + "uid": "uid4", + "tax_uid": "tax_uid0", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid6", + "discount_uid": "discount_uid8", + "applied_money": {} + } + ], + "applied_service_charges": [ + { + "uid": "uid9", + "service_charge_uid": "service_charge_uid9", + "applied_money": {} + }, + { + "uid": "uid0", + "service_charge_uid": "service_charge_uid0", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_sales_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "pricing_blocklists": { + "blocked_discounts": [ + { + "uid": "uid5", + "discount_uid": "discount_uid1", + "discount_catalog_object_id": "discount_catalog_object_id7" + }, + { + "uid": "uid6", + "discount_uid": "discount_uid2", + "discount_catalog_object_id": "discount_catalog_object_id8" + } + ], + "blocked_taxes": [ + { + "uid": "uid3", + "tax_uid": "tax_uid1", + "tax_catalog_object_id": "tax_catalog_object_id7" + }, + { + "uid": "uid2", + "tax_uid": "tax_uid2", + "tax_catalog_object_id": "tax_catalog_object_id6" + }, + { + "uid": "uid1", + "tax_uid": "tax_uid3", + "tax_catalog_object_id": "tax_catalog_object_id5" + } + ] + }, + "total_service_charge_money": {} + }, + { + "uid": "uid3", + "name": "name3", + "quantity": "quantity9", + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name1", + "abbreviation": "abbreviation3" + }, + "area_unit": "METRIC_SQUARE_CENTIMETER", + "length_unit": "IMPERIAL_MILE", + "volume_unit": "METRIC_MILLILITER", + "weight_unit": "IMPERIAL_POUND", + "generic_unit": "UNIT", + "time_unit": "GENERIC_HOUR", + "type": "TYPE_AREA" + }, + "precision": 217, + "catalog_object_id": "catalog_object_id7", + "catalog_version": 105 + }, + "note": "note1", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 219, + "variation_name": "variation_name3", + "item_type": "GIFT_CARD", + "metadata": { + "key0": "metadata0" + }, + "modifiers": [ + { + "uid": "uid4", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 158, + "name": "name4", + "quantity": "quantity0", + "base_price_money": { + "amount": 82, + "currency": "COP" + }, + "total_price_money": { + "amount": 80, + "currency": "PYG" + }, + "metadata": { + "key0": "metadata1" + } + } + ], + "applied_taxes": [ + { + "uid": "uid3", + "tax_uid": "tax_uid1", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid7", + "discount_uid": "discount_uid7", + "applied_money": {} + }, + { + "uid": "uid8", + "discount_uid": "discount_uid6", + "applied_money": {} + } + ], + "applied_service_charges": [ + { + "uid": "uid8", + "service_charge_uid": "service_charge_uid8", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_sales_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "pricing_blocklists": { + "blocked_discounts": [ + { + "uid": "uid6", + "discount_uid": "discount_uid2", + "discount_catalog_object_id": "discount_catalog_object_id8" + }, + { + "uid": "uid7", + "discount_uid": "discount_uid3", + "discount_catalog_object_id": "discount_catalog_object_id9" + }, + { + "uid": "uid8", + "discount_uid": "discount_uid4", + "discount_catalog_object_id": "discount_catalog_object_id0" + } + ], + "blocked_taxes": [ + { + "uid": "uid4", + "tax_uid": "tax_uid0", + "tax_catalog_object_id": "tax_catalog_object_id8" + }, + { + "uid": "uid3", + "tax_uid": "tax_uid1", + "tax_catalog_object_id": "tax_catalog_object_id7" + } + ] + }, + "total_service_charge_money": {} + }, + { + "uid": "uid4", + "name": "name4", + "quantity": "quantity0", + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name2", + "abbreviation": "abbreviation4" + }, + "area_unit": "METRIC_SQUARE_METER", + "length_unit": "IMPERIAL_YARD", + "volume_unit": "METRIC_LITER", + "weight_unit": "IMPERIAL_WEIGHT_OUNCE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MINUTE", + "type": "TYPE_CUSTOM" + }, + "precision": 218, + "catalog_object_id": "catalog_object_id6", + "catalog_version": 104 + }, + "note": "note0", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 218, + "variation_name": "variation_name4", + "item_type": "ITEM", + "metadata": { + "key0": "metadata9", + "key1": "metadata0", + "key2": "metadata1" + }, + "modifiers": [ + { + "uid": "uid5", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 157, + "name": "name5", + "quantity": "quantity1", + "base_price_money": { + "amount": 83, + "currency": "COU" + }, + "total_price_money": { + "amount": 81, + "currency": "QAR" + }, + "metadata": { + "key0": "metadata2", + "key1": "metadata1", + "key2": "metadata0" + } + }, + { + "uid": "uid6", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 156, + "name": "name6", + "quantity": "quantity2", + "base_price_money": { + "amount": 84, + "currency": "CRC" + }, + "total_price_money": { + "amount": 82, + "currency": "RON" + }, + "metadata": { + "key0": "metadata3", + "key1": "metadata2" + } + } + ], + "applied_taxes": [ + { + "uid": "uid4", + "tax_uid": "tax_uid0", + "applied_money": {} + }, + { + "uid": "uid5", + "tax_uid": "tax_uid9", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid8", + "discount_uid": "discount_uid6", + "applied_money": {} + }, + { + "uid": "uid9", + "discount_uid": "discount_uid5", + "applied_money": {} + }, + { + "uid": "uid0", + "discount_uid": "discount_uid4", + "applied_money": {} + } + ], + "applied_service_charges": [ + { + "uid": "uid7", + "service_charge_uid": "service_charge_uid7", + "applied_money": {} + }, + { + "uid": "uid8", + "service_charge_uid": "service_charge_uid8", + "applied_money": {} + }, + { + "uid": "uid9", + "service_charge_uid": "service_charge_uid9", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_sales_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "pricing_blocklists": { + "blocked_discounts": [ + { + "uid": "uid7", + "discount_uid": "discount_uid3", + "discount_catalog_object_id": "discount_catalog_object_id9" + } + ], + "blocked_taxes": [ + { + "uid": "uid5", + "tax_uid": "tax_uid9", + "tax_catalog_object_id": "tax_catalog_object_id9" + } + ] + }, + "total_service_charge_money": {} + } + ], + "taxes": [ + { + "uid": "uid8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 22, + "name": "name8", + "type": "UNKNOWN_TAX", + "percentage": "percentage6", + "metadata": { + "key0": "metadata5" + }, + "applied_money": {}, + "scope": "OTHER_TAX_SCOPE", + "auto_applied": false + }, + { + "uid": "uid9", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 21, + "name": "name9", + "type": "INCLUSIVE", + "percentage": "percentage7", + "metadata": { + "key0": "metadata4", + "key1": "metadata5", + "key2": "metadata6" + }, + "applied_money": {}, + "scope": "ORDER", + "auto_applied": true + } + ], + "discounts": [ + { + "uid": "uid8", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 48, + "name": "name8", + "type": "VARIABLE_PERCENTAGE", + "percentage": "percentage6", + "amount_money": {}, + "applied_money": {}, + "metadata": { + "key0": "metadata1", + "key1": "metadata0" + }, + "scope": "LINE_ITEM", + "reward_ids": [ + "reward_ids5" + ], + "pricing_rule_id": "pricing_rule_id0" + }, + { + "uid": "uid9", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 49, + "name": "name9", + "type": "VARIABLE_AMOUNT", + "percentage": "percentage7", + "amount_money": {}, + "applied_money": {}, + "metadata": { + "key0": "metadata0", + "key1": "metadata9", + "key2": "metadata8" + }, + "scope": "ORDER", + "reward_ids": [ + "reward_ids6", + "reward_ids7" + ], + "pricing_rule_id": "pricing_rule_id1" + }, + { + "uid": "uid0", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 50, + "name": "name0", + "type": "UNKNOWN_DISCOUNT", + "percentage": "percentage8", + "amount_money": {}, + "applied_money": {}, + "metadata": { + "key0": "metadata9" + }, + "scope": "OTHER_DISCOUNT_SCOPE", + "reward_ids": [ + "reward_ids7", + "reward_ids8", + "reward_ids9" + ], + "pricing_rule_id": "pricing_rule_id2" + } + ], + "service_charges": [ + { + "uid": "uid8", + "name": "name8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 12, + "percentage": "percentage6", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "SUBTOTAL_PHASE", + "taxable": false, + "applied_taxes": [ + {} + ], + "metadata": { + "key0": "metadata5" + }, + "type": "AUTO_GRATUITY", + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "OTHER_SERVICE_CHARGE_SCOPE" + }, + { + "uid": "uid7", + "name": "name7", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 13, + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_AMOUNT_PHASE", + "taxable": true, + "applied_taxes": [ + {}, + {}, + {} + ], + "metadata": { + "key0": "metadata6", + "key1": "metadata7" + }, + "type": "CUSTOM", + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "LINE_ITEM" + }, + { + "uid": "uid6", + "name": "name6", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 14, + "percentage": "percentage4", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_PERCENTAGE_PHASE", + "taxable": false, + "applied_taxes": [ + {}, + {} + ], + "metadata": { + "key0": "metadata7", + "key1": "metadata8", + "key2": "metadata9" + }, + "type": "AUTO_GRATUITY", + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "ORDER" + } + ], + "fulfillments": [ + { + "uid": "uid3", + "type": "SHIPMENT", + "state": "RESERVED", + "line_item_application": "ENTRY_LIST", + "entries": [ + { + "uid": "uid8", + "line_item_uid": "line_item_uid8", + "quantity": "quantity4", + "metadata": { + "key0": "metadata5", + "key1": "metadata6", + "key2": "metadata7" + } + } + ], + "metadata": { + "key0": "metadata0", + "key1": "metadata9", + "key2": "metadata8" + }, + "pickup_details": { + "recipient": { + "customer_id": "customer_id1", + "display_name": "display_name3", + "email_address": "email_address1", + "phone_number": "phone_number1", + "address": { + "address_line_1": "address_line_19", + "address_line_2": "address_line_29", + "address_line_3": "address_line_35", + "locality": "locality9", + "sublocality": "sublocality9", + "sublocality_2": "sublocality_27", + "sublocality_3": "sublocality_39", + "administrative_district_level_1": "administrative_district_level_13", + "administrative_district_level_2": "administrative_district_level_25", + "administrative_district_level_3": "administrative_district_level_37", + "postal_code": "postal_code1", + "country": "LT", + "first_name": "first_name9", + "last_name": "last_name7" + } + }, + "expires_at": "expires_at5", + "auto_complete_duration": "auto_complete_duration5", + "schedule_type": "ASAP", + "pickup_at": "pickup_at7", + "pickup_window_duration": "pickup_window_duration1", + "prep_time_duration": "prep_time_duration3", + "note": "note7", + "placed_at": "placed_at1", + "accepted_at": "accepted_at5", + "rejected_at": "rejected_at3", + "ready_at": "ready_at1", + "expired_at": "expired_at1", + "picked_up_at": "picked_up_at1", + "canceled_at": "canceled_at7", + "cancel_reason": "cancel_reason7", + "is_curbside_pickup": true, + "curbside_pickup_details": { + "curbside_details": "curbside_details3", + "buyer_arrived_at": "buyer_arrived_at9" + } + }, + "shipment_details": { + "recipient": { + "customer_id": "customer_id5", + "display_name": "display_name7", + "email_address": "email_address5", + "phone_number": "phone_number5", + "address": { + "address_line_1": "address_line_13", + "address_line_2": "address_line_23", + "address_line_3": "address_line_39", + "locality": "locality3", + "sublocality": "sublocality3", + "sublocality_2": "sublocality_21", + "sublocality_3": "sublocality_33", + "administrative_district_level_1": "administrative_district_level_17", + "administrative_district_level_2": "administrative_district_level_29", + "administrative_district_level_3": "administrative_district_level_31", + "postal_code": "postal_code5", + "country": "MX", + "first_name": "first_name3", + "last_name": "last_name1" + } + }, + "carrier": "carrier7", + "shipping_note": "shipping_note1", + "shipping_type": "shipping_type1", + "tracking_number": "tracking_number3", + "tracking_url": "tracking_url5", + "placed_at": "placed_at5", + "in_progress_at": "in_progress_at9", + "packaged_at": "packaged_at9", + "expected_shipped_at": "expected_shipped_at9", + "shipped_at": "shipped_at3", + "canceled_at": "canceled_at1", + "cancel_reason": "cancel_reason1", + "failed_at": "failed_at9", + "failure_reason": "failure_reason5" + }, + "delivery_details": { + "recipient": {}, + "schedule_type": "ASAP", + "placed_at": "placed_at9", + "deliver_at": "deliver_at7", + "prep_time_duration": "prep_time_duration1", + "delivery_window_duration": "delivery_window_duration3", + "note": "note5", + "completed_at": "completed_at1", + "in_progress_at": "in_progress_at5", + "rejected_at": "rejected_at1", + "ready_at": "ready_at9", + "delivered_at": "delivered_at7", + "canceled_at": "canceled_at5", + "cancel_reason": "cancel_reason5", + "courier_pickup_at": "courier_pickup_at1", + "courier_pickup_window_duration": "courier_pickup_window_duration3", + "is_no_contact_delivery": true, + "dropoff_notes": "dropoff_notes3", + "courier_provider_name": "courier_provider_name7", + "courier_support_phone_number": "courier_support_phone_number5", + "square_delivery_id": "square_delivery_id9", + "external_delivery_id": "external_delivery_id3", + "managed_delivery": true + } + }, + { + "uid": "uid4", + "type": "DELIVERY", + "state": "PREPARED", + "line_item_application": "ALL", + "entries": [ + { + "uid": "uid9", + "line_item_uid": "line_item_uid9", + "quantity": "quantity5", + "metadata": { + "key0": "metadata4", + "key1": "metadata5" + } + }, + { + "uid": "uid0", + "line_item_uid": "line_item_uid0", + "quantity": "quantity6", + "metadata": { + "key0": "metadata3" + } + } + ], + "metadata": { + "key0": "metadata1", + "key1": "metadata0" + }, + "pickup_details": { + "recipient": { + "customer_id": "customer_id2", + "display_name": "display_name4", + "email_address": "email_address2", + "phone_number": "phone_number2", + "address": { + "address_line_1": "address_line_10", + "address_line_2": "address_line_20", + "address_line_3": "address_line_36", + "locality": "locality0", + "sublocality": "sublocality0", + "sublocality_2": "sublocality_28", + "sublocality_3": "sublocality_30", + "administrative_district_level_1": "administrative_district_level_14", + "administrative_district_level_2": "administrative_district_level_26", + "administrative_district_level_3": "administrative_district_level_38", + "postal_code": "postal_code2", + "country": "LU", + "first_name": "first_name0", + "last_name": "last_name8" + } + }, + "expires_at": "expires_at6", + "auto_complete_duration": "auto_complete_duration6", + "schedule_type": "SCHEDULED", + "pickup_at": "pickup_at8", + "pickup_window_duration": "pickup_window_duration2", + "prep_time_duration": "prep_time_duration4", + "note": "note8", + "placed_at": "placed_at2", + "accepted_at": "accepted_at6", + "rejected_at": "rejected_at4", + "ready_at": "ready_at2", + "expired_at": "expired_at2", + "picked_up_at": "picked_up_at2", + "canceled_at": "canceled_at8", + "cancel_reason": "cancel_reason8", + "is_curbside_pickup": false, + "curbside_pickup_details": { + "curbside_details": "curbside_details4", + "buyer_arrived_at": "buyer_arrived_at0" + } + }, + "shipment_details": { + "recipient": { + "customer_id": "customer_id6", + "display_name": "display_name8", + "email_address": "email_address6", + "phone_number": "phone_number4", + "address": { + "address_line_1": "address_line_14", + "address_line_2": "address_line_24", + "address_line_3": "address_line_30", + "locality": "locality4", + "sublocality": "sublocality4", + "sublocality_2": "sublocality_22", + "sublocality_3": "sublocality_34", + "administrative_district_level_1": "administrative_district_level_18", + "administrative_district_level_2": "administrative_district_level_20", + "administrative_district_level_3": "administrative_district_level_32", + "postal_code": "postal_code6", + "country": "MY", + "first_name": "first_name4", + "last_name": "last_name2" + } + }, + "carrier": "carrier8", + "shipping_note": "shipping_note2", + "shipping_type": "shipping_type0", + "tracking_number": "tracking_number4", + "tracking_url": "tracking_url6", + "placed_at": "placed_at4", + "in_progress_at": "in_progress_at8", + "packaged_at": "packaged_at0", + "expected_shipped_at": "expected_shipped_at0", + "shipped_at": "shipped_at4", + "canceled_at": "canceled_at2", + "cancel_reason": "cancel_reason2", + "failed_at": "failed_at0", + "failure_reason": "failure_reason4" + }, + "delivery_details": { + "recipient": {}, + "schedule_type": "SCHEDULED", + "placed_at": "placed_at0", + "deliver_at": "deliver_at8", + "prep_time_duration": "prep_time_duration2", + "delivery_window_duration": "delivery_window_duration4", + "note": "note6", + "completed_at": "completed_at2", + "in_progress_at": "in_progress_at6", + "rejected_at": "rejected_at2", + "ready_at": "ready_at0", + "delivered_at": "delivered_at8", + "canceled_at": "canceled_at6", + "cancel_reason": "cancel_reason6", + "courier_pickup_at": "courier_pickup_at2", + "courier_pickup_window_duration": "courier_pickup_window_duration4", + "is_no_contact_delivery": false, + "dropoff_notes": "dropoff_notes4", + "courier_provider_name": "courier_provider_name8", + "courier_support_phone_number": "courier_support_phone_number6", + "square_delivery_id": "square_delivery_id0", + "external_delivery_id": "external_delivery_id4", + "managed_delivery": false + } + }, + { + "uid": "uid5", + "type": "PICKUP", + "state": "COMPLETED", + "line_item_application": "ENTRY_LIST", + "entries": [ + { + "uid": "uid0", + "line_item_uid": "line_item_uid0", + "quantity": "quantity6", + "metadata": { + "key0": "metadata3" + } + }, + { + "uid": "uid1", + "line_item_uid": "line_item_uid1", + "quantity": "quantity7", + "metadata": { + "key0": "metadata2", + "key1": "metadata3", + "key2": "metadata4" + } + }, + { + "uid": "uid2", + "line_item_uid": "line_item_uid2", + "quantity": "quantity8", + "metadata": { + "key0": "metadata1", + "key1": "metadata2" + } + } + ], + "metadata": { + "key0": "metadata2" + }, + "pickup_details": { + "recipient": { + "customer_id": "customer_id3", + "display_name": "display_name5", + "email_address": "email_address3", + "phone_number": "phone_number3", + "address": { + "address_line_1": "address_line_11", + "address_line_2": "address_line_21", + "address_line_3": "address_line_37", + "locality": "locality1", + "sublocality": "sublocality1", + "sublocality_2": "sublocality_29", + "sublocality_3": "sublocality_31", + "administrative_district_level_1": "administrative_district_level_15", + "administrative_district_level_2": "administrative_district_level_27", + "administrative_district_level_3": "administrative_district_level_39", + "postal_code": "postal_code3", + "country": "LV", + "first_name": "first_name1", + "last_name": "last_name9" + } + }, + "expires_at": "expires_at7", + "auto_complete_duration": "auto_complete_duration7", + "schedule_type": "ASAP", + "pickup_at": "pickup_at9", + "pickup_window_duration": "pickup_window_duration3", + "prep_time_duration": "prep_time_duration5", + "note": "note9", + "placed_at": "placed_at3", + "accepted_at": "accepted_at7", + "rejected_at": "rejected_at5", + "ready_at": "ready_at3", + "expired_at": "expired_at3", + "picked_up_at": "picked_up_at3", + "canceled_at": "canceled_at9", + "cancel_reason": "cancel_reason9", + "is_curbside_pickup": true, + "curbside_pickup_details": { + "curbside_details": "curbside_details5", + "buyer_arrived_at": "buyer_arrived_at1" + } + }, + "shipment_details": { + "recipient": { + "customer_id": "customer_id7", + "display_name": "display_name9", + "email_address": "email_address7", + "phone_number": "phone_number3", + "address": { + "address_line_1": "address_line_15", + "address_line_2": "address_line_25", + "address_line_3": "address_line_31", + "locality": "locality5", + "sublocality": "sublocality5", + "sublocality_2": "sublocality_23", + "sublocality_3": "sublocality_35", + "administrative_district_level_1": "administrative_district_level_19", + "administrative_district_level_2": "administrative_district_level_21", + "administrative_district_level_3": "administrative_district_level_33", + "postal_code": "postal_code7", + "country": "MZ", + "first_name": "first_name5", + "last_name": "last_name3" + } + }, + "carrier": "carrier9", + "shipping_note": "shipping_note3", + "shipping_type": "shipping_type9", + "tracking_number": "tracking_number5", + "tracking_url": "tracking_url7", + "placed_at": "placed_at3", + "in_progress_at": "in_progress_at7", + "packaged_at": "packaged_at1", + "expected_shipped_at": "expected_shipped_at1", + "shipped_at": "shipped_at5", + "canceled_at": "canceled_at3", + "cancel_reason": "cancel_reason3", + "failed_at": "failed_at1", + "failure_reason": "failure_reason3" + }, + "delivery_details": { + "recipient": {}, + "schedule_type": "ASAP", + "placed_at": "placed_at1", + "deliver_at": "deliver_at9", + "prep_time_duration": "prep_time_duration3", + "delivery_window_duration": "delivery_window_duration5", + "note": "note7", + "completed_at": "completed_at3", + "in_progress_at": "in_progress_at7", + "rejected_at": "rejected_at3", + "ready_at": "ready_at1", + "delivered_at": "delivered_at9", + "canceled_at": "canceled_at7", + "cancel_reason": "cancel_reason7", + "courier_pickup_at": "courier_pickup_at3", + "courier_pickup_window_duration": "courier_pickup_window_duration5", + "is_no_contact_delivery": true, + "dropoff_notes": "dropoff_notes5", + "courier_provider_name": "courier_provider_name9", + "courier_support_phone_number": "courier_support_phone_number7", + "square_delivery_id": "square_delivery_id1", + "external_delivery_id": "external_delivery_id5", + "managed_delivery": true + } + } + ], + "returns": [ + { + "uid": "uid0", + "source_order_id": "source_order_id2", + "return_line_items": [ + { + "uid": "uid5", + "source_line_item_uid": "source_line_item_uid7", + "name": "name5", + "quantity": "quantity1", + "quantity_unit": {}, + "note": "note9", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 177, + "variation_name": "variation_name5", + "item_type": "ITEM", + "return_modifiers": [ + { + "uid": "uid6", + "source_modifier_uid": "source_modifier_uid0", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 22, + "name": "name6", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity2" + } + ], + "applied_taxes": [ + {}, + {} + ], + "applied_discounts": [ + {}, + {}, + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {}, + {}, + {} + ], + "total_service_charge_money": {} + }, + { + "uid": "uid4", + "source_line_item_uid": "source_line_item_uid8", + "name": "name4", + "quantity": "quantity0", + "quantity_unit": {}, + "note": "note0", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 178, + "variation_name": "variation_name4", + "item_type": "GIFT_CARD", + "return_modifiers": [ + { + "uid": "uid7", + "source_modifier_uid": "source_modifier_uid9", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 21, + "name": "name7", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity3" + }, + { + "uid": "uid8", + "source_modifier_uid": "source_modifier_uid8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 20, + "name": "name8", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity4" + } + ], + "applied_taxes": [ + {} + ], + "applied_discounts": [ + {}, + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {} + ], + "total_service_charge_money": {} + } + ], + "return_service_charges": [ + { + "uid": "uid1", + "source_service_charge_uid": "source_service_charge_uid5", + "name": "name1", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 61, + "percentage": "percentage9", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_AMOUNT_PHASE", + "taxable": true, + "applied_taxes": [ + {}, + {} + ], + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "ORDER" + }, + { + "uid": "uid2", + "source_service_charge_uid": "source_service_charge_uid4", + "name": "name2", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 60, + "percentage": "percentage0", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "SUBTOTAL_PHASE", + "taxable": false, + "applied_taxes": [ + {}, + {}, + {} + ], + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "LINE_ITEM" + }, + { + "uid": "uid3", + "source_service_charge_uid": "source_service_charge_uid3", + "name": "name3", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 59, + "percentage": "percentage1", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "TOTAL_PHASE", + "taxable": true, + "applied_taxes": [ + {} + ], + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "OTHER_SERVICE_CHARGE_SCOPE" + } + ], + "return_taxes": [ + { + "uid": "uid8", + "source_tax_uid": "source_tax_uid6", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 204, + "name": "name8", + "type": "INCLUSIVE", + "percentage": "percentage6", + "applied_money": {}, + "scope": "ORDER" + } + ], + "return_discounts": [ + { + "uid": "uid6", + "source_discount_uid": "source_discount_uid4", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 166, + "name": "name6", + "type": "VARIABLE_AMOUNT", + "percentage": "percentage4", + "amount_money": {}, + "applied_money": {}, + "scope": "OTHER_DISCOUNT_SCOPE" + }, + { + "uid": "uid7", + "source_discount_uid": "source_discount_uid3", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 165, + "name": "name7", + "type": "VARIABLE_PERCENTAGE", + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "scope": "ORDER" + } + ], + "rounding_adjustment": { + "uid": "uid2", + "name": "name2", + "amount_money": {} + }, + "return_amounts": { + "total_money": {}, + "tax_money": {}, + "discount_money": {}, + "tip_money": {}, + "service_charge_money": {} + } + } + ], + "return_amounts": {}, + "net_amounts": {}, + "rounding_adjustment": {}, + "tenders": [ + { + "id": "id9", + "location_id": "location_id3", + "transaction_id": "transaction_id7", + "created_at": "created_at7", + "note": "note5", + "amount_money": {}, + "tip_money": {}, + "processing_fee_money": {}, + "customer_id": "customer_id7", + "type": "CASH", + "card_details": { + "status": "CAPTURED", + "card": { + "id": "id1", + "card_brand": "SQUARE_CAPITAL_CARD", + "last_4": "last_43", + "exp_month": 209, + "exp_year": 87, + "cardholder_name": "cardholder_name3", + "billing_address": {}, + "fingerprint": "fingerprint7", + "customer_id": "customer_id9", + "merchant_id": "merchant_id1", + "reference_id": "reference_id1", + "enabled": true, + "card_type": "DEBIT", + "prepaid_type": "UNKNOWN_PREPAID_TYPE", + "bin": "bin1", + "version": 83, + "card_co_brand": "UNKNOWN" + }, + "entry_method": "ON_FILE" + }, + "cash_details": { + "buyer_tendered_money": {}, + "change_back_money": {} + }, + "additional_recipients": [ + { + "location_id": "location_id2", + "description": "description8", + "amount_money": {}, + "receivable_id": "receivable_id8" + }, + { + "location_id": "location_id3", + "description": "description9", + "amount_money": {}, + "receivable_id": "receivable_id9" + }, + { + "location_id": "location_id4", + "description": "description0", + "amount_money": {}, + "receivable_id": "receivable_id0" + } + ], + "payment_id": "payment_id9" + }, + { + "id": "id0", + "location_id": "location_id4", + "transaction_id": "transaction_id8", + "created_at": "created_at8", + "note": "note6", + "amount_money": {}, + "tip_money": {}, + "processing_fee_money": {}, + "customer_id": "customer_id8", + "type": "THIRD_PARTY_CARD", + "card_details": { + "status": "AUTHORIZED", + "card": { + "id": "id2", + "card_brand": "SQUARE_GIFT_CARD", + "last_4": "last_44", + "exp_month": 208, + "exp_year": 88, + "cardholder_name": "cardholder_name2", + "billing_address": {}, + "fingerprint": "fingerprint8", + "customer_id": "customer_id0", + "merchant_id": "merchant_id2", + "reference_id": "reference_id0", + "enabled": false, + "card_type": "CREDIT", + "prepaid_type": "NOT_PREPAID", + "bin": "bin2", + "version": 82, + "card_co_brand": "CLEARPAY" + }, + "entry_method": "CONTACTLESS" + }, + "cash_details": { + "buyer_tendered_money": {}, + "change_back_money": {} + }, + "additional_recipients": [ + { + "location_id": "location_id3", + "description": "description9", + "amount_money": {}, + "receivable_id": "receivable_id9" + } + ], + "payment_id": "payment_id0" + }, + { + "id": "id1", + "location_id": "location_id5", + "transaction_id": "transaction_id9", + "created_at": "created_at9", + "note": "note7", + "amount_money": {}, + "tip_money": {}, + "processing_fee_money": {}, + "customer_id": "customer_id9", + "type": "SQUARE_GIFT_CARD", + "card_details": { + "status": "FAILED", + "card": { + "id": "id3", + "card_brand": "CHINA_UNIONPAY", + "last_4": "last_45", + "exp_month": 207, + "exp_year": 89, + "cardholder_name": "cardholder_name1", + "billing_address": {}, + "fingerprint": "fingerprint9", + "customer_id": "customer_id1", + "merchant_id": "merchant_id3", + "reference_id": "reference_id9", + "enabled": true, + "card_type": "UNKNOWN_CARD_TYPE", + "prepaid_type": "PREPAID", + "bin": "bin3", + "version": 81, + "card_co_brand": "AFTERPAY" + }, + "entry_method": "SWIPED" + }, + "cash_details": { + "buyer_tendered_money": {}, + "change_back_money": {} + }, + "additional_recipients": [ + { + "location_id": "location_id4", + "description": "description0", + "amount_money": {}, + "receivable_id": "receivable_id0" + }, + { + "location_id": "location_id5", + "description": "description1", + "amount_money": {}, + "receivable_id": "receivable_id1" + } + ], + "payment_id": "payment_id1" + } + ], + "refunds": [ + { + "id": "id7", + "location_id": "location_id1", + "transaction_id": "transaction_id5", + "tender_id": "tender_id5", + "created_at": "created_at5", + "reason": "reason7", + "amount_money": {}, + "status": "FAILED", + "processing_fee_money": {}, + "additional_recipients": [ + {} + ] + }, + { + "id": "id8", + "location_id": "location_id2", + "transaction_id": "transaction_id6", + "tender_id": "tender_id6", + "created_at": "created_at6", + "reason": "reason6", + "amount_money": {}, + "status": "REJECTED", + "processing_fee_money": {}, + "additional_recipients": [ + {}, + {} + ] + }, + { + "id": "id9", + "location_id": "location_id3", + "transaction_id": "transaction_id7", + "tender_id": "tender_id7", + "created_at": "created_at7", + "reason": "reason5", + "amount_money": {}, + "status": "APPROVED", + "processing_fee_money": {}, + "additional_recipients": [ + {}, + {}, + {} + ] + } + ], + "metadata": { + "key0": "metadata6", + "key1": "metadata7", + "key2": "metadata8" + }, + "created_at": "created_at5", + "updated_at": "updated_at7", + "closed_at": "closed_at9", + "state": "COMPLETED", + "version": 67, + "total_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_tip_money": {}, + "total_service_charge_money": {}, + "ticket_name": "ticket_name9", + "pricing_options": { + "auto_apply_discounts": true, + "auto_apply_taxes": true + }, + "rewards": [ + { + "id": "id2", + "reward_tier_id": "reward_tier_id8" + } + ], + "net_amount_due_money": {} + } + ], + "subscription_plans": [ + { + "type": "QUICK_AMOUNTS_SETTINGS", + "id": "id6", + "updated_at": "updated_at2", + "version": 126, + "is_deleted": false, + "custom_attribute_values": { + "key0": { + "name": "name7", + "string_value": "string_value1", + "custom_attribute_definition_id": "custom_attribute_definition_id5", + "type": "BOOLEAN", + "number_value": "number_value7", + "boolean_value": true, + "selection_uid_values": [ + "selection_uid_values4" + ], + "key": "key7" + } + }, + "catalog_v1_ids": [ + { + "catalog_v1_id": "catalog_v1_id0", + "location_id": "location_id0" + }, + { + "catalog_v1_id": "catalog_v1_id1", + "location_id": "location_id1" + } + ], + "present_at_all_locations": false, + "present_at_location_ids": [ + "present_at_location_ids6" + ], + "absent_at_location_ids": [ + "absent_at_location_ids7", + "absent_at_location_ids8" + ], + "item_data": { + "name": "name2", + "description": "description2", + "abbreviation": "abbreviation4", + "label_color": "label_color4", + "available_online": false, + "available_for_pickup": false, + "available_electronically": false, + "category_id": "category_id6", + "tax_ids": [ + "tax_ids5", + "tax_ids6", + "tax_ids7" + ], + "modifier_list_info": [ + { + "modifier_list_id": "modifier_list_id2", + "modifier_overrides": [ + { + "modifier_id": "modifier_id5", + "on_by_default": true + }, + { + "modifier_id": "modifier_id6", + "on_by_default": false + } + ], + "min_selected_modifiers": 34, + "max_selected_modifiers": 14, + "enabled": false + }, + { + "modifier_list_id": "modifier_list_id3", + "modifier_overrides": [ + { + "modifier_id": "modifier_id6", + "on_by_default": false + }, + { + "modifier_id": "modifier_id7", + "on_by_default": true + }, + { + "modifier_id": "modifier_id8", + "on_by_default": false + } + ], + "min_selected_modifiers": 35, + "max_selected_modifiers": 15, + "enabled": true + }, + { + "modifier_list_id": "modifier_list_id4", + "modifier_overrides": [ + { + "modifier_id": "modifier_id7", + "on_by_default": true + } + ], + "min_selected_modifiers": 36, + "max_selected_modifiers": 16, + "enabled": false + } + ], + "variations": [ + { + "type": "PRICING_RULE", + "id": "id5", + "updated_at": "updated_at9", + "version": 229, + "is_deleted": true, + "custom_attribute_values": { + "key0": {} + }, + "catalog_v1_ids": [ + {}, + {} + ], + "present_at_all_locations": true, + "present_at_location_ids": [ + "present_at_location_ids5" + ], + "absent_at_location_ids": [ + "absent_at_location_ids6", + "absent_at_location_ids7" + ], + "item_data": { + "name": "name3", + "description": "description3", + "abbreviation": "abbreviation5", + "label_color": "label_color5", + "available_online": true, + "available_for_pickup": true, + "available_electronically": true, + "category_id": "category_id5", + "tax_ids": [ + "tax_ids6", + "tax_ids5", + "tax_ids4" + ], + "modifier_list_info": [ + {}, + {}, + {} + ], + "variations": [ + {}, + {} + ], + "product_type": "GIFT_CARD", + "skip_modifier_screen": true, + "item_options": [ + { + "item_option_id": "item_option_id8" + }, + { + "item_option_id": "item_option_id7" + } + ], + "image_ids": [ + "image_ids2", + "image_ids1", + "image_ids0" + ], + "sort_name": "sort_name5", + "description_html": "description_html3", + "description_plaintext": "description_plaintext3" + }, + "category_data": { + "name": "name9", + "image_ids": [ + "image_ids4" + ] + }, + "item_variation_data": { + "item_id": "item_id9", + "name": "name1", + "sku": "sku3", + "upc": "upc1", + "ordinal": 23, + "pricing_type": "VARIABLE_PRICING", + "price_money": { + "amount": 3, + "currency": "MXN" + }, + "location_overrides": [ + { + "location_id": "location_id6", + "price_money": { + "amount": 98, + "currency": "UGX" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 218, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until0" + } + ], + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 231, + "user_data": "user_data5", + "service_duration": 113, + "available_for_booking": true, + "item_option_values": [ + { + "item_option_id": "item_option_id0", + "item_option_value_id": "item_option_value_id2" + }, + { + "item_option_id": "item_option_id1", + "item_option_value_id": "item_option_value_id1" + } + ], + "measurement_unit_id": "measurement_unit_id9", + "sellable": true, + "stockable": true, + "image_ids": [ + "image_ids4", + "image_ids5" + ], + "team_member_ids": [ + "team_member_ids8", + "team_member_ids9", + "team_member_ids0" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id1", + "stockable_quantity": "stockable_quantity1", + "nonstockable_quantity": "nonstockable_quantity3" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids0", + "item_variation_vendor_info_ids1" + ] + }, + "tax_data": { + "name": "name1", + "calculation_phase": "TAX_TOTAL_PHASE", + "inclusion_type": "INCLUSIVE", + "percentage": "percentage9", + "applies_to_custom_amounts": true, + "enabled": true + }, + "discount_data": { + "name": "name7", + "discount_type": "FIXED_AMOUNT", + "percentage": "percentage5", + "amount_money": {}, + "pin_required": true, + "label_color": "label_color9", + "modify_tax_basis": "DO_NOT_MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name1", + "ordinal": 41, + "selection_type": "MULTIPLE", + "modifiers": [ + {}, + {}, + {} + ], + "image_ids": [ + "image_ids4", + "image_ids3", + "image_ids2" + ] + }, + "modifier_data": { + "name": "name7", + "price_money": {}, + "ordinal": 19, + "modifier_list_id": "modifier_list_id3", + "image_id": "image_id1" + }, + "time_period_data": { + "event": "event1" + }, + "product_set_data": { + "name": "name3", + "product_ids_any": [ + "product_ids_any5", + "product_ids_any4" + ], + "product_ids_all": [ + "product_ids_all4", + "product_ids_all3" + ], + "quantity_exact": 121, + "quantity_min": 255, + "quantity_max": 229, + "all_products": true + }, + "pricing_rule_data": { + "name": "name5", + "time_period_ids": [ + "time_period_ids7" + ], + "discount_id": "discount_id3", + "match_products_id": "match_products_id7", + "apply_products_id": "apply_products_id1", + "exclude_products_id": "exclude_products_id1", + "valid_from_date": "valid_from_date7", + "valid_from_local_time": "valid_from_local_time5", + "valid_until_date": "valid_until_date9", + "valid_until_local_time": "valid_until_local_time9", + "exclude_strategy": "MOST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any4" + ] + }, + "image_data": { + "name": "name5", + "url": "url9", + "caption": "caption9", + "photo_studio_order_id": "photo_studio_order_id7" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name9", + "abbreviation": "abbreviation1" + }, + "area_unit": "IMPERIAL_SQUARE_YARD", + "length_unit": "METRIC_CENTIMETER", + "volume_unit": "METRIC_LITER", + "weight_unit": "METRIC_KILOGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MILLISECOND", + "type": "TYPE_GENERIC" + }, + "precision": 159 + }, + "subscription_plan_data": { + "name": "name5", + "phases": [ + { + "uid": "uid0", + "cadence": "EVERY_TWO_YEARS", + "periods": 228, + "recurring_price_money": {}, + "ordinal": 194 + }, + { + "uid": "uid9", + "cadence": "DAILY", + "periods": 227, + "recurring_price_money": {}, + "ordinal": 193 + }, + { + "uid": "uid8", + "cadence": "WEEKLY", + "periods": 226, + "recurring_price_money": {}, + "ordinal": 192 + } + ] + }, + "item_option_data": { + "name": "name1", + "display_name": "display_name1", + "description": "description9", + "show_colors": true, + "values": [ + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id7", + "name": "name5", + "description": "description5", + "color": "color9", + "ordinal": 205 + }, + "custom_attribute_definition_data": { + "type": "SELECTION", + "name": "name3", + "description": "description3", + "source_application": { + "product": "ONLINE_STORE", + "application_id": "application_id1", + "name": "name5" + }, + "allowed_object_types": [ + "ITEM", + "SUBSCRIPTION_PLAN" + ], + "seller_visibility": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "app_visibility": "APP_VISIBILITY_HIDDEN", + "string_config": { + "enforce_uniqueness": true + }, + "number_config": { + "precision": 201 + }, + "selection_config": { + "max_allowed_selections": 195, + "allowed_selections": [ + { + "uid": "uid2", + "name": "name2" + } + ] + }, + "custom_attribute_usage_count": 31, + "key": "key3" + }, + "quick_amounts_settings_data": { + "option": "DISABLED", + "eligible_for_auto_amounts": true, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 121, + "ordinal": 53 + }, + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 122, + "ordinal": 54 + }, + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 123, + "ordinal": 55 + } + ] + } + }, + { + "type": "MODIFIER", + "id": "id6", + "updated_at": "updated_at8", + "version": 230, + "is_deleted": false, + "custom_attribute_values": { + "key0": {}, + "key1": {}, + "key2": {} + }, + "catalog_v1_ids": [ + {}, + {}, + {} + ], + "present_at_all_locations": false, + "present_at_location_ids": [ + "present_at_location_ids6", + "present_at_location_ids7" + ], + "absent_at_location_ids": [ + "absent_at_location_ids7", + "absent_at_location_ids8", + "absent_at_location_ids9" + ], + "item_data": { + "name": "name2", + "description": "description2", + "abbreviation": "abbreviation4", + "label_color": "label_color4", + "available_online": false, + "available_for_pickup": false, + "available_electronically": false, + "category_id": "category_id6", + "tax_ids": [ + "tax_ids5" + ], + "modifier_list_info": [ + {}, + {} + ], + "variations": [ + {}, + {}, + {} + ], + "product_type": "REGULAR", + "skip_modifier_screen": false, + "item_options": [ + { + "item_option_id": "item_option_id9" + } + ], + "image_ids": [ + "image_ids3", + "image_ids2" + ], + "sort_name": "sort_name6", + "description_html": "description_html2", + "description_plaintext": "description_plaintext2" + }, + "category_data": { + "name": "name0", + "image_ids": [ + "image_ids5", + "image_ids6" + ] + }, + "item_variation_data": { + "item_id": "item_id8", + "name": "name2", + "sku": "sku2", + "upc": "upc0", + "ordinal": 24, + "pricing_type": "FIXED_PRICING", + "price_money": { + "amount": 2, + "currency": "MWK" + }, + "location_overrides": [ + { + "location_id": "location_id7", + "price_money": { + "amount": 99, + "currency": "USD" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 219, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until1" + }, + { + "location_id": "location_id8", + "price_money": { + "amount": 100, + "currency": "USN" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 220, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until2" + } + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 230, + "user_data": "user_data4", + "service_duration": 114, + "available_for_booking": false, + "item_option_values": [ + { + "item_option_id": "item_option_id9", + "item_option_value_id": "item_option_value_id3" + } + ], + "measurement_unit_id": "measurement_unit_id8", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids3" + ], + "team_member_ids": [ + "team_member_ids9" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id0", + "stockable_quantity": "stockable_quantity2", + "nonstockable_quantity": "nonstockable_quantity4" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids1", + "item_variation_vendor_info_ids2", + "item_variation_vendor_info_ids3" + ] + }, + "tax_data": { + "name": "name0", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "percentage8", + "applies_to_custom_amounts": false, + "enabled": false + }, + "discount_data": { + "name": "name6", + "discount_type": "FIXED_PERCENTAGE", + "percentage": "percentage4", + "amount_money": {}, + "pin_required": false, + "label_color": "label_color8", + "modify_tax_basis": "MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name0", + "ordinal": 40, + "selection_type": "SINGLE", + "modifiers": [ + {}, + {} + ], + "image_ids": [ + "image_ids5", + "image_ids4" + ] + }, + "modifier_data": { + "name": "name6", + "price_money": {}, + "ordinal": 18, + "modifier_list_id": "modifier_list_id2", + "image_id": "image_id0" + }, + "time_period_data": { + "event": "event0" + }, + "product_set_data": { + "name": "name4", + "product_ids_any": [ + "product_ids_any6" + ], + "product_ids_all": [ + "product_ids_all5" + ], + "quantity_exact": 122, + "quantity_min": 0, + "quantity_max": 230, + "all_products": false + }, + "pricing_rule_data": { + "name": "name4", + "time_period_ids": [ + "time_period_ids6", + "time_period_ids7", + "time_period_ids8" + ], + "discount_id": "discount_id2", + "match_products_id": "match_products_id8", + "apply_products_id": "apply_products_id2", + "exclude_products_id": "exclude_products_id0", + "valid_from_date": "valid_from_date8", + "valid_from_local_time": "valid_from_local_time6", + "valid_until_date": "valid_until_date0", + "valid_until_local_time": "valid_until_local_time0", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any3", + "customer_group_ids_any4", + "customer_group_ids_any5" + ] + }, + "image_data": { + "name": "name6", + "url": "url0", + "caption": "caption0", + "photo_studio_order_id": "photo_studio_order_id8" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name8", + "abbreviation": "abbreviation0" + }, + "area_unit": "IMPERIAL_SQUARE_FOOT", + "length_unit": "METRIC_METER", + "volume_unit": "METRIC_MILLILITER", + "weight_unit": "IMPERIAL_WEIGHT_OUNCE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_DAY", + "type": "TYPE_CUSTOM" + }, + "precision": 158 + }, + "subscription_plan_data": { + "name": "name4", + "phases": [ + { + "uid": "uid1", + "cadence": "ANNUAL", + "periods": 229, + "recurring_price_money": {}, + "ordinal": 195 + }, + { + "uid": "uid0", + "cadence": "EVERY_TWO_YEARS", + "periods": 228, + "recurring_price_money": {}, + "ordinal": 194 + } + ] + }, + "item_option_data": { + "name": "name0", + "display_name": "display_name0", + "description": "description0", + "show_colors": false, + "values": [ + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id8", + "name": "name6", + "description": "description6", + "color": "color0", + "ordinal": 206 + }, + "custom_attribute_definition_data": { + "type": "NUMBER", + "name": "name4", + "description": "description4", + "source_application": { + "product": "PAYROLL", + "application_id": "application_id2", + "name": "name6" + }, + "allowed_object_types": [ + "SUBSCRIPTION_PLAN", + "QUICK_AMOUNTS_SETTINGS", + "CUSTOM_ATTRIBUTE_DEFINITION" + ], + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_READ_ONLY", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 200 + }, + "selection_config": { + "max_allowed_selections": 196, + "allowed_selections": [ + { + "uid": "uid3", + "name": "name3" + }, + { + "uid": "uid4", + "name": "name4" + } + ] + }, + "custom_attribute_usage_count": 32, + "key": "key4" + }, + "quick_amounts_settings_data": { + "option": "MANUAL", + "eligible_for_auto_amounts": false, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 122, + "ordinal": 54 + } + ] + } + } + ], + "product_type": "GIFT_CARD", + "skip_modifier_screen": false, + "item_options": [ + {}, + {}, + {} + ], + "image_ids": [ + "image_ids7", + "image_ids6" + ], + "sort_name": "sort_name6", + "description_html": "description_html2", + "description_plaintext": "description_plaintext2" + }, + "category_data": { + "name": "name0", + "image_ids": [ + "image_ids5" + ] + }, + "item_variation_data": { + "item_id": "item_id8", + "name": "name2", + "sku": "sku8", + "upc": "upc0", + "ordinal": 176, + "pricing_type": "FIXED_PRICING", + "price_money": {}, + "location_overrides": [ + {} + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 178, + "user_data": "user_data4", + "service_duration": 10, + "available_for_booking": false, + "item_option_values": [ + {}, + {} + ], + "measurement_unit_id": "measurement_unit_id8", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids3", + "image_ids2", + "image_ids1" + ], + "team_member_ids": [ + "team_member_ids9", + "team_member_ids0", + "team_member_ids1" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id0", + "stockable_quantity": "stockable_quantity2", + "nonstockable_quantity": "nonstockable_quantity4" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids1", + "item_variation_vendor_info_ids2" + ] + }, + "tax_data": { + "name": "name0", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "percentage8", + "applies_to_custom_amounts": false, + "enabled": false + }, + "discount_data": { + "name": "name4", + "discount_type": "FIXED_PERCENTAGE", + "percentage": "percentage2", + "amount_money": {}, + "pin_required": false, + "label_color": "label_color6", + "modify_tax_basis": "MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name0", + "ordinal": 144, + "selection_type": "SINGLE", + "modifiers": [ + {}, + {}, + {} + ], + "image_ids": [ + "image_ids5", + "image_ids6" + ] + }, + "modifier_data": { + "name": "name4", + "price_money": {}, + "ordinal": 38, + "modifier_list_id": "modifier_list_id0", + "image_id": "image_id8" + }, + "time_period_data": { + "event": "event0" + }, + "product_set_data": { + "name": "name4", + "product_ids_any": [ + "product_ids_any0", + "product_ids_any9", + "product_ids_any8" + ], + "product_ids_all": [ + "product_ids_all7", + "product_ids_all8", + "product_ids_all9" + ], + "quantity_exact": 18, + "quantity_min": 152, + "quantity_max": 126, + "all_products": false + }, + "pricing_rule_data": { + "name": "name6", + "time_period_ids": [ + "time_period_ids8", + "time_period_ids9" + ], + "discount_id": "discount_id4", + "match_products_id": "match_products_id6", + "apply_products_id": "apply_products_id0", + "exclude_products_id": "exclude_products_id2", + "valid_from_date": "valid_from_date6", + "valid_from_local_time": "valid_from_local_time4", + "valid_until_date": "valid_until_date8", + "valid_until_local_time": "valid_until_local_time8", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any5", + "customer_group_ids_any6" + ] + }, + "image_data": { + "name": "name6", + "url": "url0", + "caption": "caption0", + "photo_studio_order_id": "photo_studio_order_id8" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name8", + "abbreviation": "abbreviation0" + }, + "area_unit": "IMPERIAL_SQUARE_FOOT", + "length_unit": "METRIC_METER", + "volume_unit": "IMPERIAL_CUBIC_YARD", + "weight_unit": "IMPERIAL_STONE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_SECOND", + "type": "TYPE_LENGTH" + }, + "precision": 6 + }, + "subscription_plan_data": { + "name": "name4", + "phases": [ + {}, + {} + ] + }, + "item_option_data": { + "name": "name0", + "display_name": "display_name0", + "description": "description0", + "show_colors": false, + "values": [ + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id8", + "name": "name6", + "description": "description6", + "color": "color0", + "ordinal": 102 + }, + "custom_attribute_definition_data": { + "type": "NUMBER", + "name": "name4", + "description": "description4", + "source_application": { + "product": "PAYROLL", + "application_id": "application_id2", + "name": "name6" + }, + "allowed_object_types": [ + "TIME_PERIOD", + "MEASUREMENT_UNIT" + ], + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_HIDDEN", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 48 + }, + "selection_config": { + "max_allowed_selections": 92, + "allowed_selections": [ + {} + ] + }, + "custom_attribute_usage_count": 184, + "key": "key4" + }, + "quick_amounts_settings_data": { + "option": "DISABLED", + "eligible_for_auto_amounts": false, + "amounts": [ + {}, + {}, + {} + ] + } + }, + { + "type": "CUSTOM_ATTRIBUTE_DEFINITION", + "id": "id7", + "updated_at": "updated_at3", + "version": 127, + "is_deleted": true, + "custom_attribute_values": { + "key0": { + "name": "name8", + "string_value": "string_value2", + "custom_attribute_definition_id": "custom_attribute_definition_id4", + "type": "STRING", + "number_value": "number_value8", + "boolean_value": false, + "selection_uid_values": [ + "selection_uid_values5", + "selection_uid_values6" + ], + "key": "key8" + }, + "key1": { + "name": "name7", + "string_value": "string_value1", + "custom_attribute_definition_id": "custom_attribute_definition_id5", + "type": "BOOLEAN", + "number_value": "number_value7", + "boolean_value": true, + "selection_uid_values": [ + "selection_uid_values4" + ], + "key": "key7" + }, + "key2": { + "name": "name6", + "string_value": "string_value0", + "custom_attribute_definition_id": "custom_attribute_definition_id6", + "type": "NUMBER", + "number_value": "number_value6", + "boolean_value": false, + "selection_uid_values": [ + "selection_uid_values3", + "selection_uid_values4", + "selection_uid_values5" + ], + "key": "key6" + } + }, + "catalog_v1_ids": [ + { + "catalog_v1_id": "catalog_v1_id1", + "location_id": "location_id1" + }, + { + "catalog_v1_id": "catalog_v1_id2", + "location_id": "location_id2" + }, + { + "catalog_v1_id": "catalog_v1_id3", + "location_id": "location_id3" + } + ], + "present_at_all_locations": true, + "present_at_location_ids": [ + "present_at_location_ids7", + "present_at_location_ids8" + ], + "absent_at_location_ids": [ + "absent_at_location_ids8", + "absent_at_location_ids9", + "absent_at_location_ids0" + ], + "item_data": { + "name": "name1", + "description": "description1", + "abbreviation": "abbreviation3", + "label_color": "label_color3", + "available_online": true, + "available_for_pickup": true, + "available_electronically": true, + "category_id": "category_id7", + "tax_ids": [ + "tax_ids6" + ], + "modifier_list_info": [ + { + "modifier_list_id": "modifier_list_id1", + "modifier_overrides": [ + { + "modifier_id": "modifier_id4", + "on_by_default": false + } + ], + "min_selected_modifiers": 33, + "max_selected_modifiers": 13, + "enabled": true + }, + { + "modifier_list_id": "modifier_list_id2", + "modifier_overrides": [ + { + "modifier_id": "modifier_id5", + "on_by_default": true + }, + { + "modifier_id": "modifier_id6", + "on_by_default": false + } + ], + "min_selected_modifiers": 34, + "max_selected_modifiers": 14, + "enabled": false + } + ], + "variations": [ + { + "type": "MODIFIER", + "id": "id6", + "updated_at": "updated_at8", + "version": 230, + "is_deleted": false, + "custom_attribute_values": { + "key0": {}, + "key1": {}, + "key2": {} + }, + "catalog_v1_ids": [ + {}, + {}, + {} + ], + "present_at_all_locations": false, + "present_at_location_ids": [ + "present_at_location_ids6", + "present_at_location_ids7" + ], + "absent_at_location_ids": [ + "absent_at_location_ids7", + "absent_at_location_ids8", + "absent_at_location_ids9" + ], + "item_data": { + "name": "name2", + "description": "description2", + "abbreviation": "abbreviation4", + "label_color": "label_color4", + "available_online": false, + "available_for_pickup": false, + "available_electronically": false, + "category_id": "category_id6", + "tax_ids": [ + "tax_ids5" + ], + "modifier_list_info": [ + {}, + {} + ], + "variations": [ + {}, + {}, + {} + ], + "product_type": "REGULAR", + "skip_modifier_screen": false, + "item_options": [ + { + "item_option_id": "item_option_id9" + } + ], + "image_ids": [ + "image_ids3", + "image_ids2" + ], + "sort_name": "sort_name6", + "description_html": "description_html2", + "description_plaintext": "description_plaintext2" + }, + "category_data": { + "name": "name0", + "image_ids": [ + "image_ids5", + "image_ids6" + ] + }, + "item_variation_data": { + "item_id": "item_id8", + "name": "name2", + "sku": "sku2", + "upc": "upc0", + "ordinal": 24, + "pricing_type": "FIXED_PRICING", + "price_money": { + "amount": 2, + "currency": "MWK" + }, + "location_overrides": [ + { + "location_id": "location_id7", + "price_money": { + "amount": 99, + "currency": "USD" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 219, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until1" + }, + { + "location_id": "location_id8", + "price_money": { + "amount": 100, + "currency": "USN" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 220, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until2" + } + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 230, + "user_data": "user_data4", + "service_duration": 114, + "available_for_booking": false, + "item_option_values": [ + { + "item_option_id": "item_option_id9", + "item_option_value_id": "item_option_value_id3" + } + ], + "measurement_unit_id": "measurement_unit_id8", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids3" + ], + "team_member_ids": [ + "team_member_ids9" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id0", + "stockable_quantity": "stockable_quantity2", + "nonstockable_quantity": "nonstockable_quantity4" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids1", + "item_variation_vendor_info_ids2", + "item_variation_vendor_info_ids3" + ] + }, + "tax_data": { + "name": "name0", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "percentage8", + "applies_to_custom_amounts": false, + "enabled": false + }, + "discount_data": { + "name": "name6", + "discount_type": "FIXED_PERCENTAGE", + "percentage": "percentage4", + "amount_money": {}, + "pin_required": false, + "label_color": "label_color8", + "modify_tax_basis": "MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name0", + "ordinal": 40, + "selection_type": "SINGLE", + "modifiers": [ + {}, + {} + ], + "image_ids": [ + "image_ids5", + "image_ids4" + ] + }, + "modifier_data": { + "name": "name6", + "price_money": {}, + "ordinal": 18, + "modifier_list_id": "modifier_list_id2", + "image_id": "image_id0" + }, + "time_period_data": { + "event": "event0" + }, + "product_set_data": { + "name": "name4", + "product_ids_any": [ + "product_ids_any6" + ], + "product_ids_all": [ + "product_ids_all5" + ], + "quantity_exact": 122, + "quantity_min": 0, + "quantity_max": 230, + "all_products": false + }, + "pricing_rule_data": { + "name": "name4", + "time_period_ids": [ + "time_period_ids6", + "time_period_ids7", + "time_period_ids8" + ], + "discount_id": "discount_id2", + "match_products_id": "match_products_id8", + "apply_products_id": "apply_products_id2", + "exclude_products_id": "exclude_products_id0", + "valid_from_date": "valid_from_date8", + "valid_from_local_time": "valid_from_local_time6", + "valid_until_date": "valid_until_date0", + "valid_until_local_time": "valid_until_local_time0", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any3", + "customer_group_ids_any4", + "customer_group_ids_any5" + ] + }, + "image_data": { + "name": "name6", + "url": "url0", + "caption": "caption0", + "photo_studio_order_id": "photo_studio_order_id8" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name8", + "abbreviation": "abbreviation0" + }, + "area_unit": "IMPERIAL_SQUARE_FOOT", + "length_unit": "METRIC_METER", + "volume_unit": "METRIC_MILLILITER", + "weight_unit": "IMPERIAL_WEIGHT_OUNCE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_DAY", + "type": "TYPE_CUSTOM" + }, + "precision": 158 + }, + "subscription_plan_data": { + "name": "name4", + "phases": [ + { + "uid": "uid1", + "cadence": "ANNUAL", + "periods": 229, + "recurring_price_money": {}, + "ordinal": 195 + }, + { + "uid": "uid0", + "cadence": "EVERY_TWO_YEARS", + "periods": 228, + "recurring_price_money": {}, + "ordinal": 194 + } + ] + }, + "item_option_data": { + "name": "name0", + "display_name": "display_name0", + "description": "description0", + "show_colors": false, + "values": [ + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id8", + "name": "name6", + "description": "description6", + "color": "color0", + "ordinal": 206 + }, + "custom_attribute_definition_data": { + "type": "NUMBER", + "name": "name4", + "description": "description4", + "source_application": { + "product": "PAYROLL", + "application_id": "application_id2", + "name": "name6" + }, + "allowed_object_types": [ + "SUBSCRIPTION_PLAN", + "QUICK_AMOUNTS_SETTINGS", + "CUSTOM_ATTRIBUTE_DEFINITION" + ], + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_READ_ONLY", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 200 + }, + "selection_config": { + "max_allowed_selections": 196, + "allowed_selections": [ + { + "uid": "uid3", + "name": "name3" + }, + { + "uid": "uid4", + "name": "name4" + } + ] + }, + "custom_attribute_usage_count": 32, + "key": "key4" + }, + "quick_amounts_settings_data": { + "option": "MANUAL", + "eligible_for_auto_amounts": false, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 122, + "ordinal": 54 + } + ] + } + }, + { + "type": "MODIFIER_LIST", + "id": "id7", + "updated_at": "updated_at7", + "version": 231, + "is_deleted": true, + "custom_attribute_values": { + "key0": {}, + "key1": {} + }, + "catalog_v1_ids": [ + {} + ], + "present_at_all_locations": true, + "present_at_location_ids": [ + "present_at_location_ids7", + "present_at_location_ids8", + "present_at_location_ids9" + ], + "absent_at_location_ids": [ + "absent_at_location_ids8" + ], + "item_data": { + "name": "name1", + "description": "description1", + "abbreviation": "abbreviation3", + "label_color": "label_color3", + "available_online": true, + "available_for_pickup": true, + "available_electronically": true, + "category_id": "category_id7", + "tax_ids": [ + "tax_ids4", + "tax_ids3" + ], + "modifier_list_info": [ + {} + ], + "variations": [ + {} + ], + "product_type": "APPOINTMENTS_SERVICE", + "skip_modifier_screen": true, + "item_options": [ + { + "item_option_id": "item_option_id0" + }, + { + "item_option_id": "item_option_id9" + }, + { + "item_option_id": "item_option_id8" + } + ], + "image_ids": [ + "image_ids4" + ], + "sort_name": "sort_name7", + "description_html": "description_html1", + "description_plaintext": "description_plaintext1" + }, + "category_data": { + "name": "name1", + "image_ids": [ + "image_ids6", + "image_ids7", + "image_ids8" + ] + }, + "item_variation_data": { + "item_id": "item_id7", + "name": "name3", + "sku": "sku1", + "upc": "upc9", + "ordinal": 25, + "pricing_type": "VARIABLE_PRICING", + "price_money": { + "amount": 1, + "currency": "MVR" + }, + "location_overrides": [ + { + "location_id": "location_id8", + "price_money": { + "amount": 100, + "currency": "USN" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 220, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until2" + }, + { + "location_id": "location_id9", + "price_money": { + "amount": 101, + "currency": "USS" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 221, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until3" + }, + { + "location_id": "location_id0", + "price_money": { + "amount": 102, + "currency": "UYI" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 222, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until4" + } + ], + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 229, + "user_data": "user_data3", + "service_duration": 115, + "available_for_booking": true, + "item_option_values": [ + { + "item_option_id": "item_option_id8", + "item_option_value_id": "item_option_value_id4" + }, + { + "item_option_id": "item_option_id9", + "item_option_value_id": "item_option_value_id3" + }, + { + "item_option_id": "item_option_id0", + "item_option_value_id": "item_option_value_id2" + } + ], + "measurement_unit_id": "measurement_unit_id7", + "sellable": true, + "stockable": true, + "image_ids": [ + "image_ids2", + "image_ids3", + "image_ids4" + ], + "team_member_ids": [ + "team_member_ids0", + "team_member_ids1" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id9", + "stockable_quantity": "stockable_quantity3", + "nonstockable_quantity": "nonstockable_quantity5" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids2" + ] + }, + "tax_data": { + "name": "name9", + "calculation_phase": "TAX_TOTAL_PHASE", + "inclusion_type": "INCLUSIVE", + "percentage": "percentage7", + "applies_to_custom_amounts": true, + "enabled": true + }, + "discount_data": { + "name": "name5", + "discount_type": "VARIABLE_AMOUNT", + "percentage": "percentage3", + "amount_money": {}, + "pin_required": true, + "label_color": "label_color7", + "modify_tax_basis": "DO_NOT_MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name9", + "ordinal": 39, + "selection_type": "MULTIPLE", + "modifiers": [ + {} + ], + "image_ids": [ + "image_ids6" + ] + }, + "modifier_data": { + "name": "name5", + "price_money": {}, + "ordinal": 17, + "modifier_list_id": "modifier_list_id1", + "image_id": "image_id9" + }, + "time_period_data": { + "event": "event9" + }, + "product_set_data": { + "name": "name5", + "product_ids_any": [ + "product_ids_any7", + "product_ids_any6", + "product_ids_any5" + ], + "product_ids_all": [ + "product_ids_all6", + "product_ids_all5", + "product_ids_all4" + ], + "quantity_exact": 123, + "quantity_min": 1, + "quantity_max": 231, + "all_products": true + }, + "pricing_rule_data": { + "name": "name3", + "time_period_ids": [ + "time_period_ids5", + "time_period_ids6" + ], + "discount_id": "discount_id1", + "match_products_id": "match_products_id9", + "apply_products_id": "apply_products_id3", + "exclude_products_id": "exclude_products_id9", + "valid_from_date": "valid_from_date9", + "valid_from_local_time": "valid_from_local_time7", + "valid_until_date": "valid_until_date1", + "valid_until_local_time": "valid_until_local_time1", + "exclude_strategy": "MOST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any2", + "customer_group_ids_any3" + ] + }, + "image_data": { + "name": "name7", + "url": "url1", + "caption": "caption1", + "photo_studio_order_id": "photo_studio_order_id9" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name7", + "abbreviation": "abbreviation9" + }, + "area_unit": "IMPERIAL_SQUARE_INCH", + "length_unit": "METRIC_KILOMETER", + "volume_unit": "IMPERIAL_CUBIC_YARD", + "weight_unit": "IMPERIAL_POUND", + "generic_unit": "UNIT", + "time_unit": "GENERIC_HOUR", + "type": "TYPE_AREA" + }, + "precision": 157 + }, + "subscription_plan_data": { + "name": "name3", + "phases": [ + { + "uid": "uid2", + "cadence": "EVERY_SIX_MONTHS", + "periods": 230, + "recurring_price_money": {}, + "ordinal": 196 + } + ] + }, + "item_option_data": { + "name": "name9", + "display_name": "display_name9", + "description": "description1", + "show_colors": true, + "values": [ + {}, + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id9", + "name": "name7", + "description": "description7", + "color": "color1", + "ordinal": 207 + }, + "custom_attribute_definition_data": { + "type": "BOOLEAN", + "name": "name5", + "description": "description5", + "source_application": { + "product": "DASHBOARD", + "application_id": "application_id3", + "name": "name7" + }, + "allowed_object_types": [ + "QUICK_AMOUNTS_SETTINGS" + ], + "seller_visibility": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "app_visibility": "APP_VISIBILITY_READ_WRITE_VALUES", + "string_config": { + "enforce_uniqueness": true + }, + "number_config": { + "precision": 199 + }, + "selection_config": { + "max_allowed_selections": 197, + "allowed_selections": [ + { + "uid": "uid4", + "name": "name4" + }, + { + "uid": "uid5", + "name": "name5" + }, + { + "uid": "uid6", + "name": "name6" + } + ] + }, + "custom_attribute_usage_count": 33, + "key": "key5" + }, + "quick_amounts_settings_data": { + "option": "AUTO", + "eligible_for_auto_amounts": true, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 123, + "ordinal": 55 + }, + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 124, + "ordinal": 56 + } + ] + } + }, + { + "type": "DISCOUNT", + "id": "id8", + "updated_at": "updated_at6", + "version": 232, + "is_deleted": false, + "custom_attribute_values": { + "key0": {} + }, + "catalog_v1_ids": [ + {}, + {} + ], + "present_at_all_locations": false, + "present_at_location_ids": [ + "present_at_location_ids8" + ], + "absent_at_location_ids": [ + "absent_at_location_ids9", + "absent_at_location_ids0" + ], + "item_data": { + "name": "name0", + "description": "description0", + "abbreviation": "abbreviation2", + "label_color": "label_color2", + "available_online": false, + "available_for_pickup": false, + "available_electronically": false, + "category_id": "category_id8", + "tax_ids": [ + "tax_ids3", + "tax_ids2", + "tax_ids1" + ], + "modifier_list_info": [ + {}, + {}, + {} + ], + "variations": [ + {}, + {} + ], + "product_type": "GIFT_CARD", + "skip_modifier_screen": false, + "item_options": [ + { + "item_option_id": "item_option_id1" + }, + { + "item_option_id": "item_option_id0" + } + ], + "image_ids": [ + "image_ids5", + "image_ids4", + "image_ids3" + ], + "sort_name": "sort_name8", + "description_html": "description_html0", + "description_plaintext": "description_plaintext0" + }, + "category_data": { + "name": "name2", + "image_ids": [ + "image_ids7" + ] + }, + "item_variation_data": { + "item_id": "item_id6", + "name": "name4", + "sku": "sku0", + "upc": "upc8", + "ordinal": 26, + "pricing_type": "FIXED_PRICING", + "price_money": { + "amount": 0, + "currency": "MUR" + }, + "location_overrides": [ + { + "location_id": "location_id9", + "price_money": { + "amount": 101, + "currency": "USS" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 221, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until3" + } + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 228, + "user_data": "user_data2", + "service_duration": 116, + "available_for_booking": false, + "item_option_values": [ + { + "item_option_id": "item_option_id7", + "item_option_value_id": "item_option_value_id5" + }, + { + "item_option_id": "item_option_id8", + "item_option_value_id": "item_option_value_id4" + } + ], + "measurement_unit_id": "measurement_unit_id6", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids1", + "image_ids2" + ], + "team_member_ids": [ + "team_member_ids1", + "team_member_ids2", + "team_member_ids3" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id8", + "stockable_quantity": "stockable_quantity4", + "nonstockable_quantity": "nonstockable_quantity6" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids3", + "item_variation_vendor_info_ids4" + ] + }, + "tax_data": { + "name": "name8", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "percentage6", + "applies_to_custom_amounts": false, + "enabled": false + }, + "discount_data": { + "name": "name4", + "discount_type": "VARIABLE_PERCENTAGE", + "percentage": "percentage2", + "amount_money": {}, + "pin_required": false, + "label_color": "label_color6", + "modify_tax_basis": "MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name8", + "ordinal": 38, + "selection_type": "SINGLE", + "modifiers": [ + {}, + {}, + {} + ], + "image_ids": [ + "image_ids7", + "image_ids6", + "image_ids5" + ] + }, + "modifier_data": { + "name": "name4", + "price_money": {}, + "ordinal": 16, + "modifier_list_id": "modifier_list_id0", + "image_id": "image_id8" + }, + "time_period_data": { + "event": "event8" + }, + "product_set_data": { + "name": "name6", + "product_ids_any": [ + "product_ids_any8", + "product_ids_any7" + ], + "product_ids_all": [ + "product_ids_all7", + "product_ids_all6" + ], + "quantity_exact": 124, + "quantity_min": 2, + "quantity_max": 232, + "all_products": false + }, + "pricing_rule_data": { + "name": "name2", + "time_period_ids": [ + "time_period_ids4" + ], + "discount_id": "discount_id0", + "match_products_id": "match_products_id0", + "apply_products_id": "apply_products_id4", + "exclude_products_id": "exclude_products_id8", + "valid_from_date": "valid_from_date0", + "valid_from_local_time": "valid_from_local_time8", + "valid_until_date": "valid_until_date2", + "valid_until_local_time": "valid_until_local_time2", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any1" + ] + }, + "image_data": { + "name": "name8", + "url": "url2", + "caption": "caption2", + "photo_studio_order_id": "photo_studio_order_id0" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name6", + "abbreviation": "abbreviation8" + }, + "area_unit": "IMPERIAL_ACRE", + "length_unit": "IMPERIAL_INCH", + "volume_unit": "IMPERIAL_CUBIC_FOOT", + "weight_unit": "IMPERIAL_STONE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MINUTE", + "type": "TYPE_LENGTH" + }, + "precision": 156 + }, + "subscription_plan_data": { + "name": "name2", + "phases": [ + { + "uid": "uid3", + "cadence": "EVERY_FOUR_MONTHS", + "periods": 231, + "recurring_price_money": {}, + "ordinal": 197 + }, + { + "uid": "uid2", + "cadence": "EVERY_SIX_MONTHS", + "periods": 230, + "recurring_price_money": {}, + "ordinal": 196 + }, + { + "uid": "uid1", + "cadence": "ANNUAL", + "periods": 229, + "recurring_price_money": {}, + "ordinal": 195 + } + ] + }, + "item_option_data": { + "name": "name8", + "display_name": "display_name8", + "description": "description2", + "show_colors": false, + "values": [ + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id0", + "name": "name8", + "description": "description8", + "color": "color2", + "ordinal": 208 + }, + "custom_attribute_definition_data": { + "type": "STRING", + "name": "name6", + "description": "description6", + "source_application": { + "product": "ITEM_LIBRARY_IMPORT", + "application_id": "application_id4", + "name": "name8" + }, + "allowed_object_types": [ + "CUSTOM_ATTRIBUTE_DEFINITION", + "ITEM_OPTION_VAL" + ], + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_HIDDEN", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 198 + }, + "selection_config": { + "max_allowed_selections": 198, + "allowed_selections": [ + { + "uid": "uid5", + "name": "name5" + } + ] + }, + "custom_attribute_usage_count": 34, + "key": "key6" + }, + "quick_amounts_settings_data": { + "option": "DISABLED", + "eligible_for_auto_amounts": false, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 124, + "ordinal": 56 + }, + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 125, + "ordinal": 57 + }, + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 126, + "ordinal": 58 + } + ] + } + } + ], + "product_type": "REGULAR", + "skip_modifier_screen": true, + "item_options": [ + {} + ], + "image_ids": [ + "image_ids6", + "image_ids5", + "image_ids4" + ], + "sort_name": "sort_name7", + "description_html": "description_html1", + "description_plaintext": "description_plaintext1" + }, + "category_data": { + "name": "name1", + "image_ids": [ + "image_ids6", + "image_ids7" + ] + }, + "item_variation_data": { + "item_id": "item_id7", + "name": "name3", + "sku": "sku9", + "upc": "upc9", + "ordinal": 177, + "pricing_type": "VARIABLE_PRICING", + "price_money": {}, + "location_overrides": [ + {}, + {} + ], + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 179, + "user_data": "user_data3", + "service_duration": 11, + "available_for_booking": true, + "item_option_values": [ + {} + ], + "measurement_unit_id": "measurement_unit_id7", + "sellable": true, + "stockable": true, + "image_ids": [ + "image_ids2" + ], + "team_member_ids": [ + "team_member_ids0" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id1", + "stockable_quantity": "stockable_quantity3", + "nonstockable_quantity": "nonstockable_quantity5" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids2", + "item_variation_vendor_info_ids3", + "item_variation_vendor_info_ids4" + ] + }, + "tax_data": { + "name": "name1", + "calculation_phase": "TAX_TOTAL_PHASE", + "inclusion_type": "INCLUSIVE", + "percentage": "percentage9", + "applies_to_custom_amounts": true, + "enabled": true + }, + "discount_data": { + "name": "name5", + "discount_type": "FIXED_AMOUNT", + "percentage": "percentage3", + "amount_money": {}, + "pin_required": true, + "label_color": "label_color7", + "modify_tax_basis": "DO_NOT_MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name9", + "ordinal": 143, + "selection_type": "MULTIPLE", + "modifiers": [ + {}, + {} + ], + "image_ids": [ + "image_ids6", + "image_ids7", + "image_ids8" + ] + }, + "modifier_data": { + "name": "name5", + "price_money": {}, + "ordinal": 39, + "modifier_list_id": "modifier_list_id1", + "image_id": "image_id9" + }, + "time_period_data": { + "event": "event9" + }, + "product_set_data": { + "name": "name5", + "product_ids_any": [ + "product_ids_any9" + ], + "product_ids_all": [ + "product_ids_all8" + ], + "quantity_exact": 19, + "quantity_min": 153, + "quantity_max": 127, + "all_products": true + }, + "pricing_rule_data": { + "name": "name7", + "time_period_ids": [ + "time_period_ids9", + "time_period_ids0", + "time_period_ids1" + ], + "discount_id": "discount_id5", + "match_products_id": "match_products_id5", + "apply_products_id": "apply_products_id9", + "exclude_products_id": "exclude_products_id3", + "valid_from_date": "valid_from_date5", + "valid_from_local_time": "valid_from_local_time3", + "valid_until_date": "valid_until_date7", + "valid_until_local_time": "valid_until_local_time7", + "exclude_strategy": "MOST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any6", + "customer_group_ids_any7", + "customer_group_ids_any8" + ] + }, + "image_data": { + "name": "name7", + "url": "url1", + "caption": "caption1", + "photo_studio_order_id": "photo_studio_order_id9" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name7", + "abbreviation": "abbreviation9" + }, + "area_unit": "IMPERIAL_SQUARE_INCH", + "length_unit": "METRIC_KILOMETER", + "volume_unit": "IMPERIAL_CUBIC_FOOT", + "weight_unit": "METRIC_MILLIGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MINUTE", + "type": "TYPE_VOLUME" + }, + "precision": 5 + }, + "subscription_plan_data": { + "name": "name3", + "phases": [ + {}, + {}, + {} + ] + }, + "item_option_data": { + "name": "name1", + "display_name": "display_name1", + "description": "description9", + "show_colors": true, + "values": [ + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id9", + "name": "name7", + "description": "description7", + "color": "color1", + "ordinal": 103 + }, + "custom_attribute_definition_data": { + "type": "SELECTION", + "name": "name5", + "description": "description5", + "source_application": { + "product": "DASHBOARD", + "application_id": "application_id3", + "name": "name7" + }, + "allowed_object_types": [ + "MEASUREMENT_UNIT", + "ITEM_OPTION", + "ITEM_OPTION_VAL" + ], + "seller_visibility": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "app_visibility": "APP_VISIBILITY_READ_ONLY", + "string_config": { + "enforce_uniqueness": true + }, + "number_config": { + "precision": 47 + }, + "selection_config": { + "max_allowed_selections": 93, + "allowed_selections": [ + {}, + {} + ] + }, + "custom_attribute_usage_count": 185, + "key": "key5" + }, + "quick_amounts_settings_data": { + "option": "MANUAL", + "eligible_for_auto_amounts": true, + "amounts": [ + {} + ] + } + } + ] } ``` diff --git a/doc/models/payment-link.md b/doc/models/payment-link.md index 7cbace05..29d065da 100644 --- a/doc/models/payment-link.md +++ b/doc/models/payment-link.md @@ -15,7 +15,8 @@ | `orderId` | `string \| undefined` | Optional | The ID of the order associated with the payment link.
**Constraints**: *Maximum Length*: `192` | | `checkoutOptions` | [`CheckoutOptions \| undefined`](../../doc/models/checkout-options.md) | Optional | - | | `prePopulatedData` | [`PrePopulatedData \| undefined`](../../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). | -| `url` | `string \| undefined` | Optional | The URL of the payment link.
**Constraints**: *Maximum Length*: `255` | +| `url` | `string \| undefined` | Optional | The shortened URL of the payment link.
**Constraints**: *Maximum Length*: `255` | +| `longUrl` | `string \| undefined` | Optional | The long URL of the payment link.
**Constraints**: *Maximum Length*: `255` | | `createdAt` | `string \| undefined` | Optional | The timestamp when the payment link was created, in RFC 3339 format. | | `updatedAt` | `string \| undefined` | Optional | The timestamp when the payment link was last updated, in RFC 3339 format. | | `paymentNote` | `string \| undefined` | Optional | An optional note. After Square processes the payment, this note is added to the
resulting `Payment`.
**Constraints**: *Maximum Length*: `500` | @@ -24,16 +25,67 @@ ```json { - "id": null, + "id": "id0", "version": 172, - "description": null, - "order_id": null, - "checkout_options": null, - "pre_populated_data": null, - "url": null, - "created_at": null, - "updated_at": null, - "payment_note": null + "description": "description0", + "order_id": "order_id6", + "checkout_options": { + "allow_tipping": false, + "custom_fields": [ + { + "title": "title9" + }, + { + "title": "title0" + } + ], + "subscription_plan_id": "subscription_plan_id8", + "redirect_url": "redirect_url2", + "merchant_support_email": "merchant_support_email8", + "ask_for_shipping_address": false, + "accepted_payment_methods": { + "apple_pay": false, + "google_pay": false, + "cash_app_pay": false, + "afterpay_clearpay": false + }, + "app_fee_money": { + "amount": 194, + "currency": "XBA" + }, + "shipping_fee": { + "name": "name2", + "charge": { + "amount": 8, + "currency": "FJD" + } + } + }, + "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", + "sublocality_2": "sublocality_20", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_16", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_30", + "postal_code": "postal_code4", + "country": "IO", + "first_name": "first_name2", + "last_name": "last_name0" + } + }, + "url": "url4", + "long_url": "long_url0", + "created_at": "created_at2", + "updated_at": "updated_at4", + "payment_note": "payment_note8" } ``` diff --git a/doc/models/payment-options-delay-action.md b/doc/models/payment-options-delay-action.md new file mode 100644 index 00000000..447fa0c1 --- /dev/null +++ b/doc/models/payment-options-delay-action.md @@ -0,0 +1,17 @@ + +# 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 index 76703a85..8a84787d 100644 --- a/doc/models/payment-options.md +++ b/doc/models/payment-options.md @@ -10,16 +10,18 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `autocomplete` | `boolean \| undefined` | Optional | Indicates whether the `Payment` objects created from this `TerminalCheckout` are automatically
`COMPLETED` or left in an `APPROVED` state for later modification. | -| `delayDuration` | `string \| undefined` | 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, CANCELED, or FAILED) 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. | +| `delayDuration` | `string \| undefined` | 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. | | `acceptPartialAuthorization` | `boolean \| undefined` | 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 | +| `delayAction` | [`string \| undefined`](../../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. | ## Example (as JSON) ```json { - "autocomplete": null, - "delay_duration": null, - "accept_partial_authorization": null + "autocomplete": false, + "delay_duration": "delay_duration2", + "accept_partial_authorization": false, + "delay_action": "CANCEL" } ``` diff --git a/doc/models/payment-refund.md b/doc/models/payment-refund.md index 0303495e..72226052 100644 --- a/doc/models/payment-refund.md +++ b/doc/models/payment-refund.md @@ -33,23 +33,89 @@ the original payment and the amount of money refunded. ```json { "id": "id0", - "status": null, - "location_id": null, - "unlinked": null, - "destination_type": null, - "destination_details": null, + "status": "status8", + "location_id": "location_id4", + "unlinked": false, + "destination_type": "destination_type4", + "destination_details": { + "card_details": { + "card": { + "id": "id0", + "card_brand": "FELICA", + "last_4": "last_42", + "exp_month": 2, + "exp_year": 38, + "cardholder_name": "cardholder_name4", + "billing_address": { + "address_line_1": "address_line_18", + "address_line_2": "address_line_22", + "address_line_3": "address_line_38", + "locality": "locality8", + "sublocality": "sublocality2", + "sublocality_2": "sublocality_20", + "sublocality_3": "sublocality_38", + "administrative_district_level_1": "administrative_district_level_16", + "administrative_district_level_2": "administrative_district_level_22", + "administrative_district_level_3": "administrative_district_level_30", + "postal_code": "postal_code4", + "country": "CZ", + "first_name": "first_name2", + "last_name": "last_name0" + }, + "fingerprint": "fingerprint6", + "customer_id": "customer_id8", + "merchant_id": "merchant_id0", + "reference_id": "reference_id2", + "enabled": false, + "card_type": "UNKNOWN_CARD_TYPE", + "prepaid_type": "PREPAID", + "bin": "bin0", + "version": 124, + "card_co_brand": "AFTERPAY" + }, + "entry_method": "entry_method2" + } + }, "amount_money": { - "amount": null, - "currency": null + "amount": 186, + "currency": "NGN" + }, + "app_fee_money": { + "amount": 106, + "currency": "GBP" }, - "app_fee_money": null, - "processing_fee": null, - "payment_id": null, - "order_id": null, - "reason": null, - "created_at": null, - "updated_at": null, - "team_member_id": null + "processing_fee": [ + { + "effective_at": "effective_at6", + "type": "type8", + "amount_money": { + "amount": 214, + "currency": "BWP" + } + }, + { + "effective_at": "effective_at7", + "type": "type7", + "amount_money": { + "amount": 215, + "currency": "BYR" + } + }, + { + "effective_at": "effective_at8", + "type": "type6", + "amount_money": { + "amount": 216, + "currency": "BZD" + } + } + ], + "payment_id": "payment_id0", + "order_id": "order_id6", + "reason": "reason4", + "created_at": "created_at2", + "updated_at": "updated_at4", + "team_member_id": "team_member_id0" } ``` diff --git a/doc/models/payment.md b/doc/models/payment.md index e0b84a37..6f8472ac 100644 --- a/doc/models/payment.md +++ b/doc/models/payment.md @@ -37,7 +37,7 @@ Represents a payment processed by the Square API. | `referenceId` | `string \| undefined` | Optional | An optional ID that associates the payment with an entity in
another system.
**Constraints**: *Maximum Length*: `40` | | `customerId` | `string \| undefined` | 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` | | `employeeId` | `string \| undefined` | Optional | __Deprecated__: Use `Payment.team_member_id` instead.

An optional ID of the employee associated with taking the payment.
**Constraints**: *Maximum Length*: `192` | -| `teamMemberId` | `string \| undefined` | Optional | An optional ID of the [TeamMember](../../doc/models/team-member.md) associated with taking the payment.
**Constraints**: *Maximum Length*: `192` | +| `teamMemberId` | `string \| undefined` | Optional | An optional ID of the [TeamMember](entity:TeamMember) associated with taking the payment.
**Constraints**: *Maximum Length*: `192` | | `refundIds` | `string[] \| undefined` | Optional | A list of `refund_id`s identifying refunds for the payment. | | `riskEvaluation` | [`RiskEvaluation \| undefined`](../../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). | | `buyerEmailAddress` | `string \| undefined` | Optional | The buyer's email address.
**Constraints**: *Maximum Length*: `255` | @@ -56,46 +56,257 @@ Represents a payment processed by the Square API. ```json { - "id": null, - "created_at": null, - "updated_at": null, - "amount_money": null, - "tip_money": null, - "total_money": null, - "app_fee_money": null, - "approved_money": null, - "processing_fee": null, - "refunded_money": null, - "status": null, - "delay_duration": null, - "delay_action": null, - "delayed_until": null, - "source_type": null, - "card_details": null, - "cash_details": null, - "bank_account_details": null, - "external_details": null, - "wallet_details": null, - "buy_now_pay_later_details": null, - "location_id": null, - "order_id": null, - "reference_id": null, - "customer_id": null, - "employee_id": null, - "team_member_id": null, - "refund_ids": null, - "risk_evaluation": null, - "buyer_email_address": null, - "billing_address": null, - "shipping_address": null, - "note": null, - "statement_description_identifier": null, - "capabilities": null, - "receipt_number": null, - "receipt_url": null, - "device_details": null, - "application_details": null, - "version_token": null + "id": "id0", + "created_at": "created_at2", + "updated_at": "updated_at4", + "amount_money": { + "amount": 186, + "currency": "NGN" + }, + "tip_money": { + "amount": 190, + "currency": "CHE" + }, + "total_money": { + "amount": 250, + "currency": "UNKNOWN_CURRENCY" + }, + "app_fee_money": { + "amount": 106, + "currency": "GBP" + }, + "approved_money": { + "amount": 138, + "currency": "GIP" + }, + "processing_fee": [ + { + "effective_at": "effective_at6", + "type": "type8", + "amount_money": { + "amount": 214, + "currency": "BWP" + } + }, + { + "effective_at": "effective_at7", + "type": "type7", + "amount_money": { + "amount": 215, + "currency": "BYR" + } + }, + { + "effective_at": "effective_at8", + "type": "type6", + "amount_money": { + "amount": 216, + "currency": "BZD" + } + } + ], + "refunded_money": { + "amount": 214, + "currency": "GYD" + }, + "status": "status8", + "delay_duration": "delay_duration2", + "delay_action": "delay_action0", + "delayed_until": "delayed_until2", + "source_type": "source_type0", + "card_details": { + "status": "status4", + "card": { + "id": "id6", + "card_brand": "JCB", + "last_4": "last_48", + "exp_month": 4, + "exp_year": 36, + "cardholder_name": "cardholder_name8", + "billing_address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_28", + "address_line_3": "address_line_34", + "locality": "locality2", + "sublocality": "sublocality8", + "sublocality_2": "sublocality_26", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_12", + "administrative_district_level_2": "administrative_district_level_26", + "administrative_district_level_3": "administrative_district_level_36", + "postal_code": "postal_code0", + "country": "RW", + "first_name": "first_name8", + "last_name": "last_name6" + }, + "fingerprint": "fingerprint2", + "customer_id": "customer_id4", + "merchant_id": "merchant_id6", + "reference_id": "reference_id4", + "enabled": false, + "card_type": "UNKNOWN_CARD_TYPE", + "prepaid_type": "PREPAID", + "bin": "bin6", + "version": 122, + "card_co_brand": "AFTERPAY" + }, + "entry_method": "entry_method8", + "cvv_status": "cvv_status4", + "avs_status": "avs_status6", + "auth_result_code": "auth_result_code0", + "application_identifier": "application_identifier4", + "application_name": "application_name6", + "application_cryptogram": "application_cryptogram6", + "verification_method": "verification_method2", + "verification_results": "verification_results4", + "statement_description": "statement_description6", + "device_details": { + "device_id": "device_id2", + "device_installation_id": "device_installation_id4", + "device_name": "device_name6" + }, + "card_payment_timeline": { + "authorized_at": "authorized_at8", + "captured_at": "captured_at8", + "voided_at": "voided_at2" + }, + "refund_requires_card_presence": false, + "errors": [ + { + "category": "INVALID_REQUEST_ERROR", + "code": "INVALID_EMAIL_ADDRESS", + "detail": "detail3", + "field": "field1" + } + ] + }, + "cash_details": { + "buyer_supplied_money": { + "amount": 140, + "currency": "MYR" + }, + "change_back_money": { + "amount": 112, + "currency": "BHD" + } + }, + "bank_account_details": { + "bank_name": "bank_name4", + "transfer_type": "transfer_type8", + "account_ownership_type": "account_ownership_type8", + "fingerprint": "fingerprint6", + "country": "country4", + "statement_description": "statement_description4", + "ach_details": { + "routing_number": "routing_number0", + "account_number_suffix": "account_number_suffix8", + "account_type": "account_type2" + }, + "errors": [ + { + "category": "API_ERROR", + "code": "V1_APPLICATION", + "detail": "detail1", + "field": "field9" + }, + { + "category": "AUTHENTICATION_ERROR", + "code": "V1_ACCESS_TOKEN", + "detail": "detail2", + "field": "field0" + } + ] + }, + "external_details": { + "type": "type6", + "source": "source0", + "source_id": "source_id8", + "source_fee_money": { + "amount": 234, + "currency": "NZD" + } + }, + "wallet_details": { + "status": "status2", + "brand": "brand0", + "cash_app_details": { + "buyer_full_name": "buyer_full_name4", + "buyer_country_code": "buyer_country_code4", + "buyer_cashtag": "buyer_cashtag2" + } + }, + "buy_now_pay_later_details": { + "brand": "brand4", + "afterpay_details": { + "email_address": "email_address2" + }, + "clearpay_details": { + "email_address": "email_address4" + } + }, + "location_id": "location_id4", + "order_id": "order_id6", + "reference_id": "reference_id2", + "customer_id": "customer_id8", + "employee_id": "employee_id0", + "team_member_id": "team_member_id0", + "refund_ids": [ + "refund_ids9" + ], + "risk_evaluation": { + "created_at": "created_at0", + "risk_level": "PENDING" + }, + "buyer_email_address": "buyer_email_address8", + "billing_address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_28", + "address_line_3": "address_line_34", + "locality": "locality8", + "sublocality": "sublocality8", + "sublocality_2": "sublocality_26", + "sublocality_3": "sublocality_38", + "administrative_district_level_1": "administrative_district_level_12", + "administrative_district_level_2": "administrative_district_level_26", + "administrative_district_level_3": "administrative_district_level_36", + "postal_code": "postal_code0", + "country": "MG", + "first_name": "first_name8", + "last_name": "last_name6" + }, + "shipping_address": { + "address_line_1": "address_line_10", + "address_line_2": "address_line_20", + "address_line_3": "address_line_36", + "locality": "locality0", + "sublocality": "sublocality0", + "sublocality_2": "sublocality_28", + "sublocality_3": "sublocality_30", + "administrative_district_level_1": "administrative_district_level_14", + "administrative_district_level_2": "administrative_district_level_26", + "administrative_district_level_3": "administrative_district_level_38", + "postal_code": "postal_code2", + "country": "PT", + "first_name": "first_name0", + "last_name": "last_name8" + }, + "note": "note4", + "statement_description_identifier": "statement_description_identifier4", + "capabilities": [ + "capabilities7" + ], + "receipt_number": "receipt_number4", + "receipt_url": "receipt_url8", + "device_details": { + "device_id": "device_id2", + "device_installation_id": "device_installation_id4", + "device_name": "device_name6" + }, + "application_details": { + "square_product": "RETAIL", + "application_id": "application_id6" + }, + "version_token": "version_token4" } ``` diff --git a/doc/models/payout-entry.md b/doc/models/payout-entry.md index b8a3470d..738ad956 100644 --- a/doc/models/payout-entry.md +++ b/doc/models/payout-entry.md @@ -48,33 +48,96 @@ The total amount of the payout will equal the sum of the payout entries for a ba { "id": "id0", "payout_id": "payout_id6", - "effective_at": null, - "type": null, - "gross_amount_money": null, - "fee_amount_money": null, - "net_amount_money": null, - "type_app_fee_revenue_details": null, - "type_app_fee_refund_details": null, - "type_automatic_savings_details": null, - "type_automatic_savings_reversed_details": null, - "type_charge_details": null, - "type_deposit_fee_details": null, - "type_dispute_details": null, - "type_fee_details": null, - "type_free_processing_details": null, - "type_hold_adjustment_details": null, - "type_open_dispute_details": null, - "type_other_details": null, - "type_other_adjustment_details": null, - "type_refund_details": null, - "type_release_adjustment_details": null, - "type_reserve_hold_details": null, - "type_reserve_release_details": null, - "type_square_capital_payment_details": null, - "type_square_capital_reversed_payment_details": null, - "type_tax_on_fee_details": null, - "type_third_party_fee_details": null, - "type_third_party_fee_refund_details": null + "effective_at": "effective_at6", + "type": "CHARGE", + "gross_amount_money": { + "amount": 186, + "currency": "SVC" + }, + "fee_amount_money": { + "amount": 126, + "currency": "ANG" + }, + "net_amount_money": { + "amount": 6, + "currency": "AOA" + }, + "type_app_fee_revenue_details": { + "payment_id": "payment_id0", + "location_id": "location_id4" + }, + "type_app_fee_refund_details": { + "payment_id": "payment_id6", + "refund_id": "refund_id0", + "location_id": "location_id0" + }, + "type_automatic_savings_details": { + "payment_id": "payment_id4", + "payout_id": "payout_id0" + }, + "type_automatic_savings_reversed_details": { + "payment_id": "payment_id8", + "payout_id": "payout_id4" + }, + "type_charge_details": { + "payment_id": "payment_id4" + }, + "type_deposit_fee_details": { + "payout_id": "payout_id8" + }, + "type_dispute_details": { + "payment_id": "payment_id4", + "dispute_id": "dispute_id6" + }, + "type_fee_details": { + "payment_id": "payment_id8" + }, + "type_free_processing_details": { + "payment_id": "payment_id4" + }, + "type_hold_adjustment_details": { + "payment_id": "payment_id8" + }, + "type_open_dispute_details": { + "payment_id": "payment_id6", + "dispute_id": "dispute_id8" + }, + "type_other_details": { + "payment_id": "payment_id8" + }, + "type_other_adjustment_details": { + "payment_id": "payment_id6" + }, + "type_refund_details": { + "payment_id": "payment_id8", + "refund_id": "refund_id2" + }, + "type_release_adjustment_details": { + "payment_id": "payment_id4" + }, + "type_reserve_hold_details": { + "payment_id": "payment_id4" + }, + "type_reserve_release_details": { + "payment_id": "payment_id6" + }, + "type_square_capital_payment_details": { + "payment_id": "payment_id2" + }, + "type_square_capital_reversed_payment_details": { + "payment_id": "payment_id6" + }, + "type_tax_on_fee_details": { + "payment_id": "payment_id4", + "tax_rate_description": "tax_rate_description2" + }, + "type_third_party_fee_details": { + "payment_id": "payment_id2" + }, + "type_third_party_fee_refund_details": { + "payment_id": "payment_id8", + "refund_id": "refund_id2" + } } ``` diff --git a/doc/models/payout-fee.md b/doc/models/payout-fee.md index 30a726f5..77226e9c 100644 --- a/doc/models/payout-fee.md +++ b/doc/models/payout-fee.md @@ -19,9 +19,12 @@ Represents a payout fee that can incur as part of a payout. ```json { - "amount_money": null, - "effective_at": null, - "type": null + "amount_money": { + "amount": 186, + "currency": "NGN" + }, + "effective_at": "effective_at6", + "type": "TRANSFER_FEE" } ``` diff --git a/doc/models/payout.md b/doc/models/payout.md index 4cdd0727..1112d7bf 100644 --- a/doc/models/payout.md +++ b/doc/models/payout.md @@ -19,7 +19,7 @@ external bank account or to the Square balance. | `updatedAt` | `string \| undefined` | Optional | The timestamp of when the payout was last updated, in RFC 3339 format. | | `amountMoney` | [`Money \| undefined`](../../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. | | `destination` | [`Destination \| undefined`](../../doc/models/destination.md) | Optional | Information about the destination against which the payout was made. | -| `version` | `number \| undefined` | 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. | +| `version` | `number \| undefined` | 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. | | `type` | [`string \| undefined`](../../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. | | `payoutFee` | [`PayoutFee[] \| undefined`](../../doc/models/payout-fee.md) | Optional | A list of transfer fees and any taxes on the fees assessed by Square for this payout. | | `arrivalDate` | `string \| undefined` | Optional | The calendar date, in ISO 8601 format (YYYY-MM-DD), when the payout is due to arrive in the seller’s banking destination. | @@ -29,16 +29,47 @@ external bank account or to the Square balance. ```json { "id": "id0", - "status": null, + "status": "PAID", "location_id": "location_id4", - "created_at": null, - "updated_at": null, - "amount_money": null, - "destination": null, - "version": null, - "type": null, - "payout_fee": null, - "arrival_date": null + "created_at": "created_at2", + "updated_at": "updated_at4", + "amount_money": { + "amount": 186, + "currency": "NGN" + }, + "destination": { + "type": "BANK_ACCOUNT", + "id": "id4" + }, + "version": 172, + "type": "BATCH", + "payout_fee": [ + { + "amount_money": { + "amount": 84, + "currency": "MZN" + }, + "effective_at": "effective_at0", + "type": "TRANSFER_FEE" + }, + { + "amount_money": { + "amount": 85, + "currency": "NAD" + }, + "effective_at": "effective_at1", + "type": "TAX_ON_TRANSFER_FEE" + }, + { + "amount_money": { + "amount": 86, + "currency": "NGN" + }, + "effective_at": "effective_at2", + "type": "TRANSFER_FEE" + } + ], + "arrival_date": "arrival_date0" } ``` diff --git a/doc/models/pre-populated-data.md b/doc/models/pre-populated-data.md index f80f9571..896dc027 100644 --- a/doc/models/pre-populated-data.md +++ b/doc/models/pre-populated-data.md @@ -21,9 +21,24 @@ see [Optional Checkout Configurations](https://developer.squareup.com/docs/check ```json { - "buyer_email": null, - "buyer_phone_number": null, - "buyer_address": null + "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", + "sublocality_2": "sublocality_20", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_16", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_30", + "postal_code": "postal_code4", + "country": "IO", + "first_name": "first_name2", + "last_name": "last_name0" + } } ``` diff --git a/doc/models/processing-fee.md b/doc/models/processing-fee.md index 46cbf638..3b39f088 100644 --- a/doc/models/processing-fee.md +++ b/doc/models/processing-fee.md @@ -19,9 +19,12 @@ Represents the Square processing fee. ```json { - "effective_at": null, - "type": null, - "amount_money": null + "effective_at": "effective_at6", + "type": "type0", + "amount_money": { + "amount": 186, + "currency": "NGN" + } } ``` diff --git a/doc/models/publish-invoice-request.md b/doc/models/publish-invoice-request.md index 8c688289..bb00d2c0 100644 --- a/doc/models/publish-invoice-request.md +++ b/doc/models/publish-invoice-request.md @@ -11,7 +11,7 @@ Describes a `PublishInvoice` request. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `version` | `number` | Required | The version of the [invoice](../../doc/models/invoice.md) to publish.
This must match the current version of the invoice; otherwise, the request is rejected. | +| `version` | `number` | Required | The version of the [invoice](entity:Invoice) to publish.
This must match the current version of the invoice; otherwise, the request is rejected. | | `idempotencyKey` | `string \| undefined` | 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/working-with-apis/idempotency).
**Constraints**: *Maximum Length*: `128` | ## Example (as JSON) diff --git a/doc/models/quantity-ratio.md b/doc/models/quantity-ratio.md index 79e8cc89..040a8d52 100644 --- a/doc/models/quantity-ratio.md +++ b/doc/models/quantity-ratio.md @@ -18,8 +18,8 @@ A whole number or unreduced fractional ratio. ```json { - "quantity": null, - "quantity_denominator": null + "quantity": 68, + "quantity_denominator": 0 } ``` diff --git a/doc/models/quick-pay.md b/doc/models/quick-pay.md index 4824c1d2..cc9ca59a 100644 --- a/doc/models/quick-pay.md +++ b/doc/models/quick-pay.md @@ -23,8 +23,8 @@ see [Quick Pay Checkout](https://developer.squareup.com/docs/checkout-api/quick- { "name": "name0", "price_money": { - "amount": null, - "currency": null + "amount": 202, + "currency": "BBD" }, "location_id": "location_id4" } diff --git a/doc/models/range.md b/doc/models/range.md index d40ba263..aae35d64 100644 --- a/doc/models/range.md +++ b/doc/models/range.md @@ -18,8 +18,8 @@ The range of a number value between the specified lower and upper bounds. ```json { - "min": null, - "max": null + "min": "min2", + "max": "max0" } ``` diff --git a/doc/models/receipt-options.md b/doc/models/receipt-options.md index 8928a9f0..80005e02 100644 --- a/doc/models/receipt-options.md +++ b/doc/models/receipt-options.md @@ -20,8 +20,8 @@ Describes receipt action fields. ```json { "payment_id": "payment_id0", - "print_only": null, - "is_duplicate": null + "print_only": false, + "is_duplicate": false } ``` diff --git a/doc/models/redeem-loyalty-reward-request.md b/doc/models/redeem-loyalty-reward-request.md index d4303db6..77dc305f 100644 --- a/doc/models/redeem-loyalty-reward-request.md +++ b/doc/models/redeem-loyalty-reward-request.md @@ -12,7 +12,7 @@ A request to redeem a loyalty reward. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `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` | -| `locationId` | `string` | Required | The ID of the [location](../../doc/models/location.md) where the reward is redeemed.
**Constraints**: *Minimum Length*: `1` | +| `locationId` | `string` | Required | The ID of the [location](entity:Location) where the reward is redeemed.
**Constraints**: *Minimum Length*: `1` | ## Example (as JSON) diff --git a/doc/models/refund-payment-request.md b/doc/models/refund-payment-request.md index 752c5a7b..9abc01ca 100644 --- a/doc/models/refund-payment-request.md +++ b/doc/models/refund-payment-request.md @@ -18,10 +18,10 @@ Describes a request to refund a payment using [RefundPayment](../../doc/api/refu | `destinationId` | `string \| undefined` | Optional | The ID indicating where funds will be refunded to, if this is an unlinked refund.
This can be any of the following: A token generated by Web Payments SDK;
a card-on-file identifier.
Required for requests specifying unlinked=true.
Otherwise, if included when `unlinked=false`, will throw an error. | | `unlinked` | `boolean \| undefined` | 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. | | `locationId` | `string \| undefined` | 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` | -| `customerId` | `string \| undefined` | Optional | The [Customer](../../doc/models/customer.md) 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`. | +| `customerId` | `string \| undefined` | 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`. | | `reason` | `string \| undefined` | Optional | A description of the reason for the refund.
**Constraints**: *Maximum Length*: `192` | | `paymentVersionToken` | `string \| undefined` | 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. | -| `teamMemberId` | `string \| undefined` | Optional | An optional [TeamMember](../../doc/models/team-member.md) ID to associate with this refund.
**Constraints**: *Maximum Length*: `192` | +| `teamMemberId` | `string \| undefined` | Optional | An optional [TeamMember](entity:TeamMember) ID to associate with this refund.
**Constraints**: *Maximum Length*: `192` | ## Example (as JSON) diff --git a/doc/models/refund.md b/doc/models/refund.md index 9616bd51..b8dcaba4 100644 --- a/doc/models/refund.md +++ b/doc/models/refund.md @@ -28,17 +28,48 @@ Represents a refund processed for a Square transaction. { "id": "id0", "location_id": "location_id4", - "transaction_id": null, + "transaction_id": "transaction_id8", "tender_id": "tender_id8", - "created_at": null, + "created_at": "created_at2", "reason": "reason4", "amount_money": { - "amount": null, - "currency": null + "amount": 186, + "currency": "NGN" }, "status": "PENDING", - "processing_fee_money": null, - "additional_recipients": null + "processing_fee_money": { + "amount": 112, + "currency": "XBB" + }, + "additional_recipients": [ + { + "location_id": "location_id3", + "description": "description9", + "amount_money": { + "amount": 83, + "currency": "ALL" + }, + "receivable_id": "receivable_id9" + }, + { + "location_id": "location_id4", + "description": "description0", + "amount_money": { + "amount": 84, + "currency": "AMD" + }, + "receivable_id": "receivable_id0" + }, + { + "location_id": "location_id5", + "description": "description1", + "amount_money": { + "amount": 85, + "currency": "ANG" + }, + "receivable_id": "receivable_id1" + } + ] } ``` diff --git a/doc/models/resume-subscription-request.md b/doc/models/resume-subscription-request.md index 2ed9e5f5..f9aae351 100644 --- a/doc/models/resume-subscription-request.md +++ b/doc/models/resume-subscription-request.md @@ -19,8 +19,8 @@ Defines input parameters in a request to the ```json { - "resume_effective_date": null, - "resume_change_timing": null + "resume_effective_date": "resume_effective_date2", + "resume_change_timing": "IMMEDIATE" } ``` diff --git a/doc/models/retrieve-booking-custom-attribute-definition-request.md b/doc/models/retrieve-booking-custom-attribute-definition-request.md index ed04c84c..934ae8ad 100644 --- a/doc/models/retrieve-booking-custom-attribute-definition-request.md +++ b/doc/models/retrieve-booking-custom-attribute-definition-request.md @@ -17,7 +17,7 @@ Represents a [RetrieveBookingCustomAttributeDefinition](../../doc/api/booking-cu ```json { - "version": null + "version": 172 } ``` diff --git a/doc/models/retrieve-booking-custom-attribute-request.md b/doc/models/retrieve-booking-custom-attribute-request.md index f8ff3df7..873aea56 100644 --- a/doc/models/retrieve-booking-custom-attribute-request.md +++ b/doc/models/retrieve-booking-custom-attribute-request.md @@ -11,15 +11,15 @@ Represents a [RetrieveBookingCustomAttribute](../../doc/api/booking-custom-attri | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `withDefinition` | `boolean \| undefined` | Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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`. | +| `withDefinition` | `boolean \| undefined` | 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`. | | `version` | `number \| undefined` | 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. | ## Example (as JSON) ```json { - "with_definition": null, - "version": null + "with_definition": false, + "version": 172 } ``` diff --git a/doc/models/retrieve-booking-custom-attribute-response.md b/doc/models/retrieve-booking-custom-attribute-response.md index ac4f006c..fc39db1d 100644 --- a/doc/models/retrieve-booking-custom-attribute-response.md +++ b/doc/models/retrieve-booking-custom-attribute-response.md @@ -19,8 +19,50 @@ Either `custom_attribute_definition` or `errors` is present in the response. ```json { - "custom_attribute": null, - "errors": null + "custom_attribute": { + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/retrieve-catalog-object-request.md b/doc/models/retrieve-catalog-object-request.md index 6255142e..a68832ca 100644 --- a/doc/models/retrieve-catalog-object-request.md +++ b/doc/models/retrieve-catalog-object-request.md @@ -16,8 +16,8 @@ ```json { - "include_related_objects": null, - "catalog_version": null + "include_related_objects": false, + "catalog_version": 126 } ``` diff --git a/doc/models/retrieve-customer-custom-attribute-definition-request.md b/doc/models/retrieve-customer-custom-attribute-definition-request.md index 1f82d60f..28187e0d 100644 --- a/doc/models/retrieve-customer-custom-attribute-definition-request.md +++ b/doc/models/retrieve-customer-custom-attribute-definition-request.md @@ -17,7 +17,7 @@ Represents a [RetrieveCustomerCustomAttributeDefinition](../../doc/api/customer- ```json { - "version": null + "version": 172 } ``` diff --git a/doc/models/retrieve-customer-custom-attribute-request.md b/doc/models/retrieve-customer-custom-attribute-request.md index 0fbe99fb..502048b0 100644 --- a/doc/models/retrieve-customer-custom-attribute-request.md +++ b/doc/models/retrieve-customer-custom-attribute-request.md @@ -11,15 +11,15 @@ Represents a [RetrieveCustomerCustomAttribute](../../doc/api/customer-custom-att | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `withDefinition` | `boolean \| undefined` | Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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`. | +| `withDefinition` | `boolean \| undefined` | 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`. | | `version` | `number \| undefined` | 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. | ## Example (as JSON) ```json { - "with_definition": null, - "version": null + "with_definition": false, + "version": 172 } ``` diff --git a/doc/models/retrieve-customer-custom-attribute-response.md b/doc/models/retrieve-customer-custom-attribute-response.md index a8969b99..5cc03490 100644 --- a/doc/models/retrieve-customer-custom-attribute-response.md +++ b/doc/models/retrieve-customer-custom-attribute-response.md @@ -19,8 +19,50 @@ Either `custom_attribute_definition` or `errors` is present in the response. ```json { - "custom_attribute": null, - "errors": null + "custom_attribute": { + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/retrieve-employee-response.md b/doc/models/retrieve-employee-response.md index 2746aac3..a04f395e 100644 --- a/doc/models/retrieve-employee-response.md +++ b/doc/models/retrieve-employee-response.md @@ -16,8 +16,42 @@ ```json { - "employee": null, - "errors": null + "employee": { + "id": "id8", + "first_name": "first_name8", + "last_name": "last_name6", + "email": "email8", + "phone_number": "phone_number6", + "location_ids": [ + "location_ids8", + "location_ids9", + "location_ids0" + ], + "status": "ACTIVE", + "is_owner": false, + "created_at": "created_at6", + "updated_at": "updated_at4" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/retrieve-inventory-changes-request.md b/doc/models/retrieve-inventory-changes-request.md index 893da82a..9e7bbfab 100644 --- a/doc/models/retrieve-inventory-changes-request.md +++ b/doc/models/retrieve-inventory-changes-request.md @@ -9,15 +9,15 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `locationIds` | `string \| undefined` | Optional | The [Location](../../doc/models/location.md) IDs to look up as a comma-separated
list. An empty list queries all locations. | +| `locationIds` | `string \| undefined` | Optional | The [Location](entity:Location) IDs to look up as a comma-separated
list. An empty list queries all locations. | | `cursor` | `string \| undefined` | 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. | ## Example (as JSON) ```json { - "location_ids": null, - "cursor": null + "location_ids": "location_ids0", + "cursor": "cursor6" } ``` diff --git a/doc/models/retrieve-inventory-count-request.md b/doc/models/retrieve-inventory-count-request.md index 635d6d2d..aabb1e4a 100644 --- a/doc/models/retrieve-inventory-count-request.md +++ b/doc/models/retrieve-inventory-count-request.md @@ -9,15 +9,15 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `locationIds` | `string \| undefined` | Optional | The [Location](../../doc/models/location.md) IDs to look up as a comma-separated
list. An empty list queries all locations. | +| `locationIds` | `string \| undefined` | Optional | The [Location](entity:Location) IDs to look up as a comma-separated
list. An empty list queries all locations. | | `cursor` | `string \| undefined` | 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. | ## Example (as JSON) ```json { - "location_ids": null, - "cursor": null + "location_ids": "location_ids0", + "cursor": "cursor6" } ``` diff --git a/doc/models/retrieve-location-custom-attribute-definition-request.md b/doc/models/retrieve-location-custom-attribute-definition-request.md index 3183fbbd..0102a21b 100644 --- a/doc/models/retrieve-location-custom-attribute-definition-request.md +++ b/doc/models/retrieve-location-custom-attribute-definition-request.md @@ -17,7 +17,7 @@ Represents a [RetrieveLocationCustomAttributeDefinition](../../doc/api/location- ```json { - "version": null + "version": 172 } ``` diff --git a/doc/models/retrieve-location-custom-attribute-request.md b/doc/models/retrieve-location-custom-attribute-request.md index cf8a81ca..511bbb4c 100644 --- a/doc/models/retrieve-location-custom-attribute-request.md +++ b/doc/models/retrieve-location-custom-attribute-request.md @@ -11,15 +11,15 @@ Represents a [RetrieveLocationCustomAttribute](../../doc/api/location-custom-att | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `withDefinition` | `boolean \| undefined` | Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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`. | +| `withDefinition` | `boolean \| undefined` | 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`. | | `version` | `number \| undefined` | 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. | ## Example (as JSON) ```json { - "with_definition": null, - "version": null + "with_definition": false, + "version": 172 } ``` diff --git a/doc/models/retrieve-location-custom-attribute-response.md b/doc/models/retrieve-location-custom-attribute-response.md index 383843b2..efa97885 100644 --- a/doc/models/retrieve-location-custom-attribute-response.md +++ b/doc/models/retrieve-location-custom-attribute-response.md @@ -19,8 +19,50 @@ Either `custom_attribute_definition` or `errors` is present in the response. ```json { - "custom_attribute": null, - "errors": null + "custom_attribute": { + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/retrieve-order-custom-attribute-definition-request.md b/doc/models/retrieve-order-custom-attribute-definition-request.md index 7c9ec27f..d86efbb6 100644 --- a/doc/models/retrieve-order-custom-attribute-definition-request.md +++ b/doc/models/retrieve-order-custom-attribute-definition-request.md @@ -17,7 +17,7 @@ Represents a get request for an order custom attribute definition. ```json { - "version": null + "version": 172 } ``` diff --git a/doc/models/retrieve-order-custom-attribute-request.md b/doc/models/retrieve-order-custom-attribute-request.md index 4d15fdb5..8f9246ee 100644 --- a/doc/models/retrieve-order-custom-attribute-request.md +++ b/doc/models/retrieve-order-custom-attribute-request.md @@ -12,14 +12,14 @@ Represents a get request for an order custom attribute. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `version` | `number \| undefined` | 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. | -| `withDefinition` | `boolean \| undefined` | Optional | Indicates whether to return the [custom attribute definition](../../doc/models/custom-attribute-definition.md) 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`. | +| `withDefinition` | `boolean \| undefined` | 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`. | ## Example (as JSON) ```json { - "version": null, - "with_definition": null + "version": 172, + "with_definition": false } ``` diff --git a/doc/models/retrieve-order-custom-attribute-response.md b/doc/models/retrieve-order-custom-attribute-response.md index 7cfb7cb1..7bbb2d7b 100644 --- a/doc/models/retrieve-order-custom-attribute-response.md +++ b/doc/models/retrieve-order-custom-attribute-response.md @@ -18,8 +18,50 @@ Represents a response from getting an order custom attribute. ```json { - "custom_attribute": null, - "errors": null + "custom_attribute": { + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/retrieve-payment-link-response.md b/doc/models/retrieve-payment-link-response.md index b7f0b1c8..5f395e2f 100644 --- a/doc/models/retrieve-payment-link-response.md +++ b/doc/models/retrieve-payment-link-response.md @@ -19,6 +19,7 @@ "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 diff --git a/doc/models/retrieve-subscription-request.md b/doc/models/retrieve-subscription-request.md index 3bbcdcaf..f049b4fa 100644 --- a/doc/models/retrieve-subscription-request.md +++ b/doc/models/retrieve-subscription-request.md @@ -18,7 +18,7 @@ Defines input parameters in a request to the ```json { - "include": null + "include": "include2" } ``` diff --git a/doc/models/retrieve-transaction-response.md b/doc/models/retrieve-transaction-response.md index 046e22aa..2e9f92e8 100644 --- a/doc/models/retrieve-transaction-response.md +++ b/doc/models/retrieve-transaction-response.md @@ -2,7 +2,7 @@ # Retrieve Transaction Response Defines the fields that are included in the response body of -a request to the [RetrieveTransaction](../../doc/api/transactions.md#retrieve-transaction) endpoint. +a request to the [RetrieveTransaction](api-endpoint:Transactions-RetrieveTransaction) endpoint. One of `errors` or `transaction` is present in a given response (never both). diff --git a/doc/models/retrieve-vendor-response.md b/doc/models/retrieve-vendor-response.md index 086c40b8..dc38ba66 100644 --- a/doc/models/retrieve-vendor-response.md +++ b/doc/models/retrieve-vendor-response.md @@ -18,8 +18,62 @@ Represents an output from a call to [RetrieveVendor](../../doc/api/vendors.md#re ```json { - "errors": null, - "vendor": null + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ], + "vendor": { + "id": "id6", + "created_at": "created_at4", + "updated_at": "updated_at2", + "name": "name6", + "address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_22", + "address_line_3": "address_line_38", + "locality": "locality2", + "sublocality": "sublocality2", + "sublocality_2": "sublocality_20", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_16", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_30", + "postal_code": "postal_code4", + "country": "NL", + "first_name": "first_name2", + "last_name": "last_name0" + }, + "contacts": [ + { + "id": "id3", + "name": "name3", + "email_address": "email_address1", + "phone_number": "phone_number1", + "removed": true, + "ordinal": 11 + } + ], + "account_number": "account_number6", + "note": "note2", + "version": 76, + "status": "ACTIVE" + } } ``` diff --git a/doc/models/risk-evaluation.md b/doc/models/risk-evaluation.md index d6d2bc4e..6ebb7564 100644 --- a/doc/models/risk-evaluation.md +++ b/doc/models/risk-evaluation.md @@ -23,8 +23,8 @@ provide the goods/services or refund the payment). ```json { - "created_at": null, - "risk_level": null + "created_at": "created_at2", + "risk_level": "MODERATE" } ``` diff --git a/doc/models/save-card-options.md b/doc/models/save-card-options.md index 61fec3a1..de55c818 100644 --- a/doc/models/save-card-options.md +++ b/doc/models/save-card-options.md @@ -20,8 +20,8 @@ Describes save-card action fields. ```json { "customer_id": "customer_id8", - "card_id": null, - "reference_id": null + "card_id": "card_id4", + "reference_id": "reference_id2" } ``` diff --git a/doc/models/search-availability-filter.md b/doc/models/search-availability-filter.md index 86d719bb..e2b16d6f 100644 --- a/doc/models/search-availability-filter.md +++ b/doc/models/search-availability-filter.md @@ -21,12 +21,47 @@ A query filter to search for buyer-accessible availabilities by. ```json { "start_at_range": { - "start_at": null, - "end_at": null + "start_at": "start_at6", + "end_at": "end_at6" }, - "location_id": null, - "segment_filters": null, - "booking_id": null + "location_id": "location_id4", + "segment_filters": [ + { + "service_variation_id": "service_variation_id6", + "team_member_id_filter": { + "all": [ + "all5" + ], + "any": [ + "any2", + "any3" + ], + "none": [ + "none7" + ] + } + }, + { + "service_variation_id": "service_variation_id5", + "team_member_id_filter": { + "all": [ + "all4", + "all5", + "all6" + ], + "any": [ + "any3", + "any4", + "any5" + ], + "none": [ + "none8", + "none9" + ] + } + } + ], + "booking_id": "booking_id4" } ``` diff --git a/doc/models/search-availability-query.md b/doc/models/search-availability-query.md index 97f09236..e6003c07 100644 --- a/doc/models/search-availability-query.md +++ b/doc/models/search-availability-query.md @@ -19,12 +19,64 @@ The query used to search for buyer-accessible availabilities of bookings. { "filter": { "start_at_range": { - "start_at": null, - "end_at": null + "start_at": "start_at0", + "end_at": "end_at2" }, - "location_id": null, - "segment_filters": null, - "booking_id": null + "location_id": "location_id8", + "segment_filters": [ + { + "service_variation_id": "service_variation_id8", + "team_member_id_filter": { + "all": [ + "all9", + "all8", + "all7" + ], + "any": [ + "any6", + "any7", + "any8" + ], + "none": [ + "none1", + "none2" + ] + } + }, + { + "service_variation_id": "service_variation_id9", + "team_member_id_filter": { + "all": [ + "all0", + "all9" + ], + "any": [ + "any7" + ], + "none": [ + "none2", + "none3", + "none4" + ] + } + }, + { + "service_variation_id": "service_variation_id0", + "team_member_id_filter": { + "all": [ + "all1" + ], + "any": [ + "any8", + "any9" + ], + "none": [ + "none3" + ] + } + } + ], + "booking_id": "booking_id8" } } ``` diff --git a/doc/models/search-availability-request.md b/doc/models/search-availability-request.md index 84011206..16e0d839 100644 --- a/doc/models/search-availability-request.md +++ b/doc/models/search-availability-request.md @@ -18,12 +18,28 @@ "query": { "filter": { "start_at_range": { - "start_at": null, - "end_at": null + "start_at": "start_at0", + "end_at": "end_at2" }, - "location_id": null, - "segment_filters": null, - "booking_id": null + "location_id": "location_id8", + "segment_filters": [ + { + "service_variation_id": "service_variation_id0", + "team_member_id_filter": { + "all": [ + "all9" + ], + "any": [ + "any8", + "any9" + ], + "none": [ + "none3" + ] + } + } + ], + "booking_id": "booking_id8" } } } diff --git a/doc/models/search-catalog-items-request.md b/doc/models/search-catalog-items-request.md index 6a1d9f40..fe41c45e 100644 --- a/doc/models/search-catalog-items-request.md +++ b/doc/models/search-catalog-items-request.md @@ -19,7 +19,7 @@ Defines the request body for the [SearchCatalogItems](../../doc/api/catalog.md#s | `limit` | `number \| undefined` | Optional | The maximum number of results to return per page. The default value is 100.
**Constraints**: `<= 100` | | `sortOrder` | [`string \| undefined`](../../doc/models/sort-order.md) | Optional | The order (e.g., chronological or alphabetical) in which results from a request are returned. | | `productTypes` | [`string[] \| undefined`](../../doc/models/catalog-item-product-type.md) | Optional | The product types query expression to return items or item variations having the specified product types. | -| `customAttributeFilters` | [`CustomAttributeFilter[] \| undefined`](../../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](../../doc/api/catalog.md#search-catalog-items) endpoint. | +| `customAttributeFilters` | [`CustomAttributeFilter[] \| undefined`](../../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. | ## Example (as JSON) diff --git a/doc/models/search-catalog-items-response.md b/doc/models/search-catalog-items-response.md index d39aca56..e7a50d29 100644 --- a/doc/models/search-catalog-items-response.md +++ b/doc/models/search-catalog-items-response.md @@ -20,10 +20,2374 @@ Defines the response body returned from the [SearchCatalogItems](../../doc/api/c ```json { - "errors": null, - "items": null, - "cursor": null, - "matched_variation_ids": null + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ], + "items": [ + { + "type": "PRODUCT_SET", + "id": "id7", + "updated_at": "updated_at7", + "version": 143, + "is_deleted": true, + "custom_attribute_values": { + "key0": { + "name": "name8", + "string_value": "string_value2", + "custom_attribute_definition_id": "custom_attribute_definition_id4", + "type": "STRING", + "number_value": "number_value8", + "boolean_value": false, + "selection_uid_values": [ + "selection_uid_values5" + ], + "key": "key8" + } + }, + "catalog_v1_ids": [ + { + "catalog_v1_id": "catalog_v1_id1", + "location_id": "location_id1" + }, + { + "catalog_v1_id": "catalog_v1_id2", + "location_id": "location_id2" + } + ], + "present_at_all_locations": true, + "present_at_location_ids": [ + "present_at_location_ids7" + ], + "absent_at_location_ids": [ + "absent_at_location_ids8", + "absent_at_location_ids9" + ], + "item_data": { + "name": "name1", + "description": "description1", + "abbreviation": "abbreviation3", + "label_color": "label_color3", + "available_online": true, + "available_for_pickup": true, + "available_electronically": true, + "category_id": "category_id7", + "tax_ids": [ + "tax_ids6", + "tax_ids7", + "tax_ids8" + ], + "modifier_list_info": [ + { + "modifier_list_id": "modifier_list_id1", + "modifier_overrides": [ + { + "modifier_id": "modifier_id4", + "on_by_default": false + }, + { + "modifier_id": "modifier_id5", + "on_by_default": true + } + ], + "min_selected_modifiers": 17, + "max_selected_modifiers": 253, + "enabled": true + }, + { + "modifier_list_id": "modifier_list_id2", + "modifier_overrides": [ + { + "modifier_id": "modifier_id5", + "on_by_default": true + }, + { + "modifier_id": "modifier_id6", + "on_by_default": false + }, + { + "modifier_id": "modifier_id7", + "on_by_default": true + } + ], + "min_selected_modifiers": 18, + "max_selected_modifiers": 254, + "enabled": false + }, + { + "modifier_list_id": "modifier_list_id3", + "modifier_overrides": [ + { + "modifier_id": "modifier_id6", + "on_by_default": false + } + ], + "min_selected_modifiers": 19, + "max_selected_modifiers": 255, + "enabled": true + } + ], + "variations": [ + { + "type": "CATEGORY", + "id": "id6", + "updated_at": "updated_at8", + "version": 10, + "is_deleted": false, + "custom_attribute_values": { + "key0": {} + }, + "catalog_v1_ids": [ + {}, + {} + ], + "present_at_all_locations": false, + "present_at_location_ids": [ + "present_at_location_ids6" + ], + "absent_at_location_ids": [ + "absent_at_location_ids7", + "absent_at_location_ids8" + ], + "item_data": { + "name": "name2", + "description": "description2", + "abbreviation": "abbreviation4", + "label_color": "label_color4", + "available_online": false, + "available_for_pickup": false, + "available_electronically": false, + "category_id": "category_id6", + "tax_ids": [ + "tax_ids5", + "tax_ids4", + "tax_ids3" + ], + "modifier_list_info": [ + {}, + {}, + {} + ], + "variations": [ + {}, + {} + ], + "product_type": "GIFT_CARD", + "skip_modifier_screen": false, + "item_options": [ + { + "item_option_id": "item_option_id9" + }, + { + "item_option_id": "item_option_id8" + } + ], + "image_ids": [ + "image_ids7", + "image_ids8", + "image_ids9" + ], + "sort_name": "sort_name6", + "description_html": "description_html2", + "description_plaintext": "description_plaintext2" + }, + "category_data": { + "name": "name0", + "image_ids": [ + "image_ids5" + ] + }, + "item_variation_data": { + "item_id": "item_id8", + "name": "name2", + "sku": "sku2", + "upc": "upc0", + "ordinal": 40, + "pricing_type": "FIXED_PRICING", + "price_money": { + "amount": 242, + "currency": "ANG" + }, + "location_overrides": [ + { + "location_id": "location_id7", + "price_money": { + "amount": 115, + "currency": "ILS" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 235, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until1" + } + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 214, + "user_data": "user_data4", + "service_duration": 130, + "available_for_booking": false, + "item_option_values": [ + { + "item_option_id": "item_option_id9", + "item_option_value_id": "item_option_value_id3" + }, + { + "item_option_id": "item_option_id0", + "item_option_value_id": "item_option_value_id2" + } + ], + "measurement_unit_id": "measurement_unit_id8", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids3", + "image_ids4" + ], + "team_member_ids": [ + "team_member_ids9", + "team_member_ids0", + "team_member_ids1" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id0", + "stockable_quantity": "stockable_quantity2", + "nonstockable_quantity": "nonstockable_quantity4" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids1", + "item_variation_vendor_info_ids2" + ] + }, + "tax_data": { + "name": "name0", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "percentage8", + "applies_to_custom_amounts": false, + "enabled": false + }, + "discount_data": { + "name": "name6", + "discount_type": "FIXED_PERCENTAGE", + "percentage": "percentage4", + "amount_money": {}, + "pin_required": false, + "label_color": "label_color8", + "modify_tax_basis": "MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name0", + "ordinal": 24, + "selection_type": "SINGLE", + "modifiers": [ + {}, + {}, + {} + ], + "image_ids": [ + "image_ids5", + "image_ids4", + "image_ids3" + ] + }, + "modifier_data": { + "name": "name6", + "price_money": {}, + "ordinal": 2, + "modifier_list_id": "modifier_list_id2", + "image_id": "image_id0" + }, + "time_period_data": { + "event": "event0" + }, + "product_set_data": { + "name": "name4", + "product_ids_any": [ + "product_ids_any6", + "product_ids_any5" + ], + "product_ids_all": [ + "product_ids_all5", + "product_ids_all4" + ], + "quantity_exact": 138, + "quantity_min": 16, + "quantity_max": 10, + "all_products": false + }, + "pricing_rule_data": { + "name": "name4", + "time_period_ids": [ + "time_period_ids6" + ], + "discount_id": "discount_id2", + "match_products_id": "match_products_id8", + "apply_products_id": "apply_products_id2", + "exclude_products_id": "exclude_products_id0", + "valid_from_date": "valid_from_date8", + "valid_from_local_time": "valid_from_local_time6", + "valid_until_date": "valid_until_date0", + "valid_until_local_time": "valid_until_local_time0", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any3" + ] + }, + "image_data": { + "name": "name6", + "url": "url0", + "caption": "caption0", + "photo_studio_order_id": "photo_studio_order_id8" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name8", + "abbreviation": "abbreviation0" + }, + "area_unit": "IMPERIAL_SQUARE_FOOT", + "length_unit": "METRIC_METER", + "volume_unit": "GENERIC_QUART", + "weight_unit": "IMPERIAL_STONE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_DAY", + "type": "TYPE_WEIGHT" + }, + "precision": 142 + }, + "subscription_plan_data": { + "name": "name4", + "phases": [ + { + "uid": "uid1", + "cadence": "THIRTY_DAYS", + "periods": 245, + "recurring_price_money": {}, + "ordinal": 211 + }, + { + "uid": "uid0", + "cadence": "SIXTY_DAYS", + "periods": 244, + "recurring_price_money": {}, + "ordinal": 210 + }, + { + "uid": "uid9", + "cadence": "NINETY_DAYS", + "periods": 243, + "recurring_price_money": {}, + "ordinal": 209 + } + ] + }, + "item_option_data": { + "name": "name0", + "display_name": "display_name0", + "description": "description0", + "show_colors": false, + "values": [ + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id8", + "name": "name6", + "description": "description6", + "color": "color0", + "ordinal": 222 + }, + "custom_attribute_definition_data": { + "type": "NUMBER", + "name": "name4", + "description": "description4", + "source_application": { + "product": "PAYROLL", + "application_id": "application_id2", + "name": "name6" + }, + "allowed_object_types": [ + "DISCOUNT", + "TAX", + "ITEM_VARIATION" + ], + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_HIDDEN", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 184 + }, + "selection_config": { + "max_allowed_selections": 212, + "allowed_selections": [ + { + "uid": "uid3", + "name": "name3" + } + ] + }, + "custom_attribute_usage_count": 48, + "key": "key4" + }, + "quick_amounts_settings_data": { + "option": "DISABLED", + "eligible_for_auto_amounts": false, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 138, + "ordinal": 70 + }, + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 139, + "ordinal": 71 + }, + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 140, + "ordinal": 72 + } + ] + } + }, + { + "type": "IMAGE", + "id": "id7", + "updated_at": "updated_at7", + "version": 9, + "is_deleted": true, + "custom_attribute_values": { + "key0": {}, + "key1": {}, + "key2": {} + }, + "catalog_v1_ids": [ + {}, + {}, + {} + ], + "present_at_all_locations": true, + "present_at_location_ids": [ + "present_at_location_ids7", + "present_at_location_ids8" + ], + "absent_at_location_ids": [ + "absent_at_location_ids8", + "absent_at_location_ids9", + "absent_at_location_ids0" + ], + "item_data": { + "name": "name1", + "description": "description1", + "abbreviation": "abbreviation3", + "label_color": "label_color3", + "available_online": true, + "available_for_pickup": true, + "available_electronically": true, + "category_id": "category_id7", + "tax_ids": [ + "tax_ids4" + ], + "modifier_list_info": [ + {}, + {} + ], + "variations": [ + {}, + {}, + {} + ], + "product_type": "REGULAR", + "skip_modifier_screen": true, + "item_options": [ + { + "item_option_id": "item_option_id0" + } + ], + "image_ids": [ + "image_ids6", + "image_ids7" + ], + "sort_name": "sort_name7", + "description_html": "description_html1", + "description_plaintext": "description_plaintext1" + }, + "category_data": { + "name": "name1", + "image_ids": [ + "image_ids6", + "image_ids7" + ] + }, + "item_variation_data": { + "item_id": "item_id7", + "name": "name3", + "sku": "sku1", + "upc": "upc9", + "ordinal": 41, + "pricing_type": "VARIABLE_PRICING", + "price_money": { + "amount": 241, + "currency": "AMD" + }, + "location_overrides": [ + { + "location_id": "location_id8", + "price_money": { + "amount": 116, + "currency": "INR" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 236, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until2" + }, + { + "location_id": "location_id9", + "price_money": { + "amount": 117, + "currency": "IQD" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 237, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until3" + } + ], + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 213, + "user_data": "user_data3", + "service_duration": 131, + "available_for_booking": true, + "item_option_values": [ + { + "item_option_id": "item_option_id8", + "item_option_value_id": "item_option_value_id4" + } + ], + "measurement_unit_id": "measurement_unit_id7", + "sellable": true, + "stockable": true, + "image_ids": [ + "image_ids2" + ], + "team_member_ids": [ + "team_member_ids0" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id9", + "stockable_quantity": "stockable_quantity3", + "nonstockable_quantity": "nonstockable_quantity5" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids2", + "item_variation_vendor_info_ids3", + "item_variation_vendor_info_ids4" + ] + }, + "tax_data": { + "name": "name9", + "calculation_phase": "TAX_TOTAL_PHASE", + "inclusion_type": "INCLUSIVE", + "percentage": "percentage7", + "applies_to_custom_amounts": true, + "enabled": true + }, + "discount_data": { + "name": "name5", + "discount_type": "VARIABLE_AMOUNT", + "percentage": "percentage3", + "amount_money": {}, + "pin_required": true, + "label_color": "label_color7", + "modify_tax_basis": "DO_NOT_MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name9", + "ordinal": 23, + "selection_type": "MULTIPLE", + "modifiers": [ + {}, + {} + ], + "image_ids": [ + "image_ids6", + "image_ids5" + ] + }, + "modifier_data": { + "name": "name5", + "price_money": {}, + "ordinal": 1, + "modifier_list_id": "modifier_list_id1", + "image_id": "image_id9" + }, + "time_period_data": { + "event": "event9" + }, + "product_set_data": { + "name": "name5", + "product_ids_any": [ + "product_ids_any7" + ], + "product_ids_all": [ + "product_ids_all6" + ], + "quantity_exact": 139, + "quantity_min": 17, + "quantity_max": 9, + "all_products": true + }, + "pricing_rule_data": { + "name": "name3", + "time_period_ids": [ + "time_period_ids5", + "time_period_ids6", + "time_period_ids7" + ], + "discount_id": "discount_id1", + "match_products_id": "match_products_id9", + "apply_products_id": "apply_products_id3", + "exclude_products_id": "exclude_products_id9", + "valid_from_date": "valid_from_date9", + "valid_from_local_time": "valid_from_local_time7", + "valid_until_date": "valid_until_date1", + "valid_until_local_time": "valid_until_local_time1", + "exclude_strategy": "MOST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any2", + "customer_group_ids_any3", + "customer_group_ids_any4" + ] + }, + "image_data": { + "name": "name7", + "url": "url1", + "caption": "caption1", + "photo_studio_order_id": "photo_studio_order_id9" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name7", + "abbreviation": "abbreviation9" + }, + "area_unit": "IMPERIAL_SQUARE_INCH", + "length_unit": "METRIC_KILOMETER", + "volume_unit": "GENERIC_PINT", + "weight_unit": "METRIC_MILLIGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_HOUR", + "type": "TYPE_VOLUME" + }, + "precision": 141 + }, + "subscription_plan_data": { + "name": "name3", + "phases": [ + { + "uid": "uid2", + "cadence": "EVERY_TWO_WEEKS", + "periods": 246, + "recurring_price_money": {}, + "ordinal": 212 + }, + { + "uid": "uid1", + "cadence": "THIRTY_DAYS", + "periods": 245, + "recurring_price_money": {}, + "ordinal": 211 + } + ] + }, + "item_option_data": { + "name": "name9", + "display_name": "display_name9", + "description": "description1", + "show_colors": true, + "values": [ + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id9", + "name": "name7", + "description": "description7", + "color": "color1", + "ordinal": 223 + }, + "custom_attribute_definition_data": { + "type": "BOOLEAN", + "name": "name5", + "description": "description5", + "source_application": { + "product": "DASHBOARD", + "application_id": "application_id3", + "name": "name7" + }, + "allowed_object_types": [ + "MODIFIER_LIST", + "DISCOUNT" + ], + "seller_visibility": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "app_visibility": "APP_VISIBILITY_READ_ONLY", + "string_config": { + "enforce_uniqueness": true + }, + "number_config": { + "precision": 183 + }, + "selection_config": { + "max_allowed_selections": 213, + "allowed_selections": [ + { + "uid": "uid4", + "name": "name4" + }, + { + "uid": "uid5", + "name": "name5" + } + ] + }, + "custom_attribute_usage_count": 49, + "key": "key5" + }, + "quick_amounts_settings_data": { + "option": "MANUAL", + "eligible_for_auto_amounts": true, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 139, + "ordinal": 71 + } + ] + } + } + ], + "product_type": "GIFT_CARD", + "skip_modifier_screen": true, + "item_options": [ + {}, + {}, + {} + ], + "image_ids": [ + "image_ids6", + "image_ids5" + ], + "sort_name": "sort_name7", + "description_html": "description_html1", + "description_plaintext": "description_plaintext1" + }, + "category_data": { + "name": "name1", + "image_ids": [ + "image_ids6" + ] + }, + "item_variation_data": { + "item_id": "item_id7", + "name": "name3", + "sku": "sku1", + "upc": "upc9", + "ordinal": 193, + "pricing_type": "VARIABLE_PRICING", + "price_money": {}, + "location_overrides": [ + {} + ], + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 195, + "user_data": "user_data3", + "service_duration": 27, + "available_for_booking": true, + "item_option_values": [ + {}, + {} + ], + "measurement_unit_id": "measurement_unit_id7", + "sellable": true, + "stockable": true, + "image_ids": [ + "image_ids8", + "image_ids7" + ], + "team_member_ids": [ + "team_member_ids0", + "team_member_ids1", + "team_member_ids2" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id1", + "stockable_quantity": "stockable_quantity3", + "nonstockable_quantity": "nonstockable_quantity5" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids2", + "item_variation_vendor_info_ids3" + ] + }, + "tax_data": { + "name": "name1", + "calculation_phase": "TAX_TOTAL_PHASE", + "inclusion_type": "INCLUSIVE", + "percentage": "percentage9", + "applies_to_custom_amounts": true, + "enabled": true + }, + "discount_data": { + "name": "name5", + "discount_type": "FIXED_AMOUNT", + "percentage": "percentage3", + "amount_money": {}, + "pin_required": true, + "label_color": "label_color7", + "modify_tax_basis": "DO_NOT_MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name9", + "ordinal": 127, + "selection_type": "MULTIPLE", + "modifiers": [ + {}, + {}, + {} + ], + "image_ids": [ + "image_ids6", + "image_ids7" + ] + }, + "modifier_data": { + "name": "name5", + "price_money": {}, + "ordinal": 55, + "modifier_list_id": "modifier_list_id1", + "image_id": "image_id9" + }, + "time_period_data": { + "event": "event9" + }, + "product_set_data": { + "name": "name5", + "product_ids_any": [ + "product_ids_any9", + "product_ids_any8", + "product_ids_any7" + ], + "product_ids_all": [ + "product_ids_all2", + "product_ids_all1", + "product_ids_all0" + ], + "quantity_exact": 35, + "quantity_min": 169, + "quantity_max": 143, + "all_products": true + }, + "pricing_rule_data": { + "name": "name7", + "time_period_ids": [ + "time_period_ids9", + "time_period_ids0" + ], + "discount_id": "discount_id5", + "match_products_id": "match_products_id5", + "apply_products_id": "apply_products_id9", + "exclude_products_id": "exclude_products_id3", + "valid_from_date": "valid_from_date5", + "valid_from_local_time": "valid_from_local_time3", + "valid_until_date": "valid_until_date7", + "valid_until_local_time": "valid_until_local_time7", + "exclude_strategy": "MOST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any6", + "customer_group_ids_any7" + ] + }, + "image_data": { + "name": "name7", + "url": "url1", + "caption": "caption1", + "photo_studio_order_id": "photo_studio_order_id9" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name7", + "abbreviation": "abbreviation9" + }, + "area_unit": "IMPERIAL_SQUARE_INCH", + "length_unit": "METRIC_KILOMETER", + "volume_unit": "GENERIC_CUP", + "weight_unit": "METRIC_KILOGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MINUTE", + "type": "TYPE_GENERIC" + }, + "precision": 245 + }, + "subscription_plan_data": { + "name": "name3", + "phases": [ + {}, + {} + ] + }, + "item_option_data": { + "name": "name1", + "display_name": "display_name1", + "description": "description9", + "show_colors": true, + "values": [ + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id9", + "name": "name7", + "description": "description7", + "color": "color1", + "ordinal": 119 + }, + "custom_attribute_definition_data": { + "type": "SELECTION", + "name": "name5", + "description": "description5", + "source_application": { + "product": "DASHBOARD", + "application_id": "application_id3", + "name": "name7" + }, + "allowed_object_types": [ + "IMAGE", + "ITEM" + ], + "seller_visibility": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "app_visibility": "APP_VISIBILITY_HIDDEN", + "string_config": { + "enforce_uniqueness": true + }, + "number_config": { + "precision": 31 + }, + "selection_config": { + "max_allowed_selections": 109, + "allowed_selections": [ + {} + ] + }, + "custom_attribute_usage_count": 201, + "key": "key5" + }, + "quick_amounts_settings_data": { + "option": "DISABLED", + "eligible_for_auto_amounts": true, + "amounts": [ + {}, + {}, + {} + ] + } + }, + { + "type": "PRICING_RULE", + "id": "id8", + "updated_at": "updated_at6", + "version": 144, + "is_deleted": false, + "custom_attribute_values": { + "key0": { + "name": "name9", + "string_value": "string_value3", + "custom_attribute_definition_id": "custom_attribute_definition_id3", + "type": "SELECTION", + "number_value": "number_value9", + "boolean_value": true, + "selection_uid_values": [ + "selection_uid_values6", + "selection_uid_values7" + ], + "key": "key9" + }, + "key1": { + "name": "name8", + "string_value": "string_value2", + "custom_attribute_definition_id": "custom_attribute_definition_id4", + "type": "STRING", + "number_value": "number_value8", + "boolean_value": false, + "selection_uid_values": [ + "selection_uid_values5" + ], + "key": "key8" + }, + "key2": { + "name": "name7", + "string_value": "string_value1", + "custom_attribute_definition_id": "custom_attribute_definition_id5", + "type": "BOOLEAN", + "number_value": "number_value7", + "boolean_value": true, + "selection_uid_values": [ + "selection_uid_values4", + "selection_uid_values5", + "selection_uid_values6" + ], + "key": "key7" + } + }, + "catalog_v1_ids": [ + { + "catalog_v1_id": "catalog_v1_id2", + "location_id": "location_id2" + }, + { + "catalog_v1_id": "catalog_v1_id3", + "location_id": "location_id3" + }, + { + "catalog_v1_id": "catalog_v1_id4", + "location_id": "location_id4" + } + ], + "present_at_all_locations": false, + "present_at_location_ids": [ + "present_at_location_ids8", + "present_at_location_ids9" + ], + "absent_at_location_ids": [ + "absent_at_location_ids9", + "absent_at_location_ids0", + "absent_at_location_ids1" + ], + "item_data": { + "name": "name0", + "description": "description0", + "abbreviation": "abbreviation2", + "label_color": "label_color2", + "available_online": false, + "available_for_pickup": false, + "available_electronically": false, + "category_id": "category_id8", + "tax_ids": [ + "tax_ids7" + ], + "modifier_list_info": [ + { + "modifier_list_id": "modifier_list_id0", + "modifier_overrides": [ + { + "modifier_id": "modifier_id3", + "on_by_default": true + } + ], + "min_selected_modifiers": 16, + "max_selected_modifiers": 252, + "enabled": false + }, + { + "modifier_list_id": "modifier_list_id1", + "modifier_overrides": [ + { + "modifier_id": "modifier_id4", + "on_by_default": false + }, + { + "modifier_id": "modifier_id5", + "on_by_default": true + } + ], + "min_selected_modifiers": 17, + "max_selected_modifiers": 253, + "enabled": true + } + ], + "variations": [ + { + "type": "IMAGE", + "id": "id7", + "updated_at": "updated_at7", + "version": 9, + "is_deleted": true, + "custom_attribute_values": { + "key0": {}, + "key1": {}, + "key2": {} + }, + "catalog_v1_ids": [ + {}, + {}, + {} + ], + "present_at_all_locations": true, + "present_at_location_ids": [ + "present_at_location_ids7", + "present_at_location_ids8" + ], + "absent_at_location_ids": [ + "absent_at_location_ids8", + "absent_at_location_ids9", + "absent_at_location_ids0" + ], + "item_data": { + "name": "name1", + "description": "description1", + "abbreviation": "abbreviation3", + "label_color": "label_color3", + "available_online": true, + "available_for_pickup": true, + "available_electronically": true, + "category_id": "category_id7", + "tax_ids": [ + "tax_ids4" + ], + "modifier_list_info": [ + {}, + {} + ], + "variations": [ + {}, + {}, + {} + ], + "product_type": "REGULAR", + "skip_modifier_screen": true, + "item_options": [ + { + "item_option_id": "item_option_id0" + } + ], + "image_ids": [ + "image_ids6", + "image_ids7" + ], + "sort_name": "sort_name7", + "description_html": "description_html1", + "description_plaintext": "description_plaintext1" + }, + "category_data": { + "name": "name1", + "image_ids": [ + "image_ids6", + "image_ids7" + ] + }, + "item_variation_data": { + "item_id": "item_id7", + "name": "name3", + "sku": "sku1", + "upc": "upc9", + "ordinal": 41, + "pricing_type": "VARIABLE_PRICING", + "price_money": { + "amount": 241, + "currency": "AMD" + }, + "location_overrides": [ + { + "location_id": "location_id8", + "price_money": { + "amount": 116, + "currency": "INR" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 236, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until2" + }, + { + "location_id": "location_id9", + "price_money": { + "amount": 117, + "currency": "IQD" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 237, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until3" + } + ], + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 213, + "user_data": "user_data3", + "service_duration": 131, + "available_for_booking": true, + "item_option_values": [ + { + "item_option_id": "item_option_id8", + "item_option_value_id": "item_option_value_id4" + } + ], + "measurement_unit_id": "measurement_unit_id7", + "sellable": true, + "stockable": true, + "image_ids": [ + "image_ids2" + ], + "team_member_ids": [ + "team_member_ids0" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id9", + "stockable_quantity": "stockable_quantity3", + "nonstockable_quantity": "nonstockable_quantity5" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids2", + "item_variation_vendor_info_ids3", + "item_variation_vendor_info_ids4" + ] + }, + "tax_data": { + "name": "name9", + "calculation_phase": "TAX_TOTAL_PHASE", + "inclusion_type": "INCLUSIVE", + "percentage": "percentage7", + "applies_to_custom_amounts": true, + "enabled": true + }, + "discount_data": { + "name": "name5", + "discount_type": "VARIABLE_AMOUNT", + "percentage": "percentage3", + "amount_money": {}, + "pin_required": true, + "label_color": "label_color7", + "modify_tax_basis": "DO_NOT_MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name9", + "ordinal": 23, + "selection_type": "MULTIPLE", + "modifiers": [ + {}, + {} + ], + "image_ids": [ + "image_ids6", + "image_ids5" + ] + }, + "modifier_data": { + "name": "name5", + "price_money": {}, + "ordinal": 1, + "modifier_list_id": "modifier_list_id1", + "image_id": "image_id9" + }, + "time_period_data": { + "event": "event9" + }, + "product_set_data": { + "name": "name5", + "product_ids_any": [ + "product_ids_any7" + ], + "product_ids_all": [ + "product_ids_all6" + ], + "quantity_exact": 139, + "quantity_min": 17, + "quantity_max": 9, + "all_products": true + }, + "pricing_rule_data": { + "name": "name3", + "time_period_ids": [ + "time_period_ids5", + "time_period_ids6", + "time_period_ids7" + ], + "discount_id": "discount_id1", + "match_products_id": "match_products_id9", + "apply_products_id": "apply_products_id3", + "exclude_products_id": "exclude_products_id9", + "valid_from_date": "valid_from_date9", + "valid_from_local_time": "valid_from_local_time7", + "valid_until_date": "valid_until_date1", + "valid_until_local_time": "valid_until_local_time1", + "exclude_strategy": "MOST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any2", + "customer_group_ids_any3", + "customer_group_ids_any4" + ] + }, + "image_data": { + "name": "name7", + "url": "url1", + "caption": "caption1", + "photo_studio_order_id": "photo_studio_order_id9" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name7", + "abbreviation": "abbreviation9" + }, + "area_unit": "IMPERIAL_SQUARE_INCH", + "length_unit": "METRIC_KILOMETER", + "volume_unit": "GENERIC_PINT", + "weight_unit": "METRIC_MILLIGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_HOUR", + "type": "TYPE_VOLUME" + }, + "precision": 141 + }, + "subscription_plan_data": { + "name": "name3", + "phases": [ + { + "uid": "uid2", + "cadence": "EVERY_TWO_WEEKS", + "periods": 246, + "recurring_price_money": {}, + "ordinal": 212 + }, + { + "uid": "uid1", + "cadence": "THIRTY_DAYS", + "periods": 245, + "recurring_price_money": {}, + "ordinal": 211 + } + ] + }, + "item_option_data": { + "name": "name9", + "display_name": "display_name9", + "description": "description1", + "show_colors": true, + "values": [ + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id9", + "name": "name7", + "description": "description7", + "color": "color1", + "ordinal": 223 + }, + "custom_attribute_definition_data": { + "type": "BOOLEAN", + "name": "name5", + "description": "description5", + "source_application": { + "product": "DASHBOARD", + "application_id": "application_id3", + "name": "name7" + }, + "allowed_object_types": [ + "MODIFIER_LIST", + "DISCOUNT" + ], + "seller_visibility": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "app_visibility": "APP_VISIBILITY_READ_ONLY", + "string_config": { + "enforce_uniqueness": true + }, + "number_config": { + "precision": 183 + }, + "selection_config": { + "max_allowed_selections": 213, + "allowed_selections": [ + { + "uid": "uid4", + "name": "name4" + }, + { + "uid": "uid5", + "name": "name5" + } + ] + }, + "custom_attribute_usage_count": 49, + "key": "key5" + }, + "quick_amounts_settings_data": { + "option": "MANUAL", + "eligible_for_auto_amounts": true, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 139, + "ordinal": 71 + } + ] + } + }, + { + "type": "ITEM", + "id": "id8", + "updated_at": "updated_at6", + "version": 8, + "is_deleted": false, + "custom_attribute_values": { + "key0": {}, + "key1": {} + }, + "catalog_v1_ids": [ + {} + ], + "present_at_all_locations": false, + "present_at_location_ids": [ + "present_at_location_ids8", + "present_at_location_ids9", + "present_at_location_ids0" + ], + "absent_at_location_ids": [ + "absent_at_location_ids9" + ], + "item_data": { + "name": "name0", + "description": "description0", + "abbreviation": "abbreviation2", + "label_color": "label_color2", + "available_online": false, + "available_for_pickup": false, + "available_electronically": false, + "category_id": "category_id8", + "tax_ids": [ + "tax_ids3", + "tax_ids2" + ], + "modifier_list_info": [ + {} + ], + "variations": [ + {} + ], + "product_type": "APPOINTMENTS_SERVICE", + "skip_modifier_screen": false, + "item_options": [ + { + "item_option_id": "item_option_id1" + }, + { + "item_option_id": "item_option_id0" + }, + { + "item_option_id": "item_option_id9" + } + ], + "image_ids": [ + "image_ids5" + ], + "sort_name": "sort_name8", + "description_html": "description_html0", + "description_plaintext": "description_plaintext0" + }, + "category_data": { + "name": "name2", + "image_ids": [ + "image_ids7", + "image_ids8", + "image_ids9" + ] + }, + "item_variation_data": { + "item_id": "item_id6", + "name": "name4", + "sku": "sku0", + "upc": "upc8", + "ordinal": 42, + "pricing_type": "FIXED_PRICING", + "price_money": { + "amount": 240, + "currency": "ALL" + }, + "location_overrides": [ + { + "location_id": "location_id9", + "price_money": { + "amount": 117, + "currency": "IQD" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 237, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until3" + }, + { + "location_id": "location_id0", + "price_money": { + "amount": 118, + "currency": "IRR" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 238, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until4" + }, + { + "location_id": "location_id1", + "price_money": { + "amount": 119, + "currency": "ISK" + }, + "pricing_type": "VARIABLE_PRICING", + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 239, + "sold_out": true, + "sold_out_valid_until": "sold_out_valid_until5" + } + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 212, + "user_data": "user_data2", + "service_duration": 132, + "available_for_booking": false, + "item_option_values": [ + { + "item_option_id": "item_option_id7", + "item_option_value_id": "item_option_value_id5" + }, + { + "item_option_id": "item_option_id8", + "item_option_value_id": "item_option_value_id4" + }, + { + "item_option_id": "item_option_id9", + "item_option_value_id": "item_option_value_id3" + } + ], + "measurement_unit_id": "measurement_unit_id6", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids1", + "image_ids2", + "image_ids3" + ], + "team_member_ids": [ + "team_member_ids1", + "team_member_ids2" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id8", + "stockable_quantity": "stockable_quantity4", + "nonstockable_quantity": "nonstockable_quantity6" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids3" + ] + }, + "tax_data": { + "name": "name8", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "percentage6", + "applies_to_custom_amounts": false, + "enabled": false + }, + "discount_data": { + "name": "name4", + "discount_type": "VARIABLE_PERCENTAGE", + "percentage": "percentage2", + "amount_money": {}, + "pin_required": false, + "label_color": "label_color6", + "modify_tax_basis": "MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name8", + "ordinal": 22, + "selection_type": "SINGLE", + "modifiers": [ + {} + ], + "image_ids": [ + "image_ids7" + ] + }, + "modifier_data": { + "name": "name4", + "price_money": {}, + "ordinal": 0, + "modifier_list_id": "modifier_list_id0", + "image_id": "image_id8" + }, + "time_period_data": { + "event": "event8" + }, + "product_set_data": { + "name": "name6", + "product_ids_any": [ + "product_ids_any8", + "product_ids_any7", + "product_ids_any6" + ], + "product_ids_all": [ + "product_ids_all7", + "product_ids_all6", + "product_ids_all5" + ], + "quantity_exact": 140, + "quantity_min": 18, + "quantity_max": 8, + "all_products": false + }, + "pricing_rule_data": { + "name": "name2", + "time_period_ids": [ + "time_period_ids4", + "time_period_ids5" + ], + "discount_id": "discount_id0", + "match_products_id": "match_products_id0", + "apply_products_id": "apply_products_id4", + "exclude_products_id": "exclude_products_id8", + "valid_from_date": "valid_from_date0", + "valid_from_local_time": "valid_from_local_time8", + "valid_until_date": "valid_until_date2", + "valid_until_local_time": "valid_until_local_time2", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any1", + "customer_group_ids_any2" + ] + }, + "image_data": { + "name": "name8", + "url": "url2", + "caption": "caption2", + "photo_studio_order_id": "photo_studio_order_id0" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name6", + "abbreviation": "abbreviation8" + }, + "area_unit": "IMPERIAL_ACRE", + "length_unit": "IMPERIAL_INCH", + "volume_unit": "GENERIC_CUP", + "weight_unit": "METRIC_GRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MINUTE", + "type": "TYPE_LENGTH" + }, + "precision": 140 + }, + "subscription_plan_data": { + "name": "name2", + "phases": [ + { + "uid": "uid3", + "cadence": "WEEKLY", + "periods": 247, + "recurring_price_money": {}, + "ordinal": 213 + } + ] + }, + "item_option_data": { + "name": "name8", + "display_name": "display_name8", + "description": "description2", + "show_colors": false, + "values": [ + {}, + {}, + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id0", + "name": "name8", + "description": "description8", + "color": "color2", + "ordinal": 224 + }, + "custom_attribute_definition_data": { + "type": "STRING", + "name": "name6", + "description": "description6", + "source_application": { + "product": "ITEM_LIBRARY_IMPORT", + "application_id": "application_id4", + "name": "name8" + }, + "allowed_object_types": [ + "MODIFIER" + ], + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_READ_WRITE_VALUES", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 182 + }, + "selection_config": { + "max_allowed_selections": 214, + "allowed_selections": [ + { + "uid": "uid5", + "name": "name5" + }, + { + "uid": "uid6", + "name": "name6" + }, + { + "uid": "uid7", + "name": "name7" + } + ] + }, + "custom_attribute_usage_count": 50, + "key": "key6" + }, + "quick_amounts_settings_data": { + "option": "AUTO", + "eligible_for_auto_amounts": false, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 140, + "ordinal": 72 + }, + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 141, + "ordinal": 73 + } + ] + } + }, + { + "type": "SUBSCRIPTION_PLAN", + "id": "id9", + "updated_at": "updated_at5", + "version": 7, + "is_deleted": true, + "custom_attribute_values": { + "key0": {} + }, + "catalog_v1_ids": [ + {}, + {} + ], + "present_at_all_locations": true, + "present_at_location_ids": [ + "present_at_location_ids9" + ], + "absent_at_location_ids": [ + "absent_at_location_ids0", + "absent_at_location_ids1" + ], + "item_data": { + "name": "name9", + "description": "description9", + "abbreviation": "abbreviation1", + "label_color": "label_color1", + "available_online": true, + "available_for_pickup": true, + "available_electronically": true, + "category_id": "category_id9", + "tax_ids": [ + "tax_ids2", + "tax_ids1", + "tax_ids0" + ], + "modifier_list_info": [ + {}, + {}, + {} + ], + "variations": [ + {}, + {} + ], + "product_type": "GIFT_CARD", + "skip_modifier_screen": true, + "item_options": [ + { + "item_option_id": "item_option_id2" + }, + { + "item_option_id": "item_option_id1" + } + ], + "image_ids": [ + "image_ids4", + "image_ids5", + "image_ids6" + ], + "sort_name": "sort_name9", + "description_html": "description_html9", + "description_plaintext": "description_plaintext9" + }, + "category_data": { + "name": "name3", + "image_ids": [ + "image_ids8" + ] + }, + "item_variation_data": { + "item_id": "item_id5", + "name": "name5", + "sku": "sku9", + "upc": "upc7", + "ordinal": 43, + "pricing_type": "VARIABLE_PRICING", + "price_money": { + "amount": 239, + "currency": "AFN" + }, + "location_overrides": [ + { + "location_id": "location_id0", + "price_money": { + "amount": 118, + "currency": "IRR" + }, + "pricing_type": "FIXED_PRICING", + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 238, + "sold_out": false, + "sold_out_valid_until": "sold_out_valid_until4" + } + ], + "track_inventory": true, + "inventory_alert_type": "LOW_QUANTITY", + "inventory_alert_threshold": 211, + "user_data": "user_data1", + "service_duration": 133, + "available_for_booking": true, + "item_option_values": [ + { + "item_option_id": "item_option_id6", + "item_option_value_id": "item_option_value_id6" + }, + { + "item_option_id": "item_option_id7", + "item_option_value_id": "item_option_value_id5" + } + ], + "measurement_unit_id": "measurement_unit_id5", + "sellable": true, + "stockable": true, + "image_ids": [ + "image_ids0", + "image_ids1" + ], + "team_member_ids": [ + "team_member_ids2", + "team_member_ids3", + "team_member_ids4" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id7", + "stockable_quantity": "stockable_quantity5", + "nonstockable_quantity": "nonstockable_quantity7" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids4", + "item_variation_vendor_info_ids5" + ] + }, + "tax_data": { + "name": "name7", + "calculation_phase": "TAX_TOTAL_PHASE", + "inclusion_type": "INCLUSIVE", + "percentage": "percentage5", + "applies_to_custom_amounts": true, + "enabled": true + }, + "discount_data": { + "name": "name3", + "discount_type": "FIXED_AMOUNT", + "percentage": "percentage1", + "amount_money": {}, + "pin_required": true, + "label_color": "label_color5", + "modify_tax_basis": "DO_NOT_MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name7", + "ordinal": 21, + "selection_type": "MULTIPLE", + "modifiers": [ + {}, + {}, + {} + ], + "image_ids": [ + "image_ids8", + "image_ids7", + "image_ids6" + ] + }, + "modifier_data": { + "name": "name3", + "price_money": {}, + "ordinal": 255, + "modifier_list_id": "modifier_list_id9", + "image_id": "image_id7" + }, + "time_period_data": { + "event": "event7" + }, + "product_set_data": { + "name": "name7", + "product_ids_any": [ + "product_ids_any9", + "product_ids_any8" + ], + "product_ids_all": [ + "product_ids_all8", + "product_ids_all7" + ], + "quantity_exact": 141, + "quantity_min": 19, + "quantity_max": 7, + "all_products": true + }, + "pricing_rule_data": { + "name": "name1", + "time_period_ids": [ + "time_period_ids3" + ], + "discount_id": "discount_id9", + "match_products_id": "match_products_id1", + "apply_products_id": "apply_products_id5", + "exclude_products_id": "exclude_products_id7", + "valid_from_date": "valid_from_date1", + "valid_from_local_time": "valid_from_local_time9", + "valid_until_date": "valid_until_date3", + "valid_until_local_time": "valid_until_local_time3", + "exclude_strategy": "MOST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any0" + ] + }, + "image_data": { + "name": "name9", + "url": "url3", + "caption": "caption3", + "photo_studio_order_id": "photo_studio_order_id1" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name5", + "abbreviation": "abbreviation7" + }, + "area_unit": "METRIC_SQUARE_KILOMETER", + "length_unit": "IMPERIAL_FOOT", + "volume_unit": "GENERIC_SHOT", + "weight_unit": "METRIC_KILOGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_SECOND", + "type": "TYPE_AREA" + }, + "precision": 139 + }, + "subscription_plan_data": { + "name": "name1", + "phases": [ + { + "uid": "uid4", + "cadence": "DAILY", + "periods": 248, + "recurring_price_money": {}, + "ordinal": 214 + }, + { + "uid": "uid3", + "cadence": "WEEKLY", + "periods": 247, + "recurring_price_money": {}, + "ordinal": 213 + }, + { + "uid": "uid2", + "cadence": "EVERY_TWO_WEEKS", + "periods": 246, + "recurring_price_money": {}, + "ordinal": 212 + } + ] + }, + "item_option_data": { + "name": "name7", + "display_name": "display_name7", + "description": "description3", + "show_colors": true, + "values": [ + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id1", + "name": "name9", + "description": "description9", + "color": "color3", + "ordinal": 225 + }, + "custom_attribute_definition_data": { + "type": "SELECTION", + "name": "name7", + "description": "description7", + "source_application": { + "product": "OTHER", + "application_id": "application_id5", + "name": "name9" + }, + "allowed_object_types": [ + "PRICING_RULE", + "MODIFIER", + "MODIFIER_LIST" + ], + "seller_visibility": "SELLER_VISIBILITY_READ_WRITE_VALUES", + "app_visibility": "APP_VISIBILITY_HIDDEN", + "string_config": { + "enforce_uniqueness": true + }, + "number_config": { + "precision": 181 + }, + "selection_config": { + "max_allowed_selections": 215, + "allowed_selections": [ + { + "uid": "uid6", + "name": "name6" + } + ] + }, + "custom_attribute_usage_count": 51, + "key": "key7" + }, + "quick_amounts_settings_data": { + "option": "DISABLED", + "eligible_for_auto_amounts": true, + "amounts": [ + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 141, + "ordinal": 73 + }, + { + "type": "QUICK_AMOUNT_TYPE_MANUAL", + "amount": {}, + "score": 142, + "ordinal": 74 + }, + { + "type": "QUICK_AMOUNT_TYPE_AUTO", + "amount": {}, + "score": 143, + "ordinal": 75 + } + ] + } + } + ], + "product_type": "REGULAR", + "skip_modifier_screen": false, + "item_options": [ + {} + ], + "image_ids": [ + "image_ids5", + "image_ids4", + "image_ids3" + ], + "sort_name": "sort_name8", + "description_html": "description_html0", + "description_plaintext": "description_plaintext0" + }, + "category_data": { + "name": "name2", + "image_ids": [ + "image_ids7", + "image_ids8" + ] + }, + "item_variation_data": { + "item_id": "item_id6", + "name": "name4", + "sku": "sku0", + "upc": "upc8", + "ordinal": 194, + "pricing_type": "FIXED_PRICING", + "price_money": {}, + "location_overrides": [ + {}, + {} + ], + "track_inventory": false, + "inventory_alert_type": "NONE", + "inventory_alert_threshold": 196, + "user_data": "user_data2", + "service_duration": 28, + "available_for_booking": false, + "item_option_values": [ + {} + ], + "measurement_unit_id": "measurement_unit_id6", + "sellable": false, + "stockable": false, + "image_ids": [ + "image_ids9" + ], + "team_member_ids": [ + "team_member_ids1" + ], + "stockable_conversion": { + "stockable_item_variation_id": "stockable_item_variation_id2", + "stockable_quantity": "stockable_quantity4", + "nonstockable_quantity": "nonstockable_quantity6" + }, + "item_variation_vendor_info_ids": [ + "item_variation_vendor_info_ids3", + "item_variation_vendor_info_ids4", + "item_variation_vendor_info_ids5" + ] + }, + "tax_data": { + "name": "name2", + "calculation_phase": "TAX_SUBTOTAL_PHASE", + "inclusion_type": "ADDITIVE", + "percentage": "percentage0", + "applies_to_custom_amounts": false, + "enabled": false + }, + "discount_data": { + "name": "name6", + "discount_type": "VARIABLE_PERCENTAGE", + "percentage": "percentage4", + "amount_money": {}, + "pin_required": false, + "label_color": "label_color8", + "modify_tax_basis": "MODIFY_TAX_BASIS", + "maximum_amount_money": {} + }, + "modifier_list_data": { + "name": "name8", + "ordinal": 126, + "selection_type": "SINGLE", + "modifiers": [ + {}, + {} + ], + "image_ids": [ + "image_ids7", + "image_ids8", + "image_ids9" + ] + }, + "modifier_data": { + "name": "name6", + "price_money": {}, + "ordinal": 56, + "modifier_list_id": "modifier_list_id2", + "image_id": "image_id0" + }, + "time_period_data": { + "event": "event8" + }, + "product_set_data": { + "name": "name6", + "product_ids_any": [ + "product_ids_any8" + ], + "product_ids_all": [ + "product_ids_all1" + ], + "quantity_exact": 36, + "quantity_min": 170, + "quantity_max": 144, + "all_products": false + }, + "pricing_rule_data": { + "name": "name8", + "time_period_ids": [ + "time_period_ids0", + "time_period_ids1", + "time_period_ids2" + ], + "discount_id": "discount_id6", + "match_products_id": "match_products_id4", + "apply_products_id": "apply_products_id8", + "exclude_products_id": "exclude_products_id4", + "valid_from_date": "valid_from_date4", + "valid_from_local_time": "valid_from_local_time2", + "valid_until_date": "valid_until_date6", + "valid_until_local_time": "valid_until_local_time6", + "exclude_strategy": "LEAST_EXPENSIVE", + "minimum_order_subtotal_money": {}, + "customer_group_ids_any": [ + "customer_group_ids_any7", + "customer_group_ids_any8", + "customer_group_ids_any9" + ] + }, + "image_data": { + "name": "name8", + "url": "url2", + "caption": "caption2", + "photo_studio_order_id": "photo_studio_order_id0" + }, + "measurement_unit_data": { + "measurement_unit": { + "custom_unit": { + "name": "name6", + "abbreviation": "abbreviation8" + }, + "area_unit": "IMPERIAL_ACRE", + "length_unit": "IMPERIAL_INCH", + "volume_unit": "GENERIC_SHOT", + "weight_unit": "IMPERIAL_WEIGHT_OUNCE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_HOUR", + "type": "TYPE_CUSTOM" + }, + "precision": 244 + }, + "subscription_plan_data": { + "name": "name2", + "phases": [ + {}, + {}, + {} + ] + }, + "item_option_data": { + "name": "name2", + "display_name": "display_name2", + "description": "description8", + "show_colors": false, + "values": [ + {} + ] + }, + "item_option_value_data": { + "item_option_id": "item_option_id0", + "name": "name8", + "description": "description8", + "color": "color2", + "ordinal": 120 + }, + "custom_attribute_definition_data": { + "type": "STRING", + "name": "name6", + "description": "description6", + "source_application": { + "product": "ITEM_LIBRARY_IMPORT", + "application_id": "application_id4", + "name": "name8" + }, + "allowed_object_types": [ + "ITEM", + "SUBSCRIPTION_PLAN", + "QUICK_AMOUNTS_SETTINGS" + ], + "seller_visibility": "SELLER_VISIBILITY_HIDDEN", + "app_visibility": "APP_VISIBILITY_READ_ONLY", + "string_config": { + "enforce_uniqueness": false + }, + "number_config": { + "precision": 30 + }, + "selection_config": { + "max_allowed_selections": 110, + "allowed_selections": [ + {}, + {} + ] + }, + "custom_attribute_usage_count": 202, + "key": "key6" + }, + "quick_amounts_settings_data": { + "option": "MANUAL", + "eligible_for_auto_amounts": false, + "amounts": [ + {} + ] + } + } + ], + "cursor": "cursor6", + "matched_variation_ids": [ + "matched_variation_ids9", + "matched_variation_ids0" + ] } ``` diff --git a/doc/models/search-catalog-objects-request.md b/doc/models/search-catalog-objects-request.md index 9718d178..076b5d27 100644 --- a/doc/models/search-catalog-objects-request.md +++ b/doc/models/search-catalog-objects-request.md @@ -9,8 +9,8 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `cursor` | `string \| undefined` | Optional | The pagination cursor returned in the previous response. Leave unset for an initial request.
See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. | -| `objectTypes` | [`string[] \| undefined`](../../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. | +| `cursor` | `string \| undefined` | 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. | +| `objectTypes` | [`string[] \| undefined`](../../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. | | `includeDeletedObjects` | `boolean \| undefined` | Optional | If `true`, deleted objects will be included in the results. Deleted objects will have their
`is_deleted` field set to `true`. | | `includeRelatedObjects` | `boolean \| undefined` | 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` | | `beginTime` | `string \| undefined` | 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. | diff --git a/doc/models/search-catalog-objects-response.md b/doc/models/search-catalog-objects-response.md index 56393adc..48ce4ab8 100644 --- a/doc/models/search-catalog-objects-response.md +++ b/doc/models/search-catalog-objects-response.md @@ -10,7 +10,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination) for more information. | +| `cursor` | `string \| undefined` | 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. | | `objects` | [`CatalogObject[] \| undefined`](../../doc/models/catalog-object.md) | Optional | The CatalogObjects returned. | | `relatedObjects` | [`CatalogObject[] \| undefined`](../../doc/models/catalog-object.md) | Optional | A list of CatalogObjects referenced by the objects in the `objects` field. | | `latestTime` | `string \| undefined` | 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. | diff --git a/doc/models/search-loyalty-accounts-request-loyalty-account-query.md b/doc/models/search-loyalty-accounts-request-loyalty-account-query.md index 25b76266..c7f6935d 100644 --- a/doc/models/search-loyalty-accounts-request-loyalty-account-query.md +++ b/doc/models/search-loyalty-accounts-request-loyalty-account-query.md @@ -18,8 +18,17 @@ The search criteria for the loyalty accounts. ```json { - "mappings": null, - "customer_ids": null + "mappings": [ + { + "id": "id4", + "created_at": "created_at8", + "phone_number": "phone_number8" + } + ], + "customer_ids": [ + "customer_ids1", + "customer_ids2" + ] } ``` diff --git a/doc/models/search-loyalty-accounts-request.md b/doc/models/search-loyalty-accounts-request.md index 49027a3f..e610559f 100644 --- a/doc/models/search-loyalty-accounts-request.md +++ b/doc/models/search-loyalty-accounts-request.md @@ -12,8 +12,8 @@ A request to search for loyalty accounts. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `query` | [`SearchLoyaltyAccountsRequestLoyaltyAccountQuery \| undefined`](../../doc/models/search-loyalty-accounts-request-loyalty-account-query.md) | Optional | The search criteria for the loyalty accounts. | -| `limit` | `number \| undefined` | Optional | The maximum number of results to include in the response. The default value is 30.
**Constraints**: `>= 1`, `<= 30` | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination). | +| `limit` | `number \| undefined` | Optional | The maximum number of results to include in the response. The default value is 30.
**Constraints**: `>= 1`, `<= 200` | +| `cursor` | `string \| undefined` | 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). | ## Example (as JSON) diff --git a/doc/models/search-loyalty-accounts-response.md b/doc/models/search-loyalty-accounts-response.md index cf4dced9..76d22752 100644 --- a/doc/models/search-loyalty-accounts-response.md +++ b/doc/models/search-loyalty-accounts-response.md @@ -13,7 +13,7 @@ A response that includes loyalty accounts that satisfy the search criteria. | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | | `loyaltyAccounts` | [`LoyaltyAccount[] \| undefined`](../../doc/models/loyalty-account.md) | Optional | The loyalty accounts that met the search criteria,
in order of creation date. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination). | +| `cursor` | `string \| undefined` | 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). | ## Example (as JSON) diff --git a/doc/models/search-loyalty-events-request.md b/doc/models/search-loyalty-events-request.md index cec1e889..48d8c432 100644 --- a/doc/models/search-loyalty-events-request.md +++ b/doc/models/search-loyalty-events-request.md @@ -13,7 +13,7 @@ A request to search for loyalty events. | --- | --- | --- | --- | | `query` | [`LoyaltyEventQuery \| undefined`](../../doc/models/loyalty-event-query.md) | Optional | Represents a query used to search for loyalty events. | | `limit` | `number \| undefined` | 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` | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination). | +| `cursor` | `string \| undefined` | 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). | ## Example (as JSON) diff --git a/doc/models/search-loyalty-events-response.md b/doc/models/search-loyalty-events-response.md index 56952cc2..ee14845c 100644 --- a/doc/models/search-loyalty-events-response.md +++ b/doc/models/search-loyalty-events-response.md @@ -14,7 +14,7 @@ criteria, in order by the `created_at` date. | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | | `events` | [`LoyaltyEvent[] \| undefined`](../../doc/models/loyalty-event.md) | Optional | The loyalty events that satisfy the search criteria. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination). | +| `cursor` | `string \| undefined` | 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). | ## Example (as JSON) diff --git a/doc/models/search-loyalty-rewards-request-loyalty-reward-query.md b/doc/models/search-loyalty-rewards-request-loyalty-reward-query.md index e8e7145e..83d56a55 100644 --- a/doc/models/search-loyalty-rewards-request-loyalty-reward-query.md +++ b/doc/models/search-loyalty-rewards-request-loyalty-reward-query.md @@ -11,7 +11,7 @@ The set of search requirements. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `loyaltyAccountId` | `string` | Required | The ID of the [loyalty account](../../doc/models/loyalty-account.md) to which the loyalty reward belongs.
**Constraints**: *Minimum Length*: `1` | +| `loyaltyAccountId` | `string` | Required | The ID of the [loyalty account](entity:LoyaltyAccount) to which the loyalty reward belongs.
**Constraints**: *Minimum Length*: `1` | | `status` | [`string \| undefined`](../../doc/models/loyalty-reward-status.md) | Optional | The status of the loyalty reward. | ## Example (as JSON) @@ -19,7 +19,7 @@ The set of search requirements. ```json { "loyalty_account_id": "loyalty_account_id0", - "status": null + "status": "DELETED" } ``` diff --git a/doc/models/search-loyalty-rewards-request.md b/doc/models/search-loyalty-rewards-request.md index f1bc7737..7445a166 100644 --- a/doc/models/search-loyalty-rewards-request.md +++ b/doc/models/search-loyalty-rewards-request.md @@ -13,7 +13,7 @@ A request to search for loyalty rewards. | --- | --- | --- | --- | | `query` | [`SearchLoyaltyRewardsRequestLoyaltyRewardQuery \| undefined`](../../doc/models/search-loyalty-rewards-request-loyalty-reward-query.md) | Optional | The set of search requirements. | | `limit` | `number \| undefined` | Optional | The maximum number of results to return in the response. The default value is 30.
**Constraints**: `>= 1`, `<= 30` | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination). | +| `cursor` | `string \| undefined` | 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). | ## Example (as JSON) diff --git a/doc/models/search-orders-customer-filter.md b/doc/models/search-orders-customer-filter.md index fcaf38b4..1599d9d7 100644 --- a/doc/models/search-orders-customer-filter.md +++ b/doc/models/search-orders-customer-filter.md @@ -19,7 +19,10 @@ associated with the order. It does not filter based on the ```json { - "customer_ids": null + "customer_ids": [ + "customer_ids1", + "customer_ids2" + ] } ``` diff --git a/doc/models/search-orders-date-time-filter.md b/doc/models/search-orders-date-time-filter.md index c852c83a..a5bc3488 100644 --- a/doc/models/search-orders-date-time-filter.md +++ b/doc/models/search-orders-date-time-filter.md @@ -32,9 +32,18 @@ in `DateTimeFilter`, you must set the `sort_field` in `SearchOrdersSort` to ```json { - "created_at": null, - "updated_at": null, - "closed_at": null + "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 index 1da76752..ff3eae35 100644 --- a/doc/models/search-orders-filter.md +++ b/doc/models/search-orders-filter.md @@ -22,11 +22,43 @@ are ANDed together. ```json { - "state_filter": null, - "date_time_filter": null, - "fulfillment_filter": null, - "source_filter": null, - "customer_filter": null + "state_filter": { + "states": [ + "CANCELED", + "DRAFT" + ] + }, + "date_time_filter": { + "created_at": { + "start_at": "start_at0", + "end_at": "end_at2" + }, + "updated_at": { + "start_at": "start_at8", + "end_at": "end_at4" + }, + "closed_at": {} + }, + "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 index 9986f737..93ad8182 100644 --- a/doc/models/search-orders-fulfillment-filter.md +++ b/doc/models/search-orders-fulfillment-filter.md @@ -11,15 +11,20 @@ Filter based on [order fulfillment](../../doc/models/fulfillment.md) information | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `fulfillmentTypes` | [`string[] \| undefined`](../../doc/models/fulfillment-type.md) | Optional | A list of [fulfillment types](../../doc/models/fulfillment-type.md) 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 | -| `fulfillmentStates` | [`string[] \| undefined`](../../doc/models/fulfillment-state.md) | Optional | A list of [fulfillment states](../../doc/models/fulfillment-state.md) 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 | +| `fulfillmentTypes` | [`string[] \| undefined`](../../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 | +| `fulfillmentStates` | [`string[] \| undefined`](../../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 | ## Example (as JSON) ```json { - "fulfillment_types": null, - "fulfillment_states": null + "fulfillment_types": [ + "PICKUP", + "SHIPMENT" + ], + "fulfillment_states": [ + "PROPOSED" + ] } ``` diff --git a/doc/models/search-orders-query.md b/doc/models/search-orders-query.md index a34882b8..f4802369 100644 --- a/doc/models/search-orders-query.md +++ b/doc/models/search-orders-query.md @@ -18,8 +18,52 @@ Contains query criteria for the search. ```json { - "filter": null, - "sort": null + "filter": { + "state_filter": { + "states": [ + "CANCELED", + "COMPLETED" + ] + }, + "date_time_filter": { + "created_at": { + "start_at": "start_at6", + "end_at": "end_at6" + }, + "updated_at": { + "start_at": "start_at0", + "end_at": "end_at2" + }, + "closed_at": {} + }, + "fulfillment_filter": { + "fulfillment_types": [ + "SHIPMENT", + "DELIVERY", + "PICKUP" + ], + "fulfillment_states": [ + "PREPARED", + "COMPLETED", + "CANCELED" + ] + }, + "source_filter": { + "source_names": [ + "source_names0" + ] + }, + "customer_filter": { + "customer_ids": [ + "customer_ids7", + "customer_ids8" + ] + } + }, + "sort": { + "sort_field": "UPDATED_AT", + "sort_order": "DESC" + } } ``` diff --git a/doc/models/search-orders-request.md b/doc/models/search-orders-request.md index 216d9614..3373b6c9 100644 --- a/doc/models/search-orders-request.md +++ b/doc/models/search-orders-request.md @@ -15,10 +15,10 @@ results. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `locationIds` | `string[] \| undefined` | Optional | The location IDs for the orders to query. All locations must belong to
the same merchant.

Min: 1 location ID.

Max: 10 location IDs. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination). | +| `cursor` | `string \| undefined` | 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). | | `query` | [`SearchOrdersQuery \| undefined`](../../doc/models/search-orders-query.md) | Optional | Contains query criteria for the search. | | `limit` | `number \| undefined` | 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.

Default: `500`
**Constraints**: `>= 1` | -| `returnEntries` | `boolean \| undefined` | Optional | A Boolean that controls the format of the search results. If `true`,
`SearchOrders` returns [OrderEntry](../../doc/models/order-entry.md) objects. If `false`, `SearchOrders`
returns complete order objects.

Default: `false`. | +| `returnEntries` | `boolean \| undefined` | 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`. | ## Example (as JSON) diff --git a/doc/models/search-orders-response.md b/doc/models/search-orders-response.md index ef9fa00d..72e16d41 100644 --- a/doc/models/search-orders-response.md +++ b/doc/models/search-orders-response.md @@ -12,10 +12,10 @@ Either the `order_entries` or `orders` field is set, depending on whether | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `orderEntries` | [`OrderEntry[] \| undefined`](../../doc/models/order-entry.md) | Optional | A list of [OrderEntries](../../doc/models/order-entry.md) that fit the query
conditions. The list is populated only if `return_entries` is set to `true` in the request. | -| `orders` | [`Order[] \| undefined`](../../doc/models/order.md) | Optional | A list of
[Order](../../doc/models/order.md) objects that match the query conditions. The list is populated only if
`return_entries` is set to `false` in the request. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination). | -| `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | [Errors](../../doc/models/error.md) encountered during the search. | +| `orderEntries` | [`OrderEntry[] \| undefined`](../../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. | +| `orders` | [`Order[] \| undefined`](../../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. | +| `cursor` | `string \| undefined` | 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). | +| `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | [Errors](entity:Error) encountered during the search. | ## Example (as JSON) diff --git a/doc/models/search-orders-sort.md b/doc/models/search-orders-sort.md index d097a492..8b349801 100644 --- a/doc/models/search-orders-sort.md +++ b/doc/models/search-orders-sort.md @@ -20,7 +20,7 @@ by a timestamp field. ```json { "sort_field": "CLOSED_AT", - "sort_order": null + "sort_order": "DESC" } ``` diff --git a/doc/models/search-orders-source-filter.md b/doc/models/search-orders-source-filter.md index a2b252e1..6192472d 100644 --- a/doc/models/search-orders-source-filter.md +++ b/doc/models/search-orders-source-filter.md @@ -11,13 +11,15 @@ A filter based on order `source` information. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `sourceNames` | `string[] \| undefined` | Optional | Filters by the [Source](../../doc/models/order-source.md) `name`. The filter returns any orders
with a `source.name` that matches any of the listed source names.

Max: 10 source names. | +| `sourceNames` | `string[] \| undefined` | 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. | ## Example (as JSON) ```json { - "source_names": null + "source_names": [ + "source_names8" + ] } ``` diff --git a/doc/models/search-subscriptions-filter.md b/doc/models/search-subscriptions-filter.md index c65f0543..6fcab8a3 100644 --- a/doc/models/search-subscriptions-filter.md +++ b/doc/models/search-subscriptions-filter.md @@ -20,9 +20,16 @@ the [SearchSubscriptions](../../doc/api/subscriptions.md#search-subscriptions) e ```json { - "customer_ids": null, - "location_ids": null, - "source_names": null + "customer_ids": [ + "customer_ids1", + "customer_ids2" + ], + "location_ids": [ + "location_ids0" + ], + "source_names": [ + "source_names8" + ] } ``` diff --git a/doc/models/search-subscriptions-query.md b/doc/models/search-subscriptions-query.md index d5613300..61d043fb 100644 --- a/doc/models/search-subscriptions-query.md +++ b/doc/models/search-subscriptions-query.md @@ -17,7 +17,18 @@ Represents a query, consisting of specified query expressions, used to search fo ```json { - "filter": null + "filter": { + "customer_ids": [ + "customer_ids3", + "customer_ids2" + ], + "location_ids": [ + "location_ids4" + ], + "source_names": [ + "source_names2" + ] + } } ``` diff --git a/doc/models/search-team-members-filter.md b/doc/models/search-team-members-filter.md index 5138703a..dbda4004 100644 --- a/doc/models/search-team-members-filter.md +++ b/doc/models/search-team-members-filter.md @@ -27,9 +27,11 @@ returns only active team members assigned to either location "A" or "B". ```json { - "location_ids": null, - "status": null, - "is_owner": null + "location_ids": [ + "location_ids0" + ], + "status": "ACTIVE", + "is_owner": false } ``` diff --git a/doc/models/search-team-members-query.md b/doc/models/search-team-members-query.md index 7587a1b0..29b6f450 100644 --- a/doc/models/search-team-members-query.md +++ b/doc/models/search-team-members-query.md @@ -17,7 +17,13 @@ Represents the parameters in a search for `TeamMember` objects. ```json { - "filter": null + "filter": { + "location_ids": [ + "location_ids4" + ], + "status": "ACTIVE", + "is_owner": false + } } ``` diff --git a/doc/models/search-terminal-actions-request.md b/doc/models/search-terminal-actions-request.md index cc14f685..6bd8377b 100644 --- a/doc/models/search-terminal-actions-request.md +++ b/doc/models/search-terminal-actions-request.md @@ -10,7 +10,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `query` | [`TerminalActionQuery \| undefined`](../../doc/models/terminal-action-query.md) | Optional | - | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination) for more
information. | +| `cursor` | `string \| undefined` | 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. | | `limit` | `number \| undefined` | Optional | Limit the number of results returned for a single request.
**Constraints**: `>= 1`, `<= 100` | ## Example (as JSON) diff --git a/doc/models/search-terminal-actions-response.md b/doc/models/search-terminal-actions-response.md index 45a46fcf..b69890db 100644 --- a/doc/models/search-terminal-actions-response.md +++ b/doc/models/search-terminal-actions-response.md @@ -11,7 +11,7 @@ | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Information on errors encountered during the request. | | `action` | [`TerminalAction[] \| undefined`](../../doc/models/terminal-action.md) | Optional | The requested search result of `TerminalAction`s. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination) for more
information. | +| `cursor` | `string \| undefined` | 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. | ## Example (as JSON) diff --git a/doc/models/search-terminal-checkouts-request.md b/doc/models/search-terminal-checkouts-request.md index a170e0bb..4e32cf05 100644 --- a/doc/models/search-terminal-checkouts-request.md +++ b/doc/models/search-terminal-checkouts-request.md @@ -10,7 +10,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | | `query` | [`TerminalCheckoutQuery \| undefined`](../../doc/models/terminal-checkout-query.md) | Optional | - | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination) for more information. | +| `cursor` | `string \| undefined` | 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. | | `limit` | `number \| undefined` | Optional | Limits the number of results returned for a single request.
**Constraints**: `>= 1`, `<= 100` | ## Example (as JSON) diff --git a/doc/models/search-terminal-checkouts-response.md b/doc/models/search-terminal-checkouts-response.md index 03b24fb1..74961a27 100644 --- a/doc/models/search-terminal-checkouts-response.md +++ b/doc/models/search-terminal-checkouts-response.md @@ -11,7 +11,7 @@ | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | | `checkouts` | [`TerminalCheckout[] \| undefined`](../../doc/models/terminal-checkout.md) | Optional | The requested search result of `TerminalCheckout` objects. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination) for more information. | +| `cursor` | `string \| undefined` | 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. | ## Example (as JSON) diff --git a/doc/models/search-terminal-refunds-response.md b/doc/models/search-terminal-refunds-response.md index 80f6a863..2d74a686 100644 --- a/doc/models/search-terminal-refunds-response.md +++ b/doc/models/search-terminal-refunds-response.md @@ -11,7 +11,7 @@ | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Information about errors encountered during the request. | | `refunds` | [`TerminalRefund[] \| undefined`](../../doc/models/terminal-refund.md) | Optional | The requested search result of `TerminalRefund` objects. | -| `cursor` | `string \| undefined` | 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/basics/api101/pagination) for more information. | +| `cursor` | `string \| undefined` | 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. | ## Example (as JSON) diff --git a/doc/models/search-vendors-request-filter.md b/doc/models/search-vendors-request-filter.md index 4801e58c..0009a76c 100644 --- a/doc/models/search-vendors-request-filter.md +++ b/doc/models/search-vendors-request-filter.md @@ -11,15 +11,23 @@ Defines supported query expressions to search for vendors by. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `name` | `string[] \| undefined` | Optional | The names of the [Vendor](../../doc/models/vendor.md) objects to retrieve. | -| `status` | [`string[] \| undefined`](../../doc/models/vendor-status.md) | Optional | The statuses of the [Vendor](../../doc/models/vendor.md) objects to retrieve.
See [VendorStatus](#type-vendorstatus) for possible values | +| `name` | `string[] \| undefined` | Optional | The names of the [Vendor](entity:Vendor) objects to retrieve. | +| `status` | [`string[] \| undefined`](../../doc/models/vendor-status.md) | Optional | The statuses of the [Vendor](entity:Vendor) objects to retrieve.
See [VendorStatus](#type-vendorstatus) for possible values | ## Example (as JSON) ```json { - "name": null, - "status": null + "name": [ + "name0", + "name1", + "name2" + ], + "status": [ + "ACTIVE", + "INACTIVE", + "ACTIVE" + ] } ``` diff --git a/doc/models/search-vendors-request-sort.md b/doc/models/search-vendors-request-sort.md index 0dc0853d..bda09493 100644 --- a/doc/models/search-vendors-request-sort.md +++ b/doc/models/search-vendors-request-sort.md @@ -18,8 +18,8 @@ Defines a sorter used to sort results from [SearchVendors](../../doc/api/vendors ```json { - "field": null, - "order": null + "field": "NAME", + "order": "DESC" } ``` diff --git a/doc/models/search-vendors-request.md b/doc/models/search-vendors-request.md index 3b93701b..8b74f412 100644 --- a/doc/models/search-vendors-request.md +++ b/doc/models/search-vendors-request.md @@ -14,6 +14,7 @@ Represents an input into a call to [SearchVendors](../../doc/api/vendors.md#sear | `filter` | [`SearchVendorsRequestFilter \| undefined`](../../doc/models/search-vendors-request-filter.md) | Optional | Defines supported query expressions to search for vendors by. | | `sort` | [`SearchVendorsRequestSort \| undefined`](../../doc/models/search-vendors-request-sort.md) | Optional | Defines a sorter used to sort results from [SearchVendors](../../doc/api/vendors.md#search-vendors). | | `cursor` | `string \| undefined` | 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. | +| `limit` | `bigint \| undefined` | Optional | Limit on how many vendors will be returned by the search.
**Constraints**: `>= 1`, `<= 500` | ## Example (as JSON) diff --git a/doc/models/search-vendors-response.md b/doc/models/search-vendors-response.md index b080c87c..73f5f0c2 100644 --- a/doc/models/search-vendors-response.md +++ b/doc/models/search-vendors-response.md @@ -12,16 +12,168 @@ Represents an output from a call to [SearchVendors](../../doc/api/vendors.md#sea | Name | Type | Tags | Description | | --- | --- | --- | --- | | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Errors encountered when the request fails. | -| `vendors` | [`Vendor[] \| undefined`](../../doc/models/vendor.md) | Optional | The [Vendor](../../doc/models/vendor.md) objects matching the specified search filter. | +| `vendors` | [`Vendor[] \| undefined`](../../doc/models/vendor.md) | Optional | The [Vendor](entity:Vendor) objects matching the specified search filter. | | `cursor` | `string \| undefined` | 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. | ## Example (as JSON) ```json { - "errors": null, - "vendors": null, - "cursor": null + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ], + "vendors": [ + { + "id": "id9", + "created_at": "created_at7", + "updated_at": "updated_at5", + "name": "name9", + "address": { + "address_line_1": "address_line_15", + "address_line_2": "address_line_25", + "address_line_3": "address_line_31", + "locality": "locality5", + "sublocality": "sublocality5", + "sublocality_2": "sublocality_23", + "sublocality_3": "sublocality_35", + "administrative_district_level_1": "administrative_district_level_19", + "administrative_district_level_2": "administrative_district_level_21", + "administrative_district_level_3": "administrative_district_level_33", + "postal_code": "postal_code7", + "country": "HT", + "first_name": "first_name5", + "last_name": "last_name3" + }, + "contacts": [ + { + "id": "id6", + "name": "name6", + "email_address": "email_address4", + "phone_number": "phone_number4", + "removed": false, + "ordinal": 232 + }, + { + "id": "id7", + "name": "name7", + "email_address": "email_address5", + "phone_number": "phone_number5", + "removed": true, + "ordinal": 233 + }, + { + "id": "id8", + "name": "name8", + "email_address": "email_address6", + "phone_number": "phone_number6", + "removed": false, + "ordinal": 234 + } + ], + "account_number": "account_number1", + "note": "note5", + "version": 41, + "status": "INACTIVE" + }, + { + "id": "id0", + "created_at": "created_at8", + "updated_at": "updated_at4", + "name": "name0", + "address": { + "address_line_1": "address_line_16", + "address_line_2": "address_line_26", + "address_line_3": "address_line_32", + "locality": "locality6", + "sublocality": "sublocality6", + "sublocality_2": "sublocality_24", + "sublocality_3": "sublocality_36", + "administrative_district_level_1": "administrative_district_level_10", + "administrative_district_level_2": "administrative_district_level_22", + "administrative_district_level_3": "administrative_district_level_34", + "postal_code": "postal_code8", + "country": "HU", + "first_name": "first_name6", + "last_name": "last_name4" + }, + "contacts": [ + { + "id": "id7", + "name": "name7", + "email_address": "email_address5", + "phone_number": "phone_number5", + "removed": true, + "ordinal": 233 + } + ], + "account_number": "account_number0", + "note": "note4", + "version": 42, + "status": "ACTIVE" + }, + { + "id": "id1", + "created_at": "created_at9", + "updated_at": "updated_at3", + "name": "name1", + "address": { + "address_line_1": "address_line_17", + "address_line_2": "address_line_27", + "address_line_3": "address_line_33", + "locality": "locality7", + "sublocality": "sublocality7", + "sublocality_2": "sublocality_25", + "sublocality_3": "sublocality_37", + "administrative_district_level_1": "administrative_district_level_11", + "administrative_district_level_2": "administrative_district_level_23", + "administrative_district_level_3": "administrative_district_level_35", + "postal_code": "postal_code9", + "country": "ID", + "first_name": "first_name7", + "last_name": "last_name5" + }, + "contacts": [ + { + "id": "id8", + "name": "name8", + "email_address": "email_address6", + "phone_number": "phone_number6", + "removed": false, + "ordinal": 234 + }, + { + "id": "id9", + "name": "name9", + "email_address": "email_address7", + "phone_number": "phone_number7", + "removed": true, + "ordinal": 235 + } + ], + "account_number": "account_number9", + "note": "note3", + "version": 43, + "status": "INACTIVE" + } + ], + "cursor": "cursor6" } ``` diff --git a/doc/models/segment-filter.md b/doc/models/segment-filter.md index 54735adb..ccbf39b0 100644 --- a/doc/models/segment-filter.md +++ b/doc/models/segment-filter.md @@ -11,7 +11,7 @@ A query filter to search for buyer-accessible appointment segments by. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `serviceVariationId` | `string` | Required | The ID of the [CatalogItemVariation](../../doc/models/catalog-item-variation.md) object representing the service booked in this segment.
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `36` | +| `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` | | `teamMemberIdFilter` | [`FilterValue \| undefined`](../../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. | ## Example (as JSON) @@ -19,7 +19,22 @@ A query filter to search for buyer-accessible appointment segments by. ```json { "service_variation_id": "service_variation_id6", - "team_member_id_filter": null + "team_member_id_filter": { + "all": [ + "all5", + "all6", + "all7" + ], + "any": [ + "any2", + "any3", + "any4" + ], + "none": [ + "none7", + "none8" + ] + } } ``` diff --git a/doc/models/shift-filter.md b/doc/models/shift-filter.md index 58e61290..30db9fe1 100644 --- a/doc/models/shift-filter.md +++ b/doc/models/shift-filter.md @@ -24,13 +24,33 @@ used by Square's servers to apply each filter property specified. ```json { - "location_ids": null, - "employee_ids": null, - "status": null, - "start": null, - "end": null, - "workday": null, - "team_member_ids": null + "location_ids": [ + "location_ids0" + ], + "employee_ids": [ + "employee_ids5" + ], + "status": "OPEN", + "start": { + "start_at": "start_at6", + "end_at": "end_at6" + }, + "end": { + "start_at": "start_at0", + "end_at": "end_at2" + }, + "workday": { + "date_range": { + "start_date": "start_date0", + "end_date": "end_date6" + }, + "match_shifts_by": "START_AT", + "default_timezone": "default_timezone0" + }, + "team_member_ids": [ + "team_member_ids7", + "team_member_ids8" + ] } ``` diff --git a/doc/models/shift-query.md b/doc/models/shift-query.md index 42faed46..7cdee04f 100644 --- a/doc/models/shift-query.md +++ b/doc/models/shift-query.md @@ -18,8 +18,39 @@ The parameters of a `Shift` search query, which includes filter and sort options ```json { - "filter": null, - "sort": null + "filter": { + "location_ids": [ + "location_ids4" + ], + "employee_ids": [ + "employee_ids9" + ], + "status": "OPEN", + "start": { + "start_at": "start_at0", + "end_at": "end_at2" + }, + "end": { + "start_at": "start_at4", + "end_at": "end_at8" + }, + "workday": { + "date_range": { + "start_date": "start_date4", + "end_date": "end_date8" + }, + "match_shifts_by": "START_AT", + "default_timezone": "default_timezone4" + }, + "team_member_ids": [ + "team_member_ids1", + "team_member_ids2" + ] + }, + "sort": { + "field": "START_AT", + "order": "DESC" + } } ``` diff --git a/doc/models/shift-sort.md b/doc/models/shift-sort.md index e961472c..7bad70e4 100644 --- a/doc/models/shift-sort.md +++ b/doc/models/shift-sort.md @@ -18,8 +18,8 @@ Sets the sort order of search results. ```json { - "field": null, - "order": null + "field": "START_AT", + "order": "DESC" } ``` diff --git a/doc/models/shift-wage.md b/doc/models/shift-wage.md index 9e979743..6b623aa9 100644 --- a/doc/models/shift-wage.md +++ b/doc/models/shift-wage.md @@ -18,8 +18,11 @@ The hourly wage rate used to compensate an employee for this shift. ```json { - "title": null, - "hourly_rate": null + "title": "title4", + "hourly_rate": { + "amount": 172, + "currency": "TJS" + } } ``` diff --git a/doc/models/shift-workday.md b/doc/models/shift-workday.md index 889b2c7b..9c60b33e 100644 --- a/doc/models/shift-workday.md +++ b/doc/models/shift-workday.md @@ -20,9 +20,12 @@ a `Shift` must start or end in before passing the filter condition. ```json { - "date_range": null, - "match_shifts_by": null, - "default_timezone": null + "date_range": { + "start_date": "start_date6", + "end_date": "end_date2" + }, + "match_shifts_by": "INTERSECTION", + "default_timezone": "default_timezone6" } ``` diff --git a/doc/models/shift.md b/doc/models/shift.md index ed64f88a..1ab65dc4 100644 --- a/doc/models/shift.md +++ b/doc/models/shift.md @@ -31,19 +31,53 @@ taken during the shift. ```json { - "id": null, - "employee_id": null, - "location_id": null, - "timezone": null, + "id": "id0", + "employee_id": "employee_id0", + "location_id": "location_id4", + "timezone": "timezone0", "start_at": "start_at2", - "end_at": null, - "wage": null, - "breaks": null, - "status": null, - "version": null, - "created_at": null, - "updated_at": null, - "team_member_id": null + "end_at": "end_at0", + "wage": { + "title": "title8", + "hourly_rate": { + "amount": 2, + "currency": "BND" + } + }, + "breaks": [ + { + "id": "id8", + "start_at": "start_at0", + "end_at": "end_at2", + "break_type_id": "break_type_id4", + "name": "name8", + "expected_duration": "expected_duration6", + "is_paid": false + }, + { + "id": "id9", + "start_at": "start_at1", + "end_at": "end_at1", + "break_type_id": "break_type_id5", + "name": "name9", + "expected_duration": "expected_duration5", + "is_paid": true + }, + { + "id": "id0", + "start_at": "start_at2", + "end_at": "end_at0", + "break_type_id": "break_type_id6", + "name": "name0", + "expected_duration": "expected_duration4", + "is_paid": false + } + ], + "status": "OPEN", + "version": 172, + "created_at": "created_at2", + "updated_at": "updated_at4", + "team_member_id": "team_member_id0" } ``` diff --git a/doc/models/shipping-fee.md b/doc/models/shipping-fee.md index d3c55eb7..b1cfeb1b 100644 --- a/doc/models/shipping-fee.md +++ b/doc/models/shipping-fee.md @@ -16,10 +16,10 @@ ```json { - "name": null, + "name": "name0", "charge": { - "amount": null, - "currency": null + "amount": 80, + "currency": "CUC" } } ``` diff --git a/doc/models/site.md b/doc/models/site.md index e91e2006..96ab8f82 100644 --- a/doc/models/site.md +++ b/doc/models/site.md @@ -22,12 +22,12 @@ Represents a Square Online site, which is an online store for a Square seller. ```json { - "id": null, - "site_title": null, - "domain": null, - "is_published": null, - "created_at": null, - "updated_at": null + "id": "id0", + "site_title": "site_title6", + "domain": "domain6", + "is_published": false, + "created_at": "created_at2", + "updated_at": "updated_at4" } ``` diff --git a/doc/models/snippet-response.md b/doc/models/snippet-response.md index 03552296..5e41f430 100644 --- a/doc/models/snippet-response.md +++ b/doc/models/snippet-response.md @@ -16,8 +16,33 @@ ```json { - "errors": null, - "snippet": null + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ], + "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 index 3d9ef482..d1cbcc4e 100644 --- a/doc/models/snippet.md +++ b/doc/models/snippet.md @@ -21,11 +21,11 @@ Represents the snippet that is added to a Square Online site. The snippet code i ```json { - "id": null, - "site_id": null, + "id": "id0", + "site_id": "site_id6", "content": "content4", - "created_at": null, - "updated_at": null + "created_at": "created_at2", + "updated_at": "updated_at4" } ``` diff --git a/doc/models/source-application.md b/doc/models/source-application.md index af3ff15d..53774199 100644 --- a/doc/models/source-application.md +++ b/doc/models/source-application.md @@ -12,16 +12,16 @@ Represents information about the application used to generate a change. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `product` | [`string \| undefined`](../../doc/models/product.md) | Optional | Indicates the Square product used to generate a change. | -| `applicationId` | `string \| undefined` | Optional | __Read only__ The Square-assigned ID of the application. This field is used only if the
[product](../../doc/models/product.md) type is `EXTERNAL_API`. | +| `applicationId` | `string \| undefined` | Optional | __Read only__ The Square-assigned ID of the application. This field is used only if the
[product](entity:Product) type is `EXTERNAL_API`. | | `name` | `string \| undefined` | Optional | __Read only__ The display name of the application
(for example, `"Custom Application"` or `"Square POS 4.74 for Android"`). | ## Example (as JSON) ```json { - "product": null, - "application_id": null, - "name": null + "product": "SQUARE_POS", + "application_id": "application_id4", + "name": "name0" } ``` diff --git a/doc/models/square-event-data.md b/doc/models/square-event-data.md index 645d54aa..de195b6a 100644 --- a/doc/models/square-event-data.md +++ b/doc/models/square-event-data.md @@ -18,10 +18,13 @@ ```json { - "type": null, - "id": null, - "deleted": null, - "object": null + "type": "type0", + "id": "id0", + "deleted": false, + "object": { + "key1": "val1", + "key2": "val2" + } } ``` diff --git a/doc/models/square-event.md b/doc/models/square-event.md index 81f0a2ec..63ae6807 100644 --- a/doc/models/square-event.md +++ b/doc/models/square-event.md @@ -20,12 +20,20 @@ ```json { - "merchant_id": null, - "location_id": null, - "type": null, - "event_id": null, - "created_at": null, - "data": null + "merchant_id": "merchant_id0", + "location_id": "location_id4", + "type": "type0", + "event_id": "event_id6", + "created_at": "created_at2", + "data": { + "type": "type0", + "id": "id0", + "deleted": false, + "object": { + "key1": "val1", + "key2": "val2" + } + } } ``` diff --git a/doc/models/standard-unit-description-group.md b/doc/models/standard-unit-description-group.md index 99b194bc..ada2fb4c 100644 --- a/doc/models/standard-unit-description-group.md +++ b/doc/models/standard-unit-description-group.md @@ -18,8 +18,60 @@ Group of standard measurement units. ```json { - "standard_unit_descriptions": null, - "language_code": null + "standard_unit_descriptions": [ + { + "unit": { + "custom_unit": { + "name": "name1", + "abbreviation": "abbreviation3" + }, + "area_unit": "IMPERIAL_SQUARE_INCH", + "length_unit": "IMPERIAL_FOOT", + "volume_unit": "GENERIC_QUART", + "weight_unit": "IMPERIAL_POUND", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MINUTE", + "type": "TYPE_AREA" + }, + "name": "name1", + "abbreviation": "abbreviation3" + }, + { + "unit": { + "custom_unit": { + "name": "name2", + "abbreviation": "abbreviation4" + }, + "area_unit": "IMPERIAL_SQUARE_FOOT", + "length_unit": "IMPERIAL_YARD", + "volume_unit": "GENERIC_GALLON", + "weight_unit": "IMPERIAL_STONE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_HOUR", + "type": "TYPE_LENGTH" + }, + "name": "name2", + "abbreviation": "abbreviation4" + }, + { + "unit": { + "custom_unit": { + "name": "name3", + "abbreviation": "abbreviation5" + }, + "area_unit": "IMPERIAL_SQUARE_YARD", + "length_unit": "IMPERIAL_MILE", + "volume_unit": "IMPERIAL_CUBIC_INCH", + "weight_unit": "METRIC_MILLIGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_DAY", + "type": "TYPE_VOLUME" + }, + "name": "name3", + "abbreviation": "abbreviation5" + } + ], + "language_code": "language_code8" } ``` diff --git a/doc/models/standard-unit-description.md b/doc/models/standard-unit-description.md index ad2fc22a..a848ecf0 100644 --- a/doc/models/standard-unit-description.md +++ b/doc/models/standard-unit-description.md @@ -19,9 +19,21 @@ Contains the name and abbreviation for standard measurement unit. ```json { - "unit": null, - "name": null, - "abbreviation": null + "unit": { + "custom_unit": { + "name": "name0", + "abbreviation": "abbreviation2" + }, + "area_unit": "IMPERIAL_ACRE", + "length_unit": "IMPERIAL_INCH", + "volume_unit": "METRIC_MILLILITER", + "weight_unit": "IMPERIAL_STONE", + "generic_unit": "UNIT", + "time_unit": "GENERIC_DAY", + "type": "TYPE_LENGTH" + }, + "name": "name0", + "abbreviation": "abbreviation2" } ``` diff --git a/doc/models/subscription-action.md b/doc/models/subscription-action.md index d115a1d2..8b792db4 100644 --- a/doc/models/subscription-action.md +++ b/doc/models/subscription-action.md @@ -20,10 +20,10 @@ Represents an action as a pending change to a subscription. ```json { - "id": null, - "type": null, - "effective_date": null, - "new_plan_id": null + "id": "id0", + "type": "RESUME", + "effective_date": "effective_date0", + "new_plan_id": "new_plan_id4" } ``` diff --git a/doc/models/subscription-event-info.md b/doc/models/subscription-event-info.md index 8da2fee1..2dfde8e0 100644 --- a/doc/models/subscription-event-info.md +++ b/doc/models/subscription-event-info.md @@ -18,8 +18,8 @@ Provides information about the subscription event. ```json { - "detail": null, - "code": null + "detail": "detail6", + "code": "CUSTOMER_DELETED" } ``` diff --git a/doc/models/subscription-event.md b/doc/models/subscription-event.md index 728cf95e..39fa5628 100644 --- a/doc/models/subscription-event.md +++ b/doc/models/subscription-event.md @@ -25,7 +25,10 @@ Describes changes to a subscription and the subscription status. "subscription_event_type": "RESUME_SUBSCRIPTION", "effective_date": "effective_date0", "plan_id": "plan_id8", - "info": null + "info": { + "detail": "detail6", + "code": "CUSTOMER_DELETED" + } } ``` diff --git a/doc/models/subscription-phase.md b/doc/models/subscription-phase.md index 6772b093..e7da7bae 100644 --- a/doc/models/subscription-phase.md +++ b/doc/models/subscription-phase.md @@ -22,11 +22,14 @@ Describes a phase in a subscription plan. For more information, see ```json { - "uid": null, + "uid": "uid0", "cadence": "DAILY", - "periods": null, - "recurring_price_money": null, - "ordinal": null + "periods": 142, + "recurring_price_money": { + "amount": 66, + "currency": "NAD" + }, + "ordinal": 80 } ``` diff --git a/doc/models/subscription-source.md b/doc/models/subscription-source.md index 167d0168..819d61ef 100644 --- a/doc/models/subscription-source.md +++ b/doc/models/subscription-source.md @@ -17,7 +17,7 @@ The origination details of the subscription. ```json { - "name": null + "name": "name0" } ``` diff --git a/doc/models/subscription-test-result.md b/doc/models/subscription-test-result.md index b0937c57..bf79dc17 100644 --- a/doc/models/subscription-test-result.md +++ b/doc/models/subscription-test-result.md @@ -22,11 +22,11 @@ event types, and signature key. ```json { - "id": null, - "status_code": null, - "payload": null, - "created_at": null, - "updated_at": null + "id": "id0", + "status_code": 122, + "payload": "payload6", + "created_at": "created_at2", + "updated_at": "updated_at4" } ``` diff --git a/doc/models/subscription.md b/doc/models/subscription.md index e94d5a39..50a0c697 100644 --- a/doc/models/subscription.md +++ b/doc/models/subscription.md @@ -16,18 +16,18 @@ For an overview of the `Subscription` type, see | --- | --- | --- | --- | | `id` | `string \| undefined` | Optional | The Square-assigned ID of the subscription.
**Constraints**: *Maximum Length*: `255` | | `locationId` | `string \| undefined` | Optional | The ID of the location associated with the subscription. | -| `planId` | `string \| undefined` | Optional | The ID of the subscribed-to [subscription plan](../../doc/models/catalog-subscription-plan.md). | -| `customerId` | `string \| undefined` | Optional | The ID of the subscribing [customer](../../doc/models/customer.md) profile. | +| `planId` | `string \| undefined` | Optional | The ID of the subscribed-to [subscription plan](entity:CatalogSubscriptionPlan). | +| `customerId` | `string \| undefined` | Optional | The ID of the subscribing [customer](entity:Customer) profile. | | `startDate` | `string \| undefined` | Optional | The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to start the subscription. | | `canceledDate` | `string \| undefined` | 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. | | `chargedThroughDate` | `string \| undefined` | 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. | | `status` | [`string \| undefined`](../../doc/models/subscription-status.md) | Optional | Supported subscription statuses. | | `taxPercentage` | `string \| undefined` | 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%. | -| `invoiceIds` | `string[] \| undefined` | Optional | The IDs of the [invoices](../../doc/models/invoice.md) created for the
subscription, listed in order when the invoices were created
(newest invoices appear first). | +| `invoiceIds` | `string[] \| undefined` | Optional | The IDs of the [invoices](entity:Invoice) created for the
subscription, listed in order when the invoices were created
(newest invoices appear first). | | `priceOverrideMoney` | [`Money \| undefined`](../../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. | | `version` | `bigint \| undefined` | 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. | | `createdAt` | `string \| undefined` | Optional | The timestamp when the subscription was created, in RFC 3339 format. | -| `cardId` | `string \| undefined` | Optional | The ID of the [subscriber's](../../doc/models/customer.md) [card](../../doc/models/card.md)
used to charge for the subscription. | +| `cardId` | `string \| undefined` | Optional | The ID of the [subscriber's](entity:Customer) [card](entity:Card)
used to charge for the subscription. | | `timezone` | `string \| undefined` | 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`). | | `source` | [`SubscriptionSource \| undefined`](../../doc/models/subscription-source.md) | Optional | The origination details of the subscription. | | `actions` | [`SubscriptionAction[] \| undefined`](../../doc/models/subscription-action.md) | Optional | The list of scheduled actions on this subscription. It is set only in the response from
[RetrieveSubscription](../../doc/api/subscriptions.md#retrieve-subscription) with the query parameter
of `include=actions` or from
[SearchSubscriptions](../../doc/api/subscriptions.md#search-subscriptions) with the input parameter
of `include:["actions"]`. | @@ -36,23 +36,51 @@ For an overview of the `Subscription` type, see ```json { - "id": null, - "location_id": null, - "plan_id": null, - "customer_id": null, - "start_date": null, - "canceled_date": null, - "charged_through_date": null, - "status": null, - "tax_percentage": null, - "invoice_ids": null, - "price_override_money": null, - "version": null, - "created_at": null, - "card_id": null, - "timezone": null, - "source": null, - "actions": null + "id": "id0", + "location_id": "location_id4", + "plan_id": "plan_id8", + "customer_id": "customer_id8", + "start_date": "start_date6", + "canceled_date": "canceled_date6", + "charged_through_date": "charged_through_date4", + "status": "DEACTIVATED", + "tax_percentage": "tax_percentage6", + "invoice_ids": [ + "invoice_ids1", + "invoice_ids2", + "invoice_ids3" + ], + "price_override_money": { + "amount": 42, + "currency": "WST" + }, + "version": 172, + "created_at": "created_at2", + "card_id": "card_id4", + "timezone": "timezone0", + "source": { + "name": "name4" + }, + "actions": [ + { + "id": "id9", + "type": "PAUSE", + "effective_date": "effective_date1", + "new_plan_id": "new_plan_id5" + }, + { + "id": "id0", + "type": "CANCEL", + "effective_date": "effective_date0", + "new_plan_id": "new_plan_id6" + }, + { + "id": "id1", + "type": "SWAP_PLAN", + "effective_date": "effective_date9", + "new_plan_id": "new_plan_id7" + } + ] } ``` diff --git a/doc/models/tax-ids.md b/doc/models/tax-ids.md index 1312adf5..62f50999 100644 --- a/doc/models/tax-ids.md +++ b/doc/models/tax-ids.md @@ -20,10 +20,10 @@ Identifiers for the location used by various governments for tax purposes. ```json { - "eu_vat": null, - "fr_siret": null, - "fr_naf": null, - "es_nif": null + "eu_vat": "eu_vat2", + "fr_siret": "fr_siret0", + "fr_naf": "fr_naf0", + "es_nif": "es_nif4" } ``` diff --git a/doc/models/team-member-assigned-locations.md b/doc/models/team-member-assigned-locations.md index d25dacbe..6a34f6e6 100644 --- a/doc/models/team-member-assigned-locations.md +++ b/doc/models/team-member-assigned-locations.md @@ -12,14 +12,16 @@ An object that represents a team member's assignment to locations. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `assignmentType` | [`string \| undefined`](../../doc/models/team-member-assigned-locations-assignment-type.md) | Optional | Enumerates the possible assignment types that the team member can have. | -| `locationIds` | `string[] \| undefined` | Optional | The locations that the team member is assigned to. | +| `locationIds` | `string[] \| undefined` | Optional | The explicit locations that the team member is assigned to. | ## Example (as JSON) ```json { - "assignment_type": null, - "location_ids": null + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS", + "location_ids": [ + "location_ids0" + ] } ``` diff --git a/doc/models/team-member-booking-profile.md b/doc/models/team-member-booking-profile.md index 2714c868..bbf70774 100644 --- a/doc/models/team-member-booking-profile.md +++ b/doc/models/team-member-booking-profile.md @@ -11,7 +11,7 @@ The booking profile of a seller's team member, including the team member's ID, d | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `teamMemberId` | `string \| undefined` | Optional | The ID of the [TeamMember](../../doc/models/team-member.md) object for the team member associated with the booking profile.
**Constraints**: *Maximum Length*: `32` | +| `teamMemberId` | `string \| undefined` | Optional | The ID of the [TeamMember](entity:TeamMember) object for the team member associated with the booking profile.
**Constraints**: *Maximum Length*: `32` | | `description` | `string \| undefined` | Optional | The description of the team member.
**Constraints**: *Maximum Length*: `65536` | | `displayName` | `string \| undefined` | Optional | The display name of the team member.
**Constraints**: *Maximum Length*: `512` | | `isBookable` | `boolean \| undefined` | 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`). | @@ -21,11 +21,11 @@ The booking profile of a seller's team member, including the team member's ID, d ```json { - "team_member_id": null, - "description": null, - "display_name": null, - "is_bookable": null, - "profile_image_url": null + "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-wage.md b/doc/models/team-member-wage.md index f327cae6..a4c4d857 100644 --- a/doc/models/team-member-wage.md +++ b/doc/models/team-member-wage.md @@ -21,10 +21,13 @@ specified by the `title` property of this object. ```json { - "id": null, - "team_member_id": null, - "title": null, - "hourly_rate": null + "id": "id0", + "team_member_id": "team_member_id0", + "title": "title4", + "hourly_rate": { + "amount": 172, + "currency": "TJS" + } } ``` diff --git a/doc/models/team-member.md b/doc/models/team-member.md index b5bef080..e201d587 100644 --- a/doc/models/team-member.md +++ b/doc/models/team-member.md @@ -27,17 +27,24 @@ A record representing an individual team member for a business. ```json { - "id": null, - "reference_id": null, - "is_owner": null, - "status": null, - "given_name": null, - "family_name": null, - "email_address": null, - "phone_number": null, - "created_at": null, - "updated_at": null, - "assigned_locations": null + "id": "id0", + "reference_id": "reference_id2", + "is_owner": false, + "status": "ACTIVE", + "given_name": "given_name2", + "family_name": "family_name6", + "email_address": "email_address2", + "phone_number": "phone_number2", + "created_at": "created_at2", + "updated_at": "updated_at4", + "assigned_locations": { + "assignment_type": "ALL_CURRENT_AND_FUTURE_LOCATIONS", + "location_ids": [ + "location_ids8", + "location_ids9", + "location_ids0" + ] + } } ``` diff --git a/doc/models/tender-card-details.md b/doc/models/tender-card-details.md index 97385188..b8841a91 100644 --- a/doc/models/tender-card-details.md +++ b/doc/models/tender-card-details.md @@ -19,9 +19,42 @@ Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CAR ```json { - "status": null, - "card": null, - "entry_method": null + "status": "AUTHORIZED", + "card": { + "id": "id6", + "card_brand": "OTHER_BRAND", + "last_4": "last_48", + "exp_month": 228, + "exp_year": 68, + "cardholder_name": "cardholder_name8", + "billing_address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_28", + "address_line_3": "address_line_34", + "locality": "locality2", + "sublocality": "sublocality8", + "sublocality_2": "sublocality_26", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_12", + "administrative_district_level_2": "administrative_district_level_26", + "administrative_district_level_3": "administrative_district_level_36", + "postal_code": "postal_code0", + "country": "KR", + "first_name": "first_name8", + "last_name": "last_name6" + }, + "fingerprint": "fingerprint2", + "customer_id": "customer_id4", + "merchant_id": "merchant_id6", + "reference_id": "reference_id6", + "enabled": false, + "card_type": "UNKNOWN_CARD_TYPE", + "prepaid_type": "PREPAID", + "bin": "bin6", + "version": 154, + "card_co_brand": "AFTERPAY" + }, + "entry_method": "KEYED" } ``` diff --git a/doc/models/tender-cash-details.md b/doc/models/tender-cash-details.md index 82df8e9b..e601b8d9 100644 --- a/doc/models/tender-cash-details.md +++ b/doc/models/tender-cash-details.md @@ -18,8 +18,14 @@ Represents the details of a tender with `type` `CASH`. ```json { - "buyer_tendered_money": null, - "change_back_money": null + "buyer_tendered_money": { + "amount": 238, + "currency": "JMD" + }, + "change_back_money": { + "amount": 78, + "currency": "MUR" + } } ``` diff --git a/doc/models/tender.md b/doc/models/tender.md index 7c4c9210..7ffa9941 100644 --- a/doc/models/tender.md +++ b/doc/models/tender.md @@ -24,26 +24,109 @@ Represents a tender (i.e., a method of payment) used in a Square transaction. | `cardDetails` | [`TenderCardDetails \| undefined`](../../doc/models/tender-card-details.md) | Optional | Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD` | | `cashDetails` | [`TenderCashDetails \| undefined`](../../doc/models/tender-cash-details.md) | Optional | Represents the details of a tender with `type` `CASH`. | | `additionalRecipients` | [`AdditionalRecipient[] \| undefined`](../../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. | -| `paymentId` | `string \| undefined` | Optional | The ID of the [Payment](../../doc/models/payment.md) that corresponds to this tender.
This value is only present for payments created with the v2 Payments API.
**Constraints**: *Maximum Length*: `192` | +| `paymentId` | `string \| undefined` | 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` | ## Example (as JSON) ```json { - "id": null, - "location_id": null, - "transaction_id": null, - "created_at": null, - "note": null, - "amount_money": null, - "tip_money": null, - "processing_fee_money": null, - "customer_id": null, + "id": "id0", + "location_id": "location_id4", + "transaction_id": "transaction_id8", + "created_at": "created_at2", + "note": "note4", + "amount_money": { + "amount": 186, + "currency": "NGN" + }, + "tip_money": { + "amount": 190, + "currency": "CHE" + }, + "processing_fee_money": { + "amount": 112, + "currency": "XBB" + }, + "customer_id": "customer_id8", "type": "WALLET", - "card_details": null, - "cash_details": null, - "additional_recipients": null, - "payment_id": null + "card_details": { + "status": "AUTHORIZED", + "card": { + "id": "id6", + "card_brand": "JCB", + "last_4": "last_48", + "exp_month": 4, + "exp_year": 36, + "cardholder_name": "cardholder_name8", + "billing_address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_28", + "address_line_3": "address_line_34", + "locality": "locality2", + "sublocality": "sublocality8", + "sublocality_2": "sublocality_26", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_12", + "administrative_district_level_2": "administrative_district_level_26", + "administrative_district_level_3": "administrative_district_level_36", + "postal_code": "postal_code0", + "country": "RW", + "first_name": "first_name8", + "last_name": "last_name6" + }, + "fingerprint": "fingerprint2", + "customer_id": "customer_id4", + "merchant_id": "merchant_id6", + "reference_id": "reference_id4", + "enabled": false, + "card_type": "UNKNOWN_CARD_TYPE", + "prepaid_type": "PREPAID", + "bin": "bin6", + "version": 122, + "card_co_brand": "AFTERPAY" + }, + "entry_method": "ON_FILE" + }, + "cash_details": { + "buyer_tendered_money": { + "amount": 8, + "currency": "XXX" + }, + "change_back_money": { + "amount": 112, + "currency": "BHD" + } + }, + "additional_recipients": [ + { + "location_id": "location_id3", + "description": "description9", + "amount_money": { + "amount": 83, + "currency": "ALL" + }, + "receivable_id": "receivable_id9" + }, + { + "location_id": "location_id4", + "description": "description0", + "amount_money": { + "amount": 84, + "currency": "AMD" + }, + "receivable_id": "receivable_id0" + }, + { + "location_id": "location_id5", + "description": "description1", + "amount_money": { + "amount": 85, + "currency": "ANG" + }, + "receivable_id": "receivable_id1" + } + ], + "payment_id": "payment_id0" } ``` diff --git a/doc/models/terminal-action-query-filter.md b/doc/models/terminal-action-query-filter.md index 3006af4f..0cf86ec5 100644 --- a/doc/models/terminal-action-query-filter.md +++ b/doc/models/terminal-action-query-filter.md @@ -18,10 +18,13 @@ ```json { - "device_id": null, - "created_at": null, - "status": null, - "type": null + "device_id": "device_id6", + "created_at": { + "start_at": "start_at4", + "end_at": "end_at8" + }, + "status": "status8", + "type": "RECEIPT" } ``` diff --git a/doc/models/terminal-action-query-sort.md b/doc/models/terminal-action-query-sort.md index b3a4e0c5..faf4326f 100644 --- a/doc/models/terminal-action-query-sort.md +++ b/doc/models/terminal-action-query-sort.md @@ -15,7 +15,7 @@ ```json { - "sort_order": null + "sort_order": "DESC" } ``` diff --git a/doc/models/terminal-action.md b/doc/models/terminal-action.md index 77044f38..facf59c3 100644 --- a/doc/models/terminal-action.md +++ b/doc/models/terminal-action.md @@ -28,18 +28,39 @@ Represents an action processed by the Square Terminal. ```json { - "id": null, - "device_id": null, - "deadline_duration": null, - "status": null, - "cancel_reason": null, - "created_at": null, - "updated_at": null, - "app_id": null, - "type": null, - "save_card_options": null, - "receipt_options": null, - "device_metadata": null + "id": "id0", + "device_id": "device_id6", + "deadline_duration": "deadline_duration8", + "status": "status8", + "cancel_reason": "SELLER_CANCELED", + "created_at": "created_at2", + "updated_at": "updated_at4", + "app_id": "app_id6", + "type": "RECEIPT", + "save_card_options": { + "customer_id": "customer_id0", + "card_id": "card_id2", + "reference_id": "reference_id0" + }, + "receipt_options": { + "payment_id": "payment_id0", + "print_only": false, + "is_duplicate": false + }, + "device_metadata": { + "battery_percentage": "battery_percentage0", + "charging_state": "charging_state2", + "location_id": "location_id8", + "merchant_id": "merchant_id4", + "network_connection_type": "network_connection_type4", + "payment_region": "payment_region2", + "serial_number": "serial_number8", + "os_version": "os_version2", + "app_version": "app_version4", + "wifi_network_name": "wifi_network_name0", + "wifi_network_strength": "wifi_network_strength4", + "ip_address": "ip_address4" + } } ``` diff --git a/doc/models/terminal-checkout-query-filter.md b/doc/models/terminal-checkout-query-filter.md index 7808c6fc..975ba575 100644 --- a/doc/models/terminal-checkout-query-filter.md +++ b/doc/models/terminal-checkout-query-filter.md @@ -17,9 +17,12 @@ ```json { - "device_id": null, - "created_at": null, - "status": null + "device_id": "device_id6", + "created_at": { + "start_at": "start_at4", + "end_at": "end_at8" + }, + "status": "status8" } ``` diff --git a/doc/models/terminal-checkout-query-sort.md b/doc/models/terminal-checkout-query-sort.md index db657dd8..44d0be82 100644 --- a/doc/models/terminal-checkout-query-sort.md +++ b/doc/models/terminal-checkout-query-sort.md @@ -15,7 +15,7 @@ ```json { - "sort_order": null + "sort_order": "DESC" } ``` diff --git a/doc/models/terminal-checkout-query.md b/doc/models/terminal-checkout-query.md index 1b00d416..1926229a 100644 --- a/doc/models/terminal-checkout-query.md +++ b/doc/models/terminal-checkout-query.md @@ -16,8 +16,17 @@ ```json { - "filter": null, - "sort": null + "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 index 1aa28cce..f018a271 100644 --- a/doc/models/terminal-checkout.md +++ b/doc/models/terminal-checkout.md @@ -27,40 +27,69 @@ Represents a checkout processed by the Square Terminal. | `appId` | `string \| undefined` | Optional | The ID of the application that created the checkout. | | `locationId` | `string \| undefined` | Optional | The location of the device where the `TerminalCheckout` was directed. | | `paymentType` | [`string \| undefined`](../../doc/models/checkout-options-payment-type.md) | Optional | - | +| `teamMemberId` | `string \| undefined` | Optional | An optional ID of the team member associated with creating the checkout. | | `customerId` | `string \| undefined` | Optional | An optional ID of the customer associated with the checkout. | | `appFeeMoney` | [`Money \| undefined`](../../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. | +| `statementDescriptionIdentifier` | `string \| undefined` | 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` | +| `tipMoney` | [`Money \| undefined`](../../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. | ## Example (as JSON) ```json { - "id": null, + "id": "id0", "amount_money": { - "amount": null, - "currency": null + "amount": 186, + "currency": "NGN" + }, + "reference_id": "reference_id2", + "note": "note4", + "order_id": "order_id6", + "payment_options": { + "autocomplete": false, + "delay_duration": "delay_duration2", + "accept_partial_authorization": false, + "delay_action": "CANCEL" }, - "reference_id": null, - "note": null, - "order_id": null, - "payment_options": null, "device_options": { "device_id": "device_id6", - "skip_receipt_screen": null, - "collect_signature": null, - "tip_settings": null, - "show_itemized_cart": null + "skip_receipt_screen": false, + "collect_signature": false, + "tip_settings": { + "allow_tipping": false, + "separate_tip_screen": false, + "custom_tip_field": false, + "tip_percentages": [ + 154 + ], + "smart_tipping": false + }, + "show_itemized_cart": false + }, + "deadline_duration": "deadline_duration8", + "status": "status8", + "cancel_reason": "SELLER_CANCELED", + "payment_ids": [ + "payment_ids6", + "payment_ids7", + "payment_ids8" + ], + "created_at": "created_at2", + "updated_at": "updated_at4", + "app_id": "app_id6", + "location_id": "location_id4", + "payment_type": "FELICA_QUICPAY", + "team_member_id": "team_member_id0", + "customer_id": "customer_id8", + "app_fee_money": { + "amount": 106, + "currency": "GBP" }, - "deadline_duration": null, - "status": null, - "cancel_reason": null, - "payment_ids": null, - "created_at": null, - "updated_at": null, - "app_id": null, - "location_id": null, - "payment_type": null, - "customer_id": null, - "app_fee_money": null + "statement_description_identifier": "statement_description_identifier4", + "tip_money": { + "amount": 190, + "currency": "CHE" + } } ``` diff --git a/doc/models/terminal-refund-query-filter.md b/doc/models/terminal-refund-query-filter.md index e44bde62..be3517fd 100644 --- a/doc/models/terminal-refund-query-filter.md +++ b/doc/models/terminal-refund-query-filter.md @@ -17,9 +17,12 @@ ```json { - "device_id": null, - "created_at": null, - "status": null + "device_id": "device_id6", + "created_at": { + "start_at": "start_at4", + "end_at": "end_at8" + }, + "status": "status8" } ``` diff --git a/doc/models/terminal-refund-query-sort.md b/doc/models/terminal-refund-query-sort.md index f89f51af..42a0a65a 100644 --- a/doc/models/terminal-refund-query-sort.md +++ b/doc/models/terminal-refund-query-sort.md @@ -15,7 +15,7 @@ ```json { - "sort_order": null + "sort_order": "sort_order0" } ``` diff --git a/doc/models/terminal-refund-query.md b/doc/models/terminal-refund-query.md index 4c3592e5..3a4e78e3 100644 --- a/doc/models/terminal-refund-query.md +++ b/doc/models/terminal-refund-query.md @@ -16,8 +16,17 @@ ```json { - "filter": null, - "sort": null + "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 index d2812338..f5e4dbe8 100644 --- a/doc/models/terminal-refund.md +++ b/doc/models/terminal-refund.md @@ -30,23 +30,23 @@ Represents a payment refund processed by the Square Terminal. Only supports Inte ```json { - "id": null, - "refund_id": null, + "id": "id0", + "refund_id": "refund_id4", "payment_id": "payment_id0", - "order_id": null, + "order_id": "order_id6", "amount_money": { - "amount": null, - "currency": null + "amount": 186, + "currency": "NGN" }, "reason": "reason4", "device_id": "device_id6", - "deadline_duration": null, - "status": null, - "cancel_reason": null, - "created_at": null, - "updated_at": null, - "app_id": null, - "location_id": null + "deadline_duration": "deadline_duration8", + "status": "status8", + "cancel_reason": "SELLER_CANCELED", + "created_at": "created_at2", + "updated_at": "updated_at4", + "app_id": "app_id6", + "location_id": "location_id4" } ``` diff --git a/doc/models/test-webhook-subscription-request.md b/doc/models/test-webhook-subscription-request.md index f27c79fe..448a7045 100644 --- a/doc/models/test-webhook-subscription-request.md +++ b/doc/models/test-webhook-subscription-request.md @@ -11,7 +11,7 @@ Tests a [Subscription](../../doc/models/webhook-subscription.md) by sending a te | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `eventType` | `string \| undefined` | Optional | The event type that will be used to test the [Subscription](../../doc/models/webhook-subscription.md). The event type must be
contained in the list of event types in the [Subscription](../../doc/models/webhook-subscription.md). | +| `eventType` | `string \| undefined` | 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). | ## Example (as JSON) diff --git a/doc/models/time-range.md b/doc/models/time-range.md index 04d19d8f..eea31777 100644 --- a/doc/models/time-range.md +++ b/doc/models/time-range.md @@ -22,8 +22,8 @@ how time ranges are handled. ```json { - "start_at": null, - "end_at": null + "start_at": "start_at2", + "end_at": "end_at0" } ``` diff --git a/doc/models/tip-settings.md b/doc/models/tip-settings.md index 3f959132..6ca87c8e 100644 --- a/doc/models/tip-settings.md +++ b/doc/models/tip-settings.md @@ -19,11 +19,14 @@ ```json { - "allow_tipping": null, - "separate_tip_screen": null, - "custom_tip_field": null, - "tip_percentages": null, - "smart_tipping": null + "allow_tipping": false, + "separate_tip_screen": false, + "custom_tip_field": false, + "tip_percentages": [ + 156, + 157 + ], + "smart_tipping": false } ``` diff --git a/doc/models/transaction.md b/doc/models/transaction.md index ebf500c7..78ab27d9 100644 --- a/doc/models/transaction.md +++ b/doc/models/transaction.md @@ -20,7 +20,7 @@ the transaction. | `createdAt` | `string \| undefined` | Optional | The timestamp for when the transaction was created, in RFC 3339 format.
**Constraints**: *Maximum Length*: `32` | | `tenders` | [`Tender[] \| undefined`](../../doc/models/tender.md) | Optional | The tenders used to pay in the transaction. | | `refunds` | [`Refund[] \| undefined`](../../doc/models/refund.md) | Optional | Refunds that have been applied to any tender in the transaction. | -| `referenceId` | `string \| undefined` | Optional | If the transaction was created with the [Charge]($e/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` | +| `referenceId` | `string \| undefined` | 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` | | `product` | [`string \| undefined`](../../doc/models/transaction-product.md) | Optional | Indicates the Square product used to process a transaction. | | `clientId` | `string \| undefined` | 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` | | `shippingAddress` | [`Address \| undefined`](../../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). | @@ -30,16 +30,351 @@ the transaction. ```json { - "id": null, - "location_id": null, - "created_at": null, - "tenders": null, - "refunds": null, - "reference_id": null, - "product": null, - "client_id": null, - "shipping_address": null, - "order_id": null + "id": "id0", + "location_id": "location_id4", + "created_at": "created_at2", + "tenders": [ + { + "id": "id2", + "location_id": "location_id6", + "transaction_id": "transaction_id0", + "created_at": "created_at0", + "note": "note8", + "amount_money": { + "amount": 214, + "currency": "TJS" + }, + "tip_money": { + "amount": 218, + "currency": "HTG" + }, + "processing_fee_money": {}, + "customer_id": "customer_id0", + "type": "OTHER", + "card_details": { + "status": "AUTHORIZED", + "card": { + "id": "id6", + "card_brand": "INTERAC", + "last_4": "last_48", + "exp_month": 148, + "exp_year": 148, + "cardholder_name": "cardholder_name8", + "billing_address": { + "address_line_1": "address_line_18", + "address_line_2": "address_line_22", + "address_line_3": "address_line_38", + "locality": "locality8", + "sublocality": "sublocality2", + "sublocality_2": "sublocality_20", + "sublocality_3": "sublocality_38", + "administrative_district_level_1": "administrative_district_level_16", + "administrative_district_level_2": "administrative_district_level_22", + "administrative_district_level_3": "administrative_district_level_30", + "postal_code": "postal_code4", + "country": "PY", + "first_name": "first_name2", + "last_name": "last_name0" + }, + "fingerprint": "fingerprint2", + "customer_id": "customer_id4", + "merchant_id": "merchant_id6", + "reference_id": "reference_id6", + "enabled": false, + "card_type": "DEBIT", + "prepaid_type": "UNKNOWN_PREPAID_TYPE", + "bin": "bin6", + "version": 234, + "card_co_brand": "UNKNOWN" + }, + "entry_method": "KEYED" + }, + "cash_details": { + "buyer_tendered_money": {}, + "change_back_money": {} + }, + "additional_recipients": [ + { + "location_id": "location_id5", + "description": "description1", + "amount_money": {}, + "receivable_id": "receivable_id1" + }, + { + "location_id": "location_id6", + "description": "description2", + "amount_money": {}, + "receivable_id": "receivable_id2" + }, + { + "location_id": "location_id7", + "description": "description3", + "amount_money": {}, + "receivable_id": "receivable_id3" + } + ], + "payment_id": "payment_id2" + }, + { + "id": "id3", + "location_id": "location_id7", + "transaction_id": "transaction_id1", + "created_at": "created_at1", + "note": "note9", + "amount_money": { + "amount": 215, + "currency": "TMT" + }, + "tip_money": { + "amount": 219, + "currency": "HUF" + }, + "processing_fee_money": {}, + "customer_id": "customer_id1", + "type": "CARD", + "card_details": { + "status": "FAILED", + "card": { + "id": "id5", + "card_brand": "EFTPOS", + "last_4": "last_47", + "exp_month": 149, + "exp_year": 147, + "cardholder_name": "cardholder_name9", + "billing_address": { + "address_line_1": "address_line_17", + "address_line_2": "address_line_23", + "address_line_3": "address_line_39", + "locality": "locality7", + "sublocality": "sublocality3", + "sublocality_2": "sublocality_21", + "sublocality_3": "sublocality_37", + "administrative_district_level_1": "administrative_district_level_17", + "administrative_district_level_2": "administrative_district_level_21", + "administrative_district_level_3": "administrative_district_level_31", + "postal_code": "postal_code5", + "country": "QA", + "first_name": "first_name3", + "last_name": "last_name1" + }, + "fingerprint": "fingerprint1", + "customer_id": "customer_id3", + "merchant_id": "merchant_id5", + "reference_id": "reference_id7", + "enabled": true, + "card_type": "UNKNOWN_CARD_TYPE", + "prepaid_type": "PREPAID", + "bin": "bin5", + "version": 233, + "card_co_brand": "AFTERPAY" + }, + "entry_method": "EMV" + }, + "cash_details": { + "buyer_tendered_money": {}, + "change_back_money": {} + }, + "additional_recipients": [ + { + "location_id": "location_id6", + "description": "description2", + "amount_money": {}, + "receivable_id": "receivable_id2" + } + ], + "payment_id": "payment_id3" + }, + { + "id": "id4", + "location_id": "location_id8", + "transaction_id": "transaction_id2", + "created_at": "created_at2", + "note": "note0", + "amount_money": { + "amount": 216, + "currency": "TND" + }, + "tip_money": { + "amount": 220, + "currency": "IDR" + }, + "processing_fee_money": {}, + "customer_id": "customer_id2", + "type": "CASH", + "card_details": { + "status": "VOIDED", + "card": { + "id": "id4", + "card_brand": "FELICA", + "last_4": "last_46", + "exp_month": 150, + "exp_year": 146, + "cardholder_name": "cardholder_name0", + "billing_address": { + "address_line_1": "address_line_16", + "address_line_2": "address_line_24", + "address_line_3": "address_line_30", + "locality": "locality6", + "sublocality": "sublocality4", + "sublocality_2": "sublocality_22", + "sublocality_3": "sublocality_36", + "administrative_district_level_1": "administrative_district_level_18", + "administrative_district_level_2": "administrative_district_level_20", + "administrative_district_level_3": "administrative_district_level_32", + "postal_code": "postal_code6", + "country": "RE", + "first_name": "first_name4", + "last_name": "last_name2" + }, + "fingerprint": "fingerprint0", + "customer_id": "customer_id2", + "merchant_id": "merchant_id4", + "reference_id": "reference_id8", + "enabled": false, + "card_type": "CREDIT", + "prepaid_type": "NOT_PREPAID", + "bin": "bin4", + "version": 232, + "card_co_brand": "CLEARPAY" + }, + "entry_method": "ON_FILE" + }, + "cash_details": { + "buyer_tendered_money": {}, + "change_back_money": {} + }, + "additional_recipients": [ + { + "location_id": "location_id7", + "description": "description3", + "amount_money": {}, + "receivable_id": "receivable_id3" + }, + { + "location_id": "location_id8", + "description": "description4", + "amount_money": {}, + "receivable_id": "receivable_id4" + } + ], + "payment_id": "payment_id4" + } + ], + "refunds": [ + { + "id": "id4", + "location_id": "location_id8", + "transaction_id": "transaction_id2", + "tender_id": "tender_id2", + "created_at": "created_at2", + "reason": "reason0", + "amount_money": { + "amount": 186, + "currency": "YER" + }, + "status": "PENDING", + "processing_fee_money": { + "amount": 112, + "currency": "GEL" + }, + "additional_recipients": [ + { + "location_id": "location_id7", + "description": "description3", + "amount_money": {}, + "receivable_id": "receivable_id3" + } + ] + }, + { + "id": "id5", + "location_id": "location_id9", + "transaction_id": "transaction_id3", + "tender_id": "tender_id3", + "created_at": "created_at3", + "reason": "reason9", + "amount_money": { + "amount": 187, + "currency": "ZAR" + }, + "status": "APPROVED", + "processing_fee_money": { + "amount": 113, + "currency": "GHS" + }, + "additional_recipients": [ + { + "location_id": "location_id8", + "description": "description4", + "amount_money": {}, + "receivable_id": "receivable_id4" + }, + { + "location_id": "location_id9", + "description": "description5", + "amount_money": {}, + "receivable_id": "receivable_id5" + } + ] + }, + { + "id": "id6", + "location_id": "location_id0", + "transaction_id": "transaction_id4", + "tender_id": "tender_id4", + "created_at": "created_at4", + "reason": "reason8", + "amount_money": { + "amount": 188, + "currency": "ZMK" + }, + "status": "REJECTED", + "processing_fee_money": { + "amount": 114, + "currency": "GIP" + }, + "additional_recipients": [ + { + "location_id": "location_id9", + "description": "description5", + "amount_money": {}, + "receivable_id": "receivable_id5" + }, + { + "location_id": "location_id0", + "description": "description6", + "amount_money": {}, + "receivable_id": "receivable_id6" + }, + { + "location_id": "location_id1", + "description": "description7", + "amount_money": {}, + "receivable_id": "receivable_id7" + } + ] + } + ], + "reference_id": "reference_id2", + "product": "PAYROLL", + "client_id": "client_id8", + "shipping_address": { + "address_line_1": "address_line_10", + "address_line_2": "address_line_20", + "address_line_3": "address_line_36", + "locality": "locality0", + "sublocality": "sublocality0", + "sublocality_2": "sublocality_28", + "sublocality_3": "sublocality_30", + "administrative_district_level_1": "administrative_district_level_14", + "administrative_district_level_2": "administrative_district_level_26", + "administrative_district_level_3": "administrative_district_level_38", + "postal_code": "postal_code2", + "country": "PT", + "first_name": "first_name0", + "last_name": "last_name8" + }, + "order_id": "order_id6" } ``` diff --git a/doc/models/update-booking-custom-attribute-definition-request.md b/doc/models/update-booking-custom-attribute-definition-request.md index 13fb620a..424caa02 100644 --- a/doc/models/update-booking-custom-attribute-definition-request.md +++ b/doc/models/update-booking-custom-attribute-definition-request.md @@ -19,16 +19,19 @@ Represents an [UpdateBookingCustomAttributeDefinition](../../doc/api/booking-cus ```json { "custom_attribute_definition": { - "key": null, - "schema": null, - "name": null, - "description": null, - "visibility": null, - "version": null, - "updated_at": null, - "created_at": null + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description8", + "visibility": "VISIBILITY_HIDDEN", + "version": 20, + "updated_at": "updated_at2", + "created_at": "created_at0" }, - "idempotency_key": null + "idempotency_key": "idempotency_key6" } ``` diff --git a/doc/models/update-booking-request.md b/doc/models/update-booking-request.md index eb8c32f3..21ae0447 100644 --- a/doc/models/update-booking-request.md +++ b/doc/models/update-booking-request.md @@ -16,24 +16,53 @@ ```json { - "idempotency_key": null, + "idempotency_key": "idempotency_key6", "booking": { - "id": null, - "version": null, - "status": null, - "created_at": null, - "updated_at": null, - "start_at": null, - "location_id": null, - "customer_id": null, - "customer_note": null, - "seller_note": null, - "appointment_segments": null, - "transition_time_minutes": null, - "all_day": null, - "location_type": null, - "creator_details": null, - "source": null + "id": "id4", + "version": 156, + "status": "CANCELLED_BY_SELLER", + "created_at": "created_at2", + "updated_at": "updated_at0", + "start_at": "start_at6", + "location_id": "location_id8", + "customer_id": "customer_id2", + "customer_note": "customer_note6", + "seller_note": "seller_note6", + "appointment_segments": [ + { + "duration_minutes": 76, + "service_variation_id": "service_variation_id8", + "team_member_id": "team_member_id4", + "service_variation_version": 244, + "intermission_minutes": 250, + "any_team_member": false, + "resource_ids": [ + "resource_ids4", + "resource_ids5", + "resource_ids6" + ] + }, + { + "duration_minutes": 77, + "service_variation_id": "service_variation_id9", + "team_member_id": "team_member_id5", + "service_variation_version": 245, + "intermission_minutes": 251, + "any_team_member": true, + "resource_ids": [ + "resource_ids5" + ] + } + ], + "transition_time_minutes": 64, + "all_day": false, + "location_type": "CUSTOMER_LOCATION", + "creator_details": { + "creator_type": "TEAM_MEMBER", + "team_member_id": "team_member_id0", + "customer_id": "customer_id8" + }, + "source": "FIRST_PARTY_MERCHANT" } } ``` diff --git a/doc/models/update-catalog-image-request.md b/doc/models/update-catalog-image-request.md index 8649879b..f5085fea 100644 --- a/doc/models/update-catalog-image-request.md +++ b/doc/models/update-catalog-image-request.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `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/basics/api101/idempotency) for more information.
**Constraints**: *Minimum Length*: `1` | +| `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` | ## Example (as JSON) diff --git a/doc/models/update-order-custom-attribute-definition-request.md b/doc/models/update-order-custom-attribute-definition-request.md index 75f6668e..e20802d8 100644 --- a/doc/models/update-order-custom-attribute-definition-request.md +++ b/doc/models/update-order-custom-attribute-definition-request.md @@ -12,7 +12,7 @@ Represents an update request for an order custom attribute definition. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `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. | -| `idempotencyKey` | `string \| undefined` | Optional | A unique identifier for this request, used to ensure idempotency.
For more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency).
**Constraints**: *Maximum Length*: `45` | +| `idempotencyKey` | `string \| undefined` | Optional | A unique identifier for this request, used to ensure idempotency.
For more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `45` | ## Example (as JSON) diff --git a/doc/models/update-order-request.md b/doc/models/update-order-request.md index 508f342e..95f5f399 100644 --- a/doc/models/update-order-request.md +++ b/doc/models/update-order-request.md @@ -20,9 +20,1373 @@ Defines the fields that are included in requests to the ```json { - "order": null, - "fields_to_clear": null, - "idempotency_key": null + "order": { + "id": "id6", + "location_id": "location_id0", + "reference_id": "reference_id4", + "source": { + "name": "name2" + }, + "customer_id": "customer_id4", + "line_items": [ + { + "uid": "uid1", + "name": "name1", + "quantity": "quantity7", + "quantity_unit": { + "measurement_unit": { + "custom_unit": { + "name": "name9", + "abbreviation": "abbreviation1" + }, + "area_unit": "METRIC_SQUARE_CENTIMETER", + "length_unit": "IMPERIAL_MILE", + "volume_unit": "GENERIC_FLUID_OUNCE", + "weight_unit": "METRIC_KILOGRAM", + "generic_unit": "UNIT", + "time_unit": "GENERIC_MILLISECOND", + "type": "TYPE_GENERIC" + }, + "precision": 201, + "catalog_object_id": "catalog_object_id1", + "catalog_version": 135 + }, + "note": "note3", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 235, + "variation_name": "variation_name1", + "item_type": "CUSTOM_AMOUNT", + "metadata": { + "key0": "metadata2", + "key1": "metadata3" + }, + "modifiers": [ + { + "uid": "uid2", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 82, + "name": "name2", + "quantity": "quantity8", + "base_price_money": { + "amount": 66, + "currency": "ETB" + }, + "total_price_money": { + "amount": 64, + "currency": "SLL" + }, + "metadata": { + "key0": "metadata9", + "key1": "metadata8" + } + }, + { + "uid": "uid3", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 83, + "name": "name3", + "quantity": "quantity9", + "base_price_money": { + "amount": 67, + "currency": "EUR" + }, + "total_price_money": { + "amount": 65, + "currency": "SOS" + }, + "metadata": { + "key0": "metadata0" + } + }, + { + "uid": "uid4", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 84, + "name": "name4", + "quantity": "quantity0", + "base_price_money": { + "amount": 68, + "currency": "FJD" + }, + "total_price_money": { + "amount": 66, + "currency": "SRD" + }, + "metadata": { + "key0": "metadata1", + "key1": "metadata0", + "key2": "metadata9" + } + } + ], + "applied_taxes": [ + { + "uid": "uid1", + "tax_uid": "tax_uid7", + "applied_money": {} + }, + { + "uid": "uid2", + "tax_uid": "tax_uid8", + "applied_money": {} + }, + { + "uid": "uid3", + "tax_uid": "tax_uid9", + "applied_money": {} + } + ], + "applied_discounts": [ + { + "uid": "uid5", + "discount_uid": "discount_uid9", + "applied_money": {} + } + ], + "applied_service_charges": [ + { + "uid": "uid0", + "service_charge_uid": "service_charge_uid0", + "applied_money": {} + }, + { + "uid": "uid9", + "service_charge_uid": "service_charge_uid9", + "applied_money": {} + } + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_sales_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "pricing_blocklists": { + "blocked_discounts": [ + { + "uid": "uid4", + "discount_uid": "discount_uid0", + "discount_catalog_object_id": "discount_catalog_object_id6" + }, + { + "uid": "uid5", + "discount_uid": "discount_uid1", + "discount_catalog_object_id": "discount_catalog_object_id7" + } + ], + "blocked_taxes": [ + { + "uid": "uid2", + "tax_uid": "tax_uid8", + "tax_catalog_object_id": "tax_catalog_object_id6" + }, + { + "uid": "uid1", + "tax_uid": "tax_uid7", + "tax_catalog_object_id": "tax_catalog_object_id5" + } + ] + }, + "total_service_charge_money": {} + } + ], + "taxes": [ + { + "uid": "uid9", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 153, + "name": "name9", + "type": "ADDITIVE", + "percentage": "percentage7", + "metadata": { + "key0": "metadata4", + "key1": "metadata5" + }, + "applied_money": {}, + "scope": "LINE_ITEM", + "auto_applied": true + }, + { + "uid": "uid8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 154, + "name": "name8", + "type": "INCLUSIVE", + "percentage": "percentage6", + "metadata": { + "key0": "metadata5", + "key1": "metadata6", + "key2": "metadata7" + }, + "applied_money": {}, + "scope": "ORDER", + "auto_applied": false + } + ], + "discounts": [ + { + "uid": "uid7", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 97, + "name": "name7", + "type": "FIXED_AMOUNT", + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "metadata": { + "key0": "metadata8" + }, + "scope": "OTHER_DISCOUNT_SCOPE", + "reward_ids": [ + "reward_ids4", + "reward_ids5", + "reward_ids6" + ], + "pricing_rule_id": "pricing_rule_id9" + }, + { + "uid": "uid8", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 98, + "name": "name8", + "type": "VARIABLE_PERCENTAGE", + "percentage": "percentage6", + "amount_money": {}, + "applied_money": {}, + "metadata": { + "key0": "metadata9", + "key1": "metadata0" + }, + "scope": "LINE_ITEM", + "reward_ids": [ + "reward_ids5" + ], + "pricing_rule_id": "pricing_rule_id0" + } + ], + "service_charges": [ + { + "uid": "uid9", + "name": "name9", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 213, + "percentage": "percentage7", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_AMOUNT_PHASE", + "taxable": true, + "applied_taxes": [ + {} + ], + "metadata": { + "key0": "metadata4" + }, + "type": "CUSTOM", + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "OTHER_SERVICE_CHARGE_SCOPE" + } + ], + "fulfillments": [ + { + "uid": "uid2", + "type": "PICKUP", + "state": "PROPOSED", + "line_item_application": "ALL", + "entries": [ + { + "uid": "uid7", + "line_item_uid": "line_item_uid7", + "quantity": "quantity3", + "metadata": { + "key0": "metadata4" + } + }, + { + "uid": "uid8", + "line_item_uid": "line_item_uid8", + "quantity": "quantity4", + "metadata": { + "key0": "metadata5", + "key1": "metadata4", + "key2": "metadata3" + } + }, + { + "uid": "uid9", + "line_item_uid": "line_item_uid9", + "quantity": "quantity5", + "metadata": { + "key0": "metadata6", + "key1": "metadata5" + } + } + ], + "metadata": { + "key0": "metadata7" + }, + "pickup_details": { + "recipient": { + "customer_id": "customer_id0", + "display_name": "display_name2", + "email_address": "email_address0", + "phone_number": "phone_number0", + "address": { + "address_line_1": "address_line_18", + "address_line_2": "address_line_28", + "address_line_3": "address_line_34", + "locality": "locality8", + "sublocality": "sublocality8", + "sublocality_2": "sublocality_26", + "sublocality_3": "sublocality_38", + "administrative_district_level_1": "administrative_district_level_12", + "administrative_district_level_2": "administrative_district_level_24", + "administrative_district_level_3": "administrative_district_level_36", + "postal_code": "postal_code0", + "country": "SY", + "first_name": "first_name8", + "last_name": "last_name6" + } + }, + "expires_at": "expires_at4", + "auto_complete_duration": "auto_complete_duration4", + "schedule_type": "SCHEDULED", + "pickup_at": "pickup_at6", + "pickup_window_duration": "pickup_window_duration0", + "prep_time_duration": "prep_time_duration2", + "note": "note6", + "placed_at": "placed_at0", + "accepted_at": "accepted_at4", + "rejected_at": "rejected_at2", + "ready_at": "ready_at0", + "expired_at": "expired_at0", + "picked_up_at": "picked_up_at0", + "canceled_at": "canceled_at6", + "cancel_reason": "cancel_reason6", + "is_curbside_pickup": false, + "curbside_pickup_details": { + "curbside_details": "curbside_details2", + "buyer_arrived_at": "buyer_arrived_at8" + } + }, + "shipment_details": { + "recipient": { + "customer_id": "customer_id4", + "display_name": "display_name6", + "email_address": "email_address4", + "phone_number": "phone_number4", + "address": { + "address_line_1": "address_line_12", + "address_line_2": "address_line_22", + "address_line_3": "address_line_38", + "locality": "locality2", + "sublocality": "sublocality2", + "sublocality_2": "sublocality_20", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_16", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_30", + "postal_code": "postal_code4", + "country": "VA", + "first_name": "first_name2", + "last_name": "last_name0" + } + }, + "carrier": "carrier6", + "shipping_note": "shipping_note0", + "shipping_type": "shipping_type8", + "tracking_number": "tracking_number2", + "tracking_url": "tracking_url4", + "placed_at": "placed_at4", + "in_progress_at": "in_progress_at0", + "packaged_at": "packaged_at8", + "expected_shipped_at": "expected_shipped_at8", + "shipped_at": "shipped_at2", + "canceled_at": "canceled_at0", + "cancel_reason": "cancel_reason0", + "failed_at": "failed_at8", + "failure_reason": "failure_reason4" + }, + "delivery_details": { + "recipient": {}, + "schedule_type": "SCHEDULED", + "placed_at": "placed_at8", + "deliver_at": "deliver_at6", + "prep_time_duration": "prep_time_duration0", + "delivery_window_duration": "delivery_window_duration2", + "note": "note4", + "completed_at": "completed_at0", + "in_progress_at": "in_progress_at4", + "rejected_at": "rejected_at0", + "ready_at": "ready_at8", + "delivered_at": "delivered_at6", + "canceled_at": "canceled_at4", + "cancel_reason": "cancel_reason4", + "courier_pickup_at": "courier_pickup_at0", + "courier_pickup_window_duration": "courier_pickup_window_duration2", + "is_no_contact_delivery": false, + "dropoff_notes": "dropoff_notes2", + "courier_provider_name": "courier_provider_name6", + "courier_support_phone_number": "courier_support_phone_number4", + "square_delivery_id": "square_delivery_id8", + "external_delivery_id": "external_delivery_id2", + "managed_delivery": false + } + }, + { + "uid": "uid3", + "type": "SHIPMENT", + "state": "RESERVED", + "line_item_application": "ENTRY_LIST", + "entries": [ + { + "uid": "uid8", + "line_item_uid": "line_item_uid8", + "quantity": "quantity4", + "metadata": { + "key0": "metadata5", + "key1": "metadata4", + "key2": "metadata3" + } + } + ], + "metadata": { + "key0": "metadata6", + "key1": "metadata5" + }, + "pickup_details": { + "recipient": { + "customer_id": "customer_id1", + "display_name": "display_name3", + "email_address": "email_address1", + "phone_number": "phone_number1", + "address": { + "address_line_1": "address_line_19", + "address_line_2": "address_line_29", + "address_line_3": "address_line_35", + "locality": "locality9", + "sublocality": "sublocality9", + "sublocality_2": "sublocality_27", + "sublocality_3": "sublocality_39", + "administrative_district_level_1": "administrative_district_level_13", + "administrative_district_level_2": "administrative_district_level_25", + "administrative_district_level_3": "administrative_district_level_37", + "postal_code": "postal_code1", + "country": "SZ", + "first_name": "first_name9", + "last_name": "last_name7" + } + }, + "expires_at": "expires_at5", + "auto_complete_duration": "auto_complete_duration5", + "schedule_type": "ASAP", + "pickup_at": "pickup_at7", + "pickup_window_duration": "pickup_window_duration1", + "prep_time_duration": "prep_time_duration3", + "note": "note7", + "placed_at": "placed_at1", + "accepted_at": "accepted_at5", + "rejected_at": "rejected_at3", + "ready_at": "ready_at1", + "expired_at": "expired_at1", + "picked_up_at": "picked_up_at1", + "canceled_at": "canceled_at7", + "cancel_reason": "cancel_reason7", + "is_curbside_pickup": true, + "curbside_pickup_details": { + "curbside_details": "curbside_details3", + "buyer_arrived_at": "buyer_arrived_at9" + } + }, + "shipment_details": { + "recipient": { + "customer_id": "customer_id5", + "display_name": "display_name7", + "email_address": "email_address5", + "phone_number": "phone_number5", + "address": { + "address_line_1": "address_line_13", + "address_line_2": "address_line_23", + "address_line_3": "address_line_39", + "locality": "locality3", + "sublocality": "sublocality3", + "sublocality_2": "sublocality_21", + "sublocality_3": "sublocality_33", + "administrative_district_level_1": "administrative_district_level_17", + "administrative_district_level_2": "administrative_district_level_29", + "administrative_district_level_3": "administrative_district_level_31", + "postal_code": "postal_code5", + "country": "VC", + "first_name": "first_name3", + "last_name": "last_name1" + } + }, + "carrier": "carrier7", + "shipping_note": "shipping_note1", + "shipping_type": "shipping_type9", + "tracking_number": "tracking_number3", + "tracking_url": "tracking_url5", + "placed_at": "placed_at5", + "in_progress_at": "in_progress_at1", + "packaged_at": "packaged_at9", + "expected_shipped_at": "expected_shipped_at9", + "shipped_at": "shipped_at3", + "canceled_at": "canceled_at1", + "cancel_reason": "cancel_reason1", + "failed_at": "failed_at9", + "failure_reason": "failure_reason5" + }, + "delivery_details": { + "recipient": {}, + "schedule_type": "ASAP", + "placed_at": "placed_at9", + "deliver_at": "deliver_at7", + "prep_time_duration": "prep_time_duration1", + "delivery_window_duration": "delivery_window_duration3", + "note": "note5", + "completed_at": "completed_at1", + "in_progress_at": "in_progress_at5", + "rejected_at": "rejected_at1", + "ready_at": "ready_at9", + "delivered_at": "delivered_at7", + "canceled_at": "canceled_at5", + "cancel_reason": "cancel_reason5", + "courier_pickup_at": "courier_pickup_at1", + "courier_pickup_window_duration": "courier_pickup_window_duration3", + "is_no_contact_delivery": true, + "dropoff_notes": "dropoff_notes3", + "courier_provider_name": "courier_provider_name7", + "courier_support_phone_number": "courier_support_phone_number5", + "square_delivery_id": "square_delivery_id9", + "external_delivery_id": "external_delivery_id3", + "managed_delivery": true + } + } + ], + "returns": [ + { + "uid": "uid9", + "source_order_id": "source_order_id7", + "return_line_items": [ + { + "uid": "uid4", + "source_line_item_uid": "source_line_item_uid2", + "name": "name4", + "quantity": "quantity0", + "quantity_unit": {}, + "note": "note0", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 26, + "variation_name": "variation_name4", + "item_type": "GIFT_CARD", + "return_modifiers": [ + { + "uid": "uid3", + "source_modifier_uid": "source_modifier_uid3", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 79, + "name": "name3", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity9" + }, + { + "uid": "uid2", + "source_modifier_uid": "source_modifier_uid4", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 80, + "name": "name2", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity8" + } + ], + "applied_taxes": [ + {} + ], + "applied_discounts": [ + {}, + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {} + ], + "total_service_charge_money": {} + } + ], + "return_service_charges": [ + { + "uid": "uid0", + "source_service_charge_uid": "source_service_charge_uid6", + "name": "name0", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 12, + "percentage": "percentage8", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "SUBTOTAL_PHASE", + "taxable": false, + "applied_taxes": [ + {} + ], + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "OTHER_SERVICE_CHARGE_SCOPE" + }, + { + "uid": "uid1", + "source_service_charge_uid": "source_service_charge_uid5", + "name": "name1", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 11, + "percentage": "percentage9", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "TOTAL_PHASE", + "taxable": true, + "applied_taxes": [ + {}, + {} + ], + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "ORDER" + } + ], + "return_taxes": [ + { + "uid": "uid1", + "source_tax_uid": "source_tax_uid9", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 255, + "name": "name1", + "type": "UNKNOWN_TAX", + "percentage": "percentage9", + "applied_money": {}, + "scope": "OTHER_TAX_SCOPE" + }, + { + "uid": "uid2", + "source_tax_uid": "source_tax_uid0", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 254, + "name": "name2", + "type": "INCLUSIVE", + "percentage": "percentage0", + "applied_money": {}, + "scope": "ORDER" + }, + { + "uid": "uid3", + "source_tax_uid": "source_tax_uid1", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 253, + "name": "name3", + "type": "ADDITIVE", + "percentage": "percentage1", + "applied_money": {}, + "scope": "LINE_ITEM" + } + ], + "return_discounts": [ + { + "uid": "uid9", + "source_discount_uid": "source_discount_uid9", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 79, + "name": "name9", + "type": "FIXED_PERCENTAGE", + "percentage": "percentage7", + "amount_money": {}, + "applied_money": {}, + "scope": "LINE_ITEM" + }, + { + "uid": "uid8", + "source_discount_uid": "source_discount_uid8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 80, + "name": "name8", + "type": "FIXED_AMOUNT", + "percentage": "percentage6", + "amount_money": {}, + "applied_money": {}, + "scope": "ORDER" + } + ], + "rounding_adjustment": { + "uid": "uid1", + "name": "name1", + "amount_money": {} + }, + "return_amounts": { + "total_money": {}, + "tax_money": {}, + "discount_money": {}, + "tip_money": {}, + "service_charge_money": {} + } + }, + { + "uid": "uid0", + "source_order_id": "source_order_id8", + "return_line_items": [ + { + "uid": "uid5", + "source_line_item_uid": "source_line_item_uid3", + "name": "name5", + "quantity": "quantity1", + "quantity_unit": {}, + "note": "note1", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 25, + "variation_name": "variation_name5", + "item_type": "ITEM", + "return_modifiers": [ + { + "uid": "uid4", + "source_modifier_uid": "source_modifier_uid2", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 78, + "name": "name4", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity0" + } + ], + "applied_taxes": [ + {}, + {} + ], + "applied_discounts": [ + {}, + {}, + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {}, + {} + ], + "total_service_charge_money": {} + }, + { + "uid": "uid6", + "source_line_item_uid": "source_line_item_uid4", + "name": "name6", + "quantity": "quantity2", + "quantity_unit": {}, + "note": "note2", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 24, + "variation_name": "variation_name6", + "item_type": "CUSTOM_AMOUNT", + "return_modifiers": [ + { + "uid": "uid5", + "source_modifier_uid": "source_modifier_uid1", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 77, + "name": "name5", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity1" + }, + { + "uid": "uid4", + "source_modifier_uid": "source_modifier_uid2", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 78, + "name": "name4", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity0" + }, + { + "uid": "uid3", + "source_modifier_uid": "source_modifier_uid3", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 79, + "name": "name3", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity9" + } + ], + "applied_taxes": [ + {}, + {}, + {} + ], + "applied_discounts": [ + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {}, + {}, + {} + ], + "total_service_charge_money": {} + } + ], + "return_service_charges": [ + { + "uid": "uid1", + "source_service_charge_uid": "source_service_charge_uid5", + "name": "name1", + "catalog_object_id": "catalog_object_id5", + "catalog_version": 11, + "percentage": "percentage9", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "TOTAL_PHASE", + "taxable": true, + "applied_taxes": [ + {}, + {} + ], + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "ORDER" + }, + { + "uid": "uid2", + "source_service_charge_uid": "source_service_charge_uid4", + "name": "name2", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 10, + "percentage": "percentage0", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_PERCENTAGE_PHASE", + "taxable": false, + "applied_taxes": [ + {}, + {}, + {} + ], + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "LINE_ITEM" + }, + { + "uid": "uid3", + "source_service_charge_uid": "source_service_charge_uid3", + "name": "name3", + "catalog_object_id": "catalog_object_id7", + "catalog_version": 9, + "percentage": "percentage1", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_AMOUNT_PHASE", + "taxable": true, + "applied_taxes": [ + {} + ], + "treatment_type": "APPORTIONED_TREATMENT", + "scope": "OTHER_SERVICE_CHARGE_SCOPE" + } + ], + "return_taxes": [ + { + "uid": "uid2", + "source_tax_uid": "source_tax_uid0", + "catalog_object_id": "catalog_object_id4", + "catalog_version": 254, + "name": "name2", + "type": "INCLUSIVE", + "percentage": "percentage0", + "applied_money": {}, + "scope": "ORDER" + } + ], + "return_discounts": [ + { + "uid": "uid8", + "source_discount_uid": "source_discount_uid8", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 80, + "name": "name8", + "type": "FIXED_AMOUNT", + "percentage": "percentage6", + "amount_money": {}, + "applied_money": {}, + "scope": "ORDER" + }, + { + "uid": "uid7", + "source_discount_uid": "source_discount_uid7", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 81, + "name": "name7", + "type": "VARIABLE_PERCENTAGE", + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "scope": "OTHER_DISCOUNT_SCOPE" + }, + { + "uid": "uid6", + "source_discount_uid": "source_discount_uid6", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 82, + "name": "name6", + "type": "VARIABLE_AMOUNT", + "percentage": "percentage4", + "amount_money": {}, + "applied_money": {}, + "scope": "LINE_ITEM" + } + ], + "rounding_adjustment": { + "uid": "uid2", + "name": "name2", + "amount_money": {} + }, + "return_amounts": { + "total_money": {}, + "tax_money": {}, + "discount_money": {}, + "tip_money": {}, + "service_charge_money": {} + } + }, + { + "uid": "uid1", + "source_order_id": "source_order_id9", + "return_line_items": [ + { + "uid": "uid6", + "source_line_item_uid": "source_line_item_uid4", + "name": "name6", + "quantity": "quantity2", + "quantity_unit": {}, + "note": "note2", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 24, + "variation_name": "variation_name6", + "item_type": "CUSTOM_AMOUNT", + "return_modifiers": [ + { + "uid": "uid5", + "source_modifier_uid": "source_modifier_uid1", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 77, + "name": "name5", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity1" + }, + { + "uid": "uid4", + "source_modifier_uid": "source_modifier_uid2", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 78, + "name": "name4", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity0" + }, + { + "uid": "uid3", + "source_modifier_uid": "source_modifier_uid3", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 79, + "name": "name3", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity9" + } + ], + "applied_taxes": [ + {}, + {}, + {} + ], + "applied_discounts": [ + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {}, + {}, + {} + ], + "total_service_charge_money": {} + }, + { + "uid": "uid7", + "source_line_item_uid": "source_line_item_uid5", + "name": "name7", + "quantity": "quantity3", + "quantity_unit": {}, + "note": "note3", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 23, + "variation_name": "variation_name7", + "item_type": "GIFT_CARD", + "return_modifiers": [ + { + "uid": "uid6", + "source_modifier_uid": "source_modifier_uid0", + "catalog_object_id": "catalog_object_id0", + "catalog_version": 76, + "name": "name6", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity2" + }, + { + "uid": "uid5", + "source_modifier_uid": "source_modifier_uid1", + "catalog_object_id": "catalog_object_id1", + "catalog_version": 77, + "name": "name5", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity1" + } + ], + "applied_taxes": [ + {} + ], + "applied_discounts": [ + {}, + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {} + ], + "total_service_charge_money": {} + }, + { + "uid": "uid8", + "source_line_item_uid": "source_line_item_uid6", + "name": "name8", + "quantity": "quantity4", + "quantity_unit": {}, + "note": "note4", + "catalog_object_id": "catalog_object_id8", + "catalog_version": 22, + "variation_name": "variation_name8", + "item_type": "ITEM", + "return_modifiers": [ + { + "uid": "uid7", + "source_modifier_uid": "source_modifier_uid9", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 75, + "name": "name7", + "base_price_money": {}, + "total_price_money": {}, + "quantity": "quantity3" + } + ], + "applied_taxes": [ + {}, + {} + ], + "applied_discounts": [ + {}, + {}, + {} + ], + "base_price_money": {}, + "variation_total_price_money": {}, + "gross_return_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_money": {}, + "applied_service_charges": [ + {}, + {} + ], + "total_service_charge_money": {} + } + ], + "return_service_charges": [ + { + "uid": "uid2", + "source_service_charge_uid": "source_service_charge_uid4", + "name": "name2", + "catalog_object_id": "catalog_object_id6", + "catalog_version": 10, + "percentage": "percentage0", + "amount_money": {}, + "applied_money": {}, + "total_money": {}, + "total_tax_money": {}, + "calculation_phase": "APPORTIONED_PERCENTAGE_PHASE", + "taxable": false, + "applied_taxes": [ + {}, + {}, + {} + ], + "treatment_type": "LINE_ITEM_TREATMENT", + "scope": "LINE_ITEM" + } + ], + "return_taxes": [ + { + "uid": "uid3", + "source_tax_uid": "source_tax_uid1", + "catalog_object_id": "catalog_object_id3", + "catalog_version": 253, + "name": "name3", + "type": "ADDITIVE", + "percentage": "percentage1", + "applied_money": {}, + "scope": "LINE_ITEM" + }, + { + "uid": "uid4", + "source_tax_uid": "source_tax_uid2", + "catalog_object_id": "catalog_object_id2", + "catalog_version": 252, + "name": "name4", + "type": "UNKNOWN_TAX", + "percentage": "percentage2", + "applied_money": {}, + "scope": "OTHER_TAX_SCOPE" + } + ], + "return_discounts": [ + { + "uid": "uid7", + "source_discount_uid": "source_discount_uid7", + "catalog_object_id": "catalog_object_id9", + "catalog_version": 81, + "name": "name7", + "type": "VARIABLE_PERCENTAGE", + "percentage": "percentage5", + "amount_money": {}, + "applied_money": {}, + "scope": "OTHER_DISCOUNT_SCOPE" + } + ], + "rounding_adjustment": { + "uid": "uid3", + "name": "name3", + "amount_money": {} + }, + "return_amounts": { + "total_money": {}, + "tax_money": {}, + "discount_money": {}, + "tip_money": {}, + "service_charge_money": {} + } + } + ], + "return_amounts": {}, + "net_amounts": {}, + "rounding_adjustment": {}, + "tenders": [ + { + "id": "id8", + "location_id": "location_id2", + "transaction_id": "transaction_id6", + "created_at": "created_at6", + "note": "note4", + "amount_money": {}, + "tip_money": {}, + "processing_fee_money": {}, + "customer_id": "customer_id6", + "type": "SQUARE_GIFT_CARD", + "card_details": { + "status": "AUTHORIZED", + "card": { + "id": "id0", + "card_brand": "OTHER_BRAND", + "last_4": "last_42", + "exp_month": 160, + "exp_year": 136, + "cardholder_name": "cardholder_name4", + "billing_address": {}, + "fingerprint": "fingerprint6", + "customer_id": "customer_id8", + "merchant_id": "merchant_id0", + "reference_id": "reference_id8", + "enabled": false, + "card_type": "UNKNOWN_CARD_TYPE", + "prepaid_type": "PREPAID", + "bin": "bin0", + "version": 222, + "card_co_brand": "AFTERPAY" + }, + "entry_method": "EMV" + }, + "cash_details": { + "buyer_tendered_money": {}, + "change_back_money": {} + }, + "additional_recipients": [ + { + "location_id": "location_id1", + "description": "description7", + "amount_money": {}, + "receivable_id": "receivable_id7" + }, + { + "location_id": "location_id2", + "description": "description8", + "amount_money": {}, + "receivable_id": "receivable_id8" + } + ], + "payment_id": "payment_id8" + }, + { + "id": "id9", + "location_id": "location_id3", + "transaction_id": "transaction_id7", + "created_at": "created_at7", + "note": "note5", + "amount_money": {}, + "tip_money": {}, + "processing_fee_money": {}, + "customer_id": "customer_id7", + "type": "NO_SALE", + "card_details": { + "status": "CAPTURED", + "card": { + "id": "id1", + "card_brand": "EBT", + "last_4": "last_43", + "exp_month": 159, + "exp_year": 137, + "cardholder_name": "cardholder_name3", + "billing_address": {}, + "fingerprint": "fingerprint7", + "customer_id": "customer_id9", + "merchant_id": "merchant_id1", + "reference_id": "reference_id9", + "enabled": true, + "card_type": "DEBIT", + "prepaid_type": "UNKNOWN_PREPAID_TYPE", + "bin": "bin1", + "version": 223, + "card_co_brand": "UNKNOWN" + }, + "entry_method": "ON_FILE" + }, + "cash_details": { + "buyer_tendered_money": {}, + "change_back_money": {} + }, + "additional_recipients": [ + { + "location_id": "location_id2", + "description": "description8", + "amount_money": {}, + "receivable_id": "receivable_id8" + }, + { + "location_id": "location_id3", + "description": "description9", + "amount_money": {}, + "receivable_id": "receivable_id9" + }, + { + "location_id": "location_id4", + "description": "description0", + "amount_money": {}, + "receivable_id": "receivable_id0" + } + ], + "payment_id": "payment_id9" + } + ], + "refunds": [ + { + "id": "id2", + "location_id": "location_id6", + "transaction_id": "transaction_id0", + "tender_id": "tender_id0", + "created_at": "created_at0", + "reason": "reason2", + "amount_money": {}, + "status": "PENDING", + "processing_fee_money": {}, + "additional_recipients": [ + {} + ] + } + ], + "metadata": { + "key0": "metadata3" + }, + "created_at": "created_at4", + "updated_at": "updated_at2", + "closed_at": "closed_at8", + "state": "OPEN", + "version": 116, + "total_money": {}, + "total_tax_money": {}, + "total_discount_money": {}, + "total_tip_money": {}, + "total_service_charge_money": {}, + "ticket_name": "ticket_name0", + "pricing_options": { + "auto_apply_discounts": false, + "auto_apply_taxes": false + }, + "rewards": [ + { + "id": "id1", + "reward_tier_id": "reward_tier_id7" + }, + { + "id": "id2", + "reward_tier_id": "reward_tier_id8" + }, + { + "id": "id3", + "reward_tier_id": "reward_tier_id9" + } + ], + "net_amount_due_money": {} + }, + "fields_to_clear": [ + "fields_to_clear1" + ], + "idempotency_key": "idempotency_key6" } ``` diff --git a/doc/models/update-payment-link-response.md b/doc/models/update-payment-link-response.md index 74b85d77..15bcad6e 100644 --- a/doc/models/update-payment-link-response.md +++ b/doc/models/update-payment-link-response.md @@ -22,6 +22,7 @@ }, "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", diff --git a/doc/models/update-vendor-request.md b/doc/models/update-vendor-request.md index 8c0ac78a..53689343 100644 --- a/doc/models/update-vendor-request.md +++ b/doc/models/update-vendor-request.md @@ -11,7 +11,7 @@ Represents an input to a call to [UpdateVendor](../../doc/api/vendors.md#update- | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `idempotencyKey` | `string \| undefined` | Optional | A client-supplied, universally unique identifier (UUID) for the
request.

See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the
[API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more
information.
**Constraints**: *Maximum Length*: `128` | +| `idempotencyKey` | `string \| undefined` | 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` | | `vendor` | [`Vendor`](../../doc/models/vendor.md) | Required | Represents a supplier to a seller. | ## Example (as JSON) diff --git a/doc/models/update-webhook-subscription-signature-key-request.md b/doc/models/update-webhook-subscription-signature-key-request.md index 2f8c6e7c..6793e743 100644 --- a/doc/models/update-webhook-subscription-signature-key-request.md +++ b/doc/models/update-webhook-subscription-signature-key-request.md @@ -11,7 +11,7 @@ Updates a [Subscription](../../doc/models/webhook-subscription.md) by replacing | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `idempotencyKey` | `string \| undefined` | Optional | A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](../../doc/api/webhook-subscriptions.md#update-webhook-subscription-signature-key) request.
**Constraints**: *Maximum Length*: `45` | +| `idempotencyKey` | `string \| undefined` | Optional | A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey) request.
**Constraints**: *Maximum Length*: `45` | ## Example (as JSON) diff --git a/doc/models/upsert-booking-custom-attribute-request.md b/doc/models/upsert-booking-custom-attribute-request.md index 20e198ed..97356c1d 100644 --- a/doc/models/upsert-booking-custom-attribute-request.md +++ b/doc/models/upsert-booking-custom-attribute-request.md @@ -19,15 +19,30 @@ Represents an [UpsertBookingCustomAttribute](../../doc/api/booking-custom-attrib ```json { "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" }, - "idempotency_key": null + "idempotency_key": "idempotency_key6" } ``` diff --git a/doc/models/upsert-booking-custom-attribute-response.md b/doc/models/upsert-booking-custom-attribute-response.md index e659a278..07baadf7 100644 --- a/doc/models/upsert-booking-custom-attribute-response.md +++ b/doc/models/upsert-booking-custom-attribute-response.md @@ -19,8 +19,50 @@ Either `custom_attribute_definition` or `errors` is present in the response. ```json { - "custom_attribute": null, - "errors": null + "custom_attribute": { + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/upsert-catalog-object-request.md b/doc/models/upsert-catalog-object-request.md index c0b3b9d8..b30febea 100644 --- a/doc/models/upsert-catalog-object-request.md +++ b/doc/models/upsert-catalog-object-request.md @@ -9,7 +9,7 @@ | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `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/basics/api101/idempotency) for more information.
**Constraints**: *Minimum Length*: `1` | +| `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` | | `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. | ## Example (as JSON) diff --git a/doc/models/upsert-customer-custom-attribute-request.md b/doc/models/upsert-customer-custom-attribute-request.md index d5f480b8..8d88f774 100644 --- a/doc/models/upsert-customer-custom-attribute-request.md +++ b/doc/models/upsert-customer-custom-attribute-request.md @@ -19,15 +19,30 @@ Represents an [UpsertCustomerCustomAttribute](../../doc/api/customer-custom-attr ```json { "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" }, - "idempotency_key": null + "idempotency_key": "idempotency_key6" } ``` diff --git a/doc/models/upsert-customer-custom-attribute-response.md b/doc/models/upsert-customer-custom-attribute-response.md index 5509ed33..f986739c 100644 --- a/doc/models/upsert-customer-custom-attribute-response.md +++ b/doc/models/upsert-customer-custom-attribute-response.md @@ -19,8 +19,50 @@ Either `custom_attribute_definition` or `errors` is present in the response. ```json { - "custom_attribute": null, - "errors": null + "custom_attribute": { + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/upsert-location-custom-attribute-request.md b/doc/models/upsert-location-custom-attribute-request.md index c6bd233c..2407cc9a 100644 --- a/doc/models/upsert-location-custom-attribute-request.md +++ b/doc/models/upsert-location-custom-attribute-request.md @@ -19,15 +19,30 @@ Represents an [UpsertLocationCustomAttribute](../../doc/api/location-custom-attr ```json { "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" }, - "idempotency_key": null + "idempotency_key": "idempotency_key6" } ``` diff --git a/doc/models/upsert-location-custom-attribute-response.md b/doc/models/upsert-location-custom-attribute-response.md index 8fa11af9..0446dc60 100644 --- a/doc/models/upsert-location-custom-attribute-response.md +++ b/doc/models/upsert-location-custom-attribute-response.md @@ -19,8 +19,50 @@ Either `custom_attribute_definition` or `errors` is present in the response. ```json { - "custom_attribute": null, - "errors": null + "custom_attribute": { + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/upsert-order-custom-attribute-request.md b/doc/models/upsert-order-custom-attribute-request.md index a8defe1e..aaf5ba03 100644 --- a/doc/models/upsert-order-custom-attribute-request.md +++ b/doc/models/upsert-order-custom-attribute-request.md @@ -12,22 +12,37 @@ Represents an upsert request for an order custom attribute. | Name | Type | Tags | Description | | --- | --- | --- | --- | | `customAttribute` | [`CustomAttribute`](../../doc/models/custom-attribute.md) | Required | A custom attribute value. Each custom attribute value has a corresponding
`CustomAttributeDefinition` object. | -| `idempotencyKey` | `string \| undefined` | Optional | A unique identifier for this request, used to ensure idempotency.
For more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency).
**Constraints**: *Maximum Length*: `45` | +| `idempotencyKey` | `string \| undefined` | Optional | A unique identifier for this request, used to ensure idempotency.
For more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency).
**Constraints**: *Minimum Length*: `1`, *Maximum Length*: `45` | ## Example (as JSON) ```json { "custom_attribute": { - "key": null, - "value": null, - "version": null, - "visibility": null, - "definition": null, - "updated_at": null, - "created_at": null + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" }, - "idempotency_key": null + "idempotency_key": "idempotency_key6" } ``` diff --git a/doc/models/upsert-order-custom-attribute-response.md b/doc/models/upsert-order-custom-attribute-response.md index 825b0aa5..6d7fd3ee 100644 --- a/doc/models/upsert-order-custom-attribute-response.md +++ b/doc/models/upsert-order-custom-attribute-response.md @@ -18,8 +18,50 @@ Represents a response from upserting order custom attribute definitions. ```json { - "custom_attribute": null, - "errors": null + "custom_attribute": { + "key": "key2", + "value": { + "key1": "val1", + "key2": "val2" + }, + "version": 102, + "visibility": "VISIBILITY_READ_ONLY", + "definition": { + "key": "key2", + "schema": { + "key1": "val1", + "key2": "val2" + }, + "name": "name2", + "description": "description2", + "visibility": "VISIBILITY_READ_ONLY", + "version": 198, + "updated_at": "updated_at8", + "created_at": "created_at0" + }, + "updated_at": "updated_at2", + "created_at": "created_at0" + }, + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ] } ``` diff --git a/doc/models/v1-create-refund-request.md b/doc/models/v1-create-refund-request.md index 201bef58..d08275b3 100644 --- a/doc/models/v1-create-refund-request.md +++ b/doc/models/v1-create-refund-request.md @@ -24,8 +24,11 @@ V1CreateRefundRequest "payment_id": "payment_id0", "type": "FULL", "reason": "reason4", - "refunded_money": null, - "request_idempotence_key": null + "refunded_money": { + "amount": 214, + "currency_code": "CHW" + }, + "request_idempotence_key": "request_idempotence_key8" } ``` diff --git a/doc/models/v1-list-orders-request.md b/doc/models/v1-list-orders-request.md index d495751b..b2db3d32 100644 --- a/doc/models/v1-list-orders-request.md +++ b/doc/models/v1-list-orders-request.md @@ -17,9 +17,9 @@ ```json { - "order": null, - "limit": null, - "batch_token": null + "order": "DESC", + "limit": 172, + "batch_token": "batch_token2" } ``` diff --git a/doc/models/v1-list-orders-response.md b/doc/models/v1-list-orders-response.md index 16541f34..b787b36a 100644 --- a/doc/models/v1-list-orders-response.md +++ b/doc/models/v1-list-orders-response.md @@ -15,7 +15,178 @@ ```json { - "items": null + "items": [ + { + "errors": [ + { + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "GENERIC_DECLINE", + "detail": "detail8", + "field": "field6" + }, + { + "category": "API_ERROR", + "code": "CVV_FAILURE", + "detail": "detail9", + "field": "field7" + }, + { + "category": "AUTHENTICATION_ERROR", + "code": "ADDRESS_VERIFICATION_FAILURE", + "detail": "detail0", + "field": "field8" + } + ], + "id": "id7", + "buyer_email": "buyer_email1", + "recipient_name": "recipient_name5", + "recipient_phone_number": "recipient_phone_number7", + "state": "REJECTED", + "shipping_address": { + "address_line_1": "address_line_17", + "address_line_2": "address_line_23", + "address_line_3": "address_line_39", + "locality": "locality3", + "sublocality": "sublocality3", + "sublocality_2": "sublocality_21", + "sublocality_3": "sublocality_33", + "administrative_district_level_1": "administrative_district_level_17", + "administrative_district_level_2": "administrative_district_level_21", + "administrative_district_level_3": "administrative_district_level_31", + "postal_code": "postal_code5", + "country": "HN", + "first_name": "first_name3", + "last_name": "last_name1" + }, + "subtotal_money": { + "amount": 199, + "currency_code": "JMD" + }, + "total_shipping_money": { + "amount": 177, + "currency_code": "XAG" + }, + "total_tax_money": {}, + "total_price_money": {}, + "total_discount_money": {}, + "created_at": "created_at5", + "updated_at": "updated_at7", + "expires_at": "expires_at9", + "payment_id": "payment_id7", + "buyer_note": "buyer_note9", + "completed_note": "completed_note7", + "refunded_note": "refunded_note1", + "canceled_note": "canceled_note3", + "tender": { + "id": "id3", + "type": "CASH", + "name": "name3", + "employee_id": "employee_id3", + "receipt_url": "receipt_url5", + "card_brand": "JCB", + "pan_suffix": "pan_suffix3", + "entry_method": "SQUARE_CASH", + "payment_note": "payment_note1", + "total_money": {}, + "tendered_money": {}, + "tendered_at": "tendered_at7", + "settled_at": "settled_at9", + "change_back_money": {}, + "refunded_money": {}, + "is_exchange": true + }, + "order_history": [ + { + "action": "ORDER_PLACED", + "created_at": "created_at2" + } + ], + "promo_code": "promo_code5", + "btc_receive_address": "btc_receive_address5", + "btc_price_satoshi": 114.71 + }, + { + "errors": [ + { + "category": "API_ERROR", + "code": "CVV_FAILURE", + "detail": "detail9", + "field": "field7" + } + ], + "id": "id8", + "buyer_email": "buyer_email0", + "recipient_name": "recipient_name6", + "recipient_phone_number": "recipient_phone_number6", + "state": "REFUNDED", + "shipping_address": { + "address_line_1": "address_line_18", + "address_line_2": "address_line_22", + "address_line_3": "address_line_38", + "locality": "locality2", + "sublocality": "sublocality2", + "sublocality_2": "sublocality_20", + "sublocality_3": "sublocality_32", + "administrative_district_level_1": "administrative_district_level_16", + "administrative_district_level_2": "administrative_district_level_22", + "administrative_district_level_3": "administrative_district_level_30", + "postal_code": "postal_code4", + "country": "HM", + "first_name": "first_name2", + "last_name": "last_name0" + }, + "subtotal_money": { + "amount": 200, + "currency_code": "JOD" + }, + "total_shipping_money": { + "amount": 178, + "currency_code": "XAU" + }, + "total_tax_money": {}, + "total_price_money": {}, + "total_discount_money": {}, + "created_at": "created_at6", + "updated_at": "updated_at6", + "expires_at": "expires_at8", + "payment_id": "payment_id8", + "buyer_note": "buyer_note0", + "completed_note": "completed_note8", + "refunded_note": "refunded_note2", + "canceled_note": "canceled_note2", + "tender": { + "id": "id4", + "type": "THIRD_PARTY_CARD", + "name": "name4", + "employee_id": "employee_id4", + "receipt_url": "receipt_url6", + "card_brand": "CHINA_UNIONPAY", + "pan_suffix": "pan_suffix4", + "entry_method": "SQUARE_WALLET", + "payment_note": "payment_note2", + "total_money": {}, + "tendered_money": {}, + "tendered_at": "tendered_at8", + "settled_at": "settled_at0", + "change_back_money": {}, + "refunded_money": {}, + "is_exchange": false + }, + "order_history": [ + { + "action": "DECLINED", + "created_at": "created_at3" + }, + { + "action": "PAYMENT_RECEIVED", + "created_at": "created_at4" + } + ], + "promo_code": "promo_code4", + "btc_receive_address": "btc_receive_address6", + "btc_price_satoshi": 114.72 + } + ] } ``` diff --git a/doc/models/v1-list-payments-request.md b/doc/models/v1-list-payments-request.md index 9676f78d..fd3ee24f 100644 --- a/doc/models/v1-list-payments-request.md +++ b/doc/models/v1-list-payments-request.md @@ -20,12 +20,12 @@ ```json { - "order": null, - "begin_time": null, - "end_time": null, - "limit": null, - "batch_token": null, - "include_partial": null + "order": "DESC", + "begin_time": "begin_time2", + "end_time": "end_time2", + "limit": 172, + "batch_token": "batch_token2", + "include_partial": false } ``` diff --git a/doc/models/v1-list-payments-response.md b/doc/models/v1-list-payments-response.md index 7cce08ca..354b4cb1 100644 --- a/doc/models/v1-list-payments-response.md +++ b/doc/models/v1-list-payments-response.md @@ -15,7 +15,761 @@ ```json { - "items": null + "items": [ + { + "id": "id7", + "merchant_id": "merchant_id7", + "created_at": "created_at5", + "creator_id": "creator_id7", + "device": { + "id": "id3", + "name": "name3" + }, + "payment_url": "payment_url1", + "receipt_url": "receipt_url1", + "inclusive_tax_money": { + "amount": 43, + "currency_code": "NPR" + }, + "additive_tax_money": { + "amount": 49, + "currency_code": "LTL" + }, + "tax_money": {}, + "tip_money": {}, + "discount_money": {}, + "total_collected_money": {}, + "processing_fee_money": {}, + "net_total_money": {}, + "refunded_money": {}, + "swedish_rounding_money": {}, + "gross_sales_money": {}, + "net_sales_money": {}, + "inclusive_tax": [ + { + "errors": [ + { + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "UNSUPPORTED_SOURCE_TYPE", + "detail": "detail5", + "field": "field3" + }, + { + "category": "API_ERROR", + "code": "CARD_MISMATCH", + "detail": "detail6", + "field": "field4" + }, + { + "category": "AUTHENTICATION_ERROR", + "code": "CARD_DECLINED", + "detail": "detail7", + "field": "field5" + } + ], + "name": "name4", + "applied_money": {}, + "rate": "rate6", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id2" + }, + { + "errors": [ + { + "category": "API_ERROR", + "code": "CARD_MISMATCH", + "detail": "detail6", + "field": "field4" + } + ], + "name": "name5", + "applied_money": {}, + "rate": "rate5", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id3" + } + ], + "additive_tax": [ + {}, + {} + ], + "tender": [ + { + "id": "id1", + "type": "NO_SALE", + "name": "name1", + "employee_id": "employee_id1", + "receipt_url": "receipt_url3", + "card_brand": "JCB", + "pan_suffix": "pan_suffix1", + "entry_method": "SCANNED", + "payment_note": "payment_note9", + "total_money": {}, + "tendered_money": {}, + "tendered_at": "tendered_at5", + "settled_at": "settled_at7", + "change_back_money": {}, + "refunded_money": {}, + "is_exchange": true + } + ], + "refunds": [ + { + "type": "PARTIAL", + "reason": "reason7", + "refunded_money": {}, + "refunded_processing_fee_money": {}, + "refunded_tax_money": {}, + "refunded_additive_tax_money": {}, + "refunded_additive_tax": [ + {}, + {} + ], + "refunded_inclusive_tax_money": {}, + "refunded_inclusive_tax": [ + {}, + {} + ], + "refunded_tip_money": {}, + "refunded_discount_money": {}, + "refunded_surcharge_money": {}, + "refunded_surcharges": [ + { + "name": "name7", + "applied_money": {}, + "rate": "rate3", + "amount_money": {}, + "type": "UNKNOWN", + "taxable": true, + "taxes": [ + {}, + {}, + {} + ], + "surcharge_id": "surcharge_id7" + }, + { + "name": "name8", + "applied_money": {}, + "rate": "rate2", + "amount_money": {}, + "type": "CUSTOM", + "taxable": false, + "taxes": [ + {}, + {} + ], + "surcharge_id": "surcharge_id6" + }, + { + "name": "name9", + "applied_money": {}, + "rate": "rate1", + "amount_money": {}, + "type": "AUTO_GRATUITY", + "taxable": true, + "taxes": [ + {} + ], + "surcharge_id": "surcharge_id5" + } + ], + "created_at": "created_at5", + "processed_at": "processed_at9", + "payment_id": "payment_id7", + "merchant_id": "merchant_id7", + "is_exchange": true + }, + { + "type": "FULL", + "reason": "reason6", + "refunded_money": {}, + "refunded_processing_fee_money": {}, + "refunded_tax_money": {}, + "refunded_additive_tax_money": {}, + "refunded_additive_tax": [ + {}, + {}, + {} + ], + "refunded_inclusive_tax_money": {}, + "refunded_inclusive_tax": [ + {}, + {}, + {} + ], + "refunded_tip_money": {}, + "refunded_discount_money": {}, + "refunded_surcharge_money": {}, + "refunded_surcharges": [ + { + "name": "name6", + "applied_money": {}, + "rate": "rate4", + "amount_money": {}, + "type": "AUTO_GRATUITY", + "taxable": false, + "taxes": [ + {} + ], + "surcharge_id": "surcharge_id8" + }, + { + "name": "name7", + "applied_money": {}, + "rate": "rate3", + "amount_money": {}, + "type": "UNKNOWN", + "taxable": true, + "taxes": [ + {}, + {}, + {} + ], + "surcharge_id": "surcharge_id7" + } + ], + "created_at": "created_at4", + "processed_at": "processed_at8", + "payment_id": "payment_id8", + "merchant_id": "merchant_id8", + "is_exchange": false + }, + { + "type": "PARTIAL", + "reason": "reason5", + "refunded_money": {}, + "refunded_processing_fee_money": {}, + "refunded_tax_money": {}, + "refunded_additive_tax_money": {}, + "refunded_additive_tax": [ + {} + ], + "refunded_inclusive_tax_money": {}, + "refunded_inclusive_tax": [ + {} + ], + "refunded_tip_money": {}, + "refunded_discount_money": {}, + "refunded_surcharge_money": {}, + "refunded_surcharges": [ + { + "name": "name5", + "applied_money": {}, + "rate": "rate5", + "amount_money": {}, + "type": "CUSTOM", + "taxable": true, + "taxes": [ + {}, + {} + ], + "surcharge_id": "surcharge_id9" + } + ], + "created_at": "created_at3", + "processed_at": "processed_at7", + "payment_id": "payment_id9", + "merchant_id": "merchant_id9", + "is_exchange": true + } + ], + "itemizations": [ + { + "name": "name3", + "quantity": 137.09, + "itemization_type": "CUSTOM_AMOUNT", + "item_detail": { + "category_name": "category_name7", + "sku": "sku3", + "item_id": "item_id9", + "item_variation_id": "item_variation_id5" + }, + "notes": "notes3", + "item_variation_name": "item_variation_name1", + "total_money": {}, + "single_quantity_money": {}, + "gross_sales_money": {}, + "discount_money": {}, + "net_sales_money": {}, + "taxes": [ + {}, + {} + ], + "discounts": [ + { + "name": "name4", + "applied_money": {}, + "discount_id": "discount_id2" + }, + { + "name": "name5", + "applied_money": {}, + "discount_id": "discount_id3" + }, + { + "name": "name6", + "applied_money": {}, + "discount_id": "discount_id4" + } + ], + "modifiers": [ + { + "name": "name4", + "applied_money": {}, + "modifier_option_id": "modifier_option_id0" + }, + { + "name": "name5", + "applied_money": {}, + "modifier_option_id": "modifier_option_id1" + } + ] + }, + { + "name": "name4", + "quantity": 137.1, + "itemization_type": "GIFT_CARD_ACTIVATION", + "item_detail": { + "category_name": "category_name6", + "sku": "sku2", + "item_id": "item_id8", + "item_variation_id": "item_variation_id6" + }, + "notes": "notes4", + "item_variation_name": "item_variation_name2", + "total_money": {}, + "single_quantity_money": {}, + "gross_sales_money": {}, + "discount_money": {}, + "net_sales_money": {}, + "taxes": [ + {} + ], + "discounts": [ + { + "name": "name5", + "applied_money": {}, + "discount_id": "discount_id3" + } + ], + "modifiers": [ + { + "name": "name5", + "applied_money": {}, + "modifier_option_id": "modifier_option_id1" + }, + { + "name": "name6", + "applied_money": {}, + "modifier_option_id": "modifier_option_id2" + }, + { + "name": "name7", + "applied_money": {}, + "modifier_option_id": "modifier_option_id3" + } + ] + } + ], + "surcharge_money": {}, + "surcharges": [ + {}, + {}, + {} + ], + "is_partial": true + }, + { + "id": "id8", + "merchant_id": "merchant_id8", + "created_at": "created_at6", + "creator_id": "creator_id8", + "device": { + "id": "id4", + "name": "name4" + }, + "payment_url": "payment_url2", + "receipt_url": "receipt_url0", + "inclusive_tax_money": { + "amount": 44, + "currency_code": "NZD" + }, + "additive_tax_money": { + "amount": 48, + "currency_code": "LSL" + }, + "tax_money": {}, + "tip_money": {}, + "discount_money": {}, + "total_collected_money": {}, + "processing_fee_money": {}, + "net_total_money": {}, + "refunded_money": {}, + "swedish_rounding_money": {}, + "gross_sales_money": {}, + "net_sales_money": {}, + "inclusive_tax": [ + { + "errors": [ + { + "category": "API_ERROR", + "code": "CARD_MISMATCH", + "detail": "detail6", + "field": "field4" + } + ], + "name": "name5", + "applied_money": {}, + "rate": "rate5", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id3" + }, + { + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "CARD_DECLINED", + "detail": "detail7", + "field": "field5" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "VERIFY_CVV_FAILURE", + "detail": "detail8", + "field": "field6" + } + ], + "name": "name6", + "applied_money": {}, + "rate": "rate4", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id4" + }, + { + "errors": [ + { + "category": "INVALID_REQUEST_ERROR", + "code": "VERIFY_CVV_FAILURE", + "detail": "detail8", + "field": "field6" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "VERIFY_AVS_FAILURE", + "detail": "detail9", + "field": "field7" + }, + { + "category": "PAYMENT_METHOD_ERROR", + "code": "CARD_DECLINED_CALL_ISSUER", + "detail": "detail0", + "field": "field8" + } + ], + "name": "name7", + "applied_money": {}, + "rate": "rate3", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id5" + } + ], + "additive_tax": [ + {}, + {}, + {} + ], + "tender": [ + { + "id": "id2", + "type": "SQUARE_WALLET", + "name": "name2", + "employee_id": "employee_id2", + "receipt_url": "receipt_url4", + "card_brand": "CHINA_UNIONPAY", + "pan_suffix": "pan_suffix2", + "entry_method": "SQUARE_CASH", + "payment_note": "payment_note0", + "total_money": {}, + "tendered_money": {}, + "tendered_at": "tendered_at6", + "settled_at": "settled_at8", + "change_back_money": {}, + "refunded_money": {}, + "is_exchange": false + }, + { + "id": "id3", + "type": "SQUARE_GIFT_CARD", + "name": "name3", + "employee_id": "employee_id3", + "receipt_url": "receipt_url5", + "card_brand": "SQUARE_GIFT_CARD", + "pan_suffix": "pan_suffix3", + "entry_method": "SQUARE_WALLET", + "payment_note": "payment_note1", + "total_money": {}, + "tendered_money": {}, + "tendered_at": "tendered_at7", + "settled_at": "settled_at9", + "change_back_money": {}, + "refunded_money": {}, + "is_exchange": true + } + ], + "refunds": [ + { + "type": "FULL", + "reason": "reason8", + "refunded_money": {}, + "refunded_processing_fee_money": {}, + "refunded_tax_money": {}, + "refunded_additive_tax_money": {}, + "refunded_additive_tax": [ + {} + ], + "refunded_inclusive_tax_money": {}, + "refunded_inclusive_tax": [ + {} + ], + "refunded_tip_money": {}, + "refunded_discount_money": {}, + "refunded_surcharge_money": {}, + "refunded_surcharges": [ + { + "name": "name8", + "applied_money": {}, + "rate": "rate2", + "amount_money": {}, + "type": "CUSTOM", + "taxable": false, + "taxes": [ + {}, + {} + ], + "surcharge_id": "surcharge_id6" + } + ], + "created_at": "created_at6", + "processed_at": "processed_at0", + "payment_id": "payment_id6", + "merchant_id": "merchant_id6", + "is_exchange": false + }, + { + "type": "PARTIAL", + "reason": "reason7", + "refunded_money": {}, + "refunded_processing_fee_money": {}, + "refunded_tax_money": {}, + "refunded_additive_tax_money": {}, + "refunded_additive_tax": [ + {}, + {} + ], + "refunded_inclusive_tax_money": {}, + "refunded_inclusive_tax": [ + {}, + {} + ], + "refunded_tip_money": {}, + "refunded_discount_money": {}, + "refunded_surcharge_money": {}, + "refunded_surcharges": [ + { + "name": "name7", + "applied_money": {}, + "rate": "rate3", + "amount_money": {}, + "type": "UNKNOWN", + "taxable": true, + "taxes": [ + {}, + {}, + {} + ], + "surcharge_id": "surcharge_id7" + }, + { + "name": "name8", + "applied_money": {}, + "rate": "rate2", + "amount_money": {}, + "type": "CUSTOM", + "taxable": false, + "taxes": [ + {}, + {} + ], + "surcharge_id": "surcharge_id6" + }, + { + "name": "name9", + "applied_money": {}, + "rate": "rate1", + "amount_money": {}, + "type": "AUTO_GRATUITY", + "taxable": true, + "taxes": [ + {} + ], + "surcharge_id": "surcharge_id5" + } + ], + "created_at": "created_at5", + "processed_at": "processed_at9", + "payment_id": "payment_id7", + "merchant_id": "merchant_id7", + "is_exchange": true + } + ], + "itemizations": [ + { + "name": "name4", + "quantity": 137.1, + "itemization_type": "GIFT_CARD_ACTIVATION", + "item_detail": { + "category_name": "category_name6", + "sku": "sku2", + "item_id": "item_id8", + "item_variation_id": "item_variation_id6" + }, + "notes": "notes4", + "item_variation_name": "item_variation_name2", + "total_money": {}, + "single_quantity_money": {}, + "gross_sales_money": {}, + "discount_money": {}, + "net_sales_money": {}, + "taxes": [ + {} + ], + "discounts": [ + { + "name": "name5", + "applied_money": {}, + "discount_id": "discount_id3" + } + ], + "modifiers": [ + { + "name": "name5", + "applied_money": {}, + "modifier_option_id": "modifier_option_id1" + }, + { + "name": "name6", + "applied_money": {}, + "modifier_option_id": "modifier_option_id2" + }, + { + "name": "name7", + "applied_money": {}, + "modifier_option_id": "modifier_option_id3" + } + ] + }, + { + "name": "name5", + "quantity": 137.11, + "itemization_type": "GIFT_CARD_RELOAD", + "item_detail": { + "category_name": "category_name5", + "sku": "sku1", + "item_id": "item_id7", + "item_variation_id": "item_variation_id7" + }, + "notes": "notes5", + "item_variation_name": "item_variation_name3", + "total_money": {}, + "single_quantity_money": {}, + "gross_sales_money": {}, + "discount_money": {}, + "net_sales_money": {}, + "taxes": [ + {}, + {}, + {} + ], + "discounts": [ + { + "name": "name6", + "applied_money": {}, + "discount_id": "discount_id4" + }, + { + "name": "name7", + "applied_money": {}, + "discount_id": "discount_id5" + } + ], + "modifiers": [ + { + "name": "name6", + "applied_money": {}, + "modifier_option_id": "modifier_option_id2" + } + ] + }, + { + "name": "name6", + "quantity": 137.12, + "itemization_type": "GIFT_CARD_UNKNOWN", + "item_detail": { + "category_name": "category_name4", + "sku": "sku0", + "item_id": "item_id6", + "item_variation_id": "item_variation_id8" + }, + "notes": "notes6", + "item_variation_name": "item_variation_name4", + "total_money": {}, + "single_quantity_money": {}, + "gross_sales_money": {}, + "discount_money": {}, + "net_sales_money": {}, + "taxes": [ + {}, + {} + ], + "discounts": [ + { + "name": "name7", + "applied_money": {}, + "discount_id": "discount_id5" + }, + { + "name": "name8", + "applied_money": {}, + "discount_id": "discount_id6" + }, + { + "name": "name9", + "applied_money": {}, + "discount_id": "discount_id7" + } + ], + "modifiers": [ + { + "name": "name7", + "applied_money": {}, + "modifier_option_id": "modifier_option_id3" + }, + { + "name": "name8", + "applied_money": {}, + "modifier_option_id": "modifier_option_id4" + } + ] + } + ], + "surcharge_money": {}, + "surcharges": [ + {} + ], + "is_partial": false + } + ] } ``` diff --git a/doc/models/v1-list-refunds-request.md b/doc/models/v1-list-refunds-request.md index 4d0daa04..9436ed7c 100644 --- a/doc/models/v1-list-refunds-request.md +++ b/doc/models/v1-list-refunds-request.md @@ -19,11 +19,11 @@ ```json { - "order": null, - "begin_time": null, - "end_time": null, - "limit": null, - "batch_token": null + "order": "DESC", + "begin_time": "begin_time2", + "end_time": "end_time2", + "limit": 172, + "batch_token": "batch_token2" } ``` diff --git a/doc/models/v1-list-refunds-response.md b/doc/models/v1-list-refunds-response.md index 159377af..26ce5b80 100644 --- a/doc/models/v1-list-refunds-response.md +++ b/doc/models/v1-list-refunds-response.md @@ -15,7 +15,184 @@ ```json { - "items": null + "items": [ + { + "type": "PARTIAL", + "reason": "reason7", + "refunded_money": { + "amount": 17, + "currency_code": "XTS" + }, + "refunded_processing_fee_money": { + "amount": 59, + "currency_code": "GYD" + }, + "refunded_tax_money": {}, + "refunded_additive_tax_money": {}, + "refunded_additive_tax": [ + { + "errors": [ + { + "category": "REFUND_ERROR", + "code": "INVALID_TIME", + "detail": "detail8", + "field": "field6" + }, + { + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "INVALID_TIME_RANGE", + "detail": "detail9", + "field": "field7" + }, + { + "category": "API_ERROR", + "code": "INVALID_VALUE", + "detail": "detail0", + "field": "field8" + } + ], + "name": "name7", + "applied_money": {}, + "rate": "rate3", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id5" + } + ], + "refunded_inclusive_tax_money": {}, + "refunded_inclusive_tax": [ + {} + ], + "refunded_tip_money": {}, + "refunded_discount_money": {}, + "refunded_surcharge_money": {}, + "refunded_surcharges": [ + { + "name": "name3", + "applied_money": {}, + "rate": "rate7", + "amount_money": {}, + "type": "CUSTOM", + "taxable": true, + "taxes": [ + {}, + {} + ], + "surcharge_id": "surcharge_id1" + } + ], + "created_at": "created_at5", + "processed_at": "processed_at9", + "payment_id": "payment_id7", + "merchant_id": "merchant_id7", + "is_exchange": true + }, + { + "type": "FULL", + "reason": "reason6", + "refunded_money": { + "amount": 18, + "currency_code": "XXX" + }, + "refunded_processing_fee_money": { + "amount": 60, + "currency_code": "HKD" + }, + "refunded_tax_money": {}, + "refunded_additive_tax_money": {}, + "refunded_additive_tax": [ + { + "errors": [ + { + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "INVALID_TIME_RANGE", + "detail": "detail9", + "field": "field7" + } + ], + "name": "name8", + "applied_money": {}, + "rate": "rate2", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id6" + }, + { + "errors": [ + { + "category": "API_ERROR", + "code": "INVALID_VALUE", + "detail": "detail0", + "field": "field8" + }, + { + "category": "AUTHENTICATION_ERROR", + "code": "INVALID_CURSOR", + "detail": "detail1", + "field": "field9" + } + ], + "name": "name9", + "applied_money": {}, + "rate": "rate1", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id7" + } + ], + "refunded_inclusive_tax_money": {}, + "refunded_inclusive_tax": [ + {}, + {} + ], + "refunded_tip_money": {}, + "refunded_discount_money": {}, + "refunded_surcharge_money": {}, + "refunded_surcharges": [ + { + "name": "name4", + "applied_money": {}, + "rate": "rate6", + "amount_money": {}, + "type": "AUTO_GRATUITY", + "taxable": false, + "taxes": [ + {} + ], + "surcharge_id": "surcharge_id0" + }, + { + "name": "name3", + "applied_money": {}, + "rate": "rate7", + "amount_money": {}, + "type": "CUSTOM", + "taxable": true, + "taxes": [ + {}, + {} + ], + "surcharge_id": "surcharge_id1" + }, + { + "name": "name2", + "applied_money": {}, + "rate": "rate8", + "amount_money": {}, + "type": "UNKNOWN", + "taxable": false, + "taxes": [ + {}, + {}, + {} + ], + "surcharge_id": "surcharge_id2" + } + ], + "created_at": "created_at6", + "processed_at": "processed_at8", + "payment_id": "payment_id8", + "merchant_id": "merchant_id8", + "is_exchange": false + } + ] } ``` diff --git a/doc/models/v1-list-settlements-request.md b/doc/models/v1-list-settlements-request.md index c537b0cd..5ca09a45 100644 --- a/doc/models/v1-list-settlements-request.md +++ b/doc/models/v1-list-settlements-request.md @@ -20,12 +20,12 @@ ```json { - "order": null, - "begin_time": null, - "end_time": null, - "limit": null, - "status": null, - "batch_token": null + "order": "DESC", + "begin_time": "begin_time2", + "end_time": "end_time2", + "limit": 172, + "status": "SENT", + "batch_token": "batch_token2" } ``` diff --git a/doc/models/v1-list-settlements-response.md b/doc/models/v1-list-settlements-response.md index 31709bcf..effc7791 100644 --- a/doc/models/v1-list-settlements-response.md +++ b/doc/models/v1-list-settlements-response.md @@ -15,7 +15,68 @@ ```json { - "items": null + "items": [ + { + "id": "id7", + "status": "SENT", + "total_money": { + "amount": 53, + "currency_code": "PGK" + }, + "initiated_at": "initiated_at9", + "bank_account_id": "bank_account_id7", + "entries": [ + { + "payment_id": "payment_id2", + "type": "SUBSCRIPTION_FEE_REFUND", + "amount_money": { + "amount": 84, + "currency_code": "AOA" + }, + "fee_money": {} + } + ] + }, + { + "id": "id8", + "status": "FAILED", + "total_money": { + "amount": 54, + "currency_code": "PHP" + }, + "initiated_at": "initiated_at0", + "bank_account_id": "bank_account_id8", + "entries": [ + { + "payment_id": "payment_id3", + "type": "SUBSCRIPTION_FEE", + "amount_money": { + "amount": 85, + "currency_code": "ARS" + }, + "fee_money": {} + }, + { + "payment_id": "payment_id2", + "type": "SUBSCRIPTION_FEE_REFUND", + "amount_money": { + "amount": 84, + "currency_code": "AOA" + }, + "fee_money": {} + }, + { + "payment_id": "payment_id1", + "type": "OTHER", + "amount_money": { + "amount": 83, + "currency_code": "ANG" + }, + "fee_money": {} + } + ] + } + ] } ``` diff --git a/doc/models/v1-money.md b/doc/models/v1-money.md index 96d5a5bd..d6736089 100644 --- a/doc/models/v1-money.md +++ b/doc/models/v1-money.md @@ -16,8 +16,8 @@ ```json { - "amount": null, - "currency_code": null + "amount": 46, + "currency_code": "BTN" } ``` diff --git a/doc/models/v1-order-history-entry.md b/doc/models/v1-order-history-entry.md index 054fdfe5..d1364757 100644 --- a/doc/models/v1-order-history-entry.md +++ b/doc/models/v1-order-history-entry.md @@ -18,8 +18,8 @@ V1OrderHistoryEntry ```json { - "action": null, - "created_at": null + "action": "ORDER_PLACED", + "created_at": "created_at2" } ``` diff --git a/doc/models/v1-order.md b/doc/models/v1-order.md index f4279422..501412d7 100644 --- a/doc/models/v1-order.md +++ b/doc/models/v1-order.md @@ -41,31 +41,108 @@ V1Order ```json { - "errors": null, - "id": null, - "buyer_email": null, - "recipient_name": null, - "recipient_phone_number": null, - "state": null, - "shipping_address": null, - "subtotal_money": null, - "total_shipping_money": null, - "total_tax_money": null, - "total_price_money": null, - "total_discount_money": null, - "created_at": null, - "updated_at": null, - "expires_at": null, - "payment_id": null, - "buyer_note": null, - "completed_note": null, - "refunded_note": null, - "canceled_note": null, - "tender": null, - "order_history": null, - "promo_code": null, - "btc_receive_address": null, - "btc_price_satoshi": null + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ], + "id": "id0", + "buyer_email": "buyer_email8", + "recipient_name": "recipient_name8", + "recipient_phone_number": "recipient_phone_number4", + "state": "COMPLETED", + "shipping_address": { + "address_line_1": "address_line_10", + "address_line_2": "address_line_20", + "address_line_3": "address_line_36", + "locality": "locality0", + "sublocality": "sublocality0", + "sublocality_2": "sublocality_28", + "sublocality_3": "sublocality_30", + "administrative_district_level_1": "administrative_district_level_14", + "administrative_district_level_2": "administrative_district_level_26", + "administrative_district_level_3": "administrative_district_level_38", + "postal_code": "postal_code2", + "country": "PT", + "first_name": "first_name0", + "last_name": "last_name8" + }, + "subtotal_money": { + "amount": 116, + "currency_code": "JOD" + }, + "total_shipping_money": { + "amount": 118, + "currency_code": "BOB" + }, + "total_tax_money": { + "amount": 58, + "currency_code": "MVR" + }, + "total_price_money": { + "amount": 52, + "currency_code": "KHR" + }, + "total_discount_money": { + "amount": 132, + "currency_code": "PKR" + }, + "created_at": "created_at2", + "updated_at": "updated_at4", + "expires_at": "expires_at6", + "payment_id": "payment_id0", + "buyer_note": "buyer_note2", + "completed_note": "completed_note0", + "refunded_note": "refunded_note4", + "canceled_note": "canceled_note0", + "tender": { + "id": "id6", + "type": "THIRD_PARTY_CARD", + "name": "name6", + "employee_id": "employee_id6", + "receipt_url": "receipt_url2", + "card_brand": "OTHER_BRAND", + "pan_suffix": "pan_suffix6", + "entry_method": "SWIPED", + "payment_note": "payment_note4", + "total_money": { + "amount": 14, + "currency_code": "SRD" + }, + "tendered_money": { + "amount": 122, + "currency_code": "XAG" + }, + "tendered_at": "tendered_at0", + "settled_at": "settled_at8", + "change_back_money": {}, + "refunded_money": {}, + "is_exchange": false + }, + "order_history": [ + { + "action": "PAYMENT_RECEIVED", + "created_at": "created_at5" + } + ], + "promo_code": "promo_code2", + "btc_receive_address": "btc_receive_address2", + "btc_price_satoshi": 144.84 } ``` diff --git a/doc/models/v1-payment-discount.md b/doc/models/v1-payment-discount.md index 60f14a3a..d1f5f133 100644 --- a/doc/models/v1-payment-discount.md +++ b/doc/models/v1-payment-discount.md @@ -19,9 +19,12 @@ V1PaymentDiscount ```json { - "name": null, - "applied_money": null, - "discount_id": null + "name": "name0", + "applied_money": { + "amount": 196, + "currency_code": "LYD" + }, + "discount_id": "discount_id8" } ``` diff --git a/doc/models/v1-payment-item-detail.md b/doc/models/v1-payment-item-detail.md index 3287db37..46c513df 100644 --- a/doc/models/v1-payment-item-detail.md +++ b/doc/models/v1-payment-item-detail.md @@ -20,10 +20,10 @@ V1PaymentItemDetail ```json { - "category_name": null, - "sku": null, - "item_id": null, - "item_variation_id": null + "category_name": "category_name8", + "sku": "sku4", + "item_id": "item_id0", + "item_variation_id": "item_variation_id4" } ``` diff --git a/doc/models/v1-payment-itemization.md b/doc/models/v1-payment-itemization.md index f69bf14a..2888b7b2 100644 --- a/doc/models/v1-payment-itemization.md +++ b/doc/models/v1-payment-itemization.md @@ -45,20 +45,137 @@ price of items might have changed since the payment was processed. ```json { - "name": null, - "quantity": null, - "itemization_type": null, - "item_detail": null, - "notes": null, - "item_variation_name": null, - "total_money": null, - "single_quantity_money": null, - "gross_sales_money": null, - "discount_money": null, - "net_sales_money": null, - "taxes": null, - "discounts": null, - "modifiers": null + "name": "name0", + "quantity": 149.16, + "itemization_type": "GIFT_CARD_UNKNOWN", + "item_detail": { + "category_name": "category_name0", + "sku": "sku6", + "item_id": "item_id2", + "item_variation_id": "item_variation_id2" + }, + "notes": "notes0", + "item_variation_name": "item_variation_name2", + "total_money": { + "amount": 250, + "currency_code": "USS" + }, + "single_quantity_money": { + "amount": 184, + "currency_code": "TZS" + }, + "gross_sales_money": { + "amount": 198, + "currency_code": "HKD" + }, + "discount_money": { + "amount": 92, + "currency_code": "DJF" + }, + "net_sales_money": { + "amount": 110, + "currency_code": "UZS" + }, + "taxes": [ + { + "errors": [ + { + "category": "RATE_LIMIT_ERROR", + "code": "MAP_KEY_LENGTH_TOO_SHORT", + "detail": "detail6", + "field": "field4" + }, + { + "category": "PAYMENT_METHOD_ERROR", + "code": "MAP_KEY_LENGTH_TOO_LONG", + "detail": "detail7", + "field": "field5" + } + ], + "name": "name5", + "applied_money": { + "amount": 109, + "currency_code": "USN" + }, + "rate": "rate5", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id3" + }, + { + "errors": [ + { + "category": "PAYMENT_METHOD_ERROR", + "code": "MAP_KEY_LENGTH_TOO_LONG", + "detail": "detail7", + "field": "field5" + }, + { + "category": "REFUND_ERROR", + "code": "CUSTOMER_MISSING_NAME", + "detail": "detail8", + "field": "field6" + }, + { + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "CUSTOMER_MISSING_EMAIL", + "detail": "detail9", + "field": "field7" + } + ], + "name": "name6", + "applied_money": { + "amount": 108, + "currency_code": "USD" + }, + "rate": "rate4", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id4" + } + ], + "discounts": [ + { + "name": "name1", + "applied_money": { + "amount": 97, + "currency_code": "STD" + }, + "discount_id": "discount_id9" + }, + { + "name": "name2", + "applied_money": { + "amount": 96, + "currency_code": "SSP" + }, + "discount_id": "discount_id0" + }, + { + "name": "name3", + "applied_money": { + "amount": 95, + "currency_code": "SRD" + }, + "discount_id": "discount_id1" + } + ], + "modifiers": [ + { + "name": "name1", + "applied_money": { + "amount": 135, + "currency_code": "MZN" + }, + "modifier_option_id": "modifier_option_id7" + }, + { + "name": "name2", + "applied_money": { + "amount": 134, + "currency_code": "MYR" + }, + "modifier_option_id": "modifier_option_id8" + } + ] } ``` diff --git a/doc/models/v1-payment-modifier.md b/doc/models/v1-payment-modifier.md index 23281a1d..654cb33b 100644 --- a/doc/models/v1-payment-modifier.md +++ b/doc/models/v1-payment-modifier.md @@ -19,9 +19,12 @@ V1PaymentModifier ```json { - "name": null, - "applied_money": null, - "modifier_option_id": null + "name": "name0", + "applied_money": { + "amount": 196, + "currency_code": "LYD" + }, + "modifier_option_id": "modifier_option_id6" } ``` diff --git a/doc/models/v1-payment-surcharge.md b/doc/models/v1-payment-surcharge.md index af33b29a..b0f6bec1 100644 --- a/doc/models/v1-payment-surcharge.md +++ b/doc/models/v1-payment-surcharge.md @@ -24,14 +24,75 @@ V1PaymentSurcharge ```json { - "name": null, - "applied_money": null, - "rate": null, - "amount_money": null, - "type": null, - "taxable": null, - "taxes": null, - "surcharge_id": null + "name": "name0", + "applied_money": { + "amount": 196, + "currency_code": "LYD" + }, + "rate": "rate0", + "amount_money": { + "amount": 186, + "currency_code": "KRW" + }, + "type": "CUSTOM", + "taxable": false, + "taxes": [ + { + "errors": [ + { + "category": "RATE_LIMIT_ERROR", + "code": "MAP_KEY_LENGTH_TOO_SHORT", + "detail": "detail6", + "field": "field4" + }, + { + "category": "PAYMENT_METHOD_ERROR", + "code": "MAP_KEY_LENGTH_TOO_LONG", + "detail": "detail7", + "field": "field5" + } + ], + "name": "name5", + "applied_money": { + "amount": 109, + "currency_code": "USN" + }, + "rate": "rate5", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id3" + }, + { + "errors": [ + { + "category": "PAYMENT_METHOD_ERROR", + "code": "MAP_KEY_LENGTH_TOO_LONG", + "detail": "detail7", + "field": "field5" + }, + { + "category": "REFUND_ERROR", + "code": "CUSTOMER_MISSING_NAME", + "detail": "detail8", + "field": "field6" + }, + { + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "CUSTOMER_MISSING_EMAIL", + "detail": "detail9", + "field": "field7" + } + ], + "name": "name6", + "applied_money": { + "amount": 108, + "currency_code": "USD" + }, + "rate": "rate4", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id4" + } + ], + "surcharge_id": "surcharge_id4" } ``` diff --git a/doc/models/v1-payment-tax.md b/doc/models/v1-payment-tax.md index 89504b66..ccfec326 100644 --- a/doc/models/v1-payment-tax.md +++ b/doc/models/v1-payment-tax.md @@ -22,12 +22,34 @@ V1PaymentTax ```json { - "errors": null, - "name": null, - "applied_money": null, - "rate": null, - "inclusion_type": null, - "fee_id": null + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "REFUND_ALREADY_PENDING", + "detail": "detail1", + "field": "field9" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "PAYMENT_NOT_REFUNDABLE", + "detail": "detail2", + "field": "field0" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "REFUND_DECLINED", + "detail": "detail3", + "field": "field1" + } + ], + "name": "name0", + "applied_money": { + "amount": 196, + "currency_code": "LYD" + }, + "rate": "rate0", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id8" } ``` diff --git a/doc/models/v1-payment.md b/doc/models/v1-payment.md index fa842221..1d3948eb 100644 --- a/doc/models/v1-payment.md +++ b/doc/models/v1-payment.md @@ -62,33 +62,843 @@ Monetary values are negative if they represent an ```json { - "id": null, - "merchant_id": null, - "created_at": null, - "creator_id": null, - "device": null, - "payment_url": null, - "receipt_url": null, - "inclusive_tax_money": null, - "additive_tax_money": null, - "tax_money": null, - "tip_money": null, - "discount_money": null, - "total_collected_money": null, - "processing_fee_money": null, - "net_total_money": null, - "refunded_money": null, - "swedish_rounding_money": null, - "gross_sales_money": null, - "net_sales_money": null, - "inclusive_tax": null, - "additive_tax": null, - "tender": null, - "refunds": null, - "itemizations": null, - "surcharge_money": null, - "surcharges": null, - "is_partial": null + "id": "id0", + "merchant_id": "merchant_id0", + "created_at": "created_at2", + "creator_id": "creator_id0", + "device": { + "id": "id6", + "name": "name6" + }, + "payment_url": "payment_url6", + "receipt_url": "receipt_url8", + "inclusive_tax_money": { + "amount": 240, + "currency_code": "TZS" + }, + "additive_tax_money": { + "amount": 16, + "currency_code": "AMD" + }, + "tax_money": { + "amount": 58, + "currency_code": "GHS" + }, + "tip_money": { + "amount": 190, + "currency_code": "AED" + }, + "discount_money": { + "amount": 92, + "currency_code": "DJF" + }, + "total_collected_money": { + "amount": 236, + "currency_code": "CVE" + }, + "processing_fee_money": { + "amount": 112, + "currency_code": "SVC" + }, + "net_total_money": { + "amount": 208, + "currency_code": "INR" + }, + "refunded_money": { + "amount": 214, + "currency_code": "CHW" + }, + "swedish_rounding_money": { + "amount": 114, + "currency_code": "CUC" + }, + "gross_sales_money": { + "amount": 198, + "currency_code": "HKD" + }, + "net_sales_money": { + "amount": 110, + "currency_code": "UZS" + }, + "inclusive_tax": [ + { + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "FORBIDDEN", + "detail": "detail8", + "field": "field6" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "INSUFFICIENT_SCOPES", + "detail": "detail9", + "field": "field7" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "APPLICATION_DISABLED", + "detail": "detail0", + "field": "field8" + } + ], + "name": "name7", + "applied_money": { + "amount": 39, + "currency_code": "XBB" + }, + "rate": "rate3", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id5" + }, + { + "errors": [ + { + "category": "INVALID_REQUEST_ERROR", + "code": "INSUFFICIENT_SCOPES", + "detail": "detail9", + "field": "field7" + } + ], + "name": "name8", + "applied_money": { + "amount": 38, + "currency_code": "XBA" + }, + "rate": "rate2", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id6" + } + ], + "additive_tax": [ + { + "errors": [ + { + "category": "PAYMENT_METHOD_ERROR", + "code": "INVALID_PHONE_NUMBER", + "detail": "detail4", + "field": "field2" + }, + { + "category": "REFUND_ERROR", + "code": "CHECKOUT_EXPIRED", + "detail": "detail5", + "field": "field3" + }, + { + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "BAD_CERTIFICATE", + "detail": "detail6", + "field": "field4" + } + ], + "name": "name3", + "applied_money": { + "amount": 179, + "currency_code": "COU" + }, + "rate": "rate3", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id1" + }, + { + "errors": [ + { + "category": "REFUND_ERROR", + "code": "CHECKOUT_EXPIRED", + "detail": "detail5", + "field": "field3" + } + ], + "name": "name4", + "applied_money": { + "amount": 180, + "currency_code": "CRC" + }, + "rate": "rate4", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id2" + } + ], + "tender": [ + { + "id": "id4", + "type": "CREDIT_CARD", + "name": "name4", + "employee_id": "employee_id4", + "receipt_url": "receipt_url6", + "card_brand": "OTHER_BRAND", + "pan_suffix": "pan_suffix4", + "entry_method": "SQUARE_WALLET", + "payment_note": "payment_note2", + "total_money": { + "amount": 24, + "currency_code": "CNY" + }, + "tendered_money": { + "amount": 132, + "currency_code": "HRK" + }, + "tendered_at": "tendered_at8", + "settled_at": "settled_at0", + "change_back_money": {}, + "refunded_money": {}, + "is_exchange": false + } + ], + "refunds": [ + { + "type": "FULL", + "reason": "reason0", + "refunded_money": { + "amount": 214, + "currency_code": "MVR" + }, + "refunded_processing_fee_money": { + "amount": 92, + "currency_code": "HNL" + }, + "refunded_tax_money": {}, + "refunded_additive_tax_money": {}, + "refunded_additive_tax": [ + { + "errors": [ + { + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "EXPECTED_ARRAY", + "detail": "detail5", + "field": "field3" + } + ], + "name": "name4", + "applied_money": {}, + "rate": "rate6", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id2" + }, + { + "errors": [ + { + "category": "API_ERROR", + "code": "EXPECTED_MAP", + "detail": "detail6", + "field": "field4" + }, + { + "category": "AUTHENTICATION_ERROR", + "code": "EXPECTED_BASE64_ENCODED_BYTE_ARRAY", + "detail": "detail7", + "field": "field5" + } + ], + "name": "name5", + "applied_money": {}, + "rate": "rate5", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id3" + } + ], + "refunded_inclusive_tax_money": {}, + "refunded_inclusive_tax": [ + {}, + {} + ], + "refunded_tip_money": {}, + "refunded_discount_money": {}, + "refunded_surcharge_money": {}, + "refunded_surcharges": [ + { + "name": "name0", + "applied_money": {}, + "rate": "rate0", + "amount_money": {}, + "type": "AUTO_GRATUITY", + "taxable": false, + "taxes": [ + {} + ], + "surcharge_id": "surcharge_id4" + }, + { + "name": "name9", + "applied_money": {}, + "rate": "rate1", + "amount_money": {}, + "type": "CUSTOM", + "taxable": true, + "taxes": [ + {}, + {} + ], + "surcharge_id": "surcharge_id5" + }, + { + "name": "name8", + "applied_money": {}, + "rate": "rate2", + "amount_money": {}, + "type": "UNKNOWN", + "taxable": false, + "taxes": [ + {}, + {}, + {} + ], + "surcharge_id": "surcharge_id6" + } + ], + "created_at": "created_at2", + "processed_at": "processed_at2", + "payment_id": "payment_id4", + "merchant_id": "merchant_id4", + "is_exchange": false + }, + { + "type": "PARTIAL", + "reason": "reason9", + "refunded_money": { + "amount": 215, + "currency_code": "MWK" + }, + "refunded_processing_fee_money": { + "amount": 91, + "currency_code": "HKD" + }, + "refunded_tax_money": {}, + "refunded_additive_tax_money": {}, + "refunded_additive_tax": [ + { + "errors": [ + { + "category": "API_ERROR", + "code": "EXPECTED_MAP", + "detail": "detail6", + "field": "field4" + }, + { + "category": "AUTHENTICATION_ERROR", + "code": "EXPECTED_BASE64_ENCODED_BYTE_ARRAY", + "detail": "detail7", + "field": "field5" + } + ], + "name": "name5", + "applied_money": {}, + "rate": "rate5", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id3" + }, + { + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "EXPECTED_BASE64_ENCODED_BYTE_ARRAY", + "detail": "detail7", + "field": "field5" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "INVALID_ARRAY_VALUE", + "detail": "detail8", + "field": "field6" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "INVALID_ENUM_VALUE", + "detail": "detail9", + "field": "field7" + } + ], + "name": "name6", + "applied_money": {}, + "rate": "rate4", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id4" + }, + { + "errors": [ + { + "category": "INVALID_REQUEST_ERROR", + "code": "INVALID_ARRAY_VALUE", + "detail": "detail8", + "field": "field6" + } + ], + "name": "name7", + "applied_money": {}, + "rate": "rate3", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id5" + } + ], + "refunded_inclusive_tax_money": {}, + "refunded_inclusive_tax": [ + {}, + {}, + {} + ], + "refunded_tip_money": {}, + "refunded_discount_money": {}, + "refunded_surcharge_money": {}, + "refunded_surcharges": [ + { + "name": "name1", + "applied_money": {}, + "rate": "rate9", + "amount_money": {}, + "type": "UNKNOWN", + "taxable": true, + "taxes": [ + {}, + {}, + {} + ], + "surcharge_id": "surcharge_id3" + }, + { + "name": "name0", + "applied_money": {}, + "rate": "rate0", + "amount_money": {}, + "type": "AUTO_GRATUITY", + "taxable": false, + "taxes": [ + {} + ], + "surcharge_id": "surcharge_id4" + } + ], + "created_at": "created_at3", + "processed_at": "processed_at1", + "payment_id": "payment_id5", + "merchant_id": "merchant_id5", + "is_exchange": true + }, + { + "type": "FULL", + "reason": "reason8", + "refunded_money": { + "amount": 216, + "currency_code": "MXN" + }, + "refunded_processing_fee_money": { + "amount": 90, + "currency_code": "GYD" + }, + "refunded_tax_money": {}, + "refunded_additive_tax_money": {}, + "refunded_additive_tax": [ + { + "errors": [ + { + "category": "AUTHENTICATION_ERROR", + "code": "EXPECTED_BASE64_ENCODED_BYTE_ARRAY", + "detail": "detail7", + "field": "field5" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "INVALID_ARRAY_VALUE", + "detail": "detail8", + "field": "field6" + }, + { + "category": "RATE_LIMIT_ERROR", + "code": "INVALID_ENUM_VALUE", + "detail": "detail9", + "field": "field7" + } + ], + "name": "name6", + "applied_money": {}, + "rate": "rate4", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id4" + } + ], + "refunded_inclusive_tax_money": {}, + "refunded_inclusive_tax": [ + {} + ], + "refunded_tip_money": {}, + "refunded_discount_money": {}, + "refunded_surcharge_money": {}, + "refunded_surcharges": [ + { + "name": "name2", + "applied_money": {}, + "rate": "rate8", + "amount_money": {}, + "type": "CUSTOM", + "taxable": false, + "taxes": [ + {}, + {} + ], + "surcharge_id": "surcharge_id2" + } + ], + "created_at": "created_at4", + "processed_at": "processed_at0", + "payment_id": "payment_id6", + "merchant_id": "merchant_id6", + "is_exchange": false + } + ], + "itemizations": [ + { + "name": "name6", + "quantity": 167.22, + "itemization_type": "GIFT_CARD_UNKNOWN", + "item_detail": { + "category_name": "category_name4", + "sku": "sku0", + "item_id": "item_id6", + "item_variation_id": "item_variation_id8" + }, + "notes": "notes6", + "item_variation_name": "item_variation_name6", + "total_money": { + "amount": 8, + "currency_code": "UAH" + }, + "single_quantity_money": { + "amount": 170, + "currency_code": "USN" + }, + "gross_sales_money": {}, + "discount_money": {}, + "net_sales_money": {}, + "taxes": [ + { + "errors": [ + { + "category": "RATE_LIMIT_ERROR", + "code": "RESERVATION_DECLINED", + "detail": "detail0", + "field": "field8" + }, + { + "category": "PAYMENT_METHOD_ERROR", + "code": "UNKNOWN_BODY_PARAMETER", + "detail": "detail1", + "field": "field9" + } + ], + "name": "name9", + "applied_money": {}, + "rate": "rate1", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id7" + }, + { + "errors": [ + { + "category": "PAYMENT_METHOD_ERROR", + "code": "UNKNOWN_BODY_PARAMETER", + "detail": "detail1", + "field": "field9" + }, + { + "category": "REFUND_ERROR", + "code": "NOT_FOUND", + "detail": "detail2", + "field": "field0" + }, + { + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND", + "detail": "detail3", + "field": "field1" + } + ], + "name": "name0", + "applied_money": {}, + "rate": "rate0", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id8" + } + ], + "discounts": [ + { + "name": "name7", + "applied_money": {}, + "discount_id": "discount_id5" + }, + { + "name": "name8", + "applied_money": {}, + "discount_id": "discount_id6" + }, + { + "name": "name9", + "applied_money": {}, + "discount_id": "discount_id7" + } + ], + "modifiers": [ + { + "name": "name7", + "applied_money": {}, + "modifier_option_id": "modifier_option_id3" + }, + { + "name": "name8", + "applied_money": {}, + "modifier_option_id": "modifier_option_id4" + } + ] + }, + { + "name": "name7", + "quantity": 167.23, + "itemization_type": "OTHER", + "item_detail": { + "category_name": "category_name3", + "sku": "sku9", + "item_id": "item_id5", + "item_variation_id": "item_variation_id9" + }, + "notes": "notes7", + "item_variation_name": "item_variation_name5", + "total_money": { + "amount": 9, + "currency_code": "UGX" + }, + "single_quantity_money": { + "amount": 169, + "currency_code": "USD" + }, + "gross_sales_money": {}, + "discount_money": {}, + "net_sales_money": {}, + "taxes": [ + { + "errors": [ + { + "category": "INVALID_REQUEST_ERROR", + "code": "ALLOWABLE_PIN_TRIES_EXCEEDED", + "detail": "detail9", + "field": "field7" + } + ], + "name": "name8", + "applied_money": {}, + "rate": "rate2", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id6" + } + ], + "discounts": [ + { + "name": "name8", + "applied_money": {}, + "discount_id": "discount_id6" + } + ], + "modifiers": [ + { + "name": "name8", + "applied_money": {}, + "modifier_option_id": "modifier_option_id4" + }, + { + "name": "name9", + "applied_money": {}, + "modifier_option_id": "modifier_option_id5" + }, + { + "name": "name0", + "applied_money": {}, + "modifier_option_id": "modifier_option_id6" + } + ] + } + ], + "surcharge_money": { + "amount": 74, + "currency_code": "NOK" + }, + "surcharges": [ + { + "name": "name1", + "applied_money": { + "amount": 251, + "currency_code": "KYD" + }, + "rate": "rate9", + "amount_money": { + "amount": 131, + "currency_code": "LTL" + }, + "type": "CUSTOM", + "taxable": true, + "taxes": [ + { + "errors": [ + { + "category": "REFUND_ERROR", + "code": "SANDBOX_NOT_SUPPORTED", + "detail": "detail7", + "field": "field5" + } + ], + "name": "name6", + "applied_money": {}, + "rate": "rate4", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id4" + }, + { + "errors": [ + { + "category": "PAYMENT_METHOD_ERROR", + "code": "UNEXPECTED_VALUE", + "detail": "detail6", + "field": "field4" + }, + { + "category": "REFUND_ERROR", + "code": "SANDBOX_NOT_SUPPORTED", + "detail": "detail7", + "field": "field5" + }, + { + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "INVALID_EMAIL_ADDRESS", + "detail": "detail8", + "field": "field6" + } + ], + "name": "name5", + "applied_money": {}, + "rate": "rate5", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id3" + } + ], + "surcharge_id": "surcharge_id3" + }, + { + "name": "name2", + "applied_money": { + "amount": 250, + "currency_code": "KWD" + }, + "rate": "rate8", + "amount_money": { + "amount": 132, + "currency_code": "LVL" + }, + "type": "AUTO_GRATUITY", + "taxable": false, + "taxes": [ + { + "errors": [ + { + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "INVALID_EMAIL_ADDRESS", + "detail": "detail8", + "field": "field6" + }, + { + "category": "API_ERROR", + "code": "INVALID_PHONE_NUMBER", + "detail": "detail9", + "field": "field7" + } + ], + "name": "name7", + "applied_money": {}, + "rate": "rate3", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id5" + } + ], + "surcharge_id": "surcharge_id2" + }, + { + "name": "name3", + "applied_money": { + "amount": 249, + "currency_code": "KRW" + }, + "rate": "rate7", + "amount_money": { + "amount": 133, + "currency_code": "LYD" + }, + "type": "UNKNOWN", + "taxable": true, + "taxes": [ + { + "errors": [ + { + "category": "API_ERROR", + "code": "INVALID_PHONE_NUMBER", + "detail": "detail9", + "field": "field7" + }, + { + "category": "AUTHENTICATION_ERROR", + "code": "CHECKOUT_EXPIRED", + "detail": "detail0", + "field": "field8" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "BAD_CERTIFICATE", + "detail": "detail1", + "field": "field9" + } + ], + "name": "name8", + "applied_money": {}, + "rate": "rate2", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id6" + }, + { + "errors": [ + { + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "INVALID_EMAIL_ADDRESS", + "detail": "detail8", + "field": "field6" + }, + { + "category": "API_ERROR", + "code": "INVALID_PHONE_NUMBER", + "detail": "detail9", + "field": "field7" + } + ], + "name": "name7", + "applied_money": {}, + "rate": "rate3", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id5" + }, + { + "errors": [ + { + "category": "REFUND_ERROR", + "code": "SANDBOX_NOT_SUPPORTED", + "detail": "detail7", + "field": "field5" + } + ], + "name": "name6", + "applied_money": {}, + "rate": "rate4", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id4" + } + ], + "surcharge_id": "surcharge_id1" + } + ], + "is_partial": false } ``` diff --git a/doc/models/v1-refund.md b/doc/models/v1-refund.md index 917dcfbb..a05f9132 100644 --- a/doc/models/v1-refund.md +++ b/doc/models/v1-refund.md @@ -34,24 +34,170 @@ V1Refund ```json { - "type": null, - "reason": null, - "refunded_money": null, - "refunded_processing_fee_money": null, - "refunded_tax_money": null, - "refunded_additive_tax_money": null, - "refunded_additive_tax": null, - "refunded_inclusive_tax_money": null, - "refunded_inclusive_tax": null, - "refunded_tip_money": null, - "refunded_discount_money": null, - "refunded_surcharge_money": null, - "refunded_surcharges": null, - "created_at": null, - "processed_at": null, - "payment_id": null, - "merchant_id": null, - "is_exchange": null + "type": "FULL", + "reason": "reason4", + "refunded_money": { + "amount": 214, + "currency_code": "CHW" + }, + "refunded_processing_fee_money": { + "amount": 0, + "currency_code": "LBP" + }, + "refunded_tax_money": { + "amount": 148, + "currency_code": "BAM" + }, + "refunded_additive_tax_money": { + "amount": 234, + "currency_code": "BZD" + }, + "refunded_additive_tax": [ + { + "errors": [ + { + "category": "API_ERROR", + "code": "MAP_KEY_LENGTH_TOO_SHORT", + "detail": "detail1", + "field": "field9" + }, + { + "category": "AUTHENTICATION_ERROR", + "code": "MAP_KEY_LENGTH_TOO_LONG", + "detail": "detail2", + "field": "field0" + }, + { + "category": "INVALID_REQUEST_ERROR", + "code": "CUSTOMER_MISSING_NAME", + "detail": "detail3", + "field": "field1" + } + ], + "name": "name0", + "applied_money": { + "amount": 170, + "currency_code": "OMR" + }, + "rate": "rate0", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id8" + } + ], + "refunded_inclusive_tax_money": { + "amount": 212, + "currency_code": "JPY" + }, + "refunded_inclusive_tax": [ + { + "errors": [ + { + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "INVALID_TIME", + "detail": "detail3", + "field": "field1" + }, + { + "category": "API_ERROR", + "code": "INVALID_TIME_RANGE", + "detail": "detail4", + "field": "field2" + }, + { + "category": "AUTHENTICATION_ERROR", + "code": "INVALID_VALUE", + "detail": "detail5", + "field": "field3" + } + ], + "name": "name2", + "applied_money": { + "amount": 188, + "currency_code": "MYR" + }, + "rate": "rate8", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id0" + } + ], + "refunded_tip_money": { + "amount": 198, + "currency_code": "XCD" + }, + "refunded_discount_money": { + "amount": 120, + "currency_code": "XBC" + }, + "refunded_surcharge_money": { + "amount": 194, + "currency_code": "THB" + }, + "refunded_surcharges": [ + { + "name": "name4", + "applied_money": { + "amount": 200, + "currency_code": "EUR" + }, + "rate": "rate6", + "amount_money": { + "amount": 182, + "currency_code": "QAR" + }, + "type": "CUSTOM", + "taxable": false, + "taxes": [ + { + "errors": [ + { + "category": "API_ERROR", + "code": "RESERVATION_DECLINED", + "detail": "detail0", + "field": "field8" + } + ], + "name": "name9", + "applied_money": {}, + "rate": "rate1", + "inclusion_type": "INCLUSIVE", + "fee_id": "fee_id7" + }, + { + "errors": [ + { + "category": "MERCHANT_SUBSCRIPTION_ERROR", + "code": "ALLOWABLE_PIN_TRIES_EXCEEDED", + "detail": "detail9", + "field": "field7" + }, + { + "category": "API_ERROR", + "code": "RESERVATION_DECLINED", + "detail": "detail0", + "field": "field8" + }, + { + "category": "AUTHENTICATION_ERROR", + "code": "UNKNOWN_BODY_PARAMETER", + "detail": "detail1", + "field": "field9" + } + ], + "name": "name8", + "applied_money": {}, + "rate": "rate2", + "inclusion_type": "ADDITIVE", + "fee_id": "fee_id6" + } + ], + "surcharge_id": "surcharge_id0" + } + ], + "created_at": "created_at2", + "processed_at": "processed_at6", + "payment_id": "payment_id0", + "merchant_id": "merchant_id0", + "is_exchange": false } ``` diff --git a/doc/models/v1-settlement-entry.md b/doc/models/v1-settlement-entry.md index 0c01d465..7d621835 100644 --- a/doc/models/v1-settlement-entry.md +++ b/doc/models/v1-settlement-entry.md @@ -20,10 +20,16 @@ V1SettlementEntry ```json { - "payment_id": null, - "type": null, - "amount_money": null, - "fee_money": null + "payment_id": "payment_id0", + "type": "PAID_SERVICE_FEE", + "amount_money": { + "amount": 186, + "currency_code": "KRW" + }, + "fee_money": { + "amount": 108, + "currency_code": "UZS" + } } ``` diff --git a/doc/models/v1-settlement.md b/doc/models/v1-settlement.md index 32f8f79f..749971a4 100644 --- a/doc/models/v1-settlement.md +++ b/doc/models/v1-settlement.md @@ -22,12 +22,28 @@ V1Settlement ```json { - "id": null, - "status": null, - "total_money": null, - "initiated_at": null, - "bank_account_id": null, - "entries": null + "id": "id0", + "status": "FAILED", + "total_money": { + "amount": 250, + "currency_code": "USS" + }, + "initiated_at": "initiated_at2", + "bank_account_id": "bank_account_id0", + "entries": [ + { + "payment_id": "payment_id5", + "type": "PAID_SERVICE_FEE", + "amount_money": { + "amount": 91, + "currency_code": "PEN" + }, + "fee_money": { + "amount": 203, + "currency_code": "RON" + } + } + ] } ``` diff --git a/doc/models/v1-tender.md b/doc/models/v1-tender.md index bb410774..a0a3e9cf 100644 --- a/doc/models/v1-tender.md +++ b/doc/models/v1-tender.md @@ -53,22 +53,34 @@ associated payment. ```json { - "id": null, - "type": null, - "name": null, - "employee_id": null, - "receipt_url": null, - "card_brand": null, - "pan_suffix": null, - "entry_method": null, - "payment_note": null, - "total_money": null, - "tendered_money": null, - "tendered_at": null, - "settled_at": null, - "change_back_money": null, - "refunded_money": null, - "is_exchange": null + "id": "id0", + "type": "UNKNOWN", + "name": "name0", + "employee_id": "employee_id0", + "receipt_url": "receipt_url8", + "card_brand": "OTHER_BRAND", + "pan_suffix": "pan_suffix0", + "entry_method": "OTHER", + "payment_note": "payment_note8", + "total_money": { + "amount": 250, + "currency_code": "USS" + }, + "tendered_money": { + "amount": 102, + "currency_code": "UNKNOWN_CURRENCY" + }, + "tendered_at": "tendered_at6", + "settled_at": "settled_at4", + "change_back_money": { + "amount": 78, + "currency_code": "JMD" + }, + "refunded_money": { + "amount": 214, + "currency_code": "CHW" + }, + "is_exchange": false } ``` diff --git a/doc/models/v1-update-order-request.md b/doc/models/v1-update-order-request.md index 72691174..3edce8a6 100644 --- a/doc/models/v1-update-order-request.md +++ b/doc/models/v1-update-order-request.md @@ -22,10 +22,10 @@ V1UpdateOrderRequest ```json { "action": "COMPLETE", - "shipped_tracking_number": null, - "completed_note": null, - "refunded_note": null, - "canceled_note": null + "shipped_tracking_number": "shipped_tracking_number0", + "completed_note": "completed_note0", + "refunded_note": "refunded_note4", + "canceled_note": "canceled_note0" } ``` diff --git a/doc/models/vendor-contact.md b/doc/models/vendor-contact.md index 5536a044..b96c0bca 100644 --- a/doc/models/vendor-contact.md +++ b/doc/models/vendor-contact.md @@ -11,22 +11,22 @@ Represents a contact of a [Vendor](../../doc/models/vendor.md). | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `string \| undefined` | Optional | A unique Square-generated ID for the [VendorContact](../../doc/models/vendor-contact.md).
This field is required when attempting to update a [VendorContact](../../doc/models/vendor-contact.md).
**Constraints**: *Maximum Length*: `100` | -| `name` | `string \| undefined` | Optional | The name of the [VendorContact](../../doc/models/vendor-contact.md).
This field is required when attempting to create a [Vendor](../../doc/models/vendor.md).
**Constraints**: *Maximum Length*: `255` | -| `emailAddress` | `string \| undefined` | Optional | The email address of the [VendorContact](../../doc/models/vendor-contact.md).
**Constraints**: *Maximum Length*: `255` | -| `phoneNumber` | `string \| undefined` | Optional | The phone number of the [VendorContact](../../doc/models/vendor-contact.md).
**Constraints**: *Maximum Length*: `255` | -| `removed` | `boolean \| undefined` | Optional | The state of the [VendorContact](../../doc/models/vendor-contact.md). | -| `ordinal` | `number` | Required | The ordinal of the [VendorContact](../../doc/models/vendor-contact.md). | +| `id` | `string \| undefined` | 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` | +| `name` | `string \| undefined` | Optional | The name of the [VendorContact](entity:VendorContact).
This field is required when attempting to create a [Vendor](entity:Vendor).
**Constraints**: *Maximum Length*: `255` | +| `emailAddress` | `string \| undefined` | Optional | The email address of the [VendorContact](entity:VendorContact).
**Constraints**: *Maximum Length*: `255` | +| `phoneNumber` | `string \| undefined` | Optional | The phone number of the [VendorContact](entity:VendorContact).
**Constraints**: *Maximum Length*: `255` | +| `removed` | `boolean \| undefined` | Optional | The state of the [VendorContact](entity:VendorContact). | +| `ordinal` | `number` | Required | The ordinal of the [VendorContact](entity:VendorContact). | ## Example (as JSON) ```json { - "id": null, - "name": null, - "email_address": null, - "phone_number": null, - "removed": null, + "id": "id0", + "name": "name0", + "email_address": "email_address2", + "phone_number": "phone_number2", + "removed": false, "ordinal": 80 } ``` diff --git a/doc/models/vendor.md b/doc/models/vendor.md index 1803c560..b91445b1 100644 --- a/doc/models/vendor.md +++ b/doc/models/vendor.md @@ -11,31 +11,63 @@ Represents a supplier to a seller. | Name | Type | Tags | Description | | --- | --- | --- | --- | -| `id` | `string \| undefined` | Optional | A unique Square-generated ID for the [Vendor](../../doc/models/vendor.md).
This field is required when attempting to update a [Vendor](../../doc/models/vendor.md).
**Constraints**: *Maximum Length*: `100` | -| `createdAt` | `string \| undefined` | Optional | An RFC 3339-formatted timestamp that indicates when the
[Vendor](../../doc/models/vendor.md) was created.
**Constraints**: *Maximum Length*: `34` | -| `updatedAt` | `string \| undefined` | Optional | An RFC 3339-formatted timestamp that indicates when the
[Vendor](../../doc/models/vendor.md) was last updated.
**Constraints**: *Maximum Length*: `34` | -| `name` | `string \| undefined` | Optional | The name of the [Vendor](../../doc/models/vendor.md).
This field is required when attempting to create or update a [Vendor](../../doc/models/vendor.md).
**Constraints**: *Maximum Length*: `100` | +| `id` | `string \| undefined` | 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` | +| `createdAt` | `string \| undefined` | Optional | An RFC 3339-formatted timestamp that indicates when the
[Vendor](entity:Vendor) was created.
**Constraints**: *Maximum Length*: `34` | +| `updatedAt` | `string \| undefined` | Optional | An RFC 3339-formatted timestamp that indicates when the
[Vendor](entity:Vendor) was last updated.
**Constraints**: *Maximum Length*: `34` | +| `name` | `string \| undefined` | 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` | | `address` | [`Address \| undefined`](../../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). | -| `contacts` | [`VendorContact[] \| undefined`](../../doc/models/vendor-contact.md) | Optional | The contacts of the [Vendor](../../doc/models/vendor.md). | -| `accountNumber` | `string \| undefined` | Optional | The account number of the [Vendor](../../doc/models/vendor.md).
**Constraints**: *Maximum Length*: `100` | -| `note` | `string \| undefined` | Optional | A note detailing information about the [Vendor](../../doc/models/vendor.md).
**Constraints**: *Maximum Length*: `4096` | -| `version` | `number \| undefined` | Optional | The version of the [Vendor](../../doc/models/vendor.md). | +| `contacts` | [`VendorContact[] \| undefined`](../../doc/models/vendor-contact.md) | Optional | The contacts of the [Vendor](entity:Vendor). | +| `accountNumber` | `string \| undefined` | Optional | The account number of the [Vendor](entity:Vendor).
**Constraints**: *Maximum Length*: `100` | +| `note` | `string \| undefined` | Optional | A note detailing information about the [Vendor](entity:Vendor).
**Constraints**: *Maximum Length*: `4096` | +| `version` | `number \| undefined` | Optional | The version of the [Vendor](entity:Vendor). | | `status` | [`string \| undefined`](../../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. | ## Example (as JSON) ```json { - "id": null, - "created_at": null, - "updated_at": null, - "name": null, - "address": null, - "contacts": null, - "account_number": null, - "note": null, - "version": null, - "status": null + "id": "id0", + "created_at": "created_at2", + "updated_at": "updated_at4", + "name": "name0", + "address": { + "address_line_1": "address_line_16", + "address_line_2": "address_line_26", + "address_line_3": "address_line_32", + "locality": "locality6", + "sublocality": "sublocality6", + "sublocality_2": "sublocality_24", + "sublocality_3": "sublocality_36", + "administrative_district_level_1": "administrative_district_level_10", + "administrative_district_level_2": "administrative_district_level_28", + "administrative_district_level_3": "administrative_district_level_34", + "postal_code": "postal_code8", + "country": "BE", + "first_name": "first_name6", + "last_name": "last_name4" + }, + "contacts": [ + { + "id": "id7", + "name": "name7", + "email_address": "email_address5", + "phone_number": "phone_number5", + "removed": true, + "ordinal": 19 + }, + { + "id": "id8", + "name": "name8", + "email_address": "email_address6", + "phone_number": "phone_number6", + "removed": false, + "ordinal": 20 + } + ], + "account_number": "account_number0", + "note": "note4", + "version": 172, + "status": "ACTIVE" } ``` diff --git a/doc/models/void-transaction-response.md b/doc/models/void-transaction-response.md index 55fe3fed..4588bd73 100644 --- a/doc/models/void-transaction-response.md +++ b/doc/models/void-transaction-response.md @@ -2,7 +2,7 @@ # Void Transaction Response Defines the fields that are included in the response body of -a request to the [VoidTransaction](../../doc/api/transactions.md#void-transaction) endpoint. +a request to the [VoidTransaction](api-endpoint:Transactions-VoidTransaction) endpoint. ## Structure diff --git a/doc/models/wage-setting.md b/doc/models/wage-setting.md index 86e6ae19..24f37672 100644 --- a/doc/models/wage-setting.md +++ b/doc/models/wage-setting.md @@ -22,12 +22,52 @@ An object representing a team member's wage information. ```json { - "team_member_id": null, - "job_assignments": null, - "is_overtime_exempt": null, - "version": null, - "created_at": null, - "updated_at": null + "team_member_id": "team_member_id0", + "job_assignments": [ + { + "job_title": "job_title1", + "pay_type": "NONE", + "hourly_rate": { + "amount": 79, + "currency": "QAR" + }, + "annual_rate": { + "amount": 19, + "currency": "PKR" + }, + "weekly_hours": 187 + }, + { + "job_title": "job_title2", + "pay_type": "HOURLY", + "hourly_rate": { + "amount": 80, + "currency": "RON" + }, + "annual_rate": { + "amount": 20, + "currency": "PLN" + }, + "weekly_hours": 188 + }, + { + "job_title": "job_title3", + "pay_type": "SALARY", + "hourly_rate": { + "amount": 81, + "currency": "RSD" + }, + "annual_rate": { + "amount": 21, + "currency": "PYG" + }, + "weekly_hours": 189 + } + ], + "is_overtime_exempt": false, + "version": 172, + "created_at": "created_at2", + "updated_at": "updated_at4" } ``` diff --git a/doc/models/webhook-subscription.md b/doc/models/webhook-subscription.md index 3e69d93b..40dddb4d 100644 --- a/doc/models/webhook-subscription.md +++ b/doc/models/webhook-subscription.md @@ -26,15 +26,18 @@ event types, and signature key. ```json { - "id": null, - "name": null, - "enabled": null, - "event_types": null, - "notification_url": null, - "api_version": null, - "signature_key": null, - "created_at": null, - "updated_at": null + "id": "id0", + "name": "name0", + "enabled": false, + "event_types": [ + "event_types8", + "event_types9" + ], + "notification_url": "notification_url4", + "api_version": "api_version8", + "signature_key": "signature_key0", + "created_at": "created_at2", + "updated_at": "updated_at4" } ``` diff --git a/doc/models/workweek-config.md b/doc/models/workweek-config.md index ec7115b7..2190fc1c 100644 --- a/doc/models/workweek-config.md +++ b/doc/models/workweek-config.md @@ -23,12 +23,12 @@ workweek. This is used to calculate overtime pay. ```json { - "id": null, + "id": "id0", "start_of_week": "MON", "start_of_day_local_time": "start_of_day_local_time6", - "version": null, - "created_at": null, - "updated_at": null + "version": 172, + "created_at": "created_at2", + "updated_at": "updated_at4" } ``` diff --git a/package.json b/package.json index 44a71fa1..153a2f18 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "version": "25.2.0", + "version": "26.0.0", "license": "MIT", "sideEffects": false, "main": "dist/cjs/index.js", @@ -10,7 +10,7 @@ "src" ], "engines": { - "node": ">=10.4.0" + "node": ">=14.17.0" }, "scripts": { "build": "rm -rf dist & tsc -p tsconfig.esm.json & tsc -p tsconfig.cjs.json", @@ -45,11 +45,11 @@ "uuid": "^8.3.0" }, "dependencies": { - "@apimatic/authentication-adapters": "^0.1.0", - "@apimatic/axios-client-adapter": "^0.1.0", - "@apimatic/core": "^0.9.0", + "@apimatic/authentication-adapters": "^0.3.0", + "@apimatic/axios-client-adapter": "^0.2.0", + "@apimatic/core": "^0.10.0", "@apimatic/json-bigint": "^1.2.0", - "@apimatic/schema": "^0.6.0", + "@apimatic/schema": "^0.7.0", "@types/node": "^14.14.30" }, "bugs": { diff --git a/src/api/bookingCustomAttributesApi.ts b/src/api/bookingCustomAttributesApi.ts index ed1d2e5c..4f03bac3 100644 --- a/src/api/bookingCustomAttributesApi.ts +++ b/src/api/bookingCustomAttributesApi.ts @@ -318,7 +318,7 @@ export class BookingCustomAttributesApi extends BaseApi { * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and * `APPOINTMENTS_READ` for the OAuth scope. * - * @param bookingId The ID of the target [booking]($m/Booking). + * @param bookingId The ID of the target [booking](entity:Booking). * @param 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 @@ -328,11 +328,11 @@ export class BookingCustomAttributesApi extends BaseApi { * 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 withDefinitions Indicates whether to return the [custom attribute - * definition]($m/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`. + * @param 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 Response from the API call */ async listBookingCustomAttributes( @@ -370,7 +370,7 @@ export class BookingCustomAttributesApi extends BaseApi { * to *Appointments Plus* * or *Appointments Premium*. * - * @param bookingId The ID of the target [booking]($m/Booking). + * @param bookingId The ID of the target [booking](entity:Booking). * @param 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. @@ -400,15 +400,15 @@ export class BookingCustomAttributesApi extends BaseApi { * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and * `APPOINTMENTS_READ` for the OAuth scope. * - * @param bookingId The ID of the target [booking]($m/Booking). + * @param bookingId The ID of the target [booking](entity:Booking). * @param 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 withDefinition Indicates whether to return the [custom attribute - * definition]($m/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 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 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 @@ -450,7 +450,7 @@ export class BookingCustomAttributesApi extends BaseApi { * to *Appointments Plus* * or *Appointments Premium*. * - * @param bookingId The ID of the target [booking]($m/Booking). + * @param bookingId The ID of the target [booking](entity:Booking). * @param 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 diff --git a/src/api/bookingsApi.ts b/src/api/bookingsApi.ts index dd19526a..9946074a 100644 --- a/src/api/bookingsApi.ts +++ b/src/api/bookingsApi.ts @@ -106,8 +106,8 @@ export class BookingsApi extends BaseApi { * Creates a booking. * * The required input must include the following: - * - `Booking.location_id`, - * - `Booking.start_at`, + * - `Booking.location_id` + * - `Booking.start_at` * - `Booking.team_member_id` * - `Booking.AppointmentSegment.service_variation_id` * - `Booking.AppointmentSegment.service_variation_version` @@ -244,7 +244,8 @@ export class BookingsApi extends BaseApi { * To call this endpoint with seller-level permissions, set `APPOINTMENTS_ALL_READ` and * `APPOINTMENTS_READ` for the OAuth scope. * - * @param bookingId The ID of the [Booking]($m/Booking) object representing the to-be-retrieved booking. + * @param bookingId The ID of the [Booking](entity:Booking) object representing the to-be-retrieved + * booking. * @return Response from the API call */ async retrieveBooking( @@ -268,8 +269,8 @@ export class BookingsApi extends BaseApi { * to *Appointments Plus* * or *Appointments Premium*. * - * @param bookingId The ID of the [Booking]($m/Booking) object representing the to- - * be-updated booking. + * @param bookingId The ID of the [Booking](entity:Booking) object representing + * the to-be-updated booking. * @param body An object containing the fields to POST for the request. See * the corresponding object definition for field details. * @return Response from the API call @@ -301,8 +302,8 @@ export class BookingsApi extends BaseApi { * to *Appointments Plus* * or *Appointments Premium*. * - * @param bookingId The ID of the [Booking]($m/Booking) object representing the to- - * be-cancelled booking. + * @param bookingId The ID of the [Booking](entity:Booking) object representing + * the to-be-cancelled booking. * @param body An object containing the fields to POST for the request. See * the corresponding object definition for field details. * @return Response from the API call diff --git a/src/api/cardsApi.ts b/src/api/cardsApi.ts index eb791443..53e825a9 100644 --- a/src/api/cardsApi.ts +++ b/src/api/cardsApi.ts @@ -29,8 +29,8 @@ export class CardsApi extends BaseApi { * * @param cursor A pagination cursor returned by a previous call to this endpoint. Provide this * to retrieve the next set of results for your original query. See - * [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for - * more information. + * [Pagination](https://developer.squareup.com/docs/build-basics/common-api- + * patterns/pagination) for more information. * @param customerId Limit results to cards associated with the customer supplied. By default, all * cards owned by the merchant are returned. * @param includeDisabled Includes disabled cards. By default, all enabled cards owned by the merchant diff --git a/src/api/catalogApi.ts b/src/api/catalogApi.ts index a39eeef7..ca027c4a 100644 --- a/src/api/catalogApi.ts +++ b/src/api/catalogApi.ts @@ -292,9 +292,10 @@ export class CatalogApi extends BaseApi { * * @param 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/basics/api101/pagination) for more information. + * //developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for + * more information. * @param types An optional case-insensitive, comma-separated list of object types to retrieve. - * The valid values are defined in the [CatalogObjectType]($m/CatalogObjectType) + * 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 diff --git a/src/api/checkoutApi.ts b/src/api/checkoutApi.ts index 3eddc47d..89b8abe9 100644 --- a/src/api/checkoutApi.ts +++ b/src/api/checkoutApi.ts @@ -48,7 +48,7 @@ export class CheckoutApi extends BaseApi { * NOTE: The Checkout API has been updated with new features. * For more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout- * api#checkout-api-highlights). - * We recommend that you use the new [CreatePaymentLink]($e/Checkout/CreatePaymentLink) + * We recommend that you use the new [CreatePaymentLink](api-endpoint:Checkout-CreatePaymentLink) * endpoint in place of this previously released endpoint. * * @param locationId The ID of the business location to associate the checkout diff --git a/src/api/customerCustomAttributesApi.ts b/src/api/customerCustomAttributesApi.ts index 911250a9..123b1ade 100644 --- a/src/api/customerCustomAttributesApi.ts +++ b/src/api/customerCustomAttributesApi.ts @@ -291,7 +291,7 @@ export class CustomerCustomAttributesApi extends BaseApi { * 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 customerId The ID of the target [customer profile]($m/Customer). + * @param customerId The ID of the target [customer profile](entity:Customer). * @param 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 @@ -301,11 +301,11 @@ export class CustomerCustomAttributesApi extends BaseApi { * 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 withDefinitions Indicates whether to return the [custom attribute - * definition]($m/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`. + * @param 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 Response from the API call */ async listCustomerCustomAttributes( @@ -339,7 +339,7 @@ export class CustomerCustomAttributesApi extends BaseApi { * `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes * (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. * - * @param customerId The ID of the target [customer profile]($m/Customer). + * @param customerId The ID of the target [customer profile](entity:Customer). * @param 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. @@ -373,15 +373,15 @@ export class CustomerCustomAttributesApi extends BaseApi { * attributes * (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. * - * @param customerId The ID of the target [customer profile]($m/Customer). + * @param customerId The ID of the target [customer profile](entity:Customer). * @param 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 withDefinition Indicates whether to return the [custom attribute - * definition]($m/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 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 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 @@ -425,8 +425,8 @@ export class CustomerCustomAttributesApi extends BaseApi { * 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 customerId The ID of the target [customer - * profile]($m/Customer). + * @param customerId The ID of the target [customer profile](entity: + * Customer). * @param 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 diff --git a/src/api/disputesApi.ts b/src/api/disputesApi.ts index 3c6a89b2..35fcf645 100644 --- a/src/api/disputesApi.ts +++ b/src/api/disputesApi.ts @@ -52,8 +52,8 @@ export class DisputesApi extends BaseApi { * * @param 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/basics/api101/pagination). + * information, see [Pagination](https://developer.squareup.com/docs/build-basics/common- + * api-patterns/pagination). * @param states The dispute states used to filter the result. If not specified, the endpoint returns * all disputes. * @param locationId The ID of the location for which to return a list of disputes. If not specified, the diff --git a/src/api/giftCardActivitiesApi.ts b/src/api/giftCardActivitiesApi.ts index 62753137..ac69218e 100644 --- a/src/api/giftCardActivitiesApi.ts +++ b/src/api/giftCardActivitiesApi.ts @@ -24,9 +24,9 @@ export class GiftCardActivitiesApi extends BaseApi { * @param giftCardId 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. - * @param type If a [type]($m/GiftCardActivityType) is provided, the endpoint returns gift card - * activities of the specified type. Otherwise, the endpoint returns all types of gift - * card activities. + * @param type 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. * @param locationId 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. diff --git a/src/api/giftCardsApi.ts b/src/api/giftCardsApi.ts index 45cc5584..2cb7e0e1 100644 --- a/src/api/giftCardsApi.ts +++ b/src/api/giftCardsApi.ts @@ -55,10 +55,10 @@ export class GiftCardsApi extends BaseApi { * Lists all gift cards. You can specify optional filters to retrieve * a subset of the gift cards. Results are sorted by `created_at` in ascending order. * - * @param type If a [type]($m/GiftCardType) is provided, the endpoint returns gift cards of the + * @param type 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. - * @param state If a [state]($m/GiftCardStatus) is provided, the endpoint returns the gift cards in - * the specified state. Otherwise, the endpoint returns the gift cards of all states. + * @param state 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. * @param limit If a limit is provided, the endpoint returns only the specified number of results * per page. The maximum value is 50. The default value is 30. For more information, see * [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination). diff --git a/src/api/inventoryApi.ts b/src/api/inventoryApi.ts index 5c7c57ce..d6f8849f 100644 --- a/src/api/inventoryApi.ts +++ b/src/api/inventoryApi.ts @@ -48,11 +48,11 @@ import { BaseApi } from './baseApi'; export class InventoryApi extends BaseApi { /** - * Deprecated version of [RetrieveInventoryAdjustment]($e/Inventory/RetrieveInventoryAdjustment) after - * the endpoint URL + * Deprecated version of [RetrieveInventoryAdjustment](api-endpoint:Inventory- + * RetrieveInventoryAdjustment) after the endpoint URL * is updated to conform to the standard convention. * - * @param adjustmentId ID of the [InventoryAdjustment]($m/InventoryAdjustment) to retrieve. + * @param adjustmentId ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve. * @return Response from the API call * @deprecated */ @@ -74,7 +74,7 @@ export class InventoryApi extends BaseApi { * Returns the [InventoryAdjustment]($m/InventoryAdjustment) object * with the provided `adjustment_id`. * - * @param adjustmentId ID of the [InventoryAdjustment]($m/InventoryAdjustment) to retrieve. + * @param adjustmentId ID of the [InventoryAdjustment](entity:InventoryAdjustment) to retrieve. * @return Response from the API call */ async retrieveInventoryAdjustment( @@ -91,8 +91,8 @@ export class InventoryApi extends BaseApi { } /** - * Deprecated version of [BatchChangeInventory]($e/Inventory/BatchChangeInventory) after the endpoint - * URL + * Deprecated version of [BatchChangeInventory](api-endpoint:Inventory-BatchChangeInventory) after the + * endpoint URL * is updated to conform to the standard convention. * * @param body An object containing the fields to POST for the request. @@ -116,8 +116,8 @@ export class InventoryApi extends BaseApi { } /** - * Deprecated version of [BatchRetrieveInventoryChanges]($e/Inventory/BatchRetrieveInventoryChanges) - * after the endpoint URL + * Deprecated version of [BatchRetrieveInventoryChanges](api-endpoint:Inventory- + * BatchRetrieveInventoryChanges) after the endpoint URL * is updated to conform to the standard convention. * * @param body An object containing the fields to POST for @@ -147,8 +147,8 @@ export class InventoryApi extends BaseApi { } /** - * Deprecated version of [BatchRetrieveInventoryCounts]($e/Inventory/BatchRetrieveInventoryCounts) - * after the endpoint URL + * Deprecated version of [BatchRetrieveInventoryCounts](api-endpoint:Inventory- + * BatchRetrieveInventoryCounts) after the endpoint URL * is updated to conform to the standard convention. * * @param body An object containing the fields to POST for the @@ -277,11 +277,11 @@ export class InventoryApi extends BaseApi { } /** - * Deprecated version of [RetrieveInventoryPhysicalCount]($e/Inventory/RetrieveInventoryPhysicalCount) - * after the endpoint URL + * Deprecated version of [RetrieveInventoryPhysicalCount](api-endpoint:Inventory- + * RetrieveInventoryPhysicalCount) after the endpoint URL * is updated to conform to the standard convention. * - * @param physicalCountId ID of the [InventoryPhysicalCount]($m/InventoryPhysicalCount) to retrieve. + * @param physicalCountId ID of the [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve. * @return Response from the API call * @deprecated */ @@ -305,7 +305,7 @@ export class InventoryApi extends BaseApi { * Returns the [InventoryPhysicalCount]($m/InventoryPhysicalCount) * object with the provided `physical_count_id`. * - * @param physicalCountId ID of the [InventoryPhysicalCount]($m/InventoryPhysicalCount) to retrieve. + * @param physicalCountId ID of the [InventoryPhysicalCount](entity:InventoryPhysicalCount) to retrieve. * @return Response from the API call */ async retrieveInventoryPhysicalCount( @@ -327,7 +327,7 @@ export class InventoryApi extends BaseApi { * Returns the [InventoryTransfer]($m/InventoryTransfer) object * with the provided `transfer_id`. * - * @param transferId ID of the [InventoryTransfer]($m/InventoryTransfer) to retrieve. + * @param transferId ID of the [InventoryTransfer](entity:InventoryTransfer) to retrieve. * @return Response from the API call */ async retrieveInventoryTransfer( @@ -349,9 +349,9 @@ export class InventoryApi extends BaseApi { * [Location]($m/Location)s. Responses are paginated and unsorted. * For more sophisticated queries, use a batch endpoint. * - * @param catalogObjectId ID of the [CatalogObject]($m/CatalogObject) to retrieve. - * @param locationIds The [Location]($m/Location) IDs to look up as a comma-separated list. An empty - * list queries all locations. + * @param catalogObjectId ID of the [CatalogObject](entity:CatalogObject) to retrieve. + * @param locationIds The [Location](entity:Location) IDs to look up as a comma-separated list. An + * empty list queries all locations. * @param 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) @@ -378,11 +378,11 @@ export class InventoryApi extends BaseApi { /** * Returns a set of physical counts and inventory adjustments for the - * provided [CatalogObject]($m/CatalogObject) at the requested - * [Location]($m/Location)s. + * provided [CatalogObject](entity:CatalogObject) at the requested + * [Location](entity:Location)s. * - * You can achieve the same result by calling - * [BatchRetrieveInventoryChanges]($e/Inventory/BatchRetrieveInventoryChanges) + * 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 @@ -392,9 +392,9 @@ export class InventoryApi extends BaseApi { * used to display recent changes for a specific item. For more * sophisticated queries, use a batch endpoint. * - * @param catalogObjectId ID of the [CatalogObject]($m/CatalogObject) to retrieve. - * @param locationIds The [Location]($m/Location) IDs to look up as a comma-separated list. An empty - * list queries all locations. + * @param catalogObjectId ID of the [CatalogObject](entity:CatalogObject) to retrieve. + * @param locationIds The [Location](entity:Location) IDs to look up as a comma-separated list. An + * empty list queries all locations. * @param 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) diff --git a/src/api/invoicesApi.ts b/src/api/invoicesApi.ts index 08ffa621..0ac5de39 100644 --- a/src/api/invoicesApi.ts +++ b/src/api/invoicesApi.ts @@ -144,9 +144,9 @@ export class InvoicesApi extends BaseApi { * invoice (you cannot delete a published invoice, including one that is scheduled for processing). * * @param invoiceId The ID of the invoice to delete. - * @param version The version of the [invoice]($m/Invoice) to delete. If you do not know the version, - * you can call [GetInvoice]($e/Invoices/GetInvoice) or - * [ListInvoices]($e/Invoices/ListInvoices). + * @param 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 Response from the API call */ async deleteInvoice( @@ -218,7 +218,7 @@ export class InvoicesApi extends BaseApi { * You cannot cancel an invoice in the `DRAFT` state or in a terminal state: `PAID`, `REFUNDED`, * `CANCELED`, or `FAILED`. * - * @param invoiceId The ID of the [invoice]($m/Invoice) to cancel. + * @param invoiceId The ID of the [invoice](entity:Invoice) to cancel. * @param body An object containing the fields to POST for the request. See * the corresponding object definition for field details. * @return Response from the API call diff --git a/src/api/locationCustomAttributesApi.ts b/src/api/locationCustomAttributesApi.ts index f2e23d60..029a4fbd 100644 --- a/src/api/locationCustomAttributesApi.ts +++ b/src/api/locationCustomAttributesApi.ts @@ -310,7 +310,7 @@ export class LocationCustomAttributesApi extends BaseApi { * 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 locationId The ID of the target [location]($m/Location). + * @param locationId The ID of the target [location](entity:Location). * @param visibilityFilter Filters the `CustomAttributeDefinition` results by their `visibility` values. * @param 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 @@ -321,11 +321,11 @@ export class LocationCustomAttributesApi extends BaseApi { * 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 withDefinitions Indicates whether to return the [custom attribute - * definition]($m/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`. + * @param 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 Response from the API call */ async listLocationCustomAttributes( @@ -360,7 +360,7 @@ export class LocationCustomAttributesApi extends BaseApi { * To delete a custom attribute owned by another application, the `visibility` setting must be * `VISIBILITY_READ_WRITE_VALUES`. * - * @param locationId The ID of the target [location]($m/Location). + * @param locationId The ID of the target [location](entity:Location). * @param 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. @@ -390,15 +390,15 @@ export class LocationCustomAttributesApi extends BaseApi { * To retrieve a custom attribute owned by another application, the `visibility` setting must be * `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. * - * @param locationId The ID of the target [location]($m/Location). + * @param locationId The ID of the target [location](entity:Location). * @param 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 withDefinition Indicates whether to return the [custom attribute - * definition]($m/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 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 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 @@ -439,7 +439,8 @@ export class LocationCustomAttributesApi extends BaseApi { * To create or update a custom attribute owned by another application, the `visibility` setting * must be `VISIBILITY_READ_WRITE_VALUES`. * - * @param locationId The ID of the target [location]($m/Location). + * @param locationId The ID of the target [location](entity: + * Location). * @param 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 diff --git a/src/api/loyaltyApi.ts b/src/api/loyaltyApi.ts index f6590ac4..98a87aea 100644 --- a/src/api/loyaltyApi.ts +++ b/src/api/loyaltyApi.ts @@ -166,7 +166,7 @@ export class LoyaltyApi extends BaseApi { /** * Retrieves a loyalty account. * - * @param accountId The ID of the [loyalty account]($m/LoyaltyAccount) to retrieve. + * @param accountId The ID of the [loyalty account](entity:LoyaltyAccount) to retrieve. * @return Response from the API call */ async retrieveLoyaltyAccount( @@ -200,8 +200,8 @@ export class LoyaltyApi extends BaseApi { * [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty- * promotions#calculate-promotion-points). * - * @param accountId The ID of the target [loyalty - * account]($m/LoyaltyAccount). + * @param accountId The ID of the target [loyalty account](entity: + * LoyaltyAccount). * @param body An object containing the fields to POST for the * request. See the corresponding object definition for * field details. @@ -234,8 +234,8 @@ export class LoyaltyApi extends BaseApi { * [AccumulateLoyaltyPoints]($e/Loyalty/AccumulateLoyaltyPoints) * to add points when a buyer pays for the purchase. * - * @param accountId The ID of the target [loyalty - * account]($m/LoyaltyAccount). + * @param accountId The ID of the target [loyalty account](entity: + * LoyaltyAccount). * @param body An object containing the fields to POST for the request. * See the corresponding object definition for field * details. @@ -292,8 +292,8 @@ export class LoyaltyApi extends BaseApi { * information, see [Loyalty Program Overview](https://developer.squareup.com/docs/loyalty/overview). * * - * Replaced with [RetrieveLoyaltyProgram]($e/Loyalty/RetrieveLoyaltyProgram) when used with the keyword - * `main`. + * Replaced with [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when used with + * the keyword `main`. * * @return Response from the API call * @deprecated @@ -350,8 +350,9 @@ export class LoyaltyApi extends BaseApi { * [Calculating promotion points](https://developer.squareup.com/docs/loyalty-api/loyalty- * promotions#calculate-promotion-points). * - * @param programId The ID of the [loyalty program]($m/LoyaltyProgram), - * which defines the rules for accruing points. + * @param programId The ID of the [loyalty program](entity: + * LoyaltyProgram), which defines the rules for accruing + * points. * @param body An object containing the fields to POST for the * request. See the corresponding object definition for * field details. @@ -377,8 +378,9 @@ export class LoyaltyApi extends BaseApi { * 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 programId The ID of the base [loyalty program]($m/LoyaltyProgram). To get the program ID, call - * [RetrieveLoyaltyProgram]($e/Loyalty/RetrieveLoyaltyProgram) using the `main` keyword. + * @param 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 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. @@ -421,11 +423,11 @@ export class LoyaltyApi extends BaseApi { * `available_time` setting. A loyalty program can have a maximum of 10 loyalty promotions with an * `ACTIVE` or `SCHEDULED` status. * - * @param programId The ID of the [loyalty program]($m/LoyaltyProgram) to - * associate with the promotion. To get the program ID, - * call - * [RetrieveLoyaltyProgram]($e/Loyalty/RetrieveLoyaltyPro - * gram) using the `main` keyword. + * @param 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 body An object containing the fields to POST for the * request. See the corresponding object definition for * field details. @@ -450,10 +452,10 @@ export class LoyaltyApi extends BaseApi { /** * Retrieves a loyalty promotion. * - * @param promotionId The ID of the [loyalty promotion]($m/LoyaltyPromotion) to retrieve. - * @param programId The ID of the base [loyalty program]($m/LoyaltyProgram). To get the program ID, - * call [RetrieveLoyaltyProgram]($e/Loyalty/RetrieveLoyaltyProgram) using the `main` - * keyword. + * @param promotionId The ID of the [loyalty promotion](entity:LoyaltyPromotion) to retrieve. + * @param 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 Response from the API call */ async retrieveLoyaltyPromotion( @@ -483,9 +485,9 @@ export class LoyaltyApi extends BaseApi { * * This endpoint sets the loyalty promotion to the `CANCELED` state * - * @param promotionId The ID of the [loyalty promotion]($m/LoyaltyPromotion) to cancel. You can cancel a - * promotion that has an `ACTIVE` or `SCHEDULED` status. - * @param programId The ID of the base [loyalty program]($m/LoyaltyProgram). + * @param promotionId The ID of the [loyalty promotion](entity:LoyaltyPromotion) to cancel. You can + * cancel a promotion that has an `ACTIVE` or `SCHEDULED` status. + * @param programId The ID of the base [loyalty program](entity:LoyaltyProgram). * @return Response from the API call */ async cancelLoyaltyPromotion( @@ -569,7 +571,7 @@ export class LoyaltyApi extends BaseApi { * * You cannot delete a reward that has reached the terminal state (REDEEMED). * - * @param rewardId The ID of the [loyalty reward]($m/LoyaltyReward) to delete. + * @param rewardId The ID of the [loyalty reward](entity:LoyaltyReward) to delete. * @return Response from the API call */ async deleteLoyaltyReward( @@ -585,7 +587,7 @@ export class LoyaltyApi extends BaseApi { /** * Retrieves a loyalty reward. * - * @param rewardId The ID of the [loyalty reward]($m/LoyaltyReward) to retrieve. + * @param rewardId The ID of the [loyalty reward](entity:LoyaltyReward) to retrieve. * @return Response from the API call */ async retrieveLoyaltyReward( @@ -611,7 +613,7 @@ export class LoyaltyApi extends BaseApi { * In other words, points used for the reward cannot be returned * to the account. * - * @param rewardId The ID of the [loyalty reward]($m/LoyaltyReward) to + * @param rewardId The ID of the [loyalty reward](entity:LoyaltyReward) to * redeem. * @param body An object containing the fields to POST for the request. * See the corresponding object definition for field diff --git a/src/api/orderCustomAttributesApi.ts b/src/api/orderCustomAttributesApi.ts index 61745f56..2b20aedc 100644 --- a/src/api/orderCustomAttributesApi.ts +++ b/src/api/orderCustomAttributesApi.ts @@ -328,7 +328,7 @@ export class OrderCustomAttributesApi extends BaseApi { * 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 orderId The ID of the target [order]($m/Order). + * @param orderId The ID of the target [order](entity:Order). * @param visibilityFilter Requests that all of the custom attributes be returned, or only those that * are read-only or read-write. * @param cursor The cursor returned in the paged response from the previous call to this @@ -340,11 +340,11 @@ export class OrderCustomAttributesApi extends BaseApi { * 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 withDefinitions Indicates whether to return the [custom attribute - * definition]($m/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`. + * @param 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 Response from the API call */ async listOrderCustomAttributes( @@ -381,7 +381,7 @@ export class OrderCustomAttributesApi extends BaseApi { * `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes * (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. * - * @param orderId The ID of the target [order]($m/Order). + * @param orderId The ID of the target [order](entity:Order). * @param customAttributeKey The key of the custom attribute to delete. This key must match the key of * an existing custom attribute definition. * @return Response from the API call @@ -414,18 +414,18 @@ export class OrderCustomAttributesApi extends BaseApi { * attributes * also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`. * - * @param orderId The ID of the target [order]($m/Order). + * @param orderId The ID of the target [order](entity:Order). * @param customAttributeKey The key of the custom attribute to retrieve. This key must match the key * of an existing custom attribute definition. * @param 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 withDefinition Indicates whether to return the [custom attribute - * definition]($m/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`. + * @param 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 Response from the API call */ async retrieveOrderCustomAttribute( @@ -465,7 +465,8 @@ export class OrderCustomAttributesApi extends BaseApi { * 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 orderId The ID of the target [order]($m/Order). + * @param orderId The ID of the target [order](entity: + * Order). * @param customAttributeKey The key of the custom attribute to create * or update. This key must match the key * of an existing custom attribute definition. diff --git a/src/api/paymentsApi.ts b/src/api/paymentsApi.ts index e287503c..76f4f054 100644 --- a/src/api/paymentsApi.ts +++ b/src/api/paymentsApi.ts @@ -55,16 +55,18 @@ export class PaymentsApi extends BaseApi { * * The maximum results per page is 100. * - * @param beginTime The timestamp for the beginning of the reporting period, in RFC 3339 format. - * Inclusive. Default: The current time minus one year. - * @param endTime The timestamp for the end of the reporting period, in RFC 3339 format. Default: The + * @param beginTime 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. + * @param endTime 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. - * @param sortOrder The order in which results are listed: - `ASC` - Oldest to newest. - `DESC` - Newest - * to oldest (default). + * @param sortOrder The order in which results are listed by `Payment.created_at`: - `ASC` - Oldest to + * newest. - `DESC` - Newest to oldest (default). * @param 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/basics/api101/pagination). + * information, see [Pagination](https://developer.squareup.com/docs/build-basics/common- + * api-patterns/pagination). * @param locationId Limit results to the location supplied. By default, results are returned for the * default (main) location associated with the seller. * @param total The exact amount in the `total_money` for a payment. diff --git a/src/api/payoutsApi.ts b/src/api/payoutsApi.ts index c69a9642..9bd6bd9a 100644 --- a/src/api/payoutsApi.ts +++ b/src/api/payoutsApi.ts @@ -21,7 +21,7 @@ export class PayoutsApi extends BaseApi { * order. * To call this endpoint, set `PAYOUTS_READ` for the OAuth scope. * - * @param locationId The ID of the location for which to list the payouts. By default, payouts are + * @param locationId 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. * @param status If provided, only payouts with the given status are returned. * @param beginTime The timestamp for the beginning of the payout creation time, in RFC 3339 format. @@ -31,9 +31,9 @@ export class PayoutsApi extends BaseApi { * @param sortOrder The order in which payouts are listed. * @param 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/basics/api101/pagination). If request parameters change between requests, - * subsequent results may contain duplicates or missing records. + * 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 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 @@ -95,9 +95,9 @@ export class PayoutsApi extends BaseApi { * @param sortOrder The order in which payout entries are listed. * @param 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/basics/api101/pagination). If request - * parameters change between requests, subsequent results may contain duplicates or - * missing records. + * [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 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 diff --git a/src/api/refundsApi.ts b/src/api/refundsApi.ts index 71abb888..7e37f0d8 100644 --- a/src/api/refundsApi.ts +++ b/src/api/refundsApi.ts @@ -27,21 +27,23 @@ export class RefundsApi extends BaseApi { * * The maximum results per page is 100. * - * @param beginTime The timestamp for the beginning of the requested reporting period, in RFC 3339 - * format. Default: The current time minus one year. - * @param endTime The timestamp for the end of the requested reporting period, in RFC 3339 format. - * Default: The current time. - * @param sortOrder The order in which results are listed: - `ASC` - Oldest to newest. - `DESC` - Newest - * to oldest (default). + * @param beginTime 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. + * @param endTime 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. + * @param sortOrder The order in which results are listed by `PaymentRefund.created_at`: - `ASC` - + * Oldest to newest. - `DESC` - Newest to oldest (default). * @param 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/basics/api101/pagination). + * information, see [Pagination](https://developer.squareup.com/docs/build-basics/common- + * api-patterns/pagination). * @param locationId Limit results to the location supplied. By default, results are returned for all * locations associated with the seller. * @param status If provided, only refunds with the given status are returned. For a list of refund - * status values, see [PaymentRefund]($m/PaymentRefund). Default: If omitted, refunds - * are returned regardless of their status. + * status values, see [PaymentRefund](entity:PaymentRefund). Default: If omitted, + * refunds are returned regardless of their status. * @param sourceType 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. diff --git a/src/api/transactionsApi.ts b/src/api/transactionsApi.ts index a709c784..2f101627 100644 --- a/src/api/transactionsApi.ts +++ b/src/api/transactionsApi.ts @@ -93,7 +93,7 @@ export class TransactionsApi extends BaseApi { } /** - * Captures a transaction that was created with the [Charge]($e/Transactions/Charge) + * Captures a transaction that was created with the [Charge](api-endpoint:Transactions-Charge) * endpoint with a `delay_capture` value of `true`. * * @@ -122,7 +122,7 @@ export class TransactionsApi extends BaseApi { } /** - * Cancels a transaction that was created with the [Charge]($e/Transactions/Charge) + * Cancels a transaction that was created with the [Charge](api-endpoint:Transactions-Charge) * endpoint with a `delay_capture` value of `true`. * * diff --git a/src/api/vendorsApi.ts b/src/api/vendorsApi.ts index 8c2767df..981aea94 100644 --- a/src/api/vendorsApi.ts +++ b/src/api/vendorsApi.ts @@ -158,7 +158,7 @@ export class VendorsApi extends BaseApi { /** * Retrieves the vendor of a specified [Vendor]($m/Vendor) ID. * - * @param vendorId ID of the [Vendor]($m/Vendor) to retrieve. + * @param vendorId ID of the [Vendor](entity:Vendor) to retrieve. * @return Response from the API call */ async retrieveVendor( diff --git a/src/api/webhookSubscriptionsApi.ts b/src/api/webhookSubscriptionsApi.ts index ae351609..32fc469c 100644 --- a/src/api/webhookSubscriptionsApi.ts +++ b/src/api/webhookSubscriptionsApi.ts @@ -77,10 +77,10 @@ export class WebhookSubscriptionsApi extends BaseApi { * to retrieve the next set of results for your original query. For more * information, see [Pagination](https://developer.squareup. * com/docs/basics/api101/pagination). - * @param includeDisabled Includes disabled [Subscription]($m/WebhookSubscription)s. By default, all - * enabled [Subscription]($m/WebhookSubscription)s are returned. - * @param sortOrder Sorts the returned list by when the [Subscription]($m/WebhookSubscription) was - * created with the specified order. This field defaults to ASC. + * @param includeDisabled Includes disabled [Subscription](entity:WebhookSubscription)s. By default, all + * enabled [Subscription](entity:WebhookSubscription)s are returned. + * @param sortOrder Sorts the returned list by when the [Subscription](entity:WebhookSubscription) + * was created with the specified order. This field defaults to ASC. * @param 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 @@ -137,7 +137,7 @@ export class WebhookSubscriptionsApi extends BaseApi { /** * Deletes a webhook subscription. * - * @param subscriptionId [REQUIRED] The ID of the [Subscription]($m/WebhookSubscription) to delete. + * @param subscriptionId [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete. * @return Response from the API call */ async deleteWebhookSubscription( @@ -158,7 +158,7 @@ export class WebhookSubscriptionsApi extends BaseApi { /** * Retrieves a webhook subscription identified by its ID. * - * @param subscriptionId [REQUIRED] The ID of the [Subscription]($m/WebhookSubscription) to retrieve. + * @param subscriptionId [REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to retrieve. * @return Response from the API call */ async retrieveWebhookSubscription( @@ -179,8 +179,8 @@ export class WebhookSubscriptionsApi extends BaseApi { /** * Updates a webhook subscription. * - * @param subscriptionId [REQUIRED] The ID of the - * [Subscription]($m/WebhookSubscription) to update. + * @param subscriptionId [REQUIRED] The ID of the [Subscription](entity: + * WebhookSubscription) to update. * @param body An object containing the fields to POST for the * request. See the corresponding object * definition for field details. @@ -209,8 +209,8 @@ export class WebhookSubscriptionsApi extends BaseApi { * Updates a webhook subscription by replacing the existing signature key with a new one. * * @param subscriptionId [REQUIRED] The ID of the - * [Subscription]($m/WebhookSubscriptio - * n) to update. + * [Subscription](entity: + * WebhookSubscription) to update. * @param body An object containing the fields to * POST for the request. See the * corresponding object definition for @@ -239,8 +239,8 @@ export class WebhookSubscriptionsApi extends BaseApi { /** * Tests a webhook subscription by sending a test event to the notification URL. * - * @param subscriptionId [REQUIRED] The ID of the - * [Subscription]($m/WebhookSubscription) to test. + * @param subscriptionId [REQUIRED] The ID of the [Subscription](entity: + * WebhookSubscription) to test. * @param body An object containing the fields to POST for the * request. See the corresponding object definition * for field details. diff --git a/src/client.ts b/src/client.ts index 45289d67..92657e88 100644 --- a/src/client.ts +++ b/src/client.ts @@ -66,7 +66,7 @@ import { import { HttpClient } from './clientAdapter'; /** Current SDK version */ -export const SDK_VERSION = '25.2.0'; +export const SDK_VERSION = '26.0.0'; export class Client implements ClientInterface { private _config: Readonly; private _timeout: number; @@ -129,7 +129,7 @@ export class Client implements ClientInterface { ? this._config.httpClientOptions.timeout : this._config.timeout; this._userAgent = updateUserAgent( - 'Square-TypeScript-SDK/25.2.0 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}', + 'Square-TypeScript-SDK/26.0.0 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}', this._config.squareVersion, this._config.userAgentDetail ); diff --git a/src/defaultConfiguration.ts b/src/defaultConfiguration.ts index 9a8130cb..c0794460 100644 --- a/src/defaultConfiguration.ts +++ b/src/defaultConfiguration.ts @@ -4,7 +4,7 @@ import { RetryConfiguration } from './core'; /** Default values for the configuration parameters of the client. */ export const DEFAULT_CONFIGURATION: Configuration = { timeout: 60000, - squareVersion: '2023-03-15', + squareVersion: '2023-04-19', additionalHeaders: {}, userAgentDetail: '', environment: Environment.Production, diff --git a/src/index.ts b/src/index.ts index 4e8ea97d..1f8865ce 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,8 +1,8 @@ export * from './client'; export * from './configuration'; +export type { ApiResponse } from './core' export { AbortError, - ApiResponse, ArgumentsValidationError, cloneFileWrapper, FileWrapper, @@ -51,834 +51,835 @@ export * from './api/v1TransactionsApi'; export * from './api/vendorsApi'; export * from './api/webhookSubscriptionsApi'; export * from './errors/apiError'; -export { AcceptDisputeResponse } from './models/acceptDisputeResponse'; -export { AcceptedPaymentMethods } from './models/acceptedPaymentMethods'; -export { AccumulateLoyaltyPointsRequest } from './models/accumulateLoyaltyPointsRequest'; -export { AccumulateLoyaltyPointsResponse } from './models/accumulateLoyaltyPointsResponse'; -export { ACHDetails } from './models/aCHDetails'; -export { AddGroupToCustomerResponse } from './models/addGroupToCustomerResponse'; -export { AdditionalRecipient } from './models/additionalRecipient'; -export { Address } from './models/address'; -export { AdjustLoyaltyPointsRequest } from './models/adjustLoyaltyPointsRequest'; -export { AdjustLoyaltyPointsResponse } from './models/adjustLoyaltyPointsResponse'; -export { AfterpayDetails } from './models/afterpayDetails'; -export { ApplicationDetails } from './models/applicationDetails'; -export { AppointmentSegment } from './models/appointmentSegment'; -export { Availability } from './models/availability'; -export { BankAccount } from './models/bankAccount'; -export { BankAccountPaymentDetails } from './models/bankAccountPaymentDetails'; -export { BatchChangeInventoryRequest } from './models/batchChangeInventoryRequest'; -export { BatchChangeInventoryResponse } from './models/batchChangeInventoryResponse'; -export { BatchDeleteCatalogObjectsRequest } from './models/batchDeleteCatalogObjectsRequest'; -export { BatchDeleteCatalogObjectsResponse } from './models/batchDeleteCatalogObjectsResponse'; -export { BatchRetrieveCatalogObjectsRequest } from './models/batchRetrieveCatalogObjectsRequest'; -export { BatchRetrieveCatalogObjectsResponse } from './models/batchRetrieveCatalogObjectsResponse'; -export { BatchRetrieveInventoryChangesRequest } from './models/batchRetrieveInventoryChangesRequest'; -export { BatchRetrieveInventoryChangesResponse } from './models/batchRetrieveInventoryChangesResponse'; -export { BatchRetrieveInventoryCountsRequest } from './models/batchRetrieveInventoryCountsRequest'; -export { BatchRetrieveInventoryCountsResponse } from './models/batchRetrieveInventoryCountsResponse'; -export { BatchRetrieveOrdersRequest } from './models/batchRetrieveOrdersRequest'; -export { BatchRetrieveOrdersResponse } from './models/batchRetrieveOrdersResponse'; -export { BatchUpsertCatalogObjectsRequest } from './models/batchUpsertCatalogObjectsRequest'; -export { BatchUpsertCatalogObjectsResponse } from './models/batchUpsertCatalogObjectsResponse'; -export { Booking } from './models/booking'; -export { BookingCreatorDetails } from './models/bookingCreatorDetails'; -export { BookingCustomAttributeDeleteRequest } from './models/bookingCustomAttributeDeleteRequest'; -export { BookingCustomAttributeDeleteResponse } from './models/bookingCustomAttributeDeleteResponse'; -export { BookingCustomAttributeUpsertRequest } from './models/bookingCustomAttributeUpsertRequest'; -export { BookingCustomAttributeUpsertResponse } from './models/bookingCustomAttributeUpsertResponse'; -export { Break } from './models/break'; -export { BreakType } from './models/breakType'; -export { BulkCreateTeamMembersRequest } from './models/bulkCreateTeamMembersRequest'; -export { BulkCreateTeamMembersResponse } from './models/bulkCreateTeamMembersResponse'; -export { BulkCreateVendorsRequest } from './models/bulkCreateVendorsRequest'; -export { BulkCreateVendorsResponse } from './models/bulkCreateVendorsResponse'; -export { BulkDeleteBookingCustomAttributesRequest } from './models/bulkDeleteBookingCustomAttributesRequest'; -export { BulkDeleteBookingCustomAttributesResponse } from './models/bulkDeleteBookingCustomAttributesResponse'; -export { BulkDeleteLocationCustomAttributesRequest } from './models/bulkDeleteLocationCustomAttributesRequest'; -export { BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest } from './models/bulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest'; -export { BulkDeleteLocationCustomAttributesResponse } from './models/bulkDeleteLocationCustomAttributesResponse'; -export { BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse } from './models/bulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse'; -export { BulkDeleteOrderCustomAttributesRequest } from './models/bulkDeleteOrderCustomAttributesRequest'; -export { BulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute } from './models/bulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute'; -export { BulkDeleteOrderCustomAttributesResponse } from './models/bulkDeleteOrderCustomAttributesResponse'; -export { BulkRetrieveVendorsRequest } from './models/bulkRetrieveVendorsRequest'; -export { BulkRetrieveVendorsResponse } from './models/bulkRetrieveVendorsResponse'; -export { BulkUpdateTeamMembersRequest } from './models/bulkUpdateTeamMembersRequest'; -export { BulkUpdateTeamMembersResponse } from './models/bulkUpdateTeamMembersResponse'; -export { BulkUpdateVendorsRequest } from './models/bulkUpdateVendorsRequest'; -export { BulkUpdateVendorsResponse } from './models/bulkUpdateVendorsResponse'; -export { BulkUpsertBookingCustomAttributesRequest } from './models/bulkUpsertBookingCustomAttributesRequest'; -export { BulkUpsertBookingCustomAttributesResponse } from './models/bulkUpsertBookingCustomAttributesResponse'; -export { BulkUpsertCustomerCustomAttributesRequest } from './models/bulkUpsertCustomerCustomAttributesRequest'; -export { BulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest } from './models/bulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest'; -export { BulkUpsertCustomerCustomAttributesResponse } from './models/bulkUpsertCustomerCustomAttributesResponse'; -export { BulkUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse } from './models/bulkUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse'; -export { BulkUpsertLocationCustomAttributesRequest } from './models/bulkUpsertLocationCustomAttributesRequest'; -export { BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest } from './models/bulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest'; -export { BulkUpsertLocationCustomAttributesResponse } from './models/bulkUpsertLocationCustomAttributesResponse'; -export { BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse } from './models/bulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse'; -export { BulkUpsertOrderCustomAttributesRequest } from './models/bulkUpsertOrderCustomAttributesRequest'; -export { BulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute } from './models/bulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute'; -export { BulkUpsertOrderCustomAttributesResponse } from './models/bulkUpsertOrderCustomAttributesResponse'; -export { BusinessAppointmentSettings } from './models/businessAppointmentSettings'; -export { BusinessBookingProfile } from './models/businessBookingProfile'; -export { BusinessHours } from './models/businessHours'; -export { BusinessHoursPeriod } from './models/businessHoursPeriod'; -export { BuyNowPayLaterDetails } from './models/buyNowPayLaterDetails'; -export { CalculateLoyaltyPointsRequest } from './models/calculateLoyaltyPointsRequest'; -export { CalculateLoyaltyPointsResponse } from './models/calculateLoyaltyPointsResponse'; -export { CalculateOrderRequest } from './models/calculateOrderRequest'; -export { CalculateOrderResponse } from './models/calculateOrderResponse'; -export { CancelBookingRequest } from './models/cancelBookingRequest'; -export { CancelBookingResponse } from './models/cancelBookingResponse'; -export { CancelInvoiceRequest } from './models/cancelInvoiceRequest'; -export { CancelInvoiceResponse } from './models/cancelInvoiceResponse'; -export { CancelLoyaltyPromotionResponse } from './models/cancelLoyaltyPromotionResponse'; -export { CancelPaymentByIdempotencyKeyRequest } from './models/cancelPaymentByIdempotencyKeyRequest'; -export { CancelPaymentByIdempotencyKeyResponse } from './models/cancelPaymentByIdempotencyKeyResponse'; -export { CancelPaymentResponse } from './models/cancelPaymentResponse'; -export { CancelSubscriptionResponse } from './models/cancelSubscriptionResponse'; -export { CancelTerminalActionResponse } from './models/cancelTerminalActionResponse'; -export { CancelTerminalCheckoutResponse } from './models/cancelTerminalCheckoutResponse'; -export { CancelTerminalRefundResponse } from './models/cancelTerminalRefundResponse'; -export { CaptureTransactionResponse } from './models/captureTransactionResponse'; -export { Card } from './models/card'; -export { CardPaymentDetails } from './models/cardPaymentDetails'; -export { CardPaymentTimeline } from './models/cardPaymentTimeline'; -export { CashAppDetails } from './models/cashAppDetails'; -export { CashDrawerDevice } from './models/cashDrawerDevice'; -export { CashDrawerShift } from './models/cashDrawerShift'; -export { CashDrawerShiftEvent } from './models/cashDrawerShiftEvent'; -export { CashDrawerShiftSummary } from './models/cashDrawerShiftSummary'; -export { CashPaymentDetails } from './models/cashPaymentDetails'; -export { CatalogCategory } from './models/catalogCategory'; -export { CatalogCustomAttributeDefinition } from './models/catalogCustomAttributeDefinition'; -export { CatalogCustomAttributeDefinitionNumberConfig } from './models/catalogCustomAttributeDefinitionNumberConfig'; -export { CatalogCustomAttributeDefinitionSelectionConfig } from './models/catalogCustomAttributeDefinitionSelectionConfig'; -export { CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection } from './models/catalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection'; -export { CatalogCustomAttributeDefinitionStringConfig } from './models/catalogCustomAttributeDefinitionStringConfig'; -export { CatalogCustomAttributeValue } from './models/catalogCustomAttributeValue'; -export { CatalogDiscount } from './models/catalogDiscount'; -export { CatalogIdMapping } from './models/catalogIdMapping'; -export { CatalogImage } from './models/catalogImage'; -export { CatalogInfoResponse } from './models/catalogInfoResponse'; -export { CatalogInfoResponseLimits } from './models/catalogInfoResponseLimits'; -export { CatalogItem } from './models/catalogItem'; -export { CatalogItemModifierListInfo } from './models/catalogItemModifierListInfo'; -export { CatalogItemOption } from './models/catalogItemOption'; -export { CatalogItemOptionForItem } from './models/catalogItemOptionForItem'; -export { CatalogItemOptionValue } from './models/catalogItemOptionValue'; -export { CatalogItemOptionValueForItemVariation } from './models/catalogItemOptionValueForItemVariation'; -export { CatalogItemVariation } from './models/catalogItemVariation'; -export { CatalogMeasurementUnit } from './models/catalogMeasurementUnit'; -export { CatalogModifier } from './models/catalogModifier'; -export { CatalogModifierList } from './models/catalogModifierList'; -export { CatalogModifierOverride } from './models/catalogModifierOverride'; -export { CatalogObject } from './models/catalogObject'; -export { CatalogObjectBatch } from './models/catalogObjectBatch'; -export { CatalogObjectReference } from './models/catalogObjectReference'; -export { CatalogPricingRule } from './models/catalogPricingRule'; -export { CatalogProductSet } from './models/catalogProductSet'; -export { CatalogQuery } from './models/catalogQuery'; -export { CatalogQueryExact } from './models/catalogQueryExact'; -export { CatalogQueryItemsForItemOptions } from './models/catalogQueryItemsForItemOptions'; -export { CatalogQueryItemsForModifierList } from './models/catalogQueryItemsForModifierList'; -export { CatalogQueryItemsForTax } from './models/catalogQueryItemsForTax'; -export { CatalogQueryItemVariationsForItemOptionValues } from './models/catalogQueryItemVariationsForItemOptionValues'; -export { CatalogQueryPrefix } from './models/catalogQueryPrefix'; -export { CatalogQueryRange } from './models/catalogQueryRange'; -export { CatalogQuerySet } from './models/catalogQuerySet'; -export { CatalogQuerySortedAttribute } from './models/catalogQuerySortedAttribute'; -export { CatalogQueryText } from './models/catalogQueryText'; -export { CatalogQuickAmount } from './models/catalogQuickAmount'; -export { CatalogQuickAmountsSettings } from './models/catalogQuickAmountsSettings'; -export { CatalogStockConversion } from './models/catalogStockConversion'; -export { CatalogSubscriptionPlan } from './models/catalogSubscriptionPlan'; -export { CatalogTax } from './models/catalogTax'; -export { CatalogTimePeriod } from './models/catalogTimePeriod'; -export { CatalogV1Id } from './models/catalogV1Id'; -export { ChargeRequest } from './models/chargeRequest'; -export { ChargeRequestAdditionalRecipient } from './models/chargeRequestAdditionalRecipient'; -export { ChargeResponse } from './models/chargeResponse'; -export { Checkout } from './models/checkout'; -export { CheckoutOptions } from './models/checkoutOptions'; -export { ClearpayDetails } from './models/clearpayDetails'; -export { CloneOrderRequest } from './models/cloneOrderRequest'; -export { CloneOrderResponse } from './models/cloneOrderResponse'; -export { CompletePaymentRequest } from './models/completePaymentRequest'; -export { CompletePaymentResponse } from './models/completePaymentResponse'; -export { Coordinates } from './models/coordinates'; -export { CreateBookingCustomAttributeDefinitionRequest } from './models/createBookingCustomAttributeDefinitionRequest'; -export { CreateBookingCustomAttributeDefinitionResponse } from './models/createBookingCustomAttributeDefinitionResponse'; -export { CreateBookingRequest } from './models/createBookingRequest'; -export { CreateBookingResponse } from './models/createBookingResponse'; -export { CreateBreakTypeRequest } from './models/createBreakTypeRequest'; -export { CreateBreakTypeResponse } from './models/createBreakTypeResponse'; -export { CreateCardRequest } from './models/createCardRequest'; -export { CreateCardResponse } from './models/createCardResponse'; -export { CreateCatalogImageRequest } from './models/createCatalogImageRequest'; -export { CreateCatalogImageResponse } from './models/createCatalogImageResponse'; -export { CreateCheckoutRequest } from './models/createCheckoutRequest'; -export { CreateCheckoutResponse } from './models/createCheckoutResponse'; -export { CreateCustomerCardRequest } from './models/createCustomerCardRequest'; -export { CreateCustomerCardResponse } from './models/createCustomerCardResponse'; -export { CreateCustomerCustomAttributeDefinitionRequest } from './models/createCustomerCustomAttributeDefinitionRequest'; -export { CreateCustomerCustomAttributeDefinitionResponse } from './models/createCustomerCustomAttributeDefinitionResponse'; -export { CreateCustomerGroupRequest } from './models/createCustomerGroupRequest'; -export { CreateCustomerGroupResponse } from './models/createCustomerGroupResponse'; -export { CreateCustomerRequest } from './models/createCustomerRequest'; -export { CreateCustomerResponse } from './models/createCustomerResponse'; -export { CreateDeviceCodeRequest } from './models/createDeviceCodeRequest'; -export { CreateDeviceCodeResponse } from './models/createDeviceCodeResponse'; -export { CreateDisputeEvidenceFileRequest } from './models/createDisputeEvidenceFileRequest'; -export { CreateDisputeEvidenceFileResponse } from './models/createDisputeEvidenceFileResponse'; -export { CreateDisputeEvidenceTextRequest } from './models/createDisputeEvidenceTextRequest'; -export { CreateDisputeEvidenceTextResponse } from './models/createDisputeEvidenceTextResponse'; -export { CreateGiftCardActivityRequest } from './models/createGiftCardActivityRequest'; -export { CreateGiftCardActivityResponse } from './models/createGiftCardActivityResponse'; -export { CreateGiftCardRequest } from './models/createGiftCardRequest'; -export { CreateGiftCardResponse } from './models/createGiftCardResponse'; -export { CreateInvoiceRequest } from './models/createInvoiceRequest'; -export { CreateInvoiceResponse } from './models/createInvoiceResponse'; -export { CreateLocationCustomAttributeDefinitionRequest } from './models/createLocationCustomAttributeDefinitionRequest'; -export { CreateLocationCustomAttributeDefinitionResponse } from './models/createLocationCustomAttributeDefinitionResponse'; -export { CreateLocationRequest } from './models/createLocationRequest'; -export { CreateLocationResponse } from './models/createLocationResponse'; -export { CreateLoyaltyAccountRequest } from './models/createLoyaltyAccountRequest'; -export { CreateLoyaltyAccountResponse } from './models/createLoyaltyAccountResponse'; -export { CreateLoyaltyPromotionRequest } from './models/createLoyaltyPromotionRequest'; -export { CreateLoyaltyPromotionResponse } from './models/createLoyaltyPromotionResponse'; -export { CreateLoyaltyRewardRequest } from './models/createLoyaltyRewardRequest'; -export { CreateLoyaltyRewardResponse } from './models/createLoyaltyRewardResponse'; -export { CreateMobileAuthorizationCodeRequest } from './models/createMobileAuthorizationCodeRequest'; -export { CreateMobileAuthorizationCodeResponse } from './models/createMobileAuthorizationCodeResponse'; -export { CreateOrderCustomAttributeDefinitionRequest } from './models/createOrderCustomAttributeDefinitionRequest'; -export { CreateOrderCustomAttributeDefinitionResponse } from './models/createOrderCustomAttributeDefinitionResponse'; -export { CreateOrderRequest } from './models/createOrderRequest'; -export { CreateOrderResponse } from './models/createOrderResponse'; -export { CreatePaymentLinkRequest } from './models/createPaymentLinkRequest'; -export { CreatePaymentLinkResponse } from './models/createPaymentLinkResponse'; -export { CreatePaymentRequest } from './models/createPaymentRequest'; -export { CreatePaymentResponse } from './models/createPaymentResponse'; -export { CreateRefundRequest } from './models/createRefundRequest'; -export { CreateRefundResponse } from './models/createRefundResponse'; -export { CreateShiftRequest } from './models/createShiftRequest'; -export { CreateShiftResponse } from './models/createShiftResponse'; -export { CreateSubscriptionRequest } from './models/createSubscriptionRequest'; -export { CreateSubscriptionResponse } from './models/createSubscriptionResponse'; -export { CreateTeamMemberRequest } from './models/createTeamMemberRequest'; -export { CreateTeamMemberResponse } from './models/createTeamMemberResponse'; -export { CreateTerminalActionRequest } from './models/createTerminalActionRequest'; -export { CreateTerminalActionResponse } from './models/createTerminalActionResponse'; -export { CreateTerminalCheckoutRequest } from './models/createTerminalCheckoutRequest'; -export { CreateTerminalCheckoutResponse } from './models/createTerminalCheckoutResponse'; -export { CreateTerminalRefundRequest } from './models/createTerminalRefundRequest'; -export { CreateTerminalRefundResponse } from './models/createTerminalRefundResponse'; -export { CreateVendorRequest } from './models/createVendorRequest'; -export { CreateVendorResponse } from './models/createVendorResponse'; -export { CreateWebhookSubscriptionRequest } from './models/createWebhookSubscriptionRequest'; -export { CreateWebhookSubscriptionResponse } from './models/createWebhookSubscriptionResponse'; -export { CustomAttribute } from './models/customAttribute'; -export { CustomAttributeDefinition } from './models/customAttributeDefinition'; -export { CustomAttributeFilter } from './models/customAttributeFilter'; -export { Customer } from './models/customer'; -export { CustomerAddressFilter } from './models/customerAddressFilter'; -export { CustomerCreationSourceFilter } from './models/customerCreationSourceFilter'; -export { CustomerCustomAttributeFilter } from './models/customerCustomAttributeFilter'; -export { CustomerCustomAttributeFilters } from './models/customerCustomAttributeFilters'; -export { CustomerCustomAttributeFilterValue } from './models/customerCustomAttributeFilterValue'; -export { CustomerFilter } from './models/customerFilter'; -export { CustomerGroup } from './models/customerGroup'; -export { CustomerPreferences } from './models/customerPreferences'; -export { CustomerQuery } from './models/customerQuery'; -export { CustomerSegment } from './models/customerSegment'; -export { CustomerSort } from './models/customerSort'; -export { CustomerTaxIds } from './models/customerTaxIds'; -export { CustomerTextFilter } from './models/customerTextFilter'; -export { CustomField } from './models/customField'; -export { DateRange } from './models/dateRange'; -export { DeleteBookingCustomAttributeDefinitionResponse } from './models/deleteBookingCustomAttributeDefinitionResponse'; -export { DeleteBookingCustomAttributeResponse } from './models/deleteBookingCustomAttributeResponse'; -export { DeleteBreakTypeResponse } from './models/deleteBreakTypeResponse'; -export { DeleteCatalogObjectResponse } from './models/deleteCatalogObjectResponse'; -export { DeleteCustomerCardResponse } from './models/deleteCustomerCardResponse'; -export { DeleteCustomerCustomAttributeDefinitionResponse } from './models/deleteCustomerCustomAttributeDefinitionResponse'; -export { DeleteCustomerCustomAttributeResponse } from './models/deleteCustomerCustomAttributeResponse'; -export { DeleteCustomerGroupResponse } from './models/deleteCustomerGroupResponse'; -export { DeleteCustomerRequest } from './models/deleteCustomerRequest'; -export { DeleteCustomerResponse } from './models/deleteCustomerResponse'; -export { DeleteDisputeEvidenceResponse } from './models/deleteDisputeEvidenceResponse'; -export { DeleteInvoiceRequest } from './models/deleteInvoiceRequest'; -export { DeleteInvoiceResponse } from './models/deleteInvoiceResponse'; -export { DeleteLocationCustomAttributeDefinitionResponse } from './models/deleteLocationCustomAttributeDefinitionResponse'; -export { DeleteLocationCustomAttributeResponse } from './models/deleteLocationCustomAttributeResponse'; -export { DeleteLoyaltyRewardResponse } from './models/deleteLoyaltyRewardResponse'; -export { DeleteOrderCustomAttributeDefinitionResponse } from './models/deleteOrderCustomAttributeDefinitionResponse'; -export { DeleteOrderCustomAttributeResponse } from './models/deleteOrderCustomAttributeResponse'; -export { DeletePaymentLinkResponse } from './models/deletePaymentLinkResponse'; -export { DeleteShiftResponse } from './models/deleteShiftResponse'; -export { DeleteSnippetResponse } from './models/deleteSnippetResponse'; -export { DeleteSubscriptionActionResponse } from './models/deleteSubscriptionActionResponse'; -export { DeleteWebhookSubscriptionResponse } from './models/deleteWebhookSubscriptionResponse'; -export { DeprecatedCreateDisputeEvidenceFileRequest } from './models/deprecatedCreateDisputeEvidenceFileRequest'; -export { DeprecatedCreateDisputeEvidenceFileResponse } from './models/deprecatedCreateDisputeEvidenceFileResponse'; -export { DeprecatedCreateDisputeEvidenceTextRequest } from './models/deprecatedCreateDisputeEvidenceTextRequest'; -export { DeprecatedCreateDisputeEvidenceTextResponse } from './models/deprecatedCreateDisputeEvidenceTextResponse'; -export { Destination } from './models/destination'; -export { DestinationDetails } from './models/destinationDetails'; -export { DestinationDetailsCardRefundDetails } from './models/destinationDetailsCardRefundDetails'; -export { Device } from './models/device'; -export { DeviceCheckoutOptions } from './models/deviceCheckoutOptions'; -export { DeviceCode } from './models/deviceCode'; -export { DeviceDetails } from './models/deviceDetails'; -export { DeviceMetadata } from './models/deviceMetadata'; -export { DigitalWalletDetails } from './models/digitalWalletDetails'; -export { DisableCardResponse } from './models/disableCardResponse'; -export { Dispute } from './models/dispute'; -export { DisputedPayment } from './models/disputedPayment'; -export { DisputeEvidence } from './models/disputeEvidence'; -export { DisputeEvidenceFile } from './models/disputeEvidenceFile'; -export { Employee } from './models/employee'; -export { EmployeeWage } from './models/employeeWage'; -export { Error } from './models/error'; -export { EventTypeMetadata } from './models/eventTypeMetadata'; -export { ExternalPaymentDetails } from './models/externalPaymentDetails'; -export { FilterValue } from './models/filterValue'; -export { FloatNumberRange } from './models/floatNumberRange'; -export { Fulfillment } from './models/fulfillment'; -export { FulfillmentDeliveryDetails } from './models/fulfillmentDeliveryDetails'; -export { FulfillmentFulfillmentEntry } from './models/fulfillmentFulfillmentEntry'; -export { FulfillmentPickupDetails } from './models/fulfillmentPickupDetails'; -export { FulfillmentPickupDetailsCurbsidePickupDetails } from './models/fulfillmentPickupDetailsCurbsidePickupDetails'; -export { FulfillmentRecipient } from './models/fulfillmentRecipient'; -export { FulfillmentShipmentDetails } from './models/fulfillmentShipmentDetails'; -export { GetBankAccountByV1IdResponse } from './models/getBankAccountByV1IdResponse'; -export { GetBankAccountResponse } from './models/getBankAccountResponse'; -export { GetBreakTypeResponse } from './models/getBreakTypeResponse'; -export { GetDeviceCodeResponse } from './models/getDeviceCodeResponse'; -export { GetEmployeeWageResponse } from './models/getEmployeeWageResponse'; -export { GetInvoiceResponse } from './models/getInvoiceResponse'; -export { GetPaymentRefundResponse } from './models/getPaymentRefundResponse'; -export { GetPaymentResponse } from './models/getPaymentResponse'; -export { GetPayoutResponse } from './models/getPayoutResponse'; -export { GetShiftResponse } from './models/getShiftResponse'; -export { GetTeamMemberWageResponse } from './models/getTeamMemberWageResponse'; -export { GetTerminalActionResponse } from './models/getTerminalActionResponse'; -export { GetTerminalCheckoutResponse } from './models/getTerminalCheckoutResponse'; -export { GetTerminalRefundResponse } from './models/getTerminalRefundResponse'; -export { GiftCard } from './models/giftCard'; -export { GiftCardActivity } from './models/giftCardActivity'; -export { GiftCardActivityActivate } from './models/giftCardActivityActivate'; -export { GiftCardActivityAdjustDecrement } from './models/giftCardActivityAdjustDecrement'; -export { GiftCardActivityAdjustIncrement } from './models/giftCardActivityAdjustIncrement'; -export { GiftCardActivityBlock } from './models/giftCardActivityBlock'; -export { GiftCardActivityClearBalance } from './models/giftCardActivityClearBalance'; -export { GiftCardActivityDeactivate } from './models/giftCardActivityDeactivate'; -export { GiftCardActivityImport } from './models/giftCardActivityImport'; -export { GiftCardActivityImportReversal } from './models/giftCardActivityImportReversal'; -export { GiftCardActivityLoad } from './models/giftCardActivityLoad'; -export { GiftCardActivityRedeem } from './models/giftCardActivityRedeem'; -export { GiftCardActivityRefund } from './models/giftCardActivityRefund'; -export { GiftCardActivityTransferBalanceFrom } from './models/giftCardActivityTransferBalanceFrom'; -export { GiftCardActivityTransferBalanceTo } from './models/giftCardActivityTransferBalanceTo'; -export { GiftCardActivityUnblock } from './models/giftCardActivityUnblock'; -export { GiftCardActivityUnlinkedActivityRefund } from './models/giftCardActivityUnlinkedActivityRefund'; -export { InventoryAdjustment } from './models/inventoryAdjustment'; -export { InventoryAdjustmentGroup } from './models/inventoryAdjustmentGroup'; -export { InventoryChange } from './models/inventoryChange'; -export { InventoryCount } from './models/inventoryCount'; -export { InventoryPhysicalCount } from './models/inventoryPhysicalCount'; -export { InventoryTransfer } from './models/inventoryTransfer'; -export { Invoice } from './models/invoice'; -export { InvoiceAcceptedPaymentMethods } from './models/invoiceAcceptedPaymentMethods'; -export { InvoiceCustomField } from './models/invoiceCustomField'; -export { InvoiceFilter } from './models/invoiceFilter'; -export { InvoicePaymentReminder } from './models/invoicePaymentReminder'; -export { InvoicePaymentRequest } from './models/invoicePaymentRequest'; -export { InvoiceQuery } from './models/invoiceQuery'; -export { InvoiceRecipient } from './models/invoiceRecipient'; -export { InvoiceRecipientTaxIds } from './models/invoiceRecipientTaxIds'; -export { InvoiceSort } from './models/invoiceSort'; -export { ItemVariationLocationOverrides } from './models/itemVariationLocationOverrides'; -export { JobAssignment } from './models/jobAssignment'; -export { LinkCustomerToGiftCardRequest } from './models/linkCustomerToGiftCardRequest'; -export { LinkCustomerToGiftCardResponse } from './models/linkCustomerToGiftCardResponse'; -export { ListBankAccountsRequest } from './models/listBankAccountsRequest'; -export { ListBankAccountsResponse } from './models/listBankAccountsResponse'; -export { ListBookingCustomAttributeDefinitionsRequest } from './models/listBookingCustomAttributeDefinitionsRequest'; -export { ListBookingCustomAttributeDefinitionsResponse } from './models/listBookingCustomAttributeDefinitionsResponse'; -export { ListBookingCustomAttributesRequest } from './models/listBookingCustomAttributesRequest'; -export { ListBookingCustomAttributesResponse } from './models/listBookingCustomAttributesResponse'; -export { ListBookingsRequest } from './models/listBookingsRequest'; -export { ListBookingsResponse } from './models/listBookingsResponse'; -export { ListBreakTypesRequest } from './models/listBreakTypesRequest'; -export { ListBreakTypesResponse } from './models/listBreakTypesResponse'; -export { ListCardsRequest } from './models/listCardsRequest'; -export { ListCardsResponse } from './models/listCardsResponse'; -export { ListCashDrawerShiftEventsRequest } from './models/listCashDrawerShiftEventsRequest'; -export { ListCashDrawerShiftEventsResponse } from './models/listCashDrawerShiftEventsResponse'; -export { ListCashDrawerShiftsRequest } from './models/listCashDrawerShiftsRequest'; -export { ListCashDrawerShiftsResponse } from './models/listCashDrawerShiftsResponse'; -export { ListCatalogRequest } from './models/listCatalogRequest'; -export { ListCatalogResponse } from './models/listCatalogResponse'; -export { ListCustomerCustomAttributeDefinitionsRequest } from './models/listCustomerCustomAttributeDefinitionsRequest'; -export { ListCustomerCustomAttributeDefinitionsResponse } from './models/listCustomerCustomAttributeDefinitionsResponse'; -export { ListCustomerCustomAttributesRequest } from './models/listCustomerCustomAttributesRequest'; -export { ListCustomerCustomAttributesResponse } from './models/listCustomerCustomAttributesResponse'; -export { ListCustomerGroupsRequest } from './models/listCustomerGroupsRequest'; -export { ListCustomerGroupsResponse } from './models/listCustomerGroupsResponse'; -export { ListCustomerSegmentsRequest } from './models/listCustomerSegmentsRequest'; -export { ListCustomerSegmentsResponse } from './models/listCustomerSegmentsResponse'; -export { ListCustomersRequest } from './models/listCustomersRequest'; -export { ListCustomersResponse } from './models/listCustomersResponse'; -export { ListDeviceCodesRequest } from './models/listDeviceCodesRequest'; -export { ListDeviceCodesResponse } from './models/listDeviceCodesResponse'; -export { ListDisputeEvidenceRequest } from './models/listDisputeEvidenceRequest'; -export { ListDisputeEvidenceResponse } from './models/listDisputeEvidenceResponse'; -export { ListDisputesRequest } from './models/listDisputesRequest'; -export { ListDisputesResponse } from './models/listDisputesResponse'; -export { ListEmployeesRequest } from './models/listEmployeesRequest'; -export { ListEmployeesResponse } from './models/listEmployeesResponse'; -export { ListEmployeeWagesRequest } from './models/listEmployeeWagesRequest'; -export { ListEmployeeWagesResponse } from './models/listEmployeeWagesResponse'; -export { ListGiftCardActivitiesRequest } from './models/listGiftCardActivitiesRequest'; -export { ListGiftCardActivitiesResponse } from './models/listGiftCardActivitiesResponse'; -export { ListGiftCardsRequest } from './models/listGiftCardsRequest'; -export { ListGiftCardsResponse } from './models/listGiftCardsResponse'; -export { ListInvoicesRequest } from './models/listInvoicesRequest'; -export { ListInvoicesResponse } from './models/listInvoicesResponse'; -export { ListLocationCustomAttributeDefinitionsRequest } from './models/listLocationCustomAttributeDefinitionsRequest'; -export { ListLocationCustomAttributeDefinitionsResponse } from './models/listLocationCustomAttributeDefinitionsResponse'; -export { ListLocationCustomAttributesRequest } from './models/listLocationCustomAttributesRequest'; -export { ListLocationCustomAttributesResponse } from './models/listLocationCustomAttributesResponse'; -export { ListLocationsResponse } from './models/listLocationsResponse'; -export { ListLoyaltyProgramsResponse } from './models/listLoyaltyProgramsResponse'; -export { ListLoyaltyPromotionsRequest } from './models/listLoyaltyPromotionsRequest'; -export { ListLoyaltyPromotionsResponse } from './models/listLoyaltyPromotionsResponse'; -export { ListMerchantsRequest } from './models/listMerchantsRequest'; -export { ListMerchantsResponse } from './models/listMerchantsResponse'; -export { ListOrderCustomAttributeDefinitionsRequest } from './models/listOrderCustomAttributeDefinitionsRequest'; -export { ListOrderCustomAttributeDefinitionsResponse } from './models/listOrderCustomAttributeDefinitionsResponse'; -export { ListOrderCustomAttributesRequest } from './models/listOrderCustomAttributesRequest'; -export { ListOrderCustomAttributesResponse } from './models/listOrderCustomAttributesResponse'; -export { ListPaymentLinksRequest } from './models/listPaymentLinksRequest'; -export { ListPaymentLinksResponse } from './models/listPaymentLinksResponse'; -export { ListPaymentRefundsRequest } from './models/listPaymentRefundsRequest'; -export { ListPaymentRefundsResponse } from './models/listPaymentRefundsResponse'; -export { ListPaymentsRequest } from './models/listPaymentsRequest'; -export { ListPaymentsResponse } from './models/listPaymentsResponse'; -export { ListPayoutEntriesRequest } from './models/listPayoutEntriesRequest'; -export { ListPayoutEntriesResponse } from './models/listPayoutEntriesResponse'; -export { ListPayoutsRequest } from './models/listPayoutsRequest'; -export { ListPayoutsResponse } from './models/listPayoutsResponse'; -export { ListRefundsRequest } from './models/listRefundsRequest'; -export { ListRefundsResponse } from './models/listRefundsResponse'; -export { ListSitesResponse } from './models/listSitesResponse'; -export { ListSubscriptionEventsRequest } from './models/listSubscriptionEventsRequest'; -export { ListSubscriptionEventsResponse } from './models/listSubscriptionEventsResponse'; -export { ListTeamMemberBookingProfilesRequest } from './models/listTeamMemberBookingProfilesRequest'; -export { ListTeamMemberBookingProfilesResponse } from './models/listTeamMemberBookingProfilesResponse'; -export { ListTeamMemberWagesRequest } from './models/listTeamMemberWagesRequest'; -export { ListTeamMemberWagesResponse } from './models/listTeamMemberWagesResponse'; -export { ListTransactionsRequest } from './models/listTransactionsRequest'; -export { ListTransactionsResponse } from './models/listTransactionsResponse'; -export { ListWebhookEventTypesRequest } from './models/listWebhookEventTypesRequest'; -export { ListWebhookEventTypesResponse } from './models/listWebhookEventTypesResponse'; -export { ListWebhookSubscriptionsRequest } from './models/listWebhookSubscriptionsRequest'; -export { ListWebhookSubscriptionsResponse } from './models/listWebhookSubscriptionsResponse'; -export { ListWorkweekConfigsRequest } from './models/listWorkweekConfigsRequest'; -export { ListWorkweekConfigsResponse } from './models/listWorkweekConfigsResponse'; -export { Location } from './models/location'; -export { LoyaltyAccount } from './models/loyaltyAccount'; -export { LoyaltyAccountExpiringPointDeadline } from './models/loyaltyAccountExpiringPointDeadline'; -export { LoyaltyAccountMapping } from './models/loyaltyAccountMapping'; -export { LoyaltyEvent } from './models/loyaltyEvent'; -export { LoyaltyEventAccumulatePoints } from './models/loyaltyEventAccumulatePoints'; -export { LoyaltyEventAccumulatePromotionPoints } from './models/loyaltyEventAccumulatePromotionPoints'; -export { LoyaltyEventAdjustPoints } from './models/loyaltyEventAdjustPoints'; -export { LoyaltyEventCreateReward } from './models/loyaltyEventCreateReward'; -export { LoyaltyEventDateTimeFilter } from './models/loyaltyEventDateTimeFilter'; -export { LoyaltyEventDeleteReward } from './models/loyaltyEventDeleteReward'; -export { LoyaltyEventExpirePoints } from './models/loyaltyEventExpirePoints'; -export { LoyaltyEventFilter } from './models/loyaltyEventFilter'; -export { LoyaltyEventLocationFilter } from './models/loyaltyEventLocationFilter'; -export { LoyaltyEventLoyaltyAccountFilter } from './models/loyaltyEventLoyaltyAccountFilter'; -export { LoyaltyEventOrderFilter } from './models/loyaltyEventOrderFilter'; -export { LoyaltyEventOther } from './models/loyaltyEventOther'; -export { LoyaltyEventQuery } from './models/loyaltyEventQuery'; -export { LoyaltyEventRedeemReward } from './models/loyaltyEventRedeemReward'; -export { LoyaltyEventTypeFilter } from './models/loyaltyEventTypeFilter'; -export { LoyaltyProgram } from './models/loyaltyProgram'; -export { LoyaltyProgramAccrualRule } from './models/loyaltyProgramAccrualRule'; -export { LoyaltyProgramAccrualRuleCategoryData } from './models/loyaltyProgramAccrualRuleCategoryData'; -export { LoyaltyProgramAccrualRuleItemVariationData } from './models/loyaltyProgramAccrualRuleItemVariationData'; -export { LoyaltyProgramAccrualRuleSpendData } from './models/loyaltyProgramAccrualRuleSpendData'; -export { LoyaltyProgramAccrualRuleVisitData } from './models/loyaltyProgramAccrualRuleVisitData'; -export { LoyaltyProgramExpirationPolicy } from './models/loyaltyProgramExpirationPolicy'; -export { LoyaltyProgramRewardDefinition } from './models/loyaltyProgramRewardDefinition'; -export { LoyaltyProgramRewardTier } from './models/loyaltyProgramRewardTier'; -export { LoyaltyProgramTerminology } from './models/loyaltyProgramTerminology'; -export { LoyaltyPromotion } from './models/loyaltyPromotion'; -export { LoyaltyPromotionAvailableTimeData } from './models/loyaltyPromotionAvailableTimeData'; -export { LoyaltyPromotionIncentive } from './models/loyaltyPromotionIncentive'; -export { LoyaltyPromotionIncentivePointsAdditionData } from './models/loyaltyPromotionIncentivePointsAdditionData'; -export { LoyaltyPromotionIncentivePointsMultiplierData } from './models/loyaltyPromotionIncentivePointsMultiplierData'; -export { LoyaltyPromotionTriggerLimit } from './models/loyaltyPromotionTriggerLimit'; -export { LoyaltyReward } from './models/loyaltyReward'; -export { MeasurementUnit } from './models/measurementUnit'; -export { MeasurementUnitCustom } from './models/measurementUnitCustom'; -export { Merchant } from './models/merchant'; -export { Money } from './models/money'; -export { ObtainTokenRequest } from './models/obtainTokenRequest'; -export { ObtainTokenResponse } from './models/obtainTokenResponse'; -export { Order } from './models/order'; -export { OrderCreated } from './models/orderCreated'; -export { OrderCreatedObject } from './models/orderCreatedObject'; -export { OrderEntry } from './models/orderEntry'; -export { OrderFulfillment } from './models/orderFulfillment'; -export { OrderFulfillmentDeliveryDetails } from './models/orderFulfillmentDeliveryDetails'; -export { OrderFulfillmentFulfillmentEntry } from './models/orderFulfillmentFulfillmentEntry'; -export { OrderFulfillmentPickupDetails } from './models/orderFulfillmentPickupDetails'; -export { OrderFulfillmentPickupDetailsCurbsidePickupDetails } from './models/orderFulfillmentPickupDetailsCurbsidePickupDetails'; -export { OrderFulfillmentRecipient } from './models/orderFulfillmentRecipient'; -export { OrderFulfillmentShipmentDetails } from './models/orderFulfillmentShipmentDetails'; -export { OrderFulfillmentUpdated } from './models/orderFulfillmentUpdated'; -export { OrderFulfillmentUpdatedObject } from './models/orderFulfillmentUpdatedObject'; -export { OrderFulfillmentUpdatedUpdate } from './models/orderFulfillmentUpdatedUpdate'; -export { OrderLineItem } from './models/orderLineItem'; -export { OrderLineItemAppliedDiscount } from './models/orderLineItemAppliedDiscount'; -export { OrderLineItemAppliedTax } from './models/orderLineItemAppliedTax'; -export { OrderLineItemDiscount } from './models/orderLineItemDiscount'; -export { OrderLineItemModifier } from './models/orderLineItemModifier'; -export { OrderLineItemPricingBlocklists } from './models/orderLineItemPricingBlocklists'; -export { OrderLineItemPricingBlocklistsBlockedDiscount } from './models/orderLineItemPricingBlocklistsBlockedDiscount'; -export { OrderLineItemPricingBlocklistsBlockedTax } from './models/orderLineItemPricingBlocklistsBlockedTax'; -export { OrderLineItemTax } from './models/orderLineItemTax'; -export { OrderMoneyAmounts } from './models/orderMoneyAmounts'; -export { OrderPricingOptions } from './models/orderPricingOptions'; -export { OrderQuantityUnit } from './models/orderQuantityUnit'; -export { OrderReturn } from './models/orderReturn'; -export { OrderReturnDiscount } from './models/orderReturnDiscount'; -export { OrderReturnLineItem } from './models/orderReturnLineItem'; -export { OrderReturnLineItemModifier } from './models/orderReturnLineItemModifier'; -export { OrderReturnServiceCharge } from './models/orderReturnServiceCharge'; -export { OrderReturnTax } from './models/orderReturnTax'; -export { OrderReward } from './models/orderReward'; -export { OrderRoundingAdjustment } from './models/orderRoundingAdjustment'; -export { OrderServiceCharge } from './models/orderServiceCharge'; -export { OrderSource } from './models/orderSource'; -export { OrderUpdated } from './models/orderUpdated'; -export { OrderUpdatedObject } from './models/orderUpdatedObject'; -export { PauseSubscriptionRequest } from './models/pauseSubscriptionRequest'; -export { PauseSubscriptionResponse } from './models/pauseSubscriptionResponse'; -export { Payment } from './models/payment'; -export { PaymentBalanceActivityAppFeeRefundDetail } from './models/paymentBalanceActivityAppFeeRefundDetail'; -export { PaymentBalanceActivityAppFeeRevenueDetail } from './models/paymentBalanceActivityAppFeeRevenueDetail'; -export { PaymentBalanceActivityAutomaticSavingsDetail } from './models/paymentBalanceActivityAutomaticSavingsDetail'; -export { PaymentBalanceActivityAutomaticSavingsReversedDetail } from './models/paymentBalanceActivityAutomaticSavingsReversedDetail'; -export { PaymentBalanceActivityChargeDetail } from './models/paymentBalanceActivityChargeDetail'; -export { PaymentBalanceActivityDepositFeeDetail } from './models/paymentBalanceActivityDepositFeeDetail'; -export { PaymentBalanceActivityDisputeDetail } from './models/paymentBalanceActivityDisputeDetail'; -export { PaymentBalanceActivityFeeDetail } from './models/paymentBalanceActivityFeeDetail'; -export { PaymentBalanceActivityFreeProcessingDetail } from './models/paymentBalanceActivityFreeProcessingDetail'; -export { PaymentBalanceActivityHoldAdjustmentDetail } from './models/paymentBalanceActivityHoldAdjustmentDetail'; -export { PaymentBalanceActivityOpenDisputeDetail } from './models/paymentBalanceActivityOpenDisputeDetail'; -export { PaymentBalanceActivityOtherAdjustmentDetail } from './models/paymentBalanceActivityOtherAdjustmentDetail'; -export { PaymentBalanceActivityOtherDetail } from './models/paymentBalanceActivityOtherDetail'; -export { PaymentBalanceActivityRefundDetail } from './models/paymentBalanceActivityRefundDetail'; -export { PaymentBalanceActivityReleaseAdjustmentDetail } from './models/paymentBalanceActivityReleaseAdjustmentDetail'; -export { PaymentBalanceActivityReserveHoldDetail } from './models/paymentBalanceActivityReserveHoldDetail'; -export { PaymentBalanceActivityReserveReleaseDetail } from './models/paymentBalanceActivityReserveReleaseDetail'; -export { PaymentBalanceActivitySquareCapitalPaymentDetail } from './models/paymentBalanceActivitySquareCapitalPaymentDetail'; -export { PaymentBalanceActivitySquareCapitalReversedPaymentDetail } from './models/paymentBalanceActivitySquareCapitalReversedPaymentDetail'; -export { PaymentBalanceActivityTaxOnFeeDetail } from './models/paymentBalanceActivityTaxOnFeeDetail'; -export { PaymentBalanceActivityThirdPartyFeeDetail } from './models/paymentBalanceActivityThirdPartyFeeDetail'; -export { PaymentBalanceActivityThirdPartyFeeRefundDetail } from './models/paymentBalanceActivityThirdPartyFeeRefundDetail'; -export { PaymentLink } from './models/paymentLink'; -export { PaymentLinkRelatedResources } from './models/paymentLinkRelatedResources'; -export { PaymentOptions } from './models/paymentOptions'; -export { PaymentRefund } from './models/paymentRefund'; -export { PayOrderRequest } from './models/payOrderRequest'; -export { PayOrderResponse } from './models/payOrderResponse'; -export { Payout } from './models/payout'; -export { PayoutEntry } from './models/payoutEntry'; -export { PayoutFee } from './models/payoutFee'; -export { PrePopulatedData } from './models/prePopulatedData'; -export { ProcessingFee } from './models/processingFee'; -export { PublishInvoiceRequest } from './models/publishInvoiceRequest'; -export { PublishInvoiceResponse } from './models/publishInvoiceResponse'; -export { QuantityRatio } from './models/quantityRatio'; -export { QuickPay } from './models/quickPay'; -export { Range } from './models/range'; -export { ReceiptOptions } from './models/receiptOptions'; -export { RedeemLoyaltyRewardRequest } from './models/redeemLoyaltyRewardRequest'; -export { RedeemLoyaltyRewardResponse } from './models/redeemLoyaltyRewardResponse'; -export { Refund } from './models/refund'; -export { RefundPaymentRequest } from './models/refundPaymentRequest'; -export { RefundPaymentResponse } from './models/refundPaymentResponse'; -export { RegisterDomainRequest } from './models/registerDomainRequest'; -export { RegisterDomainResponse } from './models/registerDomainResponse'; -export { RemoveGroupFromCustomerResponse } from './models/removeGroupFromCustomerResponse'; -export { RenewTokenRequest } from './models/renewTokenRequest'; -export { RenewTokenResponse } from './models/renewTokenResponse'; -export { ResumeSubscriptionRequest } from './models/resumeSubscriptionRequest'; -export { ResumeSubscriptionResponse } from './models/resumeSubscriptionResponse'; -export { RetrieveBookingCustomAttributeDefinitionRequest } from './models/retrieveBookingCustomAttributeDefinitionRequest'; -export { RetrieveBookingCustomAttributeDefinitionResponse } from './models/retrieveBookingCustomAttributeDefinitionResponse'; -export { RetrieveBookingCustomAttributeRequest } from './models/retrieveBookingCustomAttributeRequest'; -export { RetrieveBookingCustomAttributeResponse } from './models/retrieveBookingCustomAttributeResponse'; -export { RetrieveBookingResponse } from './models/retrieveBookingResponse'; -export { RetrieveBusinessBookingProfileResponse } from './models/retrieveBusinessBookingProfileResponse'; -export { RetrieveCardResponse } from './models/retrieveCardResponse'; -export { RetrieveCashDrawerShiftRequest } from './models/retrieveCashDrawerShiftRequest'; -export { RetrieveCashDrawerShiftResponse } from './models/retrieveCashDrawerShiftResponse'; -export { RetrieveCatalogObjectRequest } from './models/retrieveCatalogObjectRequest'; -export { RetrieveCatalogObjectResponse } from './models/retrieveCatalogObjectResponse'; -export { RetrieveCustomerCustomAttributeDefinitionRequest } from './models/retrieveCustomerCustomAttributeDefinitionRequest'; -export { RetrieveCustomerCustomAttributeDefinitionResponse } from './models/retrieveCustomerCustomAttributeDefinitionResponse'; -export { RetrieveCustomerCustomAttributeRequest } from './models/retrieveCustomerCustomAttributeRequest'; -export { RetrieveCustomerCustomAttributeResponse } from './models/retrieveCustomerCustomAttributeResponse'; -export { RetrieveCustomerGroupResponse } from './models/retrieveCustomerGroupResponse'; -export { RetrieveCustomerResponse } from './models/retrieveCustomerResponse'; -export { RetrieveCustomerSegmentResponse } from './models/retrieveCustomerSegmentResponse'; -export { RetrieveDisputeEvidenceResponse } from './models/retrieveDisputeEvidenceResponse'; -export { RetrieveDisputeResponse } from './models/retrieveDisputeResponse'; -export { RetrieveEmployeeResponse } from './models/retrieveEmployeeResponse'; -export { RetrieveGiftCardFromGANRequest } from './models/retrieveGiftCardFromGANRequest'; -export { RetrieveGiftCardFromGANResponse } from './models/retrieveGiftCardFromGANResponse'; -export { RetrieveGiftCardFromNonceRequest } from './models/retrieveGiftCardFromNonceRequest'; -export { RetrieveGiftCardFromNonceResponse } from './models/retrieveGiftCardFromNonceResponse'; -export { RetrieveGiftCardResponse } from './models/retrieveGiftCardResponse'; -export { RetrieveInventoryAdjustmentResponse } from './models/retrieveInventoryAdjustmentResponse'; -export { RetrieveInventoryChangesRequest } from './models/retrieveInventoryChangesRequest'; -export { RetrieveInventoryChangesResponse } from './models/retrieveInventoryChangesResponse'; -export { RetrieveInventoryCountRequest } from './models/retrieveInventoryCountRequest'; -export { RetrieveInventoryCountResponse } from './models/retrieveInventoryCountResponse'; -export { RetrieveInventoryPhysicalCountResponse } from './models/retrieveInventoryPhysicalCountResponse'; -export { RetrieveInventoryTransferResponse } from './models/retrieveInventoryTransferResponse'; -export { RetrieveLocationCustomAttributeDefinitionRequest } from './models/retrieveLocationCustomAttributeDefinitionRequest'; -export { RetrieveLocationCustomAttributeDefinitionResponse } from './models/retrieveLocationCustomAttributeDefinitionResponse'; -export { RetrieveLocationCustomAttributeRequest } from './models/retrieveLocationCustomAttributeRequest'; -export { RetrieveLocationCustomAttributeResponse } from './models/retrieveLocationCustomAttributeResponse'; -export { RetrieveLocationResponse } from './models/retrieveLocationResponse'; -export { RetrieveLoyaltyAccountResponse } from './models/retrieveLoyaltyAccountResponse'; -export { RetrieveLoyaltyProgramResponse } from './models/retrieveLoyaltyProgramResponse'; -export { RetrieveLoyaltyPromotionResponse } from './models/retrieveLoyaltyPromotionResponse'; -export { RetrieveLoyaltyRewardResponse } from './models/retrieveLoyaltyRewardResponse'; -export { RetrieveMerchantResponse } from './models/retrieveMerchantResponse'; -export { RetrieveOrderCustomAttributeDefinitionRequest } from './models/retrieveOrderCustomAttributeDefinitionRequest'; -export { RetrieveOrderCustomAttributeDefinitionResponse } from './models/retrieveOrderCustomAttributeDefinitionResponse'; -export { RetrieveOrderCustomAttributeRequest } from './models/retrieveOrderCustomAttributeRequest'; -export { RetrieveOrderCustomAttributeResponse } from './models/retrieveOrderCustomAttributeResponse'; -export { RetrieveOrderResponse } from './models/retrieveOrderResponse'; -export { RetrievePaymentLinkResponse } from './models/retrievePaymentLinkResponse'; -export { RetrieveSnippetResponse } from './models/retrieveSnippetResponse'; -export { RetrieveSubscriptionRequest } from './models/retrieveSubscriptionRequest'; -export { RetrieveSubscriptionResponse } from './models/retrieveSubscriptionResponse'; -export { RetrieveTeamMemberBookingProfileResponse } from './models/retrieveTeamMemberBookingProfileResponse'; -export { RetrieveTeamMemberResponse } from './models/retrieveTeamMemberResponse'; -export { RetrieveTokenStatusResponse } from './models/retrieveTokenStatusResponse'; -export { RetrieveTransactionResponse } from './models/retrieveTransactionResponse'; -export { RetrieveVendorResponse } from './models/retrieveVendorResponse'; -export { RetrieveWageSettingResponse } from './models/retrieveWageSettingResponse'; -export { RetrieveWebhookSubscriptionResponse } from './models/retrieveWebhookSubscriptionResponse'; -export { RevokeTokenRequest } from './models/revokeTokenRequest'; -export { RevokeTokenResponse } from './models/revokeTokenResponse'; -export { RiskEvaluation } from './models/riskEvaluation'; -export { SaveCardOptions } from './models/saveCardOptions'; -export { SearchAvailabilityFilter } from './models/searchAvailabilityFilter'; -export { SearchAvailabilityQuery } from './models/searchAvailabilityQuery'; -export { SearchAvailabilityRequest } from './models/searchAvailabilityRequest'; -export { SearchAvailabilityResponse } from './models/searchAvailabilityResponse'; -export { SearchCatalogItemsRequest } from './models/searchCatalogItemsRequest'; -export { SearchCatalogItemsResponse } from './models/searchCatalogItemsResponse'; -export { SearchCatalogObjectsRequest } from './models/searchCatalogObjectsRequest'; -export { SearchCatalogObjectsResponse } from './models/searchCatalogObjectsResponse'; -export { SearchCustomersRequest } from './models/searchCustomersRequest'; -export { SearchCustomersResponse } from './models/searchCustomersResponse'; -export { SearchInvoicesRequest } from './models/searchInvoicesRequest'; -export { SearchInvoicesResponse } from './models/searchInvoicesResponse'; -export { SearchLoyaltyAccountsRequest } from './models/searchLoyaltyAccountsRequest'; -export { SearchLoyaltyAccountsRequestLoyaltyAccountQuery } from './models/searchLoyaltyAccountsRequestLoyaltyAccountQuery'; -export { SearchLoyaltyAccountsResponse } from './models/searchLoyaltyAccountsResponse'; -export { SearchLoyaltyEventsRequest } from './models/searchLoyaltyEventsRequest'; -export { SearchLoyaltyEventsResponse } from './models/searchLoyaltyEventsResponse'; -export { SearchLoyaltyRewardsRequest } from './models/searchLoyaltyRewardsRequest'; -export { SearchLoyaltyRewardsRequestLoyaltyRewardQuery } from './models/searchLoyaltyRewardsRequestLoyaltyRewardQuery'; -export { SearchLoyaltyRewardsResponse } from './models/searchLoyaltyRewardsResponse'; -export { SearchOrdersCustomerFilter } from './models/searchOrdersCustomerFilter'; -export { SearchOrdersDateTimeFilter } from './models/searchOrdersDateTimeFilter'; -export { SearchOrdersFilter } from './models/searchOrdersFilter'; -export { SearchOrdersFulfillmentFilter } from './models/searchOrdersFulfillmentFilter'; -export { SearchOrdersQuery } from './models/searchOrdersQuery'; -export { SearchOrdersRequest } from './models/searchOrdersRequest'; -export { SearchOrdersResponse } from './models/searchOrdersResponse'; -export { SearchOrdersSort } from './models/searchOrdersSort'; -export { SearchOrdersSourceFilter } from './models/searchOrdersSourceFilter'; -export { SearchOrdersStateFilter } from './models/searchOrdersStateFilter'; -export { SearchShiftsRequest } from './models/searchShiftsRequest'; -export { SearchShiftsResponse } from './models/searchShiftsResponse'; -export { SearchSubscriptionsFilter } from './models/searchSubscriptionsFilter'; -export { SearchSubscriptionsQuery } from './models/searchSubscriptionsQuery'; -export { SearchSubscriptionsRequest } from './models/searchSubscriptionsRequest'; -export { SearchSubscriptionsResponse } from './models/searchSubscriptionsResponse'; -export { SearchTeamMembersFilter } from './models/searchTeamMembersFilter'; -export { SearchTeamMembersQuery } from './models/searchTeamMembersQuery'; -export { SearchTeamMembersRequest } from './models/searchTeamMembersRequest'; -export { SearchTeamMembersResponse } from './models/searchTeamMembersResponse'; -export { SearchTerminalActionsRequest } from './models/searchTerminalActionsRequest'; -export { SearchTerminalActionsResponse } from './models/searchTerminalActionsResponse'; -export { SearchTerminalCheckoutsRequest } from './models/searchTerminalCheckoutsRequest'; -export { SearchTerminalCheckoutsResponse } from './models/searchTerminalCheckoutsResponse'; -export { SearchTerminalRefundsRequest } from './models/searchTerminalRefundsRequest'; -export { SearchTerminalRefundsResponse } from './models/searchTerminalRefundsResponse'; -export { SearchVendorsRequest } from './models/searchVendorsRequest'; -export { SearchVendorsRequestFilter } from './models/searchVendorsRequestFilter'; -export { SearchVendorsRequestSort } from './models/searchVendorsRequestSort'; -export { SearchVendorsResponse } from './models/searchVendorsResponse'; -export { SegmentFilter } from './models/segmentFilter'; -export { Shift } from './models/shift'; -export { ShiftFilter } from './models/shiftFilter'; -export { ShiftQuery } from './models/shiftQuery'; -export { ShiftSort } from './models/shiftSort'; -export { ShiftWage } from './models/shiftWage'; -export { ShiftWorkday } from './models/shiftWorkday'; -export { ShippingFee } from './models/shippingFee'; -export { Site } from './models/site'; -export { Snippet } from './models/snippet'; -export { SnippetResponse } from './models/snippetResponse'; -export { SourceApplication } from './models/sourceApplication'; -export { SquareEvent } from './models/squareEvent'; -export { SquareEventData } from './models/squareEventData'; -export { StandardUnitDescription } from './models/standardUnitDescription'; -export { StandardUnitDescriptionGroup } from './models/standardUnitDescriptionGroup'; -export { SubmitEvidenceResponse } from './models/submitEvidenceResponse'; -export { Subscription } from './models/subscription'; -export { SubscriptionAction } from './models/subscriptionAction'; -export { SubscriptionEvent } from './models/subscriptionEvent'; -export { SubscriptionEventInfo } from './models/subscriptionEventInfo'; -export { SubscriptionPhase } from './models/subscriptionPhase'; -export { SubscriptionSource } from './models/subscriptionSource'; -export { SubscriptionTestResult } from './models/subscriptionTestResult'; -export { SwapPlanRequest } from './models/swapPlanRequest'; -export { SwapPlanResponse } from './models/swapPlanResponse'; -export { TaxIds } from './models/taxIds'; -export { TeamMember } from './models/teamMember'; -export { TeamMemberAssignedLocations } from './models/teamMemberAssignedLocations'; -export { TeamMemberBookingProfile } from './models/teamMemberBookingProfile'; -export { TeamMemberWage } from './models/teamMemberWage'; -export { Tender } from './models/tender'; -export { TenderCardDetails } from './models/tenderCardDetails'; -export { TenderCashDetails } from './models/tenderCashDetails'; -export { TerminalAction } from './models/terminalAction'; -export { TerminalActionQuery } from './models/terminalActionQuery'; -export { TerminalActionQueryFilter } from './models/terminalActionQueryFilter'; -export { TerminalActionQuerySort } from './models/terminalActionQuerySort'; -export { TerminalCheckout } from './models/terminalCheckout'; -export { TerminalCheckoutQuery } from './models/terminalCheckoutQuery'; -export { TerminalCheckoutQueryFilter } from './models/terminalCheckoutQueryFilter'; -export { TerminalCheckoutQuerySort } from './models/terminalCheckoutQuerySort'; -export { TerminalRefund } from './models/terminalRefund'; -export { TerminalRefundQuery } from './models/terminalRefundQuery'; -export { TerminalRefundQueryFilter } from './models/terminalRefundQueryFilter'; -export { TerminalRefundQuerySort } from './models/terminalRefundQuerySort'; -export { TestWebhookSubscriptionRequest } from './models/testWebhookSubscriptionRequest'; -export { TestWebhookSubscriptionResponse } from './models/testWebhookSubscriptionResponse'; -export { TimeRange } from './models/timeRange'; -export { TipSettings } from './models/tipSettings'; -export { Transaction } from './models/transaction'; -export { UnlinkCustomerFromGiftCardRequest } from './models/unlinkCustomerFromGiftCardRequest'; -export { UnlinkCustomerFromGiftCardResponse } from './models/unlinkCustomerFromGiftCardResponse'; -export { UpdateBookingCustomAttributeDefinitionRequest } from './models/updateBookingCustomAttributeDefinitionRequest'; -export { UpdateBookingCustomAttributeDefinitionResponse } from './models/updateBookingCustomAttributeDefinitionResponse'; -export { UpdateBookingRequest } from './models/updateBookingRequest'; -export { UpdateBookingResponse } from './models/updateBookingResponse'; -export { UpdateBreakTypeRequest } from './models/updateBreakTypeRequest'; -export { UpdateBreakTypeResponse } from './models/updateBreakTypeResponse'; -export { UpdateCatalogImageRequest } from './models/updateCatalogImageRequest'; -export { UpdateCatalogImageResponse } from './models/updateCatalogImageResponse'; -export { UpdateCustomerCustomAttributeDefinitionRequest } from './models/updateCustomerCustomAttributeDefinitionRequest'; -export { UpdateCustomerCustomAttributeDefinitionResponse } from './models/updateCustomerCustomAttributeDefinitionResponse'; -export { UpdateCustomerGroupRequest } from './models/updateCustomerGroupRequest'; -export { UpdateCustomerGroupResponse } from './models/updateCustomerGroupResponse'; -export { UpdateCustomerRequest } from './models/updateCustomerRequest'; -export { UpdateCustomerResponse } from './models/updateCustomerResponse'; -export { UpdateInvoiceRequest } from './models/updateInvoiceRequest'; -export { UpdateInvoiceResponse } from './models/updateInvoiceResponse'; -export { UpdateItemModifierListsRequest } from './models/updateItemModifierListsRequest'; -export { UpdateItemModifierListsResponse } from './models/updateItemModifierListsResponse'; -export { UpdateItemTaxesRequest } from './models/updateItemTaxesRequest'; -export { UpdateItemTaxesResponse } from './models/updateItemTaxesResponse'; -export { UpdateLocationCustomAttributeDefinitionRequest } from './models/updateLocationCustomAttributeDefinitionRequest'; -export { UpdateLocationCustomAttributeDefinitionResponse } from './models/updateLocationCustomAttributeDefinitionResponse'; -export { UpdateLocationRequest } from './models/updateLocationRequest'; -export { UpdateLocationResponse } from './models/updateLocationResponse'; -export { UpdateOrderCustomAttributeDefinitionRequest } from './models/updateOrderCustomAttributeDefinitionRequest'; -export { UpdateOrderCustomAttributeDefinitionResponse } from './models/updateOrderCustomAttributeDefinitionResponse'; -export { UpdateOrderRequest } from './models/updateOrderRequest'; -export { UpdateOrderResponse } from './models/updateOrderResponse'; -export { UpdatePaymentLinkRequest } from './models/updatePaymentLinkRequest'; -export { UpdatePaymentLinkResponse } from './models/updatePaymentLinkResponse'; -export { UpdatePaymentRequest } from './models/updatePaymentRequest'; -export { UpdatePaymentResponse } from './models/updatePaymentResponse'; -export { UpdateShiftRequest } from './models/updateShiftRequest'; -export { UpdateShiftResponse } from './models/updateShiftResponse'; -export { UpdateSubscriptionRequest } from './models/updateSubscriptionRequest'; -export { UpdateSubscriptionResponse } from './models/updateSubscriptionResponse'; -export { UpdateTeamMemberRequest } from './models/updateTeamMemberRequest'; -export { UpdateTeamMemberResponse } from './models/updateTeamMemberResponse'; -export { UpdateVendorRequest } from './models/updateVendorRequest'; -export { UpdateVendorResponse } from './models/updateVendorResponse'; -export { UpdateWageSettingRequest } from './models/updateWageSettingRequest'; -export { UpdateWageSettingResponse } from './models/updateWageSettingResponse'; -export { UpdateWebhookSubscriptionRequest } from './models/updateWebhookSubscriptionRequest'; -export { UpdateWebhookSubscriptionResponse } from './models/updateWebhookSubscriptionResponse'; -export { UpdateWebhookSubscriptionSignatureKeyRequest } from './models/updateWebhookSubscriptionSignatureKeyRequest'; -export { UpdateWebhookSubscriptionSignatureKeyResponse } from './models/updateWebhookSubscriptionSignatureKeyResponse'; -export { UpdateWorkweekConfigRequest } from './models/updateWorkweekConfigRequest'; -export { UpdateWorkweekConfigResponse } from './models/updateWorkweekConfigResponse'; -export { UpsertBookingCustomAttributeRequest } from './models/upsertBookingCustomAttributeRequest'; -export { UpsertBookingCustomAttributeResponse } from './models/upsertBookingCustomAttributeResponse'; -export { UpsertCatalogObjectRequest } from './models/upsertCatalogObjectRequest'; -export { UpsertCatalogObjectResponse } from './models/upsertCatalogObjectResponse'; -export { UpsertCustomerCustomAttributeRequest } from './models/upsertCustomerCustomAttributeRequest'; -export { UpsertCustomerCustomAttributeResponse } from './models/upsertCustomerCustomAttributeResponse'; -export { UpsertLocationCustomAttributeRequest } from './models/upsertLocationCustomAttributeRequest'; -export { UpsertLocationCustomAttributeResponse } from './models/upsertLocationCustomAttributeResponse'; -export { UpsertOrderCustomAttributeRequest } from './models/upsertOrderCustomAttributeRequest'; -export { UpsertOrderCustomAttributeResponse } from './models/upsertOrderCustomAttributeResponse'; -export { UpsertSnippetRequest } from './models/upsertSnippetRequest'; -export { UpsertSnippetResponse } from './models/upsertSnippetResponse'; -export { V1CreateRefundRequest } from './models/v1CreateRefundRequest'; -export { V1ListOrdersRequest } from './models/v1ListOrdersRequest'; -export { V1ListOrdersResponse } from './models/v1ListOrdersResponse'; -export { V1ListPaymentsRequest } from './models/v1ListPaymentsRequest'; -export { V1ListPaymentsResponse } from './models/v1ListPaymentsResponse'; -export { V1ListRefundsRequest } from './models/v1ListRefundsRequest'; -export { V1ListRefundsResponse } from './models/v1ListRefundsResponse'; -export { V1ListSettlementsRequest } from './models/v1ListSettlementsRequest'; -export { V1ListSettlementsResponse } from './models/v1ListSettlementsResponse'; -export { V1Money } from './models/v1Money'; -export { V1Order } from './models/v1Order'; -export { V1OrderHistoryEntry } from './models/v1OrderHistoryEntry'; -export { V1Payment } from './models/v1Payment'; -export { V1PaymentDiscount } from './models/v1PaymentDiscount'; -export { V1PaymentItemDetail } from './models/v1PaymentItemDetail'; -export { V1PaymentItemization } from './models/v1PaymentItemization'; -export { V1PaymentModifier } from './models/v1PaymentModifier'; -export { V1PaymentSurcharge } from './models/v1PaymentSurcharge'; -export { V1PaymentTax } from './models/v1PaymentTax'; -export { V1PhoneNumber } from './models/v1PhoneNumber'; -export { V1Refund } from './models/v1Refund'; -export { V1Settlement } from './models/v1Settlement'; -export { V1SettlementEntry } from './models/v1SettlementEntry'; -export { V1Tender } from './models/v1Tender'; -export { V1UpdateOrderRequest } from './models/v1UpdateOrderRequest'; -export { Vendor } from './models/vendor'; -export { VendorContact } from './models/vendorContact'; -export { VoidTransactionResponse } from './models/voidTransactionResponse'; -export { WageSetting } from './models/wageSetting'; -export { WebhookSubscription } from './models/webhookSubscription'; -export { WorkweekConfig } from './models/workweekConfig'; +export type { AcceptDisputeResponse } from './models/acceptDisputeResponse'; +export type { AcceptedPaymentMethods } from './models/acceptedPaymentMethods'; +export type { AccumulateLoyaltyPointsRequest } from './models/accumulateLoyaltyPointsRequest'; +export type { AccumulateLoyaltyPointsResponse } from './models/accumulateLoyaltyPointsResponse'; +export type { ACHDetails } from './models/aCHDetails'; +export type { AddGroupToCustomerResponse } from './models/addGroupToCustomerResponse'; +export type { AdditionalRecipient } from './models/additionalRecipient'; +export type { Address } from './models/address'; +export type { AdjustLoyaltyPointsRequest } from './models/adjustLoyaltyPointsRequest'; +export type { AdjustLoyaltyPointsResponse } from './models/adjustLoyaltyPointsResponse'; +export type { AfterpayDetails } from './models/afterpayDetails'; +export type { ApplicationDetails } from './models/applicationDetails'; +export type { AppointmentSegment } from './models/appointmentSegment'; +export type { Availability } from './models/availability'; +export type { BankAccount } from './models/bankAccount'; +export type { BankAccountPaymentDetails } from './models/bankAccountPaymentDetails'; +export type { BatchChangeInventoryRequest } from './models/batchChangeInventoryRequest'; +export type { BatchChangeInventoryResponse } from './models/batchChangeInventoryResponse'; +export type { BatchDeleteCatalogObjectsRequest } from './models/batchDeleteCatalogObjectsRequest'; +export type { BatchDeleteCatalogObjectsResponse } from './models/batchDeleteCatalogObjectsResponse'; +export type { BatchRetrieveCatalogObjectsRequest } from './models/batchRetrieveCatalogObjectsRequest'; +export type { BatchRetrieveCatalogObjectsResponse } from './models/batchRetrieveCatalogObjectsResponse'; +export type { BatchRetrieveInventoryChangesRequest } from './models/batchRetrieveInventoryChangesRequest'; +export type { BatchRetrieveInventoryChangesResponse } from './models/batchRetrieveInventoryChangesResponse'; +export type { BatchRetrieveInventoryCountsRequest } from './models/batchRetrieveInventoryCountsRequest'; +export type { BatchRetrieveInventoryCountsResponse } from './models/batchRetrieveInventoryCountsResponse'; +export type { BatchRetrieveOrdersRequest } from './models/batchRetrieveOrdersRequest'; +export type { BatchRetrieveOrdersResponse } from './models/batchRetrieveOrdersResponse'; +export type { BatchUpsertCatalogObjectsRequest } from './models/batchUpsertCatalogObjectsRequest'; +export type { BatchUpsertCatalogObjectsResponse } from './models/batchUpsertCatalogObjectsResponse'; +export type { Booking } from './models/booking'; +export type { BookingCreatorDetails } from './models/bookingCreatorDetails'; +export type { BookingCustomAttributeDeleteRequest } from './models/bookingCustomAttributeDeleteRequest'; +export type { BookingCustomAttributeDeleteResponse } from './models/bookingCustomAttributeDeleteResponse'; +export type { BookingCustomAttributeUpsertRequest } from './models/bookingCustomAttributeUpsertRequest'; +export type { BookingCustomAttributeUpsertResponse } from './models/bookingCustomAttributeUpsertResponse'; +export type { Break } from './models/break'; +export type { BreakType } from './models/breakType'; +export type { BulkCreateTeamMembersRequest } from './models/bulkCreateTeamMembersRequest'; +export type { BulkCreateTeamMembersResponse } from './models/bulkCreateTeamMembersResponse'; +export type { BulkCreateVendorsRequest } from './models/bulkCreateVendorsRequest'; +export type { BulkCreateVendorsResponse } from './models/bulkCreateVendorsResponse'; +export type { BulkDeleteBookingCustomAttributesRequest } from './models/bulkDeleteBookingCustomAttributesRequest'; +export type { BulkDeleteBookingCustomAttributesResponse } from './models/bulkDeleteBookingCustomAttributesResponse'; +export type { BulkDeleteLocationCustomAttributesRequest } from './models/bulkDeleteLocationCustomAttributesRequest'; +export type { BulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest } from './models/bulkDeleteLocationCustomAttributesRequestLocationCustomAttributeDeleteRequest'; +export type { BulkDeleteLocationCustomAttributesResponse } from './models/bulkDeleteLocationCustomAttributesResponse'; +export type { BulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse } from './models/bulkDeleteLocationCustomAttributesResponseLocationCustomAttributeDeleteResponse'; +export type { BulkDeleteOrderCustomAttributesRequest } from './models/bulkDeleteOrderCustomAttributesRequest'; +export type { BulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute } from './models/bulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute'; +export type { BulkDeleteOrderCustomAttributesResponse } from './models/bulkDeleteOrderCustomAttributesResponse'; +export type { BulkRetrieveVendorsRequest } from './models/bulkRetrieveVendorsRequest'; +export type { BulkRetrieveVendorsResponse } from './models/bulkRetrieveVendorsResponse'; +export type { BulkUpdateTeamMembersRequest } from './models/bulkUpdateTeamMembersRequest'; +export type { BulkUpdateTeamMembersResponse } from './models/bulkUpdateTeamMembersResponse'; +export type { BulkUpdateVendorsRequest } from './models/bulkUpdateVendorsRequest'; +export type { BulkUpdateVendorsResponse } from './models/bulkUpdateVendorsResponse'; +export type { BulkUpsertBookingCustomAttributesRequest } from './models/bulkUpsertBookingCustomAttributesRequest'; +export type { BulkUpsertBookingCustomAttributesResponse } from './models/bulkUpsertBookingCustomAttributesResponse'; +export type { BulkUpsertCustomerCustomAttributesRequest } from './models/bulkUpsertCustomerCustomAttributesRequest'; +export type { BulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest } from './models/bulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest'; +export type { BulkUpsertCustomerCustomAttributesResponse } from './models/bulkUpsertCustomerCustomAttributesResponse'; +export type { BulkUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse } from './models/bulkUpsertCustomerCustomAttributesResponseCustomerCustomAttributeUpsertResponse'; +export type { BulkUpsertLocationCustomAttributesRequest } from './models/bulkUpsertLocationCustomAttributesRequest'; +export type { BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest } from './models/bulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest'; +export type { BulkUpsertLocationCustomAttributesResponse } from './models/bulkUpsertLocationCustomAttributesResponse'; +export type { BulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse } from './models/bulkUpsertLocationCustomAttributesResponseLocationCustomAttributeUpsertResponse'; +export type { BulkUpsertOrderCustomAttributesRequest } from './models/bulkUpsertOrderCustomAttributesRequest'; +export type { BulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute } from './models/bulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute'; +export type { BulkUpsertOrderCustomAttributesResponse } from './models/bulkUpsertOrderCustomAttributesResponse'; +export type { BusinessAppointmentSettings } from './models/businessAppointmentSettings'; +export type { BusinessBookingProfile } from './models/businessBookingProfile'; +export type { BusinessHours } from './models/businessHours'; +export type { BusinessHoursPeriod } from './models/businessHoursPeriod'; +export type { BuyNowPayLaterDetails } from './models/buyNowPayLaterDetails'; +export type { CalculateLoyaltyPointsRequest } from './models/calculateLoyaltyPointsRequest'; +export type { CalculateLoyaltyPointsResponse } from './models/calculateLoyaltyPointsResponse'; +export type { CalculateOrderRequest } from './models/calculateOrderRequest'; +export type { CalculateOrderResponse } from './models/calculateOrderResponse'; +export type { CancelBookingRequest } from './models/cancelBookingRequest'; +export type { CancelBookingResponse } from './models/cancelBookingResponse'; +export type { CancelInvoiceRequest } from './models/cancelInvoiceRequest'; +export type { CancelInvoiceResponse } from './models/cancelInvoiceResponse'; +export type { CancelLoyaltyPromotionResponse } from './models/cancelLoyaltyPromotionResponse'; +export type { CancelPaymentByIdempotencyKeyRequest } from './models/cancelPaymentByIdempotencyKeyRequest'; +export type { CancelPaymentByIdempotencyKeyResponse } from './models/cancelPaymentByIdempotencyKeyResponse'; +export type { CancelPaymentResponse } from './models/cancelPaymentResponse'; +export type { CancelSubscriptionResponse } from './models/cancelSubscriptionResponse'; +export type { CancelTerminalActionResponse } from './models/cancelTerminalActionResponse'; +export type { CancelTerminalCheckoutResponse } from './models/cancelTerminalCheckoutResponse'; +export type { CancelTerminalRefundResponse } from './models/cancelTerminalRefundResponse'; +export type { CaptureTransactionResponse } from './models/captureTransactionResponse'; +export type { Card } from './models/card'; +export type { CardPaymentDetails } from './models/cardPaymentDetails'; +export type { CardPaymentTimeline } from './models/cardPaymentTimeline'; +export type { CashAppDetails } from './models/cashAppDetails'; +export type { CashDrawerDevice } from './models/cashDrawerDevice'; +export type { CashDrawerShift } from './models/cashDrawerShift'; +export type { CashDrawerShiftEvent } from './models/cashDrawerShiftEvent'; +export type { CashDrawerShiftSummary } from './models/cashDrawerShiftSummary'; +export type { CashPaymentDetails } from './models/cashPaymentDetails'; +export type { CatalogCategory } from './models/catalogCategory'; +export type { CatalogCustomAttributeDefinition } from './models/catalogCustomAttributeDefinition'; +export type { CatalogCustomAttributeDefinitionNumberConfig } from './models/catalogCustomAttributeDefinitionNumberConfig'; +export type { CatalogCustomAttributeDefinitionSelectionConfig } from './models/catalogCustomAttributeDefinitionSelectionConfig'; +export type { CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection } from './models/catalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection'; +export type { CatalogCustomAttributeDefinitionStringConfig } from './models/catalogCustomAttributeDefinitionStringConfig'; +export type { CatalogCustomAttributeValue } from './models/catalogCustomAttributeValue'; +export type { CatalogDiscount } from './models/catalogDiscount'; +export type { CatalogIdMapping } from './models/catalogIdMapping'; +export type { CatalogImage } from './models/catalogImage'; +export type { CatalogInfoResponse } from './models/catalogInfoResponse'; +export type { CatalogInfoResponseLimits } from './models/catalogInfoResponseLimits'; +export type { CatalogItem } from './models/catalogItem'; +export type { CatalogItemModifierListInfo } from './models/catalogItemModifierListInfo'; +export type { CatalogItemOption } from './models/catalogItemOption'; +export type { CatalogItemOptionForItem } from './models/catalogItemOptionForItem'; +export type { CatalogItemOptionValue } from './models/catalogItemOptionValue'; +export type { CatalogItemOptionValueForItemVariation } from './models/catalogItemOptionValueForItemVariation'; +export type { CatalogItemVariation } from './models/catalogItemVariation'; +export type { CatalogMeasurementUnit } from './models/catalogMeasurementUnit'; +export type { CatalogModifier } from './models/catalogModifier'; +export type { CatalogModifierList } from './models/catalogModifierList'; +export type { CatalogModifierOverride } from './models/catalogModifierOverride'; +export type { CatalogObject } from './models/catalogObject'; +export type { CatalogObjectBatch } from './models/catalogObjectBatch'; +export type { CatalogObjectReference } from './models/catalogObjectReference'; +export type { CatalogPricingRule } from './models/catalogPricingRule'; +export type { CatalogProductSet } from './models/catalogProductSet'; +export type { CatalogQuery } from './models/catalogQuery'; +export type { CatalogQueryExact } from './models/catalogQueryExact'; +export type { CatalogQueryItemsForItemOptions } from './models/catalogQueryItemsForItemOptions'; +export type { CatalogQueryItemsForModifierList } from './models/catalogQueryItemsForModifierList'; +export type { CatalogQueryItemsForTax } from './models/catalogQueryItemsForTax'; +export type { CatalogQueryItemVariationsForItemOptionValues } from './models/catalogQueryItemVariationsForItemOptionValues'; +export type { CatalogQueryPrefix } from './models/catalogQueryPrefix'; +export type { CatalogQueryRange } from './models/catalogQueryRange'; +export type { CatalogQuerySet } from './models/catalogQuerySet'; +export type { CatalogQuerySortedAttribute } from './models/catalogQuerySortedAttribute'; +export type { CatalogQueryText } from './models/catalogQueryText'; +export type { CatalogQuickAmount } from './models/catalogQuickAmount'; +export type { CatalogQuickAmountsSettings } from './models/catalogQuickAmountsSettings'; +export type { CatalogStockConversion } from './models/catalogStockConversion'; +export type { CatalogSubscriptionPlan } from './models/catalogSubscriptionPlan'; +export type { CatalogTax } from './models/catalogTax'; +export type { CatalogTimePeriod } from './models/catalogTimePeriod'; +export type { CatalogV1Id } from './models/catalogV1Id'; +export type { ChargeRequest } from './models/chargeRequest'; +export type { ChargeRequestAdditionalRecipient } from './models/chargeRequestAdditionalRecipient'; +export type { ChargeResponse } from './models/chargeResponse'; +export type { Checkout } from './models/checkout'; +export type { CheckoutOptions } from './models/checkoutOptions'; +export type { ClearpayDetails } from './models/clearpayDetails'; +export type { CloneOrderRequest } from './models/cloneOrderRequest'; +export type { CloneOrderResponse } from './models/cloneOrderResponse'; +export type { CompletePaymentRequest } from './models/completePaymentRequest'; +export type { CompletePaymentResponse } from './models/completePaymentResponse'; +export type { Coordinates } from './models/coordinates'; +export type { CreateBookingCustomAttributeDefinitionRequest } from './models/createBookingCustomAttributeDefinitionRequest'; +export type { CreateBookingCustomAttributeDefinitionResponse } from './models/createBookingCustomAttributeDefinitionResponse'; +export type { CreateBookingRequest } from './models/createBookingRequest'; +export type { CreateBookingResponse } from './models/createBookingResponse'; +export type { CreateBreakTypeRequest } from './models/createBreakTypeRequest'; +export type { CreateBreakTypeResponse } from './models/createBreakTypeResponse'; +export type { CreateCardRequest } from './models/createCardRequest'; +export type { CreateCardResponse } from './models/createCardResponse'; +export type { CreateCatalogImageRequest } from './models/createCatalogImageRequest'; +export type { CreateCatalogImageResponse } from './models/createCatalogImageResponse'; +export type { CreateCheckoutRequest } from './models/createCheckoutRequest'; +export type { CreateCheckoutResponse } from './models/createCheckoutResponse'; +export type { CreateCustomerCardRequest } from './models/createCustomerCardRequest'; +export type { CreateCustomerCardResponse } from './models/createCustomerCardResponse'; +export type { CreateCustomerCustomAttributeDefinitionRequest } from './models/createCustomerCustomAttributeDefinitionRequest'; +export type { CreateCustomerCustomAttributeDefinitionResponse } from './models/createCustomerCustomAttributeDefinitionResponse'; +export type { CreateCustomerGroupRequest } from './models/createCustomerGroupRequest'; +export type { CreateCustomerGroupResponse } from './models/createCustomerGroupResponse'; +export type { CreateCustomerRequest } from './models/createCustomerRequest'; +export type { CreateCustomerResponse } from './models/createCustomerResponse'; +export type { CreateDeviceCodeRequest } from './models/createDeviceCodeRequest'; +export type { CreateDeviceCodeResponse } from './models/createDeviceCodeResponse'; +export type { CreateDisputeEvidenceFileRequest } from './models/createDisputeEvidenceFileRequest'; +export type { CreateDisputeEvidenceFileResponse } from './models/createDisputeEvidenceFileResponse'; +export type { CreateDisputeEvidenceTextRequest } from './models/createDisputeEvidenceTextRequest'; +export type { CreateDisputeEvidenceTextResponse } from './models/createDisputeEvidenceTextResponse'; +export type { CreateGiftCardActivityRequest } from './models/createGiftCardActivityRequest'; +export type { CreateGiftCardActivityResponse } from './models/createGiftCardActivityResponse'; +export type { CreateGiftCardRequest } from './models/createGiftCardRequest'; +export type { CreateGiftCardResponse } from './models/createGiftCardResponse'; +export type { CreateInvoiceRequest } from './models/createInvoiceRequest'; +export type { CreateInvoiceResponse } from './models/createInvoiceResponse'; +export type { CreateLocationCustomAttributeDefinitionRequest } from './models/createLocationCustomAttributeDefinitionRequest'; +export type { CreateLocationCustomAttributeDefinitionResponse } from './models/createLocationCustomAttributeDefinitionResponse'; +export type { CreateLocationRequest } from './models/createLocationRequest'; +export type { CreateLocationResponse } from './models/createLocationResponse'; +export type { CreateLoyaltyAccountRequest } from './models/createLoyaltyAccountRequest'; +export type { CreateLoyaltyAccountResponse } from './models/createLoyaltyAccountResponse'; +export type { CreateLoyaltyPromotionRequest } from './models/createLoyaltyPromotionRequest'; +export type { CreateLoyaltyPromotionResponse } from './models/createLoyaltyPromotionResponse'; +export type { CreateLoyaltyRewardRequest } from './models/createLoyaltyRewardRequest'; +export type { CreateLoyaltyRewardResponse } from './models/createLoyaltyRewardResponse'; +export type { CreateMobileAuthorizationCodeRequest } from './models/createMobileAuthorizationCodeRequest'; +export type { CreateMobileAuthorizationCodeResponse } from './models/createMobileAuthorizationCodeResponse'; +export type { CreateOrderCustomAttributeDefinitionRequest } from './models/createOrderCustomAttributeDefinitionRequest'; +export type { CreateOrderCustomAttributeDefinitionResponse } from './models/createOrderCustomAttributeDefinitionResponse'; +export type { CreateOrderRequest } from './models/createOrderRequest'; +export type { CreateOrderResponse } from './models/createOrderResponse'; +export type { CreatePaymentLinkRequest } from './models/createPaymentLinkRequest'; +export type { CreatePaymentLinkResponse } from './models/createPaymentLinkResponse'; +export type { CreatePaymentRequest } from './models/createPaymentRequest'; +export type { CreatePaymentResponse } from './models/createPaymentResponse'; +export type { CreateRefundRequest } from './models/createRefundRequest'; +export type { CreateRefundResponse } from './models/createRefundResponse'; +export type { CreateShiftRequest } from './models/createShiftRequest'; +export type { CreateShiftResponse } from './models/createShiftResponse'; +export type { CreateSubscriptionRequest } from './models/createSubscriptionRequest'; +export type { CreateSubscriptionResponse } from './models/createSubscriptionResponse'; +export type { CreateTeamMemberRequest } from './models/createTeamMemberRequest'; +export type { CreateTeamMemberResponse } from './models/createTeamMemberResponse'; +export type { CreateTerminalActionRequest } from './models/createTerminalActionRequest'; +export type { CreateTerminalActionResponse } from './models/createTerminalActionResponse'; +export type { CreateTerminalCheckoutRequest } from './models/createTerminalCheckoutRequest'; +export type { CreateTerminalCheckoutResponse } from './models/createTerminalCheckoutResponse'; +export type { CreateTerminalRefundRequest } from './models/createTerminalRefundRequest'; +export type { CreateTerminalRefundResponse } from './models/createTerminalRefundResponse'; +export type { CreateVendorRequest } from './models/createVendorRequest'; +export type { CreateVendorResponse } from './models/createVendorResponse'; +export type { CreateWebhookSubscriptionRequest } from './models/createWebhookSubscriptionRequest'; +export type { CreateWebhookSubscriptionResponse } from './models/createWebhookSubscriptionResponse'; +export type { CustomAttribute } from './models/customAttribute'; +export type { CustomAttributeDefinition } from './models/customAttributeDefinition'; +export type { CustomAttributeFilter } from './models/customAttributeFilter'; +export type { Customer } from './models/customer'; +export type { CustomerAddressFilter } from './models/customerAddressFilter'; +export type { CustomerCreationSourceFilter } from './models/customerCreationSourceFilter'; +export type { CustomerCustomAttributeFilter } from './models/customerCustomAttributeFilter'; +export type { CustomerCustomAttributeFilters } from './models/customerCustomAttributeFilters'; +export type { CustomerCustomAttributeFilterValue } from './models/customerCustomAttributeFilterValue'; +export type { CustomerFilter } from './models/customerFilter'; +export type { CustomerGroup } from './models/customerGroup'; +export type { CustomerPreferences } from './models/customerPreferences'; +export type { CustomerQuery } from './models/customerQuery'; +export type { CustomerSegment } from './models/customerSegment'; +export type { CustomerSort } from './models/customerSort'; +export type { CustomerTaxIds } from './models/customerTaxIds'; +export type { CustomerTextFilter } from './models/customerTextFilter'; +export type { CustomField } from './models/customField'; +export type { DateRange } from './models/dateRange'; +export type { DeleteBookingCustomAttributeDefinitionResponse } from './models/deleteBookingCustomAttributeDefinitionResponse'; +export type { DeleteBookingCustomAttributeResponse } from './models/deleteBookingCustomAttributeResponse'; +export type { DeleteBreakTypeResponse } from './models/deleteBreakTypeResponse'; +export type { DeleteCatalogObjectResponse } from './models/deleteCatalogObjectResponse'; +export type { DeleteCustomerCardResponse } from './models/deleteCustomerCardResponse'; +export type { DeleteCustomerCustomAttributeDefinitionResponse } from './models/deleteCustomerCustomAttributeDefinitionResponse'; +export type { DeleteCustomerCustomAttributeResponse } from './models/deleteCustomerCustomAttributeResponse'; +export type { DeleteCustomerGroupResponse } from './models/deleteCustomerGroupResponse'; +export type { DeleteCustomerRequest } from './models/deleteCustomerRequest'; +export type { DeleteCustomerResponse } from './models/deleteCustomerResponse'; +export type { DeleteDisputeEvidenceResponse } from './models/deleteDisputeEvidenceResponse'; +export type { DeleteInvoiceRequest } from './models/deleteInvoiceRequest'; +export type { DeleteInvoiceResponse } from './models/deleteInvoiceResponse'; +export type { DeleteLocationCustomAttributeDefinitionResponse } from './models/deleteLocationCustomAttributeDefinitionResponse'; +export type { DeleteLocationCustomAttributeResponse } from './models/deleteLocationCustomAttributeResponse'; +export type { DeleteLoyaltyRewardResponse } from './models/deleteLoyaltyRewardResponse'; +export type { DeleteOrderCustomAttributeDefinitionResponse } from './models/deleteOrderCustomAttributeDefinitionResponse'; +export type { DeleteOrderCustomAttributeResponse } from './models/deleteOrderCustomAttributeResponse'; +export type { DeletePaymentLinkResponse } from './models/deletePaymentLinkResponse'; +export type { DeleteShiftResponse } from './models/deleteShiftResponse'; +export type { DeleteSnippetResponse } from './models/deleteSnippetResponse'; +export type { DeleteSubscriptionActionResponse } from './models/deleteSubscriptionActionResponse'; +export type { DeleteWebhookSubscriptionResponse } from './models/deleteWebhookSubscriptionResponse'; +export type { DeprecatedCreateDisputeEvidenceFileRequest } from './models/deprecatedCreateDisputeEvidenceFileRequest'; +export type { DeprecatedCreateDisputeEvidenceFileResponse } from './models/deprecatedCreateDisputeEvidenceFileResponse'; +export type { DeprecatedCreateDisputeEvidenceTextRequest } from './models/deprecatedCreateDisputeEvidenceTextRequest'; +export type { DeprecatedCreateDisputeEvidenceTextResponse } from './models/deprecatedCreateDisputeEvidenceTextResponse'; +export type { Destination } from './models/destination'; +export type { DestinationDetails } from './models/destinationDetails'; +export type { DestinationDetailsCardRefundDetails } from './models/destinationDetailsCardRefundDetails'; +export type { Device } from './models/device'; +export type { DeviceCheckoutOptions } from './models/deviceCheckoutOptions'; +export type { DeviceCode } from './models/deviceCode'; +export type { DeviceDetails } from './models/deviceDetails'; +export type { DeviceMetadata } from './models/deviceMetadata'; +export type { DigitalWalletDetails } from './models/digitalWalletDetails'; +export type { DisableCardResponse } from './models/disableCardResponse'; +export type { Dispute } from './models/dispute'; +export type { DisputedPayment } from './models/disputedPayment'; +export type { DisputeEvidence } from './models/disputeEvidence'; +export type { DisputeEvidenceFile } from './models/disputeEvidenceFile'; +export type { Employee } from './models/employee'; +export type { EmployeeWage } from './models/employeeWage'; +export type { Error } from './models/error'; +export type { EventTypeMetadata } from './models/eventTypeMetadata'; +export type { ExternalPaymentDetails } from './models/externalPaymentDetails'; +export type { FilterValue } from './models/filterValue'; +export type { FloatNumberRange } from './models/floatNumberRange'; +export type { Fulfillment } from './models/fulfillment'; +export type { FulfillmentDeliveryDetails } from './models/fulfillmentDeliveryDetails'; +export type { FulfillmentFulfillmentEntry } from './models/fulfillmentFulfillmentEntry'; +export type { FulfillmentPickupDetails } from './models/fulfillmentPickupDetails'; +export type { FulfillmentPickupDetailsCurbsidePickupDetails } from './models/fulfillmentPickupDetailsCurbsidePickupDetails'; +export type { FulfillmentRecipient } from './models/fulfillmentRecipient'; +export type { FulfillmentShipmentDetails } from './models/fulfillmentShipmentDetails'; +export type { GetBankAccountByV1IdResponse } from './models/getBankAccountByV1IdResponse'; +export type { GetBankAccountResponse } from './models/getBankAccountResponse'; +export type { GetBreakTypeResponse } from './models/getBreakTypeResponse'; +export type { GetDeviceCodeResponse } from './models/getDeviceCodeResponse'; +export type { GetEmployeeWageResponse } from './models/getEmployeeWageResponse'; +export type { GetInvoiceResponse } from './models/getInvoiceResponse'; +export type { GetPaymentRefundResponse } from './models/getPaymentRefundResponse'; +export type { GetPaymentResponse } from './models/getPaymentResponse'; +export type { GetPayoutResponse } from './models/getPayoutResponse'; +export type { GetShiftResponse } from './models/getShiftResponse'; +export type { GetTeamMemberWageResponse } from './models/getTeamMemberWageResponse'; +export type { GetTerminalActionResponse } from './models/getTerminalActionResponse'; +export type { GetTerminalCheckoutResponse } from './models/getTerminalCheckoutResponse'; +export type { GetTerminalRefundResponse } from './models/getTerminalRefundResponse'; +export type { GiftCard } from './models/giftCard'; +export type { GiftCardActivity } from './models/giftCardActivity'; +export type { GiftCardActivityActivate } from './models/giftCardActivityActivate'; +export type { GiftCardActivityAdjustDecrement } from './models/giftCardActivityAdjustDecrement'; +export type { GiftCardActivityAdjustIncrement } from './models/giftCardActivityAdjustIncrement'; +export type { GiftCardActivityBlock } from './models/giftCardActivityBlock'; +export type { GiftCardActivityClearBalance } from './models/giftCardActivityClearBalance'; +export type { GiftCardActivityDeactivate } from './models/giftCardActivityDeactivate'; +export type { GiftCardActivityImport } from './models/giftCardActivityImport'; +export type { GiftCardActivityImportReversal } from './models/giftCardActivityImportReversal'; +export type { GiftCardActivityLoad } from './models/giftCardActivityLoad'; +export type { GiftCardActivityRedeem } from './models/giftCardActivityRedeem'; +export type { GiftCardActivityRefund } from './models/giftCardActivityRefund'; +export type { GiftCardActivityTransferBalanceFrom } from './models/giftCardActivityTransferBalanceFrom'; +export type { GiftCardActivityTransferBalanceTo } from './models/giftCardActivityTransferBalanceTo'; +export type { GiftCardActivityUnblock } from './models/giftCardActivityUnblock'; +export type { GiftCardActivityUnlinkedActivityRefund } from './models/giftCardActivityUnlinkedActivityRefund'; +export type { InventoryAdjustment } from './models/inventoryAdjustment'; +export type { InventoryAdjustmentGroup } from './models/inventoryAdjustmentGroup'; +export type { InventoryChange } from './models/inventoryChange'; +export type { InventoryCount } from './models/inventoryCount'; +export type { InventoryPhysicalCount } from './models/inventoryPhysicalCount'; +export type { InventoryTransfer } from './models/inventoryTransfer'; +export type { Invoice } from './models/invoice'; +export type { InvoiceAcceptedPaymentMethods } from './models/invoiceAcceptedPaymentMethods'; +export type { InvoiceCustomField } from './models/invoiceCustomField'; +export type { InvoiceFilter } from './models/invoiceFilter'; +export type { InvoicePaymentReminder } from './models/invoicePaymentReminder'; +export type { InvoicePaymentRequest } from './models/invoicePaymentRequest'; +export type { InvoiceQuery } from './models/invoiceQuery'; +export type { InvoiceRecipient } from './models/invoiceRecipient'; +export type { InvoiceRecipientTaxIds } from './models/invoiceRecipientTaxIds'; +export type { InvoiceSort } from './models/invoiceSort'; +export type { ItemVariationLocationOverrides } from './models/itemVariationLocationOverrides'; +export type { JobAssignment } from './models/jobAssignment'; +export type { LinkCustomerToGiftCardRequest } from './models/linkCustomerToGiftCardRequest'; +export type { LinkCustomerToGiftCardResponse } from './models/linkCustomerToGiftCardResponse'; +export type { ListBankAccountsRequest } from './models/listBankAccountsRequest'; +export type { ListBankAccountsResponse } from './models/listBankAccountsResponse'; +export type { ListBookingCustomAttributeDefinitionsRequest } from './models/listBookingCustomAttributeDefinitionsRequest'; +export type { ListBookingCustomAttributeDefinitionsResponse } from './models/listBookingCustomAttributeDefinitionsResponse'; +export type { ListBookingCustomAttributesRequest } from './models/listBookingCustomAttributesRequest'; +export type { ListBookingCustomAttributesResponse } from './models/listBookingCustomAttributesResponse'; +export type { ListBookingsRequest } from './models/listBookingsRequest'; +export type { ListBookingsResponse } from './models/listBookingsResponse'; +export type { ListBreakTypesRequest } from './models/listBreakTypesRequest'; +export type { ListBreakTypesResponse } from './models/listBreakTypesResponse'; +export type { ListCardsRequest } from './models/listCardsRequest'; +export type { ListCardsResponse } from './models/listCardsResponse'; +export type { ListCashDrawerShiftEventsRequest } from './models/listCashDrawerShiftEventsRequest'; +export type { ListCashDrawerShiftEventsResponse } from './models/listCashDrawerShiftEventsResponse'; +export type { ListCashDrawerShiftsRequest } from './models/listCashDrawerShiftsRequest'; +export type { ListCashDrawerShiftsResponse } from './models/listCashDrawerShiftsResponse'; +export type { ListCatalogRequest } from './models/listCatalogRequest'; +export type { ListCatalogResponse } from './models/listCatalogResponse'; +export type { ListCustomerCustomAttributeDefinitionsRequest } from './models/listCustomerCustomAttributeDefinitionsRequest'; +export type { ListCustomerCustomAttributeDefinitionsResponse } from './models/listCustomerCustomAttributeDefinitionsResponse'; +export type { ListCustomerCustomAttributesRequest } from './models/listCustomerCustomAttributesRequest'; +export type { ListCustomerCustomAttributesResponse } from './models/listCustomerCustomAttributesResponse'; +export type { ListCustomerGroupsRequest } from './models/listCustomerGroupsRequest'; +export type { ListCustomerGroupsResponse } from './models/listCustomerGroupsResponse'; +export type { ListCustomerSegmentsRequest } from './models/listCustomerSegmentsRequest'; +export type { ListCustomerSegmentsResponse } from './models/listCustomerSegmentsResponse'; +export type { ListCustomersRequest } from './models/listCustomersRequest'; +export type { ListCustomersResponse } from './models/listCustomersResponse'; +export type { ListDeviceCodesRequest } from './models/listDeviceCodesRequest'; +export type { ListDeviceCodesResponse } from './models/listDeviceCodesResponse'; +export type { ListDisputeEvidenceRequest } from './models/listDisputeEvidenceRequest'; +export type { ListDisputeEvidenceResponse } from './models/listDisputeEvidenceResponse'; +export type { ListDisputesRequest } from './models/listDisputesRequest'; +export type { ListDisputesResponse } from './models/listDisputesResponse'; +export type { ListEmployeesRequest } from './models/listEmployeesRequest'; +export type { ListEmployeesResponse } from './models/listEmployeesResponse'; +export type { ListEmployeeWagesRequest } from './models/listEmployeeWagesRequest'; +export type { ListEmployeeWagesResponse } from './models/listEmployeeWagesResponse'; +export type { ListGiftCardActivitiesRequest } from './models/listGiftCardActivitiesRequest'; +export type { ListGiftCardActivitiesResponse } from './models/listGiftCardActivitiesResponse'; +export type { ListGiftCardsRequest } from './models/listGiftCardsRequest'; +export type { ListGiftCardsResponse } from './models/listGiftCardsResponse'; +export type { ListInvoicesRequest } from './models/listInvoicesRequest'; +export type { ListInvoicesResponse } from './models/listInvoicesResponse'; +export type { ListLocationCustomAttributeDefinitionsRequest } from './models/listLocationCustomAttributeDefinitionsRequest'; +export type { ListLocationCustomAttributeDefinitionsResponse } from './models/listLocationCustomAttributeDefinitionsResponse'; +export type { ListLocationCustomAttributesRequest } from './models/listLocationCustomAttributesRequest'; +export type { ListLocationCustomAttributesResponse } from './models/listLocationCustomAttributesResponse'; +export type { ListLocationsResponse } from './models/listLocationsResponse'; +export type { ListLoyaltyProgramsResponse } from './models/listLoyaltyProgramsResponse'; +export type { ListLoyaltyPromotionsRequest } from './models/listLoyaltyPromotionsRequest'; +export type { ListLoyaltyPromotionsResponse } from './models/listLoyaltyPromotionsResponse'; +export type { ListMerchantsRequest } from './models/listMerchantsRequest'; +export type { ListMerchantsResponse } from './models/listMerchantsResponse'; +export type { ListOrderCustomAttributeDefinitionsRequest } from './models/listOrderCustomAttributeDefinitionsRequest'; +export type { ListOrderCustomAttributeDefinitionsResponse } from './models/listOrderCustomAttributeDefinitionsResponse'; +export type { ListOrderCustomAttributesRequest } from './models/listOrderCustomAttributesRequest'; +export type { ListOrderCustomAttributesResponse } from './models/listOrderCustomAttributesResponse'; +export type { ListPaymentLinksRequest } from './models/listPaymentLinksRequest'; +export type { ListPaymentLinksResponse } from './models/listPaymentLinksResponse'; +export type { ListPaymentRefundsRequest } from './models/listPaymentRefundsRequest'; +export type { ListPaymentRefundsResponse } from './models/listPaymentRefundsResponse'; +export type { ListPaymentsRequest } from './models/listPaymentsRequest'; +export type { ListPaymentsResponse } from './models/listPaymentsResponse'; +export type { ListPayoutEntriesRequest } from './models/listPayoutEntriesRequest'; +export type { ListPayoutEntriesResponse } from './models/listPayoutEntriesResponse'; +export type { ListPayoutsRequest } from './models/listPayoutsRequest'; +export type { ListPayoutsResponse } from './models/listPayoutsResponse'; +export type { ListRefundsRequest } from './models/listRefundsRequest'; +export type { ListRefundsResponse } from './models/listRefundsResponse'; +export type { ListSitesResponse } from './models/listSitesResponse'; +export type { ListSubscriptionEventsRequest } from './models/listSubscriptionEventsRequest'; +export type { ListSubscriptionEventsResponse } from './models/listSubscriptionEventsResponse'; +export type { ListTeamMemberBookingProfilesRequest } from './models/listTeamMemberBookingProfilesRequest'; +export type { ListTeamMemberBookingProfilesResponse } from './models/listTeamMemberBookingProfilesResponse'; +export type { ListTeamMemberWagesRequest } from './models/listTeamMemberWagesRequest'; +export type { ListTeamMemberWagesResponse } from './models/listTeamMemberWagesResponse'; +export type { ListTransactionsRequest } from './models/listTransactionsRequest'; +export type { ListTransactionsResponse } from './models/listTransactionsResponse'; +export type { ListWebhookEventTypesRequest } from './models/listWebhookEventTypesRequest'; +export type { ListWebhookEventTypesResponse } from './models/listWebhookEventTypesResponse'; +export type { ListWebhookSubscriptionsRequest } from './models/listWebhookSubscriptionsRequest'; +export type { ListWebhookSubscriptionsResponse } from './models/listWebhookSubscriptionsResponse'; +export type { ListWorkweekConfigsRequest } from './models/listWorkweekConfigsRequest'; +export type { ListWorkweekConfigsResponse } from './models/listWorkweekConfigsResponse'; +export type { Location } from './models/location'; +export type { LoyaltyAccount } from './models/loyaltyAccount'; +export type { LoyaltyAccountExpiringPointDeadline } from './models/loyaltyAccountExpiringPointDeadline'; +export type { LoyaltyAccountMapping } from './models/loyaltyAccountMapping'; +export type { LoyaltyEvent } from './models/loyaltyEvent'; +export type { LoyaltyEventAccumulatePoints } from './models/loyaltyEventAccumulatePoints'; +export type { LoyaltyEventAccumulatePromotionPoints } from './models/loyaltyEventAccumulatePromotionPoints'; +export type { LoyaltyEventAdjustPoints } from './models/loyaltyEventAdjustPoints'; +export type { LoyaltyEventCreateReward } from './models/loyaltyEventCreateReward'; +export type { LoyaltyEventDateTimeFilter } from './models/loyaltyEventDateTimeFilter'; +export type { LoyaltyEventDeleteReward } from './models/loyaltyEventDeleteReward'; +export type { LoyaltyEventExpirePoints } from './models/loyaltyEventExpirePoints'; +export type { LoyaltyEventFilter } from './models/loyaltyEventFilter'; +export type { LoyaltyEventLocationFilter } from './models/loyaltyEventLocationFilter'; +export type { LoyaltyEventLoyaltyAccountFilter } from './models/loyaltyEventLoyaltyAccountFilter'; +export type { LoyaltyEventOrderFilter } from './models/loyaltyEventOrderFilter'; +export type { LoyaltyEventOther } from './models/loyaltyEventOther'; +export type { LoyaltyEventQuery } from './models/loyaltyEventQuery'; +export type { LoyaltyEventRedeemReward } from './models/loyaltyEventRedeemReward'; +export type { LoyaltyEventTypeFilter } from './models/loyaltyEventTypeFilter'; +export type { LoyaltyProgram } from './models/loyaltyProgram'; +export type { LoyaltyProgramAccrualRule } from './models/loyaltyProgramAccrualRule'; +export type { LoyaltyProgramAccrualRuleCategoryData } from './models/loyaltyProgramAccrualRuleCategoryData'; +export type { LoyaltyProgramAccrualRuleItemVariationData } from './models/loyaltyProgramAccrualRuleItemVariationData'; +export type { LoyaltyProgramAccrualRuleSpendData } from './models/loyaltyProgramAccrualRuleSpendData'; +export type { LoyaltyProgramAccrualRuleVisitData } from './models/loyaltyProgramAccrualRuleVisitData'; +export type { LoyaltyProgramExpirationPolicy } from './models/loyaltyProgramExpirationPolicy'; +export type { LoyaltyProgramRewardDefinition } from './models/loyaltyProgramRewardDefinition'; +export type { LoyaltyProgramRewardTier } from './models/loyaltyProgramRewardTier'; +export type { LoyaltyProgramTerminology } from './models/loyaltyProgramTerminology'; +export type { LoyaltyPromotion } from './models/loyaltyPromotion'; +export type { LoyaltyPromotionAvailableTimeData } from './models/loyaltyPromotionAvailableTimeData'; +export type { LoyaltyPromotionIncentive } from './models/loyaltyPromotionIncentive'; +export type { LoyaltyPromotionIncentivePointsAdditionData } from './models/loyaltyPromotionIncentivePointsAdditionData'; +export type { LoyaltyPromotionIncentivePointsMultiplierData } from './models/loyaltyPromotionIncentivePointsMultiplierData'; +export type { LoyaltyPromotionTriggerLimit } from './models/loyaltyPromotionTriggerLimit'; +export type { LoyaltyReward } from './models/loyaltyReward'; +export type { MeasurementUnit } from './models/measurementUnit'; +export type { MeasurementUnitCustom } from './models/measurementUnitCustom'; +export type { Merchant } from './models/merchant'; +export type { Money } from './models/money'; +export type { ObtainTokenRequest } from './models/obtainTokenRequest'; +export type { ObtainTokenResponse } from './models/obtainTokenResponse'; +export type { Order } from './models/order'; +export type { OrderCreated } from './models/orderCreated'; +export type { OrderCreatedObject } from './models/orderCreatedObject'; +export type { OrderEntry } from './models/orderEntry'; +export type { OrderFulfillment } from './models/orderFulfillment'; +export type { OrderFulfillmentDeliveryDetails } from './models/orderFulfillmentDeliveryDetails'; +export type { OrderFulfillmentFulfillmentEntry } from './models/orderFulfillmentFulfillmentEntry'; +export type { OrderFulfillmentPickupDetails } from './models/orderFulfillmentPickupDetails'; +export type { OrderFulfillmentPickupDetailsCurbsidePickupDetails } from './models/orderFulfillmentPickupDetailsCurbsidePickupDetails'; +export type { OrderFulfillmentRecipient } from './models/orderFulfillmentRecipient'; +export type { OrderFulfillmentShipmentDetails } from './models/orderFulfillmentShipmentDetails'; +export type { OrderFulfillmentUpdated } from './models/orderFulfillmentUpdated'; +export type { OrderFulfillmentUpdatedObject } from './models/orderFulfillmentUpdatedObject'; +export type { OrderFulfillmentUpdatedUpdate } from './models/orderFulfillmentUpdatedUpdate'; +export type { OrderLineItem } from './models/orderLineItem'; +export type { OrderLineItemAppliedDiscount } from './models/orderLineItemAppliedDiscount'; +export type { OrderLineItemAppliedServiceCharge } from './models/orderLineItemAppliedServiceCharge'; +export type { OrderLineItemAppliedTax } from './models/orderLineItemAppliedTax'; +export type { OrderLineItemDiscount } from './models/orderLineItemDiscount'; +export type { OrderLineItemModifier } from './models/orderLineItemModifier'; +export type { OrderLineItemPricingBlocklists } from './models/orderLineItemPricingBlocklists'; +export type { OrderLineItemPricingBlocklistsBlockedDiscount } from './models/orderLineItemPricingBlocklistsBlockedDiscount'; +export type { OrderLineItemPricingBlocklistsBlockedTax } from './models/orderLineItemPricingBlocklistsBlockedTax'; +export type { OrderLineItemTax } from './models/orderLineItemTax'; +export type { OrderMoneyAmounts } from './models/orderMoneyAmounts'; +export type { OrderPricingOptions } from './models/orderPricingOptions'; +export type { OrderQuantityUnit } from './models/orderQuantityUnit'; +export type { OrderReturn } from './models/orderReturn'; +export type { OrderReturnDiscount } from './models/orderReturnDiscount'; +export type { OrderReturnLineItem } from './models/orderReturnLineItem'; +export type { OrderReturnLineItemModifier } from './models/orderReturnLineItemModifier'; +export type { OrderReturnServiceCharge } from './models/orderReturnServiceCharge'; +export type { OrderReturnTax } from './models/orderReturnTax'; +export type { OrderReward } from './models/orderReward'; +export type { OrderRoundingAdjustment } from './models/orderRoundingAdjustment'; +export type { OrderServiceCharge } from './models/orderServiceCharge'; +export type { OrderSource } from './models/orderSource'; +export type { OrderUpdated } from './models/orderUpdated'; +export type { OrderUpdatedObject } from './models/orderUpdatedObject'; +export type { PauseSubscriptionRequest } from './models/pauseSubscriptionRequest'; +export type { PauseSubscriptionResponse } from './models/pauseSubscriptionResponse'; +export type { Payment } from './models/payment'; +export type { PaymentBalanceActivityAppFeeRefundDetail } from './models/paymentBalanceActivityAppFeeRefundDetail'; +export type { PaymentBalanceActivityAppFeeRevenueDetail } from './models/paymentBalanceActivityAppFeeRevenueDetail'; +export type { PaymentBalanceActivityAutomaticSavingsDetail } from './models/paymentBalanceActivityAutomaticSavingsDetail'; +export type { PaymentBalanceActivityAutomaticSavingsReversedDetail } from './models/paymentBalanceActivityAutomaticSavingsReversedDetail'; +export type { PaymentBalanceActivityChargeDetail } from './models/paymentBalanceActivityChargeDetail'; +export type { PaymentBalanceActivityDepositFeeDetail } from './models/paymentBalanceActivityDepositFeeDetail'; +export type { PaymentBalanceActivityDisputeDetail } from './models/paymentBalanceActivityDisputeDetail'; +export type { PaymentBalanceActivityFeeDetail } from './models/paymentBalanceActivityFeeDetail'; +export type { PaymentBalanceActivityFreeProcessingDetail } from './models/paymentBalanceActivityFreeProcessingDetail'; +export type { PaymentBalanceActivityHoldAdjustmentDetail } from './models/paymentBalanceActivityHoldAdjustmentDetail'; +export type { PaymentBalanceActivityOpenDisputeDetail } from './models/paymentBalanceActivityOpenDisputeDetail'; +export type { PaymentBalanceActivityOtherAdjustmentDetail } from './models/paymentBalanceActivityOtherAdjustmentDetail'; +export type { PaymentBalanceActivityOtherDetail } from './models/paymentBalanceActivityOtherDetail'; +export type { PaymentBalanceActivityRefundDetail } from './models/paymentBalanceActivityRefundDetail'; +export type { PaymentBalanceActivityReleaseAdjustmentDetail } from './models/paymentBalanceActivityReleaseAdjustmentDetail'; +export type { PaymentBalanceActivityReserveHoldDetail } from './models/paymentBalanceActivityReserveHoldDetail'; +export type { PaymentBalanceActivityReserveReleaseDetail } from './models/paymentBalanceActivityReserveReleaseDetail'; +export type { PaymentBalanceActivitySquareCapitalPaymentDetail } from './models/paymentBalanceActivitySquareCapitalPaymentDetail'; +export type { PaymentBalanceActivitySquareCapitalReversedPaymentDetail } from './models/paymentBalanceActivitySquareCapitalReversedPaymentDetail'; +export type { PaymentBalanceActivityTaxOnFeeDetail } from './models/paymentBalanceActivityTaxOnFeeDetail'; +export type { PaymentBalanceActivityThirdPartyFeeDetail } from './models/paymentBalanceActivityThirdPartyFeeDetail'; +export type { PaymentBalanceActivityThirdPartyFeeRefundDetail } from './models/paymentBalanceActivityThirdPartyFeeRefundDetail'; +export type { PaymentLink } from './models/paymentLink'; +export type { PaymentLinkRelatedResources } from './models/paymentLinkRelatedResources'; +export type { PaymentOptions } from './models/paymentOptions'; +export type { PaymentRefund } from './models/paymentRefund'; +export type { PayOrderRequest } from './models/payOrderRequest'; +export type { PayOrderResponse } from './models/payOrderResponse'; +export type { Payout } from './models/payout'; +export type { PayoutEntry } from './models/payoutEntry'; +export type { PayoutFee } from './models/payoutFee'; +export type { PrePopulatedData } from './models/prePopulatedData'; +export type { ProcessingFee } from './models/processingFee'; +export type { PublishInvoiceRequest } from './models/publishInvoiceRequest'; +export type { PublishInvoiceResponse } from './models/publishInvoiceResponse'; +export type { QuantityRatio } from './models/quantityRatio'; +export type { QuickPay } from './models/quickPay'; +export type { Range } from './models/range'; +export type { ReceiptOptions } from './models/receiptOptions'; +export type { RedeemLoyaltyRewardRequest } from './models/redeemLoyaltyRewardRequest'; +export type { RedeemLoyaltyRewardResponse } from './models/redeemLoyaltyRewardResponse'; +export type { Refund } from './models/refund'; +export type { RefundPaymentRequest } from './models/refundPaymentRequest'; +export type { RefundPaymentResponse } from './models/refundPaymentResponse'; +export type { RegisterDomainRequest } from './models/registerDomainRequest'; +export type { RegisterDomainResponse } from './models/registerDomainResponse'; +export type { RemoveGroupFromCustomerResponse } from './models/removeGroupFromCustomerResponse'; +export type { RenewTokenRequest } from './models/renewTokenRequest'; +export type { RenewTokenResponse } from './models/renewTokenResponse'; +export type { ResumeSubscriptionRequest } from './models/resumeSubscriptionRequest'; +export type { ResumeSubscriptionResponse } from './models/resumeSubscriptionResponse'; +export type { RetrieveBookingCustomAttributeDefinitionRequest } from './models/retrieveBookingCustomAttributeDefinitionRequest'; +export type { RetrieveBookingCustomAttributeDefinitionResponse } from './models/retrieveBookingCustomAttributeDefinitionResponse'; +export type { RetrieveBookingCustomAttributeRequest } from './models/retrieveBookingCustomAttributeRequest'; +export type { RetrieveBookingCustomAttributeResponse } from './models/retrieveBookingCustomAttributeResponse'; +export type { RetrieveBookingResponse } from './models/retrieveBookingResponse'; +export type { RetrieveBusinessBookingProfileResponse } from './models/retrieveBusinessBookingProfileResponse'; +export type { RetrieveCardResponse } from './models/retrieveCardResponse'; +export type { RetrieveCashDrawerShiftRequest } from './models/retrieveCashDrawerShiftRequest'; +export type { RetrieveCashDrawerShiftResponse } from './models/retrieveCashDrawerShiftResponse'; +export type { RetrieveCatalogObjectRequest } from './models/retrieveCatalogObjectRequest'; +export type { RetrieveCatalogObjectResponse } from './models/retrieveCatalogObjectResponse'; +export type { RetrieveCustomerCustomAttributeDefinitionRequest } from './models/retrieveCustomerCustomAttributeDefinitionRequest'; +export type { RetrieveCustomerCustomAttributeDefinitionResponse } from './models/retrieveCustomerCustomAttributeDefinitionResponse'; +export type { RetrieveCustomerCustomAttributeRequest } from './models/retrieveCustomerCustomAttributeRequest'; +export type { RetrieveCustomerCustomAttributeResponse } from './models/retrieveCustomerCustomAttributeResponse'; +export type { RetrieveCustomerGroupResponse } from './models/retrieveCustomerGroupResponse'; +export type { RetrieveCustomerResponse } from './models/retrieveCustomerResponse'; +export type { RetrieveCustomerSegmentResponse } from './models/retrieveCustomerSegmentResponse'; +export type { RetrieveDisputeEvidenceResponse } from './models/retrieveDisputeEvidenceResponse'; +export type { RetrieveDisputeResponse } from './models/retrieveDisputeResponse'; +export type { RetrieveEmployeeResponse } from './models/retrieveEmployeeResponse'; +export type { RetrieveGiftCardFromGANRequest } from './models/retrieveGiftCardFromGANRequest'; +export type { RetrieveGiftCardFromGANResponse } from './models/retrieveGiftCardFromGANResponse'; +export type { RetrieveGiftCardFromNonceRequest } from './models/retrieveGiftCardFromNonceRequest'; +export type { RetrieveGiftCardFromNonceResponse } from './models/retrieveGiftCardFromNonceResponse'; +export type { RetrieveGiftCardResponse } from './models/retrieveGiftCardResponse'; +export type { RetrieveInventoryAdjustmentResponse } from './models/retrieveInventoryAdjustmentResponse'; +export type { RetrieveInventoryChangesRequest } from './models/retrieveInventoryChangesRequest'; +export type { RetrieveInventoryChangesResponse } from './models/retrieveInventoryChangesResponse'; +export type { RetrieveInventoryCountRequest } from './models/retrieveInventoryCountRequest'; +export type { RetrieveInventoryCountResponse } from './models/retrieveInventoryCountResponse'; +export type { RetrieveInventoryPhysicalCountResponse } from './models/retrieveInventoryPhysicalCountResponse'; +export type { RetrieveInventoryTransferResponse } from './models/retrieveInventoryTransferResponse'; +export type { RetrieveLocationCustomAttributeDefinitionRequest } from './models/retrieveLocationCustomAttributeDefinitionRequest'; +export type { RetrieveLocationCustomAttributeDefinitionResponse } from './models/retrieveLocationCustomAttributeDefinitionResponse'; +export type { RetrieveLocationCustomAttributeRequest } from './models/retrieveLocationCustomAttributeRequest'; +export type { RetrieveLocationCustomAttributeResponse } from './models/retrieveLocationCustomAttributeResponse'; +export type { RetrieveLocationResponse } from './models/retrieveLocationResponse'; +export type { RetrieveLoyaltyAccountResponse } from './models/retrieveLoyaltyAccountResponse'; +export type { RetrieveLoyaltyProgramResponse } from './models/retrieveLoyaltyProgramResponse'; +export type { RetrieveLoyaltyPromotionResponse } from './models/retrieveLoyaltyPromotionResponse'; +export type { RetrieveLoyaltyRewardResponse } from './models/retrieveLoyaltyRewardResponse'; +export type { RetrieveMerchantResponse } from './models/retrieveMerchantResponse'; +export type { RetrieveOrderCustomAttributeDefinitionRequest } from './models/retrieveOrderCustomAttributeDefinitionRequest'; +export type { RetrieveOrderCustomAttributeDefinitionResponse } from './models/retrieveOrderCustomAttributeDefinitionResponse'; +export type { RetrieveOrderCustomAttributeRequest } from './models/retrieveOrderCustomAttributeRequest'; +export type { RetrieveOrderCustomAttributeResponse } from './models/retrieveOrderCustomAttributeResponse'; +export type { RetrieveOrderResponse } from './models/retrieveOrderResponse'; +export type { RetrievePaymentLinkResponse } from './models/retrievePaymentLinkResponse'; +export type { RetrieveSnippetResponse } from './models/retrieveSnippetResponse'; +export type { RetrieveSubscriptionRequest } from './models/retrieveSubscriptionRequest'; +export type { RetrieveSubscriptionResponse } from './models/retrieveSubscriptionResponse'; +export type { RetrieveTeamMemberBookingProfileResponse } from './models/retrieveTeamMemberBookingProfileResponse'; +export type { RetrieveTeamMemberResponse } from './models/retrieveTeamMemberResponse'; +export type { RetrieveTokenStatusResponse } from './models/retrieveTokenStatusResponse'; +export type { RetrieveTransactionResponse } from './models/retrieveTransactionResponse'; +export type { RetrieveVendorResponse } from './models/retrieveVendorResponse'; +export type { RetrieveWageSettingResponse } from './models/retrieveWageSettingResponse'; +export type { RetrieveWebhookSubscriptionResponse } from './models/retrieveWebhookSubscriptionResponse'; +export type { RevokeTokenRequest } from './models/revokeTokenRequest'; +export type { RevokeTokenResponse } from './models/revokeTokenResponse'; +export type { RiskEvaluation } from './models/riskEvaluation'; +export type { SaveCardOptions } from './models/saveCardOptions'; +export type { SearchAvailabilityFilter } from './models/searchAvailabilityFilter'; +export type { SearchAvailabilityQuery } from './models/searchAvailabilityQuery'; +export type { SearchAvailabilityRequest } from './models/searchAvailabilityRequest'; +export type { SearchAvailabilityResponse } from './models/searchAvailabilityResponse'; +export type { SearchCatalogItemsRequest } from './models/searchCatalogItemsRequest'; +export type { SearchCatalogItemsResponse } from './models/searchCatalogItemsResponse'; +export type { SearchCatalogObjectsRequest } from './models/searchCatalogObjectsRequest'; +export type { SearchCatalogObjectsResponse } from './models/searchCatalogObjectsResponse'; +export type { SearchCustomersRequest } from './models/searchCustomersRequest'; +export type { SearchCustomersResponse } from './models/searchCustomersResponse'; +export type { SearchInvoicesRequest } from './models/searchInvoicesRequest'; +export type { SearchInvoicesResponse } from './models/searchInvoicesResponse'; +export type { SearchLoyaltyAccountsRequest } from './models/searchLoyaltyAccountsRequest'; +export type { SearchLoyaltyAccountsRequestLoyaltyAccountQuery } from './models/searchLoyaltyAccountsRequestLoyaltyAccountQuery'; +export type { SearchLoyaltyAccountsResponse } from './models/searchLoyaltyAccountsResponse'; +export type { SearchLoyaltyEventsRequest } from './models/searchLoyaltyEventsRequest'; +export type { SearchLoyaltyEventsResponse } from './models/searchLoyaltyEventsResponse'; +export type { SearchLoyaltyRewardsRequest } from './models/searchLoyaltyRewardsRequest'; +export type { SearchLoyaltyRewardsRequestLoyaltyRewardQuery } from './models/searchLoyaltyRewardsRequestLoyaltyRewardQuery'; +export type { SearchLoyaltyRewardsResponse } from './models/searchLoyaltyRewardsResponse'; +export type { SearchOrdersCustomerFilter } from './models/searchOrdersCustomerFilter'; +export type { SearchOrdersDateTimeFilter } from './models/searchOrdersDateTimeFilter'; +export type { SearchOrdersFilter } from './models/searchOrdersFilter'; +export type { SearchOrdersFulfillmentFilter } from './models/searchOrdersFulfillmentFilter'; +export type { SearchOrdersQuery } from './models/searchOrdersQuery'; +export type { SearchOrdersRequest } from './models/searchOrdersRequest'; +export type { SearchOrdersResponse } from './models/searchOrdersResponse'; +export type { SearchOrdersSort } from './models/searchOrdersSort'; +export type { SearchOrdersSourceFilter } from './models/searchOrdersSourceFilter'; +export type { SearchOrdersStateFilter } from './models/searchOrdersStateFilter'; +export type { SearchShiftsRequest } from './models/searchShiftsRequest'; +export type { SearchShiftsResponse } from './models/searchShiftsResponse'; +export type { SearchSubscriptionsFilter } from './models/searchSubscriptionsFilter'; +export type { SearchSubscriptionsQuery } from './models/searchSubscriptionsQuery'; +export type { SearchSubscriptionsRequest } from './models/searchSubscriptionsRequest'; +export type { SearchSubscriptionsResponse } from './models/searchSubscriptionsResponse'; +export type { SearchTeamMembersFilter } from './models/searchTeamMembersFilter'; +export type { SearchTeamMembersQuery } from './models/searchTeamMembersQuery'; +export type { SearchTeamMembersRequest } from './models/searchTeamMembersRequest'; +export type { SearchTeamMembersResponse } from './models/searchTeamMembersResponse'; +export type { SearchTerminalActionsRequest } from './models/searchTerminalActionsRequest'; +export type { SearchTerminalActionsResponse } from './models/searchTerminalActionsResponse'; +export type { SearchTerminalCheckoutsRequest } from './models/searchTerminalCheckoutsRequest'; +export type { SearchTerminalCheckoutsResponse } from './models/searchTerminalCheckoutsResponse'; +export type { SearchTerminalRefundsRequest } from './models/searchTerminalRefundsRequest'; +export type { SearchTerminalRefundsResponse } from './models/searchTerminalRefundsResponse'; +export type { SearchVendorsRequest } from './models/searchVendorsRequest'; +export type { SearchVendorsRequestFilter } from './models/searchVendorsRequestFilter'; +export type { SearchVendorsRequestSort } from './models/searchVendorsRequestSort'; +export type { SearchVendorsResponse } from './models/searchVendorsResponse'; +export type { SegmentFilter } from './models/segmentFilter'; +export type { Shift } from './models/shift'; +export type { ShiftFilter } from './models/shiftFilter'; +export type { ShiftQuery } from './models/shiftQuery'; +export type { ShiftSort } from './models/shiftSort'; +export type { ShiftWage } from './models/shiftWage'; +export type { ShiftWorkday } from './models/shiftWorkday'; +export type { ShippingFee } from './models/shippingFee'; +export type { Site } from './models/site'; +export type { Snippet } from './models/snippet'; +export type { SnippetResponse } from './models/snippetResponse'; +export type { SourceApplication } from './models/sourceApplication'; +export type { SquareEvent } from './models/squareEvent'; +export type { SquareEventData } from './models/squareEventData'; +export type { StandardUnitDescription } from './models/standardUnitDescription'; +export type { StandardUnitDescriptionGroup } from './models/standardUnitDescriptionGroup'; +export type { SubmitEvidenceResponse } from './models/submitEvidenceResponse'; +export type { Subscription } from './models/subscription'; +export type { SubscriptionAction } from './models/subscriptionAction'; +export type { SubscriptionEvent } from './models/subscriptionEvent'; +export type { SubscriptionEventInfo } from './models/subscriptionEventInfo'; +export type { SubscriptionPhase } from './models/subscriptionPhase'; +export type { SubscriptionSource } from './models/subscriptionSource'; +export type { SubscriptionTestResult } from './models/subscriptionTestResult'; +export type { SwapPlanRequest } from './models/swapPlanRequest'; +export type { SwapPlanResponse } from './models/swapPlanResponse'; +export type { TaxIds } from './models/taxIds'; +export type { TeamMember } from './models/teamMember'; +export type { TeamMemberAssignedLocations } from './models/teamMemberAssignedLocations'; +export type { TeamMemberBookingProfile } from './models/teamMemberBookingProfile'; +export type { TeamMemberWage } from './models/teamMemberWage'; +export type { Tender } from './models/tender'; +export type { TenderCardDetails } from './models/tenderCardDetails'; +export type { TenderCashDetails } from './models/tenderCashDetails'; +export type { TerminalAction } from './models/terminalAction'; +export type { TerminalActionQuery } from './models/terminalActionQuery'; +export type { TerminalActionQueryFilter } from './models/terminalActionQueryFilter'; +export type { TerminalActionQuerySort } from './models/terminalActionQuerySort'; +export type { TerminalCheckout } from './models/terminalCheckout'; +export type { TerminalCheckoutQuery } from './models/terminalCheckoutQuery'; +export type { TerminalCheckoutQueryFilter } from './models/terminalCheckoutQueryFilter'; +export type { TerminalCheckoutQuerySort } from './models/terminalCheckoutQuerySort'; +export type { TerminalRefund } from './models/terminalRefund'; +export type { TerminalRefundQuery } from './models/terminalRefundQuery'; +export type { TerminalRefundQueryFilter } from './models/terminalRefundQueryFilter'; +export type { TerminalRefundQuerySort } from './models/terminalRefundQuerySort'; +export type { TestWebhookSubscriptionRequest } from './models/testWebhookSubscriptionRequest'; +export type { TestWebhookSubscriptionResponse } from './models/testWebhookSubscriptionResponse'; +export type { TimeRange } from './models/timeRange'; +export type { TipSettings } from './models/tipSettings'; +export type { Transaction } from './models/transaction'; +export type { UnlinkCustomerFromGiftCardRequest } from './models/unlinkCustomerFromGiftCardRequest'; +export type { UnlinkCustomerFromGiftCardResponse } from './models/unlinkCustomerFromGiftCardResponse'; +export type { UpdateBookingCustomAttributeDefinitionRequest } from './models/updateBookingCustomAttributeDefinitionRequest'; +export type { UpdateBookingCustomAttributeDefinitionResponse } from './models/updateBookingCustomAttributeDefinitionResponse'; +export type { UpdateBookingRequest } from './models/updateBookingRequest'; +export type { UpdateBookingResponse } from './models/updateBookingResponse'; +export type { UpdateBreakTypeRequest } from './models/updateBreakTypeRequest'; +export type { UpdateBreakTypeResponse } from './models/updateBreakTypeResponse'; +export type { UpdateCatalogImageRequest } from './models/updateCatalogImageRequest'; +export type { UpdateCatalogImageResponse } from './models/updateCatalogImageResponse'; +export type { UpdateCustomerCustomAttributeDefinitionRequest } from './models/updateCustomerCustomAttributeDefinitionRequest'; +export type { UpdateCustomerCustomAttributeDefinitionResponse } from './models/updateCustomerCustomAttributeDefinitionResponse'; +export type { UpdateCustomerGroupRequest } from './models/updateCustomerGroupRequest'; +export type { UpdateCustomerGroupResponse } from './models/updateCustomerGroupResponse'; +export type { UpdateCustomerRequest } from './models/updateCustomerRequest'; +export type { UpdateCustomerResponse } from './models/updateCustomerResponse'; +export type { UpdateInvoiceRequest } from './models/updateInvoiceRequest'; +export type { UpdateInvoiceResponse } from './models/updateInvoiceResponse'; +export type { UpdateItemModifierListsRequest } from './models/updateItemModifierListsRequest'; +export type { UpdateItemModifierListsResponse } from './models/updateItemModifierListsResponse'; +export type { UpdateItemTaxesRequest } from './models/updateItemTaxesRequest'; +export type { UpdateItemTaxesResponse } from './models/updateItemTaxesResponse'; +export type { UpdateLocationCustomAttributeDefinitionRequest } from './models/updateLocationCustomAttributeDefinitionRequest'; +export type { UpdateLocationCustomAttributeDefinitionResponse } from './models/updateLocationCustomAttributeDefinitionResponse'; +export type { UpdateLocationRequest } from './models/updateLocationRequest'; +export type { UpdateLocationResponse } from './models/updateLocationResponse'; +export type { UpdateOrderCustomAttributeDefinitionRequest } from './models/updateOrderCustomAttributeDefinitionRequest'; +export type { UpdateOrderCustomAttributeDefinitionResponse } from './models/updateOrderCustomAttributeDefinitionResponse'; +export type { UpdateOrderRequest } from './models/updateOrderRequest'; +export type { UpdateOrderResponse } from './models/updateOrderResponse'; +export type { UpdatePaymentLinkRequest } from './models/updatePaymentLinkRequest'; +export type { UpdatePaymentLinkResponse } from './models/updatePaymentLinkResponse'; +export type { UpdatePaymentRequest } from './models/updatePaymentRequest'; +export type { UpdatePaymentResponse } from './models/updatePaymentResponse'; +export type { UpdateShiftRequest } from './models/updateShiftRequest'; +export type { UpdateShiftResponse } from './models/updateShiftResponse'; +export type { UpdateSubscriptionRequest } from './models/updateSubscriptionRequest'; +export type { UpdateSubscriptionResponse } from './models/updateSubscriptionResponse'; +export type { UpdateTeamMemberRequest } from './models/updateTeamMemberRequest'; +export type { UpdateTeamMemberResponse } from './models/updateTeamMemberResponse'; +export type { UpdateVendorRequest } from './models/updateVendorRequest'; +export type { UpdateVendorResponse } from './models/updateVendorResponse'; +export type { UpdateWageSettingRequest } from './models/updateWageSettingRequest'; +export type { UpdateWageSettingResponse } from './models/updateWageSettingResponse'; +export type { UpdateWebhookSubscriptionRequest } from './models/updateWebhookSubscriptionRequest'; +export type { UpdateWebhookSubscriptionResponse } from './models/updateWebhookSubscriptionResponse'; +export type { UpdateWebhookSubscriptionSignatureKeyRequest } from './models/updateWebhookSubscriptionSignatureKeyRequest'; +export type { UpdateWebhookSubscriptionSignatureKeyResponse } from './models/updateWebhookSubscriptionSignatureKeyResponse'; +export type { UpdateWorkweekConfigRequest } from './models/updateWorkweekConfigRequest'; +export type { UpdateWorkweekConfigResponse } from './models/updateWorkweekConfigResponse'; +export type { UpsertBookingCustomAttributeRequest } from './models/upsertBookingCustomAttributeRequest'; +export type { UpsertBookingCustomAttributeResponse } from './models/upsertBookingCustomAttributeResponse'; +export type { UpsertCatalogObjectRequest } from './models/upsertCatalogObjectRequest'; +export type { UpsertCatalogObjectResponse } from './models/upsertCatalogObjectResponse'; +export type { UpsertCustomerCustomAttributeRequest } from './models/upsertCustomerCustomAttributeRequest'; +export type { UpsertCustomerCustomAttributeResponse } from './models/upsertCustomerCustomAttributeResponse'; +export type { UpsertLocationCustomAttributeRequest } from './models/upsertLocationCustomAttributeRequest'; +export type { UpsertLocationCustomAttributeResponse } from './models/upsertLocationCustomAttributeResponse'; +export type { UpsertOrderCustomAttributeRequest } from './models/upsertOrderCustomAttributeRequest'; +export type { UpsertOrderCustomAttributeResponse } from './models/upsertOrderCustomAttributeResponse'; +export type { UpsertSnippetRequest } from './models/upsertSnippetRequest'; +export type { UpsertSnippetResponse } from './models/upsertSnippetResponse'; +export type { V1CreateRefundRequest } from './models/v1CreateRefundRequest'; +export type { V1ListOrdersRequest } from './models/v1ListOrdersRequest'; +export type { V1ListOrdersResponse } from './models/v1ListOrdersResponse'; +export type { V1ListPaymentsRequest } from './models/v1ListPaymentsRequest'; +export type { V1ListPaymentsResponse } from './models/v1ListPaymentsResponse'; +export type { V1ListRefundsRequest } from './models/v1ListRefundsRequest'; +export type { V1ListRefundsResponse } from './models/v1ListRefundsResponse'; +export type { V1ListSettlementsRequest } from './models/v1ListSettlementsRequest'; +export type { V1ListSettlementsResponse } from './models/v1ListSettlementsResponse'; +export type { V1Money } from './models/v1Money'; +export type { V1Order } from './models/v1Order'; +export type { V1OrderHistoryEntry } from './models/v1OrderHistoryEntry'; +export type { V1Payment } from './models/v1Payment'; +export type { V1PaymentDiscount } from './models/v1PaymentDiscount'; +export type { V1PaymentItemDetail } from './models/v1PaymentItemDetail'; +export type { V1PaymentItemization } from './models/v1PaymentItemization'; +export type { V1PaymentModifier } from './models/v1PaymentModifier'; +export type { V1PaymentSurcharge } from './models/v1PaymentSurcharge'; +export type { V1PaymentTax } from './models/v1PaymentTax'; +export type { V1PhoneNumber } from './models/v1PhoneNumber'; +export type { V1Refund } from './models/v1Refund'; +export type { V1Settlement } from './models/v1Settlement'; +export type { V1SettlementEntry } from './models/v1SettlementEntry'; +export type { V1Tender } from './models/v1Tender'; +export type { V1UpdateOrderRequest } from './models/v1UpdateOrderRequest'; +export type { Vendor } from './models/vendor'; +export type { VendorContact } from './models/vendorContact'; +export type { VoidTransactionResponse } from './models/voidTransactionResponse'; +export type { WageSetting } from './models/wageSetting'; +export type { WebhookSubscription } from './models/webhookSubscription'; +export type { WorkweekConfig } from './models/workweekConfig'; export * from './utilities/webhooksHelper'; diff --git a/src/models/accumulateLoyaltyPointsRequest.ts b/src/models/accumulateLoyaltyPointsRequest.ts index fa32e6d3..cc17458e 100644 --- a/src/models/accumulateLoyaltyPointsRequest.ts +++ b/src/models/accumulateLoyaltyPointsRequest.ts @@ -13,7 +13,7 @@ export interface AccumulateLoyaltyPointsRequest { * Keys can be any valid string but must be unique for every request. */ idempotencyKey: string; - /** The [location]($m/Location) where the purchase was made. */ + /** The [location](entity:Location) where the purchase was made. */ locationId: string; } diff --git a/src/models/appointmentSegment.ts b/src/models/appointmentSegment.ts index 84980267..011ffc88 100644 --- a/src/models/appointmentSegment.ts +++ b/src/models/appointmentSegment.ts @@ -14,9 +14,9 @@ import { export interface AppointmentSegment { /** The time span in minutes of an appointment segment. */ durationMinutes?: number | null; - /** The ID of the [CatalogItemVariation]($m/CatalogItemVariation) object representing the service booked in this segment. */ + /** The ID of the [CatalogItemVariation](entity:CatalogItemVariation) object representing the service booked in this segment. */ serviceVariationId?: string | null; - /** The ID of the [TeamMember]($m/TeamMember) object representing the team member booked in this segment. */ + /** The ID of the [TeamMember](entity:TeamMember) object representing the team member booked in this segment. */ teamMemberId: string; /** The current version of the item variation representing the service booked in this segment. */ serviceVariationVersion?: bigint | null; diff --git a/src/models/batchChangeInventoryRequest.ts b/src/models/batchChangeInventoryRequest.ts index 1856c0c5..8937f9ee 100644 --- a/src/models/batchChangeInventoryRequest.ts +++ b/src/models/batchChangeInventoryRequest.ts @@ -14,8 +14,8 @@ export interface BatchChangeInventoryRequest { /** * A client-supplied, universally unique identifier (UUID) for the * request. - * See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the - * [API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more + * 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. */ idempotencyKey: string; diff --git a/src/models/batchRetrieveCatalogObjectsResponse.ts b/src/models/batchRetrieveCatalogObjectsResponse.ts index 83736833..9b756568 100644 --- a/src/models/batchRetrieveCatalogObjectsResponse.ts +++ b/src/models/batchRetrieveCatalogObjectsResponse.ts @@ -5,9 +5,9 @@ import { Error, errorSchema } from './error'; export interface BatchRetrieveCatalogObjectsResponse { /** Any errors that occurred during the request. */ errors?: Error[]; - /** A list of [CatalogObject]($m/CatalogObject)s returned. */ + /** A list of [CatalogObject](entity:CatalogObject)s returned. */ objects?: CatalogObject[]; - /** A list of [CatalogObject]($m/CatalogObject)s referenced by the object in the `objects` field. */ + /** A list of [CatalogObject](entity:CatalogObject)s referenced by the object in the `objects` field. */ relatedObjects?: CatalogObject[]; } diff --git a/src/models/batchRetrieveInventoryChangesRequest.ts b/src/models/batchRetrieveInventoryChangesRequest.ts index 21644f3c..fad416dd 100644 --- a/src/models/batchRetrieveInventoryChangesRequest.ts +++ b/src/models/batchRetrieveInventoryChangesRequest.ts @@ -48,7 +48,7 @@ export interface BatchRetrieveInventoryChangesRequest { * See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. */ cursor?: string | null; - /** The number of [records]($m/InventoryChange) to return. */ + /** The number of [records](entity:InventoryChange) to return. */ limit?: number | null; } diff --git a/src/models/batchRetrieveInventoryCountsRequest.ts b/src/models/batchRetrieveInventoryCountsRequest.ts index 0a80c6d9..78104b84 100644 --- a/src/models/batchRetrieveInventoryCountsRequest.ts +++ b/src/models/batchRetrieveInventoryCountsRequest.ts @@ -37,7 +37,7 @@ export interface BatchRetrieveInventoryCountsRequest { * The default is null. */ states?: string[] | null; - /** The number of [records]($m/InventoryCount) to return. */ + /** The number of [records](entity:InventoryCount) to return. */ limit?: number | null; } diff --git a/src/models/batchUpsertCatalogObjectsRequest.ts b/src/models/batchUpsertCatalogObjectsRequest.ts index 9e44b550..8084cdcf 100644 --- a/src/models/batchUpsertCatalogObjectsRequest.ts +++ b/src/models/batchUpsertCatalogObjectsRequest.ts @@ -13,7 +13,7 @@ export interface BatchUpsertCatalogObjectsRequest { * 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/basics/api101/idempotency) for more information. + * See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. */ idempotencyKey: string; /** diff --git a/src/models/booking.ts b/src/models/booking.ts index c144d60b..418dc2c8 100644 --- a/src/models/booking.ts +++ b/src/models/booking.ts @@ -35,14 +35,14 @@ export interface Booking { updatedAt?: string; /** The RFC 3339 timestamp specifying the starting time of this booking. */ startAt?: string | null; - /** The ID of the [Location]($m/Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed. */ + /** The ID of the [Location](entity:Location) object representing the location where the booked service is provided. Once set when the booking is created, its value cannot be changed. */ locationId?: string | null; - /** The ID of the [Customer]($m/Customer) object representing the customer receiving the booked service. */ + /** The ID of the [Customer](entity:Customer) object representing the customer receiving the booked service. */ customerId?: string | null; - /** The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject]($m/CatalogObject) instance. */ + /** The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant [CatalogObject](entity:CatalogObject) instance. */ customerNote?: string | null; /** - * The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject]($m/CatalogObject) instance. + * The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific [CatalogObject](entity:CatalogObject) instance. * This field should not be visible to customers. */ sellerNote?: string | null; diff --git a/src/models/bookingCustomAttributeDeleteRequest.ts b/src/models/bookingCustomAttributeDeleteRequest.ts index 829a4f0f..71109eea 100644 --- a/src/models/bookingCustomAttributeDeleteRequest.ts +++ b/src/models/bookingCustomAttributeDeleteRequest.ts @@ -5,7 +5,7 @@ import { object, Schema, string } from '../schema'; * request. An individual request contains a booking ID, the custom attribute to delete, and an optional idempotency key. */ export interface BookingCustomAttributeDeleteRequest { - /** The ID of the target [booking]($m/Booking). */ + /** The ID of the target [booking](entity:Booking). */ bookingId: string; /** * The key of the custom attribute to delete. This key must match the `key` of a diff --git a/src/models/bookingCustomAttributeDeleteResponse.ts b/src/models/bookingCustomAttributeDeleteResponse.ts index a1af9e2e..276eaae8 100644 --- a/src/models/bookingCustomAttributeDeleteResponse.ts +++ b/src/models/bookingCustomAttributeDeleteResponse.ts @@ -3,7 +3,7 @@ import { Error, errorSchema } from './error'; /** Represents a response for an individual upsert request in a [BulkDeleteBookingCustomAttributes]($e/BookingCustomAttributes/BulkDeleteBookingCustomAttributes) operation. */ export interface BookingCustomAttributeDeleteResponse { - /** The ID of the [booking]($m/Booking) associated with the custom attribute. */ + /** The ID of the [booking](entity:Booking) associated with the custom attribute. */ bookingId?: string; /** Any errors that occurred while processing the individual request. */ errors?: Error[]; diff --git a/src/models/bookingCustomAttributeUpsertRequest.ts b/src/models/bookingCustomAttributeUpsertRequest.ts index 39fdb88d..20627aa7 100644 --- a/src/models/bookingCustomAttributeUpsertRequest.ts +++ b/src/models/bookingCustomAttributeUpsertRequest.ts @@ -7,7 +7,7 @@ import { CustomAttribute, customAttributeSchema } from './customAttribute'; * and an optional idempotency key. */ export interface BookingCustomAttributeUpsertRequest { - /** The ID of the target [booking]($m/Booking). */ + /** The ID of the target [booking](entity:Booking). */ bookingId: string; /** * A custom attribute value. Each custom attribute value has a corresponding diff --git a/src/models/bookingCustomAttributeUpsertResponse.ts b/src/models/bookingCustomAttributeUpsertResponse.ts index 78137cb0..6d84aec5 100644 --- a/src/models/bookingCustomAttributeUpsertResponse.ts +++ b/src/models/bookingCustomAttributeUpsertResponse.ts @@ -4,7 +4,7 @@ import { Error, errorSchema } from './error'; /** Represents a response for an individual upsert request in a [BulkUpsertBookingCustomAttributes]($e/BookingCustomAttributes/BulkUpsertBookingCustomAttributes) operation. */ export interface BookingCustomAttributeUpsertResponse { - /** The ID of the [booking]($m/Booking) associated with the custom attribute. */ + /** The ID of the [booking](entity:Booking) associated with the custom attribute. */ bookingId?: string; /** * A custom attribute value. Each custom attribute value has a corresponding diff --git a/src/models/bulkCreateTeamMembersRequest.ts b/src/models/bulkCreateTeamMembersRequest.ts index bf245419..911dc3cf 100644 --- a/src/models/bulkCreateTeamMembersRequest.ts +++ b/src/models/bulkCreateTeamMembersRequest.ts @@ -6,7 +6,7 @@ import { /** Represents a bulk create request for `TeamMember` objects. */ export interface BulkCreateTeamMembersRequest { - /** The data used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. */ + /** The data used to create the `TeamMember` objects. Each key is the `idempotency_key` that maps to the `CreateTeamMemberRequest`. The maximum number of create objects is 25. */ teamMembers: Record; } diff --git a/src/models/bulkCreateVendorsRequest.ts b/src/models/bulkCreateVendorsRequest.ts index d0d8c241..e4e6f051 100644 --- a/src/models/bulkCreateVendorsRequest.ts +++ b/src/models/bulkCreateVendorsRequest.ts @@ -3,7 +3,7 @@ import { Vendor, vendorSchema } from './vendor'; /** Represents an input to a call to [BulkCreateVendors]($e/Vendors/BulkCreateVendors). */ export interface BulkCreateVendorsRequest { - /** Specifies a set of new [Vendor]($m/Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs. */ + /** Specifies a set of new [Vendor](entity:Vendor) objects as represented by a collection of idempotency-key/`Vendor`-object pairs. */ vendors: Record; } diff --git a/src/models/bulkCreateVendorsResponse.ts b/src/models/bulkCreateVendorsResponse.ts index b638ad88..b9ebc739 100644 --- a/src/models/bulkCreateVendorsResponse.ts +++ b/src/models/bulkCreateVendorsResponse.ts @@ -10,7 +10,7 @@ export interface BulkCreateVendorsResponse { /** Any errors that occurred during the request. */ errors?: Error[]; /** - * A set of [CreateVendorResponse]($m/CreateVendorResponse) objects encapsulating successfully created [Vendor]($m/Vendor) + * A set of [CreateVendorResponse](entity:CreateVendorResponse) objects encapsulating successfully created [Vendor](entity:Vendor) * objects or error responses for failed attempts. The set is represented by * a collection of idempotency-key/`Vendor`-object or idempotency-key/error-object pairs. The idempotency keys correspond to those specified * in the input. diff --git a/src/models/bulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute.ts b/src/models/bulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute.ts index 5b450dce..fc3cbee7 100644 --- a/src/models/bulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute.ts +++ b/src/models/bulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute.ts @@ -7,7 +7,7 @@ export interface BulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute { * of an existing custom attribute definition. */ key?: string; - /** The ID of the target [order]($m/Order). */ + /** The ID of the target [order](entity:Order). */ orderId: string; } diff --git a/src/models/bulkRetrieveVendorsRequest.ts b/src/models/bulkRetrieveVendorsRequest.ts index e1a772d0..ac08e554 100644 --- a/src/models/bulkRetrieveVendorsRequest.ts +++ b/src/models/bulkRetrieveVendorsRequest.ts @@ -2,7 +2,7 @@ import { array, nullable, object, optional, Schema, string } from '../schema'; /** Represents an input to a call to [BulkRetrieveVendors]($e/Vendors/BulkRetrieveVendors). */ export interface BulkRetrieveVendorsRequest { - /** IDs of the [Vendor]($m/Vendor) objects to retrieve. */ + /** IDs of the [Vendor](entity:Vendor) objects to retrieve. */ vendorIds?: string[] | null; } diff --git a/src/models/bulkRetrieveVendorsResponse.ts b/src/models/bulkRetrieveVendorsResponse.ts index c574f768..41b99a50 100644 --- a/src/models/bulkRetrieveVendorsResponse.ts +++ b/src/models/bulkRetrieveVendorsResponse.ts @@ -10,7 +10,7 @@ export interface BulkRetrieveVendorsResponse { /** Any errors that occurred during the request. */ errors?: Error[]; /** - * The set of [RetrieveVendorResponse]($m/RetrieveVendorResponse) objects encapsulating successfully retrieved [Vendor]($m/Vendor) + * The set of [RetrieveVendorResponse](entity:RetrieveVendorResponse) objects encapsulating successfully retrieved [Vendor](entity:Vendor) * objects or error responses for failed attempts. The set is represented by * a collection of `Vendor`-ID/`Vendor`-object or `Vendor`-ID/error-object pairs. */ diff --git a/src/models/bulkUpdateTeamMembersRequest.ts b/src/models/bulkUpdateTeamMembersRequest.ts index 4ac0ea07..aa5962ad 100644 --- a/src/models/bulkUpdateTeamMembersRequest.ts +++ b/src/models/bulkUpdateTeamMembersRequest.ts @@ -6,7 +6,7 @@ import { /** Represents a bulk update request for `TeamMember` objects. */ export interface BulkUpdateTeamMembersRequest { - /** The data used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. */ + /** The data used to update the `TeamMember` objects. Each key is the `team_member_id` that maps to the `UpdateTeamMemberRequest`. The maximum number of update objects is 25. */ teamMembers: Record; } diff --git a/src/models/bulkUpdateVendorsRequest.ts b/src/models/bulkUpdateVendorsRequest.ts index fddcb21f..d902469c 100644 --- a/src/models/bulkUpdateVendorsRequest.ts +++ b/src/models/bulkUpdateVendorsRequest.ts @@ -7,7 +7,7 @@ import { /** Represents an input to a call to [BulkUpdateVendors]($e/Vendors/BulkUpdateVendors). */ export interface BulkUpdateVendorsRequest { /** - * A set of [UpdateVendorRequest]($m/UpdateVendorRequest) objects encapsulating to-be-updated [Vendor]($m/Vendor) + * A set of [UpdateVendorRequest](entity:UpdateVendorRequest) objects encapsulating to-be-updated [Vendor](entity:Vendor) * objects. The set is represented by a collection of `Vendor`-ID/`UpdateVendorRequest`-object pairs. */ vendors: Record; diff --git a/src/models/bulkUpdateVendorsResponse.ts b/src/models/bulkUpdateVendorsResponse.ts index 09412d77..f4f38d54 100644 --- a/src/models/bulkUpdateVendorsResponse.ts +++ b/src/models/bulkUpdateVendorsResponse.ts @@ -10,7 +10,7 @@ export interface BulkUpdateVendorsResponse { /** Errors encountered when the request fails. */ errors?: Error[]; /** - * A set of [UpdateVendorResponse]($m/UpdateVendorResponse) objects encapsulating successfully created [Vendor]($m/Vendor) + * A set of [UpdateVendorResponse](entity:UpdateVendorResponse) objects encapsulating successfully created [Vendor](entity:Vendor) * objects or error responses for failed attempts. The set is represented by a collection of `Vendor`-ID/`UpdateVendorResponse`-object or * `Vendor`-ID/error-object pairs. */ diff --git a/src/models/bulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest.ts b/src/models/bulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest.ts index 2ddd6cdd..9de367d3 100644 --- a/src/models/bulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest.ts +++ b/src/models/bulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest.ts @@ -7,7 +7,7 @@ import { CustomAttribute, customAttributeSchema } from './customAttribute'; * and an optional idempotency key. */ export interface BulkUpsertCustomerCustomAttributesRequestCustomerCustomAttributeUpsertRequest { - /** The ID of the target [customer profile]($m/Customer). */ + /** The ID of the target [customer profile](entity:Customer). */ customerId: string; /** * A custom attribute value. Each custom attribute value has a corresponding diff --git a/src/models/bulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest.ts b/src/models/bulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest.ts index 1fc34b2b..ef03b2c4 100644 --- a/src/models/bulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest.ts +++ b/src/models/bulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest.ts @@ -7,7 +7,7 @@ import { CustomAttribute, customAttributeSchema } from './customAttribute'; * and an optional idempotency key. */ export interface BulkUpsertLocationCustomAttributesRequestLocationCustomAttributeUpsertRequest { - /** The ID of the target [location]($m/Location). */ + /** The ID of the target [location](entity:Location). */ locationId: string; /** * A custom attribute value. Each custom attribute value has a corresponding diff --git a/src/models/bulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute.ts b/src/models/bulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute.ts index ff55169e..5ca90992 100644 --- a/src/models/bulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute.ts +++ b/src/models/bulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute.ts @@ -13,7 +13,7 @@ export interface BulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute { * For more information, see [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency). */ idempotencyKey?: string | null; - /** The ID of the target [order]($m/Order). */ + /** The ID of the target [order](entity:Order). */ orderId: string; } diff --git a/src/models/calculateLoyaltyPointsRequest.ts b/src/models/calculateLoyaltyPointsRequest.ts index aeb61060..a4779271 100644 --- a/src/models/calculateLoyaltyPointsRequest.ts +++ b/src/models/calculateLoyaltyPointsRequest.ts @@ -4,7 +4,7 @@ import { Money, moneySchema } from './money'; /** Represents a [CalculateLoyaltyPoints]($e/Loyalty/CalculateLoyaltyPoints) request. */ export interface CalculateLoyaltyPointsRequest { /** - * The [order]($m/Order) ID for which to calculate the points. + * The [order](entity:Order) ID for which to calculate the points. * Specify this field if your application uses the Orders API to process orders. * Otherwise, specify the `transaction_amount_money`. */ @@ -19,7 +19,7 @@ export interface CalculateLoyaltyPointsRequest { */ transactionAmountMoney?: Money; /** - * The ID of the target [loyalty account]($m/LoyaltyAccount). Optionally specify this field + * The ID of the target [loyalty account](entity:LoyaltyAccount). Optionally specify this field * if your application uses the Orders API to process orders. * If specified, the `promotion_points` field in the response shows the number of points the buyer would * earn from the purchase. In this case, Square uses the account ID to determine whether the promotion's diff --git a/src/models/cancelInvoiceRequest.ts b/src/models/cancelInvoiceRequest.ts index ab3f9a71..1e1e58e0 100644 --- a/src/models/cancelInvoiceRequest.ts +++ b/src/models/cancelInvoiceRequest.ts @@ -3,9 +3,9 @@ import { number, object, Schema } from '../schema'; /** Describes a `CancelInvoice` request. */ export interface CancelInvoiceRequest { /** - * The version of the [invoice]($m/Invoice) to cancel. + * The version of the [invoice](entity:Invoice) to cancel. * If you do not know the version, you can call - * [GetInvoice]($e/Invoices/GetInvoice) or [ListInvoices]($e/Invoices/ListInvoices). + * [GetInvoice](api-endpoint:Invoices-GetInvoice) or [ListInvoices](api-endpoint:Invoices-ListInvoices). */ version: number; } diff --git a/src/models/captureTransactionResponse.ts b/src/models/captureTransactionResponse.ts index 005047d5..8913b3e2 100644 --- a/src/models/captureTransactionResponse.ts +++ b/src/models/captureTransactionResponse.ts @@ -3,7 +3,7 @@ import { Error, errorSchema } from './error'; /** * Defines the fields that are included in the response body of - * a request to the [CaptureTransaction]($e/Transactions/CaptureTransaction) endpoint. + * a request to the [CaptureTransaction](api-endpoint:Transactions-CaptureTransaction) endpoint. */ export interface CaptureTransactionResponse { /** Any errors that occurred during the request. */ diff --git a/src/models/cashAppDetails.ts b/src/models/cashAppDetails.ts index 7eecd3f4..de2ab0d9 100644 --- a/src/models/cashAppDetails.ts +++ b/src/models/cashAppDetails.ts @@ -6,7 +6,7 @@ export interface CashAppDetails { buyerFullName?: string | null; /** * The country of the Cash App account holder, in ISO 3166-1-alpha-2 format. - * For possible values, see [Country]($m/Country). + * For possible values, see [Country](entity:Country). */ buyerCountryCode?: string | null; /** $Cashtag of the Cash App account holder. */ diff --git a/src/models/catalogCustomAttributeDefinition.ts b/src/models/catalogCustomAttributeDefinition.ts index e524f6f3..53b0cff2 100644 --- a/src/models/catalogCustomAttributeDefinition.ts +++ b/src/models/catalogCustomAttributeDefinition.ts @@ -49,8 +49,8 @@ export interface CatalogCustomAttributeDefinition { /** Represents information about the application used to generate a change. */ sourceApplication?: SourceApplication; /** - * The set of Catalog Object Types that this Custom Attribute may be applied to. - * Currently, only `ITEM` and `ITEM_VARIATION` are allowed. At least one type must be included. + * The set of `CatalogObject` types that this custom atttribute may be applied to. + * Currently, only `ITEM`, `ITEM_VARIATION`, and `MODIFIER` are allowed. At least one type must be included. * See [CatalogObjectType](#type-catalogobjecttype) for possible values */ allowedObjectTypes: string[]; diff --git a/src/models/catalogCustomAttributeValue.ts b/src/models/catalogCustomAttributeValue.ts index c6505d99..d35ee250 100644 --- a/src/models/catalogCustomAttributeValue.ts +++ b/src/models/catalogCustomAttributeValue.ts @@ -18,7 +18,7 @@ export interface CatalogCustomAttributeValue { name?: string | null; /** The string value of the custom attribute. Populated if `type` = `STRING`. */ stringValue?: string | null; - /** The id of the [CatalogCustomAttributeDefinition]($m/CatalogCustomAttributeDefinition) this value belongs to. */ + /** The id of the [CatalogCustomAttributeDefinition](entity:CatalogCustomAttributeDefinition) this value belongs to. */ customAttributeDefinitionId?: string; /** Defines the possible types for a custom attribute. */ type?: string; @@ -31,7 +31,11 @@ export interface CatalogCustomAttributeValue { booleanValue?: boolean | null; /** One or more choices from `allowed_selections`. Populated if `type` = `SELECTION`. */ selectionUidValues?: string[] | null; - /** A copy of key from the associated `CatalogCustomAttributeDefinition`. */ + /** + * If the associated `CatalogCustomAttributeDefinition` object is defined by another application, this key 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", this key is "abcd1234:cocoa_brand" + * when the application making the request is different from the application defining the custom attribute definition. Otherwise, the key is simply "cocoa_brand". + */ key?: string; } diff --git a/src/models/catalogImage.ts b/src/models/catalogImage.ts index 54b77462..83322688 100644 --- a/src/models/catalogImage.ts +++ b/src/models/catalogImage.ts @@ -12,20 +12,20 @@ export interface CatalogImage { /** * The internal name to identify this image in calls to the Square API. * This is a searchable attribute for use in applicable query filters - * using the [SearchCatalogObjects]($e/Catalog/SearchCatalogObjects). + * using the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects). * It is not unique and should not be shown in a buyer facing context. */ name?: string | null; /** * The URL of this image, generated by Square after an image is uploaded - * using the [CreateCatalogImage]($e/Catalog/CreateCatalogImage) endpoint. + * using the [CreateCatalogImage](api-endpoint:Catalog-CreateCatalogImage) endpoint. * To modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field. */ url?: string | null; /** * A caption that describes what is shown in the image. Displayed in the * Square Online Store. This is a searchable attribute for use in applicable query filters - * using the [SearchCatalogObjects]($e/Catalog/SearchCatalogObjects). + * using the [SearchCatalogObjects](api-endpoint:Catalog-SearchCatalogObjects). */ caption?: string | null; /** The immutable order ID for this image object created by the Photo Studio service in Square Online Store. */ diff --git a/src/models/catalogItem.ts b/src/models/catalogItem.ts index 45a9d842..ca0fbec3 100644 --- a/src/models/catalogItem.ts +++ b/src/models/catalogItem.ts @@ -25,7 +25,7 @@ export interface CatalogItem { /** * The item's description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points. * Deprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description - * of the [CatalogItem]($m/CatalogItem) instance. The `description` and `description_html` field values are kept in sync. If you try to + * of the [CatalogItem](entity:CatalogItem) instance. The `description` and `description_html` field values are kept in sync. If you try to * set the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other, * except for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null * does not nullify `description_html`. @@ -60,7 +60,7 @@ export interface CatalogItem { */ modifierListInfo?: CatalogItemModifierListInfo[] | null; /** - * A list of [CatalogItemVariation]($m/CatalogItemVariation) objects for this item. An item must have + * A list of [CatalogItemVariation](entity:CatalogItemVariation) objects for this item. An item must have * at least one variation. */ variations?: CatalogObject[] | null; @@ -89,6 +89,7 @@ export interface CatalogItem { imageIds?: string[] | null; /** * A name to sort the item by. If this name is unspecified, namely, the `sort_name` field is absent, the regular `name` field is used for sorting. + * Its value must not be empty. * It is currently supported for sellers of the Japanese locale only. */ sortName?: string | null; diff --git a/src/models/catalogItemVariation.ts b/src/models/catalogItemVariation.ts index 9be342d3..e5270bfa 100644 --- a/src/models/catalogItemVariation.ts +++ b/src/models/catalogItemVariation.ts @@ -132,6 +132,11 @@ export interface CatalogItemVariation { * share the same underlying stock. */ stockableConversion?: CatalogStockConversion; + /** + * A list of ids of [CatalogItemVariationVendorInfo](entity:CatalogItemVariationVendorInfo) objects that + * reference this ItemVariation. (Deprecated in favor of item_variation_vendor_infos) + */ + itemVariationVendorInfoIds?: string[] | null; } export const catalogItemVariationSchema: Schema = object({ @@ -170,4 +175,8 @@ export const catalogItemVariationSchema: Schema = object({ 'stockable_conversion', optional(lazy(() => catalogStockConversionSchema)), ], + itemVariationVendorInfoIds: [ + 'item_variation_vendor_info_ids', + optional(nullable(array(string()))), + ], }); diff --git a/src/models/catalogObject.ts b/src/models/catalogObject.ts index 9eb263a1..95d07aef 100644 --- a/src/models/catalogObject.ts +++ b/src/models/catalogObject.ts @@ -106,8 +106,8 @@ export interface CatalogObject { isDeleted?: boolean | null; /** * A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair - * is a [CatalogCustomAttributeValue]($m/CatalogCustomAttributeValue) object. The key is the `key` attribute - * value defined in the associated [CatalogCustomAttributeDefinition]($m/CatalogCustomAttributeDefinition) + * 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 diff --git a/src/models/catalogStockConversion.ts b/src/models/catalogStockConversion.ts index 1b2bc0c7..4d0e3d8d 100644 --- a/src/models/catalogStockConversion.ts +++ b/src/models/catalogStockConversion.ts @@ -7,11 +7,11 @@ import { object, Schema, string } from '../schema'; */ export interface CatalogStockConversion { /** - * References to the stockable [CatalogItemVariation]($m/CatalogItemVariation) + * 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]($m/CatalogItem) of the converted `CatalogItemVariation.` + * that shares the parent [CatalogItem](entity:CatalogItem) of the converted `CatalogItemVariation.` */ stockableItemVariationId: string; /** @@ -22,7 +22,7 @@ export interface CatalogStockConversion { */ stockableQuantity: string; /** - * The converted equivalent quantity of the non-stockable [CatalogItemVariation]($m/CatalogItemVariation) + * 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 diff --git a/src/models/catalogSubscriptionPlan.ts b/src/models/catalogSubscriptionPlan.ts index a93a9ae9..6227cb6f 100644 --- a/src/models/catalogSubscriptionPlan.ts +++ b/src/models/catalogSubscriptionPlan.ts @@ -20,7 +20,7 @@ export interface CatalogSubscriptionPlan { /** The name of the plan. */ name: string; /** - * A list of SubscriptionPhase containing the [SubscriptionPhase]($m/SubscriptionPhase) for this plan. + * 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 */ phases?: SubscriptionPhase[] | null; diff --git a/src/models/chargeRequest.ts b/src/models/chargeRequest.ts index 80d15b9f..133c566d 100644 --- a/src/models/chargeRequest.ts +++ b/src/models/chargeRequest.ts @@ -17,8 +17,8 @@ import { Money, moneySchema } from './money'; /** * Defines the parameters that can be included in the body of - * a request to the [Charge]($e/Transactions/Charge) endpoint. - * Deprecated - recommend using [CreatePayment]($e/Payments/CreatePayment) + * a request to the [Charge](api-endpoint:Transactions-Charge) endpoint. + * Deprecated - recommend using [CreatePayment](api-endpoint:Payments-CreatePayment) */ export interface ChargeRequest { /** @@ -59,8 +59,8 @@ export interface ChargeRequest { /** * If `true`, the request will only perform an Auth on the provided * card. You can then later perform either a Capture (with the - * [CaptureTransaction]($e/Transactions/CaptureTransaction) endpoint) or a Void - * (with the [VoidTransaction]($e/Transactions/VoidTransaction) endpoint). + * [CaptureTransaction](api-endpoint:Transactions-CaptureTransaction) endpoint) or a Void + * (with the [VoidTransaction](api-endpoint:Transactions-VoidTransaction) endpoint). * Default value: `false` */ delayCapture?: boolean | null; diff --git a/src/models/chargeResponse.ts b/src/models/chargeResponse.ts index 98864a49..da03a115 100644 --- a/src/models/chargeResponse.ts +++ b/src/models/chargeResponse.ts @@ -4,7 +4,7 @@ import { Transaction, transactionSchema } from './transaction'; /** * Defines the fields that are included in the response body of - * a request to the [Charge]($e/Transactions/Charge) endpoint. + * a request to the [Charge](api-endpoint:Transactions-Charge) endpoint. * One of `errors` or `transaction` is present in a given response (never both). */ export interface ChargeResponse { diff --git a/src/models/createCardRequest.ts b/src/models/createCardRequest.ts index d82c9fe0..e5d99f3c 100644 --- a/src/models/createCardRequest.ts +++ b/src/models/createCardRequest.ts @@ -2,7 +2,7 @@ import { lazy, object, optional, Schema, string } from '../schema'; import { Card, cardSchema } from './card'; /** - * Creates a card from the source (nonce, payment id, etc). Accessible via + * Creates a card from the source (payment token or payment id). Accessible via * HTTP requests at POST https://connect.squareup.com/v2/cards */ export interface CreateCardRequest { @@ -10,7 +10,7 @@ export interface CreateCardRequest { * 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/basics/api101/idempotency) for more information. + * See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. */ idempotencyKey: string; /** The ID of the source which represents the card information to be stored. This can be a card nonce or a payment id. */ diff --git a/src/models/createCardResponse.ts b/src/models/createCardResponse.ts index 6c98f178..1213f509 100644 --- a/src/models/createCardResponse.ts +++ b/src/models/createCardResponse.ts @@ -9,7 +9,7 @@ import { Error, errorSchema } from './error'; * present. */ export interface CreateCardResponse { - /** Information on errors encountered during the request. */ + /** Errors resulting from the request. */ errors?: Error[]; /** * Represents the payment details of a card to be used for payments. These diff --git a/src/models/createCatalogImageRequest.ts b/src/models/createCatalogImageRequest.ts index 5e4a31d3..5db9fb21 100644 --- a/src/models/createCatalogImageRequest.ts +++ b/src/models/createCatalogImageRequest.ts @@ -5,7 +5,7 @@ export interface CreateCatalogImageRequest { /** * 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/basics/api101/idempotency) for more information. + * See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. */ idempotencyKey: string; /** diff --git a/src/models/createGiftCardRequest.ts b/src/models/createGiftCardRequest.ts index a25faf36..e7191e9f 100644 --- a/src/models/createGiftCardRequest.ts +++ b/src/models/createGiftCardRequest.ts @@ -9,7 +9,7 @@ export interface CreateGiftCardRequest { */ idempotencyKey: string; /** - * The ID of the [location]($m/Location) where the gift card should be registered for + * 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. */ locationId: string; diff --git a/src/models/createPaymentRequest.ts b/src/models/createPaymentRequest.ts index 4fc383b4..7873bb32 100644 --- a/src/models/createPaymentRequest.ts +++ b/src/models/createPaymentRequest.ts @@ -41,7 +41,7 @@ export interface CreatePaymentRequest { * [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) * for more information. */ - amountMoney: Money; + amountMoney?: 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 @@ -91,7 +91,7 @@ export interface CreatePaymentRequest { /** Associates a previously created order with this payment. */ orderId?: string; /** - * The [Customer]($m/Customer) ID of the customer associated with the payment. + * 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. */ customerId?: string; @@ -101,7 +101,7 @@ export interface CreatePaymentRequest { */ locationId?: string; /** - * An optional [TeamMember]($m/TeamMember) ID to associate with + * An optional [TeamMember](entity:TeamMember) ID to associate with * this payment. */ teamMemberId?: string; @@ -168,7 +168,7 @@ export interface CreatePaymentRequest { export const createPaymentRequestSchema: Schema = object({ sourceId: ['source_id', string()], idempotencyKey: ['idempotency_key', string()], - amountMoney: ['amount_money', lazy(() => moneySchema)], + amountMoney: ['amount_money', optional(lazy(() => moneySchema))], tipMoney: ['tip_money', optional(lazy(() => moneySchema))], appFeeMoney: ['app_fee_money', optional(lazy(() => moneySchema))], delayDuration: ['delay_duration', optional(string())], diff --git a/src/models/createRefundRequest.ts b/src/models/createRefundRequest.ts index f5cdeb8b..1d227781 100644 --- a/src/models/createRefundRequest.ts +++ b/src/models/createRefundRequest.ts @@ -3,8 +3,8 @@ import { Money, moneySchema } from './money'; /** * Defines the body parameters that can be included in - * a request to the [CreateRefund]($e/Transactions/CreateRefund) endpoint. - * Deprecated - recommend using [RefundPayment]($e/Refunds/RefundPayment) + * a request to the [CreateRefund](api-endpoint:Transactions-CreateRefund) endpoint. + * Deprecated - recommend using [RefundPayment](api-endpoint:Refunds-RefundPayment) */ export interface CreateRefundRequest { /** @@ -18,7 +18,7 @@ export interface CreateRefundRequest { idempotencyKey: string; /** * The ID of the tender to refund. - * A [`Transaction`]($m/Transaction) has one or more `tenders` (i.e., methods + * 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. */ diff --git a/src/models/createRefundResponse.ts b/src/models/createRefundResponse.ts index 222d187d..8ef68bd6 100644 --- a/src/models/createRefundResponse.ts +++ b/src/models/createRefundResponse.ts @@ -4,7 +4,7 @@ import { Refund, refundSchema } from './refund'; /** * Defines the fields that are included in the response body of - * a request to the [CreateRefund]($e/Transactions/CreateRefund) endpoint. + * a request to the [CreateRefund](api-endpoint:Transactions-CreateRefund) endpoint. * One of `errors` or `refund` is present in a given response (never both). */ export interface CreateRefundResponse { diff --git a/src/models/createSubscriptionRequest.ts b/src/models/createSubscriptionRequest.ts index cf0a00a9..86adc78a 100644 --- a/src/models/createSubscriptionRequest.ts +++ b/src/models/createSubscriptionRequest.ts @@ -26,7 +26,7 @@ export interface CreateSubscriptionRequest { * [Subscriptions Walkthrough](https://developer.squareup.com/docs/subscriptions-api/walkthrough). */ planId: string; - /** The ID of the [customer]($m/Customer) subscribing to the subscription plan. */ + /** The ID of the [customer](entity:Customer) subscribing to the subscription plan. */ customerId: string; /** * The `YYYY-MM-DD`-formatted date to start the subscription. @@ -60,7 +60,7 @@ export interface CreateSubscriptionRequest { */ priceOverrideMoney?: Money; /** - * The ID of the [subscriber's]($m/Customer) [card]($m/Card) to charge. + * 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. For an example to * create a customer profile for a subscriber and add a card on file, see [Subscriptions Walkthrough](https://developer.squareup.com/docs/subscriptions-api/walkthrough). */ diff --git a/src/models/createVendorRequest.ts b/src/models/createVendorRequest.ts index 0bb43f5c..64f52c24 100644 --- a/src/models/createVendorRequest.ts +++ b/src/models/createVendorRequest.ts @@ -4,9 +4,9 @@ import { Vendor, vendorSchema } from './vendor'; /** Represents an input to a call to [CreateVendor]($e/Vendors/CreateVendor). */ export interface CreateVendorRequest { /** - * A client-supplied, universally unique identifier (UUID) to make this [CreateVendor]($e/Vendors/CreateVendor) call idempotent. - * See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the - * [API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more + * 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. */ idempotencyKey: string; diff --git a/src/models/createWebhookSubscriptionRequest.ts b/src/models/createWebhookSubscriptionRequest.ts index 400bcd9f..959e5510 100644 --- a/src/models/createWebhookSubscriptionRequest.ts +++ b/src/models/createWebhookSubscriptionRequest.ts @@ -6,7 +6,7 @@ import { /** Creates a [Subscription]($m/WebhookSubscription). */ export interface CreateWebhookSubscriptionRequest { - /** A unique string that identifies the [CreateWebhookSubscription]($e/WebhookSubscriptions/CreateWebhookSubscription) request. */ + /** A unique string that identifies the [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscription) request. */ idempotencyKey?: string; /** * Represents the details of a webhook subscription, including notification URL, diff --git a/src/models/customer.ts b/src/models/customer.ts index 305e6d10..b8b26083 100644 --- a/src/models/customer.ts +++ b/src/models/customer.ts @@ -20,8 +20,8 @@ import { CustomerTaxIds, customerTaxIdsSchema } from './customerTaxIds'; export interface Customer { /** * 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]($e/Customers/SearchCustomers) - * or [ListCustomers]($e/Customers/ListCustomers) endpoint. + * 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. */ id?: string; /** The timestamp when the customer profile was created, in RFC 3339 format. */ @@ -30,8 +30,8 @@ export interface Customer { updatedAt?: string; /** * Payment details of the credit, debit, and gift cards stored on file for the customer profile. - * DEPRECATED at version 2021-06-16. Replaced by calling [ListCards]($e/Cards/ListCards) (for credit and debit cards on file) - * or [ListGiftCards]($e/GiftCards/ListGiftCards) (for gift cards on file) and including the `customer_id` query parameter. + * DEPRECATED at version 2021-06-16. 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). */ cards?: Card[] | null; @@ -68,9 +68,9 @@ export interface Customer { preferences?: CustomerPreferences; /** Indicates the method used to create the customer profile. */ creationSource?: string; - /** The IDs of [customer groups]($m/CustomerGroup) the customer belongs to. */ + /** The IDs of [customer groups](entity:CustomerGroup) the customer belongs to. */ groupIds?: string[] | null; - /** The IDs of [customer segments]($m/CustomerSegment) the customer belongs to. */ + /** The IDs of [customer segments](entity:CustomerSegment) the customer belongs to. */ segmentIds?: string[] | null; /** 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. */ version?: bigint; diff --git a/src/models/customerCustomAttributeFilter.ts b/src/models/customerCustomAttributeFilter.ts index c7b91314..77c38db8 100644 --- a/src/models/customerCustomAttributeFilter.ts +++ b/src/models/customerCustomAttributeFilter.ts @@ -11,8 +11,8 @@ import { TimeRange, timeRangeSchema } from './timeRange'; */ export interface CustomerCustomAttributeFilter { /** - * The `key` of the [custom attribute]($m/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]($e/CustomerCustomAttributes). + * 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). */ key: string; /** diff --git a/src/models/deleteInvoiceRequest.ts b/src/models/deleteInvoiceRequest.ts index e4be8366..650b01fc 100644 --- a/src/models/deleteInvoiceRequest.ts +++ b/src/models/deleteInvoiceRequest.ts @@ -3,9 +3,9 @@ import { number, object, optional, Schema } from '../schema'; /** Describes a `DeleteInvoice` request. */ export interface DeleteInvoiceRequest { /** - * The version of the [invoice]($m/Invoice) to delete. - * If you do not know the version, you can call [GetInvoice]($e/Invoices/GetInvoice) or - * [ListInvoices]($e/Invoices/ListInvoices). + * 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). */ version?: number; } diff --git a/src/models/giftCard.ts b/src/models/giftCard.ts index 0b89e61d..f4a0517e 100644 --- a/src/models/giftCard.ts +++ b/src/models/giftCard.ts @@ -44,7 +44,7 @@ export interface GiftCard { * seller at the time of activation. */ createdAt?: string; - /** The IDs of the [customer profiles]($m/Customer) to whom this gift card is linked. */ + /** The IDs of the [customer profiles](entity:Customer) to whom this gift card is linked. */ customerIds?: string[]; } diff --git a/src/models/giftCardActivity.ts b/src/models/giftCardActivity.ts index 77a7d890..2e0aa64b 100644 --- a/src/models/giftCardActivity.ts +++ b/src/models/giftCardActivity.ts @@ -71,7 +71,7 @@ export interface GiftCardActivity { id?: string; /** Indicates the type of [gift card activity]($m/GiftCardActivity). */ type: string; - /** The ID of the [business location]($m/Location) where the activity occurred. */ + /** The ID of the [business location](entity:Location) where the activity occurred. */ locationId: string; /** The timestamp when the gift card activity was created, in RFC 3339 format. */ createdAt?: string; diff --git a/src/models/giftCardActivityActivate.ts b/src/models/giftCardActivityActivate.ts index d96d15db..01bf5505 100644 --- a/src/models/giftCardActivityActivate.ts +++ b/src/models/giftCardActivityActivate.ts @@ -21,15 +21,15 @@ export interface GiftCardActivityActivate { */ amountMoney?: Money; /** - * The ID of the [order]($m/Order) that contains the `GIFT_CARD` line item. + * 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]($e/GiftCardActivities/CreateGiftCardActivity) request. + * [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. */ orderId?: string | null; /** * 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]($e/GiftCardActivities/CreateGiftCardActivity) request. + * in the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. */ lineItemUid?: string | null; /** @@ -42,7 +42,7 @@ export interface GiftCardActivityActivate { * 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]($e/GiftCardActivities/CreateGiftCardActivity) request. + * 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. diff --git a/src/models/giftCardActivityLoad.ts b/src/models/giftCardActivityLoad.ts index cd3f1575..47808def 100644 --- a/src/models/giftCardActivityLoad.ts +++ b/src/models/giftCardActivityLoad.ts @@ -21,15 +21,15 @@ export interface GiftCardActivityLoad { */ amountMoney?: Money; /** - * The ID of the [order]($m/Order) that contains the `GIFT_CARD` line item. + * 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]($e/GiftCardActivities/CreateGiftCardActivity) request. + * [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. */ orderId?: string | null; /** * 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]($e/GiftCardActivities/CreateGiftCardActivity) request. + * in the [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) request. */ lineItemUid?: string | null; /** @@ -42,7 +42,7 @@ export interface GiftCardActivityLoad { * 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]($e/GiftCardActivities/CreateGiftCardActivity) request. + * 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. diff --git a/src/models/giftCardActivityRefund.ts b/src/models/giftCardActivityRefund.ts index c007c390..304c3b10 100644 --- a/src/models/giftCardActivityRefund.ts +++ b/src/models/giftCardActivityRefund.ts @@ -5,7 +5,7 @@ import { Money, moneySchema } from './money'; export interface GiftCardActivityRefund { /** * The ID of the refunded `REDEEM` gift card activity. Square populates this field if the - * `payment_id` in the corresponding [RefundPayment]($e/Refunds/RefundPayment) request + * `payment_id` in the corresponding [RefundPayment](api-endpoint:Refunds-RefundPayment) request * represents a redemption made by the same gift card. Note that you must use `RefundPayment` * to refund a gift card payment to the same gift card if the payment was processed by Square. * For applications that use a custom payment processing system, this field is required when creating diff --git a/src/models/inventoryAdjustment.ts b/src/models/inventoryAdjustment.ts index fcd7856d..a88c8403 100644 --- a/src/models/inventoryAdjustment.ts +++ b/src/models/inventoryAdjustment.ts @@ -30,17 +30,17 @@ export interface InventoryAdjustment { /** Indicates the state of a tracked item quantity in the lifecycle of goods. */ toState?: string; /** - * The Square-generated ID of the [Location]($m/Location) where the related + * The Square-generated ID of the [Location](entity:Location) where the related * quantity of items is being tracked. */ locationId?: string | null; /** * The Square-generated ID of the - * [CatalogObject]($m/CatalogObject) being tracked. + * [CatalogObject](entity:CatalogObject) being tracked. */ catalogObjectId?: string | null; /** - * The [type]($m/CatalogObjectType) of the [CatalogObject]($m/CatalogObject) being tracked. + * 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. */ @@ -71,23 +71,23 @@ export interface InventoryAdjustment { /** Represents information about the application used to generate a change. */ source?: SourceApplication; /** - * The Square-generated ID of the [Employee]($m/Employee) responsible for the + * The Square-generated ID of the [Employee](entity:Employee) responsible for the * inventory adjustment. */ employeeId?: string | null; /** - * The Square-generated ID of the [Team Member]($m/TeamMember) responsible for the + * The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the * inventory adjustment. */ teamMemberId?: string | null; /** - * The Square-generated ID of the [Transaction]($m/Transaction) that + * The Square-generated ID of the [Transaction](entity:Transaction) that * caused the adjustment. Only relevant for payment-related state * transitions. */ transactionId?: string; /** - * The Square-generated ID of the [Refund]($m/Refund) that + * The Square-generated ID of the [Refund](entity:Refund) that * caused the adjustment. Only relevant for refund-related state * transitions. */ diff --git a/src/models/inventoryChange.ts b/src/models/inventoryChange.ts index 78b3ca94..20e9a5dc 100644 --- a/src/models/inventoryChange.ts +++ b/src/models/inventoryChange.ts @@ -46,7 +46,7 @@ export interface InventoryChange { * specifies the precision for decimal quantities. */ measurementUnit?: CatalogMeasurementUnit; - /** The ID of the [CatalogMeasurementUnit]($m/CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change. */ + /** The ID of the [CatalogMeasurementUnit](entity:CatalogMeasurementUnit) object representing the catalog measurement unit associated with the inventory change. */ measurementUnitId?: string; } diff --git a/src/models/inventoryCount.ts b/src/models/inventoryCount.ts index 57d580f0..24d2f553 100644 --- a/src/models/inventoryCount.ts +++ b/src/models/inventoryCount.ts @@ -8,11 +8,11 @@ import { boolean, nullable, object, optional, Schema, string } from '../schema'; export interface InventoryCount { /** * The Square-generated ID of the - * [CatalogObject]($m/CatalogObject) being tracked. + * [CatalogObject](entity:CatalogObject) being tracked. */ catalogObjectId?: string | null; /** - * The [type]($m/CatalogObjectType) of the [CatalogObject]($m/CatalogObject) being tracked. + * 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. */ @@ -20,7 +20,7 @@ export interface InventoryCount { /** Indicates the state of a tracked item quantity in the lifecycle of goods. */ state?: string; /** - * The Square-generated ID of the [Location]($m/Location) where the related + * The Square-generated ID of the [Location](entity:Location) where the related * quantity of items is being tracked. */ locationId?: string | null; diff --git a/src/models/inventoryPhysicalCount.ts b/src/models/inventoryPhysicalCount.ts index 764d388b..95cc47fd 100644 --- a/src/models/inventoryPhysicalCount.ts +++ b/src/models/inventoryPhysicalCount.ts @@ -13,22 +13,22 @@ import { export interface InventoryPhysicalCount { /** * A unique Square-generated ID for the - * [InventoryPhysicalCount]($m/InventoryPhysicalCount). + * [InventoryPhysicalCount](entity:InventoryPhysicalCount). */ id?: string; /** * An optional ID provided by the application to tie the - * [InventoryPhysicalCount]($m/InventoryPhysicalCount) to an external + * [InventoryPhysicalCount](entity:InventoryPhysicalCount) to an external * system. */ referenceId?: string | null; /** * The Square-generated ID of the - * [CatalogObject]($m/CatalogObject) being tracked. + * [CatalogObject](entity:CatalogObject) being tracked. */ catalogObjectId?: string | null; /** - * The [type]($m/CatalogObjectType) of the [CatalogObject]($m/CatalogObject) being tracked. + * 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. */ @@ -36,7 +36,7 @@ export interface InventoryPhysicalCount { /** Indicates the state of a tracked item quantity in the lifecycle of goods. */ state?: string; /** - * The Square-generated ID of the [Location]($m/Location) where the related + * The Square-generated ID of the [Location](entity:Location) where the related * quantity of items is being tracked. */ locationId?: string | null; @@ -48,12 +48,12 @@ export interface InventoryPhysicalCount { /** Represents information about the application used to generate a change. */ source?: SourceApplication; /** - * The Square-generated ID of the [Employee]($m/Employee) responsible for the + * The Square-generated ID of the [Employee](entity:Employee) responsible for the * physical count. */ employeeId?: string | null; /** - * The Square-generated ID of the [Team Member]($m/TeamMember) responsible for the + * The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the * physical count. */ teamMemberId?: string | null; diff --git a/src/models/inventoryTransfer.ts b/src/models/inventoryTransfer.ts index 59940d4d..44fbe8e8 100644 --- a/src/models/inventoryTransfer.ts +++ b/src/models/inventoryTransfer.ts @@ -22,22 +22,22 @@ export interface InventoryTransfer { /** Indicates the state of a tracked item quantity in the lifecycle of goods. */ state?: string; /** - * The Square-generated ID of the [Location]($m/Location) where the related + * The Square-generated ID of the [Location](entity:Location) where the related * quantity of items was tracked before the transfer. */ fromLocationId?: string | null; /** - * The Square-generated ID of the [Location]($m/Location) where the related + * The Square-generated ID of the [Location](entity:Location) where the related * quantity of items was tracked after the transfer. */ toLocationId?: string | null; /** * The Square-generated ID of the - * [CatalogObject]($m/CatalogObject) being tracked. + * [CatalogObject](entity:CatalogObject) being tracked. */ catalogObjectId?: string | null; /** - * The [type]($m/CatalogObjectType) of the [CatalogObject]($m/CatalogObject) being tracked. + * 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. */ @@ -62,12 +62,12 @@ export interface InventoryTransfer { /** Represents information about the application used to generate a change. */ source?: SourceApplication; /** - * The Square-generated ID of the [Employee]($m/Employee) responsible for the + * The Square-generated ID of the [Employee](entity:Employee) responsible for the * inventory transfer. */ employeeId?: string | null; /** - * The Square-generated ID of the [Team Member]($m/TeamMember) responsible for the + * The Square-generated ID of the [Team Member](entity:TeamMember) responsible for the * inventory transfer. */ teamMemberId?: string | null; diff --git a/src/models/invoice.ts b/src/models/invoice.ts index e56456b2..481ff993 100644 --- a/src/models/invoice.ts +++ b/src/models/invoice.ts @@ -39,10 +39,10 @@ export interface Invoice { */ locationId?: string | null; /** - * The ID of the [order]($m/Order) for which the invoice is created. + * 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]($e/Orders/RetrieveOrder) endpoint using the order ID. + * [RetrieveOrder](api-endpoint:Orders-RetrieveOrder) endpoint using the order ID. */ orderId?: string | null; /** @@ -128,7 +128,7 @@ export interface Invoice { */ customFields?: InvoiceCustomField[] | null; /** - * The ID of the [subscription]($m/Subscription) associated with the invoice. + * The ID of the [subscription](entity:Subscription) associated with the invoice. * This field is present only on subscription billing invoices. */ subscriptionId?: string; diff --git a/src/models/invoicePaymentRequest.ts b/src/models/invoicePaymentRequest.ts index 91391d26..5bfc4a4a 100644 --- a/src/models/invoicePaymentRequest.ts +++ b/src/models/invoicePaymentRequest.ts @@ -22,7 +22,7 @@ import { Money, moneySchema } from './money'; * [Invoices Plus subscription](https://developer.squareup.com/docs/invoices-api/overview#invoices-plus-subscription). */ export interface InvoicePaymentRequest { - /** The Square-generated ID of the payment request in an [invoice]($m/Invoice). */ + /** The Square-generated ID of the payment request in an [invoice](entity:Invoice). */ uid?: string | null; /** * Specifies the action for Square to take for processing the invoice. For example, @@ -75,7 +75,7 @@ export interface InvoicePaymentRequest { automaticPaymentSource?: string; /** * 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]($e/Cards/ListCards) and include the `customer_id` of the invoice recipient. + * call [ListCards](api-endpoint:Cards-ListCards) and include the `customer_id` of the invoice recipient. */ cardId?: string | null; /** A list of one or more reminders to send for the payment request. */ diff --git a/src/models/listBookingCustomAttributesRequest.ts b/src/models/listBookingCustomAttributesRequest.ts index a506aa56..f325f6c5 100644 --- a/src/models/listBookingCustomAttributesRequest.ts +++ b/src/models/listBookingCustomAttributesRequest.ts @@ -23,7 +23,7 @@ export interface ListBookingCustomAttributesRequest { */ cursor?: string | null; /** - * Indicates whether to return the [custom attribute definition]($m/CustomAttributeDefinition) in the `definition` field of each + * 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`. */ diff --git a/src/models/listCardsRequest.ts b/src/models/listCardsRequest.ts index 26e79e65..63404fd4 100644 --- a/src/models/listCardsRequest.ts +++ b/src/models/listCardsRequest.ts @@ -8,7 +8,7 @@ export interface ListCardsRequest { /** * 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/basics/api101/pagination) for more information. + * See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. */ cursor?: string | null; /** diff --git a/src/models/listCardsResponse.ts b/src/models/listCardsResponse.ts index dff23e4f..a5ff4ef2 100644 --- a/src/models/listCardsResponse.ts +++ b/src/models/listCardsResponse.ts @@ -16,7 +16,7 @@ export interface ListCardsResponse { /** * The pagination cursor to be used in a subsequent request. If empty, * this is the final response. - * See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. */ cursor?: string; } diff --git a/src/models/listCatalogRequest.ts b/src/models/listCatalogRequest.ts index 9298780b..02287ee7 100644 --- a/src/models/listCatalogRequest.ts +++ b/src/models/listCatalogRequest.ts @@ -4,12 +4,12 @@ export interface ListCatalogRequest { /** * 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/basics/api101/pagination) for more information. + * See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. */ cursor?: string | null; /** * An optional case-insensitive, comma-separated list of object types to retrieve. - * The valid values are defined in the [CatalogObjectType]($m/CatalogObjectType) enum, for example, + * 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 diff --git a/src/models/listCatalogResponse.ts b/src/models/listCatalogResponse.ts index a59bda8b..e1a29071 100644 --- a/src/models/listCatalogResponse.ts +++ b/src/models/listCatalogResponse.ts @@ -7,7 +7,7 @@ export interface ListCatalogResponse { errors?: Error[]; /** * The pagination cursor to be used in a subsequent request. If unset, this is the final response. - * See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. */ cursor?: string; /** The CatalogObjects returned. */ diff --git a/src/models/listCustomerCustomAttributesRequest.ts b/src/models/listCustomerCustomAttributesRequest.ts index 01540957..9e99a59f 100644 --- a/src/models/listCustomerCustomAttributesRequest.ts +++ b/src/models/listCustomerCustomAttributesRequest.ts @@ -23,7 +23,7 @@ export interface ListCustomerCustomAttributesRequest { */ cursor?: string | null; /** - * Indicates whether to return the [custom attribute definition]($m/CustomAttributeDefinition) in the `definition` field of each + * 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`. */ diff --git a/src/models/listDisputesRequest.ts b/src/models/listDisputesRequest.ts index fbef0072..0320012d 100644 --- a/src/models/listDisputesRequest.ts +++ b/src/models/listDisputesRequest.ts @@ -5,7 +5,7 @@ export interface ListDisputesRequest { /** * 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/basics/api101/pagination). + * For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string | null; /** diff --git a/src/models/listDisputesResponse.ts b/src/models/listDisputesResponse.ts index fd3f3f15..e3636bfd 100644 --- a/src/models/listDisputesResponse.ts +++ b/src/models/listDisputesResponse.ts @@ -10,7 +10,7 @@ export interface ListDisputesResponse { disputes?: Dispute[]; /** * 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/basics/api101/pagination). + * If unset, this is the final response. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string; } diff --git a/src/models/listGiftCardActivitiesRequest.ts b/src/models/listGiftCardActivitiesRequest.ts index 03f8eab8..e4ce82d4 100644 --- a/src/models/listGiftCardActivitiesRequest.ts +++ b/src/models/listGiftCardActivitiesRequest.ts @@ -12,7 +12,7 @@ export interface ListGiftCardActivitiesRequest { */ giftCardId?: string | null; /** - * If a [type]($m/GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. + * 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. */ type?: string | null; diff --git a/src/models/listGiftCardsRequest.ts b/src/models/listGiftCardsRequest.ts index 261a1ad4..1011a7b1 100644 --- a/src/models/listGiftCardsRequest.ts +++ b/src/models/listGiftCardsRequest.ts @@ -6,12 +6,12 @@ import { nullable, number, object, optional, Schema, string } from '../schema'; */ export interface ListGiftCardsRequest { /** - * If a [type]($m/GiftCardType) is provided, the endpoint returns gift cards of the specified type. + * 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. */ type?: string | null; /** - * If a [state]($m/GiftCardStatus) is provided, the endpoint returns the gift cards in the specified state. + * 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. */ state?: string | null; diff --git a/src/models/listLocationCustomAttributesRequest.ts b/src/models/listLocationCustomAttributesRequest.ts index 45e9917f..6498a1e7 100644 --- a/src/models/listLocationCustomAttributesRequest.ts +++ b/src/models/listLocationCustomAttributesRequest.ts @@ -25,7 +25,7 @@ export interface ListLocationCustomAttributesRequest { */ cursor?: string | null; /** - * Indicates whether to return the [custom attribute definition]($m/CustomAttributeDefinition) in the `definition` field of each + * 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`. */ diff --git a/src/models/listOrderCustomAttributesRequest.ts b/src/models/listOrderCustomAttributesRequest.ts index c19fcf62..ebc06ea8 100644 --- a/src/models/listOrderCustomAttributesRequest.ts +++ b/src/models/listOrderCustomAttributesRequest.ts @@ -26,7 +26,7 @@ export interface ListOrderCustomAttributesRequest { */ limit?: number | null; /** - * Indicates whether to return the [custom attribute definition]($m/CustomAttributeDefinition) in the `definition` field of each + * 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`. */ diff --git a/src/models/listPaymentRefundsRequest.ts b/src/models/listPaymentRefundsRequest.ts index e0c0524b..e60c87e7 100644 --- a/src/models/listPaymentRefundsRequest.ts +++ b/src/models/listPaymentRefundsRequest.ts @@ -7,17 +7,19 @@ import { nullable, number, object, optional, Schema, string } from '../schema'; */ export interface ListPaymentRefundsRequest { /** - * The timestamp for the beginning of the requested reporting period, in RFC 3339 format. + * 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. */ beginTime?: string | null; /** - * The timestamp for the end of the requested reporting period, in RFC 3339 format. + * 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. */ endTime?: string | null; /** - * The order in which results are listed: + * The order in which results are listed by `PaymentRefund.created_at`: * - `ASC` - Oldest to newest. * - `DESC` - Newest to oldest (default). */ @@ -25,7 +27,7 @@ export interface ListPaymentRefundsRequest { /** * 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/basics/api101/pagination). + * For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string | null; /** @@ -35,7 +37,7 @@ export interface ListPaymentRefundsRequest { locationId?: string | null; /** * If provided, only refunds with the given status are returned. - * For a list of refund status values, see [PaymentRefund]($m/PaymentRefund). + * For a list of refund status values, see [PaymentRefund](entity:PaymentRefund). * Default: If omitted, refunds are returned regardless of their status. */ status?: string | null; diff --git a/src/models/listPaymentRefundsResponse.ts b/src/models/listPaymentRefundsResponse.ts index 1c18f1ec..c7437767 100644 --- a/src/models/listPaymentRefundsResponse.ts +++ b/src/models/listPaymentRefundsResponse.ts @@ -14,7 +14,7 @@ export interface ListPaymentRefundsResponse { /** * 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/basics/api101/pagination). + * For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string; } diff --git a/src/models/listPaymentsRequest.ts b/src/models/listPaymentsRequest.ts index 8e4bf148..70372ec2 100644 --- a/src/models/listPaymentsRequest.ts +++ b/src/models/listPaymentsRequest.ts @@ -15,17 +15,19 @@ import { */ export interface ListPaymentsRequest { /** - * The timestamp for the beginning of the reporting period, in RFC 3339 format. + * 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. */ beginTime?: string | null; /** - * The timestamp for the end of the reporting period, in RFC 3339 format. + * 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. */ endTime?: string | null; /** - * The order in which results are listed: + * The order in which results are listed by `Payment.created_at`: * - `ASC` - Oldest to newest. * - `DESC` - Newest to oldest (default). */ @@ -33,7 +35,7 @@ export interface ListPaymentsRequest { /** * 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/basics/api101/pagination). + * For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string | null; /** diff --git a/src/models/listPaymentsResponse.ts b/src/models/listPaymentsResponse.ts index 7e80ef9e..3403bd87 100644 --- a/src/models/listPaymentsResponse.ts +++ b/src/models/listPaymentsResponse.ts @@ -11,7 +11,7 @@ export interface ListPaymentsResponse { /** * 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/basics/api101/pagination). + * For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string; } diff --git a/src/models/listPayoutEntriesRequest.ts b/src/models/listPayoutEntriesRequest.ts index 805ff29a..6414ec54 100644 --- a/src/models/listPayoutEntriesRequest.ts +++ b/src/models/listPayoutEntriesRequest.ts @@ -6,7 +6,7 @@ export interface ListPayoutEntriesRequest { /** * 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/basics/api101/pagination). + * 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. */ cursor?: string | null; diff --git a/src/models/listPayoutEntriesResponse.ts b/src/models/listPayoutEntriesResponse.ts index 70c71764..e9f37000 100644 --- a/src/models/listPayoutEntriesResponse.ts +++ b/src/models/listPayoutEntriesResponse.ts @@ -8,7 +8,7 @@ export interface ListPayoutEntriesResponse { payoutEntries?: PayoutEntry[]; /** * 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/basics/api101/pagination). + * For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string; /** Information about errors encountered during the request. */ diff --git a/src/models/listPayoutsRequest.ts b/src/models/listPayoutsRequest.ts index d8cd70c1..8c040f9b 100644 --- a/src/models/listPayoutsRequest.ts +++ b/src/models/listPayoutsRequest.ts @@ -24,7 +24,7 @@ export interface ListPayoutsRequest { /** * 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/basics/api101/pagination). + * 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. */ cursor?: string | null; diff --git a/src/models/listPayoutsResponse.ts b/src/models/listPayoutsResponse.ts index 23589650..2f82469f 100644 --- a/src/models/listPayoutsResponse.ts +++ b/src/models/listPayoutsResponse.ts @@ -8,7 +8,7 @@ export interface ListPayoutsResponse { payouts?: Payout[]; /** * 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/basics/api101/pagination). + * For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string; /** Information about errors encountered during the request. */ diff --git a/src/models/listRefundsRequest.ts b/src/models/listRefundsRequest.ts index 4389bd34..fbe6d7b2 100644 --- a/src/models/listRefundsRequest.ts +++ b/src/models/listRefundsRequest.ts @@ -2,8 +2,8 @@ import { nullable, object, optional, Schema, string } from '../schema'; /** * Defines the query parameters that can be included in - * a request to the [ListRefunds]($e/Transactions/ListRefunds) endpoint. - * Deprecated - recommend using [SearchOrders]($e/Orders/SearchOrders) + * a request to the [ListRefunds](api-endpoint:Transactions-ListRefunds) endpoint. + * Deprecated - recommend using [SearchOrders](api-endpoint:Orders-SearchOrders) */ export interface ListRefundsRequest { /** diff --git a/src/models/listRefundsResponse.ts b/src/models/listRefundsResponse.ts index b84d20a2..73cd20ad 100644 --- a/src/models/listRefundsResponse.ts +++ b/src/models/listRefundsResponse.ts @@ -4,7 +4,7 @@ import { Refund, refundSchema } from './refund'; /** * Defines the fields that are included in the response body of - * a request to the [ListRefunds]($e/Transactions/ListRefunds) endpoint. + * a request to the [ListRefunds](api-endpoint:Transactions-ListRefunds) endpoint. * One of `errors` or `refunds` is present in a given response (never both). */ export interface ListRefundsResponse { diff --git a/src/models/listTransactionsRequest.ts b/src/models/listTransactionsRequest.ts index 1edf20ec..81ff18cc 100644 --- a/src/models/listTransactionsRequest.ts +++ b/src/models/listTransactionsRequest.ts @@ -2,8 +2,8 @@ import { nullable, object, optional, Schema, string } from '../schema'; /** * Defines the query parameters that can be included in - * a request to the [ListTransactions]($e/Transactions/ListTransactions) endpoint. - * Deprecated - recommend using [SearchOrders]($e/Orders/SearchOrders) + * a request to the [ListTransactions](api-endpoint:Transactions-ListTransactions) endpoint. + * Deprecated - recommend using [SearchOrders](api-endpoint:Orders-SearchOrders) */ export interface ListTransactionsRequest { /** diff --git a/src/models/listTransactionsResponse.ts b/src/models/listTransactionsResponse.ts index 4d3af05d..30efdfb2 100644 --- a/src/models/listTransactionsResponse.ts +++ b/src/models/listTransactionsResponse.ts @@ -4,7 +4,7 @@ import { Transaction, transactionSchema } from './transaction'; /** * Defines the fields that are included in the response body of - * a request to the [ListTransactions]($e/Transactions/ListTransactions) endpoint. + * a request to the [ListTransactions](api-endpoint:Transactions-ListTransactions) endpoint. * One of `errors` or `transactions` is present in a given response (never both). */ export interface ListTransactionsResponse { diff --git a/src/models/listWebhookEventTypesResponse.ts b/src/models/listWebhookEventTypesResponse.ts index 30843826..75ced1da 100644 --- a/src/models/listWebhookEventTypesResponse.ts +++ b/src/models/listWebhookEventTypesResponse.ts @@ -16,7 +16,7 @@ export interface ListWebhookEventTypesResponse { errors?: Error[]; /** The list of event types. */ eventTypes?: string[]; - /** Contains the metadata of a webhook event type. For more information, see [EventTypeMetadata]($m/EventTypeMetadata). */ + /** Contains the metadata of a webhook event type. For more information, see [EventTypeMetadata](entity:EventTypeMetadata). */ metadata?: EventTypeMetadata[]; } diff --git a/src/models/listWebhookSubscriptionsRequest.ts b/src/models/listWebhookSubscriptionsRequest.ts index a4d950e0..f98aa00b 100644 --- a/src/models/listWebhookSubscriptionsRequest.ts +++ b/src/models/listWebhookSubscriptionsRequest.ts @@ -17,8 +17,8 @@ export interface ListWebhookSubscriptionsRequest { */ cursor?: string | null; /** - * Includes disabled [Subscription]($m/WebhookSubscription)s. - * By default, all enabled [Subscription]($m/WebhookSubscription)s are returned. + * Includes disabled [Subscription](entity:WebhookSubscription)s. + * By default, all enabled [Subscription](entity:WebhookSubscription)s are returned. */ includeDisabled?: boolean | null; /** The order (e.g., chronological or alphabetical) in which results from a request are returned. */ diff --git a/src/models/listWebhookSubscriptionsResponse.ts b/src/models/listWebhookSubscriptionsResponse.ts index f896e681..16b2631d 100644 --- a/src/models/listWebhookSubscriptionsResponse.ts +++ b/src/models/listWebhookSubscriptionsResponse.ts @@ -14,7 +14,7 @@ import { export interface ListWebhookSubscriptionsResponse { /** Information on errors encountered during the request. */ errors?: Error[]; - /** The requested list of [Subscription]($m/WebhookSubscription)s. */ + /** The requested list of [Subscription](entity:WebhookSubscription)s. */ subscriptions?: WebhookSubscription[]; /** * The pagination cursor to be used in a subsequent request. If empty, diff --git a/src/models/location.ts b/src/models/location.ts index 7624ef59..ef7e0617 100644 --- a/src/models/location.ts +++ b/src/models/location.ts @@ -34,7 +34,7 @@ export interface Location { timezone?: string | null; /** * The Square features that are enabled for the location. - * See [LocationCapability]($m/LocationCapability) for possible values. + * See [LocationCapability](entity:LocationCapability) for possible values. * See [LocationCapability](#type-locationcapability) for possible values */ capabilities?: string[]; diff --git a/src/models/loyaltyAccount.ts b/src/models/loyaltyAccount.ts index d3d85fe1..38cbadde 100644 --- a/src/models/loyaltyAccount.ts +++ b/src/models/loyaltyAccount.ts @@ -24,7 +24,7 @@ import { export interface LoyaltyAccount { /** The Square-assigned ID of the loyalty account. */ id?: string; - /** The Square-assigned ID of the [loyalty program]($m/LoyaltyProgram) to which the account belongs. */ + /** The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram) to which the account belongs. */ programId: string; /** * The available point balance in the loyalty account. If points are scheduled to expire, they are listed in the `expiring_point_deadlines` field. @@ -33,7 +33,7 @@ export interface LoyaltyAccount { balance?: number; /** The total points accrued during the lifetime of the account. */ lifetimePoints?: number; - /** The Square-assigned ID of the [customer]($m/Customer) that is associated with the account. */ + /** The Square-assigned ID of the [customer](entity:Customer) that is associated with the account. */ customerId?: string | null; /** * 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. diff --git a/src/models/loyaltyEvent.ts b/src/models/loyaltyEvent.ts index 7b8cf286..651a1ce3 100644 --- a/src/models/loyaltyEvent.ts +++ b/src/models/loyaltyEvent.ts @@ -53,9 +53,9 @@ export interface LoyaltyEvent { deleteReward?: LoyaltyEventDeleteReward; /** Provides metadata when the event `type` is `ADJUST_POINTS`. */ adjustPoints?: LoyaltyEventAdjustPoints; - /** The ID of the [loyalty account]($m/LoyaltyAccount) associated with the event. */ + /** The ID of the [loyalty account](entity:LoyaltyAccount) associated with the event. */ loyaltyAccountId: string; - /** The ID of the [location]($m/Location) where the event occurred. */ + /** The ID of the [location](entity:Location) where the event occurred. */ locationId?: string; /** Defines whether the event was generated by the Square Point of Sale. */ source: string; diff --git a/src/models/loyaltyEventAccumulatePoints.ts b/src/models/loyaltyEventAccumulatePoints.ts index a0b52bc4..11525236 100644 --- a/src/models/loyaltyEventAccumulatePoints.ts +++ b/src/models/loyaltyEventAccumulatePoints.ts @@ -2,12 +2,12 @@ import { nullable, number, object, optional, Schema, string } from '../schema'; /** Provides metadata when the event `type` is `ACCUMULATE_POINTS`. */ export interface LoyaltyEventAccumulatePoints { - /** The ID of the [loyalty program]($m/LoyaltyProgram). */ + /** The ID of the [loyalty program](entity:LoyaltyProgram). */ loyaltyProgramId?: string; /** The number of points accumulated by the event. */ points?: number | null; /** - * The ID of the [order]($m/Order) for which the buyer accumulated the points. + * 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. */ orderId?: string | null; diff --git a/src/models/loyaltyEventAccumulatePromotionPoints.ts b/src/models/loyaltyEventAccumulatePromotionPoints.ts index c0540b1c..a25c7bc1 100644 --- a/src/models/loyaltyEventAccumulatePromotionPoints.ts +++ b/src/models/loyaltyEventAccumulatePromotionPoints.ts @@ -2,14 +2,14 @@ import { number, object, optional, Schema, string } from '../schema'; /** Provides metadata when the event `type` is `ACCUMULATE_PROMOTION_POINTS`. */ export interface LoyaltyEventAccumulatePromotionPoints { - /** The Square-assigned ID of the [loyalty program]($m/LoyaltyProgram). */ + /** The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram). */ loyaltyProgramId?: string; - /** The Square-assigned ID of the [loyalty promotion]($m/LoyaltyPromotion). */ + /** The Square-assigned ID of the [loyalty promotion](entity:LoyaltyPromotion). */ loyaltyPromotionId?: string; /** The number of points earned by the event. */ points: number; /** - * The ID of the [order]($m/Order) for which the buyer earned the promotion points. + * 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. */ orderId: string; diff --git a/src/models/loyaltyEventAdjustPoints.ts b/src/models/loyaltyEventAdjustPoints.ts index 982ac86d..c2f560f7 100644 --- a/src/models/loyaltyEventAdjustPoints.ts +++ b/src/models/loyaltyEventAdjustPoints.ts @@ -2,7 +2,7 @@ import { nullable, number, object, optional, Schema, string } from '../schema'; /** Provides metadata when the event `type` is `ADJUST_POINTS`. */ export interface LoyaltyEventAdjustPoints { - /** The Square-assigned ID of the [loyalty program]($m/LoyaltyProgram). */ + /** The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram). */ loyaltyProgramId?: string; /** The number of points added or removed. */ points: number; diff --git a/src/models/loyaltyEventCreateReward.ts b/src/models/loyaltyEventCreateReward.ts index 5a9aba22..31482cd9 100644 --- a/src/models/loyaltyEventCreateReward.ts +++ b/src/models/loyaltyEventCreateReward.ts @@ -2,10 +2,10 @@ import { number, object, optional, Schema, string } from '../schema'; /** Provides metadata when the event `type` is `CREATE_REWARD`. */ export interface LoyaltyEventCreateReward { - /** The ID of the [loyalty program]($m/LoyaltyProgram). */ + /** The ID of the [loyalty program](entity:LoyaltyProgram). */ loyaltyProgramId: string; /** - * The Square-assigned ID of the created [loyalty reward]($m/LoyaltyReward). + * The Square-assigned ID of the created [loyalty reward](entity:LoyaltyReward). * This field is returned only if the event source is `LOYALTY_API`. */ rewardId?: string; diff --git a/src/models/loyaltyEventDeleteReward.ts b/src/models/loyaltyEventDeleteReward.ts index d314e93e..610a002f 100644 --- a/src/models/loyaltyEventDeleteReward.ts +++ b/src/models/loyaltyEventDeleteReward.ts @@ -2,10 +2,10 @@ import { number, object, optional, Schema, string } from '../schema'; /** Provides metadata when the event `type` is `DELETE_REWARD`. */ export interface LoyaltyEventDeleteReward { - /** The ID of the [loyalty program]($m/LoyaltyProgram). */ + /** The ID of the [loyalty program](entity:LoyaltyProgram). */ loyaltyProgramId: string; /** - * The ID of the deleted [loyalty reward]($m/LoyaltyReward). + * The ID of the deleted [loyalty reward](entity:LoyaltyReward). * This field is returned only if the event source is `LOYALTY_API`. */ rewardId?: string; diff --git a/src/models/loyaltyEventExpirePoints.ts b/src/models/loyaltyEventExpirePoints.ts index 353f3106..490a852b 100644 --- a/src/models/loyaltyEventExpirePoints.ts +++ b/src/models/loyaltyEventExpirePoints.ts @@ -2,7 +2,7 @@ import { number, object, Schema, string } from '../schema'; /** Provides metadata when the event `type` is `EXPIRE_POINTS`. */ export interface LoyaltyEventExpirePoints { - /** The Square-assigned ID of the [loyalty program]($m/LoyaltyProgram). */ + /** The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram). */ loyaltyProgramId: string; /** The number of points expired. */ points: number; diff --git a/src/models/loyaltyEventLocationFilter.ts b/src/models/loyaltyEventLocationFilter.ts index 31865984..df5be7d4 100644 --- a/src/models/loyaltyEventLocationFilter.ts +++ b/src/models/loyaltyEventLocationFilter.ts @@ -3,7 +3,7 @@ import { array, object, Schema, string } from '../schema'; /** Filter events by location. */ export interface LoyaltyEventLocationFilter { /** - * The [location]($m/Location) IDs for loyalty events to query. + * The [location](entity:Location) IDs for loyalty events to query. * If multiple values are specified, the endpoint uses * a logical OR to combine them. */ diff --git a/src/models/loyaltyEventLoyaltyAccountFilter.ts b/src/models/loyaltyEventLoyaltyAccountFilter.ts index 2abf00d7..0724d425 100644 --- a/src/models/loyaltyEventLoyaltyAccountFilter.ts +++ b/src/models/loyaltyEventLoyaltyAccountFilter.ts @@ -2,7 +2,7 @@ import { object, Schema, string } from '../schema'; /** Filter events by loyalty account. */ export interface LoyaltyEventLoyaltyAccountFilter { - /** The ID of the [loyalty account]($m/LoyaltyAccount) associated with loyalty events. */ + /** The ID of the [loyalty account](entity:LoyaltyAccount) associated with loyalty events. */ loyaltyAccountId: string; } diff --git a/src/models/loyaltyEventOrderFilter.ts b/src/models/loyaltyEventOrderFilter.ts index 1688b377..3aa40343 100644 --- a/src/models/loyaltyEventOrderFilter.ts +++ b/src/models/loyaltyEventOrderFilter.ts @@ -2,7 +2,7 @@ import { object, Schema, string } from '../schema'; /** Filter events by the order associated with the event. */ export interface LoyaltyEventOrderFilter { - /** The ID of the [order]($m/Order) associated with the event. */ + /** The ID of the [order](entity:Order) associated with the event. */ orderId: string; } diff --git a/src/models/loyaltyEventOther.ts b/src/models/loyaltyEventOther.ts index 5487ece5..6649b0bb 100644 --- a/src/models/loyaltyEventOther.ts +++ b/src/models/loyaltyEventOther.ts @@ -2,7 +2,7 @@ import { number, object, Schema, string } from '../schema'; /** Provides metadata when the event `type` is `OTHER`. */ export interface LoyaltyEventOther { - /** The Square-assigned ID of the [loyalty program]($m/LoyaltyProgram). */ + /** The Square-assigned ID of the [loyalty program](entity:LoyaltyProgram). */ loyaltyProgramId: string; /** The number of points added or removed. */ points: number; diff --git a/src/models/loyaltyEventRedeemReward.ts b/src/models/loyaltyEventRedeemReward.ts index 8d254aa3..1ff4859e 100644 --- a/src/models/loyaltyEventRedeemReward.ts +++ b/src/models/loyaltyEventRedeemReward.ts @@ -2,15 +2,15 @@ import { object, optional, Schema, string } from '../schema'; /** Provides metadata when the event `type` is `REDEEM_REWARD`. */ export interface LoyaltyEventRedeemReward { - /** The ID of the [loyalty program]($m/LoyaltyProgram). */ + /** The ID of the [loyalty program](entity:LoyaltyProgram). */ loyaltyProgramId: string; /** - * The ID of the redeemed [loyalty reward]($m/LoyaltyReward). + * The ID of the redeemed [loyalty reward](entity:LoyaltyReward). * This field is returned only if the event source is `LOYALTY_API`. */ rewardId?: string; /** - * The ID of the [order]($m/Order) that redeemed the reward. + * 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. */ orderId?: string; diff --git a/src/models/loyaltyProgram.ts b/src/models/loyaltyProgram.ts index 1ce120d3..3433b67e 100644 --- a/src/models/loyaltyProgram.ts +++ b/src/models/loyaltyProgram.ts @@ -43,7 +43,7 @@ export interface LoyaltyProgram { expirationPolicy?: LoyaltyProgramExpirationPolicy; /** Represents the naming used for loyalty points. */ terminology?: LoyaltyProgramTerminology; - /** The [locations]($m/Location) at which the program is active. */ + /** The [locations](entity:Location) at which the program is active. */ locationIds?: string[] | null; /** The timestamp when the program was created, in RFC 3339 format. */ createdAt?: string; @@ -51,8 +51,8 @@ export interface LoyaltyProgram { updatedAt?: string; /** * Defines how buyers can earn loyalty points from the base loyalty program. - * To check for associated [loyalty promotions]($m/LoyaltyPromotion) that enable - * buyers to earn extra points, call [ListLoyaltyPromotions]($e/Loyalty/ListLoyaltyPromotions). + * To check for associated [loyalty promotions](entity:LoyaltyPromotion) that enable + * buyers to earn extra points, call [ListLoyaltyPromotions](api-endpoint:Loyalty-ListLoyaltyPromotions). */ accrualRules?: LoyaltyProgramAccrualRule[] | null; } diff --git a/src/models/loyaltyProgramAccrualRuleCategoryData.ts b/src/models/loyaltyProgramAccrualRuleCategoryData.ts index e3f9fa21..28602204 100644 --- a/src/models/loyaltyProgramAccrualRuleCategoryData.ts +++ b/src/models/loyaltyProgramAccrualRuleCategoryData.ts @@ -3,7 +3,7 @@ import { object, Schema, string } from '../schema'; /** Represents additional data for rules with the `CATEGORY` accrual type. */ export interface LoyaltyProgramAccrualRuleCategoryData { /** - * The ID of the `CATEGORY` [catalog object]($m/CatalogObject) that buyers can purchase to earn + * The ID of the `CATEGORY` [catalog object](entity:CatalogObject) that buyers can purchase to earn * points. */ categoryId: string; diff --git a/src/models/loyaltyProgramAccrualRuleItemVariationData.ts b/src/models/loyaltyProgramAccrualRuleItemVariationData.ts index 577bbcbb..24868625 100644 --- a/src/models/loyaltyProgramAccrualRuleItemVariationData.ts +++ b/src/models/loyaltyProgramAccrualRuleItemVariationData.ts @@ -3,7 +3,7 @@ import { object, Schema, string } from '../schema'; /** Represents additional data for rules with the `ITEM_VARIATION` accrual type. */ export interface LoyaltyProgramAccrualRuleItemVariationData { /** - * The ID of the `ITEM_VARIATION` [catalog object]($m/CatalogObject) that buyers can purchase to earn + * The ID of the `ITEM_VARIATION` [catalog object](entity:CatalogObject) that buyers can purchase to earn * points. */ itemVariationId: string; diff --git a/src/models/loyaltyProgramAccrualRuleSpendData.ts b/src/models/loyaltyProgramAccrualRuleSpendData.ts index a4b0baad..26c5f499 100644 --- a/src/models/loyaltyProgramAccrualRuleSpendData.ts +++ b/src/models/loyaltyProgramAccrualRuleSpendData.ts @@ -22,13 +22,13 @@ export interface LoyaltyProgramAccrualRuleSpendData { amountMoney: Money; /** * The IDs of any `CATEGORY` catalog objects that are excluded from points accrual. - * You can use the [BatchRetrieveCatalogObjects]($e/Catalog/BatchRetrieveCatalogObjects) + * You can use the [BatchRetrieveCatalogObjects](api-endpoint:Catalog-BatchRetrieveCatalogObjects) * endpoint to retrieve information about the excluded categories. */ excludedCategoryIds?: string[] | null; /** * The IDs of any `ITEM_VARIATION` catalog objects that are excluded from points accrual. - * You can use the [BatchRetrieveCatalogObjects]($e/Catalog/BatchRetrieveCatalogObjects) + * You can use the [BatchRetrieveCatalogObjects](api-endpoint:Catalog-BatchRetrieveCatalogObjects) * endpoint to retrieve information about the excluded item variations. */ excludedItemVariationIds?: string[] | null; diff --git a/src/models/loyaltyPromotion.ts b/src/models/loyaltyPromotion.ts index d0010ce5..243e99bc 100644 --- a/src/models/loyaltyPromotion.ts +++ b/src/models/loyaltyPromotion.ts @@ -57,7 +57,7 @@ export interface LoyaltyPromotion { canceledAt?: string; /** The timestamp when the promotion was last updated, in RFC 3339 format. */ updatedAt?: string; - /** The ID of the [loyalty program]($m/LoyaltyProgram) associated with the promotion. */ + /** The ID of the [loyalty program](entity:LoyaltyProgram) associated with the promotion. */ loyaltyProgramId?: string; /** * Represents an amount of money. `Money` fields can be signed or unsigned. @@ -69,7 +69,7 @@ export interface LoyaltyPromotion { */ minimumSpendAmountMoney?: Money; /** - * The IDs of any qualifying `ITEM_VARIATION` [catalog objects]($m/CatalogObject). If specified, + * 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. @@ -77,7 +77,7 @@ export interface LoyaltyPromotion { */ qualifyingItemVariationIds?: string[] | null; /** - * The IDs of any qualifying `CATEGORY` [catalog objects]($m/CatalogObject). If specified, + * 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. diff --git a/src/models/loyaltyReward.ts b/src/models/loyaltyReward.ts index bd5fef19..3510b288 100644 --- a/src/models/loyaltyReward.ts +++ b/src/models/loyaltyReward.ts @@ -9,13 +9,13 @@ export interface LoyaltyReward { id?: string; /** The status of the loyalty reward. */ status?: string; - /** The Square-assigned ID of the [loyalty account]($m/LoyaltyAccount) to which the reward belongs. */ + /** The Square-assigned ID of the [loyalty account](entity:LoyaltyAccount) to which the reward belongs. */ loyaltyAccountId: string; - /** The Square-assigned ID of the [reward tier]($m/LoyaltyProgramRewardTier) used to create the reward. */ + /** The Square-assigned ID of the [reward tier](entity:LoyaltyProgramRewardTier) used to create the reward. */ rewardTierId: string; /** The number of loyalty points used for the reward. */ points?: number; - /** The Square-assigned ID of the [order]($m/Order) to which the reward is attached. */ + /** The Square-assigned ID of the [order](entity:Order) to which the reward is attached. */ orderId?: string | null; /** The timestamp when the reward was created, in RFC 3339 format. */ createdAt?: string; diff --git a/src/models/order.ts b/src/models/order.ts index 3af5da04..56d4dc98 100644 --- a/src/models/order.ts +++ b/src/models/order.ts @@ -60,10 +60,9 @@ export interface Order { source?: OrderSource; /** * The ID of the [customer]($m/Customer) associated with the order. - * __IMPORTANT:__ You should specify a `customer_id` if you want the corresponding payment transactions - * to be explicitly linked to the customer in the Seller Dashboard. If this field is omitted, the - * `customer_id` assigned to any underlying `Payment` objects is ignored and might result in the - * creation of new [instant profiles](https://developer.squareup.com/docs/customers-api/what-it-does#instant-profiles). + * 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). */ customerId?: string | null; /** The line items included in the order. */ @@ -137,7 +136,7 @@ export interface Order { createdAt?: string; /** The timestamp for when the order was last updated, in RFC 3339 format (for example, "2016-09-04T23:59:33.123Z"). */ updatedAt?: string; - /** The timestamp for when the order reached a terminal [state]($m/OrderState), in RFC 3339 format (for example "2016-09-04T23:59:33.123Z"). */ + /** The timestamp for when the order reached a terminal [state](entity:OrderState), in RFC 3339 format (for example "2016-09-04T23:59:33.123Z"). */ closedAt?: string; /** The state of the order. */ state?: string; diff --git a/src/models/orderLineItem.ts b/src/models/orderLineItem.ts index ea2e0ee6..406213d5 100644 --- a/src/models/orderLineItem.ts +++ b/src/models/orderLineItem.ts @@ -14,6 +14,10 @@ import { OrderLineItemAppliedDiscount, orderLineItemAppliedDiscountSchema, } from './orderLineItemAppliedDiscount'; +import { + OrderLineItemAppliedServiceCharge, + orderLineItemAppliedServiceChargeSchema, +} from './orderLineItemAppliedServiceCharge'; import { OrderLineItemAppliedTax, orderLineItemAppliedTaxSchema, @@ -56,7 +60,7 @@ export interface OrderLineItem { quantityUnit?: OrderQuantityUnit; /** The note of the line item. */ note?: string | null; - /** The [CatalogItemVariation]($m/CatalogItemVariation) ID applied to this line item. */ + /** The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this line item. */ catalogObjectId?: string | null; /** The version of the catalog object that this line item references. */ catalogVersion?: bigint | null; @@ -80,7 +84,7 @@ export interface OrderLineItem { * For more information, see [Metadata](https://developer.squareup.com/docs/build-basics/metadata). */ metadata?: Record | null; - /** The [CatalogModifier]($m/CatalogModifier)s applied to this line item. */ + /** The [CatalogModifier](entity:CatalogModifier)s applied to this line item. */ modifiers?: OrderLineItemModifier[] | null; /** * The list of references to taxes applied to this line item. Each @@ -106,6 +110,14 @@ export interface OrderLineItem { * To change the amount of a discount, modify the referenced top-level discount. */ appliedDiscounts?: OrderLineItemAppliedDiscount[] | null; + /** + * 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. + */ + appliedServiceCharges?: OrderLineItemAppliedServiceCharge[] | null; /** * 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 @@ -166,6 +178,15 @@ export interface OrderLineItem { * [Apply Taxes and Discounts](https://developer.squareup.com/docs/orders-api/apply-taxes-and-discounts). */ pricingBlocklists?: OrderLineItemPricingBlocklists; + /** + * 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. + */ + totalServiceChargeMoney?: Money; } export const orderLineItemSchema: Schema = object({ @@ -194,6 +215,12 @@ export const orderLineItemSchema: Schema = object({ 'applied_discounts', optional(nullable(array(lazy(() => orderLineItemAppliedDiscountSchema)))), ], + appliedServiceCharges: [ + 'applied_service_charges', + optional( + nullable(array(lazy(() => orderLineItemAppliedServiceChargeSchema))) + ), + ], basePriceMoney: ['base_price_money', optional(lazy(() => moneySchema))], variationTotalPriceMoney: [ 'variation_total_price_money', @@ -210,4 +237,8 @@ export const orderLineItemSchema: Schema = object({ 'pricing_blocklists', optional(lazy(() => orderLineItemPricingBlocklistsSchema)), ], + totalServiceChargeMoney: [ + 'total_service_charge_money', + optional(lazy(() => moneySchema)), + ], }); diff --git a/src/models/orderLineItemAppliedServiceCharge.ts b/src/models/orderLineItemAppliedServiceCharge.ts new file mode 100644 index 00000000..852c6d99 --- /dev/null +++ b/src/models/orderLineItemAppliedServiceCharge.ts @@ -0,0 +1,31 @@ +import { lazy, nullable, object, optional, Schema, string } from '../schema'; +import { Money, moneySchema } from './money'; + +export interface OrderLineItemAppliedServiceCharge { + /** A unique ID that identifies the applied service charge only within this order. */ + uid?: string | null; + /** + * 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`. + */ + serviceChargeUid: string; + /** + * 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. + */ + appliedMoney?: Money; +} + +export const orderLineItemAppliedServiceChargeSchema: Schema = object( + { + uid: ['uid', optional(nullable(string()))], + serviceChargeUid: ['service_charge_uid', string()], + appliedMoney: ['applied_money', optional(lazy(() => moneySchema))], + } +); diff --git a/src/models/orderLineItemDiscount.ts b/src/models/orderLineItemDiscount.ts index ca9e7586..1e83446f 100644 --- a/src/models/orderLineItemDiscount.ts +++ b/src/models/orderLineItemDiscount.ts @@ -21,7 +21,7 @@ import { Money, moneySchema } from './money'; export interface OrderLineItemDiscount { /** A unique ID that identifies the discount only within this order. */ uid?: string | null; - /** The catalog object ID referencing [CatalogDiscount]($m/CatalogDiscount). */ + /** The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount). */ catalogObjectId?: string | null; /** The version of the catalog object that this discount references. */ catalogVersion?: bigint | null; @@ -80,7 +80,7 @@ export interface OrderLineItemDiscount { */ rewardIds?: string[]; /** - * The object ID of a [pricing rule]($m/CatalogPricingRule) to be applied + * 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. diff --git a/src/models/orderLineItemModifier.ts b/src/models/orderLineItemModifier.ts index d9d846ca..7dcd0658 100644 --- a/src/models/orderLineItemModifier.ts +++ b/src/models/orderLineItemModifier.ts @@ -14,7 +14,7 @@ import { Money, moneySchema } from './money'; export interface OrderLineItemModifier { /** A unique ID that identifies the modifier only within this order. */ uid?: string | null; - /** The catalog object ID referencing [CatalogModifier]($m/CatalogModifier). */ + /** The catalog object ID referencing [CatalogModifier](entity:CatalogModifier). */ catalogObjectId?: string | null; /** The version of the catalog object that this modifier references. */ catalogVersion?: bigint | null; diff --git a/src/models/orderLineItemTax.ts b/src/models/orderLineItemTax.ts index c827f0fe..e0d4b862 100644 --- a/src/models/orderLineItemTax.ts +++ b/src/models/orderLineItemTax.ts @@ -20,7 +20,7 @@ import { Money, moneySchema } from './money'; export interface OrderLineItemTax { /** A unique ID that identifies the tax only within this order. */ uid?: string | null; - /** The catalog object ID referencing [CatalogTax]($m/CatalogTax). */ + /** The catalog object ID referencing [CatalogTax](entity:CatalogTax). */ catalogObjectId?: string | null; /** The version of the catalog object that this tax references. */ catalogVersion?: bigint | null; diff --git a/src/models/orderQuantityUnit.ts b/src/models/orderQuantityUnit.ts index 478130c7..1fd9da60 100644 --- a/src/models/orderQuantityUnit.ts +++ b/src/models/orderQuantityUnit.ts @@ -30,7 +30,7 @@ export interface OrderQuantityUnit { precision?: number | null; /** * The catalog object ID referencing the - * [CatalogMeasurementUnit]($m/CatalogMeasurementUnit). + * [CatalogMeasurementUnit](entity:CatalogMeasurementUnit). * This field is set when this is a catalog-backed measurement unit. */ catalogObjectId?: string | null; diff --git a/src/models/orderReturnDiscount.ts b/src/models/orderReturnDiscount.ts index a726993d..a08f9cbb 100644 --- a/src/models/orderReturnDiscount.ts +++ b/src/models/orderReturnDiscount.ts @@ -21,7 +21,7 @@ export interface OrderReturnDiscount { uid?: string | null; /** The discount `uid` from the order that contains the original application of this discount. */ sourceDiscountUid?: string | null; - /** The catalog object ID referencing [CatalogDiscount]($m/CatalogDiscount). */ + /** The catalog object ID referencing [CatalogDiscount](entity:CatalogDiscount). */ catalogObjectId?: string | null; /** The version of the catalog object that this discount references. */ catalogVersion?: bigint | null; diff --git a/src/models/orderReturnLineItem.ts b/src/models/orderReturnLineItem.ts index 1be04b24..a9dbf5fb 100644 --- a/src/models/orderReturnLineItem.ts +++ b/src/models/orderReturnLineItem.ts @@ -13,6 +13,10 @@ import { OrderLineItemAppliedDiscount, orderLineItemAppliedDiscountSchema, } from './orderLineItemAppliedDiscount'; +import { + OrderLineItemAppliedServiceCharge, + orderLineItemAppliedServiceChargeSchema, +} from './orderLineItemAppliedServiceCharge'; import { OrderLineItemAppliedTax, orderLineItemAppliedTaxSchema, @@ -48,7 +52,7 @@ export interface OrderReturnLineItem { quantityUnit?: OrderQuantityUnit; /** The note of the return line item. */ note?: string | null; - /** The [CatalogItemVariation]($m/CatalogItemVariation) ID applied to this return line item. */ + /** The [CatalogItemVariation](entity:CatalogItemVariation) ID applied to this return line item. */ catalogObjectId?: string | null; /** The version of the catalog object that this line item references. */ catalogVersion?: bigint | null; @@ -56,7 +60,7 @@ export interface OrderReturnLineItem { variationName?: string | null; /** Represents the line item type. */ itemType?: string; - /** The [CatalogModifier]($m/CatalogModifier)s applied to this line item. */ + /** The [CatalogModifier](entity:CatalogModifier)s applied to this line item. */ returnModifiers?: OrderReturnLineItemModifier[] | null; /** * The list of references to `OrderReturnTax` entities applied to the return line item. Each @@ -126,6 +130,22 @@ export interface OrderReturnLineItem { * for more information. */ totalMoney?: Money; + /** + * 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. + */ + appliedServiceCharges?: OrderLineItemAppliedServiceCharge[] | null; + /** + * 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. + */ + totalServiceChargeMoney?: Money; } export const orderReturnLineItemSchema: Schema = object({ @@ -166,4 +186,14 @@ export const orderReturnLineItemSchema: Schema = object({ optional(lazy(() => moneySchema)), ], totalMoney: ['total_money', optional(lazy(() => moneySchema))], + appliedServiceCharges: [ + 'applied_service_charges', + optional( + nullable(array(lazy(() => orderLineItemAppliedServiceChargeSchema))) + ), + ], + totalServiceChargeMoney: [ + 'total_service_charge_money', + optional(lazy(() => moneySchema)), + ], }); diff --git a/src/models/orderReturnLineItemModifier.ts b/src/models/orderReturnLineItemModifier.ts index 54437023..fc995ad0 100644 --- a/src/models/orderReturnLineItemModifier.ts +++ b/src/models/orderReturnLineItemModifier.ts @@ -18,7 +18,7 @@ export interface OrderReturnLineItemModifier { * original sale of this line item modifier. */ sourceModifierUid?: string | null; - /** The catalog object ID referencing [CatalogModifier]($m/CatalogModifier). */ + /** The catalog object ID referencing [CatalogModifier](entity:CatalogModifier). */ catalogObjectId?: string | null; /** The version of the catalog object that this line item modifier references. */ catalogVersion?: bigint | null; @@ -42,6 +42,16 @@ export interface OrderReturnLineItemModifier { * for more information. */ totalPriceMoney?: Money; + /** + * 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. + */ + quantity?: string | null; } export const orderReturnLineItemModifierSchema: Schema = object( @@ -53,5 +63,6 @@ export const orderReturnLineItemModifierSchema: Schema moneySchema))], totalPriceMoney: ['total_price_money', optional(lazy(() => moneySchema))], + quantity: ['quantity', optional(nullable(string()))], } ); diff --git a/src/models/orderReturnServiceCharge.ts b/src/models/orderReturnServiceCharge.ts index a8748520..b49bcdec 100644 --- a/src/models/orderReturnServiceCharge.ts +++ b/src/models/orderReturnServiceCharge.ts @@ -27,7 +27,7 @@ export interface OrderReturnServiceCharge { sourceServiceChargeUid?: string | null; /** The name of the service charge. */ name?: string | null; - /** The catalog object ID of the associated [OrderServiceCharge]($m/OrderServiceCharge). */ + /** The catalog object ID of the associated [OrderServiceCharge](entity:OrderServiceCharge). */ catalogObjectId?: string | null; /** The version of the catalog object that this service charge references. */ catalogVersion?: bigint | null; @@ -93,6 +93,16 @@ export interface OrderReturnServiceCharge { * populated. */ appliedTaxes?: OrderLineItemAppliedTax[] | null; + /** + * Indicates whether the service charge will be treated as a value-holding line item or + * apportioned toward a line item. + */ + treatmentType?: string; + /** + * Indicates whether this is a line-item or order-level apportioned + * service charge. + */ + scope?: string; } export const orderReturnServiceChargeSchema: Schema = object( @@ -116,5 +126,7 @@ export const orderReturnServiceChargeSchema: Schema = 'applied_taxes', optional(nullable(array(lazy(() => orderLineItemAppliedTaxSchema)))), ], + treatmentType: ['treatment_type', optional(string())], + scope: ['scope', optional(string())], } ); diff --git a/src/models/orderReturnTax.ts b/src/models/orderReturnTax.ts index a0964f0e..f7b82579 100644 --- a/src/models/orderReturnTax.ts +++ b/src/models/orderReturnTax.ts @@ -20,7 +20,7 @@ export interface OrderReturnTax { uid?: string | null; /** The tax `uid` from the order that contains the original tax charge. */ sourceTaxUid?: string | null; - /** The catalog object ID referencing [CatalogTax]($m/CatalogTax). */ + /** The catalog object ID referencing [CatalogTax](entity:CatalogTax). */ catalogObjectId?: string | null; /** The version of the catalog object that this tax references. */ catalogVersion?: bigint | null; diff --git a/src/models/orderServiceCharge.ts b/src/models/orderServiceCharge.ts index d114148a..895831c1 100644 --- a/src/models/orderServiceCharge.ts +++ b/src/models/orderServiceCharge.ts @@ -22,7 +22,7 @@ export interface OrderServiceCharge { uid?: string | null; /** The name of the service charge. */ name?: string | null; - /** The catalog object ID referencing the service charge [CatalogObject]($m/CatalogObject). */ + /** The catalog object ID referencing the service charge [CatalogObject](entity:CatalogObject). */ catalogObjectId?: string | null; /** The version of the catalog object that this service charge references. */ catalogVersion?: bigint | null; @@ -110,6 +110,16 @@ export interface OrderServiceCharge { */ metadata?: Record | null; type?: string; + /** + * Indicates whether the service charge will be treated as a value-holding line item or + * apportioned toward a line item. + */ + treatmentType?: string; + /** + * Indicates whether this is a line-item or order-level apportioned + * service charge. + */ + scope?: string; } export const orderServiceChargeSchema: Schema = object({ @@ -130,4 +140,6 @@ export const orderServiceChargeSchema: Schema = object({ ], metadata: ['metadata', optional(nullable(dict(string())))], type: ['type', optional(string())], + treatmentType: ['treatment_type', optional(string())], + scope: ['scope', optional(string())], }); diff --git a/src/models/payOrderRequest.ts b/src/models/payOrderRequest.ts index 68aa3cdf..085f92ec 100644 --- a/src/models/payOrderRequest.ts +++ b/src/models/payOrderRequest.ts @@ -23,7 +23,7 @@ export interface PayOrderRequest { /** The version of the order being paid. If not supplied, the latest version will be paid. */ orderVersion?: number | null; /** - * The IDs of the [payments]($m/Payment) to collect. + * The IDs of the [payments](entity:Payment) to collect. * The payment total must match the order total. */ paymentIds?: string[] | null; diff --git a/src/models/payment.ts b/src/models/payment.ts index 4c53222e..96a8ec97 100644 --- a/src/models/payment.ts +++ b/src/models/payment.ts @@ -189,7 +189,7 @@ export interface Payment { * An optional ID of the employee associated with taking the payment. */ employeeId?: string; - /** An optional ID of the [TeamMember]($m/TeamMember) associated with taking the payment. */ + /** An optional ID of the [TeamMember](entity:TeamMember) associated with taking the payment. */ teamMemberId?: string; /** A list of `refund_id`s identifying refunds for the payment. */ refundIds?: string[]; diff --git a/src/models/paymentLink.ts b/src/models/paymentLink.ts index 95bd37a8..8f8e47e9 100644 --- a/src/models/paymentLink.ts +++ b/src/models/paymentLink.ts @@ -29,8 +29,10 @@ export interface PaymentLink { * see [Optional Checkout Configurations](https://developer.squareup.com/docs/checkout-api/optional-checkout-configurations). */ prePopulatedData?: PrePopulatedData; - /** The URL of the payment link. */ + /** The shortened URL of the payment link. */ url?: string; + /** The long URL of the payment link. */ + longUrl?: string; /** The timestamp when the payment link was created, in RFC 3339 format. */ createdAt?: string; /** The timestamp when the payment link was last updated, in RFC 3339 format. */ @@ -56,6 +58,7 @@ export const paymentLinkSchema: Schema = object({ optional(lazy(() => prePopulatedDataSchema)), ], url: ['url', optional(string())], + longUrl: ['long_url', optional(string())], createdAt: ['created_at', optional(string())], updatedAt: ['updated_at', optional(string())], paymentNote: ['payment_note', optional(nullable(string()))], diff --git a/src/models/paymentOptions.ts b/src/models/paymentOptions.ts index 45ad18ea..1d4a231b 100644 --- a/src/models/paymentOptions.ts +++ b/src/models/paymentOptions.ts @@ -9,7 +9,7 @@ export interface PaymentOptions { /** * 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, CANCELED, or FAILED) before the `delay_duration` time period. + * (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 @@ -32,6 +32,11 @@ export interface PaymentOptions { * Default: false */ acceptPartialAuthorization?: boolean | null; + /** + * Describes the action to be applied to a delayed capture payment when the delay_duration + * has elapsed. + */ + delayAction?: string; } export const paymentOptionsSchema: Schema = object({ @@ -41,4 +46,5 @@ export const paymentOptionsSchema: Schema = object({ 'accept_partial_authorization', optional(nullable(boolean())), ], + delayAction: ['delay_action', optional(string())], }); diff --git a/src/models/payout.ts b/src/models/payout.ts index d48d8052..ba0b650d 100644 --- a/src/models/payout.ts +++ b/src/models/payout.ts @@ -40,7 +40,7 @@ export interface Payout { destination?: Destination; /** * 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. + * The version number helps developers receive event notifications or feeds out of order. */ version?: number; /** diff --git a/src/models/publishInvoiceRequest.ts b/src/models/publishInvoiceRequest.ts index aa0ddb73..7eda38ab 100644 --- a/src/models/publishInvoiceRequest.ts +++ b/src/models/publishInvoiceRequest.ts @@ -3,7 +3,7 @@ import { nullable, number, object, optional, Schema, string } from '../schema'; /** Describes a `PublishInvoice` request. */ export interface PublishInvoiceRequest { /** - * The version of the [invoice]($m/Invoice) to publish. + * The version of the [invoice](entity:Invoice) to publish. * This must match the current version of the invoice; otherwise, the request is rejected. */ version: number; diff --git a/src/models/redeemLoyaltyRewardRequest.ts b/src/models/redeemLoyaltyRewardRequest.ts index 986033b4..a79416ec 100644 --- a/src/models/redeemLoyaltyRewardRequest.ts +++ b/src/models/redeemLoyaltyRewardRequest.ts @@ -7,7 +7,7 @@ export interface RedeemLoyaltyRewardRequest { * Keys can be any valid string, but must be unique for every request. */ idempotencyKey: string; - /** The ID of the [location]($m/Location) where the reward is redeemed. */ + /** The ID of the [location](entity:Location) where the reward is redeemed. */ locationId: string; } diff --git a/src/models/refundPaymentRequest.ts b/src/models/refundPaymentRequest.ts index ecb0b4c2..a76c1449 100644 --- a/src/models/refundPaymentRequest.ts +++ b/src/models/refundPaymentRequest.ts @@ -63,7 +63,7 @@ export interface RefundPaymentRequest { */ locationId?: string | null; /** - * The [Customer]($m/Customer) ID of the customer associated with the refund. + * 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`. */ @@ -77,7 +77,7 @@ export interface RefundPaymentRequest { * If the versions match, or the field is not provided, the refund proceeds as normal. */ paymentVersionToken?: string | null; - /** An optional [TeamMember]($m/TeamMember) ID to associate with this refund. */ + /** An optional [TeamMember](entity:TeamMember) ID to associate with this refund. */ teamMemberId?: string | null; } diff --git a/src/models/retrieveBookingCustomAttributeRequest.ts b/src/models/retrieveBookingCustomAttributeRequest.ts index 86fc1312..3d33038e 100644 --- a/src/models/retrieveBookingCustomAttributeRequest.ts +++ b/src/models/retrieveBookingCustomAttributeRequest.ts @@ -3,7 +3,7 @@ import { boolean, nullable, number, object, optional, Schema } from '../schema'; /** Represents a [RetrieveBookingCustomAttribute]($e/BookingCustomAttributes/RetrieveBookingCustomAttribute) request. */ export interface RetrieveBookingCustomAttributeRequest { /** - * Indicates whether to return the [custom attribute definition]($m/CustomAttributeDefinition) in the `definition` field of + * 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`. */ diff --git a/src/models/retrieveCustomerCustomAttributeRequest.ts b/src/models/retrieveCustomerCustomAttributeRequest.ts index 202766dd..bd74c60a 100644 --- a/src/models/retrieveCustomerCustomAttributeRequest.ts +++ b/src/models/retrieveCustomerCustomAttributeRequest.ts @@ -3,7 +3,7 @@ import { boolean, nullable, number, object, optional, Schema } from '../schema'; /** Represents a [RetrieveCustomerCustomAttribute]($e/CustomerCustomAttributes/RetrieveCustomerCustomAttribute) request. */ export interface RetrieveCustomerCustomAttributeRequest { /** - * Indicates whether to return the [custom attribute definition]($m/CustomAttributeDefinition) in the `definition` field of + * 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`. */ diff --git a/src/models/retrieveInventoryChangesRequest.ts b/src/models/retrieveInventoryChangesRequest.ts index 97643423..6a333a80 100644 --- a/src/models/retrieveInventoryChangesRequest.ts +++ b/src/models/retrieveInventoryChangesRequest.ts @@ -2,7 +2,7 @@ import { nullable, object, optional, Schema, string } from '../schema'; export interface RetrieveInventoryChangesRequest { /** - * The [Location]($m/Location) IDs to look up as a comma-separated + * The [Location](entity:Location) IDs to look up as a comma-separated * list. An empty list queries all locations. */ locationIds?: string | null; diff --git a/src/models/retrieveInventoryCountRequest.ts b/src/models/retrieveInventoryCountRequest.ts index db857437..f3cb7430 100644 --- a/src/models/retrieveInventoryCountRequest.ts +++ b/src/models/retrieveInventoryCountRequest.ts @@ -2,7 +2,7 @@ import { nullable, object, optional, Schema, string } from '../schema'; export interface RetrieveInventoryCountRequest { /** - * The [Location]($m/Location) IDs to look up as a comma-separated + * The [Location](entity:Location) IDs to look up as a comma-separated * list. An empty list queries all locations. */ locationIds?: string | null; diff --git a/src/models/retrieveLocationCustomAttributeRequest.ts b/src/models/retrieveLocationCustomAttributeRequest.ts index 5a9dd860..4e003876 100644 --- a/src/models/retrieveLocationCustomAttributeRequest.ts +++ b/src/models/retrieveLocationCustomAttributeRequest.ts @@ -3,7 +3,7 @@ import { boolean, nullable, number, object, optional, Schema } from '../schema'; /** Represents a [RetrieveLocationCustomAttribute]($e/LocationCustomAttributes/RetrieveLocationCustomAttribute) request. */ export interface RetrieveLocationCustomAttributeRequest { /** - * Indicates whether to return the [custom attribute definition]($m/CustomAttributeDefinition) in the `definition` field of + * 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`. */ diff --git a/src/models/retrieveOrderCustomAttributeRequest.ts b/src/models/retrieveOrderCustomAttributeRequest.ts index e5819219..063497fd 100644 --- a/src/models/retrieveOrderCustomAttributeRequest.ts +++ b/src/models/retrieveOrderCustomAttributeRequest.ts @@ -8,7 +8,7 @@ export interface RetrieveOrderCustomAttributeRequest { */ version?: number; /** - * Indicates whether to return the [custom attribute definition]($m/CustomAttributeDefinition) in the `definition` field of each + * 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`. */ diff --git a/src/models/retrieveTransactionResponse.ts b/src/models/retrieveTransactionResponse.ts index e3db64f0..568802fc 100644 --- a/src/models/retrieveTransactionResponse.ts +++ b/src/models/retrieveTransactionResponse.ts @@ -4,7 +4,7 @@ import { Transaction, transactionSchema } from './transaction'; /** * Defines the fields that are included in the response body of - * a request to the [RetrieveTransaction]($e/Transactions/RetrieveTransaction) endpoint. + * a request to the [RetrieveTransaction](api-endpoint:Transactions-RetrieveTransaction) endpoint. * One of `errors` or `transaction` is present in a given response (never both). */ export interface RetrieveTransactionResponse { diff --git a/src/models/searchCatalogItemsRequest.ts b/src/models/searchCatalogItemsRequest.ts index f9f7f952..0257a99c 100644 --- a/src/models/searchCatalogItemsRequest.ts +++ b/src/models/searchCatalogItemsRequest.ts @@ -40,7 +40,7 @@ export interface SearchCatalogItemsRequest { /** * 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]($e/Catalog/SearchCatalogItems) endpoint. + * a single call to the [SearchCatalogItems](api-endpoint:Catalog-SearchCatalogItems) endpoint. */ customAttributeFilters?: CustomAttributeFilter[]; } diff --git a/src/models/searchCatalogObjectsRequest.ts b/src/models/searchCatalogObjectsRequest.ts index f0927081..830f6763 100644 --- a/src/models/searchCatalogObjectsRequest.ts +++ b/src/models/searchCatalogObjectsRequest.ts @@ -13,7 +13,7 @@ import { CatalogQuery, catalogQuerySchema } from './catalogQuery'; export interface SearchCatalogObjectsRequest { /** * The pagination cursor returned in the previous response. Leave unset for an initial request. - * See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. */ cursor?: string; /** @@ -25,6 +25,9 @@ export interface SearchCatalogObjectsRequest { * 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. */ objectTypes?: string[]; /** diff --git a/src/models/searchCatalogObjectsResponse.ts b/src/models/searchCatalogObjectsResponse.ts index 5d968608..f8124300 100644 --- a/src/models/searchCatalogObjectsResponse.ts +++ b/src/models/searchCatalogObjectsResponse.ts @@ -7,7 +7,7 @@ export interface SearchCatalogObjectsResponse { errors?: Error[]; /** * The pagination cursor to be used in a subsequent request. If unset, this is the final response. - * See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. */ cursor?: string; /** The CatalogObjects returned. */ diff --git a/src/models/searchLoyaltyAccountsRequest.ts b/src/models/searchLoyaltyAccountsRequest.ts index 7c8a905b..40434f1e 100644 --- a/src/models/searchLoyaltyAccountsRequest.ts +++ b/src/models/searchLoyaltyAccountsRequest.ts @@ -15,7 +15,7 @@ export interface SearchLoyaltyAccountsRequest { * 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/basics/api101/pagination). + * see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string; } diff --git a/src/models/searchLoyaltyAccountsResponse.ts b/src/models/searchLoyaltyAccountsResponse.ts index 78f4d923..ce4c985e 100644 --- a/src/models/searchLoyaltyAccountsResponse.ts +++ b/src/models/searchLoyaltyAccountsResponse.ts @@ -15,7 +15,7 @@ export interface SearchLoyaltyAccountsResponse { * 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/basics/api101/pagination). + * see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string; } diff --git a/src/models/searchLoyaltyEventsRequest.ts b/src/models/searchLoyaltyEventsRequest.ts index 38ef282a..6f4654fb 100644 --- a/src/models/searchLoyaltyEventsRequest.ts +++ b/src/models/searchLoyaltyEventsRequest.ts @@ -17,7 +17,7 @@ export interface SearchLoyaltyEventsRequest { /** * 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/basics/api101/pagination). + * For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string; } diff --git a/src/models/searchLoyaltyEventsResponse.ts b/src/models/searchLoyaltyEventsResponse.ts index 3ead75ad..cb40bc2f 100644 --- a/src/models/searchLoyaltyEventsResponse.ts +++ b/src/models/searchLoyaltyEventsResponse.ts @@ -15,7 +15,7 @@ export interface SearchLoyaltyEventsResponse { * 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/basics/api101/pagination). + * see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string; } diff --git a/src/models/searchLoyaltyRewardsRequest.ts b/src/models/searchLoyaltyRewardsRequest.ts index 2137357e..705513a3 100644 --- a/src/models/searchLoyaltyRewardsRequest.ts +++ b/src/models/searchLoyaltyRewardsRequest.ts @@ -15,7 +15,7 @@ export interface SearchLoyaltyRewardsRequest { * 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/basics/api101/pagination). + * see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string; } diff --git a/src/models/searchLoyaltyRewardsRequestLoyaltyRewardQuery.ts b/src/models/searchLoyaltyRewardsRequestLoyaltyRewardQuery.ts index fa92fc22..7c7499f6 100644 --- a/src/models/searchLoyaltyRewardsRequestLoyaltyRewardQuery.ts +++ b/src/models/searchLoyaltyRewardsRequestLoyaltyRewardQuery.ts @@ -2,7 +2,7 @@ import { object, optional, Schema, string } from '../schema'; /** The set of search requirements. */ export interface SearchLoyaltyRewardsRequestLoyaltyRewardQuery { - /** The ID of the [loyalty account]($m/LoyaltyAccount) to which the loyalty reward belongs. */ + /** The ID of the [loyalty account](entity:LoyaltyAccount) to which the loyalty reward belongs. */ loyaltyAccountId: string; /** The status of the loyalty reward. */ status?: string; diff --git a/src/models/searchOrdersFulfillmentFilter.ts b/src/models/searchOrdersFulfillmentFilter.ts index d98a1e41..1e34940b 100644 --- a/src/models/searchOrdersFulfillmentFilter.ts +++ b/src/models/searchOrdersFulfillmentFilter.ts @@ -3,14 +3,14 @@ import { array, nullable, object, optional, Schema, string } from '../schema'; /** Filter based on [order fulfillment]($m/Fulfillment) information. */ export interface SearchOrdersFulfillmentFilter { /** - * A list of [fulfillment types]($m/FulfillmentType) to filter + * 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 */ fulfillmentTypes?: string[] | null; /** - * A list of [fulfillment states]($m/FulfillmentState) to filter + * 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 diff --git a/src/models/searchOrdersRequest.ts b/src/models/searchOrdersRequest.ts index 31be230a..5516e0cd 100644 --- a/src/models/searchOrdersRequest.ts +++ b/src/models/searchOrdersRequest.ts @@ -30,7 +30,7 @@ export interface SearchOrdersRequest { /** * 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/basics/api101/pagination). + * For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string; /** Contains query criteria for the search. */ @@ -43,7 +43,7 @@ export interface SearchOrdersRequest { limit?: number; /** * A Boolean that controls the format of the search results. If `true`, - * `SearchOrders` returns [OrderEntry]($m/OrderEntry) objects. If `false`, `SearchOrders` + * `SearchOrders` returns [OrderEntry](entity:OrderEntry) objects. If `false`, `SearchOrders` * returns complete order objects. * Default: `false`. */ diff --git a/src/models/searchOrdersResponse.ts b/src/models/searchOrdersResponse.ts index 67a657a1..cd7ab79b 100644 --- a/src/models/searchOrdersResponse.ts +++ b/src/models/searchOrdersResponse.ts @@ -9,23 +9,23 @@ import { OrderEntry, orderEntrySchema } from './orderEntry'; */ export interface SearchOrdersResponse { /** - * A list of [OrderEntries]($m/OrderEntry) that fit the query + * 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. */ orderEntries?: OrderEntry[]; /** * A list of - * [Order]($m/Order) objects that match the query conditions. The list is populated only if + * [Order](entity:Order) objects that match the query conditions. The list is populated only if * `return_entries` is set to `false` in the request. */ orders?: Order[]; /** * 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/basics/api101/pagination). + * For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). */ cursor?: string; - /** [Errors]($m/Error) encountered during the search. */ + /** [Errors](entity:Error) encountered during the search. */ errors?: Error[]; } diff --git a/src/models/searchOrdersSourceFilter.ts b/src/models/searchOrdersSourceFilter.ts index 799199c3..fbd071c9 100644 --- a/src/models/searchOrdersSourceFilter.ts +++ b/src/models/searchOrdersSourceFilter.ts @@ -3,7 +3,7 @@ import { array, nullable, object, optional, Schema, string } from '../schema'; /** A filter based on order `source` information. */ export interface SearchOrdersSourceFilter { /** - * Filters by the [Source]($m/OrderSource) `name`. The filter returns any orders + * 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. */ diff --git a/src/models/searchTerminalActionsRequest.ts b/src/models/searchTerminalActionsRequest.ts index b316a52b..d0656cc5 100644 --- a/src/models/searchTerminalActionsRequest.ts +++ b/src/models/searchTerminalActionsRequest.ts @@ -9,7 +9,7 @@ export interface SearchTerminalActionsRequest { /** * A pagination cursor returned by a previous call to this endpoint. * Provide this to retrieve the next set of results for the original query. - * See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more + * See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more * information. */ cursor?: string; diff --git a/src/models/searchTerminalActionsResponse.ts b/src/models/searchTerminalActionsResponse.ts index 635f627b..19390dfc 100644 --- a/src/models/searchTerminalActionsResponse.ts +++ b/src/models/searchTerminalActionsResponse.ts @@ -10,7 +10,7 @@ export interface SearchTerminalActionsResponse { /** * The pagination cursor to be used in a subsequent request. If empty, * this is the final response. - * See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more + * See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more * information. */ cursor?: string; diff --git a/src/models/searchTerminalCheckoutsRequest.ts b/src/models/searchTerminalCheckoutsRequest.ts index 09f2195b..926d9a76 100644 --- a/src/models/searchTerminalCheckoutsRequest.ts +++ b/src/models/searchTerminalCheckoutsRequest.ts @@ -9,7 +9,7 @@ export interface SearchTerminalCheckoutsRequest { /** * 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/basics/api101/pagination) for more information. + * See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. */ cursor?: string; /** Limits the number of results returned for a single request. */ diff --git a/src/models/searchTerminalCheckoutsResponse.ts b/src/models/searchTerminalCheckoutsResponse.ts index c7b0392d..2a8e5f1e 100644 --- a/src/models/searchTerminalCheckoutsResponse.ts +++ b/src/models/searchTerminalCheckoutsResponse.ts @@ -10,7 +10,7 @@ export interface SearchTerminalCheckoutsResponse { /** * The pagination cursor to be used in a subsequent request. If empty, * this is the final response. - * See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. */ cursor?: string; } diff --git a/src/models/searchTerminalRefundsResponse.ts b/src/models/searchTerminalRefundsResponse.ts index 696d3814..1c7e08e9 100644 --- a/src/models/searchTerminalRefundsResponse.ts +++ b/src/models/searchTerminalRefundsResponse.ts @@ -10,7 +10,7 @@ export interface SearchTerminalRefundsResponse { /** * The pagination cursor to be used in a subsequent request. If empty, * this is the final response. - * See [Pagination](https://developer.squareup.com/docs/basics/api101/pagination) for more information. + * See [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination) for more information. */ cursor?: string; } diff --git a/src/models/searchVendorsRequest.ts b/src/models/searchVendorsRequest.ts index 04641f0e..258cc0fb 100644 --- a/src/models/searchVendorsRequest.ts +++ b/src/models/searchVendorsRequest.ts @@ -1,4 +1,4 @@ -import { lazy, object, optional, Schema, string } from '../schema'; +import { bigint, lazy, object, optional, Schema, string } from '../schema'; import { SearchVendorsRequestFilter, searchVendorsRequestFilterSchema, @@ -20,10 +20,13 @@ export interface SearchVendorsRequest { * See the [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination) guide for more information. */ cursor?: string; + /** Limit on how many vendors will be returned by the search. */ + limit?: bigint; } export const searchVendorsRequestSchema: Schema = object({ filter: ['filter', optional(lazy(() => searchVendorsRequestFilterSchema))], sort: ['sort', optional(lazy(() => searchVendorsRequestSortSchema))], cursor: ['cursor', optional(string())], + limit: ['limit', optional(bigint())], }); diff --git a/src/models/searchVendorsRequestFilter.ts b/src/models/searchVendorsRequestFilter.ts index 49e19590..86b89e98 100644 --- a/src/models/searchVendorsRequestFilter.ts +++ b/src/models/searchVendorsRequestFilter.ts @@ -2,10 +2,10 @@ import { array, nullable, object, optional, Schema, string } from '../schema'; /** Defines supported query expressions to search for vendors by. */ export interface SearchVendorsRequestFilter { - /** The names of the [Vendor]($m/Vendor) objects to retrieve. */ + /** The names of the [Vendor](entity:Vendor) objects to retrieve. */ name?: string[] | null; /** - * The statuses of the [Vendor]($m/Vendor) objects to retrieve. + * The statuses of the [Vendor](entity:Vendor) objects to retrieve. * See [VendorStatus](#type-vendorstatus) for possible values */ status?: string[] | null; diff --git a/src/models/searchVendorsResponse.ts b/src/models/searchVendorsResponse.ts index 19ca9f10..df829bd1 100644 --- a/src/models/searchVendorsResponse.ts +++ b/src/models/searchVendorsResponse.ts @@ -6,7 +6,7 @@ import { Vendor, vendorSchema } from './vendor'; export interface SearchVendorsResponse { /** Errors encountered when the request fails. */ errors?: Error[]; - /** The [Vendor]($m/Vendor) objects matching the specified search filter. */ + /** The [Vendor](entity:Vendor) objects matching the specified search filter. */ vendors?: Vendor[]; /** * The pagination cursor to be used in a subsequent request. If unset, diff --git a/src/models/segmentFilter.ts b/src/models/segmentFilter.ts index 9ca488c1..5cb57e4f 100644 --- a/src/models/segmentFilter.ts +++ b/src/models/segmentFilter.ts @@ -3,7 +3,7 @@ import { FilterValue, filterValueSchema } from './filterValue'; /** A query filter to search for buyer-accessible appointment segments by. */ export interface SegmentFilter { - /** The ID of the [CatalogItemVariation]($m/CatalogItemVariation) object representing the service booked in this segment. */ + /** The ID of the [CatalogItemVariation](entity:CatalogItemVariation) object representing the service booked in this segment. */ serviceVariationId: string; /** * A filter to select resources based on an exact field value. For any given diff --git a/src/models/sourceApplication.ts b/src/models/sourceApplication.ts index 566c9207..5525bb69 100644 --- a/src/models/sourceApplication.ts +++ b/src/models/sourceApplication.ts @@ -6,7 +6,7 @@ export interface SourceApplication { product?: string; /** * __Read only__ The Square-assigned ID of the application. This field is used only if the - * [product]($m/Product) type is `EXTERNAL_API`. + * [product](entity:Product) type is `EXTERNAL_API`. */ applicationId?: string | null; /** diff --git a/src/models/subscription.ts b/src/models/subscription.ts index faf3a821..6040fd08 100644 --- a/src/models/subscription.ts +++ b/src/models/subscription.ts @@ -28,9 +28,9 @@ export interface Subscription { id?: string; /** The ID of the location associated with the subscription. */ locationId?: string; - /** The ID of the subscribed-to [subscription plan]($m/CatalogSubscriptionPlan). */ + /** The ID of the subscribed-to [subscription plan](entity:CatalogSubscriptionPlan). */ planId?: string; - /** The ID of the subscribing [customer]($m/Customer) profile. */ + /** The ID of the subscribing [customer](entity:Customer) profile. */ customerId?: string; /** The `YYYY-MM-DD`-formatted date (for example, 2013-01-15) to start the subscription. */ startDate?: string; @@ -62,7 +62,7 @@ export interface Subscription { */ taxPercentage?: string | null; /** - * The IDs of the [invoices]($m/Invoice) created for the + * The IDs of the [invoices](entity:Invoice) created for the * subscription, listed in order when the invoices were created * (newest invoices appear first). */ @@ -85,7 +85,7 @@ export interface Subscription { /** The timestamp when the subscription was created, in RFC 3339 format. */ createdAt?: string; /** - * The ID of the [subscriber's]($m/Customer) [card]($m/Card) + * The ID of the [subscriber's](entity:Customer) [card](entity:Card) * used to charge for the subscription. */ cardId?: string | null; diff --git a/src/models/teamMemberAssignedLocations.ts b/src/models/teamMemberAssignedLocations.ts index 35a8675a..f39a64f2 100644 --- a/src/models/teamMemberAssignedLocations.ts +++ b/src/models/teamMemberAssignedLocations.ts @@ -4,7 +4,7 @@ import { array, nullable, object, optional, Schema, string } from '../schema'; export interface TeamMemberAssignedLocations { /** Enumerates the possible assignment types that the team member can have. */ assignmentType?: string; - /** The locations that the team member is assigned to. */ + /** The explicit locations that the team member is assigned to. */ locationIds?: string[] | null; } diff --git a/src/models/teamMemberBookingProfile.ts b/src/models/teamMemberBookingProfile.ts index 58dd0314..4e5abbf2 100644 --- a/src/models/teamMemberBookingProfile.ts +++ b/src/models/teamMemberBookingProfile.ts @@ -2,7 +2,7 @@ import { boolean, nullable, object, optional, Schema, string } from '../schema'; /** 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. */ export interface TeamMemberBookingProfile { - /** The ID of the [TeamMember]($m/TeamMember) object for the team member associated with the booking profile. */ + /** The ID of the [TeamMember](entity:TeamMember) object for the team member associated with the booking profile. */ teamMemberId?: string; /** The description of the team member. */ description?: string; diff --git a/src/models/tender.ts b/src/models/tender.ts index 0627c58a..db5127fc 100644 --- a/src/models/tender.ts +++ b/src/models/tender.ts @@ -77,7 +77,7 @@ export interface Tender { */ additionalRecipients?: AdditionalRecipient[] | null; /** - * The ID of the [Payment]($m/Payment) that corresponds to this tender. + * 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. */ paymentId?: string | null; diff --git a/src/models/terminalCheckout.ts b/src/models/terminalCheckout.ts index a6dc98bf..d993ab54 100644 --- a/src/models/terminalCheckout.ts +++ b/src/models/terminalCheckout.ts @@ -68,6 +68,8 @@ export interface TerminalCheckout { /** The location of the device where the `TerminalCheckout` was directed. */ locationId?: string; paymentType?: string; + /** An optional ID of the team member associated with creating the checkout. */ + teamMemberId?: string | null; /** An optional ID of the customer associated with the checkout. */ customerId?: string | null; /** @@ -79,6 +81,21 @@ export interface TerminalCheckout { * for more information. */ appFeeMoney?: Money; + /** + * 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. + */ + statementDescriptionIdentifier?: string | null; + /** + * 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. + */ + tipMoney?: Money; } export const terminalCheckoutSchema: Schema = object({ @@ -101,6 +118,12 @@ export const terminalCheckoutSchema: Schema = object({ appId: ['app_id', optional(string())], locationId: ['location_id', optional(string())], paymentType: ['payment_type', optional(string())], + teamMemberId: ['team_member_id', optional(nullable(string()))], customerId: ['customer_id', optional(nullable(string()))], appFeeMoney: ['app_fee_money', optional(lazy(() => moneySchema))], + statementDescriptionIdentifier: [ + 'statement_description_identifier', + optional(nullable(string())), + ], + tipMoney: ['tip_money', optional(lazy(() => moneySchema))], }); diff --git a/src/models/testWebhookSubscriptionRequest.ts b/src/models/testWebhookSubscriptionRequest.ts index 1e2d29db..77635774 100644 --- a/src/models/testWebhookSubscriptionRequest.ts +++ b/src/models/testWebhookSubscriptionRequest.ts @@ -3,8 +3,8 @@ import { nullable, object, optional, Schema, string } from '../schema'; /** Tests a [Subscription]($m/WebhookSubscription) by sending a test event to its notification URL. */ export interface TestWebhookSubscriptionRequest { /** - * The event type that will be used to test the [Subscription]($m/WebhookSubscription). The event type must be - * contained in the list of event types in the [Subscription]($m/WebhookSubscription). + * 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). */ eventType?: string | null; } diff --git a/src/models/transaction.ts b/src/models/transaction.ts index 4640942b..59876c44 100644 --- a/src/models/transaction.ts +++ b/src/models/transaction.ts @@ -29,7 +29,7 @@ export interface Transaction { /** Refunds that have been applied to any tender in the transaction. */ refunds?: Refund[] | null; /** - * If the transaction was created with the [Charge]($e/Transactions/Charge) + * 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. */ diff --git a/src/models/updateCatalogImageRequest.ts b/src/models/updateCatalogImageRequest.ts index 8ec06c04..ed509766 100644 --- a/src/models/updateCatalogImageRequest.ts +++ b/src/models/updateCatalogImageRequest.ts @@ -4,7 +4,7 @@ export interface UpdateCatalogImageRequest { /** * 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/basics/api101/idempotency) for more information. + * See [Idempotency keys](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. */ idempotencyKey: string; } diff --git a/src/models/updateVendorRequest.ts b/src/models/updateVendorRequest.ts index 6c544004..b21809d5 100644 --- a/src/models/updateVendorRequest.ts +++ b/src/models/updateVendorRequest.ts @@ -6,8 +6,8 @@ export interface UpdateVendorRequest { /** * A client-supplied, universally unique identifier (UUID) for the * request. - * See [Idempotency](https://developer.squareup.com/docs/basics/api101/idempotency) in the - * [API Development 101](https://developer.squareup.com/docs/basics/api101/overview) section for more + * 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. */ idempotencyKey?: string | null; diff --git a/src/models/updateWebhookSubscriptionSignatureKeyRequest.ts b/src/models/updateWebhookSubscriptionSignatureKeyRequest.ts index b4003ad1..6d3894ec 100644 --- a/src/models/updateWebhookSubscriptionSignatureKeyRequest.ts +++ b/src/models/updateWebhookSubscriptionSignatureKeyRequest.ts @@ -2,7 +2,7 @@ import { nullable, object, optional, Schema, string } from '../schema'; /** Updates a [Subscription]($m/WebhookSubscription) by replacing the existing signature key with a new one. */ export interface UpdateWebhookSubscriptionSignatureKeyRequest { - /** A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey]($e/WebhookSubscriptions/UpdateWebhookSubscriptionSignatureKey) request. */ + /** A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey) request. */ idempotencyKey?: string | null; } diff --git a/src/models/upsertCatalogObjectRequest.ts b/src/models/upsertCatalogObjectRequest.ts index dff2c503..3a763292 100644 --- a/src/models/upsertCatalogObjectRequest.ts +++ b/src/models/upsertCatalogObjectRequest.ts @@ -10,7 +10,7 @@ export interface UpsertCatalogObjectRequest { * 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/basics/api101/idempotency) for more information. + * See [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency) for more information. */ idempotencyKey: string; /** diff --git a/src/models/vendor.ts b/src/models/vendor.ts index 089ecc37..ef25b2c6 100644 --- a/src/models/vendor.ts +++ b/src/models/vendor.ts @@ -14,23 +14,23 @@ import { VendorContact, vendorContactSchema } from './vendorContact'; /** Represents a supplier to a seller. */ export interface Vendor { /** - * A unique Square-generated ID for the [Vendor]($m/Vendor). - * This field is required when attempting to update a [Vendor]($m/Vendor). + * A unique Square-generated ID for the [Vendor](entity:Vendor). + * This field is required when attempting to update a [Vendor](entity:Vendor). */ id?: string; /** * An RFC 3339-formatted timestamp that indicates when the - * [Vendor]($m/Vendor) was created. + * [Vendor](entity:Vendor) was created. */ createdAt?: string; /** * An RFC 3339-formatted timestamp that indicates when the - * [Vendor]($m/Vendor) was last updated. + * [Vendor](entity:Vendor) was last updated. */ updatedAt?: string; /** - * The name of the [Vendor]($m/Vendor). - * This field is required when attempting to create or update a [Vendor]($m/Vendor). + * The name of the [Vendor](entity:Vendor). + * This field is required when attempting to create or update a [Vendor](entity:Vendor). */ name?: string | null; /** @@ -38,13 +38,13 @@ export interface Vendor { * For more information, see [Working with Addresses](https://developer.squareup.com/docs/build-basics/working-with-addresses). */ address?: Address; - /** The contacts of the [Vendor]($m/Vendor). */ + /** The contacts of the [Vendor](entity:Vendor). */ contacts?: VendorContact[] | null; - /** The account number of the [Vendor]($m/Vendor). */ + /** The account number of the [Vendor](entity:Vendor). */ accountNumber?: string | null; - /** A note detailing information about the [Vendor]($m/Vendor). */ + /** A note detailing information about the [Vendor](entity:Vendor). */ note?: string | null; - /** The version of the [Vendor]($m/Vendor). */ + /** The version of the [Vendor](entity:Vendor). */ version?: number; /** * The status of the [Vendor]($m/Vendor), diff --git a/src/models/vendorContact.ts b/src/models/vendorContact.ts index 7b7cf119..289400d8 100644 --- a/src/models/vendorContact.ts +++ b/src/models/vendorContact.ts @@ -11,22 +11,22 @@ import { /** Represents a contact of a [Vendor]($m/Vendor). */ export interface VendorContact { /** - * A unique Square-generated ID for the [VendorContact]($m/VendorContact). - * This field is required when attempting to update a [VendorContact]($m/VendorContact). + * A unique Square-generated ID for the [VendorContact](entity:VendorContact). + * This field is required when attempting to update a [VendorContact](entity:VendorContact). */ id?: string; /** - * The name of the [VendorContact]($m/VendorContact). - * This field is required when attempting to create a [Vendor]($m/Vendor). + * The name of the [VendorContact](entity:VendorContact). + * This field is required when attempting to create a [Vendor](entity:Vendor). */ name?: string | null; - /** The email address of the [VendorContact]($m/VendorContact). */ + /** The email address of the [VendorContact](entity:VendorContact). */ emailAddress?: string | null; - /** The phone number of the [VendorContact]($m/VendorContact). */ + /** The phone number of the [VendorContact](entity:VendorContact). */ phoneNumber?: string | null; - /** The state of the [VendorContact]($m/VendorContact). */ + /** The state of the [VendorContact](entity:VendorContact). */ removed?: boolean | null; - /** The ordinal of the [VendorContact]($m/VendorContact). */ + /** The ordinal of the [VendorContact](entity:VendorContact). */ ordinal: number; } diff --git a/src/models/voidTransactionResponse.ts b/src/models/voidTransactionResponse.ts index 96a72f11..29381949 100644 --- a/src/models/voidTransactionResponse.ts +++ b/src/models/voidTransactionResponse.ts @@ -3,7 +3,7 @@ import { Error, errorSchema } from './error'; /** * Defines the fields that are included in the response body of - * a request to the [VoidTransaction]($e/Transactions/VoidTransaction) endpoint. + * a request to the [VoidTransaction](api-endpoint:Transactions-VoidTransaction) endpoint. */ export interface VoidTransactionResponse { /** Any errors that occurred during the request. */