FM / Api

/home/desid573/public_html/gcdriver/square/docs/Api/

/home/desid573/public_html/gcdriver/square/docs/Api

Name	Size	Mode	Actions
ApplePayApi.md	2338	0644	edit dl rm
CatalogApi.md	25498	0644	edit dl rm
CheckoutApi.md	2313	0644	edit dl rm
CustomersApi.md	16093	0644	edit dl rm
EmployeesApi.md	3823	0644	edit dl rm
InventoryApi.md	16122	0644	edit dl rm
LaborApi.md	25643	0644	edit dl rm
LocationsApi.md	1608	0644	edit dl rm
MobileAuthorizationApi.md	2632	0644	edit dl rm
OAuthApi.md	7820	0644	edit dl rm
OrdersApi.md	12538	0644	edit dl rm
PaymentsApi.md	13570	0644	edit dl rm
RefundsApi.md	7701	0644	edit dl rm
ReportingApi.md	8109	0644	edit dl rm
TransactionsApi.md	18657	0644	edit dl rm
V1EmployeesApi.md	36727	0644	edit dl rm
V1ItemsApi.md	76351	0644	edit dl rm
V1LocationsApi.md	2583	0644	edit dl rm
V1TransactionsApi.md	29937	0644	edit dl rm

Edit: /home/desid573/public_html/gcdriver/square/docs/Api/OAuthApi.md (7820B)

# SquareConnect\OAuthApi

