whoami7 - Manager
:
/
home
/
qbizpnmr
/
arif.umairtax.com
/
vendor
/
square
/
square
/
src
/
Models
/
Upload File:
files >> /home/qbizpnmr/arif.umairtax.com/vendor/square/square/src/Models/ObtainTokenRequest.php
<?php declare(strict_types=1); namespace Square\Models; use stdClass; class ObtainTokenRequest implements \JsonSerializable { /** * @var string */ private $clientId; /** * @var array */ private $clientSecret = []; /** * @var array */ private $code = []; /** * @var array */ private $redirectUri = []; /** * @var string */ private $grantType; /** * @var array */ private $refreshToken = []; /** * @var array */ private $migrationToken = []; /** * @var array */ private $scopes = []; /** * @var array */ private $shortLived = []; /** * @var array */ private $codeVerifier = []; /** * @param string $clientId * @param string $grantType */ public function __construct(string $clientId, string $grantType) { $this->clientId = $clientId; $this->grantType = $grantType; } /** * Returns Client Id. * The Square-issued ID of your application, which is available on the **OAuth** page in the * [Developer Dashboard](https://developer.squareup.com/apps). */ public function getClientId(): string { return $this->clientId; } /** * Sets Client Id. * The Square-issued ID of your application, which is available on the **OAuth** page in the * [Developer Dashboard](https://developer.squareup.com/apps). * * @required * @maps client_id */ public function setClientId(string $clientId): void { $this->clientId = $clientId; } /** * Returns Client Secret. * The Square-issued application secret for your application, which is available on the **OAuth** page * in the [Developer Dashboard](https://developer.squareup.com/apps). This parameter is only required * when * you're not using the [OAuth PKCE (Proof Key for Code Exchange) flow](https://developer.squareup. * com/docs/oauth-api/overview#pkce-flow). * The PKCE flow requires a `code_verifier` instead of a `client_secret` when `grant_type` is set to * `authorization_code`. * If `grant_type` is set to `refresh_token` and the `refresh_token` is obtained uaing PKCE, the PKCE * flow only requires `client_id`, * `grant_type`, and `refresh_token`. */ public function getClientSecret(): ?string { if (count($this->clientSecret) == 0) { return null; } return $this->clientSecret['value']; } /** * Sets Client Secret. * The Square-issued application secret for your application, which is available on the **OAuth** page * in the [Developer Dashboard](https://developer.squareup.com/apps). This parameter is only required * when * you're not using the [OAuth PKCE (Proof Key for Code Exchange) flow](https://developer.squareup. * com/docs/oauth-api/overview#pkce-flow). * The PKCE flow requires a `code_verifier` instead of a `client_secret` when `grant_type` is set to * `authorization_code`. * If `grant_type` is set to `refresh_token` and the `refresh_token` is obtained uaing PKCE, the PKCE * flow only requires `client_id`, * `grant_type`, and `refresh_token`. * * @maps client_secret */ public function setClientSecret(?string $clientSecret): void { $this->clientSecret['value'] = $clientSecret; } /** * Unsets Client Secret. * The Square-issued application secret for your application, which is available on the **OAuth** page * in the [Developer Dashboard](https://developer.squareup.com/apps). This parameter is only required * when * you're not using the [OAuth PKCE (Proof Key for Code Exchange) flow](https://developer.squareup. * com/docs/oauth-api/overview#pkce-flow). * The PKCE flow requires a `code_verifier` instead of a `client_secret` when `grant_type` is set to * `authorization_code`. * If `grant_type` is set to `refresh_token` and the `refresh_token` is obtained uaing PKCE, the PKCE * flow only requires `client_id`, * `grant_type`, and `refresh_token`. */ public function unsetClientSecret(): void { $this->clientSecret = []; } /** * Returns Code. * The authorization code to exchange. * This code 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. */ public function getCode(): ?string { if (count($this->code) == 0) { return null; } return $this->code['value']; } /** * Sets Code. * The authorization code to exchange. * This code 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. * * @maps code */ public function setCode(?string $code): void { $this->code['value'] = $code; } /** * Unsets Code. * The authorization code to exchange. * This code 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. */ public function unsetCode(): void { $this->code = []; } /** * Returns Redirect Uri. * The redirect URL assigned on the **OAuth** page for your application in the [Developer * Dashboard](https://developer.squareup.com/apps). */ public function getRedirectUri(): ?string { if (count($this->redirectUri) == 0) { return null; } return $this->redirectUri['value']; } /** * Sets Redirect Uri. * The redirect URL assigned on the **OAuth** page for your application in the [Developer * Dashboard](https://developer.squareup.com/apps). * * @maps redirect_uri */ public function setRedirectUri(?string $redirectUri): void { $this->redirectUri['value'] = $redirectUri; } /** * Unsets Redirect Uri. * The redirect URL assigned on the **OAuth** page for your application in the [Developer * Dashboard](https://developer.squareup.com/apps). */ public function unsetRedirectUri(): void { $this->redirectUri = []; } /** * Returns Grant Type. * Specifies the method to request an OAuth access token. * Valid values are `authorization_code`, `refresh_token`, and `migration_token`. */ public function getGrantType(): string { return $this->grantType; } /** * Sets Grant Type. * Specifies the method to request an OAuth access token. * Valid values are `authorization_code`, `refresh_token`, and `migration_token`. * * @required * @maps grant_type */ public function setGrantType(string $grantType): void { $this->grantType = $grantType; } /** * Returns Refresh Token. * 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 that the application wants a replacement for an expired OAuth access token. */ public function getRefreshToken(): ?string { if (count($this->refreshToken) == 0) { return null; } return $this->refreshToken['value']; } /** * Sets Refresh Token. * 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 that the application wants a replacement for an expired OAuth access token. * * @maps refresh_token */ public function setRefreshToken(?string $refreshToken): void { $this->refreshToken['value'] = $refreshToken; } /** * Unsets Refresh Token. * 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 that the application wants a replacement for an expired OAuth access token. */ public function unsetRefreshToken(): void { $this->refreshToken = []; } /** * Returns Migration Token. * A 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](https://developer.squareup. * com/docs/oauth-api/migrate-to-refresh-tokens). */ public function getMigrationToken(): ?string { if (count($this->migrationToken) == 0) { return null; } return $this->migrationToken['value']; } /** * Sets Migration Token. * A 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](https://developer.squareup. * com/docs/oauth-api/migrate-to-refresh-tokens). * * @maps migration_token */ public function setMigrationToken(?string $migrationToken): void { $this->migrationToken['value'] = $migrationToken; } /** * Unsets Migration Token. * A 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](https://developer.squareup. * com/docs/oauth-api/migrate-to-refresh-tokens). */ public function unsetMigrationToken(): void { $this->migrationToken = []; } /** * Returns Scopes. * A JSON list of strings representing the permissions that the application is requesting. * For example, "`["MERCHANT_PROFILE_READ","PAYMENTS_READ","BANK_ACCOUNTS_READ"]`". * * The access token returned in the response is granted the permissions * that comprise the intersection between the requested list of permissions and those * that belong to the provided refresh token. * * @return string[]|null */ public function getScopes(): ?array { if (count($this->scopes) == 0) { return null; } return $this->scopes['value']; } /** * Sets Scopes. * A JSON list of strings representing the permissions that the application is requesting. * For example, "`["MERCHANT_PROFILE_READ","PAYMENTS_READ","BANK_ACCOUNTS_READ"]`". * * The access token returned in the response is granted the permissions * that comprise the intersection between the requested list of permissions and those * that belong to the provided refresh token. * * @maps scopes * * @param string[]|null $scopes */ public function setScopes(?array $scopes): void { $this->scopes['value'] = $scopes; } /** * Unsets Scopes. * A JSON list of strings representing the permissions that the application is requesting. * For example, "`["MERCHANT_PROFILE_READ","PAYMENTS_READ","BANK_ACCOUNTS_READ"]`". * * The access token returned in the response is granted the permissions * that comprise the intersection between the requested list of permissions and those * that belong to the provided refresh token. */ public function unsetScopes(): void { $this->scopes = []; } /** * Returns Short Lived. * A Boolean indicating a request for a short-lived access token. * * The short-lived access token returned in the response expires in 24 hours. */ public function getShortLived(): ?bool { if (count($this->shortLived) == 0) { return null; } return $this->shortLived['value']; } /** * Sets Short Lived. * A Boolean indicating a request for a short-lived access token. * * The short-lived access token returned in the response expires in 24 hours. * * @maps short_lived */ public function setShortLived(?bool $shortLived): void { $this->shortLived['value'] = $shortLived; } /** * Unsets Short Lived. * A Boolean indicating a request for a short-lived access token. * * The short-lived access token returned in the response expires in 24 hours. */ public function unsetShortLived(): void { $this->shortLived = []; } /** * Returns Code Verifier. * Must be provided when using the PKCE OAuth flow if `grant_type` is set to `authorization_code`. The * `code_verifier` is used to verify against the * `code_challenge` associated with the `authorization_code`. */ public function getCodeVerifier(): ?string { if (count($this->codeVerifier) == 0) { return null; } return $this->codeVerifier['value']; } /** * Sets Code Verifier. * Must be provided when using the PKCE OAuth flow if `grant_type` is set to `authorization_code`. The * `code_verifier` is used to verify against the * `code_challenge` associated with the `authorization_code`. * * @maps code_verifier */ public function setCodeVerifier(?string $codeVerifier): void { $this->codeVerifier['value'] = $codeVerifier; } /** * Unsets Code Verifier. * Must be provided when using the PKCE OAuth flow if `grant_type` is set to `authorization_code`. The * `code_verifier` is used to verify against the * `code_challenge` associated with the `authorization_code`. */ public function unsetCodeVerifier(): void { $this->codeVerifier = []; } /** * Encode this object to JSON * * @param bool $asArrayWhenEmpty Whether to serialize this model as an array whenever no fields * are set. (default: false) * * @return array|stdClass */ #[\ReturnTypeWillChange] // @phan-suppress-current-line PhanUndeclaredClassAttribute for (php < 8.1) public function jsonSerialize(bool $asArrayWhenEmpty = false) { $json = []; $json['client_id'] = $this->clientId; if (!empty($this->clientSecret)) { $json['client_secret'] = $this->clientSecret['value']; } if (!empty($this->code)) { $json['code'] = $this->code['value']; } if (!empty($this->redirectUri)) { $json['redirect_uri'] = $this->redirectUri['value']; } $json['grant_type'] = $this->grantType; if (!empty($this->refreshToken)) { $json['refresh_token'] = $this->refreshToken['value']; } if (!empty($this->migrationToken)) { $json['migration_token'] = $this->migrationToken['value']; } if (!empty($this->scopes)) { $json['scopes'] = $this->scopes['value']; } if (!empty($this->shortLived)) { $json['short_lived'] = $this->shortLived['value']; } if (!empty($this->codeVerifier)) { $json['code_verifier'] = $this->codeVerifier['value']; } $json = array_filter($json, function ($val) { return $val !== null; }); return (!$asArrayWhenEmpty && empty($json)) ? new stdClass() : $json; } }
Copyright ©2021 || Defacer Indonesia