Merge pull request #29 from square/release/2.5.1

Release 2.5.1

CHANGES.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## Version 2.5.1 (2017-11-10)
+
+* `ordinal` is added to `CatalogItemVariation`
+* `website_url` is added to `Location`
+* `tip_money` is added to `Tender`
+* Changed `object_type` and `placeholder_type` from lists to single values in `V1PageCell` to mirror data model
+
 ## Version 2.5 (2017-11-02)
 
 ### New features: Transaction API and Reporting API

README.md

@@ -18,7 +18,7 @@ Add this dependency to your project's POM:
 <dependency>
     <groupId>com.squareup</groupId>
     <artifactId>connect</artifactId>
-    <version>2.5.0</version>
+    <version>2.5.1</version>
     <scope>compile</scope>
 </dependency>
 ```
@@ -28,7 +28,7 @@ Add this dependency to your project's POM:
 Add this dependency to your project's build file:
 
 ```groovy
-compile "com.squareup:connect:2.5.0"
+compile "com.squareup:connect:2.5.1"
 ```
 
 ### Build and Install locally
@@ -47,7 +47,7 @@ At first generate the JAR by executing:
 
 Then manually install the following JARs:
 
-* target/connect-2.5.0.jar
+* target/connect-2.5.1.jar
 * target/lib/*.jar
 
 ## Getting Started
@@ -406,6 +406,13 @@ Authentication schemes defined for the API:
   - EMPLOYEES_WRITE: POST, PUT, and DELETE endpoints related to employee management
   - TIMECARDS_READ: GET endpoints related to employee timecards
   - TIMECARDS_WRITE: POST, PUT, and DELETE endpoints related to employee timecards
+  - PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS: Allow third party applications to deduct a portion of each transaction amount.
+
+### oauth2ClientSecret
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
 
 
 ## Pagination of V1 Endpoints

build.gradle

@@ -2,7 +2,7 @@ apply plugin: 'idea'
 apply plugin: 'eclipse'
 
 group = 'com.squareup'
-version = '2.5.0'
+version = '2.5.1'
 
 buildscript {
     repositories {

docs/AdditionalRecipient.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **locationId** | **String** | The location ID for a recipient (other than the merchant) receiving a portion of this tender. | 
 **description** | **String** | The description of the additional recipient. | 
 **amountMoney** | [**Money**](Money.md) | The amount of money distributed to the recipient. | 
-**receivableId** | **String** | The unique ID for this [AdditionalRecipientReceivable](#type-additionalrecipientreceivable), assigned by the server. TODO(botros): add required annotations on this, SETL-7263 |  [optional]
+**receivableId** | **String** | The unique ID for this [AdditionalRecipientReceivable](#type-additionalrecipientreceivable), assigned by the server. |  [optional]
 
 
 

docs/CatalogItemVariation.md

@@ -8,6 +8,7 @@ Name | Type | Description | Notes
 **name** | **String** | The item variation's name. Searchable. |  [optional]
 **sku** | **String** | The item variation's SKU, if any. Searchable. |  [optional]
 **upc** | **String** | The item variation's UPC, if any. Searchable. |  [optional]
+**ordinal** | **Integer** | The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal for each item variation within a parent [CatalogItem](#type-catalogitem) is set according to the item variations's position. On reads, the value is not guaranteed to be sequential or unique. |  [optional]
 **pricingType** | [**PricingTypeEnum**](#PricingTypeEnum) | Indicates whether the item variation's price is fixed or determined at the time of sale. See [CatalogPricingType](#type-catalogpricingtype) for all possible values. |  [optional]
 **priceMoney** | [**Money**](Money.md) | The item variation's price, if fixed pricing is used. |  [optional]
 **locationOverrides** | [**List<ItemVariationLocationOverrides>**](ItemVariationLocationOverrides.md) | Per-[location](#type-location) price and inventory overrides. |  [optional]

docs/ChargeRequest.md

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **shippingAddress** | [**Address**](Address.md) | The buyer's shipping address, if available. This value is optional, but this transaction is ineligible for chargeback protection if neither this parameter nor `billing_address` is provided. |  [optional]
 **buyerEmailAddress** | **String** | The buyer's email address, if available. This value is optional, but this transaction is ineligible for chargeback protection if it is not provided. |  [optional]
 **orderId** | **String** | The ID of the order to associate with this transaction.  If you provide this value, the `amount_money` value of your request must __exactly match__ the `total_money` value of the order's `order_amounts` field. |  [optional]
-**additionalRecipients** | [**List<AdditionalRecipient>**](AdditionalRecipient.md) | The basic primitive of multi party settlement. The value is optional. The transation facilitated by you can be splited from here.  If you provide this value, the `amount_money` value in your additional_recipients must not be more than 90% of the `amount_money` value in you charge's request. The `location_id` must be the valid location of the app owner merchant.  This field is currently not supported in sandbox. |  [optional]
+**additionalRecipients** | [**List<AdditionalRecipient>**](AdditionalRecipient.md) | The basic primitive of multi-party transaction. The value is optional. The transaction facilitated by you can be split from here.  If you provide this value, the `amount_money` value in your additional_recipients must not be more than 90% of the `amount_money` value in you charge's request. The `location_id` must be the valid location of the app owner merchant.  This field requires `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission.  This field is currently not supported in sandbox. |  [optional]
 
 
 

