Merge pull request #6 from saasus-platform/feature/19

ドキュメント整備

.gitignore

@@ -1,3 +1,4 @@
 vendor/
 composer.phar
 .phpunit.result.cache
+.history

README.md

@@ -1,3 +1,58 @@
-# saasus-sdk-php
+# PHP SaaSus SDK
+
+---
+## SDK 利用の準備
+
+### セットアップ
+```
+composer config repositories.anti-pattern-inc/saasus-sdk-php vcs https://github.com/saasus-platform/saasus-sdk-php
+```
+### SDK追加
+```
+composer require Anti-Pattern-Inc/saasus-sdk-php
+```
+
+### 環境変数を定義
+```
+### for SaaSus Platform
+SAASUS_SAAS_ID="saasid_98tjo3wifaoua （画面のSaaS ID）"
+SAASUS_API_KEY="apikey_kjntowjfoasnkjntwonsflajsno4as （画面のAPI KEY）"
+SAASUS_SECRET_KEY="DuFMclufMf7OH2r4Ma3nB2TatvRufqja7V2yZrlz+xA （画面のクライアントシークレット）"
+SAASUS_LOGIN_URL="https://auth.sample.saasus.jp/　（ログイン画面のURL）"
+```
+SAASUS_SAAS_ID, SAASUS_API_KEY は先ほど画面で表示した SaaS ID と API Keyを、
+SAASUS_LOGIN_URL は、SaaSus コンソールで作成したログイン画面のURLを設定します。
+
+
+### 認証モジュールの組み込み
+
+api/routes/web.php
+
+```
+// SaaSus SDK標準のAuth Middlewareを利用する
+Route::middleware(\AntiPatternInc\Saasus\Laravel\Middleware\Auth::class)->group(function () {
+    // 固有のロジックを記載する
+
+    Route::redirect('/', '/xxxxxx');
+});
+```
+
+---
+## PHP SDK
+- [Auth](./generated/Auth/README.md)
+
+    ユーザ情報、基本情報、認証情報、テナント情報、役割(ロール)情報などに参照・更新に利用します。
+
+- [Pricing](./generated/Pricing/README.md)
+
+    プライシングユニット、機能メニュー、料金プラン、メータリングユニットカウントなど料金に関連する情報の参照・更新に利用します。
+
+- [Billing](./generated/Billing/README.md)
+
+    請求業務で使う外部SaaSとの連携情報の参照・更新に利用します。
+
+
+---
+# ユースケースサンプル
+　準備中・・・
 
-https://docs.saasus.io/

generated/Auth/README.md

