Merge pull request #107 from square/release/4.20200812.2

Release 4.20200812.2

CHANGES.md

@@ -1,5 +1,27 @@
 # Change Log
 
+## Version 4.20200812.2 (2020-08-12T00:00)
+## API releases
+* Subscriptions API (beta):
+  * For an overview, see [Square Subscriptions.](https://developer.squareup.com/docs/subscriptions/overview)
+  * For technical reference, see [Subscriptions API.](https://developer.squareup.com/reference/square_2020-08-12/subscriptions-api)
+
+## Existing API updates
+* Catalog API
+	* [CatalogSubscriptionPlan](https://developer.squareup.com/reference/square_2020-08-12/objects/CatalogSubscriptionPlan) (beta). This catalog type is added in support of the Subscriptions API. Subscription plans are stored as catalog object of the `SUBSCRIPTION_PLAN` type. For more information, see [Set Up and Manage a Subscription Plan.](https://developer.squareup.com/docs/subscriptions-api/setup-plan)
+
+## SqPaymentForm SDK updates
+* [SqPaymentForm.masterpassImageURL.](https://developer.squareup.com/docs/api/paymentform#masterpassimageurl) This function is updated to return a Secure Remote Commerce background image URL.
+
+## Documentation updates
+* Locations API
+	* [About the main location.](https://developer.squareup.com/docs/locations-api#about-the-main-location) Added  clarifying information about the main location concept.
+* OAuth API
+	* [Migrate to the Square API OAuth Flow.](https://developer.squareup.com/docs/oauth-api/migrate-to-square-oauth-flow) Added a new topic to document migration from a v1 location-scoped OAuth access token to the Square seller-scoped OAuth access token.
+* Payment Form SDK
+  * Renamed the Add a Masterpass Button topic to [Add a Secure Remote Commerce Button.](https://developer.squareup.com/docs/payment-form/add-digital-wallets/masterpass) Updated the instructions to add a Secure Remote Commerce button to replace a legacy Masterpass button.
+  * [Payment form technical reference.](https://developer.squareup.com/docs/api/paymentform) Updated the reference to show code examples for adding a Secure Remote Commerce button.
+
 ## Version 4.20200722.1 (2020-07-22T00:00)
 ## API releases
 

README.md

@@ -195,6 +195,12 @@ Class | Method | HTTP request | Description
 *SquareConnect.RefundsApi* | [**refundPayment**](docs/RefundsApi.md#refundPayment) | **POST** /v2/refunds | RefundPayment
 *SquareConnect.ReportingApi* | [**listAdditionalRecipientReceivableRefunds**](docs/ReportingApi.md#listAdditionalRecipientReceivableRefunds) | **GET** /v2/locations/{location_id}/additional-recipient-receivable-refunds | ListAdditionalRecipientReceivableRefunds
 *SquareConnect.ReportingApi* | [**listAdditionalRecipientReceivables**](docs/ReportingApi.md#listAdditionalRecipientReceivables) | **GET** /v2/locations/{location_id}/additional-recipient-receivables | ListAdditionalRecipientReceivables
+*SquareConnect.SubscriptionsApi* | [**cancelSubscription**](docs/SubscriptionsApi.md#cancelSubscription) | **POST** /v2/subscriptions/{subscription_id}/cancel | CancelSubscription
+*SquareConnect.SubscriptionsApi* | [**createSubscription**](docs/SubscriptionsApi.md#createSubscription) | **POST** /v2/subscriptions | CreateSubscription
+*SquareConnect.SubscriptionsApi* | [**listSubscriptionEvents**](docs/SubscriptionsApi.md#listSubscriptionEvents) | **GET** /v2/subscriptions/{subscription_id}/events | ListSubscriptionEvents
+*SquareConnect.SubscriptionsApi* | [**retrieveSubscription**](docs/SubscriptionsApi.md#retrieveSubscription) | **GET** /v2/subscriptions/{subscription_id} | RetrieveSubscription
+*SquareConnect.SubscriptionsApi* | [**searchSubscriptions**](docs/SubscriptionsApi.md#searchSubscriptions) | **POST** /v2/subscriptions/search | SearchSubscriptions
+*SquareConnect.SubscriptionsApi* | [**updateSubscription**](docs/SubscriptionsApi.md#updateSubscription) | **PUT** /v2/subscriptions/{subscription_id} | UpdateSubscription
 *SquareConnect.TeamApi* | [**bulkCreateTeamMembers**](docs/TeamApi.md#bulkCreateTeamMembers) | **POST** /v2/team-members/bulk-create | BulkCreateTeamMembers
 *SquareConnect.TeamApi* | [**bulkUpdateTeamMembers**](docs/TeamApi.md#bulkUpdateTeamMembers) | **POST** /v2/team-members/bulk-update | BulkUpdateTeamMembers
 *SquareConnect.TeamApi* | [**createTeamMember**](docs/TeamApi.md#createTeamMember) | **POST** /v2/team-members | CreateTeamMember
@@ -335,6 +341,8 @@ Class | Method | HTTP request | Description
  - [SquareConnect.CancelPaymentByIdempotencyKeyResponse](docs/CancelPaymentByIdempotencyKeyResponse.md)
  - [SquareConnect.CancelPaymentRequest](docs/CancelPaymentRequest.md)
  - [SquareConnect.CancelPaymentResponse](docs/CancelPaymentResponse.md)
+ - [SquareConnect.CancelSubscriptionRequest](docs/CancelSubscriptionRequest.md)
+ - [SquareConnect.CancelSubscriptionResponse](docs/CancelSubscriptionResponse.md)
  - [SquareConnect.CancelTerminalCheckoutRequest](docs/CancelTerminalCheckoutRequest.md)
  - [SquareConnect.CancelTerminalCheckoutResponse](docs/CancelTerminalCheckoutResponse.md)
  - [SquareConnect.CaptureTransactionRequest](docs/CaptureTransactionRequest.md)
@@ -401,6 +409,7 @@ Class | Method | HTTP request | Description
  - [SquareConnect.CatalogQuickAmountType](docs/CatalogQuickAmountType.md)
  - [SquareConnect.CatalogQuickAmountsSettings](docs/CatalogQuickAmountsSettings.md)
  - [SquareConnect.CatalogQuickAmountsSettingsOption](docs/CatalogQuickAmountsSettingsOption.md)
+ - [SquareConnect.CatalogSubscriptionPlan](docs/CatalogSubscriptionPlan.md)
  - [SquareConnect.CatalogTax](docs/CatalogTax.md)
  - [SquareConnect.CatalogTimePeriod](docs/CatalogTimePeriod.md)
  - [SquareConnect.CatalogV1Id](docs/CatalogV1Id.md)
@@ -448,6 +457,8 @@ Class | Method | HTTP request | Description
  - [SquareConnect.CreateRefundResponse](docs/CreateRefundResponse.md)
  - [SquareConnect.CreateShiftRequest](docs/CreateShiftRequest.md)
  - [SquareConnect.CreateShiftResponse](docs/CreateShiftResponse.md)
+ - [SquareConnect.CreateSubscriptionRequest](docs/CreateSubscriptionRequest.md)
+ - [SquareConnect.CreateSubscriptionResponse](docs/CreateSubscriptionResponse.md)
  - [SquareConnect.CreateTeamMemberRequest](docs/CreateTeamMemberRequest.md)
  - [SquareConnect.CreateTeamMemberResponse](docs/CreateTeamMemberResponse.md)
  - [SquareConnect.CreateTerminalCheckoutRequest](docs/CreateTerminalCheckoutRequest.md)
@@ -593,6 +604,8 @@ Class | Method | HTTP request | Description
  - [SquareConnect.ListPaymentsResponse](docs/ListPaymentsResponse.md)
  - [SquareConnect.ListRefundsRequest](docs/ListRefundsRequest.md)
  - [SquareConnect.ListRefundsResponse](docs/ListRefundsResponse.md)
+ - [SquareConnect.ListSubscriptionEventsRequest](docs/ListSubscriptionEventsRequest.md)
+ - [SquareConnect.ListSubscriptionEventsResponse](docs/ListSubscriptionEventsResponse.md)
  - [SquareConnect.ListTransactionsRequest](docs/ListTransactionsRequest.md)
  - [SquareConnect.ListTransactionsResponse](docs/ListTransactionsResponse.md)
  - [SquareConnect.ListWorkweekConfigsRequest](docs/ListWorkweekConfigsRequest.md)
@@ -749,6 +762,8 @@ Class | Method | HTTP request | Description
  - [SquareConnect.RetrieveLoyaltyRewardResponse](docs/RetrieveLoyaltyRewardResponse.md)
  - [SquareConnect.RetrieveMerchantRequest](docs/RetrieveMerchantRequest.md)
  - [SquareConnect.RetrieveMerchantResponse](docs/RetrieveMerchantResponse.md)
+ - [SquareConnect.RetrieveSubscriptionRequest](docs/RetrieveSubscriptionRequest.md)
+ - [SquareConnect.RetrieveSubscriptionResponse](docs/RetrieveSubscriptionResponse.md)
  - [SquareConnect.RetrieveTeamMemberRequest](docs/RetrieveTeamMemberRequest.md)
  - [SquareConnect.RetrieveTeamMemberResponse](docs/RetrieveTeamMemberResponse.md)
  - [SquareConnect.RetrieveTransactionRequest](docs/RetrieveTransactionRequest.md)
@@ -787,6 +802,10 @@ Class | Method | HTTP request | Description
  - [SquareConnect.SearchOrdersStateFilter](docs/SearchOrdersStateFilter.md)
  - [SquareConnect.SearchShiftsRequest](docs/SearchShiftsRequest.md)
  - [SquareConnect.SearchShiftsResponse](docs/SearchShiftsResponse.md)
+ - [SquareConnect.SearchSubscriptionsFilter](docs/SearchSubscriptionsFilter.md)
+ - [SquareConnect.SearchSubscriptionsQuery](docs/SearchSubscriptionsQuery.md)
+ - [SquareConnect.SearchSubscriptionsRequest](docs/SearchSubscriptionsRequest.md)
+ - [SquareConnect.SearchSubscriptionsResponse](docs/SearchSubscriptionsResponse.md)
  - [SquareConnect.SearchTeamMembersFilter](docs/SearchTeamMembersFilter.md)
  - [SquareConnect.SearchTeamMembersQuery](docs/SearchTeamMembersQuery.md)
  - [SquareConnect.SearchTeamMembersRequest](docs/SearchTeamMembersRequest.md)
@@ -809,6 +828,12 @@ Class | Method | HTTP request | Description
  - [SquareConnect.StandardUnitDescriptionGroup](docs/StandardUnitDescriptionGroup.md)
  - [SquareConnect.SubmitEvidenceRequest](docs/SubmitEvidenceRequest.md)
  - [SquareConnect.SubmitEvidenceResponse](docs/SubmitEvidenceResponse.md)
+ - [SquareConnect.Subscription](docs/Subscription.md)
+ - [SquareConnect.SubscriptionCadence](docs/SubscriptionCadence.md)
+ - [SquareConnect.SubscriptionEvent](docs/SubscriptionEvent.md)
+ - [SquareConnect.SubscriptionEventSubscriptionEventType](docs/SubscriptionEventSubscriptionEventType.md)
+ - [SquareConnect.SubscriptionPhase](docs/SubscriptionPhase.md)
+ - [SquareConnect.SubscriptionStatus](docs/SubscriptionStatus.md)
  - [SquareConnect.TaxCalculationPhase](docs/TaxCalculationPhase.md)
  - [SquareConnect.TaxInclusionType](docs/TaxInclusionType.md)
  - [SquareConnect.TeamMember](docs/TeamMember.md)
@@ -848,6 +873,8 @@ Class | Method | HTTP request | Description
  - [SquareConnect.UpdateOrderResponse](docs/UpdateOrderResponse.md)
  - [SquareConnect.UpdateShiftRequest](docs/UpdateShiftRequest.md)
  - [SquareConnect.UpdateShiftResponse](docs/UpdateShiftResponse.md)
+ - [SquareConnect.UpdateSubscriptionRequest](docs/UpdateSubscriptionRequest.md)
+ - [SquareConnect.UpdateSubscriptionResponse](docs/UpdateSubscriptionResponse.md)
  - [SquareConnect.UpdateTeamMemberRequest](docs/UpdateTeamMemberRequest.md)
  - [SquareConnect.UpdateTeamMemberResponse](docs/UpdateTeamMemberResponse.md)
  - [SquareConnect.UpdateWageSettingRequest](docs/UpdateWageSettingRequest.md)

docs/CancelSubscriptionRequest.md

@@ -0,0 +1,12 @@
+# SquareConnect.CancelSubscriptionRequest
+
+### Description
+**Note: This model is in beta.**
+
+Defines parameters in a  [CancelSubscription](#endpoint-subscriptions-cancelsubscription) endpoint request.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

docs/CancelSubscriptionResponse.md

@@ -0,0 +1,14 @@
+# SquareConnect.CancelSubscriptionResponse
+
+### Description
+**Note: This model is in beta.**
+
+Defines fields that are included in a  [CancelSubscription](#endpoint-subscriptions-cancelsubscription) response.
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**[Error]**](Error.md) | Information about errors encountered during the request. | [optional] 
+**subscription** | [**Subscription**](Subscription.md) | The canceled subscription. | [optional] 
+
+

docs/CatalogObject.md

@@ -2,7 +2,7 @@
 
 ### Description
 
-The wrapper object for the Catalog entries of a given object type.   The type of a particular `CatalogObject` is determined by the value of the `type` attribute and only the corresponding data attribute can be set on the `CatalogObject` instance. For example, the following list shows some instances of `CatalogObject` of a given `type` and their corresponding data atrribute that can be set: - For a `CatalogObject` of the `ITEM` type, set the `item_data` attribute to yield the `CatalogItem` object.  - For a `CatalogObject` of the `ITEM_VARIATION` type, set the `item_variation_data` attribute to yield the `CatalogItemVariation` object. - For a `CatalogObject` of the `MODIFIER` type, set the `modifier_data` attribute to yield the `CatalogModifier` object. - For a `CatalogObject` of the `MODIFIER_LIST` type, set the `modifier_list_data` attribute to yield the `CatalogModifierList` object. - For a `CatalogObject` of the `CATEGORY` type, set the `category_data` attribute to yield the `CatalogCategory` object. - For a `CatalogObject` of the `DISCOUNT` type, set the `discount_data` attribute to yield the `CatalogDiscount` object. - For a `CatalogObject` of the `TAX` type, set the `tax_data` attribute to yield the `CatalogTax` object. - For a `CatalogObject` of the `IMAGE` type, set the `image_data` attribute to yield the `CatalogImageData`  object. - For a `CatalogObject` of the `QUICK_AMOUNTS_SETTINGS` type, set the `quick_amounts_settings_data` attribute to yield the `CatalogQuickAmountsSettings` object. - For a `CatalogObject` of the `PRICING_RULE` type, set the `pricing_rule_data` attribute to yield the `CatalogPricingRule` object. - For a `CatalogObject` of the `TIME_PERIOD` type, set the `time_period_data` attribute to yield the `CatalogTimePeriod` object. - For a `CatalogObject` of the `PRODUCT_SET` type, set the `product_set_data` attribute to yield the `CatalogProductSet`  object.  For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/catalog-api/design-a-catalog) guide.
+The wrapper object for the Catalog entries of a given object type.   The type of a particular `CatalogObject` is determined by the value of the `type` attribute and only the corresponding data attribute can be set on the `CatalogObject` instance. For example, the following list shows some instances of `CatalogObject` of a given `type` and their corresponding data atrribute that can be set: - For a `CatalogObject` of the `ITEM` type, set the `item_data` attribute to yield the `CatalogItem` object.  - For a `CatalogObject` of the `ITEM_VARIATION` type, set the `item_variation_data` attribute to yield the `CatalogItemVariation` object. - For a `CatalogObject` of the `MODIFIER` type, set the `modifier_data` attribute to yield the `CatalogModifier` object. - For a `CatalogObject` of the `MODIFIER_LIST` type, set the `modifier_list_data` attribute to yield the `CatalogModifierList` object. - For a `CatalogObject` of the `CATEGORY` type, set the `category_data` attribute to yield the `CatalogCategory` object. - For a `CatalogObject` of the `DISCOUNT` type, set the `discount_data` attribute to yield the `CatalogDiscount` object. - For a `CatalogObject` of the `TAX` type, set the `tax_data` attribute to yield the `CatalogTax` object. - For a `CatalogObject` of the `IMAGE` type, set the `image_data` attribute to yield the `CatalogImageData`  object. - For a `CatalogObject` of the `QUICK_AMOUNTS_SETTINGS` type, set the `quick_amounts_settings_data` attribute to yield the `CatalogQuickAmountsSettings` object. - For a `CatalogObject` of the `PRICING_RULE` type, set the `pricing_rule_data` attribute to yield the `CatalogPricingRule` object. - For a `CatalogObject` of the `TIME_PERIOD` type, set the `time_period_data` attribute to yield the `CatalogTimePeriod` object. - For a `CatalogObject` of the `PRODUCT_SET` type, set the `product_set_data` attribute to yield the `CatalogProductSet`  object. - For a `CatalogObject` of the `SUBSCRIPTION_PLAN` type, set the `subscription_plan_data` attribute to yield the `CatalogSubscriptionPlan` object.   For a more detailed discussion of the Catalog data model, please see the [Design a Catalog](/catalog-api/design-a-catalog) guide.
 
 ## Properties
 Name | Type | Description | Notes
@@ -30,6 +30,7 @@ Name | Type | Description | Notes
 **pricing_rule_data** | [**CatalogPricingRule**](CatalogPricingRule.md) | Structured data for a `CatalogPricingRule`, set for CatalogObjects of type `PRICING_RULE`. A `CatalogPricingRule` object often works with a `CatalogProductSet` object or a `CatalogTimePeriod` object. | [optional] 
 **image_data** | [**CatalogImage**](CatalogImage.md) | Structured data for a `CatalogImage`, set for CatalogObjects of type `IMAGE`. | [optional] 
 **measurement_unit_data** | [**CatalogMeasurementUnit**](CatalogMeasurementUnit.md) | Structured data for a `CatalogMeasurementUnit`, set for CatalogObjects of type `MEASUREMENT_UNIT`. | [optional] 
+**subscription_plan_data** | [**CatalogSubscriptionPlan**](CatalogSubscriptionPlan.md) | Structured data for a `CatalogSubscriptionPlan`, set for CatalogObjects of type `SUBSCRIPTION_PLAN`. | [optional] 
 **item_option_data** | [**CatalogItemOption**](CatalogItemOption.md) | Structured data for a `CatalogItemOption`, set for CatalogObjects of type `ITEM_OPTION`. | [optional] 
 **item_option_value_data** | [**CatalogItemOptionValue**](CatalogItemOptionValue.md) | Structured data for a `CatalogItemOptionValue`, set for CatalogObjects of type `ITEM_OPTION_VAL`. | [optional] 
 **custom_attribute_definition_data** | [**CatalogCustomAttributeDefinition**](CatalogCustomAttributeDefinition.md) | Structured data for a `CatalogCustomAttributeDefinition`, set for CatalogObjects of type `CUSTOM_ATTRIBUTE_DEFINITION`. | [optional] 

docs/CatalogObjectType.md

@@ -27,6 +27,8 @@
 
 * `MEASUREMENT_UNIT` (value: `"MEASUREMENT_UNIT"`)
 
+* `SUBSCRIPTION_PLAN` (value: `"SUBSCRIPTION_PLAN"`)
+
 * `ITEM_OPTION` (value: `"ITEM_OPTION"`)
 
 * `ITEM_OPTION_VAL` (value: `"ITEM_OPTION_VAL"`)

docs/CatalogSubscriptionPlan.md

@@ -0,0 +1,14 @@
+# SquareConnect.CatalogSubscriptionPlan
+
+### Description
+**Note: This model is in beta.**
+
+Describes a subscription plan. For more information, see [Set Up and Manage a Subscription Plan](/docs/subscriptions-api/setup-plan).
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | The name of the plan. | [optional] 
+**phases** | [**[SubscriptionPhase]**](SubscriptionPhase.md) | A list of SubscriptionPhase containing the `SubscriptionPhase` for this plan. | [optional] 
+
+