square_connect 2.20190313.1.282 → 2.20190327.1.292

Sign up to get free protection for your applications and to get access to all the features.
Files changed (128) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGES.md +12 -0
  3. data/README.md +5 -4
  4. data/docs/Address.md +1 -1
  5. data/docs/BatchRetrieveInventoryChangesRequest.md +2 -2
  6. data/docs/Card.md +1 -1
  7. data/docs/CatalogDiscount.md +1 -1
  8. data/docs/CatalogImage.md +14 -0
  9. data/docs/CatalogItem.md +2 -2
  10. data/docs/CatalogItemVariation.md +2 -2
  11. data/docs/CatalogModifierList.md +1 -1
  12. data/docs/CatalogObject.md +3 -1
  13. data/docs/CatalogObjectType.md +1 -0
  14. data/docs/CatalogQuerySortedAttribute.md +1 -1
  15. data/docs/CatalogTax.md +2 -2
  16. data/docs/CreateOrderRequestTax.md +1 -1
  17. data/docs/Customer.md +1 -1
  18. data/docs/CustomerCreationSourceFilter.md +2 -2
  19. data/docs/CustomerSort.md +2 -2
  20. data/docs/CustomersApi.md +5 -5
  21. data/docs/Employee.md +1 -1
  22. data/docs/Error.md +1 -1
  23. data/docs/InventoryAdjustment.md +2 -2
  24. data/docs/InventoryChange.md +1 -1
  25. data/docs/InventoryCount.md +1 -1
  26. data/docs/InventoryPhysicalCount.md +1 -1
  27. data/docs/InventoryTransfer.md +1 -1
  28. data/docs/ItemVariationLocationOverrides.md +2 -2
  29. data/docs/ListAdditionalRecipientReceivableRefundsRequest.md +1 -1
  30. data/docs/ListAdditionalRecipientReceivablesRequest.md +1 -1
  31. data/docs/ListCustomersRequest.md +2 -2
  32. data/docs/ListEmployeesRequest.md +1 -1
  33. data/docs/ListRefundsRequest.md +1 -1
  34. data/docs/ListTransactionsRequest.md +1 -1
  35. data/docs/Location.md +5 -5
  36. data/docs/Money.md +1 -1
  37. data/docs/ObtainTokenRequest.md +6 -6
  38. data/docs/ObtainTokenResponse.md +2 -2
  39. data/docs/OrderFulfillment.md +2 -2
  40. data/docs/OrderFulfillmentPickupDetails.md +1 -1
  41. data/docs/OrderLineItemDiscount.md +2 -2
  42. data/docs/OrderLineItemTax.md +2 -2
  43. data/docs/Refund.md +1 -1
  44. data/docs/RegisterDomainResponse.md +1 -1
  45. data/docs/SearchCatalogObjectsRequest.md +1 -1
  46. data/docs/Shift.md +1 -1
  47. data/docs/ShiftFilter.md +1 -1
  48. data/docs/ShiftSort.md +2 -2
  49. data/docs/ShiftWorkday.md +1 -1
  50. data/docs/SourceApplication.md +1 -1
  51. data/docs/Tender.md +1 -1
  52. data/docs/TenderCardDetails.md +2 -2
  53. data/docs/Transaction.md +1 -1
  54. data/docs/V1Payment.md +1 -1
  55. data/docs/WorkweekConfig.md +1 -1
  56. data/lib/square_connect.rb +1 -0
  57. data/lib/square_connect/api/apple_pay_api.rb +1 -1
  58. data/lib/square_connect/api/catalog_api.rb +11 -11
  59. data/lib/square_connect/api/checkout_api.rb +1 -1
  60. data/lib/square_connect/api/customers_api.rb +14 -14
  61. data/lib/square_connect/api/employees_api.rb +2 -2
  62. data/lib/square_connect/api/inventory_api.rb +7 -7
  63. data/lib/square_connect/api/labor_api.rb +14 -14
  64. data/lib/square_connect/api/locations_api.rb +1 -1
  65. data/lib/square_connect/api/mobile_authorization_api.rb +1 -1
  66. data/lib/square_connect/api/o_auth_api.rb +3 -3
  67. data/lib/square_connect/api/orders_api.rb +2 -2
  68. data/lib/square_connect/api/reporting_api.rb +2 -2
  69. data/lib/square_connect/api/transactions_api.rb +7 -7
  70. data/lib/square_connect/api/v1_employees_api.rb +16 -16
  71. data/lib/square_connect/api/v1_items_api.rb +40 -40
  72. data/lib/square_connect/api/v1_locations_api.rb +2 -2
  73. data/lib/square_connect/api/v1_transactions_api.rb +11 -11
  74. data/lib/square_connect/api_client.rb +1 -1
  75. data/lib/square_connect/models/address.rb +1 -1
  76. data/lib/square_connect/models/batch_retrieve_inventory_changes_request.rb +2 -2
  77. data/lib/square_connect/models/card.rb +1 -1
  78. data/lib/square_connect/models/catalog_discount.rb +1 -1
  79. data/lib/square_connect/models/catalog_image.rb +206 -0
  80. data/lib/square_connect/models/catalog_item.rb +2 -2
  81. data/lib/square_connect/models/catalog_item_variation.rb +2 -2
  82. data/lib/square_connect/models/catalog_modifier_list.rb +1 -1
  83. data/lib/square_connect/models/catalog_object.rb +27 -7
  84. data/lib/square_connect/models/catalog_object_type.rb +1 -0
  85. data/lib/square_connect/models/catalog_query_sorted_attribute.rb +1 -1
  86. data/lib/square_connect/models/catalog_tax.rb +2 -2
  87. data/lib/square_connect/models/create_order_request_tax.rb +1 -1
  88. data/lib/square_connect/models/customer.rb +1 -1
  89. data/lib/square_connect/models/customer_creation_source_filter.rb +2 -2
  90. data/lib/square_connect/models/customer_sort.rb +2 -2
  91. data/lib/square_connect/models/employee.rb +1 -1
  92. data/lib/square_connect/models/error.rb +1 -1
  93. data/lib/square_connect/models/inventory_adjustment.rb +2 -2
  94. data/lib/square_connect/models/inventory_change.rb +1 -1
  95. data/lib/square_connect/models/inventory_count.rb +1 -1
  96. data/lib/square_connect/models/inventory_physical_count.rb +1 -1
  97. data/lib/square_connect/models/inventory_transfer.rb +1 -1
  98. data/lib/square_connect/models/item_variation_location_overrides.rb +2 -2
  99. data/lib/square_connect/models/list_additional_recipient_receivable_refunds_request.rb +1 -1
  100. data/lib/square_connect/models/list_additional_recipient_receivables_request.rb +1 -1
  101. data/lib/square_connect/models/list_customers_request.rb +2 -2
  102. data/lib/square_connect/models/list_employees_request.rb +1 -1
  103. data/lib/square_connect/models/list_refunds_request.rb +1 -1
  104. data/lib/square_connect/models/list_transactions_request.rb +1 -1
  105. data/lib/square_connect/models/location.rb +5 -5
  106. data/lib/square_connect/models/money.rb +1 -1
  107. data/lib/square_connect/models/obtain_token_request.rb +20 -5
  108. data/lib/square_connect/models/obtain_token_response.rb +2 -2
  109. data/lib/square_connect/models/order_fulfillment.rb +2 -2
  110. data/lib/square_connect/models/order_fulfillment_pickup_details.rb +1 -1
  111. data/lib/square_connect/models/order_line_item_discount.rb +2 -2
  112. data/lib/square_connect/models/order_line_item_tax.rb +2 -2
  113. data/lib/square_connect/models/refund.rb +1 -1
  114. data/lib/square_connect/models/register_domain_response.rb +1 -1
  115. data/lib/square_connect/models/search_catalog_objects_request.rb +1 -1
  116. data/lib/square_connect/models/shift.rb +1 -1
  117. data/lib/square_connect/models/shift_filter.rb +1 -1
  118. data/lib/square_connect/models/shift_sort.rb +2 -2
  119. data/lib/square_connect/models/shift_workday.rb +1 -1
  120. data/lib/square_connect/models/source_application.rb +1 -1
  121. data/lib/square_connect/models/tender.rb +1 -1
  122. data/lib/square_connect/models/tender_card_details.rb +2 -2
  123. data/lib/square_connect/models/transaction.rb +1 -1
  124. data/lib/square_connect/models/v1_payment.rb +1 -1
  125. data/lib/square_connect/models/workweek_config.rb +1 -1
  126. data/lib/square_connect/version.rb +1 -1
  127. data/spec/models/catalog_image_spec.rb +51 -0
  128. metadata +6 -2
