Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,8 @@ Class | Method | HTTP request | Description
- [ProductDetailsResponse](docs/Model/ProductDetailsResponse.md)
- [ProductListResponse](docs/Model/ProductListResponse.md)
- [ProductUpdateRequest](docs/Model/ProductUpdateRequest.md)
- [RedirectOptionsRequest](docs/Model/RedirectOptionsRequest.md)
- [RedirectOptionsResponse](docs/Model/RedirectOptionsResponse.md)
- [SetupFlowCancelRequest](docs/Model/SetupFlowCancelRequest.md)
- [SetupFlowCancellationReason](docs/Model/SetupFlowCancellationReason.md)
- [SetupFlowCreateRequest](docs/Model/SetupFlowCreateRequest.md)
Expand All @@ -266,6 +268,7 @@ Class | Method | HTTP request | Description
- [TaxRateDetailsResponse](docs/Model/TaxRateDetailsResponse.md)
- [TaxRateListResponse](docs/Model/TaxRateListResponse.md)
- [TaxRateUpdateRequest](docs/Model/TaxRateUpdateRequest.md)
- [TaxType](docs/Model/TaxType.md)
- [TermListResponse](docs/Model/TermListResponse.md)
- [TermResponse](docs/Model/TermResponse.md)
- [Usage](docs/Model/Usage.md)
Expand Down
1 change: 1 addition & 0 deletions docs/Model/CheckoutSessionCreateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
**metadata** | **array<string,mixed>** | キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。&lt;a href&#x3D;\&quot;https://docs.pay.jp/v2/guide/developers/metadata\&quot;&gt;詳細はメタデータのドキュメントを参照してください。&lt;/a&gt; | [optional]
**successUrl** | **string** | 支払いや設定が完了した際に、PAY.JP が顧客をリダイレクトする URL。成功した Checkout Session からの情報をページで使用したい場合は、成功ページのカスタマイズに関するガイドをお読みください。 | [optional]
**cancelUrl** | **string** | キャンセル時のリダイレクト URL | [optional]
**redirectOptions** | [**\PAYJPV2\Model\RedirectOptionsRequest**](RedirectOptionsRequest.md) | Checkout から success_url へリダイレクトする際のオプション。Checkout が作成する PaymentFlow / SetupFlow に引き継がれます。 | [optional]
**currency** | [**\PAYJPV2\Model\Currency**](Currency.md) | 価格の通貨。現在は &#x60;jpy&#x60; のみサポートしています。 | [optional]
**expiresAt** | **\DateTime** | Checkout Session の有効期限が失効する日時 | [optional]
**locale** | [**\PAYJPV2\Model\Locale**](Locale.md) | Checkout 画面の表示言語を指定します。 | 指定できる値 | |:---| | **ja**: 日本語で表示します。 | | [optional]
Expand Down
1 change: 1 addition & 0 deletions docs/Model/CheckoutSessionDetailsResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Name | Type | Description | Notes
**status** | [**\PAYJPV2\Model\CheckoutSessionStatus**](CheckoutSessionStatus.md) | チェックアウトセッションのステータス |
**successUrl** | **string** | |
**cancelUrl** | **string** | |
**redirectOptions** | [**\PAYJPV2\Model\RedirectOptionsResponse**](RedirectOptionsResponse.md) | success_url へリダイレクトする際のオプション |
**url** | **string** | URL |
**metadata** | **array<string,mixed>** | メタデータ |
**createdAt** | **\DateTime** | 作成日時 (UTC, ISO 8601 形式) |
Expand Down
1 change: 1 addition & 0 deletions docs/Model/PaymentFlowCreateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
**captureMethod** | [**\PAYJPV2\Model\CaptureMethod**](CaptureMethod.md) | 支払いの確定方法を指定します。 | 値 | |:---| | **automatic**: (デフォルト) 顧客が支払いを承認すると、自動的に確定させます。 | | **manual**: 顧客が支払いを承認すると一旦確定を保留し、後で Payment Flow の Capture API を使用して確定します。(すべての支払い方法がこれをサポートしているわけではありません)。 | | [optional]
**confirm** | **bool** | 「true」に設定すると、この PaymentFlow を直ちに確定しようと試みます。 | [optional] [default to false]
**returnUrl** | **string** | 顧客が支払いを完了後かキャンセルした後にリダイレクトされる URL。アプリにリダイレクトしたい場合は URI Scheme を指定できます。confirm&#x3D;true の場合のみ指定できます。 | [optional]
**redirectOptions** | [**\PAYJPV2\Model\RedirectOptionsRequest**](RedirectOptionsRequest.md) | return_url へリダイレクトする際のオプション | [optional]
**description** | **string** | オブジェクトにセットする任意の文字列。 | [optional]
**metadata** | **array<string,mixed>** | キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。&lt;a href&#x3D;\&quot;https://docs.pay.jp/v2/guide/developers/metadata\&quot;&gt;詳細はメタデータのドキュメントを参照してください。&lt;/a&gt; | [optional]