docs/CreateCheckoutRequest.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **prePopulateBuyerEmail** | **String** | If provided, the buyer's email is pre-populated on the checkout page as an editable text field.  Default: none; only exists if explicitly set. |  [optional]
 **prePopulateShippingAddress** | [**Address**](Address.md) | If provided, the buyer's shipping info is pre-populated on the checkout page as editable text fields.  Default: none; only exists if explicitly set. |  [optional]
 **redirectUrl** | **String** | The URL to redirect to after checkout is completed with `checkoutId`, Square's `orderId`, `transactionId`, and `referenceId` appended as URL parameters. For example, if the provided redirect_url is `http://www.example.com/order-complete`, a successful transaction redirects the customer to:  `http://www.example.com/order-complete?checkoutId=xxxxxx&orderId=xxxxxx&referenceId=xxxxxx&transactionId=xxxxxx`  If you do not provide a redirect URL, Square Checkout will display an order confirmation page on your behalf; however Square strongly recommends that you provide a redirect URL so you can verify the transaction results and finalize the order through your existing/normal confirmation workflow.  Default: none; only exists if explicitly set. |  [optional]
-**additionalRecipients** | [**List<ChargeRequestAdditionalRecipient>**](ChargeRequestAdditionalRecipient.md) | The basic primitive of multi party settlement. The value is optional. The transation facilitated by you can be splited from here.  If you provide this value, the `amount_money` value in your additional_recipients must not be more than 90% of the `total_money` calcualted by Square for your order. The `location_id` must be the valid location of the app owner merchant.  This field is currently not supported in sandbox. |  [optional]
+**additionalRecipients** | [**List<ChargeRequestAdditionalRecipient>**](ChargeRequestAdditionalRecipient.md) | The basic primitive of multi-party transaction. The value is optional. The transaction facilitated by you can be split from here.  If you provide this value, the `amount_money` value in your additional_recipients must not be more than 90% of the `total_money` calculated by Square for your order. The `location_id` must be the valid location of the app owner merchant.  This field requires `PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS` OAuth permission.  This field is currently not supported in sandbox. |  [optional]
 
 
 