@@ -15,10 +15,10 @@ module SquareConnect
15
15
  # The tax's name. Searchable. This field has max length of 255 Unicode code points.
16
16
  attr_accessor :name
17
17
 
18
- # Whether the tax is calculated based on a payment's subtotal or total. See [TaxCalculationPhase](#type-taxcalculationphase) for all possible values.
18
+ # Whether the tax is calculated based on a payment's subtotal or total. See [TaxCalculationPhase](#type-taxcalculationphase) for possible values
19
19
  attr_accessor :calculation_phase
20
20
 
21
- # Whether the tax is `ADDITIVE` or `INCLUSIVE`. See [TaxInclusionType](#type-taxinclusiontype) for all possible values.
21
+ # Whether the tax is `ADDITIVE` or `INCLUSIVE`. See [TaxInclusionType](#type-taxinclusiontype) for possible values
22
22
  attr_accessor :inclusion_type
23
23
 
24
24
  # The percentage of the tax in decimal form, using a `'.'` as the decimal separator and without a `'%'` sign. A value of `7.5` corresponds to 7.5%.
@@ -18,7 +18,7 @@ module SquareConnect
18
18
  # Only used for ad hoc taxes. The tax's name. Do not provide a value for this field if you set `catalog_object_id`.
19
19
  attr_accessor :name
