geekle-organization-service
このサービスは、サプライユーザーのための組織管理を行います。
カスタムフィールド
src/custom-fields/organization.tsファイル内に、製品エンティティを使用してジョブをリストするのを容易にするための追加フィールドが追加されています。
| フィールド名 | 型 | 説明 |
|---|---|---|
| capital_range | string | 会社の資本金額 |
| representative_person_name | string | 会社の代表者の名前 |
| establishment_date | date | 会社の設立日 |
| organization_summary | string | 会社の概要 |
| industry | string | 会社が属する業界 |
| industry_category | string | 会社が属する業界カテゴリ |
| business_operations | string | 会社の業務内容 |
| upcoming_hiring_positions | string | 会社が募集している職種のリスト |
| application_user_info | object | 組織申請を作成したユーザーの情報 |
| company_registration_form_completed | boolean | 会社が登録フォームを完了しているかどうか |
| application_approval_date | string | 組織が承認された日付 |
| payment_customer_id | string | Stripe顧客ID |
| needs_payment_method_setup | boolean | 組織が最新の支払い情報を持っているかどうか |
| subscription_status | string | Stripeサブスクリプションのステータス |
| subscription_id | string | StripeサブスクリプションID |
カスタムフィールドバリデーター
src/validators内に、新しいカスタムフィールドの値を検証するための追加バリデーターが追加されています。
| エンドポイント | バリデーター名 | 説明 |
|---|---|---|
| createOrganization | valid_capital_range_update | 資本金額が正しくフォーマットされていることを確認します |
| updateOrganization | valid_capital_range_update | 資本金額が正しくフォーマットされていることを確認します |
| createOrganization | duplicate_applications_update | この組織による申請が既に存在するかどうかを確認します |
| updateOrganization | duplicate_applications_update | この組織による申請が既に存在するかどうかを確認します |
| updateOrganization | prevent_updating_status_update | 申請のステータスがどのように更新されるかを検証します |
| createOrganization | application_required_fields_create | contact_name, contact_email_address, contact_phone_number, agree_to_terms_of_useの値がすべて入力されているかどうかを確認します |
カスタムバリデーター
| エンドポイント | バリデーター名 | 説明 |
|---|---|---|
| webhook | createIsWebHookAuthenticateValidator | イベントのヘッダーに保存されたチェックサムがサーバーでデコードされ、イベントボディのバッファーと一致するかどうかを確認し、改ざんされていないことを確認します |
カスタムメール
カスタムメールはsrc/emails内に格納され、src/index.tsファイルから有効化されています。テンプレートはsrc/emails/templates/approved-application.htmlに保存されています。
| エンドポイント | テンプレート | 説明 |
|---|---|---|
| updateOrganization | approved-application.html | 組織が承認された際に送信されます |
| updateOrganization | rejected-application.html | 組織が拒否された際に送信されます |
| createOrganization | new-application-to-admins.html | 新しい組織申請が作成された際に管理者に送信されます |
| createOrganization | new-application.html | 新しい組織申請者に送信されます |
| updateOrganization | payment-complete.html | 支払いAPIで課金された際に送信されます |
| webhook | payment-details-needed.html | 組織が無料試用期間を3日残している際に送信されます |
| webhook | payment-failed.html | Stripeがユーザーから課金できなかった場合に送信されます |
カスタムサイドエフェクト
組織には3つのカスタムサイドエフェクトがあります。
| エンドポイント | サイドエフェクト名 | 説明 |
|---|---|---|
| updateOrganization | setApplicationApprovalDate | 組織が承認された日付をapplication_approval_dateに保存します |
| updateOrganization | setSubscriptionData | 承認された組織リクエストに対してのみ実行されるようにバリデートし、すべての情報が揃った段階で、組織に関連付けられた顧客IDを使用してサブスクリプションを作成し、サブスクリプションIDを組織に保存します。 |
| updateOrganization | createPaymentCustomer | Stripeバックエンドに対して顧客作成コールを行います。顧客が作成されると、顧客情報を組織に更新し、両方のプラットフォームからリンクします。 |
無効化されたエンドポイント
一部のエンドポイントは未使用のため無効化されています。
adapter = sdkAdapter.setEnabledAdapterMethods(adapter, [
'getOrganization',
'createOrganization',
'listOrganizationsForUser',
'listOrgUsersForOrganization',
'updateOrganization',
'listOrganizations',
'createUpdateManyOrgUsers',
'getOrgUserExistence',
'getOrgUserRole',
]);