Expand Down
1 change: 1 addition & 0 deletions docs/Model/PaymentFlowResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ Name | Type | Description | Notes
**status** | [**\PAYJPV2\Model\PaymentFlowStatus**](PaymentFlowStatus.md) | この PaymentFlow のステータス。 | 値 | |:---| | **requires_payment_method**: 支払い方法が必要です。 | | **requires_confirmation**: 確認が必要です。 | | **requires_action**: 顧客のアクションが必要です。 | | **processing**: 処理中です。 | | **requires_capture**: 確定が必要です。 | | **canceled**: キャンセルされました。 | | **succeeded**: 成功しました。 | |
**nextAction** | **array<string,mixed>** | |
**returnUrl** | **string** | |
**redirectOptions** | [**\PAYJPV2\Model\RedirectOptionsResponse**](RedirectOptionsResponse.md) | return_url へリダイレクトする際のオプション |
**captureMethod** | [**\PAYJPV2\Model\CaptureMethod**](CaptureMethod.md) | 支払いの確定方法 | 値 | |:---| | **automatic**: (デフォルト) 顧客が支払いを承認すると、自動的に確定させます。 | | **manual**: 顧客が支払いを承認すると一旦確定を保留し、後で Capture API を使用して確定します。(すべての支払い方法がこれをサポートしているわけではありません)。 | |
**lastPaymentError** | **array<string,mixed>** | |
**cancellationReason** | [**\PAYJPV2\Model\PaymentFlowCancellationReason**](PaymentFlowCancellationReason.md) | |
Expand Down
1 change: 1 addition & 0 deletions docs/Model/PaymentFlowUpdateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Name | Type | Description | Notes
**paymentMethodOptions** | [**\PAYJPV2\Model\PaymentFlowPaymentMethodOptionsRequest**](PaymentFlowPaymentMethodOptionsRequest.md) | この PaymentFlow 固有の支払い方法の設定 | [optional]
**paymentMethodTypes** | [**\PAYJPV2\Model\PaymentMethodTypes[]**](PaymentMethodTypes.md) | この PaymentFlow で使用できる支払い方法の種類のリスト。指定しない場合は、PAY.JP は支払い方法の設定から利用可能な支払い方法を動的に表示します。 | [optional]
**returnUrl** | **string** | 顧客が支払いを完了後かキャンセルした後にリダイレクトされる URL。アプリにリダイレクトしたい場合は URI Scheme を指定できます。 | [optional]
**redirectOptions** | [**\PAYJPV2\Model\RedirectOptionsRequest**](RedirectOptionsRequest.md) | return_url へリダイレクトする際のオプション | [optional]
**description** | **string** | オブジェクトにセットする任意の文字列。 | [optional]
**metadata** | **array<string,mixed>** | キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。&lt;a href&#x3D;\&quot;https://docs.pay.jp/v2/guide/developers/metadata\&quot;&gt;詳細はメタデータのドキュメントを参照してください。&lt;/a&gt; | [optional]