20
20
 
21
- # Only used for ad hoc taxes. Indicates the calculation method used to apply the line item tax. Default: `ADDITIVE`; See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values.
21
+ # Only used for ad hoc taxes. Indicates the calculation method used to apply the line item tax. Default: `ADDITIVE`; See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values
22
22
  attr_accessor :type
23
23
 
24
24
  # Only used for ad hoc taxes. The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. This value range between 0.0 up to 100.0
@@ -60,7 +60,7 @@ module SquareConnect
60
60
  # The groups the customer belongs to.
61
61
  attr_accessor :groups
62
62
 
63
- # A creation source represents the method used to create the customer profile.
63
+ # A creation source represents the method used to create the customer profile. See [CustomerCreationSource](#type-customercreationsource) for possible values
64
64
  attr_accessor :creation_source
65
65
 
66
66
  class EnumAttributeValidator
@@ -12,10 +12,10 @@ require 'date'
12
12
  module SquareConnect
13
13
  # Creation source filter. If one or more creation sources are set, customer profiles are included in, or excluded from, the result if they match at least one of the filter criteria.
14
14
  class CustomerCreationSourceFilter
15
- # The list of creation sources used as filtering criteria. See [CustomerCreationSource](#type-customercreationsource) for possible values.
15
+ # The list of creation sources used as filtering criteria. See [CustomerCreationSource](#type-customercreationsource) for possible values
16
16
  attr_accessor :values
17
17
 
18
- # Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values.
18
+ # Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values
19
19
  attr_accessor :rule
20
20
 
21
21
  class EnumAttributeValidator
@@ -12,10 +12,10 @@ require 'date'
12
12
  module SquareConnect
13
13
  # Indicates the field to use for sorting customer profiles. For example, by total money spent with the merchant or the date of their first purchase.
14
14
  class CustomerSort
15
- # The field to sort the results on. It could be the total money spent at the merchant, the date of the first visit (etc). See [CustomerSortField](#type-customersortfield) for possible values. Default value: `DEFAULT`.
15
+ # The field to sort the results on. It could be the total money spent at the merchant, the date of the first visit (etc). See [CustomerSortField](#type-customersortfield) for possible values
16
16
  attr_accessor :field
17
17
 
18
- # Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. See [SortOrder](#type-sortorder) for possible values. Default value: `ASC`.
18
+ # Indicates the order in which results should be displayed based on the value of the sort field. String comparisons use standard alphabetic comparison to determine order. Strings representing numbers are sorted as strings. See [SortOrder](#type-sortorder) for possible values
19
19
  attr_accessor :order
20
20
 
21
21
  class EnumAttributeValidator
@@ -24,7 +24,7 @@ module SquareConnect
24
24
  # A list of location IDs where this employee has access.
25
25
  attr_accessor :location_ids
26
26
 
27
- # Specifies the status of the employee being fetched.
27
+ # Specifies the status of the employee being fetched. See [EmployeeStatus](#type-employeestatus) for possible values
28
28
  attr_accessor :status
29
29
 
30
30
  # A read-only timestamp in RFC 3339 format.
@@ -12,7 +12,7 @@ require 'date'
12
12
  module SquareConnect