docs/Location.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **phoneNumber** | **String** | The location's phone_number. |  [optional]
 **businessName** | **String** | The location's business_name which is shown to its customers. For example, this is the name printed on its customer's receipts. |  [optional]
 **type** | [**TypeEnum**](#TypeEnum) | 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. |  [optional]
+**websiteUrl** | **String** | The location's website, as set by the account owner in the Square dashboard.  Default: none; only exists if explicitly set. |  [optional]
 
 
 <a name="List<CapabilitiesEnum>"></a>

docs/ReportingApi.md

@@ -14,7 +14,7 @@ Method | HTTP request | Description
 
 ListAdditionalRecipientReceivableRefunds
 
-Lists Additional Recipient Receivable Refunds for a particular location.  Max results per [page](#paginatingresults): 50
+Returns a list of refunded transactions (across all possible originating locations) relating to monies credited to the provided location ID by another Square account using the `additional_recipients` field in a transaction.  Max results per [page](#paginatingresults): 50
 
 ### Example
 ```java
@@ -75,7 +75,7 @@ Name | Type | Description  | Notes
 
 ListAdditionalRecipientReceivables
 
-Lists Additional Recipient Receivables for a particular location.  Max results per [page](#paginatingresults): 50
+Returns a list of receivables (across all possible sending locations) representing monies credited to the provided location ID by another Square account using the `additional_recipients` field in a transaction.  Max results per [page](#paginatingresults): 50
 
 ### Example
 ```java

docs/Tender.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **createdAt** | **String** | The time when the tender was created, in RFC 3339 format. |  [optional]
 **note** | **String** | An optional note associated with the tender at the time of payment. |  [optional]
 **amountMoney** | [**Money**](Money.md) | The amount of the tender. |  [optional]
+**tipMoney** | [**Money**](Money.md) | The tip's amount of the tender. |  [optional]
 **processingFeeMoney** | [**Money**](Money.md) | The amount of any Square processing fees applied to the tender.  This field is not immediately populated when a new transaction is created. It is usually available after about ten seconds. |  [optional]
 **customerId** | **String** | If the tender is associated with a customer or represents a customer's card on file, this is the ID of the associated customer. |  [optional]
 **type** | [**TypeEnum**](#TypeEnum) | The type of tender, such as `CARD` or `CASH`. | 

docs/V1PageCell.md

@@ -7,13 +7,13 @@ Name | Type | Description | Notes
 **pageId** | **String** | The unique identifier of the page the cell is included on. |  [optional]
 **row** | **Integer** | The row of the cell. Always an integer between 0 and 4, inclusive. |  [optional]
 **column** | **Integer** | The column of the cell. Always an integer between 0 and 4, inclusive. |  [optional]
-**objectType** | [**List<ObjectTypeEnum>**](#List<ObjectTypeEnum>) | The type of entity represented in the cell (ITEM, DISCOUNT, CATEGORY, or PLACEHOLDER). |  [optional]
+**objectType** | [**ObjectTypeEnum**](#ObjectTypeEnum) | The type of entity represented in the cell (ITEM, DISCOUNT, CATEGORY, or PLACEHOLDER). |  [optional]
 **objectId** | **String** | The unique identifier of the entity represented in the cell. Not present for cells with an object_type of PLACEHOLDER. |  [optional]
-**placeholderType** | [**List<PlaceholderTypeEnum>**](#List<PlaceholderTypeEnum>) | For a cell with an object_type of PLACEHOLDER, this value indicates the cell's special behavior. |  [optional]
+**placeholderType** | [**PlaceholderTypeEnum**](#PlaceholderTypeEnum) | For a cell with an object_type of PLACEHOLDER, this value indicates the cell's special behavior. |  [optional]
 
 
-<a name="List<ObjectTypeEnum>"></a>
-## Enum: List&lt;ObjectTypeEnum&gt;
+<a name="ObjectTypeEnum"></a>
+## Enum: ObjectTypeEnum
 Name | Value
 ---- | -----
 ITEM | &quot;ITEM&quot;
@@ -22,8 +22,8 @@ CATEGORY | &quot;CATEGORY&quot;
 PLACEHOLDER | &quot;PLACEHOLDER&quot;
 
 
-<a name="List<PlaceholderTypeEnum>"></a>
-## Enum: List&lt;PlaceholderTypeEnum&gt;
+<a name="PlaceholderTypeEnum"></a>
+## Enum: PlaceholderTypeEnum
 Name | Value
 ---- | -----
 ALL_ITEMS | &quot;ALL_ITEMS&quot;

pom.xml

@@ -5,7 +5,7 @@
   <artifactId>connect</artifactId>
   <packaging>jar</packaging>
   <name>connect</name>
-  <version>2.5.0</version>
+  <version>2.5.1</version>
   <url>https://github.com/square/connect-java-sdk/</url>
   <description>Java client library for the Square Connect API</description>
   <scm>

src/main/java/com/squareup/connect/ApiClient.java

@@ -73,11 +73,12 @@ public ApiClient() {
     this.dateFormat = new RFC3339DateFormat();
 
     // Set default User-Agent.
-    setUserAgent("Square-Connect-Java/2.5.0");
+    setUserAgent("Square-Connect-Java/2.5.1");
 
     // Setup authentications (key: authentication name, value: authentication).
     authentications = new HashMap<String, Authentication>();
     authentications.put("oauth2", new OAuth());
+    authentications.put("oauth2ClientSecret", new ApiKeyAuth("header", "Authorization"));
     // Prevent the authentications from being modified.
     authentications = Collections.unmodifiableMap(authentications);
   }

src/main/java/com/squareup/connect/api/ReportingApi.java

@@ -38,7 +38,7 @@ public void setApiClient(ApiClient apiClient) {
 
   /**
    * ListAdditionalRecipientReceivableRefunds
-   * Lists Additional Recipient Receivable Refunds for a particular location.  Max results per [page](#paginatingresults): 50
+   * Returns a list of refunded transactions (across all possible originating locations) relating to monies credited to the provided location ID by another Square account using the `additional_recipients` field in a transaction.  Max results per [page](#paginatingresults): 50
    * @param locationId The ID of the location to list AdditionalRecipientReceivableRefunds for. (required)
    * @param beginTime The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year. (optional)
    * @param endTime 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. (optional)
@@ -90,7 +90,7 @@ public ListAdditionalRecipientReceivableRefundsResponse listAdditionalRecipientR
 
   /**
    * ListAdditionalRecipientReceivableRefunds
-   * Lists Additional Recipient Receivable Refunds for a particular location.  Max results per [page](#paginatingresults): 50
+   * Returns a list of refunded transactions (across all possible originating locations) relating to monies credited to the provided location ID by another Square account using the `additional_recipients` field in a transaction.  Max results per [page](#paginatingresults): 50
    * @param locationId The ID of the location to list AdditionalRecipientReceivableRefunds for. (required)
    * @param beginTime The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year. (optional)
    * @param endTime 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. (optional)
@@ -140,7 +140,7 @@ public ListAdditionalRecipientReceivableRefundsResponse listAdditionalRecipientR
   }
   /**
    * ListAdditionalRecipientReceivables
-   * Lists Additional Recipient Receivables for a particular location.  Max results per [page](#paginatingresults): 50
+   * Returns a list of receivables (across all possible sending locations) representing monies credited to the provided location ID by another Square account using the `additional_recipients` field in a transaction.  Max results per [page](#paginatingresults): 50
    * @param locationId The ID of the location to list AdditionalRecipientReceivables for. (required)
    * @param beginTime The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year. (optional)
    * @param endTime 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. (optional)
@@ -192,7 +192,7 @@ public ListAdditionalRecipientReceivablesResponse listAdditionalRecipientReceiva
 
   /**
    * ListAdditionalRecipientReceivables
-   * Lists Additional Recipient Receivables for a particular location.  Max results per [page](#paginatingresults): 50
+   * Returns a list of receivables (across all possible sending locations) representing monies credited to the provided location ID by another Square account using the `additional_recipients` field in a transaction.  Max results per [page](#paginatingresults): 50
    * @param locationId The ID of the location to list AdditionalRecipientReceivables for. (required)
    * @param beginTime The beginning of the requested reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for details on date inclusivity/exclusivity.  Default value: The current time minus one year. (optional)
    * @param endTime 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. (optional)

src/main/java/com/squareup/connect/models/AdditionalRecipient.java

@@ -99,10 +99,10 @@ public AdditionalRecipient receivableId(String receivableId) {
   }
 
    /**
-   * The unique ID for this [AdditionalRecipientReceivable](#type-additionalrecipientreceivable), assigned by the server. TODO(botros): add required annotations on this, SETL-7263
+   * The unique ID for this [AdditionalRecipientReceivable](#type-additionalrecipientreceivable), assigned by the server.
    * @return receivableId
   **/
-  @ApiModelProperty(value = "The unique ID for this [AdditionalRecipientReceivable](#type-additionalrecipientreceivable), assigned by the server. TODO(botros): add required annotations on this, SETL-7263")
+  @ApiModelProperty(value = "The unique ID for this [AdditionalRecipientReceivable](#type-additionalrecipientreceivable), assigned by the server.")
   public String getReceivableId() {
     return receivableId;
   }