Expand Down
9 changes: 9 additions & 0 deletions docs/Model/RedirectOptionsRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# # RedirectOptionsRequest

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**includeClientSecret** | **bool** | return_url へリダイレクトする際、クエリパラメーターに client_secret を付与するかどうか。デフォルトは &#x60;true&#x60; です。 | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
9 changes: 9 additions & 0 deletions docs/Model/RedirectOptionsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# # RedirectOptionsResponse

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**includeClientSecret** | **bool** | return_url へリダイレクトする際、クエリパラメーターに client_secret を付与するかどうか。デフォルトは &#x60;true&#x60; です。 | [optional] [default to true]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
1 change: 1 addition & 0 deletions docs/Model/SetupFlowCreateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
**paymentMethodOptions** | [**\PAYJPV2\Model\SetupFlowPaymentMethodOptionsRequest**](SetupFlowPaymentMethodOptionsRequest.md) | この SetupFlow 固有の支払い方法の設定 | [optional]
**paymentMethodTypes** | **string[]** | この SetupFlow で使用できる支払い方法の種類のリスト。 指定しない場合は、PAY.JP は支払い方法の設定から利用可能な支払い方法を動的に表示します。 | [optional]
**usage** | [**\PAYJPV2\Model\Usage**](Usage.md) | 支払い方法が今後どのように使用されるかを指定します。指定されていない場合、この値はデフォルトで &#x60;off_session&#x60; になります。 | 値 | |:---| | **off_session**: 定期課金など、顧客がカートなどの決済フローにいるかどうか不明な場合は &#x60;off_session&#x60; を使用してください。 | | **on_session**: 顧客がカートなどの決済フローにいる場合にのみ支払い方法を利用する場合は &#x60;on_session&#x60; を使用してください。 | | [optional]
**redirectOptions** | [**\PAYJPV2\Model\RedirectOptionsRequest**](RedirectOptionsRequest.md) | return_url へリダイレクトする際のオプション | [optional]
**description** | **string** | 説明。 | [optional]
**metadata** | **array<string,mixed>** | キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。&lt;a href&#x3D;\&quot;https://docs.pay.jp/v2/guide/developers/metadata\&quot;&gt;詳細はメタデータのドキュメントを参照してください。&lt;/a&gt; | [optional]

Expand Down
1 change: 1 addition & 0 deletions docs/Model/SetupFlowResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ Name | Type | Description | Notes
**status** | [**\PAYJPV2\Model\SetupFlowStatus**](SetupFlowStatus.md) | この SetupFlow のステータスです。&lt;a href&#x3D;\&quot;https://docs.pay.jp/v2/guide/payments/setupflow#setup-flow-%E3%81%AE%E3%82%B9%E3%83%86%E3%83%BC%E3%82%BF%E3%82%B9\&quot; target&#x3D;\&quot;_blank\&quot;&gt;ステータスの詳細についてはこちらをご覧ください。&lt;/a&gt; | 値 | |:---| | **requires_payment_method**: 支払い方法が必要です。 | | **requires_confirmation**: 確認が必要です。 | | **requires_action**: 顧客のアクションが必要です。 | | **processing**: 処理中です。 | | **succeeded**: 成功しました。 | | **canceled**: キャンセルされました。 | |
**nextAction** | **array<string,mixed>** | |
**returnUrl** | **string** | |
**redirectOptions** | [**\PAYJPV2\Model\RedirectOptionsResponse**](RedirectOptionsResponse.md) | return_url へリダイレクトする際のオプション |
**lastSetupError** | **array<string,mixed>** | |
**cancellationReason** | [**\PAYJPV2\Model\SetupFlowCancellationReason**](SetupFlowCancellationReason.md) | |
**createdAt** | **\DateTime** | 作成日時 (UTC, ISO 8601 形式) |
Expand Down
1 change: 1 addition & 0 deletions docs/Model/SetupFlowUpdateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Name | Type | Description | Notes
**customerId** | **string** | この SetupFlow に関連付ける顧客の ID。SetupFlow により作られた PaymentMethod はこの顧客に紐付きます。 | [optional]
**paymentMethodOptions** | [**\PAYJPV2\Model\SetupFlowPaymentMethodOptionsRequest**](SetupFlowPaymentMethodOptionsRequest.md) | この SetupFlow 固有の支払い方法の設定 | [optional]
**paymentMethodTypes** | **string[]** | この SetupFlow で使用できる支払い方法の種類のリスト。 指定しない場合は、PAY.JP は支払い方法の設定から利用可能な支払い方法を動的に表示します。 | [optional]
**redirectOptions** | [**\PAYJPV2\Model\RedirectOptionsRequest**](RedirectOptionsRequest.md) | return_url へリダイレクトする際のオプション | [optional]
**description** | **string** | 説明。 | [optional]
**metadata** | **array<string,mixed>** | キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。&lt;a href&#x3D;\&quot;https://docs.pay.jp/v2/guide/developers/metadata\&quot;&gt;詳細はメタデータのドキュメントを参照してください。&lt;/a&gt; | [optional]