13
13
  # Represents an error encountered during a request to the Connect API.
14
14
  class Error
15
- # The error's high-level category. See [ErrorCategory](#type-errorcategory) for possible values.
15
+ # The error's high-level category. See [ErrorCategory](#type-errorcategory) for possible values
16
16
  attr_accessor :category
17
17
 
18
18
  # The error's specific code. See [ErrorCode](#type-errorcode) for possible values
@@ -18,10 +18,10 @@ module SquareConnect
18
18
  # An optional ID provided by the application to tie the [InventoryAdjustment](#type-inventoryadjustment) to an external system.
19
19
  attr_accessor :reference_id
20
20
 
21
- # The [InventoryState](#type-inventorystate) of the related quantity of items before the adjustment.
21
+ # The [InventoryState](#type-inventorystate) of the related quantity of items before the adjustment. See [InventoryState](#type-inventorystate) for possible values
22
22
  attr_accessor :from_state
23
23
 
24
- # The [InventoryState](#type-inventorystate) of the related quantity of items after the adjustment.
24
+ # The [InventoryState](#type-inventorystate) of the related quantity of items after the adjustment. See [InventoryState](#type-inventorystate) for possible values
25
25
  attr_accessor :to_state
26
26
 
27
27
  # The Square ID of the [Location](#type-location) where the related quantity of items are being tracked.
@@ -12,7 +12,7 @@ require 'date'
12
12
  module SquareConnect
13
13
  # Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular [CatalogObject](#type-catalogobject).
14
14
  class InventoryChange
15
- # Indicates how the inventory change was applied. See [InventoryChangeType](#type-inventorychangetype) for all possible values.
15
+ # Indicates how the inventory change was applied. See [InventoryChangeType](#type-inventorychangetype) for possible values
16
16
  attr_accessor :type
17
17
 
18
18
  # Contains details about the physical count when `type` is `PHYSICAL_COUNT` and unset for all other types.
@@ -18,7 +18,7 @@ module SquareConnect
18
18
  # The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type.
19
19
  attr_accessor :catalog_object_type
20
20
 
21
- # The current [InventoryState](#type-inventorystate) for the related quantity of items.
21
+ # The current [InventoryState](#type-inventorystate) for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values
22
22
  attr_accessor :state
23
23
 
24
24
  # The Square ID of the [Location](#type-location) where the related quantity of items are being tracked.
@@ -24,7 +24,7 @@ module SquareConnect
24
24
  # The [CatalogObjectType](#type-catalogobjecttype) of the [CatalogObject](#type-catalogobject) being tracked. Tracking is only supported for the `ITEM_VARIATION` type.
25
25
  attr_accessor :catalog_object_type
26
26
 
27
- # The current [InventoryState](#type-inventorystate) for the related quantity of items.
27
+ # The current [InventoryState](#type-inventorystate) for the related quantity of items. See [InventoryState](#type-inventorystate) for possible values
28
28
  attr_accessor :state
29
29
 
30
30
  # The Square ID of the [Location](#type-location) where the related quantity of items are being tracked.
@@ -18,7 +18,7 @@ module SquareConnect
18
18
  # An optional ID provided by the application to tie the [InventoryTransfer](#type-inventorytransfer) to an external system.
19
19
  attr_accessor :reference_id
20
20
 
21
- # The [InventoryState](#type-inventorystate) for the quantity of items being transfered.
21
+ # The [InventoryState](#type-inventorystate) for the quantity of items being transfered. See [InventoryState](#type-inventorystate) for possible values
22
22
  attr_accessor :state
23
23
 
24
24
  # The Square ID of the [Location](#type-location) where the related quantity of items were tracked before the transfer.
@@ -18,13 +18,13 @@ module SquareConnect
18
18
  # The price of the [CatalogItemVariation](#type-catalogitemvariation) at the given [location](#type-location), or blank for variable pricing.
19
19
  attr_accessor :price_money
20
20
 
21
- # The pricing type (fixed or variable) for the [CatalogItemVariation](#type-catalogitemvariation) at the given [location](#type-location). See [CatalogPricingType](#type-catalogpricingtype) for all possible values.
21
+ # The pricing type (fixed or variable) for the [CatalogItemVariation](#type-catalogitemvariation) at the given [location](#type-location). See [CatalogPricingType](#type-catalogpricingtype) for possible values
22
22
  attr_accessor :pricing_type
23
23
 