All URIs are relative to *https://connect.squareup.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**obtainToken**](OAuthApi.md#obtainToken) | **POST** /oauth2/token | ObtainToken
[**renewToken**](OAuthApi.md#renewToken) | **POST** /oauth2/clients/{client_id}/access-token/renew | RenewToken
[**revokeToken**](OAuthApi.md#revokeToken) | **POST** /oauth2/revoke | RevokeToken

# **obtainToken**
> \SquareConnect\Model\ObtainTokenResponse obtainToken($body)

ObtainToken

Returns an OAuth access token.   The endpoint supports distinct methods of obtaining OAuth access tokens.  Applications specify a method by adding the `grant_type` parameter  in the request and also provide relevant information.  For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management).   __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and  a refresh token in the response.   __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__.

### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new SquareConnect\Api\OAuthApi();
$body = new \SquareConnect\Model\ObtainTokenRequest(); // \SquareConnect\Model\ObtainTokenRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

try {
    $result = $apiInstance->obtainToken($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OAuthApi->obtainToken: ', $e->getMessage(), PHP_EOL;
}
?>
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**\SquareConnect\Model\ObtainTokenRequest**](../Model/ObtainTokenRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. |

### Return type

[**\SquareConnect\Model\ObtainTokenResponse**](../Model/ObtainTokenResponse.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)

# **renewToken**
**Note: This endpoint is deprecated.**
> \SquareConnect\Model\RenewTokenResponse renewToken($client_id, $body)

RenewToken

`RenewToken` is deprecated. For information about refreshing OAuth access tokens, see  [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens).   Renews an OAuth access token before it expires.  OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning.  __Important:__ The `Authorization` header for this endpoint must have the following format:  ``` Authorization: Client APPLICATION_SECRET ```  Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps).

### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: oauth2ClientSecret
$config = SquareConnect\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SquareConnect\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new SquareConnect\Api\OAuthApi();
$client_id = "client_id_example"; // string | Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps).
$body = new \SquareConnect\Model\RenewTokenRequest(); // \SquareConnect\Model\RenewTokenRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

try {
    $result = $apiInstance->renewToken($client_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OAuthApi->renewToken: ', $e->getMessage(), PHP_EOL;
}
?>
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **client_id** | **string**| Your application&#39;s ID, available from the [application dashboard](https://connect.squareup.com/apps). |
 **body** | [**\SquareConnect\Model\RenewTokenRequest**](../Model/RenewTokenRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. |

### Return type

[**\SquareConnect\Model\RenewTokenResponse**](../Model/RenewTokenResponse.md)

### Authorization

[oauth2ClientSecret](../../README.md#oauth2ClientSecret)

### HTTP request headers

- **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)

# **revokeToken**
> \SquareConnect\Model\RevokeTokenResponse revokeToken($body)

RevokeToken

Revokes an access token generated with the OAuth flow.  If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately.  __Important:__ The `Authorization` header for this endpoint must have the following format:  ``` Authorization: Client APPLICATION_SECRET ```  Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps).

### Example
```php
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new SquareConnect\Api\OAuthApi();
$body = new \SquareConnect\Model\RevokeTokenRequest(); // \SquareConnect\Model\RevokeTokenRequest | An object containing the fields to POST for the request.  See the corresponding object definition for field details.

try {
    $result = $apiInstance->revokeToken($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OAuthApi->revokeToken: ', $e->getMessage(), PHP_EOL;
}
?>
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**\SquareConnect\Model\RevokeTokenRequest**](../Model/RevokeTokenRequest.md)| An object containing the fields to POST for the request.  See the corresponding object definition for field details. |

### Return type

[**\SquareConnect\Model\RevokeTokenResponse**](../Model/RevokeTokenResponse.md)

### Authorization

[oauth2ClientSecret](../../README.md#oauth2ClientSecret)

### HTTP request headers

- **Content-Type**: application/json
 - **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)

# SquareConnect\OAuthApi All URIs are relative to *https://connect.squareup.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**obtainToken**](OAuthApi.md#obtainToken) | **POST** /oauth2/token | ObtainToken [**renewToken**](OAuthApi.md#renewToken) | **POST** /oauth2/clients/{client_id}/access-token/renew | RenewToken [**revokeToken**](OAuthApi.md#revokeToken) | **POST** /oauth2/revoke | RevokeToken # **obtainToken** > \SquareConnect\Model\ObtainTokenResponse obtainToken($body) ObtainToken Returns an OAuth access token. The endpoint supports distinct methods of obtaining OAuth access tokens. Applications specify a method by adding the `grant_type` parameter in the request and also provide relevant information. For more information, see [OAuth access token management](/authz/oauth/how-it-works#oauth-access-token-management). __Note:__ Regardless of the method application specified, the endpoint always returns two items; an OAuth access token and a refresh token in the response. __OAuth tokens should only live on secure servers. Application clients should never interact directly with OAuth tokens__. ### Example ```php obtainToken($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling OAuthApi->obtainToken: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**\SquareConnect\Model\ObtainTokenRequest**](../Model/ObtainTokenRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | ### Return type [**\SquareConnect\Model\ObtainTokenResponse**](../Model/ObtainTokenResponse.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) # **renewToken** **Note: This endpoint is deprecated.** > \SquareConnect\Model\RenewTokenResponse renewToken($client_id, $body) RenewToken `RenewToken` is deprecated. For information about refreshing OAuth access tokens, see [Renew OAuth Token](https://developer.squareup.com/docs/oauth-api/cookbook/renew-oauth-tokens). Renews an OAuth access token before it expires. OAuth access tokens besides your application's personal access token expire after __30 days__. You can also renew expired tokens within __15 days__ of their expiration. You cannot renew an access token that has been expired for more than 15 days. Instead, the associated user must re-complete the OAuth flow from the beginning. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). ### Example ```php setApiKey('Authorization', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = SquareConnect\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); $apiInstance = new SquareConnect\Api\OAuthApi(); $client_id = "client_id_example"; // string | Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). $body = new \SquareConnect\Model\RenewTokenRequest(); // \SquareConnect\Model\RenewTokenRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. try { $result = $apiInstance->renewToken($client_id, $body); print_r($result); } catch (Exception $e) { echo 'Exception when calling OAuthApi->renewToken: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **client_id** | **string**| Your application's ID, available from the [application dashboard](https://connect.squareup.com/apps). | **body** | [**\SquareConnect\Model\RenewTokenRequest**](../Model/RenewTokenRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | ### Return type [**\SquareConnect\Model\RenewTokenResponse**](../Model/RenewTokenResponse.md) ### Authorization [oauth2ClientSecret](../../README.md#oauth2ClientSecret) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) # **revokeToken** > \SquareConnect\Model\RevokeTokenResponse revokeToken($body) RevokeToken Revokes an access token generated with the OAuth flow. If an account has more than one OAuth access token for your application, this endpoint revokes all of them, regardless of which token you specify. When an OAuth access token is revoked, all of the active subscriptions associated with that OAuth token are canceled immediately. __Important:__ The `Authorization` header for this endpoint must have the following format: ``` Authorization: Client APPLICATION_SECRET ``` Replace `APPLICATION_SECRET` with the application secret on the Credentials page in the [application dashboard](https://connect.squareup.com/apps). ### Example ```php setApiKey('Authorization', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = SquareConnect\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); $apiInstance = new SquareConnect\Api\OAuthApi(); $body = new \SquareConnect\Model\RevokeTokenRequest(); // \SquareConnect\Model\RevokeTokenRequest | An object containing the fields to POST for the request. See the corresponding object definition for field details. try { $result = $apiInstance->revokeToken($body); print_r($result); } catch (Exception $e) { echo 'Exception when calling OAuthApi->revokeToken: ', $e->getMessage(), PHP_EOL; } ?> ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**\SquareConnect\Model\RevokeTokenRequest**](../Model/RevokeTokenRequest.md)| An object containing the fields to POST for the request. See the corresponding object definition for field details. | ### Return type [**\SquareConnect\Model\RevokeTokenResponse**](../Model/RevokeTokenResponse.md) ### Authorization [oauth2ClientSecret](../../README.md#oauth2ClientSecret) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)