Expand Down
1 change: 1 addition & 0 deletions docs/Model/TaxRateCreateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Name | Type | Description | Notes
**active** | **bool** | この税率が有効であるかどうか。無効にした場合でも、すでに設定されている定期課金などでは使用可能です。 | [optional] [default to true]
**country** | [**\PAYJPV2\Model\Country**](Country.md) | 有効な2文字の &lt;a href&#x3D;\&quot;https://ja.wikipedia.org/wiki/ISO_3166-1\&quot; target&#x3D;\&quot;_blank\&quot;&gt;ISO 国コード&lt;/a&gt; | [optional]
**description** | **string** | 説明。管理画面内のみで表示され、顧客には表示されません。 | [optional]
**taxType** | [**\PAYJPV2\Model\TaxType**](TaxType.md) | | [optional]
**metadata** | **array<string,mixed>** | キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。&lt;a href&#x3D;\&quot;https://docs.pay.jp/v2/guide/developers/metadata\&quot;&gt;詳細はメタデータのドキュメントを参照してください。&lt;/a&gt; | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
1 change: 1 addition & 0 deletions docs/Model/TaxRateDetailsResponse.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Name | Type | Description | Notes
**active** | **bool** | この税率が有効であるかどうか |
**country** | [**\PAYJPV2\Model\Country**](Country.md) | |
**description** | **string** | |
**taxType** | [**\PAYJPV2\Model\TaxType**](TaxType.md) | |
**createdAt** | **\DateTime** | 作成日時 (UTC, ISO 8601 形式) |
**updatedAt** | **\DateTime** | 更新日時 (UTC, ISO 8601 形式) |
**metadata** | **array<string,mixed>** | メタデータ |
Expand Down
1 change: 1 addition & 0 deletions docs/Model/TaxRateUpdateRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Name | Type | Description | Notes
**country** | [**\PAYJPV2\Model\Country**](Country.md) | 有効な2文字の &lt;a href&#x3D;\&quot;https://ja.wikipedia.org/wiki/ISO_3166-1\&quot; target&#x3D;\&quot;_blank\&quot;&gt;ISO 国コード&lt;/a&gt; | [optional]
**description** | **string** | 説明。管理画面内のみで表示され、顧客には表示されません。 | [optional]
**displayName** | **string** | 表示名。顧客に表示されます。 | [optional]
**taxType** | [**\PAYJPV2\Model\TaxType**](TaxType.md) | | [optional]
**metadata** | **array<string,mixed>** | キーバリューの任意のデータを格納できます。20件まで登録可能で、空文字列を指定するとそのキーを削除できます。&lt;a href&#x3D;\&quot;https://docs.pay.jp/v2/guide/developers/metadata\&quot;&gt;詳細はメタデータのドキュメントを参照してください。&lt;/a&gt; | [optional]

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
8 changes: 8 additions & 0 deletions docs/Model/TaxType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# # TaxType

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