24
24
  # If `true`, inventory tracking is active for the [CatalogItemVariation](#type-catalogitemvariation) at this [location](#type-location).
25
25
  attr_accessor :track_inventory
26
26
 
27
- # Indicates whether the [CatalogItemVariation](#type-catalogitemvariation) displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for all possible values.
27
+ # Indicates whether the [CatalogItemVariation](#type-catalogitemvariation) displays an alert when its inventory quantity is less than or equal to its `inventory_alert_threshold`. See [InventoryAlertType](#type-inventoryalerttype) for possible values
28
28
  attr_accessor :inventory_alert_type
29
29
 
30
30
  # If the inventory quantity for the variation is less than or equal to this value and `inventory_alert_type` is `LOW_QUANTITY`, the variation displays an alert in the merchant dashboard. This value is always an integer.
@@ -18,7 +18,7 @@ module SquareConnect
18
18
  # The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.
19
19
  attr_accessor :end_time
20
20
 
21
- # The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
21
+ # The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` See [SortOrder](#type-sortorder) for possible values
22
22
  attr_accessor :sort_order
23
23
 
24
24
  # 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](/basics/api101/pagination) for more information.
@@ -18,7 +18,7 @@ module SquareConnect
18
18
  # The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.
19
19
  attr_accessor :end_time
20
20
 
21
- # The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
21
+ # The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` See [SortOrder](#type-sortorder) for possible values
22
22
  attr_accessor :sort_order
23
23
 
24
24
  # 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](/basics/api101/pagination) for more information.
@@ -15,10 +15,10 @@ module SquareConnect
15
15
  # 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](/basics/api101/pagination) for more information.
16
16
  attr_accessor :cursor
17
17
 
18
- # Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values.
18
+ # Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values
19
19
  attr_accessor :sort_field
20
20
 
21
- # Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values.
21
+ # Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values
22
22
  attr_accessor :sort_order
23
23
 
24
24
  class EnumAttributeValidator
@@ -15,7 +15,7 @@ module SquareConnect
15
15
  # Filter employees returned to only those that are associated with the specified location.
16
16
  attr_accessor :location_id
17
17
 
18
- # Specifies the EmployeeStatus to filter the employee by.
18
+ # Specifies the EmployeeStatus to filter the employee by. See [EmployeeStatus](#type-employeestatus) for possible values
19
19
  attr_accessor :status
20
20
 
21
21
  # The number of employees to be returned on each page.
@@ -18,7 +18,7 @@ module SquareConnect
18
18
  # The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.
19
19
  attr_accessor :end_time
20
20
 
21
- # The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
21
+ # The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` See [SortOrder](#type-sortorder) for possible values
22
22
  attr_accessor :sort_order
23
23
 
24
24
  # 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](/basics/api101/pagination) for more information.
@@ -18,7 +18,7 @@ module SquareConnect
18
18
  # The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.
19
19
  attr_accessor :end_time
20
20
 
21
- # The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC`
21
+ # The order in which results are listed in the response (`ASC` for oldest first, `DESC` for newest first). Default value: `DESC` See [SortOrder](#type-sortorder) for possible values
22
22
  attr_accessor :sort_order
23
23
 
24
24
  # 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](/basics/api101/pagination) for more information.
@@ -24,10 +24,10 @@ module SquareConnect
24
24
  # The [IANA Timezone Database](https://www.iana.org/time-zones) identifier for the location's timezone.
25
25
  attr_accessor :timezone
26
26
 
27
- # Indicates which Square features are enabled for the location. See [LocationCapability](#type-locationcapability) for possible values.
27
+ # Indicates which Square features are enabled for the location. See [LocationCapability](#type-locationcapability) for possible values
28
28
  attr_accessor :capabilities
29
29
 
30
- # The location's status See [LocationStatus](#type-locationstatus) for possible values.
30
+ # The location's status See [LocationStatus](#type-locationstatus) for possible values
31
31
  attr_accessor :status
32
32
 
33
33
  # The time when the location was created, in RFC 3339 format.
@@ -36,13 +36,13 @@ module SquareConnect
36
36
  # The identifier of the merchant that owns the location.
37
37
  attr_accessor :merchant_id
38
38
 
39
- # The location's country, in ISO 3166-1-alpha-2 format. See [Country](#type-country) for possible values.
39
+ # The location's country, in ISO 3166-1-alpha-2 format. See [Country](#type-country) for possible values
40
40
  attr_accessor :country
41
41
 