@@ -0,0 +1,106 @@
+# Auth
+  詳細(引数、戻り値)はAPIドキュメントを[参照](https://docs.saasus.io/reference/getuserinfo)
+
+## ユーザー情報
+- GetUserInfo ・・・ユーザー情報取得
+
+## 基本情報
+- GetBasicInfo  ・・・基本設定情報の取得
+- UpdateBasicInfo ・・・基本設定情報の更新
+
+- FindNotificationMessages  ・・・通知メールテンプレートを取得
+- UpdateNotificationMessages  ・・・通知メールテンプレートを更新
+
+- GetCustomizePages ・・・認証系画面設定情報取得
+- UpdateCustomizePages  ・・・認証系画面設定情報設定
+
+- GetCustomizePageSettings  ・・・認証認可基本情報取得
+- UpdateCustomizePageSettings ・・・認証認可基本情報更新
+
+- GetEventBridgeSettings  ・・・イベント連携設定を取得
+- SaveEventBridgeSettings ・・・イベント連携設定を更新
+- DeleteEventBridgeSettings ・・・イベント連携設定を削除
+- CreateEventBridgeTestEvent・・・イベント連携のテスト送信
+
+## 認証情報
+- GetAuthInfo ・・・認証情報を取得
+- UpdateAuthInfo  ・・・認証情報を更
+- GetSignInSettings ・・・パスワード要件を取得
+- UpdateSignInSettings  ・・・パスワード要件を更新
+
+## SaaSユーザー情報
+- GetSaaSUsers  ・・・ユーザー一覧を取得
+
+- GetSaaSUser ・・・ユーザー情報を取得
+- CreateSaaSUser  ・・・SaaSにユーザーを作成
+- DeleteSaaSUser  ・・・ユーザー情報を削除
+
+- UpdateSaasUserPassword  ・・・パスワードを変更
+
+- UpdateSaasUserEmail ・・・メールアドレスを変更
+
+- CreateSecretCode  ・・・認証アプリケーション登録用のシークレットコードを作成
+- UpdateSoftwareToken ・・・認証アプリケーションを登録
+
+- GetUserMfaPreference  ・・・ユーザーのMFA設定を取得
+- UpdateUserMfaPreference ・・・ユーザーのMFA設定を更新
+
+
+### Tenant情報
+- GetAllTenantUsers ・・・ユーザー一覧を取得
+- GetAllTenantUser  ・・・ユーザー情報を取得
+
+- GetTenantUsers  ・・・テナントのユーザー一覧を取得
+
+- GetTenantUse  ・・・テナントのユーザー情報を取得
+- CreateTenantUser  ・・・テナントにユーザーを作成
+
+- UpdateTenantUser  ・・・テナントのユーザー属性情報を更新
+- DeleteTenantUser  ・・・テナントのユーザー情報を削除
+
+- CreateTenantUserRoles ・・・テナントのユーザー情報に役割(ロール)を作成
+- DeleteTenantUserRole  ・・・テナントのユーザーから役割(ロール)を削除
+
+## 役割(ロール)情報
+- GetRoles  ・・・役割(ロール)一覧を取得
+- CreateRole  ・・・役割(ロール)を作成
+- DeleteRole  ・・・役割(ロール)を削除
+
+## ユーザーの追加属性情報
+- GetUserAttributes ・・・ユーザー属性の一覧を取得
+- CreateUserAttribute ・・・ユーザー属性の作成
+- DeleteUserAttribute ・・・ユーザー属性の削除
+
+## Tenantの追加属性情報
+- GetTenantAttributes ・・・テナント属性の一覧を取得
+- CreateTenantAttribute ・・・テナント属性の作成
+- DeleteTenantAttribute ・・・テナント属性の削除
+
+## Tenant情報
+- GetTenants  ・・・テナント一覧取得
+- GetTenant ・・・テナントを作成
+- CreateTenant  ・・・テナント情報を取得
+- UpdateTenant  ・・・テナント情報を更新
+- DeleteTenant  ・・・テナント情報を削除
+
+## SaaSus情報
+- GetApiKeys  ・・・APIキー一覧を取
+- CreateApiKey  ・・・APIキーを作成
+- DeleteApiKey  ・・・APIキーを削除
+- GetSaasID ・・・SaasIDを取得
+- UpdateSaasID  ・・・SaasIDを更新
+- GetClientSecret ・・・クライアントシークレットを取得
+- UpdateClientSecret  ・・・クライアントシークレットを更新
+
+## 環境情報
+- GetEnvs ・・・環境情報一覧を取得
+
+- GetEnv ・・・環境情報の取得
+- CreateEnv ・・・環境情報を作成
+- UpdateEnv ・・・環境情報を更新
+- DeleteEnv ・・・環境情報を削除
+
+## 認証・認可情報
+- GetAuthCredentials  ・・・認証・認可情報の取得
+- CreateAuthCredentials ・・・認証・認可情報の保存
+

generated/Billing/README.md

@@ -0,0 +1,7 @@
+# Billing
+  詳細(引数、戻り値)はAPIドキュメントを[参照](https://docs.saasus.io/reference/getstripeinfo)
+
+## stripeリソースの操作
+- GetStripeInfo ・・・Stripeの連携情報を取得
+- UpdateStripeInfo  ・・・Stripeの連携情報を更新
+- DeleteStripeInfo  ・・・Stripeの連携情報を削除

generated/Pricing/README.md

@@ -0,0 +1,40 @@
+# Pricing
+  詳細(引数、戻り値)はAPIドキュメントを[参照](https://docs.saasus.io/reference/getpricingunits)
+
+## プライシングユニット
+- GetPricingUnits ・・・プライシングユニットの一覧を取得
+
+- GetPricingUnit  ・・・プライシングユニットを取得
+- CreatePricingUnit ・・・プライシングユニットを作成
+
+## 機能メニュー
+- GetPricingMenus ・・・プライシング機能メニュー一覧を取得
+
+- GetPricingMenu  ・・・プライシング機能メニューを取得
+- CreatePricingMenu ・・・プライシング機能メニューを作成
+
+## 料金プラン
+- GetPricingPlans ・・・料金プラン一覧を取得
+
+- GetPricingPlan  ・・・料金プランを取得
+- CreatePricingPlan ・・・料金プランを作成
+
+
+## メータリング
+- GetMeteringUnitDateCountByTenantIdAndUnitNameAndDate  ・・・指定した日付のメータリングユニットカウントを取得
+- UpdateMeteringUnitDateCount ・・・指定した日付のメータリングユニットカウントを更新
+- DeleteMeteringUnitDateCount ・・・指定した日付のメータリングユニットカウントを削除
+
+- GetMeteringUnitDateCountByTenantIdAndUnitNameToday  ・・・当日のメータリングユニットカウントを取得
+- UpdateMeteringUnitDateCountToday  ・・・当日のメータリングユニットカウントを更新
+- DeleteMeteringUnitDateCountToday  ・・・当日のメータリングユニットカウントを削除
+
+- GetMeteringUnitMonthCountByTenantIdAndUnitNameThisMonth ・・・当月のメータリングユニットカウントを取得
+- GetMeteringUnitMonthCountByTenantIdAndUnitNameAndMonth  ・・・指定月のメータリングユニットカウントを取得
+
+- GetMeteringUnitDateCountsByTenantIdAndDate  ・・・指定日の全メータリングユニットカウントを取得
+- GetMeteringUnitMonthCountsByTenantIdAndMonth  ・・・指定月の全メータリングユニットカウントを取得
+
+
+
+