[[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
34 changes: 34 additions & 0 deletions lib/Model/CheckoutSessionCreateRequest.php
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ class CheckoutSessionCreateRequest implements ModelInterface, ArrayAccess, \Json
'metadata' => 'array<string,mixed>',
'successUrl' => 'string',
'cancelUrl' => 'string',
'redirectOptions' => '\PAYJPV2\Model\RedirectOptionsRequest',
'currency' => '\PAYJPV2\Model\Currency',
'expiresAt' => '\DateTime',
'locale' => '\PAYJPV2\Model\Locale',
Expand Down Expand Up @@ -95,6 +96,7 @@ class CheckoutSessionCreateRequest implements ModelInterface, ArrayAccess, \Json
'metadata' => null,
'successUrl' => null,
'cancelUrl' => null,
'redirectOptions' => null,
'currency' => null,
'expiresAt' => 'date-time',
'locale' => null,
Expand All @@ -121,6 +123,7 @@ class CheckoutSessionCreateRequest implements ModelInterface, ArrayAccess, \Json
'metadata' => false,
'successUrl' => false,
'cancelUrl' => false,
'redirectOptions' => false,
'currency' => false,
'expiresAt' => false,
'locale' => false,
Expand Down Expand Up @@ -227,6 +230,7 @@ public function isNullableSetToNull(string $property): bool
'metadata' => 'metadata',
'successUrl' => 'success_url',
'cancelUrl' => 'cancel_url',
'redirectOptions' => 'redirect_options',
'currency' => 'currency',
'expiresAt' => 'expires_at',
'locale' => 'locale',
Expand All @@ -253,6 +257,7 @@ public function isNullableSetToNull(string $property): bool
'metadata' => 'setMetadata',
'successUrl' => 'setSuccessUrl',
'cancelUrl' => 'setCancelUrl',
'redirectOptions' => 'setRedirectOptions',
'currency' => 'setCurrency',
'expiresAt' => 'setExpiresAt',
'locale' => 'setLocale',
Expand All @@ -279,6 +284,7 @@ public function isNullableSetToNull(string $property): bool
'metadata' => 'getMetadata',
'successUrl' => 'getSuccessUrl',
'cancelUrl' => 'getCancelUrl',
'redirectOptions' => 'getRedirectOptions',
'currency' => 'getCurrency',
'expiresAt' => 'getExpiresAt',
'locale' => 'getLocale',
Expand Down Expand Up @@ -356,6 +362,7 @@ public function __construct(?array $data = null)
$this->setIfExists('metadata', $data ?? [], null);
$this->setIfExists('successUrl', $data ?? [], null);
$this->setIfExists('cancelUrl', $data ?? [], null);
$this->setIfExists('redirectOptions', $data ?? [], null);
$this->setIfExists('currency', $data ?? [], null);
$this->setIfExists('expiresAt', $data ?? [], null);
$this->setIfExists('locale', $data ?? [], null);
Expand Down Expand Up @@ -667,6 +674,33 @@ public function setCancelUrl(?string $cancelUrl): self
return $this;
}

/**
* Gets redirectOptions
*
* @return \PAYJPV2\Model\RedirectOptionsRequest|null
*/
public function getRedirectOptions(): ?\PAYJPV2\Model\RedirectOptionsRequest
{
return $this->container['redirectOptions'];
}

/**
* Sets redirectOptions
*
* @param \PAYJPV2\Model\RedirectOptionsRequest|null $redirectOptions Checkout から success_url へリダイレクトする際のオプション。Checkout が作成する PaymentFlow / SetupFlow に引き継がれます。
*
* @return self
*/
public function setRedirectOptions(?\PAYJPV2\Model\RedirectOptionsRequest $redirectOptions): self
{
if (is_null($redirectOptions)) {
throw new \InvalidArgumentException('non-nullable redirectOptions cannot be null');
}
$this->container['redirectOptions'] = $redirectOptions;

return $this;
}

/**
* Gets currency
*
Expand Down
Loading
Loading