42
42
  # The language associated with the location in [BCP 47 format](https://tools.ietf.org/html/bcp47#appendix-A).
43
43
  attr_accessor :language_code
44
44
 
45
- # The currency used for all transactions at this location, specified in __ISO 4217 format__. For example, the currency for a location processing transactions in the United States is 'USD'. See [Currency](#type-currency) for possible values.
45
+ # The currency used for all transactions at this location, specified in __ISO 4217 format__. For example, the currency for a location processing transactions in the United States is 'USD'. See [Currency](#type-currency) for possible values
46
46
  attr_accessor :currency
47
47
 
48
48
  # The location's phone_number.
@@ -51,7 +51,7 @@ module SquareConnect
51
51
  # The location's business_name which is shown to its customers. For example, this is the name printed on its customer's receipts.
52
52
  attr_accessor :business_name
53
53
 
54
- # The location's type, as set by the account owner in the Square dashboard. Typically used to indicate whether or not the location object represents a physical space like a building or mall space. See [LocationType](#type-locationtype) for possible values.
54
+ # The location's type, as set by the account owner in the Square dashboard. Typically used to indicate whether or not the location object represents a physical space like a building or mall space. See [LocationType](#type-locationtype) for possible values
55
55
  attr_accessor :type
56
56
 
57
57
  # The location's website, as set by the account owner in the Square dashboard. Default: none; only exists if explicitly set.
@@ -15,7 +15,7 @@ module SquareConnect
15
15
  # The amount of money, in the smallest denomination of the currency indicated by `currency`. For example, when `currency` is `USD`, `amount` is in cents.
16
16
  attr_accessor :amount
17
17
 
18
- # The type of currency, in __ISO 4217 format__. For example, the currency code for US dollars is `USD`. See [Currency](#type-currency) for possible values.
18
+ # The type of currency, in __ISO 4217 format__. For example, the currency code for US dollars is `USD`. See [Currency](#type-currency) for possible values
19
19
  attr_accessor :currency
20
20
 
21
21
  class EnumAttributeValidator
@@ -15,22 +15,22 @@ module SquareConnect
15
15
  # The Square-issued ID of your application, available from the [application dashboard](https://connect.squareup.com/apps).
16
16
  attr_accessor :client_id
17
17
 
18
- # The Square-issued application secret for your application, available from the [application dashboard](https://connect.squareup.com/apps).
18
+ # The Square-issued application secret for your application, available from the [application dashboard](https://connect.squareup.com/apps).
19
19
  attr_accessor :client_secret
20
20
 
21
- # The authorization code to exchange. This is required if `grant_type` is set to `authorization_code`, to indicate that the application wants to exchange an authorization code for an OAuth access token.
21
+ # The authorization code to exchange. This is required if `grant_type` is set to `authorization_code`, to indicate that the application wants to exchange an authorization code for an OAuth access token.
22
22
  attr_accessor :code
23
23
 
24
24
  # The redirect URL assigned in the [application dashboard](https://connect.squareup.com/apps).
25
25
  attr_accessor :redirect_uri
26
26
 
27
- # Specifies the method to request an OAuth access token. Valid values are: `authorization_code`, `refresh_token`, and `migration_token`
27
+ # Specifies the method to request an OAuth access token. Valid values are: `authorization_code`, `refresh_token`, and `migration_token`
28
28
  attr_accessor :grant_type
29
29
 
30
- # A valid refresh token for generating a new OAuth access token. A valid refresh token is required if `grant_type` is set to `refresh_token` , to indicate the application wants a replacement for an expired OAuth access token.
30
+ # A valid refresh token for generating a new OAuth access token. A valid refresh token is required if `grant_type` is set to `refresh_token` , to indicate the application wants a replacement for an expired OAuth access token.
31
31
  attr_accessor :refresh_token
32
32
 
33
- # Legacy OAuth access token obtained using a Connect API version prior to 2019-03-13. This parameter is required if `grant_type` is set to `migration_token` to indicate that the application wants to get a replacement OAuth access token. The response also returns a refresh token. For more information, see [Migrate to Using Refresh Tokens](/authz/oauth/migration).
33
+ # Legacy OAuth access token obtained using a Connect API version prior to 2019-03-13. This parameter is required if `grant_type` is set to `migration_token` to indicate that the application wants to get a replacement OAuth access token. The response also returns a refresh token. For more information, see [Migrate to Using Refresh Tokens](/authz/oauth/migration).
34
34
  attr_accessor :migration_token
35
35
 
36
36
 
@@ -102,12 +102,27 @@ module SquareConnect
102
102
  # @return Array for valid properies with the reasons
103
103
  def list_invalid_properties
104
104
  invalid_properties = Array.new
105
+ if @client_id.nil?
106
+ invalid_properties.push("invalid value for 'client_id', client_id cannot be nil.")
107
+ end
108
+
109
+ if @client_secret.nil?
110
+ invalid_properties.push("invalid value for 'client_secret', client_secret cannot be nil.")
111
+ end
112
+
113
+ if @grant_type.nil?
114
+ invalid_properties.push("invalid value for 'grant_type', grant_type cannot be nil.")
115
+ end
116
+
105
117
  return invalid_properties
106
118
  end
107
119
 
108
120
  # Check to see if the all the properties in the model are valid
109
121
  # @return true if the model is valid
110
122
  def valid?
123
+ return false if @client_id.nil?
124
+ return false if @client_secret.nil?
125
+ return false if @grant_type.nil?
111
126
  return true
112
127
  end
113
128
 
@@ -24,7 +24,7 @@ module SquareConnect
24
24
  # The ID of the authorizing merchant's business.
25
25
  attr_accessor :merchant_id
26
26
 
27
- # __Legacy field__. The ID of a subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization.
27
+ # __Legacy field__. The ID of a subscription plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization.
28
28
  attr_accessor :subscription_id
29
29
 
30
30
  # The ID of the [subscription](https://docs.connect.squareup.com/api/connect/v1/#navsection-subscriptionmanagement) plan the merchant signed up for. Only present if the merchant signed up for a subscription during authorization.
@@ -33,7 +33,7 @@ module SquareConnect
33
33
  # Then OpenID token belonging to this this person. Only present if the OPENID scope is included in the authorize request.
34
34
  attr_accessor :id_token
35
35
 
36
- # A refresh token. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management).
36
+ # A refresh token. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management).
37
37
  attr_accessor :refresh_token
38
38
 
39
39
 
@@ -12,10 +12,10 @@ require 'date'
12
12
  module SquareConnect
13
13
  # Contains details on how to fulfill this order.
14
14
  class OrderFulfillment
15
- # The type of the fulfillment.
15
+ # The type of the fulfillment. See [OrderFulfillmentType](#type-orderfulfillmenttype) for possible values
16
16
  attr_accessor :type
17
17
 
18
- # The state of the fulfillment.
18
+ # The state of the fulfillment. See [OrderFulfillmentState](#type-orderfulfillmentstate) for possible values
19
19
  attr_accessor :state
20
20
 
21
21
  # Contains pickup-specific details. Required when fulfillment type is `PICKUP`.
@@ -21,7 +21,7 @@ module SquareConnect
21
21
  # The auto completion duration in RFC3339 duration format, e.g., \"P1W3D\". If set, an open and accepted pickup fulfillment will automatically move to the `COMPLETED` state after this period of time. If not set, this pickup fulfillment will remain accepted until it is canceled or completed.
22
22
  attr_accessor :auto_complete_duration
23
23
 
24
- # The schedule type of the pickup fulfillment. Defaults to `SCHEDULED`.
24
+ # The schedule type of the pickup fulfillment. Defaults to `SCHEDULED`. See [OrderFulfillmentPickupDetailsScheduleType](#type-orderfulfillmentpickupdetailsscheduletype) for possible values
25
25
  attr_accessor :schedule_type
26
26
 
27
27
  # The pickup [timestamp](#workingwithdates) in RFC3339 timestamp format, e.g., \"2016-09-04T23:59:33.123Z\". For fulfillments with the schedule type `ASAP`, this is automatically set to the current time plus the expected duration to prepare the fulfillment. This represents the start of the pickup window.
@@ -18,7 +18,7 @@ module SquareConnect
18
18
  # The discount's name.
19
19
  attr_accessor :name
20
20
 
21
- # The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values.
21
+ # The type of the discount. If it is created by API, it would be either `FIXED_PERCENTAGE` or `FIXED_AMOUNT`. VARIABLE_* is not supported in API because the order is created at the time of sale and either percentage or amount has to be specified. See [OrderLineItemDiscountType](#type-orderlineitemdiscounttype) for possible values
22
22
  attr_accessor :type
23
23
 
24
24
  # The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%. The percentage won't be set for an amount-based discount.
@@ -30,7 +30,7 @@ module SquareConnect
30
30
  # The amount of discount actually applied to this line item. Represents the amount of money applied to a line item as a discount When an amount-based discount is at order-level, this value is different from `amount_money` because the discount is distributed across the line items.
31
31
  attr_accessor :applied_money
32
32
 
33
- # Indicates the level at which the discount applies. This field is set by the server. If set in a CreateOrder request, it will be ignored on write. See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values.
33
+ # Indicates the level at which the discount applies. This field is set by the server. If set in a CreateOrder request, it will be ignored on write. See [OrderLineItemDiscountScope](#type-orderlineitemdiscountscope) for possible values
34
34
  attr_accessor :scope
35
35
 
36
36
  class EnumAttributeValidator
@@ -18,7 +18,7 @@ module SquareConnect
18
18
  # The tax's name.
19
19
  attr_accessor :name
20
20
 
21
- # Indicates the calculation method used to apply the tax. See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values.
21
+ # Indicates the calculation method used to apply the tax. See [OrderLineItemTaxType](#type-orderlineitemtaxtype) for possible values
22
22
  attr_accessor :type
23
23
 
24
24
  # The percentage of the tax, as a string representation of a decimal number. A value of `7.25` corresponds to a percentage of 7.25%.
@@ -27,7 +27,7 @@ module SquareConnect
27
27
  # The amount of the money applied by the tax in an order.
28
28
  attr_accessor :applied_money
29
29
 
30
- # Indicates the level at which the tax applies. This field is set by the server. If set in a CreateOrder request, it will be ignored on write. See [OrderLineItemTaxScope](#type-orderlineitemtaxscope) for possible values.
30
+ # Indicates the level at which the tax applies. This field is set by the server. If set in a CreateOrder request, it will be ignored on write. See [OrderLineItemTaxScope](#type-orderlineitemtaxscope) for possible values
31
31
  attr_accessor :scope
32
32
 
33
33
  class EnumAttributeValidator
@@ -33,7 +33,7 @@ module SquareConnect
33
33
  # The amount of money refunded to the buyer.
34
34
  attr_accessor :amount_money
35
35
 
36
- # The current status of the refund (`PENDING`, `APPROVED`, `REJECTED`, or `FAILED`).
36
+ # The current status of the refund (`PENDING`, `APPROVED`, `REJECTED`, or `FAILED`). See [RefundStatus](#type-refundstatus) for possible values
37
37
  attr_accessor :status
38
38
 
39
39
  # The amount of Square processing fee money refunded to the *merchant*.
@@ -15,7 +15,7 @@ module SquareConnect
15
15
  # Any errors that occurred during the request.
16
16
  attr_accessor :errors
17
17
 
18
- # Status of the domain registration. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values.
18
+ # Status of the domain registration. See [RegisterDomainResponseStatus](#type-registerdomainresponsestatus) for possible values
19
19
  attr_accessor :status
20
20
 
21
21
  class EnumAttributeValidator
@@ -15,7 +15,7 @@ module SquareConnect
15
15
  # The pagination cursor returned in the previous response. Leave unset for an initial request. See [Pagination](/basics/api101/pagination) for more information.
16
16
  attr_accessor :cursor
17
17
 
18
- # The desired set of object types to appear in the search results. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`.
18
+ # The desired set of object types to appear in the search results. The legal values are taken from the [CatalogObjectType](#type-catalogobjecttype) enumeration, namely `\"ITEM\"`, `\"ITEM_VARIATION\"`, `\"CATEGORY\"`, `\"DISCOUNT\"`, `\"TAX\"`, `\"MODIFIER\"`, or `\"MODIFIER_LIST\"`. See [CatalogObjectType](#type-catalogobjecttype) for possible values
19
19
  attr_accessor :object_types
20
20
 
21
21
  # If `true`, deleted objects will be included in the results. Deleted objects will have their `is_deleted` field set to `true`.
@@ -36,7 +36,7 @@ module SquareConnect
36
36
  # A list of any paid or unpaid breaks that were taken during this shift.
37
37
  attr_accessor :breaks
38
38
 
39
- # Describes working state of the current `Shift`.
39
+ # Describes working state of the current `Shift`. See [ShiftStatus](#type-shiftstatus) for possible values
40
40
  attr_accessor :status
41
41
 
42
42
  # Used for resolving concurrency issues; request will fail if version provided does not match server version at time of request. If not provided, Square executes a blind write; potentially overwriting data from another write.